4.3 CAN FD - Controller Area Network Flexible Data-Rate

• struct CAN1_FIFOREG

  Defines a structure to access CAN1 FIFO Registers.

• struct CAN1_RX_FIFO_MSG

  CAN1 Receive FIFO Message Object head count information maintenance data structure.

• struct CAN_MSG_FIELD

  Used to configure the message fields of CAN frame.

• struct CAN_MSG_OBJ

  Used to configure the message object of CAN frame.

• #define CAN_FD1_Initialize CAN1_Initialize

  Defines the Custom Name for CAN1_Initialize() API.

• #define CAN_FD1_Deinitialize CAN1_Deinitialize

  Defines the Custom Name for CAN1_Deinitialize() API.

• #define CAN_FD1_OperationModeSet CAN1_OperationModeSet

  Defines the Custom Name for CAN1_OperationModeSet() API.

• #define CAN_FD1_OperationModeGet CAN1_OperationModeGet

  Defines the Custom Name for CAN1_OperationModeGet() API.

• #define CAN_FD1_Transmit CAN1_Transmit

  Defines the Custom Name for CAN1_Transmit() API.

• #define CAN_FD1_TransmitFIFOStatusGet CAN1_TransmitFIFOStatusGet

  Defines the Custom Name for CAN1_TransmitFIFOStatusGet() API.

• #define CAN_FD1_IsTxErrorPassive CAN1_IsTxErrorPassive

  Defines the Custom Name for CAN1_IsTxErrorPassive() API.

• #define CAN_FD1_IsTxErrorWarning CAN1_IsTxErrorWarning

  Defines the Custom Name for CAN1_IsTxErrorWarning() API.

• #define CAN_FD1_IsTxErrorActive CAN1_IsTxErrorActive

  Defines the Custom Name for CAN1_IsTxErrorActive() API.

• #define CAN_FD1_Receive CAN1_Receive

  Defines the Custom Name for CAN1_Receive() API.

• #define CAN_FD1_ReceiveMessageGet CAN1_ReceiveMessageGet

  Defines the Custom Name for CAN1_ReceiveMessageGet() API.

• #define CAN_FD1_ReceivedMessageCountGet CAN1_ReceivedMessageCountGet

  Defines the Custom Name for CAN1_ReceivedMessageCountGet() API.

• #define CAN_FD1_ReceiveFIFOStatusGet CAN1_ReceiveFIFOStatusGet

  Defines the Custom Name for CAN1_ReceiveFIFOStatusGet() API.

• #define CAN_FD1_IsRxErrorPassive CAN1_IsRxErrorPassive

  Defines the Custom Name for CAN1_IsRxErrorPassive() API.

• #define CAN_FD1_IsRxErrorWarning CAN1_IsRxErrorWarning

  Defines the Custom Name for CAN1_IsRxErrorWarning() API.

• #define CAN_FD1_IsRxErrorActive CAN1_IsRxErrorActive

  Defines the Custom Name for CAN1_IsRxErrorActive() API.

• #define CAN_FD1_IsBusOff CAN1_IsBusOff

  Defines the Custom Name for CAN1_IsBusOff() API.

• #define CAN_FD1_Sleep CAN1_Sleep

  Defines the Custom Name for CAN1_Sleep() API.

• #define CAN_FD1_InvalidMessageCallbackRegister CAN1_InvalidMessageCallbackRegister

  Defines the Custom Name for CAN1_InvalidMessageCallbackRegister() API.

• #define CAN_FD1_BusWakeUpActivityCallbackRegister CAN1_BusWakeUpActivityCallbackRegister

  Defines the Custom Name for CAN1_BusWakeUpActivityCallbackRegister() API.

• #define CAN_FD1_BusErrorCallbackRegister CAN1_BusErrorCallbackRegister

  Defines the Custom Name for CAN1_BusErrorCallbackRegister() API.

• #define CAN_FD1_ModeChangeCallbackRegister CAN1_ModeChangeCallbackRegister

  Defines the Custom Name for CAN1_ModeChangeCallbackRegister() API.

• #define CAN_FD1_SystemErrorCallbackRegister CAN1_SystemErrorCallbackRegister

  Defines the Custom Name for CAN1_SystemErrorCallbackRegister() API.

• #define CAN_FD1_TxAttemptCallbackRegister CAN1_TxAttemptCallbackRegister

  Defines the Custom Name for CAN1_TxAttemptCallbackRegister() API.

• #define CAN_FD1_RxBufferOverFlowCallbackRegister CAN1_RxBufferOverFlowCallbackRegister

  Defines the Custom Name for CAN1_RxBufferOverFlowCallbackRegister() API.

• #define CAN1_TX_TXQ CAN1_TXQ

  CAN1 Transmit FIFO TXQ Custom Name.

• #define CAN1_TX_FIFO1 CAN1_FIFO_1

  CAN1 Transmit FIFO 1 Custom Name.

• #define CAN1_RX_FIFO2 CAN1_FIFO_2

  CAN1 Receive FIFO 2 Custom Name.

