Zephyr API Documentation 4.0.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
usbc_tc.h File Reference

USB Type-C Cable and Connector API used for USB-C drivers. More...

#include <zephyr/types.h>

Go to the source code of this file.

Macros

#define TC_V_SINK_DISCONNECT_MIN_MV   800
 VBUS minimum for a sink disconnect detection.
 
#define TC_V_SINK_DISCONNECT_MAX_MV   3670
 VBUS maximum for a sink disconnect detection.
 
#define TC_T_VBUS_ON_MAX_MS   275
 From entry to Attached.SRC until VBUS reaches the minimum vSafe5V threshold as measured at the source’s receptacle See Table 4-29 VBUS and VCONN Timing Parameters.
 
#define TC_T_VBUS_OFF_MAX_MS   650
 From the time the Sink is detached until the Source removes VBUS and reaches vSafe0V (See USB PD).
 
#define TC_T_VCONN_ON_MAX_MS   2
 From the time the Source supplied VBUS in the Attached.SRC state.
 
#define TC_T_VCONN_ON_PA_MAX_MS   100
 From the time a Sink with accessory support enters the PoweredAccessory state until the Sink sources minimum VCONN voltage (see Table 4-5) See Table 4-29 VBUS and VCONN Timing Parameters.
 
#define TC_T_VCONN_OFF_MAX_MS   35
 From the time that a Sink is detached or as directed until the VCONN supply is disconnected.
 
#define TC_T_SINK_ADJ_MAX_MS   60
 Response time for a Sink to adjust its current consumption to be in the specified range due to a change in USB Type-C Current advertisement See Table 4-29 VBUS and VCONN Timing Parameters.
 
#define TC_T_DRP_MIN_MS   50
 The minimum period a DRP shall complete a Source to Sink and back advertisement See Table 4-30 DRP Timing Parameters.
 
#define TC_T_DRP_MAX_MS   100
 The maximum period a DRP shall complete a Source to Sink and back advertisement See Table 4-30 DRP Timing Parameters.
 
#define TC_T_DRP_TRANSITION_MIN_MS   0
 The minimum time a DRP shall complete transitions between Source and Sink roles during role resolution See Table 4-30 DRP Timing Parameters.
 
#define TC_T_DRP_TRANSITION_MAX_MS   1
 The maximum time a DRP shall complete transitions between Source and Sink roles during role resolution See Table 4-30 DRP Timing Parameters.
 
#define TC_T_DRP_TRY_MIN_MS   75
 Minimum wait time associated with the Try.SRC state.
 
#define TC_T_DRP_TRY_MAX_MS   150
 Maximum wait time associated with the Try.SRC state.
 
#define TC_T_DRP_TRY_WAIT_MIN_MS   400
 Minimum wait time associated with the Try.SNK state.
 
#define TC_T_DRP_TRY_WAIT_MAX_MS   800
 Maximum wait time associated with the Try.SNK state.
 
#define TC_T_TRY_TIMEOUT_MIN_MS   550
 Minimum timeout for transition from Try.SRC to TryWait.SNK.
 
#define TC_T_TRY_TIMEOUT_MAX_MS   1100
 Maximum timeout for transition from Try.SRC to TryWait.SNK.
 
#define TC_T_VPD_DETACH_MIN_MS   10
 Minimum Time for a DRP to detect that the connected Charge-Through VCONNPowered USB Device has been detached, after VBUS has been removed.
 
#define TC_T_VPD_DETACH_MAX_MS   20
 Maximum Time for a DRP to detect that the connected Charge-Through VCONNPowered USB Device has been detached, after VBUS has been removed.
 
#define TC_T_CC_DEBOUNCE_MIN_MS   100
 Minimum time a port shall wait before it can determine it is attached See Table 4-31 CC Timing.
 
#define TC_T_CC_DEBOUNCE_MAX_MS   200
 Maximum time a port shall wait before it can determine it is attached See Table 4-31 CC Timing.
 
#define TC_T_PD_DEBOUNCE_MIN_MS   10
 Minimum time a Sink port shall wait before it can determine it is detached due to the potential for USB PD signaling on CC as described in the state definitions.
 
#define TC_T_PD_DEBOUNCE_MAX_MS   20
 Maximum time a Sink port shall wait before it can determine it is detached due to the potential for USB PD signaling on CC as described in the state definitions.
 
#define TC_T_TRY_CC_DEBOUNCE_MIN_MS   10
 Minimum Time a port shall wait before it can determine it is re-attached during the try-wait process.
 
#define TC_T_TRY_CC_DEBOUNCE_MAX_MS   10
 Maximum Time a port shall wait before it can determine it is re-attached during the try-wait process.
 
#define TC_T_ERROR_RECOVERY_SELF_POWERED_MIN_MS   25
 Minimum time a self-powered port shall remain in the ErrorRecovery state.
 
#define TC_T_ERROR_RECOVERY_SOURCE_MIN_MS   240
 Minimum time a source shall remain in the ErrorRecovery state if it was sourcing VCONN in the previous state.
 
