General Description

Enumerations
enum	cy_en_usb_cal_ret_code_t { CY_USB_CAL_STATUS_SUCCESS =0 , CY_USB_CAL_STATUS_FAILURE , CY_USB_CAL_STATUS_BAD_PARAM , CY_USB_CAL_STATUS_CAL_CTXT_NULL , CY_USB_CAL_STATUS_MALLOC_FAILED , CY_USB_CAL_STATUS_MSG_SEND_FAIL , CY_USB_CAL_STATUS_CAL_BASE_NULL , CY_USB_CAL_STATUS_TOGGLE_FAILED , CY_USB_CAL_STATUS_CAL_PROT_BASE_NULL , CY_USB_CAL_STATUS_CAL_LNK_BASE_NULL , CY_USB_CAL_STATUS_CAL_EPM_BASE_NULL , CY_USB_CAL_STATUS_CAL_MAIN_BASE_NULL , CY_USB_CAL_STATUS_TIMEOUT }
	List of API error codes returned by CAL APIs in various conditions. More...

enum	cy_en_usb_cal_msg_type_t { CY_USB_CAL_MSG_INVALID =0 , CY_USB_CAL_MSG_RESET , CY_USB_CAL_MSG_HSGRANT , CY_USB_CAL_MSG_RESET_DONE , CY_USB_CAL_MSG_SUDAV , CY_USB_CAL_MSG_STATUS_STAGE , CY_USB_CAL_MSG_SETADDR , CY_USB_CAL_MSG_SUSP , CY_USB_CAL_MSG_RESUME_START , CY_USB_CAL_MSG_RESUME_END , CY_USB_CAL_MSG_DEEP_SLEEP_EXIT , CY_USB_CAL_MSG_L1_SLEEP , CY_USB_CAL_MSG_L1_URESUME , CY_USB_CAL_MSG_IN_ZLP , CY_USB_CAL_MSG_IN_SLP , CY_USB_CAL_MSG_OUT_ZLP , CY_USB_CAL_MSG_OUT_SLP , CY_USB_CAL_MSG_OUT_DONE , CY_USB_CAL_MSG_SOF_ITP , CY_USB_CAL_MSG_ERRLIMIT , CY_USBSS_CAL_MSG_LNK_RESET , CY_USBSS_CAL_MSG_LNK_CONNECT , CY_USBSS_CAL_MSG_LNK_DISCONNECT , CY_USBSS_CAL_MSG_LNK_INT , CY_USBSS_CAL_MSG_LNK_ERR_LIMIT , CY_USBSS_CAL_MSG_LNK_RX_DETECT_ACTIVE , CY_USBSS_CAL_MSG_LNK_SS_DISABLE , CY_USBSS_CAL_MSG_LNK_COMPLIANCE , CY_USBSS_CAL_MSG_USB3_LNKFAIL , CY_USBSS_CAL_MSG_EP_INT , CY_USBSS_CAL_MSG_PROT_INT , CY_USB_CAL_MSG_PROT_SETADDR_0 , CY_USB_CAL_MSG_PROT_SUTOK , CY_USB_CAL_MSG_PROT_HOST_ERR , CY_USB_CAL_MSG_PROT_TIMEOUT_PORT_CAP , CY_USB_CAL_MSG_PROT_TIMEOUT_PORT_CFG , CY_USB_CAL_MSG_PROT_TIMEOUT_PING , CY_USB_CAL_MSG_PROT_LMP_INVALID_PORT_CAP , CY_USB_CAL_MSG_PROT_LMP_INVALID_PORT_CFG , CY_USBSS_CAL_MSG_PROT_EP_INT , CY_USBSS_CAL_MSG_VBUS_CHANGE , CY_USBSS_CAL_MSG_USB3_WARM_RESET , CY_USBSS_CAL_MSG_USB3_U3_SUSPEND , CY_USBSS_CAL_MSG_USB3_U0_RESUME , CY_USBSS_CAL_MSG_UX_REENABLE , CY_USBSS_CAL_MSG_EPM_UNDERRUN , CY_USBSS_CAL_MSG_USB3_LMP_FAIL , CY_USBSS_CAL_MSG_USB3_RATE_CHG , CY_USBSS_CAL_MSG_ABORT_UX_ENABLE , CY_USBSS_CAL_MSG_HANDLE_RXLOCK_FAILURE , CY_USB_CAL_MSG_EP0_RCV_DONE , CY_USBSS_CAL_MSG_PORT_CONFIGURED , CY_USBSS_CAL_MSG_LPBK_FORCED , CY_USB_CAL_MSG_SS_RECONNECT , CY_USB_CAL_MSG_MAX }
	Types of messages sent the by the USBHS and/or USBSS CAL drivers to the USBD stack. More...