• #define CAN1_RX_FIFO3 CAN1_FIFO_3

  CAN1 Receive FIFO 3 Custom Name.

• #define CAN_FD1_Tasks CAN1_Tasks

  Defines the Custom Name for CAN1_Tasks() API.

• #define CAN_FD_MESSAGE_FORMAT_FEATURE_AVAILABLE 1

  Defines the CAN FD Message format data update request functionality.

• #define CAN_FIFO_BASED_TRANSMIT_PRIORITY_FEATURE_AVAILABLE 1

  Defines the CAN FIFO based transmit priority data update request functionality.

• #define CAN_DMA_INTERFACE_FEATURE_AVAILABLE 0

  Defines the CAN 2.0 DMA interface data update request functionality.

• enum CAN_TX_FIFO_CHANNELS { CAN1_TXQ = 0, CAN1_FIFO_1 = 1, CAN_TX_FIFO_MAX }

  Defines the CAN FIFOs configured as transmit.

• enum CAN_RX_FIFO_CHANNELS { CAN1_FIFO_2 = 2, CAN1_FIFO_3 = 3, CAN_RX_FIFO_MAX }

  Defines the CAN FIFOs configured as receive.

• enum CAN_MSG_OBJ_BRS_MODE { CAN_NON_BRS_MODE = 0, CAN_BRS_MODE = 1 }

  Defines if the bit rate switching is enabled or disabled in the CAN message object.

• enum CAN_MSG_OBJ_ID_TYPE { CAN_FRAME_STD = 0, CAN_FRAME_EXT = 1 }

  Defines if the message ID is Standard ID or Extended ID in CAN message object.

• enum CAN_MSG_OBJ_FRAME_TYPE { CAN_FRAME_DATA = 0, CAN_FRAME_RTR = 1 }

  Defines if the frame type is Data frame or Remote Transmit Request frame in CAN message object.

• enum CAN_MSG_OBJ_TYPE { CAN_2_0_FORMAT = 0, CAN_FD_FORMAT = 1 }

  Defines if the CAN message object is in CAN FD format or CAN 2.0 format.

• enum CAN_TX_MSG_REQUEST_STATUS { CAN_TX_MSG_REQUEST_SUCCESS = 0, CAN_TX_MSG_REQUEST_DLC_EXCEED_ERROR = 1, CAN_TX_MSG_REQUEST_BRS_ERROR = 2, CAN_TX_MSG_REQUEST_FIFO_FULL = 3 }

  Defines the CAN transmit API return status.

• enum CAN_OP_MODES { CAN_NORMAL_FD_MODE = 0x0, CAN_DISABLE_MODE = 0x1, CAN_INTERNAL_LOOPBACK_MODE = 0x2, CAN_LISTEN_ONLY_MODE = 0x3, CAN_CONFIGURATION_MODE = 0x4, CAN_EXTERNAL_LOOPBACK_MODE = 0x5, CAN_NORMAL_2_0_MODE = 0x6, CAN_RESTRICTED_OPERATION_MODE =0x7 }

  Defines the CAN operation modes that are available for the module to use.

• enum CAN_OP_MODE_STATUS { CAN_OP_MODE_REQUEST_SUCCESS, CAN_OP_MODE_REQUEST_FAIL, CAN_OP_MODE_SYS_ERROR_OCCURED }

  Defines the return status of CAN operation mode set API.

• enum CAN_TX_FIFO_STATUS { CAN_TX_FIFO_FULL = 0x0, CAN_TX_FIFO_AVAILABLE = 0x1 }

  Defines the status of CAN FD transmit FIFO.

• enum CAN_RX_FIFO_STATUS { CAN_RX_MSG_NOT_AVAILABLE = 0x0, CAN_RX_MSG_AVAILABLE = 0x1, CAN_RX_MSG_OVERFLOW = 0x8 }

  Defines the CAN FD receive FIFO status bit mask values.

• enum CAN_DLC { DLC_0, DLC_1, DLC_2, DLC_3, DLC_4, DLC_5, DLC_6, DLC_7, DLC_8, DLC_12, DLC_16, DLC_20, DLC_24, DLC_32, DLC_48, DLC_64 }

  Defines the CAN message payload sizes that are available for the mode to use.

• static uint8_t CAN1_DlcToDataBytesGet (const enum CAN_DLC dlc)

  Get the DLC enum based data byte value.

• static uint8_t CAN1_PLSIZEToPayloadBytesGet (uint8_t plsize)

  Get the Payload size in bytes for PLSIZE register value.

• static bool CAN1_IsTxChannel (uint8_t channel)

  Check if a valid channel is configured as transmitter or not.

• static enum CAN_TX_FIFO_STATUS CAN1_GetTxFifoStatus (uint8_t validChannel)

  Returns the CAN1 transmit FIFO status.

• static void CAN1_MessageWriteToFifo (uint8_t *txFifoObj, struct CAN_MSG_OBJ *txCanMsg)

  Reads the message object from user input and updates the CAN1 TX FIFO.

