Enumerated Types

Enumerations
enum	cy_en_isouart_event_t {   CY_ISOUART_EVENT_NONE = 0U,   CY_ISOUART_EVENT_WRITE = 1U,   CY_ISOUART_EVENT_EARLY_READ = 2U,   CY_ISOUART_EVENT_LATE_READ = 3U }
	Iso UART event types. More...
enum	cy_en_isouart_interface_side_t {   CY_ISOUART_IF_LOW = 0U,   CY_ISOUART_IF_HIGH = 1U }
	Interface side to be read. More...
enum	cy_en_isouart_crc_policy_t {   CY_ISOUART_CRC8_SAE_J1850 = 0U,   CY_ISOUART_CRC8_H2F = 1U }
	Configure the CRC Polynomial. More...
enum	cy_en_isouart_chain_topology_t {   CY_ISOUART_MOT = 0U,   CY_ISOUART_MOB = 1U,   CY_ISOUART_MOT_RING = 2U,   CY_ISOUART_MOB_RING = 3U }
	Configure the Topology of iso UART chain. More...
enum	cy_en_isouart_host_bitrate_t {   CY_ISOUART_HOST_BITRATE_2_1MBPS = 0U,   CY_ISOUART_HOST_BITRATE_3_0MBPS = 1U }
	Configure the data rate of the iso UART chain. More...
enum	cy_en_isouart_receiver_mode_t {   CY_ISOUART_RECEIVER_MODE_REGISTER = 0U,   CY_ISOUART_RECEIVER_MODE_UNPACKED = 1U,   CY_ISOUART_RECEIVER_MODE_RAW = 2U }
	Configure how received data is processed. More...
enum	cy_en_isouart_interface_state_t {   CY_ISOUART_INTERFACE_STATE_SLEEP = 0U,   CY_ISOUART_INTERFACE_STATE_INIT = 1U,   CY_ISOUART_INTERFACE_STATE_IDLE = 2U,   CY_ISOUART_INTERFACE_STATE_REQUEST = 3U,   CY_ISOUART_INTERFACE_STATE_REVERSE = 4U,   CY_ISOUART_INTERFACE_STATE_REPLY = 5U,   CY_ISOUART_INTERFACE_STATE_BC_WAIT = 6U,   CY_ISOUART_INTERFACE_STATE_BC_REPLY = 7U,   CY_ISOUART_INTERFACE_STATE_BC_REVERSE = 8U,   CY_ISOUART_INTERFACE_STATE_EMM = 9U }
	High-level interface state of the iso UART. More...
enum	cy_en_isouart_request_state_t {   CY_ISOUART_REQUEST_STATE_BLOCK_ID = 0U,   CY_ISOUART_REQUEST_STATE_DEVICE_ID = 1U,   CY_ISOUART_REQUEST_STATE_ADDR = 2U,   CY_ISOUART_REQUEST_STATE_DATA1 = 3U,   CY_ISOUART_REQUEST_STATE_DATA0 = 4U,   CY_ISOUART_REQUEST_STATE_CRC = 5U }
	Sub-state of a host request sequence. More...
enum	cy_en_isouart_reply_state_t {   CY_ISOUART_REPLY_STATE_REPLY_FRAME = 0U,   CY_ISOUART_REPLY_STATE_ID_FRAME = 1U,   CY_ISOUART_REPLY_STATE_ADDR_FRAME = 2U,   CY_ISOUART_REPLY_STATE_DATA1_FRAME = 3U,   CY_ISOUART_REPLY_STATE_DATA0_FRAME = 4U,   CY_ISOUART_REPLY_STATE_CRC_FRAME = 5U }
	Sub-state of a a reply frame sequence. More...
enum	cy_en_isouart_host_command_t {   CY_ISOUART_HOST_COMMAND_WRITE = 0U,   CY_ISOUART_HOST_COMMAND_BC_WRITE = 1U,   CY_ISOUART_HOST_COMMAND_READ = 2U,   CY_ISOUART_HOST_COMMAND_MULTI_READ = 3U,   CY_ISOUART_HOST_COMMAND_BC_READ = 4U,   CY_ISOUART_HOST_COMMAND_BC_MULTI_READ = 5U }
	Last host command type observed on the bus. More...
