MTB CAT1 Peripheral driver library

General Description

Enumerations

enum  cy_en_canfd_status_t {
  CY_CANFD_SUCCESS = 0x00U,
  CY_CANFD_BAD_PARAM = CY_CANFD_ID | CY_PDL_STATUS_ERROR | 0x01u,
  CY_CANFD_ERROR_TIMEOUT = CY_CANFD_ID | CY_PDL_STATUS_ERROR | 0x02u
}
 CAN FD status enumeration. More...
 
enum  cy_en_canfd_tx_buffer_status_t {
  CY_CANFD_TX_BUFFER_IDLE = 0u,
  CY_CANFD_TX_BUFFER_PENDING = 1u,
  CY_CANFD_TX_BUFFER_TRANSMIT_OCCURRED = 2u,
  CY_CANFD_TX_BUFFER_CANCEL_REQUESTED = 3u,
  CY_CANFD_TX_BUFFER_CANCEL_FINISHED = 4u
}
 CAN FD Tx Buffer status enumeration. More...
 
enum  cy_en_canfd_buffer_data_size_t {
  CY_CANFD_BUFFER_DATA_SIZE_8 = 0u,
  CY_CANFD_BUFFER_DATA_SIZE_12 = 1u,
  CY_CANFD_BUFFER_DATA_SIZE_16 = 2u,
  CY_CANFD_BUFFER_DATA_SIZE_20 = 3u,
  CY_CANFD_BUFFER_DATA_SIZE_24 = 4u,
  CY_CANFD_BUFFER_DATA_SIZE_32 = 5u,
  CY_CANFD_BUFFER_DATA_SIZE_48 = 6u,
  CY_CANFD_BUFFER_DATA_SIZE_64 = 7u
}
 CAN FD Tx/Rx buffer element size. More...
 
enum  cy_en_canfd_fifo_mode_t {
  CY_CANFD_FIFO_MODE_BLOCKING = 0u,
  CY_CANFD_FIFO_MODE_OVERWRITE = 1u
}
 CAN FD Rx FIFO operating mode. More...
 
enum  cy_en_accept_non_matching_frames_t {
  CY_CANFD_ACCEPT_IN_RXFIFO_0 = 0u,
  CY_CANFD_ACCEPT_IN_RXFIFO_1 = 1u,
  CY_CANFD_REJECT_NON_MATCHING = 2u
}
 CAN FD accept non matching frames. More...
 
enum  cy_en_canfd_id_filter_element_config_t {
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_DISABLE_FILETER_ELEMENT = 0x00u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO0 = 0x01u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO1 = 0x02u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_REJECT_ID = 0x03u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PRIORIY = 0x04u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO0 = 0x05u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO1 = 0x06u,
  CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXBUFF_OR_DEBUGMSG = 0x07u
}
 ID Filter element configuration type. More...
 
enum  cy_en_canfd_std_id_filter_type_t {
  CY_CANFD_STD_ID_FILTER_TYPE_RANGE = 0x00u,
  CY_CANFD_STD_ID_FILTER_TYPE_DUAL = 0x01u,
  CY_CANFD_STD_ID_FILTER_TYPE_CLASSIC = 0x02u
}
 Standard ID filter type. More...
 
enum  cy_en_canfd_ext_id_filter_type_t {
  CY_CANFD_EXT_ID_FILTER_TYPE_RANGE_AND_MASK = 0x00u,
  CY_CANFD_EXT_ID_FILTER_TYPE_DUAL = 0x01u,
  CY_CANFD_EXT_ID_FILTER_TYPE_CLASSIC = 0x02u,
  CY_CANFD_EXT_ID_FILTER_TYPE_RANGE = 0x03u
}
 Extended ID filter type. More...
 
enum  cy_en_canfd_rtr_t {
  CY_CANFD_RTR_DATA_FRAME = 0x00u,
  CY_CANFD_RTR_REMOTE_FRAME = 0x01u
}
 Type for indication of the received frame (Remote Transmission Request) More...
 
