drivers/usb/host/xhci.h

   1
   2 /*
   3  * xHCI host controller driver
   4  *
   5  * Copyright (C) 2008 Intel Corp.
   6  *
   7  * Author: Sarah Sharp
   8  * Some code borrowed from the Linux EHCI driver.
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License version 2 as
  12  * published by the Free Software Foundation.
  13  *
  14  * This program is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
  16  * or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  17  * for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software Foundation,
  21  * Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  22  */
  23
  24 #ifndef __LINUX_XHCI_HCD_H
  25 #define __LINUX_XHCI_HCD_H
  26
  27 #include <linux/usb.h>
  28 #include <linux/timer.h>
  29 #include <linux/kernel.h>
  30 #include <linux/usb/hcd.h>
  31
  32 /* Code sharing between pci-quirks and xhci hcd */
  33 #include        "xhci-ext-caps.h"
  34 #include "pci-quirks.h"
  35
  36 /* xHCI PCI Configuration Registers */
  37 #define XHCI_SBRN_OFFSET        (0x60)
  38
  39 /* Max number of USB devices for any host controller - limit in section 6.1 */
  40 #define MAX_HC_SLOTS            256
  41 /* Section 5.3.3 - MaxPorts */
  42 #define MAX_HC_PORTS            127
  43
  44 /*
  45  * xHCI register interface.
  46  * This corresponds to the eXtensible Host Controller Interface (xHCI)
  47  * Revision 0.95 specification
  48  */
  49
  50 /**
  51  * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
  52  * @hc_capbase:         length of the capabilities register and HC version number
  53  * @hcs_params1:        HCSPARAMS1 - Structural Parameters 1
  54  * @hcs_params2:        HCSPARAMS2 - Structural Parameters 2
  55  * @hcs_params3:        HCSPARAMS3 - Structural Parameters 3
  56  * @hcc_params:         HCCPARAMS - Capability Parameters
  57  * @db_off:             DBOFF - Doorbell array offset
  58  * @run_regs_off:       RTSOFF - Runtime register space offset
  59  */
  60 struct xhci_cap_regs {
  61         __le32  hc_capbase;
  62         __le32  hcs_params1;
  63         __le32  hcs_params2;
  64         __le32  hcs_params3;
  65         __le32  hcc_params;
  66         __le32  db_off;
  67         __le32  run_regs_off;
  68         /* Reserved up to (CAPLENGTH - 0x1C) */
  69 };
  70
  71 /* hc_capbase bitmasks */
  72 /* bits 7:0 - how long is the Capabilities register */
  73 #define HC_LENGTH(p)            XHCI_HC_LENGTH(p)
  74 /* bits 31:16   */
  75 #define HC_VERSION(p)           (((p) >> 16) & 0xffff)
  76
  77 /* HCSPARAMS1 - hcs_params1 - bitmasks */
  78 /* bits 0:7, Max Device Slots */
  79 #define HCS_MAX_SLOTS(p)        (((p) >> 0) & 0xff)
  80 #define HCS_SLOTS_MASK          0xff
  81 /* bits 8:18, Max Interrupters */
  82 #define HCS_MAX_INTRS(p)        (((p) >> 8) & 0x7ff)
  83 /* bits 24:31, Max Ports - max value is 0x7F = 127 ports */
  84 #define HCS_MAX_PORTS(p)        (((p) >> 24) & 0x7f)
  85
  86 /* HCSPARAMS2 - hcs_params2 - bitmasks */
  87 /* bits 0:3, frames or uframes that SW needs to queue transactions
  88  * ahead of the HW to meet periodic deadlines */
  89 #define HCS_IST(p)              (((p) >> 0) & 0xf)
  90 /* bits 4:7, max number of Event Ring segments */
  91 #define HCS_ERST_MAX(p)         (((p) >> 4) & 0xf)
  92 /* bits 21:25 Hi 5 bits of Scratchpad buffers SW must allocate for the HW */
  93 /* bit 26 Scratchpad restore - for save/restore HW state - not used yet */
  94 /* bits 27:31 Lo 5 bits of Scratchpad buffers SW must allocate for the HW */
  95 #define HCS_MAX_SCRATCHPAD(p)   ((((p) >> 16) & 0x3e0) | (((p) >> 27) & 0x1f))
  96
  97 /* HCSPARAMS3 - hcs_params3 - bitmasks */
  98 /* bits 0:7, Max U1 to U0 latency for the roothub ports */
  99 #define HCS_U1_LATENCY(p)       (((p) >> 0) & 0xff)
 100 /* bits 16:31, Max U2 to U0 latency for the roothub ports */
 101 #define HCS_U2_LATENCY(p)       (((p) >> 16) & 0xffff)
 102
 103 /* HCCPARAMS - hcc_params - bitmasks */
 104 /* true: HC can use 64-bit address pointers */
 105 #define HCC_64BIT_ADDR(p)       ((p) & (1 << 0))
 106 /* true: HC can do bandwidth negotiation */
 107 #define HCC_BANDWIDTH_NEG(p)    ((p) & (1 << 1))
 108 /* true: HC uses 64-byte Device Context structures
 109  * FIXME 64-byte context structures aren't supported yet.
 110  */
 111 #define HCC_64BYTE_CONTEXT(p)   ((p) & (1 << 2))
 112 /* true: HC has port power switches */
 113 #define HCC_PPC(p)              ((p) & (1 << 3))
 114 /* true: HC has port indicators */
 115 #define HCS_INDICATOR(p)        ((p) & (1 << 4))
 116 /* true: HC has Light HC Reset Capability */
 117 #define HCC_LIGHT_RESET(p)      ((p) & (1 << 5))
 118 /* true: HC supports latency tolerance messaging */
 119 #define HCC_LTC(p)              ((p) & (1 << 6))
 120 /* true: no secondary Stream ID Support */
 121 #define HCC_NSS(p)              ((p) & (1 << 7))
 122 /* true: HC supports Stopped - Short Packet */
 123 #define HCC_SPC(p)              ((p) & (1 << 9))
 124 /* true: HC has Contiguous Frame ID Capability */
 125 #define HCC_CFC(p)              ((p) & (1 << 11))
 126 /* Max size for Primary Stream Arrays - 2^(n+1), where n is bits 12:15 */
 127 #define HCC_MAX_PSA(p)          (1 << ((((p) >> 12) & 0xf) + 1))
 128 /* Extended Capabilities pointer from PCI base - section 5.3.6 */
 129 #define HCC_EXT_CAPS(p)         XHCI_HCC_EXT_CAPS(p)
 130
 131 /* db_off bitmask - bits 0:1 reserved */
 132 #define DBOFF_MASK      (~0x3)
 133
 134 /* run_regs_off bitmask - bits 0:4 reserved */
 135 #define RTSOFF_MASK     (~0x1f)
 136
 137
 138 /* Number of registers per port */
 139 #define NUM_PORT_REGS   4
 140
 141 #define PORTSC          0
 142 #define PORTPMSC        1
 143 #define PORTLI          2
 144 #define PORTHLPMC       3
 145
 146 /**
 147  * struct xhci_op_regs - xHCI Host Controller Operational Registers.
 148  * @command:            USBCMD - xHC command register
 149  * @status:             USBSTS - xHC status register
 150  * @page_size:          This indicates the page size that the host controller
 151  *                      supports.  If bit n is set, the HC supports a page size
 152  *                      of 2^(n+12), up to a 128MB page size.
 153  *                      4K is the minimum page size.
 154  * @cmd_ring:           CRP - 64-bit Command Ring Pointer
 155  * @dcbaa_ptr:          DCBAAP - 64-bit Device Context Base Address Array Pointer
 156  * @config_reg:         CONFIG - Configure Register
 157  * @port_status_base:   PORTSCn - base address for Port Status and Control
 158  *                      Each port has a Port Status and Control register,
 159  *                      followed by a Port Power Management Status and Control
 160  *                      register, a Port Link Info register, and a reserved
 161  *                      register.
 162  * @port_power_base:    PORTPMSCn - base address for
 163  *                      Port Power Management Status and Control
 164  * @port_link_base:     PORTLIn - base address for Port Link Info (current
 165  *                      Link PM state and control) for USB 2.1 and USB 3.0
 166  *                      devices.
 167  */
 168 struct xhci_op_regs {
 169         __le32  command;
 170         __le32  status;
 171         __le32  page_size;
 172         __le32  reserved1;
 173         __le32  reserved2;
 174         __le32  dev_notification;
 175         __le64  cmd_ring;
 176         /* rsvd: offset 0x20-2F */
 177         __le32  reserved3[4];
 178         __le64  dcbaa_ptr;
 179         __le32  config_reg;
 180         /* rsvd: offset 0x3C-3FF */
 181         __le32  reserved4[241];
 182         /* port 1 registers, which serve as a base address for other ports */
 183         __le32  port_status_base;
 184         __le32  port_power_base;
 185         __le32  port_link_base;
 186         __le32  reserved5;
 187         /* registers for ports 2-255 */
 188         __le32  reserved6[NUM_PORT_REGS*254];
 189 };
 190
 191 /* USBCMD - USB command - command bitmasks */
 192 /* start/stop HC execution - do not write unless HC is halted*/
 193 #define CMD_RUN         XHCI_CMD_RUN
 194 /* Reset HC - resets internal HC state machine and all registers (except
 195  * PCI config regs).  HC does NOT drive a USB reset on the downstream ports.
 196  * The xHCI driver must reinitialize the xHC after setting this bit.
 197  */
 198 #define CMD_RESET       (1 << 1)
 199 /* Event Interrupt Enable - a '1' allows interrupts from the host controller */
 200 #define CMD_EIE         XHCI_CMD_EIE
 201 /* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
 202 #define CMD_HSEIE       XHCI_CMD_HSEIE
 203 /* bits 4:6 are reserved (and should be preserved on writes). */
 204 /* light reset (port status stays unchanged) - reset completed when this is 0 */
 205 #define CMD_LRESET      (1 << 7)
 206 /* host controller save/restore state. */
 207 #define CMD_CSS         (1 << 8)
 208 #define CMD_CRS         (1 << 9)
 209 /* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
 210 #define CMD_EWE         XHCI_CMD_EWE
 211 /* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
 212  * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
 213  * '0' means the xHC can power it off if all ports are in the disconnect,
 214  * disabled, or powered-off state.
 215  */
 216 #define CMD_PM_INDEX    (1 << 11)
 217 /* bits 12:31 are reserved (and should be preserved on writes). */
 218
 219 /* IMAN - Interrupt Management Register */
 220 #define IMAN_IE         (1 << 1)
 221 #define IMAN_IP         (1 << 0)
 222
 223 /* USBSTS - USB status - status bitmasks */
 224 /* HC not running - set to 1 when run/stop bit is cleared. */
 225 #define STS_HALT        XHCI_STS_HALT
 226 /* serious error, e.g. PCI parity error.  The HC will clear the run/stop bit. */
 227 #define STS_FATAL       (1 << 2)
 228 /* event interrupt - clear this prior to clearing any IP flags in IR set*/
 229 #define STS_EINT        (1 << 3)
 230 /* port change detect */
 231 #define STS_PORT        (1 << 4)
 232 /* bits 5:7 reserved and zeroed */
 233 /* save state status - '1' means xHC is saving state */
 234 #define STS_SAVE        (1 << 8)
 235 /* restore state status - '1' means xHC is restoring state */
 236 #define STS_RESTORE     (1 << 9)
 237 /* true: save or restore error */
 238 #define STS_SRE         (1 << 10)
 239 /* true: Controller Not Ready to accept doorbell or op reg writes after reset */
 240 #define STS_CNR         XHCI_STS_CNR
 241 /* true: internal Host Controller Error - SW needs to reset and reinitialize */
 242 #define STS_HCE         (1 << 12)
 243 /* bits 13:31 reserved and should be preserved */
 244
 245 /*
 246  * DNCTRL - Device Notification Control Register - dev_notification bitmasks
 247  * Generate a device notification event when the HC sees a transaction with a
 248  * notification type that matches a bit set in this bit field.
 249  */
 250 #define DEV_NOTE_MASK           (0xffff)
 251 #define ENABLE_DEV_NOTE(x)      (1 << (x))
 252 /* Most of the device notification types should only be used for debug.
 253  * SW does need to pay attention to function wake notifications.
 254  */
 255 #define DEV_NOTE_FWAKE          ENABLE_DEV_NOTE(1)
 256
 257 /* CRCR - Command Ring Control Register - cmd_ring bitmasks */
 258 /* bit 0 is the command ring cycle state */
 259 /* stop ring operation after completion of the currently executing command */
 260 #define CMD_RING_PAUSE          (1 << 1)
 261 /* stop ring immediately - abort the currently executing command */
 262 #define CMD_RING_ABORT          (1 << 2)
 263 /* true: command ring is running */
 264 #define CMD_RING_RUNNING        (1 << 3)
 265 /* bits 4:5 reserved and should be preserved */
 266 /* Command Ring pointer - bit mask for the lower 32 bits. */
 267 #define CMD_RING_RSVD_BITS      (0x3f)
 268
 269 /* CONFIG - Configure Register - config_reg bitmasks */
 270 /* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
 271 #define MAX_DEVS(p)     ((p) & 0xff)
 272 /* bits 8:31 - reserved and should be preserved */
 273
 274 /* PORTSC - Port Status and Control Register - port_status_base bitmasks */
 275 /* true: device connected */
 276 #define PORT_CONNECT    (1 << 0)
 277 /* true: port enabled */
 278 #define PORT_PE         (1 << 1)
 279 /* bit 2 reserved and zeroed */
 280 /* true: port has an over-current condition */
 281 #define PORT_OC         (1 << 3)
 282 /* true: port reset signaling asserted */
 283 #define PORT_RESET      (1 << 4)
 284 /* Port Link State - bits 5:8
 285  * A read gives the current link PM state of the port,
 286  * a write with Link State Write Strobe set sets the link state.
 287  */
 288 #define PORT_PLS_MASK   (0xf << 5)
 289 #define XDEV_U0         (0x0 << 5)
 290 #define XDEV_U2         (0x2 << 5)
 291 #define XDEV_U3         (0x3 << 5)
 292 #define XDEV_INACTIVE   (0x6 << 5)
 293 #define XDEV_RESUME     (0xf << 5)
 294 /* true: port has power (see HCC_PPC) */
 295 #define PORT_POWER      (1 << 9)
 296 /* bits 10:13 indicate device speed:
 297  * 0 - undefined speed - port hasn't be initialized by a reset yet
 298  * 1 - full speed
 299  * 2 - low speed
 300  * 3 - high speed
 301  * 4 - super speed
 302  * 5-15 reserved
 303  */
 304 #define DEV_SPEED_MASK          (0xf << 10)
 305 #define XDEV_FS                 (0x1 << 10)
 306 #define XDEV_LS                 (0x2 << 10)
 307 #define XDEV_HS                 (0x3 << 10)
 308 #define XDEV_SS                 (0x4 << 10)
 309 #define DEV_UNDEFSPEED(p)       (((p) & DEV_SPEED_MASK) == (0x0<<10))
 310 #define DEV_FULLSPEED(p)        (((p) & DEV_SPEED_MASK) == XDEV_FS)
 311 #define DEV_LOWSPEED(p)         (((p) & DEV_SPEED_MASK) == XDEV_LS)
 312 #define DEV_HIGHSPEED(p)        (((p) & DEV_SPEED_MASK) == XDEV_HS)
 313 #define DEV_SUPERSPEED(p)       (((p) & DEV_SPEED_MASK) == XDEV_SS)
 314 /* Bits 20:23 in the Slot Context are the speed for the device */
 315 #define SLOT_SPEED_FS           (XDEV_FS << 10)
 316 #define SLOT_SPEED_LS           (XDEV_LS << 10)
 317 #define SLOT_SPEED_HS           (XDEV_HS << 10)
 318 #define SLOT_SPEED_SS           (XDEV_SS << 10)
 319 /* Port Indicator Control */
 320 #define PORT_LED_OFF    (0 << 14)
 321 #define PORT_LED_AMBER  (1 << 14)
 322 #define PORT_LED_GREEN  (2 << 14)
 323 #define PORT_LED_MASK   (3 << 14)
 324 /* Port Link State Write Strobe - set this when changing link state */
 325 #define PORT_LINK_STROBE        (1 << 16)
 326 /* true: connect status change */
 327 #define PORT_CSC        (1 << 17)
 328 /* true: port enable change */
 329 #define PORT_PEC        (1 << 18)
 330 /* true: warm reset for a USB 3.0 device is done.  A "hot" reset puts the port
 331  * into an enabled state, and the device into the default state.  A "warm" reset
 332  * also resets the link, forcing the device through the link training sequence.
 333  * SW can also look at the Port Reset register to see when warm reset is done.
 334  */
 335 #define PORT_WRC        (1 << 19)
 336 /* true: over-current change */
 337 #define PORT_OCC        (1 << 20)
 338 /* true: reset change - 1 to 0 transition of PORT_RESET */
 339 #define PORT_RC         (1 << 21)
 340 /* port link status change - set on some port link state transitions:
 341  *  Transition                          Reason
 342  *  ------------------------------------------------------------------------------
 343  *  - U3 to Resume                      Wakeup signaling from a device
 344  *  - Resume to Recovery to U0          USB 3.0 device resume
 345  *  - Resume to U0                      USB 2.0 device resume
 346  *  - U3 to Recovery to U0              Software resume of USB 3.0 device complete
 347  *  - U3 to U0                          Software resume of USB 2.0 device complete
 348  *  - U2 to U0                          L1 resume of USB 2.1 device complete
 349  *  - U0 to U0 (???)                    L1 entry rejection by USB 2.1 device
 350  *  - U0 to disabled                    L1 entry error with USB 2.1 device
 351  *  - Any state to inactive             Error on USB 3.0 port
 352  */
 353 #define PORT_PLC        (1 << 22)
 354 /* port configure error change - port failed to configure its link partner */
 355 #define PORT_CEC        (1 << 23)
 356 /* Cold Attach Status - xHC can set this bit to report device attached during
 357  * Sx state. Warm port reset should be perfomed to clear this bit and move port
 358  * to connected state.
 359  */
 360 #define PORT_CAS        (1 << 24)
 361 /* wake on connect (enable) */
 362 #define PORT_WKCONN_E   (1 << 25)
 363 /* wake on disconnect (enable) */
 364 #define PORT_WKDISC_E   (1 << 26)
 365 /* wake on over-current (enable) */
 366 #define PORT_WKOC_E     (1 << 27)
 367 /* bits 28:29 reserved */
 368 /* true: device is non-removable - for USB 3.0 roothub emulation */
 369 #define PORT_DEV_REMOVE (1 << 30)
 370 /* Initiate a warm port reset - complete when PORT_WRC is '1' */
 371 #define PORT_WR         (1 << 31)
 372
 373 /* We mark duplicate entries with -1 */
 374 #define DUPLICATE_ENTRY ((u8)(-1))
 375
 376 /* Port Power Management Status and Control - port_power_base bitmasks */
 377 /* Inactivity timer value for transitions into U1, in microseconds.
 378  * Timeout can be up to 127us.  0xFF means an infinite timeout.
 379  */
 380 #define PORT_U1_TIMEOUT(p)      ((p) & 0xff)
 381 #define PORT_U1_TIMEOUT_MASK    0xff
 382 /* Inactivity timer value for transitions into U2 */
 383 #define PORT_U2_TIMEOUT(p)      (((p) & 0xff) << 8)
 384 #define PORT_U2_TIMEOUT_MASK    (0xff << 8)
 385 /* Bits 24:31 for port testing */
 386
 387 /* USB2 Protocol PORTSPMSC */
 388 #define PORT_L1S_MASK           7
 389 #define PORT_L1S_SUCCESS        1
 390 #define PORT_RWE                (1 << 3)
 391 #define PORT_HIRD(p)            (((p) & 0xf) << 4)
 392 #define PORT_HIRD_MASK          (0xf << 4)
 393 #define PORT_L1DS_MASK          (0xff << 8)
 394 #define PORT_L1DS(p)            (((p) & 0xff) << 8)
 395 #define PORT_HLE                (1 << 16)
 396
 397
 398 /* USB2 Protocol PORTHLPMC */
 399 #define PORT_HIRDM(p)((p) & 3)
 400 #define PORT_L1_TIMEOUT(p)(((p) & 0xff) << 2)
 401 #define PORT_BESLD(p)(((p) & 0xf) << 10)
 402
 403 /* use 512 microseconds as USB2 LPM L1 default timeout. */
 404 #define XHCI_L1_TIMEOUT         512
 405
 406 /* Set default HIRD/BESL value to 4 (350/400us) for USB2 L1 LPM resume latency.
 407  * Safe to use with mixed HIRD and BESL systems (host and device) and is used
 408  * by other operating systems.
 409  *
 410  * XHCI 1.0 errata 8/14/12 Table 13 notes:
 411  * "Software should choose xHC BESL/BESLD field values that do not violate a
 412  * device's resume latency requirements,
 413  * e.g. not program values > '4' if BLC = '1' and a HIRD device is attached,
 414  * or not program values < '4' if BLC = '0' and a BESL device is attached.
 415  */
 416 #define XHCI_DEFAULT_BESL       4
 417
 418 /**
 419  * struct xhci_intr_reg - Interrupt Register Set
 420  * @irq_pending:        IMAN - Interrupt Management Register.  Used to enable
 421  *                      interrupts and check for pending interrupts.
 422  * @irq_control:        IMOD - Interrupt Moderation Register.
 423  *                      Used to throttle interrupts.
 424  * @erst_size:          Number of segments in the Event Ring Segment Table (ERST).
 425  * @erst_base:          ERST base address.
 426  * @erst_dequeue:       Event ring dequeue pointer.
 427  *
 428  * Each interrupter (defined by a MSI-X vector) has an event ring and an Event
 429  * Ring Segment Table (ERST) associated with it.  The event ring is comprised of
 430  * multiple segments of the same size.  The HC places events on the ring and
 431  * "updates the Cycle bit in the TRBs to indicate to software the current
 432  * position of the Enqueue Pointer." The HCD (Linux) processes those events and
 433  * updates the dequeue pointer.
 434  */
 435 struct xhci_intr_reg {
 436         __le32  irq_pending;
 437         __le32  irq_control;
 438         __le32  erst_size;
 439         __le32  rsvd;
 440         __le64  erst_base;
 441         __le64  erst_dequeue;
 442 };
 443
 444 /* irq_pending bitmasks */
 445 #define ER_IRQ_PENDING(p)       ((p) & 0x1)
 446 /* bits 2:31 need to be preserved */
 447 /* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
 448 #define ER_IRQ_CLEAR(p)         ((p) & 0xfffffffe)
 449 #define ER_IRQ_ENABLE(p)        ((ER_IRQ_CLEAR(p)) | 0x2)
 450 #define ER_IRQ_DISABLE(p)       ((ER_IRQ_CLEAR(p)) & ~(0x2))
 451
 452 /* irq_control bitmasks */
 453 /* Minimum interval between interrupts (in 250ns intervals).  The interval
 454  * between interrupts will be longer if there are no events on the event ring.
 455  * Default is 4000 (1 ms).
 456  */
 457 #define ER_IRQ_INTERVAL_MASK    (0xffff)
 458 /* Counter used to count down the time to the next interrupt - HW use only */
 459 #define ER_IRQ_COUNTER_MASK     (0xffff << 16)
 460
 461 /* erst_size bitmasks */
 462 /* Preserve bits 16:31 of erst_size */
 463 #define ERST_SIZE_MASK          (0xffff << 16)
 464
 465 /* erst_dequeue bitmasks */
 466 /* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
 467  * where the current dequeue pointer lies.  This is an optional HW hint.
 468  */
 469 #define ERST_DESI_MASK          (0x7)
 470 /* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
 471  * a work queue (or delayed service routine)?
 472  */
 473 #define ERST_EHB                (1 << 3)
 474 #define ERST_PTR_MASK           (0xf)
 475
 476 /**
 477  * struct xhci_run_regs
 478  * @microframe_index:
 479  *              MFINDEX - current microframe number
 480  *
 481  * Section 5.5 Host Controller Runtime Registers:
 482  * "Software should read and write these registers using only Dword (32 bit)
 483  * or larger accesses"
 484  */
 485 struct xhci_run_regs {
 486         __le32                  microframe_index;
 487         __le32                  rsvd[7];
 488         struct xhci_intr_reg    ir_set[128];
 489 };
 490
 491 /**
 492  * struct doorbell_array
 493  *
 494  * Bits  0 -  7: Endpoint target
 495  * Bits  8 - 15: RsvdZ
 496  * Bits 16 - 31: Stream ID
 497  *
 498  * Section 5.6
 499  */
 500 struct xhci_doorbell_array {
 501         __le32  doorbell[256];
 502 };
 503
 504 #define DB_VALUE(ep, stream)    ((((ep) + 1) & 0xff) | ((stream) << 16))
 505 #define DB_VALUE_HOST           0x00000000
 506
 507 /**
 508  * struct xhci_protocol_caps
 509  * @revision:           major revision, minor revision, capability ID,
 510  *                      and next capability pointer.
 511  * @name_string:        Four ASCII characters to say which spec this xHC
 512  *                      follows, typically "USB ".
 513  * @port_info:          Port offset, count, and protocol-defined information.
 514  */
 515 struct xhci_protocol_caps {
 516         u32     revision;
 517         u32     name_string;
 518         u32     port_info;
 519 };
 520
 521 #define XHCI_EXT_PORT_MAJOR(x)  (((x) >> 24) & 0xff)
 522 #define XHCI_EXT_PORT_OFF(x)    ((x) & 0xff)
 523 #define XHCI_EXT_PORT_COUNT(x)  (((x) >> 8) & 0xff)
 524
 525 /**
 526  * struct xhci_container_ctx
 527  * @type: Type of context.  Used to calculated offsets to contained contexts.
 528  * @size: Size of the context data
 529  * @bytes: The raw context data given to HW
 530  * @dma: dma address of the bytes
 531  *
 532  * Represents either a Device or Input context.  Holds a pointer to the raw
 533  * memory used for the context (bytes) and dma address of it (dma).
 534  */
 535 struct xhci_container_ctx {
 536         unsigned type;
 537 #define XHCI_CTX_TYPE_DEVICE  0x1
 538 #define XHCI_CTX_TYPE_INPUT   0x2
 539
 540         int size;
 541
 542         u8 *bytes;
 543         dma_addr_t dma;
 544 };
 545
 546 /**
 547  * struct xhci_slot_ctx
 548  * @dev_info:   Route string, device speed, hub info, and last valid endpoint
 549  * @dev_info2:  Max exit latency for device number, root hub port number
 550  * @tt_info:    tt_info is used to construct split transaction tokens
 551  * @dev_state:  slot state and device address
 552  *
 553  * Slot Context - section 6.2.1.1.  This assumes the HC uses 32-byte context
 554  * structures.  If the HC uses 64-byte contexts, there is an additional 32 bytes
 555  * reserved at the end of the slot context for HC internal use.
 556  */
 557 struct xhci_slot_ctx {
 558         __le32  dev_info;
 559         __le32  dev_info2;
 560         __le32  tt_info;
 561         __le32  dev_state;
 562         /* offset 0x10 to 0x1f reserved for HC internal use */
 563         __le32  reserved[4];
 564 };
 565
 566 /* dev_info bitmasks */
 567 /* Route String - 0:19 */
 568 #define ROUTE_STRING_MASK       (0xfffff)
 569 /* Device speed - values defined by PORTSC Device Speed field - 20:23 */
 570 #define DEV_SPEED       (0xf << 20)
 571 /* bit 24 reserved */
 572 /* Is this LS/FS device connected through a HS hub? - bit 25 */
 573 #define DEV_MTT         (0x1 << 25)
 574 /* Set if the device is a hub - bit 26 */
 575 #define DEV_HUB         (0x1 << 26)
 576 /* Index of the last valid endpoint context in this device context - 27:31 */
 577 #define LAST_CTX_MASK   (0x1f << 27)
 578 #define LAST_CTX(p)     ((p) << 27)
 579 #define LAST_CTX_TO_EP_NUM(p)   (((p) >> 27) - 1)
 580 #define SLOT_FLAG       (1 << 0)
 581 #define EP0_FLAG        (1 << 1)
 582
 583 /* dev_info2 bitmasks */
 584 /* Max Exit Latency (ms) - worst case time to wake up all links in dev path */
 585 #define MAX_EXIT        (0xffff)
 586 /* Root hub port number that is needed to access the USB device */
 587 #define ROOT_HUB_PORT(p)        (((p) & 0xff) << 16)
 588 #define DEVINFO_TO_ROOT_HUB_PORT(p)     (((p) >> 16) & 0xff)
 589 /* Maximum number of ports under a hub device */
 590 #define XHCI_MAX_PORTS(p)       (((p) & 0xff) << 24)
 591
 592 /* tt_info bitmasks */
 593 /*
 594  * TT Hub Slot ID - for low or full speed devices attached to a high-speed hub
 595  * The Slot ID of the hub that isolates the high speed signaling from
 596  * this low or full-speed device.  '0' if attached to root hub port.
 597  */
 598 #define TT_SLOT         (0xff)
 599 /*
 600  * The number of the downstream facing port of the high-speed hub
 601  * '0' if the device is not low or full speed.
 602  */
 603 #define TT_PORT         (0xff << 8)
 604 #define TT_THINK_TIME(p)        (((p) & 0x3) << 16)
 605
 606 /* dev_state bitmasks */
 607 /* USB device address - assigned by the HC */
 608 #define DEV_ADDR_MASK   (0xff)
 609 /* bits 8:26 reserved */
 610 /* Slot state */
 611 #define SLOT_STATE      (0x1f << 27)
 612 #define GET_SLOT_STATE(p)       (((p) & (0x1f << 27)) >> 27)
 613
 614 #define SLOT_STATE_DISABLED     0
 615 #define SLOT_STATE_ENABLED      SLOT_STATE_DISABLED
 616 #define SLOT_STATE_DEFAULT      1
 617 #define SLOT_STATE_ADDRESSED    2
 618 #define SLOT_STATE_CONFIGURED   3
 619
 620 /**
 621  * struct xhci_ep_ctx
 622  * @ep_info:    endpoint state, streams, mult, and interval information.
 623  * @ep_info2:   information on endpoint type, max packet size, max burst size,
 624  *              error count, and whether the HC will force an event for all
 625  *              transactions.
 626  * @deq:        64-bit ring dequeue pointer address.  If the endpoint only
 627  *              defines one stream, this points to the endpoint transfer ring.
 628  *              Otherwise, it points to a stream context array, which has a
 629  *              ring pointer for each flow.
 630  * @tx_info:
 631  *              Average TRB lengths for the endpoint ring and
 632  *              max payload within an Endpoint Service Interval Time (ESIT).
 633  *
 634  * Endpoint Context - section 6.2.1.2.  This assumes the HC uses 32-byte context
 635  * structures.  If the HC uses 64-byte contexts, there is an additional 32 bytes
 636  * reserved at the end of the endpoint context for HC internal use.
 637  */
 638 struct xhci_ep_ctx {
 639         __le32  ep_info;
 640         __le32  ep_info2;
 641         __le64  deq;
 642         __le32  tx_info;
 643         /* offset 0x14 - 0x1f reserved for HC internal use */
 644         __le32  reserved[3];
 645 };
 646
 647 /* ep_info bitmasks */
 648 /*
 649  * Endpoint State - bits 0:2
 650  * 0 - disabled
 651  * 1 - running
 652  * 2 - halted due to halt condition - ok to manipulate endpoint ring
 653  * 3 - stopped
 654  * 4 - TRB error
 655  * 5-7 - reserved
 656  */
 657 #define EP_STATE_MASK           (0xf)
 658 #define EP_STATE_DISABLED       0
 659 #define EP_STATE_RUNNING        1
 660 #define EP_STATE_HALTED         2
 661 #define EP_STATE_STOPPED        3
 662 #define EP_STATE_ERROR          4
 663 /* Mult - Max number of burtst within an interval, in EP companion desc. */
 664 #define EP_MULT(p)              (((p) & 0x3) << 8)
 665 #define CTX_TO_EP_MULT(p)       (((p) >> 8) & 0x3)
 666 /* bits 10:14 are Max Primary Streams */
 667 /* bit 15 is Linear Stream Array */
 668 /* Interval - period between requests to an endpoint - 125u increments. */
 669 #define EP_INTERVAL(p)          (((p) & 0xff) << 16)
 670 #define EP_INTERVAL_TO_UFRAMES(p)               (1 << (((p) >> 16) & 0xff))
 671 #define CTX_TO_EP_INTERVAL(p)   (((p) >> 16) & 0xff)
 672 #define EP_MAXPSTREAMS_MASK     (0x1f << 10)
 673 #define EP_MAXPSTREAMS(p)       (((p) << 10) & EP_MAXPSTREAMS_MASK)
 674 /* Endpoint is set up with a Linear Stream Array (vs. Secondary Stream Array) */
 675 #define EP_HAS_LSA              (1 << 15)
 676
 677 /* ep_info2 bitmasks */
 678 /*
 679  * Force Event - generate transfer events for all TRBs for this endpoint
 680  * This will tell the HC to ignore the IOC and ISP flags (for debugging only).
 681  */
 682 #define FORCE_EVENT     (0x1)
 683 #define ERROR_COUNT(p)  (((p) & 0x3) << 1)
 684 #define CTX_TO_EP_TYPE(p)       (((p) >> 3) & 0x7)
 685 #define EP_TYPE(p)      ((p) << 3)
 686 #define ISOC_OUT_EP     1
 687 #define BULK_OUT_EP     2
 688 #define INT_OUT_EP      3
 689 #define CTRL_EP         4
 690 #define ISOC_IN_EP      5
 691 #define BULK_IN_EP      6
 692 #define INT_IN_EP       7
 693 /* bit 6 reserved */
 694 /* bit 7 is Host Initiate Disable - for disabling stream selection */
 695 #define MAX_BURST(p)    (((p)&0xff) << 8)
 696 #define CTX_TO_MAX_BURST(p)     (((p) >> 8) & 0xff)
 697 #define MAX_PACKET(p)   (((p)&0xffff) << 16)
 698 #define MAX_PACKET_MASK         (0xffff << 16)
 699 #define MAX_PACKET_DECODED(p)   (((p) >> 16) & 0xffff)
 700
 701 /* Get max packet size from ep desc. Bit 10..0 specify the max packet size.
 702  * USB2.0 spec 9.6.6.
 703  */
 704 #define GET_MAX_PACKET(p)       ((p) & 0x7ff)
 705
 706 /* tx_info bitmasks */
 707 #define AVG_TRB_LENGTH_FOR_EP(p)        ((p) & 0xffff)
 708 #define MAX_ESIT_PAYLOAD_FOR_EP(p)      (((p) & 0xffff) << 16)
 709 #define CTX_TO_MAX_ESIT_PAYLOAD(p)      (((p) >> 16) & 0xffff)
 710
 711 /* deq bitmasks */
 712 #define EP_CTX_CYCLE_MASK               (1 << 0)
 713 #define SCTX_DEQ_MASK                   (~0xfL)
 714
 715
 716 /**
 717  * struct xhci_input_control_context
 718  * Input control context; see section 6.2.5.
 719  *
 720  * @drop_context:       set the bit of the endpoint context you want to disable
 721  * @add_context:        set the bit of the endpoint context you want to enable
 722  */
 723 struct xhci_input_control_ctx {
 724         __le32  drop_flags;
 725         __le32  add_flags;
 726         __le32  rsvd2[6];
 727 };
 728
 729 #define EP_IS_ADDED(ctrl_ctx, i) \
 730         (le32_to_cpu(ctrl_ctx->add_flags) & (1 << (i + 1)))
 731 #define EP_IS_DROPPED(ctrl_ctx, i)       \
 732         (le32_to_cpu(ctrl_ctx->drop_flags) & (1 << (i + 1)))
 733
 734 /* Represents everything that is needed to issue a command on the command ring.
 735  * It's useful to pre-allocate these for commands that cannot fail due to
 736  * out-of-memory errors, like freeing streams.
 737  */
 738 struct xhci_command {
 739         /* Input context for changing device state */
 740         struct xhci_container_ctx       *in_ctx;
 741         u32                             status;
 742         /* If completion is null, no one is waiting on this command
 743          * and the structure can be freed after the command completes.
 744          */
 745         struct completion               *completion;
 746         union xhci_trb                  *command_trb;
 747         struct list_head                cmd_list;
 748 };
 749
 750 /* drop context bitmasks */
 751 #define DROP_EP(x)      (0x1 << x)
 752 /* add context bitmasks */
 753 #define ADD_EP(x)       (0x1 << x)
 754
 755 struct xhci_stream_ctx {
 756         /* 64-bit stream ring address, cycle state, and stream type */
 757         __le64  stream_ring;
 758         /* offset 0x14 - 0x1f reserved for HC internal use */
 759         __le32  reserved[2];
 760 };
 761
 762 /* Stream Context Types (section 6.4.1) - bits 3:1 of stream ctx deq ptr */
 763 #define SCT_FOR_CTX(p)          (((p) & 0x7) << 1)
 764 /* Secondary stream array type, dequeue pointer is to a transfer ring */
 765 #define SCT_SEC_TR              0
 766 /* Primary stream array type, dequeue pointer is to a transfer ring */
 767 #define SCT_PRI_TR              1
 768 /* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
 769 #define SCT_SSA_8               2
 770 #define SCT_SSA_16              3
 771 #define SCT_SSA_32              4
 772 #define SCT_SSA_64              5
 773 #define SCT_SSA_128             6
 774 #define SCT_SSA_256             7
 775
 776 /* Assume no secondary streams for now */
 777 struct xhci_stream_info {
 778         struct xhci_ring                **stream_rings;
 779         /* Number of streams, including stream 0 (which drivers can't use) */
 780         unsigned int                    num_streams;
 781         /* The stream context array may be bigger than
 782          * the number of streams the driver asked for
 783          */
 784         struct xhci_stream_ctx          *stream_ctx_array;
 785         unsigned int                    num_stream_ctxs;
 786         dma_addr_t                      ctx_array_dma;
 787         /* For mapping physical TRB addresses to segments in stream rings */
 788         struct radix_tree_root          trb_address_map;
 789         struct xhci_command             *free_streams_command;
 790 };
 791
 792 #define SMALL_STREAM_ARRAY_SIZE         256
 793 #define MEDIUM_STREAM_ARRAY_SIZE        1024
 794
 795 /* Some Intel xHCI host controllers need software to keep track of the bus
 796  * bandwidth.  Keep track of endpoint info here.  Each root port is allocated
 797  * the full bus bandwidth.  We must also treat TTs (including each port under a
 798  * multi-TT hub) as a separate bandwidth domain.  The direct memory interface
 799  * (DMI) also limits the total bandwidth (across all domains) that can be used.
 800  */
 801 struct xhci_bw_info {
 802         /* ep_interval is zero-based */
 803         unsigned int            ep_interval;
 804         /* mult and num_packets are one-based */
 805         unsigned int            mult;
 806         unsigned int            num_packets;
 807         unsigned int            max_packet_size;
 808         unsigned int            max_esit_payload;
 809         unsigned int            type;
 810 };
 811
 812 /* "Block" sizes in bytes the hardware uses for different device speeds.
 813  * The logic in this part of the hardware limits the number of bits the hardware
 814  * can use, so must represent bandwidth in a less precise manner to mimic what
 815  * the scheduler hardware computes.
 816  */
 817 #define FS_BLOCK        1
 818 #define HS_BLOCK        4
 819 #define SS_BLOCK        16
 820 #define DMI_BLOCK       32
 821
 822 /* Each device speed has a protocol overhead (CRC, bit stuffing, etc) associated
 823  * with each byte transferred.  SuperSpeed devices have an initial overhead to
 824  * set up bursts.  These are in blocks, see above.  LS overhead has already been
 825  * translated into FS blocks.
 826  */
 827 #define DMI_OVERHEAD 8
 828 #define DMI_OVERHEAD_BURST 4
 829 #define SS_OVERHEAD 8
 830 #define SS_OVERHEAD_BURST 32
 831 #define HS_OVERHEAD 26
 832 #define FS_OVERHEAD 20
 833 #define LS_OVERHEAD 128
 834 /* The TTs need to claim roughly twice as much bandwidth (94 bytes per
 835  * microframe ~= 24Mbps) of the HS bus as the devices can actually use because
 836  * of overhead associated with split transfers crossing microframe boundaries.
 837  * 31 blocks is pure protocol overhead.
 838  */
 839 #define TT_HS_OVERHEAD (31 + 94)
 840 #define TT_DMI_OVERHEAD (25 + 12)
 841
 842 /* Bandwidth limits in blocks */
 843 #define FS_BW_LIMIT             1285
 844 #define TT_BW_LIMIT             1320
 845 #define HS_BW_LIMIT             1607
 846 #define SS_BW_LIMIT_IN          3906
 847 #define DMI_BW_LIMIT_IN         3906
 848 #define SS_BW_LIMIT_OUT         3906
 849 #define DMI_BW_LIMIT_OUT        3906
 850
 851 /* Percentage of bus bandwidth reserved for non-periodic transfers */
 852 #define FS_BW_RESERVED          10
 853 #define HS_BW_RESERVED          20
 854 #define SS_BW_RESERVED          10
 855
 856 struct xhci_virt_ep {
 857         struct xhci_ring                *ring;
 858         /* Related to endpoints that are configured to use stream IDs only */
 859         struct xhci_stream_info         *stream_info;
 860         /* Temporary storage in case the configure endpoint command fails and we
 861          * have to restore the device state to the previous state
 862          */
 863         struct xhci_ring                *new_ring;
 864         unsigned int                    ep_state;
 865 #define SET_DEQ_PENDING         (1 << 0)
 866 #define EP_HALTED               (1 << 1)        /* For stall handling */
 867 #define EP_HALT_PENDING         (1 << 2)        /* For URB cancellation */
 868 /* Transitioning the endpoint to using streams, don't enqueue URBs */
 869 #define EP_GETTING_STREAMS      (1 << 3)
 870 #define EP_HAS_STREAMS          (1 << 4)
 871 /* Transitioning the endpoint to not using streams, don't enqueue URBs */
 872 #define EP_GETTING_NO_STREAMS   (1 << 5)
 873         /* ----  Related to URB cancellation ---- */
 874         struct list_head        cancelled_td_list;
 875         struct xhci_td          *stopped_td;
 876         unsigned int            stopped_stream;
 877         /* Watchdog timer for stop endpoint command to cancel URBs */
 878         struct timer_list       stop_cmd_timer;
 879         int                     stop_cmds_pending;
 880         struct xhci_hcd         *xhci;
 881         /* Dequeue pointer and dequeue segment for a submitted Set TR Dequeue
 882          * command.  We'll need to update the ring's dequeue segment and dequeue
 883          * pointer after the command completes.
 884          */
 885         struct xhci_segment     *queued_deq_seg;
 886         union xhci_trb          *queued_deq_ptr;
 887         /*
 888          * Sometimes the xHC can not process isochronous endpoint ring quickly
 889          * enough, and it will miss some isoc tds on the ring and generate
 890          * a Missed Service Error Event.
 891          * Set skip flag when receive a Missed Service Error Event and
 892          * process the missed tds on the endpoint ring.
 893          */
 894         bool                    skip;
 895         /* Bandwidth checking storage */
 896         struct xhci_bw_info     bw_info;
 897         struct list_head        bw_endpoint_list;
 898         /* Isoch Frame ID checking storage */
 899         int                     next_frame_id;
 900 };
 901
 902 enum xhci_overhead_type {
 903         LS_OVERHEAD_TYPE = 0,
 904         FS_OVERHEAD_TYPE,
 905         HS_OVERHEAD_TYPE,
 906 };
 907
 908 struct xhci_interval_bw {
 909         unsigned int            num_packets;
 910         /* Sorted by max packet size.
 911          * Head of the list is the greatest max packet size.
 912          */
 913         struct list_head        endpoints;
 914         /* How many endpoints of each speed are present. */
 915         unsigned int            overhead[3];
 916 };
 917
 918 #define XHCI_MAX_INTERVAL       16
 919
 920 struct xhci_interval_bw_table {
 921         unsigned int            interval0_esit_payload;
 922         struct xhci_interval_bw interval_bw[XHCI_MAX_INTERVAL];
 923         /* Includes reserved bandwidth for async endpoints */
 924         unsigned int            bw_used;
 925         unsigned int            ss_bw_in;
 926         unsigned int            ss_bw_out;
 927 };
 928
 929
 930 struct xhci_virt_device {
 931         struct usb_device               *udev;
 932         /*
 933          * Commands to the hardware are passed an "input context" that
 934          * tells the hardware what to change in its data structures.
 935          * The hardware will return changes in an "output context" that
 936          * software must allocate for the hardware.  We need to keep
 937          * track of input and output contexts separately because
 938          * these commands might fail and we don't trust the hardware.
 939          */
 940         struct xhci_container_ctx       *out_ctx;
 941         /* Used for addressing devices and configuration changes */
 942         struct xhci_container_ctx       *in_ctx;
 943         /* Rings saved to ensure old alt settings can be re-instated */
 944         struct xhci_ring                **ring_cache;
 945         int                             num_rings_cached;
 946 #define XHCI_MAX_RINGS_CACHED   31
 947         struct xhci_virt_ep             eps[31];
 948         struct completion               cmd_completion;
 949         u8                              fake_port;
 950         u8                              real_port;
 951         struct xhci_interval_bw_table   *bw_table;
 952         struct xhci_tt_bw_info          *tt_info;
 953         /* The current max exit latency for the enabled USB3 link states. */
 954         u16                             current_mel;
 955 };
 956
 957 /*
 958  * For each roothub, keep track of the bandwidth information for each periodic
 959  * interval.
 960  *
 961  * If a high speed hub is attached to the roothub, each TT associated with that
 962  * hub is a separate bandwidth domain.  The interval information for the
 963  * endpoints on the devices under that TT will appear in the TT structure.
 964  */
 965 struct xhci_root_port_bw_info {
 966         struct list_head                tts;
 967         unsigned int                    num_active_tts;
 968         struct xhci_interval_bw_table   bw_table;
 969 };
 970
 971 struct xhci_tt_bw_info {
 972         struct list_head                tt_list;
 973         int                             slot_id;
 974         int                             ttport;
 975         struct xhci_interval_bw_table   bw_table;
 976         int                             active_eps;
 977 };
 978
 979
 980 /**
 981  * struct xhci_device_context_array
 982  * @dev_context_ptr     array of 64-bit DMA addresses for device contexts
 983  */
 984 struct xhci_device_context_array {
 985         /* 64-bit device addresses; we only write 32-bit addresses */
 986         __le64                  dev_context_ptrs[MAX_HC_SLOTS];
 987         /* private xHCD pointers */
 988         dma_addr_t      dma;
 989 };
 990 /* TODO: write function to set the 64-bit device DMA address */
 991 /*
 992  * TODO: change this to be dynamically sized at HC mem init time since the HC
 993  * might not be able to handle the maximum number of devices possible.
 994  */
 995
 996
 997 struct xhci_transfer_event {
 998         /* 64-bit buffer address, or immediate data */
 999         __le64  buffer;
1000         __le32  transfer_len;
1001         /* This field is interpreted differently based on the type of TRB */
1002         __le32  flags;
1003 };
1004
1005 /* Transfer event TRB length bit mask */
1006 /* bits 0:23 */
1007 #define EVENT_TRB_LEN(p)                ((p) & 0xffffff)
1008
1009 /** Transfer Event bit fields **/
1010 #define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
1011
1012 /* Completion Code - only applicable for some types of TRBs */
1013 #define COMP_CODE_MASK          (0xff << 24)
1014 #define GET_COMP_CODE(p)        (((p) & COMP_CODE_MASK) >> 24)
1015 #define COMP_SUCCESS    1
1016 /* Data Buffer Error */
1017 #define COMP_DB_ERR     2
1018 /* Babble Detected Error */
1019 #define COMP_BABBLE     3
1020 /* USB Transaction Error */
1021 #define COMP_TX_ERR     4
1022 /* TRB Error - some TRB field is invalid */
1023 #define COMP_TRB_ERR    5
1024 /* Stall Error - USB device is stalled */
1025 #define COMP_STALL      6
1026 /* Resource Error - HC doesn't have memory for that device configuration */
1027 #define COMP_ENOMEM     7
1028 /* Bandwidth Error - not enough room in schedule for this dev config */
1029 #define COMP_BW_ERR     8
1030 /* No Slots Available Error - HC ran out of device slots */
1031 #define COMP_ENOSLOTS   9
1032 /* Invalid Stream Type Error */
1033 #define COMP_STREAM_ERR 10
1034 /* Slot Not Enabled Error - doorbell rung for disabled device slot */
1035 #define COMP_EBADSLT    11
1036 /* Endpoint Not Enabled Error */
1037 #define COMP_EBADEP     12
1038 /* Short Packet */
1039 #define COMP_SHORT_TX   13
1040 /* Ring Underrun - doorbell rung for an empty isoc OUT ep ring */
1041 #define COMP_UNDERRUN   14
1042 /* Ring Overrun - isoc IN ep ring is empty when ep is scheduled to RX */
1043 #define COMP_OVERRUN    15
1044 /* Virtual Function Event Ring Full Error */
1045 #define COMP_VF_FULL    16
1046 /* Parameter Error - Context parameter is invalid */
1047 #define COMP_EINVAL     17
1048 /* Bandwidth Overrun Error - isoc ep exceeded its allocated bandwidth */
1049 #define COMP_BW_OVER    18
1050 /* Context State Error - illegal context state transition requested */
1051 #define COMP_CTX_STATE  19
1052 /* No Ping Response Error - HC didn't get PING_RESPONSE in time to TX */
1053 #define COMP_PING_ERR   20
1054 /* Event Ring is full */
1055 #define COMP_ER_FULL    21
1056 /* Incompatible Device Error */
1057 #define COMP_DEV_ERR    22
1058 /* Missed Service Error - HC couldn't service an isoc ep within interval */
1059 #define COMP_MISSED_INT 23
1060 /* Successfully stopped command ring */
1061 #define COMP_CMD_STOP   24
1062 /* Successfully aborted current command and stopped command ring */
1063 #define COMP_CMD_ABORT  25
1064 /* Stopped - transfer was terminated by a stop endpoint command */
1065 #define COMP_STOP       26
1066 /* Same as COMP_EP_STOPPED, but the transferred length in the event is invalid */
1067 #define COMP_STOP_INVAL 27
1068 /* Same as COMP_EP_STOPPED, but a short packet detected */
1069 #define COMP_STOP_SHORT 28
1070 /* Max Exit Latency Too Large Error */
1071 #define COMP_MEL_ERR    29
1072 /* TRB type 30 reserved */
1073 /* Isoc Buffer Overrun - an isoc IN ep sent more data than could fit in TD */
1074 #define COMP_BUFF_OVER  31
1075 /* Event Lost Error - xHC has an "internal event overrun condition" */
1076 #define COMP_ISSUES     32
1077 /* Undefined Error - reported when other error codes don't apply */
1078 #define COMP_UNKNOWN    33
1079 /* Invalid Stream ID Error */
1080 #define COMP_STRID_ERR  34
1081 /* Secondary Bandwidth Error - may be returned by a Configure Endpoint cmd */
1082 #define COMP_2ND_BW_ERR 35
1083 /* Split Transaction Error */
1084 #define COMP_SPLIT_ERR  36
1085
1086 struct xhci_link_trb {
1087         /* 64-bit segment pointer*/
1088         __le64 segment_ptr;
1089         __le32 intr_target;
1090         __le32 control;
1091 };
1092
1093 /* control bitfields */
1094 #define LINK_TOGGLE     (0x1<<1)
1095
1096 /* Command completion event TRB */
1097 struct xhci_event_cmd {
1098         /* Pointer to command TRB, or the value passed by the event data trb */
1099         __le64 cmd_trb;
1100         __le32 status;
1101         __le32 flags;
1102 };
1103
1104 /* flags bitmasks */
1105
1106 /* Address device - disable SetAddress */
1107 #define TRB_BSR         (1<<9)
1108 enum xhci_setup_dev {
1109         SETUP_CONTEXT_ONLY,
1110         SETUP_CONTEXT_ADDRESS,
1111 };
1112
1113 /* bits 16:23 are the virtual function ID */
1114 /* bits 24:31 are the slot ID */
1115 #define TRB_TO_SLOT_ID(p)       (((p) & (0xff<<24)) >> 24)
1116 #define SLOT_ID_FOR_TRB(p)      (((p) & 0xff) << 24)
1117
1118 /* Stop Endpoint TRB - ep_index to endpoint ID for this TRB */
1119 #define TRB_TO_EP_INDEX(p)              ((((p) & (0x1f << 16)) >> 16) - 1)
1120 #define EP_ID_FOR_TRB(p)                ((((p) + 1) & 0x1f) << 16)
1121
1122 #define SUSPEND_PORT_FOR_TRB(p)         (((p) & 1) << 23)
1123 #define TRB_TO_SUSPEND_PORT(p)          (((p) & (1 << 23)) >> 23)
1124 #define LAST_EP_INDEX                   30
1125
1126 /* Set TR Dequeue Pointer command TRB fields, 6.4.3.9 */
1127 #define TRB_TO_STREAM_ID(p)             ((((p) & (0xffff << 16)) >> 16))
1128 #define STREAM_ID_FOR_TRB(p)            ((((p)) & 0xffff) << 16)
1129 #define SCT_FOR_TRB(p)                  (((p) << 1) & 0x7)
1130
1131
1132 /* Port Status Change Event TRB fields */
1133 /* Port ID - bits 31:24 */
1134 #define GET_PORT_ID(p)          (((p) & (0xff << 24)) >> 24)
1135
1136 /* Normal TRB fields */
1137 /* transfer_len bitmasks - bits 0:16 */
1138 #define TRB_LEN(p)              ((p) & 0x1ffff)
1139 /* Interrupter Target - which MSI-X vector to target the completion event at */
1140 #define TRB_INTR_TARGET(p)      (((p) & 0x3ff) << 22)
1141 #define GET_INTR_TARGET(p)      (((p) >> 22) & 0x3ff)
1142 #define TRB_TBC(p)              (((p) & 0x3) << 7)
1143 #define TRB_TLBPC(p)            (((p) & 0xf) << 16)
1144
1145 /* Cycle bit - indicates TRB ownership by HC or HCD */
1146 #define TRB_CYCLE               (1<<0)
1147 /*
1148  * Force next event data TRB to be evaluated before task switch.
1149  * Used to pass OS data back after a TD completes.
1150  */
1151 #define TRB_ENT                 (1<<1)
1152 /* Interrupt on short packet */
1153 #define TRB_ISP                 (1<<2)
1154 /* Set PCIe no snoop attribute */
1155 #define TRB_NO_SNOOP            (1<<3)
1156 /* Chain multiple TRBs into a TD */
1157 #define TRB_CHAIN               (1<<4)
1158 /* Interrupt on completion */
1159 #define TRB_IOC                 (1<<5)
1160 /* The buffer pointer contains immediate data */
1161 #define TRB_IDT                 (1<<6)
1162
1163 /* Block Event Interrupt */
1164 #define TRB_BEI                 (1<<9)
1165
1166 /* Control transfer TRB specific fields */
1167 #define TRB_DIR_IN              (1<<16)
1168 #define TRB_TX_TYPE(p)          ((p) << 16)
1169 #define TRB_DATA_OUT            2
1170 #define TRB_DATA_IN             3
1171
1172 /* Isochronous TRB specific fields */
1173 #define TRB_SIA                 (1<<31)
1174 #define TRB_FRAME_ID(p)         (((p) & 0x7ff) << 20)
1175
1176 struct xhci_generic_trb {
1177         __le32 field[4];
1178 };
1179
1180 union xhci_trb {
1181         struct xhci_link_trb            link;
1182         struct xhci_transfer_event      trans_event;
1183         struct xhci_event_cmd           event_cmd;
1184         struct xhci_generic_trb         generic;
1185 };
1186
1187 /* TRB bit mask */
1188 #define TRB_TYPE_BITMASK        (0xfc00)
1189 #define TRB_TYPE(p)             ((p) << 10)
1190 #define TRB_FIELD_TO_TYPE(p)    (((p) & TRB_TYPE_BITMASK) >> 10)
1191 /* TRB type IDs */
1192 /* bulk, interrupt, isoc scatter/gather, and control data stage */
1193 #define TRB_NORMAL              1
1194 /* setup stage for control transfers */
1195 #define TRB_SETUP               2
1196 /* data stage for control transfers */
1197 #define TRB_DATA                3
1198 /* status stage for control transfers */
1199 #define TRB_STATUS              4
1200 /* isoc transfers */
1201 #define TRB_ISOC                5
1202 /* TRB for linking ring segments */
1203 #define TRB_LINK                6
1204 #define TRB_EVENT_DATA          7
1205 /* Transfer Ring No-op (not for the command ring) */
1206 #define TRB_TR_NOOP             8
1207 /* Command TRBs */
1208 /* Enable Slot Command */
1209 #define TRB_ENABLE_SLOT         9
1210 /* Disable Slot Command */
1211 #define TRB_DISABLE_SLOT        10
1212 /* Address Device Command */
1213 #define TRB_ADDR_DEV            11
1214 /* Configure Endpoint Command */
1215 #define TRB_CONFIG_EP           12
1216 /* Evaluate Context Command */
1217 #define TRB_EVAL_CONTEXT        13
1218 /* Reset Endpoint Command */
1219 #define TRB_RESET_EP            14
1220 /* Stop Transfer Ring Command */
1221 #define TRB_STOP_RING           15
1222 /* Set Transfer Ring Dequeue Pointer Command */
1223 #define TRB_SET_DEQ             16
1224 /* Reset Device Command */
1225 #define TRB_RESET_DEV           17
1226 /* Force Event Command (opt) */
1227 #define TRB_FORCE_EVENT         18
1228 /* Negotiate Bandwidth Command (opt) */
1229 #define TRB_NEG_BANDWIDTH       19
1230 /* Set Latency Tolerance Value Command (opt) */
1231 #define TRB_SET_LT              20
1232 /* Get port bandwidth Command */
1233 #define TRB_GET_BW              21
1234 /* Force Header Command - generate a transaction or link management packet */
1235 #define TRB_FORCE_HEADER        22
1236 /* No-op Command - not for transfer rings */
1237 #define TRB_CMD_NOOP            23
1238 /* TRB IDs 24-31 reserved */
1239 /* Event TRBS */
1240 /* Transfer Event */
1241 #define TRB_TRANSFER            32
1242 /* Command Completion Event */
1243 #define TRB_COMPLETION          33
1244 /* Port Status Change Event */
1245 #define TRB_PORT_STATUS         34
1246 /* Bandwidth Request Event (opt) */
1247 #define TRB_BANDWIDTH_EVENT     35
1248 /* Doorbell Event (opt) */
1249 #define TRB_DOORBELL            36
1250 /* Host Controller Event */
1251 #define TRB_HC_EVENT            37
1252 /* Device Notification Event - device sent function wake notification */
1253 #define TRB_DEV_NOTE            38
1254 /* MFINDEX Wrap Event - microframe counter wrapped */
1255 #define TRB_MFINDEX_WRAP        39
1256 /* TRB IDs 40-47 reserved, 48-63 is vendor-defined */
1257
1258 /* Nec vendor-specific command completion event. */
1259 #define TRB_NEC_CMD_COMP        48
1260 /* Get NEC firmware revision. */
1261 #define TRB_NEC_GET_FW          49
1262
1263 #define TRB_TYPE_LINK(x)        (((x) & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK))
1264 /* Above, but for __le32 types -- can avoid work by swapping constants: */
1265 #define TRB_TYPE_LINK_LE32(x)   (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1266                                  cpu_to_le32(TRB_TYPE(TRB_LINK)))
1267 #define TRB_TYPE_NOOP_LE32(x)   (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1268                                  cpu_to_le32(TRB_TYPE(TRB_TR_NOOP)))
1269
1270 #define NEC_FW_MINOR(p)         (((p) >> 0) & 0xff)
1271 #define NEC_FW_MAJOR(p)         (((p) >> 8) & 0xff)
1272
1273 /*
1274  * TRBS_PER_SEGMENT must be a multiple of 4,
1275  * since the command ring is 64-byte aligned.
1276  * It must also be greater than 16.
1277  */
1278 #define TRBS_PER_SEGMENT        256
1279 /* Allow two commands + a link TRB, along with any reserved command TRBs */
1280 #define MAX_RSVD_CMD_TRBS       (TRBS_PER_SEGMENT - 3)
1281 #define TRB_SEGMENT_SIZE        (TRBS_PER_SEGMENT*16)
1282 #define TRB_SEGMENT_SHIFT       (ilog2(TRB_SEGMENT_SIZE))
1283 /* TRB buffer pointers can't cross 64KB boundaries */
1284 #define TRB_MAX_BUFF_SHIFT              16
1285 #define TRB_MAX_BUFF_SIZE       (1 << TRB_MAX_BUFF_SHIFT)
1286
1287 struct xhci_segment {
1288         union xhci_trb          *trbs;
1289         /* private to HCD */
1290         struct xhci_segment     *next;
1291         dma_addr_t              dma;
1292 };
1293
1294 struct xhci_td {
1295         struct list_head        td_list;
1296         struct list_head        cancelled_td_list;
1297         struct urb              *urb;
1298         struct xhci_segment     *start_seg;
1299         union xhci_trb          *first_trb;
1300         union xhci_trb          *last_trb;
1301         /* actual_length of the URB has already been set */
1302         bool                    urb_length_set;
1303 };
1304
1305 /* xHCI command default timeout value */
1306 #define XHCI_CMD_DEFAULT_TIMEOUT        (5 * HZ)
1307
1308 /* command descriptor */
1309 struct xhci_cd {
1310         struct xhci_command     *command;
1311         union xhci_trb          *cmd_trb;
1312 };
1313
1314 struct xhci_dequeue_state {
1315         struct xhci_segment *new_deq_seg;
1316         union xhci_trb *new_deq_ptr;
1317         int new_cycle_state;
1318 };
1319
1320 enum xhci_ring_type {
1321         TYPE_CTRL = 0,
1322         TYPE_ISOC,
1323         TYPE_BULK,
1324         TYPE_INTR,
1325         TYPE_STREAM,
1326         TYPE_COMMAND,
1327         TYPE_EVENT,
1328 };
1329
1330 struct xhci_ring {
1331         struct xhci_segment     *first_seg;
1332         struct xhci_segment     *last_seg;
1333         union  xhci_trb         *enqueue;
1334         struct xhci_segment     *enq_seg;
1335         unsigned int            enq_updates;
1336         union  xhci_trb         *dequeue;
1337         struct xhci_segment     *deq_seg;
1338         unsigned int            deq_updates;
1339         struct list_head        td_list;
1340         /*
1341          * Write the cycle state into the TRB cycle field to give ownership of
1342          * the TRB to the host controller (if we are the producer), or to check
1343          * if we own the TRB (if we are the consumer).  See section 4.9.1.
1344          */
1345         u32                     cycle_state;
1346         unsigned int            stream_id;
1347         unsigned int            num_segs;
1348         unsigned int            num_trbs_free;
1349         unsigned int            num_trbs_free_temp;
1350         enum xhci_ring_type     type;
1351         bool                    last_td_was_short;
1352         struct radix_tree_root  *trb_address_map;
1353 };
1354
1355 struct xhci_erst_entry {
1356         /* 64-bit event ring segment address */
1357         __le64  seg_addr;
1358         __le32  seg_size;
1359         /* Set to zero */
1360         __le32  rsvd;
1361 };
1362
1363 struct xhci_erst {
1364         struct xhci_erst_entry  *entries;
1365         unsigned int            num_entries;
1366         /* xhci->event_ring keeps track of segment dma addresses */
1367         dma_addr_t              erst_dma_addr;
1368         /* Num entries the ERST can contain */
1369         unsigned int            erst_size;
1370 };
1371
1372 struct xhci_scratchpad {
1373         u64 *sp_array;
1374         dma_addr_t sp_dma;
1375         void **sp_buffers;
1376         dma_addr_t *sp_dma_buffers;
1377 };
1378
1379 struct urb_priv {
1380         int     length;
1381         int     td_cnt;
1382         struct  xhci_td *td[0];
1383 };
1384
1385 /*
1386  * Each segment table entry is 4*32bits long.  1K seems like an ok size:
1387  * (1K bytes * 8bytes/bit) / (4*32 bits) = 64 segment entries in the table,
1388  * meaning 64 ring segments.
1389  * Initial allocated size of the ERST, in number of entries */
1390 #define ERST_NUM_SEGS   1
1391 /* Initial allocated size of the ERST, in number of entries */
1392 #define ERST_SIZE       64
1393 /* Initial number of event segment rings allocated */
1394 #define ERST_ENTRIES    1
1395 /* Poll every 60 seconds */
1396 #define POLL_TIMEOUT    60
1397 /* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1398 #define XHCI_STOP_EP_CMD_TIMEOUT        5
1399 /* XXX: Make these module parameters */
1400
1401 struct s3_save {
1402         u32     command;
1403         u32     dev_nt;
1404         u64     dcbaa_ptr;
1405         u32     config_reg;
1406         u32     irq_pending;
1407         u32     irq_control;
1408         u32     erst_size;
1409         u64     erst_base;
1410         u64     erst_dequeue;
1411 };
1412
1413 /* Use for lpm */
1414 struct dev_info {
1415         u32                     dev_id;
1416         struct  list_head       list;
1417 };
1418
1419 struct xhci_bus_state {
1420         unsigned long           bus_suspended;
1421         unsigned long           next_statechange;
1422
1423         /* Port suspend arrays are indexed by the portnum of the fake roothub */
1424         /* ports suspend status arrays - max 31 ports for USB2, 15 for USB3 */
1425         u32                     port_c_suspend;
1426         u32                     suspended_ports;
1427         u32                     port_remote_wakeup;
1428         unsigned long           resume_done[USB_MAXCHILDREN];
1429         /* which ports have started to resume */
1430         unsigned long           resuming_ports;
1431         /* Which ports are waiting on RExit to U0 transition. */
1432         unsigned long           rexit_ports;
1433         struct completion       rexit_done[USB_MAXCHILDREN];
1434 };
1435
1436
1437 /*
1438  * It can take up to 20 ms to transition from RExit to U0 on the
1439  * Intel Lynx Point LP xHCI host.
1440  */
1441 #define XHCI_MAX_REXIT_TIMEOUT  (20 * 1000)
1442
1443 static inline unsigned int hcd_index(struct usb_hcd *hcd)
1444 {
1445         if (hcd->speed == HCD_USB3)
1446                 return 0;
1447         else
1448                 return 1;
1449 }
1450
1451 /* There is one xhci_hcd structure per controller */
1452 struct xhci_hcd {
1453         struct usb_hcd *main_hcd;
1454         struct usb_hcd *shared_hcd;
1455         /* glue to PCI and HCD framework */
1456         struct xhci_cap_regs __iomem *cap_regs;
1457         struct xhci_op_regs __iomem *op_regs;
1458         struct xhci_run_regs __iomem *run_regs;
1459         struct xhci_doorbell_array __iomem *dba;
1460         /* Our HCD's current interrupter register set */
1461         struct  xhci_intr_reg __iomem *ir_set;
1462
1463         /* Cached register copies of read-only HC data */
1464         __u32           hcs_params1;
1465         __u32           hcs_params2;
1466         __u32           hcs_params3;
1467         __u32           hcc_params;
1468
1469         spinlock_t      lock;
1470
1471         /* packed release number */
1472         u8              sbrn;
1473         u16             hci_version;
1474         u8              max_slots;
1475         u8              max_interrupters;
1476         u8              max_ports;
1477         u8              isoc_threshold;
1478         int             event_ring_max;
1479         int             addr_64;
1480         /* 4KB min, 128MB max */
1481         int             page_size;
1482         /* Valid values are 12 to 20, inclusive */
1483         int             page_shift;
1484         /* msi-x vectors */
1485         int             msix_count;
1486         struct msix_entry       *msix_entries;
1487         /* optional clock */
1488         struct clk              *clk;
1489         /* data structures */
1490         struct xhci_device_context_array *dcbaa;
1491         struct xhci_ring        *cmd_ring;
1492         unsigned int            cmd_ring_state;
1493 #define CMD_RING_STATE_RUNNING         (1 << 0)
1494 #define CMD_RING_STATE_ABORTED         (1 << 1)
1495 #define CMD_RING_STATE_STOPPED         (1 << 2)
1496         struct list_head        cmd_list;
1497         unsigned int            cmd_ring_reserved_trbs;
1498         struct timer_list       cmd_timer;
1499         struct xhci_command     *current_cmd;
1500         struct xhci_ring        *event_ring;
1501         struct xhci_erst        erst;
1502         /* Scratchpad */
1503         struct xhci_scratchpad  *scratchpad;
1504         /* Store LPM test failed devices' information */
1505         struct list_head        lpm_failed_devs;
1506
1507         /* slot enabling and address device helpers */
1508         /* these are not thread safe so use mutex */
1509         struct mutex mutex;
1510         struct completion       addr_dev;
1511         int slot_id;
1512         /* For USB 3.0 LPM enable/disable. */
1513         struct xhci_command             *lpm_command;
1514         /* Internal mirror of the HW's dcbaa */
1515         struct xhci_virt_device *devs[MAX_HC_SLOTS];
1516         /* For keeping track of bandwidth domains per roothub. */
1517         struct xhci_root_port_bw_info   *rh_bw;
1518
1519         /* DMA pools */
1520         struct dma_pool *device_pool;
1521         struct dma_pool *segment_pool;
1522         struct dma_pool *small_streams_pool;
1523         struct dma_pool *medium_streams_pool;
1524
1525         /* Host controller watchdog timer structures */
1526         unsigned int            xhc_state;
1527
1528         u32                     command;
1529         struct s3_save          s3;
1530 /* Host controller is dying - not responding to commands. "I'm not dead yet!"
1531  *
1532  * xHC interrupts have been disabled and a watchdog timer will (or has already)
1533  * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code.  Any code
1534  * that sees this status (other than the timer that set it) should stop touching
1535  * hardware immediately.  Interrupt handlers should return immediately when
1536  * they see this status (any time they drop and re-acquire xhci->lock).
1537  * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1538  * putting the TD on the canceled list, etc.
1539  *
1540  * There are no reports of xHCI host controllers that display this issue.
1541  */
1542 #define XHCI_STATE_DYING        (1 << 0)
1543 #define XHCI_STATE_HALTED       (1 << 1)
1544         /* Statistics */
1545         int                     error_bitmask;
1546         unsigned int            quirks;
1547 #define XHCI_LINK_TRB_QUIRK     (1 << 0)
1548 #define XHCI_RESET_EP_QUIRK     (1 << 1)
1549 #define XHCI_NEC_HOST           (1 << 2)
1550 #define XHCI_AMD_PLL_FIX        (1 << 3)
1551 #define XHCI_SPURIOUS_SUCCESS   (1 << 4)
1552 /*
1553  * Certain Intel host controllers have a limit to the number of endpoint
1554  * contexts they can handle.  Ideally, they would signal that they can't handle
1555  * anymore endpoint contexts by returning a Resource Error for the Configure
1556  * Endpoint command, but they don't.  Instead they expect software to keep track
1557  * of the number of active endpoints for them, across configure endpoint
1558  * commands, reset device commands, disable slot commands, and address device
1559  * commands.
1560  */
1561 #define XHCI_EP_LIMIT_QUIRK     (1 << 5)
1562 #define XHCI_BROKEN_MSI         (1 << 6)
1563 #define XHCI_RESET_ON_RESUME    (1 << 7)
1564 #define XHCI_SW_BW_CHECKING     (1 << 8)
1565 #define XHCI_AMD_0x96_HOST      (1 << 9)
1566 #define XHCI_TRUST_TX_LENGTH    (1 << 10)
1567 #define XHCI_LPM_SUPPORT        (1 << 11)
1568 #define XHCI_INTEL_HOST         (1 << 12)
1569 #define XHCI_SPURIOUS_REBOOT    (1 << 13)
1570 #define XHCI_COMP_MODE_QUIRK    (1 << 14)
1571 #define XHCI_AVOID_BEI          (1 << 15)
1572 #define XHCI_PLAT               (1 << 16)
1573 #define XHCI_SLOW_SUSPEND       (1 << 17)
1574 #define XHCI_SPURIOUS_WAKEUP    (1 << 18)
1575 /* For controllers with a broken beyond repair streams implementation */
1576 #define XHCI_BROKEN_STREAMS     (1 << 19)
1577 #define XHCI_PME_STUCK_QUIRK    (1 << 20)
1578         unsigned int            num_active_eps;
1579         unsigned int            limit_active_eps;
1580         /* There are two roothubs to keep track of bus suspend info for */
1581         struct xhci_bus_state   bus_state[2];
1582         /* Is each xHCI roothub port a USB 3.0, USB 2.0, or USB 1.1 port? */
1583         u8                      *port_array;
1584         /* Array of pointers to USB 3.0 PORTSC registers */
1585         __le32 __iomem          **usb3_ports;
1586         unsigned int            num_usb3_ports;
1587         /* Array of pointers to USB 2.0 PORTSC registers */
1588         __le32 __iomem          **usb2_ports;
1589         unsigned int            num_usb2_ports;
1590         /* support xHCI 0.96 spec USB2 software LPM */
1591         unsigned                sw_lpm_support:1;
1592         /* support xHCI 1.0 spec USB2 hardware LPM */
1593         unsigned                hw_lpm_support:1;
1594         /* cached usb2 extened protocol capabilites */
1595         u32                     *ext_caps;
1596         unsigned int            num_ext_caps;
1597         /* Compliance Mode Recovery Data */
1598         struct timer_list       comp_mode_recovery_timer;
1599         u32                     port_status_u0;
1600 /* Compliance Mode Timer Triggered every 2 seconds */
1601 #define COMP_MODE_RCVRY_MSECS 2000
1602 };
1603
1604 /* Platform specific overrides to generic XHCI hc_driver ops */
1605 struct xhci_driver_overrides {
1606         size_t extra_priv_size;
1607         int (*reset)(struct usb_hcd *hcd);
1608         int (*start)(struct usb_hcd *hcd);
1609 };
1610
1611 #define XHCI_CFC_DELAY          10
1612
1613 /* convert between an HCD pointer and the corresponding EHCI_HCD */
1614 static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1615 {
1616         struct usb_hcd *primary_hcd;
1617
1618         if (usb_hcd_is_primary_hcd(hcd))
1619                 primary_hcd = hcd;
1620         else
1621                 primary_hcd = hcd->primary_hcd;
1622
1623         return (struct xhci_hcd *) (primary_hcd->hcd_priv);
1624 }
1625
1626 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1627 {
1628         return xhci->main_hcd;
1629 }
1630
1631 #define xhci_dbg(xhci, fmt, args...) \
1632         dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1633 #define xhci_err(xhci, fmt, args...) \
1634         dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1635 #define xhci_warn(xhci, fmt, args...) \
1636         dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1637 #define xhci_warn_ratelimited(xhci, fmt, args...) \
1638         dev_warn_ratelimited(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1639 #define xhci_info(xhci, fmt, args...) \
1640         dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1641
1642 /*
1643  * Registers should always be accessed with double word or quad word accesses.
1644  *
1645  * Some xHCI implementations may support 64-bit address pointers.  Registers
1646  * with 64-bit address pointers should be written to with dword accesses by
1647  * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1648  * xHCI implementations that do not support 64-bit address pointers will ignore
1649  * the high dword, and write order is irrelevant.
1650  */
1651 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
1652                 __le64 __iomem *regs)
1653 {
1654         __u32 __iomem *ptr = (__u32 __iomem *) regs;
1655         u64 val_lo = readl(ptr);
1656         u64 val_hi = readl(ptr + 1);
1657         return val_lo + (val_hi << 32);
1658 }
1659 static inline void xhci_write_64(struct xhci_hcd *xhci,
1660                                  const u64 val, __le64 __iomem *regs)
1661 {
1662         __u32 __iomem *ptr = (__u32 __iomem *) regs;
1663         u32 val_lo = lower_32_bits(val);
1664         u32 val_hi = upper_32_bits(val);
1665
1666         writel(val_lo, ptr);
1667         writel(val_hi, ptr + 1);
1668 }
1669
1670 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1671 {
1672         return xhci->quirks & XHCI_LINK_TRB_QUIRK;
1673 }
1674
1675 /* xHCI debugging */
1676 void xhci_print_ir_set(struct xhci_hcd *xhci, int set_num);
1677 void xhci_print_registers(struct xhci_hcd *xhci);
1678 void xhci_dbg_regs(struct xhci_hcd *xhci);
1679 void xhci_print_run_regs(struct xhci_hcd *xhci);
1680 void xhci_print_trb_offsets(struct xhci_hcd *xhci, union xhci_trb *trb);
1681 void xhci_debug_trb(struct xhci_hcd *xhci, union xhci_trb *trb);
1682 void xhci_debug_segment(struct xhci_hcd *xhci, struct xhci_segment *seg);
1683 void xhci_debug_ring(struct xhci_hcd *xhci, struct xhci_ring *ring);
1684 void xhci_dbg_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1685 void xhci_dbg_cmd_ptrs(struct xhci_hcd *xhci);
1686 void xhci_dbg_ring_ptrs(struct xhci_hcd *xhci, struct xhci_ring *ring);
1687 void xhci_dbg_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int last_ep);
1688 char *xhci_get_slot_state(struct xhci_hcd *xhci,
1689                 struct xhci_container_ctx *ctx);
1690 void xhci_dbg_ep_rings(struct xhci_hcd *xhci,
1691                 unsigned int slot_id, unsigned int ep_index,
1692                 struct xhci_virt_ep *ep);
1693 void xhci_dbg_trace(struct xhci_hcd *xhci, void (*trace)(struct va_format *),
1694                         const char *fmt, ...);
1695
1696 /* xHCI memory management */
1697 void xhci_mem_cleanup(struct xhci_hcd *xhci);
1698 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
1699 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1700 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
1701 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
1702 void xhci_copy_ep0_dequeue_into_input_ctx(struct xhci_hcd *xhci,
1703                 struct usb_device *udev);
1704 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor *desc);
1705 unsigned int xhci_get_endpoint_address(unsigned int ep_index);
1706 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor *desc);
1707 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index);
1708 unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
1709 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
1710 void xhci_drop_ep_from_interval_table(struct xhci_hcd *xhci,
1711                 struct xhci_bw_info *ep_bw,
1712                 struct xhci_interval_bw_table *bw_table,
1713                 struct usb_device *udev,
1714                 struct xhci_virt_ep *virt_ep,
1715                 struct xhci_tt_bw_info *tt_info);
1716 void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
1717                 struct xhci_virt_device *virt_dev,
1718                 int old_active_eps);
1719 void xhci_clear_endpoint_bw_info(struct xhci_bw_info *bw_info);
1720 void xhci_update_bw_info(struct xhci_hcd *xhci,
1721                 struct xhci_container_ctx *in_ctx,
1722                 struct xhci_input_control_ctx *ctrl_ctx,
1723                 struct xhci_virt_device *virt_dev);
1724 void xhci_endpoint_copy(struct xhci_hcd *xhci,
1725                 struct xhci_container_ctx *in_ctx,
1726                 struct xhci_container_ctx *out_ctx,
1727                 unsigned int ep_index);
1728 void xhci_slot_copy(struct xhci_hcd *xhci,
1729                 struct xhci_container_ctx *in_ctx,
1730                 struct xhci_container_ctx *out_ctx);
1731 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1732                 struct usb_device *udev, struct usb_host_endpoint *ep,
1733                 gfp_t mem_flags);
1734 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
1735 int xhci_ring_expansion(struct xhci_hcd *xhci, struct xhci_ring *ring,
1736                                 unsigned int num_trbs, gfp_t flags);
1737 void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
1738                 struct xhci_virt_device *virt_dev,
1739                 unsigned int ep_index);
1740 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1741                 unsigned int num_stream_ctxs,
1742                 unsigned int num_streams, gfp_t flags);
1743 void xhci_free_stream_info(struct xhci_hcd *xhci,
1744                 struct xhci_stream_info *stream_info);
1745 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1746                 struct xhci_ep_ctx *ep_ctx,
1747                 struct xhci_stream_info *stream_info);
1748 void xhci_setup_no_streams_ep_input_ctx(struct xhci_ep_ctx *ep_ctx,
1749                 struct xhci_virt_ep *ep);
1750 void xhci_free_device_endpoint_resources(struct xhci_hcd *xhci,
1751         struct xhci_virt_device *virt_dev, bool drop_control_ep);
1752 struct xhci_ring *xhci_dma_to_transfer_ring(
1753                 struct xhci_virt_ep *ep,
1754                 u64 address);
1755 struct xhci_ring *xhci_stream_id_to_ring(
1756                 struct xhci_virt_device *dev,
1757                 unsigned int ep_index,
1758                 unsigned int stream_id);
1759 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
1760                 bool allocate_in_ctx, bool allocate_completion,
1761                 gfp_t mem_flags);
1762 void xhci_urb_free_priv(struct urb_priv *urb_priv);
1763 void xhci_free_command(struct xhci_hcd *xhci,
1764                 struct xhci_command *command);
1765
1766 /* xHCI host controller glue */
1767 typedef void (*xhci_get_quirks_t)(struct device *, struct xhci_hcd *);
1768 int xhci_handshake(void __iomem *ptr, u32 mask, u32 done, int usec);
1769 void xhci_quiesce(struct xhci_hcd *xhci);
1770 int xhci_halt(struct xhci_hcd *xhci);
1771 int xhci_reset(struct xhci_hcd *xhci);
1772 int xhci_init(struct usb_hcd *hcd);
1773 int xhci_run(struct usb_hcd *hcd);
1774 void xhci_stop(struct usb_hcd *hcd);
1775 void xhci_shutdown(struct usb_hcd *hcd);
1776 int xhci_gen_setup(struct usb_hcd *hcd, xhci_get_quirks_t get_quirks);
1777 void xhci_init_driver(struct hc_driver *drv,
1778                       const struct xhci_driver_overrides *over);
1779
1780 #ifdef  CONFIG_PM
1781 int xhci_suspend(struct xhci_hcd *xhci, bool do_wakeup);
1782 int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
1783 #else
1784 #define xhci_suspend    NULL
1785 #define xhci_resume     NULL
1786 #endif
1787
1788 int xhci_get_frame(struct usb_hcd *hcd);
1789 irqreturn_t xhci_irq(struct usb_hcd *hcd);
1790 irqreturn_t xhci_msi_irq(int irq, void *hcd);
1791 int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
1792 void xhci_free_dev(struct usb_hcd *hcd, struct usb_device *udev);
1793 int xhci_alloc_tt_info(struct xhci_hcd *xhci,
1794                 struct xhci_virt_device *virt_dev,
1795                 struct usb_device *hdev,
1796                 struct usb_tt *tt, gfp_t mem_flags);
1797 int xhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1798                 struct usb_host_endpoint **eps, unsigned int num_eps,
1799                 unsigned int num_streams, gfp_t mem_flags);
1800 int xhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1801                 struct usb_host_endpoint **eps, unsigned int num_eps,
1802                 gfp_t mem_flags);
1803 int xhci_address_device(struct usb_hcd *hcd, struct usb_device *udev);
1804 int xhci_enable_device(struct usb_hcd *hcd, struct usb_device *udev);
1805 int xhci_update_device(struct usb_hcd *hcd, struct usb_device *udev);
1806 int xhci_set_usb2_hardware_lpm(struct usb_hcd *hcd,
1807                                 struct usb_device *udev, int enable);
1808 int xhci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev,
1809                         struct usb_tt *tt, gfp_t mem_flags);
1810 int xhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags);
1811 int xhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
1812 int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1813 int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1814 void xhci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep);
1815 int xhci_discover_or_reset_device(struct usb_hcd *hcd, struct usb_device *udev);
1816 int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1817 void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1818
1819 /* xHCI ring, segment, TRB, and TD functions */
1820 dma_addr_t xhci_trb_virt_to_dma(struct xhci_segment *seg, union xhci_trb *trb);
1821 struct xhci_segment *trb_in_td(struct xhci_hcd *xhci,
1822                 struct xhci_segment *start_seg, union xhci_trb *start_trb,
1823                 union xhci_trb *end_trb, dma_addr_t suspect_dma, bool debug);
1824 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
1825 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
1826 int xhci_queue_slot_control(struct xhci_hcd *xhci, struct xhci_command *cmd,
1827                 u32 trb_type, u32 slot_id);
1828 int xhci_queue_address_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
1829                 dma_addr_t in_ctx_ptr, u32 slot_id, enum xhci_setup_dev);
1830 int xhci_queue_vendor_command(struct xhci_hcd *xhci, struct xhci_command *cmd,
1831                 u32 field1, u32 field2, u32 field3, u32 field4);
1832 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, struct xhci_command *cmd,
1833                 int slot_id, unsigned int ep_index, int suspend);
1834 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1835                 int slot_id, unsigned int ep_index);
1836 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1837                 int slot_id, unsigned int ep_index);
1838 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1839                 int slot_id, unsigned int ep_index);
1840 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1841                 struct urb *urb, int slot_id, unsigned int ep_index);
1842 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci,
1843                 struct xhci_command *cmd, dma_addr_t in_ctx_ptr, u32 slot_id,
1844                 bool command_must_succeed);
1845 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, struct xhci_command *cmd,
1846                 dma_addr_t in_ctx_ptr, u32 slot_id, bool command_must_succeed);
1847 int xhci_queue_reset_ep(struct xhci_hcd *xhci, struct xhci_command *cmd,
1848                 int slot_id, unsigned int ep_index);
1849 int xhci_queue_reset_device(struct xhci_hcd *xhci, struct xhci_command *cmd,
1850                 u32 slot_id);
1851 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
1852                 unsigned int slot_id, unsigned int ep_index,
1853                 unsigned int stream_id, struct xhci_td *cur_td,
1854                 struct xhci_dequeue_state *state);
1855 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
1856                 unsigned int slot_id, unsigned int ep_index,
1857                 unsigned int stream_id,
1858                 struct xhci_dequeue_state *deq_state);
1859 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci,
1860                 unsigned int ep_index, struct xhci_td *td);
1861 void xhci_queue_config_ep_quirk(struct xhci_hcd *xhci,
1862                 unsigned int slot_id, unsigned int ep_index,
1863                 struct xhci_dequeue_state *deq_state);
1864 void xhci_stop_endpoint_command_watchdog(unsigned long arg);
1865 void xhci_handle_command_timeout(unsigned long data);
1866
1867 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1868                 unsigned int ep_index, unsigned int stream_id);
1869 void xhci_cleanup_command_queue(struct xhci_hcd *xhci);
1870
1871 /* xHCI roothub code */
1872 void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1873                                 int port_id, u32 link_state);
1874 int xhci_enable_usb3_lpm_timeout(struct usb_hcd *hcd,
1875                         struct usb_device *udev, enum usb3_link_state state);
1876 int xhci_disable_usb3_lpm_timeout(struct usb_hcd *hcd,
1877                         struct usb_device *udev, enum usb3_link_state state);
1878 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1879                                 int port_id, u32 port_bit);
1880 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
1881                 char *buf, u16 wLength);
1882 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
1883 int xhci_find_raw_port_number(struct usb_hcd *hcd, int port1);
1884
1885 #ifdef CONFIG_PM
1886 int xhci_bus_suspend(struct usb_hcd *hcd);
1887 int xhci_bus_resume(struct usb_hcd *hcd);
1888 #else
1889 #define xhci_bus_suspend        NULL
1890 #define xhci_bus_resume         NULL
1891 #endif  /* CONFIG_PM */
1892
1893 u32 xhci_port_state_to_neutral(u32 state);
1894 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1895                 u16 port);
1896 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
1897
1898 /* xHCI contexts */
1899 struct xhci_input_control_ctx *xhci_get_input_control_ctx(struct xhci_container_ctx *ctx);
1900 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1901 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
1902
1903 #endif /* __LINUX_XHCI_HCD_H */