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