xref: /kernel/linux/linux-5.10/drivers/usb/dwc3/core.h (revision 8c2ecf20)
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * core.h - DesignWare USB3 DRD Core Header
4 *
5 * Copyright (C) 2010-2011 Texas Instruments Incorporated - https://www.ti.com
6 *
7 * Authors: Felipe Balbi <balbi@ti.com>,
8 *	    Sebastian Andrzej Siewior <bigeasy@linutronix.de>
9 */
10
11#ifndef __DRIVERS_USB_DWC3_CORE_H
12#define __DRIVERS_USB_DWC3_CORE_H
13
14#include <linux/device.h>
15#include <linux/spinlock.h>
16#include <linux/mutex.h>
17#include <linux/ioport.h>
18#include <linux/list.h>
19#include <linux/bitops.h>
20#include <linux/dma-mapping.h>
21#include <linux/mm.h>
22#include <linux/debugfs.h>
23#include <linux/wait.h>
24#include <linux/workqueue.h>
25
26#include <linux/usb/ch9.h>
27#include <linux/usb/gadget.h>
28#include <linux/usb/otg.h>
29#include <linux/usb/role.h>
30#include <linux/ulpi/interface.h>
31
32#include <linux/phy/phy.h>
33
34#define DWC3_MSG_MAX	500
35
36/* Global constants */
37#define DWC3_PULL_UP_TIMEOUT	500	/* ms */
38#define DWC3_BOUNCE_SIZE	1024	/* size of a superspeed bulk */
39#define DWC3_EP0_SETUP_SIZE	512
40#define DWC3_ENDPOINTS_NUM	32
41#define DWC3_XHCI_RESOURCES_NUM	2
42#define DWC3_ISOC_MAX_RETRIES	5
43
44#define DWC3_SCRATCHBUF_SIZE	4096	/* each buffer is assumed to be 4KiB */
45#define DWC3_EVENT_BUFFERS_SIZE	4096
46#define DWC3_EVENT_TYPE_MASK	0xfe
47
48#define DWC3_EVENT_TYPE_DEV	0
49#define DWC3_EVENT_TYPE_CARKIT	3
50#define DWC3_EVENT_TYPE_I2C	4
51
52#define DWC3_DEVICE_EVENT_DISCONNECT		0
53#define DWC3_DEVICE_EVENT_RESET			1
54#define DWC3_DEVICE_EVENT_CONNECT_DONE		2
55#define DWC3_DEVICE_EVENT_LINK_STATUS_CHANGE	3
56#define DWC3_DEVICE_EVENT_WAKEUP		4
57#define DWC3_DEVICE_EVENT_HIBER_REQ		5
58#define DWC3_DEVICE_EVENT_EOPF			6
59#define DWC3_DEVICE_EVENT_SOF			7
60#define DWC3_DEVICE_EVENT_ERRATIC_ERROR		9
61#define DWC3_DEVICE_EVENT_CMD_CMPL		10
62#define DWC3_DEVICE_EVENT_OVERFLOW		11
63
64/* Controller's role while using the OTG block */
65#define DWC3_OTG_ROLE_IDLE	0
66#define DWC3_OTG_ROLE_HOST	1
67#define DWC3_OTG_ROLE_DEVICE	2
68
69#define DWC3_GEVNTCOUNT_MASK	0xfffc
70#define DWC3_GEVNTCOUNT_EHB	BIT(31)
71#define DWC3_GSNPSID_MASK	0xffff0000
72#define DWC3_GSNPSREV_MASK	0xffff
73#define DWC3_GSNPS_ID(p)	(((p) & DWC3_GSNPSID_MASK) >> 16)
74
75/* DWC3 registers memory space boundries */
76#define DWC3_XHCI_REGS_START		0x0
77#define DWC3_XHCI_REGS_END		0x7fff
78#define DWC3_GLOBALS_REGS_START		0xc100
79#define DWC3_GLOBALS_REGS_END		0xc6ff
80#define DWC3_DEVICE_REGS_START		0xc700
81#define DWC3_DEVICE_REGS_END		0xcbff
82#define DWC3_OTG_REGS_START		0xcc00
83#define DWC3_OTG_REGS_END		0xccff
84
85/* Global Registers */
86#define DWC3_GSBUSCFG0		0xc100
87#define DWC3_GSBUSCFG1		0xc104
88#define DWC3_GTXTHRCFG		0xc108
89#define DWC3_GRXTHRCFG		0xc10c
90#define DWC3_GCTL		0xc110
91#define DWC3_GEVTEN		0xc114
92#define DWC3_GSTS		0xc118
93#define DWC3_GUCTL1		0xc11c
94#define DWC3_GSNPSID		0xc120
95#define DWC3_GGPIO		0xc124
96#define DWC3_GUID		0xc128
97#define DWC3_GUCTL		0xc12c
98#define DWC3_GBUSERRADDR0	0xc130
99#define DWC3_GBUSERRADDR1	0xc134
100#define DWC3_GPRTBIMAP0		0xc138
101#define DWC3_GPRTBIMAP1		0xc13c
102#define DWC3_GHWPARAMS0		0xc140
103#define DWC3_GHWPARAMS1		0xc144
104#define DWC3_GHWPARAMS2		0xc148
105#define DWC3_GHWPARAMS3		0xc14c
106#define DWC3_GHWPARAMS4		0xc150
107#define DWC3_GHWPARAMS5		0xc154
108#define DWC3_GHWPARAMS6		0xc158
109#define DWC3_GHWPARAMS7		0xc15c
110#define DWC3_GDBGFIFOSPACE	0xc160
111#define DWC3_GDBGLTSSM		0xc164
112#define DWC3_GDBGBMU		0xc16c
113#define DWC3_GDBGLSPMUX		0xc170
114#define DWC3_GDBGLSP		0xc174
115#define DWC3_GDBGEPINFO0	0xc178
116#define DWC3_GDBGEPINFO1	0xc17c
117#define DWC3_GPRTBIMAP_HS0	0xc180
118#define DWC3_GPRTBIMAP_HS1	0xc184
119#define DWC3_GPRTBIMAP_FS0	0xc188
120#define DWC3_GPRTBIMAP_FS1	0xc18c
121#define DWC3_GUCTL2		0xc19c
122
123#define DWC3_VER_NUMBER		0xc1a0
124#define DWC3_VER_TYPE		0xc1a4
125
126#define DWC3_GUSB2PHYCFG(n)	(0xc200 + ((n) * 0x04))
127#define DWC3_GUSB2I2CCTL(n)	(0xc240 + ((n) * 0x04))
128
129#define DWC3_GUSB2PHYACC(n)	(0xc280 + ((n) * 0x04))
130
131#define DWC3_GUSB3PIPECTL(n)	(0xc2c0 + ((n) * 0x04))
132
133#define DWC3_GTXFIFOSIZ(n)	(0xc300 + ((n) * 0x04))
134#define DWC3_GRXFIFOSIZ(n)	(0xc380 + ((n) * 0x04))
135
136#define DWC3_GEVNTADRLO(n)	(0xc400 + ((n) * 0x10))
137#define DWC3_GEVNTADRHI(n)	(0xc404 + ((n) * 0x10))
138#define DWC3_GEVNTSIZ(n)	(0xc408 + ((n) * 0x10))
139#define DWC3_GEVNTCOUNT(n)	(0xc40c + ((n) * 0x10))
140
141#define DWC3_GHWPARAMS8		0xc600
142#define DWC3_GUCTL3		0xc60c
143#define DWC3_GFLADJ		0xc630
144
145/* Device Registers */
146#define DWC3_DCFG		0xc700
147#define DWC3_DCTL		0xc704
148#define DWC3_DEVTEN		0xc708
149#define DWC3_DSTS		0xc70c
150#define DWC3_DGCMDPAR		0xc710
151#define DWC3_DGCMD		0xc714
152#define DWC3_DALEPENA		0xc720
153
154#define DWC3_DEP_BASE(n)	(0xc800 + ((n) * 0x10))
155#define DWC3_DEPCMDPAR2		0x00
156#define DWC3_DEPCMDPAR1		0x04
157#define DWC3_DEPCMDPAR0		0x08
158#define DWC3_DEPCMD		0x0c
159
160#define DWC3_DEV_IMOD(n)	(0xca00 + ((n) * 0x4))
161
162/* OTG Registers */
163#define DWC3_OCFG		0xcc00
164#define DWC3_OCTL		0xcc04
165#define DWC3_OEVT		0xcc08
166#define DWC3_OEVTEN		0xcc0C
167#define DWC3_OSTS		0xcc10
168
169/* Bit fields */
170
171/* Global SoC Bus Configuration INCRx Register 0 */
172#define DWC3_GSBUSCFG0_INCR256BRSTENA	(1 << 7) /* INCR256 burst */
173#define DWC3_GSBUSCFG0_INCR128BRSTENA	(1 << 6) /* INCR128 burst */
174#define DWC3_GSBUSCFG0_INCR64BRSTENA	(1 << 5) /* INCR64 burst */
175#define DWC3_GSBUSCFG0_INCR32BRSTENA	(1 << 4) /* INCR32 burst */
176#define DWC3_GSBUSCFG0_INCR16BRSTENA	(1 << 3) /* INCR16 burst */
177#define DWC3_GSBUSCFG0_INCR8BRSTENA	(1 << 2) /* INCR8 burst */
178#define DWC3_GSBUSCFG0_INCR4BRSTENA	(1 << 1) /* INCR4 burst */
179#define DWC3_GSBUSCFG0_INCRBRSTENA	(1 << 0) /* undefined length enable */
180#define DWC3_GSBUSCFG0_INCRBRST_MASK	0xff
181
182/* Global Debug LSP MUX Select */
183#define DWC3_GDBGLSPMUX_ENDBC		BIT(15)	/* Host only */
184#define DWC3_GDBGLSPMUX_HOSTSELECT(n)	((n) & 0x3fff)
185#define DWC3_GDBGLSPMUX_DEVSELECT(n)	(((n) & 0xf) << 4)
186#define DWC3_GDBGLSPMUX_EPSELECT(n)	((n) & 0xf)
187
188/* Global Debug Queue/FIFO Space Available Register */
189#define DWC3_GDBGFIFOSPACE_NUM(n)	((n) & 0x1f)
190#define DWC3_GDBGFIFOSPACE_TYPE(n)	(((n) << 5) & 0x1e0)
191#define DWC3_GDBGFIFOSPACE_SPACE_AVAILABLE(n) (((n) >> 16) & 0xffff)
192
193#define DWC3_TXFIFO		0
194#define DWC3_RXFIFO		1
195#define DWC3_TXREQQ		2
196#define DWC3_RXREQQ		3
197#define DWC3_RXINFOQ		4
198#define DWC3_PSTATQ		5
199#define DWC3_DESCFETCHQ		6
200#define DWC3_EVENTQ		7
201#define DWC3_AUXEVENTQ		8
202
203/* Global RX Threshold Configuration Register */
204#define DWC3_GRXTHRCFG_MAXRXBURSTSIZE(n) (((n) & 0x1f) << 19)
205#define DWC3_GRXTHRCFG_RXPKTCNT(n) (((n) & 0xf) << 24)
206#define DWC3_GRXTHRCFG_PKTCNTSEL BIT(29)
207
208/* Global RX Threshold Configuration Register for DWC_usb31 only */
209#define DWC31_GRXTHRCFG_MAXRXBURSTSIZE(n)	(((n) & 0x1f) << 16)
210#define DWC31_GRXTHRCFG_RXPKTCNT(n)		(((n) & 0x1f) << 21)
211#define DWC31_GRXTHRCFG_PKTCNTSEL		BIT(26)
212#define DWC31_RXTHRNUMPKTSEL_HS_PRD		BIT(15)
213#define DWC31_RXTHRNUMPKT_HS_PRD(n)		(((n) & 0x3) << 13)
214#define DWC31_RXTHRNUMPKTSEL_PRD		BIT(10)
215#define DWC31_RXTHRNUMPKT_PRD(n)		(((n) & 0x1f) << 5)
216#define DWC31_MAXRXBURSTSIZE_PRD(n)		((n) & 0x1f)
217
218/* Global TX Threshold Configuration Register for DWC_usb31 only */
219#define DWC31_GTXTHRCFG_MAXTXBURSTSIZE(n)	(((n) & 0x1f) << 16)
220#define DWC31_GTXTHRCFG_TXPKTCNT(n)		(((n) & 0x1f) << 21)
221#define DWC31_GTXTHRCFG_PKTCNTSEL		BIT(26)
222#define DWC31_TXTHRNUMPKTSEL_HS_PRD		BIT(15)
223#define DWC31_TXTHRNUMPKT_HS_PRD(n)		(((n) & 0x3) << 13)
224#define DWC31_TXTHRNUMPKTSEL_PRD		BIT(10)
225#define DWC31_TXTHRNUMPKT_PRD(n)		(((n) & 0x1f) << 5)
226#define DWC31_MAXTXBURSTSIZE_PRD(n)		((n) & 0x1f)
227
228/* Global Configuration Register */
229#define DWC3_GCTL_PWRDNSCALE(n)	((n) << 19)
230#define DWC3_GCTL_U2RSTECN	BIT(16)
231#define DWC3_GCTL_RAMCLKSEL(x)	(((x) & DWC3_GCTL_CLK_MASK) << 6)
232#define DWC3_GCTL_CLK_BUS	(0)
233#define DWC3_GCTL_CLK_PIPE	(1)
234#define DWC3_GCTL_CLK_PIPEHALF	(2)
235#define DWC3_GCTL_CLK_MASK	(3)
236
237#define DWC3_GCTL_PRTCAP(n)	(((n) & (3 << 12)) >> 12)
238#define DWC3_GCTL_PRTCAPDIR(n)	((n) << 12)
239#define DWC3_GCTL_PRTCAP_HOST	1
240#define DWC3_GCTL_PRTCAP_DEVICE	2
241#define DWC3_GCTL_PRTCAP_OTG	3
242
243#define DWC3_GCTL_CORESOFTRESET		BIT(11)
244#define DWC3_GCTL_SOFITPSYNC		BIT(10)
245#define DWC3_GCTL_SCALEDOWN(n)		((n) << 4)
246#define DWC3_GCTL_SCALEDOWN_MASK	DWC3_GCTL_SCALEDOWN(3)
247#define DWC3_GCTL_DISSCRAMBLE		BIT(3)
248#define DWC3_GCTL_U2EXIT_LFPS		BIT(2)
249#define DWC3_GCTL_GBLHIBERNATIONEN	BIT(1)
250#define DWC3_GCTL_DSBLCLKGTNG		BIT(0)
251
252/* Global User Control 1 Register */
253#define DWC3_GUCTL1_PARKMODE_DISABLE_SS	BIT(17)
254#define DWC3_GUCTL1_TX_IPGAP_LINECHECK_DIS	BIT(28)
255#define DWC3_GUCTL1_DEV_L1_EXIT_BY_HW	BIT(24)
256
257/* Global Status Register */
258#define DWC3_GSTS_OTG_IP	BIT(10)
259#define DWC3_GSTS_BC_IP		BIT(9)
260#define DWC3_GSTS_ADP_IP	BIT(8)
261#define DWC3_GSTS_HOST_IP	BIT(7)
262#define DWC3_GSTS_DEVICE_IP	BIT(6)
263#define DWC3_GSTS_CSR_TIMEOUT	BIT(5)
264#define DWC3_GSTS_BUS_ERR_ADDR_VLD	BIT(4)
265#define DWC3_GSTS_CURMOD(n)	((n) & 0x3)
266#define DWC3_GSTS_CURMOD_DEVICE	0
267#define DWC3_GSTS_CURMOD_HOST	1
268
269/* Global USB2 PHY Configuration Register */
270#define DWC3_GUSB2PHYCFG_PHYSOFTRST	BIT(31)
271#define DWC3_GUSB2PHYCFG_U2_FREECLK_EXISTS	BIT(30)
272#define DWC3_GUSB2PHYCFG_SUSPHY		BIT(6)
273#define DWC3_GUSB2PHYCFG_ULPI_UTMI	BIT(4)
274#define DWC3_GUSB2PHYCFG_ENBLSLPM	BIT(8)
275#define DWC3_GUSB2PHYCFG_PHYIF(n)	(n << 3)
276#define DWC3_GUSB2PHYCFG_PHYIF_MASK	DWC3_GUSB2PHYCFG_PHYIF(1)
277#define DWC3_GUSB2PHYCFG_USBTRDTIM(n)	(n << 10)
278#define DWC3_GUSB2PHYCFG_USBTRDTIM_MASK	DWC3_GUSB2PHYCFG_USBTRDTIM(0xf)
279#define USBTRDTIM_UTMI_8_BIT		9
280#define USBTRDTIM_UTMI_16_BIT		5
281#define UTMI_PHYIF_16_BIT		1
282#define UTMI_PHYIF_8_BIT		0
283
284/* Global USB2 PHY Vendor Control Register */
285#define DWC3_GUSB2PHYACC_NEWREGREQ	BIT(25)
286#define DWC3_GUSB2PHYACC_DONE		BIT(24)
287#define DWC3_GUSB2PHYACC_BUSY		BIT(23)
288#define DWC3_GUSB2PHYACC_WRITE		BIT(22)
289#define DWC3_GUSB2PHYACC_ADDR(n)	(n << 16)
290#define DWC3_GUSB2PHYACC_EXTEND_ADDR(n)	(n << 8)
291#define DWC3_GUSB2PHYACC_DATA(n)	(n & 0xff)
292
293/* Global USB3 PIPE Control Register */
294#define DWC3_GUSB3PIPECTL_PHYSOFTRST	BIT(31)
295#define DWC3_GUSB3PIPECTL_U2SSINP3OK	BIT(29)
296#define DWC3_GUSB3PIPECTL_DISRXDETINP3	BIT(28)
297#define DWC3_GUSB3PIPECTL_UX_EXIT_PX	BIT(27)
298#define DWC3_GUSB3PIPECTL_REQP1P2P3	BIT(24)
299#define DWC3_GUSB3PIPECTL_DEP1P2P3(n)	((n) << 19)
300#define DWC3_GUSB3PIPECTL_DEP1P2P3_MASK	DWC3_GUSB3PIPECTL_DEP1P2P3(7)
301#define DWC3_GUSB3PIPECTL_DEP1P2P3_EN	DWC3_GUSB3PIPECTL_DEP1P2P3(1)
302#define DWC3_GUSB3PIPECTL_DEPOCHANGE	BIT(18)
303#define DWC3_GUSB3PIPECTL_SUSPHY	BIT(17)
304#define DWC3_GUSB3PIPECTL_LFPSFILT	BIT(9)
305#define DWC3_GUSB3PIPECTL_RX_DETOPOLL	BIT(8)
306#define DWC3_GUSB3PIPECTL_TX_DEEPH_MASK	DWC3_GUSB3PIPECTL_TX_DEEPH(3)
307#define DWC3_GUSB3PIPECTL_TX_DEEPH(n)	((n) << 1)
308
309/* Global TX Fifo Size Register */
310#define DWC31_GTXFIFOSIZ_TXFRAMNUM	BIT(15)		/* DWC_usb31 only */
311#define DWC31_GTXFIFOSIZ_TXFDEP(n)	((n) & 0x7fff)	/* DWC_usb31 only */
312#define DWC3_GTXFIFOSIZ_TXFDEP(n)	((n) & 0xffff)
313#define DWC3_GTXFIFOSIZ_TXFSTADDR(n)	((n) & 0xffff0000)
314
315/* Global RX Fifo Size Register */
316#define DWC31_GRXFIFOSIZ_RXFDEP(n)	((n) & 0x7fff)	/* DWC_usb31 only */
317#define DWC3_GRXFIFOSIZ_RXFDEP(n)	((n) & 0xffff)
318
319/* Global Event Size Registers */
320#define DWC3_GEVNTSIZ_INTMASK		BIT(31)
321#define DWC3_GEVNTSIZ_SIZE(n)		((n) & 0xffff)
322
323/* Global HWPARAMS0 Register */
324#define DWC3_GHWPARAMS0_MODE(n)		((n) & 0x3)
325#define DWC3_GHWPARAMS0_MODE_GADGET	0
326#define DWC3_GHWPARAMS0_MODE_HOST	1
327#define DWC3_GHWPARAMS0_MODE_DRD	2
328#define DWC3_GHWPARAMS0_MBUS_TYPE(n)	(((n) >> 3) & 0x7)
329#define DWC3_GHWPARAMS0_SBUS_TYPE(n)	(((n) >> 6) & 0x3)
330#define DWC3_GHWPARAMS0_MDWIDTH(n)	(((n) >> 8) & 0xff)
331#define DWC3_GHWPARAMS0_SDWIDTH(n)	(((n) >> 16) & 0xff)
332#define DWC3_GHWPARAMS0_AWIDTH(n)	(((n) >> 24) & 0xff)
333
334/* Global HWPARAMS1 Register */
335#define DWC3_GHWPARAMS1_EN_PWROPT(n)	(((n) & (3 << 24)) >> 24)
336#define DWC3_GHWPARAMS1_EN_PWROPT_NO	0
337#define DWC3_GHWPARAMS1_EN_PWROPT_CLK	1
338#define DWC3_GHWPARAMS1_EN_PWROPT_HIB	2
339#define DWC3_GHWPARAMS1_PWROPT(n)	((n) << 24)
340#define DWC3_GHWPARAMS1_PWROPT_MASK	DWC3_GHWPARAMS1_PWROPT(3)
341#define DWC3_GHWPARAMS1_ENDBC		BIT(31)
342
343/* Global HWPARAMS3 Register */
344#define DWC3_GHWPARAMS3_SSPHY_IFC(n)		((n) & 3)
345#define DWC3_GHWPARAMS3_SSPHY_IFC_DIS		0
346#define DWC3_GHWPARAMS3_SSPHY_IFC_GEN1		1
347#define DWC3_GHWPARAMS3_SSPHY_IFC_GEN2		2 /* DWC_usb31 only */
348#define DWC3_GHWPARAMS3_HSPHY_IFC(n)		(((n) & (3 << 2)) >> 2)
349#define DWC3_GHWPARAMS3_HSPHY_IFC_DIS		0
350#define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI		1
351#define DWC3_GHWPARAMS3_HSPHY_IFC_ULPI		2
352#define DWC3_GHWPARAMS3_HSPHY_IFC_UTMI_ULPI	3
353#define DWC3_GHWPARAMS3_FSPHY_IFC(n)		(((n) & (3 << 4)) >> 4)
354#define DWC3_GHWPARAMS3_FSPHY_IFC_DIS		0
355#define DWC3_GHWPARAMS3_FSPHY_IFC_ENA		1
356
357/* Global HWPARAMS4 Register */
358#define DWC3_GHWPARAMS4_HIBER_SCRATCHBUFS(n)	(((n) & (0x0f << 13)) >> 13)
359#define DWC3_MAX_HIBER_SCRATCHBUFS		15
360
361/* Global HWPARAMS6 Register */
362#define DWC3_GHWPARAMS6_BCSUPPORT		BIT(14)
363#define DWC3_GHWPARAMS6_OTG3SUPPORT		BIT(13)
364#define DWC3_GHWPARAMS6_ADPSUPPORT		BIT(12)
365#define DWC3_GHWPARAMS6_HNPSUPPORT		BIT(11)
366#define DWC3_GHWPARAMS6_SRPSUPPORT		BIT(10)
367#define DWC3_GHWPARAMS6_EN_FPGA			BIT(7)
368
369/* DWC_usb32 only */
370#define DWC3_GHWPARAMS6_MDWIDTH(n)		((n) & (0x3 << 8))
371
372/* Global HWPARAMS7 Register */
373#define DWC3_GHWPARAMS7_RAM1_DEPTH(n)	((n) & 0xffff)
374#define DWC3_GHWPARAMS7_RAM2_DEPTH(n)	(((n) >> 16) & 0xffff)
375
376/* Global Frame Length Adjustment Register */
377#define DWC3_GFLADJ_30MHZ_SDBND_SEL		BIT(7)
378#define DWC3_GFLADJ_30MHZ_MASK			0x3f
379
380/* Global User Control Register 2 */
381#define DWC3_GUCTL2_RST_ACTBITLATER		BIT(14)
382
383/* Global User Control Register 3 */
384#define DWC3_GUCTL3_SPLITDISABLE		BIT(14)
385
386/* Device Configuration Register */
387#define DWC3_DCFG_DEVADDR(addr)	((addr) << 3)
388#define DWC3_DCFG_DEVADDR_MASK	DWC3_DCFG_DEVADDR(0x7f)
389
390#define DWC3_DCFG_SPEED_MASK	(7 << 0)
391#define DWC3_DCFG_SUPERSPEED_PLUS (5 << 0)  /* DWC_usb31 only */
392#define DWC3_DCFG_SUPERSPEED	(4 << 0)
393#define DWC3_DCFG_HIGHSPEED	(0 << 0)
394#define DWC3_DCFG_FULLSPEED	BIT(0)
395#define DWC3_DCFG_LOWSPEED	(2 << 0)
396
397#define DWC3_DCFG_NUMP_SHIFT	17
398#define DWC3_DCFG_NUMP(n)	(((n) >> DWC3_DCFG_NUMP_SHIFT) & 0x1f)
399#define DWC3_DCFG_NUMP_MASK	(0x1f << DWC3_DCFG_NUMP_SHIFT)
400#define DWC3_DCFG_LPM_CAP	BIT(22)
401
402/* Device Control Register */
403#define DWC3_DCTL_RUN_STOP	BIT(31)
404#define DWC3_DCTL_CSFTRST	BIT(30)
405#define DWC3_DCTL_LSFTRST	BIT(29)
406
407#define DWC3_DCTL_HIRD_THRES_MASK	(0x1f << 24)
408#define DWC3_DCTL_HIRD_THRES(n)	((n) << 24)
409
410#define DWC3_DCTL_APPL1RES	BIT(23)
411
412/* These apply for core versions 1.87a and earlier */
413#define DWC3_DCTL_TRGTULST_MASK		(0x0f << 17)
414#define DWC3_DCTL_TRGTULST(n)		((n) << 17)
415#define DWC3_DCTL_TRGTULST_U2		(DWC3_DCTL_TRGTULST(2))
416#define DWC3_DCTL_TRGTULST_U3		(DWC3_DCTL_TRGTULST(3))
417#define DWC3_DCTL_TRGTULST_SS_DIS	(DWC3_DCTL_TRGTULST(4))
418#define DWC3_DCTL_TRGTULST_RX_DET	(DWC3_DCTL_TRGTULST(5))
419#define DWC3_DCTL_TRGTULST_SS_INACT	(DWC3_DCTL_TRGTULST(6))
420
421/* These apply for core versions 1.94a and later */
422#define DWC3_DCTL_NYET_THRES(n)		(((n) & 0xf) << 20)
423
424#define DWC3_DCTL_KEEP_CONNECT		BIT(19)
425#define DWC3_DCTL_L1_HIBER_EN		BIT(18)
426#define DWC3_DCTL_CRS			BIT(17)
427#define DWC3_DCTL_CSS			BIT(16)
428
429#define DWC3_DCTL_INITU2ENA		BIT(12)
430#define DWC3_DCTL_ACCEPTU2ENA		BIT(11)
431#define DWC3_DCTL_INITU1ENA		BIT(10)
432#define DWC3_DCTL_ACCEPTU1ENA		BIT(9)
433#define DWC3_DCTL_TSTCTRL_MASK		(0xf << 1)
434
435#define DWC3_DCTL_ULSTCHNGREQ_MASK	(0x0f << 5)
436#define DWC3_DCTL_ULSTCHNGREQ(n) (((n) << 5) & DWC3_DCTL_ULSTCHNGREQ_MASK)
437
438#define DWC3_DCTL_ULSTCHNG_NO_ACTION	(DWC3_DCTL_ULSTCHNGREQ(0))
439#define DWC3_DCTL_ULSTCHNG_SS_DISABLED	(DWC3_DCTL_ULSTCHNGREQ(4))
440#define DWC3_DCTL_ULSTCHNG_RX_DETECT	(DWC3_DCTL_ULSTCHNGREQ(5))
441#define DWC3_DCTL_ULSTCHNG_SS_INACTIVE	(DWC3_DCTL_ULSTCHNGREQ(6))
442#define DWC3_DCTL_ULSTCHNG_RECOVERY	(DWC3_DCTL_ULSTCHNGREQ(8))
443#define DWC3_DCTL_ULSTCHNG_COMPLIANCE	(DWC3_DCTL_ULSTCHNGREQ(10))
444#define DWC3_DCTL_ULSTCHNG_LOOPBACK	(DWC3_DCTL_ULSTCHNGREQ(11))
445
446/* Device Event Enable Register */
447#define DWC3_DEVTEN_VNDRDEVTSTRCVEDEN	BIT(12)
448#define DWC3_DEVTEN_EVNTOVERFLOWEN	BIT(11)
449#define DWC3_DEVTEN_CMDCMPLTEN		BIT(10)
450#define DWC3_DEVTEN_ERRTICERREN		BIT(9)
451#define DWC3_DEVTEN_SOFEN		BIT(7)
452#define DWC3_DEVTEN_EOPFEN		BIT(6)
453#define DWC3_DEVTEN_HIBERNATIONREQEVTEN	BIT(5)
454#define DWC3_DEVTEN_WKUPEVTEN		BIT(4)
455#define DWC3_DEVTEN_ULSTCNGEN		BIT(3)
456#define DWC3_DEVTEN_CONNECTDONEEN	BIT(2)
457#define DWC3_DEVTEN_USBRSTEN		BIT(1)
458#define DWC3_DEVTEN_DISCONNEVTEN	BIT(0)
459
460/* Device Status Register */
461#define DWC3_DSTS_DCNRD			BIT(29)
462
463/* This applies for core versions 1.87a and earlier */
464#define DWC3_DSTS_PWRUPREQ		BIT(24)
465
466/* These apply for core versions 1.94a and later */
467#define DWC3_DSTS_RSS			BIT(25)
468#define DWC3_DSTS_SSS			BIT(24)
469
470#define DWC3_DSTS_COREIDLE		BIT(23)
471#define DWC3_DSTS_DEVCTRLHLT		BIT(22)
472
473#define DWC3_DSTS_USBLNKST_MASK		(0x0f << 18)
474#define DWC3_DSTS_USBLNKST(n)		(((n) & DWC3_DSTS_USBLNKST_MASK) >> 18)
475
476#define DWC3_DSTS_RXFIFOEMPTY		BIT(17)
477
478#define DWC3_DSTS_SOFFN_MASK		(0x3fff << 3)
479#define DWC3_DSTS_SOFFN(n)		(((n) & DWC3_DSTS_SOFFN_MASK) >> 3)
480
481#define DWC3_DSTS_CONNECTSPD		(7 << 0)
482
483#define DWC3_DSTS_SUPERSPEED_PLUS	(5 << 0) /* DWC_usb31 only */
484#define DWC3_DSTS_SUPERSPEED		(4 << 0)
485#define DWC3_DSTS_HIGHSPEED		(0 << 0)
486#define DWC3_DSTS_FULLSPEED		BIT(0)
487#define DWC3_DSTS_LOWSPEED		(2 << 0)
488
489/* Device Generic Command Register */
490#define DWC3_DGCMD_SET_LMP		0x01
491#define DWC3_DGCMD_SET_PERIODIC_PAR	0x02
492#define DWC3_DGCMD_XMIT_FUNCTION	0x03
493
494/* These apply for core versions 1.94a and later */
495#define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_LO	0x04
496#define DWC3_DGCMD_SET_SCRATCHPAD_ADDR_HI	0x05
497
498#define DWC3_DGCMD_SELECTED_FIFO_FLUSH	0x09
499#define DWC3_DGCMD_ALL_FIFO_FLUSH	0x0a
500#define DWC3_DGCMD_SET_ENDPOINT_NRDY	0x0c
501#define DWC3_DGCMD_SET_ENDPOINT_PRIME	0x0d
502#define DWC3_DGCMD_RUN_SOC_BUS_LOOPBACK	0x10
503
504#define DWC3_DGCMD_STATUS(n)		(((n) >> 12) & 0x0F)
505#define DWC3_DGCMD_CMDACT		BIT(10)
506#define DWC3_DGCMD_CMDIOC		BIT(8)
507
508/* Device Generic Command Parameter Register */
509#define DWC3_DGCMDPAR_FORCE_LINKPM_ACCEPT	BIT(0)
510#define DWC3_DGCMDPAR_FIFO_NUM(n)		((n) << 0)
511#define DWC3_DGCMDPAR_RX_FIFO			(0 << 5)
512#define DWC3_DGCMDPAR_TX_FIFO			BIT(5)
513#define DWC3_DGCMDPAR_LOOPBACK_DIS		(0 << 0)
514#define DWC3_DGCMDPAR_LOOPBACK_ENA		BIT(0)
515
516/* Device Endpoint Command Register */
517#define DWC3_DEPCMD_PARAM_SHIFT		16
518#define DWC3_DEPCMD_PARAM(x)		((x) << DWC3_DEPCMD_PARAM_SHIFT)
519#define DWC3_DEPCMD_GET_RSC_IDX(x)	(((x) >> DWC3_DEPCMD_PARAM_SHIFT) & 0x7f)
520#define DWC3_DEPCMD_STATUS(x)		(((x) >> 12) & 0x0F)
521#define DWC3_DEPCMD_HIPRI_FORCERM	BIT(11)
522#define DWC3_DEPCMD_CLEARPENDIN		BIT(11)
523#define DWC3_DEPCMD_CMDACT		BIT(10)
524#define DWC3_DEPCMD_CMDIOC		BIT(8)
525
526#define DWC3_DEPCMD_DEPSTARTCFG		(0x09 << 0)
527#define DWC3_DEPCMD_ENDTRANSFER		(0x08 << 0)
528#define DWC3_DEPCMD_UPDATETRANSFER	(0x07 << 0)
529#define DWC3_DEPCMD_STARTTRANSFER	(0x06 << 0)
530#define DWC3_DEPCMD_CLEARSTALL		(0x05 << 0)
531#define DWC3_DEPCMD_SETSTALL		(0x04 << 0)
532/* This applies for core versions 1.90a and earlier */
533#define DWC3_DEPCMD_GETSEQNUMBER	(0x03 << 0)
534/* This applies for core versions 1.94a and later */
535#define DWC3_DEPCMD_GETEPSTATE		(0x03 << 0)
536#define DWC3_DEPCMD_SETTRANSFRESOURCE	(0x02 << 0)
537#define DWC3_DEPCMD_SETEPCONFIG		(0x01 << 0)
538
539#define DWC3_DEPCMD_CMD(x)		((x) & 0xf)
540
541/* The EP number goes 0..31 so ep0 is always out and ep1 is always in */
542#define DWC3_DALEPENA_EP(n)		BIT(n)
543
544#define DWC3_DEPCMD_TYPE_CONTROL	0
545#define DWC3_DEPCMD_TYPE_ISOC		1
546#define DWC3_DEPCMD_TYPE_BULK		2
547#define DWC3_DEPCMD_TYPE_INTR		3
548
549#define DWC3_DEV_IMOD_COUNT_SHIFT	16
550#define DWC3_DEV_IMOD_COUNT_MASK	(0xffff << 16)
551#define DWC3_DEV_IMOD_INTERVAL_SHIFT	0
552#define DWC3_DEV_IMOD_INTERVAL_MASK	(0xffff << 0)
553
554/* OTG Configuration Register */
555#define DWC3_OCFG_DISPWRCUTTOFF		BIT(5)
556#define DWC3_OCFG_HIBDISMASK		BIT(4)
557#define DWC3_OCFG_SFTRSTMASK		BIT(3)
558#define DWC3_OCFG_OTGVERSION		BIT(2)
559#define DWC3_OCFG_HNPCAP		BIT(1)
560#define DWC3_OCFG_SRPCAP		BIT(0)
561
562/* OTG CTL Register */
563#define DWC3_OCTL_OTG3GOERR		BIT(7)
564#define DWC3_OCTL_PERIMODE		BIT(6)
565#define DWC3_OCTL_PRTPWRCTL		BIT(5)
566#define DWC3_OCTL_HNPREQ		BIT(4)
567#define DWC3_OCTL_SESREQ		BIT(3)
568#define DWC3_OCTL_TERMSELIDPULSE	BIT(2)
569#define DWC3_OCTL_DEVSETHNPEN		BIT(1)
570#define DWC3_OCTL_HSTSETHNPEN		BIT(0)
571
572/* OTG Event Register */
573#define DWC3_OEVT_DEVICEMODE		BIT(31)
574#define DWC3_OEVT_XHCIRUNSTPSET		BIT(27)
575#define DWC3_OEVT_DEVRUNSTPSET		BIT(26)
576#define DWC3_OEVT_HIBENTRY		BIT(25)
577#define DWC3_OEVT_CONIDSTSCHNG		BIT(24)
578#define DWC3_OEVT_HRRCONFNOTIF		BIT(23)
579#define DWC3_OEVT_HRRINITNOTIF		BIT(22)
580#define DWC3_OEVT_ADEVIDLE		BIT(21)
581#define DWC3_OEVT_ADEVBHOSTEND		BIT(20)
582#define DWC3_OEVT_ADEVHOST		BIT(19)
583#define DWC3_OEVT_ADEVHNPCHNG		BIT(18)
584#define DWC3_OEVT_ADEVSRPDET		BIT(17)
585#define DWC3_OEVT_ADEVSESSENDDET	BIT(16)
586#define DWC3_OEVT_BDEVBHOSTEND		BIT(11)
587#define DWC3_OEVT_BDEVHNPCHNG		BIT(10)
588#define DWC3_OEVT_BDEVSESSVLDDET	BIT(9)
589#define DWC3_OEVT_BDEVVBUSCHNG		BIT(8)
590#define DWC3_OEVT_BSESSVLD		BIT(3)
591#define DWC3_OEVT_HSTNEGSTS		BIT(2)
592#define DWC3_OEVT_SESREQSTS		BIT(1)
593#define DWC3_OEVT_ERROR			BIT(0)
594
595/* OTG Event Enable Register */
596#define DWC3_OEVTEN_XHCIRUNSTPSETEN	BIT(27)
597#define DWC3_OEVTEN_DEVRUNSTPSETEN	BIT(26)
598#define DWC3_OEVTEN_HIBENTRYEN		BIT(25)
599#define DWC3_OEVTEN_CONIDSTSCHNGEN	BIT(24)
600#define DWC3_OEVTEN_HRRCONFNOTIFEN	BIT(23)
601#define DWC3_OEVTEN_HRRINITNOTIFEN	BIT(22)
602#define DWC3_OEVTEN_ADEVIDLEEN		BIT(21)
603#define DWC3_OEVTEN_ADEVBHOSTENDEN	BIT(20)
604#define DWC3_OEVTEN_ADEVHOSTEN		BIT(19)
605#define DWC3_OEVTEN_ADEVHNPCHNGEN	BIT(18)
606#define DWC3_OEVTEN_ADEVSRPDETEN	BIT(17)
607#define DWC3_OEVTEN_ADEVSESSENDDETEN	BIT(16)
608#define DWC3_OEVTEN_BDEVBHOSTENDEN	BIT(11)
609#define DWC3_OEVTEN_BDEVHNPCHNGEN	BIT(10)
610#define DWC3_OEVTEN_BDEVSESSVLDDETEN	BIT(9)
611#define DWC3_OEVTEN_BDEVVBUSCHNGEN	BIT(8)
612
613/* OTG Status Register */
614#define DWC3_OSTS_DEVRUNSTP		BIT(13)
615#define DWC3_OSTS_XHCIRUNSTP		BIT(12)
616#define DWC3_OSTS_PERIPHERALSTATE	BIT(4)
617#define DWC3_OSTS_XHCIPRTPOWER		BIT(3)
618#define DWC3_OSTS_BSESVLD		BIT(2)
619#define DWC3_OSTS_VBUSVLD		BIT(1)
620#define DWC3_OSTS_CONIDSTS		BIT(0)
621
622/* Structures */
623
624struct dwc3_trb;
625
626/**
627 * struct dwc3_event_buffer - Software event buffer representation
628 * @buf: _THE_ buffer
629 * @cache: The buffer cache used in the threaded interrupt
630 * @length: size of this buffer
631 * @lpos: event offset
632 * @count: cache of last read event count register
633 * @flags: flags related to this event buffer
634 * @dma: dma_addr_t
635 * @dwc: pointer to DWC controller
636 */
637struct dwc3_event_buffer {
638	void			*buf;
639	void			*cache;
640	unsigned int		length;
641	unsigned int		lpos;
642	unsigned int		count;
643	unsigned int		flags;
644
645#define DWC3_EVENT_PENDING	BIT(0)
646
647	dma_addr_t		dma;
648
649	struct dwc3		*dwc;
650};
651
652#define DWC3_EP_FLAG_STALLED	BIT(0)
653#define DWC3_EP_FLAG_WEDGED	BIT(1)
654
655#define DWC3_EP_DIRECTION_TX	true
656#define DWC3_EP_DIRECTION_RX	false
657
658#define DWC3_TRB_NUM		256
659
660/**
661 * struct dwc3_ep - device side endpoint representation
662 * @endpoint: usb endpoint
663 * @cancelled_list: list of cancelled requests for this endpoint
664 * @pending_list: list of pending requests for this endpoint
665 * @started_list: list of started requests on this endpoint
666 * @regs: pointer to first endpoint register
667 * @trb_pool: array of transaction buffers
668 * @trb_pool_dma: dma address of @trb_pool
669 * @trb_enqueue: enqueue 'pointer' into TRB array
670 * @trb_dequeue: dequeue 'pointer' into TRB array
671 * @dwc: pointer to DWC controller
672 * @saved_state: ep state saved during hibernation
673 * @flags: endpoint flags (wedged, stalled, ...)
674 * @number: endpoint number (1 - 15)
675 * @type: set to bmAttributes & USB_ENDPOINT_XFERTYPE_MASK
676 * @resource_index: Resource transfer index
677 * @frame_number: set to the frame number we want this transfer to start (ISOC)
678 * @interval: the interval on which the ISOC transfer is started
679 * @name: a human readable name e.g. ep1out-bulk
680 * @direction: true for TX, false for RX
681 * @stream_capable: true when streams are enabled
682 * @combo_num: the test combination BIT[15:14] of the frame number to test
683 *		isochronous START TRANSFER command failure workaround
684 * @start_cmd_status: the status of testing START TRANSFER command with
685 *		combo_num = 'b00
686 */
687struct dwc3_ep {
688	struct usb_ep		endpoint;
689	struct list_head	cancelled_list;
690	struct list_head	pending_list;
691	struct list_head	started_list;
692
693	void __iomem		*regs;
694
695	struct dwc3_trb		*trb_pool;
696	dma_addr_t		trb_pool_dma;
697	struct dwc3		*dwc;
698
699	u32			saved_state;
700	unsigned int		flags;
701#define DWC3_EP_ENABLED		BIT(0)
702#define DWC3_EP_STALL		BIT(1)
703#define DWC3_EP_WEDGE		BIT(2)
704#define DWC3_EP_TRANSFER_STARTED BIT(3)
705#define DWC3_EP_END_TRANSFER_PENDING BIT(4)
706#define DWC3_EP_PENDING_REQUEST	BIT(5)
707#define DWC3_EP_DELAY_START	BIT(6)
708#define DWC3_EP_WAIT_TRANSFER_COMPLETE	BIT(7)
709#define DWC3_EP_IGNORE_NEXT_NOSTREAM	BIT(8)
710#define DWC3_EP_FORCE_RESTART_STREAM	BIT(9)
711#define DWC3_EP_FIRST_STREAM_PRIMED	BIT(10)
712#define DWC3_EP_PENDING_CLEAR_STALL	BIT(11)
713
714	/* This last one is specific to EP0 */
715#define DWC3_EP0_DIR_IN		BIT(31)
716
717	/*
718	 * IMPORTANT: we *know* we have 256 TRBs in our @trb_pool, so we will
719	 * use a u8 type here. If anybody decides to increase number of TRBs to
720	 * anything larger than 256 - I can't see why people would want to do
721	 * this though - then this type needs to be changed.
722	 *
723	 * By using u8 types we ensure that our % operator when incrementing
724	 * enqueue and dequeue get optimized away by the compiler.
725	 */
726	u8			trb_enqueue;
727	u8			trb_dequeue;
728
729	u8			number;
730	u8			type;
731	u8			resource_index;
732	u32			frame_number;
733	u32			interval;
734
735	char			name[20];
736
737	unsigned		direction:1;
738	unsigned		stream_capable:1;
739
740	/* For isochronous START TRANSFER workaround only */
741	u8			combo_num;
742	int			start_cmd_status;
743};
744
745enum dwc3_phy {
746	DWC3_PHY_UNKNOWN = 0,
747	DWC3_PHY_USB3,
748	DWC3_PHY_USB2,
749};
750
751enum dwc3_ep0_next {
752	DWC3_EP0_UNKNOWN = 0,
753	DWC3_EP0_COMPLETE,
754	DWC3_EP0_NRDY_DATA,
755	DWC3_EP0_NRDY_STATUS,
756};
757
758enum dwc3_ep0_state {
759	EP0_UNCONNECTED		= 0,
760	EP0_SETUP_PHASE,
761	EP0_DATA_PHASE,
762	EP0_STATUS_PHASE,
763};
764
765enum dwc3_link_state {
766	/* In SuperSpeed */
767	DWC3_LINK_STATE_U0		= 0x00, /* in HS, means ON */
768	DWC3_LINK_STATE_U1		= 0x01,
769	DWC3_LINK_STATE_U2		= 0x02, /* in HS, means SLEEP */
770	DWC3_LINK_STATE_U3		= 0x03, /* in HS, means SUSPEND */
771	DWC3_LINK_STATE_SS_DIS		= 0x04,
772	DWC3_LINK_STATE_RX_DET		= 0x05, /* in HS, means Early Suspend */
773	DWC3_LINK_STATE_SS_INACT	= 0x06,
774	DWC3_LINK_STATE_POLL		= 0x07,
775	DWC3_LINK_STATE_RECOV		= 0x08,
776	DWC3_LINK_STATE_HRESET		= 0x09,
777	DWC3_LINK_STATE_CMPLY		= 0x0a,
778	DWC3_LINK_STATE_LPBK		= 0x0b,
779	DWC3_LINK_STATE_RESET		= 0x0e,
780	DWC3_LINK_STATE_RESUME		= 0x0f,
781	DWC3_LINK_STATE_MASK		= 0x0f,
782};
783
784/* TRB Length, PCM and Status */
785#define DWC3_TRB_SIZE_MASK	(0x00ffffff)
786#define DWC3_TRB_SIZE_LENGTH(n)	((n) & DWC3_TRB_SIZE_MASK)
787#define DWC3_TRB_SIZE_PCM1(n)	(((n) & 0x03) << 24)
788#define DWC3_TRB_SIZE_TRBSTS(n)	(((n) & (0x0f << 28)) >> 28)
789
790#define DWC3_TRBSTS_OK			0
791#define DWC3_TRBSTS_MISSED_ISOC		1
792#define DWC3_TRBSTS_SETUP_PENDING	2
793#define DWC3_TRB_STS_XFER_IN_PROG	4
794
795/* TRB Control */
796#define DWC3_TRB_CTRL_HWO		BIT(0)
797#define DWC3_TRB_CTRL_LST		BIT(1)
798#define DWC3_TRB_CTRL_CHN		BIT(2)
799#define DWC3_TRB_CTRL_CSP		BIT(3)
800#define DWC3_TRB_CTRL_TRBCTL(n)		(((n) & 0x3f) << 4)
801#define DWC3_TRB_CTRL_ISP_IMI		BIT(10)
802#define DWC3_TRB_CTRL_IOC		BIT(11)
803#define DWC3_TRB_CTRL_SID_SOFN(n)	(((n) & 0xffff) << 14)
804#define DWC3_TRB_CTRL_GET_SID_SOFN(n)	(((n) & (0xffff << 14)) >> 14)
805
806#define DWC3_TRBCTL_TYPE(n)		((n) & (0x3f << 4))
807#define DWC3_TRBCTL_NORMAL		DWC3_TRB_CTRL_TRBCTL(1)
808#define DWC3_TRBCTL_CONTROL_SETUP	DWC3_TRB_CTRL_TRBCTL(2)
809#define DWC3_TRBCTL_CONTROL_STATUS2	DWC3_TRB_CTRL_TRBCTL(3)
810#define DWC3_TRBCTL_CONTROL_STATUS3	DWC3_TRB_CTRL_TRBCTL(4)
811#define DWC3_TRBCTL_CONTROL_DATA	DWC3_TRB_CTRL_TRBCTL(5)
812#define DWC3_TRBCTL_ISOCHRONOUS_FIRST	DWC3_TRB_CTRL_TRBCTL(6)
813#define DWC3_TRBCTL_ISOCHRONOUS		DWC3_TRB_CTRL_TRBCTL(7)
814#define DWC3_TRBCTL_LINK_TRB		DWC3_TRB_CTRL_TRBCTL(8)
815
816/**
817 * struct dwc3_trb - transfer request block (hw format)
818 * @bpl: DW0-3
819 * @bph: DW4-7
820 * @size: DW8-B
821 * @ctrl: DWC-F
822 */
823struct dwc3_trb {
824	u32		bpl;
825	u32		bph;
826	u32		size;
827	u32		ctrl;
828} __packed;
829
830/**
831 * struct dwc3_hwparams - copy of HWPARAMS registers
832 * @hwparams0: GHWPARAMS0
833 * @hwparams1: GHWPARAMS1
834 * @hwparams2: GHWPARAMS2
835 * @hwparams3: GHWPARAMS3
836 * @hwparams4: GHWPARAMS4
837 * @hwparams5: GHWPARAMS5
838 * @hwparams6: GHWPARAMS6
839 * @hwparams7: GHWPARAMS7
840 * @hwparams8: GHWPARAMS8
841 */
842struct dwc3_hwparams {
843	u32	hwparams0;
844	u32	hwparams1;
845	u32	hwparams2;
846	u32	hwparams3;
847	u32	hwparams4;
848	u32	hwparams5;
849	u32	hwparams6;
850	u32	hwparams7;
851	u32	hwparams8;
852};
853
854/* HWPARAMS0 */
855#define DWC3_MODE(n)		((n) & 0x7)
856
857#define DWC3_MDWIDTH(n)		(((n) & 0xff00) >> 8)
858
859/* HWPARAMS1 */
860#define DWC3_NUM_INT(n)		(((n) & (0x3f << 15)) >> 15)
861
862/* HWPARAMS3 */
863#define DWC3_NUM_IN_EPS_MASK	(0x1f << 18)
864#define DWC3_NUM_EPS_MASK	(0x3f << 12)
865#define DWC3_NUM_EPS(p)		(((p)->hwparams3 &		\
866			(DWC3_NUM_EPS_MASK)) >> 12)
867#define DWC3_NUM_IN_EPS(p)	(((p)->hwparams3 &		\
868			(DWC3_NUM_IN_EPS_MASK)) >> 18)
869
870/* HWPARAMS7 */
871#define DWC3_RAM1_DEPTH(n)	((n) & 0xffff)
872
873/**
874 * struct dwc3_request - representation of a transfer request
875 * @request: struct usb_request to be transferred
876 * @list: a list_head used for request queueing
877 * @dep: struct dwc3_ep owning this request
878 * @sg: pointer to first incomplete sg
879 * @start_sg: pointer to the sg which should be queued next
880 * @num_pending_sgs: counter to pending sgs
881 * @num_queued_sgs: counter to the number of sgs which already got queued
882 * @remaining: amount of data remaining
883 * @status: internal dwc3 request status tracking
884 * @epnum: endpoint number to which this request refers
885 * @trb: pointer to struct dwc3_trb
886 * @trb_dma: DMA address of @trb
887 * @num_trbs: number of TRBs used by this request
888 * @needs_extra_trb: true when request needs one extra TRB (either due to ZLP
889 *	or unaligned OUT)
890 * @direction: IN or OUT direction flag
891 * @mapped: true when request has been dma-mapped
892 */
893struct dwc3_request {
894	struct usb_request	request;
895	struct list_head	list;
896	struct dwc3_ep		*dep;
897	struct scatterlist	*sg;
898	struct scatterlist	*start_sg;
899
900	unsigned int		num_pending_sgs;
901	unsigned int		num_queued_sgs;
902	unsigned int		remaining;
903
904	unsigned int		status;
905#define DWC3_REQUEST_STATUS_QUEUED	0
906#define DWC3_REQUEST_STATUS_STARTED	1
907#define DWC3_REQUEST_STATUS_CANCELLED	2
908#define DWC3_REQUEST_STATUS_COMPLETED	3
909#define DWC3_REQUEST_STATUS_UNKNOWN	-1
910
911	u8			epnum;
912	struct dwc3_trb		*trb;
913	dma_addr_t		trb_dma;
914
915	unsigned int		num_trbs;
916
917	unsigned int		needs_extra_trb:1;
918	unsigned int		direction:1;
919	unsigned int		mapped:1;
920};
921
922/*
923 * struct dwc3_scratchpad_array - hibernation scratchpad array
924 * (format defined by hw)
925 */
926struct dwc3_scratchpad_array {
927	__le64	dma_adr[DWC3_MAX_HIBER_SCRATCHBUFS];
928};
929
930/**
931 * struct dwc3 - representation of our controller
932 * @drd_work: workqueue used for role swapping
933 * @ep0_trb: trb which is used for the ctrl_req
934 * @bounce: address of bounce buffer
935 * @scratchbuf: address of scratch buffer
936 * @setup_buf: used while precessing STD USB requests
937 * @ep0_trb_addr: dma address of @ep0_trb
938 * @bounce_addr: dma address of @bounce
939 * @ep0_usb_req: dummy req used while handling STD USB requests
940 * @scratch_addr: dma address of scratchbuf
941 * @ep0_in_setup: one control transfer is completed and enter setup phase
942 * @lock: for synchronizing
943 * @mutex: for mode switching
944 * @dev: pointer to our struct device
945 * @sysdev: pointer to the DMA-capable device
946 * @xhci: pointer to our xHCI child
947 * @xhci_resources: struct resources for our @xhci child
948 * @ev_buf: struct dwc3_event_buffer pointer
949 * @eps: endpoint array
950 * @gadget: device side representation of the peripheral controller
951 * @gadget_driver: pointer to the gadget driver
952 * @clks: array of clocks
953 * @num_clks: number of clocks
954 * @reset: reset control
955 * @regs: base address for our registers
956 * @regs_size: address space size
957 * @fladj: frame length adjustment
958 * @irq_gadget: peripheral controller's IRQ number
959 * @otg_irq: IRQ number for OTG IRQs
960 * @current_otg_role: current role of operation while using the OTG block
961 * @desired_otg_role: desired role of operation while using the OTG block
962 * @otg_restart_host: flag that OTG controller needs to restart host
963 * @nr_scratch: number of scratch buffers
964 * @u1u2: only used on revisions <1.83a for workaround
965 * @maximum_speed: maximum speed requested (mainly for testing purposes)
966 * @ip: controller's ID
967 * @revision: controller's version of an IP
968 * @version_type: VERSIONTYPE register contents, a sub release of a revision
969 * @dr_mode: requested mode of operation
970 * @current_dr_role: current role of operation when in dual-role mode
971 * @desired_dr_role: desired role of operation when in dual-role mode
972 * @edev: extcon handle
973 * @edev_nb: extcon notifier
974 * @hsphy_mode: UTMI phy mode, one of following:
975 *		- USBPHY_INTERFACE_MODE_UTMI
976 *		- USBPHY_INTERFACE_MODE_UTMIW
977 * @role_sw: usb_role_switch handle
978 * @role_switch_default_mode: default operation mode of controller while
979 *			usb role is USB_ROLE_NONE.
980 * @usb2_phy: pointer to USB2 PHY
981 * @usb3_phy: pointer to USB3 PHY
982 * @usb2_generic_phy: pointer to USB2 PHY
983 * @usb3_generic_phy: pointer to USB3 PHY
984 * @phys_ready: flag to indicate that PHYs are ready
985 * @ulpi: pointer to ulpi interface
986 * @ulpi_ready: flag to indicate that ULPI is initialized
987 * @u2sel: parameter from Set SEL request.
988 * @u2pel: parameter from Set SEL request.
989 * @u1sel: parameter from Set SEL request.
990 * @u1pel: parameter from Set SEL request.
991 * @num_eps: number of endpoints
992 * @ep0_next_event: hold the next expected event
993 * @ep0state: state of endpoint zero
994 * @link_state: link state
995 * @speed: device speed (super, high, full, low)
996 * @hwparams: copy of hwparams registers
997 * @root: debugfs root folder pointer
998 * @regset: debugfs pointer to regdump file
999 * @dbg_lsp_select: current debug lsp mux register selection
1000 * @test_mode: true when we're entering a USB test mode
1001 * @test_mode_nr: test feature selector
1002 * @lpm_nyet_threshold: LPM NYET response threshold
1003 * @hird_threshold: HIRD threshold
1004 * @rx_thr_num_pkt_prd: periodic ESS receive packet count
1005 * @rx_max_burst_prd: max periodic ESS receive burst size
1006 * @tx_thr_num_pkt_prd: periodic ESS transmit packet count
1007 * @tx_max_burst_prd: max periodic ESS transmit burst size
1008 * @hsphy_interface: "utmi" or "ulpi"
1009 * @connected: true when we're connected to a host, false otherwise
1010 * @softconnect: true when gadget connect is called, false when disconnect runs
1011 * @delayed_status: true when gadget driver asks for delayed status
1012 * @ep0_bounced: true when we used bounce buffer
1013 * @ep0_expect_in: true when we expect a DATA IN transfer
1014 * @has_hibernation: true when dwc3 was configured with Hibernation
1015 * @sysdev_is_parent: true when dwc3 device has a parent driver
1016 * @has_lpm_erratum: true when core was configured with LPM Erratum. Note that
1017 *			there's now way for software to detect this in runtime.
1018 * @is_utmi_l1_suspend: the core asserts output signal
1019 *	0	- utmi_sleep_n
1020 *	1	- utmi_l1_suspend_n
1021 * @is_fpga: true when we are using the FPGA board
1022 * @pending_events: true when we have pending IRQs to be handled
1023 * @pullups_connected: true when Run/Stop bit is set
1024 * @setup_packet_pending: true when there's a Setup Packet in FIFO. Workaround
1025 * @three_stage_setup: set if we perform a three phase setup
1026 * @dis_start_transfer_quirk: set if start_transfer failure SW workaround is
1027 *			not needed for DWC_usb31 version 1.70a-ea06 and below
1028 * @usb3_lpm_capable: set if hadrware supports Link Power Management
1029 * @usb2_lpm_disable: set to disable usb2 lpm for host
1030 * @usb2_gadget_lpm_disable: set to disable usb2 lpm for gadget
1031 * @disable_scramble_quirk: set if we enable the disable scramble quirk
1032 * @u2exit_lfps_quirk: set if we enable u2exit lfps quirk
1033 * @u2ss_inp3_quirk: set if we enable P3 OK for U2/SS Inactive quirk
1034 * @req_p1p2p3_quirk: set if we enable request p1p2p3 quirk
1035 * @del_p1p2p3_quirk: set if we enable delay p1p2p3 quirk
1036 * @del_phy_power_chg_quirk: set if we enable delay phy power change quirk
1037 * @lfps_filter_quirk: set if we enable LFPS filter quirk
1038 * @rx_detect_poll_quirk: set if we enable rx_detect to polling lfps quirk
1039 * @dis_u3_susphy_quirk: set if we disable usb3 suspend phy
1040 * @dis_u2_susphy_quirk: set if we disable usb2 suspend phy
1041 * @dis_enblslpm_quirk: set if we clear enblslpm in GUSB2PHYCFG,
1042 *                      disabling the suspend signal to the PHY.
1043 * @dis_u1_entry_quirk: set if link entering into U1 state needs to be disabled.
1044 * @dis_u2_entry_quirk: set if link entering into U2 state needs to be disabled.
1045 * @dis_rxdet_inp3_quirk: set if we disable Rx.Detect in P3
1046 * @dis_u2_freeclk_exists_quirk : set if we clear u2_freeclk_exists
1047 *			in GUSB2PHYCFG, specify that USB2 PHY doesn't
1048 *			provide a free-running PHY clock.
1049 * @dis_del_phy_power_chg_quirk: set if we disable delay phy power
1050 *			change quirk.
1051 * @dis_tx_ipgap_linecheck_quirk: set if we disable u2mac linestate
1052 *			check during HS transmit.
1053 * @parkmode_disable_ss_quirk: set if we need to disable all SuperSpeed
1054 *			instances in park mode.
1055 * @tx_de_emphasis_quirk: set if we enable Tx de-emphasis quirk
1056 * @tx_de_emphasis: Tx de-emphasis value
1057 *	0	- -6dB de-emphasis
1058 *	1	- -3.5dB de-emphasis
1059 *	2	- No de-emphasis
1060 *	3	- Reserved
1061 * @dis_metastability_quirk: set to disable metastability quirk.
1062 * @dis_split_quirk: set to disable split boundary.
1063 * @imod_interval: set the interrupt moderation interval in 250ns
1064 *			increments or 0 to disable.
1065 */
1066struct dwc3 {
1067	struct work_struct	drd_work;
1068	struct dwc3_trb		*ep0_trb;
1069	void			*bounce;
1070	void			*scratchbuf;
1071	u8			*setup_buf;
1072	dma_addr_t		ep0_trb_addr;
1073	dma_addr_t		bounce_addr;
1074	dma_addr_t		scratch_addr;
1075	struct dwc3_request	ep0_usb_req;
1076	struct completion	ep0_in_setup;
1077
1078	/* device lock */
1079	spinlock_t		lock;
1080
1081	/* mode switching lock */
1082	struct mutex		mutex;
1083
1084	struct device		*dev;
1085	struct device		*sysdev;
1086
1087	struct platform_device	*xhci;
1088	struct resource		xhci_resources[DWC3_XHCI_RESOURCES_NUM];
1089
1090	struct dwc3_event_buffer *ev_buf;
1091	struct dwc3_ep		*eps[DWC3_ENDPOINTS_NUM];
1092
1093	struct usb_gadget	*gadget;
1094	struct usb_gadget_driver *gadget_driver;
1095
1096	struct clk_bulk_data	*clks;
1097	int			num_clks;
1098
1099	struct reset_control	*reset;
1100
1101	struct usb_phy		*usb2_phy;
1102	struct usb_phy		*usb3_phy;
1103
1104	struct phy		*usb2_generic_phy;
1105	struct phy		*usb3_generic_phy;
1106
1107	bool			phys_ready;
1108
1109	struct ulpi		*ulpi;
1110	bool			ulpi_ready;
1111
1112	void __iomem		*regs;
1113	size_t			regs_size;
1114
1115	enum usb_dr_mode	dr_mode;
1116	u32			current_dr_role;
1117	u32			desired_dr_role;
1118	struct extcon_dev	*edev;
1119	struct notifier_block	edev_nb;
1120	enum usb_phy_interface	hsphy_mode;
1121	struct usb_role_switch	*role_sw;
1122	enum usb_dr_mode	role_switch_default_mode;
1123
1124	u32			fladj;
1125	u32			irq_gadget;
1126	u32			otg_irq;
1127	u32			current_otg_role;
1128	u32			desired_otg_role;
1129	bool			otg_restart_host;
1130	u32			nr_scratch;
1131	u32			u1u2;
1132	u32			maximum_speed;
1133
1134	u32			ip;
1135
1136#define DWC3_IP			0x5533
1137#define DWC31_IP		0x3331
1138#define DWC32_IP		0x3332
1139
1140	u32			revision;
1141
1142#define DWC3_REVISION_ANY	0x0
1143#define DWC3_REVISION_173A	0x5533173a
1144#define DWC3_REVISION_175A	0x5533175a
1145#define DWC3_REVISION_180A	0x5533180a
1146#define DWC3_REVISION_183A	0x5533183a
1147#define DWC3_REVISION_185A	0x5533185a
1148#define DWC3_REVISION_187A	0x5533187a
1149#define DWC3_REVISION_188A	0x5533188a
1150#define DWC3_REVISION_190A	0x5533190a
1151#define DWC3_REVISION_194A	0x5533194a
1152#define DWC3_REVISION_200A	0x5533200a
1153#define DWC3_REVISION_202A	0x5533202a
1154#define DWC3_REVISION_210A	0x5533210a
1155#define DWC3_REVISION_220A	0x5533220a
1156#define DWC3_REVISION_230A	0x5533230a
1157#define DWC3_REVISION_240A	0x5533240a
1158#define DWC3_REVISION_250A	0x5533250a
1159#define DWC3_REVISION_260A	0x5533260a
1160#define DWC3_REVISION_270A	0x5533270a
1161#define DWC3_REVISION_280A	0x5533280a
1162#define DWC3_REVISION_290A	0x5533290a
1163#define DWC3_REVISION_300A	0x5533300a
1164#define DWC3_REVISION_310A	0x5533310a
1165#define DWC3_REVISION_330A	0x5533330a
1166
1167#define DWC31_REVISION_ANY	0x0
1168#define DWC31_REVISION_110A	0x3131302a
1169#define DWC31_REVISION_120A	0x3132302a
1170#define DWC31_REVISION_160A	0x3136302a
1171#define DWC31_REVISION_170A	0x3137302a
1172#define DWC31_REVISION_180A	0x3138302a
1173#define DWC31_REVISION_190A	0x3139302a
1174
1175#define DWC32_REVISION_ANY	0x0
1176#define DWC32_REVISION_100A	0x3130302a
1177
1178	u32			version_type;
1179
1180#define DWC31_VERSIONTYPE_ANY		0x0
1181#define DWC31_VERSIONTYPE_EA01		0x65613031
1182#define DWC31_VERSIONTYPE_EA02		0x65613032
1183#define DWC31_VERSIONTYPE_EA03		0x65613033
1184#define DWC31_VERSIONTYPE_EA04		0x65613034
1185#define DWC31_VERSIONTYPE_EA05		0x65613035
1186#define DWC31_VERSIONTYPE_EA06		0x65613036
1187
1188	enum dwc3_ep0_next	ep0_next_event;
1189	enum dwc3_ep0_state	ep0state;
1190	enum dwc3_link_state	link_state;
1191
1192	u16			u2sel;
1193	u16			u2pel;
1194	u8			u1sel;
1195	u8			u1pel;
1196
1197	u8			speed;
1198
1199	u8			num_eps;
1200
1201	struct dwc3_hwparams	hwparams;
1202	struct dentry		*root;
1203	struct debugfs_regset32	*regset;
1204
1205	u32			dbg_lsp_select;
1206
1207	u8			test_mode;
1208	u8			test_mode_nr;
1209	u8			lpm_nyet_threshold;
1210	u8			hird_threshold;
1211	u8			rx_thr_num_pkt_prd;
1212	u8			rx_max_burst_prd;
1213	u8			tx_thr_num_pkt_prd;
1214	u8			tx_max_burst_prd;
1215
1216	const char		*hsphy_interface;
1217
1218	unsigned		connected:1;
1219	unsigned		softconnect:1;
1220	unsigned		delayed_status:1;
1221	unsigned		ep0_bounced:1;
1222	unsigned		ep0_expect_in:1;
1223	unsigned		has_hibernation:1;
1224	unsigned		sysdev_is_parent:1;
1225	unsigned		has_lpm_erratum:1;
1226	unsigned		is_utmi_l1_suspend:1;
1227	unsigned		is_fpga:1;
1228	unsigned		pending_events:1;
1229	unsigned		pullups_connected:1;
1230	unsigned		setup_packet_pending:1;
1231	unsigned		three_stage_setup:1;
1232	unsigned		dis_start_transfer_quirk:1;
1233	unsigned		usb3_lpm_capable:1;
1234	unsigned		usb2_lpm_disable:1;
1235	unsigned		usb2_gadget_lpm_disable:1;
1236
1237	unsigned		disable_scramble_quirk:1;
1238	unsigned		u2exit_lfps_quirk:1;
1239	unsigned		u2ss_inp3_quirk:1;
1240	unsigned		req_p1p2p3_quirk:1;
1241	unsigned                del_p1p2p3_quirk:1;
1242	unsigned		del_phy_power_chg_quirk:1;
1243	unsigned		lfps_filter_quirk:1;
1244	unsigned		rx_detect_poll_quirk:1;
1245	unsigned		dis_u3_susphy_quirk:1;
1246	unsigned		dis_u2_susphy_quirk:1;
1247	unsigned		dis_enblslpm_quirk:1;
1248	unsigned		dis_u1_entry_quirk:1;
1249	unsigned		dis_u2_entry_quirk:1;
1250	unsigned		dis_rxdet_inp3_quirk:1;
1251	unsigned		dis_u2_freeclk_exists_quirk:1;
1252	unsigned		dis_del_phy_power_chg_quirk:1;
1253	unsigned		dis_tx_ipgap_linecheck_quirk:1;
1254	unsigned		parkmode_disable_ss_quirk:1;
1255
1256	unsigned		tx_de_emphasis_quirk:1;
1257	unsigned		tx_de_emphasis:2;
1258
1259	unsigned		dis_metastability_quirk:1;
1260
1261	unsigned		dis_split_quirk:1;
1262
1263	u16			imod_interval;
1264};
1265
1266#define INCRX_BURST_MODE 0
1267#define INCRX_UNDEF_LENGTH_BURST_MODE 1
1268
1269#define work_to_dwc(w)		(container_of((w), struct dwc3, drd_work))
1270
1271/* -------------------------------------------------------------------------- */
1272
1273struct dwc3_event_type {
1274	u32	is_devspec:1;
1275	u32	type:7;
1276	u32	reserved8_31:24;
1277} __packed;
1278
1279#define DWC3_DEPEVT_XFERCOMPLETE	0x01
1280#define DWC3_DEPEVT_XFERINPROGRESS	0x02
1281#define DWC3_DEPEVT_XFERNOTREADY	0x03
1282#define DWC3_DEPEVT_RXTXFIFOEVT		0x04
1283#define DWC3_DEPEVT_STREAMEVT		0x06
1284#define DWC3_DEPEVT_EPCMDCMPLT		0x07
1285
1286/**
1287 * struct dwc3_event_depevt - Device Endpoint Events
1288 * @one_bit: indicates this is an endpoint event (not used)
1289 * @endpoint_number: number of the endpoint
1290 * @endpoint_event: The event we have:
1291 *	0x00	- Reserved
1292 *	0x01	- XferComplete
1293 *	0x02	- XferInProgress
1294 *	0x03	- XferNotReady
1295 *	0x04	- RxTxFifoEvt (IN->Underrun, OUT->Overrun)
1296 *	0x05	- Reserved
1297 *	0x06	- StreamEvt
1298 *	0x07	- EPCmdCmplt
1299 * @reserved11_10: Reserved, don't use.
1300 * @status: Indicates the status of the event. Refer to databook for
1301 *	more information.
1302 * @parameters: Parameters of the current event. Refer to databook for
1303 *	more information.
1304 */
1305struct dwc3_event_depevt {
1306	u32	one_bit:1;
1307	u32	endpoint_number:5;
1308	u32	endpoint_event:4;
1309	u32	reserved11_10:2;
1310	u32	status:4;
1311
1312/* Within XferNotReady */
1313#define DEPEVT_STATUS_TRANSFER_ACTIVE	BIT(3)
1314
1315/* Within XferComplete or XferInProgress */
1316#define DEPEVT_STATUS_BUSERR	BIT(0)
1317#define DEPEVT_STATUS_SHORT	BIT(1)
1318#define DEPEVT_STATUS_IOC	BIT(2)
1319#define DEPEVT_STATUS_LST	BIT(3) /* XferComplete */
1320#define DEPEVT_STATUS_MISSED_ISOC BIT(3) /* XferInProgress */
1321
1322/* Stream event only */
1323#define DEPEVT_STREAMEVT_FOUND		1
1324#define DEPEVT_STREAMEVT_NOTFOUND	2
1325
1326/* Stream event parameter */
1327#define DEPEVT_STREAM_PRIME		0xfffe
1328#define DEPEVT_STREAM_NOSTREAM		0x0
1329
1330/* Control-only Status */
1331#define DEPEVT_STATUS_CONTROL_DATA	1
1332#define DEPEVT_STATUS_CONTROL_STATUS	2
1333#define DEPEVT_STATUS_CONTROL_PHASE(n)	((n) & 3)
1334
1335/* In response to Start Transfer */
1336#define DEPEVT_TRANSFER_NO_RESOURCE	1
1337#define DEPEVT_TRANSFER_BUS_EXPIRY	2
1338
1339	u32	parameters:16;
1340
1341/* For Command Complete Events */
1342#define DEPEVT_PARAMETER_CMD(n)	(((n) & (0xf << 8)) >> 8)
1343} __packed;
1344
1345/**
1346 * struct dwc3_event_devt - Device Events
1347 * @one_bit: indicates this is a non-endpoint event (not used)
1348 * @device_event: indicates it's a device event. Should read as 0x00
1349 * @type: indicates the type of device event.
1350 *	0	- DisconnEvt
1351 *	1	- USBRst
1352 *	2	- ConnectDone
1353 *	3	- ULStChng
1354 *	4	- WkUpEvt
1355 *	5	- Reserved
1356 *	6	- EOPF
1357 *	7	- SOF
1358 *	8	- Reserved
1359 *	9	- ErrticErr
1360 *	10	- CmdCmplt
1361 *	11	- EvntOverflow
1362 *	12	- VndrDevTstRcved
1363 * @reserved15_12: Reserved, not used
1364 * @event_info: Information about this event
1365 * @reserved31_25: Reserved, not used
1366 */
1367struct dwc3_event_devt {
1368	u32	one_bit:1;
1369	u32	device_event:7;
1370	u32	type:4;
1371	u32	reserved15_12:4;
1372	u32	event_info:9;
1373	u32	reserved31_25:7;
1374} __packed;
1375
1376/**
1377 * struct dwc3_event_gevt - Other Core Events
1378 * @one_bit: indicates this is a non-endpoint event (not used)
1379 * @device_event: indicates it's (0x03) Carkit or (0x04) I2C event.
1380 * @phy_port_number: self-explanatory
1381 * @reserved31_12: Reserved, not used.
1382 */
1383struct dwc3_event_gevt {
1384	u32	one_bit:1;
1385	u32	device_event:7;
1386	u32	phy_port_number:4;
1387	u32	reserved31_12:20;
1388} __packed;
1389
1390/**
1391 * union dwc3_event - representation of Event Buffer contents
1392 * @raw: raw 32-bit event
1393 * @type: the type of the event
1394 * @depevt: Device Endpoint Event
1395 * @devt: Device Event
1396 * @gevt: Global Event
1397 */
1398union dwc3_event {
1399	u32				raw;
1400	struct dwc3_event_type		type;
1401	struct dwc3_event_depevt	depevt;
1402	struct dwc3_event_devt		devt;
1403	struct dwc3_event_gevt		gevt;
1404};
1405
1406/**
1407 * struct dwc3_gadget_ep_cmd_params - representation of endpoint command
1408 * parameters
1409 * @param2: third parameter
1410 * @param1: second parameter
1411 * @param0: first parameter
1412 */
1413struct dwc3_gadget_ep_cmd_params {
1414	u32	param2;
1415	u32	param1;
1416	u32	param0;
1417};
1418
1419/*
1420 * DWC3 Features to be used as Driver Data
1421 */
1422
1423#define DWC3_HAS_PERIPHERAL		BIT(0)
1424#define DWC3_HAS_XHCI			BIT(1)
1425#define DWC3_HAS_OTG			BIT(3)
1426
1427/* prototypes */
1428void dwc3_set_prtcap(struct dwc3 *dwc, u32 mode);
1429void dwc3_set_mode(struct dwc3 *dwc, u32 mode);
1430u32 dwc3_core_fifo_space(struct dwc3_ep *dep, u8 type);
1431
1432#define DWC3_IP_IS(_ip)							\
1433	(dwc->ip == _ip##_IP)
1434
1435#define DWC3_VER_IS(_ip, _ver)						\
1436	(DWC3_IP_IS(_ip) && dwc->revision == _ip##_REVISION_##_ver)
1437
1438#define DWC3_VER_IS_PRIOR(_ip, _ver)					\
1439	(DWC3_IP_IS(_ip) && dwc->revision < _ip##_REVISION_##_ver)
1440
1441#define DWC3_VER_IS_WITHIN(_ip, _from, _to)				\
1442	(DWC3_IP_IS(_ip) &&						\
1443	 dwc->revision >= _ip##_REVISION_##_from &&			\
1444	 (!(_ip##_REVISION_##_to) ||					\
1445	  dwc->revision <= _ip##_REVISION_##_to))
1446
1447#define DWC3_VER_TYPE_IS_WITHIN(_ip, _ver, _from, _to)			\
1448	(DWC3_VER_IS(_ip, _ver) &&					\
1449	 dwc->version_type >= _ip##_VERSIONTYPE_##_from &&		\
1450	 (!(_ip##_VERSIONTYPE_##_to) ||					\
1451	  dwc->version_type <= _ip##_VERSIONTYPE_##_to))
1452
1453bool dwc3_has_imod(struct dwc3 *dwc);
1454
1455int dwc3_event_buffers_setup(struct dwc3 *dwc);
1456void dwc3_event_buffers_cleanup(struct dwc3 *dwc);
1457
1458int dwc3_core_soft_reset(struct dwc3 *dwc);
1459
1460#if IS_ENABLED(CONFIG_USB_DWC3_HOST) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1461int dwc3_host_init(struct dwc3 *dwc);
1462void dwc3_host_exit(struct dwc3 *dwc);
1463#else
1464static inline int dwc3_host_init(struct dwc3 *dwc)
1465{ return 0; }
1466static inline void dwc3_host_exit(struct dwc3 *dwc)
1467{ }
1468#endif
1469
1470#if IS_ENABLED(CONFIG_USB_DWC3_GADGET) || IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1471int dwc3_gadget_init(struct dwc3 *dwc);
1472void dwc3_gadget_exit(struct dwc3 *dwc);
1473int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode);
1474int dwc3_gadget_get_link_state(struct dwc3 *dwc);
1475int dwc3_gadget_set_link_state(struct dwc3 *dwc, enum dwc3_link_state state);
1476int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1477		struct dwc3_gadget_ep_cmd_params *params);
1478int dwc3_send_gadget_generic_command(struct dwc3 *dwc, unsigned int cmd,
1479		u32 param);
1480#else
1481static inline int dwc3_gadget_init(struct dwc3 *dwc)
1482{ return 0; }
1483static inline void dwc3_gadget_exit(struct dwc3 *dwc)
1484{ }
1485static inline int dwc3_gadget_set_test_mode(struct dwc3 *dwc, int mode)
1486{ return 0; }
1487static inline int dwc3_gadget_get_link_state(struct dwc3 *dwc)
1488{ return 0; }
1489static inline int dwc3_gadget_set_link_state(struct dwc3 *dwc,
1490		enum dwc3_link_state state)
1491{ return 0; }
1492
1493static inline int dwc3_send_gadget_ep_cmd(struct dwc3_ep *dep, unsigned int cmd,
1494		struct dwc3_gadget_ep_cmd_params *params)
1495{ return 0; }
1496static inline int dwc3_send_gadget_generic_command(struct dwc3 *dwc,
1497		int cmd, u32 param)
1498{ return 0; }
1499#endif
1500
1501#if IS_ENABLED(CONFIG_USB_DWC3_DUAL_ROLE)
1502int dwc3_drd_init(struct dwc3 *dwc);
1503void dwc3_drd_exit(struct dwc3 *dwc);
1504void dwc3_otg_init(struct dwc3 *dwc);
1505void dwc3_otg_exit(struct dwc3 *dwc);
1506void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus);
1507void dwc3_otg_host_init(struct dwc3 *dwc);
1508#else
1509static inline int dwc3_drd_init(struct dwc3 *dwc)
1510{ return 0; }
1511static inline void dwc3_drd_exit(struct dwc3 *dwc)
1512{ }
1513static inline void dwc3_otg_init(struct dwc3 *dwc)
1514{ }
1515static inline void dwc3_otg_exit(struct dwc3 *dwc)
1516{ }
1517static inline void dwc3_otg_update(struct dwc3 *dwc, bool ignore_idstatus)
1518{ }
1519static inline void dwc3_otg_host_init(struct dwc3 *dwc)
1520{ }
1521#endif
1522
1523/* power management interface */
1524#if !IS_ENABLED(CONFIG_USB_DWC3_HOST)
1525int dwc3_gadget_suspend(struct dwc3 *dwc);
1526int dwc3_gadget_resume(struct dwc3 *dwc);
1527void dwc3_gadget_process_pending_events(struct dwc3 *dwc);
1528#else
1529static inline int dwc3_gadget_suspend(struct dwc3 *dwc)
1530{
1531	return 0;
1532}
1533
1534static inline int dwc3_gadget_resume(struct dwc3 *dwc)
1535{
1536	return 0;
1537}
1538
1539static inline void dwc3_gadget_process_pending_events(struct dwc3 *dwc)
1540{
1541}
1542#endif /* !IS_ENABLED(CONFIG_USB_DWC3_HOST) */
1543
1544#if IS_ENABLED(CONFIG_USB_DWC3_ULPI)
1545int dwc3_ulpi_init(struct dwc3 *dwc);
1546void dwc3_ulpi_exit(struct dwc3 *dwc);
1547#else
1548static inline int dwc3_ulpi_init(struct dwc3 *dwc)
1549{ return 0; }
1550static inline void dwc3_ulpi_exit(struct dwc3 *dwc)
1551{ }
1552#endif
1553
1554#endif /* __DRIVERS_USB_DWC3_CORE_H */
1555