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>
29 #include <linux/dmi.h>
33 #define DRIVER_AUTHOR "Sarah Sharp"
34 #define DRIVER_DESC "'eXtensible' Host Controller (xHC) Driver"
36 /* Some 0.95 hardware can't handle the chain bit on a Link TRB being cleared */
37 static int link_quirk
;
38 module_param(link_quirk
, int, S_IRUGO
| S_IWUSR
);
39 MODULE_PARM_DESC(link_quirk
, "Don't clear the chain bit on a link TRB");
41 /* TODO: copied from ehci-hcd.c - can this be refactored? */
43 * xhci_handshake - spin reading hc until handshake completes or fails
44 * @ptr: address of hc register to be read
45 * @mask: bits to look at in result of read
46 * @done: value of those bits when handshake succeeds
47 * @usec: timeout in microseconds
49 * Returns negative errno, or zero on success
51 * Success happens when the "mask" bits have the specified value (hardware
52 * handshake done). There are two failure modes: "usec" have passed (major
53 * hardware flakeout), or the register reads as all-ones (hardware removed).
55 int xhci_handshake(struct xhci_hcd
*xhci
, void __iomem
*ptr
,
56 u32 mask
, u32 done
, int usec
)
61 result
= xhci_readl(xhci
, ptr
);
62 if (result
== ~(u32
)0) /* card removed */
74 * Disable interrupts and begin the xHCI halting process.
76 void xhci_quiesce(struct xhci_hcd
*xhci
)
83 halted
= xhci_readl(xhci
, &xhci
->op_regs
->status
) & STS_HALT
;
87 cmd
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
89 xhci_writel(xhci
, cmd
, &xhci
->op_regs
->command
);
93 * Force HC into halt state.
95 * Disable any IRQs and clear the run/stop bit.
96 * HC will complete any current and actively pipelined transactions, and
97 * should halt within 16 ms of the run/stop bit being cleared.
98 * Read HC Halted bit in the status register to see when the HC is finished.
100 int xhci_halt(struct xhci_hcd
*xhci
)
103 xhci_dbg(xhci
, "// Halt the HC\n");
106 ret
= xhci_handshake(xhci
, &xhci
->op_regs
->status
,
107 STS_HALT
, STS_HALT
, XHCI_MAX_HALT_USEC
);
109 xhci
->xhc_state
|= XHCI_STATE_HALTED
;
110 xhci
->cmd_ring_state
= CMD_RING_STATE_STOPPED
;
112 xhci_warn(xhci
, "Host not halted after %u microseconds.\n",
118 * Set the run bit and wait for the host to be running.
120 static int xhci_start(struct xhci_hcd
*xhci
)
125 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
127 xhci_dbg(xhci
, "// Turn on HC, cmd = 0x%x.\n",
129 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
132 * Wait for the HCHalted Status bit to be 0 to indicate the host is
135 ret
= xhci_handshake(xhci
, &xhci
->op_regs
->status
,
136 STS_HALT
, 0, XHCI_MAX_HALT_USEC
);
137 if (ret
== -ETIMEDOUT
)
138 xhci_err(xhci
, "Host took too long to start, "
139 "waited %u microseconds.\n",
142 xhci
->xhc_state
&= ~XHCI_STATE_HALTED
;
149 * This resets pipelines, timers, counters, state machines, etc.
150 * Transactions will be terminated immediately, and operational registers
151 * will be set to their defaults.
153 int xhci_reset(struct xhci_hcd
*xhci
)
159 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
160 if ((state
& STS_HALT
) == 0) {
161 xhci_warn(xhci
, "Host controller not halted, aborting reset.\n");
165 xhci_dbg(xhci
, "// Reset the HC\n");
166 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
167 command
|= CMD_RESET
;
168 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
170 ret
= xhci_handshake(xhci
, &xhci
->op_regs
->command
,
171 CMD_RESET
, 0, 10 * 1000 * 1000);
175 xhci_dbg(xhci
, "Wait for controller to be ready for doorbell rings\n");
177 * xHCI cannot write to any doorbells or operational registers other
178 * than status until the "Controller Not Ready" flag is cleared.
180 ret
= xhci_handshake(xhci
, &xhci
->op_regs
->status
,
181 STS_CNR
, 0, 10 * 1000 * 1000);
183 for (i
= 0; i
< 2; ++i
) {
184 xhci
->bus_state
[i
].port_c_suspend
= 0;
185 xhci
->bus_state
[i
].suspended_ports
= 0;
186 xhci
->bus_state
[i
].resuming_ports
= 0;
193 static int xhci_free_msi(struct xhci_hcd
*xhci
)
197 if (!xhci
->msix_entries
)
200 for (i
= 0; i
< xhci
->msix_count
; i
++)
201 if (xhci
->msix_entries
[i
].vector
)
202 free_irq(xhci
->msix_entries
[i
].vector
,
210 static int xhci_setup_msi(struct xhci_hcd
*xhci
)
213 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
215 ret
= pci_enable_msi(pdev
);
217 xhci_dbg(xhci
, "failed to allocate MSI entry\n");
221 ret
= request_irq(pdev
->irq
, xhci_msi_irq
,
222 0, "xhci_hcd", xhci_to_hcd(xhci
));
224 xhci_dbg(xhci
, "disable MSI interrupt\n");
225 pci_disable_msi(pdev
);
233 * free all IRQs request
235 static void xhci_free_irq(struct xhci_hcd
*xhci
)
237 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
240 /* return if using legacy interrupt */
241 if (xhci_to_hcd(xhci
)->irq
> 0)
244 ret
= xhci_free_msi(xhci
);
248 free_irq(pdev
->irq
, xhci_to_hcd(xhci
));
256 static int xhci_setup_msix(struct xhci_hcd
*xhci
)
259 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
260 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
263 * calculate number of msi-x vectors supported.
264 * - HCS_MAX_INTRS: the max number of interrupts the host can handle,
265 * with max number of interrupters based on the xhci HCSPARAMS1.
266 * - num_online_cpus: maximum msi-x vectors per CPUs core.
267 * Add additional 1 vector to ensure always available interrupt.
269 xhci
->msix_count
= min(num_online_cpus() + 1,
270 HCS_MAX_INTRS(xhci
->hcs_params1
));
273 kmalloc((sizeof(struct msix_entry
))*xhci
->msix_count
,
275 if (!xhci
->msix_entries
) {
276 xhci_err(xhci
, "Failed to allocate MSI-X entries\n");
280 for (i
= 0; i
< xhci
->msix_count
; i
++) {
281 xhci
->msix_entries
[i
].entry
= i
;
282 xhci
->msix_entries
[i
].vector
= 0;
285 ret
= pci_enable_msix(pdev
, xhci
->msix_entries
, xhci
->msix_count
);
287 xhci_dbg(xhci
, "Failed to enable MSI-X\n");
291 for (i
= 0; i
< xhci
->msix_count
; i
++) {
292 ret
= request_irq(xhci
->msix_entries
[i
].vector
,
294 0, "xhci_hcd", xhci_to_hcd(xhci
));
299 hcd
->msix_enabled
= 1;
303 xhci_dbg(xhci
, "disable MSI-X interrupt\n");
305 pci_disable_msix(pdev
);
307 kfree(xhci
->msix_entries
);
308 xhci
->msix_entries
= NULL
;
312 /* Free any IRQs and disable MSI-X */
313 static void xhci_cleanup_msix(struct xhci_hcd
*xhci
)
315 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
316 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
320 if (xhci
->msix_entries
) {
321 pci_disable_msix(pdev
);
322 kfree(xhci
->msix_entries
);
323 xhci
->msix_entries
= NULL
;
325 pci_disable_msi(pdev
);
328 hcd
->msix_enabled
= 0;
332 static void __maybe_unused
xhci_msix_sync_irqs(struct xhci_hcd
*xhci
)
336 if (xhci
->msix_entries
) {
337 for (i
= 0; i
< xhci
->msix_count
; i
++)
338 synchronize_irq(xhci
->msix_entries
[i
].vector
);
342 static int xhci_try_enable_msi(struct usb_hcd
*hcd
)
344 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
345 struct pci_dev
*pdev
= to_pci_dev(xhci_to_hcd(xhci
)->self
.controller
);
349 * Some Fresco Logic host controllers advertise MSI, but fail to
350 * generate interrupts. Don't even try to enable MSI.
352 if (xhci
->quirks
& XHCI_BROKEN_MSI
)
355 /* unregister the legacy interrupt */
357 free_irq(hcd
->irq
, hcd
);
360 ret
= xhci_setup_msix(xhci
);
362 /* fall back to msi*/
363 ret
= xhci_setup_msi(xhci
);
366 /* hcd->irq is 0, we have MSI */
370 xhci_err(xhci
, "No msi-x/msi found and no IRQ in BIOS\n");
375 /* fall back to legacy interrupt*/
376 ret
= request_irq(pdev
->irq
, &usb_hcd_irq
, IRQF_SHARED
,
377 hcd
->irq_descr
, hcd
);
379 xhci_err(xhci
, "request interrupt %d failed\n",
383 hcd
->irq
= pdev
->irq
;
389 static int xhci_try_enable_msi(struct usb_hcd
*hcd
)
394 static void xhci_cleanup_msix(struct xhci_hcd
*xhci
)
398 static void xhci_msix_sync_irqs(struct xhci_hcd
*xhci
)
404 static void compliance_mode_recovery(unsigned long arg
)
406 struct xhci_hcd
*xhci
;
411 xhci
= (struct xhci_hcd
*)arg
;
413 for (i
= 0; i
< xhci
->num_usb3_ports
; i
++) {
414 temp
= xhci_readl(xhci
, xhci
->usb3_ports
[i
]);
415 if ((temp
& PORT_PLS_MASK
) == USB_SS_PORT_LS_COMP_MOD
) {
417 * Compliance Mode Detected. Letting USB Core
418 * handle the Warm Reset
420 xhci_dbg(xhci
, "Compliance mode detected->port %d\n",
422 xhci_dbg(xhci
, "Attempting compliance mode recovery\n");
423 hcd
= xhci
->shared_hcd
;
425 if (hcd
->state
== HC_STATE_SUSPENDED
)
426 usb_hcd_resume_root_hub(hcd
);
428 usb_hcd_poll_rh_status(hcd
);
432 if (xhci
->port_status_u0
!= ((1 << xhci
->num_usb3_ports
)-1))
433 mod_timer(&xhci
->comp_mode_recovery_timer
,
434 jiffies
+ msecs_to_jiffies(COMP_MODE_RCVRY_MSECS
));
438 * Quirk to work around issue generated by the SN65LVPE502CP USB3.0 re-driver
439 * that causes ports behind that hardware to enter compliance mode sometimes.
440 * The quirk creates a timer that polls every 2 seconds the link state of
441 * each host controller's port and recovers it by issuing a Warm reset
442 * if Compliance mode is detected, otherwise the port will become "dead" (no
443 * device connections or disconnections will be detected anymore). Becasue no
444 * status event is generated when entering compliance mode (per xhci spec),
445 * this quirk is needed on systems that have the failing hardware installed.
447 static void compliance_mode_recovery_timer_init(struct xhci_hcd
*xhci
)
449 xhci
->port_status_u0
= 0;
450 init_timer(&xhci
->comp_mode_recovery_timer
);
452 xhci
->comp_mode_recovery_timer
.data
= (unsigned long) xhci
;
453 xhci
->comp_mode_recovery_timer
.function
= compliance_mode_recovery
;
454 xhci
->comp_mode_recovery_timer
.expires
= jiffies
+
455 msecs_to_jiffies(COMP_MODE_RCVRY_MSECS
);
457 set_timer_slack(&xhci
->comp_mode_recovery_timer
,
458 msecs_to_jiffies(COMP_MODE_RCVRY_MSECS
));
459 add_timer(&xhci
->comp_mode_recovery_timer
);
460 xhci_dbg(xhci
, "Compliance mode recovery timer initialized\n");
464 * This function identifies the systems that have installed the SN65LVPE502CP
465 * USB3.0 re-driver and that need the Compliance Mode Quirk.
467 * Vendor: Hewlett-Packard -> System Models: Z420, Z620 and Z820
469 bool xhci_compliance_mode_recovery_timer_quirk_check(void)
471 const char *dmi_product_name
, *dmi_sys_vendor
;
473 dmi_product_name
= dmi_get_system_info(DMI_PRODUCT_NAME
);
474 dmi_sys_vendor
= dmi_get_system_info(DMI_SYS_VENDOR
);
475 if (!dmi_product_name
|| !dmi_sys_vendor
)
478 if (!(strstr(dmi_sys_vendor
, "Hewlett-Packard")))
481 if (strstr(dmi_product_name
, "Z420") ||
482 strstr(dmi_product_name
, "Z620") ||
483 strstr(dmi_product_name
, "Z820") ||
484 strstr(dmi_product_name
, "Z1 Workstation"))
490 static int xhci_all_ports_seen_u0(struct xhci_hcd
*xhci
)
492 return (xhci
->port_status_u0
== ((1 << xhci
->num_usb3_ports
)-1));
497 * Initialize memory for HCD and xHC (one-time init).
499 * Program the PAGESIZE register, initialize the device context array, create
500 * device contexts (?), set up a command ring segment (or two?), create event
501 * ring (one for now).
503 int xhci_init(struct usb_hcd
*hcd
)
505 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
508 xhci_dbg(xhci
, "xhci_init\n");
509 spin_lock_init(&xhci
->lock
);
510 if (xhci
->hci_version
== 0x95 && link_quirk
) {
511 xhci_dbg(xhci
, "QUIRK: Not clearing Link TRB chain bits.\n");
512 xhci
->quirks
|= XHCI_LINK_TRB_QUIRK
;
514 xhci_dbg(xhci
, "xHCI doesn't need link TRB QUIRK\n");
516 retval
= xhci_mem_init(xhci
, GFP_KERNEL
);
517 xhci_dbg(xhci
, "Finished xhci_init\n");
519 /* Initializing Compliance Mode Recovery Data If Needed */
520 if (xhci_compliance_mode_recovery_timer_quirk_check()) {
521 xhci
->quirks
|= XHCI_COMP_MODE_QUIRK
;
522 compliance_mode_recovery_timer_init(xhci
);
528 /*-------------------------------------------------------------------------*/
531 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
532 static void xhci_event_ring_work(unsigned long arg
)
537 struct xhci_hcd
*xhci
= (struct xhci_hcd
*) arg
;
540 xhci_dbg(xhci
, "Poll event ring: %lu\n", jiffies
);
542 spin_lock_irqsave(&xhci
->lock
, flags
);
543 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
544 xhci_dbg(xhci
, "op reg status = 0x%x\n", temp
);
545 if (temp
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_DYING
) ||
546 (xhci
->xhc_state
& XHCI_STATE_HALTED
)) {
547 xhci_dbg(xhci
, "HW died, polling stopped.\n");
548 spin_unlock_irqrestore(&xhci
->lock
, flags
);
552 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
553 xhci_dbg(xhci
, "ir_set 0 pending = 0x%x\n", temp
);
554 xhci_dbg(xhci
, "HC error bitmask = 0x%x\n", xhci
->error_bitmask
);
555 xhci
->error_bitmask
= 0;
556 xhci_dbg(xhci
, "Event ring:\n");
557 xhci_debug_segment(xhci
, xhci
->event_ring
->deq_seg
);
558 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
559 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
560 temp_64
&= ~ERST_PTR_MASK
;
561 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
562 xhci_dbg(xhci
, "Command ring:\n");
563 xhci_debug_segment(xhci
, xhci
->cmd_ring
->deq_seg
);
564 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
565 xhci_dbg_cmd_ptrs(xhci
);
566 for (i
= 0; i
< MAX_HC_SLOTS
; ++i
) {
569 for (j
= 0; j
< 31; ++j
) {
570 xhci_dbg_ep_rings(xhci
, i
, j
, &xhci
->devs
[i
]->eps
[j
]);
573 spin_unlock_irqrestore(&xhci
->lock
, flags
);
576 mod_timer(&xhci
->event_ring_timer
, jiffies
+ POLL_TIMEOUT
* HZ
);
578 xhci_dbg(xhci
, "Quit polling the event ring.\n");
582 static int xhci_run_finished(struct xhci_hcd
*xhci
)
584 if (xhci_start(xhci
)) {
588 xhci
->shared_hcd
->state
= HC_STATE_RUNNING
;
589 xhci
->cmd_ring_state
= CMD_RING_STATE_RUNNING
;
591 if (xhci
->quirks
& XHCI_NEC_HOST
)
592 xhci_ring_cmd_db(xhci
);
594 xhci_dbg(xhci
, "Finished xhci_run for USB3 roothub\n");
599 * Start the HC after it was halted.
601 * This function is called by the USB core when the HC driver is added.
602 * Its opposite is xhci_stop().
604 * xhci_init() must be called once before this function can be called.
605 * Reset the HC, enable device slot contexts, program DCBAAP, and
606 * set command ring pointer and event ring pointer.
608 * Setup MSI-X vectors and enable interrupts.
610 int xhci_run(struct usb_hcd
*hcd
)
615 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
617 /* Start the xHCI host controller running only after the USB 2.0 roothub
621 hcd
->uses_new_polling
= 1;
622 if (!usb_hcd_is_primary_hcd(hcd
))
623 return xhci_run_finished(xhci
);
625 xhci_dbg(xhci
, "xhci_run\n");
627 ret
= xhci_try_enable_msi(hcd
);
631 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
632 init_timer(&xhci
->event_ring_timer
);
633 xhci
->event_ring_timer
.data
= (unsigned long) xhci
;
634 xhci
->event_ring_timer
.function
= xhci_event_ring_work
;
635 /* Poll the event ring */
636 xhci
->event_ring_timer
.expires
= jiffies
+ POLL_TIMEOUT
* HZ
;
638 xhci_dbg(xhci
, "Setting event ring polling timer\n");
639 add_timer(&xhci
->event_ring_timer
);
642 xhci_dbg(xhci
, "Command ring memory map follows:\n");
643 xhci_debug_ring(xhci
, xhci
->cmd_ring
);
644 xhci_dbg_ring_ptrs(xhci
, xhci
->cmd_ring
);
645 xhci_dbg_cmd_ptrs(xhci
);
647 xhci_dbg(xhci
, "ERST memory map follows:\n");
648 xhci_dbg_erst(xhci
, &xhci
->erst
);
649 xhci_dbg(xhci
, "Event ring:\n");
650 xhci_debug_ring(xhci
, xhci
->event_ring
);
651 xhci_dbg_ring_ptrs(xhci
, xhci
->event_ring
);
652 temp_64
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
653 temp_64
&= ~ERST_PTR_MASK
;
654 xhci_dbg(xhci
, "ERST deq = 64'h%0lx\n", (long unsigned int) temp_64
);
656 xhci_dbg(xhci
, "// Set the interrupt modulation register\n");
657 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
658 temp
&= ~ER_IRQ_INTERVAL_MASK
;
660 xhci_writel(xhci
, temp
, &xhci
->ir_set
->irq_control
);
662 /* Set the HCD state before we enable the irqs */
663 temp
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
665 xhci_dbg(xhci
, "// Enable interrupts, cmd = 0x%x.\n",
667 xhci_writel(xhci
, temp
, &xhci
->op_regs
->command
);
669 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
670 xhci_dbg(xhci
, "// Enabling event ring interrupter %p by writing 0x%x to irq_pending\n",
671 xhci
->ir_set
, (unsigned int) ER_IRQ_ENABLE(temp
));
672 xhci_writel(xhci
, ER_IRQ_ENABLE(temp
),
673 &xhci
->ir_set
->irq_pending
);
674 xhci_print_ir_set(xhci
, 0);
676 if (xhci
->quirks
& XHCI_NEC_HOST
)
677 xhci_queue_vendor_command(xhci
, 0, 0, 0,
678 TRB_TYPE(TRB_NEC_GET_FW
));
680 xhci_dbg(xhci
, "Finished xhci_run for USB2 roothub\n");
684 static void xhci_only_stop_hcd(struct usb_hcd
*hcd
)
686 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
688 spin_lock_irq(&xhci
->lock
);
691 /* The shared_hcd is going to be deallocated shortly (the USB core only
692 * calls this function when allocation fails in usb_add_hcd(), or
693 * usb_remove_hcd() is called). So we need to unset xHCI's pointer.
695 xhci
->shared_hcd
= NULL
;
696 spin_unlock_irq(&xhci
->lock
);
702 * This function is called by the USB core when the HC driver is removed.
703 * Its opposite is xhci_run().
705 * Disable device contexts, disable IRQs, and quiesce the HC.
706 * Reset the HC, finish any completed transactions, and cleanup memory.
708 void xhci_stop(struct usb_hcd
*hcd
)
711 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
713 if (!usb_hcd_is_primary_hcd(hcd
)) {
714 xhci_only_stop_hcd(xhci
->shared_hcd
);
718 spin_lock_irq(&xhci
->lock
);
719 /* Make sure the xHC is halted for a USB3 roothub
720 * (xhci_stop() could be called as part of failed init).
724 spin_unlock_irq(&xhci
->lock
);
726 xhci_cleanup_msix(xhci
);
728 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
729 /* Tell the event ring poll function not to reschedule */
731 del_timer_sync(&xhci
->event_ring_timer
);
734 /* Deleting Compliance Mode Recovery Timer */
735 if ((xhci
->quirks
& XHCI_COMP_MODE_QUIRK
) &&
736 (!(xhci_all_ports_seen_u0(xhci
)))) {
737 del_timer_sync(&xhci
->comp_mode_recovery_timer
);
738 xhci_dbg(xhci
, "%s: compliance mode recovery timer deleted\n",
742 if (xhci
->quirks
& XHCI_AMD_PLL_FIX
)
745 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
746 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
747 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
748 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
749 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
750 &xhci
->ir_set
->irq_pending
);
751 xhci_print_ir_set(xhci
, 0);
753 xhci_dbg(xhci
, "cleaning up memory\n");
754 xhci_mem_cleanup(xhci
);
755 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
756 xhci_readl(xhci
, &xhci
->op_regs
->status
));
760 * Shutdown HC (not bus-specific)
762 * This is called when the machine is rebooting or halting. We assume that the
763 * machine will be powered off, and the HC's internal state will be reset.
764 * Don't bother to free memory.
766 * This will only ever be called with the main usb_hcd (the USB3 roothub).
768 void xhci_shutdown(struct usb_hcd
*hcd
)
770 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
772 if (xhci
->quirks
& XHCI_SPURIOUS_REBOOT
)
773 usb_disable_xhci_ports(to_pci_dev(hcd
->self
.controller
));
775 spin_lock_irq(&xhci
->lock
);
777 spin_unlock_irq(&xhci
->lock
);
779 xhci_cleanup_msix(xhci
);
781 xhci_dbg(xhci
, "xhci_shutdown completed - status = %x\n",
782 xhci_readl(xhci
, &xhci
->op_regs
->status
));
786 static void xhci_save_registers(struct xhci_hcd
*xhci
)
788 xhci
->s3
.command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
789 xhci
->s3
.dev_nt
= xhci_readl(xhci
, &xhci
->op_regs
->dev_notification
);
790 xhci
->s3
.dcbaa_ptr
= xhci_read_64(xhci
, &xhci
->op_regs
->dcbaa_ptr
);
791 xhci
->s3
.config_reg
= xhci_readl(xhci
, &xhci
->op_regs
->config_reg
);
792 xhci
->s3
.erst_size
= xhci_readl(xhci
, &xhci
->ir_set
->erst_size
);
793 xhci
->s3
.erst_base
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_base
);
794 xhci
->s3
.erst_dequeue
= xhci_read_64(xhci
, &xhci
->ir_set
->erst_dequeue
);
795 xhci
->s3
.irq_pending
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
796 xhci
->s3
.irq_control
= xhci_readl(xhci
, &xhci
->ir_set
->irq_control
);
799 static void xhci_restore_registers(struct xhci_hcd
*xhci
)
801 xhci_writel(xhci
, xhci
->s3
.command
, &xhci
->op_regs
->command
);
802 xhci_writel(xhci
, xhci
->s3
.dev_nt
, &xhci
->op_regs
->dev_notification
);
803 xhci_write_64(xhci
, xhci
->s3
.dcbaa_ptr
, &xhci
->op_regs
->dcbaa_ptr
);
804 xhci_writel(xhci
, xhci
->s3
.config_reg
, &xhci
->op_regs
->config_reg
);
805 xhci_writel(xhci
, xhci
->s3
.erst_size
, &xhci
->ir_set
->erst_size
);
806 xhci_write_64(xhci
, xhci
->s3
.erst_base
, &xhci
->ir_set
->erst_base
);
807 xhci_write_64(xhci
, xhci
->s3
.erst_dequeue
, &xhci
->ir_set
->erst_dequeue
);
808 xhci_writel(xhci
, xhci
->s3
.irq_pending
, &xhci
->ir_set
->irq_pending
);
809 xhci_writel(xhci
, xhci
->s3
.irq_control
, &xhci
->ir_set
->irq_control
);
812 static void xhci_set_cmd_ring_deq(struct xhci_hcd
*xhci
)
816 /* step 2: initialize command ring buffer */
817 val_64
= xhci_read_64(xhci
, &xhci
->op_regs
->cmd_ring
);
818 val_64
= (val_64
& (u64
) CMD_RING_RSVD_BITS
) |
819 (xhci_trb_virt_to_dma(xhci
->cmd_ring
->deq_seg
,
820 xhci
->cmd_ring
->dequeue
) &
821 (u64
) ~CMD_RING_RSVD_BITS
) |
822 xhci
->cmd_ring
->cycle_state
;
823 xhci_dbg(xhci
, "// Setting command ring address to 0x%llx\n",
824 (long unsigned long) val_64
);
825 xhci_write_64(xhci
, val_64
, &xhci
->op_regs
->cmd_ring
);
829 * The whole command ring must be cleared to zero when we suspend the host.
831 * The host doesn't save the command ring pointer in the suspend well, so we
832 * need to re-program it on resume. Unfortunately, the pointer must be 64-byte
833 * aligned, because of the reserved bits in the command ring dequeue pointer
834 * register. Therefore, we can't just set the dequeue pointer back in the
835 * middle of the ring (TRBs are 16-byte aligned).
837 static void xhci_clear_command_ring(struct xhci_hcd
*xhci
)
839 struct xhci_ring
*ring
;
840 struct xhci_segment
*seg
;
842 ring
= xhci
->cmd_ring
;
846 sizeof(union xhci_trb
) * (TRBS_PER_SEGMENT
- 1));
847 seg
->trbs
[TRBS_PER_SEGMENT
- 1].link
.control
&=
848 cpu_to_le32(~TRB_CYCLE
);
850 } while (seg
!= ring
->deq_seg
);
852 /* Reset the software enqueue and dequeue pointers */
853 ring
->deq_seg
= ring
->first_seg
;
854 ring
->dequeue
= ring
->first_seg
->trbs
;
855 ring
->enq_seg
= ring
->deq_seg
;
856 ring
->enqueue
= ring
->dequeue
;
858 ring
->num_trbs_free
= ring
->num_segs
* (TRBS_PER_SEGMENT
- 1) - 1;
860 * Ring is now zeroed, so the HW should look for change of ownership
861 * when the cycle bit is set to 1.
863 ring
->cycle_state
= 1;
866 * Reset the hardware dequeue pointer.
867 * Yes, this will need to be re-written after resume, but we're paranoid
868 * and want to make sure the hardware doesn't access bogus memory
869 * because, say, the BIOS or an SMI started the host without changing
870 * the command ring pointers.
872 xhci_set_cmd_ring_deq(xhci
);
876 * Stop HC (not bus-specific)
878 * This is called when the machine transition into S3/S4 mode.
881 int xhci_suspend(struct xhci_hcd
*xhci
)
884 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
887 if (hcd
->state
!= HC_STATE_SUSPENDED
||
888 xhci
->shared_hcd
->state
!= HC_STATE_SUSPENDED
)
891 /* Don't poll the roothubs on bus suspend. */
892 xhci_dbg(xhci
, "%s: stopping port polling.\n", __func__
);
893 clear_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
894 del_timer_sync(&hcd
->rh_timer
);
896 spin_lock_irq(&xhci
->lock
);
897 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
898 clear_bit(HCD_FLAG_HW_ACCESSIBLE
, &xhci
->shared_hcd
->flags
);
899 /* step 1: stop endpoint */
900 /* skipped assuming that port suspend has done */
902 /* step 2: clear Run/Stop bit */
903 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
905 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
906 if (xhci_handshake(xhci
, &xhci
->op_regs
->status
,
907 STS_HALT
, STS_HALT
, XHCI_MAX_HALT_USEC
)) {
908 xhci_warn(xhci
, "WARN: xHC CMD_RUN timeout\n");
909 spin_unlock_irq(&xhci
->lock
);
912 xhci_clear_command_ring(xhci
);
914 /* step 3: save registers */
915 xhci_save_registers(xhci
);
917 /* step 4: set CSS flag */
918 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
920 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
921 if (xhci_handshake(xhci
, &xhci
->op_regs
->status
,
922 STS_SAVE
, 0, 10 * 1000)) {
923 xhci_warn(xhci
, "WARN: xHC save state timeout\n");
924 spin_unlock_irq(&xhci
->lock
);
927 spin_unlock_irq(&xhci
->lock
);
930 * Deleting Compliance Mode Recovery Timer because the xHCI Host
931 * is about to be suspended.
933 if ((xhci
->quirks
& XHCI_COMP_MODE_QUIRK
) &&
934 (!(xhci_all_ports_seen_u0(xhci
)))) {
935 del_timer_sync(&xhci
->comp_mode_recovery_timer
);
936 xhci_dbg(xhci
, "%s: compliance mode recovery timer deleted\n",
940 /* step 5: remove core well power */
941 /* synchronize irq when using MSI-X */
942 xhci_msix_sync_irqs(xhci
);
948 * start xHC (not bus-specific)
950 * This is called when the machine transition from S3/S4 mode.
953 int xhci_resume(struct xhci_hcd
*xhci
, bool hibernated
)
955 u32 command
, temp
= 0;
956 struct usb_hcd
*hcd
= xhci_to_hcd(xhci
);
957 struct usb_hcd
*secondary_hcd
;
959 bool comp_timer_running
= false;
961 /* Wait a bit if either of the roothubs need to settle from the
962 * transition into bus suspend.
964 if (time_before(jiffies
, xhci
->bus_state
[0].next_statechange
) ||
966 xhci
->bus_state
[1].next_statechange
))
969 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &hcd
->flags
);
970 set_bit(HCD_FLAG_HW_ACCESSIBLE
, &xhci
->shared_hcd
->flags
);
972 spin_lock_irq(&xhci
->lock
);
973 if (xhci
->quirks
& XHCI_RESET_ON_RESUME
)
977 /* step 1: restore register */
978 xhci_restore_registers(xhci
);
979 /* step 2: initialize command ring buffer */
980 xhci_set_cmd_ring_deq(xhci
);
981 /* step 3: restore state and start state*/
982 /* step 3: set CRS flag */
983 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
985 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
986 if (xhci_handshake(xhci
, &xhci
->op_regs
->status
,
987 STS_RESTORE
, 0, 10 * 1000)) {
988 xhci_warn(xhci
, "WARN: xHC restore state timeout\n");
989 spin_unlock_irq(&xhci
->lock
);
992 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
995 /* If restore operation fails, re-initialize the HC during resume */
996 if ((temp
& STS_SRE
) || hibernated
) {
998 if ((xhci
->quirks
& XHCI_COMP_MODE_QUIRK
) &&
999 !(xhci_all_ports_seen_u0(xhci
))) {
1000 del_timer_sync(&xhci
->comp_mode_recovery_timer
);
1001 xhci_dbg(xhci
, "Compliance Mode Recovery Timer deleted!\n");
1004 /* Let the USB core know _both_ roothubs lost power. */
1005 usb_root_hub_lost_power(xhci
->main_hcd
->self
.root_hub
);
1006 usb_root_hub_lost_power(xhci
->shared_hcd
->self
.root_hub
);
1008 xhci_dbg(xhci
, "Stop HCD\n");
1011 spin_unlock_irq(&xhci
->lock
);
1012 xhci_cleanup_msix(xhci
);
1014 #ifdef CONFIG_USB_XHCI_HCD_DEBUGGING
1015 /* Tell the event ring poll function not to reschedule */
1017 del_timer_sync(&xhci
->event_ring_timer
);
1020 xhci_dbg(xhci
, "// Disabling event ring interrupts\n");
1021 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
1022 xhci_writel(xhci
, temp
& ~STS_EINT
, &xhci
->op_regs
->status
);
1023 temp
= xhci_readl(xhci
, &xhci
->ir_set
->irq_pending
);
1024 xhci_writel(xhci
, ER_IRQ_DISABLE(temp
),
1025 &xhci
->ir_set
->irq_pending
);
1026 xhci_print_ir_set(xhci
, 0);
1028 xhci_dbg(xhci
, "cleaning up memory\n");
1029 xhci_mem_cleanup(xhci
);
1030 xhci_dbg(xhci
, "xhci_stop completed - status = %x\n",
1031 xhci_readl(xhci
, &xhci
->op_regs
->status
));
1033 /* USB core calls the PCI reinit and start functions twice:
1034 * first with the primary HCD, and then with the secondary HCD.
1035 * If we don't do the same, the host will never be started.
1037 if (!usb_hcd_is_primary_hcd(hcd
))
1038 secondary_hcd
= hcd
;
1040 secondary_hcd
= xhci
->shared_hcd
;
1042 xhci_dbg(xhci
, "Initialize the xhci_hcd\n");
1043 retval
= xhci_init(hcd
->primary_hcd
);
1046 comp_timer_running
= true;
1048 xhci_dbg(xhci
, "Start the primary HCD\n");
1049 retval
= xhci_run(hcd
->primary_hcd
);
1051 xhci_dbg(xhci
, "Start the secondary HCD\n");
1052 retval
= xhci_run(secondary_hcd
);
1054 hcd
->state
= HC_STATE_SUSPENDED
;
1055 xhci
->shared_hcd
->state
= HC_STATE_SUSPENDED
;
1059 /* step 4: set Run/Stop bit */
1060 command
= xhci_readl(xhci
, &xhci
->op_regs
->command
);
1062 xhci_writel(xhci
, command
, &xhci
->op_regs
->command
);
1063 xhci_handshake(xhci
, &xhci
->op_regs
->status
, STS_HALT
,
1066 /* step 5: walk topology and initialize portsc,
1067 * portpmsc and portli
1069 /* this is done in bus_resume */
1071 /* step 6: restart each of the previously
1072 * Running endpoints by ringing their doorbells
1075 spin_unlock_irq(&xhci
->lock
);
1079 usb_hcd_resume_root_hub(hcd
);
1080 usb_hcd_resume_root_hub(xhci
->shared_hcd
);
1084 * If system is subject to the Quirk, Compliance Mode Timer needs to
1085 * be re-initialized Always after a system resume. Ports are subject
1086 * to suffer the Compliance Mode issue again. It doesn't matter if
1087 * ports have entered previously to U0 before system's suspension.
1089 if ((xhci
->quirks
& XHCI_COMP_MODE_QUIRK
) && !comp_timer_running
)
1090 compliance_mode_recovery_timer_init(xhci
);
1092 /* Re-enable port polling. */
1093 xhci_dbg(xhci
, "%s: starting port polling.\n", __func__
);
1094 set_bit(HCD_FLAG_POLL_RH
, &hcd
->flags
);
1095 usb_hcd_poll_rh_status(hcd
);
1099 #endif /* CONFIG_PM */
1101 /*-------------------------------------------------------------------------*/
1104 * xhci_get_endpoint_index - Used for passing endpoint bitmasks between the core and
1105 * HCDs. Find the index for an endpoint given its descriptor. Use the return
1106 * value to right shift 1 for the bitmask.
1108 * Index = (epnum * 2) + direction - 1,
1109 * where direction = 0 for OUT, 1 for IN.
1110 * For control endpoints, the IN index is used (OUT index is unused), so
1111 * index = (epnum * 2) + direction - 1 = (epnum * 2) + 1 - 1 = (epnum * 2)
1113 unsigned int xhci_get_endpoint_index(struct usb_endpoint_descriptor
*desc
)
1116 if (usb_endpoint_xfer_control(desc
))
1117 index
= (unsigned int) (usb_endpoint_num(desc
)*2);
1119 index
= (unsigned int) (usb_endpoint_num(desc
)*2) +
1120 (usb_endpoint_dir_in(desc
) ? 1 : 0) - 1;
1124 /* The reverse operation to xhci_get_endpoint_index. Calculate the USB endpoint
1125 * address from the XHCI endpoint index.
1127 unsigned int xhci_get_endpoint_address(unsigned int ep_index
)
1129 unsigned int number
= DIV_ROUND_UP(ep_index
, 2);
1130 unsigned int direction
= ep_index
% 2 ? USB_DIR_OUT
: USB_DIR_IN
;
1131 return direction
| number
;
1134 /* Find the flag for this endpoint (for use in the control context). Use the
1135 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
1138 unsigned int xhci_get_endpoint_flag(struct usb_endpoint_descriptor
*desc
)
1140 return 1 << (xhci_get_endpoint_index(desc
) + 1);
1143 /* Find the flag for this endpoint (for use in the control context). Use the
1144 * endpoint index to create a bitmask. The slot context is bit 0, endpoint 0 is
1147 unsigned int xhci_get_endpoint_flag_from_index(unsigned int ep_index
)
1149 return 1 << (ep_index
+ 1);
1152 /* Compute the last valid endpoint context index. Basically, this is the
1153 * endpoint index plus one. For slot contexts with more than valid endpoint,
1154 * we find the most significant bit set in the added contexts flags.
1155 * e.g. ep 1 IN (with epnum 0x81) => added_ctxs = 0b1000
1156 * fls(0b1000) = 4, but the endpoint context index is 3, so subtract one.
1158 unsigned int xhci_last_valid_endpoint(u32 added_ctxs
)
1160 return fls(added_ctxs
) - 1;
1163 /* Returns 1 if the arguments are OK;
1164 * returns 0 this is a root hub; returns -EINVAL for NULL pointers.
1166 static int xhci_check_args(struct usb_hcd
*hcd
, struct usb_device
*udev
,
1167 struct usb_host_endpoint
*ep
, int check_ep
, bool check_virt_dev
,
1169 struct xhci_hcd
*xhci
;
1170 struct xhci_virt_device
*virt_dev
;
1172 if (!hcd
|| (check_ep
&& !ep
) || !udev
) {
1173 pr_debug("xHCI %s called with invalid args\n", func
);
1176 if (!udev
->parent
) {
1177 pr_debug("xHCI %s called for root hub\n", func
);
1181 xhci
= hcd_to_xhci(hcd
);
1182 if (check_virt_dev
) {
1183 if (!udev
->slot_id
|| !xhci
->devs
[udev
->slot_id
]) {
1184 xhci_dbg(xhci
, "xHCI %s called with unaddressed device\n",
1189 virt_dev
= xhci
->devs
[udev
->slot_id
];
1190 if (virt_dev
->udev
!= udev
) {
1191 xhci_dbg(xhci
, "xHCI %s called with udev and "
1192 "virt_dev does not match\n", func
);
1197 if (xhci
->xhc_state
& XHCI_STATE_HALTED
)
1203 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
1204 struct usb_device
*udev
, struct xhci_command
*command
,
1205 bool ctx_change
, bool must_succeed
);
1208 * Full speed devices may have a max packet size greater than 8 bytes, but the
1209 * USB core doesn't know that until it reads the first 8 bytes of the
1210 * descriptor. If the usb_device's max packet size changes after that point,
1211 * we need to issue an evaluate context command and wait on it.
1213 static int xhci_check_maxpacket(struct xhci_hcd
*xhci
, unsigned int slot_id
,
1214 unsigned int ep_index
, struct urb
*urb
)
1216 struct xhci_container_ctx
*in_ctx
;
1217 struct xhci_container_ctx
*out_ctx
;
1218 struct xhci_input_control_ctx
*ctrl_ctx
;
1219 struct xhci_ep_ctx
*ep_ctx
;
1220 int max_packet_size
;
1221 int hw_max_packet_size
;
1224 out_ctx
= xhci
->devs
[slot_id
]->out_ctx
;
1225 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
1226 hw_max_packet_size
= MAX_PACKET_DECODED(le32_to_cpu(ep_ctx
->ep_info2
));
1227 max_packet_size
= usb_endpoint_maxp(&urb
->dev
->ep0
.desc
);
1228 if (hw_max_packet_size
!= max_packet_size
) {
1229 xhci_dbg(xhci
, "Max Packet Size for ep 0 changed.\n");
1230 xhci_dbg(xhci
, "Max packet size in usb_device = %d\n",
1232 xhci_dbg(xhci
, "Max packet size in xHCI HW = %d\n",
1233 hw_max_packet_size
);
1234 xhci_dbg(xhci
, "Issuing evaluate context command.\n");
1236 /* Set up the input context flags for the command */
1237 /* FIXME: This won't work if a non-default control endpoint
1238 * changes max packet sizes.
1240 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
1241 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1243 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
1247 /* Set up the modified control endpoint 0 */
1248 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
1249 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
1251 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
1252 ep_ctx
->ep_info2
&= cpu_to_le32(~MAX_PACKET_MASK
);
1253 ep_ctx
->ep_info2
|= cpu_to_le32(MAX_PACKET(max_packet_size
));
1255 ctrl_ctx
->add_flags
= cpu_to_le32(EP0_FLAG
);
1256 ctrl_ctx
->drop_flags
= 0;
1258 xhci_dbg(xhci
, "Slot %d input context\n", slot_id
);
1259 xhci_dbg_ctx(xhci
, in_ctx
, ep_index
);
1260 xhci_dbg(xhci
, "Slot %d output context\n", slot_id
);
1261 xhci_dbg_ctx(xhci
, out_ctx
, ep_index
);
1263 ret
= xhci_configure_endpoint(xhci
, urb
->dev
, NULL
,
1266 /* Clean up the input context for later use by bandwidth
1269 ctrl_ctx
->add_flags
= cpu_to_le32(SLOT_FLAG
);
1275 * non-error returns are a promise to giveback() the urb later
1276 * we drop ownership so next owner (or urb unlink) can get it
1278 int xhci_urb_enqueue(struct usb_hcd
*hcd
, struct urb
*urb
, gfp_t mem_flags
)
1280 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
1281 struct xhci_td
*buffer
;
1282 unsigned long flags
;
1284 unsigned int slot_id
, ep_index
;
1285 struct urb_priv
*urb_priv
;
1288 if (!urb
|| xhci_check_args(hcd
, urb
->dev
, urb
->ep
,
1289 true, true, __func__
) <= 0)
1292 slot_id
= urb
->dev
->slot_id
;
1293 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1295 if (!HCD_HW_ACCESSIBLE(hcd
)) {
1296 if (!in_interrupt())
1297 xhci_dbg(xhci
, "urb submitted during PCI suspend\n");
1302 if (usb_endpoint_xfer_isoc(&urb
->ep
->desc
))
1303 size
= urb
->number_of_packets
;
1307 urb_priv
= kzalloc(sizeof(struct urb_priv
) +
1308 size
* sizeof(struct xhci_td
*), mem_flags
);
1312 buffer
= kzalloc(size
* sizeof(struct xhci_td
), mem_flags
);
1318 for (i
= 0; i
< size
; i
++) {
1319 urb_priv
->td
[i
] = buffer
;
1323 urb_priv
->length
= size
;
1324 urb_priv
->td_cnt
= 0;
1325 urb
->hcpriv
= urb_priv
;
1327 if (usb_endpoint_xfer_control(&urb
->ep
->desc
)) {
1328 /* Check to see if the max packet size for the default control
1329 * endpoint changed during FS device enumeration
1331 if (urb
->dev
->speed
== USB_SPEED_FULL
) {
1332 ret
= xhci_check_maxpacket(xhci
, slot_id
,
1335 xhci_urb_free_priv(xhci
, urb_priv
);
1341 /* We have a spinlock and interrupts disabled, so we must pass
1342 * atomic context to this function, which may allocate memory.
1344 spin_lock_irqsave(&xhci
->lock
, flags
);
1345 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1347 ret
= xhci_queue_ctrl_tx(xhci
, GFP_ATOMIC
, urb
,
1351 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1352 } else if (usb_endpoint_xfer_bulk(&urb
->ep
->desc
)) {
1353 spin_lock_irqsave(&xhci
->lock
, flags
);
1354 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1356 if (xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
&
1357 EP_GETTING_STREAMS
) {
1358 xhci_warn(xhci
, "WARN: Can't enqueue URB while bulk ep "
1359 "is transitioning to using streams.\n");
1361 } else if (xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
&
1362 EP_GETTING_NO_STREAMS
) {
1363 xhci_warn(xhci
, "WARN: Can't enqueue URB while bulk ep "
1364 "is transitioning to "
1365 "not having streams.\n");
1368 ret
= xhci_queue_bulk_tx(xhci
, GFP_ATOMIC
, urb
,
1373 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1374 } else if (usb_endpoint_xfer_int(&urb
->ep
->desc
)) {
1375 spin_lock_irqsave(&xhci
->lock
, flags
);
1376 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1378 ret
= xhci_queue_intr_tx(xhci
, GFP_ATOMIC
, urb
,
1382 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1384 spin_lock_irqsave(&xhci
->lock
, flags
);
1385 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1387 ret
= xhci_queue_isoc_tx_prepare(xhci
, GFP_ATOMIC
, urb
,
1391 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1396 xhci_dbg(xhci
, "Ep 0x%x: URB %p submitted for "
1397 "non-responsive xHCI host.\n",
1398 urb
->ep
->desc
.bEndpointAddress
, urb
);
1401 xhci_urb_free_priv(xhci
, urb_priv
);
1403 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1407 /* Get the right ring for the given URB.
1408 * If the endpoint supports streams, boundary check the URB's stream ID.
1409 * If the endpoint doesn't support streams, return the singular endpoint ring.
1411 static struct xhci_ring
*xhci_urb_to_transfer_ring(struct xhci_hcd
*xhci
,
1414 unsigned int slot_id
;
1415 unsigned int ep_index
;
1416 unsigned int stream_id
;
1417 struct xhci_virt_ep
*ep
;
1419 slot_id
= urb
->dev
->slot_id
;
1420 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1421 stream_id
= urb
->stream_id
;
1422 ep
= &xhci
->devs
[slot_id
]->eps
[ep_index
];
1423 /* Common case: no streams */
1424 if (!(ep
->ep_state
& EP_HAS_STREAMS
))
1427 if (stream_id
== 0) {
1429 "WARN: Slot ID %u, ep index %u has streams, "
1430 "but URB has no stream ID.\n",
1435 if (stream_id
< ep
->stream_info
->num_streams
)
1436 return ep
->stream_info
->stream_rings
[stream_id
];
1439 "WARN: Slot ID %u, ep index %u has "
1440 "stream IDs 1 to %u allocated, "
1441 "but stream ID %u is requested.\n",
1443 ep
->stream_info
->num_streams
- 1,
1449 * Remove the URB's TD from the endpoint ring. This may cause the HC to stop
1450 * USB transfers, potentially stopping in the middle of a TRB buffer. The HC
1451 * should pick up where it left off in the TD, unless a Set Transfer Ring
1452 * Dequeue Pointer is issued.
1454 * The TRBs that make up the buffers for the canceled URB will be "removed" from
1455 * the ring. Since the ring is a contiguous structure, they can't be physically
1456 * removed. Instead, there are two options:
1458 * 1) If the HC is in the middle of processing the URB to be canceled, we
1459 * simply move the ring's dequeue pointer past those TRBs using the Set
1460 * Transfer Ring Dequeue Pointer command. This will be the common case,
1461 * when drivers timeout on the last submitted URB and attempt to cancel.
1463 * 2) If the HC is in the middle of a different TD, we turn the TRBs into a
1464 * series of 1-TRB transfer no-op TDs. (No-ops shouldn't be chained.) The
1465 * HC will need to invalidate the any TRBs it has cached after the stop
1466 * endpoint command, as noted in the xHCI 0.95 errata.
1468 * 3) The TD may have completed by the time the Stop Endpoint Command
1469 * completes, so software needs to handle that case too.
1471 * This function should protect against the TD enqueueing code ringing the
1472 * doorbell while this code is waiting for a Stop Endpoint command to complete.
1473 * It also needs to account for multiple cancellations on happening at the same
1474 * time for the same endpoint.
1476 * Note that this function can be called in any context, or so says
1477 * usb_hcd_unlink_urb()
1479 int xhci_urb_dequeue(struct usb_hcd
*hcd
, struct urb
*urb
, int status
)
1481 unsigned long flags
;
1484 struct xhci_hcd
*xhci
;
1485 struct urb_priv
*urb_priv
;
1487 unsigned int ep_index
;
1488 struct xhci_ring
*ep_ring
;
1489 struct xhci_virt_ep
*ep
;
1491 xhci
= hcd_to_xhci(hcd
);
1492 spin_lock_irqsave(&xhci
->lock
, flags
);
1493 /* Make sure the URB hasn't completed or been unlinked already */
1494 ret
= usb_hcd_check_unlink_urb(hcd
, urb
, status
);
1495 if (ret
|| !urb
->hcpriv
)
1497 temp
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
1498 if (temp
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_HALTED
)) {
1499 xhci_dbg(xhci
, "HW died, freeing TD.\n");
1500 urb_priv
= urb
->hcpriv
;
1501 for (i
= urb_priv
->td_cnt
; i
< urb_priv
->length
; i
++) {
1502 td
= urb_priv
->td
[i
];
1503 if (!list_empty(&td
->td_list
))
1504 list_del_init(&td
->td_list
);
1505 if (!list_empty(&td
->cancelled_td_list
))
1506 list_del_init(&td
->cancelled_td_list
);
1509 usb_hcd_unlink_urb_from_ep(hcd
, urb
);
1510 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1511 usb_hcd_giveback_urb(hcd
, urb
, -ESHUTDOWN
);
1512 xhci_urb_free_priv(xhci
, urb_priv
);
1515 if ((xhci
->xhc_state
& XHCI_STATE_DYING
) ||
1516 (xhci
->xhc_state
& XHCI_STATE_HALTED
)) {
1517 xhci_dbg(xhci
, "Ep 0x%x: URB %p to be canceled on "
1518 "non-responsive xHCI host.\n",
1519 urb
->ep
->desc
.bEndpointAddress
, urb
);
1520 /* Let the stop endpoint command watchdog timer (which set this
1521 * state) finish cleaning up the endpoint TD lists. We must
1522 * have caught it in the middle of dropping a lock and giving
1528 ep_index
= xhci_get_endpoint_index(&urb
->ep
->desc
);
1529 ep
= &xhci
->devs
[urb
->dev
->slot_id
]->eps
[ep_index
];
1530 ep_ring
= xhci_urb_to_transfer_ring(xhci
, urb
);
1536 urb_priv
= urb
->hcpriv
;
1537 i
= urb_priv
->td_cnt
;
1538 if (i
< urb_priv
->length
)
1539 xhci_dbg(xhci
, "Cancel URB %p, dev %s, ep 0x%x, "
1540 "starting at offset 0x%llx\n",
1541 urb
, urb
->dev
->devpath
,
1542 urb
->ep
->desc
.bEndpointAddress
,
1543 (unsigned long long) xhci_trb_virt_to_dma(
1544 urb_priv
->td
[i
]->start_seg
,
1545 urb_priv
->td
[i
]->first_trb
));
1547 for (; i
< urb_priv
->length
; i
++) {
1548 td
= urb_priv
->td
[i
];
1549 list_add_tail(&td
->cancelled_td_list
, &ep
->cancelled_td_list
);
1552 /* Queue a stop endpoint command, but only if this is
1553 * the first cancellation to be handled.
1555 if (!(ep
->ep_state
& EP_HALT_PENDING
)) {
1556 ep
->ep_state
|= EP_HALT_PENDING
;
1557 ep
->stop_cmds_pending
++;
1558 ep
->stop_cmd_timer
.expires
= jiffies
+
1559 XHCI_STOP_EP_CMD_TIMEOUT
* HZ
;
1560 add_timer(&ep
->stop_cmd_timer
);
1561 xhci_queue_stop_endpoint(xhci
, urb
->dev
->slot_id
, ep_index
, 0);
1562 xhci_ring_cmd_db(xhci
);
1565 spin_unlock_irqrestore(&xhci
->lock
, flags
);
1569 /* Drop an endpoint from a new bandwidth configuration for this device.
1570 * Only one call to this function is allowed per endpoint before
1571 * check_bandwidth() or reset_bandwidth() must be called.
1572 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
1573 * add the endpoint to the schedule with possibly new parameters denoted by a
1574 * different endpoint descriptor in usb_host_endpoint.
1575 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
1578 * The USB core will not allow URBs to be queued to an endpoint that is being
1579 * disabled, so there's no need for mutual exclusion to protect
1580 * the xhci->devs[slot_id] structure.
1582 int xhci_drop_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
1583 struct usb_host_endpoint
*ep
)
1585 struct xhci_hcd
*xhci
;
1586 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
1587 struct xhci_input_control_ctx
*ctrl_ctx
;
1588 struct xhci_slot_ctx
*slot_ctx
;
1589 unsigned int last_ctx
;
1590 unsigned int ep_index
;
1591 struct xhci_ep_ctx
*ep_ctx
;
1593 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
1596 ret
= xhci_check_args(hcd
, udev
, ep
, 1, true, __func__
);
1599 xhci
= hcd_to_xhci(hcd
);
1600 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1603 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
1604 drop_flag
= xhci_get_endpoint_flag(&ep
->desc
);
1605 if (drop_flag
== SLOT_FLAG
|| drop_flag
== EP0_FLAG
) {
1606 xhci_dbg(xhci
, "xHCI %s - can't drop slot or ep 0 %#x\n",
1607 __func__
, drop_flag
);
1611 in_ctx
= xhci
->devs
[udev
->slot_id
]->in_ctx
;
1612 out_ctx
= xhci
->devs
[udev
->slot_id
]->out_ctx
;
1613 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1615 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
1620 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1621 ep_ctx
= xhci_get_ep_ctx(xhci
, out_ctx
, ep_index
);
1622 /* If the HC already knows the endpoint is disabled,
1623 * or the HCD has noted it is disabled, ignore this request
1625 if (((ep_ctx
->ep_info
& cpu_to_le32(EP_STATE_MASK
)) ==
1626 cpu_to_le32(EP_STATE_DISABLED
)) ||
1627 le32_to_cpu(ctrl_ctx
->drop_flags
) &
1628 xhci_get_endpoint_flag(&ep
->desc
)) {
1629 xhci_warn(xhci
, "xHCI %s called with disabled ep %p\n",
1634 ctrl_ctx
->drop_flags
|= cpu_to_le32(drop_flag
);
1635 new_drop_flags
= le32_to_cpu(ctrl_ctx
->drop_flags
);
1637 ctrl_ctx
->add_flags
&= cpu_to_le32(~drop_flag
);
1638 new_add_flags
= le32_to_cpu(ctrl_ctx
->add_flags
);
1640 last_ctx
= xhci_last_valid_endpoint(le32_to_cpu(ctrl_ctx
->add_flags
));
1641 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
1642 /* Update the last valid endpoint context, if we deleted the last one */
1643 if ((le32_to_cpu(slot_ctx
->dev_info
) & LAST_CTX_MASK
) >
1644 LAST_CTX(last_ctx
)) {
1645 slot_ctx
->dev_info
&= cpu_to_le32(~LAST_CTX_MASK
);
1646 slot_ctx
->dev_info
|= cpu_to_le32(LAST_CTX(last_ctx
));
1648 new_slot_info
= le32_to_cpu(slot_ctx
->dev_info
);
1650 xhci_endpoint_zero(xhci
, xhci
->devs
[udev
->slot_id
], ep
);
1652 xhci_dbg(xhci
, "drop ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
1653 (unsigned int) ep
->desc
.bEndpointAddress
,
1655 (unsigned int) new_drop_flags
,
1656 (unsigned int) new_add_flags
,
1657 (unsigned int) new_slot_info
);
1661 /* Add an endpoint to a new possible bandwidth configuration for this device.
1662 * Only one call to this function is allowed per endpoint before
1663 * check_bandwidth() or reset_bandwidth() must be called.
1664 * A call to xhci_drop_endpoint() followed by a call to xhci_add_endpoint() will
1665 * add the endpoint to the schedule with possibly new parameters denoted by a
1666 * different endpoint descriptor in usb_host_endpoint.
1667 * A call to xhci_add_endpoint() followed by a call to xhci_drop_endpoint() is
1670 * The USB core will not allow URBs to be queued to an endpoint until the
1671 * configuration or alt setting is installed in the device, so there's no need
1672 * for mutual exclusion to protect the xhci->devs[slot_id] structure.
1674 int xhci_add_endpoint(struct usb_hcd
*hcd
, struct usb_device
*udev
,
1675 struct usb_host_endpoint
*ep
)
1677 struct xhci_hcd
*xhci
;
1678 struct xhci_container_ctx
*in_ctx
, *out_ctx
;
1679 unsigned int ep_index
;
1680 struct xhci_slot_ctx
*slot_ctx
;
1681 struct xhci_input_control_ctx
*ctrl_ctx
;
1683 unsigned int last_ctx
;
1684 u32 new_add_flags
, new_drop_flags
, new_slot_info
;
1685 struct xhci_virt_device
*virt_dev
;
1688 ret
= xhci_check_args(hcd
, udev
, ep
, 1, true, __func__
);
1690 /* So we won't queue a reset ep command for a root hub */
1694 xhci
= hcd_to_xhci(hcd
);
1695 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
1698 added_ctxs
= xhci_get_endpoint_flag(&ep
->desc
);
1699 last_ctx
= xhci_last_valid_endpoint(added_ctxs
);
1700 if (added_ctxs
== SLOT_FLAG
|| added_ctxs
== EP0_FLAG
) {
1701 /* FIXME when we have to issue an evaluate endpoint command to
1702 * deal with ep0 max packet size changing once we get the
1705 xhci_dbg(xhci
, "xHCI %s - can't add slot or ep 0 %#x\n",
1706 __func__
, added_ctxs
);
1710 virt_dev
= xhci
->devs
[udev
->slot_id
];
1711 in_ctx
= virt_dev
->in_ctx
;
1712 out_ctx
= virt_dev
->out_ctx
;
1713 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
1715 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
1720 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
1721 /* If this endpoint is already in use, and the upper layers are trying
1722 * to add it again without dropping it, reject the addition.
1724 if (virt_dev
->eps
[ep_index
].ring
&&
1725 !(le32_to_cpu(ctrl_ctx
->drop_flags
) &
1726 xhci_get_endpoint_flag(&ep
->desc
))) {
1727 xhci_warn(xhci
, "Trying to add endpoint 0x%x "
1728 "without dropping it.\n",
1729 (unsigned int) ep
->desc
.bEndpointAddress
);
1733 /* If the HCD has already noted the endpoint is enabled,
1734 * ignore this request.
1736 if (le32_to_cpu(ctrl_ctx
->add_flags
) &
1737 xhci_get_endpoint_flag(&ep
->desc
)) {
1738 xhci_warn(xhci
, "xHCI %s called with enabled ep %p\n",
1744 * Configuration and alternate setting changes must be done in
1745 * process context, not interrupt context (or so documenation
1746 * for usb_set_interface() and usb_set_configuration() claim).
1748 if (xhci_endpoint_init(xhci
, virt_dev
, udev
, ep
, GFP_NOIO
) < 0) {
1749 dev_dbg(&udev
->dev
, "%s - could not initialize ep %#x\n",
1750 __func__
, ep
->desc
.bEndpointAddress
);
1754 ctrl_ctx
->add_flags
|= cpu_to_le32(added_ctxs
);
1755 new_add_flags
= le32_to_cpu(ctrl_ctx
->add_flags
);
1757 /* If xhci_endpoint_disable() was called for this endpoint, but the
1758 * xHC hasn't been notified yet through the check_bandwidth() call,
1759 * this re-adds a new state for the endpoint from the new endpoint
1760 * descriptors. We must drop and re-add this endpoint, so we leave the
1763 new_drop_flags
= le32_to_cpu(ctrl_ctx
->drop_flags
);
1765 slot_ctx
= xhci_get_slot_ctx(xhci
, in_ctx
);
1766 /* Update the last valid endpoint context, if we just added one past */
1767 if ((le32_to_cpu(slot_ctx
->dev_info
) & LAST_CTX_MASK
) <
1768 LAST_CTX(last_ctx
)) {
1769 slot_ctx
->dev_info
&= cpu_to_le32(~LAST_CTX_MASK
);
1770 slot_ctx
->dev_info
|= cpu_to_le32(LAST_CTX(last_ctx
));
1772 new_slot_info
= le32_to_cpu(slot_ctx
->dev_info
);
1774 /* Store the usb_device pointer for later use */
1777 xhci_dbg(xhci
, "add ep 0x%x, slot id %d, new drop flags = %#x, new add flags = %#x, new slot info = %#x\n",
1778 (unsigned int) ep
->desc
.bEndpointAddress
,
1780 (unsigned int) new_drop_flags
,
1781 (unsigned int) new_add_flags
,
1782 (unsigned int) new_slot_info
);
1786 static void xhci_zero_in_ctx(struct xhci_hcd
*xhci
, struct xhci_virt_device
*virt_dev
)
1788 struct xhci_input_control_ctx
*ctrl_ctx
;
1789 struct xhci_ep_ctx
*ep_ctx
;
1790 struct xhci_slot_ctx
*slot_ctx
;
1793 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
1795 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
1800 /* When a device's add flag and drop flag are zero, any subsequent
1801 * configure endpoint command will leave that endpoint's state
1802 * untouched. Make sure we don't leave any old state in the input
1803 * endpoint contexts.
1805 ctrl_ctx
->drop_flags
= 0;
1806 ctrl_ctx
->add_flags
= 0;
1807 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
1808 slot_ctx
->dev_info
&= cpu_to_le32(~LAST_CTX_MASK
);
1809 /* Endpoint 0 is always valid */
1810 slot_ctx
->dev_info
|= cpu_to_le32(LAST_CTX(1));
1811 for (i
= 1; i
< 31; ++i
) {
1812 ep_ctx
= xhci_get_ep_ctx(xhci
, virt_dev
->in_ctx
, i
);
1813 ep_ctx
->ep_info
= 0;
1814 ep_ctx
->ep_info2
= 0;
1816 ep_ctx
->tx_info
= 0;
1820 static int xhci_configure_endpoint_result(struct xhci_hcd
*xhci
,
1821 struct usb_device
*udev
, u32
*cmd_status
)
1825 switch (*cmd_status
) {
1827 dev_warn(&udev
->dev
, "Not enough host controller resources "
1828 "for new device state.\n");
1830 /* FIXME: can we allocate more resources for the HC? */
1833 case COMP_2ND_BW_ERR
:
1834 dev_warn(&udev
->dev
, "Not enough bandwidth "
1835 "for new device state.\n");
1837 /* FIXME: can we go back to the old state? */
1840 /* the HCD set up something wrong */
1841 dev_warn(&udev
->dev
, "ERROR: Endpoint drop flag = 0, "
1843 "and endpoint is not disabled.\n");
1847 dev_warn(&udev
->dev
, "ERROR: Incompatible device for endpoint "
1848 "configure command.\n");
1852 dev_dbg(&udev
->dev
, "Successful Endpoint Configure command\n");
1856 xhci_err(xhci
, "ERROR: unexpected command completion "
1857 "code 0x%x.\n", *cmd_status
);
1864 static int xhci_evaluate_context_result(struct xhci_hcd
*xhci
,
1865 struct usb_device
*udev
, u32
*cmd_status
)
1868 struct xhci_virt_device
*virt_dev
= xhci
->devs
[udev
->slot_id
];
1870 switch (*cmd_status
) {
1872 dev_warn(&udev
->dev
, "WARN: xHCI driver setup invalid evaluate "
1873 "context command.\n");
1877 dev_warn(&udev
->dev
, "WARN: slot not enabled for"
1878 "evaluate context command.\n");
1881 case COMP_CTX_STATE
:
1882 dev_warn(&udev
->dev
, "WARN: invalid context state for "
1883 "evaluate context command.\n");
1884 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 1);
1888 dev_warn(&udev
->dev
, "ERROR: Incompatible device for evaluate "
1889 "context command.\n");
1893 /* Max Exit Latency too large error */
1894 dev_warn(&udev
->dev
, "WARN: Max Exit Latency too large\n");
1898 dev_dbg(&udev
->dev
, "Successful evaluate context command\n");
1902 xhci_err(xhci
, "ERROR: unexpected command completion "
1903 "code 0x%x.\n", *cmd_status
);
1910 static u32
xhci_count_num_new_endpoints(struct xhci_hcd
*xhci
,
1911 struct xhci_input_control_ctx
*ctrl_ctx
)
1913 u32 valid_add_flags
;
1914 u32 valid_drop_flags
;
1916 /* Ignore the slot flag (bit 0), and the default control endpoint flag
1917 * (bit 1). The default control endpoint is added during the Address
1918 * Device command and is never removed until the slot is disabled.
1920 valid_add_flags
= ctrl_ctx
->add_flags
>> 2;
1921 valid_drop_flags
= ctrl_ctx
->drop_flags
>> 2;
1923 /* Use hweight32 to count the number of ones in the add flags, or
1924 * number of endpoints added. Don't count endpoints that are changed
1925 * (both added and dropped).
1927 return hweight32(valid_add_flags
) -
1928 hweight32(valid_add_flags
& valid_drop_flags
);
1931 static unsigned int xhci_count_num_dropped_endpoints(struct xhci_hcd
*xhci
,
1932 struct xhci_input_control_ctx
*ctrl_ctx
)
1934 u32 valid_add_flags
;
1935 u32 valid_drop_flags
;
1937 valid_add_flags
= ctrl_ctx
->add_flags
>> 2;
1938 valid_drop_flags
= ctrl_ctx
->drop_flags
>> 2;
1940 return hweight32(valid_drop_flags
) -
1941 hweight32(valid_add_flags
& valid_drop_flags
);
1945 * We need to reserve the new number of endpoints before the configure endpoint
1946 * command completes. We can't subtract the dropped endpoints from the number
1947 * of active endpoints until the command completes because we can oversubscribe
1948 * the host in this case:
1950 * - the first configure endpoint command drops more endpoints than it adds
1951 * - a second configure endpoint command that adds more endpoints is queued
1952 * - the first configure endpoint command fails, so the config is unchanged
1953 * - the second command may succeed, even though there isn't enough resources
1955 * Must be called with xhci->lock held.
1957 static int xhci_reserve_host_resources(struct xhci_hcd
*xhci
,
1958 struct xhci_input_control_ctx
*ctrl_ctx
)
1962 added_eps
= xhci_count_num_new_endpoints(xhci
, ctrl_ctx
);
1963 if (xhci
->num_active_eps
+ added_eps
> xhci
->limit_active_eps
) {
1964 xhci_dbg(xhci
, "Not enough ep ctxs: "
1965 "%u active, need to add %u, limit is %u.\n",
1966 xhci
->num_active_eps
, added_eps
,
1967 xhci
->limit_active_eps
);
1970 xhci
->num_active_eps
+= added_eps
;
1971 xhci_dbg(xhci
, "Adding %u ep ctxs, %u now active.\n", added_eps
,
1972 xhci
->num_active_eps
);
1977 * The configure endpoint was failed by the xHC for some other reason, so we
1978 * need to revert the resources that failed configuration would have used.
1980 * Must be called with xhci->lock held.
1982 static void xhci_free_host_resources(struct xhci_hcd
*xhci
,
1983 struct xhci_input_control_ctx
*ctrl_ctx
)
1987 num_failed_eps
= xhci_count_num_new_endpoints(xhci
, ctrl_ctx
);
1988 xhci
->num_active_eps
-= num_failed_eps
;
1989 xhci_dbg(xhci
, "Removing %u failed ep ctxs, %u now active.\n",
1991 xhci
->num_active_eps
);
1995 * Now that the command has completed, clean up the active endpoint count by
1996 * subtracting out the endpoints that were dropped (but not changed).
1998 * Must be called with xhci->lock held.
2000 static void xhci_finish_resource_reservation(struct xhci_hcd
*xhci
,
2001 struct xhci_input_control_ctx
*ctrl_ctx
)
2003 u32 num_dropped_eps
;
2005 num_dropped_eps
= xhci_count_num_dropped_endpoints(xhci
, ctrl_ctx
);
2006 xhci
->num_active_eps
-= num_dropped_eps
;
2007 if (num_dropped_eps
)
2008 xhci_dbg(xhci
, "Removing %u dropped ep ctxs, %u now active.\n",
2010 xhci
->num_active_eps
);
2013 static unsigned int xhci_get_block_size(struct usb_device
*udev
)
2015 switch (udev
->speed
) {
2017 case USB_SPEED_FULL
:
2019 case USB_SPEED_HIGH
:
2021 case USB_SPEED_SUPER
:
2023 case USB_SPEED_UNKNOWN
:
2024 case USB_SPEED_WIRELESS
:
2026 /* Should never happen */
2032 xhci_get_largest_overhead(struct xhci_interval_bw
*interval_bw
)
2034 if (interval_bw
->overhead
[LS_OVERHEAD_TYPE
])
2036 if (interval_bw
->overhead
[FS_OVERHEAD_TYPE
])
2041 /* If we are changing a LS/FS device under a HS hub,
2042 * make sure (if we are activating a new TT) that the HS bus has enough
2043 * bandwidth for this new TT.
2045 static int xhci_check_tt_bw_table(struct xhci_hcd
*xhci
,
2046 struct xhci_virt_device
*virt_dev
,
2049 struct xhci_interval_bw_table
*bw_table
;
2050 struct xhci_tt_bw_info
*tt_info
;
2052 /* Find the bandwidth table for the root port this TT is attached to. */
2053 bw_table
= &xhci
->rh_bw
[virt_dev
->real_port
- 1].bw_table
;
2054 tt_info
= virt_dev
->tt_info
;
2055 /* If this TT already had active endpoints, the bandwidth for this TT
2056 * has already been added. Removing all periodic endpoints (and thus
2057 * making the TT enactive) will only decrease the bandwidth used.
2061 if (old_active_eps
== 0 && tt_info
->active_eps
!= 0) {
2062 if (bw_table
->bw_used
+ TT_HS_OVERHEAD
> HS_BW_LIMIT
)
2066 /* Not sure why we would have no new active endpoints...
2068 * Maybe because of an Evaluate Context change for a hub update or a
2069 * control endpoint 0 max packet size change?
2070 * FIXME: skip the bandwidth calculation in that case.
2075 static int xhci_check_ss_bw(struct xhci_hcd
*xhci
,
2076 struct xhci_virt_device
*virt_dev
)
2078 unsigned int bw_reserved
;
2080 bw_reserved
= DIV_ROUND_UP(SS_BW_RESERVED
*SS_BW_LIMIT_IN
, 100);
2081 if (virt_dev
->bw_table
->ss_bw_in
> (SS_BW_LIMIT_IN
- bw_reserved
))
2084 bw_reserved
= DIV_ROUND_UP(SS_BW_RESERVED
*SS_BW_LIMIT_OUT
, 100);
2085 if (virt_dev
->bw_table
->ss_bw_out
> (SS_BW_LIMIT_OUT
- bw_reserved
))
2092 * This algorithm is a very conservative estimate of the worst-case scheduling
2093 * scenario for any one interval. The hardware dynamically schedules the
2094 * packets, so we can't tell which microframe could be the limiting factor in
2095 * the bandwidth scheduling. This only takes into account periodic endpoints.
2097 * Obviously, we can't solve an NP complete problem to find the minimum worst
2098 * case scenario. Instead, we come up with an estimate that is no less than
2099 * the worst case bandwidth used for any one microframe, but may be an
2102 * We walk the requirements for each endpoint by interval, starting with the
2103 * smallest interval, and place packets in the schedule where there is only one
2104 * possible way to schedule packets for that interval. In order to simplify
2105 * this algorithm, we record the largest max packet size for each interval, and
2106 * assume all packets will be that size.
2108 * For interval 0, we obviously must schedule all packets for each interval.
2109 * The bandwidth for interval 0 is just the amount of data to be transmitted
2110 * (the sum of all max ESIT payload sizes, plus any overhead per packet times
2111 * the number of packets).
2113 * For interval 1, we have two possible microframes to schedule those packets
2114 * in. For this algorithm, if we can schedule the same number of packets for
2115 * each possible scheduling opportunity (each microframe), we will do so. The
2116 * remaining number of packets will be saved to be transmitted in the gaps in
2117 * the next interval's scheduling sequence.
2119 * As we move those remaining packets to be scheduled with interval 2 packets,
2120 * we have to double the number of remaining packets to transmit. This is
2121 * because the intervals are actually powers of 2, and we would be transmitting
2122 * the previous interval's packets twice in this interval. We also have to be
2123 * sure that when we look at the largest max packet size for this interval, we
2124 * also look at the largest max packet size for the remaining packets and take
2125 * the greater of the two.
2127 * The algorithm continues to evenly distribute packets in each scheduling
2128 * opportunity, and push the remaining packets out, until we get to the last
2129 * interval. Then those packets and their associated overhead are just added
2130 * to the bandwidth used.
2132 static int xhci_check_bw_table(struct xhci_hcd
*xhci
,
2133 struct xhci_virt_device
*virt_dev
,
2136 unsigned int bw_reserved
;
2137 unsigned int max_bandwidth
;
2138 unsigned int bw_used
;
2139 unsigned int block_size
;
2140 struct xhci_interval_bw_table
*bw_table
;
2141 unsigned int packet_size
= 0;
2142 unsigned int overhead
= 0;
2143 unsigned int packets_transmitted
= 0;
2144 unsigned int packets_remaining
= 0;
2147 if (virt_dev
->udev
->speed
== USB_SPEED_SUPER
)
2148 return xhci_check_ss_bw(xhci
, virt_dev
);
2150 if (virt_dev
->udev
->speed
== USB_SPEED_HIGH
) {
2151 max_bandwidth
= HS_BW_LIMIT
;
2152 /* Convert percent of bus BW reserved to blocks reserved */
2153 bw_reserved
= DIV_ROUND_UP(HS_BW_RESERVED
* max_bandwidth
, 100);
2155 max_bandwidth
= FS_BW_LIMIT
;
2156 bw_reserved
= DIV_ROUND_UP(FS_BW_RESERVED
* max_bandwidth
, 100);
2159 bw_table
= virt_dev
->bw_table
;
2160 /* We need to translate the max packet size and max ESIT payloads into
2161 * the units the hardware uses.
2163 block_size
= xhci_get_block_size(virt_dev
->udev
);
2165 /* If we are manipulating a LS/FS device under a HS hub, double check
2166 * that the HS bus has enough bandwidth if we are activing a new TT.
2168 if (virt_dev
->tt_info
) {
2169 xhci_dbg(xhci
, "Recalculating BW for rootport %u\n",
2170 virt_dev
->real_port
);
2171 if (xhci_check_tt_bw_table(xhci
, virt_dev
, old_active_eps
)) {
2172 xhci_warn(xhci
, "Not enough bandwidth on HS bus for "
2173 "newly activated TT.\n");
2176 xhci_dbg(xhci
, "Recalculating BW for TT slot %u port %u\n",
2177 virt_dev
->tt_info
->slot_id
,
2178 virt_dev
->tt_info
->ttport
);
2180 xhci_dbg(xhci
, "Recalculating BW for rootport %u\n",
2181 virt_dev
->real_port
);
2184 /* Add in how much bandwidth will be used for interval zero, or the
2185 * rounded max ESIT payload + number of packets * largest overhead.
2187 bw_used
= DIV_ROUND_UP(bw_table
->interval0_esit_payload
, block_size
) +
2188 bw_table
->interval_bw
[0].num_packets
*
2189 xhci_get_largest_overhead(&bw_table
->interval_bw
[0]);
2191 for (i
= 1; i
< XHCI_MAX_INTERVAL
; i
++) {
2192 unsigned int bw_added
;
2193 unsigned int largest_mps
;
2194 unsigned int interval_overhead
;
2197 * How many packets could we transmit in this interval?
2198 * If packets didn't fit in the previous interval, we will need
2199 * to transmit that many packets twice within this interval.
2201 packets_remaining
= 2 * packets_remaining
+
2202 bw_table
->interval_bw
[i
].num_packets
;
2204 /* Find the largest max packet size of this or the previous
2207 if (list_empty(&bw_table
->interval_bw
[i
].endpoints
))
2210 struct xhci_virt_ep
*virt_ep
;
2211 struct list_head
*ep_entry
;
2213 ep_entry
= bw_table
->interval_bw
[i
].endpoints
.next
;
2214 virt_ep
= list_entry(ep_entry
,
2215 struct xhci_virt_ep
, bw_endpoint_list
);
2216 /* Convert to blocks, rounding up */
2217 largest_mps
= DIV_ROUND_UP(
2218 virt_ep
->bw_info
.max_packet_size
,
2221 if (largest_mps
> packet_size
)
2222 packet_size
= largest_mps
;
2224 /* Use the larger overhead of this or the previous interval. */
2225 interval_overhead
= xhci_get_largest_overhead(
2226 &bw_table
->interval_bw
[i
]);
2227 if (interval_overhead
> overhead
)
2228 overhead
= interval_overhead
;
2230 /* How many packets can we evenly distribute across
2231 * (1 << (i + 1)) possible scheduling opportunities?
2233 packets_transmitted
= packets_remaining
>> (i
+ 1);
2235 /* Add in the bandwidth used for those scheduled packets */
2236 bw_added
= packets_transmitted
* (overhead
+ packet_size
);
2238 /* How many packets do we have remaining to transmit? */
2239 packets_remaining
= packets_remaining
% (1 << (i
+ 1));
2241 /* What largest max packet size should those packets have? */
2242 /* If we've transmitted all packets, don't carry over the
2243 * largest packet size.
2245 if (packets_remaining
== 0) {
2248 } else if (packets_transmitted
> 0) {
2249 /* Otherwise if we do have remaining packets, and we've
2250 * scheduled some packets in this interval, take the
2251 * largest max packet size from endpoints with this
2254 packet_size
= largest_mps
;
2255 overhead
= interval_overhead
;
2257 /* Otherwise carry over packet_size and overhead from the last
2258 * time we had a remainder.
2260 bw_used
+= bw_added
;
2261 if (bw_used
> max_bandwidth
) {
2262 xhci_warn(xhci
, "Not enough bandwidth. "
2263 "Proposed: %u, Max: %u\n",
2264 bw_used
, max_bandwidth
);
2269 * Ok, we know we have some packets left over after even-handedly
2270 * scheduling interval 15. We don't know which microframes they will
2271 * fit into, so we over-schedule and say they will be scheduled every
2274 if (packets_remaining
> 0)
2275 bw_used
+= overhead
+ packet_size
;
2277 if (!virt_dev
->tt_info
&& virt_dev
->udev
->speed
== USB_SPEED_HIGH
) {
2278 unsigned int port_index
= virt_dev
->real_port
- 1;
2280 /* OK, we're manipulating a HS device attached to a
2281 * root port bandwidth domain. Include the number of active TTs
2282 * in the bandwidth used.
2284 bw_used
+= TT_HS_OVERHEAD
*
2285 xhci
->rh_bw
[port_index
].num_active_tts
;
2288 xhci_dbg(xhci
, "Final bandwidth: %u, Limit: %u, Reserved: %u, "
2289 "Available: %u " "percent\n",
2290 bw_used
, max_bandwidth
, bw_reserved
,
2291 (max_bandwidth
- bw_used
- bw_reserved
) * 100 /
2294 bw_used
+= bw_reserved
;
2295 if (bw_used
> max_bandwidth
) {
2296 xhci_warn(xhci
, "Not enough bandwidth. Proposed: %u, Max: %u\n",
2297 bw_used
, max_bandwidth
);
2301 bw_table
->bw_used
= bw_used
;
2305 static bool xhci_is_async_ep(unsigned int ep_type
)
2307 return (ep_type
!= ISOC_OUT_EP
&& ep_type
!= INT_OUT_EP
&&
2308 ep_type
!= ISOC_IN_EP
&&
2309 ep_type
!= INT_IN_EP
);
2312 static bool xhci_is_sync_in_ep(unsigned int ep_type
)
2314 return (ep_type
== ISOC_IN_EP
|| ep_type
== INT_IN_EP
);
2317 static unsigned int xhci_get_ss_bw_consumed(struct xhci_bw_info
*ep_bw
)
2319 unsigned int mps
= DIV_ROUND_UP(ep_bw
->max_packet_size
, SS_BLOCK
);
2321 if (ep_bw
->ep_interval
== 0)
2322 return SS_OVERHEAD_BURST
+
2323 (ep_bw
->mult
* ep_bw
->num_packets
*
2324 (SS_OVERHEAD
+ mps
));
2325 return DIV_ROUND_UP(ep_bw
->mult
* ep_bw
->num_packets
*
2326 (SS_OVERHEAD
+ mps
+ SS_OVERHEAD_BURST
),
2327 1 << ep_bw
->ep_interval
);
2331 void xhci_drop_ep_from_interval_table(struct xhci_hcd
*xhci
,
2332 struct xhci_bw_info
*ep_bw
,
2333 struct xhci_interval_bw_table
*bw_table
,
2334 struct usb_device
*udev
,
2335 struct xhci_virt_ep
*virt_ep
,
2336 struct xhci_tt_bw_info
*tt_info
)
2338 struct xhci_interval_bw
*interval_bw
;
2339 int normalized_interval
;
2341 if (xhci_is_async_ep(ep_bw
->type
))
2344 if (udev
->speed
== USB_SPEED_SUPER
) {
2345 if (xhci_is_sync_in_ep(ep_bw
->type
))
2346 xhci
->devs
[udev
->slot_id
]->bw_table
->ss_bw_in
-=
2347 xhci_get_ss_bw_consumed(ep_bw
);
2349 xhci
->devs
[udev
->slot_id
]->bw_table
->ss_bw_out
-=
2350 xhci_get_ss_bw_consumed(ep_bw
);
2354 /* SuperSpeed endpoints never get added to intervals in the table, so
2355 * this check is only valid for HS/FS/LS devices.
2357 if (list_empty(&virt_ep
->bw_endpoint_list
))
2359 /* For LS/FS devices, we need to translate the interval expressed in
2360 * microframes to frames.
2362 if (udev
->speed
== USB_SPEED_HIGH
)
2363 normalized_interval
= ep_bw
->ep_interval
;
2365 normalized_interval
= ep_bw
->ep_interval
- 3;
2367 if (normalized_interval
== 0)
2368 bw_table
->interval0_esit_payload
-= ep_bw
->max_esit_payload
;
2369 interval_bw
= &bw_table
->interval_bw
[normalized_interval
];
2370 interval_bw
->num_packets
-= ep_bw
->num_packets
;
2371 switch (udev
->speed
) {
2373 interval_bw
->overhead
[LS_OVERHEAD_TYPE
] -= 1;
2375 case USB_SPEED_FULL
:
2376 interval_bw
->overhead
[FS_OVERHEAD_TYPE
] -= 1;
2378 case USB_SPEED_HIGH
:
2379 interval_bw
->overhead
[HS_OVERHEAD_TYPE
] -= 1;
2381 case USB_SPEED_SUPER
:
2382 case USB_SPEED_UNKNOWN
:
2383 case USB_SPEED_WIRELESS
:
2384 /* Should never happen because only LS/FS/HS endpoints will get
2385 * added to the endpoint list.
2390 tt_info
->active_eps
-= 1;
2391 list_del_init(&virt_ep
->bw_endpoint_list
);
2394 static void xhci_add_ep_to_interval_table(struct xhci_hcd
*xhci
,
2395 struct xhci_bw_info
*ep_bw
,
2396 struct xhci_interval_bw_table
*bw_table
,
2397 struct usb_device
*udev
,
2398 struct xhci_virt_ep
*virt_ep
,
2399 struct xhci_tt_bw_info
*tt_info
)
2401 struct xhci_interval_bw
*interval_bw
;
2402 struct xhci_virt_ep
*smaller_ep
;
2403 int normalized_interval
;
2405 if (xhci_is_async_ep(ep_bw
->type
))
2408 if (udev
->speed
== USB_SPEED_SUPER
) {
2409 if (xhci_is_sync_in_ep(ep_bw
->type
))
2410 xhci
->devs
[udev
->slot_id
]->bw_table
->ss_bw_in
+=
2411 xhci_get_ss_bw_consumed(ep_bw
);
2413 xhci
->devs
[udev
->slot_id
]->bw_table
->ss_bw_out
+=
2414 xhci_get_ss_bw_consumed(ep_bw
);
2418 /* For LS/FS devices, we need to translate the interval expressed in
2419 * microframes to frames.
2421 if (udev
->speed
== USB_SPEED_HIGH
)
2422 normalized_interval
= ep_bw
->ep_interval
;
2424 normalized_interval
= ep_bw
->ep_interval
- 3;
2426 if (normalized_interval
== 0)
2427 bw_table
->interval0_esit_payload
+= ep_bw
->max_esit_payload
;
2428 interval_bw
= &bw_table
->interval_bw
[normalized_interval
];
2429 interval_bw
->num_packets
+= ep_bw
->num_packets
;
2430 switch (udev
->speed
) {
2432 interval_bw
->overhead
[LS_OVERHEAD_TYPE
] += 1;
2434 case USB_SPEED_FULL
:
2435 interval_bw
->overhead
[FS_OVERHEAD_TYPE
] += 1;
2437 case USB_SPEED_HIGH
:
2438 interval_bw
->overhead
[HS_OVERHEAD_TYPE
] += 1;
2440 case USB_SPEED_SUPER
:
2441 case USB_SPEED_UNKNOWN
:
2442 case USB_SPEED_WIRELESS
:
2443 /* Should never happen because only LS/FS/HS endpoints will get
2444 * added to the endpoint list.
2450 tt_info
->active_eps
+= 1;
2451 /* Insert the endpoint into the list, largest max packet size first. */
2452 list_for_each_entry(smaller_ep
, &interval_bw
->endpoints
,
2454 if (ep_bw
->max_packet_size
>=
2455 smaller_ep
->bw_info
.max_packet_size
) {
2456 /* Add the new ep before the smaller endpoint */
2457 list_add_tail(&virt_ep
->bw_endpoint_list
,
2458 &smaller_ep
->bw_endpoint_list
);
2462 /* Add the new endpoint at the end of the list. */
2463 list_add_tail(&virt_ep
->bw_endpoint_list
,
2464 &interval_bw
->endpoints
);
2467 void xhci_update_tt_active_eps(struct xhci_hcd
*xhci
,
2468 struct xhci_virt_device
*virt_dev
,
2471 struct xhci_root_port_bw_info
*rh_bw_info
;
2472 if (!virt_dev
->tt_info
)
2475 rh_bw_info
= &xhci
->rh_bw
[virt_dev
->real_port
- 1];
2476 if (old_active_eps
== 0 &&
2477 virt_dev
->tt_info
->active_eps
!= 0) {
2478 rh_bw_info
->num_active_tts
+= 1;
2479 rh_bw_info
->bw_table
.bw_used
+= TT_HS_OVERHEAD
;
2480 } else if (old_active_eps
!= 0 &&
2481 virt_dev
->tt_info
->active_eps
== 0) {
2482 rh_bw_info
->num_active_tts
-= 1;
2483 rh_bw_info
->bw_table
.bw_used
-= TT_HS_OVERHEAD
;
2487 static int xhci_reserve_bandwidth(struct xhci_hcd
*xhci
,
2488 struct xhci_virt_device
*virt_dev
,
2489 struct xhci_container_ctx
*in_ctx
)
2491 struct xhci_bw_info ep_bw_info
[31];
2493 struct xhci_input_control_ctx
*ctrl_ctx
;
2494 int old_active_eps
= 0;
2496 if (virt_dev
->tt_info
)
2497 old_active_eps
= virt_dev
->tt_info
->active_eps
;
2499 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
2501 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
2506 for (i
= 0; i
< 31; i
++) {
2507 if (!EP_IS_ADDED(ctrl_ctx
, i
) && !EP_IS_DROPPED(ctrl_ctx
, i
))
2510 /* Make a copy of the BW info in case we need to revert this */
2511 memcpy(&ep_bw_info
[i
], &virt_dev
->eps
[i
].bw_info
,
2512 sizeof(ep_bw_info
[i
]));
2513 /* Drop the endpoint from the interval table if the endpoint is
2514 * being dropped or changed.
2516 if (EP_IS_DROPPED(ctrl_ctx
, i
))
2517 xhci_drop_ep_from_interval_table(xhci
,
2518 &virt_dev
->eps
[i
].bw_info
,
2524 /* Overwrite the information stored in the endpoints' bw_info */
2525 xhci_update_bw_info(xhci
, virt_dev
->in_ctx
, ctrl_ctx
, virt_dev
);
2526 for (i
= 0; i
< 31; i
++) {
2527 /* Add any changed or added endpoints to the interval table */
2528 if (EP_IS_ADDED(ctrl_ctx
, i
))
2529 xhci_add_ep_to_interval_table(xhci
,
2530 &virt_dev
->eps
[i
].bw_info
,
2537 if (!xhci_check_bw_table(xhci
, virt_dev
, old_active_eps
)) {
2538 /* Ok, this fits in the bandwidth we have.
2539 * Update the number of active TTs.
2541 xhci_update_tt_active_eps(xhci
, virt_dev
, old_active_eps
);
2545 /* We don't have enough bandwidth for this, revert the stored info. */
2546 for (i
= 0; i
< 31; i
++) {
2547 if (!EP_IS_ADDED(ctrl_ctx
, i
) && !EP_IS_DROPPED(ctrl_ctx
, i
))
2550 /* Drop the new copies of any added or changed endpoints from
2551 * the interval table.
2553 if (EP_IS_ADDED(ctrl_ctx
, i
)) {
2554 xhci_drop_ep_from_interval_table(xhci
,
2555 &virt_dev
->eps
[i
].bw_info
,
2561 /* Revert the endpoint back to its old information */
2562 memcpy(&virt_dev
->eps
[i
].bw_info
, &ep_bw_info
[i
],
2563 sizeof(ep_bw_info
[i
]));
2564 /* Add any changed or dropped endpoints back into the table */
2565 if (EP_IS_DROPPED(ctrl_ctx
, i
))
2566 xhci_add_ep_to_interval_table(xhci
,
2567 &virt_dev
->eps
[i
].bw_info
,
2577 /* Issue a configure endpoint command or evaluate context command
2578 * and wait for it to finish.
2580 static int xhci_configure_endpoint(struct xhci_hcd
*xhci
,
2581 struct usb_device
*udev
,
2582 struct xhci_command
*command
,
2583 bool ctx_change
, bool must_succeed
)
2587 unsigned long flags
;
2588 struct xhci_container_ctx
*in_ctx
;
2589 struct xhci_input_control_ctx
*ctrl_ctx
;
2590 struct completion
*cmd_completion
;
2592 struct xhci_virt_device
*virt_dev
;
2593 union xhci_trb
*cmd_trb
;
2595 spin_lock_irqsave(&xhci
->lock
, flags
);
2596 virt_dev
= xhci
->devs
[udev
->slot_id
];
2599 in_ctx
= command
->in_ctx
;
2601 in_ctx
= virt_dev
->in_ctx
;
2602 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
2604 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2605 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
2610 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
) &&
2611 xhci_reserve_host_resources(xhci
, ctrl_ctx
)) {
2612 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2613 xhci_warn(xhci
, "Not enough host resources, "
2614 "active endpoint contexts = %u\n",
2615 xhci
->num_active_eps
);
2618 if ((xhci
->quirks
& XHCI_SW_BW_CHECKING
) &&
2619 xhci_reserve_bandwidth(xhci
, virt_dev
, in_ctx
)) {
2620 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
))
2621 xhci_free_host_resources(xhci
, ctrl_ctx
);
2622 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2623 xhci_warn(xhci
, "Not enough bandwidth\n");
2628 cmd_completion
= command
->completion
;
2629 cmd_status
= &command
->status
;
2630 command
->command_trb
= xhci
->cmd_ring
->enqueue
;
2632 /* Enqueue pointer can be left pointing to the link TRB,
2633 * we must handle that
2635 if (TRB_TYPE_LINK_LE32(command
->command_trb
->link
.control
))
2636 command
->command_trb
=
2637 xhci
->cmd_ring
->enq_seg
->next
->trbs
;
2639 list_add_tail(&command
->cmd_list
, &virt_dev
->cmd_list
);
2641 cmd_completion
= &virt_dev
->cmd_completion
;
2642 cmd_status
= &virt_dev
->cmd_status
;
2644 init_completion(cmd_completion
);
2646 cmd_trb
= xhci
->cmd_ring
->dequeue
;
2648 ret
= xhci_queue_configure_endpoint(xhci
, in_ctx
->dma
,
2649 udev
->slot_id
, must_succeed
);
2651 ret
= xhci_queue_evaluate_context(xhci
, in_ctx
->dma
,
2652 udev
->slot_id
, must_succeed
);
2655 list_del(&command
->cmd_list
);
2656 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
))
2657 xhci_free_host_resources(xhci
, ctrl_ctx
);
2658 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2659 xhci_dbg(xhci
, "FIXME allocate a new ring segment\n");
2662 xhci_ring_cmd_db(xhci
);
2663 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2665 /* Wait for the configure endpoint command to complete */
2666 timeleft
= wait_for_completion_interruptible_timeout(
2668 XHCI_CMD_DEFAULT_TIMEOUT
);
2669 if (timeleft
<= 0) {
2670 xhci_warn(xhci
, "%s while waiting for %s command\n",
2671 timeleft
== 0 ? "Timeout" : "Signal",
2673 "configure endpoint" :
2674 "evaluate context");
2675 /* cancel the configure endpoint command */
2676 ret
= xhci_cancel_cmd(xhci
, command
, cmd_trb
);
2683 ret
= xhci_configure_endpoint_result(xhci
, udev
, cmd_status
);
2685 ret
= xhci_evaluate_context_result(xhci
, udev
, cmd_status
);
2687 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
)) {
2688 spin_lock_irqsave(&xhci
->lock
, flags
);
2689 /* If the command failed, remove the reserved resources.
2690 * Otherwise, clean up the estimate to include dropped eps.
2693 xhci_free_host_resources(xhci
, ctrl_ctx
);
2695 xhci_finish_resource_reservation(xhci
, ctrl_ctx
);
2696 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2701 /* Called after one or more calls to xhci_add_endpoint() or
2702 * xhci_drop_endpoint(). If this call fails, the USB core is expected
2703 * to call xhci_reset_bandwidth().
2705 * Since we are in the middle of changing either configuration or
2706 * installing a new alt setting, the USB core won't allow URBs to be
2707 * enqueued for any endpoint on the old config or interface. Nothing
2708 * else should be touching the xhci->devs[slot_id] structure, so we
2709 * don't need to take the xhci->lock for manipulating that.
2711 int xhci_check_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2715 struct xhci_hcd
*xhci
;
2716 struct xhci_virt_device
*virt_dev
;
2717 struct xhci_input_control_ctx
*ctrl_ctx
;
2718 struct xhci_slot_ctx
*slot_ctx
;
2720 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
2723 xhci
= hcd_to_xhci(hcd
);
2724 if (xhci
->xhc_state
& XHCI_STATE_DYING
)
2727 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
2728 virt_dev
= xhci
->devs
[udev
->slot_id
];
2730 /* See section 4.6.6 - A0 = 1; A1 = D0 = D1 = 0 */
2731 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
2733 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
2737 ctrl_ctx
->add_flags
|= cpu_to_le32(SLOT_FLAG
);
2738 ctrl_ctx
->add_flags
&= cpu_to_le32(~EP0_FLAG
);
2739 ctrl_ctx
->drop_flags
&= cpu_to_le32(~(SLOT_FLAG
| EP0_FLAG
));
2741 /* Don't issue the command if there's no endpoints to update. */
2742 if (ctrl_ctx
->add_flags
== cpu_to_le32(SLOT_FLAG
) &&
2743 ctrl_ctx
->drop_flags
== 0)
2746 xhci_dbg(xhci
, "New Input Control Context:\n");
2747 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
2748 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
,
2749 LAST_CTX_TO_EP_NUM(le32_to_cpu(slot_ctx
->dev_info
)));
2751 ret
= xhci_configure_endpoint(xhci
, udev
, NULL
,
2754 /* Callee should call reset_bandwidth() */
2758 xhci_dbg(xhci
, "Output context after successful config ep cmd:\n");
2759 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
,
2760 LAST_CTX_TO_EP_NUM(le32_to_cpu(slot_ctx
->dev_info
)));
2762 /* Free any rings that were dropped, but not changed. */
2763 for (i
= 1; i
< 31; ++i
) {
2764 if ((le32_to_cpu(ctrl_ctx
->drop_flags
) & (1 << (i
+ 1))) &&
2765 !(le32_to_cpu(ctrl_ctx
->add_flags
) & (1 << (i
+ 1))))
2766 xhci_free_or_cache_endpoint_ring(xhci
, virt_dev
, i
);
2768 xhci_zero_in_ctx(xhci
, virt_dev
);
2770 * Install any rings for completely new endpoints or changed endpoints,
2771 * and free or cache any old rings from changed endpoints.
2773 for (i
= 1; i
< 31; ++i
) {
2774 if (!virt_dev
->eps
[i
].new_ring
)
2776 /* Only cache or free the old ring if it exists.
2777 * It may not if this is the first add of an endpoint.
2779 if (virt_dev
->eps
[i
].ring
) {
2780 xhci_free_or_cache_endpoint_ring(xhci
, virt_dev
, i
);
2782 virt_dev
->eps
[i
].ring
= virt_dev
->eps
[i
].new_ring
;
2783 virt_dev
->eps
[i
].new_ring
= NULL
;
2789 void xhci_reset_bandwidth(struct usb_hcd
*hcd
, struct usb_device
*udev
)
2791 struct xhci_hcd
*xhci
;
2792 struct xhci_virt_device
*virt_dev
;
2795 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
2798 xhci
= hcd_to_xhci(hcd
);
2800 xhci_dbg(xhci
, "%s called for udev %p\n", __func__
, udev
);
2801 virt_dev
= xhci
->devs
[udev
->slot_id
];
2802 /* Free any rings allocated for added endpoints */
2803 for (i
= 0; i
< 31; ++i
) {
2804 if (virt_dev
->eps
[i
].new_ring
) {
2805 xhci_ring_free(xhci
, virt_dev
->eps
[i
].new_ring
);
2806 virt_dev
->eps
[i
].new_ring
= NULL
;
2809 xhci_zero_in_ctx(xhci
, virt_dev
);
2812 static void xhci_setup_input_ctx_for_config_ep(struct xhci_hcd
*xhci
,
2813 struct xhci_container_ctx
*in_ctx
,
2814 struct xhci_container_ctx
*out_ctx
,
2815 struct xhci_input_control_ctx
*ctrl_ctx
,
2816 u32 add_flags
, u32 drop_flags
)
2818 ctrl_ctx
->add_flags
= cpu_to_le32(add_flags
);
2819 ctrl_ctx
->drop_flags
= cpu_to_le32(drop_flags
);
2820 xhci_slot_copy(xhci
, in_ctx
, out_ctx
);
2821 ctrl_ctx
->add_flags
|= cpu_to_le32(SLOT_FLAG
);
2823 xhci_dbg(xhci
, "Input Context:\n");
2824 xhci_dbg_ctx(xhci
, in_ctx
, xhci_last_valid_endpoint(add_flags
));
2827 static void xhci_setup_input_ctx_for_quirk(struct xhci_hcd
*xhci
,
2828 unsigned int slot_id
, unsigned int ep_index
,
2829 struct xhci_dequeue_state
*deq_state
)
2831 struct xhci_input_control_ctx
*ctrl_ctx
;
2832 struct xhci_container_ctx
*in_ctx
;
2833 struct xhci_ep_ctx
*ep_ctx
;
2837 in_ctx
= xhci
->devs
[slot_id
]->in_ctx
;
2838 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, in_ctx
);
2840 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
2845 xhci_endpoint_copy(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
2846 xhci
->devs
[slot_id
]->out_ctx
, ep_index
);
2847 ep_ctx
= xhci_get_ep_ctx(xhci
, in_ctx
, ep_index
);
2848 addr
= xhci_trb_virt_to_dma(deq_state
->new_deq_seg
,
2849 deq_state
->new_deq_ptr
);
2851 xhci_warn(xhci
, "WARN Cannot submit config ep after "
2852 "reset ep command\n");
2853 xhci_warn(xhci
, "WARN deq seg = %p, deq ptr = %p\n",
2854 deq_state
->new_deq_seg
,
2855 deq_state
->new_deq_ptr
);
2858 ep_ctx
->deq
= cpu_to_le64(addr
| deq_state
->new_cycle_state
);
2860 added_ctxs
= xhci_get_endpoint_flag_from_index(ep_index
);
2861 xhci_setup_input_ctx_for_config_ep(xhci
, xhci
->devs
[slot_id
]->in_ctx
,
2862 xhci
->devs
[slot_id
]->out_ctx
, ctrl_ctx
,
2863 added_ctxs
, added_ctxs
);
2866 void xhci_cleanup_stalled_ring(struct xhci_hcd
*xhci
,
2867 struct usb_device
*udev
, unsigned int ep_index
)
2869 struct xhci_dequeue_state deq_state
;
2870 struct xhci_virt_ep
*ep
;
2872 xhci_dbg(xhci
, "Cleaning up stalled endpoint ring\n");
2873 ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
2874 /* We need to move the HW's dequeue pointer past this TD,
2875 * or it will attempt to resend it on the next doorbell ring.
2877 xhci_find_new_dequeue_state(xhci
, udev
->slot_id
,
2878 ep_index
, ep
->stopped_stream
, ep
->stopped_td
,
2881 /* HW with the reset endpoint quirk will use the saved dequeue state to
2882 * issue a configure endpoint command later.
2884 if (!(xhci
->quirks
& XHCI_RESET_EP_QUIRK
)) {
2885 xhci_dbg(xhci
, "Queueing new dequeue state\n");
2886 xhci_queue_new_dequeue_state(xhci
, udev
->slot_id
,
2887 ep_index
, ep
->stopped_stream
, &deq_state
);
2889 /* Better hope no one uses the input context between now and the
2890 * reset endpoint completion!
2891 * XXX: No idea how this hardware will react when stream rings
2894 xhci_dbg(xhci
, "Setting up input context for "
2895 "configure endpoint command\n");
2896 xhci_setup_input_ctx_for_quirk(xhci
, udev
->slot_id
,
2897 ep_index
, &deq_state
);
2901 /* Deal with stalled endpoints. The core should have sent the control message
2902 * to clear the halt condition. However, we need to make the xHCI hardware
2903 * reset its sequence number, since a device will expect a sequence number of
2904 * zero after the halt condition is cleared.
2905 * Context: in_interrupt
2907 void xhci_endpoint_reset(struct usb_hcd
*hcd
,
2908 struct usb_host_endpoint
*ep
)
2910 struct xhci_hcd
*xhci
;
2911 struct usb_device
*udev
;
2912 unsigned int ep_index
;
2913 unsigned long flags
;
2915 struct xhci_virt_ep
*virt_ep
;
2917 xhci
= hcd_to_xhci(hcd
);
2918 udev
= (struct usb_device
*) ep
->hcpriv
;
2919 /* Called with a root hub endpoint (or an endpoint that wasn't added
2920 * with xhci_add_endpoint()
2924 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
2925 virt_ep
= &xhci
->devs
[udev
->slot_id
]->eps
[ep_index
];
2926 if (!virt_ep
->stopped_td
) {
2927 xhci_dbg(xhci
, "Endpoint 0x%x not halted, refusing to reset.\n",
2928 ep
->desc
.bEndpointAddress
);
2931 if (usb_endpoint_xfer_control(&ep
->desc
)) {
2932 xhci_dbg(xhci
, "Control endpoint stall already handled.\n");
2936 xhci_dbg(xhci
, "Queueing reset endpoint command\n");
2937 spin_lock_irqsave(&xhci
->lock
, flags
);
2938 ret
= xhci_queue_reset_ep(xhci
, udev
->slot_id
, ep_index
);
2940 * Can't change the ring dequeue pointer until it's transitioned to the
2941 * stopped state, which is only upon a successful reset endpoint
2942 * command. Better hope that last command worked!
2945 xhci_cleanup_stalled_ring(xhci
, udev
, ep_index
);
2946 kfree(virt_ep
->stopped_td
);
2947 xhci_ring_cmd_db(xhci
);
2949 virt_ep
->stopped_td
= NULL
;
2950 virt_ep
->stopped_trb
= NULL
;
2951 virt_ep
->stopped_stream
= 0;
2952 spin_unlock_irqrestore(&xhci
->lock
, flags
);
2955 xhci_warn(xhci
, "FIXME allocate a new ring segment\n");
2958 static int xhci_check_streams_endpoint(struct xhci_hcd
*xhci
,
2959 struct usb_device
*udev
, struct usb_host_endpoint
*ep
,
2960 unsigned int slot_id
)
2963 unsigned int ep_index
;
2964 unsigned int ep_state
;
2968 ret
= xhci_check_args(xhci_to_hcd(xhci
), udev
, ep
, 1, true, __func__
);
2971 if (ep
->ss_ep_comp
.bmAttributes
== 0) {
2972 xhci_warn(xhci
, "WARN: SuperSpeed Endpoint Companion"
2973 " descriptor for ep 0x%x does not support streams\n",
2974 ep
->desc
.bEndpointAddress
);
2978 ep_index
= xhci_get_endpoint_index(&ep
->desc
);
2979 ep_state
= xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
;
2980 if (ep_state
& EP_HAS_STREAMS
||
2981 ep_state
& EP_GETTING_STREAMS
) {
2982 xhci_warn(xhci
, "WARN: SuperSpeed bulk endpoint 0x%x "
2983 "already has streams set up.\n",
2984 ep
->desc
.bEndpointAddress
);
2985 xhci_warn(xhci
, "Send email to xHCI maintainer and ask for "
2986 "dynamic stream context array reallocation.\n");
2989 if (!list_empty(&xhci
->devs
[slot_id
]->eps
[ep_index
].ring
->td_list
)) {
2990 xhci_warn(xhci
, "Cannot setup streams for SuperSpeed bulk "
2991 "endpoint 0x%x; URBs are pending.\n",
2992 ep
->desc
.bEndpointAddress
);
2998 static void xhci_calculate_streams_entries(struct xhci_hcd
*xhci
,
2999 unsigned int *num_streams
, unsigned int *num_stream_ctxs
)
3001 unsigned int max_streams
;
3003 /* The stream context array size must be a power of two */
3004 *num_stream_ctxs
= roundup_pow_of_two(*num_streams
);
3006 * Find out how many primary stream array entries the host controller
3007 * supports. Later we may use secondary stream arrays (similar to 2nd
3008 * level page entries), but that's an optional feature for xHCI host
3009 * controllers. xHCs must support at least 4 stream IDs.
3011 max_streams
= HCC_MAX_PSA(xhci
->hcc_params
);
3012 if (*num_stream_ctxs
> max_streams
) {
3013 xhci_dbg(xhci
, "xHCI HW only supports %u stream ctx entries.\n",
3015 *num_stream_ctxs
= max_streams
;
3016 *num_streams
= max_streams
;
3020 /* Returns an error code if one of the endpoint already has streams.
3021 * This does not change any data structures, it only checks and gathers
3024 static int xhci_calculate_streams_and_bitmask(struct xhci_hcd
*xhci
,
3025 struct usb_device
*udev
,
3026 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
3027 unsigned int *num_streams
, u32
*changed_ep_bitmask
)
3029 unsigned int max_streams
;
3030 unsigned int endpoint_flag
;
3034 for (i
= 0; i
< num_eps
; i
++) {
3035 ret
= xhci_check_streams_endpoint(xhci
, udev
,
3036 eps
[i
], udev
->slot_id
);
3040 max_streams
= usb_ss_max_streams(&eps
[i
]->ss_ep_comp
);
3041 if (max_streams
< (*num_streams
- 1)) {
3042 xhci_dbg(xhci
, "Ep 0x%x only supports %u stream IDs.\n",
3043 eps
[i
]->desc
.bEndpointAddress
,
3045 *num_streams
= max_streams
+1;
3048 endpoint_flag
= xhci_get_endpoint_flag(&eps
[i
]->desc
);
3049 if (*changed_ep_bitmask
& endpoint_flag
)
3051 *changed_ep_bitmask
|= endpoint_flag
;
3056 static u32
xhci_calculate_no_streams_bitmask(struct xhci_hcd
*xhci
,
3057 struct usb_device
*udev
,
3058 struct usb_host_endpoint
**eps
, unsigned int num_eps
)
3060 u32 changed_ep_bitmask
= 0;
3061 unsigned int slot_id
;
3062 unsigned int ep_index
;
3063 unsigned int ep_state
;
3066 slot_id
= udev
->slot_id
;
3067 if (!xhci
->devs
[slot_id
])
3070 for (i
= 0; i
< num_eps
; i
++) {
3071 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3072 ep_state
= xhci
->devs
[slot_id
]->eps
[ep_index
].ep_state
;
3073 /* Are streams already being freed for the endpoint? */
3074 if (ep_state
& EP_GETTING_NO_STREAMS
) {
3075 xhci_warn(xhci
, "WARN Can't disable streams for "
3077 "streams are being disabled already\n",
3078 eps
[i
]->desc
.bEndpointAddress
);
3081 /* Are there actually any streams to free? */
3082 if (!(ep_state
& EP_HAS_STREAMS
) &&
3083 !(ep_state
& EP_GETTING_STREAMS
)) {
3084 xhci_warn(xhci
, "WARN Can't disable streams for "
3086 "streams are already disabled!\n",
3087 eps
[i
]->desc
.bEndpointAddress
);
3088 xhci_warn(xhci
, "WARN xhci_free_streams() called "
3089 "with non-streams endpoint\n");
3092 changed_ep_bitmask
|= xhci_get_endpoint_flag(&eps
[i
]->desc
);
3094 return changed_ep_bitmask
;
3098 * The USB device drivers use this function (though the HCD interface in USB
3099 * core) to prepare a set of bulk endpoints to use streams. Streams are used to
3100 * coordinate mass storage command queueing across multiple endpoints (basically
3101 * a stream ID == a task ID).
3103 * Setting up streams involves allocating the same size stream context array
3104 * for each endpoint and issuing a configure endpoint command for all endpoints.
3106 * Don't allow the call to succeed if one endpoint only supports one stream
3107 * (which means it doesn't support streams at all).
3109 * Drivers may get less stream IDs than they asked for, if the host controller
3110 * hardware or endpoints claim they can't support the number of requested
3113 int xhci_alloc_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3114 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
3115 unsigned int num_streams
, gfp_t mem_flags
)
3118 struct xhci_hcd
*xhci
;
3119 struct xhci_virt_device
*vdev
;
3120 struct xhci_command
*config_cmd
;
3121 struct xhci_input_control_ctx
*ctrl_ctx
;
3122 unsigned int ep_index
;
3123 unsigned int num_stream_ctxs
;
3124 unsigned long flags
;
3125 u32 changed_ep_bitmask
= 0;
3130 /* Add one to the number of streams requested to account for
3131 * stream 0 that is reserved for xHCI usage.
3134 xhci
= hcd_to_xhci(hcd
);
3135 xhci_dbg(xhci
, "Driver wants %u stream IDs (including stream 0).\n",
3138 config_cmd
= xhci_alloc_command(xhci
, true, true, mem_flags
);
3140 xhci_dbg(xhci
, "Could not allocate xHCI command structure.\n");
3143 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, config_cmd
->in_ctx
);
3145 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
3147 xhci_free_command(xhci
, config_cmd
);
3151 /* Check to make sure all endpoints are not already configured for
3152 * streams. While we're at it, find the maximum number of streams that
3153 * all the endpoints will support and check for duplicate endpoints.
3155 spin_lock_irqsave(&xhci
->lock
, flags
);
3156 ret
= xhci_calculate_streams_and_bitmask(xhci
, udev
, eps
,
3157 num_eps
, &num_streams
, &changed_ep_bitmask
);
3159 xhci_free_command(xhci
, config_cmd
);
3160 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3163 if (num_streams
<= 1) {
3164 xhci_warn(xhci
, "WARN: endpoints can't handle "
3165 "more than one stream.\n");
3166 xhci_free_command(xhci
, config_cmd
);
3167 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3170 vdev
= xhci
->devs
[udev
->slot_id
];
3171 /* Mark each endpoint as being in transition, so
3172 * xhci_urb_enqueue() will reject all URBs.
3174 for (i
= 0; i
< num_eps
; i
++) {
3175 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3176 vdev
->eps
[ep_index
].ep_state
|= EP_GETTING_STREAMS
;
3178 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3180 /* Setup internal data structures and allocate HW data structures for
3181 * streams (but don't install the HW structures in the input context
3182 * until we're sure all memory allocation succeeded).
3184 xhci_calculate_streams_entries(xhci
, &num_streams
, &num_stream_ctxs
);
3185 xhci_dbg(xhci
, "Need %u stream ctx entries for %u stream IDs.\n",
3186 num_stream_ctxs
, num_streams
);
3188 for (i
= 0; i
< num_eps
; i
++) {
3189 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3190 vdev
->eps
[ep_index
].stream_info
= xhci_alloc_stream_info(xhci
,
3192 num_streams
, mem_flags
);
3193 if (!vdev
->eps
[ep_index
].stream_info
)
3195 /* Set maxPstreams in endpoint context and update deq ptr to
3196 * point to stream context array. FIXME
3200 /* Set up the input context for a configure endpoint command. */
3201 for (i
= 0; i
< num_eps
; i
++) {
3202 struct xhci_ep_ctx
*ep_ctx
;
3204 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3205 ep_ctx
= xhci_get_ep_ctx(xhci
, config_cmd
->in_ctx
, ep_index
);
3207 xhci_endpoint_copy(xhci
, config_cmd
->in_ctx
,
3208 vdev
->out_ctx
, ep_index
);
3209 xhci_setup_streams_ep_input_ctx(xhci
, ep_ctx
,
3210 vdev
->eps
[ep_index
].stream_info
);
3212 /* Tell the HW to drop its old copy of the endpoint context info
3213 * and add the updated copy from the input context.
3215 xhci_setup_input_ctx_for_config_ep(xhci
, config_cmd
->in_ctx
,
3216 vdev
->out_ctx
, ctrl_ctx
,
3217 changed_ep_bitmask
, changed_ep_bitmask
);
3219 /* Issue and wait for the configure endpoint command */
3220 ret
= xhci_configure_endpoint(xhci
, udev
, config_cmd
,
3223 /* xHC rejected the configure endpoint command for some reason, so we
3224 * leave the old ring intact and free our internal streams data
3230 spin_lock_irqsave(&xhci
->lock
, flags
);
3231 for (i
= 0; i
< num_eps
; i
++) {
3232 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3233 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_STREAMS
;
3234 xhci_dbg(xhci
, "Slot %u ep ctx %u now has streams.\n",
3235 udev
->slot_id
, ep_index
);
3236 vdev
->eps
[ep_index
].ep_state
|= EP_HAS_STREAMS
;
3238 xhci_free_command(xhci
, config_cmd
);
3239 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3241 /* Subtract 1 for stream 0, which drivers can't use */
3242 return num_streams
- 1;
3245 /* If it didn't work, free the streams! */
3246 for (i
= 0; i
< num_eps
; i
++) {
3247 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3248 xhci_free_stream_info(xhci
, vdev
->eps
[ep_index
].stream_info
);
3249 vdev
->eps
[ep_index
].stream_info
= NULL
;
3250 /* FIXME Unset maxPstreams in endpoint context and
3251 * update deq ptr to point to normal string ring.
3253 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_STREAMS
;
3254 vdev
->eps
[ep_index
].ep_state
&= ~EP_HAS_STREAMS
;
3255 xhci_endpoint_zero(xhci
, vdev
, eps
[i
]);
3257 xhci_free_command(xhci
, config_cmd
);
3261 /* Transition the endpoint from using streams to being a "normal" endpoint
3264 * Modify the endpoint context state, submit a configure endpoint command,
3265 * and free all endpoint rings for streams if that completes successfully.
3267 int xhci_free_streams(struct usb_hcd
*hcd
, struct usb_device
*udev
,
3268 struct usb_host_endpoint
**eps
, unsigned int num_eps
,
3272 struct xhci_hcd
*xhci
;
3273 struct xhci_virt_device
*vdev
;
3274 struct xhci_command
*command
;
3275 struct xhci_input_control_ctx
*ctrl_ctx
;
3276 unsigned int ep_index
;
3277 unsigned long flags
;
3278 u32 changed_ep_bitmask
;
3280 xhci
= hcd_to_xhci(hcd
);
3281 vdev
= xhci
->devs
[udev
->slot_id
];
3283 /* Set up a configure endpoint command to remove the streams rings */
3284 spin_lock_irqsave(&xhci
->lock
, flags
);
3285 changed_ep_bitmask
= xhci_calculate_no_streams_bitmask(xhci
,
3286 udev
, eps
, num_eps
);
3287 if (changed_ep_bitmask
== 0) {
3288 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3292 /* Use the xhci_command structure from the first endpoint. We may have
3293 * allocated too many, but the driver may call xhci_free_streams() for
3294 * each endpoint it grouped into one call to xhci_alloc_streams().
3296 ep_index
= xhci_get_endpoint_index(&eps
[0]->desc
);
3297 command
= vdev
->eps
[ep_index
].stream_info
->free_streams_command
;
3298 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, command
->in_ctx
);
3300 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3301 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
3306 for (i
= 0; i
< num_eps
; i
++) {
3307 struct xhci_ep_ctx
*ep_ctx
;
3309 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3310 ep_ctx
= xhci_get_ep_ctx(xhci
, command
->in_ctx
, ep_index
);
3311 xhci
->devs
[udev
->slot_id
]->eps
[ep_index
].ep_state
|=
3312 EP_GETTING_NO_STREAMS
;
3314 xhci_endpoint_copy(xhci
, command
->in_ctx
,
3315 vdev
->out_ctx
, ep_index
);
3316 xhci_setup_no_streams_ep_input_ctx(xhci
, ep_ctx
,
3317 &vdev
->eps
[ep_index
]);
3319 xhci_setup_input_ctx_for_config_ep(xhci
, command
->in_ctx
,
3320 vdev
->out_ctx
, ctrl_ctx
,
3321 changed_ep_bitmask
, changed_ep_bitmask
);
3322 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3324 /* Issue and wait for the configure endpoint command,
3325 * which must succeed.
3327 ret
= xhci_configure_endpoint(xhci
, udev
, command
,
3330 /* xHC rejected the configure endpoint command for some reason, so we
3331 * leave the streams rings intact.
3336 spin_lock_irqsave(&xhci
->lock
, flags
);
3337 for (i
= 0; i
< num_eps
; i
++) {
3338 ep_index
= xhci_get_endpoint_index(&eps
[i
]->desc
);
3339 xhci_free_stream_info(xhci
, vdev
->eps
[ep_index
].stream_info
);
3340 vdev
->eps
[ep_index
].stream_info
= NULL
;
3341 /* FIXME Unset maxPstreams in endpoint context and
3342 * update deq ptr to point to normal string ring.
3344 vdev
->eps
[ep_index
].ep_state
&= ~EP_GETTING_NO_STREAMS
;
3345 vdev
->eps
[ep_index
].ep_state
&= ~EP_HAS_STREAMS
;
3347 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3353 * Deletes endpoint resources for endpoints that were active before a Reset
3354 * Device command, or a Disable Slot command. The Reset Device command leaves
3355 * the control endpoint intact, whereas the Disable Slot command deletes it.
3357 * Must be called with xhci->lock held.
3359 void xhci_free_device_endpoint_resources(struct xhci_hcd
*xhci
,
3360 struct xhci_virt_device
*virt_dev
, bool drop_control_ep
)
3363 unsigned int num_dropped_eps
= 0;
3364 unsigned int drop_flags
= 0;
3366 for (i
= (drop_control_ep
? 0 : 1); i
< 31; i
++) {
3367 if (virt_dev
->eps
[i
].ring
) {
3368 drop_flags
|= 1 << i
;
3372 xhci
->num_active_eps
-= num_dropped_eps
;
3373 if (num_dropped_eps
)
3374 xhci_dbg(xhci
, "Dropped %u ep ctxs, flags = 0x%x, "
3376 num_dropped_eps
, drop_flags
,
3377 xhci
->num_active_eps
);
3381 * This submits a Reset Device Command, which will set the device state to 0,
3382 * set the device address to 0, and disable all the endpoints except the default
3383 * control endpoint. The USB core should come back and call
3384 * xhci_address_device(), and then re-set up the configuration. If this is
3385 * called because of a usb_reset_and_verify_device(), then the old alternate
3386 * settings will be re-installed through the normal bandwidth allocation
3389 * Wait for the Reset Device command to finish. Remove all structures
3390 * associated with the endpoints that were disabled. Clear the input device
3391 * structure? Cache the rings? Reset the control endpoint 0 max packet size?
3393 * If the virt_dev to be reset does not exist or does not match the udev,
3394 * it means the device is lost, possibly due to the xHC restore error and
3395 * re-initialization during S3/S4. In this case, call xhci_alloc_dev() to
3396 * re-allocate the device.
3398 int xhci_discover_or_reset_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
3401 unsigned long flags
;
3402 struct xhci_hcd
*xhci
;
3403 unsigned int slot_id
;
3404 struct xhci_virt_device
*virt_dev
;
3405 struct xhci_command
*reset_device_cmd
;
3407 int last_freed_endpoint
;
3408 struct xhci_slot_ctx
*slot_ctx
;
3409 int old_active_eps
= 0;
3411 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, false, __func__
);
3414 xhci
= hcd_to_xhci(hcd
);
3415 slot_id
= udev
->slot_id
;
3416 virt_dev
= xhci
->devs
[slot_id
];
3418 xhci_dbg(xhci
, "The device to be reset with slot ID %u does "
3419 "not exist. Re-allocate the device\n", slot_id
);
3420 ret
= xhci_alloc_dev(hcd
, udev
);
3427 if (virt_dev
->udev
!= udev
) {
3428 /* If the virt_dev and the udev does not match, this virt_dev
3429 * may belong to another udev.
3430 * Re-allocate the device.
3432 xhci_dbg(xhci
, "The device to be reset with slot ID %u does "
3433 "not match the udev. Re-allocate the device\n",
3435 ret
= xhci_alloc_dev(hcd
, udev
);
3442 /* If device is not setup, there is no point in resetting it */
3443 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->out_ctx
);
3444 if (GET_SLOT_STATE(le32_to_cpu(slot_ctx
->dev_state
)) ==
3445 SLOT_STATE_DISABLED
)
3448 xhci_dbg(xhci
, "Resetting device with slot ID %u\n", slot_id
);
3449 /* Allocate the command structure that holds the struct completion.
3450 * Assume we're in process context, since the normal device reset
3451 * process has to wait for the device anyway. Storage devices are
3452 * reset as part of error handling, so use GFP_NOIO instead of
3455 reset_device_cmd
= xhci_alloc_command(xhci
, false, true, GFP_NOIO
);
3456 if (!reset_device_cmd
) {
3457 xhci_dbg(xhci
, "Couldn't allocate command structure.\n");
3461 /* Attempt to submit the Reset Device command to the command ring */
3462 spin_lock_irqsave(&xhci
->lock
, flags
);
3463 reset_device_cmd
->command_trb
= xhci
->cmd_ring
->enqueue
;
3465 /* Enqueue pointer can be left pointing to the link TRB,
3466 * we must handle that
3468 if (TRB_TYPE_LINK_LE32(reset_device_cmd
->command_trb
->link
.control
))
3469 reset_device_cmd
->command_trb
=
3470 xhci
->cmd_ring
->enq_seg
->next
->trbs
;
3472 list_add_tail(&reset_device_cmd
->cmd_list
, &virt_dev
->cmd_list
);
3473 ret
= xhci_queue_reset_device(xhci
, slot_id
);
3475 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
3476 list_del(&reset_device_cmd
->cmd_list
);
3477 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3478 goto command_cleanup
;
3480 xhci_ring_cmd_db(xhci
);
3481 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3483 /* Wait for the Reset Device command to finish */
3484 timeleft
= wait_for_completion_interruptible_timeout(
3485 reset_device_cmd
->completion
,
3486 USB_CTRL_SET_TIMEOUT
);
3487 if (timeleft
<= 0) {
3488 xhci_warn(xhci
, "%s while waiting for reset device command\n",
3489 timeleft
== 0 ? "Timeout" : "Signal");
3490 spin_lock_irqsave(&xhci
->lock
, flags
);
3491 /* The timeout might have raced with the event ring handler, so
3492 * only delete from the list if the item isn't poisoned.
3494 if (reset_device_cmd
->cmd_list
.next
!= LIST_POISON1
)
3495 list_del(&reset_device_cmd
->cmd_list
);
3496 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3498 goto command_cleanup
;
3501 /* The Reset Device command can't fail, according to the 0.95/0.96 spec,
3502 * unless we tried to reset a slot ID that wasn't enabled,
3503 * or the device wasn't in the addressed or configured state.
3505 ret
= reset_device_cmd
->status
;
3507 case COMP_EBADSLT
: /* 0.95 completion code for bad slot ID */
3508 case COMP_CTX_STATE
: /* 0.96 completion code for same thing */
3509 xhci_dbg(xhci
, "Can't reset device (slot ID %u) in %s state\n",
3511 xhci_get_slot_state(xhci
, virt_dev
->out_ctx
));
3512 xhci_dbg(xhci
, "Not freeing device rings.\n");
3513 /* Don't treat this as an error. May change my mind later. */
3515 goto command_cleanup
;
3517 xhci_dbg(xhci
, "Successful reset device command.\n");
3520 if (xhci_is_vendor_info_code(xhci
, ret
))
3522 xhci_warn(xhci
, "Unknown completion code %u for "
3523 "reset device command.\n", ret
);
3525 goto command_cleanup
;
3528 /* Free up host controller endpoint resources */
3529 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
)) {
3530 spin_lock_irqsave(&xhci
->lock
, flags
);
3531 /* Don't delete the default control endpoint resources */
3532 xhci_free_device_endpoint_resources(xhci
, virt_dev
, false);
3533 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3536 /* Everything but endpoint 0 is disabled, so free or cache the rings. */
3537 last_freed_endpoint
= 1;
3538 for (i
= 1; i
< 31; ++i
) {
3539 struct xhci_virt_ep
*ep
= &virt_dev
->eps
[i
];
3541 if (ep
->ep_state
& EP_HAS_STREAMS
) {
3542 xhci_free_stream_info(xhci
, ep
->stream_info
);
3543 ep
->stream_info
= NULL
;
3544 ep
->ep_state
&= ~EP_HAS_STREAMS
;
3548 xhci_free_or_cache_endpoint_ring(xhci
, virt_dev
, i
);
3549 last_freed_endpoint
= i
;
3551 if (!list_empty(&virt_dev
->eps
[i
].bw_endpoint_list
))
3552 xhci_drop_ep_from_interval_table(xhci
,
3553 &virt_dev
->eps
[i
].bw_info
,
3558 xhci_clear_endpoint_bw_info(&virt_dev
->eps
[i
].bw_info
);
3560 /* If necessary, update the number of active TTs on this root port */
3561 xhci_update_tt_active_eps(xhci
, virt_dev
, old_active_eps
);
3563 xhci_dbg(xhci
, "Output context after successful reset device cmd:\n");
3564 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, last_freed_endpoint
);
3568 xhci_free_command(xhci
, reset_device_cmd
);
3573 * At this point, the struct usb_device is about to go away, the device has
3574 * disconnected, and all traffic has been stopped and the endpoints have been
3575 * disabled. Free any HC data structures associated with that device.
3577 void xhci_free_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
3579 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
3580 struct xhci_virt_device
*virt_dev
;
3581 unsigned long flags
;
3585 ret
= xhci_check_args(hcd
, udev
, NULL
, 0, true, __func__
);
3586 /* If the host is halted due to driver unload, we still need to free the
3589 if (ret
<= 0 && ret
!= -ENODEV
)
3592 virt_dev
= xhci
->devs
[udev
->slot_id
];
3594 /* Stop any wayward timer functions (which may grab the lock) */
3595 for (i
= 0; i
< 31; ++i
) {
3596 virt_dev
->eps
[i
].ep_state
&= ~EP_HALT_PENDING
;
3597 del_timer_sync(&virt_dev
->eps
[i
].stop_cmd_timer
);
3600 if (udev
->usb2_hw_lpm_enabled
) {
3601 xhci_set_usb2_hardware_lpm(hcd
, udev
, 0);
3602 udev
->usb2_hw_lpm_enabled
= 0;
3605 spin_lock_irqsave(&xhci
->lock
, flags
);
3606 /* Don't disable the slot if the host controller is dead. */
3607 state
= xhci_readl(xhci
, &xhci
->op_regs
->status
);
3608 if (state
== 0xffffffff || (xhci
->xhc_state
& XHCI_STATE_DYING
) ||
3609 (xhci
->xhc_state
& XHCI_STATE_HALTED
)) {
3610 xhci_free_virt_device(xhci
, udev
->slot_id
);
3611 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3615 if (xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
)) {
3616 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3617 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
3620 xhci_ring_cmd_db(xhci
);
3621 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3623 * Event command completion handler will free any data structures
3624 * associated with the slot. XXX Can free sleep?
3629 * Checks if we have enough host controller resources for the default control
3632 * Must be called with xhci->lock held.
3634 static int xhci_reserve_host_control_ep_resources(struct xhci_hcd
*xhci
)
3636 if (xhci
->num_active_eps
+ 1 > xhci
->limit_active_eps
) {
3637 xhci_dbg(xhci
, "Not enough ep ctxs: "
3638 "%u active, need to add 1, limit is %u.\n",
3639 xhci
->num_active_eps
, xhci
->limit_active_eps
);
3642 xhci
->num_active_eps
+= 1;
3643 xhci_dbg(xhci
, "Adding 1 ep ctx, %u now active.\n",
3644 xhci
->num_active_eps
);
3650 * Returns 0 if the xHC ran out of device slots, the Enable Slot command
3651 * timed out, or allocating memory failed. Returns 1 on success.
3653 int xhci_alloc_dev(struct usb_hcd
*hcd
, struct usb_device
*udev
)
3655 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
3656 unsigned long flags
;
3659 union xhci_trb
*cmd_trb
;
3661 spin_lock_irqsave(&xhci
->lock
, flags
);
3662 cmd_trb
= xhci
->cmd_ring
->dequeue
;
3663 ret
= xhci_queue_slot_control(xhci
, TRB_ENABLE_SLOT
, 0);
3665 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3666 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
3669 xhci_ring_cmd_db(xhci
);
3670 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3672 /* XXX: how much time for xHC slot assignment? */
3673 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
3674 XHCI_CMD_DEFAULT_TIMEOUT
);
3675 if (timeleft
<= 0) {
3676 xhci_warn(xhci
, "%s while waiting for a slot\n",
3677 timeleft
== 0 ? "Timeout" : "Signal");
3678 /* cancel the enable slot request */
3679 return xhci_cancel_cmd(xhci
, NULL
, cmd_trb
);
3682 if (!xhci
->slot_id
) {
3683 xhci_err(xhci
, "Error while assigning device slot ID\n");
3687 if ((xhci
->quirks
& XHCI_EP_LIMIT_QUIRK
)) {
3688 spin_lock_irqsave(&xhci
->lock
, flags
);
3689 ret
= xhci_reserve_host_control_ep_resources(xhci
);
3691 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3692 xhci_warn(xhci
, "Not enough host resources, "
3693 "active endpoint contexts = %u\n",
3694 xhci
->num_active_eps
);
3697 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3699 /* Use GFP_NOIO, since this function can be called from
3700 * xhci_discover_or_reset_device(), which may be called as part of
3701 * mass storage driver error handling.
3703 if (!xhci_alloc_virt_device(xhci
, xhci
->slot_id
, udev
, GFP_NOIO
)) {
3704 xhci_warn(xhci
, "Could not allocate xHCI USB device data structures\n");
3707 udev
->slot_id
= xhci
->slot_id
;
3708 /* Is this a LS or FS device under a HS hub? */
3709 /* Hub or peripherial? */
3713 /* Disable slot, if we can do it without mem alloc */
3714 spin_lock_irqsave(&xhci
->lock
, flags
);
3715 if (!xhci_queue_slot_control(xhci
, TRB_DISABLE_SLOT
, udev
->slot_id
))
3716 xhci_ring_cmd_db(xhci
);
3717 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3722 * Issue an Address Device command (which will issue a SetAddress request to
3724 * We should be protected by the usb_address0_mutex in khubd's hub_port_init, so
3725 * we should only issue and wait on one address command at the same time.
3727 * We add one to the device address issued by the hardware because the USB core
3728 * uses address 1 for the root hubs (even though they're not really devices).
3730 int xhci_address_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
3732 unsigned long flags
;
3734 struct xhci_virt_device
*virt_dev
;
3736 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
3737 struct xhci_slot_ctx
*slot_ctx
;
3738 struct xhci_input_control_ctx
*ctrl_ctx
;
3740 union xhci_trb
*cmd_trb
;
3742 if (!udev
->slot_id
) {
3743 xhci_dbg(xhci
, "Bad Slot ID %d\n", udev
->slot_id
);
3747 virt_dev
= xhci
->devs
[udev
->slot_id
];
3749 if (WARN_ON(!virt_dev
)) {
3751 * In plug/unplug torture test with an NEC controller,
3752 * a zero-dereference was observed once due to virt_dev = 0.
3753 * Print useful debug rather than crash if it is observed again!
3755 xhci_warn(xhci
, "Virt dev invalid for slot_id 0x%x!\n",
3760 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->in_ctx
);
3761 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, virt_dev
->in_ctx
);
3763 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
3768 * If this is the first Set Address since device plug-in or
3769 * virt_device realloaction after a resume with an xHCI power loss,
3770 * then set up the slot context.
3772 if (!slot_ctx
->dev_info
)
3773 xhci_setup_addressable_virt_dev(xhci
, udev
);
3774 /* Otherwise, update the control endpoint ring enqueue pointer. */
3776 xhci_copy_ep0_dequeue_into_input_ctx(xhci
, udev
);
3777 ctrl_ctx
->add_flags
= cpu_to_le32(SLOT_FLAG
| EP0_FLAG
);
3778 ctrl_ctx
->drop_flags
= 0;
3780 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
3781 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
3783 spin_lock_irqsave(&xhci
->lock
, flags
);
3784 cmd_trb
= xhci
->cmd_ring
->dequeue
;
3785 ret
= xhci_queue_address_device(xhci
, virt_dev
->in_ctx
->dma
,
3788 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3789 xhci_dbg(xhci
, "FIXME: allocate a command ring segment\n");
3792 xhci_ring_cmd_db(xhci
);
3793 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3795 /* ctrl tx can take up to 5 sec; XXX: need more time for xHC? */
3796 timeleft
= wait_for_completion_interruptible_timeout(&xhci
->addr_dev
,
3797 XHCI_CMD_DEFAULT_TIMEOUT
);
3798 /* FIXME: From section 4.3.4: "Software shall be responsible for timing
3799 * the SetAddress() "recovery interval" required by USB and aborting the
3800 * command on a timeout.
3802 if (timeleft
<= 0) {
3803 xhci_warn(xhci
, "%s while waiting for address device command\n",
3804 timeleft
== 0 ? "Timeout" : "Signal");
3805 /* cancel the address device command */
3806 ret
= xhci_cancel_cmd(xhci
, NULL
, cmd_trb
);
3812 switch (virt_dev
->cmd_status
) {
3813 case COMP_CTX_STATE
:
3815 xhci_err(xhci
, "Setup ERROR: address device command for slot %d.\n",
3820 dev_warn(&udev
->dev
, "Device not responding to set address.\n");
3824 dev_warn(&udev
->dev
, "ERROR: Incompatible device for address "
3825 "device command.\n");
3829 xhci_dbg(xhci
, "Successful Address Device command\n");
3832 xhci_err(xhci
, "ERROR: unexpected command completion "
3833 "code 0x%x.\n", virt_dev
->cmd_status
);
3834 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
3835 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
3842 temp_64
= xhci_read_64(xhci
, &xhci
->op_regs
->dcbaa_ptr
);
3843 xhci_dbg(xhci
, "Op regs DCBAA ptr = %#016llx\n", temp_64
);
3844 xhci_dbg(xhci
, "Slot ID %d dcbaa entry @%p = %#016llx\n",
3846 &xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
],
3847 (unsigned long long)
3848 le64_to_cpu(xhci
->dcbaa
->dev_context_ptrs
[udev
->slot_id
]));
3849 xhci_dbg(xhci
, "Output Context DMA address = %#08llx\n",
3850 (unsigned long long)virt_dev
->out_ctx
->dma
);
3851 xhci_dbg(xhci
, "Slot ID %d Input Context:\n", udev
->slot_id
);
3852 xhci_dbg_ctx(xhci
, virt_dev
->in_ctx
, 2);
3853 xhci_dbg(xhci
, "Slot ID %d Output Context:\n", udev
->slot_id
);
3854 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 2);
3856 * USB core uses address 1 for the roothubs, so we add one to the
3857 * address given back to us by the HC.
3859 slot_ctx
= xhci_get_slot_ctx(xhci
, virt_dev
->out_ctx
);
3860 /* Use kernel assigned address for devices; store xHC assigned
3861 * address locally. */
3862 virt_dev
->address
= (le32_to_cpu(slot_ctx
->dev_state
) & DEV_ADDR_MASK
)
3864 /* Zero the input context control for later use */
3865 ctrl_ctx
->add_flags
= 0;
3866 ctrl_ctx
->drop_flags
= 0;
3868 xhci_dbg(xhci
, "Internal device address = %d\n", virt_dev
->address
);
3874 * Transfer the port index into real index in the HW port status
3875 * registers. Caculate offset between the port's PORTSC register
3876 * and port status base. Divide the number of per port register
3877 * to get the real index. The raw port number bases 1.
3879 int xhci_find_raw_port_number(struct usb_hcd
*hcd
, int port1
)
3881 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
3882 __le32 __iomem
*base_addr
= &xhci
->op_regs
->port_status_base
;
3883 __le32 __iomem
*addr
;
3886 if (hcd
->speed
!= HCD_USB3
)
3887 addr
= xhci
->usb2_ports
[port1
- 1];
3889 addr
= xhci
->usb3_ports
[port1
- 1];
3891 raw_port
= (addr
- base_addr
)/NUM_PORT_REGS
+ 1;
3896 * Issue an Evaluate Context command to change the Maximum Exit Latency in the
3897 * slot context. If that succeeds, store the new MEL in the xhci_virt_device.
3899 static int __maybe_unused
xhci_change_max_exit_latency(struct xhci_hcd
*xhci
,
3900 struct usb_device
*udev
, u16 max_exit_latency
)
3902 struct xhci_virt_device
*virt_dev
;
3903 struct xhci_command
*command
;
3904 struct xhci_input_control_ctx
*ctrl_ctx
;
3905 struct xhci_slot_ctx
*slot_ctx
;
3906 unsigned long flags
;
3909 spin_lock_irqsave(&xhci
->lock
, flags
);
3910 if (max_exit_latency
== xhci
->devs
[udev
->slot_id
]->current_mel
) {
3911 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3915 /* Attempt to issue an Evaluate Context command to change the MEL. */
3916 virt_dev
= xhci
->devs
[udev
->slot_id
];
3917 command
= xhci
->lpm_command
;
3918 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, command
->in_ctx
);
3920 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3921 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
3926 xhci_slot_copy(xhci
, command
->in_ctx
, virt_dev
->out_ctx
);
3927 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3929 ctrl_ctx
->add_flags
|= cpu_to_le32(SLOT_FLAG
);
3930 slot_ctx
= xhci_get_slot_ctx(xhci
, command
->in_ctx
);
3931 slot_ctx
->dev_info2
&= cpu_to_le32(~((u32
) MAX_EXIT
));
3932 slot_ctx
->dev_info2
|= cpu_to_le32(max_exit_latency
);
3934 xhci_dbg(xhci
, "Set up evaluate context for LPM MEL change.\n");
3935 xhci_dbg(xhci
, "Slot %u Input Context:\n", udev
->slot_id
);
3936 xhci_dbg_ctx(xhci
, command
->in_ctx
, 0);
3938 /* Issue and wait for the evaluate context command. */
3939 ret
= xhci_configure_endpoint(xhci
, udev
, command
,
3941 xhci_dbg(xhci
, "Slot %u Output Context:\n", udev
->slot_id
);
3942 xhci_dbg_ctx(xhci
, virt_dev
->out_ctx
, 0);
3945 spin_lock_irqsave(&xhci
->lock
, flags
);
3946 virt_dev
->current_mel
= max_exit_latency
;
3947 spin_unlock_irqrestore(&xhci
->lock
, flags
);
3952 #ifdef CONFIG_PM_RUNTIME
3954 /* BESL to HIRD Encoding array for USB2 LPM */
3955 static int xhci_besl_encoding
[16] = {125, 150, 200, 300, 400, 500, 1000, 2000,
3956 3000, 4000, 5000, 6000, 7000, 8000, 9000, 10000};
3958 /* Calculate HIRD/BESL for USB2 PORTPMSC*/
3959 static int xhci_calculate_hird_besl(struct xhci_hcd
*xhci
,
3960 struct usb_device
*udev
)
3962 int u2del
, besl
, besl_host
;
3963 int besl_device
= 0;
3966 u2del
= HCS_U2_LATENCY(xhci
->hcs_params3
);
3967 field
= le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
);
3969 if (field
& USB_BESL_SUPPORT
) {
3970 for (besl_host
= 0; besl_host
< 16; besl_host
++) {
3971 if (xhci_besl_encoding
[besl_host
] >= u2del
)
3974 /* Use baseline BESL value as default */
3975 if (field
& USB_BESL_BASELINE_VALID
)
3976 besl_device
= USB_GET_BESL_BASELINE(field
);
3977 else if (field
& USB_BESL_DEEP_VALID
)
3978 besl_device
= USB_GET_BESL_DEEP(field
);
3983 besl_host
= (u2del
- 51) / 75 + 1;
3986 besl
= besl_host
+ besl_device
;
3993 /* Calculate BESLD, L1 timeout and HIRDM for USB2 PORTHLPMC */
3994 static int xhci_calculate_usb2_hw_lpm_params(struct usb_device
*udev
)
4001 field
= le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
);
4003 /* xHCI l1 is set in steps of 256us, xHCI 1.0 section 5.4.11.2 */
4004 l1
= udev
->l1_params
.timeout
/ 256;
4006 /* device has preferred BESLD */
4007 if (field
& USB_BESL_DEEP_VALID
) {
4008 besld
= USB_GET_BESL_DEEP(field
);
4012 return PORT_BESLD(besld
) | PORT_L1_TIMEOUT(l1
) | PORT_HIRDM(hirdm
);
4015 static int xhci_usb2_software_lpm_test(struct usb_hcd
*hcd
,
4016 struct usb_device
*udev
)
4018 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4019 struct dev_info
*dev_info
;
4020 __le32 __iomem
**port_array
;
4021 __le32 __iomem
*addr
, *pm_addr
;
4023 unsigned int port_num
;
4024 unsigned long flags
;
4028 if (hcd
->speed
== HCD_USB3
|| !xhci
->sw_lpm_support
||
4032 /* we only support lpm for non-hub device connected to root hub yet */
4033 if (!udev
->parent
|| udev
->parent
->parent
||
4034 udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
)
4037 spin_lock_irqsave(&xhci
->lock
, flags
);
4039 /* Look for devices in lpm_failed_devs list */
4040 dev_id
= le16_to_cpu(udev
->descriptor
.idVendor
) << 16 |
4041 le16_to_cpu(udev
->descriptor
.idProduct
);
4042 list_for_each_entry(dev_info
, &xhci
->lpm_failed_devs
, list
) {
4043 if (dev_info
->dev_id
== dev_id
) {
4049 port_array
= xhci
->usb2_ports
;
4050 port_num
= udev
->portnum
- 1;
4052 if (port_num
> HCS_MAX_PORTS(xhci
->hcs_params1
)) {
4053 xhci_dbg(xhci
, "invalid port number %d\n", udev
->portnum
);
4059 * Test USB 2.0 software LPM.
4060 * FIXME: some xHCI 1.0 hosts may implement a new register to set up
4061 * hardware-controlled USB 2.0 LPM. See section 5.4.11 and 4.23.5.1.1.1
4062 * in the June 2011 errata release.
4064 xhci_dbg(xhci
, "test port %d software LPM\n", port_num
);
4066 * Set L1 Device Slot and HIRD/BESL.
4067 * Check device's USB 2.0 extension descriptor to determine whether
4068 * HIRD or BESL shoule be used. See USB2.0 LPM errata.
4070 pm_addr
= port_array
[port_num
] + PORTPMSC
;
4071 hird
= xhci_calculate_hird_besl(xhci
, udev
);
4072 temp
= PORT_L1DS(udev
->slot_id
) | PORT_HIRD(hird
);
4073 xhci_writel(xhci
, temp
, pm_addr
);
4075 /* Set port link state to U2(L1) */
4076 addr
= port_array
[port_num
];
4077 xhci_set_link_state(xhci
, port_array
, port_num
, XDEV_U2
);
4080 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4082 spin_lock_irqsave(&xhci
->lock
, flags
);
4084 /* Check L1 Status */
4085 ret
= xhci_handshake(xhci
, pm_addr
,
4086 PORT_L1S_MASK
, PORT_L1S_SUCCESS
, 125);
4087 if (ret
!= -ETIMEDOUT
) {
4088 /* enter L1 successfully */
4089 temp
= xhci_readl(xhci
, addr
);
4090 xhci_dbg(xhci
, "port %d entered L1 state, port status 0x%x\n",
4094 temp
= xhci_readl(xhci
, pm_addr
);
4095 xhci_dbg(xhci
, "port %d software lpm failed, L1 status %d\n",
4096 port_num
, temp
& PORT_L1S_MASK
);
4100 /* Resume the port */
4101 xhci_set_link_state(xhci
, port_array
, port_num
, XDEV_U0
);
4103 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4105 spin_lock_irqsave(&xhci
->lock
, flags
);
4108 xhci_test_and_clear_bit(xhci
, port_array
, port_num
, PORT_PLC
);
4110 /* Check PORTSC to make sure the device is in the right state */
4112 temp
= xhci_readl(xhci
, addr
);
4113 xhci_dbg(xhci
, "resumed port %d status 0x%x\n", port_num
, temp
);
4114 if (!(temp
& PORT_CONNECT
) || !(temp
& PORT_PE
) ||
4115 (temp
& PORT_PLS_MASK
) != XDEV_U0
) {
4116 xhci_dbg(xhci
, "port L1 resume fail\n");
4122 /* Insert dev to lpm_failed_devs list */
4123 xhci_warn(xhci
, "device LPM test failed, may disconnect and "
4125 dev_info
= kzalloc(sizeof(struct dev_info
), GFP_ATOMIC
);
4130 dev_info
->dev_id
= dev_id
;
4131 INIT_LIST_HEAD(&dev_info
->list
);
4132 list_add(&dev_info
->list
, &xhci
->lpm_failed_devs
);
4134 xhci_ring_device(xhci
, udev
->slot_id
);
4138 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4142 int xhci_set_usb2_hardware_lpm(struct usb_hcd
*hcd
,
4143 struct usb_device
*udev
, int enable
)
4145 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4146 __le32 __iomem
**port_array
;
4147 __le32 __iomem
*pm_addr
, *hlpm_addr
;
4148 u32 pm_val
, hlpm_val
, field
;
4149 unsigned int port_num
;
4150 unsigned long flags
;
4151 int hird
, exit_latency
;
4154 if (hcd
->speed
== HCD_USB3
|| !xhci
->hw_lpm_support
||
4158 if (!udev
->parent
|| udev
->parent
->parent
||
4159 udev
->descriptor
.bDeviceClass
== USB_CLASS_HUB
)
4162 if (udev
->usb2_hw_lpm_capable
!= 1)
4165 spin_lock_irqsave(&xhci
->lock
, flags
);
4167 port_array
= xhci
->usb2_ports
;
4168 port_num
= udev
->portnum
- 1;
4169 pm_addr
= port_array
[port_num
] + PORTPMSC
;
4170 pm_val
= xhci_readl(xhci
, pm_addr
);
4171 hlpm_addr
= port_array
[port_num
] + PORTHLPMC
;
4172 field
= le32_to_cpu(udev
->bos
->ext_cap
->bmAttributes
);
4174 xhci_dbg(xhci
, "%s port %d USB2 hardware LPM\n",
4175 enable
? "enable" : "disable", port_num
);
4178 /* Host supports BESL timeout instead of HIRD */
4179 if (udev
->usb2_hw_lpm_besl_capable
) {
4180 /* if device doesn't have a preferred BESL value use a
4181 * default one which works with mixed HIRD and BESL
4182 * systems. See XHCI_DEFAULT_BESL definition in xhci.h
4184 if ((field
& USB_BESL_SUPPORT
) &&
4185 (field
& USB_BESL_BASELINE_VALID
))
4186 hird
= USB_GET_BESL_BASELINE(field
);
4188 hird
= udev
->l1_params
.besl
;
4190 exit_latency
= xhci_besl_encoding
[hird
];
4191 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4193 /* USB 3.0 code dedicate one xhci->lpm_command->in_ctx
4194 * input context for link powermanagement evaluate
4195 * context commands. It is protected by hcd->bandwidth
4196 * mutex and is shared by all devices. We need to set
4197 * the max ext latency in USB 2 BESL LPM as well, so
4198 * use the same mutex and xhci_change_max_exit_latency()
4200 mutex_lock(hcd
->bandwidth_mutex
);
4201 ret
= xhci_change_max_exit_latency(xhci
, udev
,
4203 mutex_unlock(hcd
->bandwidth_mutex
);
4207 spin_lock_irqsave(&xhci
->lock
, flags
);
4209 hlpm_val
= xhci_calculate_usb2_hw_lpm_params(udev
);
4210 xhci_writel(xhci
, hlpm_val
, hlpm_addr
);
4212 xhci_readl(xhci
, hlpm_addr
);
4214 hird
= xhci_calculate_hird_besl(xhci
, udev
);
4217 pm_val
&= ~PORT_HIRD_MASK
;
4218 pm_val
|= PORT_HIRD(hird
) | PORT_RWE
;
4219 xhci_writel(xhci
, pm_val
, pm_addr
);
4220 pm_val
= xhci_readl(xhci
, pm_addr
);
4222 xhci_writel(xhci
, pm_val
, pm_addr
);
4224 xhci_readl(xhci
, pm_addr
);
4226 pm_val
&= ~(PORT_HLE
| PORT_RWE
| PORT_HIRD_MASK
);
4227 xhci_writel(xhci
, pm_val
, pm_addr
);
4229 xhci_readl(xhci
, pm_addr
);
4230 if (udev
->usb2_hw_lpm_besl_capable
) {
4231 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4232 mutex_lock(hcd
->bandwidth_mutex
);
4233 xhci_change_max_exit_latency(xhci
, udev
, 0);
4234 mutex_unlock(hcd
->bandwidth_mutex
);
4239 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4243 /* check if a usb2 port supports a given extened capability protocol
4244 * only USB2 ports extended protocol capability values are cached.
4245 * Return 1 if capability is supported
4247 static int xhci_check_usb2_port_capability(struct xhci_hcd
*xhci
, int port
,
4248 unsigned capability
)
4250 u32 port_offset
, port_count
;
4253 for (i
= 0; i
< xhci
->num_ext_caps
; i
++) {
4254 if (xhci
->ext_caps
[i
] & capability
) {
4255 /* port offsets starts at 1 */
4256 port_offset
= XHCI_EXT_PORT_OFF(xhci
->ext_caps
[i
]) - 1;
4257 port_count
= XHCI_EXT_PORT_COUNT(xhci
->ext_caps
[i
]);
4258 if (port
>= port_offset
&&
4259 port
< port_offset
+ port_count
)
4266 int xhci_update_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
4268 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4270 int portnum
= udev
->portnum
- 1;
4272 ret
= xhci_usb2_software_lpm_test(hcd
, udev
);
4274 xhci_dbg(xhci
, "software LPM test succeed\n");
4275 if (xhci
->hw_lpm_support
== 1 &&
4276 xhci_check_usb2_port_capability(xhci
, portnum
, XHCI_HLC
)) {
4277 udev
->usb2_hw_lpm_capable
= 1;
4278 udev
->l1_params
.timeout
= XHCI_L1_TIMEOUT
;
4279 udev
->l1_params
.besl
= XHCI_DEFAULT_BESL
;
4280 if (xhci_check_usb2_port_capability(xhci
, portnum
,
4282 udev
->usb2_hw_lpm_besl_capable
= 1;
4283 ret
= xhci_set_usb2_hardware_lpm(hcd
, udev
, 1);
4285 udev
->usb2_hw_lpm_enabled
= 1;
4294 int xhci_set_usb2_hardware_lpm(struct usb_hcd
*hcd
,
4295 struct usb_device
*udev
, int enable
)
4300 int xhci_update_device(struct usb_hcd
*hcd
, struct usb_device
*udev
)
4305 #endif /* CONFIG_PM_RUNTIME */
4307 /*---------------------- USB 3.0 Link PM functions ------------------------*/
4310 /* Service interval in nanoseconds = 2^(bInterval - 1) * 125us * 1000ns / 1us */
4311 static unsigned long long xhci_service_interval_to_ns(
4312 struct usb_endpoint_descriptor
*desc
)
4314 return (1ULL << (desc
->bInterval
- 1)) * 125 * 1000;
4317 static u16
xhci_get_timeout_no_hub_lpm(struct usb_device
*udev
,
4318 enum usb3_link_state state
)
4320 unsigned long long sel
;
4321 unsigned long long pel
;
4322 unsigned int max_sel_pel
;
4327 /* Convert SEL and PEL stored in nanoseconds to microseconds */
4328 sel
= DIV_ROUND_UP(udev
->u1_params
.sel
, 1000);
4329 pel
= DIV_ROUND_UP(udev
->u1_params
.pel
, 1000);
4330 max_sel_pel
= USB3_LPM_MAX_U1_SEL_PEL
;
4334 sel
= DIV_ROUND_UP(udev
->u2_params
.sel
, 1000);
4335 pel
= DIV_ROUND_UP(udev
->u2_params
.pel
, 1000);
4336 max_sel_pel
= USB3_LPM_MAX_U2_SEL_PEL
;
4340 dev_warn(&udev
->dev
, "%s: Can't get timeout for non-U1 or U2 state.\n",
4342 return USB3_LPM_DISABLED
;
4345 if (sel
<= max_sel_pel
&& pel
<= max_sel_pel
)
4346 return USB3_LPM_DEVICE_INITIATED
;
4348 if (sel
> max_sel_pel
)
4349 dev_dbg(&udev
->dev
, "Device-initiated %s disabled "
4350 "due to long SEL %llu ms\n",
4353 dev_dbg(&udev
->dev
, "Device-initiated %s disabled "
4354 "due to long PEL %llu ms\n",
4356 return USB3_LPM_DISABLED
;
4359 /* Returns the hub-encoded U1 timeout value.
4360 * The U1 timeout should be the maximum of the following values:
4361 * - For control endpoints, U1 system exit latency (SEL) * 3
4362 * - For bulk endpoints, U1 SEL * 5
4363 * - For interrupt endpoints:
4364 * - Notification EPs, U1 SEL * 3
4365 * - Periodic EPs, max(105% of bInterval, U1 SEL * 2)
4366 * - For isochronous endpoints, max(105% of bInterval, U1 SEL * 2)
4368 static u16
xhci_calculate_intel_u1_timeout(struct usb_device
*udev
,
4369 struct usb_endpoint_descriptor
*desc
)
4371 unsigned long long timeout_ns
;
4375 ep_type
= usb_endpoint_type(desc
);
4377 case USB_ENDPOINT_XFER_CONTROL
:
4378 timeout_ns
= udev
->u1_params
.sel
* 3;
4380 case USB_ENDPOINT_XFER_BULK
:
4381 timeout_ns
= udev
->u1_params
.sel
* 5;
4383 case USB_ENDPOINT_XFER_INT
:
4384 intr_type
= usb_endpoint_interrupt_type(desc
);
4385 if (intr_type
== USB_ENDPOINT_INTR_NOTIFICATION
) {
4386 timeout_ns
= udev
->u1_params
.sel
* 3;
4389 /* Otherwise the calculation is the same as isoc eps */
4390 case USB_ENDPOINT_XFER_ISOC
:
4391 timeout_ns
= xhci_service_interval_to_ns(desc
);
4392 timeout_ns
= DIV_ROUND_UP_ULL(timeout_ns
* 105, 100);
4393 if (timeout_ns
< udev
->u1_params
.sel
* 2)
4394 timeout_ns
= udev
->u1_params
.sel
* 2;
4400 /* The U1 timeout is encoded in 1us intervals. */
4401 timeout_ns
= DIV_ROUND_UP_ULL(timeout_ns
, 1000);
4402 /* Don't return a timeout of zero, because that's USB3_LPM_DISABLED. */
4403 if (timeout_ns
== USB3_LPM_DISABLED
)
4406 /* If the necessary timeout value is bigger than what we can set in the
4407 * USB 3.0 hub, we have to disable hub-initiated U1.
4409 if (timeout_ns
<= USB3_LPM_U1_MAX_TIMEOUT
)
4411 dev_dbg(&udev
->dev
, "Hub-initiated U1 disabled "
4412 "due to long timeout %llu ms\n", timeout_ns
);
4413 return xhci_get_timeout_no_hub_lpm(udev
, USB3_LPM_U1
);
4416 /* Returns the hub-encoded U2 timeout value.
4417 * The U2 timeout should be the maximum of:
4418 * - 10 ms (to avoid the bandwidth impact on the scheduler)
4419 * - largest bInterval of any active periodic endpoint (to avoid going
4420 * into lower power link states between intervals).
4421 * - the U2 Exit Latency of the device
4423 static u16
xhci_calculate_intel_u2_timeout(struct usb_device
*udev
,
4424 struct usb_endpoint_descriptor
*desc
)
4426 unsigned long long timeout_ns
;
4427 unsigned long long u2_del_ns
;
4429 timeout_ns
= 10 * 1000 * 1000;
4431 if ((usb_endpoint_xfer_int(desc
) || usb_endpoint_xfer_isoc(desc
)) &&
4432 (xhci_service_interval_to_ns(desc
) > timeout_ns
))
4433 timeout_ns
= xhci_service_interval_to_ns(desc
);
4435 u2_del_ns
= le16_to_cpu(udev
->bos
->ss_cap
->bU2DevExitLat
) * 1000ULL;
4436 if (u2_del_ns
> timeout_ns
)
4437 timeout_ns
= u2_del_ns
;
4439 /* The U2 timeout is encoded in 256us intervals */
4440 timeout_ns
= DIV_ROUND_UP_ULL(timeout_ns
, 256 * 1000);
4441 /* If the necessary timeout value is bigger than what we can set in the
4442 * USB 3.0 hub, we have to disable hub-initiated U2.
4444 if (timeout_ns
<= USB3_LPM_U2_MAX_TIMEOUT
)
4446 dev_dbg(&udev
->dev
, "Hub-initiated U2 disabled "
4447 "due to long timeout %llu ms\n", timeout_ns
);
4448 return xhci_get_timeout_no_hub_lpm(udev
, USB3_LPM_U2
);
4451 static u16
xhci_call_host_update_timeout_for_endpoint(struct xhci_hcd
*xhci
,
4452 struct usb_device
*udev
,
4453 struct usb_endpoint_descriptor
*desc
,
4454 enum usb3_link_state state
,
4457 if (state
== USB3_LPM_U1
) {
4458 if (xhci
->quirks
& XHCI_INTEL_HOST
)
4459 return xhci_calculate_intel_u1_timeout(udev
, desc
);
4461 if (xhci
->quirks
& XHCI_INTEL_HOST
)
4462 return xhci_calculate_intel_u2_timeout(udev
, desc
);
4465 return USB3_LPM_DISABLED
;
4468 static int xhci_update_timeout_for_endpoint(struct xhci_hcd
*xhci
,
4469 struct usb_device
*udev
,
4470 struct usb_endpoint_descriptor
*desc
,
4471 enum usb3_link_state state
,
4476 alt_timeout
= xhci_call_host_update_timeout_for_endpoint(xhci
, udev
,
4477 desc
, state
, timeout
);
4479 /* If we found we can't enable hub-initiated LPM, or
4480 * the U1 or U2 exit latency was too high to allow
4481 * device-initiated LPM as well, just stop searching.
4483 if (alt_timeout
== USB3_LPM_DISABLED
||
4484 alt_timeout
== USB3_LPM_DEVICE_INITIATED
) {
4485 *timeout
= alt_timeout
;
4488 if (alt_timeout
> *timeout
)
4489 *timeout
= alt_timeout
;
4493 static int xhci_update_timeout_for_interface(struct xhci_hcd
*xhci
,
4494 struct usb_device
*udev
,
4495 struct usb_host_interface
*alt
,
4496 enum usb3_link_state state
,
4501 for (j
= 0; j
< alt
->desc
.bNumEndpoints
; j
++) {
4502 if (xhci_update_timeout_for_endpoint(xhci
, udev
,
4503 &alt
->endpoint
[j
].desc
, state
, timeout
))
4510 static int xhci_check_intel_tier_policy(struct usb_device
*udev
,
4511 enum usb3_link_state state
)
4513 struct usb_device
*parent
;
4514 unsigned int num_hubs
;
4516 if (state
== USB3_LPM_U2
)
4519 /* Don't enable U1 if the device is on a 2nd tier hub or lower. */
4520 for (parent
= udev
->parent
, num_hubs
= 0; parent
->parent
;
4521 parent
= parent
->parent
)
4527 dev_dbg(&udev
->dev
, "Disabling U1 link state for device"
4528 " below second-tier hub.\n");
4529 dev_dbg(&udev
->dev
, "Plug device into first-tier hub "
4530 "to decrease power consumption.\n");
4534 static int xhci_check_tier_policy(struct xhci_hcd
*xhci
,
4535 struct usb_device
*udev
,
4536 enum usb3_link_state state
)
4538 if (xhci
->quirks
& XHCI_INTEL_HOST
)
4539 return xhci_check_intel_tier_policy(udev
, state
);
4543 /* Returns the U1 or U2 timeout that should be enabled.
4544 * If the tier check or timeout setting functions return with a non-zero exit
4545 * code, that means the timeout value has been finalized and we shouldn't look
4546 * at any more endpoints.
4548 static u16
xhci_calculate_lpm_timeout(struct usb_hcd
*hcd
,
4549 struct usb_device
*udev
, enum usb3_link_state state
)
4551 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4552 struct usb_host_config
*config
;
4555 u16 timeout
= USB3_LPM_DISABLED
;
4557 if (state
== USB3_LPM_U1
)
4559 else if (state
== USB3_LPM_U2
)
4562 dev_warn(&udev
->dev
, "Can't enable unknown link state %i\n",
4567 if (xhci_check_tier_policy(xhci
, udev
, state
) < 0)
4570 /* Gather some information about the currently installed configuration
4571 * and alternate interface settings.
4573 if (xhci_update_timeout_for_endpoint(xhci
, udev
, &udev
->ep0
.desc
,
4577 config
= udev
->actconfig
;
4581 for (i
= 0; i
< USB_MAXINTERFACES
; i
++) {
4582 struct usb_driver
*driver
;
4583 struct usb_interface
*intf
= config
->interface
[i
];
4588 /* Check if any currently bound drivers want hub-initiated LPM
4591 if (intf
->dev
.driver
) {
4592 driver
= to_usb_driver(intf
->dev
.driver
);
4593 if (driver
&& driver
->disable_hub_initiated_lpm
) {
4594 dev_dbg(&udev
->dev
, "Hub-initiated %s disabled "
4595 "at request of driver %s\n",
4596 state_name
, driver
->name
);
4597 return xhci_get_timeout_no_hub_lpm(udev
, state
);
4601 /* Not sure how this could happen... */
4602 if (!intf
->cur_altsetting
)
4605 if (xhci_update_timeout_for_interface(xhci
, udev
,
4606 intf
->cur_altsetting
,
4613 static int calculate_max_exit_latency(struct usb_device
*udev
,
4614 enum usb3_link_state state_changed
,
4615 u16 hub_encoded_timeout
)
4617 unsigned long long u1_mel_us
= 0;
4618 unsigned long long u2_mel_us
= 0;
4619 unsigned long long mel_us
= 0;
4625 disabling_u1
= (state_changed
== USB3_LPM_U1
&&
4626 hub_encoded_timeout
== USB3_LPM_DISABLED
);
4627 disabling_u2
= (state_changed
== USB3_LPM_U2
&&
4628 hub_encoded_timeout
== USB3_LPM_DISABLED
);
4630 enabling_u1
= (state_changed
== USB3_LPM_U1
&&
4631 hub_encoded_timeout
!= USB3_LPM_DISABLED
);
4632 enabling_u2
= (state_changed
== USB3_LPM_U2
&&
4633 hub_encoded_timeout
!= USB3_LPM_DISABLED
);
4635 /* If U1 was already enabled and we're not disabling it,
4636 * or we're going to enable U1, account for the U1 max exit latency.
4638 if ((udev
->u1_params
.timeout
!= USB3_LPM_DISABLED
&& !disabling_u1
) ||
4640 u1_mel_us
= DIV_ROUND_UP(udev
->u1_params
.mel
, 1000);
4641 if ((udev
->u2_params
.timeout
!= USB3_LPM_DISABLED
&& !disabling_u2
) ||
4643 u2_mel_us
= DIV_ROUND_UP(udev
->u2_params
.mel
, 1000);
4645 if (u1_mel_us
> u2_mel_us
)
4649 /* xHCI host controller max exit latency field is only 16 bits wide. */
4650 if (mel_us
> MAX_EXIT
) {
4651 dev_warn(&udev
->dev
, "Link PM max exit latency of %lluus "
4652 "is too big.\n", mel_us
);
4658 /* Returns the USB3 hub-encoded value for the U1/U2 timeout. */
4659 int xhci_enable_usb3_lpm_timeout(struct usb_hcd
*hcd
,
4660 struct usb_device
*udev
, enum usb3_link_state state
)
4662 struct xhci_hcd
*xhci
;
4663 u16 hub_encoded_timeout
;
4667 xhci
= hcd_to_xhci(hcd
);
4668 /* The LPM timeout values are pretty host-controller specific, so don't
4669 * enable hub-initiated timeouts unless the vendor has provided
4670 * information about their timeout algorithm.
4672 if (!xhci
|| !(xhci
->quirks
& XHCI_LPM_SUPPORT
) ||
4673 !xhci
->devs
[udev
->slot_id
])
4674 return USB3_LPM_DISABLED
;
4676 hub_encoded_timeout
= xhci_calculate_lpm_timeout(hcd
, udev
, state
);
4677 mel
= calculate_max_exit_latency(udev
, state
, hub_encoded_timeout
);
4679 /* Max Exit Latency is too big, disable LPM. */
4680 hub_encoded_timeout
= USB3_LPM_DISABLED
;
4684 ret
= xhci_change_max_exit_latency(xhci
, udev
, mel
);
4687 return hub_encoded_timeout
;
4690 int xhci_disable_usb3_lpm_timeout(struct usb_hcd
*hcd
,
4691 struct usb_device
*udev
, enum usb3_link_state state
)
4693 struct xhci_hcd
*xhci
;
4697 xhci
= hcd_to_xhci(hcd
);
4698 if (!xhci
|| !(xhci
->quirks
& XHCI_LPM_SUPPORT
) ||
4699 !xhci
->devs
[udev
->slot_id
])
4702 mel
= calculate_max_exit_latency(udev
, state
, USB3_LPM_DISABLED
);
4703 ret
= xhci_change_max_exit_latency(xhci
, udev
, mel
);
4708 #else /* CONFIG_PM */
4710 int xhci_enable_usb3_lpm_timeout(struct usb_hcd
*hcd
,
4711 struct usb_device
*udev
, enum usb3_link_state state
)
4713 return USB3_LPM_DISABLED
;
4716 int xhci_disable_usb3_lpm_timeout(struct usb_hcd
*hcd
,
4717 struct usb_device
*udev
, enum usb3_link_state state
)
4721 #endif /* CONFIG_PM */
4723 /*-------------------------------------------------------------------------*/
4725 /* Once a hub descriptor is fetched for a device, we need to update the xHC's
4726 * internal data structures for the device.
4728 int xhci_update_hub_device(struct usb_hcd
*hcd
, struct usb_device
*hdev
,
4729 struct usb_tt
*tt
, gfp_t mem_flags
)
4731 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4732 struct xhci_virt_device
*vdev
;
4733 struct xhci_command
*config_cmd
;
4734 struct xhci_input_control_ctx
*ctrl_ctx
;
4735 struct xhci_slot_ctx
*slot_ctx
;
4736 unsigned long flags
;
4737 unsigned think_time
;
4740 /* Ignore root hubs */
4744 vdev
= xhci
->devs
[hdev
->slot_id
];
4746 xhci_warn(xhci
, "Cannot update hub desc for unknown device.\n");
4749 config_cmd
= xhci_alloc_command(xhci
, true, true, mem_flags
);
4751 xhci_dbg(xhci
, "Could not allocate xHCI command structure.\n");
4754 ctrl_ctx
= xhci_get_input_control_ctx(xhci
, config_cmd
->in_ctx
);
4756 xhci_warn(xhci
, "%s: Could not get input context, bad type.\n",
4758 xhci_free_command(xhci
, config_cmd
);
4762 spin_lock_irqsave(&xhci
->lock
, flags
);
4763 if (hdev
->speed
== USB_SPEED_HIGH
&&
4764 xhci_alloc_tt_info(xhci
, vdev
, hdev
, tt
, GFP_ATOMIC
)) {
4765 xhci_dbg(xhci
, "Could not allocate xHCI TT structure.\n");
4766 xhci_free_command(xhci
, config_cmd
);
4767 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4771 xhci_slot_copy(xhci
, config_cmd
->in_ctx
, vdev
->out_ctx
);
4772 ctrl_ctx
->add_flags
|= cpu_to_le32(SLOT_FLAG
);
4773 slot_ctx
= xhci_get_slot_ctx(xhci
, config_cmd
->in_ctx
);
4774 slot_ctx
->dev_info
|= cpu_to_le32(DEV_HUB
);
4776 slot_ctx
->dev_info
|= cpu_to_le32(DEV_MTT
);
4777 if (xhci
->hci_version
> 0x95) {
4778 xhci_dbg(xhci
, "xHCI version %x needs hub "
4779 "TT think time and number of ports\n",
4780 (unsigned int) xhci
->hci_version
);
4781 slot_ctx
->dev_info2
|= cpu_to_le32(XHCI_MAX_PORTS(hdev
->maxchild
));
4782 /* Set TT think time - convert from ns to FS bit times.
4783 * 0 = 8 FS bit times, 1 = 16 FS bit times,
4784 * 2 = 24 FS bit times, 3 = 32 FS bit times.
4786 * xHCI 1.0: this field shall be 0 if the device is not a
4789 think_time
= tt
->think_time
;
4790 if (think_time
!= 0)
4791 think_time
= (think_time
/ 666) - 1;
4792 if (xhci
->hci_version
< 0x100 || hdev
->speed
== USB_SPEED_HIGH
)
4793 slot_ctx
->tt_info
|=
4794 cpu_to_le32(TT_THINK_TIME(think_time
));
4796 xhci_dbg(xhci
, "xHCI version %x doesn't need hub "
4797 "TT think time or number of ports\n",
4798 (unsigned int) xhci
->hci_version
);
4800 slot_ctx
->dev_state
= 0;
4801 spin_unlock_irqrestore(&xhci
->lock
, flags
);
4803 xhci_dbg(xhci
, "Set up %s for hub device.\n",
4804 (xhci
->hci_version
> 0x95) ?
4805 "configure endpoint" : "evaluate context");
4806 xhci_dbg(xhci
, "Slot %u Input Context:\n", hdev
->slot_id
);
4807 xhci_dbg_ctx(xhci
, config_cmd
->in_ctx
, 0);
4809 /* Issue and wait for the configure endpoint or
4810 * evaluate context command.
4812 if (xhci
->hci_version
> 0x95)
4813 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
4816 ret
= xhci_configure_endpoint(xhci
, hdev
, config_cmd
,
4819 xhci_dbg(xhci
, "Slot %u Output Context:\n", hdev
->slot_id
);
4820 xhci_dbg_ctx(xhci
, vdev
->out_ctx
, 0);
4822 xhci_free_command(xhci
, config_cmd
);
4826 int xhci_get_frame(struct usb_hcd
*hcd
)
4828 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
4829 /* EHCI mods by the periodic size. Why? */
4830 return xhci_readl(xhci
, &xhci
->run_regs
->microframe_index
) >> 3;
4833 int xhci_gen_setup(struct usb_hcd
*hcd
, xhci_get_quirks_t get_quirks
)
4835 struct xhci_hcd
*xhci
;
4836 struct device
*dev
= hcd
->self
.controller
;
4840 /* Accept arbitrarily long scatter-gather lists */
4841 hcd
->self
.sg_tablesize
= ~0;
4842 /* XHCI controllers don't stop the ep queue on short packets :| */
4843 hcd
->self
.no_stop_on_short
= 1;
4845 if (usb_hcd_is_primary_hcd(hcd
)) {
4846 xhci
= kzalloc(sizeof(struct xhci_hcd
), GFP_KERNEL
);
4849 *((struct xhci_hcd
**) hcd
->hcd_priv
) = xhci
;
4850 xhci
->main_hcd
= hcd
;
4851 /* Mark the first roothub as being USB 2.0.
4852 * The xHCI driver will register the USB 3.0 roothub.
4854 hcd
->speed
= HCD_USB2
;
4855 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
4857 * USB 2.0 roothub under xHCI has an integrated TT,
4858 * (rate matching hub) as opposed to having an OHCI/UHCI
4859 * companion controller.
4863 /* xHCI private pointer was set in xhci_pci_probe for the second
4864 * registered roothub.
4866 xhci
= hcd_to_xhci(hcd
);
4867 temp
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
4868 if (HCC_64BIT_ADDR(temp
)) {
4869 xhci_dbg(xhci
, "Enabling 64-bit DMA addresses.\n");
4870 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64));
4872 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(32));
4877 xhci
->cap_regs
= hcd
->regs
;
4878 xhci
->op_regs
= hcd
->regs
+
4879 HC_LENGTH(xhci_readl(xhci
, &xhci
->cap_regs
->hc_capbase
));
4880 xhci
->run_regs
= hcd
->regs
+
4881 (xhci_readl(xhci
, &xhci
->cap_regs
->run_regs_off
) & RTSOFF_MASK
);
4882 /* Cache read-only capability registers */
4883 xhci
->hcs_params1
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params1
);
4884 xhci
->hcs_params2
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params2
);
4885 xhci
->hcs_params3
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params3
);
4886 xhci
->hcc_params
= xhci_readl(xhci
, &xhci
->cap_regs
->hc_capbase
);
4887 xhci
->hci_version
= HC_VERSION(xhci
->hcc_params
);
4888 xhci
->hcc_params
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
4889 xhci_print_registers(xhci
);
4891 get_quirks(dev
, xhci
);
4893 /* In xhci controllers which follow xhci 1.0 spec gives a spurious
4894 * success event after a short transfer. This quirk will ignore such
4897 if (xhci
->hci_version
> 0x96)
4898 xhci
->quirks
|= XHCI_SPURIOUS_SUCCESS
;
4900 /* Make sure the HC is halted. */
4901 retval
= xhci_halt(xhci
);
4905 xhci_dbg(xhci
, "Resetting HCD\n");
4906 /* Reset the internal HC memory state and registers. */
4907 retval
= xhci_reset(xhci
);
4910 xhci_dbg(xhci
, "Reset complete\n");
4912 temp
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
4913 if (HCC_64BIT_ADDR(temp
)) {
4914 xhci_dbg(xhci
, "Enabling 64-bit DMA addresses.\n");
4915 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64));
4917 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(32));
4920 xhci_dbg(xhci
, "Calling HCD init\n");
4921 /* Initialize HCD and host controller data structures. */
4922 retval
= xhci_init(hcd
);
4925 xhci_dbg(xhci
, "Called HCD init\n");
4932 MODULE_DESCRIPTION(DRIVER_DESC
);
4933 MODULE_AUTHOR(DRIVER_AUTHOR
);
4934 MODULE_LICENSE("GPL");
4936 static int __init
xhci_hcd_init(void)
4940 retval
= xhci_register_pci();
4942 pr_debug("Problem registering PCI driver.\n");
4945 retval
= xhci_register_plat();
4947 pr_debug("Problem registering platform driver.\n");
4951 * Check the compiler generated sizes of structures that must be laid
4952 * out in specific ways for hardware access.
4954 BUILD_BUG_ON(sizeof(struct xhci_doorbell_array
) != 256*32/8);
4955 BUILD_BUG_ON(sizeof(struct xhci_slot_ctx
) != 8*32/8);
4956 BUILD_BUG_ON(sizeof(struct xhci_ep_ctx
) != 8*32/8);
4957 /* xhci_device_control has eight fields, and also
4958 * embeds one xhci_slot_ctx and 31 xhci_ep_ctx
4960 BUILD_BUG_ON(sizeof(struct xhci_stream_ctx
) != 4*32/8);
4961 BUILD_BUG_ON(sizeof(union xhci_trb
) != 4*32/8);
4962 BUILD_BUG_ON(sizeof(struct xhci_erst_entry
) != 4*32/8);
4963 BUILD_BUG_ON(sizeof(struct xhci_cap_regs
) != 7*32/8);
4964 BUILD_BUG_ON(sizeof(struct xhci_intr_reg
) != 8*32/8);
4965 /* xhci_run_regs has eight fields and embeds 128 xhci_intr_regs */
4966 BUILD_BUG_ON(sizeof(struct xhci_run_regs
) != (8+8*128)*32/8);
4969 xhci_unregister_pci();
4972 module_init(xhci_hcd_init
);
4974 static void __exit
xhci_hcd_cleanup(void)
4976 xhci_unregister_pci();
4977 xhci_unregister_plat();
4979 module_exit(xhci_hcd_cleanup
);