Enumerated Types

General Description

Enumerations
enum	cy_hbdma_socket_id_t {   CY_HBDMA_LVDS_SOCKET_00 = 0x10 ,   CY_HBDMA_LVDS_SOCKET_01 ,   CY_HBDMA_LVDS_SOCKET_02 ,   CY_HBDMA_LVDS_SOCKET_03 ,   CY_HBDMA_LVDS_SOCKET_04 ,   CY_HBDMA_LVDS_SOCKET_05 ,   CY_HBDMA_LVDS_SOCKET_06 ,   CY_HBDMA_LVDS_SOCKET_07 ,   CY_HBDMA_LVDS_SOCKET_08 ,   CY_HBDMA_LVDS_SOCKET_09 ,   CY_HBDMA_LVDS_SOCKET_10 ,   CY_HBDMA_LVDS_SOCKET_11 ,   CY_HBDMA_LVDS_SOCKET_12 ,   CY_HBDMA_LVDS_SOCKET_13 ,   CY_HBDMA_LVDS_SOCKET_14 ,   CY_HBDMA_LVDS_SOCKET_15 ,   CY_HBDMA_LVDS_SOCKET_16 = 0x20U ,   CY_HBDMA_LVDS_SOCKET_17 ,   CY_HBDMA_LVDS_SOCKET_18 ,   CY_HBDMA_LVDS_SOCKET_19 ,   CY_HBDMA_LVDS_SOCKET_20 ,   CY_HBDMA_LVDS_SOCKET_21 ,   CY_HBDMA_LVDS_SOCKET_22 ,   CY_HBDMA_LVDS_SOCKET_23 ,   CY_HBDMA_LVDS_SOCKET_24 ,   CY_HBDMA_LVDS_SOCKET_25 ,   CY_HBDMA_LVDS_SOCKET_26 ,   CY_HBDMA_LVDS_SOCKET_27 ,   CY_HBDMA_LVDS_SOCKET_28 ,   CY_HBDMA_LVDS_SOCKET_29 ,   CY_HBDMA_LVDS_SOCKET_30 ,   CY_HBDMA_LVDS_SOCKET_31 ,   CY_HBDMA_USBEG_SOCKET_00 = 0x30U ,   CY_HBDMA_USBEG_SOCKET_01 ,   CY_HBDMA_USBEG_SOCKET_02 ,   CY_HBDMA_USBEG_SOCKET_03 ,   CY_HBDMA_USBEG_SOCKET_04 ,   CY_HBDMA_USBEG_SOCKET_05 ,   CY_HBDMA_USBEG_SOCKET_06 ,   CY_HBDMA_USBEG_SOCKET_07 ,   CY_HBDMA_USBEG_SOCKET_08 ,   CY_HBDMA_USBEG_SOCKET_09 ,   CY_HBDMA_USBEG_SOCKET_10 ,   CY_HBDMA_USBEG_SOCKET_11 ,   CY_HBDMA_USBEG_SOCKET_12 ,   CY_HBDMA_USBEG_SOCKET_13 ,   CY_HBDMA_USBEG_SOCKET_14 ,   CY_HBDMA_USBEG_SOCKET_15 ,   CY_HBDMA_USBIN_SOCKET_00 = 0x40U ,   CY_HBDMA_USBIN_SOCKET_01 ,   CY_HBDMA_USBIN_SOCKET_02 ,   CY_HBDMA_USBIN_SOCKET_03 ,   CY_HBDMA_USBIN_SOCKET_04 ,   CY_HBDMA_USBIN_SOCKET_05 ,   CY_HBDMA_USBIN_SOCKET_06 ,   CY_HBDMA_USBIN_SOCKET_07 ,   CY_HBDMA_USBIN_SOCKET_08 ,   CY_HBDMA_USBIN_SOCKET_09 ,   CY_HBDMA_USBIN_SOCKET_10 ,   CY_HBDMA_USBIN_SOCKET_11 ,   CY_HBDMA_USBIN_SOCKET_12 ,   CY_HBDMA_USBIN_SOCKET_13 ,   CY_HBDMA_USBIN_SOCKET_14 ,   CY_HBDMA_USBIN_SOCKET_15 ,   CY_HBDMA_USBHS_OUT_EP_00 = 0x50U ,   CY_HBDMA_USBHS_OUT_EP_01 ,   CY_HBDMA_USBHS_OUT_EP_02 ,   CY_HBDMA_USBHS_OUT_EP_03 ,   CY_HBDMA_USBHS_OUT_EP_04 ,   CY_HBDMA_USBHS_OUT_EP_05 ,   CY_HBDMA_USBHS_OUT_EP_06 ,   CY_HBDMA_USBHS_OUT_EP_07 ,   CY_HBDMA_USBHS_OUT_EP_08 ,   CY_HBDMA_USBHS_OUT_EP_09 ,   CY_HBDMA_USBHS_OUT_EP_10 ,   CY_HBDMA_USBHS_OUT_EP_11 ,   CY_HBDMA_USBHS_OUT_EP_12 ,   CY_HBDMA_USBHS_OUT_EP_13 ,   CY_HBDMA_USBHS_OUT_EP_14 ,   CY_HBDMA_USBHS_OUT_EP_15 ,   CY_HBDMA_USBHS_IN_EP_00 = 0x60U ,   CY_HBDMA_USBHS_IN_EP_01 ,   CY_HBDMA_USBHS_IN_EP_02 ,   CY_HBDMA_USBHS_IN_EP_03 ,   CY_HBDMA_USBHS_IN_EP_04 ,   CY_HBDMA_USBHS_IN_EP_05 ,   CY_HBDMA_USBHS_IN_EP_06 ,   CY_HBDMA_USBHS_IN_EP_07 ,   CY_HBDMA_USBHS_IN_EP_08 ,   CY_HBDMA_USBHS_IN_EP_09 ,   CY_HBDMA_USBHS_IN_EP_10 ,   CY_HBDMA_USBHS_IN_EP_11 ,   CY_HBDMA_USBHS_IN_EP_12 ,   CY_HBDMA_USBHS_IN_EP_13 ,   CY_HBDMA_USBHS_IN_EP_14 ,   CY_HBDMA_USBHS_IN_EP_15 ,   CY_HBDMA_VIRT_SOCKET_RD ,   CY_HBDMA_VIRT_SOCKET_WR }
	List of High BandWidth DMA sockets supported in the platform. More...