enum  cy_en_canfd_xtd_t {
  CY_CANFD_XTD_STANDARD_ID = 0x00u,
  CY_CANFD_XTD_EXTENDED_ID = 0x01u
}
 Extended Identifier type (whether the received frame has a standard or extended identifier) More...
 
enum  cy_en_canfd_esi_t {
  CY_CANFD_ESI_ERROR_ACTIVE = 0x00u,
  CY_CANFD_ESI_ERROR_PASSIVE = 0x01u
}
 Error State Indicator type. More...
 
enum  cy_en_canfd_fdf_t {
  CY_CANFD_FDF_STANDARD_FRAME = 0x00u,
  CY_CANFD_FDF_CAN_FD_FRAME = 0x01u
}
 FD Format type. More...
 
enum  cy_en_canfd_anmf_t {
  CY_CANFD_ANMF_MATCH_FILTER = 0x00u,
  CY_CANFD_ANMF_NOT_MATCH_FILTER = 0x01u
}
 Accepted Non-matching Frame type. More...
 
enum  cy_en_canfd_sfec_t {
  CY_CANFD_SFEC_DISABLE = 0x00u,
  CY_CANFD_SFEC_STORE_RX_FIFO_0 = 0x01u,
  CY_CANFD_SFEC_STORE_RX_FIFO_1 = 0x02u,
  CY_CANFD_SFEC_REJECT_ID = 0x03u,
  CY_CANFD_SFEC_SET_PRIORITY = 0x04u,
  CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_0 = 0x05u,
  CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_1 = 0x06u,
  CY_CANFD_SFEC_STORE_RX_BUFFER = 0x07u
}
 Standard Filter Element Configuration type. More...
 
enum  cy_en_canfd_sft_t {
  CY_CANFD_SFT_RANGE_SFID1_SFID2 = 0x00u,
  CY_CANFD_SFT_DUAL_ID = 0x01u,
  CY_CANFD_SFT_CLASSIC_FILTER = 0x02u,
  CY_CANFD_SFT_DISABLED = 0x03u
}
 Standard Filter Type. More...
 
enum  cy_en_canfd_efec_t {
  CY_CANFD_EFEC_DISABLE = 0x00u,
  CY_CANFD_EFEC_STORE_RX_FIFO_0 = 0x01u,
  CY_CANFD_EFEC_STORE_RX_FIFO_1 = 0x02u,
  CY_CANFD_EFEC_REJECT_ID = 0x03u,
  CY_CANFD_EFEC_SET_PRIORITY = 0x04u,
  CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_0 = 0x05u,
  CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_1 = 0x06u,
  CY_CANFD_EFEC_STORE_RX_BUFFER = 0x07u
}
 Extended Filter Element Configuration type. More...
 
enum  cy_en_canfd_eft_t {
  CY_CANFD_EFT_RANGE_EFID1_EFID2 = 0x00u,
  CY_CANFD_EFT_DUAL_ID = 0x01u,
  CY_CANFD_EFT_CLASSIC_FILTER = 0x02u,
  CY_CANFD_EFT_RANGE_EFID1_EFID2_NO_MSK = 0x03u
}
 Extended Filter Type. More...
 
enum  cy_stc_canfd_test_mode_t {
  CY_CANFD_TEST_MODE_DISABLE = 0x00u,
  CY_CANFD_TEST_MODE_BUS_MONITORING = 0x01u,
  CY_CANFD_TEST_MODE_EXTERNAL_LOOP_BACK = 0x02u,
  CY_CANFD_TEST_MODE_INTERNAL_LOOP_BACK = 0x03u
}
 Test Mode Type. More...
 
