CANFD Driver Internal Data Structures

The section has a list of all the data structures which are used internally by the driver. More...

Data Structures
struct	MCAN_ConfigParams_t
	Data structure defines the MCAN configuration parameters. More...
struct	MCAN_RxNewDataStatus_t
	Data structure defines the MCAN new data flag for Rx buffer. More...
struct	MCAN_RxFIFOStatus_t
	Data structure defines the MCAN Rx FIFO Status. More...
struct	MCAN_TxFIFOStatus_t
	Data structure defines the MCAN Tx FIFO Status. More...
struct	MCAN_TxEventFIFOStatus_t
	Data structure defines the MCAN Tx Event FIFO Status. More...
struct	MCAN_TxBufElement_t
	Data structure defines the MCAN Tx Buffer element. More...
struct	MCAN_RxBufElement_t
	Data structure defines the MCAN Rx Buffer element. More...
struct	MCAN_TxEventFIFOElement_t
	Data structure defines the MCAN Tx Event FIFO element. More...
struct	MCAN_StdMsgIDFilterElement_t
	Data structure defines the MCAN Standard Message ID Filter Element. More...
struct	MCAN_ExtMsgIDFilterElement_t
	Data structure defines the MCAN Extended Message ID Filter Element. More...
struct	MCAN_MsgRAMConfigParams_t
	Data structure defines the MCAN Message RAM Configuration Parameters. Message RAM can contain following sections: Standard ID filters, Extended ID filters, TX FIFO(or TX Q), TX Buffers, TX EventFIFO, RX FIFO0, RX FIFO1, RX Buffer. Note: If particular section in the RAM is not used then it's size should be initialized to '0' (Number of buffers in case of Tx/Rx buffer). More...
struct	MCAN_HighPriorityMsgInfo_t
	Data structure defines the MCAN High Priority Message. More...
struct	MCAN_BitTimingParams_t
	Data structure defines the parameters for bit timing calculation. Bit timing related to data phase will be valid only in case where MCAN is put in CANFD mode and will be '0' otherwise. More...
struct	MCAN_RevisionId_t
	Data structure defines the accessing Revision ID and Core Release Info. of MCAN module. More...
struct	MCAN_ECCAggrRevisionId_t
	Data structure defines the accessing Revision ID of ECC AGGR. More...
struct	MCAN_ECCWrapRevisionId_t
	Data structure defines the accessing Revision ID of ECC wrapper. More...
struct	CANFD_HwCfg_t
	CANFD Hardware Atrributes. More...
struct	CANFD_DriverMCB_t
	CANFD Master Control Block. More...
struct	CANFD_MessageObject_t
	CAN message object block. More...

Macros
#define	MCAN_INTR_MASK
	Defines all the interrupt are enabled.

Typedefs
typedef enum MCAN_IntrLineNum_t	MCAN_IntrLineNum
	Enumerates the values used to represent the MCAN interrupt lines.
typedef enum MCAN_MemType_t	MCAN_MemType
	This enumeration defines the values used to represent the MCAN Message RAM type.
typedef enum MCAN_RxFIFONum_t	MCAN_RxFIFONum
	This enumeration defines the MCAN receive FIFO number.
typedef enum CANFD_MCANElemSize_t	CANFD_MCANElemSize
	This enumeration defines the MCAN FIFO/Buffer element Size.
typedef enum CANFD_DriverState_t	CANFD_DriverState
	This enumeration defines the values used to represent the CANFD driver state.
typedef enum MCAN_IntrSrc_t	MCAN_IntrSrc
	This enumeration defines the values for MCAN interrupts.
typedef struct MCAN_ConfigParams_t	MCAN_ConfigParams
	Data structure defines the MCAN configuration parameters.
typedef struct MCAN_RxNewDataStatus_t	MCAN_RxNewDataStatus
	Data structure defines the MCAN new data flag for Rx buffer.
typedef struct MCAN_RxFIFOStatus_t	MCAN_RxFIFOStatus
	Data structure defines the MCAN Rx FIFO Status.
typedef struct MCAN_TxFIFOStatus_t	MCAN_TxFIFOStatus
	Data structure defines the MCAN Tx FIFO Status.