enum	cy_hbdma_adapter_id_t {   CY_HBDMA_ADAP_LVDS_0 = 1 ,   CY_HBDMA_ADAP_LVDS_1 ,   CY_HBDMA_ADAP_USB_IN ,   CY_HBDMA_ADAP_USB_EG }
	List of High BandWidth DMA adapters supported in the platform. More...
enum	cy_en_hbdma_status_t {   CY_HBDMA_SUCCESS = 0U ,   CY_HBDMA_BAD_PARAM = (CY_HBDMA_ID | CY_PDL_STATUS_ERROR | 1U) ,   CY_HBDMA_NOT_READY = (CY_HBDMA_ID | CY_PDL_STATUS_ERROR | 2U) }
	List of return values provided by HBW DMA driver API. More...
enum	cy_en_hbdma_sock_evt_t {   CY_HBDMA_SOCK_PRODUCE_EVT = 0 ,   CY_HBDMA_SOCK_CONSUME_EVT ,   CY_HBDMA_SOCK_STALL_EVT ,   CY_HBDMA_SOCK_SUSPEND_EVT ,   CY_HBDMA_SOCK_ERROR_EVT ,   CY_HBDMA_SOCK_XFERDONE_EVT ,   CY_HBDMA_SOCK_EVT_RCVD ,   CY_HBDMA_DATAWIRE0_INTERRUPT ,   CY_HBDMA_DATAWIRE1_INTERRUPT }
	List of interrupt callback types reported by the HBW DMA driver to the DMA manager middleware. More...
enum	cy_en_hbdma_clk_freq_t {   CY_HBDMA_CLK_150_MHZ = 0 ,   CY_HBDMA_CLK_160_MHZ ,   CY_HBDMA_CLK_240_MHZ ,   CY_HBDMA_CLK_SSPHY_CLK }
	List of High BandWidth DMA clock frequencies supported on the device family. More...