enum  cy_en_canfd_LEC_t {
  CY_CANFD_LEC_NO_ERROR = 0x00u,
  CY_CANFD_LEC_STUFF_ERROR = 0x01u,
  CY_CANFD_LEC_FORM_ERROR = 0x02u,
  CY_CANFD_LEC_ACK_ERROR = 0x03u,
  CY_CANFD_LEC_BIT1_ERROR = 0x04u,
  CY_CANFD_LEC_BIT0_ERROR = 0x05u,
  CY_CANFD_LEC_CRC_ERROR = 0x06u,
  CY_CANFD_LEC_NO_CHANGE = 0x07u
}
 Last Error Code and Data Phase Last Error Code Type. More...
 
enum  cy_en_canfd_PSR_ACT_t {
  CY_CANFD_PSR_ACT_SYNC = 0x00u,
  CY_CANFD_PSR_ACT_IDLE = 0x01u,
  CY_CANFD_PSR_ACT_RX = 0x02u,
  CY_CANFD_PSR_ACT_TX = 0x03u
}
 Bus Activity State field of the PSR Used with Cy_CANFD_GetLastError() for ACT field of the Protocol Status Register. More...
 

Enumeration Type Documentation

◆ cy_en_canfd_status_t

CAN FD status enumeration.

Enumerator
CY_CANFD_SUCCESS 

Returned successful.

CY_CANFD_BAD_PARAM 

Bad parameter was passed.

CY_CANFD_ERROR_TIMEOUT 

A Time out error occurred.

◆ cy_en_canfd_tx_buffer_status_t

CAN FD Tx Buffer status enumeration.

Enumerator
CY_CANFD_TX_BUFFER_PENDING 

Pending transmission.

CY_CANFD_TX_BUFFER_TRANSMIT_OCCURRED 

Transmission occurred.

CY_CANFD_TX_BUFFER_CANCEL_REQUESTED 

Cancellation requested.

CY_CANFD_TX_BUFFER_CANCEL_FINISHED 

Cancellation finished.

◆ cy_en_canfd_buffer_data_size_t

CAN FD Tx/Rx buffer element size.

Enumerator
CY_CANFD_BUFFER_DATA_SIZE_8 

8 byte data field

CY_CANFD_BUFFER_DATA_SIZE_12 

12 byte data field

CY_CANFD_BUFFER_DATA_SIZE_16 

16 byte data field

CY_CANFD_BUFFER_DATA_SIZE_20 

20 byte data field

CY_CANFD_BUFFER_DATA_SIZE_24 

24 byte data field

CY_CANFD_BUFFER_DATA_SIZE_32 

32 byte data field

CY_CANFD_BUFFER_DATA_SIZE_48 

48 byte data field

CY_CANFD_BUFFER_DATA_SIZE_64 

64 byte data field

◆ cy_en_canfd_fifo_mode_t

CAN FD Rx FIFO operating mode.

Enumerator
CY_CANFD_FIFO_MODE_BLOCKING 

FIFO blocking mode.

CY_CANFD_FIFO_MODE_OVERWRITE 

FIFO overwrite mode.

◆ cy_en_accept_non_matching_frames_t

CAN FD accept non matching frames.

Enumerator
CY_CANFD_ACCEPT_IN_RXFIFO_0 

Accept in Rx FIFO 0.

CY_CANFD_ACCEPT_IN_RXFIFO_1 

Accept in Rx FIFO 1.

CY_CANFD_REJECT_NON_MATCHING 

Reject the frames.

◆ cy_en_canfd_id_filter_element_config_t

ID Filter element configuration type.

Enumerator
CY_CANFD_ID_FILTER_ELEMNT_CONFIG_DISABLE_FILETER_ELEMENT 

Disable filter element.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO0 

Store in Rx FIFO 0, if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO1 

Store in Rx FIFO 1, if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_REJECT_ID 

Reject ID if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PRIORIY 

Set priority if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO0 

Set priority and store in FIFO 0, if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO1 

Set priority and store in FIFO 1, if filter matches.

CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXBUFF_OR_DEBUGMSG 

Store into Rx Buffer or as debug message, configuration of SFT[1:0] ignored.

