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