enum	cy_en_hbdma_mgr_status_t {   CY_HBDMA_MGR_SUCCESS = 0U ,   CY_HBDMA_MGR_BAD_PARAM = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 1U) ,   CY_HBDMA_MGR_TIMEOUT = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 2U) ,   CY_HBDMA_MGR_DRV_HW_ERROR = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 3U) ,   CY_HBDMA_MGR_MEMORY_ERROR = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 4U) ,   CY_HBDMA_MGR_SEQUENCE_ERROR = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 5U) ,   CY_HBDMA_MGR_MEM_CORRUPTION = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 6U) ,   CY_HBDMA_MGR_SOCK_BUSY = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 7U) ,   CY_HBDMA_MGR_NOT_SUPPORTED = (CY_HBDMA_MGR_ID | CY_PDL_STATUS_ERROR | 8U) }
	List of High BandWidth DMA manager status return codes. More...
enum	cy_en_hbdma_chn_type_t {   CY_HBDMA_TYPE_IP_TO_IP = 0 ,   CY_HBDMA_TYPE_IP_TO_MEM ,   CY_HBDMA_TYPE_MEM_TO_IP }
	Types of HBW DMA channels. More...
enum	cy_en_hbdma_cb_type_t {   CY_HBDMA_CB_NONE = 0 ,   CY_HBDMA_CB_XFER_CPLT ,   CY_HBDMA_CB_PROD_EVENT ,   CY_HBDMA_CB_CONS_EVENT ,   CY_HBDMA_CB_ERROR ,   CY_HBDMA_CB_SUSPENDED }
	List of event for which DMA channel callbacks are provided. More...
enum	cy_en_hbdma_chn_state_t {   CY_HBDMA_CHN_NOT_CONFIGURED = 0 ,   CY_HBDMA_CHN_CONFIGURED ,   CY_HBDMA_CHN_ACTIVE ,   CY_HBDMA_CHN_OVERRIDE ,   CY_HBDMA_CHN_DATADROP ,   CY_HBDMA_CHN_ERROR }
	List of HBW DMA channel states. More...

Enumeration Type Documentation

cy_hbdma_socket_id_t

enum cy_hbdma_socket_id_t

List of High BandWidth DMA sockets supported in the platform.