enum	cy_en_usbss_cal_evt_type_t { CY_SSCAL_EVT_NONE = 0x00 , CY_SSCAL_EVT_DRV_EN , CY_SSCAL_EVT_CONN_EN , CY_SSCAL_EVT_CONN_DIS , CY_SSCAL_EVT_CONNECT , CY_SSCAL_EVT_DISCONNECT , CY_SSCAL_EVT_RESET , CY_SSCAL_EVT_PSVP_RECONNECT , CY_SSCAL_EVT_PORT_CAP_HNDSHK , CY_SSCAL_EVT_PORT_CFG_HNDSHK , CY_SSCAL_EVT_LMP_TIMEOUT , CY_SSCAL_EVT_VBUS_PRESENT , CY_SSCAL_EVT_VBUS_ABSENT , CY_SSCAL_EVT_WARM_RESET , CY_SSCAL_EVT_DBG_1 , CY_SSCAL_EVT_DBG_2 , CY_SSCAL_EVT_VBUS_CHG_INTR , CY_SSCAL_EVT_SETADDR_INTR , CY_SSCAL_EVT_SUTOK_INTR , CY_SSCAL_EVT_EP0STAT_INTR , CY_SSCAL_EVT_RATE_GEN1 , CY_SSCAL_EVT_RATE_GEN2 , CY_SSCAL_EVT_NEXT_CP_SEL , CY_SSCAL_EVT_PHY0_SELECT , CY_SSCAL_EVT_PHY1_SELECT , CY_SSCAL_EVT_POLLING_CDR_RST , CY_SSCAL_EVT_RECOV_DELAY , CY_SSCAL_EVT_CDR_RESET_1 , CY_SSCAL_EVT_HP_TIMEOUT , CY_SSCAL_EVT_U3_PHY_DISABLED , CY_SSCAL_EVT_U3_WAKE_PHY_ENABLE , CY_SSCAL_EVT_DEV_U3_EXIT , CY_SSCAL_EVT_LNK_SS_DISABLE = 0x20 , CY_SSCAL_EVT_LNK_RX_DET_RES , CY_SSCAL_EVT_LNK_RX_DET_ACT , CY_SSCAL_EVT_LNK_RX_DET_QUIET , CY_SSCAL_EVT_LNK_SS_INACT_QUIET , CY_SSCAL_EVT_LNK_SS_INACT_DISC , CY_SSCAL_EVT_LNK_HOTRST_ACT , CY_SSCAL_EVT_LNK_HOTRST_EXIT , CY_SSCAL_EVT_LNK_POLLING_LFPS , CY_SSCAL_EVT_LNK_POLLING_RXEQ , CY_SSCAL_EVT_LNK_POLLING_ACT , CY_SSCAL_EVT_LNK_POLLING_CFG , CY_SSCAL_EVT_LNK_POLLING_IDLE , CY_SSCAL_EVT_LNK_POLLING_PLUS , CY_SSCAL_EVT_LNK_POLLING_PMATCH , CY_SSCAL_EVT_LNK_POLLING_PCFG , CY_SSCAL_EVT_LNK_U0 , CY_SSCAL_EVT_LNK_U1 , CY_SSCAL_EVT_LNK_U2 , CY_SSCAL_EVT_LNK_U3 , CY_SSCAL_EVT_LNK_LPBK_ACT , CY_SSCAL_EVT_LNK_LPBK_EXIT , CY_SSCAL_EVT_LNK_UNDEF0 , CY_SSCAL_EVT_LNK_COMPLIANCE , CY_SSCAL_EVT_LNK_RECOV_ACT , CY_SSCAL_EVT_LNK_RECOV_CFG , CY_SSCAL_EVT_LNK_RECOV_IDLE , CY_USBD_EVT_SS_TO_HS = 0x40 , CY_USBD_EVT_SS_REEN , CY_USBD_EVT_SS_DISB , CY_USBD_EVT_HS_DISB , CY_USBD_EVT_HS_RESET_SKIP , CY_USBD_EVT_SET_CONFIG_CB , CY_USBD_EVT_SET_INTF_CB , CY_HSCAL_EVT_CONN_EN = 0x50 , CY_HSCAL_EVT_CONN_DIS , CY_HSCAL_EVT_PHY_COMM_INIT , CY_HSCAL_EVT_PHY_FSHSMODE_INIT , CY_HSCAL_EVT_CAL_INIT_DONE , CY_HSCAL_EVT_PLL_INIT , CY_HSCAL_EVT_PLL_DEINIT , CY_HSCAL_EVT_SUSP , CY_HSCAL_EVT_URESET , CY_HSCAL_EVT_HSGRANT , CY_HSCAL_EVT_SUDAV , CY_HSCAL_EVT_ERRLIMIT , CY_HSCAL_EVT_URESUME , CY_HSCAL_EVT_STATUS_STAGE , CY_HSCAL_EVT_L1_SLEEP_REQ , CY_HSCAL_EVT_L1_URESUME , CY_HSCAL_EVT_RESET_DONE , CY_HSCAL_EVT_SET_ADDR , CY_HSCAL_EVT_HOST_URESUME_ARR , CY_HSCAL_EVT_DPSLP , CY_HSCAL_EVT_PID_MISMATCH , CY_HSCAL_EVT_START_REMOTE_WAKE_SGNAL , CY_HSCAL_EVT_USBD_INIT = 0x70 , CY_USBD_DATA_RATE_UNCONNECTED = 0x80 , CY_USBD_DATA_RATE_FS , CY_USBD_DATA_RATE_HS , CY_USBD_DATA_RATE_GEN1X1 , CY_USBD_DATA_RATE_GEN1X2 , CY_USBD_DATA_RATE_GEN2X1 , CY_USBD_DATA_RATE_GEN2X2 , CY_USB_UVC_EVT_SET_CFG = 0x90 , CY_USB_UVC_EVT_SET_INTF , CY_USB_UVC_EVT_VSTREAM_START , CY_USB_UVC_EVT_SET_CUR_REQ , CY_USB_EVT_INIT_LVDS_LB_EN = 0xA0 , CY_USB_EVT_PPORT0_EN , CY_USB_EVT_PPORT1_EN , CY_USB_EVT_LVCMOS_EN , CY_USB_EVT_LVDS_EN , CY_USB_EVT_INMD_EN , CY_USB_EVT_WL_EN , CY_USB_U3V_EVT_EPHALT_DCI_CMD = 0xB0 , CY_USB_U3V_EVT_EPHALT_DCI_RSP , CY_USB_U3V_EVT_U3V_CMD , CY_USB_U3V_EVT_U3V_RESP_SENT , CY_LNK_EVENT_DBG_0 = 0xF0 , CY_LNK_EVENT_SET_U1 , CY_LNK_EVENT_SET_U2 , CY_LNK_EVENT_CLR_U1 , CY_LNK_EVENT_CLR_U2 , CY_LNK_EVENT_SET_FORCE_ACCEPT_LPM , CY_LNK_EVENT_CLR_FORCE_ACCEPT_LPM , CY_LNK_EVENT_CDR_RST_DECODE_ERR , CY_LNK_EVENT_CDR_RST_DECODE_ERR_PHY_1 , CY_LNK_EVENT_SS_DISABLED_ENTRY , CY_LNK_EVENT_TRIG_DISCON_EVENT , CY_LNK_EVENT_LANE_POLARITY_INV , CY_LNK_EVENT_LNK_FORCE_U0 , CY_LNK_EVENT_UX_EXIT_TS1_TIMEOUT , CY_LNK_EVENT_USB_CLK_STOP , CY_LNK_EVENT_USB_CLK_START }
	List of USB events which are logged into the RAM based time-stamped event buffer for debug support. More...

enum	cy_en_usb_speed_t { CY_USBD_USB_DEV_NOT_CONNECTED = 0x00 , CY_USBD_USB_DEV_FS , CY_USBD_USB_DEV_HS , CY_USBD_USB_DEV_SS_GEN1 , CY_USBD_USB_DEV_SS_GEN1X2 , CY_USBD_USB_DEV_SS_GEN2 , CY_USBD_USB_DEV_SS_GEN2X2 }
	List of USB connection speeds which can be supported on the device. More...

enum	cy_en_usb_config_lane_t { CY_USB_CFG_LANE_AUTODETECT = 0 , CY_USB_CFG_LANE_0 , CY_USB_CFG_LANE_1 }
	Options for USB 3.x Configuration Lane Selection. More...

enum	cy_en_usb_endp_type_t { CY_USB_ENDP_TYPE_CTRL =0 , CY_USB_ENDP_TYPE_ISO , CY_USB_ENDP_TYPE_BULK , CY_USB_ENDP_TYPE_INTR , CY_USB_ENDP_TYPE_INVALID }
	List of USB endpoint types. More...

enum	cy_en_usb_endp_dir_t { CY_USB_ENDP_DIR_OUT =0 , CY_USB_ENDP_DIR_IN , CY_USB_ENDP_DIR_INVALID }
	Defines direction of USB endpoints. More...

enum	cy_en_usb_std_dscr_type_t { CY_USB_DSCR_TYPE_DEVICE = 0x01u , CY_USB_DSCR_TYPE_CFG , CY_USB_DSCR_TYPE_STR , CY_USB_DSCR_TYPE_INTF , CY_USB_DSCR_TYPE_ENDP , CY_USB_DSCR_TYPE_DEVICE_QUALIFIER , CY_USB_DSCR_TYPE_INTF_ASSOC = 0x0Bu , CY_USB_DSCR_TYPE_BOS = 0x0Fu , CY_USB_DSCR_TYPE_DEVICE_CAP = 0x10u , CY_USB_DSCR_TYPE_SS_ENDP_COMP = 0x30u , CY_USB_DSCR_TYPE_SSP_ISO_ENDP_COMP = 0x31u }
	Standard descriptor types defined by USB specification. More...

enum	cy_en_usb_set_dscr_type_t { CY_USB_SET_SS_DEVICE_DSCR , CY_USB_SET_HS_DEVICE_DSCR , CY_USB_SET_DEVICE_QUAL_DSCR , CY_USB_SET_FS_CONFIG_DSCR , CY_USB_SET_HS_CONFIG_DSCR , CY_USB_SET_SS_CONFIG_DSCR , CY_USB_SET_STRING_DSCR , CY_USB_SET_HS_BOS_DSCR , CY_USB_SET_SS_BOS_DSCR }
	List of descriptor types that can be registered with USB stack. More...

enum	cy_en_usb_usbd_cb_t { CY_USB_USBD_CB_RESET , CY_USB_USBD_CB_RESET_DONE , CY_USB_USBD_CB_BUS_SPEED , CY_USB_USBD_CB_SETUP , CY_USB_USBD_CB_SUSPEND , CY_USB_USBD_CB_RESUME , CY_USB_USBD_CB_SET_CONFIG , CY_USB_USBD_CB_SET_INTF , CY_USB_USBD_CB_STATUS_STAGE_COMP , CY_USB_USBD_CB_L1_SLEEP , CY_USB_USBD_CB_L1_RESUME , CY_USB_USBD_CB_ZLP , CY_USB_USBD_CB_SLP , CY_USB_USBD_CB_DONE , CY_USB_USBD_CB_DISCONNECT , CY_USB_USBD_CB_SETADDR , CY_USB_USBD_CB_EP0_RCV_DONE , CY_USB_USBD_CB_SOF_ITP , CY_USB_USBD_CB_USB3_LINKFAIL , CY_USB_USBD_CB_SET_INVALID }
	List of event callbacks made by USBD stack to the application. More...

enum	cy_en_usb_device_state_t { CY_USB_DEVICE_STATE_DISABLE = 0x00 , CY_USB_DEVICE_STATE_ENABLE , CY_USB_DEVICE_STATE_ATTACHED , CY_USB_DEVICE_STATE_POWER , CY_USB_DEVICE_STATE_RESET , CY_USB_DEVICE_STATE_DEFAULT , CY_USB_DEVICE_STATE_ADDRESS , CY_USB_DEVICE_STATE_CONFIGURED , CY_USB_DEVICE_STATE_SUSPEND , CY_USB_DEVICE_STATE_HS_L1 , CY_USB_DEVICE_STATE_INVALID }
	List of USB device states. More...

enum	cy_en_usb_endp0_state_t { CY_USB_ENDP0_STATE_IDLE = 0x00 , CY_USB_ENDP0_STATE_SETUP , CY_USB_ENDP0_STATE_DATAIN , CY_USB_ENDP0_STATE_DATAOUT , CY_USB_ENDP0_STATE_STATUS , CY_USB_ENDP0_STATE_STALL }
	List of USB control endpoint states. More...

enum	cy_en_usb_std_req_t { CY_USB_SC_GET_STATUS = 0x00 , CY_USB_SC_CLEAR_FEATURE , CY_USB_SC_RESERVED , CY_USB_SC_SET_FEATURE , CY_USB_SC_SET_ADDRESS = 0x05 , CY_USB_SC_GET_DESCRIPTOR , CY_USB_SC_SET_DESCRIPTOR , CY_USB_SC_GET_CONFIGURATION , CY_USB_SC_SET_CONFIGURATION , CY_USB_SC_GET_INTERFACE , CY_USB_SC_SET_INTERFACE , CY_USB_SC_SYNC_FRAME , CY_USB_SC_SET_SEL = 0x30 , CY_USB_SC_SET_ISOC_DELAY }
	Various standard request as per USB specification. More...

enum	cy_en_usb_dscr_type_t { CY_USB_DEVICE_DSCR = 0x01 , CY_USB_CONFIG_DSCR , CY_USB_STRING_DSCR , CY_USB_INTR_DSCR , CY_USB_ENDP_DSCR , CY_USB_DEVICE_QUAL_DSCR , CY_USB_OTHERSPEED_DSCR , CY_USB_BOS_DSCR = 0x0F , CY_DEVICE_CAPB_DSCR , CY_SS_ENDP_COMPN_DSCR = 0x30 , CY_SSPLUS_ISO_ENDP_COMPN_DSCR = 0x31 }
	Various standard descriptor as per USB secification. More...

enum	cy_en_usb_feature_selector_t { CY_USB_FEATURE_ENDP_HALT = 0 , CY_USB_FEATURE_FUNC_SUSPEND = 0 , CY_USB_FEATURE_DEVICE_REMOTE_WAKE = 1 , CY_USB_FEATURE_DEVICE_TEST_MODE = 2 , CY_USB_FEATURE_U1_ENABLE = 48 , CY_USB_FEATURE_U2_ENABLE = 49 , CY_USB_FEATURE_LTM_ENABLE = 50 , CY_USB_FEATURE_LDM_ENABLE = 53 }
	Defines used in set/clear feature command. More...

enum	cy_en_usb_enum_method_t { CY_USB_ENUM_METHOD_FAST = 0 , CY_USB_ENUM_METHOD_APPLICATION }
	Define for enumeration method. More...

enum	cy_en_usbd_ret_code_t { CY_USBD_STATUS_SUCCESS =0 , CY_USBD_STATUS_FAILURE , CY_USBD_STATUS_BAD_PARAM , CY_USBD_STATUS_CTXT_NULL , CY_USBD_STATUS_PTR_NULL , CY_USBD_STATUS_INVALID_CALLBACK_TYPE , CY_USBD_STATUS_INVALID_DSCR_TYPE , CY_USBD_STATUS_INVALID_INDEX , CY_USBD_STATUS_INVALID_CONFIG_NUMBER , CY_USBD_STATUS_MALLOC_FAILED , CY_USBD_STATUS_MSG_SEND_FAIL , CY_USBD_STATUS_CTRL_REQ_HANDLE_FAIL , CY_USBD_STATUS_ENDP_CONFIG_INVALID_PARAM , CY_USBD_STATUS_ENDP_CONFIG_FAIL , CY_USBD_STATUS_TIMEOUT , CY_USBD_STATUS_DSCR_FIELD_NOT_SUPPORTED }
	USBD layer return code shared between USBD layer and Application layer. More...

enum	cy_en_usbd_notification_type_t { CY_USBD_NOTIF_RESERVED = 0 , CY_USBD_NOTIF_FUNC_WAKE , CY_USBD_NOTIF_LTM , CY_USBD_NOTIF_BIAM , CY_USBD_NOTIF_RSVD4 , CY_USBD_NOTIF_SBLNK_SPEED }
	Types of device notifications applicable to USB3.2 devices. More...

enum	cy_en_usb2_ref_clk_src_t { USB2REF_CLK_SRC_UNKNOWN = 0x00 , USB2REF_CLK_SRC_ECO = 0x01 , USB2REF_CLK_SRC_EXT_CLK = 0x02 }
	Enumeration of clock sources which can possibly be used as reference for the USB High-Speed PLL. More...

enum	cy_en_usbhs_cal_test_mode_t { CY_USBHS_CAL_TEST_MODE_NORMAL =0 , CY_USBHS_CAL_TEST_MODE_TEST_J , CY_USBHS_CAL_TEST_MODE_TEST_K , CY_USBHS_CAL_TEST_MODE_TEST_SE0_NAK , CY_USBHS_CAL_TEST_MODE_TEST_PACKET , CY_USBHS_CAL_TEST_MODE_TEST_RESERVED }
	List of USB 2.x electrical test modes. More...

enum	cy_en_usbss_pkt_type_t { CY_USBSS_PKT_TYPE_LMP = 0x00 , CY_USBSS_PKT_TYPE_TP = 0x04 , CY_USBSS_PKT_TYPE_DPH = 0x08 , CY_USBSS_TP_PKT_TYPE_ITP = 0x0C }
	Types of USB 3.2 protocol layer packets. More...

enum	cy_en_usbss_tp_pkt_subtype_t { CY_USBSS_TP_SUBTYPE_RES = 0 , CY_USBSS_TP_SUBTYPE_ACK , CY_USBSS_TP_SUBTYPE_NRDY , CY_USBSS_TP_SUBTYPE_ERDY , CY_USBSS_TP_SUBTYPE_STATUS , CY_USBSS_TP_SUBTYPE_STALL , CY_USBSS_TP_SUBTYPE_NOTICE , CY_USBSS_TP_SUBTYPE_PING , CY_USBSS_TP_SUBTYPE_PINGRSP }
	Types of USB 3.2 transaction packets. More...

enum	cy_en_usbss_link_state_t { CY_USBSS_LNK_STATE_SSDISABLED = 0x00 , CY_USBSS_LNK_STATE_RXDETECT_RES = 0x01 , CY_USBSS_LNK_STATE_RXDETECT_ACT = 0x02 , CY_USBSS_LNK_STATE_RXDETECT_QUT = 0x03 , CY_USBSS_LNK_STATE_SSINACT_QUT = 0x04 , CY_USBSS_LNK_STATE_SSINACT_DET = 0x05 , CY_USBSS_LNK_STATE_POLLING_LFPS = 0x08 , CY_USBSS_LNK_STATE_POLLING_RxEQ = 0x09 , CY_USBSS_LNK_STATE_POLLING_ACT = 0x0A , CY_USBSS_LNK_STATE_POLLING_CFG = 0x0B , CY_USBSS_LNK_STATE_POLLING_IDLE = 0x0C , CY_USBSS_LNK_STATE_POLLING_LFPSPLUS = 0x0D , CY_USBSS_LNK_STATE_POLLING_PORTMATCH = 0x0E , CY_USBSS_LNK_STATE_POLLING_PORTCONF = 0x0F , CY_USBSS_LNK_STATE_U0 = 0x10 , CY_USBSS_LNK_STATE_U1 = 0x11 , CY_USBSS_LNK_STATE_U2 = 0x12 , CY_USBSS_LNK_STATE_U3 = 0x13 , CY_USBSS_LNK_STATE_LPBK_ACTV = 0x14 , CY_USBSS_LNK_STATE_COMP = 0x17 , CY_USBSS_LNK_STATE_RECOV_ACT = 0x18 , CY_USBSS_LNK_STATE_RECOV_CNFG = 0x19 , CY_USBSS_LNK_STATE_RECOV_IDLE = 0x1A , CY_USBSS_LNK_STATE_ILLEGAL = 0x1F }
	List of USB 3.2 link states. More...

enum	cy_en_usbss_lnk_power_mode_t { CY_USBSS_LPM_U0 = 0 , CY_USBSS_LPM_U1 , CY_USBSS_LPM_U2 , CY_USBSS_LPM_U3 , CY_USBSS_LPM_COMP , CY_USBSS_LPM_UNKNOWN }
	List of USB 3.2 link power modes. More...

enum	cy_en_usbss_cal_lpm_cfg_t { CY_SSCAL_LPM_DISABLED = 0 , CY_SSCAL_LPM_DELAYED , CY_SSCAL_LPM_ENABLED }
	List of possible USB 3.x LPM accept configurations. More...

enum	cy_en_usbss_delay_event_t { DELAY_EVENT_NONE = 0x00 , DELAY_EVENT_P0_CHG = 0x01 , DELAY_EVENT_HOLD_POLL_ACT = 0x02 }
	Types of events to handle after delay timer expires. More...

Enumeration Type Documentation

◆ cy_en_usb_cal_ret_code_t

enum cy_en_usb_cal_ret_code_t

List of API error codes returned by CAL APIs in various conditions.

Enumerator
CY_USB_CAL_STATUS_SUCCESS	Function completed successfully.
CY_USB_CAL_STATUS_FAILURE	Hardware level error encountered.
CY_USB_CAL_STATUS_BAD_PARAM	Invalid parameter passed to function.
CY_USB_CAL_STATUS_CAL_CTXT_NULL	Driver context is NULL.
CY_USB_CAL_STATUS_MALLOC_FAILED	Memory allocation for driver structures failed.
CY_USB_CAL_STATUS_MSG_SEND_FAIL	Sending of message to USBD stack failed.
CY_USB_CAL_STATUS_CAL_BASE_NULL	Pointer to USBHS device register set is NULL.
CY_USB_CAL_STATUS_TOGGLE_FAILED	Failed to update data toggle on USB 2.x endpoint.
CY_USB_CAL_STATUS_CAL_PROT_BASE_NULL	Pointer to USB32 protocol register set is NULL.
CY_USB_CAL_STATUS_CAL_LNK_BASE_NULL	Pointer to USB32 link register set is NULL.
CY_USB_CAL_STATUS_CAL_EPM_BASE_NULL	Pointer to USB32 EPM register set is NULL.
CY_USB_CAL_STATUS_CAL_MAIN_BASE_NULL	Pointer to USB32 register set is NULL.
CY_USB_CAL_STATUS_TIMEOUT	Operation timed out.

◆ cy_en_usb_cal_msg_type_t

enum cy_en_usb_cal_msg_type_t

Types of messages sent the by the USBHS and/or USBSS CAL drivers to the USBD stack.

Enumerator
CY_USB_CAL_MSG_INVALID	00: Invalid message type.
CY_USB_CAL_MSG_RESET	01: USB 2.x reset event.
CY_USB_CAL_MSG_HSGRANT	02: USB 2.x high speed chirp handshake complete.
CY_USB_CAL_MSG_RESET_DONE	03: USB 2.x reset complete event.
CY_USB_CAL_MSG_SUDAV	04: USB 2.x control request received.
CY_USB_CAL_MSG_STATUS_STAGE	05: USB 2.x control request acknowledged.
CY_USB_CAL_MSG_SETADDR	06: SET_ADDRESS request acknowledged.
CY_USB_CAL_MSG_SUSP	07: USB link suspended.
CY_USB_CAL_MSG_RESUME_START	08: USB 2.x resume signalling started.
CY_USB_CAL_MSG_RESUME_END	09: USB 2.x resume signalling completed.
CY_USB_CAL_MSG_DEEP_SLEEP_EXIT	10: Deep sleep exit detected.
CY_USB_CAL_MSG_L1_SLEEP	11: USB 2.x link entered L1 state.
CY_USB_CAL_MSG_L1_URESUME	12: USB 2.x link exited L1 state.
CY_USB_CAL_MSG_IN_ZLP	13: ZLP interrupt received on IN endpoint.
CY_USB_CAL_MSG_IN_SLP	14: SLP interrupt received on IN endpoint.
CY_USB_CAL_MSG_OUT_ZLP	15: ZLP interrupt received on OUT endpoint.
CY_USB_CAL_MSG_OUT_SLP	16: SLP interrupt received on OUT endpoint.
CY_USB_CAL_MSG_OUT_DONE	17: Expected amount of data received on OUT endpoint.
CY_USB_CAL_MSG_SOF_ITP	18: Start-of-Frame or ITP packet received.
CY_USB_CAL_MSG_ERRLIMIT	19: USB 2.x device raised error limit interrupt.
CY_USBSS_CAL_MSG_LNK_RESET	20: USB 3.x link reset: Warm or Hot Reset.
CY_USBSS_CAL_MSG_LNK_CONNECT	21: USB 3.x far-end terminations detected.
CY_USBSS_CAL_MSG_LNK_DISCONNECT	22: USB 3.x link entered SS.Disabled state.
CY_USBSS_CAL_MSG_LNK_INT	23: USB 3.x link interrupt received.
CY_USBSS_CAL_MSG_LNK_ERR_LIMIT	24: Too many USB 3.x link errors detected.
CY_USBSS_CAL_MSG_LNK_RX_DETECT_ACTIVE	25: USB 3.x link entered Rx.Detect.Active state.
CY_USBSS_CAL_MSG_LNK_SS_DISABLE	26: USB 3.x link entered SS.Disabled state.
CY_USBSS_CAL_MSG_LNK_COMPLIANCE	27: USB 3.x link entered Compliance state.
CY_USBSS_CAL_MSG_USB3_LNKFAIL	28: USB 3.x link unstable.
CY_USBSS_CAL_MSG_EP_INT	29: USB 2.x endpoint interrupt received.
CY_USBSS_CAL_MSG_PROT_INT	30: USB 3.x protocol interrupt received.
CY_USB_CAL_MSG_PROT_SETADDR_0	31: Device address set to 0
CY_USB_CAL_MSG_PROT_SUTOK	32: USB 3.x control request received.
CY_USB_CAL_MSG_PROT_HOST_ERR	33: USB 3.x host error indication received.
CY_USB_CAL_MSG_PROT_TIMEOUT_PORT_CAP	34: Port Capability LMP handshake timed out.
CY_USB_CAL_MSG_PROT_TIMEOUT_PORT_CFG	35: Port Configuration LMP handshake timed out.
CY_USB_CAL_MSG_PROT_TIMEOUT_PING	36: Ping timeout.
CY_USB_CAL_MSG_PROT_LMP_INVALID_PORT_CAP	37: Invalid Port Capability LMP received.
CY_USB_CAL_MSG_PROT_LMP_INVALID_PORT_CFG	38: Invalid Port Configuration LMP received.
CY_USBSS_CAL_MSG_PROT_EP_INT	39: USB 3.x endpoint interrupt received.
CY_USBSS_CAL_MSG_VBUS_CHANGE	40: VBus voltage change detected.
CY_USBSS_CAL_MSG_USB3_WARM_RESET	41: USB 3.x warm reset detected.
CY_USBSS_CAL_MSG_USB3_U3_SUSPEND	42: USB 3.x link entered U3
CY_USBSS_CAL_MSG_USB3_U0_RESUME	43: USB 3.x link re-entered U0 from U3
CY_USBSS_CAL_MSG_UX_REENABLE	44: Indication to re-enable USB 3.x LPM transitions.
CY_USBSS_CAL_MSG_EPM_UNDERRUN	45: Underrun detected by the USB 3.x endpoint memory.
CY_USBSS_CAL_MSG_USB3_LMP_FAIL	46: LMP handshake failure.
CY_USBSS_CAL_MSG_USB3_RATE_CHG	47: USB 3.x data rate changed.
CY_USBSS_CAL_MSG_ABORT_UX_ENABLE	48: Cancel re-enable of USB 3.x LPM transitions.
CY_USBSS_CAL_MSG_HANDLE_RXLOCK_FAILURE	49: Handle Gen2 link training failure.
CY_USB_CAL_MSG_EP0_RCV_DONE	50: EP0-OUT receive complete.
CY_USBSS_CAL_MSG_PORT_CONFIGURED	51: Port Configuration LMP handshake completed.
CY_USBSS_CAL_MSG_LPBK_FORCED	52: Link has been forced into Loopback state.
CY_USB_CAL_MSG_SS_RECONNECT	53: USB-SS link reconnect request from timer callback.
CY_USB_CAL_MSG_MAX	54: Invalid message.

