Zephyr Project API 4.4.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
tcpc_driver_api Struct Reference

@driver_ops{USB Type-C Port Controller} More...

#include <usbc_tcpc.h>

Data Fields

tcpc_api_init_t init
 @driver_ops_mandatory Initializes the TCPC.
tcpc_api_get_cc_t get_cc
 @driver_ops_optional Reads the status of the CC lines.
tcpc_api_select_rp_value_t select_rp_value
 @driver_ops_optional Sets the value of CC pull up resistor used when operating as a Source.
tcpc_api_get_rp_value_t get_rp_value
 @driver_ops_optional Gets the value of the CC pull up resistor used when operating as a Source.
tcpc_api_set_cc_t set_cc
 @driver_ops_mandatory Sets the CC pull resistor and sets the role as either Source or Sink.
tcpc_api_set_vconn_discharge_cb_t set_vconn_discharge_cb
 @driver_ops_mandatory Sets a callback that can enable or discharge VCONN if the TCPC is unable to or the system is configured in a way that does not use the VCONN control capabilities of the TCPC.
tcpc_api_set_vconn_cb_t set_vconn_cb
 @driver_ops_mandatory Sets a callback that can enable or disable VCONN if the TCPC is unable to or the system is configured in a way that does not use the VCONN control capabilities of the TCPC.
tcpc_api_vconn_discharge_t vconn_discharge
 @driver_ops_optional Discharges VCONN.
tcpc_api_set_vconn_t set_vconn
 @driver_ops_optional Enables or disables VCONN.
tcpc_api_set_roles_t set_roles
 @driver_ops_optional Sets the Power and Data Role of the PD message header.
tcpc_api_get_rx_pending_msg_t get_rx_pending_msg
 @driver_ops_mandatory Retrieves the Power Delivery message from the TCPC.
tcpc_api_set_rx_enable_t set_rx_enable
 @driver_ops_optional Enables the reception of SOP* message types.
tcpc_api_set_cc_polarity_t set_cc_polarity
 @driver_ops_mandatory Sets the polarity of the CC lines.
tcpc_api_transmit_data_t transmit_data
 @driver_ops_optional Transmits a Power Delivery message.
tcpc_api_dump_std_reg_t dump_std_reg
 @driver_ops_optional Dump a set of TCPC registers.
tcpc_api_get_status_register_t get_status_register
 @driver_ops_optional Gets a status register.
tcpc_api_clear_status_register_t clear_status_register
 @driver_ops_optional Clears a TCPC status register.
tcpc_api_mask_status_register_t mask_status_register
 @driver_ops_optional Sets the mask of a TCPC status register.
tcpc_api_set_debug_accessory_t set_debug_accessory
 @driver_ops_optional Manual control of TCPC DebugAccessory control.
tcpc_api_set_debug_detach_t set_debug_detach
 @driver_ops_optional Detach from a debug connection.
tcpc_api_set_drp_toggle_t set_drp_toggle
 @driver_ops_optional Enable TCPC auto dual role toggle.
tcpc_api_get_snk_ctrl_t get_snk_ctrl
 @driver_ops_optional Queries the current sinking state of the TCPC.
tcpc_api_set_snk_ctrl_t set_snk_ctrl
 @driver_ops_optional Set the VBUS sinking state of the TCPC.
tcpc_api_get_src_ctrl_t get_src_ctrl
 @driver_ops_optional Queries the current sourcing state of the TCPC.
tcpc_api_set_src_ctrl_t set_src_ctrl
 @driver_ops_optional Set the VBUS sourcing state of the TCPC.
tcpc_api_get_chip_info_t get_chip_info
 @driver_ops_optional Gets the TCPC firmware version.
tcpc_api_set_low_power_mode_t set_low_power_mode
 @driver_ops_optional Instructs the TCPC to enter or exit low power mode.
tcpc_api_sop_prime_enable_t sop_prime_enable
 @driver_ops_optional Enables the reception of SOP Prime and optionally SOP Double Prime messages.
tcpc_api_set_bist_test_mode_t set_bist_test_mode
 @driver_ops_optional Controls the BIST Mode of the TCPC.
tcpc_api_set_alert_handler_cb_t set_alert_handler_cb
 @driver_ops_mandatory Sets the alert function that's called when an interrupt is triggered due to an alert bit.

Detailed Description

@driver_ops{USB Type-C Port Controller}

Field Documentation

◆ clear_status_register

tcpc_api_clear_status_register_t tcpc_driver_api::clear_status_register

@driver_ops_optional Clears a TCPC status register.

◆ dump_std_reg

tcpc_api_dump_std_reg_t tcpc_driver_api::dump_std_reg

@driver_ops_optional Dump a set of TCPC registers.

◆ get_cc

tcpc_api_get_cc_t tcpc_driver_api::get_cc

@driver_ops_optional Reads the status of the CC lines.

◆ get_chip_info

tcpc_api_get_chip_info_t tcpc_driver_api::get_chip_info

@driver_ops_optional Gets the TCPC firmware version.