Enumerator
CY_HBDMA_LVDS_SOCKET_00	LVDS socket #00.
CY_HBDMA_LVDS_SOCKET_01	LVDS socket #01.
CY_HBDMA_LVDS_SOCKET_02	LVDS socket #02.
CY_HBDMA_LVDS_SOCKET_03	LVDS socket #03.
CY_HBDMA_LVDS_SOCKET_04	LVDS socket #04.
CY_HBDMA_LVDS_SOCKET_05	LVDS socket #05.
CY_HBDMA_LVDS_SOCKET_06	LVDS socket #06.
CY_HBDMA_LVDS_SOCKET_07	LVDS socket #07.
CY_HBDMA_LVDS_SOCKET_08	LVDS socket #08.
CY_HBDMA_LVDS_SOCKET_09	LVDS socket #09.
CY_HBDMA_LVDS_SOCKET_10	LVDS socket #10.
CY_HBDMA_LVDS_SOCKET_11	LVDS socket #11.
CY_HBDMA_LVDS_SOCKET_12	LVDS socket #12.
CY_HBDMA_LVDS_SOCKET_13	LVDS socket #13.
CY_HBDMA_LVDS_SOCKET_14	LVDS socket #14.
CY_HBDMA_LVDS_SOCKET_15	LVDS socket #15.
CY_HBDMA_LVDS_SOCKET_16	LVDS socket #16.
CY_HBDMA_LVDS_SOCKET_17	LVDS socket #17.
CY_HBDMA_LVDS_SOCKET_18	LVDS socket #18.
CY_HBDMA_LVDS_SOCKET_19	LVDS socket #19.
CY_HBDMA_LVDS_SOCKET_20	LVDS socket #20.
CY_HBDMA_LVDS_SOCKET_21	LVDS socket #21.
CY_HBDMA_LVDS_SOCKET_22	LVDS socket #22.
CY_HBDMA_LVDS_SOCKET_23	LVDS socket #23.
CY_HBDMA_LVDS_SOCKET_24	LVDS socket #24.
CY_HBDMA_LVDS_SOCKET_25	LVDS socket #25.
CY_HBDMA_LVDS_SOCKET_26	LVDS socket #26.
CY_HBDMA_LVDS_SOCKET_27	LVDS socket #27.
CY_HBDMA_LVDS_SOCKET_28	LVDS socket #28.
CY_HBDMA_LVDS_SOCKET_29	LVDS socket #29.
CY_HBDMA_LVDS_SOCKET_30	LVDS socket #30.
CY_HBDMA_LVDS_SOCKET_31	LVDS socket #31.
CY_HBDMA_USBEG_SOCKET_00	USB egress socket #00.
CY_HBDMA_USBEG_SOCKET_01	USB egress socket #01.
CY_HBDMA_USBEG_SOCKET_02	USB egress socket #02.
CY_HBDMA_USBEG_SOCKET_03	USB egress socket #03.
CY_HBDMA_USBEG_SOCKET_04	USB egress socket #04.
CY_HBDMA_USBEG_SOCKET_05	USB egress socket #05.
CY_HBDMA_USBEG_SOCKET_06	USB egress socket #06.
CY_HBDMA_USBEG_SOCKET_07	USB egress socket #07.
CY_HBDMA_USBEG_SOCKET_08	USB egress socket #08.
CY_HBDMA_USBEG_SOCKET_09	USB egress socket #09.
CY_HBDMA_USBEG_SOCKET_10	USB egress socket #10.
CY_HBDMA_USBEG_SOCKET_11	USB egress socket #11.
CY_HBDMA_USBEG_SOCKET_12	USB egress socket #12.
CY_HBDMA_USBEG_SOCKET_13	USB egress socket #13.
CY_HBDMA_USBEG_SOCKET_14	USB egress socket #14.
CY_HBDMA_USBEG_SOCKET_15	USB egress socket #15.
CY_HBDMA_USBIN_SOCKET_00	USB ingress socket #00.
CY_HBDMA_USBIN_SOCKET_01	USB ingress socket #01.
CY_HBDMA_USBIN_SOCKET_02	USB ingress socket #02.
CY_HBDMA_USBIN_SOCKET_03	USB ingress socket #03.
CY_HBDMA_USBIN_SOCKET_04	USB ingress socket #04.
CY_HBDMA_USBIN_SOCKET_05	USB ingress socket #05.
CY_HBDMA_USBIN_SOCKET_06	USB ingress socket #06.
CY_HBDMA_USBIN_SOCKET_07	USB ingress socket #07.
CY_HBDMA_USBIN_SOCKET_08	USB ingress socket #08.
CY_HBDMA_USBIN_SOCKET_09	USB ingress socket #09.
CY_HBDMA_USBIN_SOCKET_10	USB ingress socket #10.
CY_HBDMA_USBIN_SOCKET_11	USB ingress socket #11.
CY_HBDMA_USBIN_SOCKET_12	USB ingress socket #12.
CY_HBDMA_USBIN_SOCKET_13	USB ingress socket #13.
CY_HBDMA_USBIN_SOCKET_14	USB ingress socket #14.
CY_HBDMA_USBIN_SOCKET_15	USB ingress socket #15.
CY_HBDMA_USBHS_OUT_EP_00	USBHS endpoint memory for OUT EP #00.
CY_HBDMA_USBHS_OUT_EP_01	USBHS endpoint memory for OUT EP #01.
CY_HBDMA_USBHS_OUT_EP_02	USBHS endpoint memory for OUT EP #02.
CY_HBDMA_USBHS_OUT_EP_03	USBHS endpoint memory for OUT EP #03.
CY_HBDMA_USBHS_OUT_EP_04	USBHS endpoint memory for OUT EP #04.
CY_HBDMA_USBHS_OUT_EP_05	USBHS endpoint memory for OUT EP #05.
CY_HBDMA_USBHS_OUT_EP_06	USBHS endpoint memory for OUT EP #06.
CY_HBDMA_USBHS_OUT_EP_07	USBHS endpoint memory for OUT EP #07.
CY_HBDMA_USBHS_OUT_EP_08	USBHS endpoint memory for OUT EP #08.
CY_HBDMA_USBHS_OUT_EP_09	USBHS endpoint memory for OUT EP #09.
CY_HBDMA_USBHS_OUT_EP_10	USBHS endpoint memory for OUT EP #10.
CY_HBDMA_USBHS_OUT_EP_11	USBHS endpoint memory for OUT EP #11.
CY_HBDMA_USBHS_OUT_EP_12	USBHS endpoint memory for OUT EP #12.
CY_HBDMA_USBHS_OUT_EP_13	USBHS endpoint memory for OUT EP #13.
CY_HBDMA_USBHS_OUT_EP_14	USBHS endpoint memory for OUT EP #14.
CY_HBDMA_USBHS_OUT_EP_15	USBHS endpoint memory for OUT EP #15.
CY_HBDMA_USBHS_IN_EP_00	USBHS endpoint memory for IN EP #00.
CY_HBDMA_USBHS_IN_EP_01	USBHS endpoint memory for IN EP #01.
CY_HBDMA_USBHS_IN_EP_02	USBHS endpoint memory for IN EP #02.
CY_HBDMA_USBHS_IN_EP_03	USBHS endpoint memory for IN EP #03.
CY_HBDMA_USBHS_IN_EP_04	USBHS endpoint memory for IN EP #04.
CY_HBDMA_USBHS_IN_EP_05	USBHS endpoint memory for IN EP #05.
CY_HBDMA_USBHS_IN_EP_06	USBHS endpoint memory for IN EP #06.
CY_HBDMA_USBHS_IN_EP_07	USBHS endpoint memory for IN EP #07.
CY_HBDMA_USBHS_IN_EP_08	USBHS endpoint memory for IN EP #08.
CY_HBDMA_USBHS_IN_EP_09	USBHS endpoint memory for IN EP #09.
CY_HBDMA_USBHS_IN_EP_10	USBHS endpoint memory for IN EP #10.
CY_HBDMA_USBHS_IN_EP_11	USBHS endpoint memory for IN EP #11.
CY_HBDMA_USBHS_IN_EP_12	USBHS endpoint memory for IN EP #12.
CY_HBDMA_USBHS_IN_EP_13	USBHS endpoint memory for IN EP #13.
CY_HBDMA_USBHS_IN_EP_14	USBHS endpoint memory for IN EP #14.
CY_HBDMA_USBHS_IN_EP_15	USBHS endpoint memory for IN EP #15.
CY_HBDMA_VIRT_SOCKET_RD	Virtual (CPU) access socket for data read.
CY_HBDMA_VIRT_SOCKET_WR	Virtual (CPU) access socket for data write.