◆ cy_en_usbss_cal_evt_type_t

enum cy_en_usbss_cal_evt_type_t

List of USB events which are logged into the RAM based time-stamped event buffer for debug support.

Enumerator
CY_SSCAL_EVT_NONE	0x00: No event indication.
CY_SSCAL_EVT_DRV_EN	0x01: USBSS driver/IP enable.
CY_SSCAL_EVT_CONN_EN	0x02: USBSS connection enable.
CY_SSCAL_EVT_CONN_DIS	0x03: USBSS connection disable.
CY_SSCAL_EVT_CONNECT	0x04: Link connect interrupt.
CY_SSCAL_EVT_DISCONNECT	0x05: Link disconnect interrupt.
CY_SSCAL_EVT_RESET	0x06: Link reset interrupt.
CY_SSCAL_EVT_PSVP_RECONNECT	0x07: PSVP reconnect attempt after polling failure.
CY_SSCAL_EVT_PORT_CAP_HNDSHK	0x08: Port Capability handshake complete.
CY_SSCAL_EVT_PORT_CFG_HNDSHK	0x09: Port Configuration handshake complete.
CY_SSCAL_EVT_LMP_TIMEOUT	0x0A: Port Cap/Cfg handshake timeout.
CY_SSCAL_EVT_VBUS_PRESENT	0x0B: VBus presence detected.
CY_SSCAL_EVT_VBUS_ABSENT	0x0C: VBus absence detected.
CY_SSCAL_EVT_WARM_RESET	0x0D: Warm Reset detected.
CY_SSCAL_EVT_DBG_1	0x0E: App specific debug event #1
CY_SSCAL_EVT_DBG_2	0x0F: App specific debug event #2
CY_SSCAL_EVT_VBUS_CHG_INTR	0x10: VBus state change interrupt.
CY_SSCAL_EVT_SETADDR_INTR	0x11: SET_ADDRESS request received.
CY_SSCAL_EVT_SUTOK_INTR	0x12: New Control request received.
CY_SSCAL_EVT_EP0STAT_INTR	0x13: Status TP received.
CY_SSCAL_EVT_RATE_GEN1	0x14: Data rate changed to Gen1
CY_SSCAL_EVT_RATE_GEN2	0x15: Data rate changed to Gen2
CY_SSCAL_EVT_NEXT_CP_SEL	0x16: Shift to next compliance pattern.
CY_SSCAL_EVT_PHY0_SELECT	0x17: PHY0 instance selected for connection.
CY_SSCAL_EVT_PHY1_SELECT	0x18: PHY1 instance selected for connection.
CY_SSCAL_EVT_POLLING_CDR_RST	0x19: CDR reset due to long stay in Polling.Active.
CY_SSCAL_EVT_RECOV_DELAY	0x1A: Recovery is going on for a long time.
CY_SSCAL_EVT_CDR_RESET_1	0x1B: CDR reset on entry into Polling.RxEq.
CY_SSCAL_EVT_HP_TIMEOUT	0x1C: PENDING_HP_TIMER timeout.
CY_SSCAL_EVT_U3_PHY_DISABLED	0x1D: USB3 PHY disabled since link is in U3
CY_SSCAL_EVT_U3_WAKE_PHY_ENABLE	0x1E: USB3 PHY re-enabled as part of U3 exit.
CY_SSCAL_EVT_DEV_U3_EXIT	0x1F: Device initiated U3 exit.
CY_SSCAL_EVT_LNK_SS_DISABLE	0x20: LTSSM state change to SS.Disable.
CY_SSCAL_EVT_LNK_RX_DET_RES	0x21: LTSSM state change to Rx.Detect.Reset.
CY_SSCAL_EVT_LNK_RX_DET_ACT	0x22: LTSSM state change to Rx.Detect.Active.
CY_SSCAL_EVT_LNK_RX_DET_QUIET	0x23: LTSSM state change to Rx.Detect.Quiet.
CY_SSCAL_EVT_LNK_SS_INACT_QUIET	0x24: LTSSM state change to SS.Inactive.Quiet
CY_SSCAL_EVT_LNK_SS_INACT_DISC	0x25: LTSSM state change to SS.Inactive.Disconnect.Detect
CY_SSCAL_EVT_LNK_HOTRST_ACT	0x26: LTSSM state change to HotReset.Active.
CY_SSCAL_EVT_LNK_HOTRST_EXIT	0x27: LTSSM state change to HotReset.Exit.
CY_SSCAL_EVT_LNK_POLLING_LFPS	0x28: LTSSM state change to Polling.LFPS.
CY_SSCAL_EVT_LNK_POLLING_RXEQ	0x29: LTSSM state change to Polling.RxEQ.
CY_SSCAL_EVT_LNK_POLLING_ACT	0x2A: LTSSM state change to Polling.Active.
CY_SSCAL_EVT_LNK_POLLING_CFG	0x2B: LTSSM state change to Polling.Configuration.
CY_SSCAL_EVT_LNK_POLLING_IDLE	0x2C: LTSSM state change to Polling.Idle.
CY_SSCAL_EVT_LNK_POLLING_PLUS	0x2D: LTSSM state change to Polling.LFPSPlus.
CY_SSCAL_EVT_LNK_POLLING_PMATCH	0x2E: LTSSM state change to Polling.PortMatch.
CY_SSCAL_EVT_LNK_POLLING_PCFG	0x2F: LTSSM state change to Polling.PortConfig
CY_SSCAL_EVT_LNK_U0	0x30: LTSSM state change to U0
CY_SSCAL_EVT_LNK_U1	0x31: LTSSM state change to U1
CY_SSCAL_EVT_LNK_U2	0x32: LTSSM state change to U2
CY_SSCAL_EVT_LNK_U3	0x33: LTSSM state change to U3
CY_SSCAL_EVT_LNK_LPBK_ACT	0x34: LTSSM state change to Loopback.Active
CY_SSCAL_EVT_LNK_LPBK_EXIT	0x35: LTSSM state change to Loopback.Exit
CY_SSCAL_EVT_LNK_UNDEF0	0x36: Undefined link state.
CY_SSCAL_EVT_LNK_COMPLIANCE	0x37: LTSSM state change to Compliance
CY_SSCAL_EVT_LNK_RECOV_ACT	0x38: LTSSM state change to Recovery.Active
CY_SSCAL_EVT_LNK_RECOV_CFG	0x39: LTSSM state change to Recovery.Configuration
CY_SSCAL_EVT_LNK_RECOV_IDLE	0x3A: LTSSM state change to Recovery.Idle
CY_USBD_EVT_SS_TO_HS	0x40: SS to HS fallback.
CY_USBD_EVT_SS_REEN	0x41: SS Re-enable due to USB 2.x reset.
CY_USBD_EVT_SS_DISB	0x42: SS disable from USBD.
CY_USBD_EVT_HS_DISB	0x43: HS disable due to SS receiver detect.
CY_USBD_EVT_HS_RESET_SKIP	0x44: SS re-enable skipped on HS reset.
CY_USBD_EVT_SET_CONFIG_CB	0x45: SetConfig callback being invoked.
CY_USBD_EVT_SET_INTF_CB	0x46: SetInterface callback being invoked.
CY_HSCAL_EVT_CONN_EN	0x50: USBHS connection enable.
CY_HSCAL_EVT_CONN_DIS	0x51: USBHS connection disable.
CY_HSCAL_EVT_PHY_COMM_INIT	0x52: USBHS Common PHY INIT done.
CY_HSCAL_EVT_PHY_FSHSMODE_INIT	0x53: USBHS FSHS PHY INIT done.
CY_HSCAL_EVT_CAL_INIT_DONE	0x54: USBHS CAL init done.
CY_HSCAL_EVT_PLL_INIT	0x55: USBHS PLL init done.
CY_HSCAL_EVT_PLL_DEINIT	0x56: USBHS PLL DEINIT done.
CY_HSCAL_EVT_SUSP	0x57: USBHS suspend interrupt.
CY_HSCAL_EVT_URESET	0x58: USBHS URESET interrupt.
CY_HSCAL_EVT_HSGRANT	0x59: USBHS HSGRANT interrupt.
CY_HSCAL_EVT_SUDAV	0x5A: USBHS SUDAV interrupt.
CY_HSCAL_EVT_ERRLIMIT	0x5B: USBHS ERRLIMIT interrupt.
CY_HSCAL_EVT_URESUME	0x5C: USBHS URESUME interrupt.
CY_HSCAL_EVT_STATUS_STAGE	0x5D: USBHS STATUS STAGE interrupt.
CY_HSCAL_EVT_L1_SLEEP_REQ	0x5E: USBHS L1SLEEP_REQ interrupt.
CY_HSCAL_EVT_L1_URESUME	0x5F: USBHS L1URESUME interrupt.
CY_HSCAL_EVT_RESET_DONE	0x60: USBHS RESET DONE interrupt.
CY_HSCAL_EVT_SET_ADDR	0x61: USBHS SET ADDR interrupt.
CY_HSCAL_EVT_HOST_URESUME_ARR	0x62: USBHS HOST URESUME interrupt.
CY_HSCAL_EVT_DPSLP	0x63: USBHS DPSLP interrupt.
CY_HSCAL_EVT_PID_MISMATCH	0x64: USBHS PID MISMATCH interrupt.
CY_HSCAL_EVT_START_REMOTE_WAKE_SGNAL	0x65: USBHS REMOTE_WAKE SIGNAL interrupt.
CY_HSCAL_EVT_USBD_INIT	0x70: USBD INIT DONE.
CY_USBD_DATA_RATE_UNCONNECTED	0x80: USB connection not present.
CY_USBD_DATA_RATE_FS	0x81: Data rate changed to USB-FS
CY_USBD_DATA_RATE_HS	0x82: Data rate changed to USB-HS
CY_USBD_DATA_RATE_GEN1X1	0x83: Data rate changed to Gen1x1 (5Gbps)
CY_USBD_DATA_RATE_GEN1X2	0x84: Data rate changed to Gen1x2 (9Gbps)
CY_USBD_DATA_RATE_GEN2X1	0x85: Data rate changed to Gen2x1 (10Gbps)
CY_USBD_DATA_RATE_GEN2X2	0x86: Data rate changed to Gen2x2 (20Gbps)
CY_USB_UVC_EVT_SET_CFG	0x90: UVC application SET_CONFIG request.
CY_USB_UVC_EVT_SET_INTF	0x91: UVC application SET_INTERFACE request.
CY_USB_UVC_EVT_VSTREAM_START	0x92: UVC video streaming start request.
CY_USB_UVC_EVT_SET_CUR_REQ	0x93: UVC SET_CUR request.
CY_USB_EVT_INIT_LVDS_LB_EN	0xA0: LVDS link loopback enabled.
CY_USB_EVT_PPORT0_EN	0xA1: LVDS port #0 enabled.
CY_USB_EVT_PPORT1_EN	0xA2: LVDS port #1 enabled.
CY_USB_EVT_LVCMOS_EN	0xA3: LVCMOS mode selected.
CY_USB_EVT_LVDS_EN	0xA4: LVDS mode selected.
CY_USB_EVT_INMD_EN	0xA5: Metadata insertion enabled.
CY_USB_EVT_WL_EN	0xA6: LVDS WideLink mode selected.
CY_USB_U3V_EVT_EPHALT_DCI_CMD	0xB0: U3V DCI command endpoint halted.
CY_USB_U3V_EVT_EPHALT_DCI_RSP	0xB1: U3V DCI response endpoint halted.
CY_USB_U3V_EVT_U3V_CMD	0xB2: U3V DCI command received.
CY_USB_U3V_EVT_U3V_RESP_SENT	0xB3: U3V DCI response sent.
CY_LNK_EVENT_DBG_0	0xF0:
CY_LNK_EVENT_SET_U1	0xF1:
CY_LNK_EVENT_SET_U2	0xF2:
CY_LNK_EVENT_CLR_U1	0xF3:
CY_LNK_EVENT_CLR_U2	0xF4:
CY_LNK_EVENT_SET_FORCE_ACCEPT_LPM	0xF5: LPM enable forced due to Link Management Packet.
CY_LNK_EVENT_CLR_FORCE_ACCEPT_LPM	0xF6: Forced LPM enable cleared due to Link Management Packet.
CY_LNK_EVENT_CDR_RST_DECODE_ERR	0xF7: Decode error reported by PHY for config lane.
CY_LNK_EVENT_CDR_RST_DECODE_ERR_PHY_1	0xF8: Decode error reported by PHY for non-config lane.
CY_LNK_EVENT_SS_DISABLED_ENTRY	0xF9: SS.Disabled state entered.
CY_LNK_EVENT_TRIG_DISCON_EVENT	0xFA: LTSSM Disconnect interrupt forced by firmware.
CY_LNK_EVENT_LANE_POLARITY_INV	0xFB: Lane Polarity inverted
CY_LNK_EVENT_LNK_FORCE_U0	0xFC: Link forced into U0 state during Ux exit sequence.
CY_LNK_EVENT_UX_EXIT_TS1_TIMEOUT	0xFD: Transition into Recovery.Config did not happen within expected time.
CY_LNK_EVENT_USB_CLK_STOP	0xFE: USB block has been stopped.
CY_LNK_EVENT_USB_CLK_START	0xFF: USB block has been started.