◆ cy_en_canfd_std_id_filter_type_t

Standard ID filter type.

Enumerator
CY_CANFD_STD_ID_FILTER_TYPE_RANGE 

The Range filter from SFID1 to SFID2 (SFID2 = SFID1)

CY_CANFD_STD_ID_FILTER_TYPE_DUAL 

The Dual ID filter for SFID1 or SFID2.

CY_CANFD_STD_ID_FILTER_TYPE_CLASSIC 

The Classic filter: SFID1 = filter, SFID2 = mask.

◆ cy_en_canfd_ext_id_filter_type_t

Extended ID filter type.

Enumerator
CY_CANFD_EXT_ID_FILTER_TYPE_RANGE_AND_MASK 

The range filter from EFID1 to EFID2 (EFID2 = EFID1)

CY_CANFD_EXT_ID_FILTER_TYPE_DUAL 

The dual ID filter for EFID1 or EFID2.

CY_CANFD_EXT_ID_FILTER_TYPE_CLASSIC 

The classic filter: EFID1 = filter, EFID2 = mask.

CY_CANFD_EXT_ID_FILTER_TYPE_RANGE 

The range filter from EFID1 to EFID2 (EFID2 = EFID1), XIDAM mask not applied.

◆ cy_en_canfd_rtr_t

Type for indication of the received frame (Remote Transmission Request)

Enumerator
CY_CANFD_RTR_DATA_FRAME 

The received frame is a data frame.

CY_CANFD_RTR_REMOTE_FRAME 

The received frame is a remote frame.

◆ cy_en_canfd_xtd_t

Extended Identifier type (whether the received frame has a standard or extended identifier)

Enumerator
CY_CANFD_XTD_STANDARD_ID 

The 11-bit standard identifier.

CY_CANFD_XTD_EXTENDED_ID 

The 29-bit extended identifier.

◆ cy_en_canfd_esi_t

Error State Indicator type.

Enumerator
CY_CANFD_ESI_ERROR_ACTIVE 

The transmitting node is error active.

CY_CANFD_ESI_ERROR_PASSIVE 

The transmitting node is error passive.

◆ cy_en_canfd_fdf_t

FD Format type.

Enumerator
CY_CANFD_FDF_STANDARD_FRAME 

The standard frame format.

CY_CANFD_FDF_CAN_FD_FRAME 

The CAN FD frame format (new DLC-coding and CRC)

◆ cy_en_canfd_anmf_t

Accepted Non-matching Frame type.

Enumerator
CY_CANFD_ANMF_MATCH_FILTER 

The received frame matching filter index FIDX.

CY_CANFD_ANMF_NOT_MATCH_FILTER 

The received frame did not match any Rx filter element.

◆ cy_en_canfd_sfec_t

Standard Filter Element Configuration type.

Enumerator
CY_CANFD_SFEC_DISABLE 

Disable the filter element.

CY_CANFD_SFEC_STORE_RX_FIFO_0 

Store in Rx FIFO 0 if the filter matches.

CY_CANFD_SFEC_STORE_RX_FIFO_1 

Store in Rx FIFO 1 if the filter matches.

CY_CANFD_SFEC_REJECT_ID 

Reject ID if the filter matches.

CY_CANFD_SFEC_SET_PRIORITY 

Set priority if the filter matches.

CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_0 

Set priority and store in FIFO 0 if the filter matches.

CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_1 

Set priority and store in FIFO 1 if filter matches.

CY_CANFD_SFEC_STORE_RX_BUFFER 

Store into Rx Buffer or as debug message, configuration of SFT[1:0] ignored.

◆ cy_en_canfd_sft_t

Standard Filter Type.

Enumerator
CY_CANFD_SFT_RANGE_SFID1_SFID2 

The range filter from SFID1 to SFID2 (SFID2 >= SFID1)

CY_CANFD_SFT_DUAL_ID 

The Dual ID filter for SFID1 or SFID2.