cy_hbdma_adapter_id_t

enum cy_hbdma_adapter_id_t

List of High BandWidth DMA adapters supported in the platform.

Enumerator
CY_HBDMA_ADAP_LVDS_0	LVDS DMA adapter #0. Handles sockets CY_HBDMA_LVDS_SOCKET_00 to CY_HBDMA_LVDS_SOCKET_15
CY_HBDMA_ADAP_LVDS_1	LVDS DMA adapter #1. Handles sockets CY_HBDMA_LVDS_SOCKET_16 to CY_HBDMA_LVDS_SOCKET_31
CY_HBDMA_ADAP_USB_IN	USB32 Ingress DMA adapter. Handles sockets CY_HBDMA_USBIN_SOCKET_00 to CY_HBDMA_USBIN_SOCKET_15
CY_HBDMA_ADAP_USB_EG	USB32 Egress DMA adapter. Handles sockets CY_HBDMA_USBEG_SOCKET_00 to CY_HBDMA_USBEG_SOCKET_15

cy_en_hbdma_status_t

enum cy_en_hbdma_status_t

List of return values provided by HBW DMA driver API.

Enumerator
CY_HBDMA_SUCCESS	Operation completed successfully.
CY_HBDMA_BAD_PARAM	Bad API parameters.
CY_HBDMA_NOT_READY	DMA adapter not ready.

cy_en_hbdma_sock_evt_t

enum cy_en_hbdma_sock_evt_t

List of interrupt callback types reported by the HBW DMA driver to the DMA manager middleware.