• static enum CAN_TX_MSG_REQUEST_STATUS CAN1_ValidateTransmission (uint8_t channel, struct CAN_MSG_OBJ *txCanMsg)

  Validates transmission.

• static void CAN1_RX_FIFO_ResetInfo (void)

  Resets the CAN1 receive message head count.

• static bool CAN1_IsRxChannel (uint8_t channel)

  Checks if a valid channel is configured as receiver or not.

• static uint8_t CAN1_GetRxFifoStatus (uint8_t validChannel)

  Returns the CAN1 Receive FIFO status.

• static uint8_t CAN1_GetRxFifoDepth (uint8_t validChannel)

  Returns the CAN1 Receive FIFO depth.

• static void CAN1_MessageReadFromFifo (uint8_t *rxFifoObj, struct CAN_MSG_OBJ *rxCanMsg)

  Reads the message object from Receive FIFO and updates the user message object.

• static bool CAN1_ReceiveFromFiFo (uint8_t index, enum CAN_RX_FIFO_CHANNELS channel, struct CAN_MSG_OBJ *rxCanMsg)

  Reads the data object from a particular CAN receive FIFO.

• static void CAN1_TX_FIFO_Configuration (void)

  Configures the CAN1 TX FIFO settings.

• static void CAN1_RX_FIFO_Configuration (void)

  Configures the CAN1 Receive FIFO settings.

• static void CAN1_RX_FIFO_FilterMaskConfiguration (void)

  Configures the CAN1 RX FIFO filter and mask settings.

• static void CAN1_BitRateConfiguration (void)

  Configures the CAN1 Bit rate settings.

• static void CAN1_ErrorNotificationEnable (void)

  Enables the CAN1 error notification interrupt.

• void CAN1_Initialize (void)

  Initializes the CAN1 module.

• void CAN1_Deinitialize (void)

  Resets the CAN1 registers and settings to their POR values.

• enum CAN_OP_MODE_STATUS CAN1_OperationModeSet (const enum CAN_OP_MODES requestMode)

  Sets the CAN1 Operation mode.

• enum CAN_OP_MODES CAN1_OperationModeGet (void)

  Gets the CAN1 Operation mode.

• enum CAN_TX_MSG_REQUEST_STATUS CAN1_Transmit (const enum CAN_TX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ *txCanMsg)

  Writes the CAN message object to the specified transmit FIFO channel.

• enum CAN_TX_FIFO_STATUS CAN1_TransmitFIFOStatusGet (const enum CAN_TX_FIFO_CHANNELS fifoChannel)

  Returns the CAN1 transmitter FIFO status.

• bool CAN1_IsTxErrorPassive (void)

  Returns the Transmit Error Passive state. If the Transmit Error Counter is above 127, then the transmitter is in Error Passive state.

• bool CAN1_IsTxErrorWarning (void)

  Returns the Transmit Error Warning state. If the Transmit Error Counter is above 95 and below 128, then the transmitter is in Error Warning state.

• bool CAN1_IsTxErrorActive (void)

  Returns the Transmit Error Active state. If the Transmit Error Counter is above 0 and below 128, then the transmitter is in Error Active state.

• bool CAN1_Receive (struct CAN_MSG_OBJ *rxCanMsg)

  Reads a message object.

• bool CAN1_ReceiveMessageGet (const enum CAN_RX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ *rxCanMsg)

  Reads a message object from the selected CAN1 receive FIFO.

• uint8_t CAN1_ReceivedMessageCountGet (void)

  Returns the number of CAN messages received in all the FIFOs.

• uint8_t CAN1_ReceiveFIFOStatusGet (const enum CAN_RX_FIFO_CHANNELS fifoChannel)

  Returns the CAN1 receiver FIFO status.

• bool CAN1_IsRxErrorPassive (void)

  Returns the Receive Error Passive state. If the Receive Error Counter is above 127, then the receiver is in Error Passive state.

• bool CAN1_IsRxErrorWarning (void)

  Returns the Receive Error Warning state. If the Receive Error Counter is above 95 and below 128, then the receiver is in Error Warning state.

• bool CAN1_IsRxErrorActive (void)

  Returns the Receive Error Active state. If the Receive Error Counter is above 0 and below 128, then the receiver is in Error Active state.

• bool CAN1_IsBusOff (void)

  Returns the Bus Off status.

• void CAN1_Sleep (void)

  Puts the CAN1 node into Sleep mode.

• void CAN1_InvalidMessageCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_InvalidMessage callback.

• void CAN1_BusWakeUpActivityCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_BusWakeUpActivity callback.

• void CAN1_BusErrorCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_BusError callback.

• void CAN1_ModeChangeCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_ModeChange callback.

• void CAN1_SystemErrorCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_SystemError callback.

• void CAN1_TxAttemptCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_TxAttempt callback.

• void CAN1_RxBufferOverFlowCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_RxBufferOverFlow callback.

• void CAN1_TXQEmptyCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_TXQEmpty callback.

• void CAN1_FIFO1HalfEmptyCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_FIFO1HalfEmpty callback.

