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