@CHIP-RTOS C Library - CAN API

Header File: #include <CAN_API.H>

The CLIB API definition for sending and receiving data on the CAN (Controller Area Network) buses is defined here.   This API is only available in the SC1x3/SC2x @CHIP-RTOS.

The SC1x3/SC2x offers two CAN bus channels which can be operated with this API.

Each CAN channel has three hardware transmit registers and a four CAN message deep hardware receiver FIFO.   The CAN driver provides send and receive software FIFO's with user specified sizes around each of these hardware devices.

One required step in using the CAN ports is to call the CAN_Open_Port() function, which configures the port for a specific baud rate and sets the driver's software FIFO sizes.

In hardware, each receive channel offers three configurable receiver filters which can be used to reduce the load placed on the CPU by the CAN receivers.   These registers are configured with the CAN_Rx_Filters() function.

Topics

Data Structures

Error Codes

Configuration Functions

CAN_Open_Port Open specified CAN port
CAN_Rx_Filters Configure receive filters
CAN_Reconfig Reconfigure CAN port
CAN_Control Enable, disable and purge
CAN_Close_Port Shut down specified CAN port

Transmit Functions

CAN_Send Output a CAN message

Receive Functions

CAN_Recv Pickup a received CAN message
CAN_Peek Look at received CAN message, leave in queue

Status Functions

CAN_Status Check port status
CAN_Error_Counts Check port error counts
CAN_Event_Sleep Sleep until port event occurs
CAN_Set_Callback Install/Remove ISR callback

List of C Libraries
@CHIP-RTOS Main Index

End of document