• void CAN1_FIFO2NotEmptyCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_FIFO2NotEmpty callback.

• void CAN1_FIFO3FullCallbackRegister (void(*handler)(void))

  Setter function for the CAN1_FIFO3Full callback.

• void CAN1_Tasks (void)

  Used to implement the tasks for polled implementations.

• const struct CAN_INTERFACE CAN_FD1

  Structure object of type CAN_INTERFACE with the custom name given by the user.

#define CAN1_RX_FIFO2 CAN1_FIFO_2

CAN1 Receive FIFO 2 Custom Name.

Defines the custom name of CAN1_FIFO_2 used for Receive functionality.

#define CAN1_RX_FIFO3 CAN1_FIFO_3

CAN1 Receive FIFO 3 Custom Name.

Defines the custom name of CAN1_FIFO_3 used for Receive functionality.

#define CAN1_TX_FIFO1 CAN1_FIFO_1

CAN1 Transmit FIFO 1 Custom Name.

Defines the custom name of CAN1_FIFO_1 used for Transmit functionality.

#define CAN1_TX_TXQ CAN1_TXQ

CAN1 Transmit FIFO TXQ Custom Name.

Defines the custom name of CAN1_TXQ used for Transmit functionality.

#define CAN_DMA_INTERFACE_FEATURE_AVAILABLE 0

Defines the CAN 2.0 DMA interface data update request functionality.

#define CAN_FD1_BusErrorCallbackRegister CAN1_BusErrorCallbackRegister

Defines the Custom Name for CAN1_BusErrorCallbackRegister() API.

#define CAN_FD1_BusWakeUpActivityCallbackRegister CAN1_BusWakeUpActivityCallbackRegister

Defines the Custom Name for CAN1_BusWakeUpActivityCallbackRegister() API.

#define CAN_FD1_Deinitialize CAN1_Deinitialize

Defines the Custom Name for CAN1_Deinitialize() API.

#define CAN_FD1_Initialize CAN1_Initialize

Defines the Custom Name for CAN1_Initialize() API.

#define CAN_FD1_InvalidMessageCallbackRegister CAN1_InvalidMessageCallbackRegister

Defines the Custom Name for CAN1_InvalidMessageCallbackRegister() API.

#define CAN_FD1_IsBusOff CAN1_IsBusOff

Defines the Custom Name for CAN1_IsBusOff() API.

#define CAN_FD1_IsRxErrorActive CAN1_IsRxErrorActive

Defines the Custom Name for CAN1_IsRxErrorActive() API.

#define CAN_FD1_IsRxErrorPassive CAN1_IsRxErrorPassive

Defines the Custom Name for CAN1_IsRxErrorPassive() API.

#define CAN_FD1_IsRxErrorWarning CAN1_IsRxErrorWarning

Defines the Custom Name for CAN1_IsRxErrorWarning() API.

#define CAN_FD1_IsTxErrorActive CAN1_IsTxErrorActive

Defines the Custom Name for CAN1_IsTxErrorActive() API.

#define CAN_FD1_IsTxErrorPassive CAN1_IsTxErrorPassive

Defines the Custom Name for CAN1_IsTxErrorPassive() API.

#define CAN_FD1_IsTxErrorWarning CAN1_IsTxErrorWarning

Defines the Custom Name for CAN1_IsTxErrorWarning() API.

#define CAN_FD1_ModeChangeCallbackRegister CAN1_ModeChangeCallbackRegister

Defines the Custom Name for CAN1_ModeChangeCallbackRegister() API.

#define CAN_FD1_OperationModeGet CAN1_OperationModeGet

Defines the Custom Name for CAN1_OperationModeGet() API.

#define CAN_FD1_OperationModeSet CAN1_OperationModeSet

Defines the Custom Name for CAN1_OperationModeSet() API.

#define CAN_FD1_Receive CAN1_Receive

Defines the Custom Name for CAN1_Receive() API.

#define CAN_FD1_ReceivedMessageCountGet CAN1_ReceivedMessageCountGet

Defines the Custom Name for CAN1_ReceivedMessageCountGet() API.

#define CAN_FD1_ReceiveFIFOStatusGet CAN1_ReceiveFIFOStatusGet

Defines the Custom Name for CAN1_ReceiveFIFOStatusGet() API.

#define CAN_FD1_ReceiveMessageGet CAN1_ReceiveMessageGet

Defines the Custom Name for CAN1_ReceiveMessageGet() API.

#define CAN_FD1_RxBufferOverFlowCallbackRegister CAN1_RxBufferOverFlowCallbackRegister

Defines the Custom Name for CAN1_RxBufferOverFlowCallbackRegister() API.

#define CAN_FD1_Sleep CAN1_Sleep

Defines the Custom Name for CAN1_Sleep() API.

#define CAN_FD1_SystemErrorCallbackRegister CAN1_SystemErrorCallbackRegister

Defines the Custom Name for CAN1_SystemErrorCallbackRegister() API.

#define CAN_FD1_Tasks CAN1_Tasks

