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