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