Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
1/* SPDX-License-Identifier: GPL-2.0-or-later */
2/*
3 * Copyright 2015-2017 Google, Inc
4 */
5
6#ifndef __LINUX_USB_PD_H
7#define __LINUX_USB_PD_H
8
9#include <linux/bitfield.h>
10#include <linux/kernel.h>
11#include <linux/types.h>
12#include <linux/usb/typec.h>
13
14/* USB PD Messages */
15enum pd_ctrl_msg_type {
16 /* 0 Reserved */
17 PD_CTRL_GOOD_CRC = 1,
18 PD_CTRL_GOTO_MIN = 2,
19 PD_CTRL_ACCEPT = 3,
20 PD_CTRL_REJECT = 4,
21 PD_CTRL_PING = 5,
22 PD_CTRL_PS_RDY = 6,
23 PD_CTRL_GET_SOURCE_CAP = 7,
24 PD_CTRL_GET_SINK_CAP = 8,
25 PD_CTRL_DR_SWAP = 9,
26 PD_CTRL_PR_SWAP = 10,
27 PD_CTRL_VCONN_SWAP = 11,
28 PD_CTRL_WAIT = 12,
29 PD_CTRL_SOFT_RESET = 13,
30 /* 14-15 Reserved */
31 PD_CTRL_NOT_SUPP = 16,
32 PD_CTRL_GET_SOURCE_CAP_EXT = 17,
33 PD_CTRL_GET_STATUS = 18,
34 PD_CTRL_FR_SWAP = 19,
35 PD_CTRL_GET_PPS_STATUS = 20,
36 PD_CTRL_GET_COUNTRY_CODES = 21,
37 PD_CTRL_GET_SINK_CAP_EXT = 22,
38 /* 23 Reserved */
39 PD_CTRL_GET_REVISION = 24,
40 /* 25-31 Reserved */
41};
42
43enum pd_data_msg_type {
44 /* 0 Reserved */
45 PD_DATA_SOURCE_CAP = 1,
46 PD_DATA_REQUEST = 2,
47 PD_DATA_BIST = 3,
48 PD_DATA_SINK_CAP = 4,
49 PD_DATA_BATT_STATUS = 5,
50 PD_DATA_ALERT = 6,
51 PD_DATA_GET_COUNTRY_INFO = 7,
52 PD_DATA_ENTER_USB = 8,
53 /* 9-11 Reserved */
54 PD_DATA_REVISION = 12,
55 /* 13-14 Reserved */
56 PD_DATA_VENDOR_DEF = 15,
57 /* 16-31 Reserved */
58};
59
60enum pd_ext_msg_type {
61 /* 0 Reserved */
62 PD_EXT_SOURCE_CAP_EXT = 1,
63 PD_EXT_STATUS = 2,
64 PD_EXT_GET_BATT_CAP = 3,
65 PD_EXT_GET_BATT_STATUS = 4,
66 PD_EXT_BATT_CAP = 5,
67 PD_EXT_GET_MANUFACTURER_INFO = 6,
68 PD_EXT_MANUFACTURER_INFO = 7,
69 PD_EXT_SECURITY_REQUEST = 8,
70 PD_EXT_SECURITY_RESPONSE = 9,
71 PD_EXT_FW_UPDATE_REQUEST = 10,
72 PD_EXT_FW_UPDATE_RESPONSE = 11,
73 PD_EXT_PPS_STATUS = 12,
74 PD_EXT_COUNTRY_INFO = 13,
75 PD_EXT_COUNTRY_CODES = 14,
76 PD_EXT_SINK_CAP_EXT = 15,
77 /* 16-31 Reserved */
78};
79
80#define PD_REV10 0x0
81#define PD_REV20 0x1
82#define PD_REV30 0x2
83#define PD_MAX_REV PD_REV30
84
85#define PD_HEADER_EXT_HDR BIT(15)
86#define PD_HEADER_CNT_SHIFT 12
87#define PD_HEADER_CNT_MASK 0x7
88#define PD_HEADER_ID_SHIFT 9
89#define PD_HEADER_ID_MASK 0x7
90#define PD_HEADER_PWR_ROLE BIT(8)
91#define PD_HEADER_REV_SHIFT 6
92#define PD_HEADER_REV_MASK 0x3
93#define PD_HEADER_DATA_ROLE BIT(5)
94#define PD_HEADER_TYPE_SHIFT 0
95#define PD_HEADER_TYPE_MASK 0x1f
96
97#define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr) \
98 ((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) | \
99 ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) | \
100 ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) | \
101 (rev << PD_HEADER_REV_SHIFT) | \
102 (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) | \
103 (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) | \
104 ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
105
106#define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
107 cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
108
109static inline unsigned int pd_header_cnt(u16 header)
110{
111 return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
112}
113
114static inline unsigned int pd_header_cnt_le(__le16 header)
115{
116 return pd_header_cnt(le16_to_cpu(header));
117}
118
119static inline unsigned int pd_header_type(u16 header)
120{
121 return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
122}
123
124static inline unsigned int pd_header_type_le(__le16 header)
125{
126 return pd_header_type(le16_to_cpu(header));
127}
128
129static inline unsigned int pd_header_msgid(u16 header)
130{
131 return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
132}
133
134static inline unsigned int pd_header_msgid_le(__le16 header)
135{
136 return pd_header_msgid(le16_to_cpu(header));
137}
138
139static inline unsigned int pd_header_rev(u16 header)
140{
141 return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
142}
143
144static inline unsigned int pd_header_rev_le(__le16 header)
145{
146 return pd_header_rev(le16_to_cpu(header));
147}
148
149#define PD_EXT_HDR_CHUNKED BIT(15)
150#define PD_EXT_HDR_CHUNK_NUM_SHIFT 11
151#define PD_EXT_HDR_CHUNK_NUM_MASK 0xf
152#define PD_EXT_HDR_REQ_CHUNK BIT(10)
153#define PD_EXT_HDR_DATA_SIZE_SHIFT 0
154#define PD_EXT_HDR_DATA_SIZE_MASK 0x1ff
155
156#define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked) \
157 ((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) | \
158 ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) | \
159 (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) | \
160 ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
161
162#define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
163 cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
164
165static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
166{
167 return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
168 PD_EXT_HDR_CHUNK_NUM_MASK;
169}
170
171static inline unsigned int pd_ext_header_data_size(u16 ext_header)
172{
173 return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
174 PD_EXT_HDR_DATA_SIZE_MASK;
175}
176
177static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
178{
179 return pd_ext_header_data_size(le16_to_cpu(ext_header));
180}
181
182#define PD_MAX_PAYLOAD 7
183#define PD_EXT_MAX_CHUNK_DATA 26
184
185/**
186 * struct pd_chunked_ext_message_data - PD chunked extended message data as
187 * seen on wire
188 * @header: PD extended message header
189 * @data: PD extended message data
190 */
191struct pd_chunked_ext_message_data {
192 __le16 header;
193 u8 data[PD_EXT_MAX_CHUNK_DATA];
194} __packed;
195
196/**
197 * struct pd_message - PD message as seen on wire
198 * @header: PD message header
199 * @payload: PD message payload
200 * @ext_msg: PD message chunked extended message data
201 */
202struct pd_message {
203 __le16 header;
204 union {
205 __le32 payload[PD_MAX_PAYLOAD];
206 struct pd_chunked_ext_message_data ext_msg;
207 };
208} __packed;
209
210/*
211 * count_chunked_data_objs - Helper to calculate number of Data Objects on a 4
212 * byte boundary.
213 * @size: Size of data block for extended message. Should *not* include extended
214 * header size.
215 */
216static inline u8 count_chunked_data_objs(u32 size)
217{
218 size += offsetof(struct pd_chunked_ext_message_data, data);
219 return ((size / 4) + (size % 4 ? 1 : 0));
220}
221
222/* Sink Caps Extended Data Block Version */
223#define SKEDB_VER_1_0 1
224
225/* Sink Caps Extended Sink Modes */
226#define SINK_MODE_PPS BIT(0)
227#define SINK_MODE_VBUS BIT(1)
228#define SINK_MODE_AC_SUPPLY BIT(2)
229#define SINK_MODE_BATT BIT(3)
230#define SINK_MODE_BATT_UL BIT(4) /* Unlimited battery power supply */
231#define SINK_MODE_AVS BIT(5)
232
233/**
234 * struct sink_caps_ext_msg - Sink extended capability PD message
235 * @vid: Vendor ID
236 * @pid: Product ID
237 * @xid: Value assigned by USB-IF for product
238 * @fw: Firmware version
239 * @hw: Hardware version
240 * @skedb_ver: Sink Caps Extended Data Block (SKEDB) Version
241 * @load_step: Indicates the load step slew rate.
242 * @load_char: Sink overload characteristics
243 * @compliance: Types of sources the sink has been tested & certified on
244 * @touch_temp: Indicates the IEC standard to which the touch temperature
245 * conforms to (if applicable).
246 * @batt_info: Indicates number batteries and hot swappable ports
247 * @modes: Charging caps & power sources supported
248 * @spr_min_pdp: Sink Minimum PDP for SPR mode
249 * @spr_op_pdp: Sink Operational PDP for SPR mode
250 * @spr_max_pdp: Sink Maximum PDP for SPR mode
251 * @epr_min_pdp: Sink Minimum PDP for EPR mode
252 * @epr_op_pdp: Sink Operational PDP for EPR mode
253 * @epr_max_pdp: Sink Maximum PDP for EPR mode
254 */
255struct sink_caps_ext_msg {
256 __le16 vid;
257 __le16 pid;
258 __le32 xid;
259 u8 fw;
260 u8 hw;
261 u8 skedb_ver;
262 u8 load_step;
263 __le16 load_char;
264 u8 compliance;
265 u8 touch_temp;
266 u8 batt_info;
267 u8 modes;
268 u8 spr_min_pdp;
269 u8 spr_op_pdp;
270 u8 spr_max_pdp;
271 u8 epr_min_pdp;
272 u8 epr_op_pdp;
273 u8 epr_max_pdp;
274} __packed;
275
276/* PDO: Power Data Object */
277#define PDO_MAX_OBJECTS 7
278
279enum pd_pdo_type {
280 PDO_TYPE_FIXED = 0,
281 PDO_TYPE_BATT = 1,
282 PDO_TYPE_VAR = 2,
283 PDO_TYPE_APDO = 3,
284};
285
286#define PDO_TYPE_SHIFT 30
287#define PDO_TYPE_MASK 0x3
288
289#define PDO_TYPE(t) ((t) << PDO_TYPE_SHIFT)
290
291#define PDO_VOLT_MASK 0x3ff
292#define PDO_CURR_MASK 0x3ff
293#define PDO_PWR_MASK 0x3ff
294
295#define PDO_FIXED_DUAL_ROLE BIT(29) /* Power role swap supported */
296#define PDO_FIXED_SUSPEND BIT(28) /* USB Suspend supported (Source) */
297#define PDO_FIXED_HIGHER_CAP BIT(28) /* Requires more than vSafe5V (Sink) */
298#define PDO_FIXED_EXTPOWER BIT(27) /* Externally powered */
299#define PDO_FIXED_USB_COMM BIT(26) /* USB communications capable */
300#define PDO_FIXED_DATA_SWAP BIT(25) /* Data role swap supported */
301#define PDO_FIXED_UNCHUNK_EXT BIT(24) /* Unchunked Extended Message supported (Source) */
302#define PDO_FIXED_FRS_CURR_MASK (BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */
303#define PDO_FIXED_FRS_CURR_SHIFT 23
304#define PDO_FIXED_PEAK_CURR_SHIFT 20
305#define PDO_FIXED_VOLT_SHIFT 10 /* 50mV units */
306#define PDO_FIXED_CURR_SHIFT 0 /* 10mA units */
307
308#define PDO_FIXED_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
309#define PDO_FIXED_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
310
311#define PDO_FIXED(mv, ma, flags) \
312 (PDO_TYPE(PDO_TYPE_FIXED) | (flags) | \
313 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
314
315#define VSAFE5V 5000 /* mv units */
316
317#define PDO_BATT_MAX_VOLT_SHIFT 20 /* 50mV units */
318#define PDO_BATT_MIN_VOLT_SHIFT 10 /* 50mV units */
319#define PDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
320
321#define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
322#define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
323#define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
324
325#define PDO_BATT(min_mv, max_mv, max_mw) \
326 (PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) | \
327 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
328
329#define PDO_VAR_MAX_VOLT_SHIFT 20 /* 50mV units */
330#define PDO_VAR_MIN_VOLT_SHIFT 10 /* 50mV units */
331#define PDO_VAR_MAX_CURR_SHIFT 0 /* 10mA units */
332
333#define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
334#define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
335#define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
336
337#define PDO_VAR(min_mv, max_mv, max_ma) \
338 (PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) | \
339 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
340
341enum pd_apdo_type {
342 APDO_TYPE_PPS = 0,
343 APDO_TYPE_EPR_AVS = 1,
344 APDO_TYPE_SPR_AVS = 2,
345};
346
347#define PDO_APDO_TYPE_SHIFT 28
348#define PDO_APDO_TYPE_MASK 0x3
349
350#define PDO_APDO_TYPE(t) ((t) << PDO_APDO_TYPE_SHIFT)
351
352#define PDO_PPS_APDO_MAX_VOLT_SHIFT 17 /* 100mV units */
353#define PDO_PPS_APDO_MIN_VOLT_SHIFT 8 /* 100mV units */
354#define PDO_PPS_APDO_MAX_CURR_SHIFT 0 /* 50mA units */
355
356#define PDO_PPS_APDO_VOLT_MASK 0xff
357#define PDO_PPS_APDO_CURR_MASK 0x7f
358
359#define PDO_PPS_APDO_MIN_VOLT(mv) \
360 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
361#define PDO_PPS_APDO_MAX_VOLT(mv) \
362 ((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
363#define PDO_PPS_APDO_MAX_CURR(ma) \
364 ((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
365
366#define PDO_PPS_APDO(min_mv, max_mv, max_ma) \
367 (PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) | \
368 PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) | \
369 PDO_PPS_APDO_MAX_CURR(max_ma))
370
371/*
372 * Applicable only to EPR AVS APDO source cap as per
373 * Table 6.15 EPR Adjustable Voltage Supply APDO – Source
374 */
375#define PDO_EPR_AVS_APDO_PEAK_CURRENT GENMASK(27, 26)
376
377/*
378 * Applicable to both EPR AVS APDO source and sink cap as per
379 * Table 6.15 EPR Adjustable Voltage Supply APDO – Source
380 * Table 6.22 EPR Adjustable Voltage Supply APDO – Sink
381 */
382#define PDO_EPR_AVS_APDO_MAX_VOLT GENMASK(25, 17) /* 100mV unit */
383#define PDO_EPR_AVS_APDO_MIN_VOLT GENMASK(15, 8) /* 100mV unit */
384#define PDO_EPR_AVS_APDO_PDP GENMASK(7, 0) /* 1W unit */
385
386/*
387 * Applicable only SPR AVS APDO source cap as per
388 * Table 6.14 SPR Adjustable Voltage Supply APDO – Source
389 */
390#define PDO_SPR_AVS_APDO_PEAK_CURRENT GENMASK(27, 26)
391
392/*
393 * Applicable to both SPR AVS APDO source and sink cap as per
394 * Table 6.14 SPR Adjustable Voltage Supply APDO – Source
395 * Table 6.21 SPR Adjustable Voltage Supply APDO – Sink
396 */
397#define PDO_SPR_AVS_APDO_9V_TO_15V_MAX_CURR GENMASK(19, 10) /* 10mA unit */
398#define PDO_SPR_AVS_APDO_15V_TO_20V_MAX_CURR GENMASK(9, 0) /* 10mA unit */
399
400/* SPR AVS has two different current ranges 9V - 15V, 15V - 20V */
401#define SPR_AVS_TIER1_MIN_VOLT_MV 9000
402#define SPR_AVS_TIER1_MAX_VOLT_MV 15000
403#define SPR_AVS_TIER2_MAX_VOLT_MV 20000
404
405#define SPR_AVS_AVS_SMALL_STEP_V 1
406/* vAvsStep - 100mv */
407#define SPR_AVS_VOLT_MV_STEP 100
408/* SPR AVS RDO Operating Current is in 50mA step */
409#define RDO_SPR_AVS_CURR_MA_STEP 50
410/* SPR AVS RDO Output voltage is in 25mV step */
411#define RDO_SPR_AVS_OUT_VOLT_MV_STEP 25
412
413#define RDO_SPR_AVS_VOLT GENMASK(20, 9)
414#define RDO_SPR_AVS_CURR GENMASK(6, 0)
415
416#define RDO_SPR_AVS_OUT_VOLT(mv) \
417 FIELD_PREP(RDO_SPR_AVS_VOLT, ((mv) / RDO_SPR_AVS_OUT_VOLT_MV_STEP))
418
419#define RDO_SPR_AVS_OP_CURR(ma) \
420 FIELD_PREP(RDO_SPR_AVS_CURR, ((ma) / RDO_SPR_AVS_CURR_MA_STEP))
421
422#define RDO_AVS(idx, out_mv, op_ma, flags) \
423 (RDO_OBJ(idx) | (flags) | \
424 RDO_SPR_AVS_OUT_VOLT(out_mv) | RDO_SPR_AVS_OP_CURR(op_ma))
425
426static inline enum pd_pdo_type pdo_type(u32 pdo)
427{
428 return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
429}
430
431static inline unsigned int pdo_fixed_voltage(u32 pdo)
432{
433 return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
434}
435
436static inline unsigned int pdo_fixed_current(u32 pdo)
437{
438 return ((pdo >> PDO_FIXED_CURR_SHIFT) & PDO_CURR_MASK) * 10;
439}
440
441static inline unsigned int pdo_min_voltage(u32 pdo)
442{
443 return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
444}
445
446static inline unsigned int pdo_max_voltage(u32 pdo)
447{
448 return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
449}
450
451static inline unsigned int pdo_max_current(u32 pdo)
452{
453 return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
454}
455
456static inline unsigned int pdo_max_power(u32 pdo)
457{
458 return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
459}
460
461static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
462{
463 return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
464}
465
466static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
467{
468 return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
469 PDO_PPS_APDO_VOLT_MASK) * 100;
470}
471
472static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
473{
474 return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
475 PDO_PPS_APDO_VOLT_MASK) * 100;
476}
477
478static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
479{
480 return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
481 PDO_PPS_APDO_CURR_MASK) * 50;
482}
483
484static inline unsigned int pdo_epr_avs_apdo_src_peak_current(u32 pdo)
485{
486 return FIELD_GET(PDO_EPR_AVS_APDO_PEAK_CURRENT, pdo);
487}
488
489static inline unsigned int pdo_epr_avs_apdo_min_voltage_mv(u32 pdo)
490{
491 return FIELD_GET(PDO_EPR_AVS_APDO_MIN_VOLT, pdo) * 100;
492}
493
494static inline unsigned int pdo_epr_avs_apdo_max_voltage_mv(u32 pdo)
495{
496 return FIELD_GET(PDO_EPR_AVS_APDO_MIN_VOLT, pdo) * 100;
497}
498
499static inline unsigned int pdo_epr_avs_apdo_pdp_w(u32 pdo)
500{
501 return FIELD_GET(PDO_EPR_AVS_APDO_PDP, pdo);
502}
503
504static inline unsigned int pdo_spr_avs_apdo_src_peak_current(u32 pdo)
505{
506 return FIELD_GET(PDO_SPR_AVS_APDO_PEAK_CURRENT, pdo);
507}
508
509static inline unsigned int pdo_spr_avs_apdo_9v_to_15v_max_current_ma(u32 pdo)
510{
511 return FIELD_GET(PDO_SPR_AVS_APDO_9V_TO_15V_MAX_CURR, pdo) * 10;
512}
513
514static inline unsigned int pdo_spr_avs_apdo_15v_to_20v_max_current_ma(u32 pdo)
515{
516 return FIELD_GET(PDO_SPR_AVS_APDO_15V_TO_20V_MAX_CURR, pdo) * 10;
517}
518
519/* RDO: Request Data Object */
520#define RDO_OBJ_POS_SHIFT 28
521#define RDO_OBJ_POS_MASK 0x7
522#define RDO_GIVE_BACK BIT(27) /* Supports reduced operating current */
523#define RDO_CAP_MISMATCH BIT(26) /* Not satisfied by source caps */
524#define RDO_USB_COMM BIT(25) /* USB communications capable */
525#define RDO_NO_SUSPEND BIT(24) /* USB Suspend not supported */
526
527#define RDO_PWR_MASK 0x3ff
528#define RDO_CURR_MASK 0x3ff
529
530#define RDO_FIXED_OP_CURR_SHIFT 10
531#define RDO_FIXED_MAX_CURR_SHIFT 0
532
533#define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
534
535#define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
536#define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
537
538#define RDO_FIXED(idx, op_ma, max_ma, flags) \
539 (RDO_OBJ(idx) | (flags) | \
540 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
541
542#define RDO_BATT_OP_PWR_SHIFT 10 /* 250mW units */
543#define RDO_BATT_MAX_PWR_SHIFT 0 /* 250mW units */
544
545#define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
546#define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
547
548#define RDO_BATT(idx, op_mw, max_mw, flags) \
549 (RDO_OBJ(idx) | (flags) | \
550 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
551
552#define RDO_PROG_VOLT_MASK 0x7ff
553#define RDO_PROG_CURR_MASK 0x7f
554
555#define RDO_PROG_VOLT_SHIFT 9
556#define RDO_PROG_CURR_SHIFT 0
557
558#define RDO_PROG_VOLT_MV_STEP 20
559#define RDO_PROG_CURR_MA_STEP 50
560
561#define PDO_PROG_OUT_VOLT(mv) \
562 ((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
563#define PDO_PROG_OP_CURR(ma) \
564 ((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
565
566#define RDO_PROG(idx, out_mv, op_ma, flags) \
567 (RDO_OBJ(idx) | (flags) | \
568 PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
569
570static inline unsigned int rdo_index(u32 rdo)
571{
572 return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
573}
574
575static inline unsigned int rdo_op_current(u32 rdo)
576{
577 return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
578}
579
580static inline unsigned int rdo_max_current(u32 rdo)
581{
582 return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
583 RDO_CURR_MASK) * 10;
584}
585
586static inline unsigned int rdo_op_power(u32 rdo)
587{
588 return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
589}
590
591static inline unsigned int rdo_max_power(u32 rdo)
592{
593 return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
594}
595
596/* Enter_USB Data Object */
597#define EUDO_USB_MODE_MASK GENMASK(30, 28)
598#define EUDO_USB_MODE_SHIFT 28
599#define EUDO_USB_MODE_USB2 0
600#define EUDO_USB_MODE_USB3 1
601#define EUDO_USB_MODE_USB4 2
602#define EUDO_USB4_DRD BIT(26)
603#define EUDO_USB3_DRD BIT(25)
604#define EUDO_CABLE_SPEED_MASK GENMASK(23, 21)
605#define EUDO_CABLE_SPEED_SHIFT 21
606#define EUDO_CABLE_SPEED_USB2 0
607#define EUDO_CABLE_SPEED_USB3_GEN1 1
608#define EUDO_CABLE_SPEED_USB4_GEN2 2
609#define EUDO_CABLE_SPEED_USB4_GEN3 3
610#define EUDO_CABLE_TYPE_MASK GENMASK(20, 19)
611#define EUDO_CABLE_TYPE_SHIFT 19
612#define EUDO_CABLE_TYPE_PASSIVE 0
613#define EUDO_CABLE_TYPE_RE_TIMER 1
614#define EUDO_CABLE_TYPE_RE_DRIVER 2
615#define EUDO_CABLE_TYPE_OPTICAL 3
616#define EUDO_CABLE_CURRENT_MASK GENMASK(18, 17)
617#define EUDO_CABLE_CURRENT_SHIFT 17
618#define EUDO_CABLE_CURRENT_NOTSUPP 0
619#define EUDO_CABLE_CURRENT_3A 2
620#define EUDO_CABLE_CURRENT_5A 3
621#define EUDO_PCIE_SUPPORT BIT(16)
622#define EUDO_DP_SUPPORT BIT(15)
623#define EUDO_TBT_SUPPORT BIT(14)
624#define EUDO_HOST_PRESENT BIT(13)
625
626/*
627 * Request Message Data Object (PD Revision 3.1+ only)
628 * --------
629 * <31:28> :: Revision Major
630 * <27:24> :: Revision Minor
631 * <23:20> :: Version Major
632 * <19:16> :: Version Minor
633 * <15:0> :: Reserved, Shall be set to zero
634 */
635
636#define RMDO(rev_maj, rev_min, ver_maj, ver_min) \
637 (((rev_maj) & 0xf) << 28 | ((rev_min) & 0xf) << 24 | \
638 ((ver_maj) & 0xf) << 20 | ((ver_min) & 0xf) << 16)
639
640/* USB PD timers and counters */
641#define PD_T_NO_RESPONSE 5000 /* 4.5 - 5.5 seconds */
642#define PD_T_DB_DETECT 10000 /* 10 - 15 seconds */
643#define PD_T_SEND_SOURCE_CAP 150 /* 100 - 200 ms */
644#define PD_T_SENDER_RESPONSE 60 /* 24 - 30 ms, relaxed */
645#define PD_T_RECEIVER_RESPONSE 15 /* 15ms max */
646#define PD_T_SOURCE_ACTIVITY 45
647#define PD_T_SINK_ACTIVITY 135
648#define PD_T_SINK_WAIT_CAP 310 /* 310 - 620 ms */
649#define PD_T_PS_TRANSITION 500
650#define PD_T_SRC_TRANSITION 35
651#define PD_T_DRP_SNK 40
652#define PD_T_DRP_SRC 30
653#define PD_T_PS_SOURCE_OFF 920
654#define PD_T_PS_SOURCE_ON 480
655#define PD_T_PS_SOURCE_ON_PRS 450 /* 390 - 480ms */
656#define PD_T_PS_HARD_RESET 30
657#define PD_T_SRC_RECOVER 760
658#define PD_T_SRC_RECOVER_MAX 1000
659#define PD_T_SRC_TURN_ON 275
660#define PD_T_SAFE_0V 650
661#define PD_T_VCONN_SOURCE_ON 100
662#define PD_T_SINK_REQUEST 100 /* 100 ms minimum */
663#define PD_T_ERROR_RECOVERY 100 /* minimum 25 is insufficient */
664#define PD_T_SRCSWAPSTDBY 625 /* Maximum of 650ms */
665#define PD_T_NEWSRC 250 /* Maximum of 275ms */
666#define PD_T_SWAP_SRC_START 20 /* Minimum of 20ms */
667#define PD_T_BIST_CONT_MODE 50 /* 30 - 60 ms */
668#define PD_T_SINK_TX 16 /* 16 - 20 ms */
669#define PD_T_CHUNK_NOT_SUPP 42 /* 40 - 50 ms */
670#define PD_T_VCONN_STABLE 50
671
672#define PD_T_DRP_TRY 100 /* 75 - 150 ms */
673#define PD_T_DRP_TRYWAIT 600 /* 400 - 800 ms */
674
675#define PD_T_CC_DEBOUNCE 200 /* 100 - 200 ms */
676#define PD_T_PD_DEBOUNCE 20 /* 10 - 20 ms */
677#define PD_T_TRY_CC_DEBOUNCE 15 /* 10 - 20 ms */
678
679#define PD_N_CAPS_COUNT (PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
680#define PD_N_HARD_RESET_COUNT 2
681
682#define PD_P_SNK_STDBY_MW 2500 /* 2500 mW */
683
684#define PD_I_SNK_STBY_MA 500 /* 500 mA */
685
686#define PD_T_AVS_SRC_TRANS_SMALL 50 /* 50 ms */
687#define PD_T_AVS_SRC_TRANS_LARGE 700 /* 700 ms */
688
689#if IS_ENABLED(CONFIG_TYPEC)
690
691struct usb_power_delivery;
692
693/**
694 * usb_power_delivery_desc - USB Power Delivery Descriptor
695 * @revision: USB Power Delivery Specification Revision
696 * @version: USB Power Delivery Specicication Version - optional
697 */
698struct usb_power_delivery_desc {
699 u16 revision;
700 u16 version;
701};
702
703/**
704 * usb_power_delivery_capabilities_desc - Description of USB Power Delivery Capabilities Message
705 * @pdo: The Power Data Objects in the Capability Message
706 * @role: Power role of the capabilities
707 */
708struct usb_power_delivery_capabilities_desc {
709 u32 pdo[PDO_MAX_OBJECTS];
710 enum typec_role role;
711};
712
713struct usb_power_delivery_capabilities *
714usb_power_delivery_register_capabilities(struct usb_power_delivery *pd,
715 struct usb_power_delivery_capabilities_desc *desc);
716void usb_power_delivery_unregister_capabilities(struct usb_power_delivery_capabilities *cap);
717
718struct usb_power_delivery *usb_power_delivery_register(struct device *parent,
719 struct usb_power_delivery_desc *desc);
720void usb_power_delivery_unregister(struct usb_power_delivery *pd);
721
722int usb_power_delivery_link_device(struct usb_power_delivery *pd, struct device *dev);
723void usb_power_delivery_unlink_device(struct usb_power_delivery *pd, struct device *dev);
724
725#endif /* CONFIG_TYPEC */
726
727#endif /* __LINUX_USB_PD_H */