◆ cy_en_usb_speed_t

enum cy_en_usb_speed_t

List of USB connection speeds which can be supported on the device.

Enumerator
CY_USBD_USB_DEV_NOT_CONNECTED	USB connection is inactive.
CY_USBD_USB_DEV_FS	Full-Speed USB connection.
CY_USBD_USB_DEV_HS	High-Speed USB connection.
CY_USBD_USB_DEV_SS_GEN1	USB 3.2 Gen1x1 (5 Gbps) USB connection.
CY_USBD_USB_DEV_SS_GEN1X2	USB 3.2 Gen1x2 (10 Gbps) USB connection.
CY_USBD_USB_DEV_SS_GEN2	USB 3.2 Gen2x1 (10 Gbps) USB connection.
CY_USBD_USB_DEV_SS_GEN2X2	USB 3.2 Gen2x2 (20 Gbps) USB connection.

◆ cy_en_usb_config_lane_t

enum cy_en_usb_config_lane_t

Options for USB 3.x Configuration Lane Selection.

Enumerator
CY_USB_CFG_LANE_AUTODETECT	Configuration lane to be detected through CC voltage measurement.
CY_USB_CFG_LANE_0	Lane-0 to be used as Configuration lane.
CY_USB_CFG_LANE_1	Lane-1 to be used as Configuration lane.

◆ cy_en_usb_endp_type_t

enum cy_en_usb_endp_type_t

List of USB endpoint types.

Enumerator
CY_USB_ENDP_TYPE_CTRL	Control endpoint.
CY_USB_ENDP_TYPE_ISO	Isochronous endpoint.
CY_USB_ENDP_TYPE_BULK	Bulk endpoint.
CY_USB_ENDP_TYPE_INTR	Interrupt endpoint.
CY_USB_ENDP_TYPE_INVALID	Invalid endpoint type.

◆ cy_en_usb_endp_dir_t

enum cy_en_usb_endp_dir_t

Defines direction of USB endpoints.

Enumerator
CY_USB_ENDP_DIR_OUT	OUT endpoint: host to device.
CY_USB_ENDP_DIR_IN	IN endpoint: device to host.
CY_USB_ENDP_DIR_INVALID	Invalid endpoint direction.

◆ cy_en_usb_std_dscr_type_t

enum cy_en_usb_std_dscr_type_t

Standard descriptor types defined by USB specification.

Enumerator
CY_USB_DSCR_TYPE_DEVICE	0x01: Device descriptor.
CY_USB_DSCR_TYPE_CFG	0x02: Configuration descriptor.
CY_USB_DSCR_TYPE_STR	0x03: String descriptor.
CY_USB_DSCR_TYPE_INTF	0x04: Interface descriptor.
CY_USB_DSCR_TYPE_ENDP	0x05: Endpoint descriptor.
CY_USB_DSCR_TYPE_DEVICE_QUALIFIER	0x06: Device qualifier descriptor.
CY_USB_DSCR_TYPE_INTF_ASSOC	0x0B: Interface association descriptor.
CY_USB_DSCR_TYPE_BOS	0x0F: BOS descriptor.
CY_USB_DSCR_TYPE_DEVICE_CAP	0x10: Device capability descriptor.
CY_USB_DSCR_TYPE_SS_ENDP_COMP	0x30: SS endpoint companion descriptor.
CY_USB_DSCR_TYPE_SSP_ISO_ENDP_COMP	0x31: SSP isochronous EP companion descriptor.

