2 * Copyright 2015-2017 Google, Inc
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
15 #ifndef __LINUX_USB_PD_H
16 #define __LINUX_USB_PD_H
18 #include <linux/kernel.h>
19 #include <linux/types.h>
20 #include <linux/usb/typec.h>
23 enum pd_ctrl_msg_type {
31 PD_CTRL_GET_SOURCE_CAP = 7,
32 PD_CTRL_GET_SINK_CAP = 8,
35 PD_CTRL_VCONN_SWAP = 11,
37 PD_CTRL_SOFT_RESET = 13,
39 PD_CTRL_NOT_SUPP = 16,
40 PD_CTRL_GET_SOURCE_CAP_EXT = 17,
41 PD_CTRL_GET_STATUS = 18,
43 PD_CTRL_GET_PPS_STATUS = 20,
44 PD_CTRL_GET_COUNTRY_CODES = 21,
48 enum pd_data_msg_type {
50 PD_DATA_SOURCE_CAP = 1,
54 PD_DATA_BATT_STATUS = 5,
56 PD_DATA_GET_COUNTRY_INFO = 7,
58 PD_DATA_VENDOR_DEF = 15,
62 enum pd_ext_msg_type {
64 PD_EXT_SOURCE_CAP_EXT = 1,
66 PD_EXT_GET_BATT_CAP = 3,
67 PD_EXT_GET_BATT_STATUS = 4,
69 PD_EXT_GET_MANUFACTURER_INFO = 6,
70 PD_EXT_MANUFACTURER_INFO = 7,
71 PD_EXT_SECURITY_REQUEST = 8,
72 PD_EXT_SECURITY_RESPONSE = 9,
73 PD_EXT_FW_UPDATE_REQUEST = 10,
74 PD_EXT_FW_UPDATE_RESPONSE = 11,
75 PD_EXT_PPS_STATUS = 12,
76 PD_EXT_COUNTRY_INFO = 13,
77 PD_EXT_COUNTRY_CODES = 14,
84 #define PD_MAX_REV PD_REV30
86 #define PD_HEADER_EXT_HDR BIT(15)
87 #define PD_HEADER_CNT_SHIFT 12
88 #define PD_HEADER_CNT_MASK 0x7
89 #define PD_HEADER_ID_SHIFT 9
90 #define PD_HEADER_ID_MASK 0x7
91 #define PD_HEADER_PWR_ROLE BIT(8)
92 #define PD_HEADER_REV_SHIFT 6
93 #define PD_HEADER_REV_MASK 0x3
94 #define PD_HEADER_DATA_ROLE BIT(5)
95 #define PD_HEADER_TYPE_SHIFT 0
96 #define PD_HEADER_TYPE_MASK 0x1f
98 #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \
99 ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | \
100 ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \
101 ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | \
102 (rev << PD_HEADER_REV_SHIFT) | \
103 (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | \
104 (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \
105 ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
107 #define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
108 cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
110 static inline unsigned int pd_header_cnt(u16 header)
112 return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
115 static inline unsigned int pd_header_cnt_le(__le16 header)
117 return pd_header_cnt(le16_to_cpu(header));
120 static inline unsigned int pd_header_type(u16 header)
122 return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
125 static inline unsigned int pd_header_type_le(__le16 header)
127 return pd_header_type(le16_to_cpu(header));
130 static inline unsigned int pd_header_msgid(u16 header)
132 return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
135 static inline unsigned int pd_header_msgid_le(__le16 header)
137 return pd_header_msgid(le16_to_cpu(header));
140 static inline unsigned int pd_header_rev(u16 header)
142 return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
145 static inline unsigned int pd_header_rev_le(__le16 header)
147 return pd_header_rev(le16_to_cpu(header));
150 #define PD_EXT_HDR_CHUNKED BIT(15)
151 #define PD_EXT_HDR_CHUNK_NUM_SHIFT 11
152 #define PD_EXT_HDR_CHUNK_NUM_MASK 0xf
153 #define PD_EXT_HDR_REQ_CHUNK BIT(10)
154 #define PD_EXT_HDR_DATA_SIZE_SHIFT 0
155 #define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff
157 #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \
158 ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \
159 ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \
160 (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | \
161 ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
163 #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
164 cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
166 static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
168 return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
169 PD_EXT_HDR_CHUNK_NUM_MASK;
172 static inline unsigned int pd_ext_header_data_size(u16 ext_header)
174 return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
175 PD_EXT_HDR_DATA_SIZE_MASK;
178 static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
180 return pd_ext_header_data_size(le16_to_cpu(ext_header));
183 #define PD_MAX_PAYLOAD 7
184 #define PD_EXT_MAX_CHUNK_DATA 26
187 * struct pd_chunked_ext_message_data - PD chunked extended message data as
189 * @header: PD extended message header
190 * @data: PD extended message data
192 struct pd_chunked_ext_message_data {
194 u8 data[PD_EXT_MAX_CHUNK_DATA];
198 * struct pd_message - PD message as seen on wire
199 * @header: PD message header
200 * @payload: PD message payload
201 * @ext_msg: PD message chunked extended message data
206 __le32 payload[PD_MAX_PAYLOAD];
207 struct pd_chunked_ext_message_data ext_msg;
211 /* PDO: Power Data Object */
212 #define PDO_MAX_OBJECTS 7
221 #define PDO_TYPE_SHIFT 30
222 #define PDO_TYPE_MASK 0x3
224 #define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT)
226 #define PDO_VOLT_MASK 0x3ff
227 #define PDO_CURR_MASK 0x3ff
228 #define PDO_PWR_MASK 0x3ff
230 #define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */
231 #define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */
232 #define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */
233 #define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */
234 #define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */
235 #define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */
236 #define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */
237 #define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */
239 #define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
240 #define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
242 #define PDO_FIXED(mv, ma, flags) \
243 (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \
244 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
246 #define VSAFE5V 5000 /* mv units */
248 #define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */
249 #define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */
250 #define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
252 #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
253 #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
254 #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
256 #define PDO_BATT(min_mv, max_mv, max_mw) \
257 (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \
258 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
260 #define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */
261 #define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */
262 #define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */
264 #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
265 #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
266 #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
268 #define PDO_VAR(min_mv, max_mv, max_ma) \
269 (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \
270 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
276 #define PDO_APDO_TYPE_SHIFT 28 /* Only valid value currently is 0x0 - PPS */
277 #define PDO_APDO_TYPE_MASK 0x3
279 #define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT)
281 #define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */
282 #define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */
283 #define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */
285 #define PDO_PPS_APDO_VOLT_MASK 0xff
286 #define PDO_PPS_APDO_CURR_MASK 0x7f
288 #define PDO_PPS_APDO_MIN_VOLT(mv) \
289 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
290 #define PDO_PPS_APDO_MAX_VOLT(mv) \
291 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
292 #define PDO_PPS_APDO_MAX_CURR(ma) \
293 ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
295 #define PDO_PPS_APDO(min_mv, max_mv, max_ma) \
296 (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | \
297 PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \
298 PDO_PPS_APDO_MAX_CURR(max_ma))
300 static inline enum pd_pdo_type pdo_type(u32 pdo)
302 return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
305 static inline unsigned int pdo_fixed_voltage(u32 pdo)
307 return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
310 static inline unsigned int pdo_min_voltage(u32 pdo)
312 return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
315 static inline unsigned int pdo_max_voltage(u32 pdo)
317 return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
320 static inline unsigned int pdo_max_current(u32 pdo)
322 return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
325 static inline unsigned int pdo_max_power(u32 pdo)
327 return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
330 static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
332 return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
335 static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
337 return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
338 PDO_PPS_APDO_VOLT_MASK) * 100;
341 static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
343 return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
344 PDO_PPS_APDO_VOLT_MASK) * 100;
347 static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
349 return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
350 PDO_PPS_APDO_CURR_MASK) * 50;
353 /* RDO: Request Data Object */
354 #define RDO_OBJ_POS_SHIFT 28
355 #define RDO_OBJ_POS_MASK 0x7
356 #define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */
357 #define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */
358 #define RDO_USB_COMM BIT(25) /* USB communications capable */
359 #define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */
361 #define RDO_PWR_MASK 0x3ff
362 #define RDO_CURR_MASK 0x3ff
364 #define RDO_FIXED_OP_CURR_SHIFT 10
365 #define RDO_FIXED_MAX_CURR_SHIFT 0
367 #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
369 #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
370 #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
372 #define RDO_FIXED(idx, op_ma, max_ma, flags) \
373 (RDO_OBJ(idx) | (flags) | \
374 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
376 #define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */
377 #define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
379 #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
380 #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
382 #define RDO_BATT(idx, op_mw, max_mw, flags) \
383 (RDO_OBJ(idx) | (flags) | \
384 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
386 #define RDO_PROG_VOLT_MASK 0x7ff
387 #define RDO_PROG_CURR_MASK 0x7f
389 #define RDO_PROG_VOLT_SHIFT 9
390 #define RDO_PROG_CURR_SHIFT 0
392 #define RDO_PROG_VOLT_MV_STEP 20
393 #define RDO_PROG_CURR_MA_STEP 50
395 #define PDO_PROG_OUT_VOLT(mv) \
396 ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
397 #define PDO_PROG_OP_CURR(ma) \
398 ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
400 #define RDO_PROG(idx, out_mv, op_ma, flags) \
401 (RDO_OBJ(idx) | (flags) | \
402 PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
404 static inline unsigned int rdo_index(u32 rdo)
406 return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
409 static inline unsigned int rdo_op_current(u32 rdo)
411 return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
414 static inline unsigned int rdo_max_current(u32 rdo)
416 return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
420 static inline unsigned int rdo_op_power(u32 rdo)
422 return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
425 static inline unsigned int rdo_max_power(u32 rdo)
427 return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
430 /* USB PD timers and counters */
431 #define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */
432 #define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */
433 #define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */
434 #define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */
435 #define PD_T_SOURCE_ACTIVITY 45
436 #define PD_T_SINK_ACTIVITY 135
437 #define PD_T_SINK_WAIT_CAP 240
438 #define PD_T_PS_TRANSITION 500
439 #define PD_T_SRC_TRANSITION 35
440 #define PD_T_DRP_SNK 40
441 #define PD_T_DRP_SRC 30
442 #define PD_T_PS_SOURCE_OFF 920
443 #define PD_T_PS_SOURCE_ON 480
444 #define PD_T_PS_HARD_RESET 30
445 #define PD_T_SRC_RECOVER 760
446 #define PD_T_SRC_RECOVER_MAX 1000
447 #define PD_T_SRC_TURN_ON 275
448 #define PD_T_SAFE_0V 650
449 #define PD_T_VCONN_SOURCE_ON 100
450 #define PD_T_SINK_REQUEST 100 /* 100 ms minimum */
451 #define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */
452 #define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */
453 #define PD_T_NEWSRC 250 /* Maximum of 275ms */
455 #define PD_T_DRP_TRY 100 /* 75 - 150 ms */
456 #define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */
458 #define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */
459 #define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */
461 #define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
462 #define PD_N_HARD_RESET_COUNT 2
464 #endif /* __LINUX_USB_PD_H */