xref: /OK3568_Linux_fs/u-boot/drivers/usb/dwc3/core.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /**
2*4882a593Smuzhiyun  * core.h - DesignWare USB3 DRD Core Header
3*4882a593Smuzhiyun  *
4*4882a593Smuzhiyun  * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com
5*4882a593Smuzhiyun  *
6*4882a593Smuzhiyun  * Authors: Felipe Balbi <balbi@ti.com>,
7*4882a593Smuzhiyun  *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
8*4882a593Smuzhiyun  *
9*4882a593Smuzhiyun  * Taken from Linux Kernel v3.19-rc1 (drivers/usb/dwc3/core.h) and ported
10*4882a593Smuzhiyun  * to uboot.
11*4882a593Smuzhiyun  *
12*4882a593Smuzhiyun  * commit 460d098cb6 : usb: dwc3: make HIRD threshold configurable
13*4882a593Smuzhiyun  *
14*4882a593Smuzhiyun  * SPDX-License-Identifier:     GPL-2.0
15*4882a593Smuzhiyun  *
16*4882a593Smuzhiyun  */
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #ifndef __DRIVERS_USB_DWC3_CORE_H
19*4882a593Smuzhiyun #define __DRIVERS_USB_DWC3_CORE_H
20*4882a593Smuzhiyun 
21*4882a593Smuzhiyun #include <linux/ioport.h>
22*4882a593Smuzhiyun 
23*4882a593Smuzhiyun #include <linux/usb/ch9.h>
24*4882a593Smuzhiyun #include <linux/usb/otg.h>
25*4882a593Smuzhiyun #include <linux/usb/phy.h>
26*4882a593Smuzhiyun 
27*4882a593Smuzhiyun #define DWC3_MSG_MAX	500
28*4882a593Smuzhiyun 
29*4882a593Smuzhiyun /* Global constants */
30*4882a593Smuzhiyun #define DWC3_EP0_BOUNCE_SIZE	512
31*4882a593Smuzhiyun #define DWC3_ENDPOINTS_NUM	32
32*4882a593Smuzhiyun #define DWC3_XHCI_RESOURCES_NUM	2
33*4882a593Smuzhiyun 
34*4882a593Smuzhiyun #define DWC3_SCRATCHBUF_SIZE	4096	/* each buffer is assumed to be 4KiB */
35*4882a593Smuzhiyun #define DWC3_EVENT_SIZE		4	/* bytes */
36*4882a593Smuzhiyun #define DWC3_EVENT_MAX_NUM	64	/* 2 events/endpoint */
37*4882a593Smuzhiyun #define DWC3_EVENT_BUFFERS_SIZE	(DWC3_EVENT_SIZE * DWC3_EVENT_MAX_NUM)
38*4882a593Smuzhiyun #define DWC3_EVENT_TYPE_MASK	0xfe
39*4882a593Smuzhiyun 
40*4882a593Smuzhiyun #define DWC3_EVENT_TYPE_DEV	0
41*4882a593Smuzhiyun #define DWC3_EVENT_TYPE_CARKIT	3
42*4882a593Smuzhiyun #define DWC3_EVENT_TYPE_I2C	4
43*4882a593Smuzhiyun 
44*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_DISCONNECT		0
45*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_RESET			1
46*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_CONNECT_DONE		2
47*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE	3
48*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_WAKEUP		4
49*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_HIBER_REQ		5
50*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_EOPF			6
51*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_SOF			7
52*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_ERRATIC_ERROR		9
53*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_CMD_CMPL		10
54*4882a593Smuzhiyun #define DWC3_DEVICE_EVENT_OVERFLOW		11
55*4882a593Smuzhiyun 
56*4882a593Smuzhiyun #define DWC3_GEVNTCOUNT_MASK	0xfffc
57*4882a593Smuzhiyun #define DWC3_GSNPSID_MASK	0xffff0000
58*4882a593Smuzhiyun #define DWC3_GSNPSREV_MASK	0xffff
59*4882a593Smuzhiyun 
60*4882a593Smuzhiyun /* DWC3 registers memory space boundries */
61*4882a593Smuzhiyun #define DWC3_XHCI_REGS_START		0x0
62*4882a593Smuzhiyun #define DWC3_XHCI_REGS_END		0x7fff
63*4882a593Smuzhiyun #define DWC3_GLOBALS_REGS_START		0xc100
64*4882a593Smuzhiyun #define DWC3_GLOBALS_REGS_END		0xc6ff
65*4882a593Smuzhiyun #define DWC3_DEVICE_REGS_START		0xc700
66*4882a593Smuzhiyun #define DWC3_DEVICE_REGS_END		0xcbff
67*4882a593Smuzhiyun #define DWC3_OTG_REGS_START		0xcc00
68*4882a593Smuzhiyun #define DWC3_OTG_REGS_END		0xccff
69*4882a593Smuzhiyun 
70*4882a593Smuzhiyun /* Global Registers */
71*4882a593Smuzhiyun #define DWC3_GSBUSCFG0		0xc100
72*4882a593Smuzhiyun #define DWC3_GSBUSCFG1		0xc104
73*4882a593Smuzhiyun #define DWC3_GTXTHRCFG		0xc108
74*4882a593Smuzhiyun #define DWC3_GRXTHRCFG		0xc10c
75*4882a593Smuzhiyun #define DWC3_GCTL		0xc110
76*4882a593Smuzhiyun #define DWC3_GEVTEN		0xc114
77*4882a593Smuzhiyun #define DWC3_GSTS		0xc118
78*4882a593Smuzhiyun #define DWC3_GUCTL1		0xc11c
79*4882a593Smuzhiyun #define DWC3_GSNPSID		0xc120
80*4882a593Smuzhiyun #define DWC3_GGPIO		0xc124
81*4882a593Smuzhiyun #define DWC3_GUID		0xc128
82*4882a593Smuzhiyun #define DWC3_GUCTL		0xc12c
83*4882a593Smuzhiyun #define DWC3_GBUSERRADDR0	0xc130
84*4882a593Smuzhiyun #define DWC3_GBUSERRADDR1	0xc134
85*4882a593Smuzhiyun #define DWC3_GPRTBIMAP0		0xc138
86*4882a593Smuzhiyun #define DWC3_GPRTBIMAP1		0xc13c
87*4882a593Smuzhiyun #define DWC3_GHWPARAMS0		0xc140
88*4882a593Smuzhiyun #define DWC3_GHWPARAMS1		0xc144
89*4882a593Smuzhiyun #define DWC3_GHWPARAMS2		0xc148
90*4882a593Smuzhiyun #define DWC3_GHWPARAMS3		0xc14c
91*4882a593Smuzhiyun #define DWC3_GHWPARAMS4		0xc150
92*4882a593Smuzhiyun #define DWC3_GHWPARAMS5		0xc154
93*4882a593Smuzhiyun #define DWC3_GHWPARAMS6		0xc158
94*4882a593Smuzhiyun #define DWC3_GHWPARAMS7		0xc15c
95*4882a593Smuzhiyun #define DWC3_GDBGFIFOSPACE	0xc160
96*4882a593Smuzhiyun #define DWC3_GDBGLTSSM		0xc164
97*4882a593Smuzhiyun #define DWC3_GPRTBIMAP_HS0	0xc180
98*4882a593Smuzhiyun #define DWC3_GPRTBIMAP_HS1	0xc184
99*4882a593Smuzhiyun #define DWC3_GPRTBIMAP_FS0	0xc188
100*4882a593Smuzhiyun #define DWC3_GPRTBIMAP_FS1	0xc18c
101*4882a593Smuzhiyun 
102*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG(n)	(0xc200 + (n * 0x04))
103*4882a593Smuzhiyun #define DWC3_GUSB2I2CCTL(n)	(0xc240 + (n * 0x04))
104*4882a593Smuzhiyun 
105*4882a593Smuzhiyun #define DWC3_GUSB2PHYACC(n)	(0xc280 + (n * 0x04))
106*4882a593Smuzhiyun 
107*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL(n)	(0xc2c0 + (n * 0x04))
108*4882a593Smuzhiyun 
109*4882a593Smuzhiyun #define DWC3_GTXFIFOSIZ(n)	(0xc300 + (n * 0x04))
110*4882a593Smuzhiyun #define DWC3_GRXFIFOSIZ(n)	(0xc380 + (n * 0x04))
111*4882a593Smuzhiyun 
112*4882a593Smuzhiyun #define DWC3_GEVNTADRLO(n)	(0xc400 + (n * 0x10))
113*4882a593Smuzhiyun #define DWC3_GEVNTADRHI(n)	(0xc404 + (n * 0x10))
114*4882a593Smuzhiyun #define DWC3_GEVNTSIZ(n)	(0xc408 + (n * 0x10))
115*4882a593Smuzhiyun #define DWC3_GEVNTCOUNT(n)	(0xc40c + (n * 0x10))
116*4882a593Smuzhiyun 
117*4882a593Smuzhiyun #define DWC3_GHWPARAMS8		0xc600
118*4882a593Smuzhiyun 
119*4882a593Smuzhiyun /* Device Registers */
120*4882a593Smuzhiyun #define DWC3_DCFG		0xc700
121*4882a593Smuzhiyun #define DWC3_DCTL		0xc704
122*4882a593Smuzhiyun #define DWC3_DEVTEN		0xc708
123*4882a593Smuzhiyun #define DWC3_DSTS		0xc70c
124*4882a593Smuzhiyun #define DWC3_DGCMDPAR		0xc710
125*4882a593Smuzhiyun #define DWC3_DGCMD		0xc714
126*4882a593Smuzhiyun #define DWC3_DALEPENA		0xc720
127*4882a593Smuzhiyun #define DWC3_DEPCMDPAR2(n)	(0xc800 + (n * 0x10))
128*4882a593Smuzhiyun #define DWC3_DEPCMDPAR1(n)	(0xc804 + (n * 0x10))
129*4882a593Smuzhiyun #define DWC3_DEPCMDPAR0(n)	(0xc808 + (n * 0x10))
130*4882a593Smuzhiyun #define DWC3_DEPCMD(n)		(0xc80c + (n * 0x10))
131*4882a593Smuzhiyun 
132*4882a593Smuzhiyun /* OTG Registers */
133*4882a593Smuzhiyun #define DWC3_OCFG		0xcc00
134*4882a593Smuzhiyun #define DWC3_OCTL		0xcc04
135*4882a593Smuzhiyun #define DWC3_OEVT		0xcc08
136*4882a593Smuzhiyun #define DWC3_OEVTEN		0xcc0C
137*4882a593Smuzhiyun #define DWC3_OSTS		0xcc10
138*4882a593Smuzhiyun 
139*4882a593Smuzhiyun /* Bit fields */
140*4882a593Smuzhiyun 
141*4882a593Smuzhiyun /* Global Configuration Register */
142*4882a593Smuzhiyun #define DWC3_GCTL_PWRDNSCALE(n)	((n) << 19)
143*4882a593Smuzhiyun #define DWC3_GCTL_U2RSTECN	(1 << 16)
144*4882a593Smuzhiyun #define DWC3_GCTL_RAMCLKSEL(x)	(((x) & DWC3_GCTL_CLK_MASK) << 6)
145*4882a593Smuzhiyun #define DWC3_GCTL_CLK_BUS	(0)
146*4882a593Smuzhiyun #define DWC3_GCTL_CLK_PIPE	(1)
147*4882a593Smuzhiyun #define DWC3_GCTL_CLK_PIPEHALF	(2)
148*4882a593Smuzhiyun #define DWC3_GCTL_CLK_MASK	(3)
149*4882a593Smuzhiyun 
150*4882a593Smuzhiyun #define DWC3_GCTL_PRTCAP(n)	(((n) & (3 << 12)) >> 12)
151*4882a593Smuzhiyun #define DWC3_GCTL_PRTCAPDIR(n)	((n) << 12)
152*4882a593Smuzhiyun #define DWC3_GCTL_PRTCAP_HOST	1
153*4882a593Smuzhiyun #define DWC3_GCTL_PRTCAP_DEVICE	2
154*4882a593Smuzhiyun #define DWC3_GCTL_PRTCAP_OTG	3
155*4882a593Smuzhiyun 
156*4882a593Smuzhiyun #define DWC3_GCTL_CORESOFTRESET		(1 << 11)
157*4882a593Smuzhiyun #define DWC3_GCTL_SOFITPSYNC		(1 << 10)
158*4882a593Smuzhiyun #define DWC3_GCTL_SCALEDOWN(n)		((n) << 4)
159*4882a593Smuzhiyun #define DWC3_GCTL_SCALEDOWN_MASK	DWC3_GCTL_SCALEDOWN(3)
160*4882a593Smuzhiyun #define DWC3_GCTL_DISSCRAMBLE		(1 << 3)
161*4882a593Smuzhiyun #define DWC3_GCTL_U2EXIT_LFPS		(1 << 2)
162*4882a593Smuzhiyun #define DWC3_GCTL_GBLHIBERNATIONEN	(1 << 1)
163*4882a593Smuzhiyun #define DWC3_GCTL_DSBLCLKGTNG		(1 << 0)
164*4882a593Smuzhiyun 
165*4882a593Smuzhiyun /* Global User Control 1 Register */
166*4882a593Smuzhiyun #define DWC3_GUCTL1_DEV_FORCE_20_CLK_FOR_30_CLK BIT(26)
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun /* Global USB2 PHY Configuration Register */
169*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_PHYSOFTRST	(1 << 31)
170*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS	(1 << 30)
171*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_ENBLSLPM   (1 << 8)
172*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_SUSPHY		(1 << 6)
173*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_PHYIF_8BIT	(0 << 3)
174*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_PHYIF_16BIT	(1 << 3)
175*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_PHYIF(n)	((n) << 3)
176*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_PHYIF_MASK	DWC3_GUSB2PHYCFG_PHYIF(1)
177*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_USBTRDTIM(n)	((n) << 10)
178*4882a593Smuzhiyun #define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK	DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
179*4882a593Smuzhiyun #define USBTRDTIM_UTMI_8_BIT		9
180*4882a593Smuzhiyun #define USBTRDTIM_UTMI_16_BIT		5
181*4882a593Smuzhiyun #define UTMI_PHYIF_16_BIT		1
182*4882a593Smuzhiyun #define UTMI_PHYIF_8_BIT		0
183*4882a593Smuzhiyun 
184*4882a593Smuzhiyun /* Global USB3 PIPE Control Register */
185*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_PHYSOFTRST	(1 << 31)
186*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_U2SSINP3OK	(1 << 29)
187*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_REQP1P2P3	(1 << 24)
188*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_DEP1P2P3(n)	((n) << 19)
189*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK	DWC3_GUSB3PIPECTL_DEP1P2P3(7)
190*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_DEP1P2P3_EN	DWC3_GUSB3PIPECTL_DEP1P2P3(1)
191*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_DEPOCHANGE	(1 << 18)
192*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_SUSPHY	(1 << 17)
193*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_LFPSFILT	(1 << 9)
194*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_RX_DETOPOLL	(1 << 8)
195*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK	DWC3_GUSB3PIPECTL_TX_DEEPH(3)
196*4882a593Smuzhiyun #define DWC3_GUSB3PIPECTL_TX_DEEPH(n)	((n) << 1)
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun /* Global TX Fifo Size Register */
199*4882a593Smuzhiyun #define DWC3_GTXFIFOSIZ_TXFDEF(n)	((n) & 0xffff)
200*4882a593Smuzhiyun #define DWC3_GTXFIFOSIZ_TXFSTADDR(n)	((n) & 0xffff0000)
201*4882a593Smuzhiyun 
202*4882a593Smuzhiyun /* Global Event Size Registers */
203*4882a593Smuzhiyun #define DWC3_GEVNTSIZ_INTMASK		(1 << 31)
204*4882a593Smuzhiyun #define DWC3_GEVNTSIZ_SIZE(n)		((n) & 0xffff)
205*4882a593Smuzhiyun 
206*4882a593Smuzhiyun /* Global HWPARAMS1 Register */
207*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_EN_PWROPT(n)	(((n) & (3 << 24)) >> 24)
208*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_EN_PWROPT_NO	0
209*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_EN_PWROPT_CLK	1
210*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_EN_PWROPT_HIB	2
211*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_PWROPT(n)	((n) << 24)
212*4882a593Smuzhiyun #define DWC3_GHWPARAMS1_PWROPT_MASK	DWC3_GHWPARAMS1_PWROPT(3)
213*4882a593Smuzhiyun 
214*4882a593Smuzhiyun /* Global HWPARAMS3 Register */
215*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_SSPHY_IFC(n)		((n) & 3)
216*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_SSPHY_IFC_DIS		0
217*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_SSPHY_IFC_ENA		1
218*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_HSPHY_IFC(n)		(((n) & (3 << 2)) >> 2)
219*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_HSPHY_IFC_DIS		0
220*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI		1
221*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI		2
222*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI	3
223*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_FSPHY_IFC(n)		(((n) & (3 << 4)) >> 4)
224*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_FSPHY_IFC_DIS		0
225*4882a593Smuzhiyun #define DWC3_GHWPARAMS3_FSPHY_IFC_ENA		1
226*4882a593Smuzhiyun 
227*4882a593Smuzhiyun /* Global HWPARAMS4 Register */
228*4882a593Smuzhiyun #define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n)	(((n) & (0x0f << 13)) >> 13)
229*4882a593Smuzhiyun #define DWC3_MAX_HIBER_SCRATCHBUFS		15
230*4882a593Smuzhiyun 
231*4882a593Smuzhiyun /* Global HWPARAMS6 Register */
232*4882a593Smuzhiyun #define DWC3_GHWPARAMS6_EN_FPGA			(1 << 7)
233*4882a593Smuzhiyun 
234*4882a593Smuzhiyun /* Device Configuration Register */
235*4882a593Smuzhiyun #define DWC3_DCFG_DEVADDR(addr)	((addr) << 3)
236*4882a593Smuzhiyun #define DWC3_DCFG_DEVADDR_MASK	DWC3_DCFG_DEVADDR(0x7f)
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun #define DWC3_DCFG_SPEED_MASK	(7 << 0)
239*4882a593Smuzhiyun #define DWC3_DCFG_SUPERSPEED	(4 << 0)
240*4882a593Smuzhiyun #define DWC3_DCFG_HIGHSPEED	(0 << 0)
241*4882a593Smuzhiyun #define DWC3_DCFG_FULLSPEED2	(1 << 0)
242*4882a593Smuzhiyun #define DWC3_DCFG_LOWSPEED	(2 << 0)
243*4882a593Smuzhiyun #define DWC3_DCFG_FULLSPEED1	(3 << 0)
244*4882a593Smuzhiyun 
245*4882a593Smuzhiyun #define DWC3_DCFG_LPM_CAP	(1 << 22)
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun /* Device Control Register */
248*4882a593Smuzhiyun #define DWC3_DCTL_RUN_STOP	(1 << 31)
249*4882a593Smuzhiyun #define DWC3_DCTL_CSFTRST	(1 << 30)
250*4882a593Smuzhiyun #define DWC3_DCTL_LSFTRST	(1 << 29)
251*4882a593Smuzhiyun 
252*4882a593Smuzhiyun #define DWC3_DCTL_HIRD_THRES_MASK	(0x1f << 24)
253*4882a593Smuzhiyun #define DWC3_DCTL_HIRD_THRES(n)	((n) << 24)
254*4882a593Smuzhiyun 
255*4882a593Smuzhiyun #define DWC3_DCTL_APPL1RES	(1 << 23)
256*4882a593Smuzhiyun 
257*4882a593Smuzhiyun /* These apply for core versions 1.87a and earlier */
258*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_MASK		(0x0f << 17)
259*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST(n)		((n) << 17)
260*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_U2		(DWC3_DCTL_TRGTULST(2))
261*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_U3		(DWC3_DCTL_TRGTULST(3))
262*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_SS_DIS	(DWC3_DCTL_TRGTULST(4))
263*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_RX_DET	(DWC3_DCTL_TRGTULST(5))
264*4882a593Smuzhiyun #define DWC3_DCTL_TRGTULST_SS_INACT	(DWC3_DCTL_TRGTULST(6))
265*4882a593Smuzhiyun 
266*4882a593Smuzhiyun /* These apply for core versions 1.94a and later */
267*4882a593Smuzhiyun #define DWC3_DCTL_LPM_ERRATA_MASK	DWC3_DCTL_LPM_ERRATA(0xf)
268*4882a593Smuzhiyun #define DWC3_DCTL_LPM_ERRATA(n)		((n) << 20)
269*4882a593Smuzhiyun 
270*4882a593Smuzhiyun #define DWC3_DCTL_KEEP_CONNECT		(1 << 19)
271*4882a593Smuzhiyun #define DWC3_DCTL_L1_HIBER_EN		(1 << 18)
272*4882a593Smuzhiyun #define DWC3_DCTL_CRS			(1 << 17)
273*4882a593Smuzhiyun #define DWC3_DCTL_CSS			(1 << 16)
274*4882a593Smuzhiyun 
275*4882a593Smuzhiyun #define DWC3_DCTL_INITU2ENA		(1 << 12)
276*4882a593Smuzhiyun #define DWC3_DCTL_ACCEPTU2ENA		(1 << 11)
277*4882a593Smuzhiyun #define DWC3_DCTL_INITU1ENA		(1 << 10)
278*4882a593Smuzhiyun #define DWC3_DCTL_ACCEPTU1ENA		(1 << 9)
279*4882a593Smuzhiyun #define DWC3_DCTL_TSTCTRL_MASK		(0xf << 1)
280*4882a593Smuzhiyun 
281*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNGREQ_MASK	(0x0f << 5)
282*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
283*4882a593Smuzhiyun 
284*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_NO_ACTION	(DWC3_DCTL_ULSTCHNGREQ(0))
285*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_SS_DISABLED	(DWC3_DCTL_ULSTCHNGREQ(4))
286*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_RX_DETECT	(DWC3_DCTL_ULSTCHNGREQ(5))
287*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_SS_INACTIVE	(DWC3_DCTL_ULSTCHNGREQ(6))
288*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_RECOVERY	(DWC3_DCTL_ULSTCHNGREQ(8))
289*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_COMPLIANCE	(DWC3_DCTL_ULSTCHNGREQ(10))
290*4882a593Smuzhiyun #define DWC3_DCTL_ULSTCHNG_LOOPBACK	(DWC3_DCTL_ULSTCHNGREQ(11))
291*4882a593Smuzhiyun 
292*4882a593Smuzhiyun /* Device Event Enable Register */
293*4882a593Smuzhiyun #define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN	(1 << 12)
294*4882a593Smuzhiyun #define DWC3_DEVTEN_EVNTOVERFLOWEN	(1 << 11)
295*4882a593Smuzhiyun #define DWC3_DEVTEN_CMDCMPLTEN		(1 << 10)
296*4882a593Smuzhiyun #define DWC3_DEVTEN_ERRTICERREN		(1 << 9)
297*4882a593Smuzhiyun #define DWC3_DEVTEN_SOFEN		(1 << 7)
298*4882a593Smuzhiyun #define DWC3_DEVTEN_EOPFEN		(1 << 6)
299*4882a593Smuzhiyun #define DWC3_DEVTEN_HIBERNATIONREQEVTEN	(1 << 5)
300*4882a593Smuzhiyun #define DWC3_DEVTEN_WKUPEVTEN		(1 << 4)
301*4882a593Smuzhiyun #define DWC3_DEVTEN_ULSTCNGEN		(1 << 3)
302*4882a593Smuzhiyun #define DWC3_DEVTEN_CONNECTDONEEN	(1 << 2)
303*4882a593Smuzhiyun #define DWC3_DEVTEN_USBRSTEN		(1 << 1)
304*4882a593Smuzhiyun #define DWC3_DEVTEN_DISCONNEVTEN	(1 << 0)
305*4882a593Smuzhiyun 
306*4882a593Smuzhiyun /* Device Status Register */
307*4882a593Smuzhiyun #define DWC3_DSTS_DCNRD			(1 << 29)
308*4882a593Smuzhiyun 
309*4882a593Smuzhiyun /* This applies for core versions 1.87a and earlier */
310*4882a593Smuzhiyun #define DWC3_DSTS_PWRUPREQ		(1 << 24)
311*4882a593Smuzhiyun 
312*4882a593Smuzhiyun /* These apply for core versions 1.94a and later */
313*4882a593Smuzhiyun #define DWC3_DSTS_RSS			(1 << 25)
314*4882a593Smuzhiyun #define DWC3_DSTS_SSS			(1 << 24)
315*4882a593Smuzhiyun 
316*4882a593Smuzhiyun #define DWC3_DSTS_COREIDLE		(1 << 23)
317*4882a593Smuzhiyun #define DWC3_DSTS_DEVCTRLHLT		(1 << 22)
318*4882a593Smuzhiyun 
319*4882a593Smuzhiyun #define DWC3_DSTS_USBLNKST_MASK		(0x0f << 18)
320*4882a593Smuzhiyun #define DWC3_DSTS_USBLNKST(n)		(((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
321*4882a593Smuzhiyun 
322*4882a593Smuzhiyun #define DWC3_DSTS_RXFIFOEMPTY		(1 << 17)
323*4882a593Smuzhiyun 
324*4882a593Smuzhiyun #define DWC3_DSTS_SOFFN_MASK		(0x3fff << 3)
325*4882a593Smuzhiyun #define DWC3_DSTS_SOFFN(n)		(((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
326*4882a593Smuzhiyun 
327*4882a593Smuzhiyun #define DWC3_DSTS_CONNECTSPD		(7 << 0)
328*4882a593Smuzhiyun 
329*4882a593Smuzhiyun #define DWC3_DSTS_SUPERSPEED		(4 << 0)
330*4882a593Smuzhiyun #define DWC3_DSTS_HIGHSPEED		(0 << 0)
331*4882a593Smuzhiyun #define DWC3_DSTS_FULLSPEED2		(1 << 0)
332*4882a593Smuzhiyun #define DWC3_DSTS_LOWSPEED		(2 << 0)
333*4882a593Smuzhiyun #define DWC3_DSTS_FULLSPEED1		(3 << 0)
334*4882a593Smuzhiyun 
335*4882a593Smuzhiyun /* Device Generic Command Register */
336*4882a593Smuzhiyun #define DWC3_DGCMD_SET_LMP		0x01
337*4882a593Smuzhiyun #define DWC3_DGCMD_SET_PERIODIC_PAR	0x02
338*4882a593Smuzhiyun #define DWC3_DGCMD_XMIT_FUNCTION	0x03
339*4882a593Smuzhiyun 
340*4882a593Smuzhiyun /* These apply for core versions 1.94a and later */
341*4882a593Smuzhiyun #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO	0x04
342*4882a593Smuzhiyun #define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI	0x05
343*4882a593Smuzhiyun 
344*4882a593Smuzhiyun #define DWC3_DGCMD_SELECTED_FIFO_FLUSH	0x09
345*4882a593Smuzhiyun #define DWC3_DGCMD_ALL_FIFO_FLUSH	0x0a
346*4882a593Smuzhiyun #define DWC3_DGCMD_SET_ENDPOINT_NRDY	0x0c
347*4882a593Smuzhiyun #define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK	0x10
348*4882a593Smuzhiyun 
349*4882a593Smuzhiyun #define DWC3_DGCMD_STATUS(n)		(((n) >> 15) & 1)
350*4882a593Smuzhiyun #define DWC3_DGCMD_CMDACT		(1 << 10)
351*4882a593Smuzhiyun #define DWC3_DGCMD_CMDIOC		(1 << 8)
352*4882a593Smuzhiyun 
353*4882a593Smuzhiyun /* Device Generic Command Parameter Register */
354*4882a593Smuzhiyun #define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT	(1 << 0)
355*4882a593Smuzhiyun #define DWC3_DGCMDPAR_FIFO_NUM(n)		((n) << 0)
356*4882a593Smuzhiyun #define DWC3_DGCMDPAR_RX_FIFO			(0 << 5)
357*4882a593Smuzhiyun #define DWC3_DGCMDPAR_TX_FIFO			(1 << 5)
358*4882a593Smuzhiyun #define DWC3_DGCMDPAR_LOOPBACK_DIS		(0 << 0)
359*4882a593Smuzhiyun #define DWC3_DGCMDPAR_LOOPBACK_ENA		(1 << 0)
360*4882a593Smuzhiyun 
361*4882a593Smuzhiyun /* Device Endpoint Command Register */
362*4882a593Smuzhiyun #define DWC3_DEPCMD_PARAM_SHIFT		16
363*4882a593Smuzhiyun #define DWC3_DEPCMD_PARAM(x)		((x) << DWC3_DEPCMD_PARAM_SHIFT)
364*4882a593Smuzhiyun #define DWC3_DEPCMD_GET_RSC_IDX(x)	(((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
365*4882a593Smuzhiyun #define DWC3_DEPCMD_STATUS(x)		(((x) >> 15) & 1)
366*4882a593Smuzhiyun #define DWC3_DEPCMD_HIPRI_FORCERM	(1 << 11)
367*4882a593Smuzhiyun #define DWC3_DEPCMD_CMDACT		(1 << 10)
368*4882a593Smuzhiyun #define DWC3_DEPCMD_CMDIOC		(1 << 8)
369*4882a593Smuzhiyun 
370*4882a593Smuzhiyun #define DWC3_DEPCMD_DEPSTARTCFG		(0x09 << 0)
371*4882a593Smuzhiyun #define DWC3_DEPCMD_ENDTRANSFER		(0x08 << 0)
372*4882a593Smuzhiyun #define DWC3_DEPCMD_UPDATETRANSFER	(0x07 << 0)
373*4882a593Smuzhiyun #define DWC3_DEPCMD_STARTTRANSFER	(0x06 << 0)
374*4882a593Smuzhiyun #define DWC3_DEPCMD_CLEARSTALL		(0x05 << 0)
375*4882a593Smuzhiyun #define DWC3_DEPCMD_SETSTALL		(0x04 << 0)
376*4882a593Smuzhiyun /* This applies for core versions 1.90a and earlier */
377*4882a593Smuzhiyun #define DWC3_DEPCMD_GETSEQNUMBER	(0x03 << 0)
378*4882a593Smuzhiyun /* This applies for core versions 1.94a and later */
379*4882a593Smuzhiyun #define DWC3_DEPCMD_GETEPSTATE		(0x03 << 0)
380*4882a593Smuzhiyun #define DWC3_DEPCMD_SETTRANSFRESOURCE	(0x02 << 0)
381*4882a593Smuzhiyun #define DWC3_DEPCMD_SETEPCONFIG		(0x01 << 0)
382*4882a593Smuzhiyun 
383*4882a593Smuzhiyun /* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
384*4882a593Smuzhiyun #define DWC3_DALEPENA_EP(n)		(1 << n)
385*4882a593Smuzhiyun 
386*4882a593Smuzhiyun #define DWC3_DEPCMD_TYPE_CONTROL	0
387*4882a593Smuzhiyun #define DWC3_DEPCMD_TYPE_ISOC		1
388*4882a593Smuzhiyun #define DWC3_DEPCMD_TYPE_BULK		2
389*4882a593Smuzhiyun #define DWC3_DEPCMD_TYPE_INTR		3
390*4882a593Smuzhiyun 
391*4882a593Smuzhiyun /* Structures */
392*4882a593Smuzhiyun 
393*4882a593Smuzhiyun struct dwc3_trb;
394*4882a593Smuzhiyun 
395*4882a593Smuzhiyun /**
396*4882a593Smuzhiyun  * struct dwc3_event_buffer - Software event buffer representation
397*4882a593Smuzhiyun  * @buf: _THE_ buffer
398*4882a593Smuzhiyun  * @length: size of this buffer
399*4882a593Smuzhiyun  * @lpos: event offset
400*4882a593Smuzhiyun  * @count: cache of last read event count register
401*4882a593Smuzhiyun  * @flags: flags related to this event buffer
402*4882a593Smuzhiyun  * @dma: dma_addr_t
403*4882a593Smuzhiyun  * @dwc: pointer to DWC controller
404*4882a593Smuzhiyun  */
405*4882a593Smuzhiyun struct dwc3_event_buffer {
406*4882a593Smuzhiyun 	void			*buf;
407*4882a593Smuzhiyun 	unsigned		length;
408*4882a593Smuzhiyun 	unsigned int		lpos;
409*4882a593Smuzhiyun 	unsigned int		count;
410*4882a593Smuzhiyun 	unsigned int		flags;
411*4882a593Smuzhiyun 
412*4882a593Smuzhiyun #define DWC3_EVENT_PENDING	(1UL << 0)
413*4882a593Smuzhiyun 
414*4882a593Smuzhiyun 	dma_addr_t		dma;
415*4882a593Smuzhiyun 
416*4882a593Smuzhiyun 	struct dwc3		*dwc;
417*4882a593Smuzhiyun };
418*4882a593Smuzhiyun 
419*4882a593Smuzhiyun #define DWC3_EP_FLAG_STALLED	(1 << 0)
420*4882a593Smuzhiyun #define DWC3_EP_FLAG_WEDGED	(1 << 1)
421*4882a593Smuzhiyun 
422*4882a593Smuzhiyun #define DWC3_EP_DIRECTION_TX	true
423*4882a593Smuzhiyun #define DWC3_EP_DIRECTION_RX	false
424*4882a593Smuzhiyun 
425*4882a593Smuzhiyun #define DWC3_TRB_NUM		32
426*4882a593Smuzhiyun #define DWC3_TRB_MASK		(DWC3_TRB_NUM - 1)
427*4882a593Smuzhiyun 
428*4882a593Smuzhiyun /**
429*4882a593Smuzhiyun  * struct dwc3_ep - device side endpoint representation
430*4882a593Smuzhiyun  * @endpoint: usb endpoint
431*4882a593Smuzhiyun  * @request_list: list of requests for this endpoint
432*4882a593Smuzhiyun  * @req_queued: list of requests on this ep which have TRBs setup
433*4882a593Smuzhiyun  * @trb_pool: array of transaction buffers
434*4882a593Smuzhiyun  * @trb_pool_dma: dma address of @trb_pool
435*4882a593Smuzhiyun  * @free_slot: next slot which is going to be used
436*4882a593Smuzhiyun  * @busy_slot: first slot which is owned by HW
437*4882a593Smuzhiyun  * @desc: usb_endpoint_descriptor pointer
438*4882a593Smuzhiyun  * @dwc: pointer to DWC controller
439*4882a593Smuzhiyun  * @saved_state: ep state saved during hibernation
440*4882a593Smuzhiyun  * @flags: endpoint flags (wedged, stalled, ...)
441*4882a593Smuzhiyun  * @current_trb: index of current used trb
442*4882a593Smuzhiyun  * @number: endpoint number (1 - 15)
443*4882a593Smuzhiyun  * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
444*4882a593Smuzhiyun  * @resource_index: Resource transfer index
445*4882a593Smuzhiyun  * @interval: the interval on which the ISOC transfer is started
446*4882a593Smuzhiyun  * @name: a human readable name e.g. ep1out-bulk
447*4882a593Smuzhiyun  * @direction: true for TX, false for RX
448*4882a593Smuzhiyun  * @stream_capable: true when streams are enabled
449*4882a593Smuzhiyun  */
450*4882a593Smuzhiyun struct dwc3_ep {
451*4882a593Smuzhiyun 	struct usb_ep		endpoint;
452*4882a593Smuzhiyun 	struct list_head	request_list;
453*4882a593Smuzhiyun 	struct list_head	req_queued;
454*4882a593Smuzhiyun 
455*4882a593Smuzhiyun 	struct dwc3_trb		*trb_pool;
456*4882a593Smuzhiyun 	dma_addr_t		trb_pool_dma;
457*4882a593Smuzhiyun 	u32			free_slot;
458*4882a593Smuzhiyun 	u32			busy_slot;
459*4882a593Smuzhiyun 	const struct usb_ss_ep_comp_descriptor *comp_desc;
460*4882a593Smuzhiyun 	struct dwc3		*dwc;
461*4882a593Smuzhiyun 
462*4882a593Smuzhiyun 	u32			saved_state;
463*4882a593Smuzhiyun 	unsigned		flags;
464*4882a593Smuzhiyun #define DWC3_EP_ENABLED		(1 << 0)
465*4882a593Smuzhiyun #define DWC3_EP_STALL		(1 << 1)
466*4882a593Smuzhiyun #define DWC3_EP_WEDGE		(1 << 2)
467*4882a593Smuzhiyun #define DWC3_EP_BUSY		(1 << 4)
468*4882a593Smuzhiyun #define DWC3_EP_PENDING_REQUEST	(1 << 5)
469*4882a593Smuzhiyun #define DWC3_EP_MISSED_ISOC	(1 << 6)
470*4882a593Smuzhiyun 
471*4882a593Smuzhiyun 	/* This last one is specific to EP0 */
472*4882a593Smuzhiyun #define DWC3_EP0_DIR_IN		(1 << 31)
473*4882a593Smuzhiyun 
474*4882a593Smuzhiyun 	unsigned		current_trb;
475*4882a593Smuzhiyun 
476*4882a593Smuzhiyun 	u8			number;
477*4882a593Smuzhiyun 	u8			type;
478*4882a593Smuzhiyun 	u8			resource_index;
479*4882a593Smuzhiyun 	u32			interval;
480*4882a593Smuzhiyun 
481*4882a593Smuzhiyun 	char			name[20];
482*4882a593Smuzhiyun 
483*4882a593Smuzhiyun 	unsigned		direction:1;
484*4882a593Smuzhiyun 	unsigned		stream_capable:1;
485*4882a593Smuzhiyun };
486*4882a593Smuzhiyun 
487*4882a593Smuzhiyun enum dwc3_phy {
488*4882a593Smuzhiyun 	DWC3_PHY_UNKNOWN = 0,
489*4882a593Smuzhiyun 	DWC3_PHY_USB3,
490*4882a593Smuzhiyun 	DWC3_PHY_USB2,
491*4882a593Smuzhiyun };
492*4882a593Smuzhiyun 
493*4882a593Smuzhiyun enum dwc3_ep0_next {
494*4882a593Smuzhiyun 	DWC3_EP0_UNKNOWN = 0,
495*4882a593Smuzhiyun 	DWC3_EP0_COMPLETE,
496*4882a593Smuzhiyun 	DWC3_EP0_NRDY_DATA,
497*4882a593Smuzhiyun 	DWC3_EP0_NRDY_STATUS,
498*4882a593Smuzhiyun };
499*4882a593Smuzhiyun 
500*4882a593Smuzhiyun enum dwc3_ep0_state {
501*4882a593Smuzhiyun 	EP0_UNCONNECTED		= 0,
502*4882a593Smuzhiyun 	EP0_SETUP_PHASE,
503*4882a593Smuzhiyun 	EP0_DATA_PHASE,
504*4882a593Smuzhiyun 	EP0_STATUS_PHASE,
505*4882a593Smuzhiyun };
506*4882a593Smuzhiyun 
507*4882a593Smuzhiyun enum dwc3_link_state {
508*4882a593Smuzhiyun 	/* In SuperSpeed */
509*4882a593Smuzhiyun 	DWC3_LINK_STATE_U0		= 0x00, /* in HS, means ON */
510*4882a593Smuzhiyun 	DWC3_LINK_STATE_U1		= 0x01,
511*4882a593Smuzhiyun 	DWC3_LINK_STATE_U2		= 0x02, /* in HS, means SLEEP */
512*4882a593Smuzhiyun 	DWC3_LINK_STATE_U3		= 0x03, /* in HS, means SUSPEND */
513*4882a593Smuzhiyun 	DWC3_LINK_STATE_SS_DIS		= 0x04,
514*4882a593Smuzhiyun 	DWC3_LINK_STATE_RX_DET		= 0x05, /* in HS, means Early Suspend */
515*4882a593Smuzhiyun 	DWC3_LINK_STATE_SS_INACT	= 0x06,
516*4882a593Smuzhiyun 	DWC3_LINK_STATE_POLL		= 0x07,
517*4882a593Smuzhiyun 	DWC3_LINK_STATE_RECOV		= 0x08,
518*4882a593Smuzhiyun 	DWC3_LINK_STATE_HRESET		= 0x09,
519*4882a593Smuzhiyun 	DWC3_LINK_STATE_CMPLY		= 0x0a,
520*4882a593Smuzhiyun 	DWC3_LINK_STATE_LPBK		= 0x0b,
521*4882a593Smuzhiyun 	DWC3_LINK_STATE_RESET		= 0x0e,
522*4882a593Smuzhiyun 	DWC3_LINK_STATE_RESUME		= 0x0f,
523*4882a593Smuzhiyun 	DWC3_LINK_STATE_MASK		= 0x0f,
524*4882a593Smuzhiyun };
525*4882a593Smuzhiyun 
526*4882a593Smuzhiyun /* TRB Length, PCM and Status */
527*4882a593Smuzhiyun #define DWC3_TRB_SIZE_MASK	(0x00ffffff)
528*4882a593Smuzhiyun #define DWC3_TRB_SIZE_LENGTH(n)	((n) & DWC3_TRB_SIZE_MASK)
529*4882a593Smuzhiyun #define DWC3_TRB_SIZE_PCM1(n)	(((n) & 0x03) << 24)
530*4882a593Smuzhiyun #define DWC3_TRB_SIZE_TRBSTS(n)	(((n) & (0x0f << 28)) >> 28)
531*4882a593Smuzhiyun 
532*4882a593Smuzhiyun #define DWC3_TRBSTS_OK			0
533*4882a593Smuzhiyun #define DWC3_TRBSTS_MISSED_ISOC		1
534*4882a593Smuzhiyun #define DWC3_TRBSTS_SETUP_PENDING	2
535*4882a593Smuzhiyun #define DWC3_TRB_STS_XFER_IN_PROG	4
536*4882a593Smuzhiyun 
537*4882a593Smuzhiyun /* TRB Control */
538*4882a593Smuzhiyun #define DWC3_TRB_CTRL_HWO		(1 << 0)
539*4882a593Smuzhiyun #define DWC3_TRB_CTRL_LST		(1 << 1)
540*4882a593Smuzhiyun #define DWC3_TRB_CTRL_CHN		(1 << 2)
541*4882a593Smuzhiyun #define DWC3_TRB_CTRL_CSP		(1 << 3)
542*4882a593Smuzhiyun #define DWC3_TRB_CTRL_TRBCTL(n)		(((n) & 0x3f) << 4)
543*4882a593Smuzhiyun #define DWC3_TRB_CTRL_ISP_IMI		(1 << 10)
544*4882a593Smuzhiyun #define DWC3_TRB_CTRL_IOC		(1 << 11)
545*4882a593Smuzhiyun #define DWC3_TRB_CTRL_SID_SOFN(n)	(((n) & 0xffff) << 14)
546*4882a593Smuzhiyun 
547*4882a593Smuzhiyun #define DWC3_TRBCTL_NORMAL		DWC3_TRB_CTRL_TRBCTL(1)
548*4882a593Smuzhiyun #define DWC3_TRBCTL_CONTROL_SETUP	DWC3_TRB_CTRL_TRBCTL(2)
549*4882a593Smuzhiyun #define DWC3_TRBCTL_CONTROL_STATUS2	DWC3_TRB_CTRL_TRBCTL(3)
550*4882a593Smuzhiyun #define DWC3_TRBCTL_CONTROL_STATUS3	DWC3_TRB_CTRL_TRBCTL(4)
551*4882a593Smuzhiyun #define DWC3_TRBCTL_CONTROL_DATA	DWC3_TRB_CTRL_TRBCTL(5)
552*4882a593Smuzhiyun #define DWC3_TRBCTL_ISOCHRONOUS_FIRST	DWC3_TRB_CTRL_TRBCTL(6)
553*4882a593Smuzhiyun #define DWC3_TRBCTL_ISOCHRONOUS		DWC3_TRB_CTRL_TRBCTL(7)
554*4882a593Smuzhiyun #define DWC3_TRBCTL_LINK_TRB		DWC3_TRB_CTRL_TRBCTL(8)
555*4882a593Smuzhiyun 
556*4882a593Smuzhiyun /**
557*4882a593Smuzhiyun  * struct dwc3_trb - transfer request block (hw format)
558*4882a593Smuzhiyun  * @bpl: DW0-3
559*4882a593Smuzhiyun  * @bph: DW4-7
560*4882a593Smuzhiyun  * @size: DW8-B
561*4882a593Smuzhiyun  * @trl: DWC-F
562*4882a593Smuzhiyun  */
563*4882a593Smuzhiyun struct dwc3_trb {
564*4882a593Smuzhiyun 	u32		bpl;
565*4882a593Smuzhiyun 	u32		bph;
566*4882a593Smuzhiyun 	u32		size;
567*4882a593Smuzhiyun 	u32		ctrl;
568*4882a593Smuzhiyun } __packed;
569*4882a593Smuzhiyun 
570*4882a593Smuzhiyun /**
571*4882a593Smuzhiyun  * dwc3_hwparams - copy of HWPARAMS registers
572*4882a593Smuzhiyun  * @hwparams0 - GHWPARAMS0
573*4882a593Smuzhiyun  * @hwparams1 - GHWPARAMS1
574*4882a593Smuzhiyun  * @hwparams2 - GHWPARAMS2
575*4882a593Smuzhiyun  * @hwparams3 - GHWPARAMS3
576*4882a593Smuzhiyun  * @hwparams4 - GHWPARAMS4
577*4882a593Smuzhiyun  * @hwparams5 - GHWPARAMS5
578*4882a593Smuzhiyun  * @hwparams6 - GHWPARAMS6
579*4882a593Smuzhiyun  * @hwparams7 - GHWPARAMS7
580*4882a593Smuzhiyun  * @hwparams8 - GHWPARAMS8
581*4882a593Smuzhiyun  */
582*4882a593Smuzhiyun struct dwc3_hwparams {
583*4882a593Smuzhiyun 	u32	hwparams0;
584*4882a593Smuzhiyun 	u32	hwparams1;
585*4882a593Smuzhiyun 	u32	hwparams2;
586*4882a593Smuzhiyun 	u32	hwparams3;
587*4882a593Smuzhiyun 	u32	hwparams4;
588*4882a593Smuzhiyun 	u32	hwparams5;
589*4882a593Smuzhiyun 	u32	hwparams6;
590*4882a593Smuzhiyun 	u32	hwparams7;
591*4882a593Smuzhiyun 	u32	hwparams8;
592*4882a593Smuzhiyun };
593*4882a593Smuzhiyun 
594*4882a593Smuzhiyun /* HWPARAMS0 */
595*4882a593Smuzhiyun #define DWC3_MODE(n)		((n) & 0x7)
596*4882a593Smuzhiyun 
597*4882a593Smuzhiyun #define DWC3_MDWIDTH(n)		(((n) & 0xff00) >> 8)
598*4882a593Smuzhiyun 
599*4882a593Smuzhiyun /* HWPARAMS1 */
600*4882a593Smuzhiyun #define DWC3_NUM_INT(n)		(((n) & (0x3f << 15)) >> 15)
601*4882a593Smuzhiyun 
602*4882a593Smuzhiyun /* HWPARAMS3 */
603*4882a593Smuzhiyun #define DWC3_NUM_IN_EPS_MASK	(0x1f << 18)
604*4882a593Smuzhiyun #define DWC3_NUM_EPS_MASK	(0x3f << 12)
605*4882a593Smuzhiyun #define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
606*4882a593Smuzhiyun 			(DWC3_NUM_EPS_MASK)) >> 12)
607*4882a593Smuzhiyun #define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
608*4882a593Smuzhiyun 			(DWC3_NUM_IN_EPS_MASK)) >> 18)
609*4882a593Smuzhiyun 
610*4882a593Smuzhiyun /* HWPARAMS7 */
611*4882a593Smuzhiyun #define DWC3_RAM1_DEPTH(n)	((n) & 0xffff)
612*4882a593Smuzhiyun 
613*4882a593Smuzhiyun struct dwc3_request {
614*4882a593Smuzhiyun 	struct usb_request	request;
615*4882a593Smuzhiyun 	struct list_head	list;
616*4882a593Smuzhiyun 	struct dwc3_ep		*dep;
617*4882a593Smuzhiyun 	u32			start_slot;
618*4882a593Smuzhiyun 
619*4882a593Smuzhiyun 	u8			epnum;
620*4882a593Smuzhiyun 	struct dwc3_trb		*trb;
621*4882a593Smuzhiyun 	dma_addr_t		trb_dma;
622*4882a593Smuzhiyun 
623*4882a593Smuzhiyun 	unsigned		direction:1;
624*4882a593Smuzhiyun 	unsigned		mapped:1;
625*4882a593Smuzhiyun 	unsigned		queued:1;
626*4882a593Smuzhiyun };
627*4882a593Smuzhiyun 
628*4882a593Smuzhiyun /*
629*4882a593Smuzhiyun  * struct dwc3_scratchpad_array - hibernation scratchpad array
630*4882a593Smuzhiyun  * (format defined by hw)
631*4882a593Smuzhiyun  */
632*4882a593Smuzhiyun struct dwc3_scratchpad_array {
633*4882a593Smuzhiyun 	__le64	dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
634*4882a593Smuzhiyun };
635*4882a593Smuzhiyun 
636*4882a593Smuzhiyun /**
637*4882a593Smuzhiyun  * struct dwc3 - representation of our controller
638*4882a593Smuzhiyun  * @ctrl_req: usb control request which is used for ep0
639*4882a593Smuzhiyun  * @ep0_trb: trb which is used for the ctrl_req
640*4882a593Smuzhiyun  * @ep0_bounce: bounce buffer for ep0
641*4882a593Smuzhiyun  * @setup_buf: used while precessing STD USB requests
642*4882a593Smuzhiyun  * @ctrl_req_addr: dma address of ctrl_req
643*4882a593Smuzhiyun  * @ep0_trb: dma address of ep0_trb
644*4882a593Smuzhiyun  * @ep0_usb_req: dummy req used while handling STD USB requests
645*4882a593Smuzhiyun  * @ep0_bounce_addr: dma address of ep0_bounce
646*4882a593Smuzhiyun  * @scratch_addr: dma address of scratchbuf
647*4882a593Smuzhiyun  * @lock: for synchronizing
648*4882a593Smuzhiyun  * @dev: pointer to our struct device
649*4882a593Smuzhiyun  * @xhci: pointer to our xHCI child
650*4882a593Smuzhiyun  * @event_buffer_list: a list of event buffers
651*4882a593Smuzhiyun  * @gadget: device side representation of the peripheral controller
652*4882a593Smuzhiyun  * @gadget_driver: pointer to the gadget driver
653*4882a593Smuzhiyun  * @regs: base address for our registers
654*4882a593Smuzhiyun  * @regs_size: address space size
655*4882a593Smuzhiyun  * @nr_scratch: number of scratch buffers
656*4882a593Smuzhiyun  * @num_event_buffers: calculated number of event buffers
657*4882a593Smuzhiyun  * @u1u2: only used on revisions <1.83a for workaround
658*4882a593Smuzhiyun  * @maximum_speed: maximum speed requested (mainly for testing purposes)
659*4882a593Smuzhiyun  * @revision: revision register contents
660*4882a593Smuzhiyun  * @dr_mode: requested mode of operation
661*4882a593Smuzhiyun  * @hsphy_mode: UTMI phy mode, one of following:
662*4882a593Smuzhiyun  *		- USBPHY_INTERFACE_MODE_UTMI
663*4882a593Smuzhiyun  *		- USBPHY_INTERFACE_MODE_UTMIW
664*4882a593Smuzhiyun  * @dcfg: saved contents of DCFG register
665*4882a593Smuzhiyun  * @gctl: saved contents of GCTL register
666*4882a593Smuzhiyun  * @isoch_delay: wValue from Set Isochronous Delay request;
667*4882a593Smuzhiyun  * @u2sel: parameter from Set SEL request.
668*4882a593Smuzhiyun  * @u2pel: parameter from Set SEL request.
669*4882a593Smuzhiyun  * @u1sel: parameter from Set SEL request.
670*4882a593Smuzhiyun  * @u1pel: parameter from Set SEL request.
671*4882a593Smuzhiyun  * @num_out_eps: number of out endpoints
672*4882a593Smuzhiyun  * @num_in_eps: number of in endpoints
673*4882a593Smuzhiyun  * @ep0_next_event: hold the next expected event
674*4882a593Smuzhiyun  * @ep0state: state of endpoint zero
675*4882a593Smuzhiyun  * @link_state: link state
676*4882a593Smuzhiyun  * @speed: device speed (super, high, full, low)
677*4882a593Smuzhiyun  * @mem: points to start of memory which is used for this struct.
678*4882a593Smuzhiyun  * @hwparams: copy of hwparams registers
679*4882a593Smuzhiyun  * @root: debugfs root folder pointer
680*4882a593Smuzhiyun  * @regset: debugfs pointer to regdump file
681*4882a593Smuzhiyun  * @test_mode: true when we're entering a USB test mode
682*4882a593Smuzhiyun  * @test_mode_nr: test feature selector
683*4882a593Smuzhiyun  * @lpm_nyet_threshold: LPM NYET response threshold
684*4882a593Smuzhiyun  * @hird_threshold: HIRD threshold
685*4882a593Smuzhiyun  * @delayed_status: true when gadget driver asks for delayed status
686*4882a593Smuzhiyun  * @ep0_bounced: true when we used bounce buffer
687*4882a593Smuzhiyun  * @ep0_expect_in: true when we expect a DATA IN transfer
688*4882a593Smuzhiyun  * @has_hibernation: true when dwc3 was configured with Hibernation
689*4882a593Smuzhiyun  * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
690*4882a593Smuzhiyun  *			there's now way for software to detect this in runtime.
691*4882a593Smuzhiyun  * @is_utmi_l1_suspend: the core asserts output signal
692*4882a593Smuzhiyun  * 	0	- utmi_sleep_n
693*4882a593Smuzhiyun  * 	1	- utmi_l1_suspend_n
694*4882a593Smuzhiyun  * @is_selfpowered: true when we are selfpowered
695*4882a593Smuzhiyun  * @is_fpga: true when we are using the FPGA board
696*4882a593Smuzhiyun  * @needs_fifo_resize: not all users might want fifo resizing, flag it
697*4882a593Smuzhiyun  * @pullups_connected: true when Run/Stop bit is set
698*4882a593Smuzhiyun  * @resize_fifos: tells us it's ok to reconfigure our TxFIFO sizes.
699*4882a593Smuzhiyun  * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
700*4882a593Smuzhiyun  * @start_config_issued: true when StartConfig command has been issued
701*4882a593Smuzhiyun  * @three_stage_setup: set if we perform a three phase setup
702*4882a593Smuzhiyun  * @disable_scramble_quirk: set if we enable the disable scramble quirk
703*4882a593Smuzhiyun  * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
704*4882a593Smuzhiyun  * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
705*4882a593Smuzhiyun  * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
706*4882a593Smuzhiyun  * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
707*4882a593Smuzhiyun  * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
708*4882a593Smuzhiyun  * @lfps_filter_quirk: set if we enable LFPS filter quirk
709*4882a593Smuzhiyun  * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
710*4882a593Smuzhiyun  * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
711*4882a593Smuzhiyun  * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
712*4882a593Smuzhiyun  * @dis_u1u2_quirk: set if we reject transition to U1 or U2 state
713*4882a593Smuzhiyun  * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
714*4882a593Smuzhiyun  * @tx_de_emphasis: Tx de-emphasis value
715*4882a593Smuzhiyun  * 	0	- -6dB de-emphasis
716*4882a593Smuzhiyun  * 	1	- -3.5dB de-emphasis
717*4882a593Smuzhiyun  * 	2	- No de-emphasis
718*4882a593Smuzhiyun  * 	3	- Reserved
719*4882a593Smuzhiyun  * @index: index of _this_ controller
720*4882a593Smuzhiyun  * @list: to maintain the list of dwc3 controllers
721*4882a593Smuzhiyun  */
722*4882a593Smuzhiyun struct dwc3 {
723*4882a593Smuzhiyun 	struct usb_ctrlrequest	*ctrl_req;
724*4882a593Smuzhiyun 	struct dwc3_trb		*ep0_trb;
725*4882a593Smuzhiyun 	void			*ep0_bounce;
726*4882a593Smuzhiyun 	void			*scratchbuf;
727*4882a593Smuzhiyun 	u8			*setup_buf;
728*4882a593Smuzhiyun 	dma_addr_t		ctrl_req_addr;
729*4882a593Smuzhiyun 	dma_addr_t		ep0_trb_addr;
730*4882a593Smuzhiyun 	dma_addr_t		ep0_bounce_addr;
731*4882a593Smuzhiyun 	dma_addr_t		scratch_addr;
732*4882a593Smuzhiyun 	struct dwc3_request	ep0_usb_req;
733*4882a593Smuzhiyun 
734*4882a593Smuzhiyun 	/* device lock */
735*4882a593Smuzhiyun 	spinlock_t		lock;
736*4882a593Smuzhiyun 
737*4882a593Smuzhiyun #if defined(__UBOOT__) && CONFIG_IS_ENABLED(DM_USB)
738*4882a593Smuzhiyun 	struct udevice		*dev;
739*4882a593Smuzhiyun #else
740*4882a593Smuzhiyun 	struct device		*dev;
741*4882a593Smuzhiyun #endif
742*4882a593Smuzhiyun 
743*4882a593Smuzhiyun 	struct platform_device	*xhci;
744*4882a593Smuzhiyun 	struct resource		xhci_resources[DWC3_XHCI_RESOURCES_NUM];
745*4882a593Smuzhiyun 
746*4882a593Smuzhiyun 	struct dwc3_event_buffer **ev_buffs;
747*4882a593Smuzhiyun 	struct dwc3_ep		*eps[DWC3_ENDPOINTS_NUM];
748*4882a593Smuzhiyun 
749*4882a593Smuzhiyun 	struct usb_gadget	gadget;
750*4882a593Smuzhiyun 	struct usb_gadget_driver *gadget_driver;
751*4882a593Smuzhiyun 
752*4882a593Smuzhiyun 	void __iomem		*regs;
753*4882a593Smuzhiyun 	size_t			regs_size;
754*4882a593Smuzhiyun 
755*4882a593Smuzhiyun 	enum usb_dr_mode	dr_mode;
756*4882a593Smuzhiyun 	enum usb_phy_interface	hsphy_mode;
757*4882a593Smuzhiyun 
758*4882a593Smuzhiyun 	/* used for suspend/resume */
759*4882a593Smuzhiyun 	u32			dcfg;
760*4882a593Smuzhiyun 	u32			gctl;
761*4882a593Smuzhiyun 
762*4882a593Smuzhiyun 	u32			nr_scratch;
763*4882a593Smuzhiyun 	u32			num_event_buffers;
764*4882a593Smuzhiyun 	u32			u1u2;
765*4882a593Smuzhiyun 	u32			maximum_speed;
766*4882a593Smuzhiyun 	u32			revision;
767*4882a593Smuzhiyun 
768*4882a593Smuzhiyun #define DWC3_REVISION_173A	0x5533173a
769*4882a593Smuzhiyun #define DWC3_REVISION_175A	0x5533175a
770*4882a593Smuzhiyun #define DWC3_REVISION_180A	0x5533180a
771*4882a593Smuzhiyun #define DWC3_REVISION_183A	0x5533183a
772*4882a593Smuzhiyun #define DWC3_REVISION_185A	0x5533185a
773*4882a593Smuzhiyun #define DWC3_REVISION_187A	0x5533187a
774*4882a593Smuzhiyun #define DWC3_REVISION_188A	0x5533188a
775*4882a593Smuzhiyun #define DWC3_REVISION_190A	0x5533190a
776*4882a593Smuzhiyun #define DWC3_REVISION_194A	0x5533194a
777*4882a593Smuzhiyun #define DWC3_REVISION_200A	0x5533200a
778*4882a593Smuzhiyun #define DWC3_REVISION_202A	0x5533202a
779*4882a593Smuzhiyun #define DWC3_REVISION_210A	0x5533210a
780*4882a593Smuzhiyun #define DWC3_REVISION_220A	0x5533220a
781*4882a593Smuzhiyun #define DWC3_REVISION_230A	0x5533230a
782*4882a593Smuzhiyun #define DWC3_REVISION_240A	0x5533240a
783*4882a593Smuzhiyun #define DWC3_REVISION_250A	0x5533250a
784*4882a593Smuzhiyun #define DWC3_REVISION_260A	0x5533260a
785*4882a593Smuzhiyun #define DWC3_REVISION_270A	0x5533270a
786*4882a593Smuzhiyun #define DWC3_REVISION_280A	0x5533280a
787*4882a593Smuzhiyun 
788*4882a593Smuzhiyun 	enum dwc3_ep0_next	ep0_next_event;
789*4882a593Smuzhiyun 	enum dwc3_ep0_state	ep0state;
790*4882a593Smuzhiyun 	enum dwc3_link_state	link_state;
791*4882a593Smuzhiyun 
792*4882a593Smuzhiyun 	u16			isoch_delay;
793*4882a593Smuzhiyun 	u16			u2sel;
794*4882a593Smuzhiyun 	u16			u2pel;
795*4882a593Smuzhiyun 	u8			u1sel;
796*4882a593Smuzhiyun 	u8			u1pel;
797*4882a593Smuzhiyun 
798*4882a593Smuzhiyun 	u8			speed;
799*4882a593Smuzhiyun 
800*4882a593Smuzhiyun 	u8			num_out_eps;
801*4882a593Smuzhiyun 	u8			num_in_eps;
802*4882a593Smuzhiyun 
803*4882a593Smuzhiyun 	void			*mem;
804*4882a593Smuzhiyun 
805*4882a593Smuzhiyun 	struct dwc3_hwparams	hwparams;
806*4882a593Smuzhiyun 	struct dentry		*root;
807*4882a593Smuzhiyun 	struct debugfs_regset32	*regset;
808*4882a593Smuzhiyun 
809*4882a593Smuzhiyun 	u8			test_mode;
810*4882a593Smuzhiyun 	u8			test_mode_nr;
811*4882a593Smuzhiyun 	u8			lpm_nyet_threshold;
812*4882a593Smuzhiyun 	u8			hird_threshold;
813*4882a593Smuzhiyun 
814*4882a593Smuzhiyun 	unsigned		delayed_status:1;
815*4882a593Smuzhiyun 	unsigned		ep0_bounced:1;
816*4882a593Smuzhiyun 	unsigned		ep0_expect_in:1;
817*4882a593Smuzhiyun 	unsigned		has_hibernation:1;
818*4882a593Smuzhiyun 	unsigned		has_lpm_erratum:1;
819*4882a593Smuzhiyun 	unsigned		is_utmi_l1_suspend:1;
820*4882a593Smuzhiyun 	unsigned		is_selfpowered:1;
821*4882a593Smuzhiyun 	unsigned		is_fpga:1;
822*4882a593Smuzhiyun 	unsigned		needs_fifo_resize:1;
823*4882a593Smuzhiyun 	unsigned		pullups_connected:1;
824*4882a593Smuzhiyun 	unsigned		resize_fifos:1;
825*4882a593Smuzhiyun 	unsigned		setup_packet_pending:1;
826*4882a593Smuzhiyun 	unsigned		start_config_issued:1;
827*4882a593Smuzhiyun 	unsigned		three_stage_setup:1;
828*4882a593Smuzhiyun 
829*4882a593Smuzhiyun 	unsigned		disable_scramble_quirk:1;
830*4882a593Smuzhiyun 	unsigned		u2exit_lfps_quirk:1;
831*4882a593Smuzhiyun 	unsigned		u2ss_inp3_quirk:1;
832*4882a593Smuzhiyun 	unsigned		req_p1p2p3_quirk:1;
833*4882a593Smuzhiyun 	unsigned                del_p1p2p3_quirk:1;
834*4882a593Smuzhiyun 	unsigned		del_phy_power_chg_quirk:1;
835*4882a593Smuzhiyun 	unsigned		lfps_filter_quirk:1;
836*4882a593Smuzhiyun 	unsigned		rx_detect_poll_quirk:1;
837*4882a593Smuzhiyun 	unsigned		dis_u3_susphy_quirk:1;
838*4882a593Smuzhiyun 	unsigned		dis_u2_susphy_quirk:1;
839*4882a593Smuzhiyun 	unsigned		dis_u1u2_quirk:1;
840*4882a593Smuzhiyun 	unsigned		dis_enblslpm_quirk:1;
841*4882a593Smuzhiyun 	unsigned		dis_u2_freeclk_exists_quirk:1;
842*4882a593Smuzhiyun 
843*4882a593Smuzhiyun 	unsigned		tx_de_emphasis_quirk:1;
844*4882a593Smuzhiyun 	unsigned		tx_de_emphasis:2;
845*4882a593Smuzhiyun 	unsigned		usb2_phyif_utmi_width:5;
846*4882a593Smuzhiyun 	int			index;
847*4882a593Smuzhiyun 	struct list_head        list;
848*4882a593Smuzhiyun };
849*4882a593Smuzhiyun 
850*4882a593Smuzhiyun /* -------------------------------------------------------------------------- */
851*4882a593Smuzhiyun 
852*4882a593Smuzhiyun /* -------------------------------------------------------------------------- */
853*4882a593Smuzhiyun 
854*4882a593Smuzhiyun struct dwc3_event_type {
855*4882a593Smuzhiyun 	u32	is_devspec:1;
856*4882a593Smuzhiyun 	u32	type:7;
857*4882a593Smuzhiyun 	u32	reserved8_31:24;
858*4882a593Smuzhiyun } __packed;
859*4882a593Smuzhiyun 
860*4882a593Smuzhiyun #define DWC3_DEPEVT_XFERCOMPLETE	0x01
861*4882a593Smuzhiyun #define DWC3_DEPEVT_XFERINPROGRESS	0x02
862*4882a593Smuzhiyun #define DWC3_DEPEVT_XFERNOTREADY	0x03
863*4882a593Smuzhiyun #define DWC3_DEPEVT_RXTXFIFOEVT		0x04
864*4882a593Smuzhiyun #define DWC3_DEPEVT_STREAMEVT		0x06
865*4882a593Smuzhiyun #define DWC3_DEPEVT_EPCMDCMPLT		0x07
866*4882a593Smuzhiyun 
867*4882a593Smuzhiyun /**
868*4882a593Smuzhiyun  * dwc3_ep_event_string - returns event name
869*4882a593Smuzhiyun  * @event: then event code
870*4882a593Smuzhiyun  */
dwc3_ep_event_string(u8 event)871*4882a593Smuzhiyun static inline const char *dwc3_ep_event_string(u8 event)
872*4882a593Smuzhiyun {
873*4882a593Smuzhiyun 	switch (event) {
874*4882a593Smuzhiyun 	case DWC3_DEPEVT_XFERCOMPLETE:
875*4882a593Smuzhiyun 		return "Transfer Complete";
876*4882a593Smuzhiyun 	case DWC3_DEPEVT_XFERINPROGRESS:
877*4882a593Smuzhiyun 		return "Transfer In-Progress";
878*4882a593Smuzhiyun 	case DWC3_DEPEVT_XFERNOTREADY:
879*4882a593Smuzhiyun 		return "Transfer Not Ready";
880*4882a593Smuzhiyun 	case DWC3_DEPEVT_RXTXFIFOEVT:
881*4882a593Smuzhiyun 		return "FIFO";
882*4882a593Smuzhiyun 	case DWC3_DEPEVT_STREAMEVT:
883*4882a593Smuzhiyun 		return "Stream";
884*4882a593Smuzhiyun 	case DWC3_DEPEVT_EPCMDCMPLT:
885*4882a593Smuzhiyun 		return "Endpoint Command Complete";
886*4882a593Smuzhiyun 	}
887*4882a593Smuzhiyun 
888*4882a593Smuzhiyun 	return "UNKNOWN";
889*4882a593Smuzhiyun }
890*4882a593Smuzhiyun 
891*4882a593Smuzhiyun /**
892*4882a593Smuzhiyun  * struct dwc3_event_depvt - Device Endpoint Events
893*4882a593Smuzhiyun  * @one_bit: indicates this is an endpoint event (not used)
894*4882a593Smuzhiyun  * @endpoint_number: number of the endpoint
895*4882a593Smuzhiyun  * @endpoint_event: The event we have:
896*4882a593Smuzhiyun  *	0x00	- Reserved
897*4882a593Smuzhiyun  *	0x01	- XferComplete
898*4882a593Smuzhiyun  *	0x02	- XferInProgress
899*4882a593Smuzhiyun  *	0x03	- XferNotReady
900*4882a593Smuzhiyun  *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
901*4882a593Smuzhiyun  *	0x05	- Reserved
902*4882a593Smuzhiyun  *	0x06	- StreamEvt
903*4882a593Smuzhiyun  *	0x07	- EPCmdCmplt
904*4882a593Smuzhiyun  * @reserved11_10: Reserved, don't use.
905*4882a593Smuzhiyun  * @status: Indicates the status of the event. Refer to databook for
906*4882a593Smuzhiyun  *	more information.
907*4882a593Smuzhiyun  * @parameters: Parameters of the current event. Refer to databook for
908*4882a593Smuzhiyun  *	more information.
909*4882a593Smuzhiyun  */
910*4882a593Smuzhiyun struct dwc3_event_depevt {
911*4882a593Smuzhiyun 	u32	one_bit:1;
912*4882a593Smuzhiyun 	u32	endpoint_number:5;
913*4882a593Smuzhiyun 	u32	endpoint_event:4;
914*4882a593Smuzhiyun 	u32	reserved11_10:2;
915*4882a593Smuzhiyun 	u32	status:4;
916*4882a593Smuzhiyun 
917*4882a593Smuzhiyun /* Within XferNotReady */
918*4882a593Smuzhiyun #define DEPEVT_STATUS_TRANSFER_ACTIVE	(1 << 3)
919*4882a593Smuzhiyun 
920*4882a593Smuzhiyun /* Within XferComplete */
921*4882a593Smuzhiyun #define DEPEVT_STATUS_BUSERR	(1 << 0)
922*4882a593Smuzhiyun #define DEPEVT_STATUS_SHORT	(1 << 1)
923*4882a593Smuzhiyun #define DEPEVT_STATUS_IOC	(1 << 2)
924*4882a593Smuzhiyun #define DEPEVT_STATUS_LST	(1 << 3)
925*4882a593Smuzhiyun 
926*4882a593Smuzhiyun /* Stream event only */
927*4882a593Smuzhiyun #define DEPEVT_STREAMEVT_FOUND		1
928*4882a593Smuzhiyun #define DEPEVT_STREAMEVT_NOTFOUND	2
929*4882a593Smuzhiyun 
930*4882a593Smuzhiyun /* Control-only Status */
931*4882a593Smuzhiyun #define DEPEVT_STATUS_CONTROL_DATA	1
932*4882a593Smuzhiyun #define DEPEVT_STATUS_CONTROL_STATUS	2
933*4882a593Smuzhiyun 
934*4882a593Smuzhiyun 	u32	parameters:16;
935*4882a593Smuzhiyun } __packed;
936*4882a593Smuzhiyun 
937*4882a593Smuzhiyun /**
938*4882a593Smuzhiyun  * struct dwc3_event_devt - Device Events
939*4882a593Smuzhiyun  * @one_bit: indicates this is a non-endpoint event (not used)
940*4882a593Smuzhiyun  * @device_event: indicates it's a device event. Should read as 0x00
941*4882a593Smuzhiyun  * @type: indicates the type of device event.
942*4882a593Smuzhiyun  *	0	- DisconnEvt
943*4882a593Smuzhiyun  *	1	- USBRst
944*4882a593Smuzhiyun  *	2	- ConnectDone
945*4882a593Smuzhiyun  *	3	- ULStChng
946*4882a593Smuzhiyun  *	4	- WkUpEvt
947*4882a593Smuzhiyun  *	5	- Reserved
948*4882a593Smuzhiyun  *	6	- EOPF
949*4882a593Smuzhiyun  *	7	- SOF
950*4882a593Smuzhiyun  *	8	- Reserved
951*4882a593Smuzhiyun  *	9	- ErrticErr
952*4882a593Smuzhiyun  *	10	- CmdCmplt
953*4882a593Smuzhiyun  *	11	- EvntOverflow
954*4882a593Smuzhiyun  *	12	- VndrDevTstRcved
955*4882a593Smuzhiyun  * @reserved15_12: Reserved, not used
956*4882a593Smuzhiyun  * @event_info: Information about this event
957*4882a593Smuzhiyun  * @reserved31_25: Reserved, not used
958*4882a593Smuzhiyun  */
959*4882a593Smuzhiyun struct dwc3_event_devt {
960*4882a593Smuzhiyun 	u32	one_bit:1;
961*4882a593Smuzhiyun 	u32	device_event:7;
962*4882a593Smuzhiyun 	u32	type:4;
963*4882a593Smuzhiyun 	u32	reserved15_12:4;
964*4882a593Smuzhiyun 	u32	event_info:9;
965*4882a593Smuzhiyun 	u32	reserved31_25:7;
966*4882a593Smuzhiyun } __packed;
967*4882a593Smuzhiyun 
968*4882a593Smuzhiyun /**
969*4882a593Smuzhiyun  * struct dwc3_event_gevt - Other Core Events
970*4882a593Smuzhiyun  * @one_bit: indicates this is a non-endpoint event (not used)
971*4882a593Smuzhiyun  * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
972*4882a593Smuzhiyun  * @phy_port_number: self-explanatory
973*4882a593Smuzhiyun  * @reserved31_12: Reserved, not used.
974*4882a593Smuzhiyun  */
975*4882a593Smuzhiyun struct dwc3_event_gevt {
976*4882a593Smuzhiyun 	u32	one_bit:1;
977*4882a593Smuzhiyun 	u32	device_event:7;
978*4882a593Smuzhiyun 	u32	phy_port_number:4;
979*4882a593Smuzhiyun 	u32	reserved31_12:20;
980*4882a593Smuzhiyun } __packed;
981*4882a593Smuzhiyun 
982*4882a593Smuzhiyun /**
983*4882a593Smuzhiyun  * union dwc3_event - representation of Event Buffer contents
984*4882a593Smuzhiyun  * @raw: raw 32-bit event
985*4882a593Smuzhiyun  * @type: the type of the event
986*4882a593Smuzhiyun  * @depevt: Device Endpoint Event
987*4882a593Smuzhiyun  * @devt: Device Event
988*4882a593Smuzhiyun  * @gevt: Global Event
989*4882a593Smuzhiyun  */
990*4882a593Smuzhiyun union dwc3_event {
991*4882a593Smuzhiyun 	u32				raw;
992*4882a593Smuzhiyun 	struct dwc3_event_type		type;
993*4882a593Smuzhiyun 	struct dwc3_event_depevt	depevt;
994*4882a593Smuzhiyun 	struct dwc3_event_devt		devt;
995*4882a593Smuzhiyun 	struct dwc3_event_gevt		gevt;
996*4882a593Smuzhiyun };
997*4882a593Smuzhiyun 
998*4882a593Smuzhiyun /**
999*4882a593Smuzhiyun  * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1000*4882a593Smuzhiyun  * parameters
1001*4882a593Smuzhiyun  * @param2: third parameter
1002*4882a593Smuzhiyun  * @param1: second parameter
1003*4882a593Smuzhiyun  * @param0: first parameter
1004*4882a593Smuzhiyun  */
1005*4882a593Smuzhiyun struct dwc3_gadget_ep_cmd_params {
1006*4882a593Smuzhiyun 	u32	param2;
1007*4882a593Smuzhiyun 	u32	param1;
1008*4882a593Smuzhiyun 	u32	param0;
1009*4882a593Smuzhiyun };
1010*4882a593Smuzhiyun 
1011*4882a593Smuzhiyun /*
1012*4882a593Smuzhiyun  * DWC3 Features to be used as Driver Data
1013*4882a593Smuzhiyun  */
1014*4882a593Smuzhiyun 
1015*4882a593Smuzhiyun #define DWC3_HAS_PERIPHERAL		BIT(0)
1016*4882a593Smuzhiyun #define DWC3_HAS_XHCI			BIT(1)
1017*4882a593Smuzhiyun #define DWC3_HAS_OTG			BIT(3)
1018*4882a593Smuzhiyun 
1019*4882a593Smuzhiyun /* prototypes */
1020*4882a593Smuzhiyun int dwc3_gadget_resize_tx_fifos(struct dwc3 *dwc);
1021*4882a593Smuzhiyun void dwc3_of_parse(struct dwc3 *dwc);
1022*4882a593Smuzhiyun int dwc3_init(struct dwc3 *dwc);
1023*4882a593Smuzhiyun void dwc3_remove(struct dwc3 *dwc);
1024*4882a593Smuzhiyun 
dwc3_host_init(struct dwc3 * dwc)1025*4882a593Smuzhiyun static inline int dwc3_host_init(struct dwc3 *dwc)
1026*4882a593Smuzhiyun { return 0; }
dwc3_host_exit(struct dwc3 * dwc)1027*4882a593Smuzhiyun static inline void dwc3_host_exit(struct dwc3 *dwc)
1028*4882a593Smuzhiyun { }
1029*4882a593Smuzhiyun 
1030*4882a593Smuzhiyun #ifdef CONFIG_USB_DWC3_GADGET
1031*4882a593Smuzhiyun int dwc3_gadget_init(struct dwc3 *dwc);
1032*4882a593Smuzhiyun void dwc3_gadget_exit(struct dwc3 *dwc);
1033*4882a593Smuzhiyun int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
1034*4882a593Smuzhiyun int dwc3_gadget_get_link_state(struct dwc3 *dwc);
1035*4882a593Smuzhiyun int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
1036*4882a593Smuzhiyun int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
1037*4882a593Smuzhiyun 		unsigned cmd, struct dwc3_gadget_ep_cmd_params *params);
1038*4882a593Smuzhiyun int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned cmd, u32 param);
1039*4882a593Smuzhiyun #else
dwc3_gadget_init(struct dwc3 * dwc)1040*4882a593Smuzhiyun static inline int dwc3_gadget_init(struct dwc3 *dwc)
1041*4882a593Smuzhiyun { return 0; }
dwc3_gadget_exit(struct dwc3 * dwc)1042*4882a593Smuzhiyun static inline void dwc3_gadget_exit(struct dwc3 *dwc)
1043*4882a593Smuzhiyun { }
dwc3_gadget_set_test_mode(struct dwc3 * dwc,int mode)1044*4882a593Smuzhiyun static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
1045*4882a593Smuzhiyun { return 0; }
dwc3_gadget_get_link_state(struct dwc3 * dwc)1046*4882a593Smuzhiyun static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
1047*4882a593Smuzhiyun { return 0; }
dwc3_gadget_set_link_state(struct dwc3 * dwc,enum dwc3_link_state state)1048*4882a593Smuzhiyun static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
1049*4882a593Smuzhiyun 		enum dwc3_link_state state)
1050*4882a593Smuzhiyun { return 0; }
1051*4882a593Smuzhiyun 
dwc3_send_gadget_ep_cmd(struct dwc3 * dwc,unsigned ep,unsigned cmd,struct dwc3_gadget_ep_cmd_params * params)1052*4882a593Smuzhiyun static inline int dwc3_send_gadget_ep_cmd(struct dwc3 *dwc, unsigned ep,
1053*4882a593Smuzhiyun 		unsigned cmd, struct dwc3_gadget_ep_cmd_params *params)
1054*4882a593Smuzhiyun { return 0; }
dwc3_send_gadget_generic_command(struct dwc3 * dwc,int cmd,u32 param)1055*4882a593Smuzhiyun static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
1056*4882a593Smuzhiyun 		int cmd, u32 param)
1057*4882a593Smuzhiyun { return 0; }
1058*4882a593Smuzhiyun #endif
1059*4882a593Smuzhiyun 
1060*4882a593Smuzhiyun #endif /* __DRIVERS_USB_DWC3_CORE_H */
1061