Linux Kernel  3.7.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
xhci.h
Go to the documentation of this file.
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>
27 #include <linux/timer.h>
28 #include <linux/kernel.h>
29 #include <linux/usb/hcd.h>
30 
31 /* Code sharing between pci-quirks and xhci hcd */
32 #include "xhci-ext-caps.h"
33 #include "pci-quirks.h"
34 
35 /* xHCI PCI Configuration Registers */
36 #define XHCI_SBRN_OFFSET (0x60)
37 
38 /* Max number of USB devices for any host controller - limit in section 6.1 */
39 #define MAX_HC_SLOTS 256
40 /* Section 5.3.3 - MaxPorts */
41 #define MAX_HC_PORTS 127
42 
43 /*
44  * xHCI register interface.
45  * This corresponds to the eXtensible Host Controller Interface (xHCI)
46  * Revision 0.95 specification
47  */
48 
59 struct xhci_cap_regs {
67  /* Reserved up to (CAPLENGTH - 0x1C) */
68 };
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 */
93 #define HCS_MAX_SCRATCHPAD(p) (((p) >> 27) & 0x1f)
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 */
121 #define HCC_MAX_PSA(p) (1 << ((((p) >> 12) & 0xf) + 1))
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 
157 struct xhci_op_regs {
165  /* rsvd: offset 0x20-2F */
169  /* rsvd: offset 0x3C-3FF */
171  /* port 1 registers, which serve as a base address for other ports */
176  /* registers for ports 2-255 */
178 };
179 
180 /* USBCMD - USB command - command bitmasks */
181 /* start/stop HC execution - do not write unless HC is halted*/
182 #define CMD_RUN XHCI_CMD_RUN
183 /* Reset HC - resets internal HC state machine and all registers (except
184  * PCI config regs). HC does NOT drive a USB reset on the downstream ports.
185  * The xHCI driver must reinitialize the xHC after setting this bit.
186  */
187 #define CMD_RESET (1 << 1)
188 /* Event Interrupt Enable - a '1' allows interrupts from the host controller */
189 #define CMD_EIE XHCI_CMD_EIE
190 /* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
191 #define CMD_HSEIE XHCI_CMD_HSEIE
192 /* bits 4:6 are reserved (and should be preserved on writes). */
193 /* light reset (port status stays unchanged) - reset completed when this is 0 */
194 #define CMD_LRESET (1 << 7)
195 /* host controller save/restore state. */
196 #define CMD_CSS (1 << 8)
197 #define CMD_CRS (1 << 9)
198 /* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
199 #define CMD_EWE XHCI_CMD_EWE
200 /* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
201  * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
202  * '0' means the xHC can power it off if all ports are in the disconnect,
203  * disabled, or powered-off state.
204  */
205 #define CMD_PM_INDEX (1 << 11)
206 /* bits 12:31 are reserved (and should be preserved on writes). */
207 
208 /* IMAN - Interrupt Management Register */
209 #define IMAN_IP (1 << 1)
210 #define IMAN_IE (1 << 0)
211 
212 /* USBSTS - USB status - status bitmasks */
213 /* HC not running - set to 1 when run/stop bit is cleared. */
214 #define STS_HALT XHCI_STS_HALT
215 /* serious error, e.g. PCI parity error. The HC will clear the run/stop bit. */
216 #define STS_FATAL (1 << 2)
217 /* event interrupt - clear this prior to clearing any IP flags in IR set*/
218 #define STS_EINT (1 << 3)
219 /* port change detect */
220 #define STS_PORT (1 << 4)
221 /* bits 5:7 reserved and zeroed */
222 /* save state status - '1' means xHC is saving state */
223 #define STS_SAVE (1 << 8)
224 /* restore state status - '1' means xHC is restoring state */
225 #define STS_RESTORE (1 << 9)
226 /* true: save or restore error */
227 #define STS_SRE (1 << 10)
228 /* true: Controller Not Ready to accept doorbell or op reg writes after reset */
229 #define STS_CNR XHCI_STS_CNR
230 /* true: internal Host Controller Error - SW needs to reset and reinitialize */
231 #define STS_HCE (1 << 12)
232 /* bits 13:31 reserved and should be preserved */
233 
234 /*
235  * DNCTRL - Device Notification Control Register - dev_notification bitmasks
236  * Generate a device notification event when the HC sees a transaction with a
237  * notification type that matches a bit set in this bit field.
238  */
239 #define DEV_NOTE_MASK (0xffff)
240 #define ENABLE_DEV_NOTE(x) (1 << (x))
241 /* Most of the device notification types should only be used for debug.
242  * SW does need to pay attention to function wake notifications.
243  */
244 #define DEV_NOTE_FWAKE ENABLE_DEV_NOTE(1)
245 
246 /* CRCR - Command Ring Control Register - cmd_ring bitmasks */
247 /* bit 0 is the command ring cycle state */
248 /* stop ring operation after completion of the currently executing command */
249 #define CMD_RING_PAUSE (1 << 1)
250 /* stop ring immediately - abort the currently executing command */
251 #define CMD_RING_ABORT (1 << 2)
252 /* true: command ring is running */
253 #define CMD_RING_RUNNING (1 << 3)
254 /* bits 4:5 reserved and should be preserved */
255 /* Command Ring pointer - bit mask for the lower 32 bits. */
256 #define CMD_RING_RSVD_BITS (0x3f)
257 
258 /* CONFIG - Configure Register - config_reg bitmasks */
259 /* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
260 #define MAX_DEVS(p) ((p) & 0xff)
261 /* bits 8:31 - reserved and should be preserved */
262 
263 /* PORTSC - Port Status and Control Register - port_status_base bitmasks */
264 /* true: device connected */
265 #define PORT_CONNECT (1 << 0)
266 /* true: port enabled */
267 #define PORT_PE (1 << 1)
268 /* bit 2 reserved and zeroed */
269 /* true: port has an over-current condition */
270 #define PORT_OC (1 << 3)
271 /* true: port reset signaling asserted */
272 #define PORT_RESET (1 << 4)
273 /* Port Link State - bits 5:8
274  * A read gives the current link PM state of the port,
275  * a write with Link State Write Strobe set sets the link state.
276  */
277 #define PORT_PLS_MASK (0xf << 5)
278 #define XDEV_U0 (0x0 << 5)
279 #define XDEV_U2 (0x2 << 5)
280 #define XDEV_U3 (0x3 << 5)
281 #define XDEV_RESUME (0xf << 5)
282 /* true: port has power (see HCC_PPC) */
283 #define PORT_POWER (1 << 9)
284 /* bits 10:13 indicate device speed:
285  * 0 - undefined speed - port hasn't be initialized by a reset yet
286  * 1 - full speed
287  * 2 - low speed
288  * 3 - high speed
289  * 4 - super speed
290  * 5-15 reserved
291  */
292 #define DEV_SPEED_MASK (0xf << 10)
293 #define XDEV_FS (0x1 << 10)
294 #define XDEV_LS (0x2 << 10)
295 #define XDEV_HS (0x3 << 10)
296 #define XDEV_SS (0x4 << 10)
297 #define DEV_UNDEFSPEED(p) (((p) & DEV_SPEED_MASK) == (0x0<<10))
298 #define DEV_FULLSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_FS)
299 #define DEV_LOWSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_LS)
300 #define DEV_HIGHSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_HS)
301 #define DEV_SUPERSPEED(p) (((p) & DEV_SPEED_MASK) == XDEV_SS)
302 /* Bits 20:23 in the Slot Context are the speed for the device */
303 #define SLOT_SPEED_FS (XDEV_FS << 10)
304 #define SLOT_SPEED_LS (XDEV_LS << 10)
305 #define SLOT_SPEED_HS (XDEV_HS << 10)
306 #define SLOT_SPEED_SS (XDEV_SS << 10)
307 /* Port Indicator Control */
308 #define PORT_LED_OFF (0 << 14)
309 #define PORT_LED_AMBER (1 << 14)
310 #define PORT_LED_GREEN (2 << 14)
311 #define PORT_LED_MASK (3 << 14)
312 /* Port Link State Write Strobe - set this when changing link state */
313 #define PORT_LINK_STROBE (1 << 16)
314 /* true: connect status change */
315 #define PORT_CSC (1 << 17)
316 /* true: port enable change */
317 #define PORT_PEC (1 << 18)
318 /* true: warm reset for a USB 3.0 device is done. A "hot" reset puts the port
319  * into an enabled state, and the device into the default state. A "warm" reset
320  * also resets the link, forcing the device through the link training sequence.
321  * SW can also look at the Port Reset register to see when warm reset is done.
322  */
323 #define PORT_WRC (1 << 19)
324 /* true: over-current change */
325 #define PORT_OCC (1 << 20)
326 /* true: reset change - 1 to 0 transition of PORT_RESET */
327 #define PORT_RC (1 << 21)
328 /* port link status change - set on some port link state transitions:
329  * Transition Reason
330  * ------------------------------------------------------------------------------
331  * - U3 to Resume Wakeup signaling from a device
332  * - Resume to Recovery to U0 USB 3.0 device resume
333  * - Resume to U0 USB 2.0 device resume
334  * - U3 to Recovery to U0 Software resume of USB 3.0 device complete
335  * - U3 to U0 Software resume of USB 2.0 device complete
336  * - U2 to U0 L1 resume of USB 2.1 device complete
337  * - U0 to U0 (???) L1 entry rejection by USB 2.1 device
338  * - U0 to disabled L1 entry error with USB 2.1 device
339  * - Any state to inactive Error on USB 3.0 port
340  */
341 #define PORT_PLC (1 << 22)
342 /* port configure error change - port failed to configure its link partner */
343 #define PORT_CEC (1 << 23)
344 /* Cold Attach Status - xHC can set this bit to report device attached during
345  * Sx state. Warm port reset should be perfomed to clear this bit and move port
346  * to connected state.
347  */
348 #define PORT_CAS (1 << 24)
349 /* wake on connect (enable) */
350 #define PORT_WKCONN_E (1 << 25)
351 /* wake on disconnect (enable) */
352 #define PORT_WKDISC_E (1 << 26)
353 /* wake on over-current (enable) */
354 #define PORT_WKOC_E (1 << 27)
355 /* bits 28:29 reserved */
356 /* true: device is removable - for USB 3.0 roothub emulation */
357 #define PORT_DEV_REMOVE (1 << 30)
358 /* Initiate a warm port reset - complete when PORT_WRC is '1' */
359 #define PORT_WR (1 << 31)
360 
361 /* We mark duplicate entries with -1 */
362 #define DUPLICATE_ENTRY ((u8)(-1))
363 
364 /* Port Power Management Status and Control - port_power_base bitmasks */
365 /* Inactivity timer value for transitions into U1, in microseconds.
366  * Timeout can be up to 127us. 0xFF means an infinite timeout.
367  */
368 #define PORT_U1_TIMEOUT(p) ((p) & 0xff)
369 #define PORT_U1_TIMEOUT_MASK 0xff
370 /* Inactivity timer value for transitions into U2 */
371 #define PORT_U2_TIMEOUT(p) (((p) & 0xff) << 8)
372 #define PORT_U2_TIMEOUT_MASK (0xff << 8)
373 /* Bits 24:31 for port testing */
374 
375 /* USB2 Protocol PORTSPMSC */
376 #define PORT_L1S_MASK 7
377 #define PORT_L1S_SUCCESS 1
378 #define PORT_RWE (1 << 3)
379 #define PORT_HIRD(p) (((p) & 0xf) << 4)
380 #define PORT_HIRD_MASK (0xf << 4)
381 #define PORT_L1DS(p) (((p) & 0xff) << 8)
382 #define PORT_HLE (1 << 16)
383 
408 };
409 
410 /* irq_pending bitmasks */
411 #define ER_IRQ_PENDING(p) ((p) & 0x1)
412 /* bits 2:31 need to be preserved */
413 /* THIS IS BUGGY - FIXME - IP IS WRITE 1 TO CLEAR */
414 #define ER_IRQ_CLEAR(p) ((p) & 0xfffffffe)
415 #define ER_IRQ_ENABLE(p) ((ER_IRQ_CLEAR(p)) | 0x2)
416 #define ER_IRQ_DISABLE(p) ((ER_IRQ_CLEAR(p)) & ~(0x2))
417 
418 /* irq_control bitmasks */
419 /* Minimum interval between interrupts (in 250ns intervals). The interval
420  * between interrupts will be longer if there are no events on the event ring.
421  * Default is 4000 (1 ms).
422  */
423 #define ER_IRQ_INTERVAL_MASK (0xffff)
424 /* Counter used to count down the time to the next interrupt - HW use only */
425 #define ER_IRQ_COUNTER_MASK (0xffff << 16)
426 
427 /* erst_size bitmasks */
428 /* Preserve bits 16:31 of erst_size */
429 #define ERST_SIZE_MASK (0xffff << 16)
430 
431 /* erst_dequeue bitmasks */
432 /* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
433  * where the current dequeue pointer lies. This is an optional HW hint.
434  */
435 #define ERST_DESI_MASK (0x7)
436 /* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
437  * a work queue (or delayed service routine)?
438  */
439 #define ERST_EHB (1 << 3)
440 #define ERST_PTR_MASK (0xf)
441 
454  struct xhci_intr_reg ir_set[128];
455 };
456 
468 };
469 
470 #define DB_VALUE(ep, stream) ((((ep) + 1) & 0xff) | ((stream) << 16))
471 #define DB_VALUE_HOST 0x00000000
472 
485 };
486 
487 #define XHCI_EXT_PORT_MAJOR(x) (((x) >> 24) & 0xff)
488 #define XHCI_EXT_PORT_OFF(x) ((x) & 0xff)
489 #define XHCI_EXT_PORT_COUNT(x) (((x) >> 8) & 0xff)
490 
502  unsigned type;
503 #define XHCI_CTX_TYPE_DEVICE 0x1
504 #define XHCI_CTX_TYPE_INPUT 0x2
505 
506  int size;
507 
510 };
511 
528  /* offset 0x10 to 0x1f reserved for HC internal use */
530 };
531 
532 /* dev_info bitmasks */
533 /* Route String - 0:19 */
534 #define ROUTE_STRING_MASK (0xfffff)
535 /* Device speed - values defined by PORTSC Device Speed field - 20:23 */
536 #define DEV_SPEED (0xf << 20)
537 /* bit 24 reserved */
538 /* Is this LS/FS device connected through a HS hub? - bit 25 */
539 #define DEV_MTT (0x1 << 25)
540 /* Set if the device is a hub - bit 26 */
541 #define DEV_HUB (0x1 << 26)
542 /* Index of the last valid endpoint context in this device context - 27:31 */
543 #define LAST_CTX_MASK (0x1f << 27)
544 #define LAST_CTX(p) ((p) << 27)
545 #define LAST_CTX_TO_EP_NUM(p) (((p) >> 27) - 1)
546 #define SLOT_FLAG (1 << 0)
547 #define EP0_FLAG (1 << 1)
548 
549 /* dev_info2 bitmasks */
550 /* Max Exit Latency (ms) - worst case time to wake up all links in dev path */
551 #define MAX_EXIT (0xffff)
552 /* Root hub port number that is needed to access the USB device */
553 #define ROOT_HUB_PORT(p) (((p) & 0xff) << 16)
554 #define DEVINFO_TO_ROOT_HUB_PORT(p) (((p) >> 16) & 0xff)
555 /* Maximum number of ports under a hub device */
556 #define XHCI_MAX_PORTS(p) (((p) & 0xff) << 24)
557 
558 /* tt_info bitmasks */
559 /*
560  * TT Hub Slot ID - for low or full speed devices attached to a high-speed hub
561  * The Slot ID of the hub that isolates the high speed signaling from
562  * this low or full-speed device. '0' if attached to root hub port.
563  */
564 #define TT_SLOT (0xff)
565 /*
566  * The number of the downstream facing port of the high-speed hub
567  * '0' if the device is not low or full speed.
568  */
569 #define TT_PORT (0xff << 8)
570 #define TT_THINK_TIME(p) (((p) & 0x3) << 16)
571 
572 /* dev_state bitmasks */
573 /* USB device address - assigned by the HC */
574 #define DEV_ADDR_MASK (0xff)
575 /* bits 8:26 reserved */
576 /* Slot state */
577 #define SLOT_STATE (0x1f << 27)
578 #define GET_SLOT_STATE(p) (((p) & (0x1f << 27)) >> 27)
579 
580 #define SLOT_STATE_DISABLED 0
581 #define SLOT_STATE_ENABLED SLOT_STATE_DISABLED
582 #define SLOT_STATE_DEFAULT 1
583 #define SLOT_STATE_ADDRESSED 2
584 #define SLOT_STATE_CONFIGURED 3
585 
604 struct xhci_ep_ctx {
609  /* offset 0x14 - 0x1f reserved for HC internal use */
611 };
612 
613 /* ep_info bitmasks */
614 /*
615  * Endpoint State - bits 0:2
616  * 0 - disabled
617  * 1 - running
618  * 2 - halted due to halt condition - ok to manipulate endpoint ring
619  * 3 - stopped
620  * 4 - TRB error
621  * 5-7 - reserved
622  */
623 #define EP_STATE_MASK (0xf)
624 #define EP_STATE_DISABLED 0
625 #define EP_STATE_RUNNING 1
626 #define EP_STATE_HALTED 2
627 #define EP_STATE_STOPPED 3
628 #define EP_STATE_ERROR 4
629 /* Mult - Max number of burtst within an interval, in EP companion desc. */
630 #define EP_MULT(p) (((p) & 0x3) << 8)
631 #define CTX_TO_EP_MULT(p) (((p) >> 8) & 0x3)
632 /* bits 10:14 are Max Primary Streams */
633 /* bit 15 is Linear Stream Array */
634 /* Interval - period between requests to an endpoint - 125u increments. */
635 #define EP_INTERVAL(p) (((p) & 0xff) << 16)
636 #define EP_INTERVAL_TO_UFRAMES(p) (1 << (((p) >> 16) & 0xff))
637 #define CTX_TO_EP_INTERVAL(p) (((p) >> 16) & 0xff)
638 #define EP_MAXPSTREAMS_MASK (0x1f << 10)
639 #define EP_MAXPSTREAMS(p) (((p) << 10) & EP_MAXPSTREAMS_MASK)
640 /* Endpoint is set up with a Linear Stream Array (vs. Secondary Stream Array) */
641 #define EP_HAS_LSA (1 << 15)
642 
643 /* ep_info2 bitmasks */
644 /*
645  * Force Event - generate transfer events for all TRBs for this endpoint
646  * This will tell the HC to ignore the IOC and ISP flags (for debugging only).
647  */
648 #define FORCE_EVENT (0x1)
649 #define ERROR_COUNT(p) (((p) & 0x3) << 1)
650 #define CTX_TO_EP_TYPE(p) (((p) >> 3) & 0x7)
651 #define EP_TYPE(p) ((p) << 3)
652 #define ISOC_OUT_EP 1
653 #define BULK_OUT_EP 2
654 #define INT_OUT_EP 3
655 #define CTRL_EP 4
656 #define ISOC_IN_EP 5
657 #define BULK_IN_EP 6
658 #define INT_IN_EP 7
659 /* bit 6 reserved */
660 /* bit 7 is Host Initiate Disable - for disabling stream selection */
661 #define MAX_BURST(p) (((p)&0xff) << 8)
662 #define CTX_TO_MAX_BURST(p) (((p) >> 8) & 0xff)
663 #define MAX_PACKET(p) (((p)&0xffff) << 16)
664 #define MAX_PACKET_MASK (0xffff << 16)
665 #define MAX_PACKET_DECODED(p) (((p) >> 16) & 0xffff)
666 
667 /* Get max packet size from ep desc. Bit 10..0 specify the max packet size.
668  * USB2.0 spec 9.6.6.
669  */
670 #define GET_MAX_PACKET(p) ((p) & 0x7ff)
671 
672 /* tx_info bitmasks */
673 #define AVG_TRB_LENGTH_FOR_EP(p) ((p) & 0xffff)
674 #define MAX_ESIT_PAYLOAD_FOR_EP(p) (((p) & 0xffff) << 16)
675 #define CTX_TO_MAX_ESIT_PAYLOAD(p) (((p) >> 16) & 0xffff)
676 
677 /* deq bitmasks */
678 #define EP_CTX_CYCLE_MASK (1 << 0)
679 
680 
692 };
693 
694 #define EP_IS_ADDED(ctrl_ctx, i) \
695  (le32_to_cpu(ctrl_ctx->add_flags) & (1 << (i + 1)))
696 #define EP_IS_DROPPED(ctrl_ctx, i) \
697  (le32_to_cpu(ctrl_ctx->drop_flags) & (1 << (i + 1)))
698 
699 /* Represents everything that is needed to issue a command on the command ring.
700  * It's useful to pre-allocate these for commands that cannot fail due to
701  * out-of-memory errors, like freeing streams.
702  */
703 struct xhci_command {
704  /* Input context for changing device state */
707  /* If completion is null, no one is waiting on this command
708  * and the structure can be freed after the command completes.
709  */
713 };
714 
715 /* drop context bitmasks */
716 #define DROP_EP(x) (0x1 << x)
717 /* add context bitmasks */
718 #define ADD_EP(x) (0x1 << x)
719 
721  /* 64-bit stream ring address, cycle state, and stream type */
723  /* offset 0x14 - 0x1f reserved for HC internal use */
725 };
726 
727 /* Stream Context Types (section 6.4.1) - bits 3:1 of stream ctx deq ptr */
728 #define SCT_FOR_CTX(p) (((p) << 1) & 0x7)
729 /* Secondary stream array type, dequeue pointer is to a transfer ring */
730 #define SCT_SEC_TR 0
731 /* Primary stream array type, dequeue pointer is to a transfer ring */
732 #define SCT_PRI_TR 1
733 /* Dequeue pointer is for a secondary stream array (SSA) with 8 entries */
734 #define SCT_SSA_8 2
735 #define SCT_SSA_16 3
736 #define SCT_SSA_32 4
737 #define SCT_SSA_64 5
738 #define SCT_SSA_128 6
739 #define SCT_SSA_256 7
740 
741 /* Assume no secondary streams for now */
744  /* Number of streams, including stream 0 (which drivers can't use) */
745  unsigned int num_streams;
746  /* The stream context array may be bigger than
747  * the number of streams the driver asked for
748  */
750  unsigned int num_stream_ctxs;
752  /* For mapping physical TRB addresses to segments in stream rings */
755 };
756 
757 #define SMALL_STREAM_ARRAY_SIZE 256
758 #define MEDIUM_STREAM_ARRAY_SIZE 1024
759 
760 /* Some Intel xHCI host controllers need software to keep track of the bus
761  * bandwidth. Keep track of endpoint info here. Each root port is allocated
762  * the full bus bandwidth. We must also treat TTs (including each port under a
763  * multi-TT hub) as a separate bandwidth domain. The direct memory interface
764  * (DMI) also limits the total bandwidth (across all domains) that can be used.
765  */
766 struct xhci_bw_info {
767  /* ep_interval is zero-based */
768  unsigned int ep_interval;
769  /* mult and num_packets are one-based */
770  unsigned int mult;
771  unsigned int num_packets;
772  unsigned int max_packet_size;
773  unsigned int max_esit_payload;
774  unsigned int type;
775 };
776 
777 /* "Block" sizes in bytes the hardware uses for different device speeds.
778  * The logic in this part of the hardware limits the number of bits the hardware
779  * can use, so must represent bandwidth in a less precise manner to mimic what
780  * the scheduler hardware computes.
781  */
782 #define FS_BLOCK 1
783 #define HS_BLOCK 4
784 #define SS_BLOCK 16
785 #define DMI_BLOCK 32
786 
787 /* Each device speed has a protocol overhead (CRC, bit stuffing, etc) associated
788  * with each byte transferred. SuperSpeed devices have an initial overhead to
789  * set up bursts. These are in blocks, see above. LS overhead has already been
790  * translated into FS blocks.
791  */
792 #define DMI_OVERHEAD 8
793 #define DMI_OVERHEAD_BURST 4
794 #define SS_OVERHEAD 8
795 #define SS_OVERHEAD_BURST 32
796 #define HS_OVERHEAD 26
797 #define FS_OVERHEAD 20
798 #define LS_OVERHEAD 128
799 /* The TTs need to claim roughly twice as much bandwidth (94 bytes per
800  * microframe ~= 24Mbps) of the HS bus as the devices can actually use because
801  * of overhead associated with split transfers crossing microframe boundaries.
802  * 31 blocks is pure protocol overhead.
803  */
804 #define TT_HS_OVERHEAD (31 + 94)
805 #define TT_DMI_OVERHEAD (25 + 12)
806 
807 /* Bandwidth limits in blocks */
808 #define FS_BW_LIMIT 1285
809 #define TT_BW_LIMIT 1320
810 #define HS_BW_LIMIT 1607
811 #define SS_BW_LIMIT_IN 3906
812 #define DMI_BW_LIMIT_IN 3906
813 #define SS_BW_LIMIT_OUT 3906
814 #define DMI_BW_LIMIT_OUT 3906
815 
816 /* Percentage of bus bandwidth reserved for non-periodic transfers */
817 #define FS_BW_RESERVED 10
818 #define HS_BW_RESERVED 20
819 #define SS_BW_RESERVED 10
820 
821 struct xhci_virt_ep {
822  struct xhci_ring *ring;
823  /* Related to endpoints that are configured to use stream IDs only */
825  /* Temporary storage in case the configure endpoint command fails and we
826  * have to restore the device state to the previous state
827  */
829  unsigned int ep_state;
830 #define SET_DEQ_PENDING (1 << 0)
831 #define EP_HALTED (1 << 1) /* For stall handling */
832 #define EP_HALT_PENDING (1 << 2) /* For URB cancellation */
833 /* Transitioning the endpoint to using streams, don't enqueue URBs */
834 #define EP_GETTING_STREAMS (1 << 3)
835 #define EP_HAS_STREAMS (1 << 4)
836 /* Transitioning the endpoint to not using streams, don't enqueue URBs */
837 #define EP_GETTING_NO_STREAMS (1 << 5)
838  /* ---- Related to URB cancellation ---- */
840  /* The TRB that was last reported in a stopped endpoint ring */
843  unsigned int stopped_stream;
844  /* Watchdog timer for stop endpoint command to cancel URBs */
847  struct xhci_hcd *xhci;
848  /* Dequeue pointer and dequeue segment for a submitted Set TR Dequeue
849  * command. We'll need to update the ring's dequeue segment and dequeue
850  * pointer after the command completes.
851  */
854  /*
855  * Sometimes the xHC can not process isochronous endpoint ring quickly
856  * enough, and it will miss some isoc tds on the ring and generate
857  * a Missed Service Error Event.
858  * Set skip flag when receive a Missed Service Error Event and
859  * process the missed tds on the endpoint ring.
860  */
861  bool skip;
862  /* Bandwidth checking storage */
865 };
866 
871 };
872 
874  unsigned int num_packets;
875  /* Sorted by max packet size.
876  * Head of the list is the greatest max packet size.
877  */
879  /* How many endpoints of each speed are present. */
880  unsigned int overhead[3];
881 };
882 
883 #define XHCI_MAX_INTERVAL 16
884 
888  /* Includes reserved bandwidth for async endpoints */
889  unsigned int bw_used;
890  unsigned int ss_bw_in;
891  unsigned int ss_bw_out;
892 };
893 
894 
896  struct usb_device *udev;
897  /*
898  * Commands to the hardware are passed an "input context" that
899  * tells the hardware what to change in its data structures.
900  * The hardware will return changes in an "output context" that
901  * software must allocate for the hardware. We need to keep
902  * track of input and output contexts separately because
903  * these commands might fail and we don't trust the hardware.
904  */
906  /* Used for addressing devices and configuration changes */
908  /* Rings saved to ensure old alt settings can be re-instated */
911  /* Store xHC assigned device address */
912  int address;
913 #define XHCI_MAX_RINGS_CACHED 31
914  struct xhci_virt_ep eps[31];
916  /* Status of the last command issued for this device */
923  /* The current max exit latency for the enabled USB3 link states. */
925 };
926 
927 /*
928  * For each roothub, keep track of the bandwidth information for each periodic
929  * interval.
930  *
931  * If a high speed hub is attached to the roothub, each TT associated with that
932  * hub is a separate bandwidth domain. The interval information for the
933  * endpoints on the devices under that TT will appear in the TT structure.
934  */
936  struct list_head tts;
937  unsigned int num_active_tts;
939 };
940 
943  int slot_id;
944  int ttport;
947 };
948 
949 
955  /* 64-bit device addresses; we only write 32-bit addresses */
957  /* private xHCD pointers */
959 };
960 /* TODO: write function to set the 64-bit device DMA address */
961 /*
962  * TODO: change this to be dynamically sized at HC mem init time since the HC
963  * might not be able to handle the maximum number of devices possible.
964  */
965 
966 
968  /* 64-bit buffer address, or immediate data */
971  /* This field is interpreted differently based on the type of TRB */
973 };
974 
976 #define TRB_TO_EP_ID(p) (((p) >> 16) & 0x1f)
977 
978 /* Completion Code - only applicable for some types of TRBs */
979 #define COMP_CODE_MASK (0xff << 24)
980 #define GET_COMP_CODE(p) (((p) & COMP_CODE_MASK) >> 24)
981 #define COMP_SUCCESS 1
982 /* Data Buffer Error */
983 #define COMP_DB_ERR 2
984 /* Babble Detected Error */
985 #define COMP_BABBLE 3
986 /* USB Transaction Error */
987 #define COMP_TX_ERR 4
988 /* TRB Error - some TRB field is invalid */
989 #define COMP_TRB_ERR 5
990 /* Stall Error - USB device is stalled */
991 #define COMP_STALL 6
992 /* Resource Error - HC doesn't have memory for that device configuration */
993 #define COMP_ENOMEM 7
994 /* Bandwidth Error - not enough room in schedule for this dev config */
995 #define COMP_BW_ERR 8
996 /* No Slots Available Error - HC ran out of device slots */
997 #define COMP_ENOSLOTS 9
998 /* Invalid Stream Type Error */
999 #define COMP_STREAM_ERR 10
1000 /* Slot Not Enabled Error - doorbell rung for disabled device slot */
1001 #define COMP_EBADSLT 11
1002 /* Endpoint Not Enabled Error */
1003 #define COMP_EBADEP 12
1004 /* Short Packet */
1005 #define COMP_SHORT_TX 13
1006 /* Ring Underrun - doorbell rung for an empty isoc OUT ep ring */
1007 #define COMP_UNDERRUN 14
1008 /* Ring Overrun - isoc IN ep ring is empty when ep is scheduled to RX */
1009 #define COMP_OVERRUN 15
1010 /* Virtual Function Event Ring Full Error */
1011 #define COMP_VF_FULL 16
1012 /* Parameter Error - Context parameter is invalid */
1013 #define COMP_EINVAL 17
1014 /* Bandwidth Overrun Error - isoc ep exceeded its allocated bandwidth */
1015 #define COMP_BW_OVER 18
1016 /* Context State Error - illegal context state transition requested */
1017 #define COMP_CTX_STATE 19
1018 /* No Ping Response Error - HC didn't get PING_RESPONSE in time to TX */
1019 #define COMP_PING_ERR 20
1020 /* Event Ring is full */
1021 #define COMP_ER_FULL 21
1022 /* Incompatible Device Error */
1023 #define COMP_DEV_ERR 22
1024 /* Missed Service Error - HC couldn't service an isoc ep within interval */
1025 #define COMP_MISSED_INT 23
1026 /* Successfully stopped command ring */
1027 #define COMP_CMD_STOP 24
1028 /* Successfully aborted current command and stopped command ring */
1029 #define COMP_CMD_ABORT 25
1030 /* Stopped - transfer was terminated by a stop endpoint command */
1031 #define COMP_STOP 26
1032 /* Same as COMP_EP_STOPPED, but the transferred length in the event is invalid */
1033 #define COMP_STOP_INVAL 27
1034 /* Control Abort Error - Debug Capability - control pipe aborted */
1035 #define COMP_DBG_ABORT 28
1036 /* Max Exit Latency Too Large Error */
1037 #define COMP_MEL_ERR 29
1038 /* TRB type 30 reserved */
1039 /* Isoc Buffer Overrun - an isoc IN ep sent more data than could fit in TD */
1040 #define COMP_BUFF_OVER 31
1041 /* Event Lost Error - xHC has an "internal event overrun condition" */
1042 #define COMP_ISSUES 32
1043 /* Undefined Error - reported when other error codes don't apply */
1044 #define COMP_UNKNOWN 33
1045 /* Invalid Stream ID Error */
1046 #define COMP_STRID_ERR 34
1047 /* Secondary Bandwidth Error - may be returned by a Configure Endpoint cmd */
1048 #define COMP_2ND_BW_ERR 35
1049 /* Split Transaction Error */
1050 #define COMP_SPLIT_ERR 36
1051 
1053  /* 64-bit segment pointer*/
1057 };
1058 
1059 /* control bitfields */
1060 #define LINK_TOGGLE (0x1<<1)
1061 
1062 /* Command completion event TRB */
1064  /* Pointer to command TRB, or the value passed by the event data trb */
1068 };
1069 
1070 /* flags bitmasks */
1071 /* bits 16:23 are the virtual function ID */
1072 /* bits 24:31 are the slot ID */
1073 #define TRB_TO_SLOT_ID(p) (((p) & (0xff<<24)) >> 24)
1074 #define SLOT_ID_FOR_TRB(p) (((p) & 0xff) << 24)
1075 
1076 /* Stop Endpoint TRB - ep_index to endpoint ID for this TRB */
1077 #define TRB_TO_EP_INDEX(p) ((((p) & (0x1f << 16)) >> 16) - 1)
1078 #define EP_ID_FOR_TRB(p) ((((p) + 1) & 0x1f) << 16)
1079 
1080 #define SUSPEND_PORT_FOR_TRB(p) (((p) & 1) << 23)
1081 #define TRB_TO_SUSPEND_PORT(p) (((p) & (1 << 23)) >> 23)
1082 #define LAST_EP_INDEX 30
1083 
1084 /* Set TR Dequeue Pointer command TRB fields */
1085 #define TRB_TO_STREAM_ID(p) ((((p) & (0xffff << 16)) >> 16))
1086 #define STREAM_ID_FOR_TRB(p) ((((p)) & 0xffff) << 16)
1087 
1088 
1089 /* Port Status Change Event TRB fields */
1090 /* Port ID - bits 31:24 */
1091 #define GET_PORT_ID(p) (((p) & (0xff << 24)) >> 24)
1092 
1093 /* Normal TRB fields */
1094 /* transfer_len bitmasks - bits 0:16 */
1095 #define TRB_LEN(p) ((p) & 0x1ffff)
1096 /* Interrupter Target - which MSI-X vector to target the completion event at */
1097 #define TRB_INTR_TARGET(p) (((p) & 0x3ff) << 22)
1098 #define GET_INTR_TARGET(p) (((p) >> 22) & 0x3ff)
1099 #define TRB_TBC(p) (((p) & 0x3) << 7)
1100 #define TRB_TLBPC(p) (((p) & 0xf) << 16)
1101 
1102 /* Cycle bit - indicates TRB ownership by HC or HCD */
1103 #define TRB_CYCLE (1<<0)
1104 /*
1105  * Force next event data TRB to be evaluated before task switch.
1106  * Used to pass OS data back after a TD completes.
1107  */
1108 #define TRB_ENT (1<<1)
1109 /* Interrupt on short packet */
1110 #define TRB_ISP (1<<2)
1111 /* Set PCIe no snoop attribute */
1112 #define TRB_NO_SNOOP (1<<3)
1113 /* Chain multiple TRBs into a TD */
1114 #define TRB_CHAIN (1<<4)
1115 /* Interrupt on completion */
1116 #define TRB_IOC (1<<5)
1117 /* The buffer pointer contains immediate data */
1118 #define TRB_IDT (1<<6)
1119 
1120 /* Block Event Interrupt */
1121 #define TRB_BEI (1<<9)
1122 
1123 /* Control transfer TRB specific fields */
1124 #define TRB_DIR_IN (1<<16)
1125 #define TRB_TX_TYPE(p) ((p) << 16)
1126 #define TRB_DATA_OUT 2
1127 #define TRB_DATA_IN 3
1128 
1129 /* Isochronous TRB specific fields */
1130 #define TRB_SIA (1<<31)
1131 
1134 };
1135 
1136 union xhci_trb {
1141 };
1142 
1143 /* TRB bit mask */
1144 #define TRB_TYPE_BITMASK (0xfc00)
1145 #define TRB_TYPE(p) ((p) << 10)
1146 #define TRB_FIELD_TO_TYPE(p) (((p) & TRB_TYPE_BITMASK) >> 10)
1147 /* TRB type IDs */
1148 /* bulk, interrupt, isoc scatter/gather, and control data stage */
1149 #define TRB_NORMAL 1
1150 /* setup stage for control transfers */
1151 #define TRB_SETUP 2
1152 /* data stage for control transfers */
1153 #define TRB_DATA 3
1154 /* status stage for control transfers */
1155 #define TRB_STATUS 4
1156 /* isoc transfers */
1157 #define TRB_ISOC 5
1158 /* TRB for linking ring segments */
1159 #define TRB_LINK 6
1160 #define TRB_EVENT_DATA 7
1161 /* Transfer Ring No-op (not for the command ring) */
1162 #define TRB_TR_NOOP 8
1163 /* Command TRBs */
1164 /* Enable Slot Command */
1165 #define TRB_ENABLE_SLOT 9
1166 /* Disable Slot Command */
1167 #define TRB_DISABLE_SLOT 10
1168 /* Address Device Command */
1169 #define TRB_ADDR_DEV 11
1170 /* Configure Endpoint Command */
1171 #define TRB_CONFIG_EP 12
1172 /* Evaluate Context Command */
1173 #define TRB_EVAL_CONTEXT 13
1174 /* Reset Endpoint Command */
1175 #define TRB_RESET_EP 14
1176 /* Stop Transfer Ring Command */
1177 #define TRB_STOP_RING 15
1178 /* Set Transfer Ring Dequeue Pointer Command */
1179 #define TRB_SET_DEQ 16
1180 /* Reset Device Command */
1181 #define TRB_RESET_DEV 17
1182 /* Force Event Command (opt) */
1183 #define TRB_FORCE_EVENT 18
1184 /* Negotiate Bandwidth Command (opt) */
1185 #define TRB_NEG_BANDWIDTH 19
1186 /* Set Latency Tolerance Value Command (opt) */
1187 #define TRB_SET_LT 20
1188 /* Get port bandwidth Command */
1189 #define TRB_GET_BW 21
1190 /* Force Header Command - generate a transaction or link management packet */
1191 #define TRB_FORCE_HEADER 22
1192 /* No-op Command - not for transfer rings */
1193 #define TRB_CMD_NOOP 23
1194 /* TRB IDs 24-31 reserved */
1195 /* Event TRBS */
1196 /* Transfer Event */
1197 #define TRB_TRANSFER 32
1198 /* Command Completion Event */
1199 #define TRB_COMPLETION 33
1200 /* Port Status Change Event */
1201 #define TRB_PORT_STATUS 34
1202 /* Bandwidth Request Event (opt) */
1203 #define TRB_BANDWIDTH_EVENT 35
1204 /* Doorbell Event (opt) */
1205 #define TRB_DOORBELL 36
1206 /* Host Controller Event */
1207 #define TRB_HC_EVENT 37
1208 /* Device Notification Event - device sent function wake notification */
1209 #define TRB_DEV_NOTE 38
1210 /* MFINDEX Wrap Event - microframe counter wrapped */
1211 #define TRB_MFINDEX_WRAP 39
1212 /* TRB IDs 40-47 reserved, 48-63 is vendor-defined */
1213 
1214 /* Nec vendor-specific command completion event. */
1215 #define TRB_NEC_CMD_COMP 48
1216 /* Get NEC firmware revision. */
1217 #define TRB_NEC_GET_FW 49
1218 
1219 #define TRB_TYPE_LINK(x) (((x) & TRB_TYPE_BITMASK) == TRB_TYPE(TRB_LINK))
1220 /* Above, but for __le32 types -- can avoid work by swapping constants: */
1221 #define TRB_TYPE_LINK_LE32(x) (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1222  cpu_to_le32(TRB_TYPE(TRB_LINK)))
1223 #define TRB_TYPE_NOOP_LE32(x) (((x) & cpu_to_le32(TRB_TYPE_BITMASK)) == \
1224  cpu_to_le32(TRB_TYPE(TRB_TR_NOOP)))
1225 
1226 #define NEC_FW_MINOR(p) (((p) >> 0) & 0xff)
1227 #define NEC_FW_MAJOR(p) (((p) >> 8) & 0xff)
1228 
1229 /*
1230  * TRBS_PER_SEGMENT must be a multiple of 4,
1231  * since the command ring is 64-byte aligned.
1232  * It must also be greater than 16.
1233  */
1234 #define TRBS_PER_SEGMENT 64
1235 /* Allow two commands + a link TRB, along with any reserved command TRBs */
1236 #define MAX_RSVD_CMD_TRBS (TRBS_PER_SEGMENT - 3)
1237 #define SEGMENT_SIZE (TRBS_PER_SEGMENT*16)
1238 #define SEGMENT_SHIFT (__ffs(SEGMENT_SIZE))
1239 /* TRB buffer pointers can't cross 64KB boundaries */
1240 #define TRB_MAX_BUFF_SHIFT 16
1241 #define TRB_MAX_BUFF_SIZE (1 << TRB_MAX_BUFF_SHIFT)
1242 
1244  union xhci_trb *trbs;
1245  /* private to HCD */
1248 };
1249 
1250 struct xhci_td {
1253  struct urb *urb;
1257 };
1258 
1259 /* xHCI command default timeout value */
1260 #define XHCI_CMD_DEFAULT_TIMEOUT (5 * HZ)
1261 
1262 /* command descriptor */
1263 struct xhci_cd {
1267 };
1268 
1273 };
1274 
1283 };
1284 
1285 struct xhci_ring {
1290  unsigned int enq_updates;
1293  unsigned int deq_updates;
1295  /*
1296  * Write the cycle state into the TRB cycle field to give ownership of
1297  * the TRB to the host controller (if we are the producer), or to check
1298  * if we own the TRB (if we are the consumer). See section 4.9.1.
1299  */
1301  unsigned int stream_id;
1302  unsigned int num_segs;
1303  unsigned int num_trbs_free;
1304  unsigned int num_trbs_free_temp;
1307 };
1308 
1310  /* 64-bit event ring segment address */
1313  /* Set to zero */
1315 };
1316 
1317 struct xhci_erst {
1319  unsigned int num_entries;
1320  /* xhci->event_ring keeps track of segment dma addresses */
1322  /* Num entries the ERST can contain */
1323  unsigned int erst_size;
1324 };
1325 
1329  void **sp_buffers;
1331 };
1332 
1333 struct urb_priv {
1334  int length;
1335  int td_cnt;
1336  struct xhci_td *td[0];
1337 };
1338 
1339 /*
1340  * Each segment table entry is 4*32bits long. 1K seems like an ok size:
1341  * (1K bytes * 8bytes/bit) / (4*32 bits) = 64 segment entries in the table,
1342  * meaning 64 ring segments.
1343  * Initial allocated size of the ERST, in number of entries */
1344 #define ERST_NUM_SEGS 1
1345 /* Initial allocated size of the ERST, in number of entries */
1346 #define ERST_SIZE 64
1347 /* Initial number of event segment rings allocated */
1348 #define ERST_ENTRIES 1
1349 /* Poll every 60 seconds */
1350 #define POLL_TIMEOUT 60
1351 /* Stop endpoint command timeout (secs) for URB cancellation watchdog timer */
1352 #define XHCI_STOP_EP_CMD_TIMEOUT 5
1353 /* XXX: Make these module parameters */
1354 
1355 struct s3_save {
1365 };
1366 
1367 /* Use for lpm */
1368 struct dev_info {
1370  struct list_head list;
1371 };
1372 
1374  unsigned long bus_suspended;
1375  unsigned long next_statechange;
1376 
1377  /* Port suspend arrays are indexed by the portnum of the fake roothub */
1378  /* ports suspend status arrays - max 31 ports for USB2, 15 for USB3 */
1382  unsigned long resume_done[USB_MAXCHILDREN];
1383  /* which ports have started to resume */
1384  unsigned long resuming_ports;
1385 };
1386 
1387 static inline unsigned int hcd_index(struct usb_hcd *hcd)
1388 {
1389  if (hcd->speed == HCD_USB3)
1390  return 0;
1391  else
1392  return 1;
1393 }
1394 
1395 /* There is one xhci_hcd structure per controller */
1396 struct xhci_hcd {
1397  struct usb_hcd *main_hcd;
1398  struct usb_hcd *shared_hcd;
1399  /* glue to PCI and HCD framework */
1404  /* Our HCD's current interrupter register set */
1406 
1407  /* Cached register copies of read-only HC data */
1412 
1414 
1415  /* packed release number */
1423  int addr_64;
1424  /* 4KB min, 128MB max */
1426  /* Valid values are 12 to 20, inclusive */
1428  /* msi-x vectors */
1430  struct msix_entry *msix_entries;
1431  /* data structures */
1434  unsigned int cmd_ring_state;
1435 #define CMD_RING_STATE_RUNNING (1 << 0)
1436 #define CMD_RING_STATE_ABORTED (1 << 1)
1437 #define CMD_RING_STATE_STOPPED (1 << 2)
1441  struct xhci_erst erst;
1442  /* Scratchpad */
1444  /* Store LPM test failed devices' information */
1446 
1447  /* slot enabling and address device helpers */
1449  int slot_id;
1450  /* For USB 3.0 LPM enable/disable. */
1452  /* Internal mirror of the HW's dcbaa */
1454  /* For keeping track of bandwidth domains per roothub. */
1456 
1457  /* DMA pools */
1462 
1463 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1464  /* Poll the rings - for debugging */
1465  struct timer_list event_ring_timer;
1466  int zombie;
1467 #endif
1468  /* Host controller watchdog timer structures */
1469  unsigned int xhc_state;
1470 
1472  struct s3_save s3;
1473 /* Host controller is dying - not responding to commands. "I'm not dead yet!"
1474  *
1475  * xHC interrupts have been disabled and a watchdog timer will (or has already)
1476  * halt the xHCI host, and complete all URBs with an -ESHUTDOWN code. Any code
1477  * that sees this status (other than the timer that set it) should stop touching
1478  * hardware immediately. Interrupt handlers should return immediately when
1479  * they see this status (any time they drop and re-acquire xhci->lock).
1480  * xhci_urb_dequeue() should call usb_hcd_check_unlink_urb() and return without
1481  * putting the TD on the canceled list, etc.
1482  *
1483  * There are no reports of xHCI host controllers that display this issue.
1484  */
1485 #define XHCI_STATE_DYING (1 << 0)
1486 #define XHCI_STATE_HALTED (1 << 1)
1487  /* Statistics */
1489  unsigned int quirks;
1490 #define XHCI_LINK_TRB_QUIRK (1 << 0)
1491 #define XHCI_RESET_EP_QUIRK (1 << 1)
1492 #define XHCI_NEC_HOST (1 << 2)
1493 #define XHCI_AMD_PLL_FIX (1 << 3)
1494 #define XHCI_SPURIOUS_SUCCESS (1 << 4)
1495 /*
1496  * Certain Intel host controllers have a limit to the number of endpoint
1497  * contexts they can handle. Ideally, they would signal that they can't handle
1498  * anymore endpoint contexts by returning a Resource Error for the Configure
1499  * Endpoint command, but they don't. Instead they expect software to keep track
1500  * of the number of active endpoints for them, across configure endpoint
1501  * commands, reset device commands, disable slot commands, and address device
1502  * commands.
1503  */
1504 #define XHCI_EP_LIMIT_QUIRK (1 << 5)
1505 #define XHCI_BROKEN_MSI (1 << 6)
1506 #define XHCI_RESET_ON_RESUME (1 << 7)
1507 #define XHCI_SW_BW_CHECKING (1 << 8)
1508 #define XHCI_AMD_0x96_HOST (1 << 9)
1509 #define XHCI_TRUST_TX_LENGTH (1 << 10)
1510 #define XHCI_LPM_SUPPORT (1 << 11)
1511 #define XHCI_INTEL_HOST (1 << 12)
1512 #define XHCI_SPURIOUS_REBOOT (1 << 13)
1513 #define XHCI_COMP_MODE_QUIRK (1 << 14)
1514 #define XHCI_AVOID_BEI (1 << 15)
1515  unsigned int num_active_eps;
1516  unsigned int limit_active_eps;
1517  /* There are two roothubs to keep track of bus suspend info for */
1519  /* Is each xHCI roothub port a USB 3.0, USB 2.0, or USB 1.1 port? */
1521  /* Array of pointers to USB 3.0 PORTSC registers */
1523  unsigned int num_usb3_ports;
1524  /* Array of pointers to USB 2.0 PORTSC registers */
1526  unsigned int num_usb2_ports;
1527  /* support xHCI 0.96 spec USB2 software LPM */
1528  unsigned sw_lpm_support:1;
1529  /* support xHCI 1.0 spec USB2 hardware LPM */
1530  unsigned hw_lpm_support:1;
1531  /* Compliance Mode Recovery Data */
1534 /* Compliance Mode Timer Triggered every 2 seconds */
1535 #define COMP_MODE_RCVRY_MSECS 2000
1536 };
1537 
1538 /* convert between an HCD pointer and the corresponding EHCI_HCD */
1539 static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
1540 {
1541  return *((struct xhci_hcd **) (hcd->hcd_priv));
1542 }
1543 
1544 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
1545 {
1546  return xhci->main_hcd;
1547 }
1548 
1549 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1550 #define XHCI_DEBUG 1
1551 #else
1552 #define XHCI_DEBUG 0
1553 #endif
1554 
1555 #define xhci_dbg(xhci, fmt, args...) \
1556  do { if (XHCI_DEBUG) dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1557 #define xhci_info(xhci, fmt, args...) \
1558  do { if (XHCI_DEBUG) dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
1559 #define xhci_err(xhci, fmt, args...) \
1560  dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1561 #define xhci_warn(xhci, fmt, args...) \
1562  dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1563 #define xhci_warn_ratelimited(xhci, fmt, args...) \
1564  dev_warn_ratelimited(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
1565 
1566 /* TODO: copied from ehci.h - can be refactored? */
1567 /* xHCI spec says all registers are little endian */
1568 static inline unsigned int xhci_readl(const struct xhci_hcd *xhci,
1569  __le32 __iomem *regs)
1570 {
1571  return readl(regs);
1572 }
1573 static inline void xhci_writel(struct xhci_hcd *xhci,
1574  const unsigned int val, __le32 __iomem *regs)
1575 {
1576  writel(val, regs);
1577 }
1578 
1579 /*
1580  * Registers should always be accessed with double word or quad word accesses.
1581  *
1582  * Some xHCI implementations may support 64-bit address pointers. Registers
1583  * with 64-bit address pointers should be written to with dword accesses by
1584  * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
1585  * xHCI implementations that do not support 64-bit address pointers will ignore
1586  * the high dword, and write order is irrelevant.
1587  */
1588 static inline u64 xhci_read_64(const struct xhci_hcd *xhci,
1589  __le64 __iomem *regs)
1590 {
1591  __u32 __iomem *ptr = (__u32 __iomem *) regs;
1592  u64 val_lo = readl(ptr);
1593  u64 val_hi = readl(ptr + 1);
1594  return val_lo + (val_hi << 32);
1595 }
1596 static inline void xhci_write_64(struct xhci_hcd *xhci,
1597  const u64 val, __le64 __iomem *regs)
1598 {
1599  __u32 __iomem *ptr = (__u32 __iomem *) regs;
1600  u32 val_lo = lower_32_bits(val);
1601  u32 val_hi = upper_32_bits(val);
1602 
1603  writel(val_lo, ptr);
1604  writel(val_hi, ptr + 1);
1605 }
1606 
1607 static inline int xhci_link_trb_quirk(struct xhci_hcd *xhci)
1608 {
1609  return xhci->quirks & XHCI_LINK_TRB_QUIRK;
1610 }
1611 
1612 /* xHCI debugging */
1613 void xhci_print_ir_set(struct xhci_hcd *xhci, int set_num);
1614 void xhci_print_registers(struct xhci_hcd *xhci);
1615 void xhci_dbg_regs(struct xhci_hcd *xhci);
1616 void xhci_print_run_regs(struct xhci_hcd *xhci);
1617 void xhci_print_trb_offsets(struct xhci_hcd *xhci, union xhci_trb *trb);
1618 void xhci_debug_trb(struct xhci_hcd *xhci, union xhci_trb *trb);
1619 void xhci_debug_segment(struct xhci_hcd *xhci, struct xhci_segment *seg);
1620 void xhci_debug_ring(struct xhci_hcd *xhci, struct xhci_ring *ring);
1621 void xhci_dbg_erst(struct xhci_hcd *xhci, struct xhci_erst *erst);
1622 void xhci_dbg_cmd_ptrs(struct xhci_hcd *xhci);
1623 void xhci_dbg_ring_ptrs(struct xhci_hcd *xhci, struct xhci_ring *ring);
1624 void xhci_dbg_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int last_ep);
1625 char *xhci_get_slot_state(struct xhci_hcd *xhci,
1626  struct xhci_container_ctx *ctx);
1627 void xhci_dbg_ep_rings(struct xhci_hcd *xhci,
1628  unsigned int slot_id, unsigned int ep_index,
1629  struct xhci_virt_ep *ep);
1630 
1631 /* xHCI memory management */
1632 void xhci_mem_cleanup(struct xhci_hcd *xhci);
1633 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
1634 void xhci_free_virt_device(struct xhci_hcd *xhci, int slot_id);
1635 int xhci_alloc_virt_device(struct xhci_hcd *xhci, int slot_id, struct usb_device *udev, gfp_t flags);
1636 int xhci_setup_addressable_virt_dev(struct xhci_hcd *xhci, struct usb_device *udev);
1638  struct usb_device *udev);
1641 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index);
1642 unsigned int xhci_last_valid_endpoint(u32 added_ctxs);
1643 void xhci_endpoint_zero(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev, struct usb_host_endpoint *ep);
1644 void xhci_drop_ep_from_interval_table(struct xhci_hcd *xhci,
1645  struct xhci_bw_info *ep_bw,
1646  struct xhci_interval_bw_table *bw_table,
1647  struct usb_device *udev,
1648  struct xhci_virt_ep *virt_ep,
1649  struct xhci_tt_bw_info *tt_info);
1650 void xhci_update_tt_active_eps(struct xhci_hcd *xhci,
1651  struct xhci_virt_device *virt_dev,
1652  int old_active_eps);
1653 void xhci_clear_endpoint_bw_info(struct xhci_bw_info *bw_info);
1654 void xhci_update_bw_info(struct xhci_hcd *xhci,
1655  struct xhci_container_ctx *in_ctx,
1657  struct xhci_virt_device *virt_dev);
1658 void xhci_endpoint_copy(struct xhci_hcd *xhci,
1659  struct xhci_container_ctx *in_ctx,
1660  struct xhci_container_ctx *out_ctx,
1661  unsigned int ep_index);
1662 void xhci_slot_copy(struct xhci_hcd *xhci,
1663  struct xhci_container_ctx *in_ctx,
1664  struct xhci_container_ctx *out_ctx);
1665 int xhci_endpoint_init(struct xhci_hcd *xhci, struct xhci_virt_device *virt_dev,
1666  struct usb_device *udev, struct usb_host_endpoint *ep,
1667  gfp_t mem_flags);
1668 void xhci_ring_free(struct xhci_hcd *xhci, struct xhci_ring *ring);
1669 int xhci_ring_expansion(struct xhci_hcd *xhci, struct xhci_ring *ring,
1670  unsigned int num_trbs, gfp_t flags);
1671 void xhci_free_or_cache_endpoint_ring(struct xhci_hcd *xhci,
1672  struct xhci_virt_device *virt_dev,
1673  unsigned int ep_index);
1674 struct xhci_stream_info *xhci_alloc_stream_info(struct xhci_hcd *xhci,
1675  unsigned int num_stream_ctxs,
1676  unsigned int num_streams, gfp_t flags);
1677 void xhci_free_stream_info(struct xhci_hcd *xhci,
1678  struct xhci_stream_info *stream_info);
1679 void xhci_setup_streams_ep_input_ctx(struct xhci_hcd *xhci,
1680  struct xhci_ep_ctx *ep_ctx,
1681  struct xhci_stream_info *stream_info);
1683  struct xhci_ep_ctx *ep_ctx,
1684  struct xhci_virt_ep *ep);
1686  struct xhci_virt_device *virt_dev, bool drop_control_ep);
1688  struct xhci_virt_ep *ep,
1689  u64 address);
1691  struct xhci_virt_device *dev,
1692  unsigned int ep_index,
1693  unsigned int stream_id);
1694 struct xhci_command *xhci_alloc_command(struct xhci_hcd *xhci,
1695  bool allocate_in_ctx, bool allocate_completion,
1696  gfp_t mem_flags);
1697 void xhci_urb_free_priv(struct xhci_hcd *xhci, struct urb_priv *urb_priv);
1698 void xhci_free_command(struct xhci_hcd *xhci,
1699  struct xhci_command *command);
1700 
1701 #ifdef CONFIG_PCI
1702 /* xHCI PCI glue */
1703 int xhci_register_pci(void);
1704 void xhci_unregister_pci(void);
1705 #else
1706 static inline int xhci_register_pci(void) { return 0; }
1707 static inline void xhci_unregister_pci(void) {}
1708 #endif
1709 
1710 #if defined(CONFIG_USB_XHCI_PLATFORM) \
1711  || defined(CONFIG_USB_XHCI_PLATFORM_MODULE)
1712 int xhci_register_plat(void);
1713 void xhci_unregister_plat(void);
1714 #else
1715 static inline int xhci_register_plat(void)
1716 { return 0; }
1717 static inline void xhci_unregister_plat(void)
1718 { }
1719 #endif
1720 
1721 /* xHCI host controller glue */
1722 typedef void (*xhci_get_quirks_t)(struct device *, struct xhci_hcd *);
1723 int handshake(struct xhci_hcd *xhci, void __iomem *ptr,
1724  u32 mask, u32 done, int usec);
1725 void xhci_quiesce(struct xhci_hcd *xhci);
1726 int xhci_halt(struct xhci_hcd *xhci);
1727 int xhci_reset(struct xhci_hcd *xhci);
1728 int xhci_init(struct usb_hcd *hcd);
1729 int xhci_run(struct usb_hcd *hcd);
1730 void xhci_stop(struct usb_hcd *hcd);
1731 void xhci_shutdown(struct usb_hcd *hcd);
1732 int xhci_gen_setup(struct usb_hcd *hcd, xhci_get_quirks_t get_quirks);
1733 
1734 #ifdef CONFIG_PM
1735 int xhci_suspend(struct xhci_hcd *xhci);
1736 int xhci_resume(struct xhci_hcd *xhci, bool hibernated);
1737 #else
1738 #define xhci_suspend NULL
1739 #define xhci_resume NULL
1740 #endif
1741 
1742 int xhci_get_frame(struct usb_hcd *hcd);
1743 irqreturn_t xhci_irq(struct usb_hcd *hcd);
1744 irqreturn_t xhci_msi_irq(int irq, struct usb_hcd *hcd);
1745 int xhci_alloc_dev(struct usb_hcd *hcd, struct usb_device *udev);
1746 void xhci_free_dev(struct usb_hcd *hcd, struct usb_device *udev);
1747 int xhci_alloc_tt_info(struct xhci_hcd *xhci,
1748  struct xhci_virt_device *virt_dev,
1749  struct usb_device *hdev,
1750  struct usb_tt *tt, gfp_t mem_flags);
1751 int xhci_alloc_streams(struct usb_hcd *hcd, struct usb_device *udev,
1752  struct usb_host_endpoint **eps, unsigned int num_eps,
1753  unsigned int num_streams, gfp_t mem_flags);
1754 int xhci_free_streams(struct usb_hcd *hcd, struct usb_device *udev,
1755  struct usb_host_endpoint **eps, unsigned int num_eps,
1756  gfp_t mem_flags);
1757 int xhci_address_device(struct usb_hcd *hcd, struct usb_device *udev);
1758 int xhci_update_device(struct usb_hcd *hcd, struct usb_device *udev);
1759 int xhci_set_usb2_hardware_lpm(struct usb_hcd *hcd,
1760  struct usb_device *udev, int enable);
1761 int xhci_update_hub_device(struct usb_hcd *hcd, struct usb_device *hdev,
1762  struct usb_tt *tt, gfp_t mem_flags);
1763 int xhci_urb_enqueue(struct usb_hcd *hcd, struct urb *urb, gfp_t mem_flags);
1764 int xhci_urb_dequeue(struct usb_hcd *hcd, struct urb *urb, int status);
1765 int xhci_add_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1766 int xhci_drop_endpoint(struct usb_hcd *hcd, struct usb_device *udev, struct usb_host_endpoint *ep);
1767 void xhci_endpoint_reset(struct usb_hcd *hcd, struct usb_host_endpoint *ep);
1768 int xhci_discover_or_reset_device(struct usb_hcd *hcd, struct usb_device *udev);
1769 int xhci_check_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1770 void xhci_reset_bandwidth(struct usb_hcd *hcd, struct usb_device *udev);
1771 
1772 /* xHCI ring, segment, TRB, and TD functions */
1774 struct xhci_segment *trb_in_td(struct xhci_segment *start_seg,
1775  union xhci_trb *start_trb, union xhci_trb *end_trb,
1776  dma_addr_t suspect_dma);
1777 int xhci_is_vendor_info_code(struct xhci_hcd *xhci, unsigned int trb_comp_code);
1778 void xhci_ring_cmd_db(struct xhci_hcd *xhci);
1779 int xhci_queue_slot_control(struct xhci_hcd *xhci, u32 trb_type, u32 slot_id);
1780 int xhci_queue_address_device(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1781  u32 slot_id);
1782 int xhci_queue_vendor_command(struct xhci_hcd *xhci,
1783  u32 field1, u32 field2, u32 field3, u32 field4);
1784 int xhci_queue_stop_endpoint(struct xhci_hcd *xhci, int slot_id,
1785  unsigned int ep_index, int suspend);
1786 int xhci_queue_ctrl_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1787  int slot_id, unsigned int ep_index);
1788 int xhci_queue_bulk_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1789  int slot_id, unsigned int ep_index);
1790 int xhci_queue_intr_tx(struct xhci_hcd *xhci, gfp_t mem_flags, struct urb *urb,
1791  int slot_id, unsigned int ep_index);
1792 int xhci_queue_isoc_tx_prepare(struct xhci_hcd *xhci, gfp_t mem_flags,
1793  struct urb *urb, int slot_id, unsigned int ep_index);
1794 int xhci_queue_configure_endpoint(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1795  u32 slot_id, bool command_must_succeed);
1796 int xhci_queue_evaluate_context(struct xhci_hcd *xhci, dma_addr_t in_ctx_ptr,
1797  u32 slot_id, bool command_must_succeed);
1798 int xhci_queue_reset_ep(struct xhci_hcd *xhci, int slot_id,
1799  unsigned int ep_index);
1800 int xhci_queue_reset_device(struct xhci_hcd *xhci, u32 slot_id);
1801 void xhci_find_new_dequeue_state(struct xhci_hcd *xhci,
1802  unsigned int slot_id, unsigned int ep_index,
1803  unsigned int stream_id, struct xhci_td *cur_td,
1804  struct xhci_dequeue_state *state);
1805 void xhci_queue_new_dequeue_state(struct xhci_hcd *xhci,
1806  unsigned int slot_id, unsigned int ep_index,
1807  unsigned int stream_id,
1808  struct xhci_dequeue_state *deq_state);
1809 void xhci_cleanup_stalled_ring(struct xhci_hcd *xhci,
1810  struct usb_device *udev, unsigned int ep_index);
1811 void xhci_queue_config_ep_quirk(struct xhci_hcd *xhci,
1812  unsigned int slot_id, unsigned int ep_index,
1813  struct xhci_dequeue_state *deq_state);
1814 void xhci_stop_endpoint_command_watchdog(unsigned long arg);
1815 int xhci_cancel_cmd(struct xhci_hcd *xhci, struct xhci_command *command,
1816  union xhci_trb *cmd_trb);
1817 void xhci_ring_ep_doorbell(struct xhci_hcd *xhci, unsigned int slot_id,
1818  unsigned int ep_index, unsigned int stream_id);
1819 
1820 /* xHCI roothub code */
1821 void xhci_set_link_state(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1822  int port_id, u32 link_state);
1823 int xhci_enable_usb3_lpm_timeout(struct usb_hcd *hcd,
1824  struct usb_device *udev, enum usb3_link_state state);
1825 int xhci_disable_usb3_lpm_timeout(struct usb_hcd *hcd,
1826  struct usb_device *udev, enum usb3_link_state state);
1827 void xhci_test_and_clear_bit(struct xhci_hcd *xhci, __le32 __iomem **port_array,
1828  int port_id, u32 port_bit);
1829 int xhci_hub_control(struct usb_hcd *hcd, u16 typeReq, u16 wValue, u16 wIndex,
1830  char *buf, u16 wLength);
1831 int xhci_hub_status_data(struct usb_hcd *hcd, char *buf);
1832 
1833 #ifdef CONFIG_PM
1834 int xhci_bus_suspend(struct usb_hcd *hcd);
1835 int xhci_bus_resume(struct usb_hcd *hcd);
1836 #else
1837 #define xhci_bus_suspend NULL
1838 #define xhci_bus_resume NULL
1839 #endif /* CONFIG_PM */
1840 
1842 int xhci_find_slot_id_by_port(struct usb_hcd *hcd, struct xhci_hcd *xhci,
1843  u16 port);
1844 void xhci_ring_device(struct xhci_hcd *xhci, int slot_id);
1845 
1846 /* xHCI contexts */
1848 struct xhci_slot_ctx *xhci_get_slot_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx);
1849 struct xhci_ep_ctx *xhci_get_ep_ctx(struct xhci_hcd *xhci, struct xhci_container_ctx *ctx, unsigned int ep_index);
1850 
1851 #endif /* __LINUX_XHCI_HCD_H */