Overview

This section describes the programming interface of the FlexCAN driver. The FlexCAN driver configures FlexCAN module and provides functional and transactional interfaces to build the FlexCAN application.

Typical use case

Message Buffer Send Operation

Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/flexcan

Message Buffer Receive Operation

Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/flexcan

Receive FIFO Operation

Refer to the driver examples codes located at <SDK_ROOT>/boards/<BOARD>/driver_examples/flexcan

Data Structures
struct	flexcan_memory_error_report_status_t
	FlexCAN memory error register status structure. More...

struct	flexcan_frame_t
	FlexCAN message frame structure. More...

struct	flexcan_fd_frame_t
	CAN FDmessage frame structure. More...

struct	flexcan_timing_config_t
	FlexCAN protocol timing characteristic configuration structure. More...

struct	flexcan_config_t
	FlexCAN module configuration structure. More...

struct	flexcan_rx_mb_config_t
	FlexCAN Receive Message Buffer configuration structure. More...

struct	flexcan_rx_fifo_config_t
	FlexCAN Rx FIFO configuration structure. More...

struct	flexcan_mb_transfer_t
	FlexCAN Message Buffer transfer. More...

struct	flexcan_fifo_transfer_t
	FlexCAN Rx FIFO transfer. More...

struct	flexcan_handle_t
	FlexCAN handle structure. More...

Macros
#define	FLEXCAN_ID_STD(id) (((uint32_t)(((uint32_t)(id)) << CAN_ID_STD_SHIFT)) & CAN_ID_STD_MASK)
	FlexCAN Frame ID helper macro. More...

#define	FLEXCAN_ID_EXT(id)
	Extend Frame ID helper macro. More...

#define	FLEXCAN_RX_MB_STD_MASK(id, rtr, ide)
	FlexCAN Rx Message Buffer Mask helper macro. More...

#define	FLEXCAN_RX_MB_EXT_MASK(id, rtr, ide)
	Extend Rx Message Buffer Mask helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_A(id, rtr, ide)
	FlexCAN Rx FIFO Mask helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_HIGH(id, rtr, ide)
	Standard Rx FIFO Mask helper macro Type B upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_LOW(id, rtr, ide)
	Standard Rx FIFO Mask helper macro Type B lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_HIGH(id) (((uint32_t)(id)&0x7F8) << 21)
	Standard Rx FIFO Mask helper macro Type C upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_HIGH(id) (((uint32_t)(id)&0x7F8) << 13)
	Standard Rx FIFO Mask helper macro Type C mid-upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_LOW(id) (((uint32_t)(id)&0x7F8) << 5)
	Standard Rx FIFO Mask helper macro Type C mid-lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_LOW(id) (((uint32_t)(id)&0x7F8) >> 3)
	Standard Rx FIFO Mask helper macro Type C lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_A(id, rtr, ide)
	Extend Rx FIFO Mask helper macro Type A helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_HIGH(id, rtr, ide)
	Extend Rx FIFO Mask helper macro Type B upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_LOW(id, rtr, ide)
	Extend Rx FIFO Mask helper macro Type B lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_HIGH(id) ((FLEXCAN_ID_EXT(id) & 0x1FE00000) << 3)
	Extend Rx FIFO Mask helper macro Type C upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_HIGH(id)
	Extend Rx FIFO Mask helper macro Type C mid-upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_LOW(id)
	Extend Rx FIFO Mask helper macro Type C mid-lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_LOW(id) ((FLEXCAN_ID_EXT(id) & 0x1FE00000) >> 21)
	Extend Rx FIFO Mask helper macro Type C lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_A(id, rtr, ide) FLEXCAN_RX_FIFO_STD_MASK_TYPE_A(id, rtr, ide)
	FlexCAN Rx FIFO Filter helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_B_HIGH(id, rtr, ide)
	Standard Rx FIFO Filter helper macro Type B upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_B_LOW(id, rtr, ide)
	Standard Rx FIFO Filter helper macro Type B lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_HIGH(id)
	Standard Rx FIFO Filter helper macro Type C upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_MID_HIGH(id)
	Standard Rx FIFO Filter helper macro Type C mid-upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_MID_LOW(id)
	Standard Rx FIFO Filter helper macro Type C mid-lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_LOW(id)
	Standard Rx FIFO Filter helper macro Type C lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_A(id, rtr, ide) FLEXCAN_RX_FIFO_EXT_MASK_TYPE_A(id, rtr, ide)
	Extend Rx FIFO Filter helper macro Type A helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_B_HIGH(id, rtr, ide)
	Extend Rx FIFO Filter helper macro Type B upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_B_LOW(id, rtr, ide)
	Extend Rx FIFO Filter helper macro Type B lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_HIGH(id)
	Extend Rx FIFO Filter helper macro Type C upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_MID_HIGH(id)
	Extend Rx FIFO Filter helper macro Type C mid-upper part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_MID_LOW(id)
	Extend Rx FIFO Filter helper macro Type C mid-lower part helper macro. More...

#define	FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_LOW(id) FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_LOW(id)
	Extend Rx FIFO Filter helper macro Type C lower part helper macro. More...

Typedefs
typedef void(*	flexcan_transfer_callback_t )(CAN_Type base, flexcan_handle_t handle, status_t status, uint32_t result, void *userData)
	FlexCAN transfer callback function. More...

Enumerations
enum	{ kStatus_FLEXCAN_TxBusy = MAKE_STATUS(kStatusGroup_FLEXCAN, 0), kStatus_FLEXCAN_TxIdle = MAKE_STATUS(kStatusGroup_FLEXCAN, 1), kStatus_FLEXCAN_TxSwitchToRx, kStatus_FLEXCAN_RxBusy = MAKE_STATUS(kStatusGroup_FLEXCAN, 3), kStatus_FLEXCAN_RxIdle = MAKE_STATUS(kStatusGroup_FLEXCAN, 4), kStatus_FLEXCAN_RxOverflow = MAKE_STATUS(kStatusGroup_FLEXCAN, 5), kStatus_FLEXCAN_RxFifoBusy = MAKE_STATUS(kStatusGroup_FLEXCAN, 6), kStatus_FLEXCAN_RxFifoIdle = MAKE_STATUS(kStatusGroup_FLEXCAN, 7), kStatus_FLEXCAN_RxFifoOverflow = MAKE_STATUS(kStatusGroup_FLEXCAN, 8), kStatus_FLEXCAN_RxFifoWarning = MAKE_STATUS(kStatusGroup_FLEXCAN, 9), kStatus_FLEXCAN_ErrorStatus = MAKE_STATUS(kStatusGroup_FLEXCAN, 10), kStatus_FLEXCAN_WakeUp = MAKE_STATUS(kStatusGroup_FLEXCAN, 11), kStatus_FLEXCAN_UnHandled = MAKE_STATUS(kStatusGroup_FLEXCAN, 12), kStatus_FLEXCAN_RxRemote = MAKE_STATUS(kStatusGroup_FLEXCAN, 13) }
	FlexCAN transfer status. More...

enum	flexcan_frame_format_t { kFLEXCAN_FrameFormatStandard = 0x0U, kFLEXCAN_FrameFormatExtend = 0x1U }
	FlexCAN frame format. More...

enum	flexcan_frame_type_t { kFLEXCAN_FrameTypeData = 0x0U, kFLEXCAN_FrameTypeRemote = 0x1U }
	FlexCAN frame type. More...

enum	flexcan_clock_source_t { kFLEXCAN_ClkSrcOsc = 0x0U, kFLEXCAN_ClkSrcPeri = 0x1U, kFLEXCAN_ClkSrc0 = 0x0U, kFLEXCAN_ClkSrc1 = 0x1U }
	FlexCAN clock source. More...

enum	flexcan_wake_up_source_t { kFLEXCAN_WakeupSrcUnfiltered = 0x0U, kFLEXCAN_WakeupSrcFiltered = 0x1U }
	FlexCAN wake up source. More...

enum	flexcan_rx_fifo_filter_type_t { kFLEXCAN_RxFifoFilterTypeA = 0x0U, kFLEXCAN_RxFifoFilterTypeB, kFLEXCAN_RxFifoFilterTypeC, kFLEXCAN_RxFifoFilterTypeD = 0x3U }
	FlexCAN Rx Fifo Filter type. More...

enum	flexcan_mb_size_t { kFLEXCAN_8BperMB = 0x0U, kFLEXCAN_16BperMB = 0x1U, kFLEXCAN_32BperMB = 0x2U, kFLEXCAN_64BperMB = 0x3U }
	FlexCAN Message Buffer Data Size. More...

enum	flexcan_rx_fifo_priority_t { kFLEXCAN_RxFifoPrioLow = 0x0U, kFLEXCAN_RxFifoPrioHigh = 0x1U }
	FlexCAN Rx FIFO priority. More...

enum	_flexcan_interrupt_enable { kFLEXCAN_BusOffInterruptEnable = CAN_CTRL1_BOFFMSK_MASK, kFLEXCAN_ErrorInterruptEnable = CAN_CTRL1_ERRMSK_MASK, kFLEXCAN_RxWarningInterruptEnable = CAN_CTRL1_RWRNMSK_MASK, kFLEXCAN_TxWarningInterruptEnable = CAN_CTRL1_TWRNMSK_MASK, kFLEXCAN_WakeUpInterruptEnable = CAN_MCR_WAKMSK_MASK }
	FlexCAN interrupt configuration structure, default settings all disabled. More...

enum	_flexcan_flags { kFLEXCAN_FDErrorIntFlag = CAN_ESR1_ERRINT_FAST_MASK, kFLEXCAN_BusoffDoneIntFlag = CAN_ESR1_BOFFDONEINT_MASK, kFLEXCAN_SynchFlag = CAN_ESR1_SYNCH_MASK, kFLEXCAN_TxWarningIntFlag = CAN_ESR1_TWRNINT_MASK, kFLEXCAN_RxWarningIntFlag = CAN_ESR1_RWRNINT_MASK, kFLEXCAN_TxErrorWarningFlag = CAN_ESR1_TXWRN_MASK, kFLEXCAN_RxErrorWarningFlag = CAN_ESR1_RXWRN_MASK, kFLEXCAN_IdleFlag = CAN_ESR1_IDLE_MASK, kFLEXCAN_FaultConfinementFlag = CAN_ESR1_FLTCONF_MASK, kFLEXCAN_TransmittingFlag = CAN_ESR1_TX_MASK, kFLEXCAN_ReceivingFlag = CAN_ESR1_RX_MASK, kFLEXCAN_BusOffIntFlag = CAN_ESR1_BOFFINT_MASK, kFLEXCAN_ErrorIntFlag = CAN_ESR1_ERRINT_MASK, kFLEXCAN_WakeUpIntFlag = CAN_ESR1_WAKINT_MASK }
	FlexCAN status flags. More...