Defines the Custom Name for CAN1_Tasks() API.

#define CAN_FD1_Transmit CAN1_Transmit

Defines the Custom Name for CAN1_Transmit() API.

#define CAN_FD1_TransmitFIFOStatusGet CAN1_TransmitFIFOStatusGet

Defines the Custom Name for CAN1_TransmitFIFOStatusGet() API.

#define CAN_FD1_TxAttemptCallbackRegister CAN1_TxAttemptCallbackRegister

Defines the Custom Name for CAN1_TxAttemptCallbackRegister() API.

#define CAN_FD_MESSAGE_FORMAT_FEATURE_AVAILABLE 1

Defines the CAN FD Message format data update request functionality.

#define CAN_FIFO_BASED_TRANSMIT_PRIORITY_FEATURE_AVAILABLE 1

Defines the CAN FIFO based transmit priority data update request functionality.

static void CAN1_BitRateConfiguration (void )[static]

Configures the CAN1 Bit rate settings.

void CAN1_BusErrorCallbackRegister (void (*handler)(void))

Setter function for the CAN1_BusError callback.

void CAN1_BusWakeUpActivityCallbackRegister (void (*handler)(void))

Setter function for the CAN1_BusWakeUpActivity callback.

void CAN1_Deinitialize (void )

Resets the CAN1 registers and settings to their POR values.

static uint8_t CAN1_DlcToDataBytesGet (const enum CAN_DLC dlc)[static]

Get the DLC enum based data byte value.

static void CAN1_ErrorNotificationEnable (void )[static]

Enables the CAN1 error notification interrupt.

void CAN1_FIFO1HalfEmptyCallbackRegister (void (*handler)(void))

Setter function for the CAN1_FIFO1HalfEmpty callback.

void CAN1_FIFO2NotEmptyCallbackRegister (void (*handler)(void))

Setter function for the CAN1_FIFO2NotEmpty callback.

void CAN1_FIFO3FullCallbackRegister (void (*handler)(void))

Setter function for the CAN1_FIFO3Full callback.

static uint8_t CAN1_GetRxFifoDepth (uint8_t validChannel)[static]

Returns the CAN1 Receive FIFO depth.

static uint8_t CAN1_GetRxFifoStatus (uint8_t validChannel)[static]

Returns the CAN1 Receive FIFO status.

static enum CAN_TX_FIFO_STATUS CAN1_GetTxFifoStatus (uint8_t validChannel)[static]

Returns the CAN1 transmit FIFO status.

void CAN1_Initialize (void )

Initializes the CAN1 module.

void CAN1_InvalidMessageCallbackRegister (void (*handler)(void))

Setter function for the CAN1_InvalidMessage callback.

bool CAN1_IsBusOff (void )

Returns the Bus Off status.

static bool CAN1_IsRxChannel (uint8_t channel)[static]

Checks if a valid channel is configured as receiver or not.

bool CAN1_IsRxErrorActive (void )

Returns the Receive Error Active state. If the Receive Error Counter is above 0 and below 128, then the receiver is in Error Active state.

bool CAN1_IsRxErrorPassive (void )

Returns the Receive Error Passive state. If the Receive Error Counter is above 127, then the receiver is in Error Passive state.

bool CAN1_IsRxErrorWarning (void )

Returns the Receive Error Warning state. If the Receive Error Counter is above 95 and below 128, then the receiver is in Error Warning state.

static bool CAN1_IsTxChannel (uint8_t channel)[static]

Check if a valid channel is configured as transmitter or not.

bool CAN1_IsTxErrorActive (void )

Returns the Transmit Error Active state. If the Transmit Error Counter is above 0 and below 128, then the transmitter is in Error Active state.

bool CAN1_IsTxErrorPassive (void )

Returns the Transmit Error Passive state. If the Transmit Error Counter is above 127, then the transmitter is in Error Passive state.

bool CAN1_IsTxErrorWarning (void )

Returns the Transmit Error Warning state. If the Transmit Error Counter is above 95 and below 128, then the transmitter is in Error Warning state.

static void CAN1_MessageReadFromFifo (uint8_t * rxFifoObj, struct CAN_MSG_OBJ * rxCanMsg)[static]

Reads the message object from Receive FIFO and updates the user message object.

static void CAN1_MessageWriteToFifo (uint8_t * txFifoObj, struct CAN_MSG_OBJ * txCanMsg)[static]

Reads the message object from user input and updates the CAN1 TX FIFO.

void CAN1_ModeChangeCallbackRegister (void (*handler)(void))

Setter function for the CAN1_ModeChange callback.

enum CAN_OP_MODES CAN1_OperationModeGet (void )

Gets the CAN1 Operation mode.

enum CAN_OP_MODE_STATUS CAN1_OperationModeSet (const enum CAN_OP_MODES requestMode)

Sets the CAN1 Operation mode.

static uint8_t CAN1_PLSIZEToPayloadBytesGet (uint8_t plsize)[static]

Get the Payload size in bytes for PLSIZE register value.

