Macros
#define	CAN_EVENT_SPI_XFER_ERROR (0x200U)
	A SPI transfer error occurred. More...

#define	CAN_EVENT_BIT_ERR_UNCORRECTED (0x100U)
	An uncorrected bit error occurred. More...

#define	CAN_EVENT_RX_RING_BUFFER_FULL (0x80U)
	The driver's Rx ring buffer was full. More...

#define	CAN_EVENT_RX_FIFO_MSG_LOST (0x40U)
	A message was lost for hardware Rx FIFO. More...

#define	CAN_EVENT_ERR_PASSIVE (0x20U)
	State change to error passive. More...

#define	CAN_EVENT_ERR_ACTIVE (0x10U)
	State change to error active. More...

#define	CAN_EVENT_BUS_OFF (0x08U)
	State change to bus off. More...

#define	CAN_EVENT_BUS_ON (0x04U)
	State change to bus on. More...

#define	CAN_EVENT_TX_FINISHED (0x02U)
	A CAN message transmission was completed. More...

#define	CAN_EVENT_RX_DATA_AVAIL (0x01U)
	Received CAN message data is available. More...

Detailed Description

Macro Definition Documentation

§ CAN_EVENT_SPI_XFER_ERROR

#define CAN_EVENT_SPI_XFER_ERROR (0x200U)

A SPI transfer error occurred.

Note: This error is only relevant for SPI-backed external CAN controllers.

If a SPI transfer error occurs, the CAN driver behavior is undefined and message transmit and receive may be unreliable. This error is an indication that further debug of the system HW & SW is required.

§ CAN_EVENT_BIT_ERR_UNCORRECTED

#define CAN_EVENT_BIT_ERR_UNCORRECTED (0x100U)

An uncorrected bit error occurred.

If an uncorrected bit error occurs, the driver should be closed and re-opened to attempt recovery.

§ CAN_EVENT_RX_RING_BUFFER_FULL

#define CAN_EVENT_RX_RING_BUFFER_FULL (0x80U)

The driver's Rx ring buffer was full.

The driver's Rx ring buffer was full resulting in a message being discarded. The application must call CAN_read() in a more timely manner in response to CAN_EVENT_RX_DATA_AVAIL or the size of the Rx ring buffer should be increased.

§ CAN_EVENT_RX_FIFO_MSG_LOST

#define CAN_EVENT_RX_FIFO_MSG_LOST (0x40U)

A message was lost for hardware Rx FIFO.

See event data for FIFO number.

§ CAN_EVENT_ERR_PASSIVE

#define CAN_EVENT_ERR_PASSIVE (0x20U)

State change to error passive.

§ CAN_EVENT_ERR_ACTIVE

#define CAN_EVENT_ERR_ACTIVE (0x10U)

State change to error active.

§ CAN_EVENT_BUS_OFF

#define CAN_EVENT_BUS_OFF (0x08U)

State change to bus off.

§ CAN_EVENT_BUS_ON

#define CAN_EVENT_BUS_ON (0x04U)

State change to bus on.

§ CAN_EVENT_TX_FINISHED

#define CAN_EVENT_TX_FINISHED (0x02U)

A CAN message transmission was completed.

§ CAN_EVENT_RX_DATA_AVAIL

#define CAN_EVENT_RX_DATA_AVAIL (0x01U)

Received CAN message data is available.

This event is used as an indication that CAN_read() can be called to read the received message(s).

Macros