enum	_flexcan_error_flags { kFLEXCAN_FDStuffingError = CAN_ESR1_STFERR_FAST_MASK, kFLEXCAN_FDFormError = CAN_ESR1_FRMERR_FAST_MASK, kFLEXCAN_FDCrcError = CAN_ESR1_CRCERR_FAST_MASK, kFLEXCAN_FDBit0Error = CAN_ESR1_BIT0ERR_FAST_MASK, kFLEXCAN_FDBit1Error = (int)CAN_ESR1_BIT1ERR_FAST_MASK, kFLEXCAN_OverrunError = CAN_ESR1_ERROVR_MASK, kFLEXCAN_StuffingError = CAN_ESR1_STFERR_MASK, kFLEXCAN_FormError = CAN_ESR1_FRMERR_MASK, kFLEXCAN_CrcError = CAN_ESR1_CRCERR_MASK, kFLEXCAN_AckError = CAN_ESR1_ACKERR_MASK, kFLEXCAN_Bit0Error = CAN_ESR1_BIT0ERR_MASK, kFLEXCAN_Bit1Error = CAN_ESR1_BIT1ERR_MASK }
	FlexCAN error status flags. More...

enum	{ kFLEXCAN_RxFifoOverflowFlag = CAN_IFLAG1_BUF7I_MASK, kFLEXCAN_RxFifoWarningFlag = CAN_IFLAG1_BUF6I_MASK, kFLEXCAN_RxFifoFrameAvlFlag = CAN_IFLAG1_BUF5I_MASK }
	FlexCAN Rx FIFO status flags. More...

enum	flexcan_memory_error_type_t { kFLEXCAN_CorrectableError = 0U, kFLEXCAN_NonCorrectableError }
	FlexCAN Memory Error Type. More...

enum	flexcan_memory_access_type_t { kFLEXCAN_MoveOutFlexCanAccess = 0U, kFLEXCAN_MoveInAccess, kFLEXCAN_TxArbitrationAccess, kFLEXCAN_RxMatchingAccess, kFLEXCAN_MoveOutHostAccess }
	FlexCAN Memory Access Type. More...

enum	flexcan_byte_error_syndrome_t { kFLEXCAN_NoError = 0U, kFLEXCAN_ParityBits0Error = 1U, kFLEXCAN_ParityBits1Error = 2U, kFLEXCAN_ParityBits2Error = 4U, kFLEXCAN_ParityBits3Error = 8U, kFLEXCAN_ParityBits4Error = 16U, kFLEXCAN_DataBits0Error = 28U, kFLEXCAN_DataBits1Error = 22U, kFLEXCAN_DataBits2Error = 19U, kFLEXCAN_DataBits3Error = 25U, kFLEXCAN_DataBits4Error = 26U, kFLEXCAN_DataBits5Error = 7U, kFLEXCAN_DataBits6Error = 21U, kFLEXCAN_DataBits7Error = 14U, kFLEXCAN_AllZeroError = 6U, kFLEXCAN_AllOneError = 31U, kFLEXCAN_NonCorrectableErrors }
	FlexCAN Memory Error Byte Syndrome. More...

enum	_flexcan_memory_error_interrupt_enable { kFLEXCAN_HostAccessNonCorrectableErrorIntEnable = CAN_MECR_HANCEI_MSK_MASK, kFLEXCAN_FlexCanAccessNonCorrectableErrorIntEnable = CAN_MECR_FANCEI_MSK_MASK }
	FlexCAN memory error interrupt enable enumerations. More...

enum	_flexcan_memory_error_flags { kFLEXCAN_HostAccessNonCorrectableErrorFlag = CAN_ERRSR_HANCEIF_MASK, kFLEXCAN_FlexCanAccessNonCorrectableErrorFlag = CAN_ERRSR_FANCEIF_MASK, kFLEXCAN_CorrectableErrorFlag = CAN_ERRSR_CEIF_MASK, kFLEXCAN_HostAccessNonCorrectableErrorOverrunFlag = CAN_ERRSR_HANCEIOF_MASK, kFLEXCAN_FlexCanAccessNonCorrectableErrorOverrunFlag = CAN_ERRSR_FANCEIOF_MASK, kFLEXCAN_CorrectableErrorOverrunFlag = CAN_ERRSR_CEIOF_MASK }
	FlexCAN memory error status flags. More...

Driver version
#define	FSL_FLEXCAN_DRIVER_VERSION (MAKE_VERSION(2, 6, 1))
	FlexCAN driver version. More...

Initialization and deinitialization
void	FLEXCAN_EnterFreezeMode (CAN_Type *base)
	Enter FlexCAN Freeze Mode. More...

void	FLEXCAN_ExitFreezeMode (CAN_Type *base)
	Exit FlexCAN Freeze Mode. More...

uint32_t	FLEXCAN_GetInstance (CAN_Type *base)
	Get the FlexCAN instance from peripheral base address. More...

bool	FLEXCAN_CalculateImprovedTimingValues (uint32_t baudRate, uint32_t sourceClock_Hz, flexcan_timing_config_t *pTimingConfig)
	Calculates the improved timing values by specific baudrates for classical CAN. More...

void	FLEXCAN_Init (CAN_Type base, const flexcan_config_t pConfig, uint32_t sourceClock_Hz)
	Initializes a FlexCAN instance. More...

bool	FLEXCAN_FDCalculateImprovedTimingValues (uint32_t baudRate, uint32_t baudRateFD, uint32_t sourceClock_Hz, flexcan_timing_config_t *pTimingConfig)
	Calculates the improved timing values by specific baudrates for CANFD. More...

void	FLEXCAN_FDInit (CAN_Type base, const flexcan_config_t pConfig, uint32_t sourceClock_Hz, flexcan_mb_size_t dataSize, bool brs)
	Initializes a FlexCAN instance. More...

void	FLEXCAN_Deinit (CAN_Type *base)
	De-initializes a FlexCAN instance. More...

void	FLEXCAN_GetDefaultConfig (flexcan_config_t *pConfig)
	Gets the default configuration structure. More...

Configuration.
void	FLEXCAN_SetTimingConfig (CAN_Type base, const flexcan_timing_config_t pConfig)
	Sets the FlexCAN protocol timing characteristic. More...

void	FLEXCAN_SetFDTimingConfig (CAN_Type base, const flexcan_timing_config_t pConfig)
	Sets the FlexCAN FD protocol timing characteristic. More...

void	FLEXCAN_SetRxMbGlobalMask (CAN_Type *base, uint32_t mask)
	Sets the FlexCAN receive message buffer global mask. More...

void	FLEXCAN_SetRxFifoGlobalMask (CAN_Type *base, uint32_t mask)
	Sets the FlexCAN receive FIFO global mask. More...

void	FLEXCAN_SetRxIndividualMask (CAN_Type *base, uint8_t maskIdx, uint32_t mask)
	Sets the FlexCAN receive individual mask. More...

void	FLEXCAN_SetTxMbConfig (CAN_Type *base, uint8_t mbIdx, bool enable)
	Configures a FlexCAN transmit message buffer. More...

void	FLEXCAN_SetFDTxMbConfig (CAN_Type *base, uint8_t mbIdx, bool enable)
	Configures a FlexCAN transmit message buffer. More...

void	FLEXCAN_SetRxMbConfig (CAN_Type base, uint8_t mbIdx, const flexcan_rx_mb_config_t pRxMbConfig, bool enable)
	Configures a FlexCAN Receive Message Buffer. More...

void	FLEXCAN_SetFDRxMbConfig (CAN_Type base, uint8_t mbIdx, const flexcan_rx_mb_config_t pRxMbConfig, bool enable)
	Configures a FlexCAN Receive Message Buffer. More...

void	FLEXCAN_SetRxFifoConfig (CAN_Type base, const flexcan_rx_fifo_config_t pRxFifoConfig, bool enable)
	Configures the FlexCAN Rx FIFO. More...

Status
static uint32_t	FLEXCAN_GetStatusFlags (CAN_Type *base)
	Gets the FlexCAN module interrupt flags. More...

static void	FLEXCAN_ClearStatusFlags (CAN_Type *base, uint32_t mask)
	Clears status flags with the provided mask. More...

static void	FLEXCAN_GetBusErrCount (CAN_Type base, uint8_t txErrBuf, uint8_t *rxErrBuf)
	Gets the FlexCAN Bus Error Counter value. More...

static uint64_t	FLEXCAN_GetMbStatusFlags (CAN_Type *base, uint64_t mask)
	Gets the FlexCAN Message Buffer interrupt flags. More...

static void	FLEXCAN_ClearMbStatusFlags (CAN_Type *base, uint64_t mask)
	Clears the FlexCAN Message Buffer interrupt flags. More...

void	FLEXCAN_GetMemoryErrorReportStatus (CAN_Type base, flexcan_memory_error_report_status_t errorStatus)
	Gets the FlexCAN Memory Error Report registers status. More...

static uint32_t	FLEXCAN_GetMemoryErrorStatusFlags (CAN_Type *base)
	Gets the FlexCAN memory error status flags. More...

static void	FLEXCAN_ClearMemoryErrorStatusFlags (CAN_Type *base, uint32_t mask)
	Clears the FlexCAN memory error status flags with the provided mask. More...

Interrupts
static void	FLEXCAN_EnableInterrupts (CAN_Type *base, uint32_t mask)
	Enables FlexCAN interrupts according to the provided mask. More...

static void	FLEXCAN_DisableInterrupts (CAN_Type *base, uint32_t mask)
	Disables FlexCAN interrupts according to the provided mask. More...

static void	FLEXCAN_EnableMbInterrupts (CAN_Type *base, uint64_t mask)
	Enables FlexCAN Message Buffer interrupts. More...

static void	FLEXCAN_DisableMbInterrupts (CAN_Type *base, uint64_t mask)
	Disables FlexCAN Message Buffer interrupts. More...

