|  | Dual Active Bridge Development Board (Part-No. ) |
Content |  |  |  |  |  |

Loading...
Searching...
No Matches
Data Structures | Enumerations
can_types.h File Reference
MPLABX MCC Melody Code Generator » CAN FD Driver

This is the generated driver types header file for the CAN driver using CCL. More...

`#include <stdint.h>`
Include dependency graph for can_types.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

## Data Structures
struct | CAN_MSG_FIELD
| This data structure used to configure the message fields. Some of the fields formatType and brs data should match with the CAN FD configuration in Melody MCC user interface. More...
struct | CAN_MSG_OBJ
| This data structure used to configure the CAN FD message object. More...

## Enumerations
enum | CAN_MSG_OBJ_BRS_MODE { CAN_NON_BRS_MODE = 0 , CAN_BRS_MODE = 1 }
enum | CAN_MSG_OBJ_ID_TYPE { CAN_FRAME_STD = 0 , CAN_FRAME_EXT = 1 }
enum | CAN_MSG_OBJ_FRAME_TYPE { CAN_FRAME_DATA = 0 , CAN_FRAME_RTR = 1 }
enum | CAN_MSG_OBJ_TYPE { CAN_2_0_FORMAT = 0 , CAN_FD_FORMAT = 1 }
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 }
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 }
enum | CAN_OP_MODE_STATUS { CAN_OP_MODE_REQUEST_SUCCESS , CAN_OP_MODE_REQUEST_FAIL , CAN_OP_MODE_SYS_ERROR_OCCURED }
enum | CAN_TX_FIFO_STATUS { CAN_TX_FIFO_FULL , CAN_TX_FIFO_AVAILABLE }
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 }
enum | CAN_RX_FIFO_STATUS { CAN_RX_MSG_NOT_AVAILABLE = 0x0 , CAN_RX_MSG_AVAILABLE = 0x1 , CAN_RX_MSG_OVERFLOW = 0x8 }

## Detailed Description

CAN Generated Driver Types Header File

Definition in file can_types.h.

## Enumeration Type Documentation

## ◆ CAN_DLC

enum CAN_DLC

Enumerator
DLC_0 | Data length count 0
DLC_1 | Data length count 1
DLC_2 | Data length count 2
DLC_3 | Data length count 3
DLC_4 | Data length count 4
DLC_5 | Data length count 5
DLC_6 | Data length count 6
DLC_7 | Data length count 7
DLC_8 | Data length count 8
DLC_12 | Data length count 12
DLC_16 | Data length count 16
DLC_20 | Data length count 20
DLC_24 | Data length count 24
DLC_32 | Data length count 32
DLC_48 | Data length count 48
DLC_64 | Data length count 64

Definition at line 176 of file can_types.h.

## ◆ CAN_MSG_OBJ_BRS_MODE

enum CAN_MSG_OBJ_BRS_MODE

Enumerator
CAN_NON_BRS_MODE | Disable BRS Mode (Supported only in CAN FD mode)
CAN_BRS_MODE | Enable BRS Mode (Supported only in CAN FD mode)

Definition at line 79 of file can_types.h.

## ◆ CAN_MSG_OBJ_FRAME_TYPE

enum CAN_MSG_OBJ_FRAME_TYPE

Enumerator
CAN_FRAME_DATA | Data Frame CAN message object
CAN_FRAME_RTR | Remote Transmit Request Frame CAN message object

Definition at line 101 of file can_types.h.

## ◆ CAN_MSG_OBJ_ID_TYPE

enum CAN_MSG_OBJ_ID_TYPE

Enumerator
CAN_FRAME_STD | Standard ID CAN message object
CAN_FRAME_EXT | Extended ID CAN message object

Definition at line 90 of file can_types.h.

## ◆ CAN_MSG_OBJ_TYPE

enum CAN_MSG_OBJ_TYPE

Enumerator
CAN_2_0_FORMAT | CAN 2.0 Message format
CAN_FD_FORMAT | CAN FD Message format (Supported only in CAN FD mode)

Definition at line 112 of file can_types.h.

## ◆ CAN_OP_MODE_STATUS

enum CAN_OP_MODE_STATUS

Enumerator
CAN_OP_MODE_REQUEST_SUCCESS | Defines the requested operation mode set successfully
CAN_OP_MODE_REQUEST_FAIL | Defines the requested operation mode set failure. Set configuration mode before setting CAN normal or debug operation mode.
CAN_OP_MODE_SYS_ERROR_OCCURED | Defines the system error occurred while setting operation mode.

Definition at line 153 of file can_types.h.

## ◆ CAN_OP_MODES

enum CAN_OP_MODES

Enumerator
CAN_NORMAL_FD_MODE | CAN FD Normal Operation Mode (Supported only in CAN FD mode)
CAN_DISABLE_MODE | CAN Disable Operation Mode
CAN_INTERNAL_LOOPBACK_MODE | CAN Internal Loopback Operation Mode
CAN_LISTEN_ONLY_MODE | CAN Listen only Operation Mode
CAN_CONFIGURATION_MODE | CAN Configuration Operation Mode
CAN_EXTERNAL_LOOPBACK_MODE | CAN External loopback Operation Mode
CAN_NORMAL_2_0_MODE | CAN 2.0 Operation Mode
CAN_RESTRICTED_OPERATION_MODE | CAN Restricted Operation Mode

Definition at line 136 of file can_types.h.

## ◆ CAN_RX_FIFO_STATUS

enum CAN_RX_FIFO_STATUS

Enumerator
CAN_RX_MSG_NOT_AVAILABLE |
CAN_RX_MSG_AVAILABLE |
CAN_RX_MSG_OVERFLOW |

Definition at line 205 of file can_types.h.

## ◆ CAN_TX_FIFO_STATUS

enum CAN_TX_FIFO_STATUS

Enumerator
CAN_TX_FIFO_FULL | Defines the Transmit FIFO is full
CAN_TX_FIFO_AVAILABLE | Defines the Transmit FIFO is available

Definition at line 165 of file can_types.h.

## ◆ CAN_TX_MSG_REQUEST_STATUS

enum CAN_TX_MSG_REQUEST_STATUS

Enumerator
CAN_TX_MSG_REQUEST_SUCCESS | Transmit message object successfully placed into Transmit FIFO
CAN_TX_MSG_REQUEST_DLC_EXCEED_ERROR | Transmit message object DLC size is more than Transmit FIFO configured DLC size
CAN_TX_MSG_REQUEST_BRS_ERROR | Transmit FIFO is configured has Non BRS mode and CAN TX Message object has BRS enabled
CAN_TX_MSG_REQUEST_FIFO_FULL | Transmit FIFO is Full

Definition at line 123 of file can_types.h.