 |
CAT2 Peripheral Driver Library
|
|
CAT2 Peripheral Driver Library
|
Data Structures | |
| struct | cy_stc_fault_vbus_ovp_cfg_t |
| Config structure for VBUS OVP parameters. More... | |
| struct | cy_stc_fault_vbus_uvp_cfg_t |
| Config structure for VBUS UVP parameters. More... | |
| struct | cy_stc_usbpd_legacy_charging_state_t |
| Structure for legacy charging state machine. More... | |
| struct | cy_stc_fault_vbus_ocp_cfg_t |
| Config structure for VBUS OCP parameters. More... | |
| struct | cy_stc_fault_vbat_ocp_cfg_t |
| Config structure for VBAT OCP parameters. More... | |
| struct | cy_stc_fault_vconn_ocp_cfg_t |
| Config structure for VCONN OCP parameters. More... | |
| struct | cy_stc_fault_vbus_scp_cfg_t |
| Config structure for VBUS SCP parameters. More... | |
| struct | cy_stc_fault_vin_uvp_ovp_cfg_t |
| Config structure for VIN UVP / OVP parameters. More... | |
| struct | cy_stc_fault_vbus_rcp_cfg_t |
| Config structure for VBUS RCP parameters. More... | |
| struct | cy_stc_fault_cc_ovp_cfg_t |
| Config structure for CC OVP parameters. More... | |
| struct | cy_stc_fault_sbu_ovp_cfg_t |
| Config structure for SBU OVP parameters. More... | |
| struct | cy_stc_legacy_charging_cfg_t |
| Struct to hold the port legacy charging parameters. More... | |
| struct | cy_stc_cable_comp_cfg_t |
| Config structure for Cable Compensation. More... | |
| struct | cy_stc_slow_discharge_cfg_t |
| Config structure for VBUS SLOW DISCHARGE. More... | |
| struct | cy_stc_trims_cfg_t |
| Structure for trim variables. More... | |
| struct | sensor_data_t |
| Struct to hold the sensor throttling settings. More... | |
| struct | cy_stc_buck_boost_cfg_t |
| Struct to hold the power parameters settings. More... | |
| struct | cy_stc_auto_cfg_settings_t |
| Struct to hold the automotive charger settings. More... | |
| struct | cy_stc_usbpd_config_t |
| Config structure for USBPD IP configuration. More... | |
| struct | cy_stc_usbpd_context_t |
| Context structure for USBPD-IP. More... | |
| union | cy_pd_pd_hdr_t |
| Union to hold the PD header defined by the USB-PD specification. More... | |
| struct | cy_pd_pd_hdr_t::PD_HDR |
| PD message header broken down into component fields. More... | |
| union | cy_pd_pd_do_t |
| Union to hold a PD data object. More... | |
| struct | cy_pd_pd_do_t::EPRMODE_DO |
| EPR Mode Data Object. More... | |
| struct | cy_pd_pd_do_t::ENTERUSB_VDO |
| Enter USB Data Object. More... | |
| struct | cy_pd_pd_do_t::DFP_VDO |
| DFP VDO. More... | |
| struct | cy_pd_pd_do_t::UFP_VDO_1 |
| UFP VDO #1. More... | |
| struct | cy_pd_pd_do_t::TBT_CBL_VDO |
| Thunderbolt Discover Modes Response Data Object. More... | |
| struct | cy_pd_pd_do_t::TBT_VDO |
| Thunderbolt Discover Modes Response Data Object. More... | |
| struct | cy_pd_pd_do_t::TBT_UFP_VDO |
| Thunderbolt UFP Discover Modes Response Data Object. More... | |
| struct | cy_pd_pd_do_t::ADO_ALERT |
| PD 3.0 Alert Data Object. More... | |
| struct | cy_pd_pd_do_t::RDO_SPR_AVS |
| SPR AVS Request Data Object. More... | |
| struct | cy_pd_pd_do_t::RDO_EPR_AVS |
| Programmable Request Data Object. More... | |
| struct | cy_pd_pd_do_t::EPR_AVS_SNK |
| Programmable Power Supply Sink PDO. More... | |
| struct | cy_pd_pd_do_t::SPR_AVS_SRC |
| SPR AVS Source PDO. More... | |
| struct | cy_pd_pd_do_t::EPR_AVS_SRC |
| Programmable Power Supply Source PDO. More... | |
| struct | cy_pd_pd_do_t::RDO_PPS |
| Programmable Request Data Object. More... | |
| struct | cy_pd_pd_do_t::PPS_SNK |
| Programmable Power Supply Sink PDO. More... | |
| struct | cy_pd_pd_do_t::PPS_SRC |
| Programmable Power Supply Source PDO. More... | |
| struct | cy_pd_pd_do_t::DP_CONFIG_VDO |
| DisplayPort configure VDO as defined by VESA spec. More... | |
| struct | cy_pd_pd_do_t::DP_STATUS_VDO |
| DisplayPort status update VDO as defined by VESA spec. More... | |
| struct | cy_pd_pd_do_t::DP_CBL_VDO |
| DisplayPort Mode Cable VDO as defined by VESA spec. More... | |
| struct | cy_pd_pd_do_t::STD_DP_VDO |
| DisplayPort Mode VDO as defined by VESA spec. More... | |
| struct | cy_pd_pd_do_t::CY_PD_STD_SVID_RESP_VDO |
| Discover_SVID response structure. More... | |
| struct | cy_pd_pd_do_t::STD_AMA_VDO_PD3 |
| AMA VDO structure as defined by PD 3.0. More... | |
| struct | cy_pd_pd_do_t::STD_AMA_VDO |
| AMA VDO structure as defined by PD 2.0. More... | |
| struct | cy_pd_pd_do_t::ACT_CBL_VDO_2 |
| Active Cable VDO 2 structure as defined by PD 3.0, Version 1.6. More... | |
| struct | cy_pd_pd_do_t::ACT_CBL_VDO_1 |
| Active Cable VDO 1 structure as defined by PD 3.0, Version 1.6. More... | |
| struct | cy_pd_pd_do_t::ACT_CBL_VDO |
| Active cable VDO structure as defined by PD 3.0. More... | |
| struct | cy_pd_pd_do_t::PAS_CBL_VDO |
| Passive cable VDO structure as defined by PD 3.0. More... | |
| struct | cy_pd_pd_do_t::STD_CBL_VDO |
| Cable VDO structure as defined in USB-PD r2.0. More... | |
| struct | cy_pd_pd_do_t::STD_PROD_VDO |
| Product VDO structure. More... | |
| struct | cy_pd_pd_do_t::STD_CERT_VDO |
| Cert Stat VDO structure. More... | |
| struct | cy_pd_pd_do_t::STD_VDM_ID_HDR |
| Structure representing a Standard ID_HEADER VDO. More... | |
| struct | cy_pd_pd_do_t::QC_PPS_DATA_VDO |
| Structure representing an Unstructured VDM data object as defined by QC 5.0/4.0 spec. More... | |
| struct | cy_pd_pd_do_t::USTD_QC_PPS_HDR |
| Structure representing an Unstructured VDM header data object as defined by QC 5.0/4.0 spec. More... | |
| struct | cy_pd_pd_do_t::USTD_VDM_HDR |
| Structure representing an Unstructured VDM header data object as defined by Infineon. More... | |
| struct | cy_pd_pd_do_t::STD_VDM_HDR |
| Structure representing a Structured VDM Header Data Object. More... | |
| struct | cy_pd_pd_do_t::RDO_GEN_GVB |
| Structure representing a Generic Request Data Object with GiveBack. More... | |
| struct | cy_pd_pd_do_t::RDO_GEN |
| Structure representing a generic Request Data Object. More... | |
| struct | cy_pd_pd_do_t::RDO_BAT_GIVEBACK |
| Structure representing a Battery Request Data Object with GiveBack. More... | |
| struct | cy_pd_pd_do_t::RDO_BAT |
| Structure representing a Battery Request Data Object. More... | |
| struct | cy_pd_pd_do_t::RDO_FIXED_VAR_GIVEBACK |
| Structure representing a Fixed or Variable Request Data Object with GiveBack. More... | |
| struct | cy_pd_pd_do_t::RDO_FIXED_VAR |
| Structure representing a Fixed or Variable Request Data Object. More... | |
| struct | cy_pd_pd_do_t::BAT_SNK |
| Structure representing a Battery Supply PDO - Sink. More... | |
| struct | cy_pd_pd_do_t::VAR_SNK |
| Structure representing a Variable Supply PDO - Sink. More... | |
| struct | cy_pd_pd_do_t::FIXED_SNK |
| Structure representing a Fixed Supply PDO - Sink. More... | |
| struct | cy_pd_pd_do_t::SRC_GEN |
| Structure representing a generic source PDO. More... | |
| struct | cy_pd_pd_do_t::BAT_SRC |
| Structure representing a Battery Supply PDO - Source. More... | |
| struct | cy_pd_pd_do_t::VAR_SRC |
| Structure representing a Variable Supply PDO - Source. More... | |
| struct | cy_pd_pd_do_t::FIXED_SRC |
| Structure representing a Fixed Supply PDO - Source. More... | |
| struct | cy_pd_pd_do_t::BIST_DO |
| Structure of a BIST data object. More... | |
| struct | cy_stc_pd_packet_extd_t |
| Structure to hold extended PD packets (messages). More... | |
| union | cy_pd_cc_state_t |
| Union to hold CC status. More... | |
| struct | cy_stc_pd_dpm_config_t |
| Structure to hold port dpm status variables which are common to the driver and stack. More... | |
Typedefs | |
| typedef void(* | cy_usbpd_supply_change_cbk_t) (void *context, cy_en_usbpd_supply_t supply_id, bool present) |
| Callback function used to provide notification about input supply changes. More... | |
| typedef void(* | cy_cb_usbpd_phy_handle_events_t) (void *context, cy_en_usbpd_phy_events_t event) |
| Notifies the PD stack about the occurrences of cy_en_usbpd_phy_events_t events. | |
| typedef void(* | cy_cb_usbpd_vbus_load_chg_t) (void *context) |
| Provides notification on VBUS load change. | |
| typedef bool(* | cy_cb_vbus_fault_t) (void *context, bool compOut) |
| VBus OVP/OCP/SCP/RCP protection callback function. More... | |
| typedef void(* | cy_cb_adc_events_t) (void *context, bool compOut) |
| ADC Events callback function. More... | |
| typedef void(* | cy_cb_sbu_level_detect_t) (void *context, bool sbu1Detect, bool sbu2Detect) |
| SBU level detected callback function. More... | |
| typedef void(* | cy_cb_usbpd_hpd_events_t) (void *context, cy_en_usbpd_hpd_events_t event) |
| HPD event callback function. More... | |
| typedef void(* | cy_cb_bc_phy_events_t) (void *context, uint32_t event) |
| Charger Detect PHY callback prototype. More... | |
| typedef uint8_t(* | cy_usbpd_evt_cbk_t) (void *context, cy_en_usbpd_events_t event, void *evtParam) |
| USBPD Driver events callback. More... | |
| typedef void(* | cy_usbpd_typec_evt_cbk_t) (void *context, cy_en_pd_typec_events_t event) |
| Type C Driver events callback. More... | |
| typedef void(* | cy_cable_comp_vbus_cur_cbk) (void *context, uint16_t vbus_cur) |
| Vbus current change callback prototype This is the function prototype for the Vbus current change callback. More... | |
| typedef void(* | cy_pd_cmp_cbk_t) (void *context, bool state) |
| Comparator interrupt callback function. More... | |
| typedef void(* | cy_timer_cbk_t) (cy_en_usbpd_timer_id_t id, void *callbackContext) |
| Timer callback function. More... | |
| typedef bool(* | cy_timer_start_t) (struct cy_stc_usbpd_context_t_ *context, void *callbackContext, cy_en_usbpd_timer_id_t id, uint16_t period, cy_timer_cbk_t cbk) |
| Timer Start callback function. More... | |
| typedef void(* | cy_timer_stop_t) (struct cy_stc_usbpd_context_t_ *context, cy_en_usbpd_timer_id_t id) |
| Timer Stop callback function. More... | |
| typedef bool(* | cy_timer_is_running_t) (struct cy_stc_usbpd_context_t_ *context, cy_en_usbpd_timer_id_t id) |
| Timer callback function. More... | |
| typedef uint16_t(* | cy_timer_get_multiplier_t) (struct cy_stc_usbpd_context_t_ *context) |
| Timer callback function. More... | |
| typedef void(* | cy_slow_discharge_t) (void *pdStackContext) |
| vbus_slow_discharge_cbk. More... | |
| typedef void(* | cy_vbus_cf_cbk_t) (void *pdStackContext, bool cf_state) |
| VBUS current foldback callback function. More... | |
| typedef cy_stc_pd_dpm_config_t *(* | cy_cb_pd_dpm_get_config_t) (void) |
| DPM configuration information retrieval callback. More... | |
| typedef void(* cy_usbpd_supply_change_cbk_t) (void *context, cy_en_usbpd_supply_t supply_id, bool present) |
Callback function used to provide notification about input supply changes.
| context | Pointer to the context structure. |
| supply_id | ID of the supply on which change is detected. |
| present | Whether the identified supply is now present (true) or absent (false). |
| typedef bool(* cy_cb_vbus_fault_t) (void *context, bool compOut) |
VBus OVP/OCP/SCP/RCP protection callback function.
| typedef void(* cy_cb_adc_events_t) (void *context, bool compOut) |
ADC Events callback function.
| typedef void(* cy_cb_sbu_level_detect_t) (void *context, bool sbu1Detect, bool sbu2Detect) |
SBU level detected callback function.
| typedef void(* cy_cb_usbpd_hpd_events_t) (void *context, cy_en_usbpd_hpd_events_t event) |
HPD event callback function.
This function is used by the HAL layer to notify the DisplayPort alternate mode layer about HPD related events that are detected.
| typedef void(* cy_cb_bc_phy_events_t) (void *context, uint32_t event) |
Charger Detect PHY callback prototype.
This function will be used to notify the stack about PHY events.
| context | USBPD PDL Context pointer. |
| event | Type of BC PHY event. |
| typedef uint8_t(* cy_usbpd_evt_cbk_t) (void *context, cy_en_usbpd_events_t event, void *evtParam) |
USBPD Driver events callback.
| context | USBPD PDL Context pointer. |
| event | cy_en_usbpd_events_t |
| evtParam | Data associated with the event |
| typedef void(* cy_usbpd_typec_evt_cbk_t) (void *context, cy_en_pd_typec_events_t event) |
Type C Driver events callback.
| context | Caller Context pointer. |
| event | cy_en_pd_typec_events_t |
| typedef void(* cy_cable_comp_vbus_cur_cbk) (void *context, uint16_t vbus_cur) |
Vbus current change callback prototype This is the function prototype for the Vbus current change callback.
Callback can be registered with the cable compensation through 'cable_comp_enable' function and the callback handler will be called on every comparator interrupt for the changing Vbus current level.
| port | Port index. |
| vbus_cur | Latest Vbus current in 10mA units |
| cy_pd_cmp_cbk_t |
Comparator interrupt callback function.
| port | PD port on which the event occurred. |
| state | State of the comparator. |
| cy_timer_cbk_t |
Timer callback function.
This callback function is invoked on timer expiry and should be treated as interrupt.
| cy_timer_start_t |
Timer Start callback function.
This callback function is invoked for timer start from driver.
| cy_timer_stop_t |
Timer Stop callback function.
This callback function is invoked for timer stop from driver.
| cy_timer_is_running_t |
Timer callback function.
This callback function is invoked to check if software timer is running from driver.
| cy_timer_get_multiplier_t |
Timer callback function.
This callback function is invoked to get timer multiplier count.
| cy_slow_discharge_t |
vbus_slow_discharge_cbk.
This callback function is invoked to call vbus_slow_discharge_cbk from driver.
| typedef void(* cy_vbus_cf_cbk_t) (void *pdStackContext, bool cf_state) |
VBUS current foldback callback function.
| pdStackContext | Caller context pointer. |
| cf_state | Current foldback state. |
| typedef cy_stc_pd_dpm_config_t*(* cy_cb_pd_dpm_get_config_t) (void) |
DPM configuration information retrieval callback.
This callback is used by the USBPD driver to get retrieve the dpm configuration required by the USBPD driver.
| None |