bool CAN1_Receive (struct CAN_MSG_OBJ * rxCanMsg)

Reads a message object.

uint8_t CAN1_ReceivedMessageCountGet (void )

Returns the number of CAN messages received in all the FIFOs.

uint8_t CAN1_ReceiveFIFOStatusGet (const enum CAN_RX_FIFO_CHANNELS fifoChannel)

Returns the CAN1 receiver FIFO status.

static bool CAN1_ReceiveFromFiFo (uint8_t index, enum CAN_RX_FIFO_CHANNELS channel, struct CAN_MSG_OBJ * rxCanMsg)[static]

Reads the data object from a particular CAN receive FIFO.

bool CAN1_ReceiveMessageGet (const enum CAN_RX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ * rxCanMsg)

Reads a message object from the selected CAN1 receive FIFO.

static void CAN1_RX_FIFO_Configuration (void )[static]

Configures the CAN1 Receive FIFO settings.

static void CAN1_RX_FIFO_FilterMaskConfiguration (void )[static]

Configures the CAN1 RX FIFO filter and mask settings.

static void CAN1_RX_FIFO_ResetInfo (void )[static]

Resets the CAN1 receive message head count.

void CAN1_RxBufferOverFlowCallbackRegister (void (*handler)(void))

Setter function for the CAN1_RxBufferOverFlow callback.

void CAN1_Sleep (void )

Puts the CAN1 node into Sleep mode.

void CAN1_SystemErrorCallbackRegister (void (*handler)(void))

Setter function for the CAN1_SystemError callback.

void CAN1_Tasks (void )

Used to implement the tasks for polled implementations.

enum CAN_TX_MSG_REQUEST_STATUS CAN1_Transmit (const enum CAN_TX_FIFO_CHANNELS fifoChannel, struct CAN_MSG_OBJ * txCanMsg)

Writes the CAN message object to the specified transmit FIFO channel.

enum CAN_TX_FIFO_STATUS CAN1_TransmitFIFOStatusGet (const enum CAN_TX_FIFO_CHANNELS fifoChannel)

Returns the CAN1 transmitter FIFO status.

static void CAN1_TX_FIFO_Configuration (void )[static]

Configures the CAN1 TX FIFO settings.

void CAN1_TxAttemptCallbackRegister (void (*handler)(void))

Setter function for the CAN1_TxAttempt callback.

void CAN1_TXQEmptyCallbackRegister (void (*handler)(void))

Setter function for the CAN1_TXQEmpty callback.

static enum CAN_TX_MSG_REQUEST_STATUS CAN1_ValidateTransmission (uint8_t channel, struct CAN_MSG_OBJ * txCanMsg)[static]

Validates transmission.

enum CAN_DLC

Defines the CAN message payload sizes that are available for the mode to use.

enum CAN_MSG_OBJ_BRS_MODE

Defines if the bit rate switching is enabled or disabled in the CAN message object.

enum CAN_MSG_OBJ_FRAME_TYPE

Defines if the frame type is Data frame or Remote Transmit Request frame in CAN message object.

enum CAN_MSG_OBJ_ID_TYPE

Defines if the message ID is Standard ID or Extended ID in CAN message object.

enum CAN_MSG_OBJ_TYPE

Defines if the CAN message object is in CAN FD format or CAN 2.0 format.

enum CAN_OP_MODE_STATUS

Defines the return status of CAN operation mode set API.

enum CAN_OP_MODES

Defines the CAN operation modes that are available for the module to use.

enum CAN_RX_FIFO_CHANNELS

Defines the CAN FIFOs configured as receive.

enum CAN_RX_FIFO_STATUS

Defines the CAN FD receive FIFO status bit mask values.

enum CAN_TX_FIFO_CHANNELS

Defines the CAN FIFOs configured as transmit.

enum CAN_TX_FIFO_STATUS

Defines the status of CAN FD transmit FIFO.

enum CAN_TX_MSG_REQUEST_STATUS

Defines the CAN transmit API return status.

const struct CAN_INTERFACE CAN_FD1

Structure object of type CAN_INTERFACE with the custom name given by the user.

• uint8_t CONL

• uint8_t CONH

• uint8_t CONU

• uint8_t CONT

• uint8_t STAL

• uint8_t STAH

• uint8_t STAU

• uint8_t STAT

• uint32_t UA

uint8_t CONH

uint8_t CONL

uint8_t CONT

uint8_t CONU

uint8_t STAH

uint8_t STAL

uint8_t STAT

uint8_t STAU

uint32_t UA

• enum CAN_RX_FIFO_CHANNELS channel

• uint8_t headCount

enum CAN_RX_FIFO_CHANNELS channel

uint8_t headCount

• uint8_t idType:1

• uint8_t frameType:1

• uint8_t dlc:4

• uint8_t formatType:1

• uint8_t brs:1

uint8_t brs

Enables or Disables the Bit Rate Switch (width:1 bit)

uint8_t dlc

Defines the size of the data bytes in a message frame. The maximum DLC is 8 for CAN 2.0 and 64 for CAN FD (width: 4 bit)

