www.beck-ipc.com

@CHIP-RTOS C Library V2.06 - CAN API


CAN_Status

Read out status information for specified CAN port.

int CAN_Status ( unsigned int port_idx,

 CAN_STATUS far *sts );

Parameters

port_idx

CAN port specifier:   CAN0_PORT = 0, or CAN1_PORT = 1

sts

Pointer to a CAN_STATUS data structure that will be written to by this API to report the status information for the specified CAN port.

Return Value

Error code -
CAN_EC_SUCCESS = 0:   Success
CAN_EC_INVALID_PARAMS = -1:   port_idx invalid or sts pointer invalid

Comments

This function reports various status information concerning the specified CAN port.   After reading out the reported error flags, the internal error flag registers are cleared (a destructive read).

Inside this API the interrupts are masked for a short period and then re-enabled.   This function is reentrant.

See Also

RTOS API

This library function uses a dynamic link to reach the service offered by RTOS software interrupt.

Supported since or modified in @CHIP-RTOS version

    SC12SC13SC11SC1x3
    n/an/an/aV0.90

Supported by @CHIP-RTOS C Library since version

    CLIB
    V2.01

This API List
List of C Libraries
@CHIP-RTOS Main Index


End of document