CY_CANFD_SFT_CLASSIC_FILTER 

The Classic filter: SFID1 = filter, SFID2 = mask.

CY_CANFD_SFT_DISABLED 

The Filter element disabled.

◆ cy_en_canfd_efec_t

Extended Filter Element Configuration type.

Enumerator
CY_CANFD_EFEC_DISABLE 

Disable the filter element.

CY_CANFD_EFEC_STORE_RX_FIFO_0 

Store in Rx FIFO 0 if the filter matches.

CY_CANFD_EFEC_STORE_RX_FIFO_1 

Store in Rx FIFO 1 if the filter matches.

CY_CANFD_EFEC_REJECT_ID 

Reject ID if the filter matches.

CY_CANFD_EFEC_SET_PRIORITY 

Set priority if the filter matches.

CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_0 

Set priority and store in FIFO 0 if the filter matches.

CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_1 

Set priority and store in FIFO 1 if filter matches.

CY_CANFD_EFEC_STORE_RX_BUFFER 

Store into Rx Buffer or as debug message, configuration of EFT[1:0] ignored.

◆ cy_en_canfd_eft_t

Extended Filter Type.

Enumerator
CY_CANFD_EFT_RANGE_EFID1_EFID2 

The range filter from EFID1 to EFID2 (EFID2 >= EFID1)

CY_CANFD_EFT_DUAL_ID 

The Dual ID filter for EFID1 or EFID2.

CY_CANFD_EFT_CLASSIC_FILTER 

The Classic filter: EFID1 = filter, EFID2 = mask.

CY_CANFD_EFT_RANGE_EFID1_EFID2_NO_MSK 

The range filter from EFID1 to EFID2 (EFID2 >= EFID1), XIDAM mask not applied.

◆ cy_stc_canfd_test_mode_t

Test Mode Type.

Enumerator
CY_CANFD_TEST_MODE_DISABLE 

The normal operation.

Test Mode is disabled

CY_CANFD_TEST_MODE_BUS_MONITORING 

The Bus Monitoring Mode.

CY_CANFD_TEST_MODE_EXTERNAL_LOOP_BACK 

The External Loop Back Mode.

CY_CANFD_TEST_MODE_INTERNAL_LOOP_BACK 

The Internal Loop Back Mode.

◆ cy_en_canfd_LEC_t

Last Error Code and Data Phase Last Error Code Type.


Used with Cy_CANFD_GetLastError() for LEC and DLEC fields of the Protocol Status Register.

Enumerator
CY_CANFD_LEC_NO_ERROR 

No error occurred since LEC was reset by successful reception or transmission.

CY_CANFD_LEC_STUFF_ERROR 

More than 5 equal bits in a sequence occurred in a part of a received message.

CY_CANFD_LEC_FORM_ERROR 

A fixed format part of a received frame has the wrong format.

CY_CANFD_LEC_ACK_ERROR 

The message this CAN FD Core transmitted was not acknowledged by another node.

CY_CANFD_LEC_BIT1_ERROR 

While trying to send a recessive bit (1) a dominant level (0) was sampled.

CY_CANFD_LEC_BIT0_ERROR 

While trying to send a dominant bit (0) a recessive level (1) was sampled.

CY_CANFD_LEC_CRC_ERROR 

The CRC checksum was incorrect.

CY_CANFD_LEC_NO_CHANGE 

No CAN bus event was detected since the last CPU read access to the Protocol Status Register.

◆ cy_en_canfd_PSR_ACT_t

Bus Activity State field of the PSR Used with Cy_CANFD_GetLastError() for ACT field of the Protocol Status Register.

Enumerator
CY_CANFD_PSR_ACT_SYNC 

The node is synchronizing on CAN communication.

CY_CANFD_PSR_ACT_IDLE 

The node is neither receiver nor transmitter.

CY_CANFD_PSR_ACT_RX 

The node is operating as receiver.

CY_CANFD_PSR_ACT_TX 

The node is operating as transmitter.