◆ cy_en_usb_set_dscr_type_t

enum cy_en_usb_set_dscr_type_t

List of descriptor types that can be registered with USB stack.

Enumerator
CY_USB_SET_SS_DEVICE_DSCR	USB 3.x device descriptor.
CY_USB_SET_HS_DEVICE_DSCR	USB 2.x device descriptor.
CY_USB_SET_DEVICE_QUAL_DSCR	Device qualifier descriptor.
CY_USB_SET_FS_CONFIG_DSCR	Full Speed Configuration descriptor.
CY_USB_SET_HS_CONFIG_DSCR	High Speed Configuration descriptor.
CY_USB_SET_SS_CONFIG_DSCR	Super Speed Configuration descriptor.
CY_USB_SET_STRING_DSCR	String descriptor.
CY_USB_SET_HS_BOS_DSCR	USB 2.x BOS descriptor.
CY_USB_SET_SS_BOS_DSCR	USB 3.x BOS descriptor.

◆ cy_en_usb_usbd_cb_t

enum cy_en_usb_usbd_cb_t

List of event callbacks made by USBD stack to the application.

Enumerator
CY_USB_USBD_CB_RESET	USB bus reset event.
CY_USB_USBD_CB_RESET_DONE	USB reset complete event.
CY_USB_USBD_CB_BUS_SPEED	Full Speed to High Speed transition event.
CY_USB_USBD_CB_SETUP	Control request to be handled by application.
CY_USB_USBD_CB_SUSPEND	USB link suspended.
CY_USB_USBD_CB_RESUME	USB link resumed from suspend.
CY_USB_USBD_CB_SET_CONFIG	SET_CONFIGURATION request received.
CY_USB_USBD_CB_SET_INTF	SET_INTERFACE request received.
CY_USB_USBD_CB_STATUS_STAGE_COMP	Control request acknowledged.
CY_USB_USBD_CB_L1_SLEEP	USB 2.x L1 state entered.
CY_USB_USBD_CB_L1_RESUME	USB 2.x L1 state exited.
CY_USB_USBD_CB_ZLP	ZLP transfer done on endpoint. USB 2.x only.
CY_USB_USBD_CB_SLP	SLP transfer done on endpoint. USB 2.x only.
CY_USB_USBD_CB_DONE	Requested transfer completed on endpoint. USB 2.x only.
CY_USB_USBD_CB_DISCONNECT	USB disconnect detected. USB 3.x only.
CY_USB_USBD_CB_SETADDR	SET_ADDRESS command completed.
CY_USB_USBD_CB_EP0_RCV_DONE	EP0 out transfer has been completed.
CY_USB_USBD_CB_SOF_ITP	USB3 ITP or USB2 SOF received.
CY_USB_USBD_CB_USB3_LINKFAIL	USB3 link bring-up failure while USB2 is disabled.
CY_USB_USBD_CB_SET_INVALID	Invalid callback type.

◆ cy_en_usb_device_state_t

enum cy_en_usb_device_state_t

List of USB device states.

Enumerator
CY_USB_DEVICE_STATE_DISABLE	When device is not visible on BUS.
CY_USB_DEVICE_STATE_ENABLE	When device is visible on BUS.
CY_USB_DEVICE_STATE_ATTACHED	When Device visible and VBUS detected.
CY_USB_DEVICE_STATE_POWER	When VBUS visible.
CY_USB_DEVICE_STATE_RESET	when Bus reset applied.
CY_USB_DEVICE_STATE_DEFAULT	when RESET complete.
CY_USB_DEVICE_STATE_ADDRESS	When SET_ADDRESS complete.
CY_USB_DEVICE_STATE_CONFIGURED	When device is in configured state.
CY_USB_DEVICE_STATE_SUSPEND	When USB link is suspended (L2/U3)
CY_USB_DEVICE_STATE_HS_L1	When USBHS link is in L1 state.
CY_USB_DEVICE_STATE_INVALID	Unused state.

◆ cy_en_usb_endp0_state_t

enum cy_en_usb_endp0_state_t

List of USB control endpoint states.

Enumerator
CY_USB_ENDP0_STATE_IDLE	Control endpoint is idle.
CY_USB_ENDP0_STATE_SETUP	Control request received.
CY_USB_ENDP0_STATE_DATAIN	IN transfer pending.
CY_USB_ENDP0_STATE_DATAOUT	OUT transfer pending.
CY_USB_ENDP0_STATE_STATUS	Status handshake pending.
CY_USB_ENDP0_STATE_STALL	Control endpoint stalled.

◆ cy_en_usb_std_req_t

enum cy_en_usb_std_req_t

Various standard request as per USB specification.

Enumerator
CY_USB_SC_GET_STATUS	Get status.
CY_USB_SC_CLEAR_FEATURE	Clear feature.
CY_USB_SC_RESERVED	Undefined request.
CY_USB_SC_SET_FEATURE	Set feature.
CY_USB_SC_SET_ADDRESS	Set Address.
CY_USB_SC_GET_DESCRIPTOR	Get Descriptor.
CY_USB_SC_SET_DESCRIPTOR	Set Descriptor.
CY_USB_SC_GET_CONFIGURATION	Get Configuration.
CY_USB_SC_SET_CONFIGURATION	Set Configuration.
CY_USB_SC_GET_INTERFACE	Get Interface.
CY_USB_SC_SET_INTERFACE	Set Interface.
CY_USB_SC_SYNC_FRAME	Sync Frame.
CY_USB_SC_SET_SEL	Set system exit latency.
CY_USB_SC_SET_ISOC_DELAY	Set isochronous delay.

◆ cy_en_usb_dscr_type_t

enum cy_en_usb_dscr_type_t

Various standard descriptor as per USB secification.

Enumerator
CY_USB_DEVICE_DSCR	Device descriptor.
CY_USB_CONFIG_DSCR	Configuration descriptor.
CY_USB_STRING_DSCR	String descriptor.
CY_USB_INTR_DSCR	Interface descriptor.
CY_USB_ENDP_DSCR	Endpoint descriptor.
CY_USB_DEVICE_QUAL_DSCR	Device qualifier descriptor.
CY_USB_OTHERSPEED_DSCR	Other Speed configuration descriptor.
CY_USB_BOS_DSCR	BOS descriptor.
CY_DEVICE_CAPB_DSCR	Device capability descriptor.
CY_SS_ENDP_COMPN_DSCR	SS endpoint companion descriptor.
CY_SSPLUS_ISO_ENDP_COMPN_DSCR	SSP isochronous endpoint companion descriptor.

◆ cy_en_usb_feature_selector_t

enum cy_en_usb_feature_selector_t

Defines used in set/clear feature command.

Enumerator
CY_USB_FEATURE_ENDP_HALT	Endpoint Halt: Addressed to endpoint.
CY_USB_FEATURE_FUNC_SUSPEND	Function Suspend: Addressed to interface.
CY_USB_FEATURE_DEVICE_REMOTE_WAKE	Remote wake.
CY_USB_FEATURE_DEVICE_TEST_MODE	USB 2.x electrical test mode.
CY_USB_FEATURE_U1_ENABLE	USB 3.x U1 Enable
CY_USB_FEATURE_U2_ENABLE	USB 3.x U2 Enable
CY_USB_FEATURE_LTM_ENABLE	USB 3.x LTM Enable
CY_USB_FEATURE_LDM_ENABLE	USB 3.x LDM Enable

◆ cy_en_usb_enum_method_t

enum cy_en_usb_enum_method_t

Define for enumeration method.

Enumerator
CY_USB_ENUM_METHOD_FAST	USBD layer handles enumeration process.
CY_USB_ENUM_METHOD_APPLICATION	Application layer will handle enumeration.

◆ cy_en_usbd_ret_code_t

enum cy_en_usbd_ret_code_t

USBD layer return code shared between USBD layer and Application layer.

