xref: /rk3399_rockchip-uboot/include/power/power_delivery/pd_vdo.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_VDO_H
7*a2c81616SWang Jie #define __LINUX_USB_PD_VDO_H
8*a2c81616SWang Jie 
9*a2c81616SWang Jie #include "pd.h"
10*a2c81616SWang Jie 
11*a2c81616SWang Jie /*
12*a2c81616SWang Jie  * VDO : Vendor Defined Message Object
13*a2c81616SWang Jie  * VDM object is minimum of VDM header + 6 additional data objects.
14*a2c81616SWang Jie  */
15*a2c81616SWang Jie 
16*a2c81616SWang Jie #define VDO_MAX_OBJECTS		6
17*a2c81616SWang Jie #define VDO_MAX_SIZE		(VDO_MAX_OBJECTS + 1)
18*a2c81616SWang Jie 
19*a2c81616SWang Jie /*
20*a2c81616SWang Jie  * VDM header
21*a2c81616SWang Jie  * ----------
22*a2c81616SWang Jie  * <31:16>  :: SVID
23*a2c81616SWang Jie  * <15>     :: VDM type ( 1b == structured, 0b == unstructured )
24*a2c81616SWang Jie  * <14:13>  :: Structured VDM version
25*a2c81616SWang Jie  * <12:11>  :: reserved
26*a2c81616SWang Jie  * <10:8>   :: object position (1-7 valid ... used for enter/exit mode only)
27*a2c81616SWang Jie  * <7:6>    :: command type (SVDM only?)
28*a2c81616SWang Jie  * <5>      :: reserved (SVDM), command type (UVDM)
29*a2c81616SWang Jie  * <4:0>    :: command
30*a2c81616SWang Jie  */
31*a2c81616SWang Jie #define VDO(vid, type, ver, custom)			\
32*a2c81616SWang Jie 	(((vid) << 16) |				\
33*a2c81616SWang Jie 	 ((type) << 15) |				\
34*a2c81616SWang Jie 	 ((ver) << 13) |				\
35*a2c81616SWang Jie 	 ((custom) & 0x7FFF))
36*a2c81616SWang Jie 
37*a2c81616SWang Jie #define VDO_SVDM_TYPE		(1 << 15)
38*a2c81616SWang Jie #define VDO_SVDM_VERS(x)	((x) << 13)
39*a2c81616SWang Jie #define VDO_OPOS(x)		((x) << 8)
40*a2c81616SWang Jie #define VDO_CMDT(x)		((x) << 6)
41*a2c81616SWang Jie #define VDO_SVDM_VERS_MASK	VDO_SVDM_VERS(0x3)
42*a2c81616SWang Jie #define VDO_OPOS_MASK		VDO_OPOS(0x7)
43*a2c81616SWang Jie #define VDO_CMDT_MASK		VDO_CMDT(0x3)
44*a2c81616SWang Jie 
45*a2c81616SWang Jie #define CMDT_INIT		0
46*a2c81616SWang Jie #define CMDT_RSP_ACK		1
47*a2c81616SWang Jie #define CMDT_RSP_NAK		2
48*a2c81616SWang Jie #define CMDT_RSP_BUSY		3
49*a2c81616SWang Jie 
50*a2c81616SWang Jie /* reserved for SVDM ... for Google UVDM */
51*a2c81616SWang Jie #define VDO_SRC_INITIATOR	(0 << 5)
52*a2c81616SWang Jie #define VDO_SRC_RESPONDER	(1 << 5)
53*a2c81616SWang Jie 
54*a2c81616SWang Jie #define CMD_DISCOVER_IDENT	1
55*a2c81616SWang Jie #define CMD_DISCOVER_SVID	2
56*a2c81616SWang Jie #define CMD_DISCOVER_MODES	3
57*a2c81616SWang Jie #define CMD_ENTER_MODE		4
58*a2c81616SWang Jie #define CMD_EXIT_MODE		5
59*a2c81616SWang Jie #define CMD_ATTENTION		6
60*a2c81616SWang Jie 
61*a2c81616SWang Jie #define VDO_CMD_VENDOR(x)    (((0x10 + (x)) & 0x1f))
62*a2c81616SWang Jie 
63*a2c81616SWang Jie /* ChromeOS specific commands */
64*a2c81616SWang Jie #define VDO_CMD_VERSION		VDO_CMD_VENDOR(0)
65*a2c81616SWang Jie #define VDO_CMD_SEND_INFO	VDO_CMD_VENDOR(1)
66*a2c81616SWang Jie #define VDO_CMD_READ_INFO	VDO_CMD_VENDOR(2)
67*a2c81616SWang Jie #define VDO_CMD_REBOOT		VDO_CMD_VENDOR(5)
68*a2c81616SWang Jie #define VDO_CMD_FLASH_ERASE	VDO_CMD_VENDOR(6)
69*a2c81616SWang Jie #define VDO_CMD_FLASH_WRITE	VDO_CMD_VENDOR(7)
70*a2c81616SWang Jie #define VDO_CMD_ERASE_SIG	VDO_CMD_VENDOR(8)
71*a2c81616SWang Jie #define VDO_CMD_PING_ENABLE	VDO_CMD_VENDOR(10)
72*a2c81616SWang Jie #define VDO_CMD_CURRENT		VDO_CMD_VENDOR(11)
73*a2c81616SWang Jie #define VDO_CMD_FLIP		VDO_CMD_VENDOR(12)
74*a2c81616SWang Jie #define VDO_CMD_GET_LOG		VDO_CMD_VENDOR(13)
75*a2c81616SWang Jie #define VDO_CMD_CCD_EN		VDO_CMD_VENDOR(14)
76*a2c81616SWang Jie 
77*a2c81616SWang Jie #define PD_VDO_VID(vdo)		((vdo) >> 16)
78*a2c81616SWang Jie #define PD_VDO_SVDM(vdo)	(((vdo) >> 15) & 1)
79*a2c81616SWang Jie #define PD_VDO_SVDM_VER(vdo)	(((vdo) >> 13) & 0x3)
80*a2c81616SWang Jie #define PD_VDO_OPOS(vdo)	(((vdo) >> 8) & 0x7)
81*a2c81616SWang Jie #define PD_VDO_CMD(vdo)		((vdo) & 0x1f)
82*a2c81616SWang Jie #define PD_VDO_CMDT(vdo)	(((vdo) >> 6) & 0x3)
83*a2c81616SWang Jie 
84*a2c81616SWang Jie /*
85*a2c81616SWang Jie  * SVDM Identity request -> response
86*a2c81616SWang Jie  *
87*a2c81616SWang Jie  * Request is simply properly formatted SVDM header
88*a2c81616SWang Jie  *
89*a2c81616SWang Jie  * Response is 4 data objects:
90*a2c81616SWang Jie  * [0] :: SVDM header
91*a2c81616SWang Jie  * [1] :: Identitiy header
92*a2c81616SWang Jie  * [2] :: Cert Stat VDO
93*a2c81616SWang Jie  * [3] :: (Product | Cable) VDO
94*a2c81616SWang Jie  * [4] :: AMA VDO
95*a2c81616SWang Jie  *
96*a2c81616SWang Jie  */
97*a2c81616SWang Jie #define VDO_INDEX_HDR		0
98*a2c81616SWang Jie #define VDO_INDEX_IDH		1
99*a2c81616SWang Jie #define VDO_INDEX_CSTAT		2
100*a2c81616SWang Jie #define VDO_INDEX_CABLE		3
101*a2c81616SWang Jie #define VDO_INDEX_PRODUCT	3
102*a2c81616SWang Jie #define VDO_INDEX_AMA		4
103*a2c81616SWang Jie 
104*a2c81616SWang Jie /*
105*a2c81616SWang Jie  * SVDM Identity Header
106*a2c81616SWang Jie  * --------------------
107*a2c81616SWang Jie  * <31>     :: data capable as a USB host
108*a2c81616SWang Jie  * <30>     :: data capable as a USB device
109*a2c81616SWang Jie  * <29:27>  :: product type (UFP / Cable / VPD)
110*a2c81616SWang Jie  * <26>     :: modal operation supported (1b == yes)
111*a2c81616SWang Jie  * <25:23>  :: product type (DFP) (SVDM version 2.0+ only; set to zero in version 1.0)
112*a2c81616SWang Jie  * <22:21>  :: connector type (SVDM version 2.0+ only; set to zero in version 1.0)
113*a2c81616SWang Jie  * <20:16>  :: Reserved, Shall be set to zero
114*a2c81616SWang Jie  * <15:0>   :: USB-IF assigned VID for this cable vendor
115*a2c81616SWang Jie  */
116*a2c81616SWang Jie 
117*a2c81616SWang Jie /* PD Rev2.0 definition */
118*a2c81616SWang Jie #define IDH_PTYPE_UNDEF		0
119*a2c81616SWang Jie 
120*a2c81616SWang Jie /* SOP Product Type (UFP) */
121*a2c81616SWang Jie #define IDH_PTYPE_NOT_UFP	0
122*a2c81616SWang Jie #define IDH_PTYPE_HUB		1
123*a2c81616SWang Jie #define IDH_PTYPE_PERIPH	2
124*a2c81616SWang Jie #define IDH_PTYPE_PSD		3
125*a2c81616SWang Jie #define IDH_PTYPE_AMA		5
126*a2c81616SWang Jie 
127*a2c81616SWang Jie /* SOP' Product Type (Cable Plug / VPD) */
128*a2c81616SWang Jie #define IDH_PTYPE_NOT_CABLE	0
129*a2c81616SWang Jie #define IDH_PTYPE_PCABLE	3
130*a2c81616SWang Jie #define IDH_PTYPE_ACABLE	4
131*a2c81616SWang Jie #define IDH_PTYPE_VPD		6
132*a2c81616SWang Jie 
133*a2c81616SWang Jie /* SOP Product Type (DFP) */
134*a2c81616SWang Jie #define IDH_PTYPE_NOT_DFP	0
135*a2c81616SWang Jie #define IDH_PTYPE_DFP_HUB	1
136*a2c81616SWang Jie #define IDH_PTYPE_DFP_HOST	2
137*a2c81616SWang Jie #define IDH_PTYPE_DFP_PB	3
138*a2c81616SWang Jie 
139*a2c81616SWang Jie /* ID Header Mask */
140*a2c81616SWang Jie #define IDH_DFP_MASK		GENMASK(25, 23)
141*a2c81616SWang Jie #define IDH_CONN_MASK		GENMASK(22, 21)
142*a2c81616SWang Jie 
143*a2c81616SWang Jie #define VDO_IDH(usbh, usbd, ufp_cable, is_modal, dfp, conn, vid)		\
144*a2c81616SWang Jie 	((usbh) << 31 | (usbd) << 30 | ((ufp_cable) & 0x7) << 27		\
145*a2c81616SWang Jie 	 | (is_modal) << 26 | ((dfp) & 0x7) << 23 | ((conn) & 0x3) << 21	\
146*a2c81616SWang Jie 	 | ((vid) & 0xffff))
147*a2c81616SWang Jie 
148*a2c81616SWang Jie #define PD_IDH_PTYPE(vdo)	(((vdo) >> 27) & 0x7)
149*a2c81616SWang Jie #define PD_IDH_VID(vdo)		((vdo) & 0xffff)
150*a2c81616SWang Jie #define PD_IDH_MODAL_SUPP(vdo)	((vdo) & (1 << 26))
151*a2c81616SWang Jie #define PD_IDH_DFP_PTYPE(vdo)	(((vdo) >> 23) & 0x7)
152*a2c81616SWang Jie #define PD_IDH_CONN_TYPE(vdo)	(((vdo) >> 21) & 0x3)
153*a2c81616SWang Jie 
154*a2c81616SWang Jie /*
155*a2c81616SWang Jie  * Cert Stat VDO
156*a2c81616SWang Jie  * -------------
157*a2c81616SWang Jie  * <31:0>  : USB-IF assigned XID for this cable
158*a2c81616SWang Jie  */
159*a2c81616SWang Jie #define PD_CSTAT_XID(vdo)	(vdo)
160*a2c81616SWang Jie #define VDO_CERT(xid)		((xid) & 0xffffffff)
161*a2c81616SWang Jie 
162*a2c81616SWang Jie /*
163*a2c81616SWang Jie  * Product VDO
164*a2c81616SWang Jie  * -----------
165*a2c81616SWang Jie  * <31:16> : USB Product ID
166*a2c81616SWang Jie  * <15:0>  : USB bcdDevice
167*a2c81616SWang Jie  */
168*a2c81616SWang Jie #define VDO_PRODUCT(pid, bcd)	(((pid) & 0xffff) << 16 | ((bcd) & 0xffff))
169*a2c81616SWang Jie #define PD_PRODUCT_PID(vdo)	(((vdo) >> 16) & 0xffff)
170*a2c81616SWang Jie 
171*a2c81616SWang Jie /*
172*a2c81616SWang Jie  * UFP VDO (PD Revision 3.0+ only)
173*a2c81616SWang Jie  * --------
174*a2c81616SWang Jie  * <31:29> :: UFP VDO version
175*a2c81616SWang Jie  * <28>    :: Reserved
176*a2c81616SWang Jie  * <27:24> :: Device capability
177*a2c81616SWang Jie  * <23:22> :: Connector type (10b == receptacle, 11b == captive plug)
178*a2c81616SWang Jie  * <21:11> :: Reserved
179*a2c81616SWang Jie  * <10:8>  :: Vconn power (AMA only)
180*a2c81616SWang Jie  * <7>     :: Vconn required (AMA only, 0b == no, 1b == yes)
181*a2c81616SWang Jie  * <6>     :: Vbus required (AMA only, 0b == yes, 1b == no)
182*a2c81616SWang Jie  * <5:3>   :: Alternate modes
183*a2c81616SWang Jie  * <2:0>   :: USB highest speed
184*a2c81616SWang Jie  */
185*a2c81616SWang Jie #define PD_VDO_UFP_DEVCAP(vdo)	(((vdo) & GENMASK(27, 24)) >> 24)
186*a2c81616SWang Jie 
187*a2c81616SWang Jie /* UFP VDO Version */
188*a2c81616SWang Jie #define UFP_VDO_VER1_2		2
189*a2c81616SWang Jie 
190*a2c81616SWang Jie /* Device Capability */
191*a2c81616SWang Jie #define DEV_USB2_CAPABLE	BIT(0)
192*a2c81616SWang Jie #define DEV_USB2_BILLBOARD	BIT(1)
193*a2c81616SWang Jie #define DEV_USB3_CAPABLE	BIT(2)
194*a2c81616SWang Jie #define DEV_USB4_CAPABLE	BIT(3)
195*a2c81616SWang Jie 
196*a2c81616SWang Jie /* Connector Type */
197*a2c81616SWang Jie #define UFP_RECEPTACLE		2
198*a2c81616SWang Jie #define UFP_CAPTIVE		3
199*a2c81616SWang Jie 
200*a2c81616SWang Jie /* Vconn Power (AMA only, set to AMA_VCONN_NOT_REQ if Vconn is not required) */
201*a2c81616SWang Jie #define AMA_VCONN_PWR_1W	0
202*a2c81616SWang Jie #define AMA_VCONN_PWR_1W5	1
203*a2c81616SWang Jie #define AMA_VCONN_PWR_2W	2
204*a2c81616SWang Jie #define AMA_VCONN_PWR_3W	3
205*a2c81616SWang Jie #define AMA_VCONN_PWR_4W	4
206*a2c81616SWang Jie #define AMA_VCONN_PWR_5W	5
207*a2c81616SWang Jie #define AMA_VCONN_PWR_6W	6
208*a2c81616SWang Jie 
209*a2c81616SWang Jie /* Vconn Required (AMA only) */
210*a2c81616SWang Jie #define AMA_VCONN_NOT_REQ	0
211*a2c81616SWang Jie #define AMA_VCONN_REQ		1
212*a2c81616SWang Jie 
213*a2c81616SWang Jie /* Vbus Required (AMA only) */
214*a2c81616SWang Jie #define AMA_VBUS_REQ		0
215*a2c81616SWang Jie #define AMA_VBUS_NOT_REQ	1
216*a2c81616SWang Jie 
217*a2c81616SWang Jie /* Alternate Modes */
218*a2c81616SWang Jie #define UFP_ALTMODE_NOT_SUPP	0
219*a2c81616SWang Jie #define UFP_ALTMODE_TBT3	BIT(0)
220*a2c81616SWang Jie #define UFP_ALTMODE_RECFG	BIT(1)
221*a2c81616SWang Jie #define UFP_ALTMODE_NO_RECFG	BIT(2)
222*a2c81616SWang Jie 
223*a2c81616SWang Jie /* USB Highest Speed */
224*a2c81616SWang Jie #define UFP_USB2_ONLY		0
225*a2c81616SWang Jie #define UFP_USB32_GEN1		1
226*a2c81616SWang Jie #define UFP_USB32_4_GEN2	2
227*a2c81616SWang Jie #define UFP_USB4_GEN3		3
228*a2c81616SWang Jie 
229*a2c81616SWang Jie #define VDO_UFP(ver, cap, conn, vcpwr, vcr, vbr, alt, spd)			\
230*a2c81616SWang Jie 	(((ver) & 0x7) << 29 | ((cap) & 0xf) << 24 | ((conn) & 0x3) << 22	\
231*a2c81616SWang Jie 	 | ((vcpwr) & 0x7) << 8 | (vcr) << 7 | (vbr) << 6 | ((alt) & 0x7) << 3	\
232*a2c81616SWang Jie 	 | ((spd) & 0x7))
233*a2c81616SWang Jie 
234*a2c81616SWang Jie /*
235*a2c81616SWang Jie  * DFP VDO (PD Revision 3.0+ only)
236*a2c81616SWang Jie  * --------
237*a2c81616SWang Jie  * <31:29> :: DFP VDO version
238*a2c81616SWang Jie  * <28:27> :: Reserved
239*a2c81616SWang Jie  * <26:24> :: Host capability
240*a2c81616SWang Jie  * <23:22> :: Connector type (10b == receptacle, 11b == captive plug)
241*a2c81616SWang Jie  * <21:5>  :: Reserved
242*a2c81616SWang Jie  * <4:0>   :: Port number
243*a2c81616SWang Jie  */
244*a2c81616SWang Jie #define PD_VDO_DFP_HOSTCAP(vdo)	(((vdo) & GENMASK(26, 24)) >> 24)
245*a2c81616SWang Jie 
246*a2c81616SWang Jie #define DFP_VDO_VER1_1		1
247*a2c81616SWang Jie #define HOST_USB2_CAPABLE	BIT(0)
248*a2c81616SWang Jie #define HOST_USB3_CAPABLE	BIT(1)
249*a2c81616SWang Jie #define HOST_USB4_CAPABLE	BIT(2)
250*a2c81616SWang Jie #define DFP_RECEPTACLE		2
251*a2c81616SWang Jie #define DFP_CAPTIVE		3
252*a2c81616SWang Jie 
253*a2c81616SWang Jie #define VDO_DFP(ver, cap, conn, pnum)						\
254*a2c81616SWang Jie 	(((ver) & 0x7) << 29 | ((cap) & 0x7) << 24 | ((conn) & 0x3) << 22	\
255*a2c81616SWang Jie 	 | ((pnum) & 0x1f))
256*a2c81616SWang Jie 
257*a2c81616SWang Jie /*
258*a2c81616SWang Jie  * Cable VDO (for both Passive and Active Cable VDO in PD Rev2.0)
259*a2c81616SWang Jie  * ---------
260*a2c81616SWang Jie  * <31:28> :: Cable HW version
261*a2c81616SWang Jie  * <27:24> :: Cable FW version
262*a2c81616SWang Jie  * <23:20> :: Reserved, Shall be set to zero
263*a2c81616SWang Jie  * <19:18> :: type-C to Type-A/B/C/Captive (00b == A, 01 == B, 10 == C, 11 == Captive)
264*a2c81616SWang Jie  * <17>    :: Reserved, Shall be set to zero
265*a2c81616SWang Jie  * <16:13> :: cable latency (0001 == <10ns(~1m length))
266*a2c81616SWang Jie  * <12:11> :: cable termination type (11b == both ends active VCONN req)
267*a2c81616SWang Jie  * <10>    :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
268*a2c81616SWang Jie  * <9>     :: SSTX2 Directionality support
269*a2c81616SWang Jie  * <8>     :: SSRX1 Directionality support
270*a2c81616SWang Jie  * <7>     :: SSRX2 Directionality support
271*a2c81616SWang Jie  * <6:5>   :: Vbus current handling capability (01b == 3A, 10b == 5A)
272*a2c81616SWang Jie  * <4>     :: Vbus through cable (0b == no, 1b == yes)
273*a2c81616SWang Jie  * <3>     :: SOP" controller present? (0b == no, 1b == yes)
274*a2c81616SWang Jie  * <2:0>   :: USB SS Signaling support
275*a2c81616SWang Jie  *
276*a2c81616SWang Jie  * Passive Cable VDO (PD Rev3.0+)
277*a2c81616SWang Jie  * ---------
278*a2c81616SWang Jie  * <31:28> :: Cable HW version
279*a2c81616SWang Jie  * <27:24> :: Cable FW version
280*a2c81616SWang Jie  * <23:21> :: VDO version
281*a2c81616SWang Jie  * <20>    :: Reserved, Shall be set to zero
282*a2c81616SWang Jie  * <19:18> :: Type-C to Type-C/Captive (10b == C, 11b == Captive)
283*a2c81616SWang Jie  * <17>    :: Reserved, Shall be set to zero
284*a2c81616SWang Jie  * <16:13> :: cable latency (0001 == <10ns(~1m length))
285*a2c81616SWang Jie  * <12:11> :: cable termination type (10b == Vconn not req, 01b == Vconn req)
286*a2c81616SWang Jie  * <10:9>  :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
287*a2c81616SWang Jie  * <8:7>   :: Reserved, Shall be set to zero
288*a2c81616SWang Jie  * <6:5>   :: Vbus current handling capability (01b == 3A, 10b == 5A)
289*a2c81616SWang Jie  * <4:3>   :: Reserved, Shall be set to zero
290*a2c81616SWang Jie  * <2:0>   :: USB highest speed
291*a2c81616SWang Jie  *
292*a2c81616SWang Jie  * Active Cable VDO 1 (PD Rev3.0+)
293*a2c81616SWang Jie  * ---------
294*a2c81616SWang Jie  * <31:28> :: Cable HW version
295*a2c81616SWang Jie  * <27:24> :: Cable FW version
296*a2c81616SWang Jie  * <23:21> :: VDO version
297*a2c81616SWang Jie  * <20>    :: Reserved, Shall be set to zero
298*a2c81616SWang Jie  * <19:18> :: Connector type (10b == C, 11b == Captive)
299*a2c81616SWang Jie  * <17>    :: Reserved, Shall be set to zero
300*a2c81616SWang Jie  * <16:13> :: cable latency (0001 == <10ns(~1m length))
301*a2c81616SWang Jie  * <12:11> :: cable termination type (10b == one end active, 11b == both ends active VCONN req)
302*a2c81616SWang Jie  * <10:9>  :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
303*a2c81616SWang Jie  * <8>     :: SBU supported (0b == supported, 1b == not supported)
304*a2c81616SWang Jie  * <7>     :: SBU type (0b == passive, 1b == active)
305*a2c81616SWang Jie  * <6:5>   :: Vbus current handling capability (01b == 3A, 10b == 5A)
306*a2c81616SWang Jie  * <2:0>   :: USB highest speed
307*a2c81616SWang Jie  */
308*a2c81616SWang Jie /* Cable VDO Version */
309*a2c81616SWang Jie #define CABLE_VDO_VER1_0	0
310*a2c81616SWang Jie #define CABLE_VDO_VER1_3	3
311*a2c81616SWang Jie 
312*a2c81616SWang Jie /* Connector Type (_ATYPE and _BTYPE are for PD Rev2.0 only) */
313*a2c81616SWang Jie #define CABLE_ATYPE		0
314*a2c81616SWang Jie #define CABLE_BTYPE		1
315*a2c81616SWang Jie #define CABLE_CTYPE		2
316*a2c81616SWang Jie #define CABLE_CAPTIVE		3
317*a2c81616SWang Jie 
318*a2c81616SWang Jie /* Cable Latency */
319*a2c81616SWang Jie #define CABLE_LATENCY_1M	1
320*a2c81616SWang Jie #define CABLE_LATENCY_2M	2
321*a2c81616SWang Jie #define CABLE_LATENCY_3M	3
322*a2c81616SWang Jie #define CABLE_LATENCY_4M	4
323*a2c81616SWang Jie #define CABLE_LATENCY_5M	5
324*a2c81616SWang Jie #define CABLE_LATENCY_6M	6
325*a2c81616SWang Jie #define CABLE_LATENCY_7M	7
326*a2c81616SWang Jie #define CABLE_LATENCY_7M_PLUS	8
327*a2c81616SWang Jie 
328*a2c81616SWang Jie /* Cable Termination Type */
329*a2c81616SWang Jie #define PCABLE_VCONN_NOT_REQ	0
330*a2c81616SWang Jie #define PCABLE_VCONN_REQ	1
331*a2c81616SWang Jie #define ACABLE_ONE_END		2
332*a2c81616SWang Jie #define ACABLE_BOTH_END		3
333*a2c81616SWang Jie 
334*a2c81616SWang Jie /* Maximum Vbus Voltage */
335*a2c81616SWang Jie #define CABLE_MAX_VBUS_20V	0
336*a2c81616SWang Jie #define CABLE_MAX_VBUS_30V	1
337*a2c81616SWang Jie #define CABLE_MAX_VBUS_40V	2
338*a2c81616SWang Jie #define CABLE_MAX_VBUS_50V	3
339*a2c81616SWang Jie 
340*a2c81616SWang Jie /* Active Cable SBU Supported/Type */
341*a2c81616SWang Jie #define ACABLE_SBU_SUPP		0
342*a2c81616SWang Jie #define ACABLE_SBU_NOT_SUPP	1
343*a2c81616SWang Jie #define ACABLE_SBU_PASSIVE	0
344*a2c81616SWang Jie #define ACABLE_SBU_ACTIVE	1
345*a2c81616SWang Jie 
346*a2c81616SWang Jie /* Vbus Current Handling Capability */
347*a2c81616SWang Jie #define CABLE_CURR_DEF		0
348*a2c81616SWang Jie #define CABLE_CURR_3A		1
349*a2c81616SWang Jie #define CABLE_CURR_5A		2
350*a2c81616SWang Jie 
351*a2c81616SWang Jie /* USB SuperSpeed Signaling Support (PD Rev2.0) */
352*a2c81616SWang Jie #define CABLE_USBSS_U2_ONLY	0
353*a2c81616SWang Jie #define CABLE_USBSS_U31_GEN1	1
354*a2c81616SWang Jie #define CABLE_USBSS_U31_GEN2	2
355*a2c81616SWang Jie 
356*a2c81616SWang Jie /* USB Highest Speed */
357*a2c81616SWang Jie #define CABLE_USB2_ONLY		0
358*a2c81616SWang Jie #define CABLE_USB32_GEN1	1
359*a2c81616SWang Jie #define CABLE_USB32_4_GEN2	2
360*a2c81616SWang Jie #define CABLE_USB4_GEN3		3
361*a2c81616SWang Jie 
362*a2c81616SWang Jie #define VDO_CABLE(hw, fw, cbl, lat, term, tx1d, tx2d, rx1d, rx2d, cur, vps, sopp, usbss) \
363*a2c81616SWang Jie 	(((hw) & 0x7) << 28 | ((fw) & 0x7) << 24 | ((cbl) & 0x3) << 18		\
364*a2c81616SWang Jie 	 | ((lat) & 0x7) << 13 | ((term) & 0x3) << 11 | (tx1d) << 10		\
365*a2c81616SWang Jie 	 | (tx2d) << 9 | (rx1d) << 8 | (rx2d) << 7 | ((cur) & 0x3) << 5		\
366*a2c81616SWang Jie 	 | (vps) << 4 | (sopp) << 3 | ((usbss) & 0x7))
367*a2c81616SWang Jie #define VDO_PCABLE(hw, fw, ver, conn, lat, term, vbm, cur, spd)			\
368*a2c81616SWang Jie 	(((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21		\
369*a2c81616SWang Jie 	 | ((conn) & 0x3) << 18 | ((lat) & 0xf) << 13 | ((term) & 0x3) << 11	\
370*a2c81616SWang Jie 	 | ((vbm) & 0x3) << 9 | ((cur) & 0x3) << 5 | ((spd) & 0x7))
371*a2c81616SWang Jie #define VDO_ACABLE1(hw, fw, ver, conn, lat, term, vbm, sbu, sbut, cur, vbt, sopp, spd) \
372*a2c81616SWang Jie 	(((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21		\
373*a2c81616SWang Jie 	 | ((conn) & 0x3) << 18	| ((lat) & 0xf) << 13 | ((term) & 0x3) << 11	\
374*a2c81616SWang Jie 	 | ((vbm) & 0x3) << 9 | (sbu) << 8 | (sbut) << 7 | ((cur) & 0x3) << 5	\
375*a2c81616SWang Jie 	 | (vbt) << 4 | (sopp) << 3 | ((spd) & 0x7))
376*a2c81616SWang Jie 
377*a2c81616SWang Jie #define VDO_TYPEC_CABLE_TYPE(vdo)	(((vdo) >> 18) & 0x3)
378*a2c81616SWang Jie 
379*a2c81616SWang Jie /*
380*a2c81616SWang Jie  * Active Cable VDO 2
381*a2c81616SWang Jie  * ---------
382*a2c81616SWang Jie  * <31:24> :: Maximum operating temperature
383*a2c81616SWang Jie  * <23:16> :: Shutdown temperature
384*a2c81616SWang Jie  * <15>    :: Reserved, Shall be set to zero
385*a2c81616SWang Jie  * <14:12> :: U3/CLd power
386*a2c81616SWang Jie  * <11>    :: U3 to U0 transition mode (0b == direct, 1b == through U3S)
387*a2c81616SWang Jie  * <10>    :: Physical connection (0b == copper, 1b == optical)
388*a2c81616SWang Jie  * <9>     :: Active element (0b == redriver, 1b == retimer)
389*a2c81616SWang Jie  * <8>     :: USB4 supported (0b == yes, 1b == no)
390*a2c81616SWang Jie  * <7:6>   :: USB2 hub hops consumed
391*a2c81616SWang Jie  * <5>     :: USB2 supported (0b == yes, 1b == no)
392*a2c81616SWang Jie  * <4>     :: USB3.2 supported (0b == yes, 1b == no)
393*a2c81616SWang Jie  * <3>     :: USB lanes supported (0b == one lane, 1b == two lanes)
394*a2c81616SWang Jie  * <2>     :: Optically isolated active cable (0b == no, 1b == yes)
395*a2c81616SWang Jie  * <1>     :: Reserved, Shall be set to zero
396*a2c81616SWang Jie  * <0>     :: USB gen (0b == gen1, 1b == gen2+)
397*a2c81616SWang Jie  */
398*a2c81616SWang Jie 
399*a2c81616SWang Jie /* U3/CLd Power*/
400*a2c81616SWang Jie #define ACAB2_U3_CLD_10MW_PLUS	0
401*a2c81616SWang Jie #define ACAB2_U3_CLD_10MW	1
402*a2c81616SWang Jie #define ACAB2_U3_CLD_5MW	2
403*a2c81616SWang Jie #define ACAB2_U3_CLD_1MW	3
404*a2c81616SWang Jie #define ACAB2_U3_CLD_500UW	4
405*a2c81616SWang Jie #define ACAB2_U3_CLD_200UW	5
406*a2c81616SWang Jie #define ACAB2_U3_CLD_50UW	6
407*a2c81616SWang Jie 
408*a2c81616SWang Jie /* Other Active Cable VDO 2 Fields */
409*a2c81616SWang Jie #define ACAB2_U3U0_DIRECT	0
410*a2c81616SWang Jie #define ACAB2_U3U0_U3S		1
411*a2c81616SWang Jie #define ACAB2_PHY_COPPER	0
412*a2c81616SWang Jie #define ACAB2_PHY_OPTICAL	1
413*a2c81616SWang Jie #define ACAB2_REDRIVER		0
414*a2c81616SWang Jie #define ACAB2_RETIMER		1
415*a2c81616SWang Jie #define ACAB2_USB4_SUPP		0
416*a2c81616SWang Jie #define ACAB2_USB4_NOT_SUPP	1
417*a2c81616SWang Jie #define ACAB2_USB2_SUPP		0
418*a2c81616SWang Jie #define ACAB2_USB2_NOT_SUPP	1
419*a2c81616SWang Jie #define ACAB2_USB32_SUPP	0
420*a2c81616SWang Jie #define ACAB2_USB32_NOT_SUPP	1
421*a2c81616SWang Jie #define ACAB2_LANES_ONE		0
422*a2c81616SWang Jie #define ACAB2_LANES_TWO		1
423*a2c81616SWang Jie #define ACAB2_OPT_ISO_NO	0
424*a2c81616SWang Jie #define ACAB2_OPT_ISO_YES	1
425*a2c81616SWang Jie #define ACAB2_GEN_1		0
426*a2c81616SWang Jie #define ACAB2_GEN_2_PLUS	1
427*a2c81616SWang Jie 
428*a2c81616SWang Jie #define VDO_ACABLE2(mtemp, stemp, u3p, trans, phy, ele, u4, hops, u2, u32, lane, iso, gen)	\
429*a2c81616SWang Jie 	(((mtemp) & 0xff) << 24 | ((stemp) & 0xff) << 16 | ((u3p) & 0x7) << 12	\
430*a2c81616SWang Jie 	 | (trans) << 11 | (phy) << 10 | (ele) << 9 | (u4) << 8			\
431*a2c81616SWang Jie 	 | ((hops) & 0x3) << 6 | (u2) << 5 | (u32) << 4 | (lane) << 3		\
432*a2c81616SWang Jie 	 | (iso) << 2 | (gen))
433*a2c81616SWang Jie 
434*a2c81616SWang Jie /*
435*a2c81616SWang Jie  * AMA VDO (PD Rev2.0)
436*a2c81616SWang Jie  * ---------
437*a2c81616SWang Jie  * <31:28> :: Cable HW version
438*a2c81616SWang Jie  * <27:24> :: Cable FW version
439*a2c81616SWang Jie  * <23:12> :: Reserved, Shall be set to zero
440*a2c81616SWang Jie  * <11>    :: SSTX1 Directionality support (0b == fixed, 1b == cfgable)
441*a2c81616SWang Jie  * <10>    :: SSTX2 Directionality support
442*a2c81616SWang Jie  * <9>     :: SSRX1 Directionality support
443*a2c81616SWang Jie  * <8>     :: SSRX2 Directionality support
444*a2c81616SWang Jie  * <7:5>   :: Vconn power
445*a2c81616SWang Jie  * <4>     :: Vconn power required
446*a2c81616SWang Jie  * <3>     :: Vbus power required
447*a2c81616SWang Jie  * <2:0>   :: USB SS Signaling support
448*a2c81616SWang Jie  */
449*a2c81616SWang Jie #define VDO_AMA(hw, fw, tx1d, tx2d, rx1d, rx2d, vcpwr, vcr, vbr, usbss) \
450*a2c81616SWang Jie 	(((hw) & 0x7) << 28 | ((fw) & 0x7) << 24			\
451*a2c81616SWang Jie 	 | (tx1d) << 11 | (tx2d) << 10 | (rx1d) << 9 | (rx2d) << 8	\
452*a2c81616SWang Jie 	 | ((vcpwr) & 0x7) << 5 | (vcr) << 4 | (vbr) << 3		\
453*a2c81616SWang Jie 	 | ((usbss) & 0x7))
454*a2c81616SWang Jie 
455*a2c81616SWang Jie #define PD_VDO_AMA_VCONN_REQ(vdo)	(((vdo) >> 4) & 1)
456*a2c81616SWang Jie #define PD_VDO_AMA_VBUS_REQ(vdo)	(((vdo) >> 3) & 1)
457*a2c81616SWang Jie 
458*a2c81616SWang Jie #define AMA_USBSS_U2_ONLY	0
459*a2c81616SWang Jie #define AMA_USBSS_U31_GEN1	1
460*a2c81616SWang Jie #define AMA_USBSS_U31_GEN2	2
461*a2c81616SWang Jie #define AMA_USBSS_BBONLY	3
462*a2c81616SWang Jie 
463*a2c81616SWang Jie /*
464*a2c81616SWang Jie  * VPD VDO
465*a2c81616SWang Jie  * ---------
466*a2c81616SWang Jie  * <31:28> :: HW version
467*a2c81616SWang Jie  * <27:24> :: FW version
468*a2c81616SWang Jie  * <23:21> :: VDO version
469*a2c81616SWang Jie  * <20:17> :: Reserved, Shall be set to zero
470*a2c81616SWang Jie  * <16:15> :: Maximum Vbus voltage (00b == 20V, 01b == 30V, 10b == 40V, 11b == 50V)
471*a2c81616SWang Jie  * <14>    :: Charge through current support (0b == 3A, 1b == 5A)
472*a2c81616SWang Jie  * <13>    :: Reserved, Shall be set to zero
473*a2c81616SWang Jie  * <12:7>  :: Vbus impedance
474*a2c81616SWang Jie  * <6:1>   :: Ground impedance
475*a2c81616SWang Jie  * <0>     :: Charge through support (0b == no, 1b == yes)
476*a2c81616SWang Jie  */
477*a2c81616SWang Jie #define VPD_VDO_VER1_0		0
478*a2c81616SWang Jie #define VPD_MAX_VBUS_20V	0
479*a2c81616SWang Jie #define VPD_MAX_VBUS_30V	1
480*a2c81616SWang Jie #define VPD_MAX_VBUS_40V	2
481*a2c81616SWang Jie #define VPD_MAX_VBUS_50V	3
482*a2c81616SWang Jie #define VPDCT_CURR_3A		0
483*a2c81616SWang Jie #define VPDCT_CURR_5A		1
484*a2c81616SWang Jie #define VPDCT_NOT_SUPP		0
485*a2c81616SWang Jie #define VPDCT_SUPP		1
486*a2c81616SWang Jie 
487*a2c81616SWang Jie #define VDO_VPD(hw, fw, ver, vbm, curr, vbi, gi, ct)			\
488*a2c81616SWang Jie 	(((hw) & 0xf) << 28 | ((fw) & 0xf) << 24 | ((ver) & 0x7) << 21	\
489*a2c81616SWang Jie 	 | ((vbm) & 0x3) << 15 | (curr) << 14 | ((vbi) & 0x3f) << 7	\
490*a2c81616SWang Jie 	 | ((gi) & 0x3f) << 1 | (ct))
491*a2c81616SWang Jie 
492*a2c81616SWang Jie /*
493*a2c81616SWang Jie  * SVDM Discover SVIDs request -> response
494*a2c81616SWang Jie  *
495*a2c81616SWang Jie  * Request is properly formatted VDM Header with discover SVIDs command.
496*a2c81616SWang Jie  * Response is a set of SVIDs of all supported SVIDs with all zero's to
497*a2c81616SWang Jie  * mark the end of SVIDs.  If more than 12 SVIDs are supported command SHOULD be
498*a2c81616SWang Jie  * repeated.
499*a2c81616SWang Jie  */
500*a2c81616SWang Jie #define VDO_SVID(svid0, svid1)	(((svid0) & 0xffff) << 16 | ((svid1) & 0xffff))
501*a2c81616SWang Jie #define PD_VDO_SVID_SVID0(vdo)	((vdo) >> 16)
502*a2c81616SWang Jie #define PD_VDO_SVID_SVID1(vdo)	((vdo) & 0xffff)
503*a2c81616SWang Jie 
504*a2c81616SWang Jie /* USB-IF SIDs */
505*a2c81616SWang Jie #define USB_SID_PD		0xff00 /* power delivery */
506*a2c81616SWang Jie #define USB_SID_DISPLAYPORT	0xff01
507*a2c81616SWang Jie #define USB_SID_MHL		0xff02	/* Mobile High-Definition Link */
508*a2c81616SWang Jie 
509*a2c81616SWang Jie /* VDM command timeouts (in ms) */
510*a2c81616SWang Jie 
511*a2c81616SWang Jie #define PD_T_VDM_UNSTRUCTURED	500
512*a2c81616SWang Jie #define PD_T_VDM_BUSY		100
513*a2c81616SWang Jie #define PD_T_VDM_WAIT_MODE_E	100
514*a2c81616SWang Jie #define PD_T_VDM_SNDR_RSP	30
515*a2c81616SWang Jie #define PD_T_VDM_E_MODE		25
516*a2c81616SWang Jie #define PD_T_VDM_RCVR_RSP	15
517*a2c81616SWang Jie 
518*a2c81616SWang Jie #endif /* __LINUX_USB_PD_VDO_H */
519