#define TC_T_RP_VALUE_CHANGE_MIN_MS   10
 Minimum time a Sink port shall wait before it can determine there has been a change in Rp where CC is not BMC Idle or the port is unable to detect BMC Idle.
 
#define TC_T_RP_VALUE_CHANGE_MAX_MS   20
 Maximum time a Sink port shall wait before it can determine there has been a change in Rp where CC is not BMC Idle or the port is unable to detect BMC Idle.
 
#define TC_T_SRC_DISCONNECT_MIN_MS   0
 Minimum time a Source shall detect the SRC.Open state.
 
#define TC_T_SRC_DISCONNECT_MAX_MS   20
 Maximum time a Source shall detect the SRC.Open state.
 
#define TC_T_NO_TOGGLE_CONNECT_MIN_MS   0
 Minimum time to detect connection when neither Port Partner is toggling.
 
#define TC_T_NO_TOGGLE_CONNECT_MAX_MS   5
 Maximum time to detect connection when neither Port Partner is toggling.
 
#define TC_T_ONE_PORT_TOGGLE_CONNECT_MIN_MS   0
 Minimum time to detect connection when one Port Partner is toggling 0ms … dcSRC.DRP max * tDRP max + 2 * tNoToggleConnect).
 
#define TC_T_ONE_PORT_TOGGLE_CONNECT_MAX_MS   80
 Maximum time to detect connection when one Port Partner is toggling 0ms … dcSRC.DRP max * tDRP max + 2 * tNoToggleConnect).
 
#define TC_T_TWO_PORT_TOGGLE_CONNECT_MIN_MS   0
 Minimum time to detect connection when both Port Partners are toggling (0ms … 5 * tDRP max + 2 * tNoToggleConnect).
 
#define TC_T_TWO_PORT_TOGGLE_CONNECT_MAX_MS   510
 Maximum time to detect connection when both Port Partners are toggling (0ms … 5 * tDRP max + 2 * tNoToggleConnect).
 
#define TC_T_VPDCTDD_MIN_US   30
 Minimum time for a Charge-Through VCONN-Powered USB Device to detect that the Charge-Through source has disconnected from CC after VBUS has been removed, transition to CTUnattached.VPD, and re-apply its Rp termination advertising 3.0 A on the host port CC.
 
#define TC_T_VPDCTDD_MAX_MS   5
 Maximum time for a Charge-Through VCONN-Powered USB Device to detect that the Charge-Through source has disconnected from CC after VBUS has been removed, transition to CTUnattached.VPD, and re-apply its Rp termination advertising 3.0 A on the host port CC.
 
#define TC_T_VPDDISABLE_MIN_MS   25
 Minimum time for a Charge-Through VCONN-Powered USB Device shall remain in CTDisabled.VPD state.
 

Enumerations

enum  tc_cc_voltage_state {
  TC_CC_VOLT_OPEN = 0 , TC_CC_VOLT_RA = 1 , TC_CC_VOLT_RD = 2 , TC_CC_VOLT_RP_DEF = 5 ,
  TC_CC_VOLT_RP_1A5 = 6 , TC_CC_VOLT_RP_3A0 = 7
}
 CC Voltage status. More...
 
enum  tc_vbus_level { TC_VBUS_SAFE0V = 0 , TC_VBUS_PRESENT = 1 , TC_VBUS_REMOVED = 2 }
 VBUS level voltages. More...
 
enum  tc_rp_value { TC_RP_USB = 0 , TC_RP_1A5 = 1 , TC_RP_3A0 = 2 , TC_RP_RESERVED = 3 }
 Pull-Up resistor values. More...
 
enum  tc_cc_pull {
  TC_CC_RA = 0 , TC_CC_RP = 1 , TC_CC_RD = 2 , TC_CC_OPEN = 3 ,
  TC_RA_RD = 4
}
 CC pull resistors. More...
 
enum  tc_cable_plug { PD_PLUG_FROM_DFP_UFP = 0 , PD_PLUG_FROM_CABLE_VPD = 1 }
 Cable plug. More...
 
enum  tc_power_role { TC_ROLE_SINK = 0 , TC_ROLE_SOURCE = 1 }
 Power Delivery Power Role. More...
 
enum  tc_data_role { TC_ROLE_UFP = 0 , TC_ROLE_DFP = 1 , TC_ROLE_DISCONNECTED = 2 }
 Power Delivery Data Role. More...
 
enum  tc_cc_polarity { TC_POLARITY_CC1 = 0 , TC_POLARITY_CC2 = 1 }
 Polarity of the CC lines. More...
 
enum  tc_cc_states {
  TC_CC_NONE = 0 , TC_CC_UFP_NONE = 1 , TC_CC_UFP_AUDIO_ACC = 2 , TC_CC_UFP_DEBUG_ACC = 3 ,
  TC_CC_UFP_ATTACHED = 4 , TC_CC_DFP_ATTACHED = 5 , TC_CC_DFP_DEBUG_ACC = 6
}
 Possible port partner connections based on CC line states. More...
 

Detailed Description

USB Type-C Cable and Connector API used for USB-C drivers.

The information in this file was taken from the USB Type-C Cable and Connector Specification Release 2.1