Enumerated Types

group group_canfd_enums

Enums

enum cy_en_canfd_status_t

cy_en_canfd_status_t: CAN FD status enumeration.

Values:

enumerator CY_CANFD_SUCCESS

Returned successful.

enumerator CY_CANFD_BAD_PARAM

Bad parameter was passed.

enumerator CY_CANFD_ERROR_TIMEOUT

A Time out error occurred.

enum cy_en_canfd_tx_buffer_status_t

cy_en_canfd_tx_buffer_status_t: CAN FD Tx Buffer status enumeration.

Values:

enumerator CY_CANFD_TX_BUFFER_IDLE

enumerator CY_CANFD_TX_BUFFER_PENDING

Pending transmission.

enumerator CY_CANFD_TX_BUFFER_TRANSMIT_OCCURRED

Transmission occurred.

enumerator CY_CANFD_TX_BUFFER_CANCEL_REQUESTED

Cancellation requested.

enumerator CY_CANFD_TX_BUFFER_CANCEL_FINISHED

Cancellation finished.

enum cy_en_canfd_buffer_data_size_t

cy_en_canfd_buffer_data_size_t: CAN FD Tx/Rx buffer element size.

Values:

enumerator CY_CANFD_BUFFER_DATA_SIZE_8

8 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_12

12 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_16

16 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_20

20 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_24

24 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_32

32 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_48

48 byte data field

enumerator CY_CANFD_BUFFER_DATA_SIZE_64

64 byte data field

enum cy_en_canfd_fifo_mode_t

cy_en_canfd_fifo_mode_t: CAN FD Rx FIFO operating mode.

Values:

enumerator CY_CANFD_FIFO_MODE_BLOCKING

FIFO blocking mode.

enumerator CY_CANFD_FIFO_MODE_OVERWRITE

FIFO overwrite mode.

enum cy_en_accept_non_matching_frames_t

cy_en_accept_non_matching_frames_t: CAN FD accept non matching frames.

Values:

enumerator CY_CANFD_ACCEPT_IN_RXFIFO_0

Accept in Rx FIFO 0.

enumerator CY_CANFD_ACCEPT_IN_RXFIFO_1

Accept in Rx FIFO 1.

enumerator CY_CANFD_REJECT_NON_MATCHING

Reject the frames.

enum cy_en_canfd_id_filter_element_config_t

cy_en_canfd_id_filter_element_config_t: ID Filter element configuration type.

Values:

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_DISABLE_FILETER_ELEMENT

Disable filter element.

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO0

Store in Rx FIFO 0, if filter matches.

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXFIFO1

Store in Rx FIFO 1, if filter matches.

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_REJECT_ID

Reject ID if filter matches.

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PRIORIY

Set priority if filter matches.

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO0

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

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_SET_PIORITY_STORE_RXFIFO1

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

enumerator CY_CANFD_ID_FILTER_ELEMNT_CONFIG_STORE_RXBUFF_OR_DEBUGMSG

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

enum cy_en_canfd_std_id_filter_type_t

cy_en_canfd_std_id_filter_type_t: Standard ID filter type.

Values:

enumerator CY_CANFD_STD_ID_FILTER_TYPE_RANGE

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

enumerator CY_CANFD_STD_ID_FILTER_TYPE_DUAL

The Dual ID filter for SFID1 or SFID2.

enumerator CY_CANFD_STD_ID_FILTER_TYPE_CLASSIC

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

enum cy_en_canfd_ext_id_filter_type_t

cy_en_canfd_ext_id_filter_type_t: Extended ID filter type.

Values:

enumerator CY_CANFD_EXT_ID_FILTER_TYPE_RANGE_AND_MASK

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

enumerator CY_CANFD_EXT_ID_FILTER_TYPE_DUAL

The dual ID filter for EFID1 or EFID2.

enumerator CY_CANFD_EXT_ID_FILTER_TYPE_CLASSIC

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

enumerator CY_CANFD_EXT_ID_FILTER_TYPE_RANGE

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

enum cy_en_canfd_rtr_t

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

Values:

enumerator CY_CANFD_RTR_DATA_FRAME

The received frame is a data frame.

enumerator CY_CANFD_RTR_REMOTE_FRAME

The received frame is a remote frame.

enum cy_en_canfd_xtd_t

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

Values:

enumerator CY_CANFD_XTD_STANDARD_ID

The 11-bit standard identifier.

enumerator CY_CANFD_XTD_EXTENDED_ID

The 29-bit extended identifier.

enum cy_en_canfd_esi_t

cy_en_canfd_esi_t: Error State Indicator type.

Values:

enumerator CY_CANFD_ESI_ERROR_ACTIVE

The transmitting node is error active.

enumerator CY_CANFD_ESI_ERROR_PASSIVE

The transmitting node is error passive.

enum cy_en_canfd_fdf_t

cy_en_canfd_fdf_t: FD Format type.

Values:

enumerator CY_CANFD_FDF_STANDARD_FRAME