enum	cy_en_isouart_ecc_error_t {   CY_ISOUART_ECC_NO_ERROR = 0U,   CY_ISOUART_ECC_CORRECTED = 1U,   CY_ISOUART_ECC_NOT_CORRECTED = 2U }
	ECC error types. More...
enum	cy_en_isouart_wakeup_source_t {   CY_ISOUART_WAKEUP_ISOUART = 0U,   CY_ISOUART_WAKEUP_GPIO = 1U }
	Wakeup source types. More...

Detailed Description

Enumeration Type Documentation

cy_en_isouart_event_t

enum cy_en_isouart_event_t

Iso UART event types.

Enumerator
CY_ISOUART_EVENT_NONE	No trigger (interrupt)
CY_ISOUART_EVENT_WRITE	Trigger (interrupt) on a write event.
CY_ISOUART_EVENT_EARLY_READ	Trigger (interrupt) on an early read event.
CY_ISOUART_EVENT_LATE_READ	Trigger (interrupt) on a late read event.

cy_en_isouart_interface_side_t

enum cy_en_isouart_interface_side_t

Interface side to be read.

Enumerator
CY_ISOUART_IF_LOW	Low Interface.
CY_ISOUART_IF_HIGH	High Interface.

cy_en_isouart_crc_policy_t

enum cy_en_isouart_crc_policy_t

Configure the CRC Polynomial.

Enumerator
CY_ISOUART_CRC8_SAE_J1850	CRC8 SAE J1850: z^8 + z^4 + z^3 + z^2 + 1.
CY_ISOUART_CRC8_H2F	CRC8 H2F 0x2F polynomial: x^8 + x^5 + x^3 + x^2 + x + 1.

cy_en_isouart_chain_topology_t

enum cy_en_isouart_chain_topology_t

Configure the Topology of iso UART chain.

Enumerator
CY_ISOUART_MOT	Host On Top.
CY_ISOUART_MOB	Host On Bottom.
CY_ISOUART_MOT_RING	Host On Top with Ring configuration.
CY_ISOUART_MOB_RING	Host On Bottom with Ring configuration.

cy_en_isouart_host_bitrate_t

enum cy_en_isouart_host_bitrate_t

Configure the data rate of the iso UART chain.

Enumerator
CY_ISOUART_HOST_BITRATE_2_1MBPS	2.1 Mbps
CY_ISOUART_HOST_BITRATE_3_0MBPS	3.0 Mbps

cy_en_isouart_receiver_mode_t

enum cy_en_isouart_receiver_mode_t

Configure how received data is processed.

Enumerator
CY_ISOUART_RECEIVER_MODE_REGISTER	Register mode - Stored in respective RECEIVED register only.
CY_ISOUART_RECEIVER_MODE_UNPACKED	Unpacked mode - Unpacked, with Data field being stored in local SRAM.
CY_ISOUART_RECEIVER_MODE_RAW	Raw mode - Raw register values stored in local SRAM. This allows for end (slave) to end (ASIL-D host) data integrity to be maintained.

cy_en_isouart_interface_state_t

enum cy_en_isouart_interface_state_t

High-level interface state of the iso UART.

Enumerator
CY_ISOUART_INTERFACE_STATE_SLEEP	Interface in SLEEP (low power, waiting for a wake sequence).
CY_ISOUART_INTERFACE_STATE_INIT	INIT: Wake detected, interface initializing.
CY_ISOUART_INTERFACE_STATE_IDLE	IDLE: Ready, no frame in progress.
CY_ISOUART_INTERFACE_STATE_REQUEST	REQUEST: Host request (SYNC through CRC of request).
CY_ISOUART_INTERFACE_STATE_REVERSE	REVERSE: Upstream device transmitting (node replying).
CY_ISOUART_INTERFACE_STATE_REPLY	REPLY: This device transmitting a reply.
CY_ISOUART_INTERFACE_STATE_BC_WAIT	BC_WAIT: Waiting for broadcast reply from downstream devices.
CY_ISOUART_INTERFACE_STATE_BC_REPLY	BC_REPLY: This device sending broadcast reply.
CY_ISOUART_INTERFACE_STATE_BC_REVERSE	BC_REVERSE: Upstream sending broadcast reply.
CY_ISOUART_INTERFACE_STATE_EMM	EMM: Error management message being transmitted.