typedef struct MCAN_TxEventFIFOStatus_t	MCAN_TxEventFIFOStatus
	Data structure defines the MCAN Tx Event FIFO Status.
typedef struct MCAN_TxBufElement_t	MCAN_TxBufElement
	Data structure defines the MCAN Tx Buffer element.
typedef struct MCAN_RxBufElement_t	MCAN_RxBufElement
	Data structure defines the MCAN Rx Buffer element.
typedef struct MCAN_TxEventFIFOElement_t	MCAN_TxEventFIFOElement
	Data structure defines the MCAN Tx Event FIFO element.
typedef struct MCAN_StdMsgIDFilterElement_t	MCAN_StdMsgIDFilterElement
	Data structure defines the MCAN Standard Message ID Filter Element.
typedef struct MCAN_ExtMsgIDFilterElement_t	MCAN_ExtMsgIDFilterElement
	Data structure defines the MCAN Extended Message ID Filter Element.
typedef struct MCAN_MsgRAMConfigParams_t	MCAN_MsgRAMConfigParams
	Data structure defines the MCAN Message RAM Configuration Parameters. Message RAM can contain following sections: Standard ID filters, Extended ID filters, TX FIFO(or TX Q), TX Buffers, TX EventFIFO, RX FIFO0, RX FIFO1, RX Buffer. Note: If particular section in the RAM is not used then it's size should be initialized to '0' (Number of buffers in case of Tx/Rx buffer).
typedef struct MCAN_HighPriorityMsgInfo_t	MCAN_HighPriorityMsgInfo
	Data structure defines the MCAN High Priority Message.
typedef struct MCAN_BitTimingParams_t	MCAN_BitTimingParams
	Data structure defines the parameters for bit timing calculation. Bit timing related to data phase will be valid only in case where MCAN is put in CANFD mode and will be '0' otherwise.
typedef struct MCAN_RevisionId_t	MCAN_RevisionId
	Data structure defines the accessing Revision ID and Core Release Info. of MCAN module.
typedef struct MCAN_ECCAggrRevisionId_t	MCAN_ECCAggrRevisionId
	Data structure defines the accessing Revision ID of ECC AGGR.
typedef struct MCAN_ECCWrapRevisionId_t	MCAN_ECCWrapRevisionId
	Data structure defines the accessing Revision ID of ECC wrapper.
typedef struct CANFD_HwCfg_t	CANFD_HwCfg
	CANFD Hardware Atrributes. More...
typedef struct CANFD_DriverMCB_t	CANFD_DriverMCB
	CANFD Master Control Block. More...
typedef struct CANFD_MessageObject_t	CANFD_MessageObject
	CAN message object block. More...

Enumerations

Detailed Description

The section has a list of all the data structures which are used internally by the driver.

Typedef Documentation

typedef struct CANFD_DriverMCB_t CANFD_DriverMCB

CANFD Master Control Block.

The structure describes the CANFD Driver and is used to hold the relevant information with respect to the CANFD module.

typedef struct CANFD_HwCfg_t CANFD_HwCfg

CANFD Hardware Atrributes.

The structure is used to store the hardware specific configuration which is passed to each driver instance

typedef struct CANFD_MessageObject_t CANFD_MessageObject

CAN message object block.

The structure defines the message object

Enumeration Type Documentation

enum CANFD_DriverState_t

This enumeration defines the values used to represent the CANFD driver state.

Enumerator
CANFD_DriverState_UNINIT	CANFD controller not initialized
CANFD_DriverState_STARTED	CANFD controller started
CANFD_DriverState_STOPPED	CANFD controller stopped
CANFD_DriverState_SLEEP	CANFD controller in sleep mode

enum CANFD_MCANElemSize_t

This enumeration defines the MCAN FIFO/Buffer element Size.

Enumerator
CANFD_MCANElemSize_8BYTES	8 byte data field
CANFD_MCANElemSize_12BYTES	12 byte data field
CANFD_MCANElemSize_16BYTES	16 byte data field
CANFD_MCANElemSize_20BYTES	20 byte data field
CANFD_MCANElemSize_24BYTES	24 byte data field
CANFD_MCANElemSize_32BYTES	32 byte data field
CANFD_MCANElemSize_48BYTES	48 byte data field
CANFD_MCANElemSize_64BYTES	64 byte data field