The standard frame format.

enumerator CY_CANFD_FDF_CAN_FD_FRAME

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

enum cy_en_canfd_anmf_t

cy_en_canfd_anmf_t: Accepted Non-matching Frame type.

Values:

enumerator CY_CANFD_ANMF_MATCH_FILTER

The received frame matching filter index FIDX.

enumerator CY_CANFD_ANMF_NOT_MATCH_FILTER

The received frame did not match any Rx filter element.

enum cy_en_canfd_sfec_t

cy_en_canfd_sfec_t: Standard Filter Element Configuration type.

Values:

enumerator CY_CANFD_SFEC_DISABLE

Disable the filter element.

enumerator CY_CANFD_SFEC_STORE_RX_FIFO_0

Store in Rx FIFO 0 if the filter matches.

enumerator CY_CANFD_SFEC_STORE_RX_FIFO_1

Store in Rx FIFO 1 if the filter matches.

enumerator CY_CANFD_SFEC_REJECT_ID

Reject ID if the filter matches.

enumerator CY_CANFD_SFEC_SET_PRIORITY

Set priority if the filter matches.

enumerator CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_0

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

enumerator CY_CANFD_SFEC_SET_PRIORITY_STORE_FIFO_1

Set priority and store in FIFO 1 if filter matches.

enumerator CY_CANFD_SFEC_STORE_RX_BUFFER

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

enum cy_en_canfd_sft_t

cy_en_canfd_sft_t: Standard Filter Type.

Values:

enumerator CY_CANFD_SFT_RANGE_SFID1_SFID2

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

enumerator CY_CANFD_SFT_DUAL_ID

The Dual ID filter for SFID1 or SFID2.

enumerator CY_CANFD_SFT_CLASSIC_FILTER

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

enumerator CY_CANFD_SFT_DISABLED

The Filter element disabled.

enum cy_en_canfd_efec_t

cy_en_canfd_efec_t: Extended Filter Element Configuration type.

Values:

enumerator CY_CANFD_EFEC_DISABLE

Disable the filter element.

enumerator CY_CANFD_EFEC_STORE_RX_FIFO_0

Store in Rx FIFO 0 if the filter matches.

enumerator CY_CANFD_EFEC_STORE_RX_FIFO_1

Store in Rx FIFO 1 if the filter matches.

enumerator CY_CANFD_EFEC_REJECT_ID

Reject ID if the filter matches.

enumerator CY_CANFD_EFEC_SET_PRIORITY

Set priority if the filter matches.

enumerator CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_0

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

enumerator CY_CANFD_EFEC_SET_PRIORITY_STORE_FIFO_1

Set priority and store in FIFO 1 if filter matches.

enumerator CY_CANFD_EFEC_STORE_RX_BUFFER

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

enum cy_en_canfd_eft_t

cy_en_canfd_eft_t: Extended Filter Type.

Values:

enumerator CY_CANFD_EFT_RANGE_EFID1_EFID2

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

enumerator CY_CANFD_EFT_DUAL_ID

The Dual ID filter for EFID1 or EFID2.

enumerator CY_CANFD_EFT_CLASSIC_FILTER

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

enumerator CY_CANFD_EFT_RANGE_EFID1_EFID2_NO_MSK

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

enum cy_stc_canfd_test_mode_t

cy_stc_canfd_test_mode_t: Test Mode Type.

Values:

enumerator CY_CANFD_TEST_MODE_DISABLE

The normal operation.

Test Mode is disabled

enumerator CY_CANFD_TEST_MODE_BUS_MONITORING

The Bus Monitoring Mode.

enumerator CY_CANFD_TEST_MODE_EXTERNAL_LOOP_BACK

The External Loop Back Mode.

enumerator CY_CANFD_TEST_MODE_INTERNAL_LOOP_BACK

The Internal Loop Back Mode.

enum cy_en_canfd_LEC_t

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.

Values:

enumerator CY_CANFD_LEC_NO_ERROR

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

enumerator CY_CANFD_LEC_STUFF_ERROR

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

enumerator CY_CANFD_LEC_FORM_ERROR

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

enumerator CY_CANFD_LEC_ACK_ERROR

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

enumerator CY_CANFD_LEC_BIT1_ERROR

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

enumerator CY_CANFD_LEC_BIT0_ERROR

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

enumerator CY_CANFD_LEC_CRC_ERROR

The CRC checksum was incorrect.

enumerator CY_CANFD_LEC_NO_CHANGE

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

enum cy_en_canfd_PSR_ACT_t

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.

Values:

enumerator CY_CANFD_PSR_ACT_SYNC

The node is synchronizing on CAN communication.

enumerator CY_CANFD_PSR_ACT_IDLE

The node is neither receiver nor transmitter.

enumerator CY_CANFD_PSR_ACT_RX

The node is operating as receiver.

enumerator CY_CANFD_PSR_ACT_TX

The node is operating as transmitter.