PDStack Middleware Library 2.0
Enumerated Types

General Description

This section describes the enumeration types defined by the PDStack.

Enumerations

enum  cy_en_pdstack_err_recov_reason_t {
  CY_PDSTACK_ERR_RECOV_REASON_NONE = 0,
  CY_PDSTACK_ERR_RECOV_HR_FAIL,
  CY_PDSTACK_ERR_RECOV_PROTECT_FAULT,
  CY_PDSTACK_ERR_RECOV_POWER_FAULT,
  CY_PDSTACK_ERR_RECOV_BAD_DATA_ROLE,
  CY_PDSTACK_ERR_RECOV_FRS_FAIL,
  CY_PDSTACK_ERR_RECOV_DATA_RESET_FAIL
}
 Enumeration of reasons for error recovery entry. More...
 
enum  cy_en_pdstack_emca_sr_reason_t {
  CY_PDSTACK_EMCA_SR_REASON_NONE = 0,
  CY_PDSTACK_EMCA_SR_CABLE_DISC,
  CY_PDSTACK_EMCA_SR_ALT_MODE_DISC
}
 Enumeration of possible reasons to issue an EMCA (SOP' or SOP'') soft reset. More...
 
enum  cy_en_pdstack_cable_reset_reason_t {
  CY_PDSTACK_EMCA_CABLE_RES_NONE = 0,
  CY_PDSTACK_EMCA_CABLE_RES_SR_TIMEOUT
}
 Enumeration of reasons for issuing a Cable Reset. More...
 
enum  cy_en_pdstack_hard_reset_reason_t {
  CY_PDSTACK_HARDRES_REASON_NONE = 0,
  CY_PDSTACK_HARDRES_REASON_NO_SRC_CAP,
  CY_PDSTACK_HARDRES_REASON_HOSTCONN,
  CY_PDSTACK_HARDRES_REASON_SR_ERROR,
  CY_PDSTACK_HARDRES_REASON_CONTRACT_ERROR,
  CY_PDSTACK_HARDRES_REASON_DRSWAP,
  CY_PDSTACK_HARDRES_REASON_VBUS_OVP,
  CY_PDSTACK_HARDRES_REASON_VBUS_OCP,
  CY_PDSTACK_HARDRES_REASON_AMS_ERROR
}
 Enumeration of reasons for issuing a hard reset. More...
 
enum  cy_en_pdstack_soft_reset_reason_t {
  CY_PDSTACK_SOFTRES_REASON_NONE = 0,
  CY_PDSTACK_SOFTRES_REASON_SRCNEG_ERROR,
  CY_PDSTACK_SOFTRES_REASON_SNKNEG_ERROR,
  CY_PDSTACK_SOFTRES_REASON_AMS_ERROR
}
 Enumeration of reasons for issuing a soft reset. More...
 
enum  app_swap_resp_t {
  APP_RESP_ACCEPT = 0u,
  APP_RESP_REJECT,
  APP_RESP_WAIT,
  APP_RESP_NOT_SUPPORTED
}
 Possible responses to various USB-PD swap requests from the application layer. More...
 
enum  cy_en_pdstack_pd_msg_class_t {
  CY_PDSTACK_PD_CTRL_MSG = 0,
  CY_PDSTACK_PD_DATA_MSG,
  CY_PDSTACK_PD_EXTD_MSG,
  CY_PDSTACK_PD_CABLE_RESET,
  CY_PDSTACK_PD_MSG_RSVD
}
 Enum of the PD message types. More...
 
enum  cy_en_pdstack_rdo_type_t {
  CY_PDSTACK_FIXED_VAR_RDO = 0,
  CY_PDSTACK_BAT_RDO
}
 Enum of the RDO types. More...
 
enum  cy_en_pdstack_data_msg_t {
  CY_PDSTACK_DATA_MSG_SRC_CAP = 1,
  CY_PDSTACK_DATA_MSG_REQUEST,
  CY_PDSTACK_DATA_MSG_BIST,
  CY_PDSTACK_DATA_MSG_SNK_CAP,
  CY_PDSTACK_DATA_MSG_BAT_STATUS,
  CY_PDSTACK_DATA_MSG_ALERT,
  CY_PDSTACK_DATA_MSG_GET_COUNTRY_INFO,
  CY_PDSTACK_DATA_MSG_ENTER_USB,
  CY_PDSTACK_DATA_MSG_EPR_REQUEST,
  CY_PDSTACK_DATA_MSG_EPR_MODE,
  CY_PDSTACK_DATA_MSG_SOURCE_INFO,
  CY_PDSTACK_DATA_MSG_REVISION,
  CY_PDSTACK_DATA_MSG_VDM = 15
}
 Enum of the data message types. More...
 
enum  cy_en_pdstack_extd_msg_t {
  CY_PDSTACK_EXTD_MSG_SRC_CAP_EXTD = 1,
  CY_PDSTACK_EXTD_MSG_STATUS,
  CY_PDSTACK_EXTD_MSG_GET_BAT_CAP,
  CY_PDSTACK_EXTD_MSG_GET_BAT_STATUS,
  CY_PDSTACK_EXTD_MSG_BAT_CAP,
  CY_PDSTACK_EXTD_MSG_GET_MANU_INFO,
  CY_PDSTACK_EXTD_MSG_MANU_INFO,
  CY_PDSTACK_EXTD_MSG_SECURITY_REQ,
  CY_PDSTACK_EXTD_MSG_SECURITY_RESP,
  CY_PDSTACK_EXTD_MSG_FW_UPDATE_REQ,
  CY_PDSTACK_EXTD_MSG_FW_UPDATE_RESP,
  CY_PDSTACK_EXTD_MSG_PPS_STATUS,
  CY_PDSTACK_EXTD_MSG_COUNTRY_INFO,
  CY_PDSTACK_EXTD_MSG_COUNTRY_CODES,
  CY_PDSTACK_EXTD_MSG_SNK_CAP_EXTD,
  CY_PDSTACK_EXTD_MSG_EXTD_CTRL_MSG,
  CY_PDSTACK_EXTD_MSG_EPR_SRC_CAP,
  CY_PDSTACK_EXTD_MSG_EPR_SNK_CAP
}
 Enum of the extended data message types. More...
 
enum  cy_en_pdstack_extd_ctrl_msg_t {
  CY_PDSTACK_EPR_GET_SRC_CAP = 1,
  CY_PDSTACK_EPR_GET_SNK_CAP,
  CY_PDSTACK_EPR_KEEP_ALIVE,
  CY_PDSTACK_EPR_KEEP_ALIVE_ACK
}
 Enum of the Extended Control Message Types sent in Ext. More...
 
enum  cy_en_pdstack_pdo_t {
  CY_PDSTACK_PDO_FIXED_SUPPLY = 0,
  CY_PDSTACK_PDO_BATTERY,
  CY_PDSTACK_PDO_VARIABLE_SUPPLY,
  CY_PDSTACK_PDO_AUGMENTED
}
 Enum of the PDO types. More...
 
enum  cy_en_pdstack_apdo_t {
  CY_PDSTACK_APDO_PPS = 0,
  CY_PDSTACK_APDO_AVS,
  CY_PDSTACK_APDO_RSVD2,
  CY_PDSTACK_APDO_RSVD3
}
 Enum of the Augmented PDO types. More...
 
enum  cy_en_pdstack_epr_avs_t {
  CY_PDSTACK_SPR_MODE = 0,
  CY_PDSTACK_EPR_FIXED_MODE,
  CY_PDSTACK_EPR_AVS_SMALL,
  CY_PDSTACK_EPR_AVS_LARGE
}
 Enum of the EPR AVS modes. More...
 
enum  cy_en_pdstack_peak_cur_cap_t {
  CY_PDSTACK_IMAX_EQ_IOC = 0,
  CY_PDSTACK_IMAX_EQ_130_IOC,
  CY_PDSTACK_IMAX_EQ_150_IOC,
  CY_PDSTACK_IMAX_EQ_200_IOC
}
 Enum of Peak Current Capability levels. More...
 
enum  cy_en_pdstack_bist_mode_t {
  CY_PDSTACK_BIST_RX_MODE = 0,
  CY_PDSTACK_BIST_TX_MODE,
  CY_PDSTACK_BIST_RETURN_COUNTERS_MODE,
  CY_PDSTACK_BIST_CARRIER_MODE_0,
  CY_PDSTACK_BIST_CARRIER_MODE_1,
  CY_PDSTACK_BIST_CARRIER_MODE_2,
  CY_PDSTACK_BIST_CARRIER_MODE_3,
  CY_PDSTACK_BIST_EYE_PATTERN_MODE,
  CY_PDSTACK_BIST_TEST_DATA_MODE,
  CY_PDSTACK_BIST_STM_ENTRY,
  CY_PDSTACK_BIST_STM_EXIT
}
 Enum of the BIST modes. More...
 
enum  cy_en_pdstack_fr_swap_supp_t {
  CY_PDSTACK_FR_SWAP_NOT_SUPPORTED = 0,
  CY_PDSTACK_FR_SWAP_DEF_USB,
  CY_PDSTACK_FR_SWAP_1_5A,
  CY_PDSTACK_FR_SWAP_3A
}
 Enum to hold FR swap options in sink capabilities. More...
 
enum  cy_en_pdstack_app_req_status_t {
  CY_PDSTACK_REQ_SEND_HARD_RESET = 1,
  CY_PDSTACK_REQ_ACCEPT = 3,
  CY_PDSTACK_REQ_REJECT = 4,
  CY_PDSTACK_REQ_WAIT = 12,
  CY_PDSTACK_REQ_NOT_SUPPORTED = 16
}
 Enum of the PD Request results. More...
 
enum  cy_en_pdstack_resp_status_t {
  CY_PDSTACK_SEQ_ABORTED = 0,
  CY_PDSTACK_CMD_FAILED,
  CY_PDSTACK_RES_TIMEOUT,
  CY_PDSTACK_CMD_SENT,
  CY_PDSTACK_RES_RCVD
}
 Enum of the response status to DPM commands. More...
 
enum  cy_en_pdstack_dpm_pd_cmd_t {
  CY_PDSTACK_DPM_CMD_SRC_CAP_CHNG = 0,
  CY_PDSTACK_DPM_CMD_SNK_CAP_CHNG,
  CY_PDSTACK_DPM_CMD_SEND_GO_TO_MIN,
  CY_PDSTACK_DPM_CMD_GET_SNK_CAP,
  CY_PDSTACK_DPM_CMD_GET_SRC_CAP,
  CY_PDSTACK_DPM_CMD_SEND_HARD_RESET,
  CY_PDSTACK_DPM_CMD_SEND_SOFT_RESET,
  CY_PDSTACK_DPM_CMD_SEND_CABLE_RESET,
  CY_PDSTACK_DPM_CMD_SEND_SOFT_RESET_EMCA,
  CY_PDSTACK_DPM_CMD_SEND_DR_SWAP,
  CY_PDSTACK_DPM_CMD_SEND_PR_SWAP,
  CY_PDSTACK_DPM_CMD_SEND_VCONN_SWAP,
  CY_PDSTACK_DPM_CMD_SEND_VDM,
  CY_PDSTACK_DPM_CMD_SEND_EXTENDED,
  CY_PDSTACK_DPM_CMD_GET_SRC_CAP_EXTENDED,
  CY_PDSTACK_DPM_CMD_GET_STATUS,
  CY_PDSTACK_DPM_CMD_SEND_BATT_STATUS,
  CY_PDSTACK_DPM_CMD_SEND_ALERT,
  CY_PDSTACK_DPM_CMD_SEND_NOT_SUPPORTED,
  CY_PDSTACK_DPM_CMD_INITIATE_CBL_DISCOVERY,
  CY_PDSTACK_DPM_CMD_SEND_DATA_RESET,
  CY_PDSTACK_DPM_CMD_SEND_ENTER_USB,
  CY_PDSTACK_DPM_CMD_GET_SNK_CAP_EXTENDED,
  CY_PDSTACK_DPM_CMD_SEND_REQUEST,
  CY_PDSTACK_DPM_CMD_GET_PPS_STATUS,
  CY_PDSTACK_DPM_CMD_GET_COUNTRY_CODES,
  CY_PDSTACK_DPM_CMD_SEND_EPR_MODE,
  CY_PDSTACK_DPM_CMD_SNK_EPR_MODE_ENTRY,
  CY_PDSTACK_DPM_CMD_SNK_SEND_KEEP_ALIVE,
  CY_PDSTACK_DPM_CMD_SEND_EXTD_CTRL_MSG,
  CY_PDSTACK_DPM_CMD_SEND_GET_SOURCE_INFO,
  CY_PDSTACK_DPM_CMD_SEND_GET_REVISION,
  CY_PDSTACK_DPM_CMD_SEND_INVALID = 0xFFu
}
 Enum of the DPM (Device Policy Manager) command types. More...
 
enum  cy_en_pdstack_vdm_type_t {
  CY_PDSTACK_VDM_TYPE_UNSTRUCTURED = 0,
  CY_PDSTACK_VDM_TYPE_STRUCTURED
}
 Enum of the VDM types. More...
 
enum  cy_en_pdstack_std_vdm_cmd_t {
  CY_PDSTACK_VDM_CMD_DSC_IDENTITY = 1,
  CY_PDSTACK_VDM_CMD_DSC_SVIDS = 2,
  CY_PDSTACK_VDM_CMD_DSC_MODES = 3,
  CY_PDSTACK_VDM_CMD_ENTER_MODE = 4,
  CY_PDSTACK_VDM_CMD_EXIT_MODE = 5,
  CY_PDSTACK_VDM_CMD_ATTENTION = 6,
  CY_PDSTACK_VDM_CMD_DP_STATUS_UPDT = 16,
  CY_PDSTACK_VDM_CMD_DP_CONFIGURE = 17
}
 Enum of the standard VDM commands. More...
 
enum  cy_en_pdstack_std_vdm_cmd_type_t {
  CY_PDSTACK_CMD_TYPE_INITIATOR = 0,
  CY_PDSTACK_CMD_TYPE_RESP_ACK,
  CY_PDSTACK_CMD_TYPE_RESP_NAK,
  CY_PDSTACK_CMD_TYPE_RESP_BUSY
}
 Enum of the standard VDM command types. More...
 
enum  cy_en_pdstack_std_vdm_prod_t {
  CY_PDSTACK_PROD_TYPE_UNDEF = 0,
  CY_PDSTACK_PROD_TYPE_HUB = 1,
  CY_PDSTACK_PROD_TYPE_PERI = 2,
  CY_PDSTACK_PROD_TYPE_PSD = 3,
  CY_PDSTACK_PROD_TYPE_PAS_CBL = 3,
  CY_PDSTACK_PROD_TYPE_ACT_CBL = 4,
  CY_PDSTACK_PROD_TYPE_AMA = 5,
  CY_PDSTACK_PROD_TYPE_VPD = 6,
  CY_PDSTACK_PROD_TYPE_RSVD = 7
}
 Enum of the standard VDM product types. More...
 
enum  cy_en_pdstack_std_vdm_conn_t {
  CY_PDSTACK_CONN_TYPE_RSVD = 0,
  CY_PDSTACK_CONN_TYPE_RSVD1,
  CY_PDSTACK_CONN_TYPE_RECEPTACLE,
  CY_PDSTACK_CONN_TYPE_PLUG
}
 Enum of the standard VDM connector types. More...
 
enum  cy_en_pdstack_std_vdm_ver_t {
  CY_PDSTACK_STD_VDM_VER1 = 0,
  CY_PDSTACK_STD_VDM_VER2,
  CY_PDSTACK_STD_VDM_VER3,
  CY_PDSTACK_STD_VDM_VER4
}
 Enum for the standard VDM version. More...
 
enum  cy_en_pdstack_cbl_vbus_cur_t {
  CY_PDSTACK_CBL_VBUS_CUR_DFLT = 0,
  CY_PDSTACK_CBL_VBUS_CUR_3A,
  CY_PDSTACK_CBL_VBUS_CUR_5A,
  CY_PDSTACK_CBL_VBUS_CUR_0A
}
 Enum of the cable current levels. More...
 
enum  cy_en_pdstack_cbl_type_t {
  CY_PDSTACK_CBL_TYPE_PASSIVE = 0,
  CY_PDSTACK_CBL_TYPE_ACTIVE_RETIMER,
  CY_PDSTACK_CBL_TYPE_ACTIVE_REDRIVER,
  CY_PDSTACK_CBL_TYPE_OPTICAL
}
 Enum of the cable types. More...
 
enum  cy_en_pdstack_cbl_term_t {
  CY_PDSTACK_CBL_TERM_BOTH_PAS_VCONN_NOT_REQ = 0,
  CY_PDSTACK_CBL_TERM_BOTH_PAS_VCONN_REQ,
  CY_PDSTACK_CBL_TERM_ONE_ACT_ONE_PAS_VCONN_REQ,
  CY_PDSTACK_CBL_TERM_BOTH_ACT_VCONN_REQ
}
 Enum of the cable termination types. More...
 
enum  cy_en_pdstack_usb_sig_supp_t {
  CY_PDSTACK_USB_2_0 = 0,
  CY_PDSTACK_USB_GEN_1,
  CY_PDSTACK_USB_GEN_2,
  CY_PDSTACK_USB_GEN_3
}
 Enum of the USB signaling support. More...
 
enum  cy_en_pdstack_usb_dev_cap_t {
  CY_PDSTACK_DEV_CAP_USB_2_0 = (1u<<0),
  CY_PDSTACK_DEV_CAP_USB_BB_ONLY = (1u<<1),
  CY_PDSTACK_DEV_CAP_USB_3_2 = (1u<<2),
  CY_PDSTACK_DEV_CAP_USB_4_0 = (1u<<3)
}
 Enum of the USB device capabilities masks. More...
 
enum  cy_en_pdstack_usb_host_cap_t {
  CY_PDSTACK_HOST_CAP_USB_2_0 = (1u<<0),
  CY_PDSTACK_HOST_CAP_USB_3_2 = (1u<<1),
  CY_PDSTACK_HOST_CAP_USB_4_0 = (1u<<2)
}
 Enum of the USB host capabilities masks. More...
 
enum  cy_en_pdstack_usb_role_t {
  CY_PDSTACK_USB_ROLE_DEV = 0,
  CY_PDSTACK_USB_ROLE_HOST,
  CY_PDSTACK_USB_ROLE_DRD
}
 Enum of the USB role types. More...
 
enum  cy_en_pdstack_pe_cbl_state_t {
  CY_PDSTACK_CBL_FSM_DISABLED = 0,
  CY_PDSTACK_CBL_FSM_ENTRY,
  CY_PDSTACK_CBL_FSM_SEND_SOFT_RESET,
  CY_PDSTACK_CBL_FSM_SEND_DSC_ID
}
 Enum of the Policy Engine cable discovery states. More...
 
enum  cy_en_pdstack_try_src_snk_t {
  CY_PDSTACK_TRY_SRC_TRY_SNK_DISABLED = 0,
  CY_PDSTACK_TRY_SRC_ENABLED,
  CY_PDSTACK_TRY_SNK_ENABLED
}
 Enum of the Try Source/ Try Sink options. More...
 
enum  cy_en_pdstack_dpm_typec_cmd_t {
  CY_PDSTACK_DPM_CMD_SET_RP_DFLT = 0,
  CY_PDSTACK_DPM_CMD_SET_RP_1_5A,
  CY_PDSTACK_DPM_CMD_SET_RP_3A,
  CY_PDSTACK_DPM_CMD_PORT_DISABLE,
  CY_PDSTACK_DPM_CMD_TYPEC_ERR_RECOVERY,
  CY_PDSTACK_DPM_CMD_TYPEC_INVALID
}
 Enum of the DPM (Device Policy Manager) command types that can be initiated through the dpm_typec_command API. More...
 
enum  cy_en_pdstack_dpm_typec_cmd_resp_t {
  CY_PDSTACK_DPM_RESP_FAIL = 0,
  CY_PDSTACK_DPM_RESP_SUCCESS
}
 Enum of the DPM (Device Policy Manager) response types. More...
 
enum  cy_en_pdstack_typec_fsm_state_t {
  CY_PDSTACK_TYPEC_FSM_DISABLED = 0,
  CY_PDSTACK_TYPEC_FSM_ERR_RECOV,
  CY_PDSTACK_TYPEC_FSM_ATTACH_WAIT,
  CY_PDSTACK_TYPEC_FSM_UNATTACHED_SRC,
  CY_PDSTACK_TYPEC_FSM_UNATTACHED_SNK,
  CY_PDSTACK_TYPEC_FSM_UNATTACHED_WAIT_SRC,
  CY_PDSTACK_TYPEC_FSM_AUD_ACC,
  CY_PDSTACK_TYPEC_FSM_DBG_ACC,
  CY_PDSTACK_TYPEC_FSM_ATTACHED_SRC,
  CY_PDSTACK_TYPEC_FSM_ATTACHED_SNK,
  CY_PDSTACK_TYPEC_FSM_MAX_STATES
}
 Enum of the Type-C FSM states. More...
 
enum  cy_en_pdstack_pe_fsm_state_t {
  CY_PDSTACK_PE_FSM_OFF = 0,
  CY_PDSTACK_PE_FSM_HR_SEND,
  CY_PDSTACK_PE_FSM_HR_SRC_TRANS_DFLT,
  CY_PDSTACK_PE_FSM_HR_SRC_RECOVER,
  CY_PDSTACK_PE_FSM_HR_SRC_VBUS_ON,
  CY_PDSTACK_PE_FSM_HR_SNK_TRANS_DFLT,
  CY_PDSTACK_PE_FSM_HR_SNK_WAIT_VBUS_OFF,
  CY_PDSTACK_PE_FSM_HR_SNK_WAIT_VBUS_ON,
  CY_PDSTACK_PE_FSM_BIST_TEST_DATA,
  CY_PDSTACK_PE_FSM_BIST_CM2,
  CY_PDSTACK_PE_FSM_SNK_STARTUP,
  CY_PDSTACK_PE_FSM_SNK_WAIT_FOR_CAP,
  CY_PDSTACK_PE_FSM_SNK_EVAL_CAP,
  CY_PDSTACK_PE_FSM_SNK_SEL_CAP,
  CY_PDSTACK_PE_FSM_SRC_STARTUP,
  CY_PDSTACK_PE_FSM_SRC_WAIT_NEW_CAP,
  CY_PDSTACK_PE_FSM_SRC_SEND_CAP,
  CY_PDSTACK_PE_FSM_SRC_DISCOVERY,
  CY_PDSTACK_PE_FSM_SRC_NEG_CAP,
  CY_PDSTACK_PE_FSM_SRC_TRANS_SUPPLY,
  CY_PDSTACK_PE_FSM_SRC_SEND_PS_RDY,
  CY_PDSTACK_PE_FSM_SNK_TRANS,
  CY_PDSTACK_PE_FSM_SR_SEND,
  CY_PDSTACK_PE_FSM_SR_RCVD,
  CY_PDSTACK_PE_FSM_VRS_VCONN_ON,
  CY_PDSTACK_PE_FSM_VRS_VCONN_OFF,
  CY_PDSTACK_PE_FSM_SWAP_EVAL,
  CY_PDSTACK_PE_FSM_SWAP_SEND,
  CY_PDSTACK_PE_FSM_DRS_CHANGE_ROLE,
  CY_PDSTACK_PE_FSM_PRS_SRC_SNK_TRANS,
  CY_PDSTACK_PE_FSM_PRS_SRC_SNK_VBUS_OFF,
  CY_PDSTACK_PE_FSM_PRS_SRC_SNK_WAIT_PS_RDY,
  CY_PDSTACK_PE_FSM_PRS_SNK_SRC_WAIT_PS_RDY,
  CY_PDSTACK_PE_FSM_PRS_SNK_SRC_VBUS_ON,
  CY_PDSTACK_PE_FSM_FRS_CHECK_RP,
  CY_PDSTACK_PE_FSM_FRS_SRC_SNK_CC_SIGNAL,
  CY_PDSTACK_PE_FSM_READY,
  CY_PDSTACK_PE_FSM_SEND_MSG,
  CY_PDSTACK_PE_FSM_EVAL_DATA_RESET,
  CY_PDSTACK_PE_FSM_SEND_DATA_RESET,
  CY_PDSTACK_PE_FSM_EVAL_ENTER_USB,
  CY_PDSTACK_PE_FSM_SRC_EVAL_EPR_MODE_ENTRY,
  CY_PDSTACK_PE_FSM_SRC_SEND_EPR_MODE_RESULT,
  CY_PDSTACK_PE_FSM_SRC_SEND_EPR_SRC_CAP,
  CY_PDSTACK_PE_FSM_SNK_SEND_EPR_MODE_ENTRY,
  CY_PDSTACK_PE_FSM_SNK_EPR_ENTRY_WAIT_FOR_RESP,
  CY_PDSTACK_PE_FSM_SNK_EPR_KEEP_ALIVE,
  CY_PDSTACK_PE_FSM_SNK_SEND_EPR_CAP,
  CY_PDSTACK_PE_FSM_MAX_STATES
}
 Enumeration of Policy Engine states for a USB-PD port. More...
 
enum  cy_en_pdstack_contract_status_t {
  CY_PDSTACK_CONTRACT_NEGOTIATION_SUCCESSFUL = 0x01,
  CY_PDSTACK_CONTRACT_CAP_MISMATCH_DETECTED = 0x03,
  CY_PDSTACK_CONTRACT_REJECT_CONTRACT_VALID = 0x00,
  CY_PDSTACK_CONTRACT_REJECT_CONTRACT_NOT_VALID = 0x04,
  CY_PDSTACK_CONTRACT_REJECT_NO_CONTRACT = 0x08,
  CY_PDSTACK_CONTRACT_REJECT_EXPLICIT_CONTRACT = 0x0C,
  CY_PDSTACK_CONTRACT_REJECT_NO_EXPLICIT_CONTRACT = 0x10,
  CY_PDSTACK_CONTRACT_PS_READY_NOT_RECEIVED = 0x14,
  CY_PDSTACK_CONTRACT_PS_READY_NOT_SENT = 0x18
}
 Enum of possible PD contract negotiation scenarios that are used to signal the application event handler. More...
 
enum  cy_en_pdstack_app_evt_t {
  APP_EVT_UNEXPECTED_VOLTAGE_ON_VBUS,
  APP_EVT_TYPE_C_ERROR_RECOVERY,
  APP_EVT_CONNECT,
  APP_EVT_DISCONNECT,
  APP_EVT_EMCA_DETECTED,
  APP_EVT_EMCA_NOT_DETECTED,
  APP_EVT_ALT_MODE,
  APP_EVT_APP_HW,
  APP_EVT_BB,
  APP_EVT_RP_CHANGE,
  APP_EVT_HARD_RESET_RCVD,
  APP_EVT_HARD_RESET_COMPLETE,
  APP_EVT_PKT_RCVD,
  APP_EVT_PR_SWAP_COMPLETE,
  APP_EVT_DR_SWAP_COMPLETE,
  APP_EVT_VCONN_SWAP_COMPLETE,
  APP_EVT_SENDER_RESPONSE_TIMEOUT,
  APP_EVT_VENDOR_RESPONSE_TIMEOUT,
  APP_EVT_HARD_RESET_SENT,
  APP_EVT_SOFT_RESET_SENT,
  APP_EVT_CBL_RESET_SENT,
  APP_EVT_PE_DISABLED,
  APP_EVT_PD_CONTRACT_NEGOTIATION_COMPLETE,
  APP_EVT_VBUS_OVP_FAULT,
  APP_EVT_VBUS_OCP_FAULT,
  APP_EVT_VCONN_OCP_FAULT,
  APP_EVT_VBUS_PORT_DISABLE,
  APP_EVT_TYPEC_STARTED,
  APP_EVT_FR_SWAP_COMPLETE,
  APP_EVT_TEMPERATURE_FAULT,
  APP_EVT_HANDLE_EXTENDED_MSG,
  APP_EVT_VBUS_UVP_FAULT,
  APP_EVT_VBUS_SCP_FAULT,
  APP_EVT_TYPEC_ATTACH_WAIT,
  APP_EVT_TYPEC_ATTACH_WAIT_TO_UNATTACHED,
  APP_EVT_TYPEC_ATTACH,
  APP_EVT_CC_OVP,
  APP_EVT_SBU_OVP,
  APP_EVT_ALERT_RECEIVED,
  APP_EVT_SRC_CAP_TRIED_WITH_NO_RESPONSE,
  APP_EVT_PD_SINK_DEVICE_CONNECTED,
  APP_EVT_VBUS_RCP_FAULT,
  APP_EVT_STANDBY_CURRENT,
  APP_EVT_DATA_RESET_RCVD,
  APP_EVT_DATA_RESET_SENT,
  APP_EVT_DATA_RESET_CPLT,
  APP_EVT_USB_ENTRY_CPLT,
  APP_EVT_DATA_RESET_ACCEPTED,
  APP_EVT_CONFIG_ERROR,
  APP_EVT_POWER_CYCLE,
  APP_EVT_VBUS_IN_UVP_FAULT,
  APP_EVT_VBUS_IN_OVP_FAULT,
  APP_EVT_SYSTEM_OT_FAULT,
  APP_EVT_CRC_ERROR,
  APP_EVT_HR_PSRC_ENABLE,
  APP_EVT_TYPEC_RP_DETACH,
  APP_EVT_PR_SWAP_ACCEPTED,
  APP_EVT_HR_SENT_RCVD_DEFERRED,
  APP_EVT_BAD_SINK_APDO_SEL,
  APP_EVT_BC_DETECTION_COMPLETED,
  APP_EVT_SNK_FET_ENABLE,
  APP_EVT_SNK_FET_DISABLE,
  APP_EVT_SAFE_PWR_ENABLE,
  APP_EVT_SAFE_PWR_DISABLE,
  APP_EVT_FAULT_CLEANED,
  APP_EVT_MISMATCH_CLEANED,
  APP_EVT_CUST_ALT_MODE_CHANGED,
  APP_EVT_CUST_MODE_DISC_CMPL,
  APP_EVT_VBAT_GND_SCP_FAULT,
  APP_EVT_VIN_UVP_FAULT,
  APP_EVT_VIN_OVP_FAULT,
  APP_EVT_BIST_STM_ENTRY,
  APP_EVT_BIST_STM_EXIT,
  APP_EVT_ILIM_FAULT,
  APP_EVT_VREG_INRUSH_FAULT,
  APP_EVT_VREG_BOD_FAULT,
  APP_EVT_VCONN_SCP_FAULT,
  APP_EVT_SOURCE_INFO_RECEIVED,
  APP_EVT_REVISION_RECEIVED,
  APP_EVT_EPR_MODE_ENTER_RECEIVED,
  APP_EVT_EPR_MODE_ENTER_SUCCESS,
  APP_EVT_EPR_MODE_ENTER_FAILED,
  APP_EVT_EPR_MODE_EXIT,
  APP_EVT_VCONN_SWAP_FAILED,
  APP_TOTAL_EVENTS
}
 Enum of events that are signalled to the application. More...
 
enum  cy_en_pdstack_ams_type_t {
  CY_PDSTACK_AMS_NONE = 0,
  CY_PDSTACK_AMS_NON_INTR,
  CY_PDSTACK_AMS_INTR
}
 Type of USB-PD Atomic Message Sequence (AMS). More...
 
enum  pd_ams_type_t {
  PD_AMS_INTERUPTIBLE = 0,
  PD_AMS_NON_INTR_SEND_PENDING,
  PD_AMS_NON_INTR_SEND_RCV_PENDING
}
 Enum to Hold expected response result.
 
enum  cy_en_pdstack_vdm_ams_t {
  CY_PDSTACK_VDM_AMS_RESP_READY = 0,
  CY_PDSTACK_VDM_AMS_RESP_NOT_REQ,
  CY_PDSTACK_VDM_AMS_RESP_FROM_EC,
  CY_PDSTACK_VDM_AMS_RESP_NOT_SUPP
}
 Enumeration of application responses to policy manager. More...
 
enum  cy_en_pdstack_usb_data_sig_t {
  CY_PDSTACK_USB_2_0_SUPP = 0,
  CY_PDSTACK_USB_GEN_1_SUPP,
  CY_PDSTACK_USB_GEN_2_SUPP,
  CY_PDSTACK_USB_GEN_3_SUPP,
  CY_PDSTACK_USB_BB_SUPP,
  CY_PDSTACK_USB_SIG_UNKNOWN
}
 Enumeration of USB signalling supported by a device or cable. More...
 
enum  cy_en_pdstack_data_reset_state_t {
  CY_PDSTACK_DATA_RESET_IDLE = 0,
  CY_PDSTACK_DATA_RESET_WAIT_ACCEPT,
  CY_PDSTACK_DATA_RESET_ACCEPTED,
  CY_PDSTACK_DATA_RESET_WAIT_PS_RDY,
  CY_PDSTACK_DATA_RESET_WAIT_VCONN_OFF,
  CY_PDSTACK_DATA_RESET_SENDING_PS_RDY,
  CY_PDSTACK_DATA_RESET_WAIT_VCONN_ON,
  CY_PDSTACK_DATA_RESET_WAIT_COMPLETION,
  CY_PDSTACK_DATA_RESET_COMPLETE_DELAY
}
 Enumeration of sub-states associated with Data Reset AMS. More...
 
enum  cy_en_pdstack_epr_mode_state_t {
  CY_PDSTACK_EPR_MODE_STATE_IDLE = 0,
  CY_PDSTACK_EPR_MODE_STATE_WAIT_ACK,
  CY_PDSTACK_EPR_MODE_STATE_ACKED,
  CY_PDSTACK_EPR_MODE_STATE_WAIT_CBL_DSC,
  CY_PDSTACK_EPR_MODE_STATE_WAIT_COMPLETION,
  CY_PDSTACK_EPR_MODE_STATE_COMPLETE_DELAY
}
 Enumeration of sub-states associated with EPR_Mode AMS. More...
 
enum  cy_en_pdstack_eprmdo_action_t {
  CY_PDSTACK_EPR_MODE_ENTER = 1,
  CY_PDSTACK_EPR_MODE_ACK,
  CY_PDSTACK_EPR_MODE_SUCCEEDED,
  CY_PDSTACK_EPR_MODE_FAILED,
  CY_PDSTACK_EPR_MODE_EXIT
}
 Enumeration of action fields in EPR Enter Mode data object. More...
 
enum  cy_en_pdstack_eprmdo_data_t {
  CY_PDSTACK_EPR_FAIL_UNKNOWN = 0,
  CY_PDSTACK_EPR_FAIL_EPR_CABLE,
  CY_PDSTACK_EPR_FAIL_EPR_VCONN,
  CY_PDSTACK_EPR_FAIL_RDO,
  CY_PDSTACK_EPR_FAIL_UNABLE_NOW,
  CY_PDSTACK_EPR_FAIL_PDO,
  CY_PDSTACK_EPR_ENTER_SUCCESS
}
 Enumeration of data fields in EPR Enter Mode data object with EPR_MODE_ENTER_FAILED action field. More...
 
enum  cy_en_pdstack_intel_pf_type_t {
  CY_PDSTACK_PF_THUNDERBOLT = 0,
  CY_PDSTACK_PF_ICE_LAKE,
  CY_PDSTACK_PF_TIGER_LAKE,
  CY_PDSTACK_PF_MAPLE_RIDGE
}
 List of Intel TBT/USB platform types in which the CCG device is used. More...
 
enum  cy_en_pdstack_amd_pf_type_t {
  CY_PDSTACK_AMD_PF_RENOIR = 0,
  CY_PDSTACK_AMD_PF_REMBRANDT_A0,
  CY_PDSTACK_AMD_PF_REMBRANDT_B0
}
 List of AMD platform types in which the CCG device is used. More...
 
enum  cy_en_pdstack_amd_rtmr_type_t {
  CY_PDSTACK_AMD_RETIMER_NONE = 0,
  CY_PDSTACK_AMD_RETIMER_PI3DPX1205A,
  CY_PDSTACK_AMD_RETIMER_PS8828,
  CY_PDSTACK_AMD_RETIMER_PS8830,
  CY_PDSTACK_AMD_RETIMER_AUTO_PS8828A_OR_PS8830,
  CY_PDSTACK_AMD_RETIMER_KB800X_B0,
  CY_PDSTACK_AMD_RETIMER_KB800X_B1
}
 List of retimer types which could be used via AMD projects. More...
 
enum  cy_en_pdstack_pdo_sel_alg_t {
  CY_PDSTACK_HIGHEST_POWER = 1,
  CY_PDSTACK_HIGHEST_CURRENT,
  CY_PDSTACK_HIGHEST_VOLTAGE
}
 Algorithm selection for pdo evaluation. More...
 
enum  cy_en_pdstack_status_t {
  CY_PDSTACK_STAT_NO_RESPONSE = -2,
  CY_PDSTACK_STAT_SUCCESS = 0,
  CY_PDSTACK_STAT_FLASH_DATA_AVAILABLE,
  CY_PDSTACK_STAT_BAD_PARAM,
  CY_PDSTACK_STAT_INVALID_COMMAND = 3,
  CY_PDSTACK_STAT_FLASH_UPDATE_FAILED = 5,
  CY_PDSTACK_STAT_INVALID_FW,
  CY_PDSTACK_STAT_INVALID_ARGUMENT,
  CY_PDSTACK_STAT_NOT_SUPPORTED,
  CY_PDSTACK_STAT_INVALID_SIGNATURE,
  CY_PDSTACK_STAT_TRANS_FAILURE,
  CY_PDSTACK_STAT_CMD_FAILURE,
  CY_PDSTACK_STAT_FAILURE,
  CY_PDSTACK_STAT_READ_DATA,
  CY_PDSTACK_STAT_NOT_READY,
  CY_PDSTACK_STAT_BUSY,
  CY_PDSTACK_STAT_TIMEOUT,
  CY_PDSTACK_STAT_INVALID_PORT,
  CY_PDSTACK_STAT_INVALID_ID = 0x3E,
  CY_PDSTACK_STAT_INVALID_GUID,
  CY_PDSTACK_STAT_INVALID_VER,
  CY_PDSTACK_STAT_OUT_OF_SEQ_CMD,
  CY_PDSTACK_STAT_INVALID_FWCT,
  CY_PDSTACK_STAT_HASH_CMP_FAILED
}
 Interface status codes. More...
 
enum  cy_sw_timer_id_t {
  PD_TIMERS_START_ID = 0u,
  PD_CABLE_TIMER,
  PD_NO_RESPONSE_TIMER,
  PD_CBL_DSC_ID_TIMER,
  PD_CBL_DELAY_TIMER,
  PD_PHY_BUSY_TIMER,
  PD_GOOD_CRC_TX_TIMER,
  PD_HARD_RESET_TX_TIMER,
  PD_VCONN_SWAP_INITIATOR_TIMER,
  PD_GENERIC_TIMER,
  PD_PPS_TIMER,
  PD_SINK_TX_TIMER,
  PD_DATA_RESET_COMP_TIMER,
  PD_TIMER_RESERVED_13,
  PD_TIMERS_END_ID,
  TYPEC_TIMERS_START_ID = 15u,
  TYPEC_GENERIC_TIMER2 = 15u,
  TYPEC_GENERIC_TIMER1,
  TYPEC_CC1_DEBOUNCE_TIMER,
  TYPEC_CC2_DEBOUNCE_TIMER,
  TYPEC_RD_DEBOUNCE_TIMER,
  TYPEC_VBUS_DISCHARGE_TIMER,
  TYPEC_ACTIVITY_TIMER,
  TYPEC_RP_CHANGE_TIMER,
  TYPEC_TIMER_RESERVED_23,
  TYPEC_TIMERS_END_ID,
  PD_OCP_DEBOUNCE_TIMER,
  HPD_RX_ACTIVITY_TIMER_ID,
  PD_VCONN_OCP_DEBOUNCE_TIMER,
  PD_SNK_EPR_MODE_TIMER,
  PD_SRC_EPR_MODE_TIMER,
  PD_EPR_KEEPALIVE_TIMER,
  PD_TIMER_RESERVED_31,
  PD1_TIMERS_START_ID = 32u,
  PD1_CABLE_TIMER,
  PD1_NO_RESPONSE_TIMER,
  PD1_CBL_DSC_ID_TIMER,
  PD1_CBL_DELAY_TIMER,
  PD1_PHY_BUSY_TIMER,
  PD1_GOOD_CRC_TX_TIMER,
  PD1_HARD_RESET_TX_TIMER,
  PD1_VCONN_SWAP_INITIATOR_TIMER,
  PD1_GENERIC_TIMER,
  PD1_PPS_TIMER,
  PD1_SINK_TX_TIMER,
  PD1_DATA_RESET_COMP_TIMER,
  PD1_TIMER_RESERVED_43,
  PD1_TIMERS_END_ID,
  TYPEC1_TIMERS_START_ID = 47u,
  TYPEC1_GENERIC_TIMER2 = 47u,
  TYPEC1_GENERIC_TIMER1,
  TYPEC1_CC1_DEBOUNCE_TIMER,
  TYPEC1_CC2_DEBOUNCE_TIMER,
  TYPEC1_RD_DEBOUNCE_TIMER,
  TYPEC1_VBUS_DISCHARGE_TIMER,
  TYPEC1_ACTIVITY_TIMER,
  TYPEC1_RP_CHANGE_TIMER,
  TYPEC1_TIMER_RESERVED_53,
  TYPEC1_TIMERS_END_ID,
  PD1_OCP_DEBOUNCE_TIMER,
  HPD1_RX_ACTIVITY_TIMER_ID,
  PD1_VCONN_OCP_DEBOUNCE_TIMER,
  CCG_ACTIVITY_TIMER_ID,
  PD1_SNK_EPR_MODE_TIMER,
  PD1_SRC_EPR_MODE_TIMER,
  PD1_EPR_KEEPALIVE_TIMER,
  APP_TIMERS_START_ID = 64u,
  APP_PSOURCE_EN_TIMER = 64u,
  APP_PSOURCE_EN_MONITOR_TIMER,
  APP_PSOURCE_EN_HYS_TIMER,
  APP_PSOURCE_DIS_TIMER,
  APP_PSOURCE_DIS_MONITOR_TIMER,
  APP_PSOURCE_CF_TIMER,
  APP_PSOURCE_DIS_EXT_DIS_TIMER,
  APP_DB_SNK_FET_DIS_DELAY_TIMER,
  APP_PSINK_DIS_TIMER,
  APP_PSINK_DIS_MONITOR_TIMER,
  APP_VDM_BUSY_TIMER,
  APP_AME_TIMEOUT_TIMER,
  APP_VBUS_OCP_OFF_TIMER,
  APP_VBUS_OVP_OFF_TIMER,
  APP_VBUS_UVP_OFF_TIMER,
  APP_VBUS_SCP_OFF_TIMER,
  APP_FAULT_RECOVERY_TIMER,
  APP_SBU_DELAYED_CONNECT_TIMER,
  APP_MUX_DELAY_TIMER,
  APP_MUX_POLL_TIMER,
  APP_CBL_DISC_TRIGGER_TIMER,
  APP_V5V_CHANGE_DEBOUNCE_TIMER,
  APP_VCONN_RECOVERY_TIMER,
  APP_OT_DETECTION_TIMER,
  APP_CHUNKED_MSG_RESP_TIMER,
  APP_RESET_VDM_LAYER_TIMER,
  APP_BB_ON_TIMER,
  APP_BB_OFF_TIMER,
  APP_INITIATE_SWAP_TIMER,
  APP_VDM_NOT_SUPPORT_RESP_TIMER_ID,
  APP_BC_TIMERS_START_ID,
  APP_BC_GENERIC_TIMER1,
  APP_BC_GENERIC_TIMER2,
  APP_BC_DP_DM_DEBOUNCE_TIMER,
  APP_BC_DETACH_DETECT_TIMER,
  APP_CDP_DP_DM_POLL_TIMER,
  APP_EPR_MODE_TIMER,
  APP_EPR_EXT_CMD_TIMER,
  APP_TIMER_HPD_DELAY_TIMER,
  APP_PSOURCE_VBUS_SET_TIMER_ID,
  APP_PSOURCE_SAFE_FET_ON_TIMER_ID,
  APP_PSOURCE_SAFE_FET_ON_MONITOR_TIMER_ID,
  VBUS_DISCHARGE_SCHEDULE_TIMER,
  CCG_LS_MASTER_PORT_DEBOUNCE_TIMER_ID,
  CCG_LS_SLAVE_PORT_DEBOUNCE_TIMER_ID,
  CCG_LS_MASTER_WRITE_TIMER_ID,
  CCG_LS_HEART_BEAT_TIMER_ID,
  THROTTLE_TIMER_ID,
  THROTTLE_WAIT_FOR_PD_TIMER_ID,
  HPI_PD_CMD_TIMER,
  LINS_BUS_INACTIVE_TIMER,
  LINS_BUS_LISTEN_TIMER,
  LINS_MULTIFRAME_DROP_TIMER,
  APP_FET_SOFT_START_TIMER_ID,
  APP_HAL_VREG_TIMER,
  APP_HAL_GENERIC_TIMER,
  APP_REGULATOR_STARTUP_MONITOR_TIMER,
  APP_DATA_RESET_TIMER,
  SYS_BLACK_BOX_TIMER_ID,
  APP_PSOURCE_REGULATOR_MON_TIMER,
  APP_BAD_SINK_TIMEOUT_TIMER,
  APP_VBAT_GND_SCP_TIMER_ID,
  APP_VCONN_OCP_TIMER,
  APP_TIMERS_RESERVED_START_ID = 127,
  APP_TIMER_RESERVED_127 = APP_TIMERS_RESERVED_START_ID,
  APP_PORT1_TIMER_START_ID = 192u,
  I2C_SLAVE_SCB0_TIMER = 320u,
  I2C_SLAVE_SCB1_TIMER = 321u,
  I2C_SLAVE_SCB2_TIMER = 322u,
  I2C_SLAVE_SCB3_TIMER = 323u,
  USER_TIMERS_START_ID = 324u
}
 List of soft timer IDs defined for various applications. More...
 

Enumeration Type Documentation

◆ cy_en_pdstack_err_recov_reason_t

Enumeration of reasons for error recovery entry.

Enumerator
CY_PDSTACK_ERR_RECOV_REASON_NONE 

Error recovery is not active.

CY_PDSTACK_ERR_RECOV_HR_FAIL 

Error recovery due to hard reset failure.

CY_PDSTACK_ERR_RECOV_PROTECT_FAULT 

Error recovery due to protection (OVP/OCP) fault.

CY_PDSTACK_ERR_RECOV_POWER_FAULT 

Error recovery due to voltage fault.

CY_PDSTACK_ERR_RECOV_BAD_DATA_ROLE 

Error recovery due to bad data role in incoming PD message.

CY_PDSTACK_ERR_RECOV_FRS_FAIL 

Error recovery due to Fast Role Swap error.

CY_PDSTACK_ERR_RECOV_DATA_RESET_FAIL 

Error recovery due to failed Data_Reset sequence.

◆ cy_en_pdstack_emca_sr_reason_t

Enumeration of possible reasons to issue an EMCA (SOP' or SOP'') soft reset.

Enumerator
CY_PDSTACK_EMCA_SR_REASON_NONE 

No EMCA soft-reset in progress.

CY_PDSTACK_EMCA_SR_CABLE_DISC 

EMCA soft-reset due to cable discovery.

CY_PDSTACK_EMCA_SR_ALT_MODE_DISC 

EMCA soft-reset due to alt mode discovery.

◆ cy_en_pdstack_cable_reset_reason_t

Enumeration of reasons for issuing a Cable Reset.

Enumerator
CY_PDSTACK_EMCA_CABLE_RES_NONE 

No Cable Reset performed.

CY_PDSTACK_EMCA_CABLE_RES_SR_TIMEOUT 

SOP' or SOP'' SoftReset timed out.

◆ cy_en_pdstack_hard_reset_reason_t

Enumeration of reasons for issuing a hard reset.

Enumerator
CY_PDSTACK_HARDRES_REASON_NONE 

HardReset not issued.

CY_PDSTACK_HARDRES_REASON_NO_SRC_CAP 

No Source Capability messages received.

CY_PDSTACK_HARDRES_REASON_HOSTCONN 

TBT Host Connect state change.

CY_PDSTACK_HARDRES_REASON_SR_ERROR 

SoftReset failed.

CY_PDSTACK_HARDRES_REASON_CONTRACT_ERROR 

Power contract failed.

CY_PDSTACK_HARDRES_REASON_DRSWAP 

DR Swap received while in Alternate Mode.

CY_PDSTACK_HARDRES_REASON_VBUS_OVP 

Over-Voltage condition detected.

CY_PDSTACK_HARDRES_REASON_VBUS_OCP 

Over-Current condition detected.

CY_PDSTACK_HARDRES_REASON_AMS_ERROR 

PD Atomic Message Sequence error.

◆ cy_en_pdstack_soft_reset_reason_t

Enumeration of reasons for issuing a soft reset.

Enumerator
CY_PDSTACK_SOFTRES_REASON_NONE 

SoftReset not issued.

CY_PDSTACK_SOFTRES_REASON_SRCNEG_ERROR 

Contract negotiation error when PMG1x is source.

CY_PDSTACK_SOFTRES_REASON_SNKNEG_ERROR 

Contract negotiation error when PMG1x is sink.

CY_PDSTACK_SOFTRES_REASON_AMS_ERROR 

PD protocol error.

◆ app_swap_resp_t

Possible responses to various USB-PD swap requests from the application layer.

The PD stack hands the requests up to the application for handling and gets directions on handling the request in the form of these response codes.

Enumerator
APP_RESP_ACCEPT 

Swap request should be accepted.

APP_RESP_REJECT 

Swap request should be rejected.

APP_RESP_WAIT 

Swap request handling should be delayed (send wait response).

APP_RESP_NOT_SUPPORTED 

Swap request is not supported.

◆ cy_en_pdstack_pd_msg_class_t

Enum of the PD message types.

Enumerator
CY_PDSTACK_PD_CTRL_MSG 

Control message.

CY_PDSTACK_PD_DATA_MSG 

Data message.

CY_PDSTACK_PD_EXTD_MSG 

Extended data message.

CY_PDSTACK_PD_CABLE_RESET 

Cable reset message.

CY_PDSTACK_PD_MSG_RSVD 

Undefined message type.

◆ cy_en_pdstack_rdo_type_t

Enum of the RDO types.

Enumerator
CY_PDSTACK_FIXED_VAR_RDO 

Fixed or variable supply request data object.

CY_PDSTACK_BAT_RDO 

Battery request data object.

◆ cy_en_pdstack_data_msg_t

Enum of the data message types.

Enumerator
CY_PDSTACK_DATA_MSG_SRC_CAP 

0x01: Source_Capabilities message.

CY_PDSTACK_DATA_MSG_REQUEST 

0x02: Request message.

CY_PDSTACK_DATA_MSG_BIST 

0x03: BIST message.

CY_PDSTACK_DATA_MSG_SNK_CAP 

0x04: Sink_Capabilities message.

CY_PDSTACK_DATA_MSG_BAT_STATUS 

0x05: Battery_Status message.

CY_PDSTACK_DATA_MSG_ALERT 

0x06: Alert message.

CY_PDSTACK_DATA_MSG_GET_COUNTRY_INFO 

0x07: Get_Country_Info message.

CY_PDSTACK_DATA_MSG_ENTER_USB 

0x08: Enter_USB message.

CY_PDSTACK_DATA_MSG_EPR_REQUEST 

0x09: EPR_Request message.

CY_PDSTACK_DATA_MSG_EPR_MODE 

0x0A: EPR_Mode message.

CY_PDSTACK_DATA_MSG_SOURCE_INFO 

0x0B: Source_Info message.

CY_PDSTACK_DATA_MSG_REVISION 

0x0C: Revision message.

CY_PDSTACK_DATA_MSG_VDM 

0x0F: Vendor_Defined message.

◆ cy_en_pdstack_extd_msg_t

Enum of the extended data message types.

Enumerator
CY_PDSTACK_EXTD_MSG_SRC_CAP_EXTD 

0x01: Source_Capabilities_Extended message.

CY_PDSTACK_EXTD_MSG_STATUS 

0x02: Status message.

CY_PDSTACK_EXTD_MSG_GET_BAT_CAP 

0x03: Get_Battery_Cap message.

CY_PDSTACK_EXTD_MSG_GET_BAT_STATUS 

0x04: Get_Battery_Status message.

CY_PDSTACK_EXTD_MSG_BAT_CAP 

0x05: Battery_Capabilities message.

CY_PDSTACK_EXTD_MSG_GET_MANU_INFO 

0x06: Get_Manufacturer_Info message.

CY_PDSTACK_EXTD_MSG_MANU_INFO 

0x07: Manufacturer_Info message.

CY_PDSTACK_EXTD_MSG_SECURITY_REQ 

0x08: Security_Request message.

CY_PDSTACK_EXTD_MSG_SECURITY_RESP 

0x09: Security_Response message.

CY_PDSTACK_EXTD_MSG_FW_UPDATE_REQ 

0x0A: Firmware_Update_Request message.

CY_PDSTACK_EXTD_MSG_FW_UPDATE_RESP 

0x0B: Firmware_Update_Response message.

CY_PDSTACK_EXTD_MSG_PPS_STATUS 

0x0C: PPS_Status message.

CY_PDSTACK_EXTD_MSG_COUNTRY_INFO 

0x0D: Country_Info message.

CY_PDSTACK_EXTD_MSG_COUNTRY_CODES 

0x0E: Country_Codes message.

CY_PDSTACK_EXTD_MSG_SNK_CAP_EXTD 

0x0F: Sink_Capabilities_Extended message.

CY_PDSTACK_EXTD_MSG_EXTD_CTRL_MSG 

0x10: Extended_Control_Msg message.

CY_PDSTACK_EXTD_MSG_EPR_SRC_CAP 

0x11: EPR_Source_Capabilities message.

CY_PDSTACK_EXTD_MSG_EPR_SNK_CAP 

0x13: EPR_Sink_Capabilities message.

◆ cy_en_pdstack_extd_ctrl_msg_t

Enum of the Extended Control Message Types sent in Ext.

Ctrl Message Data Block (offset 0).

Enumerator
CY_PDSTACK_EPR_GET_SRC_CAP 

EPR_Get_Source_Cap ext.

control msg.

CY_PDSTACK_EPR_GET_SNK_CAP 

EPR_Get_Sink_Cap ext.

control msg .

CY_PDSTACK_EPR_KEEP_ALIVE 

EPR_KeepAlive ext.

control msg.

CY_PDSTACK_EPR_KEEP_ALIVE_ACK 

EPR_KeepAlive_Ack ext.

control msg.

◆ cy_en_pdstack_pdo_t

Enum of the PDO types.

Enumerator
CY_PDSTACK_PDO_FIXED_SUPPLY 

Fixed (voltage) supply power data object.

CY_PDSTACK_PDO_BATTERY 

Battery based power data object.

CY_PDSTACK_PDO_VARIABLE_SUPPLY 

Variable (voltage) supply power data object.

CY_PDSTACK_PDO_AUGMENTED 

Augmented power data object.

◆ cy_en_pdstack_apdo_t

Enum of the Augmented PDO types.

Enumerator
CY_PDSTACK_APDO_PPS 

Programmable Power Supply PDO.

CY_PDSTACK_APDO_AVS 

Reserved for future use.

CY_PDSTACK_APDO_RSVD2 

Reserved for future use.

CY_PDSTACK_APDO_RSVD3 

Reserved for future use.

◆ cy_en_pdstack_epr_avs_t

Enum of the EPR AVS modes.

Enumerator
CY_PDSTACK_SPR_MODE 

Standard Power Range Mode.

CY_PDSTACK_EPR_FIXED_MODE 

Extended Power Range Fixed Mode.

CY_PDSTACK_EPR_AVS_SMALL 

EPR Adjustable Voltage Supply Small step Mode.

CY_PDSTACK_EPR_AVS_LARGE 

EPR Adjustable Voltage Supply Large step Mode.

◆ cy_en_pdstack_peak_cur_cap_t

Enum of Peak Current Capability levels.

Enumerator
CY_PDSTACK_IMAX_EQ_IOC 

Peak current equal to operating current.

CY_PDSTACK_IMAX_EQ_130_IOC 

Peak current is 1.3x operating current.

CY_PDSTACK_IMAX_EQ_150_IOC 

Peak current is 1.5x operating current.

CY_PDSTACK_IMAX_EQ_200_IOC 

Peak current is 2x operating current.

◆ cy_en_pdstack_bist_mode_t

Enum of the BIST modes.

Enumerator
CY_PDSTACK_BIST_RX_MODE 

BIST receiver mode.

CY_PDSTACK_BIST_TX_MODE 

BIST transmit mode.

CY_PDSTACK_BIST_RETURN_COUNTERS_MODE 

Send Returned BIST counters response.

CY_PDSTACK_BIST_CARRIER_MODE_0 

BIST carrier mode 0.

CY_PDSTACK_BIST_CARRIER_MODE_1 

BIST carrier mode 1.

CY_PDSTACK_BIST_CARRIER_MODE_2 

BIST carrier mode 2.

CY_PDSTACK_BIST_CARRIER_MODE_3 

BIST carrier mode 3.

CY_PDSTACK_BIST_EYE_PATTERN_MODE 

BIST eye pattern.

CY_PDSTACK_BIST_TEST_DATA_MODE 

BIST test data mode.

CY_PDSTACK_BIST_STM_ENTRY 

BIST Shared Capacity Test mode entry.

CY_PDSTACK_BIST_STM_EXIT 

BIST Shared Capacity Test mode exit.

◆ cy_en_pdstack_fr_swap_supp_t

Enum to hold FR swap options in sink capabilities.

Enumerator
CY_PDSTACK_FR_SWAP_NOT_SUPPORTED 

FR_Swap is not supported.

CY_PDSTACK_FR_SWAP_DEF_USB 

Device will sink less than 900 mA of current after FR_Swap.

CY_PDSTACK_FR_SWAP_1_5A 

Device will sink less than 1.5 A of current after FR_Swap.

CY_PDSTACK_FR_SWAP_3A 

Device will sink less than 3 A of current after FR_SWAP.

◆ cy_en_pdstack_app_req_status_t

Enum of the PD Request results.

Enum fields map to the control message field in the PD spec.

Enumerator
CY_PDSTACK_REQ_SEND_HARD_RESET 

Invalid message.

Send Hard Reset.

CY_PDSTACK_REQ_ACCEPT 

Send Accept message.

CY_PDSTACK_REQ_REJECT 

Send Reject message.

CY_PDSTACK_REQ_WAIT 

Send Wait message.

CY_PDSTACK_REQ_NOT_SUPPORTED 

Send Not_Supported message.

Will translate to Reject message under PD 2.0

◆ cy_en_pdstack_resp_status_t

Enum of the response status to DPM commands.

Enumerator
CY_PDSTACK_SEQ_ABORTED 

PD AMS aborted.

CY_PDSTACK_CMD_FAILED 

PD AMS failed.

CY_PDSTACK_RES_TIMEOUT 

No response received.

CY_PDSTACK_CMD_SENT 

PD command has been sent.

Response wait may be in progress.

CY_PDSTACK_RES_RCVD 

Response received.

◆ cy_en_pdstack_dpm_pd_cmd_t

Enum of the DPM (Device Policy Manager) command types.

Enumerator
CY_PDSTACK_DPM_CMD_SRC_CAP_CHNG 

00: Source Caps changed notification.

Used to trigger fresh contract.

CY_PDSTACK_DPM_CMD_SNK_CAP_CHNG 

01: Sink Caps changed notification.

Used to trigger fresh contract.

CY_PDSTACK_DPM_CMD_SEND_GO_TO_MIN 

02: Send GotoMin message to port partner.

CY_PDSTACK_DPM_CMD_GET_SNK_CAP 

03: Send Get_Sink_Cap message to port partner.

CY_PDSTACK_DPM_CMD_GET_SRC_CAP 

04: Send Get_Source_Cap message to port partner.

CY_PDSTACK_DPM_CMD_SEND_HARD_RESET 

05: Send Hard Reset.

CY_PDSTACK_DPM_CMD_SEND_SOFT_RESET 

06: Send Soft Reset to port partner.

CY_PDSTACK_DPM_CMD_SEND_CABLE_RESET 

07: Send Cable Reset.

CY_PDSTACK_DPM_CMD_SEND_SOFT_RESET_EMCA 

08: Send Soft Reset to cable marker.

CY_PDSTACK_DPM_CMD_SEND_DR_SWAP 

09: Send DR_Swap request.

CY_PDSTACK_DPM_CMD_SEND_PR_SWAP 

0A: Send PR_Swap request.

CY_PDSTACK_DPM_CMD_SEND_VCONN_SWAP 

0B: Send VCONN_Swap request.

CY_PDSTACK_DPM_CMD_SEND_VDM 

0C: Send VDM message.

CY_PDSTACK_DPM_CMD_SEND_EXTENDED 

0D: Send extended data message.

CY_PDSTACK_DPM_CMD_GET_SRC_CAP_EXTENDED 

0E: Send Get_Source_Cap_Extended message.

CY_PDSTACK_DPM_CMD_GET_STATUS 

0F: Send Get_Status message.

CY_PDSTACK_DPM_CMD_SEND_BATT_STATUS 

10: Send Battery_Status data message.

CY_PDSTACK_DPM_CMD_SEND_ALERT 

11: Send Alert message.

CY_PDSTACK_DPM_CMD_SEND_NOT_SUPPORTED 

12: Send Not_Supported message.

CY_PDSTACK_DPM_CMD_INITIATE_CBL_DISCOVERY 

13: Initiate cable discovery (preceded by VConn Swap if required).

CY_PDSTACK_DPM_CMD_SEND_DATA_RESET 

14: Send a USB4 Data_Reset message.

CY_PDSTACK_DPM_CMD_SEND_ENTER_USB 

15: Send a USB4 Enter_USB message to port partner or cable marker.

CY_PDSTACK_DPM_CMD_GET_SNK_CAP_EXTENDED 

16: Send Get_Sink_Cap_Extended message.

CY_PDSTACK_DPM_CMD_SEND_REQUEST 

17: Send Request data message.

CY_PDSTACK_DPM_CMD_GET_PPS_STATUS 

18: Send Get_PPS_Status message.

CY_PDSTACK_DPM_CMD_GET_COUNTRY_CODES 

19: Send Get_Country_Codes message.

CY_PDSTACK_DPM_CMD_SEND_EPR_MODE 

1A: Send EPR_Mode message.

CY_PDSTACK_DPM_CMD_SNK_EPR_MODE_ENTRY 

1B: Send EPR_Mode Entry message.

CY_PDSTACK_DPM_CMD_SNK_SEND_KEEP_ALIVE 

1C: Send EPR Keep Alive message.

CY_PDSTACK_DPM_CMD_SEND_EXTD_CTRL_MSG 

1D: Send EXT_CTRL_MSG message.

CY_PDSTACK_DPM_CMD_SEND_GET_SOURCE_INFO 

1E: Send Get_Source_Info message.

CY_PDSTACK_DPM_CMD_SEND_GET_REVISION 

1F: Send Get_Revision message.

CY_PDSTACK_DPM_CMD_SEND_INVALID 

FF: Invalid command code.

◆ cy_en_pdstack_vdm_type_t

Enum of the VDM types.

Enumerator
CY_PDSTACK_VDM_TYPE_UNSTRUCTURED 

Unstructured VDM.

CY_PDSTACK_VDM_TYPE_STRUCTURED 

Structured VDM.

◆ cy_en_pdstack_std_vdm_cmd_t

Enum of the standard VDM commands.

Enumerator
CY_PDSTACK_VDM_CMD_DSC_IDENTITY 

Discover Identity command.

CY_PDSTACK_VDM_CMD_DSC_SVIDS 

Discover SVIDs command.

CY_PDSTACK_VDM_CMD_DSC_MODES 

Discover Modes command.

CY_PDSTACK_VDM_CMD_ENTER_MODE 

Enter Mode command.

CY_PDSTACK_VDM_CMD_EXIT_MODE 

Exit Mode command.

CY_PDSTACK_VDM_CMD_ATTENTION 

Attention message.

CY_PDSTACK_VDM_CMD_DP_STATUS_UPDT 

DisplayPort Status Update message.

CY_PDSTACK_VDM_CMD_DP_CONFIGURE 

DisplayPort Configure command.

◆ cy_en_pdstack_std_vdm_cmd_type_t

Enum of the standard VDM command types.

Enumerator
CY_PDSTACK_CMD_TYPE_INITIATOR 

VDM sent by command initiator.

CY_PDSTACK_CMD_TYPE_RESP_ACK 

ACK response.

CY_PDSTACK_CMD_TYPE_RESP_NAK 

NAK response.

CY_PDSTACK_CMD_TYPE_RESP_BUSY 

BUSY response.

◆ cy_en_pdstack_std_vdm_prod_t

Enum of the standard VDM product types.

Enumerator
CY_PDSTACK_PROD_TYPE_UNDEF 

Undefined device type.

CY_PDSTACK_PROD_TYPE_HUB 

Hub device type.

CY_PDSTACK_PROD_TYPE_PERI 

Peripheral device type.

CY_PDSTACK_PROD_TYPE_PSD 

Power Sink Device.

CY_PDSTACK_PROD_TYPE_PAS_CBL 

Passive Cable.

CY_PDSTACK_PROD_TYPE_ACT_CBL 

Active Cable.

CY_PDSTACK_PROD_TYPE_AMA 

Alternate Mode Accessory.

CY_PDSTACK_PROD_TYPE_VPD 

VConn powered device.

CY_PDSTACK_PROD_TYPE_RSVD 

Reserved.

Shall not be used.

◆ cy_en_pdstack_std_vdm_conn_t

Enum of the standard VDM connector types.

Enumerator
CY_PDSTACK_CONN_TYPE_RSVD 

Reserved, for compatibility with legacy systems.

CY_PDSTACK_CONN_TYPE_RSVD1 

Reserved, Shall Not be used.

CY_PDSTACK_CONN_TYPE_RECEPTACLE 

USB Type-C Receptacle.

CY_PDSTACK_CONN_TYPE_PLUG 

USB Type-C Plug.

◆ cy_en_pdstack_std_vdm_ver_t

Enum for the standard VDM version.

Enumerator
CY_PDSTACK_STD_VDM_VER1 

VDM version 1.0.

CY_PDSTACK_STD_VDM_VER2 

VDM version 2.0.

CY_PDSTACK_STD_VDM_VER3 

VDM version 3.0.

CY_PDSTACK_STD_VDM_VER4 

VDM version 4.0.

◆ cy_en_pdstack_cbl_vbus_cur_t

Enum of the cable current levels.

Enumerator
CY_PDSTACK_CBL_VBUS_CUR_DFLT 

Cable can support a maximum of 900mA.

CY_PDSTACK_CBL_VBUS_CUR_3A 

Cable can support a maximum of 3A.

CY_PDSTACK_CBL_VBUS_CUR_5A 

Cable can support a maximum of 5A.

CY_PDSTACK_CBL_VBUS_CUR_0A 

Cable does not conduct VBus power through.

◆ cy_en_pdstack_cbl_type_t

Enum of the cable types.

Enumerator
CY_PDSTACK_CBL_TYPE_PASSIVE 

Passive cable.

CY_PDSTACK_CBL_TYPE_ACTIVE_RETIMER 

Active Re-timer cable.

CY_PDSTACK_CBL_TYPE_ACTIVE_REDRIVER 

Active Re-driver cable.

CY_PDSTACK_CBL_TYPE_OPTICAL 

Optically Isolated cable.

◆ cy_en_pdstack_cbl_term_t

Enum of the cable termination types.

Enumerator
CY_PDSTACK_CBL_TERM_BOTH_PAS_VCONN_NOT_REQ 

Passive cable, VConn not required.

CY_PDSTACK_CBL_TERM_BOTH_PAS_VCONN_REQ 

Passive cable, VConn required.

CY_PDSTACK_CBL_TERM_ONE_ACT_ONE_PAS_VCONN_REQ 

One end active, one end passive, VConn required.

CY_PDSTACK_CBL_TERM_BOTH_ACT_VCONN_REQ 

Both ends of cable are active, VConn required.

◆ cy_en_pdstack_usb_sig_supp_t

Enum of the USB signaling support.

Enumerator
CY_PDSTACK_USB_2_0 

[USB 2.0] only.

CY_PDSTACK_USB_GEN_1 

[USB 3.2] Gen1.

CY_PDSTACK_USB_GEN_2 

[USB 3.2] Gen2 and [USB 4.0] Gen2.

CY_PDSTACK_USB_GEN_3 

[USB 4.0] Gen 3.

◆ cy_en_pdstack_usb_dev_cap_t

Enum of the USB device capabilities masks.

Enumerator
CY_PDSTACK_DEV_CAP_USB_2_0 

[USB 2.0] Device Capable.

CY_PDSTACK_DEV_CAP_USB_BB_ONLY 

Device Capable (Billboard only).

CY_PDSTACK_DEV_CAP_USB_3_2 

[USB 3.2] Device Capable.

CY_PDSTACK_DEV_CAP_USB_4_0 

[USB4] Device Capable.

◆ cy_en_pdstack_usb_host_cap_t

Enum of the USB host capabilities masks.

Enumerator
CY_PDSTACK_HOST_CAP_USB_2_0 

[USB 2.0] Host Capable.

CY_PDSTACK_HOST_CAP_USB_3_2 

[USB 3.2] Host Capable.

CY_PDSTACK_HOST_CAP_USB_4_0 

[USB4] Host Capable.

◆ cy_en_pdstack_usb_role_t

Enum of the USB role types.

Enumerator
CY_PDSTACK_USB_ROLE_DEV 

USB data role Device.

CY_PDSTACK_USB_ROLE_HOST 

USB data role Host.

CY_PDSTACK_USB_ROLE_DRD 

USB data role Device and Host.

◆ cy_en_pdstack_pe_cbl_state_t

Enum of the Policy Engine cable discovery states.

Enumerator
CY_PDSTACK_CBL_FSM_DISABLED 

Cable state machine is inactive.

CY_PDSTACK_CBL_FSM_ENTRY 

Cable state machine starting up.

CY_PDSTACK_CBL_FSM_SEND_SOFT_RESET 

Cable state machine sending Soft Reset to cable marker.

CY_PDSTACK_CBL_FSM_SEND_DSC_ID 

Cable state machine waiting for cable response.

◆ cy_en_pdstack_try_src_snk_t

Enum of the Try Source/ Try Sink options.

Enumerator
CY_PDSTACK_TRY_SRC_TRY_SNK_DISABLED 

Try.SRC and Try.SNK disabled.

CY_PDSTACK_TRY_SRC_ENABLED 

Try.SRC enabled.

CY_PDSTACK_TRY_SNK_ENABLED 

Try.SNK enabled.

◆ cy_en_pdstack_dpm_typec_cmd_t

Enum of the DPM (Device Policy Manager) command types that can be initiated through the dpm_typec_command API.

See also
dpm_typec_command
Enumerator
CY_PDSTACK_DPM_CMD_SET_RP_DFLT 

Command to select Default Rp.

CY_PDSTACK_DPM_CMD_SET_RP_1_5A 

Command to select 1.5 A Rp.

CY_PDSTACK_DPM_CMD_SET_RP_3A 

Command to select 3 A Rp.

CY_PDSTACK_DPM_CMD_PORT_DISABLE 

Command to disable the USB-PD port.

CY_PDSTACK_DPM_CMD_TYPEC_ERR_RECOVERY 

Command to initiate Type-C error recovery.

CY_PDSTACK_DPM_CMD_TYPEC_INVALID 

Invalid command type.

◆ cy_en_pdstack_dpm_typec_cmd_resp_t

Enum of the DPM (Device Policy Manager) response types.

Enumerator
CY_PDSTACK_DPM_RESP_FAIL 

Command failed.

CY_PDSTACK_DPM_RESP_SUCCESS 

Command succeeded.

◆ cy_en_pdstack_typec_fsm_state_t

Enum of the Type-C FSM states.

This is for internal stack usage.

Warning
The ordering of elements must not be altered unless the state table is also updated to match.
Enumerator
CY_PDSTACK_TYPEC_FSM_DISABLED 

Type-C state machine is disabled.

CY_PDSTACK_TYPEC_FSM_ERR_RECOV 

Error Recovery state.

CY_PDSTACK_TYPEC_FSM_ATTACH_WAIT 

AttachWait.SRC or AttachWait.SNK state.

CY_PDSTACK_TYPEC_FSM_UNATTACHED_SRC 

Unattached.SRC state.

CY_PDSTACK_TYPEC_FSM_UNATTACHED_SNK 

Unattached.SNK state.

CY_PDSTACK_TYPEC_FSM_UNATTACHED_WAIT_SRC 

UnattachedWait.SRC state.

CY_PDSTACK_TYPEC_FSM_AUD_ACC 

AudioAccessory state.

CY_PDSTACK_TYPEC_FSM_DBG_ACC 

DebugAccessory state.

CY_PDSTACK_TYPEC_FSM_ATTACHED_SRC 

Attached.SRC state.

CY_PDSTACK_TYPEC_FSM_ATTACHED_SNK 

Attached.SNK state.

CY_PDSTACK_TYPEC_FSM_MAX_STATES 

Invalid Type-C state.

◆ cy_en_pdstack_pe_fsm_state_t

Enumeration of Policy Engine states for a USB-PD port.

This is for internal stack usage.

Warning
The ordering of elements must not be altered unless the state table in the stack source is also updated.
Enumerator
CY_PDSTACK_PE_FSM_OFF 

00: Policy Engine not started.

CY_PDSTACK_PE_FSM_HR_SEND 

01: Send HardReset

CY_PDSTACK_PE_FSM_HR_SRC_TRANS_DFLT 

02: PE_SRC_Transition_to_default

CY_PDSTACK_PE_FSM_HR_SRC_RECOVER 

03: Policy Engine waiting for recovery before enabling VBus.

CY_PDSTACK_PE_FSM_HR_SRC_VBUS_ON 

04: Policy Engine enabling VBus after Hard Reset completion.

CY_PDSTACK_PE_FSM_HR_SNK_TRANS_DFLT 

05: PE_SNK_Transition_to_default

CY_PDSTACK_PE_FSM_HR_SNK_WAIT_VBUS_OFF 

06: Policy Engine waiting for VBus turning off.

CY_PDSTACK_PE_FSM_HR_SNK_WAIT_VBUS_ON 

07: Policy Engine waiting for VBus to turn back on.

CY_PDSTACK_PE_FSM_BIST_TEST_DATA 

08: BIST test data state.

CY_PDSTACK_PE_FSM_BIST_CM2 

09: PE_BIST_Carrier_Mode

CY_PDSTACK_PE_FSM_SNK_STARTUP 

10: PE_SNK_Startup

CY_PDSTACK_PE_FSM_SNK_WAIT_FOR_CAP 

11: PE_SNK_Wait_for_Capabilities

CY_PDSTACK_PE_FSM_SNK_EVAL_CAP 

12: PE_SNK_Evaluate_Capability

CY_PDSTACK_PE_FSM_SNK_SEL_CAP 

13: PE_SNK_Select_Capability

CY_PDSTACK_PE_FSM_SRC_STARTUP 

14: PE_SRC_Startup

CY_PDSTACK_PE_FSM_SRC_WAIT_NEW_CAP 

15: PE_SRC_Wait_New_Capabilities

CY_PDSTACK_PE_FSM_SRC_SEND_CAP 

18: PE_SRC_Send_Capabilities

CY_PDSTACK_PE_FSM_SRC_DISCOVERY 

19: PE_SRC_Discovery

CY_PDSTACK_PE_FSM_SRC_NEG_CAP 

20: PE_SRC_Negotiate_Capability

CY_PDSTACK_PE_FSM_SRC_TRANS_SUPPLY 

21: PE_SRC_Transition_Supply

CY_PDSTACK_PE_FSM_SRC_SEND_PS_RDY 

22: Policy Engine waiting to send PS_RDY.

CY_PDSTACK_PE_FSM_SNK_TRANS 

23: PE_SNK_Transition_Sink

CY_PDSTACK_PE_FSM_SR_SEND 

24: Policy Engine sending Soft Reset.

CY_PDSTACK_PE_FSM_SR_RCVD 

25: Policy Engine received Soft Reset.

CY_PDSTACK_PE_FSM_VRS_VCONN_ON 

26: Policy Engine waiting for VConn to turn on.

CY_PDSTACK_PE_FSM_VRS_VCONN_OFF 

27: Policy Engine waiting for VConn to turn off.

CY_PDSTACK_PE_FSM_SWAP_EVAL 

28: Evaluate received swap command.

CY_PDSTACK_PE_FSM_SWAP_SEND 

29: Waiting to send swap command.

CY_PDSTACK_PE_FSM_DRS_CHANGE_ROLE 

30: Change data role.

CY_PDSTACK_PE_FSM_PRS_SRC_SNK_TRANS 

31: Source to Sink PR_Swap transition start.

CY_PDSTACK_PE_FSM_PRS_SRC_SNK_VBUS_OFF 

32: Initial source waiting for VBus turning off.

CY_PDSTACK_PE_FSM_PRS_SRC_SNK_WAIT_PS_RDY 

33: Initial source waiting for PS_RDY.

CY_PDSTACK_PE_FSM_PRS_SNK_SRC_WAIT_PS_RDY 

34: Initial sink waiting for PS_RDY.

CY_PDSTACK_PE_FSM_PRS_SNK_SRC_VBUS_ON 

35: Initial sink turning VBus ON.

CY_PDSTACK_PE_FSM_FRS_CHECK_RP 

36: Initial sink checking Rp to send FR_Swap message.

CY_PDSTACK_PE_FSM_FRS_SRC_SNK_CC_SIGNAL 

37: Initial source sending FR_Swap signal.

CY_PDSTACK_PE_FSM_READY 

38: PE_Ready state.

CY_PDSTACK_PE_FSM_SEND_MSG 

39: Policy Engine sending new AMS.

CY_PDSTACK_PE_FSM_EVAL_DATA_RESET 

40: Policy Engine Handling Data_Reset request.

CY_PDSTACK_PE_FSM_SEND_DATA_RESET 

41: Policy Engine initiating Data_Reset request.

CY_PDSTACK_PE_FSM_EVAL_ENTER_USB 

42: Policy Engine handling Enter USB request.

CY_PDSTACK_PE_FSM_SRC_EVAL_EPR_MODE_ENTRY 

43: Policy Engine handling EPR MODE request.

CY_PDSTACK_PE_FSM_SRC_SEND_EPR_MODE_RESULT 

44: Policy Engine handling EPR MODE request.

CY_PDSTACK_PE_FSM_SRC_SEND_EPR_SRC_CAP 

45: Policy Engine Send EPR SRC CAP.

CY_PDSTACK_PE_FSM_SNK_SEND_EPR_MODE_ENTRY 

46: Policy Engine Request EPR Mode Entry.

CY_PDSTACK_PE_FSM_SNK_EPR_ENTRY_WAIT_FOR_RESP 

47: Policy Engine handling EPR MODE request.

CY_PDSTACK_PE_FSM_SNK_EPR_KEEP_ALIVE 

48: Policy Engine send EPR MODE Keep Alive.

CY_PDSTACK_PE_FSM_SNK_SEND_EPR_CAP 

49: Policy Engine send EPR Sink Capabilities.

CY_PDSTACK_PE_FSM_MAX_STATES 

50: Invalid Policy Engine state.

◆ cy_en_pdstack_contract_status_t

Enum of possible PD contract negotiation scenarios that are used to signal the application event handler.

This status will be reported in byte 0 of the event data passed along with the APP_EVT_PD_CONTRACT_NEGOTIATION_COMPLETE event. Bytes 3:1 of the event data are not used; and bytes 7:4 will report the RDO where applicable.

Enumerator
CY_PDSTACK_CONTRACT_NEGOTIATION_SUCCESSFUL 

PD contract negotiation successful.

CY_PDSTACK_CONTRACT_CAP_MISMATCH_DETECTED 

PD contract negotiated, but capability mismatch is present.

CY_PDSTACK_CONTRACT_REJECT_CONTRACT_VALID 

Contract rejected by PMG1, but previous contract is still valid.

CY_PDSTACK_CONTRACT_REJECT_CONTRACT_NOT_VALID 

Contract rejected by PMG1 and previous contract became invalid.

CY_PDSTACK_CONTRACT_REJECT_NO_CONTRACT 

Contract rejected by PMG1 and there was no previous contract.

CY_PDSTACK_CONTRACT_REJECT_EXPLICIT_CONTRACT 

Request rejected by port partner while in previous explicit contract.

CY_PDSTACK_CONTRACT_REJECT_NO_EXPLICIT_CONTRACT 

Request rejected by port partner with no previous explicit contract.

CY_PDSTACK_CONTRACT_PS_READY_NOT_RECEIVED 

Failed to receive PS_RDY after Accept.

CY_PDSTACK_CONTRACT_PS_READY_NOT_SENT 

Failed to send PS_RDY after Accept.

◆ cy_en_pdstack_app_evt_t

Enum of events that are signalled to the application.

Enumerator
APP_EVT_UNEXPECTED_VOLTAGE_ON_VBUS 

0x00: Unexpected high voltage seen on VBus.

APP_EVT_TYPE_C_ERROR_RECOVERY 

0x01: Type-C error recovery initiated.

APP_EVT_CONNECT 

0x02: Type-C connect detected.

APP_EVT_DISCONNECT 

0x03: Type-C disconnect(detach) detected.

APP_EVT_EMCA_DETECTED 

0x04: Cable (EMCA) discovery successful.

APP_EVT_EMCA_NOT_DETECTED 

0x05: Cable (EMCA) discovery timed out.

APP_EVT_ALT_MODE 

0x06: Alternate mode related event.

APP_EVT_APP_HW 

0x07: MUX control related event.

APP_EVT_BB 

0x08: Billboard status change.

APP_EVT_RP_CHANGE 

0x09: Rp termination change detected.

APP_EVT_HARD_RESET_RCVD 

0x0A: Hard Reset received.

APP_EVT_HARD_RESET_COMPLETE 

0x0B: Hard Reset processing completed.

APP_EVT_PKT_RCVD 

0x0C: New PD message received.

APP_EVT_PR_SWAP_COMPLETE 

0x0D: PR_SWAP process completed.

APP_EVT_DR_SWAP_COMPLETE 

0x0E: DR_SWAP process completed.

APP_EVT_VCONN_SWAP_COMPLETE 

0x0F: VConn_SWAP process completed.

APP_EVT_SENDER_RESPONSE_TIMEOUT 

0x10: Sender response timeout occurred.

APP_EVT_VENDOR_RESPONSE_TIMEOUT 

0x11: Vendor message response timeout occurred.

APP_EVT_HARD_RESET_SENT 

0x12: Hard Reset sent by PMG1.

APP_EVT_SOFT_RESET_SENT 

0x13: Soft Reset sent by PMG1.

APP_EVT_CBL_RESET_SENT 

0x14: Cable Reset sent by PMG1.

APP_EVT_PE_DISABLED 

0x15: PE.Disabled state entered.

APP_EVT_PD_CONTRACT_NEGOTIATION_COMPLETE 

0x16: Contract negotiation completed.

APP_EVT_VBUS_OVP_FAULT 

0x17: VBus Over Voltage fault detected.

APP_EVT_VBUS_OCP_FAULT 

0x18: VBus Over Current fault detected.

APP_EVT_VCONN_OCP_FAULT 

0x19: VConn Over Current fault detected.

APP_EVT_VBUS_PORT_DISABLE 

0x1A: PD port disable completed.

APP_EVT_TYPEC_STARTED 

0x1B: PD port enable (start) completed.

APP_EVT_FR_SWAP_COMPLETE 

0x1C: FR_SWAP process completed.

APP_EVT_TEMPERATURE_FAULT 

0x1D: Over Temperature fault detected.

APP_EVT_HANDLE_EXTENDED_MSG 

0x1E: Extended message received and needs to be handled.

APP_EVT_VBUS_UVP_FAULT 

0x1F: VBus Under Voltage fault detected.

APP_EVT_VBUS_SCP_FAULT 

0x20: VBus Short Circuit fault detected.

APP_EVT_TYPEC_ATTACH_WAIT 

0x21: Type-C AttachWait state entered.

APP_EVT_TYPEC_ATTACH_WAIT_TO_UNATTACHED 

0x22: Type-C transition from AttachWait to Unattached.

APP_EVT_TYPEC_ATTACH 

0x23: Type-C attach event.

APP_EVT_CC_OVP 

0x24: Over Voltage on CC/VConn line detected.

APP_EVT_SBU_OVP 

0x25: Over Voltage on SBU1/SBU2 line detected.

APP_EVT_ALERT_RECEIVED 

0x26: Alert message received.

APP_EVT_SRC_CAP_TRIED_WITH_NO_RESPONSE 

0x27: Src Cap tried with no response.

APP_EVT_PD_SINK_DEVICE_CONNECTED 

0x28: Sink device connected.

APP_EVT_VBUS_RCP_FAULT 

0x29: VBus Reverse Current fault detected.

APP_EVT_STANDBY_CURRENT 

0x2A: Standby Current.

APP_EVT_DATA_RESET_RCVD 

0x2B: USB4 Data Reset message received.

USB connection should be disabled by DFP on receiving this event.

APP_EVT_DATA_RESET_SENT 

0x2C: USB4 Data Reset message sent.

USB connection should be disabled by DFP on receiving this event.

APP_EVT_DATA_RESET_CPLT 

0x2D: USB4 Data Reset process complete.

No handling required.

APP_EVT_USB_ENTRY_CPLT 

0x2E: USB4 entry process complete.

APP_EVT_DATA_RESET_ACCEPTED 

0x2F: USB4 Data Reset Accepted.

USB connection can be re-enabled by DFP on receiving this event.

APP_EVT_CONFIG_ERROR 

0x30: Stack configuration error event.

APP_EVT_POWER_CYCLE 

0x31: Power cycle / Reset event.

APP_EVT_VBUS_IN_UVP_FAULT 

0x32: Vbus_in undervoltage fault detected.

APP_EVT_VBUS_IN_OVP_FAULT 

0x33: Vbus_in overvoltage fault detected.

APP_EVT_SYSTEM_OT_FAULT 

0x34: System overtemperature fault detected.

APP_EVT_CRC_ERROR 

0x35: PD CRC error detected.

APP_EVT_HR_PSRC_ENABLE 

0x36: PSRC enable is about to be called after Hard reset.

APP_EVT_TYPEC_RP_DETACH 

0x37: Rp removal detected while in the Attached.SNK state.

APP_EVT_PR_SWAP_ACCEPTED 

0x38: PR-SWAP accepted by PMG1 or port partner.

APP_EVT_HR_SENT_RCVD_DEFERRED 

0x39: Deferred Hard Reset Sent/Received event handling to accommodate retimer communication delay timing.

APP_EVT_BAD_SINK_APDO_SEL 

0x3A: APDO selection in PD 2.0 or less revision

APP_EVT_BC_DETECTION_COMPLETED 

0x3B: Legacy battery charging protocol detection completed .

APP_EVT_SNK_FET_ENABLE 

0x3C: HPI Enable SNK FET cmd event.

APP_EVT_SNK_FET_DISABLE 

0x3D: HPI Disable SNK FET cmd event.

APP_EVT_SAFE_PWR_ENABLE 

0x3E: HPI Enable Safe PWR path cmd event.

APP_EVT_SAFE_PWR_DISABLE 

0x3F: HPI Disable Safe PWR path cmd event.

APP_EVT_FAULT_CLEANED 

0x40: OVP/OCP/OTP fault state is cleaned.

APP_EVT_MISMATCH_CLEANED 

0x41: MISMATCH fault state is cleaned.

APP_EVT_CUST_ALT_MODE_CHANGED 

0x42: This is a custom event that could be set for notification of alternate mode specific conditions like mode entry and mode exit.

APP_EVT_CUST_MODE_DISC_CMPL 

0x43: Apple sequencing is finished .

APP_EVT_VBAT_GND_SCP_FAULT 

0x44: Battery to ground short circuit fault detected.

APP_EVT_VIN_UVP_FAULT 

0x45: Regulator input under voltage fault detected.

APP_EVT_VIN_OVP_FAULT 

0x46: Regulator input over voltage fault detected.

APP_EVT_BIST_STM_ENTRY 

0x47: BIST STM Entry event.

APP_EVT_BIST_STM_EXIT 

0x48: BIST STM Exit event.

APP_EVT_ILIM_FAULT 

0x49: Inductor Limit fault detected.

APP_EVT_VREG_INRUSH_FAULT 

0x4A: Vreg inrush detect fault detected.

APP_EVT_VREG_BOD_FAULT 

0x4B: Device Brown Out Detect fault detected.

APP_EVT_VCONN_SCP_FAULT 

0x4C: VConn Short Circuit fault detected.

APP_EVT_SOURCE_INFO_RECEIVED 

0x4D: Source Info message Received from Sink

APP_EVT_REVISION_RECEIVED 

0x4E: Revision Data message Received

APP_EVT_EPR_MODE_ENTER_RECEIVED 

0x4F: EPR Mode Enter command Received from Sink port

APP_EVT_EPR_MODE_ENTER_SUCCESS 

0x50: EPR Mode Enter successful, Source response with Enter Succeeded

APP_EVT_EPR_MODE_ENTER_FAILED 

0x51: EPR Mode Enter failed, Source response with Fail

APP_EVT_EPR_MODE_EXIT 

0x52: EPR Mode Exit Received

APP_EVT_VCONN_SWAP_FAILED 

0x53: VConn_SWAP process failed in EPR Enter msg.

sequence.

APP_TOTAL_EVENTS 

0x54: Total number of application events.

◆ cy_en_pdstack_ams_type_t

Type of USB-PD Atomic Message Sequence (AMS).

Enumerator
CY_PDSTACK_AMS_NONE 

No AMS active.

CY_PDSTACK_AMS_NON_INTR 

Non-interruptible AMS is active.

CY_PDSTACK_AMS_INTR 

Interruptible AMS is active.

◆ cy_en_pdstack_vdm_ams_t

Enumeration of application responses to policy manager.

Enumerator
CY_PDSTACK_VDM_AMS_RESP_READY 

Response is ready.

CY_PDSTACK_VDM_AMS_RESP_NOT_REQ 

No response required.

CY_PDSTACK_VDM_AMS_RESP_FROM_EC 

Response will come from EC.

CY_PDSTACK_VDM_AMS_RESP_NOT_SUPP 

Send a NOT_SUPPORTED response.

◆ cy_en_pdstack_usb_data_sig_t

Enumeration of USB signalling supported by a device or cable.

Enumerator
CY_PDSTACK_USB_2_0_SUPP 

Only USB 2.0 support.

CY_PDSTACK_USB_GEN_1_SUPP 

USB 3.1 Gen1 (5 Gbps) support.

CY_PDSTACK_USB_GEN_2_SUPP 

USB 3.1 Gen2 (10 Gbps) support.

CY_PDSTACK_USB_GEN_3_SUPP 

USB 4 Gen3 (20 Gbps) support.

CY_PDSTACK_USB_BB_SUPP 

USB Billboard device support.

CY_PDSTACK_USB_SIG_UNKNOWN 

USB data signalling support unknown.

◆ cy_en_pdstack_data_reset_state_t

Enumeration of sub-states associated with Data Reset AMS.

Enumerator
CY_PDSTACK_DATA_RESET_IDLE 

No Data_Reset related operation pending.

CY_PDSTACK_DATA_RESET_WAIT_ACCEPT 

Sender waiting for Data_Reset Acceptance.

CY_PDSTACK_DATA_RESET_ACCEPTED 

Waiting for next step after sending Accept response.

CY_PDSTACK_DATA_RESET_WAIT_PS_RDY 

Waiting for PS_RDY at the end of Data_Reset handshake.

CY_PDSTACK_DATA_RESET_WAIT_VCONN_OFF 

Waiting for VConn turn-off completion before sending PS_RDY.

CY_PDSTACK_DATA_RESET_SENDING_PS_RDY 

In the process of sending PS_RDY after Data_Reset handshake.

CY_PDSTACK_DATA_RESET_WAIT_VCONN_ON 

DFP waiting to turn VConn ON.

CY_PDSTACK_DATA_RESET_WAIT_COMPLETION 

UFP waiting for Data_Reset completion.

CY_PDSTACK_DATA_RESET_COMPLETE_DELAY 

DFP waiting to send Data_Reset_Complete message.

◆ cy_en_pdstack_epr_mode_state_t

Enumeration of sub-states associated with EPR_Mode AMS.

Enumerator
CY_PDSTACK_EPR_MODE_STATE_IDLE 

No EPR Mode related operation pending.

CY_PDSTACK_EPR_MODE_STATE_WAIT_ACK 

Sender waiting for EPR Mode Acknowledgement.

CY_PDSTACK_EPR_MODE_STATE_ACKED 

Waiting for next step after sending Accept response.

CY_PDSTACK_EPR_MODE_STATE_WAIT_CBL_DSC 

Waiting for VConn swap and Cable Discovery completion before sending EPR MODE Enter/Fail.

CY_PDSTACK_EPR_MODE_STATE_WAIT_COMPLETION 

UFP waiting for EPR Mode completion.

CY_PDSTACK_EPR_MODE_STATE_COMPLETE_DELAY 

DFP waiting to send EPR Mode Enter/Fail message.

◆ cy_en_pdstack_eprmdo_action_t

Enumeration of action fields in EPR Enter Mode data object.

Enumerator
CY_PDSTACK_EPR_MODE_ENTER 

Enter cmd.

CY_PDSTACK_EPR_MODE_ACK 

Enter Acknowledged.

CY_PDSTACK_EPR_MODE_SUCCEEDED 

Enter Succeeded.

CY_PDSTACK_EPR_MODE_FAILED 

Enter Failed.

CY_PDSTACK_EPR_MODE_EXIT 

Exit cmd.

◆ cy_en_pdstack_eprmdo_data_t

Enumeration of data fields in EPR Enter Mode data object with EPR_MODE_ENTER_FAILED action field.

Enumerator
CY_PDSTACK_EPR_FAIL_UNKNOWN 

Unknown cause.

CY_PDSTACK_EPR_FAIL_EPR_CABLE 

Cable not EPR capable.

CY_PDSTACK_EPR_FAIL_EPR_VCONN 

Source failed to become VCONN source.

CY_PDSTACK_EPR_FAIL_RDO 

EPR Mode Capable bit not set in RDO.

CY_PDSTACK_EPR_FAIL_UNABLE_NOW 

Unable at this time.

CY_PDSTACK_EPR_FAIL_PDO 

EPR Mode Capable bit not set in PDO.

CY_PDSTACK_EPR_ENTER_SUCCESS 

Enter Succeeded.No failures.

◆ cy_en_pdstack_intel_pf_type_t

List of Intel TBT/USB platform types in which the CCG device is used.

Enumerator
CY_PDSTACK_PF_THUNDERBOLT 

Thunderbolt platforms like Alpine Ridge or Titan Ridge.

CY_PDSTACK_PF_ICE_LAKE 

Intel IceLake platform.

CY_PDSTACK_PF_TIGER_LAKE 

Intel TigerLake platform.

CY_PDSTACK_PF_MAPLE_RIDGE 

Intel RocketLake + Maple Ridge platform.

◆ cy_en_pdstack_amd_pf_type_t

List of AMD platform types in which the CCG device is used.

Enumerator
CY_PDSTACK_AMD_PF_RENOIR 

AMD Renoir based platform.

CY_PDSTACK_AMD_PF_REMBRANDT_A0 

AMD Rembrandt A0 based platform.

CY_PDSTACK_AMD_PF_REMBRANDT_B0 

AMD Rembrandt B0 based platform.

◆ cy_en_pdstack_amd_rtmr_type_t

List of retimer types which could be used via AMD projects.

Enumerator
CY_PDSTACK_AMD_RETIMER_NONE 

No retimer.

CY_PDSTACK_AMD_RETIMER_PI3DPX1205A 

Retimer PI3DPX1205A.

CY_PDSTACK_AMD_RETIMER_PS8828 

Retimer PS8828.

CY_PDSTACK_AMD_RETIMER_PS8830 

Retimer PS8830.

CY_PDSTACK_AMD_RETIMER_AUTO_PS8828A_OR_PS8830 

Retimer type should be discovered.

CY_PDSTACK_AMD_RETIMER_KB800X_B0 

Retimer KB800X B0.

CY_PDSTACK_AMD_RETIMER_KB800X_B1 

Retimer KB800X B1.

◆ cy_en_pdstack_pdo_sel_alg_t

Algorithm selection for pdo evaluation.

Only fixed SRC_PDOs take part for current and voltage algorithms.

Enumerator
CY_PDSTACK_HIGHEST_POWER 

Algorithm to select contract with highest power.

CY_PDSTACK_HIGHEST_CURRENT 

Algorithm to select contract with highest current.

CY_PDSTACK_HIGHEST_VOLTAGE 

Algorithm to select contract with highest voltage.

◆ cy_en_pdstack_status_t

Interface status codes.

Enumeration to hold status codes for all PMG1 interfaces. These values are pre-defined for each interface and should not be modified. To make interface usage easier, the enumeration starts at -2. This allows the success status to have a value of zero. The response code should be incremented by two before sending out on the individual interfaces.

Enumerator
CY_PDSTACK_STAT_NO_RESPONSE 

Special status code indicating no response.

CY_PDSTACK_STAT_SUCCESS 

Success status.

CY_PDSTACK_STAT_FLASH_DATA_AVAILABLE 

Special status code indicating flash data availability.

CY_PDSTACK_STAT_BAD_PARAM 

Bad input parameter.

CY_PDSTACK_STAT_INVALID_COMMAND 

Operation failed due to invalid command.

CY_PDSTACK_STAT_FLASH_UPDATE_FAILED 

Flash write operation failed.

CY_PDSTACK_STAT_INVALID_FW 

Special status code indicating invalid firmware.

CY_PDSTACK_STAT_INVALID_ARGUMENT 

Operation failed due to invalid arguments.

CY_PDSTACK_STAT_NOT_SUPPORTED 

Feature not supported.

CY_PDSTACK_STAT_INVALID_SIGNATURE 

Invalid signature parameter identified.

CY_PDSTACK_STAT_TRANS_FAILURE 

Transaction failure status.

CY_PDSTACK_STAT_CMD_FAILURE 

Command failure status.

CY_PDSTACK_STAT_FAILURE 

Generic failure status.

CY_PDSTACK_STAT_READ_DATA 

Special status code indicating read data availability.

CY_PDSTACK_STAT_NOT_READY 

Operation failed due to device/stack not ready.

CY_PDSTACK_STAT_BUSY 

Operation failed due to device/stack busy status.

CY_PDSTACK_STAT_TIMEOUT 

Operation timed out.

CY_PDSTACK_STAT_INVALID_PORT 

Invalid port number.

CY_PDSTACK_STAT_INVALID_ID 

Invalid FWCT identity received for signed FW upgrade.

CY_PDSTACK_STAT_INVALID_GUID 

Invalid GUID received for signed FW upgrade.

CY_PDSTACK_STAT_INVALID_VER 

Invalid/older Primary FW version received for signed FW upgrade.

CY_PDSTACK_STAT_OUT_OF_SEQ_CMD 

Command sent is not expected in current state during signed FW upgrade.

CY_PDSTACK_STAT_INVALID_FWCT 

Unauthentic FWCT received for signed FW upgrade.

CY_PDSTACK_STAT_HASH_CMP_FAILED 

Hash comparison of fw image and hash in FWCT is not matched during signed FW upgrade.

◆ cy_sw_timer_id_t

List of soft timer IDs defined for various applications.

Values of the timer IDs should not be changed. Timer IDs from USER_TIMERS_START_ID can be used by user code.

Enumerator
PD_TIMERS_START_ID 

000: Start index for USB-PD stack timers.

PD_CABLE_TIMER 

001: Timer used for cable capability check.

PD_NO_RESPONSE_TIMER 

002: Response timer.

PD_CBL_DSC_ID_TIMER 

003: Timer used for cable discovery state machine.

PD_CBL_DELAY_TIMER 

004: Timer used to enforce cable delay.

PD_PHY_BUSY_TIMER 

005: Timer used to handle PHY busy status.

PD_GOOD_CRC_TX_TIMER 

006: GoodCRC timer.

PD_HARD_RESET_TX_TIMER 

007: Hard reset transmit timer.

PD_VCONN_SWAP_INITIATOR_TIMER 

008: VConn swap initiator timer.

PD_GENERIC_TIMER 

009: Generic AMS timer.

PD_PPS_TIMER 

010: PPS related timer.

PD_SINK_TX_TIMER 

011: PD 3.0 sink Rp flow control timer.

PD_DATA_RESET_COMP_TIMER 

012: Reserved for future use.

PD_TIMER_RESERVED_13 

013: Reserved for future use.

PD_TIMERS_END_ID 

014: End index (inclusive) for USB-PD stack timers.

TYPEC_TIMERS_START_ID 

015: Start index for Type-C timers.

TYPEC_GENERIC_TIMER2 

015: Generic Type-C state machine timer #2.

TYPEC_GENERIC_TIMER1 

016: Generic Type-C state machine timer #1.

TYPEC_CC1_DEBOUNCE_TIMER 

017: Timer used for CC1 debounce.

TYPEC_CC2_DEBOUNCE_TIMER 

018: Timer used for CC2 debounce.

TYPEC_RD_DEBOUNCE_TIMER 

019: Timer used for Rd debounce.

TYPEC_VBUS_DISCHARGE_TIMER 

020: VBus discharge timer id.

TYPEC_ACTIVITY_TIMER 

021: Type-C activity timer id.

TYPEC_RP_CHANGE_TIMER 

022: Timer used to trigger current limit update after Rp change.

TYPEC_TIMER_RESERVED_23 

023: Reserved for future use.

TYPEC_TIMERS_END_ID 

024: End index (inclusive) for Type-C timers.

PD_OCP_DEBOUNCE_TIMER 

025: Timer used for FW debounce of VBus OCP.

HPD_RX_ACTIVITY_TIMER_ID 

026: Timer used for HPD receive handling.

PD_VCONN_OCP_DEBOUNCE_TIMER 

027: Timer used for FW debounce of VConn OCP.

PD_SNK_EPR_MODE_TIMER 

028: Timer used for Pd Sink EPR Mode.

PD_SRC_EPR_MODE_TIMER 

029: Timer used for Pd Source EPR Mode.

PD_EPR_KEEPALIVE_TIMER 

030: Timer used by EPR state machine for sending KeepAlive message.

PD_TIMER_RESERVED_31 

031: Reserved for future use.

PD1_TIMERS_START_ID 

032: Start index for USB-PD stack timers.

PD1_CABLE_TIMER 

033: Timer used for cable capability check.

PD1_NO_RESPONSE_TIMER 

034: Response timer.

PD1_CBL_DSC_ID_TIMER 

035: Timer used for cable discovery state machine.

PD1_CBL_DELAY_TIMER 

036: Timer used to enforce cable delay.

PD1_PHY_BUSY_TIMER 

037: Timer used to handle PHY busy status.

PD1_GOOD_CRC_TX_TIMER 

038: GoodCRC timer.

PD1_HARD_RESET_TX_TIMER 

039: Hard reset transmit timer.

PD1_VCONN_SWAP_INITIATOR_TIMER 

040: VConn swap initiator timer.

PD1_GENERIC_TIMER 

041: Generic AMS timer.

PD1_PPS_TIMER 

042: PPS related timer.

PD1_SINK_TX_TIMER 

043: PD 3.0 sink Rp flow control timer.

PD1_DATA_RESET_COMP_TIMER 

044: Reserved for future use.

PD1_TIMER_RESERVED_43 

045: Reserved for future use.

PD1_TIMERS_END_ID 

046: End index (inclusive) for USB-PD stack timers.

TYPEC1_TIMERS_START_ID 

047: Start index for Type-C timers.

TYPEC1_GENERIC_TIMER2 

047: Generic Type-C state machine timer #2.

TYPEC1_GENERIC_TIMER1 

048: Generic Type-C state machine timer #1.

TYPEC1_CC1_DEBOUNCE_TIMER 

049: Timer used for CC1 debounce.

TYPEC1_CC2_DEBOUNCE_TIMER 

050: Timer used for CC2 debounce.

TYPEC1_RD_DEBOUNCE_TIMER 

051: Timer used for Rd debounce.

TYPEC1_VBUS_DISCHARGE_TIMER 

052: VBus discharge timer id.

TYPEC1_ACTIVITY_TIMER 

053: Type-C activity timer id.

TYPEC1_RP_CHANGE_TIMER 

054: Timer used to trigger current limit update after Rp change.

TYPEC1_TIMER_RESERVED_53 

055: Reserved for future use.

TYPEC1_TIMERS_END_ID 

056: End index (inclusive) for Type-C timers.

PD1_OCP_DEBOUNCE_TIMER 

057: Timer used for FW debounce of VBus OCP.

HPD1_RX_ACTIVITY_TIMER_ID 

058: Timer used for HPD receive handling.

PD1_VCONN_OCP_DEBOUNCE_TIMER 

059: Timer used for FW debounce of VConn OCP.

CCG_ACTIVITY_TIMER_ID 

060: PD Application level activity timer.

PD1_SNK_EPR_MODE_TIMER 

061: Timer used for Pd Sink EPR Mode.

PD1_SRC_EPR_MODE_TIMER 

062: Timer used for Pd Source EPR Mode.

PD1_EPR_KEEPALIVE_TIMER 

63: Timer used by EPR state machine for sending KeepAlive message.

APP_TIMERS_START_ID 

064: Start index for Application level timers.

APP_PSOURCE_EN_TIMER 

064: Timer used to ensure timely completion of power source enable operation.

APP_PSOURCE_EN_MONITOR_TIMER 

065: Timer used to monitor voltage during power source enable operation.

APP_PSOURCE_EN_HYS_TIMER 

066: Timer used to add hysteresis at the end of a power source enable operation.

APP_PSOURCE_DIS_TIMER 

067: Timer used to ensure timely completion of power source disable operation.

APP_PSOURCE_DIS_MONITOR_TIMER 

068: Timer used to monitor voltage during power source disable operation.

APP_PSOURCE_CF_TIMER 

069: Power source Current foldback restart timer ID.

APP_PSOURCE_DIS_EXT_DIS_TIMER 

070: Timer used to discharge VBus for some extra time at the end of a power source disable operation.

APP_DB_SNK_FET_DIS_DELAY_TIMER 

071: Dead battery Sink Fet disable delay timer.

APP_PSINK_DIS_TIMER 

072: Timer used to ensure timely completion of power sink disable operation.

APP_PSINK_DIS_MONITOR_TIMER 

073: Timer used to monitor voltage during power sink disable operation.

APP_VDM_BUSY_TIMER 

074: Timer used to delay retry of VDMs due to BUSY responses or errors.

APP_AME_TIMEOUT_TIMER 

075: Timer used to implement AME timeout.

APP_VBUS_OCP_OFF_TIMER 

076: Timer used to disable VBus supply after OC fault.

APP_VBUS_OVP_OFF_TIMER 

077: Timer used to disable VBus supply after OV fault.

APP_VBUS_UVP_OFF_TIMER 

078: Timer used to disable VBus supply after UV fault.

APP_VBUS_SCP_OFF_TIMER 

079: Timer used to disable VBus supply after SC fault.

APP_FAULT_RECOVERY_TIMER 

080: App timer used to delay port enable after detecting a fault.

APP_SBU_DELAYED_CONNECT_TIMER 

081: Timer used to do delayed SBU connection in Thunderbolt mode.

APP_MUX_DELAY_TIMER 

082: Timer used to delay VDM response.

APP_MUX_POLL_TIMER 

083: Timer used to MUX status.

APP_CBL_DISC_TRIGGER_TIMER 

084: Timer used to trigger cable discovery after a V5V supply change.

APP_V5V_CHANGE_DEBOUNCE_TIMER 

085: Timer used to debounce V5V voltage changes.

APP_VCONN_RECOVERY_TIMER 

086: Timer used to run Vconn swap after V5V was lost and recovered while UFP.

APP_OT_DETECTION_TIMER 

087: Timer used to call OT measurement handler.

APP_CHUNKED_MSG_RESP_TIMER 

088: Timer ID used to respond to chunked messages with NOT_SUPPORTED.

APP_RESET_VDM_LAYER_TIMER 

089: Timer used to run reset of VDM layer.

APP_BB_ON_TIMER 

090: Timer used to provide delay between disabling the Billboard device and re-enabling it.

APP_BB_OFF_TIMER 

091: Timer used to display USB billboard interface to save power.

APP_INITIATE_SWAP_TIMER 

092: Timer used to initiate SWAP operations in DRP applications with a power/data role preference.

APP_VDM_NOT_SUPPORT_RESP_TIMER_ID 

093: VDM Not supported response timer.

APP_BC_TIMERS_START_ID 

094: Start of Battery Charging State Machine timers.

APP_BC_GENERIC_TIMER1 

095: Generic timer #1 used by the BC state machine.

APP_BC_GENERIC_TIMER2 

096: Generic timer #2 used by the BC state machine.

APP_BC_DP_DM_DEBOUNCE_TIMER 

097: Timer used to debounce voltage changes on DP and DM pins.

APP_BC_DETACH_DETECT_TIMER 

098: Timer used to detect detach of a BC 1.2 sink while functioning as a CDP.

APP_CDP_DP_DM_POLL_TIMER 

099: Timer used to initiate DP/DM voltage polling while connected as a CDP.

APP_EPR_MODE_TIMER 

100: Timer used by EPR state machine.

APP_EPR_EXT_CMD_TIMER 

101: Timer used to send enter/exit EPR mode events to EPR state machine.

APP_TIMER_HPD_DELAY_TIMER 

102: This timer is used to delay HPD events.

APP_PSOURCE_VBUS_SET_TIMER_ID 

103: Power source VBUS set timer ID.

APP_PSOURCE_SAFE_FET_ON_TIMER_ID 

104: Timeout timer to set safe voltage during FET On operation.

APP_PSOURCE_SAFE_FET_ON_MONITOR_TIMER_ID 

105: Timer to monitor voltage during FET On operation.

VBUS_DISCHARGE_SCHEDULE_TIMER 

106: Timer for VBUS SLow Discharge

CCG_LS_MASTER_PORT_DEBOUNCE_TIMER_ID 

107: Macro defines Master Debounce Timer ID.

CCG_LS_SLAVE_PORT_DEBOUNCE_TIMER_ID 

108: Macro defines Slave Debounce Timer ID.

CCG_LS_MASTER_WRITE_TIMER_ID 

109: Macro defines Master Write Timer ID.

CCG_LS_HEART_BEAT_TIMER_ID 

110: Macro defines Heart Beat Timer ID.

THROTTLE_TIMER_ID 

111: Power Throttling timer ID.

THROTTLE_WAIT_FOR_PD_TIMER_ID 

112: Power Throttling timer ID.

HPI_PD_CMD_TIMER 

113: Timer ID reserved for future use.

LINS_BUS_INACTIVE_TIMER 

114: Bus Inactivity Timeout for LIN.

LINS_BUS_LISTEN_TIMER 

115: Nominal Time for Reception of a single frame from BREAK

LINS_MULTIFRAME_DROP_TIMER 

116: Multiframe timer to drop the frame upon late reception.

APP_FET_SOFT_START_TIMER_ID 

117: Timer used to control soft turn-on of power FET gate drivers.

APP_HAL_VREG_TIMER 

118: Timer that can be used for Vreg fault handling.

APP_HAL_GENERIC_TIMER 

119: Timer that can be used for generic HAL functions.

APP_REGULATOR_STARTUP_MONITOR_TIMER 

120: Timer ID reserved for regulator startup monitoring.

APP_DATA_RESET_TIMER 

121: Timer ID for DATA Reset handling.

SYS_BLACK_BOX_TIMER_ID 

122: Timer ID reserved for blackbox.

APP_PSOURCE_REGULATOR_MON_TIMER 

123: Timer ID used to monitor regulator enable status periodically.

APP_BAD_SINK_TIMEOUT_TIMER 

124: PD bad sink timeout timer ID.

APP_VBAT_GND_SCP_TIMER_ID 

125: VBAT-GND SCP recovery timer.

APP_VCONN_OCP_TIMER 

126: Timer to perform delayed start for VCONN OCP.

APP_TIMERS_RESERVED_START_ID 

127: App Reserved Timer Id Start.

APP_TIMER_RESERVED_127 

127 - 191: Timer ID reserved for future use.

APP_PORT1_TIMER_START_ID 

192: Start of timer IDs reserved for the application layer management of PD port #1.

I2C_SLAVE_SCB0_TIMER 

320: I2C transfer timeout for SCB0.

I2C_SLAVE_SCB1_TIMER 

321: I2C transfer timeout for SCB1.

I2C_SLAVE_SCB2_TIMER 

322: I2C transfer timeout for SCB2.

I2C_SLAVE_SCB3_TIMER 

323: I2C transfer timeout for SCB3.

USER_TIMERS_START_ID 

324: Start of timer IDs left for generic solution level usage.