1 /* SPDX-License-Identifier: GPL-2.0 */
2 
3 #ifndef __DRIVER_USB_TYPEC_UCSI_H
4 #define __DRIVER_USB_TYPEC_UCSI_H
5 
6 #include <linux/bitops.h>
7 #include <linux/device.h>
8 #include <linux/power_supply.h>
9 #include <linux/types.h>
10 #include <linux/usb/typec.h>
11 #include <linux/usb/pd.h>
12 #include <linux/usb/role.h>
13 
14 /* -------------------------------------------------------------------------- */
15 
16 struct ucsi;
17 struct ucsi_altmode;
18 
19 /* UCSI offsets (Bytes) */
20 #define UCSI_VERSION			0
21 #define UCSI_CCI			4
22 #define UCSI_CONTROL			8
23 #define UCSI_MESSAGE_IN			16
24 #define UCSI_MESSAGE_OUT		32
25 
26 /* Command Status and Connector Change Indication (CCI) bits */
27 #define UCSI_CCI_CONNECTOR(_c_)		(((_c_) & GENMASK(7, 1)) >> 1)
28 #define UCSI_CCI_LENGTH(_c_)		(((_c_) & GENMASK(15, 8)) >> 8)
29 #define UCSI_CCI_NOT_SUPPORTED		BIT(25)
30 #define UCSI_CCI_CANCEL_COMPLETE	BIT(26)
31 #define UCSI_CCI_RESET_COMPLETE		BIT(27)
32 #define UCSI_CCI_BUSY			BIT(28)
33 #define UCSI_CCI_ACK_COMPLETE		BIT(29)
34 #define UCSI_CCI_ERROR			BIT(30)
35 #define UCSI_CCI_COMMAND_COMPLETE	BIT(31)
36 
37 /**
38  * struct ucsi_operations - UCSI I/O operations
39  * @read: Read operation
40  * @sync_write: Blocking write operation
41  * @async_write: Non-blocking write operation
42  * @update_altmodes: Squashes duplicate DP altmodes
43  *
44  * Read and write routines for UCSI interface. @sync_write must wait for the
45  * Command Completion Event from the PPM before returning, and @async_write must
46  * return immediately after sending the data to the PPM.
47  */
48 struct ucsi_operations {
49 	int (*read)(struct ucsi *ucsi, unsigned int offset,
50 		    void *val, size_t val_len);
51 	int (*sync_write)(struct ucsi *ucsi, unsigned int offset,
52 			  const void *val, size_t val_len);
53 	int (*async_write)(struct ucsi *ucsi, unsigned int offset,
54 			   const void *val, size_t val_len);
55 	bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig,
56 				struct ucsi_altmode *updated);
57 };
58 
59 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops);
60 void ucsi_destroy(struct ucsi *ucsi);
61 int ucsi_register(struct ucsi *ucsi);
62 void ucsi_unregister(struct ucsi *ucsi);
63 void *ucsi_get_drvdata(struct ucsi *ucsi);
64 void ucsi_set_drvdata(struct ucsi *ucsi, void *data);
65 
66 void ucsi_connector_change(struct ucsi *ucsi, u8 num);
67 
68 /* -------------------------------------------------------------------------- */
69 
70 /* Commands */
71 #define UCSI_PPM_RESET			0x01
72 #define UCSI_CANCEL			0x02
73 #define UCSI_CONNECTOR_RESET		0x03
74 #define UCSI_ACK_CC_CI			0x04
75 #define UCSI_SET_NOTIFICATION_ENABLE	0x05
76 #define UCSI_GET_CAPABILITY		0x06
77 #define UCSI_GET_CONNECTOR_CAPABILITY	0x07
78 #define UCSI_SET_UOM			0x08
79 #define UCSI_SET_UOR			0x09
80 #define UCSI_SET_PDM			0x0a
81 #define UCSI_SET_PDR			0x0b
82 #define UCSI_GET_ALTERNATE_MODES	0x0c
83 #define UCSI_GET_CAM_SUPPORTED		0x0d
84 #define UCSI_GET_CURRENT_CAM		0x0e
85 #define UCSI_SET_NEW_CAM		0x0f
86 #define UCSI_GET_PDOS			0x10
87 #define UCSI_GET_CABLE_PROPERTY		0x11
88 #define UCSI_GET_CONNECTOR_STATUS	0x12
89 #define UCSI_GET_ERROR_STATUS		0x13
90 
91 #define UCSI_CONNECTOR_NUMBER(_num_)		((u64)(_num_) << 16)
92 #define UCSI_COMMAND(_cmd_)			((_cmd_) & 0xff)
93 
94 /* CONNECTOR_RESET command bits */
95 #define UCSI_CONNECTOR_RESET_HARD		BIT(23) /* Deprecated in v1.1 */
96 
97 /* ACK_CC_CI bits */
98 #define UCSI_ACK_CONNECTOR_CHANGE		BIT(16)
99 #define UCSI_ACK_COMMAND_COMPLETE		BIT(17)
100 
101 /* SET_NOTIFICATION_ENABLE command bits */
102 #define UCSI_ENABLE_NTFY_CMD_COMPLETE		BIT(16)
103 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE	BIT(17)
104 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE	BIT(18)
105 #define UCSI_ENABLE_NTFY_CAP_CHANGE		BIT(21)
106 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE	BIT(22)
107 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE	BIT(23)
108 #define UCSI_ENABLE_NTFY_CAM_CHANGE		BIT(24)
109 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE	BIT(25)
110 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE		BIT(27)
111 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE		BIT(28)
112 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE	BIT(30)
113 #define UCSI_ENABLE_NTFY_ERROR			BIT(31)
114 #define UCSI_ENABLE_NTFY_ALL			0xdbe70000
115 
116 /* SET_UOR command bits */
117 #define UCSI_SET_UOR_ROLE(_r_)		(((_r_) == TYPEC_HOST ? 1 : 2) << 23)
118 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS		BIT(25)
119 
120 /* SET_PDF command bits */
121 #define UCSI_SET_PDR_ROLE(_r_)		(((_r_) == TYPEC_SOURCE ? 1 : 2) << 23)
122 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS		BIT(25)
123 
124 /* GET_ALTERNATE_MODES command bits */
125 #define UCSI_ALTMODE_RECIPIENT(_r_)		(((_r_) >> 16) & 0x7)
126 #define UCSI_GET_ALTMODE_RECIPIENT(_r_)		((u64)(_r_) << 16)
127 #define   UCSI_RECIPIENT_CON			0
128 #define   UCSI_RECIPIENT_SOP			1
129 #define   UCSI_RECIPIENT_SOP_P			2
130 #define   UCSI_RECIPIENT_SOP_PP			3
131 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_)	((u64)(_r_) << 24)
132 #define UCSI_ALTMODE_OFFSET(_r_)		(((_r_) >> 32) & 0xff)
133 #define UCSI_GET_ALTMODE_OFFSET(_r_)		((u64)(_r_) << 32)
134 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_)	((u64)(_r_) << 40)
135 
136 /* GET_PDOS command bits */
137 #define UCSI_GET_PDOS_PARTNER_PDO(_r_)		((u64)(_r_) << 23)
138 #define UCSI_GET_PDOS_PDO_OFFSET(_r_)		((u64)(_r_) << 24)
139 #define UCSI_GET_PDOS_NUM_PDOS(_r_)		((u64)(_r_) << 32)
140 #define UCSI_MAX_PDOS				(4)
141 #define UCSI_GET_PDOS_SRC_PDOS			((u64)1 << 34)
142 
143 /* -------------------------------------------------------------------------- */
144 
145 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
146 #define UCSI_ERROR_UNREGONIZED_CMD		BIT(0)
147 #define UCSI_ERROR_INVALID_CON_NUM		BIT(1)
148 #define UCSI_ERROR_INVALID_CMD_ARGUMENT		BIT(2)
149 #define UCSI_ERROR_INCOMPATIBLE_PARTNER		BIT(3)
150 #define UCSI_ERROR_CC_COMMUNICATION_ERR		BIT(4)
151 #define UCSI_ERROR_DEAD_BATTERY			BIT(5)
152 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL	BIT(6)
153 #define UCSI_ERROR_OVERCURRENT			BIT(7)
154 #define UCSI_ERROR_UNDEFINED			BIT(8)
155 #define UCSI_ERROR_PARTNER_REJECTED_SWAP	BIT(9)
156 #define UCSI_ERROR_HARD_RESET			BIT(10)
157 #define UCSI_ERROR_PPM_POLICY_CONFLICT		BIT(11)
158 #define UCSI_ERROR_SWAP_REJECTED		BIT(12)
159 
160 #define UCSI_SET_NEW_CAM_ENTER(x)		(((x) >> 23) & 0x1)
161 #define UCSI_SET_NEW_CAM_GET_AM(x)		(((x) >> 24) & 0xff)
162 #define UCSI_SET_NEW_CAM_AM_MASK		(0xff << 24)
163 #define UCSI_SET_NEW_CAM_SET_AM(x)		(((x) & 0xff) << 24)
164 #define UCSI_CMD_CONNECTOR_MASK			(0x7)
165 
166 /* Data structure filled by PPM in response to GET_CAPABILITY command. */
167 struct ucsi_capability {
168 	u32 attributes;
169 #define UCSI_CAP_ATTR_DISABLE_STATE		BIT(0)
170 #define UCSI_CAP_ATTR_BATTERY_CHARGING		BIT(1)
171 #define UCSI_CAP_ATTR_USB_PD			BIT(2)
172 #define UCSI_CAP_ATTR_TYPEC_CURRENT		BIT(6)
173 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY		BIT(8)
174 #define UCSI_CAP_ATTR_POWER_OTHER		BIT(10)
175 #define UCSI_CAP_ATTR_POWER_VBUS		BIT(14)
176 	u8 num_connectors;
177 	u8 features;
178 #define UCSI_CAP_SET_UOM			BIT(0)
179 #define UCSI_CAP_SET_PDM			BIT(1)
180 #define UCSI_CAP_ALT_MODE_DETAILS		BIT(2)
181 #define UCSI_CAP_ALT_MODE_OVERRIDE		BIT(3)
182 #define UCSI_CAP_PDO_DETAILS			BIT(4)
183 #define UCSI_CAP_CABLE_DETAILS			BIT(5)
184 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS	BIT(6)
185 #define UCSI_CAP_PD_RESET			BIT(7)
186 	u16 reserved_1;
187 	u8 num_alt_modes;
188 	u8 reserved_2;
189 	u16 bc_version;
190 	u16 pd_version;
191 	u16 typec_version;
192 } __packed;
193 
194 /* Data structure filled by PPM in response to GET_CONNECTOR_CAPABILITY cmd. */
195 struct ucsi_connector_capability {
196 	u8 op_mode;
197 #define UCSI_CONCAP_OPMODE_DFP			BIT(0)
198 #define UCSI_CONCAP_OPMODE_UFP			BIT(1)
199 #define UCSI_CONCAP_OPMODE_DRP			BIT(2)
200 #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY	BIT(3)
201 #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY	BIT(4)
202 #define UCSI_CONCAP_OPMODE_USB2			BIT(5)
203 #define UCSI_CONCAP_OPMODE_USB3			BIT(6)
204 #define UCSI_CONCAP_OPMODE_ALT_MODE		BIT(7)
205 	u8 flags;
206 #define UCSI_CONCAP_FLAG_PROVIDER		BIT(0)
207 #define UCSI_CONCAP_FLAG_CONSUMER		BIT(1)
208 } __packed;
209 
210 struct ucsi_altmode {
211 	u16 svid;
212 	u32 mid;
213 } __packed;
214 
215 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */
216 struct ucsi_cable_property {
217 	u16 speed_supported;
218 	u8 current_capability;
219 	u8 flags;
220 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE	BIT(0)
221 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE	BIT(1)
222 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY	BIT(2)
223 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_)	((_f_) & GENMASK(3, 0))
224 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_A	0
225 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_B	1
226 #define   UCSI_CABLE_PROPERTY_PLUG_TYPE_C	2
227 #define   UCSI_CABLE_PROPERTY_PLUG_OTHER	3
228 #define UCSI_CABLE_PROP_MODE_SUPPORT		BIT(5)
229 	u8 latency;
230 } __packed;
231 
232 /* Data structure filled by PPM in response to GET_CONNECTOR_STATUS command. */
233 struct ucsi_connector_status {
234 	u16 change;
235 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE		BIT(1)
236 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE	BIT(2)
237 #define UCSI_CONSTAT_PDOS_CHANGE		BIT(5)
238 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE		BIT(6)
239 #define UCSI_CONSTAT_PD_RESET_COMPLETE		BIT(7)
240 #define UCSI_CONSTAT_CAM_CHANGE			BIT(8)
241 #define UCSI_CONSTAT_BC_CHANGE			BIT(9)
242 #define UCSI_CONSTAT_PARTNER_CHANGE		BIT(11)
243 #define UCSI_CONSTAT_POWER_DIR_CHANGE		BIT(12)
244 #define UCSI_CONSTAT_CONNECT_CHANGE		BIT(14)
245 #define UCSI_CONSTAT_ERROR			BIT(15)
246 	u16 flags;
247 #define UCSI_CONSTAT_PWR_OPMODE(_f_)		((_f_) & GENMASK(2, 0))
248 #define   UCSI_CONSTAT_PWR_OPMODE_NONE		0
249 #define   UCSI_CONSTAT_PWR_OPMODE_DEFAULT	1
250 #define   UCSI_CONSTAT_PWR_OPMODE_BC		2
251 #define   UCSI_CONSTAT_PWR_OPMODE_PD		3
252 #define   UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5	4
253 #define   UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0	5
254 #define UCSI_CONSTAT_CONNECTED			BIT(3)
255 #define UCSI_CONSTAT_PWR_DIR			BIT(4)
256 #define UCSI_CONSTAT_PARTNER_FLAGS(_f_)		(((_f_) & GENMASK(12, 5)) >> 5)
257 #define   UCSI_CONSTAT_PARTNER_FLAG_USB		1
258 #define   UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE	2
259 #define UCSI_CONSTAT_PARTNER_TYPE(_f_)		(((_f_) & GENMASK(15, 13)) >> 13)
260 #define   UCSI_CONSTAT_PARTNER_TYPE_DFP		1
261 #define   UCSI_CONSTAT_PARTNER_TYPE_UFP		2
262 #define   UCSI_CONSTAT_PARTNER_TYPE_CABLE	3 /* Powered Cable */
263 #define   UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP	4 /* Powered Cable */
264 #define   UCSI_CONSTAT_PARTNER_TYPE_DEBUG	5
265 #define   UCSI_CONSTAT_PARTNER_TYPE_AUDIO	6
266 	u32 request_data_obj;
267 	u8 pwr_status;
268 #define UCSI_CONSTAT_BC_STATUS(_p_)		((_p_) & GENMASK(2, 0))
269 #define   UCSI_CONSTAT_BC_NOT_CHARGING		0
270 #define   UCSI_CONSTAT_BC_NOMINAL_CHARGING	1
271 #define   UCSI_CONSTAT_BC_SLOW_CHARGING		2
272 #define   UCSI_CONSTAT_BC_TRICKLE_CHARGING	3
273 #define UCSI_CONSTAT_PROVIDER_CAP_LIMIT(_p_)	(((_p_) & GENMASK(6, 3)) >> 3)
274 #define   UCSI_CONSTAT_CAP_PWR_LOWERED		0
275 #define   UCSI_CONSTAT_CAP_PWR_BUDGET_LIMIT	1
276 } __packed;
277 
278 /* -------------------------------------------------------------------------- */
279 
280 struct ucsi {
281 	u16 version;
282 	struct device *dev;
283 	struct driver_data *driver_data;
284 
285 	const struct ucsi_operations *ops;
286 
287 	struct ucsi_capability cap;
288 	struct ucsi_connector *connector;
289 
290 	struct delayed_work work;
291 	int work_count;
292 #define UCSI_ROLE_SWITCH_RETRY_PER_HZ	10
293 #define UCSI_ROLE_SWITCH_INTERVAL	(HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ)
294 #define UCSI_ROLE_SWITCH_WAIT_COUNT	(10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ)
295 
296 	/* PPM Communication lock */
297 	struct mutex ppm_lock;
298 
299 	/* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */
300 	u64 ntfy;
301 
302 	/* PPM communication flags */
303 	unsigned long flags;
304 #define EVENT_PENDING	0
305 #define COMMAND_PENDING	1
306 #define ACK_PENDING	2
307 };
308 
309 #define UCSI_MAX_SVID		5
310 #define UCSI_MAX_ALTMODES	(UCSI_MAX_SVID * 6)
311 
312 #define UCSI_TYPEC_VSAFE5V	5000
313 #define UCSI_TYPEC_1_5_CURRENT	1500
314 #define UCSI_TYPEC_3_0_CURRENT	3000
315 
316 struct ucsi_connector {
317 	int num;
318 
319 	struct ucsi *ucsi;
320 	struct mutex lock; /* port lock */
321 	struct work_struct work;
322 	struct completion complete;
323 	struct workqueue_struct *wq;
324 
325 	struct typec_port *port;
326 	struct typec_partner *partner;
327 
328 	struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES];
329 	struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES];
330 
331 	struct typec_capability typec_cap;
332 
333 	struct ucsi_connector_status status;
334 	struct ucsi_connector_capability cap;
335 	struct power_supply *psy;
336 	struct power_supply_desc psy_desc;
337 	u32 rdo;
338 	u32 src_pdos[PDO_MAX_OBJECTS];
339 	int num_pdos;
340 
341 	struct usb_role_switch *usb_role_sw;
342 };
343 
344 int ucsi_send_command(struct ucsi *ucsi, u64 command,
345 		      void *retval, size_t size);
346 
347 void ucsi_altmode_update_active(struct ucsi_connector *con);
348 int ucsi_resume(struct ucsi *ucsi);
349 
350 #if IS_ENABLED(CONFIG_POWER_SUPPLY)
351 int ucsi_register_port_psy(struct ucsi_connector *con);
352 void ucsi_unregister_port_psy(struct ucsi_connector *con);
353 void ucsi_port_psy_changed(struct ucsi_connector *con);
354 #else
ucsi_register_port_psy(struct ucsi_connector * con)355 static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; }
ucsi_unregister_port_psy(struct ucsi_connector * con)356 static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { }
ucsi_port_psy_changed(struct ucsi_connector * con)357 static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { }
358 #endif /* CONFIG_POWER_SUPPLY */
359 
360 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE)
361 struct typec_altmode *
362 ucsi_register_displayport(struct ucsi_connector *con,
363 			  bool override, int offset,
364 			  struct typec_altmode_desc *desc);
365 
366 void ucsi_displayport_remove_partner(struct typec_altmode *adev);
367 
368 #else
369 static inline struct typec_altmode *
ucsi_register_displayport(struct ucsi_connector * con,bool override,int offset,struct typec_altmode_desc * desc)370 ucsi_register_displayport(struct ucsi_connector *con,
371 			  bool override, int offset,
372 			  struct typec_altmode_desc *desc)
373 {
374 	return NULL;
375 }
376 
377 static inline void
ucsi_displayport_remove_partner(struct typec_altmode * adev)378 ucsi_displayport_remove_partner(struct typec_altmode *adev) { }
379 #endif /* CONFIG_TYPEC_DP_ALTMODE */
380 
381 /*
382  * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink
383  * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3
384  */
385 #define USB_TYPEC_NVIDIA_VLINK_DP_VDO	0x1
386 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO	0x3
387 
388 #endif /* __DRIVER_USB_TYPEC_UCSI_H */
389