Enumerator
CY_HBDMA_SOCK_PRODUCE_EVT	Produce event interrupt received.
CY_HBDMA_SOCK_CONSUME_EVT	Consume event interrupt received.
CY_HBDMA_SOCK_STALL_EVT	Socket stalled interrupt received.
CY_HBDMA_SOCK_SUSPEND_EVT	Socket suspended interrupt received.
CY_HBDMA_SOCK_ERROR_EVT	Socket error interrupt received.
CY_HBDMA_SOCK_XFERDONE_EVT	Transfer done interrupt received.
CY_HBDMA_SOCK_EVT_RCVD	Event received interrupt: Identifies trigger coming from Central DMA.
CY_HBDMA_DATAWIRE0_INTERRUPT	Interrupt from DataWire-0 channel.
CY_HBDMA_DATAWIRE1_INTERRUPT	Interrupt from DataWire-1 channel.

cy_en_hbdma_clk_freq_t

enum cy_en_hbdma_clk_freq_t

List of High BandWidth DMA clock frequencies supported on the device family.

Enumerator
CY_HBDMA_CLK_150_MHZ	150 MHz clock derived from system level clk_hf4 input.
CY_HBDMA_CLK_160_MHZ	160 MHz clock divided from 480 MHz provided by USB2 PLL.
CY_HBDMA_CLK_240_MHZ	240 MHz clock divided from 480 MHz provided by USB2 PLL.
CY_HBDMA_CLK_SSPHY_CLK	Clock derived from USB3 PHY. 125 MHz in Gen1 operation and 312.5 MHz in Gen2 operation.

cy_en_hbdma_mgr_status_t

enum cy_en_hbdma_mgr_status_t

List of High BandWidth DMA manager status return codes.

Enumerator
CY_HBDMA_MGR_SUCCESS	Operation completed successfully.
CY_HBDMA_MGR_BAD_PARAM	One or more input parameters are invalid.
CY_HBDMA_MGR_TIMEOUT	Timeout occurred for the operation
CY_HBDMA_MGR_DRV_HW_ERROR	A hardware error occurred during operation.
CY_HBDMA_MGR_MEMORY_ERROR	Out of memory.
CY_HBDMA_MGR_SEQUENCE_ERROR	Call sequence error.
CY_HBDMA_MGR_MEM_CORRUPTION	Memory corruption error.
CY_HBDMA_MGR_SOCK_BUSY	Socket busy error.
CY_HBDMA_MGR_NOT_SUPPORTED	Not supported error.

cy_en_hbdma_chn_type_t

enum cy_en_hbdma_chn_type_t

Types of HBW DMA channels.

Enumerator
CY_HBDMA_TYPE_IP_TO_IP	Peripheral to peripheral DMA channel.
CY_HBDMA_TYPE_IP_TO_MEM	Peripheral to memory DMA channel.
CY_HBDMA_TYPE_MEM_TO_IP	Memory to peripheral DMA channel.

cy_en_hbdma_cb_type_t

enum cy_en_hbdma_cb_type_t

List of event for which DMA channel callbacks are provided.

Enumerator
CY_HBDMA_CB_NONE	Invalid callback type.
CY_HBDMA_CB_XFER_CPLT	Transfer completed.
CY_HBDMA_CB_PROD_EVENT	Buffer received from producer.
CY_HBDMA_CB_CONS_EVENT	Buffer drained by the consumer.
CY_HBDMA_CB_ERROR	DMA transfer error raised by the adapter.
CY_HBDMA_CB_SUSPENDED	DMA transfer has been suspended.

cy_en_hbdma_chn_state_t

enum cy_en_hbdma_chn_state_t

List of HBW DMA channel states.

Enumerator
CY_HBDMA_CHN_NOT_CONFIGURED	DMA channel has not been initialized.
CY_HBDMA_CHN_CONFIGURED	DMA channel has been created and configured.
CY_HBDMA_CHN_ACTIVE	DMA Channel has active transaction going on.
CY_HBDMA_CHN_OVERRIDE	DMA channel has over-ride data transfer going on.
CY_HBDMA_CHN_DATADROP	Auto DMA channel configured to drop all incoming data.
CY_HBDMA_CHN_ERROR	DMA Channel has encountered an error.