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 #include <linux/pci.h>
24 #include <linux/irq.h>
25 #include <linux/log2.h>
26 #include <linux/module.h>
27 #include <linux/moduleparam.h>
28 #include <linux/slab.h>
32 #define DRIVER_AUTHOR "Sarah Sharp"
33 #define DRIVER_DESC "'eXtensible' Host Controller (xHC) Driver"
35 /* Some 0.95 hardware can't handle the chain bit on a Link TRB being cleared */
36 static int link_quirk
;
37 module_param(link_quirk
, int, S_IRUGO
| S_IWUSR
);
38 MODULE_PARM_DESC(link_quirk
, "Don't clear the chain bit on a link TRB");
40 /* TODO: copied from ehci-hcd.c - can this be refactored? */
42 * handshake - spin reading hc until handshake completes or fails
43 * @ptr: address of hc register to be read
44 * @mask: bits to look at in result of read
45 * @done: value of those bits when handshake succeeds
46 * @usec: timeout in microseconds
48 * Returns negative errno, or zero on success
50 * Success happens when the "mask" bits have the specified value (hardware
51 * handshake done). There are two failure modes: "usec" have passed (major
52 * hardware flakeout), or the register reads as all-ones (hardware removed).
54 static int handshake(struct xhci_hcd
*xhci
, void __iomem
*ptr
,
55 u32 mask
, u32 done
, int usec
)
60 result
= xhci_readl(xhci
, ptr
);
61 if (result
== ~(u32
)0) /* card removed */
73 * Disable interrupts and begin the xHCI halting process.
75 void xhci_quiesce(struct xhci_hcd
*xhci
)
82 halted
= xhci_readl(xhci
, &xhci
->op_regs
->status
) & STS_HALT
;
86 cmd
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
88 xhci_writel(xhci
, cmd
, &xhci
->op_regs
->command
);
92 * Force HC into halt state.
94 * Disable any IRQs and clear the run/stop bit.
95 * HC will complete any current and actively pipelined transactions, and
96 * should halt within 16 ms of the run/stop bit being cleared.
97 * Read HC Halted bit in the status register to see when the HC is finished.
99 int xhci_halt(struct xhci_hcd
*xhci
)
102 xhci_dbg(xhci
, "// Halt the HC\n");
105 ret
= handshake(xhci
, &xhci
->op_regs
->status
,
106 STS_HALT
, STS_HALT
, XHCI_MAX_HALT_USEC
);
108 xhci
->xhc_state
|= XHCI_STATE_HALTED
;
113 * Set the run bit and wait for the host to be running.
115 static int xhci_start(struct xhci_hcd
*xhci
)
120 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
122 xhci_dbg(xhci
, "// Turn on HC, cmd = 0x%x.\n",
124 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
127 * Wait for the HCHalted Status bit to be 0 to indicate the host is
130 ret
= handshake(xhci
, &xhci
->op_regs
->status
,
131 STS_HALT
, 0, XHCI_MAX_HALT_USEC
);
132 if (ret
== -ETIMEDOUT
)
133 xhci_err(xhci
, "Host took too long to start, "
134 "waited %u microseconds.\n",
137 xhci
->xhc_state
&= ~XHCI_STATE_HALTED
;
144 * This resets pipelines, timers, counters, state machines, etc.
145 * Transactions will be terminated immediately, and operational registers
146 * will be set to their defaults.
148 int xhci_reset(struct xhci_hcd
*xhci
)
154 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
155 if ((state
& STS_HALT
) == 0) {
156 xhci_warn(xhci
, "Host controller not halted, aborting reset.\n");
160 xhci_dbg(xhci
, "// Reset the HC\n");
161 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
162 command
|= CMD_RESET
;
163 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
165 ret
= handshake(xhci
, &xhci
->op_regs
->command
,
166 CMD_RESET
, 0, 250 * 1000);
170 xhci_dbg(xhci
, "Wait for controller to be ready for doorbell rings\n");
172 * xHCI cannot write to any doorbells or operational registers other
173 * than status until the "Controller Not Ready" flag is cleared.
175 return handshake(xhci
, &xhci
->op_regs
->status
, STS_CNR
, 0, 250 * 1000);
180 * free all IRQs request
182 static void xhci_free_irq(struct xhci_hcd
*xhci
)
185 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
187 /* return if using legacy interrupt */
188 if (xhci_to_hcd(xhci
)->irq
>= 0)
191 if (xhci
->msix_entries
) {
192 for (i
= 0; i
< xhci
->msix_count
; i
++)
193 if (xhci
->msix_entries
[i
].vector
)
194 free_irq(xhci
->msix_entries
[i
].vector
,
196 } else if (pdev
->irq
>= 0)
197 free_irq(pdev
->irq
, xhci_to_hcd(xhci
));
205 static int xhci_setup_msi(struct xhci_hcd
*xhci
)
208 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
210 ret
= pci_enable_msi(pdev
);
212 xhci_err(xhci
, "failed to allocate MSI entry\n");
216 ret
= request_irq(pdev
->irq
, (irq_handler_t
)xhci_msi_irq
,
217 0, "xhci_hcd", xhci_to_hcd(xhci
));
219 xhci_err(xhci
, "disable MSI interrupt\n");
220 pci_disable_msi(pdev
);
229 static int xhci_setup_msix(struct xhci_hcd
*xhci
)
232 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
233 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
236 * calculate number of msi-x vectors supported.
237 * - HCS_MAX_INTRS: the max number of interrupts the host can handle,
238 * with max number of interrupters based on the xhci HCSPARAMS1.
239 * - num_online_cpus: maximum msi-x vectors per CPUs core.
240 * Add additional 1 vector to ensure always available interrupt.
242 xhci
->msix_count
= min(num_online_cpus() + 1,
243 HCS_MAX_INTRS(xhci
->hcs_params1
));
246 kmalloc((sizeof(struct msix_entry
))*xhci
->msix_count
,
248 if (!xhci
->msix_entries
) {
249 xhci_err(xhci
, "Failed to allocate MSI-X entries\n");
253 for (i
= 0; i
< xhci
->msix_count
; i
++) {
254 xhci
->msix_entries
[i
].entry
= i
;
255 xhci
->msix_entries
[i
].vector
= 0;
258 ret
= pci_enable_msix(pdev
, xhci
->msix_entries
, xhci
->msix_count
);
260 xhci_err(xhci
, "Failed to enable MSI-X\n");
264 for (i
= 0; i
< xhci
->msix_count
; i
++) {
265 ret
= request_irq(xhci
->msix_entries
[i
].vector
,
266 (irq_handler_t
)xhci_msi_irq
,
267 0, "xhci_hcd", xhci_to_hcd(xhci
));
272 hcd
->msix_enabled
= 1;
276 xhci_err(xhci
, "disable MSI-X interrupt\n");
278 pci_disable_msix(pdev
);
280 kfree(xhci
->msix_entries
);
281 xhci
->msix_entries
= NULL
;
285 /* Free any IRQs and disable MSI-X */
286 static void xhci_cleanup_msix(struct xhci_hcd
*xhci
)
288 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
289 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
293 if (xhci
->msix_entries
) {
294 pci_disable_msix(pdev
);
295 kfree(xhci
->msix_entries
);
296 xhci
->msix_entries
= NULL
;
298 pci_disable_msi(pdev
);
301 hcd
->msix_enabled
= 0;
306 * Initialize memory for HCD and xHC (one-time init).
308 * Program the PAGESIZE register, initialize the device context array, create
309 * device contexts (?), set up a command ring segment (or two?), create event
310 * ring (one for now).
312 int xhci_init(struct usb_hcd
*hcd
)
314 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
317 xhci_dbg(xhci
, "xhci_init\n");
318 spin_lock_init(&xhci
->lock
);
320 xhci_dbg(xhci
, "QUIRK: Not clearing Link TRB chain bits.\n");
321 xhci
->quirks
|= XHCI_LINK_TRB_QUIRK
;
323 xhci_dbg(xhci
, "xHCI doesn't need link TRB QUIRK\n");
325 retval
= xhci_mem_init(xhci
, GFP_KERNEL
);
326 xhci_dbg(xhci
, "Finished xhci_init\n");
331 /*-------------------------------------------------------------------------*/
334 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
335 static void xhci_event_ring_work(unsigned long arg
)
340 struct xhci_hcd
*xhci
= (struct xhci_hcd
*) arg
;
343 xhci_dbg(xhci
, "Poll event ring: %lu\n", jiffies
);
345 spin_lock_irqsave(&xhci
->lock
, flags
);
346 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
347 xhci_dbg(xhci
, "op reg status = 0x%x\n", temp
);
348 if (temp
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_DYING
)) {
349 xhci_dbg(xhci
, "HW died, polling stopped.\n");
350 spin_unlock_irqrestore(&xhci
->lock
, flags
);
354 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
355 xhci_dbg(xhci
, "ir_set 0 pending = 0x%x\n", temp
);
356 xhci_dbg(xhci
, "HC error bitmask = 0x%x\n", xhci
->error_bitmask
);
357 xhci
->error_bitmask
= 0;
358 xhci_dbg(xhci
, "Event ring:\n");
359 xhci_debug_segment(xhci
, xhci
->event_ring
->deq_seg
);
360 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
361 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
362 temp_64
&= ~ERST_PTR_MASK
;
363 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
364 xhci_dbg(xhci
, "Command ring:\n");
365 xhci_debug_segment(xhci
, xhci
->cmd_ring
->deq_seg
);
366 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
367 xhci_dbg_cmd_ptrs(xhci
);
368 for (i
= 0; i
< MAX_HC_SLOTS
; ++i
) {
371 for (j
= 0; j
< 31; ++j
) {
372 xhci_dbg_ep_rings(xhci
, i
, j
, &xhci
->devs
[i
]->eps
[j
]);
375 spin_unlock_irqrestore(&xhci
->lock
, flags
);
378 mod_timer(&xhci
->event_ring_timer
, jiffies
+ POLL_TIMEOUT
* HZ
);
380 xhci_dbg(xhci
, "Quit polling the event ring.\n");
384 static int xhci_run_finished(struct xhci_hcd
*xhci
)
386 if (xhci_start(xhci
)) {
390 xhci
->shared_hcd
->state
= HC_STATE_RUNNING
;
392 if (xhci
->quirks
& XHCI_NEC_HOST
)
393 xhci_ring_cmd_db(xhci
);
395 xhci_dbg(xhci
, "Finished xhci_run for USB3 roothub\n");
400 * Start the HC after it was halted.
402 * This function is called by the USB core when the HC driver is added.
403 * Its opposite is xhci_stop().
405 * xhci_init() must be called once before this function can be called.
406 * Reset the HC, enable device slot contexts, program DCBAAP, and
407 * set command ring pointer and event ring pointer.
409 * Setup MSI-X vectors and enable interrupts.
411 int xhci_run(struct usb_hcd
*hcd
)
416 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
417 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
419 /* Start the xHCI host controller running only after the USB 2.0 roothub
423 hcd
->uses_new_polling
= 1;
424 if (!usb_hcd_is_primary_hcd(hcd
))
425 return xhci_run_finished(xhci
);
427 xhci_dbg(xhci
, "xhci_run\n");
428 /* unregister the legacy interrupt */
430 free_irq(hcd
->irq
, hcd
);
433 ret
= xhci_setup_msix(xhci
);
435 /* fall back to msi*/
436 ret
= xhci_setup_msi(xhci
);
439 /* fall back to legacy interrupt*/
440 ret
= request_irq(pdev
->irq
, &usb_hcd_irq
, IRQF_SHARED
,
441 hcd
->irq_descr
, hcd
);
443 xhci_err(xhci
, "request interrupt %d failed\n",
447 hcd
->irq
= pdev
->irq
;
450 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
451 init_timer(&xhci
->event_ring_timer
);
452 xhci
->event_ring_timer
.data
= (unsigned long) xhci
;
453 xhci
->event_ring_timer
.function
= xhci_event_ring_work
;
454 /* Poll the event ring */
455 xhci
->event_ring_timer
.expires
= jiffies
+ POLL_TIMEOUT
* HZ
;
457 xhci_dbg(xhci
, "Setting event ring polling timer\n");
458 add_timer(&xhci
->event_ring_timer
);
461 xhci_dbg(xhci
, "Command ring memory map follows:\n");
462 xhci_debug_ring(xhci
, xhci
->cmd_ring
);
463 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
464 xhci_dbg_cmd_ptrs(xhci
);
466 xhci_dbg(xhci
, "ERST memory map follows:\n");
467 xhci_dbg_erst(xhci
, &xhci
->erst
);
468 xhci_dbg(xhci
, "Event ring:\n");
469 xhci_debug_ring(xhci
, xhci
->event_ring
);
470 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
471 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
472 temp_64
&= ~ERST_PTR_MASK
;
473 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
475 xhci_dbg(xhci
, "// Set the interrupt modulation register\n");
476 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
477 temp
&= ~ER_IRQ_INTERVAL_MASK
;
479 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_control
);
481 /* Set the HCD state before we enable the irqs */
482 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
484 xhci_dbg(xhci
, "// Enable interrupts, cmd = 0x%x.\n",
486 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
488 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
489 xhci_dbg(xhci
, "// Enabling event ring interrupter %p by writing 0x%x to irq_pending\n",
490 xhci
->ir_set
, (unsigned int) ER_IRQ_ENABLE(temp
));
491 xhci_writel(xhci
, ER_IRQ_ENABLE(temp
),
492 &xhci
->ir_set
->irq_pending
);
493 xhci_print_ir_set(xhci
, 0);
495 if (xhci
->quirks
& XHCI_NEC_HOST
)
496 xhci_queue_vendor_command(xhci
, 0, 0, 0,
497 TRB_TYPE(TRB_NEC_GET_FW
));
499 xhci_dbg(xhci
, "Finished xhci_run for USB2 roothub\n");
503 static void xhci_only_stop_hcd(struct usb_hcd
*hcd
)
505 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
507 spin_lock_irq(&xhci
->lock
);
510 /* The shared_hcd is going to be deallocated shortly (the USB core only
511 * calls this function when allocation fails in usb_add_hcd(), or
512 * usb_remove_hcd() is called). So we need to unset xHCI's pointer.
514 xhci
->shared_hcd
= NULL
;
515 spin_unlock_irq(&xhci
->lock
);
521 * This function is called by the USB core when the HC driver is removed.
522 * Its opposite is xhci_run().
524 * Disable device contexts, disable IRQs, and quiesce the HC.
525 * Reset the HC, finish any completed transactions, and cleanup memory.
527 void xhci_stop(struct usb_hcd
*hcd
)
530 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
532 if (!usb_hcd_is_primary_hcd(hcd
)) {
533 xhci_only_stop_hcd(xhci
->shared_hcd
);
537 spin_lock_irq(&xhci
->lock
);
538 /* Make sure the xHC is halted for a USB3 roothub
539 * (xhci_stop() could be called as part of failed init).
543 spin_unlock_irq(&xhci
->lock
);
545 xhci_cleanup_msix(xhci
);
547 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
548 /* Tell the event ring poll function not to reschedule */
550 del_timer_sync(&xhci
->event_ring_timer
);
553 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
554 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
555 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
556 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
557 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
558 &xhci
->ir_set
->irq_pending
);
559 xhci_print_ir_set(xhci
, 0);
561 xhci_dbg(xhci
, "cleaning up memory\n");
562 xhci_mem_cleanup(xhci
);
563 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
564 xhci_readl(xhci
, &xhci
->op_regs
->status
));
568 * Shutdown HC (not bus-specific)
570 * This is called when the machine is rebooting or halting. We assume that the
571 * machine will be powered off, and the HC's internal state will be reset.
572 * Don't bother to free memory.
574 * This will only ever be called with the main usb_hcd (the USB3 roothub).
576 void xhci_shutdown(struct usb_hcd
*hcd
)
578 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
580 spin_lock_irq(&xhci
->lock
);
582 spin_unlock_irq(&xhci
->lock
);
584 xhci_cleanup_msix(xhci
);
586 xhci_dbg(xhci
, "xhci_shutdown completed - status = %x\n",
587 xhci_readl(xhci
, &xhci
->op_regs
->status
));
591 static void xhci_save_registers(struct xhci_hcd
*xhci
)
593 xhci
->s3
.command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
594 xhci
->s3
.dev_nt
= xhci_readl(xhci
, &xhci
->op_regs
->dev_notification
);
595 xhci
->s3
.dcbaa_ptr
= xhci_read_64(xhci
, &xhci
->op_regs
->dcbaa_ptr
);
596 xhci
->s3
.config_reg
= xhci_readl(xhci
, &xhci
->op_regs
->config_reg
);
597 xhci
->s3
.irq_pending
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
598 xhci
->s3
.irq_control
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
599 xhci
->s3
.erst_size
= xhci_readl(xhci
, &xhci
->ir_set
->erst_size
);
600 xhci
->s3
.erst_base
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_base
);
601 xhci
->s3
.erst_dequeue
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
604 static void xhci_restore_registers(struct xhci_hcd
*xhci
)
606 xhci_writel(xhci
, xhci
->s3
.command
, &xhci
->op_regs
->command
);
607 xhci_writel(xhci
, xhci
->s3
.dev_nt
, &xhci
->op_regs
->dev_notification
);
608 xhci_write_64(xhci
, xhci
->s3
.dcbaa_ptr
, &xhci
->op_regs
->dcbaa_ptr
);
609 xhci_writel(xhci
, xhci
->s3
.config_reg
, &xhci
->op_regs
->config_reg
);
610 xhci_writel(xhci
, xhci
->s3
.irq_pending
, &xhci
->ir_set
->irq_pending
);
611 xhci_writel(xhci
, xhci
->s3
.irq_control
, &xhci
->ir_set
->irq_control
);
612 xhci_writel(xhci
, xhci
->s3
.erst_size
, &xhci
->ir_set
->erst_size
);
613 xhci_write_64(xhci
, xhci
->s3
.erst_base
, &xhci
->ir_set
->erst_base
);
616 static void xhci_set_cmd_ring_deq(struct xhci_hcd
*xhci
)
620 /* step 2: initialize command ring buffer */
621 val_64
= xhci_read_64(xhci
, &xhci
->op_regs
->cmd_ring
);
622 val_64
= (val_64
& (u64
) CMD_RING_RSVD_BITS
) |
623 (xhci_trb_virt_to_dma(xhci
->cmd_ring
->deq_seg
,
624 xhci
->cmd_ring
->dequeue
) &
625 (u64
) ~CMD_RING_RSVD_BITS
) |
626 xhci
->cmd_ring
->cycle_state
;
627 xhci_dbg(xhci
, "// Setting command ring address to 0x%llx\n",
628 (long unsigned long) val_64
);
629 xhci_write_64(xhci
, val_64
, &xhci
->op_regs
->cmd_ring
);
633 * The whole command ring must be cleared to zero when we suspend the host.
635 * The host doesn't save the command ring pointer in the suspend well, so we
636 * need to re-program it on resume. Unfortunately, the pointer must be 64-byte
637 * aligned, because of the reserved bits in the command ring dequeue pointer
638 * register. Therefore, we can't just set the dequeue pointer back in the
639 * middle of the ring (TRBs are 16-byte aligned).
641 static void xhci_clear_command_ring(struct xhci_hcd
*xhci
)
643 struct xhci_ring
*ring
;
644 struct xhci_segment
*seg
;
646 ring
= xhci
->cmd_ring
;
649 memset(seg
->trbs
, 0, SEGMENT_SIZE
);
651 } while (seg
!= ring
->deq_seg
);
653 /* Reset the software enqueue and dequeue pointers */
654 ring
->deq_seg
= ring
->first_seg
;
655 ring
->dequeue
= ring
->first_seg
->trbs
;
656 ring
->enq_seg
= ring
->deq_seg
;
657 ring
->enqueue
= ring
->dequeue
;
660 * Ring is now zeroed, so the HW should look for change of ownership
661 * when the cycle bit is set to 1.
663 ring
->cycle_state
= 1;
666 * Reset the hardware dequeue pointer.
667 * Yes, this will need to be re-written after resume, but we're paranoid
668 * and want to make sure the hardware doesn't access bogus memory
669 * because, say, the BIOS or an SMI started the host without changing
670 * the command ring pointers.
672 xhci_set_cmd_ring_deq(xhci
);
676 * Stop HC (not bus-specific)
678 * This is called when the machine transition into S3/S4 mode.
681 int xhci_suspend(struct xhci_hcd
*xhci
)
684 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
688 spin_lock_irq(&xhci
->lock
);
689 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
690 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &xhci
->shared_hcd
->flags
);
691 /* step 1: stop endpoint */
692 /* skipped assuming that port suspend has done */
694 /* step 2: clear Run/Stop bit */
695 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
697 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
698 if (handshake(xhci
, &xhci
->op_regs
->status
,
699 STS_HALT
, STS_HALT
, 100*100)) {
700 xhci_warn(xhci
, "WARN: xHC CMD_RUN timeout\n");
701 spin_unlock_irq(&xhci
->lock
);
704 xhci_clear_command_ring(xhci
);
706 /* step 3: save registers */
707 xhci_save_registers(xhci
);
709 /* step 4: set CSS flag */
710 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
712 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
713 if (handshake(xhci
, &xhci
->op_regs
->status
, STS_SAVE
, 0, 10*100)) {
714 xhci_warn(xhci
, "WARN: xHC CMD_CSS timeout\n");
715 spin_unlock_irq(&xhci
->lock
);
718 spin_unlock_irq(&xhci
->lock
);
720 /* step 5: remove core well power */
721 /* synchronize irq when using MSI-X */
722 if (xhci
->msix_entries
) {
723 for (i
= 0; i
< xhci
->msix_count
; i
++)
724 synchronize_irq(xhci
->msix_entries
[i
].vector
);
731 * start xHC (not bus-specific)
733 * This is called when the machine transition from S3/S4 mode.
736 int xhci_resume(struct xhci_hcd
*xhci
, bool hibernated
)
738 u32 command
, temp
= 0;
739 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
740 struct usb_hcd
*secondary_hcd
;
743 /* Wait a bit if either of the roothubs need to settle from the
744 * transition into bus suspend.
746 if (time_before(jiffies
, xhci
->bus_state
[0].next_statechange
) ||
748 xhci
->bus_state
[1].next_statechange
))
751 spin_lock_irq(&xhci
->lock
);
754 /* step 1: restore register */
755 xhci_restore_registers(xhci
);
756 /* step 2: initialize command ring buffer */
757 xhci_set_cmd_ring_deq(xhci
);
758 /* step 3: restore state and start state*/
759 /* step 3: set CRS flag */
760 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
762 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
763 if (handshake(xhci
, &xhci
->op_regs
->status
,
764 STS_RESTORE
, 0, 10*100)) {
765 xhci_dbg(xhci
, "WARN: xHC CMD_CSS timeout\n");
766 spin_unlock_irq(&xhci
->lock
);
769 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
772 /* If restore operation fails, re-initialize the HC during resume */
773 if ((temp
& STS_SRE
) || hibernated
) {
774 /* Let the USB core know _both_ roothubs lost power. */
775 usb_root_hub_lost_power(xhci
->main_hcd
->self
.root_hub
);
776 usb_root_hub_lost_power(xhci
->shared_hcd
->self
.root_hub
);
778 xhci_dbg(xhci
, "Stop HCD\n");
781 spin_unlock_irq(&xhci
->lock
);
782 xhci_cleanup_msix(xhci
);
784 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
785 /* Tell the event ring poll function not to reschedule */
787 del_timer_sync(&xhci
->event_ring_timer
);
790 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
791 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
792 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
793 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
794 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
795 &xhci
->ir_set
->irq_pending
);
796 xhci_print_ir_set(xhci
, 0);
798 xhci_dbg(xhci
, "cleaning up memory\n");
799 xhci_mem_cleanup(xhci
);
800 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
801 xhci_readl(xhci
, &xhci
->op_regs
->status
));
803 /* USB core calls the PCI reinit and start functions twice:
804 * first with the primary HCD, and then with the secondary HCD.
805 * If we don't do the same, the host will never be started.
807 if (!usb_hcd_is_primary_hcd(hcd
))
810 secondary_hcd
= xhci
->shared_hcd
;
812 xhci_dbg(xhci
, "Initialize the xhci_hcd\n");
813 retval
= xhci_init(hcd
->primary_hcd
);
816 xhci_dbg(xhci
, "Start the primary HCD\n");
817 retval
= xhci_run(hcd
->primary_hcd
);
821 xhci_dbg(xhci
, "Start the secondary HCD\n");
822 retval
= xhci_run(secondary_hcd
);
824 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
825 set_bit(HCD_FLAG_HW_ACCESSIBLE
,
826 &xhci
->shared_hcd
->flags
);
829 hcd
->state
= HC_STATE_SUSPENDED
;
830 xhci
->shared_hcd
->state
= HC_STATE_SUSPENDED
;
834 /* step 4: set Run/Stop bit */
835 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
837 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
838 handshake(xhci
, &xhci
->op_regs
->status
, STS_HALT
,
841 /* step 5: walk topology and initialize portsc,
842 * portpmsc and portli
844 /* this is done in bus_resume */
846 /* step 6: restart each of the previously
847 * Running endpoints by ringing their doorbells
850 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
851 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &xhci
->shared_hcd
->flags
);
853 spin_unlock_irq(&xhci
->lock
);
856 #endif /* CONFIG_PM */
858 /*-------------------------------------------------------------------------*/
861 * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
862 * HCDs. Find the index for an endpoint given its descriptor. Use the return
863 * value to right shift 1 for the bitmask.
865 * Index = (epnum * 2) + direction - 1,
866 * where direction = 0 for OUT, 1 for IN.
867 * For control endpoints, the IN index is used (OUT index is unused), so
868 * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2)
870 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor
*desc
)
873 if (usb_endpoint_xfer_control(desc
))
874 index
= (unsigned int) (usb_endpoint_num(desc
)*2);
876 index
= (unsigned int) (usb_endpoint_num(desc
)*2) +
877 (usb_endpoint_dir_in(desc
) ? 1 : 0) - 1;
881 /* Find the flag for this endpoint (for use in the control context). Use the
882 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
885 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor
*desc
)
887 return 1 << (xhci_get_endpoint_index(desc
) + 1);
890 /* Find the flag for this endpoint (for use in the control context). Use the
891 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
894 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index
)
896 return 1 << (ep_index
+ 1);
899 /* Compute the last valid endpoint context index. Basically, this is the
900 * endpoint index plus one. For slot contexts with more than valid endpoint,
901 * we find the most significant bit set in the added contexts flags.
902 * e.g. ep 1 IN (with epnum 0x81) => added_ctxs = 0b1000
903 * fls(0b1000) = 4, but the endpoint context index is 3, so subtract one.
905 unsigned int xhci_last_valid_endpoint(u32 added_ctxs
)
907 return fls(added_ctxs
) - 1;
910 /* Returns 1 if the arguments are OK;
911 * returns 0 this is a root hub; returns -EINVAL for NULL pointers.
913 static int xhci_check_args(struct usb_hcd
*hcd
, struct usb_device
*udev
,
914 struct usb_host_endpoint
*ep
, int check_ep
, bool check_virt_dev
,
916 struct xhci_hcd
*xhci
;
917 struct xhci_virt_device
*virt_dev
;
919 if (!hcd
|| (check_ep
&& !ep
) || !udev
) {
920 printk(KERN_DEBUG
"xHCI %s called with invalid args\n",
925 printk(KERN_DEBUG
"xHCI %s called for root hub\n",
930 if (check_virt_dev
) {
931 xhci
= hcd_to_xhci(hcd
);
932 if (!udev
->slot_id
|| !xhci
->devs
933 || !xhci
->devs
[udev
->slot_id
]) {
934 printk(KERN_DEBUG
"xHCI %s called with unaddressed "
939 virt_dev
= xhci
->devs
[udev
->slot_id
];
940 if (virt_dev
->udev
!= udev
) {
941 printk(KERN_DEBUG
"xHCI %s called with udev and "
942 "virt_dev does not match\n", func
);
950 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
951 struct usb_device
*udev
, struct xhci_command
*command
,
952 bool ctx_change
, bool must_succeed
);
955 * Full speed devices may have a max packet size greater than 8 bytes, but the
956 * USB core doesn't know that until it reads the first 8 bytes of the
957 * descriptor. If the usb_device's max packet size changes after that point,
958 * we need to issue an evaluate context command and wait on it.
960 static int xhci_check_maxpacket(struct xhci_hcd
*xhci
, unsigned int slot_id
,
961 unsigned int ep_index
, struct urb
*urb
)
963 struct xhci_container_ctx
*in_ctx
;
964 struct xhci_container_ctx
*out_ctx
;
965 struct xhci_input_control_ctx
*ctrl_ctx
;
966 struct xhci_ep_ctx
*ep_ctx
;
968 int hw_max_packet_size
;
971 out_ctx
= xhci
->devs
[slot_id
]->out_ctx
;
972 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
973 hw_max_packet_size
= MAX_PACKET_DECODED(ep_ctx
->ep_info2
);
974 max_packet_size
= urb
->dev
->ep0
.desc
.wMaxPacketSize
;
975 if (hw_max_packet_size
!= max_packet_size
) {
976 xhci_dbg(xhci
, "Max Packet Size for ep 0 changed.\n");
977 xhci_dbg(xhci
, "Max packet size in usb_device = %d\n",
979 xhci_dbg(xhci
, "Max packet size in xHCI HW = %d\n",
981 xhci_dbg(xhci
, "Issuing evaluate context command.\n");
983 /* Set up the modified control endpoint 0 */
984 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
985 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
986 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
987 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
988 ep_ctx
->ep_info2
&= ~MAX_PACKET_MASK
;
989 ep_ctx
->ep_info2
|= MAX_PACKET(max_packet_size
);
991 /* Set up the input context flags for the command */
992 /* FIXME: This won't work if a non-default control endpoint
993 * changes max packet sizes.
995 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
996 ctrl_ctx
->add_flags
= EP0_FLAG
;
997 ctrl_ctx
->drop_flags
= 0;
999 xhci_dbg(xhci
, "Slot %d input context\n", slot_id
);
1000 xhci_dbg_ctx(xhci
, in_ctx
, ep_index
);
1001 xhci_dbg(xhci
, "Slot %d output context\n", slot_id
);
1002 xhci_dbg_ctx(xhci
, out_ctx
, ep_index
);
1004 ret
= xhci_configure_endpoint(xhci
, urb
->dev
, NULL
,
1007 /* Clean up the input context for later use by bandwidth
1010 ctrl_ctx
->add_flags
= SLOT_FLAG
;
1016 * non-error returns are a promise to giveback() the urb later
1017 * we drop ownership so next owner (or urb unlink) can get it
1019 int xhci_urb_enqueue(struct usb_hcd
*hcd
, struct urb
*urb
, gfp_t mem_flags
)
1021 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1022 unsigned long flags
;
1024 unsigned int slot_id
, ep_index
;
1025 struct urb_priv
*urb_priv
;
1028 if (!urb
|| xhci_check_args(hcd
, urb
->dev
, urb
->ep
,
1029 true, true, __func__
) <= 0)
1032 slot_id
= urb
->dev
->slot_id
;
1033 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1035 if (!HCD_HW_ACCESSIBLE(hcd
)) {
1036 if (!in_interrupt())
1037 xhci_dbg(xhci
, "urb submitted during PCI suspend\n");
1042 if (usb_endpoint_xfer_isoc(&urb
->ep
->desc
))
1043 size
= urb
->number_of_packets
;
1047 urb_priv
= kzalloc(sizeof(struct urb_priv
) +
1048 size
* sizeof(struct xhci_td
*), mem_flags
);
1052 for (i
= 0; i
< size
; i
++) {
1053 urb_priv
->td
[i
] = kzalloc(sizeof(struct xhci_td
), mem_flags
);
1054 if (!urb_priv
->td
[i
]) {
1055 urb_priv
->length
= i
;
1056 xhci_urb_free_priv(xhci
, urb_priv
);
1061 urb_priv
->length
= size
;
1062 urb_priv
->td_cnt
= 0;
1063 urb
->hcpriv
= urb_priv
;
1065 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)) {
1066 /* Check to see if the max packet size for the default control
1067 * endpoint changed during FS device enumeration
1069 if (urb
->dev
->speed
== USB_SPEED_FULL
) {
1070 ret
= xhci_check_maxpacket(xhci
, slot_id
,
1076 /* We have a spinlock and interrupts disabled, so we must pass
1077 * atomic context to this function, which may allocate memory.
1079 spin_lock_irqsave(&xhci
->lock
, flags
);
1080 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1082 ret
= xhci_queue_ctrl_tx(xhci
, GFP_ATOMIC
, urb
,
1084 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1085 } else if (usb_endpoint_xfer_bulk(&urb
->ep
->desc
)) {
1086 spin_lock_irqsave(&xhci
->lock
, flags
);
1087 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1089 if (xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
&
1090 EP_GETTING_STREAMS
) {
1091 xhci_warn(xhci
, "WARN: Can't enqueue URB while bulk ep "
1092 "is transitioning to using streams.\n");
1094 } else if (xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
&
1095 EP_GETTING_NO_STREAMS
) {
1096 xhci_warn(xhci
, "WARN: Can't enqueue URB while bulk ep "
1097 "is transitioning to "
1098 "not having streams.\n");
1101 ret
= xhci_queue_bulk_tx(xhci
, GFP_ATOMIC
, urb
,
1104 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1105 } else if (usb_endpoint_xfer_int(&urb
->ep
->desc
)) {
1106 spin_lock_irqsave(&xhci
->lock
, flags
);
1107 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1109 ret
= xhci_queue_intr_tx(xhci
, GFP_ATOMIC
, urb
,
1111 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1113 spin_lock_irqsave(&xhci
->lock
, flags
);
1114 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1116 ret
= xhci_queue_isoc_tx_prepare(xhci
, GFP_ATOMIC
, urb
,
1118 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1123 xhci_urb_free_priv(xhci
, urb_priv
);
1125 xhci_dbg(xhci
, "Ep 0x%x: URB %p submitted for "
1126 "non-responsive xHCI host.\n",
1127 urb
->ep
->desc
.bEndpointAddress
, urb
);
1128 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1132 /* Get the right ring for the given URB.
1133 * If the endpoint supports streams, boundary check the URB's stream ID.
1134 * If the endpoint doesn't support streams, return the singular endpoint ring.
1136 static struct xhci_ring
*xhci_urb_to_transfer_ring(struct xhci_hcd
*xhci
,
1139 unsigned int slot_id
;
1140 unsigned int ep_index
;
1141 unsigned int stream_id
;
1142 struct xhci_virt_ep
*ep
;
1144 slot_id
= urb
->dev
->slot_id
;
1145 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1146 stream_id
= urb
->stream_id
;
1147 ep
= &xhci
->devs
[slot_id
]->eps
[ep_index
];
1148 /* Common case: no streams */
1149 if (!(ep
->ep_state
& EP_HAS_STREAMS
))
1152 if (stream_id
== 0) {
1154 "WARN: Slot ID %u, ep index %u has streams, "
1155 "but URB has no stream ID.\n",
1160 if (stream_id
< ep
->stream_info
->num_streams
)
1161 return ep
->stream_info
->stream_rings
[stream_id
];
1164 "WARN: Slot ID %u, ep index %u has "
1165 "stream IDs 1 to %u allocated, "
1166 "but stream ID %u is requested.\n",
1168 ep
->stream_info
->num_streams
- 1,
1174 * Remove the URB's TD from the endpoint ring. This may cause the HC to stop
1175 * USB transfers, potentially stopping in the middle of a TRB buffer. The HC
1176 * should pick up where it left off in the TD, unless a Set Transfer Ring
1177 * Dequeue Pointer is issued.
1179 * The TRBs that make up the buffers for the canceled URB will be "removed" from
1180 * the ring. Since the ring is a contiguous structure, they can't be physically
1181 * removed. Instead, there are two options:
1183 * 1) If the HC is in the middle of processing the URB to be canceled, we
1184 * simply move the ring's dequeue pointer past those TRBs using the Set
1185 * Transfer Ring Dequeue Pointer command. This will be the common case,
1186 * when drivers timeout on the last submitted URB and attempt to cancel.
1188 * 2) If the HC is in the middle of a different TD, we turn the TRBs into a
1189 * series of 1-TRB transfer no-op TDs. (No-ops shouldn't be chained.) The
1190 * HC will need to invalidate the any TRBs it has cached after the stop
1191 * endpoint command, as noted in the xHCI 0.95 errata.
1193 * 3) The TD may have completed by the time the Stop Endpoint Command
1194 * completes, so software needs to handle that case too.
1196 * This function should protect against the TD enqueueing code ringing the
1197 * doorbell while this code is waiting for a Stop Endpoint command to complete.
1198 * It also needs to account for multiple cancellations on happening at the same
1199 * time for the same endpoint.
1201 * Note that this function can be called in any context, or so says
1202 * usb_hcd_unlink_urb()
1204 int xhci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1206 unsigned long flags
;
1209 struct xhci_hcd
*xhci
;
1210 struct urb_priv
*urb_priv
;
1212 unsigned int ep_index
;
1213 struct xhci_ring
*ep_ring
;
1214 struct xhci_virt_ep
*ep
;
1216 xhci
= hcd_to_xhci(hcd
);
1217 spin_lock_irqsave(&xhci
->lock
, flags
);
1218 /* Make sure the URB hasn't completed or been unlinked already */
1219 ret
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1220 if (ret
|| !urb
->hcpriv
)
1222 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
1223 if (temp
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_HALTED
)) {
1224 xhci_dbg(xhci
, "HW died, freeing TD.\n");
1225 urb_priv
= urb
->hcpriv
;
1227 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
1228 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1229 usb_hcd_giveback_urb(hcd
, urb
, -ESHUTDOWN
);
1230 xhci_urb_free_priv(xhci
, urb_priv
);
1233 if (xhci
->xhc_state
& XHCI_STATE_DYING
) {
1234 xhci_dbg(xhci
, "Ep 0x%x: URB %p to be canceled on "
1235 "non-responsive xHCI host.\n",
1236 urb
->ep
->desc
.bEndpointAddress
, urb
);
1237 /* Let the stop endpoint command watchdog timer (which set this
1238 * state) finish cleaning up the endpoint TD lists. We must
1239 * have caught it in the middle of dropping a lock and giving
1245 xhci_dbg(xhci
, "Cancel URB %p\n", urb
);
1246 xhci_dbg(xhci
, "Event ring:\n");
1247 xhci_debug_ring(xhci
, xhci
->event_ring
);
1248 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1249 ep
= &xhci
->devs
[urb
->dev
->slot_id
]->eps
[ep_index
];
1250 ep_ring
= xhci_urb_to_transfer_ring(xhci
, urb
);
1256 xhci_dbg(xhci
, "Endpoint ring:\n");
1257 xhci_debug_ring(xhci
, ep_ring
);
1259 urb_priv
= urb
->hcpriv
;
1261 for (i
= urb_priv
->td_cnt
; i
< urb_priv
->length
; i
++) {
1262 td
= urb_priv
->td
[i
];
1263 list_add_tail(&td
->cancelled_td_list
, &ep
->cancelled_td_list
);
1266 /* Queue a stop endpoint command, but only if this is
1267 * the first cancellation to be handled.
1269 if (!(ep
->ep_state
& EP_HALT_PENDING
)) {
1270 ep
->ep_state
|= EP_HALT_PENDING
;
1271 ep
->stop_cmds_pending
++;
1272 ep
->stop_cmd_timer
.expires
= jiffies
+
1273 XHCI_STOP_EP_CMD_TIMEOUT
* HZ
;
1274 add_timer(&ep
->stop_cmd_timer
);
1275 xhci_queue_stop_endpoint(xhci
, urb
->dev
->slot_id
, ep_index
, 0);
1276 xhci_ring_cmd_db(xhci
);
1279 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1283 /* Drop an endpoint from a new bandwidth configuration for this device.
1284 * Only one call to this function is allowed per endpoint before
1285 * check_bandwidth() or reset_bandwidth() must be called.
1286 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
1287 * add the endpoint to the schedule with possibly new parameters denoted by a
1288 * different endpoint descriptor in usb_host_endpoint.
1289 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
1292 * The USB core will not allow URBs to be queued to an endpoint that is being
1293 * disabled, so there's no need for mutual exclusion to protect
1294 * the xhci->devs[slot_id] structure.
1296 int xhci_drop_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
1297 struct usb_host_endpoint
*ep
)
1299 struct xhci_hcd
*xhci
;
1300 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
1301 struct xhci_input_control_ctx
*ctrl_ctx
;
1302 struct xhci_slot_ctx
*slot_ctx
;
1303 unsigned int last_ctx
;
1304 unsigned int ep_index
;
1305 struct xhci_ep_ctx
*ep_ctx
;
1307 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
1310 ret
= xhci_check_args(hcd
, udev
, ep
, 1, true, __func__
);
1313 xhci
= hcd_to_xhci(hcd
);
1314 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1316 drop_flag
= xhci_get_endpoint_flag(&ep
->desc
);
1317 if (drop_flag
== SLOT_FLAG
|| drop_flag
== EP0_FLAG
) {
1318 xhci_dbg(xhci
, "xHCI %s - can't drop slot or ep 0 %#x\n",
1319 __func__
, drop_flag
);
1323 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
1324 out_ctx
= xhci
->devs
[udev
->slot_id
]->out_ctx
;
1325 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1326 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1327 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
1328 /* If the HC already knows the endpoint is disabled,
1329 * or the HCD has noted it is disabled, ignore this request
1331 if ((ep_ctx
->ep_info
& EP_STATE_MASK
) == EP_STATE_DISABLED
||
1332 ctrl_ctx
->drop_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
1333 xhci_warn(xhci
, "xHCI %s called with disabled ep %p\n",
1338 ctrl_ctx
->drop_flags
|= drop_flag
;
1339 new_drop_flags
= ctrl_ctx
->drop_flags
;
1341 ctrl_ctx
->add_flags
&= ~drop_flag
;
1342 new_add_flags
= ctrl_ctx
->add_flags
;
1344 last_ctx
= xhci_last_valid_endpoint(ctrl_ctx
->add_flags
);
1345 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
1346 /* Update the last valid endpoint context, if we deleted the last one */
1347 if ((slot_ctx
->dev_info
& LAST_CTX_MASK
) > LAST_CTX(last_ctx
)) {
1348 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
1349 slot_ctx
->dev_info
|= LAST_CTX(last_ctx
);
1351 new_slot_info
= slot_ctx
->dev_info
;
1353 xhci_endpoint_zero(xhci
, xhci
->devs
[udev
->slot_id
], ep
);
1355 xhci_dbg(xhci
, "drop ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
1356 (unsigned int) ep
->desc
.bEndpointAddress
,
1358 (unsigned int) new_drop_flags
,
1359 (unsigned int) new_add_flags
,
1360 (unsigned int) new_slot_info
);
1364 /* Add an endpoint to a new possible bandwidth configuration for this device.
1365 * Only one call to this function is allowed per endpoint before
1366 * check_bandwidth() or reset_bandwidth() must be called.
1367 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
1368 * add the endpoint to the schedule with possibly new parameters denoted by a
1369 * different endpoint descriptor in usb_host_endpoint.
1370 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
1373 * The USB core will not allow URBs to be queued to an endpoint until the
1374 * configuration or alt setting is installed in the device, so there's no need
1375 * for mutual exclusion to protect the xhci->devs[slot_id] structure.
1377 int xhci_add_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
1378 struct usb_host_endpoint
*ep
)
1380 struct xhci_hcd
*xhci
;
1381 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
1382 unsigned int ep_index
;
1383 struct xhci_ep_ctx
*ep_ctx
;
1384 struct xhci_slot_ctx
*slot_ctx
;
1385 struct xhci_input_control_ctx
*ctrl_ctx
;
1387 unsigned int last_ctx
;
1388 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
1391 ret
= xhci_check_args(hcd
, udev
, ep
, 1, true, __func__
);
1393 /* So we won't queue a reset ep command for a root hub */
1397 xhci
= hcd_to_xhci(hcd
);
1399 added_ctxs
= xhci_get_endpoint_flag(&ep
->desc
);
1400 last_ctx
= xhci_last_valid_endpoint(added_ctxs
);
1401 if (added_ctxs
== SLOT_FLAG
|| added_ctxs
== EP0_FLAG
) {
1402 /* FIXME when we have to issue an evaluate endpoint command to
1403 * deal with ep0 max packet size changing once we get the
1406 xhci_dbg(xhci
, "xHCI %s - can't add slot or ep 0 %#x\n",
1407 __func__
, added_ctxs
);
1411 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
1412 out_ctx
= xhci
->devs
[udev
->slot_id
]->out_ctx
;
1413 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1414 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1415 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
1416 /* If the HCD has already noted the endpoint is enabled,
1417 * ignore this request.
1419 if (ctrl_ctx
->add_flags
& xhci_get_endpoint_flag(&ep
->desc
)) {
1420 xhci_warn(xhci
, "xHCI %s called with enabled ep %p\n",
1426 * Configuration and alternate setting changes must be done in
1427 * process context, not interrupt context (or so documenation
1428 * for usb_set_interface() and usb_set_configuration() claim).
1430 if (xhci_endpoint_init(xhci
, xhci
->devs
[udev
->slot_id
],
1431 udev
, ep
, GFP_NOIO
) < 0) {
1432 dev_dbg(&udev
->dev
, "%s - could not initialize ep %#x\n",
1433 __func__
, ep
->desc
.bEndpointAddress
);
1437 ctrl_ctx
->add_flags
|= added_ctxs
;
1438 new_add_flags
= ctrl_ctx
->add_flags
;
1440 /* If xhci_endpoint_disable() was called for this endpoint, but the
1441 * xHC hasn't been notified yet through the check_bandwidth() call,
1442 * this re-adds a new state for the endpoint from the new endpoint
1443 * descriptors. We must drop and re-add this endpoint, so we leave the
1446 new_drop_flags
= ctrl_ctx
->drop_flags
;
1448 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
1449 /* Update the last valid endpoint context, if we just added one past */
1450 if ((slot_ctx
->dev_info
& LAST_CTX_MASK
) < LAST_CTX(last_ctx
)) {
1451 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
1452 slot_ctx
->dev_info
|= LAST_CTX(last_ctx
);
1454 new_slot_info
= slot_ctx
->dev_info
;
1456 /* Store the usb_device pointer for later use */
1459 xhci_dbg(xhci
, "add ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
1460 (unsigned int) ep
->desc
.bEndpointAddress
,
1462 (unsigned int) new_drop_flags
,
1463 (unsigned int) new_add_flags
,
1464 (unsigned int) new_slot_info
);
1468 static void xhci_zero_in_ctx(struct xhci_hcd
*xhci
, struct xhci_virt_device
*virt_dev
)
1470 struct xhci_input_control_ctx
*ctrl_ctx
;
1471 struct xhci_ep_ctx
*ep_ctx
;
1472 struct xhci_slot_ctx
*slot_ctx
;
1475 /* When a device's add flag and drop flag are zero, any subsequent
1476 * configure endpoint command will leave that endpoint's state
1477 * untouched. Make sure we don't leave any old state in the input
1478 * endpoint contexts.
1480 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1481 ctrl_ctx
->drop_flags
= 0;
1482 ctrl_ctx
->add_flags
= 0;
1483 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
1484 slot_ctx
->dev_info
&= ~LAST_CTX_MASK
;
1485 /* Endpoint 0 is always valid */
1486 slot_ctx
->dev_info
|= LAST_CTX(1);
1487 for (i
= 1; i
< 31; ++i
) {
1488 ep_ctx
= xhci_get_ep_ctx(xhci
, virt_dev
->in_ctx
, i
);
1489 ep_ctx
->ep_info
= 0;
1490 ep_ctx
->ep_info2
= 0;
1492 ep_ctx
->tx_info
= 0;
1496 static int xhci_configure_endpoint_result(struct xhci_hcd
*xhci
,
1497 struct usb_device
*udev
, int *cmd_status
)
1501 switch (*cmd_status
) {
1503 dev_warn(&udev
->dev
, "Not enough host controller resources "
1504 "for new device state.\n");
1506 /* FIXME: can we allocate more resources for the HC? */
1509 dev_warn(&udev
->dev
, "Not enough bandwidth "
1510 "for new device state.\n");
1512 /* FIXME: can we go back to the old state? */
1515 /* the HCD set up something wrong */
1516 dev_warn(&udev
->dev
, "ERROR: Endpoint drop flag = 0, "
1518 "and endpoint is not disabled.\n");
1522 dev_dbg(&udev
->dev
, "Successful Endpoint Configure command\n");
1526 xhci_err(xhci
, "ERROR: unexpected command completion "
1527 "code 0x%x.\n", *cmd_status
);
1534 static int xhci_evaluate_context_result(struct xhci_hcd
*xhci
,
1535 struct usb_device
*udev
, int *cmd_status
)
1538 struct xhci_virt_device
*virt_dev
= xhci
->devs
[udev
->slot_id
];
1540 switch (*cmd_status
) {
1542 dev_warn(&udev
->dev
, "WARN: xHCI driver setup invalid evaluate "
1543 "context command.\n");
1547 dev_warn(&udev
->dev
, "WARN: slot not enabled for"
1548 "evaluate context command.\n");
1549 case COMP_CTX_STATE
:
1550 dev_warn(&udev
->dev
, "WARN: invalid context state for "
1551 "evaluate context command.\n");
1552 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 1);
1556 dev_dbg(&udev
->dev
, "Successful evaluate context command\n");
1560 xhci_err(xhci
, "ERROR: unexpected command completion "
1561 "code 0x%x.\n", *cmd_status
);
1568 /* Issue a configure endpoint command or evaluate context command
1569 * and wait for it to finish.
1571 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
1572 struct usb_device
*udev
,
1573 struct xhci_command
*command
,
1574 bool ctx_change
, bool must_succeed
)
1578 unsigned long flags
;
1579 struct xhci_container_ctx
*in_ctx
;
1580 struct completion
*cmd_completion
;
1582 struct xhci_virt_device
*virt_dev
;
1584 spin_lock_irqsave(&xhci
->lock
, flags
);
1585 virt_dev
= xhci
->devs
[udev
->slot_id
];
1587 in_ctx
= command
->in_ctx
;
1588 cmd_completion
= command
->completion
;
1589 cmd_status
= &command
->status
;
1590 command
->command_trb
= xhci
->cmd_ring
->enqueue
;
1592 /* Enqueue pointer can be left pointing to the link TRB,
1593 * we must handle that
1595 if ((command
->command_trb
->link
.control
& TRB_TYPE_BITMASK
)
1596 == TRB_TYPE(TRB_LINK
))
1597 command
->command_trb
=
1598 xhci
->cmd_ring
->enq_seg
->next
->trbs
;
1600 list_add_tail(&command
->cmd_list
, &virt_dev
->cmd_list
);
1602 in_ctx
= virt_dev
->in_ctx
;
1603 cmd_completion
= &virt_dev
->cmd_completion
;
1604 cmd_status
= &virt_dev
->cmd_status
;
1606 init_completion(cmd_completion
);
1609 ret
= xhci_queue_configure_endpoint(xhci
, in_ctx
->dma
,
1610 udev
->slot_id
, must_succeed
);
1612 ret
= xhci_queue_evaluate_context(xhci
, in_ctx
->dma
,
1616 list_del(&command
->cmd_list
);
1617 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1618 xhci_dbg(xhci
, "FIXME allocate a new ring segment\n");
1621 xhci_ring_cmd_db(xhci
);
1622 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1624 /* Wait for the configure endpoint command to complete */
1625 timeleft
= wait_for_completion_interruptible_timeout(
1627 USB_CTRL_SET_TIMEOUT
);
1628 if (timeleft
<= 0) {
1629 xhci_warn(xhci
, "%s while waiting for %s command\n",
1630 timeleft
== 0 ? "Timeout" : "Signal",
1632 "configure endpoint" :
1633 "evaluate context");
1634 /* FIXME cancel the configure endpoint command */
1639 return xhci_configure_endpoint_result(xhci
, udev
, cmd_status
);
1640 return xhci_evaluate_context_result(xhci
, udev
, cmd_status
);
1643 /* Called after one or more calls to xhci_add_endpoint() or
1644 * xhci_drop_endpoint(). If this call fails, the USB core is expected
1645 * to call xhci_reset_bandwidth().
1647 * Since we are in the middle of changing either configuration or
1648 * installing a new alt setting, the USB core won't allow URBs to be
1649 * enqueued for any endpoint on the old config or interface. Nothing
1650 * else should be touching the xhci->devs[slot_id] structure, so we
1651 * don't need to take the xhci->lock for manipulating that.
1653 int xhci_check_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1657 struct xhci_hcd
*xhci
;
1658 struct xhci_virt_device
*virt_dev
;
1659 struct xhci_input_control_ctx
*ctrl_ctx
;
1660 struct xhci_slot_ctx
*slot_ctx
;
1662 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
1665 xhci
= hcd_to_xhci(hcd
);
1667 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1668 virt_dev
= xhci
->devs
[udev
->slot_id
];
1670 /* See section 4.6.6 - A0 = 1; A1 = D0 = D1 = 0 */
1671 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1672 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
1673 ctrl_ctx
->add_flags
&= ~EP0_FLAG
;
1674 ctrl_ctx
->drop_flags
&= ~SLOT_FLAG
;
1675 ctrl_ctx
->drop_flags
&= ~EP0_FLAG
;
1676 xhci_dbg(xhci
, "New Input Control Context:\n");
1677 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
1678 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
,
1679 LAST_CTX_TO_EP_NUM(slot_ctx
->dev_info
));
1681 ret
= xhci_configure_endpoint(xhci
, udev
, NULL
,
1684 /* Callee should call reset_bandwidth() */
1688 xhci_dbg(xhci
, "Output context after successful config ep cmd:\n");
1689 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
,
1690 LAST_CTX_TO_EP_NUM(slot_ctx
->dev_info
));
1692 xhci_zero_in_ctx(xhci
, virt_dev
);
1693 /* Install new rings and free or cache any old rings */
1694 for (i
= 1; i
< 31; ++i
) {
1695 if (!virt_dev
->eps
[i
].new_ring
)
1697 /* Only cache or free the old ring if it exists.
1698 * It may not if this is the first add of an endpoint.
1700 if (virt_dev
->eps
[i
].ring
) {
1701 xhci_free_or_cache_endpoint_ring(xhci
, virt_dev
, i
);
1703 virt_dev
->eps
[i
].ring
= virt_dev
->eps
[i
].new_ring
;
1704 virt_dev
->eps
[i
].new_ring
= NULL
;
1710 void xhci_reset_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
1712 struct xhci_hcd
*xhci
;
1713 struct xhci_virt_device
*virt_dev
;
1716 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
1719 xhci
= hcd_to_xhci(hcd
);
1721 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1722 virt_dev
= xhci
->devs
[udev
->slot_id
];
1723 /* Free any rings allocated for added endpoints */
1724 for (i
= 0; i
< 31; ++i
) {
1725 if (virt_dev
->eps
[i
].new_ring
) {
1726 xhci_ring_free(xhci
, virt_dev
->eps
[i
].new_ring
);
1727 virt_dev
->eps
[i
].new_ring
= NULL
;
1730 xhci_zero_in_ctx(xhci
, virt_dev
);
1733 static void xhci_setup_input_ctx_for_config_ep(struct xhci_hcd
*xhci
,
1734 struct xhci_container_ctx
*in_ctx
,
1735 struct xhci_container_ctx
*out_ctx
,
1736 u32 add_flags
, u32 drop_flags
)
1738 struct xhci_input_control_ctx
*ctrl_ctx
;
1739 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1740 ctrl_ctx
->add_flags
= add_flags
;
1741 ctrl_ctx
->drop_flags
= drop_flags
;
1742 xhci_slot_copy(xhci
, in_ctx
, out_ctx
);
1743 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
1745 xhci_dbg(xhci
, "Input Context:\n");
1746 xhci_dbg_ctx(xhci
, in_ctx
, xhci_last_valid_endpoint(add_flags
));
1749 static void xhci_setup_input_ctx_for_quirk(struct xhci_hcd
*xhci
,
1750 unsigned int slot_id
, unsigned int ep_index
,
1751 struct xhci_dequeue_state
*deq_state
)
1753 struct xhci_container_ctx
*in_ctx
;
1754 struct xhci_ep_ctx
*ep_ctx
;
1758 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
1759 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
1760 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
1761 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
1762 addr
= xhci_trb_virt_to_dma(deq_state
->new_deq_seg
,
1763 deq_state
->new_deq_ptr
);
1765 xhci_warn(xhci
, "WARN Cannot submit config ep after "
1766 "reset ep command\n");
1767 xhci_warn(xhci
, "WARN deq seg = %p, deq ptr = %p\n",
1768 deq_state
->new_deq_seg
,
1769 deq_state
->new_deq_ptr
);
1772 ep_ctx
->deq
= addr
| deq_state
->new_cycle_state
;
1774 added_ctxs
= xhci_get_endpoint_flag_from_index(ep_index
);
1775 xhci_setup_input_ctx_for_config_ep(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
1776 xhci
->devs
[slot_id
]->out_ctx
, added_ctxs
, added_ctxs
);
1779 void xhci_cleanup_stalled_ring(struct xhci_hcd
*xhci
,
1780 struct usb_device
*udev
, unsigned int ep_index
)
1782 struct xhci_dequeue_state deq_state
;
1783 struct xhci_virt_ep
*ep
;
1785 xhci_dbg(xhci
, "Cleaning up stalled endpoint ring\n");
1786 ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
1787 /* We need to move the HW's dequeue pointer past this TD,
1788 * or it will attempt to resend it on the next doorbell ring.
1790 xhci_find_new_dequeue_state(xhci
, udev
->slot_id
,
1791 ep_index
, ep
->stopped_stream
, ep
->stopped_td
,
1794 /* HW with the reset endpoint quirk will use the saved dequeue state to
1795 * issue a configure endpoint command later.
1797 if (!(xhci
->quirks
& XHCI_RESET_EP_QUIRK
)) {
1798 xhci_dbg(xhci
, "Queueing new dequeue state\n");
1799 xhci_queue_new_dequeue_state(xhci
, udev
->slot_id
,
1800 ep_index
, ep
->stopped_stream
, &deq_state
);
1802 /* Better hope no one uses the input context between now and the
1803 * reset endpoint completion!
1804 * XXX: No idea how this hardware will react when stream rings
1807 xhci_dbg(xhci
, "Setting up input context for "
1808 "configure endpoint command\n");
1809 xhci_setup_input_ctx_for_quirk(xhci
, udev
->slot_id
,
1810 ep_index
, &deq_state
);
1814 /* Deal with stalled endpoints. The core should have sent the control message
1815 * to clear the halt condition. However, we need to make the xHCI hardware
1816 * reset its sequence number, since a device will expect a sequence number of
1817 * zero after the halt condition is cleared.
1818 * Context: in_interrupt
1820 void xhci_endpoint_reset(struct usb_hcd
*hcd
,
1821 struct usb_host_endpoint
*ep
)
1823 struct xhci_hcd
*xhci
;
1824 struct usb_device
*udev
;
1825 unsigned int ep_index
;
1826 unsigned long flags
;
1828 struct xhci_virt_ep
*virt_ep
;
1830 xhci
= hcd_to_xhci(hcd
);
1831 udev
= (struct usb_device
*) ep
->hcpriv
;
1832 /* Called with a root hub endpoint (or an endpoint that wasn't added
1833 * with xhci_add_endpoint()
1837 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1838 virt_ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
1839 if (!virt_ep
->stopped_td
) {
1840 xhci_dbg(xhci
, "Endpoint 0x%x not halted, refusing to reset.\n",
1841 ep
->desc
.bEndpointAddress
);
1844 if (usb_endpoint_xfer_control(&ep
->desc
)) {
1845 xhci_dbg(xhci
, "Control endpoint stall already handled.\n");
1849 xhci_dbg(xhci
, "Queueing reset endpoint command\n");
1850 spin_lock_irqsave(&xhci
->lock
, flags
);
1851 ret
= xhci_queue_reset_ep(xhci
, udev
->slot_id
, ep_index
);
1853 * Can't change the ring dequeue pointer until it's transitioned to the
1854 * stopped state, which is only upon a successful reset endpoint
1855 * command. Better hope that last command worked!
1858 xhci_cleanup_stalled_ring(xhci
, udev
, ep_index
);
1859 kfree(virt_ep
->stopped_td
);
1860 xhci_ring_cmd_db(xhci
);
1862 virt_ep
->stopped_td
= NULL
;
1863 virt_ep
->stopped_trb
= NULL
;
1864 virt_ep
->stopped_stream
= 0;
1865 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1868 xhci_warn(xhci
, "FIXME allocate a new ring segment\n");
1871 static int xhci_check_streams_endpoint(struct xhci_hcd
*xhci
,
1872 struct usb_device
*udev
, struct usb_host_endpoint
*ep
,
1873 unsigned int slot_id
)
1876 unsigned int ep_index
;
1877 unsigned int ep_state
;
1881 ret
= xhci_check_args(xhci_to_hcd(xhci
), udev
, ep
, 1, true, __func__
);
1884 if (ep
->ss_ep_comp
.bmAttributes
== 0) {
1885 xhci_warn(xhci
, "WARN: SuperSpeed Endpoint Companion"
1886 " descriptor for ep 0x%x does not support streams\n",
1887 ep
->desc
.bEndpointAddress
);
1891 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1892 ep_state
= xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
;
1893 if (ep_state
& EP_HAS_STREAMS
||
1894 ep_state
& EP_GETTING_STREAMS
) {
1895 xhci_warn(xhci
, "WARN: SuperSpeed bulk endpoint 0x%x "
1896 "already has streams set up.\n",
1897 ep
->desc
.bEndpointAddress
);
1898 xhci_warn(xhci
, "Send email to xHCI maintainer and ask for "
1899 "dynamic stream context array reallocation.\n");
1902 if (!list_empty(&xhci
->devs
[slot_id
]->eps
[ep_index
].ring
->td_list
)) {
1903 xhci_warn(xhci
, "Cannot setup streams for SuperSpeed bulk "
1904 "endpoint 0x%x; URBs are pending.\n",
1905 ep
->desc
.bEndpointAddress
);
1911 static void xhci_calculate_streams_entries(struct xhci_hcd
*xhci
,
1912 unsigned int *num_streams
, unsigned int *num_stream_ctxs
)
1914 unsigned int max_streams
;
1916 /* The stream context array size must be a power of two */
1917 *num_stream_ctxs
= roundup_pow_of_two(*num_streams
);
1919 * Find out how many primary stream array entries the host controller
1920 * supports. Later we may use secondary stream arrays (similar to 2nd
1921 * level page entries), but that's an optional feature for xHCI host
1922 * controllers. xHCs must support at least 4 stream IDs.
1924 max_streams
= HCC_MAX_PSA(xhci
->hcc_params
);
1925 if (*num_stream_ctxs
> max_streams
) {
1926 xhci_dbg(xhci
, "xHCI HW only supports %u stream ctx entries.\n",
1928 *num_stream_ctxs
= max_streams
;
1929 *num_streams
= max_streams
;
1933 /* Returns an error code if one of the endpoint already has streams.
1934 * This does not change any data structures, it only checks and gathers
1937 static int xhci_calculate_streams_and_bitmask(struct xhci_hcd
*xhci
,
1938 struct usb_device
*udev
,
1939 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
1940 unsigned int *num_streams
, u32
*changed_ep_bitmask
)
1942 unsigned int max_streams
;
1943 unsigned int endpoint_flag
;
1947 for (i
= 0; i
< num_eps
; i
++) {
1948 ret
= xhci_check_streams_endpoint(xhci
, udev
,
1949 eps
[i
], udev
->slot_id
);
1953 max_streams
= USB_SS_MAX_STREAMS(
1954 eps
[i
]->ss_ep_comp
.bmAttributes
);
1955 if (max_streams
< (*num_streams
- 1)) {
1956 xhci_dbg(xhci
, "Ep 0x%x only supports %u stream IDs.\n",
1957 eps
[i
]->desc
.bEndpointAddress
,
1959 *num_streams
= max_streams
+1;
1962 endpoint_flag
= xhci_get_endpoint_flag(&eps
[i
]->desc
);
1963 if (*changed_ep_bitmask
& endpoint_flag
)
1965 *changed_ep_bitmask
|= endpoint_flag
;
1970 static u32
xhci_calculate_no_streams_bitmask(struct xhci_hcd
*xhci
,
1971 struct usb_device
*udev
,
1972 struct usb_host_endpoint
**eps
, unsigned int num_eps
)
1974 u32 changed_ep_bitmask
= 0;
1975 unsigned int slot_id
;
1976 unsigned int ep_index
;
1977 unsigned int ep_state
;
1980 slot_id
= udev
->slot_id
;
1981 if (!xhci
->devs
[slot_id
])
1984 for (i
= 0; i
< num_eps
; i
++) {
1985 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
1986 ep_state
= xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
;
1987 /* Are streams already being freed for the endpoint? */
1988 if (ep_state
& EP_GETTING_NO_STREAMS
) {
1989 xhci_warn(xhci
, "WARN Can't disable streams for "
1991 "streams are being disabled already.",
1992 eps
[i
]->desc
.bEndpointAddress
);
1995 /* Are there actually any streams to free? */
1996 if (!(ep_state
& EP_HAS_STREAMS
) &&
1997 !(ep_state
& EP_GETTING_STREAMS
)) {
1998 xhci_warn(xhci
, "WARN Can't disable streams for "
2000 "streams are already disabled!",
2001 eps
[i
]->desc
.bEndpointAddress
);
2002 xhci_warn(xhci
, "WARN xhci_free_streams() called "
2003 "with non-streams endpoint\n");
2006 changed_ep_bitmask
|= xhci_get_endpoint_flag(&eps
[i
]->desc
);
2008 return changed_ep_bitmask
;
2012 * The USB device drivers use this function (though the HCD interface in USB
2013 * core) to prepare a set of bulk endpoints to use streams. Streams are used to
2014 * coordinate mass storage command queueing across multiple endpoints (basically
2015 * a stream ID == a task ID).
2017 * Setting up streams involves allocating the same size stream context array
2018 * for each endpoint and issuing a configure endpoint command for all endpoints.
2020 * Don't allow the call to succeed if one endpoint only supports one stream
2021 * (which means it doesn't support streams at all).
2023 * Drivers may get less stream IDs than they asked for, if the host controller
2024 * hardware or endpoints claim they can't support the number of requested
2027 int xhci_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2028 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2029 unsigned int num_streams
, gfp_t mem_flags
)
2032 struct xhci_hcd
*xhci
;
2033 struct xhci_virt_device
*vdev
;
2034 struct xhci_command
*config_cmd
;
2035 unsigned int ep_index
;
2036 unsigned int num_stream_ctxs
;
2037 unsigned long flags
;
2038 u32 changed_ep_bitmask
= 0;
2043 /* Add one to the number of streams requested to account for
2044 * stream 0 that is reserved for xHCI usage.
2047 xhci
= hcd_to_xhci(hcd
);
2048 xhci_dbg(xhci
, "Driver wants %u stream IDs (including stream 0).\n",
2051 config_cmd
= xhci_alloc_command(xhci
, true, true, mem_flags
);
2053 xhci_dbg(xhci
, "Could not allocate xHCI command structure.\n");
2057 /* Check to make sure all endpoints are not already configured for
2058 * streams. While we're at it, find the maximum number of streams that
2059 * all the endpoints will support and check for duplicate endpoints.
2061 spin_lock_irqsave(&xhci
->lock
, flags
);
2062 ret
= xhci_calculate_streams_and_bitmask(xhci
, udev
, eps
,
2063 num_eps
, &num_streams
, &changed_ep_bitmask
);
2065 xhci_free_command(xhci
, config_cmd
);
2066 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2069 if (num_streams
<= 1) {
2070 xhci_warn(xhci
, "WARN: endpoints can't handle "
2071 "more than one stream.\n");
2072 xhci_free_command(xhci
, config_cmd
);
2073 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2076 vdev
= xhci
->devs
[udev
->slot_id
];
2077 /* Mark each endpoint as being in transition, so
2078 * xhci_urb_enqueue() will reject all URBs.
2080 for (i
= 0; i
< num_eps
; i
++) {
2081 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2082 vdev
->eps
[ep_index
].ep_state
|= EP_GETTING_STREAMS
;
2084 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2086 /* Setup internal data structures and allocate HW data structures for
2087 * streams (but don't install the HW structures in the input context
2088 * until we're sure all memory allocation succeeded).
2090 xhci_calculate_streams_entries(xhci
, &num_streams
, &num_stream_ctxs
);
2091 xhci_dbg(xhci
, "Need %u stream ctx entries for %u stream IDs.\n",
2092 num_stream_ctxs
, num_streams
);
2094 for (i
= 0; i
< num_eps
; i
++) {
2095 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2096 vdev
->eps
[ep_index
].stream_info
= xhci_alloc_stream_info(xhci
,
2098 num_streams
, mem_flags
);
2099 if (!vdev
->eps
[ep_index
].stream_info
)
2101 /* Set maxPstreams in endpoint context and update deq ptr to
2102 * point to stream context array. FIXME
2106 /* Set up the input context for a configure endpoint command. */
2107 for (i
= 0; i
< num_eps
; i
++) {
2108 struct xhci_ep_ctx
*ep_ctx
;
2110 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2111 ep_ctx
= xhci_get_ep_ctx(xhci
, config_cmd
->in_ctx
, ep_index
);
2113 xhci_endpoint_copy(xhci
, config_cmd
->in_ctx
,
2114 vdev
->out_ctx
, ep_index
);
2115 xhci_setup_streams_ep_input_ctx(xhci
, ep_ctx
,
2116 vdev
->eps
[ep_index
].stream_info
);
2118 /* Tell the HW to drop its old copy of the endpoint context info
2119 * and add the updated copy from the input context.
2121 xhci_setup_input_ctx_for_config_ep(xhci
, config_cmd
->in_ctx
,
2122 vdev
->out_ctx
, changed_ep_bitmask
, changed_ep_bitmask
);
2124 /* Issue and wait for the configure endpoint command */
2125 ret
= xhci_configure_endpoint(xhci
, udev
, config_cmd
,
2128 /* xHC rejected the configure endpoint command for some reason, so we
2129 * leave the old ring intact and free our internal streams data
2135 spin_lock_irqsave(&xhci
->lock
, flags
);
2136 for (i
= 0; i
< num_eps
; i
++) {
2137 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2138 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_STREAMS
;
2139 xhci_dbg(xhci
, "Slot %u ep ctx %u now has streams.\n",
2140 udev
->slot_id
, ep_index
);
2141 vdev
->eps
[ep_index
].ep_state
|= EP_HAS_STREAMS
;
2143 xhci_free_command(xhci
, config_cmd
);
2144 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2146 /* Subtract 1 for stream 0, which drivers can't use */
2147 return num_streams
- 1;
2150 /* If it didn't work, free the streams! */
2151 for (i
= 0; i
< num_eps
; i
++) {
2152 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2153 xhci_free_stream_info(xhci
, vdev
->eps
[ep_index
].stream_info
);
2154 vdev
->eps
[ep_index
].stream_info
= NULL
;
2155 /* FIXME Unset maxPstreams in endpoint context and
2156 * update deq ptr to point to normal string ring.
2158 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_STREAMS
;
2159 vdev
->eps
[ep_index
].ep_state
&= ~EP_HAS_STREAMS
;
2160 xhci_endpoint_zero(xhci
, vdev
, eps
[i
]);
2162 xhci_free_command(xhci
, config_cmd
);
2166 /* Transition the endpoint from using streams to being a "normal" endpoint
2169 * Modify the endpoint context state, submit a configure endpoint command,
2170 * and free all endpoint rings for streams if that completes successfully.
2172 int xhci_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
2173 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
2177 struct xhci_hcd
*xhci
;
2178 struct xhci_virt_device
*vdev
;
2179 struct xhci_command
*command
;
2180 unsigned int ep_index
;
2181 unsigned long flags
;
2182 u32 changed_ep_bitmask
;
2184 xhci
= hcd_to_xhci(hcd
);
2185 vdev
= xhci
->devs
[udev
->slot_id
];
2187 /* Set up a configure endpoint command to remove the streams rings */
2188 spin_lock_irqsave(&xhci
->lock
, flags
);
2189 changed_ep_bitmask
= xhci_calculate_no_streams_bitmask(xhci
,
2190 udev
, eps
, num_eps
);
2191 if (changed_ep_bitmask
== 0) {
2192 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2196 /* Use the xhci_command structure from the first endpoint. We may have
2197 * allocated too many, but the driver may call xhci_free_streams() for
2198 * each endpoint it grouped into one call to xhci_alloc_streams().
2200 ep_index
= xhci_get_endpoint_index(&eps
[0]->desc
);
2201 command
= vdev
->eps
[ep_index
].stream_info
->free_streams_command
;
2202 for (i
= 0; i
< num_eps
; i
++) {
2203 struct xhci_ep_ctx
*ep_ctx
;
2205 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2206 ep_ctx
= xhci_get_ep_ctx(xhci
, command
->in_ctx
, ep_index
);
2207 xhci
->devs
[udev
->slot_id
]->eps
[ep_index
].ep_state
|=
2208 EP_GETTING_NO_STREAMS
;
2210 xhci_endpoint_copy(xhci
, command
->in_ctx
,
2211 vdev
->out_ctx
, ep_index
);
2212 xhci_setup_no_streams_ep_input_ctx(xhci
, ep_ctx
,
2213 &vdev
->eps
[ep_index
]);
2215 xhci_setup_input_ctx_for_config_ep(xhci
, command
->in_ctx
,
2216 vdev
->out_ctx
, changed_ep_bitmask
, changed_ep_bitmask
);
2217 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2219 /* Issue and wait for the configure endpoint command,
2220 * which must succeed.
2222 ret
= xhci_configure_endpoint(xhci
, udev
, command
,
2225 /* xHC rejected the configure endpoint command for some reason, so we
2226 * leave the streams rings intact.
2231 spin_lock_irqsave(&xhci
->lock
, flags
);
2232 for (i
= 0; i
< num_eps
; i
++) {
2233 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
2234 xhci_free_stream_info(xhci
, vdev
->eps
[ep_index
].stream_info
);
2235 vdev
->eps
[ep_index
].stream_info
= NULL
;
2236 /* FIXME Unset maxPstreams in endpoint context and
2237 * update deq ptr to point to normal string ring.
2239 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_NO_STREAMS
;
2240 vdev
->eps
[ep_index
].ep_state
&= ~EP_HAS_STREAMS
;
2242 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2248 * This submits a Reset Device Command, which will set the device state to 0,
2249 * set the device address to 0, and disable all the endpoints except the default
2250 * control endpoint. The USB core should come back and call
2251 * xhci_address_device(), and then re-set up the configuration. If this is
2252 * called because of a usb_reset_and_verify_device(), then the old alternate
2253 * settings will be re-installed through the normal bandwidth allocation
2256 * Wait for the Reset Device command to finish. Remove all structures
2257 * associated with the endpoints that were disabled. Clear the input device
2258 * structure? Cache the rings? Reset the control endpoint 0 max packet size?
2260 * If the virt_dev to be reset does not exist or does not match the udev,
2261 * it means the device is lost, possibly due to the xHC restore error and
2262 * re-initialization during S3/S4. In this case, call xhci_alloc_dev() to
2263 * re-allocate the device.
2265 int xhci_discover_or_reset_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2268 unsigned long flags
;
2269 struct xhci_hcd
*xhci
;
2270 unsigned int slot_id
;
2271 struct xhci_virt_device
*virt_dev
;
2272 struct xhci_command
*reset_device_cmd
;
2274 int last_freed_endpoint
;
2276 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, false, __func__
);
2279 xhci
= hcd_to_xhci(hcd
);
2280 slot_id
= udev
->slot_id
;
2281 virt_dev
= xhci
->devs
[slot_id
];
2283 xhci_dbg(xhci
, "The device to be reset with slot ID %u does "
2284 "not exist. Re-allocate the device\n", slot_id
);
2285 ret
= xhci_alloc_dev(hcd
, udev
);
2292 if (virt_dev
->udev
!= udev
) {
2293 /* If the virt_dev and the udev does not match, this virt_dev
2294 * may belong to another udev.
2295 * Re-allocate the device.
2297 xhci_dbg(xhci
, "The device to be reset with slot ID %u does "
2298 "not match the udev. Re-allocate the device\n",
2300 ret
= xhci_alloc_dev(hcd
, udev
);
2307 xhci_dbg(xhci
, "Resetting device with slot ID %u\n", slot_id
);
2308 /* Allocate the command structure that holds the struct completion.
2309 * Assume we're in process context, since the normal device reset
2310 * process has to wait for the device anyway. Storage devices are
2311 * reset as part of error handling, so use GFP_NOIO instead of
2314 reset_device_cmd
= xhci_alloc_command(xhci
, false, true, GFP_NOIO
);
2315 if (!reset_device_cmd
) {
2316 xhci_dbg(xhci
, "Couldn't allocate command structure.\n");
2320 /* Attempt to submit the Reset Device command to the command ring */
2321 spin_lock_irqsave(&xhci
->lock
, flags
);
2322 reset_device_cmd
->command_trb
= xhci
->cmd_ring
->enqueue
;
2324 /* Enqueue pointer can be left pointing to the link TRB,
2325 * we must handle that
2327 if ((reset_device_cmd
->command_trb
->link
.control
& TRB_TYPE_BITMASK
)
2328 == TRB_TYPE(TRB_LINK
))
2329 reset_device_cmd
->command_trb
=
2330 xhci
->cmd_ring
->enq_seg
->next
->trbs
;
2332 list_add_tail(&reset_device_cmd
->cmd_list
, &virt_dev
->cmd_list
);
2333 ret
= xhci_queue_reset_device(xhci
, slot_id
);
2335 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
2336 list_del(&reset_device_cmd
->cmd_list
);
2337 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2338 goto command_cleanup
;
2340 xhci_ring_cmd_db(xhci
);
2341 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2343 /* Wait for the Reset Device command to finish */
2344 timeleft
= wait_for_completion_interruptible_timeout(
2345 reset_device_cmd
->completion
,
2346 USB_CTRL_SET_TIMEOUT
);
2347 if (timeleft
<= 0) {
2348 xhci_warn(xhci
, "%s while waiting for reset device command\n",
2349 timeleft
== 0 ? "Timeout" : "Signal");
2350 spin_lock_irqsave(&xhci
->lock
, flags
);
2351 /* The timeout might have raced with the event ring handler, so
2352 * only delete from the list if the item isn't poisoned.
2354 if (reset_device_cmd
->cmd_list
.next
!= LIST_POISON1
)
2355 list_del(&reset_device_cmd
->cmd_list
);
2356 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2358 goto command_cleanup
;
2361 /* The Reset Device command can't fail, according to the 0.95/0.96 spec,
2362 * unless we tried to reset a slot ID that wasn't enabled,
2363 * or the device wasn't in the addressed or configured state.
2365 ret
= reset_device_cmd
->status
;
2367 case COMP_EBADSLT
: /* 0.95 completion code for bad slot ID */
2368 case COMP_CTX_STATE
: /* 0.96 completion code for same thing */
2369 xhci_info(xhci
, "Can't reset device (slot ID %u) in %s state\n",
2371 xhci_get_slot_state(xhci
, virt_dev
->out_ctx
));
2372 xhci_info(xhci
, "Not freeing device rings.\n");
2373 /* Don't treat this as an error. May change my mind later. */
2375 goto command_cleanup
;
2377 xhci_dbg(xhci
, "Successful reset device command.\n");
2380 if (xhci_is_vendor_info_code(xhci
, ret
))
2382 xhci_warn(xhci
, "Unknown completion code %u for "
2383 "reset device command.\n", ret
);
2385 goto command_cleanup
;
2388 /* Everything but endpoint 0 is disabled, so free or cache the rings. */
2389 last_freed_endpoint
= 1;
2390 for (i
= 1; i
< 31; ++i
) {
2391 struct xhci_virt_ep
*ep
= &virt_dev
->eps
[i
];
2393 if (ep
->ep_state
& EP_HAS_STREAMS
) {
2394 xhci_free_stream_info(xhci
, ep
->stream_info
);
2395 ep
->stream_info
= NULL
;
2396 ep
->ep_state
&= ~EP_HAS_STREAMS
;
2400 xhci_free_or_cache_endpoint_ring(xhci
, virt_dev
, i
);
2401 last_freed_endpoint
= i
;
2404 xhci_dbg(xhci
, "Output context after successful reset device cmd:\n");
2405 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, last_freed_endpoint
);
2409 xhci_free_command(xhci
, reset_device_cmd
);
2414 * At this point, the struct usb_device is about to go away, the device has
2415 * disconnected, and all traffic has been stopped and the endpoints have been
2416 * disabled. Free any HC data structures associated with that device.
2418 void xhci_free_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2420 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
2421 struct xhci_virt_device
*virt_dev
;
2422 unsigned long flags
;
2426 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
2430 virt_dev
= xhci
->devs
[udev
->slot_id
];
2432 /* Stop any wayward timer functions (which may grab the lock) */
2433 for (i
= 0; i
< 31; ++i
) {
2434 virt_dev
->eps
[i
].ep_state
&= ~EP_HALT_PENDING
;
2435 del_timer_sync(&virt_dev
->eps
[i
].stop_cmd_timer
);
2438 spin_lock_irqsave(&xhci
->lock
, flags
);
2439 /* Don't disable the slot if the host controller is dead. */
2440 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
2441 if (state
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_DYING
)) {
2442 xhci_free_virt_device(xhci
, udev
->slot_id
);
2443 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2447 if (xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
)) {
2448 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2449 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
2452 xhci_ring_cmd_db(xhci
);
2453 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2455 * Event command completion handler will free any data structures
2456 * associated with the slot. XXX Can free sleep?
2461 * Returns 0 if the xHC ran out of device slots, the Enable Slot command
2462 * timed out, or allocating memory failed. Returns 1 on success.
2464 int xhci_alloc_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2466 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
2467 unsigned long flags
;
2471 spin_lock_irqsave(&xhci
->lock
, flags
);
2472 ret
= xhci_queue_slot_control(xhci
, TRB_ENABLE_SLOT
, 0);
2474 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2475 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
2478 xhci_ring_cmd_db(xhci
);
2479 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2481 /* XXX: how much time for xHC slot assignment? */
2482 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
2483 USB_CTRL_SET_TIMEOUT
);
2484 if (timeleft
<= 0) {
2485 xhci_warn(xhci
, "%s while waiting for a slot\n",
2486 timeleft
== 0 ? "Timeout" : "Signal");
2487 /* FIXME cancel the enable slot request */
2491 if (!xhci
->slot_id
) {
2492 xhci_err(xhci
, "Error while assigning device slot ID\n");
2495 /* xhci_alloc_virt_device() does not touch rings; no need to lock.
2496 * Use GFP_NOIO, since this function can be called from
2497 * xhci_discover_or_reset_device(), which may be called as part of
2498 * mass storage driver error handling.
2500 if (!xhci_alloc_virt_device(xhci
, xhci
->slot_id
, udev
, GFP_NOIO
)) {
2501 /* Disable slot, if we can do it without mem alloc */
2502 xhci_warn(xhci
, "Could not allocate xHCI USB device data structures\n");
2503 spin_lock_irqsave(&xhci
->lock
, flags
);
2504 if (!xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
))
2505 xhci_ring_cmd_db(xhci
);
2506 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2509 udev
->slot_id
= xhci
->slot_id
;
2510 /* Is this a LS or FS device under a HS hub? */
2511 /* Hub or peripherial? */
2516 * Issue an Address Device command (which will issue a SetAddress request to
2518 * We should be protected by the usb_address0_mutex in khubd's hub_port_init, so
2519 * we should only issue and wait on one address command at the same time.
2521 * We add one to the device address issued by the hardware because the USB core
2522 * uses address 1 for the root hubs (even though they're not really devices).
2524 int xhci_address_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2526 unsigned long flags
;
2528 struct xhci_virt_device
*virt_dev
;
2530 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
2531 struct xhci_slot_ctx
*slot_ctx
;
2532 struct xhci_input_control_ctx
*ctrl_ctx
;
2535 if (!udev
->slot_id
) {
2536 xhci_dbg(xhci
, "Bad Slot ID %d\n", udev
->slot_id
);
2540 virt_dev
= xhci
->devs
[udev
->slot_id
];
2542 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
2544 * If this is the first Set Address since device plug-in or
2545 * virt_device realloaction after a resume with an xHCI power loss,
2546 * then set up the slot context.
2548 if (!slot_ctx
->dev_info
)
2549 xhci_setup_addressable_virt_dev(xhci
, udev
);
2550 /* Otherwise, update the control endpoint ring enqueue pointer. */
2552 xhci_copy_ep0_dequeue_into_input_ctx(xhci
, udev
);
2553 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
2554 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
2556 spin_lock_irqsave(&xhci
->lock
, flags
);
2557 ret
= xhci_queue_address_device(xhci
, virt_dev
->in_ctx
->dma
,
2560 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2561 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
2564 xhci_ring_cmd_db(xhci
);
2565 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2567 /* ctrl tx can take up to 5 sec; XXX: need more time for xHC? */
2568 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
2569 USB_CTRL_SET_TIMEOUT
);
2570 /* FIXME: From section 4.3.4: "Software shall be responsible for timing
2571 * the SetAddress() "recovery interval" required by USB and aborting the
2572 * command on a timeout.
2574 if (timeleft
<= 0) {
2575 xhci_warn(xhci
, "%s while waiting for a slot\n",
2576 timeleft
== 0 ? "Timeout" : "Signal");
2577 /* FIXME cancel the address device command */
2581 switch (virt_dev
->cmd_status
) {
2582 case COMP_CTX_STATE
:
2584 xhci_err(xhci
, "Setup ERROR: address device command for slot %d.\n",
2589 dev_warn(&udev
->dev
, "Device not responding to set address.\n");
2593 xhci_dbg(xhci
, "Successful Address Device command\n");
2596 xhci_err(xhci
, "ERROR: unexpected command completion "
2597 "code 0x%x.\n", virt_dev
->cmd_status
);
2598 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
2599 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
2606 temp_64
= xhci_read_64(xhci
, &xhci
->op_regs
->dcbaa_ptr
);
2607 xhci_dbg(xhci
, "Op regs DCBAA ptr = %#016llx\n", temp_64
);
2608 xhci_dbg(xhci
, "Slot ID %d dcbaa entry @%p = %#016llx\n",
2610 &xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
],
2611 (unsigned long long)
2612 xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
]);
2613 xhci_dbg(xhci
, "Output Context DMA address = %#08llx\n",
2614 (unsigned long long)virt_dev
->out_ctx
->dma
);
2615 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
2616 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
2617 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
2618 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
2620 * USB core uses address 1 for the roothubs, so we add one to the
2621 * address given back to us by the HC.
2623 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->out_ctx
);
2624 /* Use kernel assigned address for devices; store xHC assigned
2625 * address locally. */
2626 virt_dev
->address
= (slot_ctx
->dev_state
& DEV_ADDR_MASK
) + 1;
2627 /* Zero the input context control for later use */
2628 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
2629 ctrl_ctx
->add_flags
= 0;
2630 ctrl_ctx
->drop_flags
= 0;
2632 xhci_dbg(xhci
, "Internal device address = %d\n", virt_dev
->address
);
2637 /* Once a hub descriptor is fetched for a device, we need to update the xHC's
2638 * internal data structures for the device.
2640 int xhci_update_hub_device(struct usb_hcd
*hcd
, struct usb_device
*hdev
,
2641 struct usb_tt
*tt
, gfp_t mem_flags
)
2643 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
2644 struct xhci_virt_device
*vdev
;
2645 struct xhci_command
*config_cmd
;
2646 struct xhci_input_control_ctx
*ctrl_ctx
;
2647 struct xhci_slot_ctx
*slot_ctx
;
2648 unsigned long flags
;
2649 unsigned think_time
;
2652 /* Ignore root hubs */
2656 vdev
= xhci
->devs
[hdev
->slot_id
];
2658 xhci_warn(xhci
, "Cannot update hub desc for unknown device.\n");
2661 config_cmd
= xhci_alloc_command(xhci
, true, true, mem_flags
);
2663 xhci_dbg(xhci
, "Could not allocate xHCI command structure.\n");
2667 spin_lock_irqsave(&xhci
->lock
, flags
);
2668 xhci_slot_copy(xhci
, config_cmd
->in_ctx
, vdev
->out_ctx
);
2669 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, config_cmd
->in_ctx
);
2670 ctrl_ctx
->add_flags
|= SLOT_FLAG
;
2671 slot_ctx
= xhci_get_slot_ctx(xhci
, config_cmd
->in_ctx
);
2672 slot_ctx
->dev_info
|= DEV_HUB
;
2674 slot_ctx
->dev_info
|= DEV_MTT
;
2675 if (xhci
->hci_version
> 0x95) {
2676 xhci_dbg(xhci
, "xHCI version %x needs hub "
2677 "TT think time and number of ports\n",
2678 (unsigned int) xhci
->hci_version
);
2679 slot_ctx
->dev_info2
|= XHCI_MAX_PORTS(hdev
->maxchild
);
2680 /* Set TT think time - convert from ns to FS bit times.
2681 * 0 = 8 FS bit times, 1 = 16 FS bit times,
2682 * 2 = 24 FS bit times, 3 = 32 FS bit times.
2684 think_time
= tt
->think_time
;
2685 if (think_time
!= 0)
2686 think_time
= (think_time
/ 666) - 1;
2687 slot_ctx
->tt_info
|= TT_THINK_TIME(think_time
);
2689 xhci_dbg(xhci
, "xHCI version %x doesn't need hub "
2690 "TT think time or number of ports\n",
2691 (unsigned int) xhci
->hci_version
);
2693 slot_ctx
->dev_state
= 0;
2694 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2696 xhci_dbg(xhci
, "Set up %s for hub device.\n",
2697 (xhci
->hci_version
> 0x95) ?
2698 "configure endpoint" : "evaluate context");
2699 xhci_dbg(xhci
, "Slot %u Input Context:\n", hdev
->slot_id
);
2700 xhci_dbg_ctx(xhci
, config_cmd
->in_ctx
, 0);
2702 /* Issue and wait for the configure endpoint or
2703 * evaluate context command.
2705 if (xhci
->hci_version
> 0x95)
2706 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
2709 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
2712 xhci_dbg(xhci
, "Slot %u Output Context:\n", hdev
->slot_id
);
2713 xhci_dbg_ctx(xhci
, vdev
->out_ctx
, 0);
2715 xhci_free_command(xhci
, config_cmd
);
2719 int xhci_get_frame(struct usb_hcd
*hcd
)
2721 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
2722 /* EHCI mods by the periodic size. Why? */
2723 return xhci_readl(xhci
, &xhci
->run_regs
->microframe_index
) >> 3;
2726 MODULE_DESCRIPTION(DRIVER_DESC
);
2727 MODULE_AUTHOR(DRIVER_AUTHOR
);
2728 MODULE_LICENSE("GPL");
2730 static int __init
xhci_hcd_init(void)
2735 retval
= xhci_register_pci();
2738 printk(KERN_DEBUG
"Problem registering PCI driver.");
2743 * Check the compiler generated sizes of structures that must be laid
2744 * out in specific ways for hardware access.
2746 BUILD_BUG_ON(sizeof(struct xhci_doorbell_array
) != 256*32/8);
2747 BUILD_BUG_ON(sizeof(struct xhci_slot_ctx
) != 8*32/8);
2748 BUILD_BUG_ON(sizeof(struct xhci_ep_ctx
) != 8*32/8);
2749 /* xhci_device_control has eight fields, and also
2750 * embeds one xhci_slot_ctx and 31 xhci_ep_ctx
2752 BUILD_BUG_ON(sizeof(struct xhci_stream_ctx
) != 4*32/8);
2753 BUILD_BUG_ON(sizeof(union xhci_trb
) != 4*32/8);
2754 BUILD_BUG_ON(sizeof(struct xhci_erst_entry
) != 4*32/8);
2755 BUILD_BUG_ON(sizeof(struct xhci_cap_regs
) != 7*32/8);
2756 BUILD_BUG_ON(sizeof(struct xhci_intr_reg
) != 8*32/8);
2757 /* xhci_run_regs has eight fields and embeds 128 xhci_intr_regs */
2758 BUILD_BUG_ON(sizeof(struct xhci_run_regs
) != (8+8*128)*32/8);
2759 BUILD_BUG_ON(sizeof(struct xhci_doorbell_array
) != 256*32/8);
2762 module_init(xhci_hcd_init
);
2764 static void __exit
xhci_hcd_cleanup(void)
2767 xhci_unregister_pci();
2770 module_exit(xhci_hcd_cleanup
);