xref: /openbmc/linux/include/linux/usb/tcpm.h (revision 599f008c)
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3  * Copyright 2015-2017 Google, Inc
4  */
5 
6 #ifndef __LINUX_USB_TCPM_H
7 #define __LINUX_USB_TCPM_H
8 
9 #include <linux/bitops.h>
10 #include <linux/usb/typec.h>
11 #include "pd.h"
12 
13 enum typec_cc_status {
14 	TYPEC_CC_OPEN,
15 	TYPEC_CC_RA,
16 	TYPEC_CC_RD,
17 	TYPEC_CC_RP_DEF,
18 	TYPEC_CC_RP_1_5,
19 	TYPEC_CC_RP_3_0,
20 };
21 
22 /* Collision Avoidance */
23 #define SINK_TX_NG	TYPEC_CC_RP_1_5
24 #define SINK_TX_OK	TYPEC_CC_RP_3_0
25 
26 enum typec_cc_polarity {
27 	TYPEC_POLARITY_CC1,
28 	TYPEC_POLARITY_CC2,
29 };
30 
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)
35 
36 enum tcpm_transmit_status {
37 	TCPC_TX_SUCCESS = 0,
38 	TCPC_TX_DISCARDED = 1,
39 	TCPC_TX_FAILED = 2,
40 };
41 
42 enum tcpm_transmit_type {
43 	TCPC_TX_SOP = 0,
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
51 };
52 
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 */
57 
58 /**
59  * struct tcpc_dev - Port configuration and callback functions
60  * @fwnode:	Pointer to port fwnode
61  * @get_vbus:	Called to read current VBUS state
62  * @get_current_limit:
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
72  * @set_polarity:
73  *		Called to set polarity
74  * @set_vconn:	Called to enable or disable VCONN
75  * @set_vbus:	Called to enable or disable VBUS
76  * @set_current_limit:
77  *		Optional; called to set current limit as negotiated
78  *		with partner.
79  * @set_pd_rx:	Called to enable or disable reception of PD messages
80  * @set_roles:	Called to set power and data roles
81  * @start_toggling:
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
88  * @enable_frs:
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.
92  * @frs_sourcing_vbus:
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
106  *		HARD_RESET etc.
107  * @is_vbus_vsafe0v:
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.
117  * @check_contaminant:
118  *		Optional; The callback is called when CC pins report open status
119  *		at the end of the deboumce period or when the port is still
120  *		toggling. Chip level drivers are expected to check for contaminant
121  *		and call tcpm_clean_port when the port is clean.
122  */
123 struct tcpc_dev {
124 	struct fwnode_handle *fwnode;
125 
126 	int (*init)(struct tcpc_dev *dev);
127 	int (*get_vbus)(struct tcpc_dev *dev);
128 	int (*get_current_limit)(struct tcpc_dev *dev);
129 	int (*set_cc)(struct tcpc_dev *dev, enum typec_cc_status cc);
130 	int (*apply_rc)(struct tcpc_dev *dev, enum typec_cc_status cc,
131 			enum typec_cc_polarity polarity);
132 	int (*get_cc)(struct tcpc_dev *dev, enum typec_cc_status *cc1,
133 		      enum typec_cc_status *cc2);
134 	int (*set_polarity)(struct tcpc_dev *dev,
135 			    enum typec_cc_polarity polarity);
136 	int (*set_vconn)(struct tcpc_dev *dev, bool on);
137 	int (*set_vbus)(struct tcpc_dev *dev, bool on, bool charge);
138 	int (*set_current_limit)(struct tcpc_dev *dev, u32 max_ma, u32 mv);
139 	int (*set_pd_rx)(struct tcpc_dev *dev, bool on);
140 	int (*set_roles)(struct tcpc_dev *dev, bool attached,
141 			 enum typec_role role, enum typec_data_role data);
142 	int (*start_toggling)(struct tcpc_dev *dev,
143 			      enum typec_port_type port_type,
144 			      enum typec_cc_status cc);
145 	int (*try_role)(struct tcpc_dev *dev, int role);
146 	int (*pd_transmit)(struct tcpc_dev *dev, enum tcpm_transmit_type type,
147 			   const struct pd_message *msg, unsigned int negotiated_rev);
148 	int (*set_bist_data)(struct tcpc_dev *dev, bool on);
149 	int (*enable_frs)(struct tcpc_dev *dev, bool enable);
150 	void (*frs_sourcing_vbus)(struct tcpc_dev *dev);
151 	int (*enable_auto_vbus_discharge)(struct tcpc_dev *dev, bool enable);
152 	int (*set_auto_vbus_discharge_threshold)(struct tcpc_dev *dev, enum typec_pwr_opmode mode,
153 						 bool pps_active, u32 requested_vbus_voltage);
154 	bool (*is_vbus_vsafe0v)(struct tcpc_dev *dev);
155 	void (*set_partner_usb_comm_capable)(struct tcpc_dev *dev, bool enable);
156 	void (*check_contaminant)(struct tcpc_dev *dev);
157 };
158 
159 struct tcpm_port;
160 
161 struct tcpm_port *tcpm_register_port(struct device *dev, struct tcpc_dev *tcpc);
162 void tcpm_unregister_port(struct tcpm_port *port);
163 
164 void tcpm_vbus_change(struct tcpm_port *port);
165 void tcpm_cc_change(struct tcpm_port *port);
166 void tcpm_sink_frs(struct tcpm_port *port);
167 void tcpm_sourcing_vbus(struct tcpm_port *port);
168 void tcpm_pd_receive(struct tcpm_port *port,
169 		     const struct pd_message *msg);
170 void tcpm_pd_transmit_complete(struct tcpm_port *port,
171 			       enum tcpm_transmit_status status);
172 void tcpm_pd_hard_reset(struct tcpm_port *port);
173 void tcpm_tcpc_reset(struct tcpm_port *port);
174 void tcpm_port_clean(struct tcpm_port *port);
175 bool tcpm_port_is_toggling(struct tcpm_port *port);
176 
177 #endif /* __LINUX_USB_TCPM_H */
178