static void	FLEXCAN_EnableMemoryErrorInterrupts (CAN_Type *base, uint32_t mask)
	Enables FlexCAN memory error interrupts according to the provided mask. More...

static void	FLEXCAN_DisableMemoryErrorInterrupts (CAN_Type *base, uint32_t mask)
	Disables FlexCAN memory error interrupts according to the provided mask. More...

DMA Control
void	FLEXCAN_EnableRxFifoDMA (CAN_Type *base, bool enable)
	Enables or disables the FlexCAN Rx FIFO DMA request. More...

static uint32_t	FLEXCAN_GetRxFifoHeadAddr (CAN_Type *base)
	Gets the Rx FIFO Head address. More...

Bus Operations
static void	FLEXCAN_Enable (CAN_Type *base, bool enable)
	Enables or disables the FlexCAN module operation. More...

status_t	FLEXCAN_WriteTxMb (CAN_Type base, uint8_t mbIdx, const flexcan_frame_t pTxFrame)
	Writes a FlexCAN Message to the Transmit Message Buffer. More...

status_t	FLEXCAN_ReadRxMb (CAN_Type base, uint8_t mbIdx, flexcan_frame_t pRxFrame)
	Reads a FlexCAN Message from Receive Message Buffer. More...

status_t	FLEXCAN_WriteFDTxMb (CAN_Type base, uint8_t mbIdx, const flexcan_fd_frame_t pTxFrame)
	Writes a FlexCAN FD Message to the Transmit Message Buffer. More...

status_t	FLEXCAN_ReadFDRxMb (CAN_Type base, uint8_t mbIdx, flexcan_fd_frame_t pRxFrame)
	Reads a FlexCAN FD Message from Receive Message Buffer. More...

status_t	FLEXCAN_ReadRxFifo (CAN_Type base, flexcan_frame_t pRxFrame)
	Reads a FlexCAN Message from Rx FIFO. More...

Transactional
status_t	FLEXCAN_TransferFDSendBlocking (CAN_Type base, uint8_t mbIdx, flexcan_fd_frame_t pTxFrame)
	Performs a polling send transaction on the CAN bus. More...

status_t	FLEXCAN_TransferFDReceiveBlocking (CAN_Type base, uint8_t mbIdx, flexcan_fd_frame_t pRxFrame)
	Performs a polling receive transaction on the CAN bus. More...

status_t	FLEXCAN_TransferFDSendNonBlocking (CAN_Type base, flexcan_handle_t handle, flexcan_mb_transfer_t *pMbXfer)
	Sends a message using IRQ. More...

status_t	FLEXCAN_TransferFDReceiveNonBlocking (CAN_Type base, flexcan_handle_t handle, flexcan_mb_transfer_t *pMbXfer)
	Receives a message using IRQ. More...

void	FLEXCAN_TransferFDAbortSend (CAN_Type base, flexcan_handle_t handle, uint8_t mbIdx)
	Aborts the interrupt driven message send process. More...

void	FLEXCAN_TransferFDAbortReceive (CAN_Type base, flexcan_handle_t handle, uint8_t mbIdx)
	Aborts the interrupt driven message receive process. More...

status_t	FLEXCAN_TransferSendBlocking (CAN_Type base, uint8_t mbIdx, flexcan_frame_t pTxFrame)
	Performs a polling send transaction on the CAN bus. More...

status_t	FLEXCAN_TransferReceiveBlocking (CAN_Type base, uint8_t mbIdx, flexcan_frame_t pRxFrame)
	Performs a polling receive transaction on the CAN bus. More...

status_t	FLEXCAN_TransferReceiveFifoBlocking (CAN_Type base, flexcan_frame_t pRxFrame)
	Performs a polling receive transaction from Rx FIFO on the CAN bus. More...

void	FLEXCAN_TransferCreateHandle (CAN_Type base, flexcan_handle_t handle, flexcan_transfer_callback_t callback, void *userData)
	Initializes the FlexCAN handle. More...

status_t	FLEXCAN_TransferSendNonBlocking (CAN_Type base, flexcan_handle_t handle, flexcan_mb_transfer_t *pMbXfer)
	Sends a message using IRQ. More...

status_t	FLEXCAN_TransferReceiveNonBlocking (CAN_Type base, flexcan_handle_t handle, flexcan_mb_transfer_t *pMbXfer)
	Receives a message using IRQ. More...

status_t	FLEXCAN_TransferReceiveFifoNonBlocking (CAN_Type base, flexcan_handle_t handle, flexcan_fifo_transfer_t *pFifoXfer)
	Receives a message from Rx FIFO using IRQ. More...

uint32_t	FLEXCAN_GetTimeStamp (flexcan_handle_t *handle, uint8_t mbIdx)
	Gets the detail index of Mailbox's Timestamp by handle. More...

void	FLEXCAN_TransferAbortSend (CAN_Type base, flexcan_handle_t handle, uint8_t mbIdx)
	Aborts the interrupt driven message send process. More...

void	FLEXCAN_TransferAbortReceive (CAN_Type base, flexcan_handle_t handle, uint8_t mbIdx)
	Aborts the interrupt driven message receive process. More...

void	FLEXCAN_TransferAbortReceiveFifo (CAN_Type base, flexcan_handle_t handle)
	Aborts the interrupt driven message receive from Rx FIFO process. More...

void	FLEXCAN_TransferHandleIRQ (CAN_Type base, flexcan_handle_t handle)
	FlexCAN IRQ handle function. More...

Data Structure Documentation

struct flexcan_memory_error_report_status_t

This structure contains the memory access properties that caused a memory error access. It is used as the parameter of FLEXCAN_GetMemoryErrorReportStatus() function. And user can use FLEXCAN_GetMemoryErrorReportStatus to get the status of the last memory error access.

Data Fields
flexcan_memory_error_type_t	errorType
	The type of memory error that giving rise to the report. More...

flexcan_memory_access_type_t	accessType
	The type of memory access that giving rise to the memory error. More...

uint16_t	accessAddress
	The address where memory error detected. More...

uint32_t	errorData
	The raw data word read from memory with error. More...

bool	byteIsRead
	The byte n (0~3) was read or not. More...

Field Documentation

flexcan_memory_error_type_t flexcan_memory_error_report_status_t::errorType

flexcan_memory_access_type_t flexcan_memory_error_report_status_t::accessType

uint16_t flexcan_memory_error_report_status_t::accessAddress

uint32_t flexcan_memory_error_report_status_t::errorData

bool flexcan_memory_error_report_status_t::byteIsRead

The type of error and which bit in byte (n) is affected by the error.

struct flexcan_frame_t

Field Documentation

uint32_t flexcan_frame_t::timestamp

uint32_t flexcan_frame_t::length

uint32_t flexcan_frame_t::type

uint32_t flexcan_frame_t::format

uint32_t flexcan_frame_t::__pad0__

uint32_t flexcan_frame_t::idhit

uint32_t flexcan_frame_t::id

uint32_t flexcan_frame_t::dataWord0

uint32_t flexcan_frame_t::dataWord1

uint8_t flexcan_frame_t::dataByte3

uint8_t flexcan_frame_t::dataByte2

uint8_t flexcan_frame_t::dataByte1

uint8_t flexcan_frame_t::dataByte0

uint8_t flexcan_frame_t::dataByte7

uint8_t flexcan_frame_t::dataByte6

uint8_t flexcan_frame_t::dataByte5

uint8_t flexcan_frame_t::dataByte4

struct flexcan_fd_frame_t

Field Documentation

uint32_t flexcan_fd_frame_t::timestamp

uint32_t flexcan_fd_frame_t::length

uint32_t flexcan_fd_frame_t::type

uint32_t flexcan_fd_frame_t::format

uint32_t flexcan_fd_frame_t::srr

uint32_t flexcan_fd_frame_t::__pad0__

uint32_t flexcan_fd_frame_t::code

uint32_t flexcan_fd_frame_t::esi

uint32_t flexcan_fd_frame_t::brs

uint32_t flexcan_fd_frame_t::edl

uint32_t flexcan_fd_frame_t::id

uint32_t flexcan_fd_frame_t::dataWord[16]

uint8_t flexcan_fd_frame_t::dataByte3

uint8_t flexcan_fd_frame_t::dataByte2

uint8_t flexcan_fd_frame_t::dataByte1

uint8_t flexcan_fd_frame_t::dataByte0

uint8_t flexcan_fd_frame_t::dataByte7

uint8_t flexcan_fd_frame_t::dataByte6

uint8_t flexcan_fd_frame_t::dataByte5

uint8_t flexcan_fd_frame_t::dataByte4

struct flexcan_timing_config_t

Data Fields
uint16_t	preDivider
	Clock Pre-scaler Division Factor. More...

uint8_t	rJumpwidth
	Re-sync Jump Width. More...

uint8_t	phaseSeg1
	Phase Segment 1. More...

uint8_t	phaseSeg2
	Phase Segment 2. More...

uint8_t	propSeg
	Propagation Segment. More...

uint16_t	fpreDivider
	Fast Clock Pre-scaler Division Factor. More...

uint8_t	frJumpwidth
	Fast Re-sync Jump Width. More...

uint8_t	fphaseSeg1
	Fast Phase Segment 1. More...

uint8_t	fphaseSeg2
	Fast Phase Segment 2. More...

uint8_t	fpropSeg
	Fast Propagation Segment. More...

Field Documentation

uint16_t flexcan_timing_config_t::preDivider

uint8_t flexcan_timing_config_t::rJumpwidth

uint8_t flexcan_timing_config_t::phaseSeg1

uint8_t flexcan_timing_config_t::phaseSeg2

uint8_t flexcan_timing_config_t::propSeg

uint16_t flexcan_timing_config_t::fpreDivider

uint8_t flexcan_timing_config_t::frJumpwidth

uint8_t flexcan_timing_config_t::fphaseSeg1

uint8_t flexcan_timing_config_t::fphaseSeg2

uint8_t flexcan_timing_config_t::fpropSeg

struct flexcan_config_t

Data Fields
uint32_t	baudRate
	FlexCAN baud rate in bps. More...

uint32_t	baudRateFD
	FlexCAN FD baud rate in bps. More...

flexcan_clock_source_t	clkSrc
	Clock source for FlexCAN Protocol Engine. More...

