CAT2 Peripheral Driver Library

Enumerations

enum  cy_en_can_status_t {
  CY_CAN_SUCCESS = 0x00U,
  CY_CAN_BAD_PARAM = CY_CAN_ID | CY_PDL_STATUS_ERROR | 0x01u,
  CY_CAN_ERROR_TIMEOUT = CY_CAN_ID | CY_PDL_STATUS_ERROR | 0x02u,
  CY_CAN_NOT_STARTED = CY_CAN_ID | CY_PDL_STATUS_ERROR | 0x03u,
  CY_CAN_BUSY = CY_CAN_ID | CY_PDL_STATUS_ERROR | 0x04u
}
 CAN status enumeration. More...
 
enum  cy_en_can_rtr_t {
  CY_CAN_RTR_DATA_FRAME = 0x00u,
  CY_CAN_RTR_REMOTE_FRAME = 0x01u
}
 Type for indication of the received frame (Remote Transmission Request) More...
 
enum  cy_en_can_ide_t {
  CY_CAN_IDE_STANDARD_ID = 0x00u,
  CY_CAN_IDE_EXTENDED_ID = 0x01u
}
 IDE format type (whether the received frame has a standard or extended identifier) More...
 
enum  cy_en_can_rx_buffer_status_t {
  CY_CAN_RX_BUFFER_EMPTY = 0u,
  CY_CAN_RX_BUFFER_FILLED = 1u
}
 CAN Rx Buffer status enumeration. More...
 
enum  cy_en_can_tx_buffer_status_t {
  CY_CAN_TX_BUFFER_IDLE = 0u,
  CY_CAN_TX_BUFFER_PENDING = 1u
}
 CAN Tx Buffer status enumeration. More...
 
enum  cy_en_can_sampling_t {
  CY_CAN_SAMPLING_MODE_1 = 0u,
  CY_CAN_SAMPLING_MODE_3 = 1u
}
 Bit sampling mode type. More...
 
enum  cy_en_can_edgemode_t {
  CY_CAN_EDGE_R_TO_D = 0u,
  CY_CAN_BOTH_EDGE = 1u
}
 Synchronization logic type. More...
 
enum  cy_en_can_arbiter_t {
  CY_CAN_ROUND_ROBIN = 0u,
  CY_CAN_FIXED_PRIORITY = 1u
}
 Tx Buffer arbitration scheme type. More...
 
enum  cy_en_can_endian_t {
  CY_CAN_BIG_ENDIAN = 0u,
  CY_CAN_LITTLE_ENDIAN = 1u
}
 Byte Endianness of the data field type. More...
 
enum  cy_en_can_busoff_restart_t {
  CY_CAN_MANUAL = 0u,
  CY_CAN_AUTOMATIC = 1u
}
 Bus-off automatic restart type. More...
 
enum  cy_en_can_test_mode_t {
  CY_CAN_TEST_MODE_DISABLE = 0u,
  CY_CAN_TEST_MODE_LISTEN = 1u,
  CY_CAN_TEST_MODE_EXTERNAL_LOOP_BACK = 2u,
  CY_CAN_TEST_MODE_INTERNAL_LOOP_BACK = 3u
}
 Test mode type. More...
 
enum  cy_en_can_lec_t {
  CY_CAN_LEC_ARBITRATION_LOSS = 0x00u,
  CY_CAN_LEC_BIT_ERROR = 0x01u,
  CY_CAN_LEC_STUFF_ERROR = 0x02u,
  CY_CAN_LEC_ACK_ERROR = 0x03u,
  CY_CAN_LEC_FORM_ERROR = 0x04u,
  CY_CAN_LEC_CRC_ERROR = 0x05u
}
 Last Error Code Type. More...
 

Detailed Description

Enumeration Type Documentation

◆ cy_en_can_status_t

CAN status enumeration.

Enumerator
CY_CAN_SUCCESS 

Returned successful.

CY_CAN_BAD_PARAM 

Bad parameter was passed.

CY_CAN_ERROR_TIMEOUT 

A Time out error occurred.

CY_CAN_NOT_STARTED 

CAN controller is not started.

CY_CAN_BUSY 

Tx Buffer is being sent.

◆ cy_en_can_rtr_t

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

Enumerator
CY_CAN_RTR_DATA_FRAME 

The received frame is a data frame.

CY_CAN_RTR_REMOTE_FRAME 

The received frame is a remote frame.

◆ cy_en_can_ide_t

IDE format type (whether the received frame has a standard or extended identifier)

Enumerator
CY_CAN_IDE_STANDARD_ID 

The 11-bit standard identifier.

CY_CAN_IDE_EXTENDED_ID 

The 29-bit extended identifier.

◆ cy_en_can_rx_buffer_status_t

CAN Rx Buffer status enumeration.

Enumerator
CY_CAN_RX_BUFFER_EMPTY 

Rx Buffer is empty.

CY_CAN_RX_BUFFER_FILLED 

Rx Buffer contains received data.

◆ cy_en_can_tx_buffer_status_t

CAN Tx Buffer status enumeration.

Enumerator
CY_CAN_TX_BUFFER_IDLE 

Tx Buffer is idle.

CY_CAN_TX_BUFFER_PENDING 

Tx Buffer is waiting to be sent.

◆ cy_en_can_sampling_t

Bit sampling mode type.

Enumerator
CY_CAN_SAMPLING_MODE_1 

Single sampling point.

CY_CAN_SAMPLING_MODE_3 

3 sampling points with majority decision

◆ cy_en_can_edgemode_t

Synchronization logic type.

Enumerator
CY_CAN_EDGE_R_TO_D 

Edge from R to D.

CY_CAN_BOTH_EDGE 

Both edge.

◆ cy_en_can_arbiter_t

Tx Buffer arbitration scheme type.

Enumerator
CY_CAN_ROUND_ROBIN 

Round robin arbitration.

CY_CAN_FIXED_PRIORITY 

Fixed priority arbitration.

◆ cy_en_can_endian_t

Byte Endianness of the data field type.

Enumerator
CY_CAN_BIG_ENDIAN 

Big endian.

CY_CAN_LITTLE_ENDIAN 

Little endian.

◆ cy_en_can_busoff_restart_t

Bus-off automatic restart type.

Enumerator
CY_CAN_MANUAL 

After bus-off, the controller remains stopped.

CY_CAN_AUTOMATIC 

After bus-off, the controller will automatically restart.

◆ cy_en_can_test_mode_t

Test mode type.

Enumerator
CY_CAN_TEST_MODE_DISABLE 

Normal operation.

CY_CAN_TEST_MODE_LISTEN 

Listen-only mode.

CY_CAN_TEST_MODE_EXTERNAL_LOOP_BACK 

External loopback mode.

CY_CAN_TEST_MODE_INTERNAL_LOOP_BACK 

Internal loopback mode.

◆ cy_en_can_lec_t

Last Error Code Type.


Used with Cy_CAN_GetErrorCapture() for ERROR_TYPE fields of the Error Capture Register.

Enumerator
CY_CAN_LEC_ARBITRATION_LOSS 

Arbitration loss.

CY_CAN_LEC_BIT_ERROR 

Bit error.

CY_CAN_LEC_STUFF_ERROR 

Bit stuff error.

CY_CAN_LEC_ACK_ERROR 

Acknowledge error.

CY_CAN_LEC_FORM_ERROR 

Form error.

CY_CAN_LEC_CRC_ERROR 

CRC error.