◆ get_rp_value

tcpc_api_get_rp_value_t tcpc_driver_api::get_rp_value

@driver_ops_optional Gets the value of the CC pull up resistor used when operating as a Source.

◆ get_rx_pending_msg

tcpc_api_get_rx_pending_msg_t tcpc_driver_api::get_rx_pending_msg

@driver_ops_mandatory Retrieves the Power Delivery message from the TCPC.

◆ get_snk_ctrl

tcpc_api_get_snk_ctrl_t tcpc_driver_api::get_snk_ctrl

@driver_ops_optional Queries the current sinking state of the TCPC.

◆ get_src_ctrl

tcpc_api_get_src_ctrl_t tcpc_driver_api::get_src_ctrl

@driver_ops_optional Queries the current sourcing state of the TCPC.

◆ get_status_register

tcpc_api_get_status_register_t tcpc_driver_api::get_status_register

@driver_ops_optional Gets a status register.

◆ init

tcpc_api_init_t tcpc_driver_api::init

@driver_ops_mandatory Initializes the TCPC.

◆ mask_status_register

tcpc_api_mask_status_register_t tcpc_driver_api::mask_status_register

@driver_ops_optional Sets the mask of a TCPC status register.

◆ select_rp_value

tcpc_api_select_rp_value_t tcpc_driver_api::select_rp_value

@driver_ops_optional Sets the value of CC pull up resistor used when operating as a Source.

◆ set_alert_handler_cb

tcpc_api_set_alert_handler_cb_t tcpc_driver_api::set_alert_handler_cb

@driver_ops_mandatory Sets the alert function that's called when an interrupt is triggered due to an alert bit.

◆ set_bist_test_mode

tcpc_api_set_bist_test_mode_t tcpc_driver_api::set_bist_test_mode

@driver_ops_optional Controls the BIST Mode of the TCPC.

◆ set_cc

tcpc_api_set_cc_t tcpc_driver_api::set_cc

@driver_ops_mandatory Sets the CC pull resistor and sets the role as either Source or Sink.

◆ set_cc_polarity

tcpc_api_set_cc_polarity_t tcpc_driver_api::set_cc_polarity

@driver_ops_mandatory Sets the polarity of the CC lines.

◆ set_debug_accessory

tcpc_api_set_debug_accessory_t tcpc_driver_api::set_debug_accessory

@driver_ops_optional Manual control of TCPC DebugAccessory control.

◆ set_debug_detach

tcpc_api_set_debug_detach_t tcpc_driver_api::set_debug_detach

@driver_ops_optional Detach from a debug connection.

◆ set_drp_toggle

tcpc_api_set_drp_toggle_t tcpc_driver_api::set_drp_toggle

@driver_ops_optional Enable TCPC auto dual role toggle.

◆ set_low_power_mode

tcpc_api_set_low_power_mode_t tcpc_driver_api::set_low_power_mode

@driver_ops_optional Instructs the TCPC to enter or exit low power mode.

◆ set_roles

tcpc_api_set_roles_t tcpc_driver_api::set_roles

@driver_ops_optional Sets the Power and Data Role of the PD message header.

◆ set_rx_enable

tcpc_api_set_rx_enable_t tcpc_driver_api::set_rx_enable

@driver_ops_optional Enables the reception of SOP* message types.

◆ set_snk_ctrl

tcpc_api_set_snk_ctrl_t tcpc_driver_api::set_snk_ctrl

@driver_ops_optional Set the VBUS sinking state of the TCPC.

◆ set_src_ctrl

tcpc_api_set_src_ctrl_t tcpc_driver_api::set_src_ctrl

@driver_ops_optional Set the VBUS sourcing state of the TCPC.

◆ set_vconn

tcpc_api_set_vconn_t tcpc_driver_api::set_vconn

@driver_ops_optional Enables or disables VCONN.

◆ set_vconn_cb

tcpc_api_set_vconn_cb_t tcpc_driver_api::set_vconn_cb

@driver_ops_mandatory Sets a callback that can enable or disable VCONN if the TCPC is unable to or the system is configured in a way that does not use the VCONN control capabilities of the TCPC.

◆ set_vconn_discharge_cb

tcpc_api_set_vconn_discharge_cb_t tcpc_driver_api::set_vconn_discharge_cb

@driver_ops_mandatory Sets a callback that can enable or discharge VCONN if the TCPC is unable to or the system is configured in a way that does not use the VCONN control capabilities of the TCPC.

◆ sop_prime_enable

tcpc_api_sop_prime_enable_t tcpc_driver_api::sop_prime_enable

@driver_ops_optional Enables the reception of SOP Prime and optionally SOP Double Prime messages.

◆ transmit_data

tcpc_api_transmit_data_t tcpc_driver_api::transmit_data

@driver_ops_optional Transmits a Power Delivery message.

◆ vconn_discharge

tcpc_api_vconn_discharge_t tcpc_driver_api::vconn_discharge

@driver_ops_optional Discharges VCONN.


The documentation for this struct was generated from the following file: