Enumerated Types

General Description

Enumerations
enum	cy_en_usbfs_dev_drv_status_t {   CY_USBFS_DEV_DRV_SUCCESS = 0U,   CY_USBFS_DEV_DRV_BAD_PARAM = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 1U),   CY_USBFS_DEV_DRV_BUF_ALLOC_FAILED = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 2U),   CY_USBFS_DEV_DRV_DMA_CFG_FAILED = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 3U),   CY_USBFS_DEV_DRV_EP_DYN_RECONFIG_TIMEOUT = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 4U),   CY_USBFS_DEV_DRV_EP_DMA_READ_TIMEOUT = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 5U),   CY_USBFS_DEV_DRV_EP_DMA_WRITE_TIMEOUT = (CY_USBFS_ID | CY_PDL_STATUS_ERROR | CY_USBFS_DEV_DRV_STATUS_CODE | 6U) }
	USBFS Device Driver return codes. More...
enum	cy_en_usbfs_dev_drv_ep_management_mode_t {   CY_USBFS_DEV_DRV_EP_MANAGEMENT_CPU = 0,   CY_USBFS_DEV_DRV_EP_MANAGEMENT_DMA = 1,   CY_USBFS_DEV_DRV_EP_MANAGEMENT_DMA_AUTO = 2 }
	Data Endpoints Buffer Management Mode. More...
enum	cy_en_usbfs_dev_ep_access_t {   CY_USBFS_DEV_DRV_USE_8_BITS_DR,   CY_USBFS_DEV_DRV_USE_16_BITS_DR }
	Data Endpoint Register Access Type. More...
enum	cy_en_usb_dev_service_cb_t {   CY_USB_DEV_BUS_RESET = 0U,   CY_USB_DEV_EP0_SETUP = 1U,   CY_USB_DEV_EP0_IN = 2U,   CY_USB_DEV_EP0_OUT = 3U }
	Service Callback Events (this enumerated type is used by middleware) More...
enum	cy_en_usbfs_dev_drv_cb_source_t {   CY_USBFS_DEV_DRV_EP1 = 0U,   CY_USBFS_DEV_DRV_EP2 = 1U,   CY_USBFS_DEV_DRV_EP3 = 2U,   CY_USBFS_DEV_DRV_EP4 = 3U,   CY_USBFS_DEV_DRV_EP5 = 4U,   CY_USBFS_DEV_DRV_EP6 = 5U,   CY_USBFS_DEV_DRV_EP7 = 6U,   CY_USBFS_DEV_DRV_EP8 = 7U,   CY_USBFS_DEV_DRV_SOF = 8U,   CY_USBFS_DEV_DRV_LPM = 9U }
	Callback Sources. More...
enum	cy_en_usb_dev_ep_state_t {   CY_USB_DEV_EP_IDLE,   CY_USB_DEV_EP_PENDING,   CY_USB_DEV_EP_COMPLETED,   CY_USB_DEV_EP_STALLED,   CY_USB_DEV_EP_DISABLED,   CY_USB_DEV_EP_INVALID }
	Data Endpoint States (this enumerated type is used by middleware) More...
enum	cy_en_usbfs_dev_drv_force_bus_state_t {   CY_USBFS_DEV_DRV_FORCE_STATE_J = 0xA0U,   CY_USBFS_DEV_DRV_FORCE_STATE_K = 0x80U,   CY_USBFS_DEV_DRV_FORCE_STATE_SE0 = 0xC0U,   CY_USBFS_DEV_DRV_FORCE_STATE_NONE = 0x00U }
	USB Lines Control. More...
enum	cy_en_usbfs_dev_drv_lpm_req_t {   CY_USBFS_DEV_DRV_LPM_REQ_NACK = 0x0U,   CY_USBFS_DEV_DRV_LPM_REQ_ACK = 0x1U }
	LPM (Link Power Management) Responses. More...
enum	cy_en_usbfs_dev_drv_ep0_ctrl_state_t {   CY_USBFS_DEV_DRV_EP0_CTRL_STATE_IDLE,   CY_USBFS_DEV_DRV_EP0_CTRL_STATE_SETUP,   CY_USBFS_DEV_DRV_EP0_CTRL_STATE_DATA,   CY_USBFS_DEV_DRV_EP0_CTRL_STATE_STATUS_IN,   CY_USBFS_DEV_DRV_EP0_CTRL_STATE_STATUS_OUT }
	USB Control EP0 transfer state.

Enumeration Type Documentation

cy_en_usbfs_dev_drv_status_t

enum cy_en_usbfs_dev_drv_status_t

USBFS Device Driver return codes.

Enumerator
CY_USBFS_DEV_DRV_SUCCESS	Operation completed successfully.
CY_USBFS_DEV_DRV_BAD_PARAM	One or more input parameters are invalid.
CY_USBFS_DEV_DRV_BUF_ALLOC_FAILED	There is not enough space in the buffer to be allocated for the endpoint (hardware or RAM)
CY_USBFS_DEV_DRV_DMA_CFG_FAILED	Failure during DMA configuration.
CY_USBFS_DEV_DRV_EP_DYN_RECONFIG_TIMEOUT	Timeout during dynamic reconfiguration.
CY_USBFS_DEV_DRV_EP_DMA_READ_TIMEOUT	Timeout during execution of the DMA read request for the OUT endpoint (only applicable in Manual DMA mode (Mode 2))
CY_USBFS_DEV_DRV_EP_DMA_WRITE_TIMEOUT	Timeout during execution of the DMA read request for the OUT endpoint (only applicable in Manual DMA mode (Mode 2))

cy_en_usbfs_dev_drv_ep_management_mode_t

enum cy_en_usbfs_dev_drv_ep_management_mode_t

Data Endpoints Buffer Management Mode.

Enumerator
CY_USBFS_DEV_DRV_EP_MANAGEMENT_CPU	CPU manages a data transfer between the hardware endpoints buffer and the user SRAM.
CY_USBFS_DEV_DRV_EP_MANAGEMENT_DMA	DMA manages data transfer between the hardware endpoints buffer and the user SRAM.
CY_USBFS_DEV_DRV_EP_MANAGEMENT_DMA_AUTO	The DMA automatically manages a data transfer between the hardware endpoints FIFO buffer and the user SRAM.

cy_en_usbfs_dev_ep_access_t

enum cy_en_usbfs_dev_ep_access_t

Data Endpoint Register Access Type.

Enumerator
CY_USBFS_DEV_DRV_USE_8_BITS_DR	Use 8-bits registers to access the data endpoints.
CY_USBFS_DEV_DRV_USE_16_BITS_DR	Use 16-bits registers to access the data endpoints.

cy_en_usb_dev_service_cb_t

enum cy_en_usb_dev_service_cb_t

Service Callback Events (this enumerated type is used by middleware)

Enumerator
CY_USB_DEV_BUS_RESET	Callback hooked to the bus reset interrupt.
CY_USB_DEV_EP0_SETUP	Callback hooked to the endpoint 0 SETUP packet interrupt.
CY_USB_DEV_EP0_IN	Callback hooked to the endpoint 0 IN packet interrupt.
CY_USB_DEV_EP0_OUT	Callback hooked to the endpoint 0 OUT packet interrupt.

cy_en_usbfs_dev_drv_cb_source_t

enum cy_en_usbfs_dev_drv_cb_source_t

Callback Sources.

Enumerator
CY_USBFS_DEV_DRV_EP1	Callback hooked to the Data Endpoint 1 completion interrupt.
CY_USBFS_DEV_DRV_EP2	Callback hooked to the Data Endpoint 2 completion interrupt.
CY_USBFS_DEV_DRV_EP3	Callback hooked to the Data Endpoint 3 completion interrupt.
CY_USBFS_DEV_DRV_EP4	Callback hooked to the Data Endpoint 4 completion interrupt.
CY_USBFS_DEV_DRV_EP5	Callback hooked to the Data Endpoint 5 completion interrupt.
CY_USBFS_DEV_DRV_EP6	Callback hooked to the Data Endpoint 6 completion interrupt.
CY_USBFS_DEV_DRV_EP7	Callback hooked to the Data Endpoint 7 completion interrupt.
CY_USBFS_DEV_DRV_EP8	Callback hooked to the Data Endpoint 8 completion interrupt.
CY_USBFS_DEV_DRV_SOF	Callback hooked to the SOF packet received interrupt.
CY_USBFS_DEV_DRV_LPM	Callback hooked to the LPM request received interrupt.

cy_en_usb_dev_ep_state_t

enum cy_en_usb_dev_ep_state_t

Data Endpoint States (this enumerated type is used by middleware)

Enumerator
CY_USB_DEV_EP_IDLE	The endpoint is in an idle state after the configuration is set.
CY_USB_DEV_EP_PENDING	The transfer targeted at an endpoint is in progress.
CY_USB_DEV_EP_COMPLETED	The transfer targeted at an endpoint is completed.
CY_USB_DEV_EP_STALLED	The endpoint is stalled.
CY_USB_DEV_EP_DISABLED	The endpoint is disabled (not used in this configuration)
CY_USB_DEV_EP_INVALID	The endpoint is not supported by the hardware.

cy_en_usbfs_dev_drv_force_bus_state_t

enum cy_en_usbfs_dev_drv_force_bus_state_t

USB Lines Control.

Enumerator
CY_USBFS_DEV_DRV_FORCE_STATE_J	Force a J State onto the USB lines.
CY_USBFS_DEV_DRV_FORCE_STATE_K	Force a K State onto the USB lines.
CY_USBFS_DEV_DRV_FORCE_STATE_SE0	Force a Single Ended 0 onto the USB lines.
CY_USBFS_DEV_DRV_FORCE_STATE_NONE	Return the bus to the SIE control.

cy_en_usbfs_dev_drv_lpm_req_t

enum cy_en_usbfs_dev_drv_lpm_req_t

LPM (Link Power Management) Responses.

Enumerator
CY_USBFS_DEV_DRV_LPM_REQ_NACK	The next LPM request will be responded with NACK.
CY_USBFS_DEV_DRV_LPM_REQ_ACK	The next LPM request will be responded with ACK.