uint8_t formatType

Defines the message type as CAN 2.0 Format or CAN_FD Format (width: 1 bit)

uint8_t frameType

Defines the message frame type as Data Frame or RTR Frame (1 bit)

uint8_t idType

Defines the message ID type as Standard ID or Extended ID (width: 1 bit)

• uint32_t msgId

• struct CAN_MSG_FIELD field

• uint8_t * data

uint8_t* data

Pointer to message data

struct CAN_MSG_FIELD field

For CAN TX/RX Message Object Control

uint32_t msgId

Set the CAN Message ID (EID <17:0> | SID <10:0>)

Macros for the CAN Bus Receive FIFO Memory.

• #define CAN1_NUM_OF_RX_FIFO (2U)

• #define CAN1_RX_FIFO_MSG_DATA (64U)

void __interrupt (irq(CAN) , base(8) )

void __interrupt (irq(CANRX) , base(8) )

void __interrupt (irq(CANTX) , base(8) )

#define CAN1_NUM_OF_RX_FIFO (2U)

#define CAN1_RX_FIFO_MSG_DATA (64U)

#define CAN_MSG_OBJ_BRS_FIELD_MASK (0x40U)

#define CAN_MSG_OBJ_BRS_POSN (0x6U)

#define CAN_MSG_OBJ_DLC_FIELD_MASK (0xFU)

#define CAN_MSG_OBJ_EID_HIGH_MASK (0x1FU)

#define CAN_MSG_OBJ_EID_HIGH_WIDTH (0x5U)

#define CAN_MSG_OBJ_EID_LOW_MASK (0xF8U)

#define CAN_MSG_OBJ_EID_LOW_POSN (0x3U)

#define CAN_MSG_OBJ_EID_LOW_WIDTH (0x5U)

#define CAN_MSG_OBJ_EID_MID_MASK (0xFFU)

#define CAN_MSG_OBJ_EID_MID_WIDTH (0x8U)

#define CAN_MSG_OBJ_FDF_FIELD_MASK (0x80U)

#define CAN_MSG_OBJ_FDF_POSN (0x7U)

#define CAN_MSG_OBJ_FRAME_TYPE_FIELD_MASK (0x20U)

#define CAN_MSG_OBJ_ID_TYPE_FIELD_MASK (0x10U)

#define CAN_MSG_OBJ_IDE_POSN (0x4U)

#define CAN_MSG_OBJ_RTR_POSN (0x5U)

#define CAN_MSG_OBJ_SID_HIGH_MASK (0x7U)

#define CAN_MSG_OBJ_SID_HIGH_WIDTH (0x3U)

#define CAN_MSG_OBJ_SID_LOW_MASK (0xFFU)

#define CAN_MSG_OBJ_SID_LOW_WIDTH (0x8U)

#define CAN_STD_MSG_ID_SIZE (CAN_MSG_OBJ_SID_LOW_WIDTH + CAN_MSG_OBJ_SID_HIGH_WIDTH)

void(* CAN1_BusErrorHandler) (void) = NULL[static]

void(* CAN1_BusWakeUpActivityHandler) (void) = NULL[static]

void(* CAN1_FIFO1HalfEmptyHandler) (void) = NULL[static]

void(* CAN1_FIFO2NotEmptyHandler) (void) = NULL[static]

void(* CAN1_FIFO3FullHandler) (void) = NULL[static]

void(* CAN1_InvalidMessageHandler) (void) = NULL[static]

void(* CAN1_ModeChangeHandler) (void) = NULL[static]

void(* CAN1_RxBufferOverFlowHandler) (void) = NULL[static]

void(* CAN1_SystemErrorHandler) (void) = NULL[static]

void(* CAN1_TxAttemptHandler) (void) = NULL[static]

void(* CAN1_TXQEmptyHandler) (void) = NULL[static]

volatile struct CAN1_FIFOREG* const FIFO = (struct CAN1_FIFOREG *)&C1TXQCONL[static]

volatile struct CAN1_RX_FIFO_MSG rxFIFOMsg[CAN1_NUM_OF_RX_FIFO][static]

Initial value:

= 
{
    
    {CAN1_FIFO_2, 0U},
    {CAN1_FIFO_3, 0U},
}

uint8_t rxMsgData[CAN1_RX_FIFO_MSG_DATA][static]

Macros for the CAN Bus Receive FIFO Memory.

• #define CAN1_NUM_OF_RX_FIFO (2U)

• #define CAN1_RX_FIFO_MSG_DATA (64U)

void __interrupt (irq(CAN) , base(8) )

static void CAN1_BitRateConfiguration (void )[static]

Configures the CAN1 Bit rate settings.

static uint8_t CAN1_DlcToDataBytesGet (const enum CAN_DLC dlc)[static]

Get the DLC enum based data byte value.

static uint8_t CAN1_GetRxFifoDepth (uint8_t validChannel)[static]

Returns the CAN1 Receive FIFO depth.