flexcan_wake_up_source_t	wakeupSrc
	Wake up source selection. More...

uint8_t	maxMbNum
	The maximum number of Message Buffers used by user. More...

bool	enableLoopBack
	Enable or Disable Loop Back Self Test Mode. More...

bool	enableTimerSync
	Enable or Disable Timer Synchronization. More...

bool	enableSelfWakeup
	Enable or Disable Self Wakeup Mode. More...

bool	enableIndividMask
	Enable or Disable Rx Individual Mask. More...

bool	disableSelfReception
	Enable or Disable Self Reflection. More...

bool	enableListenOnlyMode
	Enable or Disable Listen Only Mode. More...

bool	enableDoze
	Enable or Disable Doze Mode. More...

bool	enableMemoryErrorControl
	Enable or Disable the memory errors detection and correction mechanism. More...

bool	enableNonCorrectableErrorEnterFreeze
	Enable or Disable Non-Correctable Errors In FlexCAN Access Put Device In Freeze Mode. More...

Field Documentation

uint32_t flexcan_config_t::baudRate

uint32_t flexcan_config_t::baudRateFD

flexcan_clock_source_t flexcan_config_t::clkSrc

flexcan_wake_up_source_t flexcan_config_t::wakeupSrc

uint8_t flexcan_config_t::maxMbNum

bool flexcan_config_t::enableLoopBack

bool flexcan_config_t::enableTimerSync

bool flexcan_config_t::enableSelfWakeup

bool flexcan_config_t::enableIndividMask

bool flexcan_config_t::disableSelfReception

bool flexcan_config_t::enableListenOnlyMode

bool flexcan_config_t::enableDoze

bool flexcan_config_t::enableMemoryErrorControl

bool flexcan_config_t::enableNonCorrectableErrorEnterFreeze

struct flexcan_rx_mb_config_t

This structure is used as the parameter of FLEXCAN_SetRxMbConfig() function. The FLEXCAN_SetRxMbConfig() function is used to configure FlexCAN Receive Message Buffer. The function abort previous receiving process, clean the Message Buffer and activate the Rx Message Buffer using given Message Buffer setting.

Data Fields
uint32_t	id
	CAN Message Buffer Frame Identifier, should be set using FLEXCAN_ID_EXT() or FLEXCAN_ID_STD() macro. More...

flexcan_frame_format_t	format
	CAN Frame Identifier format(Standard of Extend). More...

flexcan_frame_type_t	type
	CAN Frame Type(Data or Remote). More...

Field Documentation

uint32_t flexcan_rx_mb_config_t::id

flexcan_frame_format_t flexcan_rx_mb_config_t::format

flexcan_frame_type_t flexcan_rx_mb_config_t::type

struct flexcan_rx_fifo_config_t

Data Fields
uint32_t *	idFilterTable
	Pointer to the FlexCAN Rx FIFO identifier filter table. More...

uint8_t	idFilterNum
	The quantity of filter elements. More...

flexcan_rx_fifo_filter_type_t	idFilterType
	The FlexCAN Rx FIFO Filter type. More...

flexcan_rx_fifo_priority_t	priority
	The FlexCAN Rx FIFO receive priority. More...

Field Documentation

uint32_t* flexcan_rx_fifo_config_t::idFilterTable

uint8_t flexcan_rx_fifo_config_t::idFilterNum

flexcan_rx_fifo_filter_type_t flexcan_rx_fifo_config_t::idFilterType

flexcan_rx_fifo_priority_t flexcan_rx_fifo_config_t::priority

struct flexcan_mb_transfer_t

Data Fields
flexcan_frame_t *	frame
	The buffer of CAN Message to be transfer. More...

uint8_t	mbIdx
	The index of Message buffer used to transfer Message. More...

Field Documentation

flexcan_frame_t* flexcan_mb_transfer_t::frame

uint8_t flexcan_mb_transfer_t::mbIdx

struct flexcan_fifo_transfer_t

Data Fields
flexcan_frame_t *	frame
	The buffer of CAN Message to be received from Rx FIFO. More...

Field Documentation

flexcan_frame_t* flexcan_fifo_transfer_t::frame

struct _flexcan_handle

FlexCAN handle structure definition.

Data Fields
flexcan_transfer_callback_t	callback
	Callback function. More...

void *	userData
	FlexCAN callback function parameter. More...

flexcan_fd_frame_t *volatile	mbFDFrameBuf [CAN_WORD1_COUNT]
	The buffer for received data from Message Buffers. More...

flexcan_frame_t *volatile	rxFifoFrameBuf
	The buffer for received data from Rx FIFO. More...

volatile uint8_t	mbState [CAN_WORD1_COUNT]
	Message Buffer transfer state. More...

volatile uint8_t	rxFifoState
	Rx FIFO transfer state. More...

volatile uint32_t	timestamp [CAN_WORD1_COUNT]
	Mailbox transfer timestamp. More...

Field Documentation

flexcan_transfer_callback_t flexcan_handle_t::callback

void* flexcan_handle_t::userData

flexcan_fd_frame_t* volatile flexcan_handle_t::mbFDFrameBuf[CAN_WORD1_COUNT]

flexcan_frame_t* volatile flexcan_handle_t::rxFifoFrameBuf

volatile uint8_t flexcan_handle_t::mbState[CAN_WORD1_COUNT]

volatile uint8_t flexcan_handle_t::rxFifoState

volatile uint32_t flexcan_handle_t::timestamp[CAN_WORD1_COUNT]

Macro Definition Documentation

#define FSL_FLEXCAN_DRIVER_VERSION (MAKE_VERSION(2, 6, 1))

#define FLEXCAN_ID_STD ( id ) (((uint32_t)(((uint32_t)(id)) << CAN_ID_STD_SHIFT)) & CAN_ID_STD_MASK)

Standard Frame ID helper macro.

#define FLEXCAN_ID_EXT ( id )

Value:

(((uint32_t)(((uint32_t)(id)) << CAN_ID_EXT_SHIFT)) & \

(CAN_ID_EXT_MASK | CAN_ID_STD_MASK))

#define FLEXCAN_RX_MB_STD_MASK	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \

FLEXCAN_ID_STD(id))

FLEXCAN_ID_STD

#define FLEXCAN_ID_STD(id)

FlexCAN Frame ID helper macro.

Definition: fsl_flexcan.h:34

Standard Rx Message Buffer Mask helper macro.

#define FLEXCAN_RX_MB_EXT_MASK	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \

FLEXCAN_ID_EXT(id))

FLEXCAN_ID_EXT

#define FLEXCAN_ID_EXT(id)

Extend Frame ID helper macro.

Definition: fsl_flexcan.h:37

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_A	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \

(FLEXCAN_ID_STD(id) << 1))

FLEXCAN_ID_STD

#define FLEXCAN_ID_STD(id)

FlexCAN Frame ID helper macro.

Definition: fsl_flexcan.h:34

Standard Rx FIFO Mask helper macro Type A helper macro.

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_HIGH	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \

(((uint32_t)(id)&0x7FF) << 19))

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_LOW	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 15) | (uint32_t)((uint32_t)(ide) << 14)) | \

(((uint32_t)(id)&0x7FF) << 3))

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_HIGH ( id ) (((uint32_t)(id)&0x7F8) << 21)

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_HIGH ( id ) (((uint32_t)(id)&0x7F8) << 13)

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_LOW ( id ) (((uint32_t)(id)&0x7F8) << 5)

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_LOW ( id ) (((uint32_t)(id)&0x7F8) >> 3)

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_A	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \

(FLEXCAN_ID_EXT(id) << 1))

FLEXCAN_ID_EXT

#define FLEXCAN_ID_EXT(id)

Extend Frame ID helper macro.

Definition: fsl_flexcan.h:37

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_HIGH	(	id,
		rtr,
		ide
	)

Value:

(                                                                             \
        ((uint32_t)((uint32_t)(rtr) << 31) | (uint32_t)((uint32_t)(ide) << 30)) | \
        ((FLEXCAN_ID_EXT(id) & 0x1FFF8000)                                        \
         << 1))

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_LOW	(	id,
		rtr,
		ide
	)

Value:

(((uint32_t)((uint32_t)(rtr) << 15) | (uint32_t)((uint32_t)(ide) << 14)) | \
     ((FLEXCAN_ID_EXT(id) & 0x1FFF8000) >>                                     \
      15))

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_HIGH ( id ) ((FLEXCAN_ID_EXT(id) & 0x1FE00000) << 3)

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_HIGH ( id )

Value:

((FLEXCAN_ID_EXT(id) & 0x1FE00000) >> \

5)

FLEXCAN_ID_EXT

#define FLEXCAN_ID_EXT(id)

Extend Frame ID helper macro.

Definition: fsl_flexcan.h:37

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_LOW ( id )

Value:

((FLEXCAN_ID_EXT(id) & 0x1FE00000) >> \

13)

FLEXCAN_ID_EXT

#define FLEXCAN_ID_EXT(id)

Extend Frame ID helper macro.

Definition: fsl_flexcan.h:37

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_LOW ( id ) ((FLEXCAN_ID_EXT(id) & 0x1FE00000) >> 21)

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_A	(	id,
		rtr,
		ide
	)	FLEXCAN_RX_FIFO_STD_MASK_TYPE_A(id, rtr, ide)

Standard Rx FIFO Filter helper macro Type A helper macro.

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_B_HIGH	(	id,
		rtr,
		ide
	)

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_HIGH( \

id, rtr, ide)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_HIGH

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_HIGH(id, rtr, ide)

Standard Rx FIFO Mask helper macro Type B upper part helper macro.

Definition: fsl_flexcan.h:61

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_B_LOW	(	id,
		rtr,
		ide
	)

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_LOW( \

id, rtr, ide)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_LOW

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_B_LOW(id, rtr, ide)

Standard Rx FIFO Mask helper macro Type B lower part helper macro.

Definition: fsl_flexcan.h:66

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_HIGH ( id )

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_HIGH( \

id)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_HIGH

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_HIGH(id)

Standard Rx FIFO Mask helper macro Type C upper part helper macro.

Definition: fsl_flexcan.h:71

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_MID_HIGH ( id )

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_HIGH( \

id)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_HIGH

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_HIGH(id)

Standard Rx FIFO Mask helper macro Type C mid-upper part helper macro.

