1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3 * Copyright 2015-2017 Google, Inc
6 #ifndef __LINUX_USB_PD_H
7 #define __LINUX_USB_PD_H
9 #include <linux/kernel.h>
10 #include <linux/types.h>
11 #include <linux/usb/typec.h>
14 enum pd_ctrl_msg_type {
22 PD_CTRL_GET_SOURCE_CAP = 7,
23 PD_CTRL_GET_SINK_CAP = 8,
26 PD_CTRL_VCONN_SWAP = 11,
28 PD_CTRL_SOFT_RESET = 13,
30 PD_CTRL_NOT_SUPP = 16,
31 PD_CTRL_GET_SOURCE_CAP_EXT = 17,
32 PD_CTRL_GET_STATUS = 18,
34 PD_CTRL_GET_PPS_STATUS = 20,
35 PD_CTRL_GET_COUNTRY_CODES = 21,
39 enum pd_data_msg_type {
41 PD_DATA_SOURCE_CAP = 1,
45 PD_DATA_BATT_STATUS = 5,
47 PD_DATA_GET_COUNTRY_INFO = 7,
48 PD_DATA_ENTER_USB = 8,
50 PD_DATA_VENDOR_DEF = 15,
54 enum pd_ext_msg_type {
56 PD_EXT_SOURCE_CAP_EXT = 1,
58 PD_EXT_GET_BATT_CAP = 3,
59 PD_EXT_GET_BATT_STATUS = 4,
61 PD_EXT_GET_MANUFACTURER_INFO = 6,
62 PD_EXT_MANUFACTURER_INFO = 7,
63 PD_EXT_SECURITY_REQUEST = 8,
64 PD_EXT_SECURITY_RESPONSE = 9,
65 PD_EXT_FW_UPDATE_REQUEST = 10,
66 PD_EXT_FW_UPDATE_RESPONSE = 11,
67 PD_EXT_PPS_STATUS = 12,
68 PD_EXT_COUNTRY_INFO = 13,
69 PD_EXT_COUNTRY_CODES = 14,
76 #define PD_MAX_REV PD_REV30
78 #define PD_HEADER_EXT_HDR BIT(15)
79 #define PD_HEADER_CNT_SHIFT 12
80 #define PD_HEADER_CNT_MASK 0x7
81 #define PD_HEADER_ID_SHIFT 9
82 #define PD_HEADER_ID_MASK 0x7
83 #define PD_HEADER_PWR_ROLE BIT(8)
84 #define PD_HEADER_REV_SHIFT 6
85 #define PD_HEADER_REV_MASK 0x3
86 #define PD_HEADER_DATA_ROLE BIT(5)
87 #define PD_HEADER_TYPE_SHIFT 0
88 #define PD_HEADER_TYPE_MASK 0x1f
90 #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \
91 ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | \
92 ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \
93 ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | \
94 (rev << PD_HEADER_REV_SHIFT) | \
95 (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | \
96 (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \
97 ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
99 #define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
100 cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
102 static inline unsigned int pd_header_cnt(u16 header)
104 return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
107 static inline unsigned int pd_header_cnt_le(__le16 header)
109 return pd_header_cnt(le16_to_cpu(header));
112 static inline unsigned int pd_header_type(u16 header)
114 return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
117 static inline unsigned int pd_header_type_le(__le16 header)
119 return pd_header_type(le16_to_cpu(header));
122 static inline unsigned int pd_header_msgid(u16 header)
124 return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
127 static inline unsigned int pd_header_msgid_le(__le16 header)
129 return pd_header_msgid(le16_to_cpu(header));
132 static inline unsigned int pd_header_rev(u16 header)
134 return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
137 static inline unsigned int pd_header_rev_le(__le16 header)
139 return pd_header_rev(le16_to_cpu(header));
142 #define PD_EXT_HDR_CHUNKED BIT(15)
143 #define PD_EXT_HDR_CHUNK_NUM_SHIFT 11
144 #define PD_EXT_HDR_CHUNK_NUM_MASK 0xf
145 #define PD_EXT_HDR_REQ_CHUNK BIT(10)
146 #define PD_EXT_HDR_DATA_SIZE_SHIFT 0
147 #define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff
149 #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \
150 ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \
151 ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \
152 (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | \
153 ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
155 #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
156 cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
158 static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
160 return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
161 PD_EXT_HDR_CHUNK_NUM_MASK;
164 static inline unsigned int pd_ext_header_data_size(u16 ext_header)
166 return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
167 PD_EXT_HDR_DATA_SIZE_MASK;
170 static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
172 return pd_ext_header_data_size(le16_to_cpu(ext_header));
175 #define PD_MAX_PAYLOAD 7
176 #define PD_EXT_MAX_CHUNK_DATA 26
179 * struct pd_chunked_ext_message_data - PD chunked extended message data as
181 * @header: PD extended message header
182 * @data: PD extended message data
184 struct pd_chunked_ext_message_data {
186 u8 data[PD_EXT_MAX_CHUNK_DATA];
190 * struct pd_message - PD message as seen on wire
191 * @header: PD message header
192 * @payload: PD message payload
193 * @ext_msg: PD message chunked extended message data
198 __le32 payload[PD_MAX_PAYLOAD];
199 struct pd_chunked_ext_message_data ext_msg;
203 /* PDO: Power Data Object */
204 #define PDO_MAX_OBJECTS 7
213 #define PDO_TYPE_SHIFT 30
214 #define PDO_TYPE_MASK 0x3
216 #define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT)
218 #define PDO_VOLT_MASK 0x3ff
219 #define PDO_CURR_MASK 0x3ff
220 #define PDO_PWR_MASK 0x3ff
222 #define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */
223 #define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */
224 #define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */
225 #define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */
226 #define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */
227 #define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */
228 #define PDO_FIXED_FRS_CURR_MASK (BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */
229 #define PDO_FIXED_FRS_CURR_SHIFT 23
230 #define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */
231 #define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */
233 #define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
234 #define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
236 #define PDO_FIXED(mv, ma, flags) \
237 (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \
238 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
240 #define VSAFE5V 5000 /* mv units */
242 #define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */
243 #define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */
244 #define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
246 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
247 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
248 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
250 #define PDO_BATT(min_mv, max_mv, max_mw) \
251 (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \
252 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
254 #define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */
255 #define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */
256 #define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */
258 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
259 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
260 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
262 #define PDO_VAR(min_mv, max_mv, max_ma) \
263 (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \
264 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
270 #define PDO_APDO_TYPE_SHIFT 28 /* Only valid value currently is 0x0 - PPS */
271 #define PDO_APDO_TYPE_MASK 0x3
273 #define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT)
275 #define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */
276 #define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */
277 #define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */
279 #define PDO_PPS_APDO_VOLT_MASK 0xff
280 #define PDO_PPS_APDO_CURR_MASK 0x7f
282 #define PDO_PPS_APDO_MIN_VOLT(mv) \
283 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
284 #define PDO_PPS_APDO_MAX_VOLT(mv) \
285 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
286 #define PDO_PPS_APDO_MAX_CURR(ma) \
287 ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
289 #define PDO_PPS_APDO(min_mv, max_mv, max_ma) \
290 (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | \
291 PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \
292 PDO_PPS_APDO_MAX_CURR(max_ma))
294 static inline enum pd_pdo_type pdo_type(u32 pdo)
296 return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
299 static inline unsigned int pdo_fixed_voltage(u32 pdo)
301 return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
304 static inline unsigned int pdo_min_voltage(u32 pdo)
306 return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
309 static inline unsigned int pdo_max_voltage(u32 pdo)
311 return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
314 static inline unsigned int pdo_max_current(u32 pdo)
316 return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
319 static inline unsigned int pdo_max_power(u32 pdo)
321 return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
324 static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
326 return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
329 static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
331 return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
332 PDO_PPS_APDO_VOLT_MASK) * 100;
335 static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
337 return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
338 PDO_PPS_APDO_VOLT_MASK) * 100;
341 static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
343 return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
344 PDO_PPS_APDO_CURR_MASK) * 50;
347 /* RDO: Request Data Object */
348 #define RDO_OBJ_POS_SHIFT 28
349 #define RDO_OBJ_POS_MASK 0x7
350 #define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */
351 #define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */
352 #define RDO_USB_COMM BIT(25) /* USB communications capable */
353 #define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */
355 #define RDO_PWR_MASK 0x3ff
356 #define RDO_CURR_MASK 0x3ff
358 #define RDO_FIXED_OP_CURR_SHIFT 10
359 #define RDO_FIXED_MAX_CURR_SHIFT 0
361 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
363 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
364 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
366 #define RDO_FIXED(idx, op_ma, max_ma, flags) \
367 (RDO_OBJ(idx) | (flags) | \
368 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
370 #define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */
371 #define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
373 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
374 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
376 #define RDO_BATT(idx, op_mw, max_mw, flags) \
377 (RDO_OBJ(idx) | (flags) | \
378 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
380 #define RDO_PROG_VOLT_MASK 0x7ff
381 #define RDO_PROG_CURR_MASK 0x7f
383 #define RDO_PROG_VOLT_SHIFT 9
384 #define RDO_PROG_CURR_SHIFT 0
386 #define RDO_PROG_VOLT_MV_STEP 20
387 #define RDO_PROG_CURR_MA_STEP 50
389 #define PDO_PROG_OUT_VOLT(mv) \
390 ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
391 #define PDO_PROG_OP_CURR(ma) \
392 ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
394 #define RDO_PROG(idx, out_mv, op_ma, flags) \
395 (RDO_OBJ(idx) | (flags) | \
396 PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
398 static inline unsigned int rdo_index(u32 rdo)
400 return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
403 static inline unsigned int rdo_op_current(u32 rdo)
405 return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
408 static inline unsigned int rdo_max_current(u32 rdo)
410 return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
414 static inline unsigned int rdo_op_power(u32 rdo)
416 return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
419 static inline unsigned int rdo_max_power(u32 rdo)
421 return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
424 /* Enter_USB Data Object */
425 #define EUDO_USB_MODE_MASK GENMASK(30, 28)
426 #define EUDO_USB_MODE_SHIFT 28
427 #define EUDO_USB_MODE_USB2 0
428 #define EUDO_USB_MODE_USB3 1
429 #define EUDO_USB_MODE_USB4 2
430 #define EUDO_USB4_DRD BIT(26)
431 #define EUDO_USB3_DRD BIT(25)
432 #define EUDO_CABLE_SPEED_MASK GENMASK(23, 21)
433 #define EUDO_CABLE_SPEED_SHIFT 21
434 #define EUDO_CABLE_SPEED_USB2 0
435 #define EUDO_CABLE_SPEED_USB3_GEN1 1
436 #define EUDO_CABLE_SPEED_USB4_GEN2 2
437 #define EUDO_CABLE_SPEED_USB4_GEN3 3
438 #define EUDO_CABLE_TYPE_MASK GENMASK(20, 19)
439 #define EUDO_CABLE_TYPE_SHIFT 19
440 #define EUDO_CABLE_TYPE_PASSIVE 0
441 #define EUDO_CABLE_TYPE_RE_TIMER 1
442 #define EUDO_CABLE_TYPE_RE_DRIVER 2
443 #define EUDO_CABLE_TYPE_OPTICAL 3
444 #define EUDO_CABLE_CURRENT_MASK GENMASK(18, 17)
445 #define EUDO_CABLE_CURRENT_SHIFT 17
446 #define EUDO_CABLE_CURRENT_NOTSUPP 0
447 #define EUDO_CABLE_CURRENT_3A 2
448 #define EUDO_CABLE_CURRENT_5A 3
449 #define EUDO_PCIE_SUPPORT BIT(16)
450 #define EUDO_DP_SUPPORT BIT(15)
451 #define EUDO_TBT_SUPPORT BIT(14)
452 #define EUDO_HOST_PRESENT BIT(13)
454 /* USB PD timers and counters */
455 #define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */
456 #define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */
457 #define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */
458 #define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */
459 #define PD_T_RECEIVER_RESPONSE 15 /* 15ms max */
460 #define PD_T_SOURCE_ACTIVITY 45
461 #define PD_T_SINK_ACTIVITY 135
462 #define PD_T_SINK_WAIT_CAP 310 /* 310 - 620 ms */
463 #define PD_T_PS_TRANSITION 500
464 #define PD_T_SRC_TRANSITION 35
465 #define PD_T_DRP_SNK 40
466 #define PD_T_DRP_SRC 30
467 #define PD_T_PS_SOURCE_OFF 920
468 #define PD_T_PS_SOURCE_ON 480
469 #define PD_T_PS_HARD_RESET 30
470 #define PD_T_SRC_RECOVER 760
471 #define PD_T_SRC_RECOVER_MAX 1000
472 #define PD_T_SRC_TURN_ON 275
473 #define PD_T_SAFE_0V 650
474 #define PD_T_VCONN_SOURCE_ON 100
475 #define PD_T_SINK_REQUEST 100 /* 100 ms minimum */
476 #define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */
477 #define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */
478 #define PD_T_NEWSRC 250 /* Maximum of 275ms */
479 #define PD_T_SWAP_SRC_START 20 /* Minimum of 20ms */
480 #define PD_T_BIST_CONT_MODE 50 /* 30 - 60 ms */
482 #define PD_T_DRP_TRY 100 /* 75 - 150 ms */
483 #define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */
485 #define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */
486 #define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */
488 #define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
489 #define PD_N_HARD_RESET_COUNT 2
491 #endif /* __LINUX_USB_PD_H */