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