Definition: fsl_flexcan.h:74

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_MID_LOW ( id )

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_LOW( \

id)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_LOW

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_MID_LOW(id)

Standard Rx FIFO Mask helper macro Type C mid-lower part helper macro.

Definition: fsl_flexcan.h:77

#define FLEXCAN_RX_FIFO_STD_FILTER_TYPE_C_LOW ( id )

Value:

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_LOW( \

id)

FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_LOW

#define FLEXCAN_RX_FIFO_STD_MASK_TYPE_C_LOW(id)

Standard Rx FIFO Mask helper macro Type C lower part helper macro.

Definition: fsl_flexcan.h:80

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_A	(	id,
		rtr,
		ide
	)	FLEXCAN_RX_FIFO_EXT_MASK_TYPE_A(id, rtr, ide)

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_B_HIGH	(	id,
		rtr,
		ide
	)

Value:

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_HIGH( \

id, rtr, ide)

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_HIGH

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_HIGH(id, rtr, ide)

Extend Rx FIFO Mask helper macro Type B upper part helper macro.

Definition: fsl_flexcan.h:88

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_B_LOW	(	id,
		rtr,
		ide
	)

Value:

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_LOW( \

id, rtr, ide)

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_LOW

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_B_LOW(id, rtr, ide)

Extend Rx FIFO Mask helper macro Type B lower part helper macro.

Definition: fsl_flexcan.h:97

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_HIGH ( id )

Value:

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_HIGH( \

id)

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_HIGH

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_HIGH(id)

Extend Rx FIFO Mask helper macro Type C upper part helper macro.

Definition: fsl_flexcan.h:104

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_MID_HIGH ( id )

Value:

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_HIGH( \

id)

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_HIGH

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_HIGH(id)

Extend Rx FIFO Mask helper macro Type C mid-upper part helper macro.

Definition: fsl_flexcan.h:107

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_MID_LOW ( id )

Value:

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_LOW( \

id)

FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_LOW

#define FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_MID_LOW(id)

Extend Rx FIFO Mask helper macro Type C mid-lower part helper macro.

Definition: fsl_flexcan.h:112

#define FLEXCAN_RX_FIFO_EXT_FILTER_TYPE_C_LOW ( id ) FLEXCAN_RX_FIFO_EXT_MASK_TYPE_C_LOW(id)

Typedef Documentation

typedef void(* flexcan_transfer_callback_t)(CAN_Type *base, flexcan_handle_t *handle, status_t status, uint32_t result, void *userData)

The FlexCAN transfer callback returns a value from the underlying layer. If the status equals to kStatus_FLEXCAN_ErrorStatus, the result parameter is the Content of FlexCAN status register which can be used to get the working status(or error status) of FlexCAN module. If the status equals to other FlexCAN Message Buffer transfer status, the result is the index of Message Buffer that generate transfer event. If the status equals to other FlexCAN Message Buffer transfer status, the result is meaningless and should be Ignored.

Enumeration Type Documentation

anonymous enum

Enumerator
kStatus_FLEXCAN_TxBusy	Tx Message Buffer is Busy.
kStatus_FLEXCAN_TxIdle	Tx Message Buffer is Idle.
kStatus_FLEXCAN_TxSwitchToRx	Remote Message is send out and Message buffer changed to Receive one.
kStatus_FLEXCAN_RxBusy	Rx Message Buffer is Busy.
kStatus_FLEXCAN_RxIdle	Rx Message Buffer is Idle.
kStatus_FLEXCAN_RxOverflow	Rx Message Buffer is Overflowed.
kStatus_FLEXCAN_RxFifoBusy	Rx Message FIFO is Busy.
kStatus_FLEXCAN_RxFifoIdle	Rx Message FIFO is Idle.
kStatus_FLEXCAN_RxFifoOverflow	Rx Message FIFO is overflowed.
kStatus_FLEXCAN_RxFifoWarning	Rx Message FIFO is almost overflowed.
kStatus_FLEXCAN_ErrorStatus	FlexCAN Module Error and Status.
kStatus_FLEXCAN_WakeUp	FlexCAN is waken up from STOP mode.
kStatus_FLEXCAN_UnHandled	UnHadled Interrupt asserted.
kStatus_FLEXCAN_RxRemote	Rx Remote Message Received in Mail box.

enum flexcan_frame_format_t

Enumerator
kFLEXCAN_FrameFormatStandard	Standard frame format attribute.
kFLEXCAN_FrameFormatExtend	Extend frame format attribute.

enum flexcan_frame_type_t

Enumerator
kFLEXCAN_FrameTypeData	Data frame type attribute.
kFLEXCAN_FrameTypeRemote	Remote frame type attribute.

enum flexcan_clock_source_t

Deprecated:

Do not use the kFLEXCAN_ClkSrcOs. It has been superceded kFLEXCAN_ClkSrc0

Do not use the kFLEXCAN_ClkSrcPeri. It has been superceded kFLEXCAN_ClkSrc1

Enumerator
kFLEXCAN_ClkSrcOsc	FlexCAN Protocol Engine clock from Oscillator.
kFLEXCAN_ClkSrcPeri	FlexCAN Protocol Engine clock from Peripheral Clock.
kFLEXCAN_ClkSrc0	FlexCAN Protocol Engine clock selected by user as SRC == 0.
kFLEXCAN_ClkSrc1	FlexCAN Protocol Engine clock selected by user as SRC == 1.

enum flexcan_wake_up_source_t

Enumerator
kFLEXCAN_WakeupSrcUnfiltered	FlexCAN uses unfiltered Rx input to detect edge.
kFLEXCAN_WakeupSrcFiltered	FlexCAN uses filtered Rx input to detect edge.

enum flexcan_rx_fifo_filter_type_t

Enumerator
kFLEXCAN_RxFifoFilterTypeA	One full ID (standard and extended) per ID Filter element.
kFLEXCAN_RxFifoFilterTypeB	Two full standard IDs or two partial 14-bit ID slices per ID Filter Table element.
kFLEXCAN_RxFifoFilterTypeC	Four partial 8-bit Standard or extended ID slices per ID Filter Table element.
kFLEXCAN_RxFifoFilterTypeD	All frames rejected.

enum flexcan_mb_size_t

Enumerator
kFLEXCAN_8BperMB	Selects 8 bytes per Message Buffer.
kFLEXCAN_16BperMB	Selects 16 bytes per Message Buffer.
kFLEXCAN_32BperMB	Selects 32 bytes per Message Buffer.
kFLEXCAN_64BperMB	Selects 64 bytes per Message Buffer.

enum flexcan_rx_fifo_priority_t

The matching process starts from the Rx MB(or Rx FIFO) with higher priority. If no MB(or Rx FIFO filter) is satisfied, the matching process goes on with the Rx FIFO(or Rx MB) with lower priority.

Enumerator
kFLEXCAN_RxFifoPrioLow	Matching process start from Rx Message Buffer first.
kFLEXCAN_RxFifoPrioHigh	Matching process start from Rx FIFO first.

enum _flexcan_interrupt_enable

This structure contains the settings for all of the FlexCAN Module interrupt configurations. Note: FlexCAN Message Buffers and Rx FIFO have their own interrupts.

Enumerator
kFLEXCAN_BusOffInterruptEnable	Bus Off interrupt.
kFLEXCAN_ErrorInterruptEnable	Error interrupt.
kFLEXCAN_RxWarningInterruptEnable	Rx Warning interrupt.
kFLEXCAN_TxWarningInterruptEnable	Tx Warning interrupt.
kFLEXCAN_WakeUpInterruptEnable	Wake Up interrupt.

enum _flexcan_flags

This provides constants for the FlexCAN status flags for use in the FlexCAN functions. Note: The CPU read action clears FlEXCAN_ErrorFlag, therefore user need to read FlEXCAN_ErrorFlag and distinguish which error is occur using _flexcan_error_flags enumerations.

Enumerator
kFLEXCAN_FDErrorIntFlag	Error Overrun Status.
kFLEXCAN_BusoffDoneIntFlag	Error Overrun Status.
kFLEXCAN_SynchFlag	CAN Synchronization Status.
kFLEXCAN_TxWarningIntFlag	Tx Warning Interrupt Flag.
kFLEXCAN_RxWarningIntFlag	Rx Warning Interrupt Flag.
kFLEXCAN_TxErrorWarningFlag	Tx Error Warning Status.
kFLEXCAN_RxErrorWarningFlag	Rx Error Warning Status.
kFLEXCAN_IdleFlag	CAN IDLE Status Flag.
kFLEXCAN_FaultConfinementFlag	Fault Confinement State Flag.
kFLEXCAN_TransmittingFlag	FlexCAN In Transmission Status.
kFLEXCAN_ReceivingFlag	FlexCAN In Reception Status.
kFLEXCAN_BusOffIntFlag	Bus Off Interrupt Flag.
kFLEXCAN_ErrorIntFlag	Error Interrupt Flag.
kFLEXCAN_WakeUpIntFlag	Wake-Up Interrupt Flag.

enum _flexcan_error_flags

The FlexCAN Error Status enumerations is used to report current error of the FlexCAN bus. This enumerations should be used with KFLEXCAN_ErrorFlag in _flexcan_flags enumerations to ditermine which error is generated.

Enumerator
kFLEXCAN_FDStuffingError	Stuffing Error.
kFLEXCAN_FDFormError	Form Error.
kFLEXCAN_FDCrcError	Cyclic Redundancy Check Error.
kFLEXCAN_FDBit0Error	Unable to send dominant bit.
kFLEXCAN_FDBit1Error	Unable to send recessive bit.
kFLEXCAN_OverrunError	Error Overrun Status.
kFLEXCAN_StuffingError	Stuffing Error.
kFLEXCAN_FormError	Form Error.
kFLEXCAN_CrcError	Cyclic Redundancy Check Error.
kFLEXCAN_AckError	Received no ACK on transmission.
kFLEXCAN_Bit0Error	Unable to send dominant bit.
kFLEXCAN_Bit1Error	Unable to send recessive bit.

anonymous enum

The FlexCAN Rx FIFO Status enumerations are used to determine the status of the Rx FIFO. Because Rx FIFO occupy the MB0 ~ MB7 (Rx Fifo filter also occupies more Message Buffer space), Rx FIFO status flags are mapped to the corresponding Message Buffer status flags.