enum MCAN_IntrLineNum_t

Enumerates the values used to represent the MCAN interrupt lines.

Enumerator
MCAN_IntrLineNum_0	MCAN interrupt line 0
MCAN_IntrLineNum_1	MCAN interrupt line 1

enum MCAN_IntrSrc_t

This enumeration defines the values for MCAN interrupts.

Enumerator
MCAN_INTR_SRC_RX_FIFO0_NEW_MSG	Rx FIFO 0 New Message interrupt
MCAN_INTR_SRC_RX_FIFO0_WATERMARK	Rx FIFO 0 Watermark Reached interrupt
MCAN_INTR_SRC_RX_FIFO0_FULL	Rx FIFO 0 Full interrupt
MCAN_INTR_SRC_RX_FIFO0_MSG_LOST	Rx FIFO 0 Message Lost interrupt
MCAN_INTR_SRC_RX_FIFO1_NEW_MSG	Rx FIFO 1 New Message interrupt
MCAN_INTR_SRC_RX_FIFO1_WATERMARK	Rx FIFO 1 Watermark Reached interrupt
MCAN_INTR_SRC_RX_FIFO1_FULL	Rx FIFO 1 Full interrupt
MCAN_INTR_SRC_RX_FIFO1_MSG_LOST	Rx FIFO 1 Message Lost interrupt
MCAN_INTR_SRC_HIGH_PRIO_MSG	High Priority Message interrupt
MCAN_INTR_SRC_TRANS_COMPLETE	Transmission Completed interrupt
MCAN_INTR_SRC_TRANS_CANCEL_FINISH	Transmission Cancellation Finished interrupt
MCAN_INTR_SRC_TX_FIFO_EMPTY	Tx FIFO Empty interrupt
MCAN_INTR_SRC_TX_EVT_FIFO_NEW_ENTRY	Tx Event FIFO New Entry interrupt
MCAN_INTR_SRC_TX_EVT_FIFO_WATERMARK	Tx Event FIFO Watermark Reached interrupt
MCAN_INTR_SRC_TX_EVT_FIFO_FULL	Tx Event FIFO Full interrupt
MCAN_INTR_SRC_TX_EVT_FIFO_ELEM_LOST	Tx Event FIFO Element Lost interrupt
MCAN_INTR_SRC_TIMESTAMP_WRAPAROUND	Timestamp Wraparound interrupt
MCAN_INTR_SRC_MSG_RAM_ACCESS_FAILURE	Message RAM Access Failure interrupt
MCAN_INTR_SRC_TIMEOUT	Timeout Occurred interrupt
MCAN_INTR_SRC_DEDICATED_RX_BUFF_MSG	Message stored to Dedicated Rx Buffer interrupt
MCAN_INTR_SRC_BIT_ERR_CORRECTED	Bit Error Corrected interrupt
MCAN_INTR_SRC_BIT_ERR_UNCORRECTED	Bit Error Uncorrected interrupt
MCAN_INTR_SRC_ERR_LOG_OVRFLW	Error Logging Overflow interrupt
MCAN_INTR_SRC_ERR_PASSIVE	Error Passive interrupt
MCAN_INTR_SRC_WARNING_STATUS	Warning Status interrupt
MCAN_INTR_SRC_BUS_OFF_STATUS	Bus_Off Status interrupt
MCAN_INTR_SRC_WATCHDOG	Watchdog Interrupt interrupt
MCAN_INTR_SRC_PROTOCOL_ERR_ARB	Protocol Error in Arbitration Phase interrupt
MCAN_INTR_SRC_PROTOCOL_ERR_DATA	Protocol Error in Data Phase interrupt
MCAN_INTR_SRC_RES_ADDR_ACCESS	Access to Reserved Address interrupt

enum MCAN_MemType_t

This enumeration defines the values used to represent the MCAN Message RAM type.

Enumerator
MCAN_MemType_BUF	MCAN Message RAM buffers MCAN Message RAM FIFO/Queue

enum MCAN_RxFIFONum_t

This enumeration defines the MCAN receive FIFO number.

Enumerator
MCAN_RxFIFONum_0	MCAN Rx FIFO 0
MCAN_RxFIFONum_1	MCAN Rx FIFO 1