static uint8_t CAN1_GetRxFifoStatus (uint8_t validChannel)[static]

Returns the CAN1 Receive FIFO status.

static enum CAN_TX_FIFO_STATUS CAN1_GetTxFifoStatus (uint8_t validChannel)[static]

Returns the CAN1 transmit FIFO status.

static bool CAN1_IsRxChannel (uint8_t channel)[static]

Checks if a valid channel is configured as receiver or not.

static bool CAN1_IsTxChannel (uint8_t channel)[static]

Check if a valid channel is configured as transmitter or not.

static void CAN1_MessageReadFromFifo (uint8_t * rxFifoObj, struct CAN_MSG_OBJ * rxCanMsg)[static]

Reads the message object from Receive FIFO and updates the user message object.

static void CAN1_MessageWriteToFifo (uint8_t * txFifoObj, struct CAN_MSG_OBJ * txCanMsg)[static]

Reads the message object from user input and updates the CAN1 TX FIFO.

static uint8_t CAN1_PLSIZEToPayloadBytesGet (uint8_t plsize)[static]

Get the Payload size in bytes for PLSIZE register value.

static bool CAN1_ReceiveFromFiFo (uint8_t index, enum CAN_RX_FIFO_CHANNELS channel, struct CAN_MSG_OBJ * rxCanMsg)[static]

Reads the data object from a particular CAN receive FIFO.

static void CAN1_RX_FIFO_Configuration (void )[static]

Configures the CAN1 Receive FIFO settings.

static void CAN1_RX_FIFO_FilterMaskConfiguration (void )[static]

Configures the CAN1 RX FIFO filter and mask settings.

static void CAN1_RX_FIFO_ResetInfo (void )[static]

Resets the CAN1 receive message head count.

static void CAN1_TX_FIFO_Configuration (void )[static]

Configures the CAN1 TX FIFO settings.

static enum CAN_TX_MSG_REQUEST_STATUS CAN1_ValidateTransmission (uint8_t channel, struct CAN_MSG_OBJ * txCanMsg)[static]

Validates transmission.

#define CAN1_NUM_OF_RX_FIFO (2U)

#define CAN1_RX_FIFO_MSG_DATA (64U)

#define CAN_MSG_OBJ_BRS_FIELD_MASK (0x40U)

#define CAN_MSG_OBJ_BRS_POSN (0x6U)

#define CAN_MSG_OBJ_DLC_FIELD_MASK (0xFU)

#define CAN_MSG_OBJ_EID_HIGH_MASK (0x1FU)

#define CAN_MSG_OBJ_EID_HIGH_WIDTH (0x5U)

#define CAN_MSG_OBJ_EID_LOW_MASK (0xF8U)

#define CAN_MSG_OBJ_EID_LOW_POSN (0x3U)

#define CAN_MSG_OBJ_EID_LOW_WIDTH (0x5U)

#define CAN_MSG_OBJ_EID_MID_MASK (0xFFU)

#define CAN_MSG_OBJ_EID_MID_WIDTH (0x8U)

#define CAN_MSG_OBJ_FDF_FIELD_MASK (0x80U)

#define CAN_MSG_OBJ_FDF_POSN (0x7U)

#define CAN_MSG_OBJ_FRAME_TYPE_FIELD_MASK (0x20U)

#define CAN_MSG_OBJ_ID_TYPE_FIELD_MASK (0x10U)

#define CAN_MSG_OBJ_IDE_POSN (0x4U)

#define CAN_MSG_OBJ_RTR_POSN (0x5U)

#define CAN_MSG_OBJ_SID_HIGH_MASK (0x7U)

#define CAN_MSG_OBJ_SID_HIGH_WIDTH (0x3U)

#define CAN_MSG_OBJ_SID_LOW_MASK (0xFFU)

#define CAN_MSG_OBJ_SID_LOW_WIDTH (0x8U)

#define CAN_STD_MSG_ID_SIZE (CAN_MSG_OBJ_SID_LOW_WIDTH + CAN_MSG_OBJ_SID_HIGH_WIDTH)

void(* CAN1_BusErrorHandler) (void) = NULL[static]

void(* CAN1_BusWakeUpActivityHandler) (void) = NULL[static]

void(* CAN1_InvalidMessageHandler) (void) = NULL[static]

void(* CAN1_ModeChangeHandler) (void) = NULL[static]

void(* CAN1_RxBufferOverFlowHandler) (void) = NULL[static]

void(* CAN1_SystemErrorHandler) (void) = NULL[static]

void(* CAN1_TxAttemptHandler) (void) = NULL[static]

volatile struct CAN1_FIFOREG* const FIFO = (struct CAN1_FIFOREG *)&C1TXQCONL[static]

volatile struct CAN1_RX_FIFO_MSG rxFIFOMsg[CAN1_NUM_OF_RX_FIFO][static]

Initial value:

= 
{
    
    {CAN1_FIFO_2, 0U},
    {CAN1_FIFO_3, 0U},
}

uint8_t rxMsgData[CAN1_RX_FIFO_MSG_DATA][static]