Enumerator
kFLEXCAN_RxFifoOverflowFlag	Rx FIFO overflow flag.
kFLEXCAN_RxFifoWarningFlag	Rx FIFO almost full flag.
kFLEXCAN_RxFifoFrameAvlFlag	Frames available in Rx FIFO flag.

enum flexcan_memory_error_type_t

Enumerator
kFLEXCAN_CorrectableError	The memory error is correctable which means on bit error.
kFLEXCAN_NonCorrectableError	The memory error is non-correctable which means two bit errors.

enum flexcan_memory_access_type_t

Enumerator
kFLEXCAN_MoveOutFlexCanAccess	The memory error was detected during move-out FlexCAN access.
kFLEXCAN_MoveInAccess	The memory error was detected during move-in FlexCAN access.
kFLEXCAN_TxArbitrationAccess	The memory error was detected during Tx Arbitration FlexCAN access.
kFLEXCAN_RxMatchingAccess	The memory error was detected during Rx Matching FlexCAN access.
kFLEXCAN_MoveOutHostAccess	The memory error was detected during Rx Matching Host (CPU) access.

enum flexcan_byte_error_syndrome_t

Enumerator
kFLEXCAN_NoError	No bit error in this byte.
kFLEXCAN_ParityBits0Error	Parity bit 0 error in this byte.
kFLEXCAN_ParityBits1Error	Parity bit 1 error in this byte.
kFLEXCAN_ParityBits2Error	Parity bit 2 error in this byte.
kFLEXCAN_ParityBits3Error	Parity bit 3 error in this byte.
kFLEXCAN_ParityBits4Error	Parity bit 4 error in this byte.
kFLEXCAN_DataBits0Error	Data bit 0 error in this byte.
kFLEXCAN_DataBits1Error	Data bit 1 error in this byte.
kFLEXCAN_DataBits2Error	Data bit 2 error in this byte.
kFLEXCAN_DataBits3Error	Data bit 3 error in this byte.
kFLEXCAN_DataBits4Error	Data bit 4 error in this byte.
kFLEXCAN_DataBits5Error	Data bit 5 error in this byte.
kFLEXCAN_DataBits6Error	Data bit 6 error in this byte.
kFLEXCAN_DataBits7Error	Data bit 7 error in this byte.
kFLEXCAN_AllZeroError	All-zeros non-correctable error in this byte.
kFLEXCAN_AllOneError	All-ones non-correctable error in this byte.
kFLEXCAN_NonCorrectableErrors	Non-correctable error in this byte.

enum _flexcan_memory_error_interrupt_enable

Enumerator

kFLEXCAN_HostAccessNonCorrectableErrorIntEnable

Host Access With Non-Correctable Errors interrupt.

FlexCAN Access With Non-Correctable Errors.

kFLEXCAN_FlexCanAccessNonCorrectableErrorIntEnable

Correctable Errors interrupt.

enum _flexcan_memory_error_flags

The FlexCAN Memory Error Status enumerations is used to determine the status of current error correction and detection operations of FlexCAN.

Enumerator
kFLEXCAN_HostAccessNonCorrectableErrorFlag	Host Access With Non-Correctable Error Interrupt Flag. FlexCAN Access With Non-Correctable Error Interrupt Flag.
kFLEXCAN_FlexCanAccessNonCorrectableErrorFlag	Correctable Error Interrupt Flag.
kFLEXCAN_CorrectableErrorFlag	Host Access With Non-Correctable Error Interrupt Overrun Flag.
kFLEXCAN_HostAccessNonCorrectableErrorOverrunFlag	FlexCAN Access With Non-Correctable Error Interrupt Overrun Flag.
kFLEXCAN_FlexCanAccessNonCorrectableErrorOverrunFlag	Correctable Error Interrupt Overrun Flag.
kFLEXCAN_CorrectableErrorOverrunFlag	All Memory Error Flags.

Function Documentation

void FLEXCAN_EnterFreezeMode ( CAN_Type * base )

This function makes the FlexCAN work under Freeze Mode.

Parameters

base	FlexCAN peripheral base address.

void FLEXCAN_ExitFreezeMode ( CAN_Type * base )

This function makes the FlexCAN leave Freeze Mode.

Parameters

base	FlexCAN peripheral base address.

uint32_t FLEXCAN_GetInstance ( CAN_Type * base )

Parameters

base	FlexCAN peripheral base address.

Returns: FlexCAN instance.

bool FLEXCAN_CalculateImprovedTimingValues	(	uint32_t	baudRate,
		uint32_t	sourceClock_Hz,
		flexcan_timing_config_t *	pTimingConfig
	)

Parameters

baudRate	The classical CAN speed in bps defined by user
sourceClock_Hz	The Source clock data speed in bps. Zero to disable baudrate switching
pTimingConfig	Pointer to the FlexCAN timing configuration structure.

Returns: TRUE if timing configuration found, FALSE if failed to find configuration

void FLEXCAN_Init	(	CAN_Type *	base,
		const flexcan_config_t *	pConfig,
		uint32_t	sourceClock_Hz
	)

This function initializes the FlexCAN module with user-defined settings. This example shows how to set up the flexcan_config_t parameters and how to call the FLEXCAN_Init function by passing in these parameters.

*   flexcan_config_t flexcanConfig;
*   flexcanConfig.clkSrc               = kFLEXCAN_ClkSrc0;
*   flexcanConfig.baudRate             = 1000000U;
*   flexcanConfig.maxMbNum             = 16;
*   flexcanConfig.enableLoopBack       = false;
*   flexcanConfig.enableSelfWakeup     = false;
*   flexcanConfig.enableIndividMask    = false;
*   flexcanConfig.enableDoze           = false;
*   flexcanConfig.disableSelfReception = false;
*   flexcanConfig.enableListenOnlyMode = false;
*   flexcanConfig.timingConfig         = timingConfig;
*   FLEXCAN_Init(CAN0, &flexcanConfig, 8000000UL);
*   

Parameters

base	FlexCAN peripheral base address.
pConfig	Pointer to the user-defined configuration structure.
sourceClock_Hz	FlexCAN Protocol Engine clock source frequency in Hz.

bool FLEXCAN_FDCalculateImprovedTimingValues	(	uint32_t	baudRate,
		uint32_t	baudRateFD,
		uint32_t	sourceClock_Hz,
		flexcan_timing_config_t *	pTimingConfig
	)

Parameters

baudRate	The CANFD bus control speed in bps defined by user
baudRateFD	The CANFD bus data speed in bps defined by user
sourceClock_Hz	The Source clock data speed in bps. Zero to disable baudrate switching
pTimingConfig	Pointer to the FlexCAN timing configuration structure.

Returns: TRUE if timing configuration found, FALSE if failed to find configuration

void FLEXCAN_FDInit	(	CAN_Type *	base,
		const flexcan_config_t *	pConfig,
		uint32_t	sourceClock_Hz,
		flexcan_mb_size_t	dataSize,
		bool	brs
	)

This function initializes the FlexCAN module with user-defined settings. This example shows how to set up the flexcan_config_t parameters and how to call the FLEXCAN_FDInit function by passing in these parameters.

*   flexcan_config_t flexcanConfig;
*   flexcanConfig.clkSrc               = kFLEXCAN_ClkSrc0;
*   flexcanConfig.baudRate             = 1000000U;
*   flexcanConfig.baudRateFD           = 2000000U;
*   flexcanConfig.maxMbNum             = 16;
*   flexcanConfig.enableLoopBack       = false;
*   flexcanConfig.enableSelfWakeup     = false;
*   flexcanConfig.enableIndividMask    = false;
*   flexcanConfig.disableSelfReception = false;
*   flexcanConfig.enableListenOnlyMode = false;
*   flexcanConfig.enableDoze           = false;
*   flexcanConfig.timingConfig         = timingConfig;
*   FLEXCAN_FDInit(CAN0, &flexcanConfig, 8000000UL, kFLEXCAN_16BperMB, false);
*   

Parameters

base	FlexCAN peripheral base address.
pConfig	Pointer to the user-defined configuration structure.
sourceClock_Hz	FlexCAN Protocol Engine clock source frequency in Hz.
dataSize	FlexCAN FD frame payload size.
brs	If bitrate switch is enabled in FD mode.

void FLEXCAN_Deinit ( CAN_Type * base )

This function disables the FlexCAN module clock and sets all register values to the reset value.

Parameters

base	FlexCAN peripheral base address.

void FLEXCAN_GetDefaultConfig ( flexcan_config_t * pConfig )

This function initializes the FlexCAN configuration structure to default values. The default values are as follows. flexcanConfig->clkSrc = kFLEXCAN_ClkSrc0; flexcanConfig->baudRate = 1000000U; flexcanConfig->baudRateFD = 2000000U; flexcanConfig->maxMbNum = 16; flexcanConfig->enableLoopBack = false; flexcanConfig->enableSelfWakeup = false; flexcanConfig->enableIndividMask = false; flexcanConfig->disableSelfReception = false; flexcanConfig->enableListenOnlyMode = false; flexcanConfig->enableDoze = false; flexcanConfig->enableMemoryErrorControl = true; flexcanConfig->enableNonCorrectableErrorEnterFreeze = true; flexcanConfig.timingConfig = timingConfig;

Parameters

pConfig Pointer to the FlexCAN configuration structure.

void FLEXCAN_SetTimingConfig	(	CAN_Type *	base,
		const flexcan_timing_config_t *	pConfig
	)

This function gives user settings to CAN bus timing characteristic. The function is for an experienced user. For less experienced users, call the FLEXCAN_Init() and fill the baud rate field with a desired value. This provides the default timing characteristics to the module.

Note that calling FLEXCAN_SetTimingConfig() overrides the baud rate set in FLEXCAN_Init().

Parameters

base	FlexCAN peripheral base address.
pConfig	Pointer to the timing configuration structure.

void FLEXCAN_SetFDTimingConfig	(	CAN_Type *	base,
		const flexcan_timing_config_t *	pConfig
	)

This function gives user settings to CAN bus timing characteristic. The function is for an experienced user. For less experienced users, call the FLEXCAN_Init() and fill the baud rate field with a desired value. This provides the default timing characteristics to the module.

Note that calling FLEXCAN_SetFDTimingConfig() overrides the baud rate set in FLEXCAN_Init().

Parameters

base	FlexCAN peripheral base address.
pConfig	Pointer to the timing configuration structure.

