2 * xHCI host controller driver
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
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.
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
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.
23 #ifndef __LINUX_XHCI_HCD_H
24 #define __LINUX_XHCI_HCD_H
26 #include <linux/usb.h>
28 #include "../core/hcd.h"
29 /* Code sharing between pci-quirks and xhci hcd */
30 #include "xhci-ext-caps.h"
32 /* xHCI PCI Configuration Registers */
33 #define XHCI_SBRN_OFFSET (0x60)
35 /* Max number of USB devices for any host controller - limit in section 6.1 */
36 #define MAX_HC_SLOTS 256
39 * xHCI register interface.
40 * This corresponds to the eXtensible Host Controller Interface (xHCI)
41 * Revision 0.95 specification
43 * Registers should always be accessed with double word or quad word accesses.
45 * Some xHCI implementations may support 64-bit address pointers. Registers
46 * with 64-bit address pointers should be written to with dword accesses by
47 * writing the low dword first (ptr[0]), then the high dword (ptr[1]) second.
48 * xHCI implementations that do not support 64-bit address pointers will ignore
49 * the high dword, and write order is irrelevant.
53 * struct xhci_cap_regs - xHCI Host Controller Capability Registers.
54 * @hc_capbase: length of the capabilities register and HC version number
55 * @hcs_params1: HCSPARAMS1 - Structural Parameters 1
56 * @hcs_params2: HCSPARAMS2 - Structural Parameters 2
57 * @hcs_params3: HCSPARAMS3 - Structural Parameters 3
58 * @hcc_params: HCCPARAMS - Capability Parameters
59 * @db_off: DBOFF - Doorbell array offset
60 * @run_regs_off: RTSOFF - Runtime register space offset
62 struct xhci_cap_regs {
70 /* Reserved up to (CAPLENGTH - 0x1C) */
71 } __attribute__ ((packed));
73 /* hc_capbase bitmasks */
74 /* bits 7:0 - how long is the Capabilities register */
75 #define HC_LENGTH(p) XHCI_HC_LENGTH(p)
77 #define HC_VERSION(p) (((p) >> 16) & 0xffff)
79 /* HCSPARAMS1 - hcs_params1 - bitmasks */
80 /* bits 0:7, Max Device Slots */
81 #define HCS_MAX_SLOTS(p) (((p) >> 0) & 0xff)
82 #define HCS_SLOTS_MASK 0xff
83 /* bits 8:18, Max Interrupters */
84 #define HCS_MAX_INTRS(p) (((p) >> 8) & 0x7ff)
85 /* bits 24:31, Max Ports - max value is 0x7F = 127 ports */
86 #define HCS_MAX_PORTS(p) (((p) >> 24) & 0x7f)
88 /* HCSPARAMS2 - hcs_params2 - bitmasks */
89 /* bits 0:3, frames or uframes that SW needs to queue transactions
90 * ahead of the HW to meet periodic deadlines */
91 #define HCS_IST(p) (((p) >> 0) & 0xf)
92 /* bits 4:7, max number of Event Ring segments */
93 #define HCS_ERST_MAX(p) (((p) >> 4) & 0xf)
94 /* bit 26 Scratchpad restore - for save/restore HW state - not used yet */
95 /* bits 27:31 number of Scratchpad buffers SW must allocate for the HW */
97 /* HCSPARAMS3 - hcs_params3 - bitmasks */
98 /* bits 0:7, Max U1 to U0 latency for the roothub ports */
99 #define HCS_U1_LATENCY(p) (((p) >> 0) & 0xff)
100 /* bits 16:31, Max U2 to U0 latency for the roothub ports */
101 #define HCS_U2_LATENCY(p) (((p) >> 16) & 0xffff)
103 /* HCCPARAMS - hcc_params - bitmasks */
104 /* true: HC can use 64-bit address pointers */
105 #define HCC_64BIT_ADDR(p) ((p) & (1 << 0))
106 /* true: HC can do bandwidth negotiation */
107 #define HCC_BANDWIDTH_NEG(p) ((p) & (1 << 1))
108 /* true: HC uses 64-byte Device Context structures
109 * FIXME 64-byte context structures aren't supported yet.
111 #define HCC_64BYTE_CONTEXT(p) ((p) & (1 << 2))
112 /* true: HC has port power switches */
113 #define HCC_PPC(p) ((p) & (1 << 3))
114 /* true: HC has port indicators */
115 #define HCS_INDICATOR(p) ((p) & (1 << 4))
116 /* true: HC has Light HC Reset Capability */
117 #define HCC_LIGHT_RESET(p) ((p) & (1 << 5))
118 /* true: HC supports latency tolerance messaging */
119 #define HCC_LTC(p) ((p) & (1 << 6))
120 /* true: no secondary Stream ID Support */
121 #define HCC_NSS(p) ((p) & (1 << 7))
122 /* Max size for Primary Stream Arrays - 2^(n+1), where n is bits 12:15 */
123 #define HCC_MAX_PSA (1 << ((((p) >> 12) & 0xf) + 1))
124 /* Extended Capabilities pointer from PCI base - section 5.3.6 */
125 #define HCC_EXT_CAPS(p) XHCI_HCC_EXT_CAPS(p)
127 /* db_off bitmask - bits 0:1 reserved */
128 #define DBOFF_MASK (~0x3)
130 /* run_regs_off bitmask - bits 0:4 reserved */
131 #define RTSOFF_MASK (~0x1f)
134 /* Number of registers per port */
135 #define NUM_PORT_REGS 4
138 * struct xhci_op_regs - xHCI Host Controller Operational Registers.
139 * @command: USBCMD - xHC command register
140 * @status: USBSTS - xHC status register
141 * @page_size: This indicates the page size that the host controller
142 * supports. If bit n is set, the HC supports a page size
143 * of 2^(n+12), up to a 128MB page size.
144 * 4K is the minimum page size.
145 * @cmd_ring: CRP - 64-bit Command Ring Pointer
146 * @dcbaa_ptr: DCBAAP - 64-bit Device Context Base Address Array Pointer
147 * @config_reg: CONFIG - Configure Register
148 * @port_status_base: PORTSCn - base address for Port Status and Control
149 * Each port has a Port Status and Control register,
150 * followed by a Port Power Management Status and Control
151 * register, a Port Link Info register, and a reserved
153 * @port_power_base: PORTPMSCn - base address for
154 * Port Power Management Status and Control
155 * @port_link_base: PORTLIn - base address for Port Link Info (current
156 * Link PM state and control) for USB 2.1 and USB 3.0
159 struct xhci_op_regs {
165 u32 dev_notification;
167 /* rsvd: offset 0x20-2F */
171 /* rsvd: offset 0x3C-3FF */
173 /* port 1 registers, which serve as a base address for other ports */
174 u32 port_status_base;
178 /* registers for ports 2-255 */
179 u32 reserved6[NUM_PORT_REGS*254];
180 } __attribute__ ((packed));
182 /* USBCMD - USB command - command bitmasks */
183 /* start/stop HC execution - do not write unless HC is halted*/
184 #define CMD_RUN XHCI_CMD_RUN
185 /* Reset HC - resets internal HC state machine and all registers (except
186 * PCI config regs). HC does NOT drive a USB reset on the downstream ports.
187 * The xHCI driver must reinitialize the xHC after setting this bit.
189 #define CMD_RESET (1 << 1)
190 /* Event Interrupt Enable - a '1' allows interrupts from the host controller */
191 #define CMD_EIE XHCI_CMD_EIE
192 /* Host System Error Interrupt Enable - get out-of-band signal for HC errors */
193 #define CMD_HSEIE XHCI_CMD_HSEIE
194 /* bits 4:6 are reserved (and should be preserved on writes). */
195 /* light reset (port status stays unchanged) - reset completed when this is 0 */
196 #define CMD_LRESET (1 << 7)
197 /* FIXME: ignoring host controller save/restore state for now. */
198 #define CMD_CSS (1 << 8)
199 #define CMD_CRS (1 << 9)
200 /* Enable Wrap Event - '1' means xHC generates an event when MFINDEX wraps. */
201 #define CMD_EWE XHCI_CMD_EWE
202 /* MFINDEX power management - '1' means xHC can stop MFINDEX counter if all root
203 * hubs are in U3 (selective suspend), disconnect, disabled, or powered-off.
204 * '0' means the xHC can power it off if all ports are in the disconnect,
205 * disabled, or powered-off state.
207 #define CMD_PM_INDEX (1 << 11)
208 /* bits 12:31 are reserved (and should be preserved on writes). */
210 /* USBSTS - USB status - status bitmasks */
211 /* HC not running - set to 1 when run/stop bit is cleared. */
212 #define STS_HALT XHCI_STS_HALT
213 /* serious error, e.g. PCI parity error. The HC will clear the run/stop bit. */
214 #define STS_FATAL (1 << 2)
215 /* event interrupt - clear this prior to clearing any IP flags in IR set*/
216 #define STS_EINT (1 << 3)
217 /* port change detect */
218 #define STS_PORT (1 << 4)
219 /* bits 5:7 reserved and zeroed */
220 /* save state status - '1' means xHC is saving state */
221 #define STS_SAVE (1 << 8)
222 /* restore state status - '1' means xHC is restoring state */
223 #define STS_RESTORE (1 << 9)
224 /* true: save or restore error */
225 #define STS_SRE (1 << 10)
226 /* true: Controller Not Ready to accept doorbell or op reg writes after reset */
227 #define STS_CNR XHCI_STS_CNR
228 /* true: internal Host Controller Error - SW needs to reset and reinitialize */
229 #define STS_HCE (1 << 12)
230 /* bits 13:31 reserved and should be preserved */
233 * DNCTRL - Device Notification Control Register - dev_notification bitmasks
234 * Generate a device notification event when the HC sees a transaction with a
235 * notification type that matches a bit set in this bit field.
237 #define DEV_NOTE_MASK (0xffff)
238 #define ENABLE_DEV_NOTE(x) (1 << x)
239 /* Most of the device notification types should only be used for debug.
240 * SW does need to pay attention to function wake notifications.
242 #define DEV_NOTE_FWAKE ENABLE_DEV_NOTE(1)
244 /* CONFIG - Configure Register - config_reg bitmasks */
245 /* bits 0:7 - maximum number of device slots enabled (NumSlotsEn) */
246 #define MAX_DEVS(p) ((p) & 0xff)
247 /* bits 8:31 - reserved and should be preserved */
249 /* PORTSC - Port Status and Control Register - port_status_base bitmasks */
250 /* true: device connected */
251 #define PORT_CONNECT (1 << 0)
252 /* true: port enabled */
253 #define PORT_PE (1 << 1)
254 /* bit 2 reserved and zeroed */
255 /* true: port has an over-current condition */
256 #define PORT_OC (1 << 3)
257 /* true: port reset signaling asserted */
258 #define PORT_RESET (1 << 4)
259 /* Port Link State - bits 5:8
260 * A read gives the current link PM state of the port,
261 * a write with Link State Write Strobe set sets the link state.
263 /* true: port has power (see HCC_PPC) */
264 #define PORT_POWER (1 << 9)
265 /* bits 10:13 indicate device speed:
266 * 0 - undefined speed - port hasn't be initialized by a reset yet
273 #define DEV_SPEED_MASK (0xf<<10)
274 #define DEV_UNDEFSPEED(p) (((p) & DEV_SPEED_MASK) == (0x0<<10))
275 #define DEV_FULLSPEED(p) (((p) & DEV_SPEED_MASK) == (0x1<<10))
276 #define DEV_LOWSPEED(p) (((p) & DEV_SPEED_MASK) == (0x2<<10))
277 #define DEV_HIGHSPEED(p) (((p) & DEV_SPEED_MASK) == (0x3<<10))
278 #define DEV_SUPERSPEED(p) (((p) & DEV_SPEED_MASK) == (0x4<<10))
279 /* Port Indicator Control */
280 #define PORT_LED_OFF (0 << 14)
281 #define PORT_LED_AMBER (1 << 14)
282 #define PORT_LED_GREEN (2 << 14)
283 #define PORT_LED_MASK (3 << 14)
284 /* Port Link State Write Strobe - set this when changing link state */
285 #define PORT_LINK_STROBE (1 << 16)
286 /* true: connect status change */
287 #define PORT_CSC (1 << 17)
288 /* true: port enable change */
289 #define PORT_PEC (1 << 18)
290 /* true: warm reset for a USB 3.0 device is done. A "hot" reset puts the port
291 * into an enabled state, and the device into the default state. A "warm" reset
292 * also resets the link, forcing the device through the link training sequence.
293 * SW can also look at the Port Reset register to see when warm reset is done.
295 #define PORT_WRC (1 << 19)
296 /* true: over-current change */
297 #define PORT_OCC (1 << 20)
298 /* true: reset change - 1 to 0 transition of PORT_RESET */
299 #define PORT_RC (1 << 21)
300 /* port link status change - set on some port link state transitions:
302 * ------------------------------------------------------------------------------
303 * - U3 to Resume Wakeup signaling from a device
304 * - Resume to Recovery to U0 USB 3.0 device resume
305 * - Resume to U0 USB 2.0 device resume
306 * - U3 to Recovery to U0 Software resume of USB 3.0 device complete
307 * - U3 to U0 Software resume of USB 2.0 device complete
308 * - U2 to U0 L1 resume of USB 2.1 device complete
309 * - U0 to U0 (???) L1 entry rejection by USB 2.1 device
310 * - U0 to disabled L1 entry error with USB 2.1 device
311 * - Any state to inactive Error on USB 3.0 port
313 #define PORT_PLC (1 << 22)
314 /* port configure error change - port failed to configure its link partner */
315 #define PORT_CEC (1 << 23)
316 /* bit 24 reserved */
317 /* wake on connect (enable) */
318 #define PORT_WKCONN_E (1 << 25)
319 /* wake on disconnect (enable) */
320 #define PORT_WKDISC_E (1 << 26)
321 /* wake on over-current (enable) */
322 #define PORT_WKOC_E (1 << 27)
323 /* bits 28:29 reserved */
324 /* true: device is removable - for USB 3.0 roothub emulation */
325 #define PORT_DEV_REMOVE (1 << 30)
326 /* Initiate a warm port reset - complete when PORT_WRC is '1' */
327 #define PORT_WR (1 << 31)
329 /* Port Power Management Status and Control - port_power_base bitmasks */
330 /* Inactivity timer value for transitions into U1, in microseconds.
331 * Timeout can be up to 127us. 0xFF means an infinite timeout.
333 #define PORT_U1_TIMEOUT(p) ((p) & 0xff)
334 /* Inactivity timer value for transitions into U2 */
335 #define PORT_U2_TIMEOUT(p) (((p) & 0xff) << 8)
336 /* Bits 24:31 for port testing */
340 * struct intr_reg - Interrupt Register Set
341 * @irq_pending: IMAN - Interrupt Management Register. Used to enable
342 * interrupts and check for pending interrupts.
343 * @irq_control: IMOD - Interrupt Moderation Register.
344 * Used to throttle interrupts.
345 * @erst_size: Number of segments in the Event Ring Segment Table (ERST).
346 * @erst_base: ERST base address.
347 * @erst_dequeue: Event ring dequeue pointer.
349 * Each interrupter (defined by a MSI-X vector) has an event ring and an Event
350 * Ring Segment Table (ERST) associated with it. The event ring is comprised of
351 * multiple segments of the same size. The HC places events on the ring and
352 * "updates the Cycle bit in the TRBs to indicate to software the current
353 * position of the Enqueue Pointer." The HCD (Linux) processes those events and
354 * updates the dequeue pointer.
363 } __attribute__ ((packed));
365 /* irq_pending bitmasks */
366 #define ER_IRQ_PENDING(p) ((p) & 0x1)
367 /* bits 2:31 need to be preserved */
368 #define ER_IRQ_CLEAR(p) ((p) & 0xfffffffe)
369 #define ER_IRQ_ENABLE(p) ((ER_IRQ_CLEAR(p)) | 0x2)
370 #define ER_IRQ_DISABLE(p) ((ER_IRQ_CLEAR(p)) & ~(0x2))
372 /* irq_control bitmasks */
373 /* Minimum interval between interrupts (in 250ns intervals). The interval
374 * between interrupts will be longer if there are no events on the event ring.
375 * Default is 4000 (1 ms).
377 #define ER_IRQ_INTERVAL_MASK (0xffff)
378 /* Counter used to count down the time to the next interrupt - HW use only */
379 #define ER_IRQ_COUNTER_MASK (0xffff << 16)
381 /* erst_size bitmasks */
382 /* Preserve bits 16:31 of erst_size */
383 #define ERST_SIZE_MASK (0xffff << 16)
385 /* erst_dequeue bitmasks */
386 /* Dequeue ERST Segment Index (DESI) - Segment number (or alias)
387 * where the current dequeue pointer lies. This is an optional HW hint.
389 #define ERST_DESI_MASK (0x7)
390 /* Event Handler Busy (EHB) - is the event ring scheduled to be serviced by
391 * a work queue (or delayed service routine)?
393 #define ERST_EHB (1 << 3)
396 * struct xhci_run_regs
398 * MFINDEX - current microframe number
400 * Section 5.5 Host Controller Runtime Registers:
401 * "Software should read and write these registers using only Dword (32 bit)
402 * or larger accesses"
404 struct xhci_run_regs {
405 u32 microframe_index;
407 struct intr_reg ir_set[128];
408 } __attribute__ ((packed));
411 /* There is one ehci_hci structure per controller */
413 /* glue to PCI and HCD framework */
414 struct xhci_cap_regs __iomem *cap_regs;
415 struct xhci_op_regs __iomem *op_regs;
416 struct xhci_run_regs __iomem *run_regs;
417 /* Our HCD's current interrupter register set */
418 struct intr_reg __iomem *ir_set;
420 /* Cached register copies of read-only HC data */
428 /* packed release number */
437 /* 4KB min, 128MB max */
439 /* Valid values are 12 to 20, inclusive */
441 /* only one MSI vector for now, but might need more later */
443 struct msix_entry *msix_entries;
446 /* convert between an HCD pointer and the corresponding EHCI_HCD */
447 static inline struct xhci_hcd *hcd_to_xhci(struct usb_hcd *hcd)
449 return (struct xhci_hcd *) (hcd->hcd_priv);
452 static inline struct usb_hcd *xhci_to_hcd(struct xhci_hcd *xhci)
454 return container_of((void *) xhci, struct usb_hcd, hcd_priv);
457 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
463 #define xhci_dbg(xhci, fmt, args...) \
464 do { if (XHCI_DEBUG) dev_dbg(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
465 #define xhci_info(xhci, fmt, args...) \
466 do { if (XHCI_DEBUG) dev_info(xhci_to_hcd(xhci)->self.controller , fmt , ## args); } while (0)
467 #define xhci_err(xhci, fmt, args...) \
468 dev_err(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
469 #define xhci_warn(xhci, fmt, args...) \
470 dev_warn(xhci_to_hcd(xhci)->self.controller , fmt , ## args)
472 /* TODO: copied from ehci.h - can be refactored? */
473 /* xHCI spec says all registers are little endian */
474 static inline unsigned int xhci_readl(const struct xhci_hcd *xhci,
479 static inline void xhci_writel(const struct xhci_hcd *xhci,
480 const unsigned int val, __u32 __iomem *regs)
483 xhci_dbg(xhci, "`MEM_WRITE_DWORD(3'b000, 32'h%0x, 32'h%0x, 4'hf);\n",
484 (unsigned int) regs, val);
489 void xhci_print_ir_set(struct xhci_hcd *xhci, struct intr_reg *ir_set, int set_num);
490 void xhci_print_registers(struct xhci_hcd *xhci);
492 /* xHCI memory managment */
493 void xhci_mem_cleanup(struct xhci_hcd *xhci);
494 int xhci_mem_init(struct xhci_hcd *xhci, gfp_t flags);
498 int xhci_register_pci(void);
499 void xhci_unregister_pci(void);
502 /* xHCI host controller glue */
503 int xhci_halt(struct xhci_hcd *xhci);
504 int xhci_reset(struct xhci_hcd *xhci);
505 int xhci_init(struct usb_hcd *hcd);
506 int xhci_run(struct usb_hcd *hcd);
507 void xhci_stop(struct usb_hcd *hcd);
508 void xhci_shutdown(struct usb_hcd *hcd);
509 int xhci_get_frame(struct usb_hcd *hcd);
511 #endif /* __LINUX_XHCI_HCD_H */