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