void FLEXCAN_SetRxMbGlobalMask	(	CAN_Type *	base,
		uint32_t	mask
	)

This function sets the global mask for the FlexCAN message buffer in a matching process. The configuration is only effective when the Rx individual mask is disabled in the FLEXCAN_Init().

Parameters

base	FlexCAN peripheral base address.
mask	Rx Message Buffer Global Mask value.

void FLEXCAN_SetRxFifoGlobalMask	(	CAN_Type *	base,
		uint32_t	mask
	)

This function sets the global mask for FlexCAN FIFO in a matching process.

Parameters

base	FlexCAN peripheral base address.
mask	Rx Fifo Global Mask value.

void FLEXCAN_SetRxIndividualMask	(	CAN_Type *	base,
		uint8_t	maskIdx,
		uint32_t	mask
	)

This function sets the individual mask for the FlexCAN matching process. The configuration is only effective when the Rx individual mask is enabled in the FLEXCAN_Init(). If the Rx FIFO is disabled, the individual mask is applied to the corresponding Message Buffer. If the Rx FIFO is enabled, the individual mask for Rx FIFO occupied Message Buffer is applied to the Rx Filter with the same index. Note that only the first 32 individual masks can be used as the Rx FIFO filter mask.

Parameters

base	FlexCAN peripheral base address.
maskIdx	The Index of individual Mask.
mask	Rx Individual Mask value.

void FLEXCAN_SetTxMbConfig	(	CAN_Type *	base,
		uint8_t	mbIdx,
		bool	enable
	)

This function aborts the previous transmission, cleans the Message Buffer, and configures it as a Transmit Message Buffer.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The Message Buffer index.
enable	Enable/disable Tx Message Buffer. true: Enable Tx Message Buffer. false: Disable Tx Message Buffer.

void FLEXCAN_SetFDTxMbConfig	(	CAN_Type *	base,
		uint8_t	mbIdx,
		bool	enable
	)

This function aborts the previous transmission, cleans the Message Buffer, and configures it as a Transmit Message Buffer.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The Message Buffer index.
enable	Enable/disable Tx Message Buffer. true: Enable Tx Message Buffer. false: Disable Tx Message Buffer.

void FLEXCAN_SetRxMbConfig	(	CAN_Type *	base,
		uint8_t	mbIdx,
		const flexcan_rx_mb_config_t *	pRxMbConfig,
		bool	enable
	)

This function cleans a FlexCAN build-in Message Buffer and configures it as a Receive Message Buffer.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The Message Buffer index.
pRxMbConfig	Pointer to the FlexCAN Message Buffer configuration structure.
enable	Enable/disable Rx Message Buffer. true: Enable Rx Message Buffer. false: Disable Rx Message Buffer.

void FLEXCAN_SetFDRxMbConfig	(	CAN_Type *	base,
		uint8_t	mbIdx,
		const flexcan_rx_mb_config_t *	pRxMbConfig,
		bool	enable
	)

This function cleans a FlexCAN build-in Message Buffer and configures it as a Receive Message Buffer.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The Message Buffer index.
pRxMbConfig	Pointer to the FlexCAN Message Buffer configuration structure.
enable	Enable/disable Rx Message Buffer. true: Enable Rx Message Buffer. false: Disable Rx Message Buffer.

void FLEXCAN_SetRxFifoConfig	(	CAN_Type *	base,
		const flexcan_rx_fifo_config_t *	pRxFifoConfig,
		bool	enable
	)

This function configures the Rx FIFO with given Rx FIFO configuration.

Parameters

base	FlexCAN peripheral base address.
pRxFifoConfig	Pointer to the FlexCAN Rx FIFO configuration structure.
enable	Enable/disable Rx FIFO. true: Enable Rx FIFO. false: Disable Rx FIFO.

static uint32_t FLEXCAN_GetStatusFlags ( CAN_Type * base )

inlinestatic

This function gets all FlexCAN status flags. The flags are returned as the logical OR value of the enumerators _flexcan_flags. To check the specific status, compare the return value with enumerators in _flexcan_flags.

Parameters

base	FlexCAN peripheral base address.

Returns: FlexCAN status flags which are ORed by the enumerators in the _flexcan_flags.

static void FLEXCAN_ClearStatusFlags	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function clears the FlexCAN status flags with a provided mask. An automatically cleared flag can't be cleared by this function.

Parameters

base	FlexCAN peripheral base address.
mask	The status flags to be cleared, it is logical OR value of _flexcan_flags.

static void FLEXCAN_GetBusErrCount	(	CAN_Type *	base,
		uint8_t *	txErrBuf,
		uint8_t *	rxErrBuf
	)

inlinestatic

This function gets the FlexCAN Bus Error Counter value for both Tx and Rx direction. These values may be needed in the upper layer error handling.

Parameters

base	FlexCAN peripheral base address.
txErrBuf	Buffer to store Tx Error Counter value.
rxErrBuf	Buffer to store Rx Error Counter value.

static uint64_t FLEXCAN_GetMbStatusFlags	(	CAN_Type *	base,
		uint64_t	mask
	)

inlinestatic

This function gets the interrupt flags of a given Message Buffers.

Parameters

base	FlexCAN peripheral base address.
mask	The ORed FlexCAN Message Buffer mask.

Returns: The status of given Message Buffers.

static void FLEXCAN_ClearMbStatusFlags	(	CAN_Type *	base,
		uint64_t	mask
	)

inlinestatic

This function clears the interrupt flags of a given Message Buffers.

Parameters

base	FlexCAN peripheral base address.
mask	The ORed FlexCAN Message Buffer mask.

void FLEXCAN_GetMemoryErrorReportStatus	(	CAN_Type *	base,
		flexcan_memory_error_report_status_t *	errorStatus
	)

This function gets the FlexCAN Memory Error Report registers status.

Parameters

base	FlexCAN peripheral base address.
errorStatus	Pointer to FlexCAN Memory Error Report registers status structure.

static uint32_t FLEXCAN_GetMemoryErrorStatusFlags ( CAN_Type * base )

inlinestatic

This function gets all FlexCAN memory error status flags. The flags are returned as the logical OR value of the enumerators _flexcan_memory_error_flags. To check the specific status, compare the return value with enumerators in _flexcan_memory_error_flags.

Parameters

base	FlexCAN peripheral base address.

Returns: FlexCAN memory error status flags which are ORed by the enumerators in the _flexcan_memory_error_flags.

static void FLEXCAN_ClearMemoryErrorStatusFlags	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function clears the FlexCAN memory error status flags with a provided mask.

Parameters

base	FlexCAN peripheral base address.
mask	The status flags to be cleared, it is logical OR value of _flexcan_memory_error_flags.

static void FLEXCAN_EnableInterrupts	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function enables the FlexCAN interrupts according to the provided mask. The mask is a logical OR of enumeration members, see _flexcan_interrupt_enable.

Parameters

base	FlexCAN peripheral base address.
mask	The interrupts to enable. Logical OR of _flexcan_interrupt_enable.

static void FLEXCAN_DisableInterrupts	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function disables the FlexCAN interrupts according to the provided mask. The mask is a logical OR of enumeration members, see _flexcan_interrupt_enable.

Parameters

base	FlexCAN peripheral base address.
mask	The interrupts to disable. Logical OR of _flexcan_interrupt_enable.

static void FLEXCAN_EnableMbInterrupts	(	CAN_Type *	base,
		uint64_t	mask
	)

inlinestatic

This function enables the interrupts of given Message Buffers.

Parameters

base	FlexCAN peripheral base address.
mask	The ORed FlexCAN Message Buffer mask.

static void FLEXCAN_DisableMbInterrupts	(	CAN_Type *	base,
		uint64_t	mask
	)

inlinestatic

This function disables the interrupts of given Message Buffers.

Parameters

base	FlexCAN peripheral base address.
mask	The ORed FlexCAN Message Buffer mask.

static void FLEXCAN_EnableMemoryErrorInterrupts	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function enables the FlexCAN memory error interrupts according to the provided mask. The mask is a logical OR of enumeration members, see _flexcan_memory_error_interrupt_enable.

Parameters

base	FlexCAN peripheral base address.
mask	The interrupts to enable. Logical OR of _flexcan_memory_error_interrupt_enable.

static void FLEXCAN_DisableMemoryErrorInterrupts	(	CAN_Type *	base,
		uint32_t	mask
	)

inlinestatic

This function disables the FlexCAN memory error interrupts according to the provided mask. The mask is a logical OR of enumeration members, see _flexcan_memory_error_interrupt_enable.

Parameters

base	FlexCAN peripheral base address.
mask	The interrupts to enable. Logical OR of _flexcan_memory_error_interrupt_enable.

void FLEXCAN_EnableRxFifoDMA	(	CAN_Type *	base,
		bool	enable
	)

This function enables or disables the DMA feature of FlexCAN build-in Rx FIFO.

Parameters

base	FlexCAN peripheral base address.
enable	true to enable, false to disable.

static uint32_t FLEXCAN_GetRxFifoHeadAddr ( CAN_Type * base )

inlinestatic

This function returns the FlexCAN Rx FIFO Head address, which is mainly used for the DMA/eDMA use case.

Parameters

base	FlexCAN peripheral base address.

Returns: FlexCAN Rx FIFO Head address.

static void FLEXCAN_Enable	(	CAN_Type *	base,
		bool	enable
	)

inlinestatic

This function enables or disables the FlexCAN module.

Parameters

base	FlexCAN base pointer.
enable	true to enable, false to disable.

status_t FLEXCAN_WriteTxMb	(	CAN_Type *	base,
		uint8_t	mbIdx,
		const flexcan_frame_t *	pTxFrame
	)

This function writes a CAN Message to the specified Transmit Message Buffer and changes the Message Buffer state to start CAN Message transmit. After that the function returns immediately.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The FlexCAN Message Buffer index.
pTxFrame	Pointer to CAN message frame to be sent.

Return values

kStatus_Success	- Write Tx Message Buffer Successfully.
kStatus_Fail	- Tx Message Buffer is currently in use.

status_t FLEXCAN_ReadRxMb	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_frame_t *	pRxFrame
	)

This function reads a CAN message from a specified Receive Message Buffer. The function fills a receive CAN message frame structure with just received data and activates the Message Buffer again. The function returns immediately.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The FlexCAN Message Buffer index.
pRxFrame	Pointer to CAN message frame structure for reception.

