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