1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright 2015-2017 Google, Inc
6 #ifndef __LINUX_USB_TCPM_H
7 #define __LINUX_USB_TCPM_H
9 #include <linux/bitops.h>
10 #include <linux/usb/typec.h>
13 enum typec_cc_status {
22 /* Collision Avoidance */
23 #define SINK_TX_NG TYPEC_CC_RP_1_5
24 #define SINK_TX_OK TYPEC_CC_RP_3_0
26 enum typec_cc_polarity {
31 /* Time to wait for TCPC to complete transmit */
32 #define PD_T_TCPC_TX_TIMEOUT 100 /* in ms */
33 #define PD_ROLE_SWAP_TIMEOUT (MSEC_PER_SEC * 10)
34 #define PD_PPS_CTRL_TIMEOUT (MSEC_PER_SEC * 10)
36 enum tcpm_transmit_status {
38 TCPC_TX_DISCARDED = 1,
42 enum tcpm_transmit_type {
44 TCPC_TX_SOP_PRIME = 1,
45 TCPC_TX_SOP_PRIME_PRIME = 2,
46 TCPC_TX_SOP_DEBUG_PRIME = 3,
47 TCPC_TX_SOP_DEBUG_PRIME_PRIME = 4,
48 TCPC_TX_HARD_RESET = 5,
49 TCPC_TX_CABLE_RESET = 6,
50 TCPC_TX_BIST_MODE_2 = 7
53 /* Mux state attributes */
54 #define TCPC_MUX_USB_ENABLED BIT(0) /* USB enabled */
55 #define TCPC_MUX_DP_ENABLED BIT(1) /* DP enabled */
56 #define TCPC_MUX_POLARITY_INVERTED BIT(2) /* Polarity inverted */
59 * struct tcpc_dev - Port configuration and callback functions
60 * @fwnode: Pointer to port fwnode
61 * @get_vbus: Called to read current VBUS state
63 * Optional; called by the tcpm core when configured as a snk
64 * and cc=Rp-def. This allows the tcpm to provide a fallback
65 * current-limit detection method for the cc=Rp-def case.
66 * For example, some tcpcs may include BC1.2 charger detection
67 * and use that in this case.
68 * @set_cc: Called to set value of CC pins
69 * @apply_rc: Optional; Needed to move TCPCI based chipset to APPLY_RC state
70 * as stated by the TCPCI specification.
71 * @get_cc: Called to read current CC pin values
73 * Called to set polarity
74 * @set_vconn: Called to enable or disable VCONN
75 * @set_vbus: Called to enable or disable VBUS
77 * Optional; called to set current limit as negotiated
79 * @set_pd_rx: Called to enable or disable reception of PD messages
80 * @set_roles: Called to set power and data roles
82 * Optional; if supported by hardware, called to start dual-role
83 * toggling or single-role connection detection. Toggling stops
84 * automatically if a connection is established.
85 * @try_role: Optional; called to set a preferred role
86 * @pd_transmit:Called to transmit PD message
87 * @set_bist_data: Turn on/off bist data mode for compliance testing
89 * Optional; Called to enable/disable PD 3.0 fast role swap.
90 * Enabling frs is accessory dependent as not all PD3.0
91 * accessories support fast role swap.
93 * Optional; Called to notify that vbus is now being sourced.
94 * Low level drivers can perform chip specific operations, if any.
95 * @enable_auto_vbus_discharge:
96 * Optional; TCPCI spec based TCPC implementations can optionally
97 * support hardware to autonomously dischrge vbus upon disconnecting
98 * as sink or source. TCPM signals TCPC to enable the mechanism upon
99 * entering connected state and signals disabling upon disconnect.
100 * @set_auto_vbus_discharge_threshold:
101 * Mandatory when enable_auto_vbus_discharge is implemented. TCPM
102 * calls this function to allow lower levels drivers to program the
103 * vbus threshold voltage below which the vbus discharge circuit
104 * will be turned on. requested_vbus_voltage is set to 0 when vbus
105 * is going to disappear knowingly i.e. during PR_SWAP and
108 * Optional; TCPCI spec based TCPC implementations are expected to
109 * detect VSAFE0V voltage level at vbus. When detection of VSAFE0V
110 * is supported by TCPC, set this callback for TCPM to query
111 * whether vbus is at VSAFE0V when needed.
112 * Returns true when vbus is at VSAFE0V, false otherwise.
113 * @set_partner_usb_comm_capable:
114 * Optional; The USB Communications Capable bit indicates if port
115 * partner is capable of communication over the USB data lines
116 * (e.g. D+/- or SS Tx/Rx). Called to notify the status of the bit.
119 struct fwnode_handle *fwnode;
121 int (*init)(struct tcpc_dev *dev);
122 int (*get_vbus)(struct tcpc_dev *dev);
123 int (*get_current_limit)(struct tcpc_dev *dev);
124 int (*set_cc)(struct tcpc_dev *dev, enum typec_cc_status cc);
125 int (*apply_rc)(struct tcpc_dev *dev, enum typec_cc_status cc,
126 enum typec_cc_polarity polarity);
127 int (*get_cc)(struct tcpc_dev *dev, enum typec_cc_status *cc1,
128 enum typec_cc_status *cc2);
129 int (*set_polarity)(struct tcpc_dev *dev,
130 enum typec_cc_polarity polarity);
131 int (*set_vconn)(struct tcpc_dev *dev, bool on);
132 int (*set_vbus)(struct tcpc_dev *dev, bool on, bool charge);
133 int (*set_current_limit)(struct tcpc_dev *dev, u32 max_ma, u32 mv);
134 int (*set_pd_rx)(struct tcpc_dev *dev, bool on);
135 int (*set_roles)(struct tcpc_dev *dev, bool attached,
136 enum typec_role role, enum typec_data_role data);
137 int (*start_toggling)(struct tcpc_dev *dev,
138 enum typec_port_type port_type,
139 enum typec_cc_status cc);
140 int (*try_role)(struct tcpc_dev *dev, int role);
141 int (*pd_transmit)(struct tcpc_dev *dev, enum tcpm_transmit_type type,
142 const struct pd_message *msg, unsigned int negotiated_rev);
143 int (*set_bist_data)(struct tcpc_dev *dev, bool on);
144 int (*enable_frs)(struct tcpc_dev *dev, bool enable);
145 void (*frs_sourcing_vbus)(struct tcpc_dev *dev);
146 int (*enable_auto_vbus_discharge)(struct tcpc_dev *dev, bool enable);
147 int (*set_auto_vbus_discharge_threshold)(struct tcpc_dev *dev, enum typec_pwr_opmode mode,
148 bool pps_active, u32 requested_vbus_voltage);
149 bool (*is_vbus_vsafe0v)(struct tcpc_dev *dev);
150 void (*set_partner_usb_comm_capable)(struct tcpc_dev *dev, bool enable);
155 struct tcpm_port *tcpm_register_port(struct device *dev, struct tcpc_dev *tcpc);
156 void tcpm_unregister_port(struct tcpm_port *port);
158 void tcpm_vbus_change(struct tcpm_port *port);
159 void tcpm_cc_change(struct tcpm_port *port);
160 void tcpm_sink_frs(struct tcpm_port *port);
161 void tcpm_sourcing_vbus(struct tcpm_port *port);
162 void tcpm_pd_receive(struct tcpm_port *port,
163 const struct pd_message *msg);
164 void tcpm_pd_transmit_complete(struct tcpm_port *port,
165 enum tcpm_transmit_status status);
166 void tcpm_pd_hard_reset(struct tcpm_port *port);
167 void tcpm_tcpc_reset(struct tcpm_port *port);
169 #endif /* __LINUX_USB_TCPM_H */