Enumerator
CY_USBD_STATUS_SUCCESS	Function completed successfully.
CY_USBD_STATUS_FAILURE	Unexpected failure condition.
CY_USBD_STATUS_BAD_PARAM	Invalid parameter passed to API.
CY_USBD_STATUS_CTXT_NULL	USBD context pointer is NULL.
CY_USBD_STATUS_PTR_NULL	NULL pointer passed for necessary parameters.
CY_USBD_STATUS_INVALID_CALLBACK_TYPE	Invalid callback type specified.
CY_USBD_STATUS_INVALID_DSCR_TYPE	Invalid descriptor type specified.
CY_USBD_STATUS_INVALID_INDEX	Invalid descriptor index specified.
CY_USBD_STATUS_INVALID_CONFIG_NUMBER	Invalid configuration index specified.
CY_USBD_STATUS_MALLOC_FAILED	Memory allocation failed.
CY_USBD_STATUS_MSG_SEND_FAIL	Sending of message to application layer failed.
CY_USBD_STATUS_CTRL_REQ_HANDLE_FAIL	Stack was unable to handle a control request.
CY_USBD_STATUS_ENDP_CONFIG_INVALID_PARAM	Invalid endpoint configuration specified.
CY_USBD_STATUS_ENDP_CONFIG_FAIL	Failed to configure endpoint.
CY_USBD_STATUS_TIMEOUT	Operation timed out.
CY_USBD_STATUS_DSCR_FIELD_NOT_SUPPORTED	Invalid descriptor field queried.

◆ cy_en_usbd_notification_type_t

enum cy_en_usbd_notification_type_t

Types of device notifications applicable to USB3.2 devices.

Enumerator
CY_USBD_NOTIF_RESERVED	Invalid value.
CY_USBD_NOTIF_FUNC_WAKE	Function wake notification.
CY_USBD_NOTIF_LTM	Latency tolerance message.
CY_USBD_NOTIF_BIAM	Bus interval adjustment message.
CY_USBD_NOTIF_RSVD4	Host Role Request message is reserved and should not be used.
CY_USBD_NOTIF_SBLNK_SPEED	Sublink Speed notification.

◆ cy_en_usb2_ref_clk_src_t

enum cy_en_usb2_ref_clk_src_t

Enumeration of clock sources which can possibly be used as reference for the USB High-Speed PLL.

Enumerator
USB2REF_CLK_SRC_UNKNOWN	Unknown clock source.
USB2REF_CLK_SRC_ECO	Clock generated by External Crystal Oscillator (ECO)
USB2REF_CLK_SRC_EXT_CLK	External clock input.

◆ cy_en_usbhs_cal_test_mode_t

enum cy_en_usbhs_cal_test_mode_t

List of USB 2.x electrical test modes.

Enumerator
CY_USBHS_CAL_TEST_MODE_NORMAL	No test mode.
CY_USBHS_CAL_TEST_MODE_TEST_J	TEST_J mode.
CY_USBHS_CAL_TEST_MODE_TEST_K	TEST_K mode.
CY_USBHS_CAL_TEST_MODE_TEST_SE0_NAK	TEST_SE0_NAK mode.
CY_USBHS_CAL_TEST_MODE_TEST_PACKET	TEST_Packet mode.
CY_USBHS_CAL_TEST_MODE_TEST_RESERVED	Invalid test selection.

◆ cy_en_usbss_pkt_type_t

enum cy_en_usbss_pkt_type_t

Types of USB 3.2 protocol layer packets.

Enumerator
CY_USBSS_PKT_TYPE_LMP	Link Management Packet.
CY_USBSS_PKT_TYPE_TP	Transaction Packet.
CY_USBSS_PKT_TYPE_DPH	Data Packet Header.
CY_USBSS_TP_PKT_TYPE_ITP	Isochronous Timestamp Packet.

◆ cy_en_usbss_tp_pkt_subtype_t

enum cy_en_usbss_tp_pkt_subtype_t

Types of USB 3.2 transaction packets.

Enumerator
CY_USBSS_TP_SUBTYPE_RES	Reserved.
CY_USBSS_TP_SUBTYPE_ACK	ACK TP.
CY_USBSS_TP_SUBTYPE_NRDY	NRDY TP.
CY_USBSS_TP_SUBTYPE_ERDY	ERDY TP.
CY_USBSS_TP_SUBTYPE_STATUS	STATUS TP.
CY_USBSS_TP_SUBTYPE_STALL	STALL TP.
CY_USBSS_TP_SUBTYPE_NOTICE	DEV_NOTIFICATION TP.
CY_USBSS_TP_SUBTYPE_PING	PING TP.
CY_USBSS_TP_SUBTYPE_PINGRSP	PING RESPONSE TP.

◆ cy_en_usbss_link_state_t

enum cy_en_usbss_link_state_t

List of USB 3.2 link states.

This list is non-exhaustive and covers only states of interest.

Enumerator
CY_USBSS_LNK_STATE_SSDISABLED	SS.Disabled.
CY_USBSS_LNK_STATE_RXDETECT_RES	Rx.Detect.Reset.
CY_USBSS_LNK_STATE_RXDETECT_ACT	Rx.Detect.Active.
CY_USBSS_LNK_STATE_RXDETECT_QUT	Rx.Detect.Quiet.
CY_USBSS_LNK_STATE_SSINACT_QUT	SS.Inactive.Quiet.
CY_USBSS_LNK_STATE_SSINACT_DET	SS.Inactive.Disconnect.Detect.
CY_USBSS_LNK_STATE_POLLING_LFPS	Polling.LFPS.
CY_USBSS_LNK_STATE_POLLING_RxEQ	Polling.RxEq.
CY_USBSS_LNK_STATE_POLLING_ACT	Polling.Active.
CY_USBSS_LNK_STATE_POLLING_CFG	Polling.Configuration.
CY_USBSS_LNK_STATE_POLLING_IDLE	Polling.Idle.
CY_USBSS_LNK_STATE_POLLING_LFPSPLUS	Polling.LfpsPlus.
CY_USBSS_LNK_STATE_POLLING_PORTMATCH	Polling.PortMatch.
CY_USBSS_LNK_STATE_POLLING_PORTCONF	Polling.PortConfig.
CY_USBSS_LNK_STATE_U0	U0 - Active state.
CY_USBSS_LNK_STATE_U1	U1.
CY_USBSS_LNK_STATE_U2	U2.
CY_USBSS_LNK_STATE_U3	U3 - Suspend state.
CY_USBSS_LNK_STATE_LPBK_ACTV	Loopback.Active state.
CY_USBSS_LNK_STATE_COMP	Compliance.
CY_USBSS_LNK_STATE_RECOV_ACT	Recovery.Active.
CY_USBSS_LNK_STATE_RECOV_CNFG	Recovery.Configuration.
CY_USBSS_LNK_STATE_RECOV_IDLE	Recovery.Idle.
CY_USBSS_LNK_STATE_ILLEGAL	Illegal/unknown LTSSM state.

◆ cy_en_usbss_lnk_power_mode_t

enum cy_en_usbss_lnk_power_mode_t

List of USB 3.2 link power modes.

Enumerator
CY_USBSS_LPM_U0	U0 (active) power state.
CY_USBSS_LPM_U1	U1 power state.
CY_USBSS_LPM_U2	U2 power state.
CY_USBSS_LPM_U3	U3 (suspend) power state.
CY_USBSS_LPM_COMP	Compliance state.
CY_USBSS_LPM_UNKNOWN	The link is not in any of the Ux states. This normally happens while the link training is ongoing.

◆ cy_en_usbss_cal_lpm_cfg_t

enum cy_en_usbss_cal_lpm_cfg_t

List of possible USB 3.x LPM accept configurations.

Enumerator
CY_SSCAL_LPM_DISABLED	U1/U2 entry has been disabled by user.
CY_SSCAL_LPM_DELAYED	U1/U2 entry delayed for the instant.
CY_SSCAL_LPM_ENABLED	U1/U2 entry is allowed.

◆ cy_en_usbss_delay_event_t

enum cy_en_usbss_delay_event_t

Types of events to handle after delay timer expires.

Enumerator
DELAY_EVENT_NONE	No events pending.
DELAY_EVENT_P0_CHG	Handle P0 change interrupt.
DELAY_EVENT_HOLD_POLL_ACT	Handle Polling Active entry event.