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/completion.h>
8 #include <linux/device.h>
9 #include <linux/power_supply.h>
10 #include <linux/types.h>
11 #include <linux/usb/typec.h>
12 #include <linux/usb/pd.h>
13 #include <linux/usb/role.h>
14 #include <linux/unaligned.h>
15
16 /* -------------------------------------------------------------------------- */
17
18 struct ucsi;
19 struct ucsi_altmode;
20 struct ucsi_connector;
21 struct dentry;
22
23 /* UCSI offsets (Bytes) */
24 #define UCSI_VERSION 0
25 #define UCSI_CCI 4
26 #define UCSI_CONTROL 8
27 #define UCSI_MESSAGE_IN 16
28 #define UCSI_MESSAGE_OUT 32
29 #define UCSIv2_MESSAGE_OUT 272
30
31 /* UCSI versions */
32 #define UCSI_VERSION_1_1 0x0110
33 #define UCSI_VERSION_1_2 0x0120
34 #define UCSI_VERSION_2_0 0x0200
35 #define UCSI_VERSION_2_1 0x0210
36 #define UCSI_VERSION_3_0 0x0300
37
38 #define UCSI_BCD_GET_MAJOR(_v_) (((_v_) >> 8) & 0xFF)
39 #define UCSI_BCD_GET_MINOR(_v_) (((_v_) >> 4) & 0x0F)
40 #define UCSI_BCD_GET_SUBMINOR(_v_) ((_v_) & 0x0F)
41
42 /*
43 * Per USB PD 3.2, Section 6.2.1.1.5, the spec revision is represented by 2 bits
44 * 0b00 = 1.0, 0b01 = 2.0, 0b10 = 3.0, 0b11 = Reserved, Shall NOT be used.
45 */
46 #define UCSI_SPEC_REVISION_TO_BCD(_v_) (((_v_) + 1) << 8)
47
48 /* Command Status and Connector Change Indication (CCI) bits */
49 #define UCSI_CCI_CONNECTOR(_c_) (((_c_) & GENMASK(7, 1)) >> 1)
50 #define UCSI_CCI_LENGTH(_c_) (((_c_) & GENMASK(15, 8)) >> 8)
51 #define UCSI_CCI_NOT_SUPPORTED BIT(25)
52 #define UCSI_CCI_CANCEL_COMPLETE BIT(26)
53 #define UCSI_CCI_RESET_COMPLETE BIT(27)
54 #define UCSI_CCI_BUSY BIT(28)
55 #define UCSI_CCI_ACK_COMPLETE BIT(29)
56 #define UCSI_CCI_ERROR BIT(30)
57 #define UCSI_CCI_COMMAND_COMPLETE BIT(31)
58
59 /**
60 * struct ucsi_operations - UCSI I/O operations
61 * @read_version: Read implemented UCSI version
62 * @read_cci: Read CCI register
63 * @poll_cci: Read CCI register while polling with notifications disabled
64 * @read_message_in: Read message data from UCSI
65 * @sync_control: Blocking control operation
66 * @async_control: Non-blocking control operation
67 * @update_altmodes: Squashes duplicate DP altmodes
68 * @update_connector: Update connector capabilities before registering
69 * @connector_status: Updates connector status, called holding connector lock
70 *
71 * Read and write routines for UCSI interface. @sync_write must wait for the
72 * Command Completion Event from the PPM before returning, and @async_write must
73 * return immediately after sending the data to the PPM.
74 */
75 struct ucsi_operations {
76 int (*read_version)(struct ucsi *ucsi, u16 *version);
77 int (*read_cci)(struct ucsi *ucsi, u32 *cci);
78 int (*poll_cci)(struct ucsi *ucsi, u32 *cci);
79 int (*read_message_in)(struct ucsi *ucsi, void *val, size_t val_len);
80 int (*sync_control)(struct ucsi *ucsi, u64 command);
81 int (*async_control)(struct ucsi *ucsi, u64 command);
82 bool (*update_altmodes)(struct ucsi *ucsi, struct ucsi_altmode *orig,
83 struct ucsi_altmode *updated);
84 void (*update_connector)(struct ucsi_connector *con);
85 void (*connector_status)(struct ucsi_connector *con);
86 };
87
88 struct ucsi *ucsi_create(struct device *dev, const struct ucsi_operations *ops);
89 void ucsi_destroy(struct ucsi *ucsi);
90 int ucsi_register(struct ucsi *ucsi);
91 void ucsi_unregister(struct ucsi *ucsi);
92 void *ucsi_get_drvdata(struct ucsi *ucsi);
93 void ucsi_set_drvdata(struct ucsi *ucsi, void *data);
94 bool ucsi_con_mutex_lock(struct ucsi_connector *con);
95 void ucsi_con_mutex_unlock(struct ucsi_connector *con);
96
97 void ucsi_connector_change(struct ucsi *ucsi, u8 num);
98
99 /* -------------------------------------------------------------------------- */
100
101 /* Commands */
102 #define UCSI_PPM_RESET 0x01
103 #define UCSI_CANCEL 0x02
104 #define UCSI_CONNECTOR_RESET 0x03
105 #define UCSI_ACK_CC_CI 0x04
106 #define UCSI_SET_NOTIFICATION_ENABLE 0x05
107 #define UCSI_GET_CAPABILITY 0x06
108 #define UCSI_GET_CONNECTOR_CAPABILITY 0x07
109 #define UCSI_SET_UOM 0x08
110 #define UCSI_SET_UOR 0x09
111 #define UCSI_SET_PDM 0x0a
112 #define UCSI_SET_PDR 0x0b
113 #define UCSI_GET_ALTERNATE_MODES 0x0c
114 #define UCSI_GET_CAM_SUPPORTED 0x0d
115 #define UCSI_GET_CURRENT_CAM 0x0e
116 #define UCSI_SET_NEW_CAM 0x0f
117 #define UCSI_GET_PDOS 0x10
118 #define UCSI_GET_CABLE_PROPERTY 0x11
119 #define UCSI_GET_CONNECTOR_STATUS 0x12
120 #define UCSI_GET_ERROR_STATUS 0x13
121 #define UCSI_GET_PD_MESSAGE 0x15
122
123 #define UCSI_CONNECTOR_NUMBER(_num_) ((u64)(_num_) << 16)
124 #define UCSI_COMMAND(_cmd_) ((_cmd_) & 0xff)
125
126 #define UCSI_GET_ALTMODE_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 24) & GENMASK(6, 0))
127 #define UCSI_DEFAULT_GET_CONNECTOR_NUMBER(_cmd_) (((_cmd_) >> 16) & GENMASK(6, 0))
128
129 /* CONNECTOR_RESET command bits */
130 #define UCSI_CONNECTOR_RESET_HARD_VER_1_0 BIT(23) /* Deprecated in v1.1 */
131 #define UCSI_CONNECTOR_RESET_DATA_VER_2_0 BIT(23) /* Redefined in v2.0 */
132
133
134 /* ACK_CC_CI bits */
135 #define UCSI_ACK_CONNECTOR_CHANGE BIT(16)
136 #define UCSI_ACK_COMMAND_COMPLETE BIT(17)
137
138 /* SET_NOTIFICATION_ENABLE command bits */
139 #define UCSI_ENABLE_NTFY_CMD_COMPLETE BIT_ULL(16)
140 #define UCSI_ENABLE_NTFY_EXT_PWR_SRC_CHANGE BIT_ULL(17)
141 #define UCSI_ENABLE_NTFY_PWR_OPMODE_CHANGE BIT_ULL(18)
142 #define UCSI_ENABLE_NTFY_ATTENTION BIT_ULL(19)
143 #define UCSI_ENABLE_NTFY_LPM_FW_UPDATE_REQ BIT_ULL(20)
144 #define UCSI_ENABLE_NTFY_CAP_CHANGE BIT_ULL(21)
145 #define UCSI_ENABLE_NTFY_PWR_LEVEL_CHANGE BIT_ULL(22)
146 #define UCSI_ENABLE_NTFY_PD_RESET_COMPLETE BIT_ULL(23)
147 #define UCSI_ENABLE_NTFY_CAM_CHANGE BIT_ULL(24)
148 #define UCSI_ENABLE_NTFY_BAT_STATUS_CHANGE BIT_ULL(25)
149 #define UCSI_ENABLE_NTFY_SECURITY_REQ_PARTNER BIT_ULL(26)
150 #define UCSI_ENABLE_NTFY_PARTNER_CHANGE BIT_ULL(27)
151 #define UCSI_ENABLE_NTFY_PWR_DIR_CHANGE BIT_ULL(28)
152 #define UCSI_ENABLE_NTFY_SET_RETIMER_MODE BIT_ULL(29)
153 #define UCSI_ENABLE_NTFY_CONNECTOR_CHANGE BIT_ULL(30)
154 #define UCSI_ENABLE_NTFY_ERROR BIT_ULL(31)
155 #define UCSI_ENABLE_NTFY_SINK_PATH_STS_CHANGE BIT_ULL(32)
156 #define UCSI_ENABLE_NTFY_ALL 0xdbe70000
157
158 /* SET_UOR command bits */
159 #define UCSI_SET_UOR_ROLE(_r_) (((_r_) == TYPEC_HOST ? 1 : 2) << 23)
160 #define UCSI_SET_UOR_ACCEPT_ROLE_SWAPS BIT(25)
161
162 /* SET_PDF command bits */
163 #define UCSI_SET_PDR_ROLE(_r_) (((_r_) == TYPEC_SOURCE ? 1 : 2) << 23)
164 #define UCSI_SET_PDR_ACCEPT_ROLE_SWAPS BIT(25)
165
166 /* GET_ALTERNATE_MODES command bits */
167 #define UCSI_ALTMODE_RECIPIENT(_r_) (((_r_) >> 16) & 0x7)
168 #define UCSI_GET_ALTMODE_RECIPIENT(_r_) ((u64)(_r_) << 16)
169 #define UCSI_RECIPIENT_CON 0
170 #define UCSI_RECIPIENT_SOP 1
171 #define UCSI_RECIPIENT_SOP_P 2
172 #define UCSI_RECIPIENT_SOP_PP 3
173 #define UCSI_GET_ALTMODE_CONNECTOR_NUMBER(_r_) ((u64)(_r_) << 24)
174 #define UCSI_ALTMODE_OFFSET(_r_) (((_r_) >> 32) & 0xff)
175 #define UCSI_GET_ALTMODE_OFFSET(_r_) ((u64)(_r_) << 32)
176 #define UCSI_GET_ALTMODE_NUM_ALTMODES(_r_) ((u64)(_r_) << 40)
177
178 /* GET_PDOS command bits */
179 #define UCSI_GET_PDOS_PARTNER_PDO(_r_) ((u64)(_r_) << 23)
180 #define UCSI_GET_PDOS_PDO_OFFSET(_r_) ((u64)(_r_) << 24)
181 #define UCSI_GET_PDOS_NUM_PDOS(_r_) ((u64)(_r_) << 32)
182 #define UCSI_MAX_PDOS (4)
183 #define UCSI_GET_PDOS_SRC_PDOS ((u64)1 << 34)
184
185 /* GET_PD_MESSAGE command bits */
186 #define UCSI_GET_PD_MESSAGE_RECIPIENT(_r_) ((u64)(_r_) << 23)
187 #define UCSI_GET_PD_MESSAGE_OFFSET(_r_) ((u64)(_r_) << 26)
188 #define UCSI_GET_PD_MESSAGE_BYTES(_r_) ((u64)(_r_) << 34)
189 #define UCSI_GET_PD_MESSAGE_TYPE(_r_) ((u64)(_r_) << 42)
190 #define UCSI_GET_PD_MESSAGE_TYPE_SNK_CAP_EXT 0
191 #define UCSI_GET_PD_MESSAGE_TYPE_SRC_CAP_EXT 1
192 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_CAP 2
193 #define UCSI_GET_PD_MESSAGE_TYPE_BAT_STAT 3
194 #define UCSI_GET_PD_MESSAGE_TYPE_IDENTITY 4
195 #define UCSI_GET_PD_MESSAGE_TYPE_REVISION 5
196
197 /* -------------------------------------------------------------------------- */
198
199 /* Error information returned by PPM in response to GET_ERROR_STATUS command. */
200 #define UCSI_ERROR_UNREGONIZED_CMD BIT(0)
201 #define UCSI_ERROR_INVALID_CON_NUM BIT(1)
202 #define UCSI_ERROR_INVALID_CMD_ARGUMENT BIT(2)
203 #define UCSI_ERROR_INCOMPATIBLE_PARTNER BIT(3)
204 #define UCSI_ERROR_CC_COMMUNICATION_ERR BIT(4)
205 #define UCSI_ERROR_DEAD_BATTERY BIT(5)
206 #define UCSI_ERROR_CONTRACT_NEGOTIATION_FAIL BIT(6)
207 #define UCSI_ERROR_OVERCURRENT BIT(7)
208 #define UCSI_ERROR_UNDEFINED BIT(8)
209 #define UCSI_ERROR_PARTNER_REJECTED_SWAP BIT(9)
210 #define UCSI_ERROR_HARD_RESET BIT(10)
211 #define UCSI_ERROR_PPM_POLICY_CONFLICT BIT(11)
212 #define UCSI_ERROR_SWAP_REJECTED BIT(12)
213 #define UCSI_ERROR_REVERSE_CURRENT_PROTECTION BIT(13)
214 #define UCSI_ERROR_SET_SINK_PATH_REJECTED BIT(14)
215
216 #define UCSI_SET_NEW_CAM_ENTER(x) (((x) >> 23) & 0x1)
217 #define UCSI_SET_NEW_CAM_GET_AM(x) (((x) >> 24) & 0xff)
218 #define UCSI_SET_NEW_CAM_AM_MASK (0xff << 24)
219 #define UCSI_SET_NEW_CAM_SET_AM(x) (((x) & 0xff) << 24)
220 #define UCSI_CMD_CONNECTOR_MASK (0x7)
221
222 /* Data structure filled by PPM in response to GET_CAPABILITY command. */
223 struct ucsi_capability {
224 u32 attributes;
225 #define UCSI_CAP_ATTR_DISABLE_STATE BIT(0)
226 #define UCSI_CAP_ATTR_BATTERY_CHARGING BIT(1)
227 #define UCSI_CAP_ATTR_USB_PD BIT(2)
228 #define UCSI_CAP_ATTR_TYPEC_CURRENT BIT(6)
229 #define UCSI_CAP_ATTR_POWER_AC_SUPPLY BIT(8)
230 #define UCSI_CAP_ATTR_POWER_OTHER BIT(10)
231 #define UCSI_CAP_ATTR_POWER_VBUS BIT(14)
232 u8 num_connectors;
233 u16 features;
234 #define UCSI_CAP_SET_UOM BIT(0)
235 #define UCSI_CAP_SET_PDM BIT(1)
236 #define UCSI_CAP_ALT_MODE_DETAILS BIT(2)
237 #define UCSI_CAP_ALT_MODE_OVERRIDE BIT(3)
238 #define UCSI_CAP_PDO_DETAILS BIT(4)
239 #define UCSI_CAP_CABLE_DETAILS BIT(5)
240 #define UCSI_CAP_EXT_SUPPLY_NOTIFICATIONS BIT(6)
241 #define UCSI_CAP_PD_RESET BIT(7)
242 #define UCSI_CAP_GET_PD_MESSAGE BIT(8)
243 #define UCSI_CAP_GET_ATTENTION_VDO BIT(9)
244 #define UCSI_CAP_FW_UPDATE_REQUEST BIT(10)
245 #define UCSI_CAP_NEGOTIATED_PWR_LEVEL_CHANGE BIT(11)
246 #define UCSI_CAP_SECURITY_REQUEST BIT(12)
247 #define UCSI_CAP_SET_RETIMER_MODE BIT(13)
248 #define UCSI_CAP_CHUNKING_SUPPORT BIT(14)
249 u8 reserved_1;
250 u8 num_alt_modes;
251 u8 reserved_2;
252 u16 bc_version;
253 u16 pd_version;
254 u16 typec_version;
255 } __packed;
256
257 /* Data structure filled by PPM in response to GET_CONNECTOR_CAPABILITY cmd. */
258 struct ucsi_connector_capability {
259 u8 op_mode;
260 #define UCSI_CONCAP_OPMODE_DFP BIT(0)
261 #define UCSI_CONCAP_OPMODE_UFP BIT(1)
262 #define UCSI_CONCAP_OPMODE_DRP BIT(2)
263 #define UCSI_CONCAP_OPMODE_AUDIO_ACCESSORY BIT(3)
264 #define UCSI_CONCAP_OPMODE_DEBUG_ACCESSORY BIT(4)
265 #define UCSI_CONCAP_OPMODE_USB2 BIT(5)
266 #define UCSI_CONCAP_OPMODE_USB3 BIT(6)
267 #define UCSI_CONCAP_OPMODE_ALT_MODE BIT(7)
268 u32 flags;
269 #define UCSI_CONCAP_FLAG_PROVIDER BIT(0)
270 #define UCSI_CONCAP_FLAG_CONSUMER BIT(1)
271 #define UCSI_CONCAP_FLAG_SWAP_TO_DFP BIT(2)
272 #define UCSI_CONCAP_FLAG_SWAP_TO_UFP BIT(3)
273 #define UCSI_CONCAP_FLAG_SWAP_TO_SRC BIT(4)
274 #define UCSI_CONCAP_FLAG_SWAP_TO_SINK BIT(5)
275 #define UCSI_CONCAP_FLAG_EX_OP_MODE(_f_) \
276 (((_f_) & GENMASK(13, 6)) >> 6)
277 #define UCSI_CONCAP_EX_OP_MODE_USB4_GEN2 BIT(0)
278 #define UCSI_CONCAP_EX_OP_MODE_EPR_SRC BIT(1)
279 #define UCSI_CONCAP_EX_OP_MODE_EPR_SINK BIT(2)
280 #define UCSI_CONCAP_EX_OP_MODE_USB4_GEN3 BIT(3)
281 #define UCSI_CONCAP_EX_OP_MODE_USB4_GEN4 BIT(4)
282 #define UCSI_CONCAP_FLAG_MISC_CAPS(_f_) \
283 (((_f_) & GENMASK(17, 14)) >> 14)
284 #define UCSI_CONCAP_MISC_CAP_FW_UPDATE BIT(0)
285 #define UCSI_CONCAP_MISC_CAP_SECURITY BIT(1)
286 #define UCSI_CONCAP_FLAG_REV_CURR_PROT_SUPPORT BIT(18)
287 #define UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV(_f_) \
288 (((_f_) & GENMASK(20, 19)) >> 19)
289 #define UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV_AS_BCD(_f_) \
290 UCSI_SPEC_REVISION_TO_BCD(UCSI_CONCAP_FLAG_PARTNER_PD_MAJOR_REV(_f_))
291 } __packed;
292
293 struct ucsi_altmode {
294 u16 svid;
295 u32 mid;
296 } __packed;
297
298 /* Data structure filled by PPM in response to GET_CABLE_PROPERTY command. */
299 struct ucsi_cable_property {
300 u16 speed_supported;
301 u8 current_capability;
302 u8 flags;
303 #define UCSI_CABLE_PROP_FLAG_VBUS_IN_CABLE BIT(0)
304 #define UCSI_CABLE_PROP_FLAG_ACTIVE_CABLE BIT(1)
305 #define UCSI_CABLE_PROP_FLAG_DIRECTIONALITY BIT(2)
306 #define UCSI_CABLE_PROP_FLAG_PLUG_TYPE(_f_) (((_f_) & GENMASK(4, 3)) >> 3)
307 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_A 0
308 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_B 1
309 #define UCSI_CABLE_PROPERTY_PLUG_TYPE_C 2
310 #define UCSI_CABLE_PROPERTY_PLUG_OTHER 3
311 #define UCSI_CABLE_PROP_FLAG_MODE_SUPPORT BIT(5)
312 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_) (((_f_) & GENMASK(7, 6)) >> 6)
313 #define UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV_AS_BCD(_f_) \
314 UCSI_SPEC_REVISION_TO_BCD(UCSI_CABLE_PROP_FLAG_PD_MAJOR_REV(_f_))
315 u8 latency;
316 } __packed;
317
318 /* Data structure filled by PPM in response to GET_CONNECTOR_STATUS command. */
319 struct ucsi_connector_status {
320 u16 change;
321 #define UCSI_CONSTAT_EXT_SUPPLY_CHANGE BIT(1)
322 #define UCSI_CONSTAT_POWER_OPMODE_CHANGE BIT(2)
323 #define UCSI_CONSTAT_PDOS_CHANGE BIT(5)
324 #define UCSI_CONSTAT_POWER_LEVEL_CHANGE BIT(6)
325 #define UCSI_CONSTAT_PD_RESET_COMPLETE BIT(7)
326 #define UCSI_CONSTAT_CAM_CHANGE BIT(8)
327 #define UCSI_CONSTAT_BC_CHANGE BIT(9)
328 #define UCSI_CONSTAT_PARTNER_CHANGE BIT(11)
329 #define UCSI_CONSTAT_POWER_DIR_CHANGE BIT(12)
330 #define UCSI_CONSTAT_CONNECT_CHANGE BIT(14)
331 #define UCSI_CONSTAT_ERROR BIT(15)
332 u16 flags;
333 #define UCSI_CONSTAT_PWR_OPMODE(_f_) ((_f_) & GENMASK(2, 0))
334 #define UCSI_CONSTAT_PWR_OPMODE_NONE 0
335 #define UCSI_CONSTAT_PWR_OPMODE_DEFAULT 1
336 #define UCSI_CONSTAT_PWR_OPMODE_BC 2
337 #define UCSI_CONSTAT_PWR_OPMODE_PD 3
338 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC1_5 4
339 #define UCSI_CONSTAT_PWR_OPMODE_TYPEC3_0 5
340 #define UCSI_CONSTAT_CONNECTED BIT(3)
341 #define UCSI_CONSTAT_PWR_DIR BIT(4)
342 #define UCSI_CONSTAT_PARTNER_FLAGS(_f_) (((_f_) & GENMASK(12, 5)) >> 5)
343 #define UCSI_CONSTAT_PARTNER_FLAG_USB 1
344 #define UCSI_CONSTAT_PARTNER_FLAG_ALT_MODE 2
345 #define UCSI_CONSTAT_PARTNER_TYPE(_f_) (((_f_) & GENMASK(15, 13)) >> 13)
346 #define UCSI_CONSTAT_PARTNER_TYPE_DFP 1
347 #define UCSI_CONSTAT_PARTNER_TYPE_UFP 2
348 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE 3 /* Powered Cable */
349 #define UCSI_CONSTAT_PARTNER_TYPE_CABLE_AND_UFP 4 /* Powered Cable */
350 #define UCSI_CONSTAT_PARTNER_TYPE_DEBUG 5
351 #define UCSI_CONSTAT_PARTNER_TYPE_AUDIO 6
352 u32 request_data_obj;
353
354 u8 pwr_status;
355 #define UCSI_CONSTAT_BC_STATUS(_p_) ((_p_) & GENMASK(1, 0))
356 #define UCSI_CONSTAT_BC_NOT_CHARGING 0
357 #define UCSI_CONSTAT_BC_NOMINAL_CHARGING 1
358 #define UCSI_CONSTAT_BC_SLOW_CHARGING 2
359 #define UCSI_CONSTAT_BC_TRICKLE_CHARGING 3
360 } __packed;
361
362 /* -------------------------------------------------------------------------- */
363
364 struct ucsi_debugfs_entry {
365 u64 command;
366 struct ucsi_data {
367 u64 low;
368 u64 high;
369 } response;
370 u32 status;
371 struct dentry *dentry;
372 };
373
374 struct ucsi {
375 u16 version;
376 struct device *dev;
377 void *driver_data;
378
379 const struct ucsi_operations *ops;
380
381 struct ucsi_capability cap;
382 struct ucsi_connector *connector;
383 struct ucsi_debugfs_entry *debugfs;
384
385 struct work_struct resume_work;
386 struct delayed_work work;
387 int work_count;
388 #define UCSI_ROLE_SWITCH_RETRY_PER_HZ 10
389 #define UCSI_ROLE_SWITCH_INTERVAL (HZ / UCSI_ROLE_SWITCH_RETRY_PER_HZ)
390 #define UCSI_ROLE_SWITCH_WAIT_COUNT (10 * UCSI_ROLE_SWITCH_RETRY_PER_HZ)
391
392 /* PPM Communication lock */
393 struct mutex ppm_lock;
394
395 /* The latest "Notification Enable" bits (SET_NOTIFICATION_ENABLE) */
396 u64 ntfy;
397
398 /* PPM communication flags */
399 unsigned long flags;
400 #define EVENT_PENDING 0
401 #define COMMAND_PENDING 1
402 #define ACK_PENDING 2
403 struct completion complete;
404
405 unsigned long quirks;
406 #define UCSI_NO_PARTNER_PDOS BIT(0) /* Don't read partner's PDOs */
407 #define UCSI_DELAY_DEVICE_PDOS BIT(1) /* Reading PDOs fails until the parter is in PD mode */
408 };
409
410 #define UCSI_MAX_DATA_LENGTH(u) (((u)->version < UCSI_VERSION_2_0) ? 0x10 : 0xff)
411
412 #define UCSI_MAX_SVID 5
413 #define UCSI_MAX_ALTMODES (UCSI_MAX_SVID * 6)
414
415 #define UCSI_TYPEC_VSAFE5V 5000
416 #define UCSI_TYPEC_DEFAULT_CURRENT 100
417 #define UCSI_TYPEC_1_5_CURRENT 1500
418 #define UCSI_TYPEC_3_0_CURRENT 3000
419
420 struct ucsi_connector {
421 int num;
422
423 struct ucsi *ucsi;
424 struct mutex lock; /* port lock */
425 struct work_struct work;
426 struct completion complete;
427 struct workqueue_struct *wq;
428 struct list_head partner_tasks;
429
430 struct typec_port *port;
431 struct typec_partner *partner;
432 struct typec_cable *cable;
433 struct typec_plug *plug;
434
435 struct typec_altmode *port_altmode[UCSI_MAX_ALTMODES];
436 struct typec_altmode *partner_altmode[UCSI_MAX_ALTMODES];
437 struct typec_altmode *plug_altmode[UCSI_MAX_ALTMODES];
438
439 struct typec_capability typec_cap;
440
441 struct ucsi_connector_status status;
442 struct ucsi_connector_capability cap;
443 struct power_supply *psy;
444 struct power_supply_desc psy_desc;
445 u32 rdo;
446 u32 src_pdos[PDO_MAX_OBJECTS];
447 int num_pdos;
448
449 /* USB PD objects */
450 struct usb_power_delivery *pd;
451 struct usb_power_delivery_capabilities *port_source_caps;
452 struct usb_power_delivery_capabilities *port_sink_caps;
453 struct usb_power_delivery *partner_pd;
454 struct usb_power_delivery_capabilities *partner_source_caps;
455 struct usb_power_delivery_capabilities *partner_sink_caps;
456
457 struct usb_role_switch *usb_role_sw;
458
459 /* USB PD identity */
460 struct usb_pd_identity partner_identity;
461 struct usb_pd_identity cable_identity;
462 };
463
464 int ucsi_send_command(struct ucsi *ucsi, u64 command,
465 void *retval, size_t size);
466
467 void ucsi_altmode_update_active(struct ucsi_connector *con);
468 int ucsi_resume(struct ucsi *ucsi);
469
470 void ucsi_notify_common(struct ucsi *ucsi, u32 cci);
471 int ucsi_sync_control_common(struct ucsi *ucsi, u64 command);
472
473 #if IS_ENABLED(CONFIG_POWER_SUPPLY)
474 int ucsi_register_port_psy(struct ucsi_connector *con);
475 void ucsi_unregister_port_psy(struct ucsi_connector *con);
476 void ucsi_port_psy_changed(struct ucsi_connector *con);
477 #else
ucsi_register_port_psy(struct ucsi_connector * con)478 static inline int ucsi_register_port_psy(struct ucsi_connector *con) { return 0; }
ucsi_unregister_port_psy(struct ucsi_connector * con)479 static inline void ucsi_unregister_port_psy(struct ucsi_connector *con) { }
ucsi_port_psy_changed(struct ucsi_connector * con)480 static inline void ucsi_port_psy_changed(struct ucsi_connector *con) { }
481 #endif /* CONFIG_POWER_SUPPLY */
482
483 #if IS_ENABLED(CONFIG_TYPEC_DP_ALTMODE)
484 struct typec_altmode *
485 ucsi_register_displayport(struct ucsi_connector *con,
486 bool override, int offset,
487 struct typec_altmode_desc *desc);
488
489 void ucsi_displayport_remove_partner(struct typec_altmode *adev);
490
491 #else
492 static inline struct typec_altmode *
ucsi_register_displayport(struct ucsi_connector * con,bool override,int offset,struct typec_altmode_desc * desc)493 ucsi_register_displayport(struct ucsi_connector *con,
494 bool override, int offset,
495 struct typec_altmode_desc *desc)
496 {
497 return typec_port_register_altmode(con->port, desc);
498 }
499
500 static inline void
ucsi_displayport_remove_partner(struct typec_altmode * adev)501 ucsi_displayport_remove_partner(struct typec_altmode *adev) { }
502 #endif /* CONFIG_TYPEC_DP_ALTMODE */
503
504 #ifdef CONFIG_DEBUG_FS
505 void ucsi_debugfs_init(void);
506 void ucsi_debugfs_exit(void);
507 void ucsi_debugfs_register(struct ucsi *ucsi);
508 void ucsi_debugfs_unregister(struct ucsi *ucsi);
509 #else
ucsi_debugfs_init(void)510 static inline void ucsi_debugfs_init(void) { }
ucsi_debugfs_exit(void)511 static inline void ucsi_debugfs_exit(void) { }
ucsi_debugfs_register(struct ucsi * ucsi)512 static inline void ucsi_debugfs_register(struct ucsi *ucsi) { }
ucsi_debugfs_unregister(struct ucsi * ucsi)513 static inline void ucsi_debugfs_unregister(struct ucsi *ucsi) { }
514 #endif /* CONFIG_DEBUG_FS */
515
516 /*
517 * NVIDIA VirtualLink (svid 0x955) has two altmode. VirtualLink
518 * DP mode with vdo=0x1 and NVIDIA test mode with vdo=0x3
519 */
520 #define USB_TYPEC_NVIDIA_VLINK_DP_VDO 0x1
521 #define USB_TYPEC_NVIDIA_VLINK_DBG_VDO 0x3
522
523 #endif /* __DRIVER_USB_TYPEC_UCSI_H */
524