cy_en_isouart_request_state_t

enum cy_en_isouart_request_state_t

Sub-state of a host request sequence.

Note

Valid only when interface state is CY_ISOUART_INTERFACE_STATE_REQUEST.

Enumerator
CY_ISOUART_REQUEST_STATE_BLOCK_ID	Sending SYNC frame / BLOCK ID (if enabled).
CY_ISOUART_REQUEST_STATE_DEVICE_ID	Sending DEVICE ID frame.
CY_ISOUART_REQUEST_STATE_ADDR	Sending ADDRESS frame.
CY_ISOUART_REQUEST_STATE_DATA1	Sending DATA1 frame (high byte).
CY_ISOUART_REQUEST_STATE_DATA0	Sending DATA0 frame (low byte).
CY_ISOUART_REQUEST_STATE_CRC	Sending CRC frame.

cy_en_isouart_reply_state_t

enum cy_en_isouart_reply_state_t

Sub-state of a a reply frame sequence.

Note

Valid only when interface state is one of: CY_ISOUART_INTERFACE_STATE_REPLY, CY_ISOUART_INTERFACE_STATE_BC_WAIT, CY_ISOUART_INTERFACE_STATE_BC_REPLY, CY_ISOUART_INTERFACE_STATE_BC_REVERSE,

Enumerator
CY_ISOUART_REPLY_STATE_REPLY_FRAME	Sending REPLY frame.
CY_ISOUART_REPLY_STATE_ID_FRAME	Sending ID frame.
CY_ISOUART_REPLY_STATE_ADDR_FRAME	Sending ADDRESS frame.
CY_ISOUART_REPLY_STATE_DATA1_FRAME	Sending DATA1 frame (high byte).
CY_ISOUART_REPLY_STATE_DATA0_FRAME	Sending DATA0 frame (low byte).
CY_ISOUART_REPLY_STATE_CRC_FRAME	Sending CRC frame.

cy_en_isouart_host_command_t

enum cy_en_isouart_host_command_t

Last host command type observed on the bus.

Note

Valid when the interface state indicates a transmit phase for a slave: CY_ISOUART_INTERFACE_STATE_REVERSE, CY_ISOUART_INTERFACE_STATE_REPLY, CY_ISOUART_INTERFACE_STATE_BC_WAIT, CY_ISOUART_INTERFACE_STATE_BC_REPLY, CY_ISOUART_INTERFACE_STATE_BC_REVERSE.

Enumerator
CY_ISOUART_HOST_COMMAND_WRITE	Write command.
CY_ISOUART_HOST_COMMAND_BC_WRITE	Broadcast Write command.
CY_ISOUART_HOST_COMMAND_READ	Read command.
CY_ISOUART_HOST_COMMAND_MULTI_READ	Multi-Read command.
CY_ISOUART_HOST_COMMAND_BC_READ	Broadcast Read command.
CY_ISOUART_HOST_COMMAND_BC_MULTI_READ	Broadcast Multi-Read command.

cy_en_isouart_ecc_error_t

enum cy_en_isouart_ecc_error_t

ECC error types.

Enumerator
CY_ISOUART_ECC_NO_ERROR	No ECC error.
CY_ISOUART_ECC_CORRECTED	Corrected ECC error.
CY_ISOUART_ECC_NOT_CORRECTED	Not corrected ECC error.

cy_en_isouart_wakeup_source_t

enum cy_en_isouart_wakeup_source_t

Wakeup source types.

Enumerator
CY_ISOUART_WAKEUP_ISOUART	Wake-up via iso UART.
CY_ISOUART_WAKEUP_GPIO	Wake-up via GPIO.