xref: /OK3568_Linux_fs/kernel/include/linux/usb/pd.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright 2015-2017 Google, Inc
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #ifndef __LINUX_USB_PD_H
7*4882a593Smuzhiyun #define __LINUX_USB_PD_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/kernel.h>
10*4882a593Smuzhiyun #include <linux/types.h>
11*4882a593Smuzhiyun #include <linux/usb/typec.h>
12*4882a593Smuzhiyun 
13*4882a593Smuzhiyun /* USB PD Messages */
14*4882a593Smuzhiyun enum pd_ctrl_msg_type {
15*4882a593Smuzhiyun 	/* 0 Reserved */
16*4882a593Smuzhiyun 	PD_CTRL_GOOD_CRC = 1,
17*4882a593Smuzhiyun 	PD_CTRL_GOTO_MIN = 2,
18*4882a593Smuzhiyun 	PD_CTRL_ACCEPT = 3,
19*4882a593Smuzhiyun 	PD_CTRL_REJECT = 4,
20*4882a593Smuzhiyun 	PD_CTRL_PING = 5,
21*4882a593Smuzhiyun 	PD_CTRL_PS_RDY = 6,
22*4882a593Smuzhiyun 	PD_CTRL_GET_SOURCE_CAP = 7,
23*4882a593Smuzhiyun 	PD_CTRL_GET_SINK_CAP = 8,
24*4882a593Smuzhiyun 	PD_CTRL_DR_SWAP = 9,
25*4882a593Smuzhiyun 	PD_CTRL_PR_SWAP = 10,
26*4882a593Smuzhiyun 	PD_CTRL_VCONN_SWAP = 11,
27*4882a593Smuzhiyun 	PD_CTRL_WAIT = 12,
28*4882a593Smuzhiyun 	PD_CTRL_SOFT_RESET = 13,
29*4882a593Smuzhiyun 	/* 14-15 Reserved */
30*4882a593Smuzhiyun 	PD_CTRL_NOT_SUPP = 16,
31*4882a593Smuzhiyun 	PD_CTRL_GET_SOURCE_CAP_EXT = 17,
32*4882a593Smuzhiyun 	PD_CTRL_GET_STATUS = 18,
33*4882a593Smuzhiyun 	PD_CTRL_FR_SWAP = 19,
34*4882a593Smuzhiyun 	PD_CTRL_GET_PPS_STATUS = 20,
35*4882a593Smuzhiyun 	PD_CTRL_GET_COUNTRY_CODES = 21,
36*4882a593Smuzhiyun 	/* 22-31 Reserved */
37*4882a593Smuzhiyun };
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun enum pd_data_msg_type {
40*4882a593Smuzhiyun 	/* 0 Reserved */
41*4882a593Smuzhiyun 	PD_DATA_SOURCE_CAP = 1,
42*4882a593Smuzhiyun 	PD_DATA_REQUEST = 2,
43*4882a593Smuzhiyun 	PD_DATA_BIST = 3,
44*4882a593Smuzhiyun 	PD_DATA_SINK_CAP = 4,
45*4882a593Smuzhiyun 	PD_DATA_BATT_STATUS = 5,
46*4882a593Smuzhiyun 	PD_DATA_ALERT = 6,
47*4882a593Smuzhiyun 	PD_DATA_GET_COUNTRY_INFO = 7,
48*4882a593Smuzhiyun 	PD_DATA_ENTER_USB = 8,
49*4882a593Smuzhiyun 	/* 9-14 Reserved */
50*4882a593Smuzhiyun 	PD_DATA_VENDOR_DEF = 15,
51*4882a593Smuzhiyun 	/* 16-31 Reserved */
52*4882a593Smuzhiyun };
53*4882a593Smuzhiyun 
54*4882a593Smuzhiyun enum pd_ext_msg_type {
55*4882a593Smuzhiyun 	/* 0 Reserved */
56*4882a593Smuzhiyun 	PD_EXT_SOURCE_CAP_EXT = 1,
57*4882a593Smuzhiyun 	PD_EXT_STATUS = 2,
58*4882a593Smuzhiyun 	PD_EXT_GET_BATT_CAP = 3,
59*4882a593Smuzhiyun 	PD_EXT_GET_BATT_STATUS = 4,
60*4882a593Smuzhiyun 	PD_EXT_BATT_CAP = 5,
61*4882a593Smuzhiyun 	PD_EXT_GET_MANUFACTURER_INFO = 6,
62*4882a593Smuzhiyun 	PD_EXT_MANUFACTURER_INFO = 7,
63*4882a593Smuzhiyun 	PD_EXT_SECURITY_REQUEST = 8,
64*4882a593Smuzhiyun 	PD_EXT_SECURITY_RESPONSE = 9,
65*4882a593Smuzhiyun 	PD_EXT_FW_UPDATE_REQUEST = 10,
66*4882a593Smuzhiyun 	PD_EXT_FW_UPDATE_RESPONSE = 11,
67*4882a593Smuzhiyun 	PD_EXT_PPS_STATUS = 12,
68*4882a593Smuzhiyun 	PD_EXT_COUNTRY_INFO = 13,
69*4882a593Smuzhiyun 	PD_EXT_COUNTRY_CODES = 14,
70*4882a593Smuzhiyun 	/* 15-31 Reserved */
71*4882a593Smuzhiyun };
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun #define PD_REV10	0x0
74*4882a593Smuzhiyun #define PD_REV20	0x1
75*4882a593Smuzhiyun #define PD_REV30	0x2
76*4882a593Smuzhiyun #define PD_MAX_REV	PD_REV30
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #define PD_HEADER_EXT_HDR	BIT(15)
79*4882a593Smuzhiyun #define PD_HEADER_CNT_SHIFT	12
80*4882a593Smuzhiyun #define PD_HEADER_CNT_MASK	0x7
81*4882a593Smuzhiyun #define PD_HEADER_ID_SHIFT	9
82*4882a593Smuzhiyun #define PD_HEADER_ID_MASK	0x7
83*4882a593Smuzhiyun #define PD_HEADER_PWR_ROLE	BIT(8)
84*4882a593Smuzhiyun #define PD_HEADER_REV_SHIFT	6
85*4882a593Smuzhiyun #define PD_HEADER_REV_MASK	0x3
86*4882a593Smuzhiyun #define PD_HEADER_DATA_ROLE	BIT(5)
87*4882a593Smuzhiyun #define PD_HEADER_TYPE_SHIFT	0
88*4882a593Smuzhiyun #define PD_HEADER_TYPE_MASK	0x1f
89*4882a593Smuzhiyun 
90*4882a593Smuzhiyun #define PD_HEADER(type, pwr, data, rev, id, cnt, ext_hdr)		\
91*4882a593Smuzhiyun 	((((type) & PD_HEADER_TYPE_MASK) << PD_HEADER_TYPE_SHIFT) |	\
92*4882a593Smuzhiyun 	 ((pwr) == TYPEC_SOURCE ? PD_HEADER_PWR_ROLE : 0) |		\
93*4882a593Smuzhiyun 	 ((data) == TYPEC_HOST ? PD_HEADER_DATA_ROLE : 0) |		\
94*4882a593Smuzhiyun 	 (rev << PD_HEADER_REV_SHIFT) |					\
95*4882a593Smuzhiyun 	 (((id) & PD_HEADER_ID_MASK) << PD_HEADER_ID_SHIFT) |		\
96*4882a593Smuzhiyun 	 (((cnt) & PD_HEADER_CNT_MASK) << PD_HEADER_CNT_SHIFT) |	\
97*4882a593Smuzhiyun 	 ((ext_hdr) ? PD_HEADER_EXT_HDR : 0))
98*4882a593Smuzhiyun 
99*4882a593Smuzhiyun #define PD_HEADER_LE(type, pwr, data, rev, id, cnt) \
100*4882a593Smuzhiyun 	cpu_to_le16(PD_HEADER((type), (pwr), (data), (rev), (id), (cnt), (0)))
101*4882a593Smuzhiyun 
pd_header_cnt(u16 header)102*4882a593Smuzhiyun static inline unsigned int pd_header_cnt(u16 header)
103*4882a593Smuzhiyun {
104*4882a593Smuzhiyun 	return (header >> PD_HEADER_CNT_SHIFT) & PD_HEADER_CNT_MASK;
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun 
pd_header_cnt_le(__le16 header)107*4882a593Smuzhiyun static inline unsigned int pd_header_cnt_le(__le16 header)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun 	return pd_header_cnt(le16_to_cpu(header));
110*4882a593Smuzhiyun }
111*4882a593Smuzhiyun 
pd_header_type(u16 header)112*4882a593Smuzhiyun static inline unsigned int pd_header_type(u16 header)
113*4882a593Smuzhiyun {
114*4882a593Smuzhiyun 	return (header >> PD_HEADER_TYPE_SHIFT) & PD_HEADER_TYPE_MASK;
115*4882a593Smuzhiyun }
116*4882a593Smuzhiyun 
pd_header_type_le(__le16 header)117*4882a593Smuzhiyun static inline unsigned int pd_header_type_le(__le16 header)
118*4882a593Smuzhiyun {
119*4882a593Smuzhiyun 	return pd_header_type(le16_to_cpu(header));
120*4882a593Smuzhiyun }
121*4882a593Smuzhiyun 
pd_header_msgid(u16 header)122*4882a593Smuzhiyun static inline unsigned int pd_header_msgid(u16 header)
123*4882a593Smuzhiyun {
124*4882a593Smuzhiyun 	return (header >> PD_HEADER_ID_SHIFT) & PD_HEADER_ID_MASK;
125*4882a593Smuzhiyun }
126*4882a593Smuzhiyun 
pd_header_msgid_le(__le16 header)127*4882a593Smuzhiyun static inline unsigned int pd_header_msgid_le(__le16 header)
128*4882a593Smuzhiyun {
129*4882a593Smuzhiyun 	return pd_header_msgid(le16_to_cpu(header));
130*4882a593Smuzhiyun }
131*4882a593Smuzhiyun 
pd_header_rev(u16 header)132*4882a593Smuzhiyun static inline unsigned int pd_header_rev(u16 header)
133*4882a593Smuzhiyun {
134*4882a593Smuzhiyun 	return (header >> PD_HEADER_REV_SHIFT) & PD_HEADER_REV_MASK;
135*4882a593Smuzhiyun }
136*4882a593Smuzhiyun 
pd_header_rev_le(__le16 header)137*4882a593Smuzhiyun static inline unsigned int pd_header_rev_le(__le16 header)
138*4882a593Smuzhiyun {
139*4882a593Smuzhiyun 	return pd_header_rev(le16_to_cpu(header));
140*4882a593Smuzhiyun }
141*4882a593Smuzhiyun 
142*4882a593Smuzhiyun #define PD_EXT_HDR_CHUNKED		BIT(15)
143*4882a593Smuzhiyun #define PD_EXT_HDR_CHUNK_NUM_SHIFT	11
144*4882a593Smuzhiyun #define PD_EXT_HDR_CHUNK_NUM_MASK	0xf
145*4882a593Smuzhiyun #define PD_EXT_HDR_REQ_CHUNK		BIT(10)
146*4882a593Smuzhiyun #define PD_EXT_HDR_DATA_SIZE_SHIFT	0
147*4882a593Smuzhiyun #define PD_EXT_HDR_DATA_SIZE_MASK	0x1ff
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun #define PD_EXT_HDR(data_size, req_chunk, chunk_num, chunked)				\
150*4882a593Smuzhiyun 	((((data_size) & PD_EXT_HDR_DATA_SIZE_MASK) << PD_EXT_HDR_DATA_SIZE_SHIFT) |	\
151*4882a593Smuzhiyun 	 ((req_chunk) ? PD_EXT_HDR_REQ_CHUNK : 0) |					\
152*4882a593Smuzhiyun 	 (((chunk_num) & PD_EXT_HDR_CHUNK_NUM_MASK) << PD_EXT_HDR_CHUNK_NUM_SHIFT) |	\
153*4882a593Smuzhiyun 	 ((chunked) ? PD_EXT_HDR_CHUNKED : 0))
154*4882a593Smuzhiyun 
155*4882a593Smuzhiyun #define PD_EXT_HDR_LE(data_size, req_chunk, chunk_num, chunked) \
156*4882a593Smuzhiyun 	cpu_to_le16(PD_EXT_HDR((data_size), (req_chunk), (chunk_num), (chunked)))
157*4882a593Smuzhiyun 
pd_ext_header_chunk_num(u16 ext_header)158*4882a593Smuzhiyun static inline unsigned int pd_ext_header_chunk_num(u16 ext_header)
159*4882a593Smuzhiyun {
160*4882a593Smuzhiyun 	return (ext_header >> PD_EXT_HDR_CHUNK_NUM_SHIFT) &
161*4882a593Smuzhiyun 		PD_EXT_HDR_CHUNK_NUM_MASK;
162*4882a593Smuzhiyun }
163*4882a593Smuzhiyun 
pd_ext_header_data_size(u16 ext_header)164*4882a593Smuzhiyun static inline unsigned int pd_ext_header_data_size(u16 ext_header)
165*4882a593Smuzhiyun {
166*4882a593Smuzhiyun 	return (ext_header >> PD_EXT_HDR_DATA_SIZE_SHIFT) &
167*4882a593Smuzhiyun 		PD_EXT_HDR_DATA_SIZE_MASK;
168*4882a593Smuzhiyun }
169*4882a593Smuzhiyun 
pd_ext_header_data_size_le(__le16 ext_header)170*4882a593Smuzhiyun static inline unsigned int pd_ext_header_data_size_le(__le16 ext_header)
171*4882a593Smuzhiyun {
172*4882a593Smuzhiyun 	return pd_ext_header_data_size(le16_to_cpu(ext_header));
173*4882a593Smuzhiyun }
174*4882a593Smuzhiyun 
175*4882a593Smuzhiyun #define PD_MAX_PAYLOAD		7
176*4882a593Smuzhiyun #define PD_EXT_MAX_CHUNK_DATA	26
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun /**
179*4882a593Smuzhiyun   * struct pd_chunked_ext_message_data - PD chunked extended message data as
180*4882a593Smuzhiyun   *					 seen on wire
181*4882a593Smuzhiyun   * @header:    PD extended message header
182*4882a593Smuzhiyun   * @data:      PD extended message data
183*4882a593Smuzhiyun   */
184*4882a593Smuzhiyun struct pd_chunked_ext_message_data {
185*4882a593Smuzhiyun 	__le16 header;
186*4882a593Smuzhiyun 	u8 data[PD_EXT_MAX_CHUNK_DATA];
187*4882a593Smuzhiyun } __packed;
188*4882a593Smuzhiyun 
189*4882a593Smuzhiyun /**
190*4882a593Smuzhiyun   * struct pd_message - PD message as seen on wire
191*4882a593Smuzhiyun   * @header:    PD message header
192*4882a593Smuzhiyun   * @payload:   PD message payload
193*4882a593Smuzhiyun   * @ext_msg:   PD message chunked extended message data
194*4882a593Smuzhiyun   */
195*4882a593Smuzhiyun struct pd_message {
196*4882a593Smuzhiyun 	__le16 header;
197*4882a593Smuzhiyun 	union {
198*4882a593Smuzhiyun 		__le32 payload[PD_MAX_PAYLOAD];
199*4882a593Smuzhiyun 		struct pd_chunked_ext_message_data ext_msg;
200*4882a593Smuzhiyun 	};
201*4882a593Smuzhiyun } __packed;
202*4882a593Smuzhiyun 
203*4882a593Smuzhiyun /* PDO: Power Data Object */
204*4882a593Smuzhiyun #define PDO_MAX_OBJECTS		7
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun enum pd_pdo_type {
207*4882a593Smuzhiyun 	PDO_TYPE_FIXED = 0,
208*4882a593Smuzhiyun 	PDO_TYPE_BATT = 1,
209*4882a593Smuzhiyun 	PDO_TYPE_VAR = 2,
210*4882a593Smuzhiyun 	PDO_TYPE_APDO = 3,
211*4882a593Smuzhiyun };
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun #define PDO_TYPE_SHIFT		30
214*4882a593Smuzhiyun #define PDO_TYPE_MASK		0x3
215*4882a593Smuzhiyun 
216*4882a593Smuzhiyun #define PDO_TYPE(t)	((t) << PDO_TYPE_SHIFT)
217*4882a593Smuzhiyun 
218*4882a593Smuzhiyun #define PDO_VOLT_MASK		0x3ff
219*4882a593Smuzhiyun #define PDO_CURR_MASK		0x3ff
220*4882a593Smuzhiyun #define PDO_PWR_MASK		0x3ff
221*4882a593Smuzhiyun 
222*4882a593Smuzhiyun #define PDO_FIXED_DUAL_ROLE		BIT(29)	/* Power role swap supported */
223*4882a593Smuzhiyun #define PDO_FIXED_SUSPEND		BIT(28) /* USB Suspend supported (Source) */
224*4882a593Smuzhiyun #define PDO_FIXED_HIGHER_CAP		BIT(28) /* Requires more than vSafe5V (Sink) */
225*4882a593Smuzhiyun #define PDO_FIXED_EXTPOWER		BIT(27) /* Externally powered */
226*4882a593Smuzhiyun #define PDO_FIXED_USB_COMM		BIT(26) /* USB communications capable */
227*4882a593Smuzhiyun #define PDO_FIXED_DATA_SWAP		BIT(25) /* Data role swap supported */
228*4882a593Smuzhiyun #define PDO_FIXED_UNCHUNK_EXT		BIT(24) /* Unchunked Extended Message supported (Source) */
229*4882a593Smuzhiyun #define PDO_FIXED_FRS_CURR_MASK		(BIT(24) | BIT(23)) /* FR_Swap Current (Sink) */
230*4882a593Smuzhiyun #define PDO_FIXED_FRS_CURR_SHIFT	23
231*4882a593Smuzhiyun #define PDO_FIXED_VOLT_SHIFT		10	/* 50mV units */
232*4882a593Smuzhiyun #define PDO_FIXED_CURR_SHIFT		0	/* 10mA units */
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun #define PDO_FIXED_VOLT(mv)	((((mv) / 50) & PDO_VOLT_MASK) << PDO_FIXED_VOLT_SHIFT)
235*4882a593Smuzhiyun #define PDO_FIXED_CURR(ma)	((((ma) / 10) & PDO_CURR_MASK) << PDO_FIXED_CURR_SHIFT)
236*4882a593Smuzhiyun 
237*4882a593Smuzhiyun #define PDO_FIXED(mv, ma, flags)			\
238*4882a593Smuzhiyun 	(PDO_TYPE(PDO_TYPE_FIXED) | (flags) |		\
239*4882a593Smuzhiyun 	 PDO_FIXED_VOLT(mv) | PDO_FIXED_CURR(ma))
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun #define VSAFE5V 5000 /* mv units */
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun #define PDO_BATT_MAX_VOLT_SHIFT	20	/* 50mV units */
244*4882a593Smuzhiyun #define PDO_BATT_MIN_VOLT_SHIFT	10	/* 50mV units */
245*4882a593Smuzhiyun #define PDO_BATT_MAX_PWR_SHIFT	0	/* 250mW units */
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun #define PDO_BATT_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MIN_VOLT_SHIFT)
248*4882a593Smuzhiyun #define PDO_BATT_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_BATT_MAX_VOLT_SHIFT)
249*4882a593Smuzhiyun #define PDO_BATT_MAX_POWER(mw) ((((mw) / 250) & PDO_PWR_MASK) << PDO_BATT_MAX_PWR_SHIFT)
250*4882a593Smuzhiyun 
251*4882a593Smuzhiyun #define PDO_BATT(min_mv, max_mv, max_mw)			\
252*4882a593Smuzhiyun 	(PDO_TYPE(PDO_TYPE_BATT) | PDO_BATT_MIN_VOLT(min_mv) |	\
253*4882a593Smuzhiyun 	 PDO_BATT_MAX_VOLT(max_mv) | PDO_BATT_MAX_POWER(max_mw))
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun #define PDO_VAR_MAX_VOLT_SHIFT	20	/* 50mV units */
256*4882a593Smuzhiyun #define PDO_VAR_MIN_VOLT_SHIFT	10	/* 50mV units */
257*4882a593Smuzhiyun #define PDO_VAR_MAX_CURR_SHIFT	0	/* 10mA units */
258*4882a593Smuzhiyun 
259*4882a593Smuzhiyun #define PDO_VAR_MIN_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MIN_VOLT_SHIFT)
260*4882a593Smuzhiyun #define PDO_VAR_MAX_VOLT(mv) ((((mv) / 50) & PDO_VOLT_MASK) << PDO_VAR_MAX_VOLT_SHIFT)
261*4882a593Smuzhiyun #define PDO_VAR_MAX_CURR(ma) ((((ma) / 10) & PDO_CURR_MASK) << PDO_VAR_MAX_CURR_SHIFT)
262*4882a593Smuzhiyun 
263*4882a593Smuzhiyun #define PDO_VAR(min_mv, max_mv, max_ma)				\
264*4882a593Smuzhiyun 	(PDO_TYPE(PDO_TYPE_VAR) | PDO_VAR_MIN_VOLT(min_mv) |	\
265*4882a593Smuzhiyun 	 PDO_VAR_MAX_VOLT(max_mv) | PDO_VAR_MAX_CURR(max_ma))
266*4882a593Smuzhiyun 
267*4882a593Smuzhiyun enum pd_apdo_type {
268*4882a593Smuzhiyun 	APDO_TYPE_PPS = 0,
269*4882a593Smuzhiyun };
270*4882a593Smuzhiyun 
271*4882a593Smuzhiyun #define PDO_APDO_TYPE_SHIFT	28	/* Only valid value currently is 0x0 - PPS */
272*4882a593Smuzhiyun #define PDO_APDO_TYPE_MASK	0x3
273*4882a593Smuzhiyun 
274*4882a593Smuzhiyun #define PDO_APDO_TYPE(t)	((t) << PDO_APDO_TYPE_SHIFT)
275*4882a593Smuzhiyun 
276*4882a593Smuzhiyun #define PDO_PPS_APDO_MAX_VOLT_SHIFT	17	/* 100mV units */
277*4882a593Smuzhiyun #define PDO_PPS_APDO_MIN_VOLT_SHIFT	8	/* 100mV units */
278*4882a593Smuzhiyun #define PDO_PPS_APDO_MAX_CURR_SHIFT	0	/* 50mA units */
279*4882a593Smuzhiyun 
280*4882a593Smuzhiyun #define PDO_PPS_APDO_VOLT_MASK	0xff
281*4882a593Smuzhiyun #define PDO_PPS_APDO_CURR_MASK	0x7f
282*4882a593Smuzhiyun 
283*4882a593Smuzhiyun #define PDO_PPS_APDO_MIN_VOLT(mv)	\
284*4882a593Smuzhiyun 	((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MIN_VOLT_SHIFT)
285*4882a593Smuzhiyun #define PDO_PPS_APDO_MAX_VOLT(mv)	\
286*4882a593Smuzhiyun 	((((mv) / 100) & PDO_PPS_APDO_VOLT_MASK) << PDO_PPS_APDO_MAX_VOLT_SHIFT)
287*4882a593Smuzhiyun #define PDO_PPS_APDO_MAX_CURR(ma)	\
288*4882a593Smuzhiyun 	((((ma) / 50) & PDO_PPS_APDO_CURR_MASK) << PDO_PPS_APDO_MAX_CURR_SHIFT)
289*4882a593Smuzhiyun 
290*4882a593Smuzhiyun #define PDO_PPS_APDO(min_mv, max_mv, max_ma)				\
291*4882a593Smuzhiyun 	(PDO_TYPE(PDO_TYPE_APDO) | PDO_APDO_TYPE(APDO_TYPE_PPS) |	\
292*4882a593Smuzhiyun 	PDO_PPS_APDO_MIN_VOLT(min_mv) | PDO_PPS_APDO_MAX_VOLT(max_mv) |	\
293*4882a593Smuzhiyun 	PDO_PPS_APDO_MAX_CURR(max_ma))
294*4882a593Smuzhiyun 
pdo_type(u32 pdo)295*4882a593Smuzhiyun static inline enum pd_pdo_type pdo_type(u32 pdo)
296*4882a593Smuzhiyun {
297*4882a593Smuzhiyun 	return (pdo >> PDO_TYPE_SHIFT) & PDO_TYPE_MASK;
298*4882a593Smuzhiyun }
299*4882a593Smuzhiyun 
pdo_fixed_voltage(u32 pdo)300*4882a593Smuzhiyun static inline unsigned int pdo_fixed_voltage(u32 pdo)
301*4882a593Smuzhiyun {
302*4882a593Smuzhiyun 	return ((pdo >> PDO_FIXED_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
303*4882a593Smuzhiyun }
304*4882a593Smuzhiyun 
pdo_min_voltage(u32 pdo)305*4882a593Smuzhiyun static inline unsigned int pdo_min_voltage(u32 pdo)
306*4882a593Smuzhiyun {
307*4882a593Smuzhiyun 	return ((pdo >> PDO_VAR_MIN_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
308*4882a593Smuzhiyun }
309*4882a593Smuzhiyun 
pdo_max_voltage(u32 pdo)310*4882a593Smuzhiyun static inline unsigned int pdo_max_voltage(u32 pdo)
311*4882a593Smuzhiyun {
312*4882a593Smuzhiyun 	return ((pdo >> PDO_VAR_MAX_VOLT_SHIFT) & PDO_VOLT_MASK) * 50;
313*4882a593Smuzhiyun }
314*4882a593Smuzhiyun 
pdo_max_current(u32 pdo)315*4882a593Smuzhiyun static inline unsigned int pdo_max_current(u32 pdo)
316*4882a593Smuzhiyun {
317*4882a593Smuzhiyun 	return ((pdo >> PDO_VAR_MAX_CURR_SHIFT) & PDO_CURR_MASK) * 10;
318*4882a593Smuzhiyun }
319*4882a593Smuzhiyun 
pdo_max_power(u32 pdo)320*4882a593Smuzhiyun static inline unsigned int pdo_max_power(u32 pdo)
321*4882a593Smuzhiyun {
322*4882a593Smuzhiyun 	return ((pdo >> PDO_BATT_MAX_PWR_SHIFT) & PDO_PWR_MASK) * 250;
323*4882a593Smuzhiyun }
324*4882a593Smuzhiyun 
pdo_apdo_type(u32 pdo)325*4882a593Smuzhiyun static inline enum pd_apdo_type pdo_apdo_type(u32 pdo)
326*4882a593Smuzhiyun {
327*4882a593Smuzhiyun 	return (pdo >> PDO_APDO_TYPE_SHIFT) & PDO_APDO_TYPE_MASK;
328*4882a593Smuzhiyun }
329*4882a593Smuzhiyun 
pdo_pps_apdo_min_voltage(u32 pdo)330*4882a593Smuzhiyun static inline unsigned int pdo_pps_apdo_min_voltage(u32 pdo)
331*4882a593Smuzhiyun {
332*4882a593Smuzhiyun 	return ((pdo >> PDO_PPS_APDO_MIN_VOLT_SHIFT) &
333*4882a593Smuzhiyun 		PDO_PPS_APDO_VOLT_MASK) * 100;
334*4882a593Smuzhiyun }
335*4882a593Smuzhiyun 
pdo_pps_apdo_max_voltage(u32 pdo)336*4882a593Smuzhiyun static inline unsigned int pdo_pps_apdo_max_voltage(u32 pdo)
337*4882a593Smuzhiyun {
338*4882a593Smuzhiyun 	return ((pdo >> PDO_PPS_APDO_MAX_VOLT_SHIFT) &
339*4882a593Smuzhiyun 		PDO_PPS_APDO_VOLT_MASK) * 100;
340*4882a593Smuzhiyun }
341*4882a593Smuzhiyun 
pdo_pps_apdo_max_current(u32 pdo)342*4882a593Smuzhiyun static inline unsigned int pdo_pps_apdo_max_current(u32 pdo)
343*4882a593Smuzhiyun {
344*4882a593Smuzhiyun 	return ((pdo >> PDO_PPS_APDO_MAX_CURR_SHIFT) &
345*4882a593Smuzhiyun 		PDO_PPS_APDO_CURR_MASK) * 50;
346*4882a593Smuzhiyun }
347*4882a593Smuzhiyun 
348*4882a593Smuzhiyun /* RDO: Request Data Object */
349*4882a593Smuzhiyun #define RDO_OBJ_POS_SHIFT	28
350*4882a593Smuzhiyun #define RDO_OBJ_POS_MASK	0x7
351*4882a593Smuzhiyun #define RDO_GIVE_BACK		BIT(27)	/* Supports reduced operating current */
352*4882a593Smuzhiyun #define RDO_CAP_MISMATCH	BIT(26) /* Not satisfied by source caps */
353*4882a593Smuzhiyun #define RDO_USB_COMM		BIT(25) /* USB communications capable */
354*4882a593Smuzhiyun #define RDO_NO_SUSPEND		BIT(24) /* USB Suspend not supported */
355*4882a593Smuzhiyun 
356*4882a593Smuzhiyun #define RDO_PWR_MASK			0x3ff
357*4882a593Smuzhiyun #define RDO_CURR_MASK			0x3ff
358*4882a593Smuzhiyun 
359*4882a593Smuzhiyun #define RDO_FIXED_OP_CURR_SHIFT		10
360*4882a593Smuzhiyun #define RDO_FIXED_MAX_CURR_SHIFT	0
361*4882a593Smuzhiyun 
362*4882a593Smuzhiyun #define RDO_OBJ(idx) (((idx) & RDO_OBJ_POS_MASK) << RDO_OBJ_POS_SHIFT)
363*4882a593Smuzhiyun 
364*4882a593Smuzhiyun #define PDO_FIXED_OP_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_OP_CURR_SHIFT)
365*4882a593Smuzhiyun #define PDO_FIXED_MAX_CURR(ma) ((((ma) / 10) & RDO_CURR_MASK) << RDO_FIXED_MAX_CURR_SHIFT)
366*4882a593Smuzhiyun 
367*4882a593Smuzhiyun #define RDO_FIXED(idx, op_ma, max_ma, flags)			\
368*4882a593Smuzhiyun 	(RDO_OBJ(idx) | (flags) |				\
369*4882a593Smuzhiyun 	 PDO_FIXED_OP_CURR(op_ma) | PDO_FIXED_MAX_CURR(max_ma))
370*4882a593Smuzhiyun 
371*4882a593Smuzhiyun #define RDO_BATT_OP_PWR_SHIFT		10	/* 250mW units */
372*4882a593Smuzhiyun #define RDO_BATT_MAX_PWR_SHIFT		0	/* 250mW units */
373*4882a593Smuzhiyun 
374*4882a593Smuzhiyun #define RDO_BATT_OP_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_OP_PWR_SHIFT)
375*4882a593Smuzhiyun #define RDO_BATT_MAX_PWR(mw) ((((mw) / 250) & RDO_PWR_MASK) << RDO_BATT_MAX_PWR_SHIFT)
376*4882a593Smuzhiyun 
377*4882a593Smuzhiyun #define RDO_BATT(idx, op_mw, max_mw, flags)			\
378*4882a593Smuzhiyun 	(RDO_OBJ(idx) | (flags) |				\
379*4882a593Smuzhiyun 	 RDO_BATT_OP_PWR(op_mw) | RDO_BATT_MAX_PWR(max_mw))
380*4882a593Smuzhiyun 
381*4882a593Smuzhiyun #define RDO_PROG_VOLT_MASK	0x7ff
382*4882a593Smuzhiyun #define RDO_PROG_CURR_MASK	0x7f
383*4882a593Smuzhiyun 
384*4882a593Smuzhiyun #define RDO_PROG_VOLT_SHIFT	9
385*4882a593Smuzhiyun #define RDO_PROG_CURR_SHIFT	0
386*4882a593Smuzhiyun 
387*4882a593Smuzhiyun #define RDO_PROG_VOLT_MV_STEP	20
388*4882a593Smuzhiyun #define RDO_PROG_CURR_MA_STEP	50
389*4882a593Smuzhiyun 
390*4882a593Smuzhiyun #define PDO_PROG_OUT_VOLT(mv)	\
391*4882a593Smuzhiyun 	((((mv) / RDO_PROG_VOLT_MV_STEP) & RDO_PROG_VOLT_MASK) << RDO_PROG_VOLT_SHIFT)
392*4882a593Smuzhiyun #define PDO_PROG_OP_CURR(ma)	\
393*4882a593Smuzhiyun 	((((ma) / RDO_PROG_CURR_MA_STEP) & RDO_PROG_CURR_MASK) << RDO_PROG_CURR_SHIFT)
394*4882a593Smuzhiyun 
395*4882a593Smuzhiyun #define RDO_PROG(idx, out_mv, op_ma, flags)			\
396*4882a593Smuzhiyun 	(RDO_OBJ(idx) | (flags) |				\
397*4882a593Smuzhiyun 	 PDO_PROG_OUT_VOLT(out_mv) | PDO_PROG_OP_CURR(op_ma))
398*4882a593Smuzhiyun 
rdo_index(u32 rdo)399*4882a593Smuzhiyun static inline unsigned int rdo_index(u32 rdo)
400*4882a593Smuzhiyun {
401*4882a593Smuzhiyun 	return (rdo >> RDO_OBJ_POS_SHIFT) & RDO_OBJ_POS_MASK;
402*4882a593Smuzhiyun }
403*4882a593Smuzhiyun 
rdo_op_current(u32 rdo)404*4882a593Smuzhiyun static inline unsigned int rdo_op_current(u32 rdo)
405*4882a593Smuzhiyun {
406*4882a593Smuzhiyun 	return ((rdo >> RDO_FIXED_OP_CURR_SHIFT) & RDO_CURR_MASK) * 10;
407*4882a593Smuzhiyun }
408*4882a593Smuzhiyun 
rdo_max_current(u32 rdo)409*4882a593Smuzhiyun static inline unsigned int rdo_max_current(u32 rdo)
410*4882a593Smuzhiyun {
411*4882a593Smuzhiyun 	return ((rdo >> RDO_FIXED_MAX_CURR_SHIFT) &
412*4882a593Smuzhiyun 		RDO_CURR_MASK) * 10;
413*4882a593Smuzhiyun }
414*4882a593Smuzhiyun 
rdo_op_power(u32 rdo)415*4882a593Smuzhiyun static inline unsigned int rdo_op_power(u32 rdo)
416*4882a593Smuzhiyun {
417*4882a593Smuzhiyun 	return ((rdo >> RDO_BATT_OP_PWR_SHIFT) & RDO_PWR_MASK) * 250;
418*4882a593Smuzhiyun }
419*4882a593Smuzhiyun 
rdo_max_power(u32 rdo)420*4882a593Smuzhiyun static inline unsigned int rdo_max_power(u32 rdo)
421*4882a593Smuzhiyun {
422*4882a593Smuzhiyun 	return ((rdo >> RDO_BATT_MAX_PWR_SHIFT) & RDO_PWR_MASK) * 250;
423*4882a593Smuzhiyun }
424*4882a593Smuzhiyun 
425*4882a593Smuzhiyun /* Enter_USB Data Object */
426*4882a593Smuzhiyun #define EUDO_USB_MODE_MASK		GENMASK(30, 28)
427*4882a593Smuzhiyun #define EUDO_USB_MODE_SHIFT		28
428*4882a593Smuzhiyun #define   EUDO_USB_MODE_USB2		0
429*4882a593Smuzhiyun #define   EUDO_USB_MODE_USB3		1
430*4882a593Smuzhiyun #define   EUDO_USB_MODE_USB4		2
431*4882a593Smuzhiyun #define EUDO_USB4_DRD			BIT(26)
432*4882a593Smuzhiyun #define EUDO_USB3_DRD			BIT(25)
433*4882a593Smuzhiyun #define EUDO_CABLE_SPEED_MASK		GENMASK(23, 21)
434*4882a593Smuzhiyun #define EUDO_CABLE_SPEED_SHIFT		21
435*4882a593Smuzhiyun #define   EUDO_CABLE_SPEED_USB2		0
436*4882a593Smuzhiyun #define   EUDO_CABLE_SPEED_USB3_GEN1	1
437*4882a593Smuzhiyun #define   EUDO_CABLE_SPEED_USB4_GEN2	2
438*4882a593Smuzhiyun #define   EUDO_CABLE_SPEED_USB4_GEN3	3
439*4882a593Smuzhiyun #define EUDO_CABLE_TYPE_MASK		GENMASK(20, 19)
440*4882a593Smuzhiyun #define EUDO_CABLE_TYPE_SHIFT		19
441*4882a593Smuzhiyun #define   EUDO_CABLE_TYPE_PASSIVE	0
442*4882a593Smuzhiyun #define   EUDO_CABLE_TYPE_RE_TIMER	1
443*4882a593Smuzhiyun #define   EUDO_CABLE_TYPE_RE_DRIVER	2
444*4882a593Smuzhiyun #define   EUDO_CABLE_TYPE_OPTICAL	3
445*4882a593Smuzhiyun #define EUDO_CABLE_CURRENT_MASK		GENMASK(18, 17)
446*4882a593Smuzhiyun #define EUDO_CABLE_CURRENT_SHIFT	17
447*4882a593Smuzhiyun #define   EUDO_CABLE_CURRENT_NOTSUPP	0
448*4882a593Smuzhiyun #define   EUDO_CABLE_CURRENT_3A		2
449*4882a593Smuzhiyun #define   EUDO_CABLE_CURRENT_5A		3
450*4882a593Smuzhiyun #define EUDO_PCIE_SUPPORT		BIT(16)
451*4882a593Smuzhiyun #define EUDO_DP_SUPPORT			BIT(15)
452*4882a593Smuzhiyun #define EUDO_TBT_SUPPORT		BIT(14)
453*4882a593Smuzhiyun #define EUDO_HOST_PRESENT		BIT(13)
454*4882a593Smuzhiyun 
455*4882a593Smuzhiyun /* USB PD timers and counters */
456*4882a593Smuzhiyun #define PD_T_NO_RESPONSE	5000	/* 4.5 - 5.5 seconds */
457*4882a593Smuzhiyun #define PD_T_DB_DETECT		10000	/* 10 - 15 seconds */
458*4882a593Smuzhiyun #define PD_T_SEND_SOURCE_CAP	150	/* 100 - 200 ms */
459*4882a593Smuzhiyun #define PD_T_SENDER_RESPONSE	60	/* 24 - 30 ms, relaxed */
460*4882a593Smuzhiyun #define PD_T_RECEIVER_RESPONSE	15	/* 15ms max */
461*4882a593Smuzhiyun #define PD_T_SOURCE_ACTIVITY	45
462*4882a593Smuzhiyun #define PD_T_SINK_ACTIVITY	135
463*4882a593Smuzhiyun #define PD_T_SINK_WAIT_CAP	310	/* 310 - 620 ms */
464*4882a593Smuzhiyun #define PD_T_PS_TRANSITION	500
465*4882a593Smuzhiyun #define PD_T_SRC_TRANSITION	35
466*4882a593Smuzhiyun #define PD_T_DRP_SNK		40
467*4882a593Smuzhiyun #define PD_T_DRP_SRC		30
468*4882a593Smuzhiyun #define PD_T_PS_SOURCE_OFF	920
469*4882a593Smuzhiyun #define PD_T_PS_SOURCE_ON	480
470*4882a593Smuzhiyun #define PD_T_PS_SOURCE_ON_PRS	450	/* 390 - 480ms */
471*4882a593Smuzhiyun #define PD_T_PS_HARD_RESET	30
472*4882a593Smuzhiyun #define PD_T_SRC_RECOVER	760
473*4882a593Smuzhiyun #define PD_T_SRC_RECOVER_MAX	1000
474*4882a593Smuzhiyun #define PD_T_SRC_TURN_ON	275
475*4882a593Smuzhiyun #define PD_T_SAFE_0V		650
476*4882a593Smuzhiyun #define PD_T_VCONN_SOURCE_ON	100
477*4882a593Smuzhiyun #define PD_T_SINK_REQUEST	100	/* 100 ms minimum */
478*4882a593Smuzhiyun #define PD_T_ERROR_RECOVERY	100	/* minimum 25 is insufficient */
479*4882a593Smuzhiyun #define PD_T_SRCSWAPSTDBY	625	/* Maximum of 650ms */
480*4882a593Smuzhiyun #define PD_T_NEWSRC		250	/* Maximum of 275ms */
481*4882a593Smuzhiyun #define PD_T_SWAP_SRC_START	20	/* Minimum of 20ms */
482*4882a593Smuzhiyun #define PD_T_BIST_CONT_MODE	50	/* 30 - 60 ms */
483*4882a593Smuzhiyun #define PD_T_SINK_TX		16	/* 16 - 20 ms */
484*4882a593Smuzhiyun #define PD_T_CHUNK_NOT_SUPP	42	/* 40 - 50 ms */
485*4882a593Smuzhiyun 
486*4882a593Smuzhiyun #define PD_T_DRP_TRY		100	/* 75 - 150 ms */
487*4882a593Smuzhiyun #define PD_T_DRP_TRYWAIT	600	/* 400 - 800 ms */
488*4882a593Smuzhiyun 
489*4882a593Smuzhiyun #define PD_T_CC_DEBOUNCE	200	/* 100 - 200 ms */
490*4882a593Smuzhiyun #define PD_T_PD_DEBOUNCE	20	/* 10 - 20 ms */
491*4882a593Smuzhiyun #define PD_T_TRY_CC_DEBOUNCE	15	/* 10 - 20 ms */
492*4882a593Smuzhiyun 
493*4882a593Smuzhiyun #define PD_N_CAPS_COUNT		(PD_T_NO_RESPONSE / PD_T_SEND_SOURCE_CAP)
494*4882a593Smuzhiyun #define PD_N_HARD_RESET_COUNT	2
495*4882a593Smuzhiyun 
496*4882a593Smuzhiyun #define PD_P_SNK_STDBY_MW	2500	/* 2500 mW */
497*4882a593Smuzhiyun 
498*4882a593Smuzhiyun #endif /* __LINUX_USB_PD_H */
499