Return values

kStatus_Success	- Rx Message Buffer is full and has been read successfully.
kStatus_FLEXCAN_RxOverflow	- Rx Message Buffer is already overflowed and has been read successfully.
kStatus_Fail	- Rx Message Buffer is empty.

status_t FLEXCAN_WriteFDTxMb	(	CAN_Type *	base,
		uint8_t	mbIdx,
		const flexcan_fd_frame_t *	pTxFrame
	)

This function writes a CAN FD Message to the specified Transmit Message Buffer and changes the Message Buffer state to start CAN FD Message transmit. After that the function returns immediately.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The FlexCAN FD Message Buffer index.
pTxFrame	Pointer to CAN FD message frame to be sent.

Return values

kStatus_Success	- Write Tx Message Buffer Successfully.
kStatus_Fail	- Tx Message Buffer is currently in use.

status_t FLEXCAN_ReadFDRxMb	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_fd_frame_t *	pRxFrame
	)

This function reads a CAN FD message from a specified Receive Message Buffer. The function fills a receive CAN FD message frame structure with just received data and activates the Message Buffer again. The function returns immediately.

Parameters

base	FlexCAN peripheral base address.
mbIdx	The FlexCAN FD Message Buffer index.
pRxFrame	Pointer to CAN FD message frame structure for reception.

Return values

kStatus_Success	- Rx Message Buffer is full and has been read successfully.
kStatus_FLEXCAN_RxOverflow	- Rx Message Buffer is already overflowed and has been read successfully.
kStatus_Fail	- Rx Message Buffer is empty.

status_t FLEXCAN_ReadRxFifo	(	CAN_Type *	base,
		flexcan_frame_t *	pRxFrame
	)

This function reads a CAN message from the FlexCAN build-in Rx FIFO.

Parameters

base	FlexCAN peripheral base address.
pRxFrame	Pointer to CAN message frame structure for reception.

Return values

kStatus_Success	- Read Message from Rx FIFO successfully.
kStatus_Fail	- Rx FIFO is not enabled.

status_t FLEXCAN_TransferFDSendBlocking	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_fd_frame_t *	pTxFrame
	)

Note that a transfer handle does not need to be created before calling this API.

Parameters

base	FlexCAN peripheral base pointer.
mbIdx	The FlexCAN FD Message Buffer index.
pTxFrame	Pointer to CAN FD message frame to be sent.

Return values

kStatus_Success	- Write Tx Message Buffer Successfully.
kStatus_Fail	- Tx Message Buffer is currently in use.

status_t FLEXCAN_TransferFDReceiveBlocking	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_fd_frame_t *	pRxFrame
	)

Note that a transfer handle does not need to be created before calling this API.

Parameters

base	FlexCAN peripheral base pointer.
mbIdx	The FlexCAN FD Message Buffer index.
pRxFrame	Pointer to CAN FD message frame structure for reception.

Return values

kStatus_Success	- Rx Message Buffer is full and has been read successfully.
kStatus_FLEXCAN_RxOverflow	- Rx Message Buffer is already overflowed and has been read successfully.
kStatus_Fail	- Rx Message Buffer is empty.

status_t FLEXCAN_TransferFDSendNonBlocking	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_mb_transfer_t *	pMbXfer
	)

This function sends a message using IRQ. This is a non-blocking function, which returns right away. When messages have been sent out, the send callback function is called.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
pMbXfer	FlexCAN FD Message Buffer transfer structure. See the flexcan_mb_transfer_t.

Return values

kStatus_Success	Start Tx Message Buffer sending process successfully.
kStatus_Fail	Write Tx Message Buffer failed.
kStatus_FLEXCAN_TxBusy	Tx Message Buffer is in use.

status_t FLEXCAN_TransferFDReceiveNonBlocking	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_mb_transfer_t *	pMbXfer
	)

This function receives a message using IRQ. This is non-blocking function, which returns right away. When the message has been received, the receive callback function is called.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
pMbXfer	FlexCAN FD Message Buffer transfer structure. See the flexcan_mb_transfer_t.

Return values

kStatus_Success	- Start Rx Message Buffer receiving process successfully.
kStatus_FLEXCAN_RxBusy	- Rx Message Buffer is in use.

void FLEXCAN_TransferFDAbortSend	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		uint8_t	mbIdx
	)

This function aborts the interrupt driven message send process.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
mbIdx	The FlexCAN FD Message Buffer index.

void FLEXCAN_TransferFDAbortReceive	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		uint8_t	mbIdx
	)

This function aborts the interrupt driven message receive process.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
mbIdx	The FlexCAN FD Message Buffer index.

status_t FLEXCAN_TransferSendBlocking	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_frame_t *	pTxFrame
	)

Note that a transfer handle does not need to be created before calling this API.

Parameters

base	FlexCAN peripheral base pointer.
mbIdx	The FlexCAN Message Buffer index.
pTxFrame	Pointer to CAN message frame to be sent.

Return values

kStatus_Success	- Write Tx Message Buffer Successfully.
kStatus_Fail	- Tx Message Buffer is currently in use.

status_t FLEXCAN_TransferReceiveBlocking	(	CAN_Type *	base,
		uint8_t	mbIdx,
		flexcan_frame_t *	pRxFrame
	)

Note that a transfer handle does not need to be created before calling this API.

Parameters

base	FlexCAN peripheral base pointer.
mbIdx	The FlexCAN Message Buffer index.
pRxFrame	Pointer to CAN message frame structure for reception.

Return values

kStatus_Success	- Rx Message Buffer is full and has been read successfully.
kStatus_FLEXCAN_RxOverflow	- Rx Message Buffer is already overflowed and has been read successfully.
kStatus_Fail	- Rx Message Buffer is empty.

status_t FLEXCAN_TransferReceiveFifoBlocking	(	CAN_Type *	base,
		flexcan_frame_t *	pRxFrame
	)

Note that a transfer handle does not need to be created before calling this API.

Parameters

base	FlexCAN peripheral base pointer.
pRxFrame	Pointer to CAN message frame structure for reception.

Return values

kStatus_Success	- Read Message from Rx FIFO successfully.
kStatus_Fail	- Rx FIFO is not enabled.

void FLEXCAN_TransferCreateHandle	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_transfer_callback_t	callback,
		void *	userData
	)

This function initializes the FlexCAN handle, which can be used for other FlexCAN transactional APIs. Usually, for a specified FlexCAN instance, call this API once to get the initialized handle.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
callback	The callback function.
userData	The parameter of the callback function.

status_t FLEXCAN_TransferSendNonBlocking	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_mb_transfer_t *	pMbXfer
	)

This function sends a message using IRQ. This is a non-blocking function, which returns right away. When messages have been sent out, the send callback function is called.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
pMbXfer	FlexCAN Message Buffer transfer structure. See the flexcan_mb_transfer_t.

Return values

kStatus_Success	Start Tx Message Buffer sending process successfully.
kStatus_Fail	Write Tx Message Buffer failed.
kStatus_FLEXCAN_TxBusy	Tx Message Buffer is in use.

status_t FLEXCAN_TransferReceiveNonBlocking	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_mb_transfer_t *	pMbXfer
	)

This function receives a message using IRQ. This is non-blocking function, which returns right away. When the message has been received, the receive callback function is called.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
pMbXfer	FlexCAN Message Buffer transfer structure. See the flexcan_mb_transfer_t.

Return values

kStatus_Success	- Start Rx Message Buffer receiving process successfully.
kStatus_FLEXCAN_RxBusy	- Rx Message Buffer is in use.

status_t FLEXCAN_TransferReceiveFifoNonBlocking	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		flexcan_fifo_transfer_t *	pFifoXfer
	)

This function receives a message using IRQ. This is a non-blocking function, which returns right away. When all messages have been received, the receive callback function is called.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
pFifoXfer	FlexCAN Rx FIFO transfer structure. See the flexcan_fifo_transfer_t.

Return values

kStatus_Success	- Start Rx FIFO receiving process successfully.
kStatus_FLEXCAN_RxFifoBusy	- Rx FIFO is currently in use.

uint32_t FLEXCAN_GetTimeStamp	(	flexcan_handle_t *	handle,
		uint8_t	mbIdx
	)

Then function can only be used when calling non-blocking Data transfer (TX/RX) API, After TX/RX data transfer done (User can get the status by handler's callback function), we can get the detail index of Mailbox's timestamp by handle, Detail non-blocking data transfer API (TX/RX) contain. -FLEXCAN_TransferSendNonBlocking -FLEXCAN_TransferFDSendNonBlocking -FLEXCAN_TransferReceiveNonBlocking -FLEXCAN_TransferFDReceiveNonBlocking -FLEXCAN_TransferReceiveFifoNonBlocking

Parameters

handle	FlexCAN handle pointer.
mbIdx	The FlexCAN FD Message Buffer index.

Return values

the	index of mailbox 's timestamp stored in the handle.

void FLEXCAN_TransferAbortSend	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		uint8_t	mbIdx
	)

This function aborts the interrupt driven message send process.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
mbIdx	The FlexCAN Message Buffer index.

void FLEXCAN_TransferAbortReceive	(	CAN_Type *	base,
		flexcan_handle_t *	handle,
		uint8_t	mbIdx
	)

This function aborts the interrupt driven message receive process.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.
mbIdx	The FlexCAN Message Buffer index.

void FLEXCAN_TransferAbortReceiveFifo	(	CAN_Type *	base,
		flexcan_handle_t *	handle
	)

This function aborts the interrupt driven message receive from Rx FIFO process.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.

void FLEXCAN_TransferHandleIRQ	(	CAN_Type *	base,
		flexcan_handle_t *	handle
	)

This function handles the FlexCAN Error, the Message Buffer, and the Rx FIFO IRQ request.

Parameters

base	FlexCAN peripheral base address.
handle	FlexCAN handle pointer.

Overview

Typical use case

Message Buffer Send Operation

Message Buffer Receive Operation

Receive FIFO Operation

Data Structures

Macros

Typedefs

Enumerations

Driver version

Initialization and deinitialization

Configuration.

Status

Interrupts

DMA Control

Bus Operations

Transactional

Data Structure Documentation

Data Fields

Field Documentation

Field Documentation

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Data Fields

Field Documentation

Macro Definition Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation