1 // SPDX-License-Identifier: GPL-2.0
3 * xHCI host controller driver PCI Bus Glue.
5 * Copyright (C) 2008 Intel Corp.
8 * Some code borrowed from the Linux EHCI driver.
11 #include <linux/pci.h>
12 #include <linux/slab.h>
13 #include <linux/module.h>
14 #include <linux/acpi.h>
17 #include "xhci-trace.h"
19 #define SSIC_PORT_NUM 2
20 #define SSIC_PORT_CFG2 0x880c
21 #define SSIC_PORT_CFG2_OFFSET 0x30
22 #define PROG_DONE (1 << 30)
23 #define SSIC_PORT_UNUSED (1 << 31)
25 /* Device for a quirk */
26 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
27 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
28 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009 0x1009
29 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
31 #define PCI_VENDOR_ID_ETRON 0x1b6f
32 #define PCI_DEVICE_ID_EJ168 0x7023
34 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
35 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
36 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI 0x9cb1
37 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI 0x22b5
38 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI 0xa12f
39 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI 0x9d2f
40 #define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI 0x0aa8
41 #define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI 0x1aa8
42 #define PCI_DEVICE_ID_INTEL_APL_XHCI 0x5aa8
43 #define PCI_DEVICE_ID_INTEL_DNV_XHCI 0x19d0
45 #define PCI_DEVICE_ID_AMD_PROMONTORYA_4 0x43b9
46 #define PCI_DEVICE_ID_AMD_PROMONTORYA_3 0x43ba
47 #define PCI_DEVICE_ID_AMD_PROMONTORYA_2 0x43bb
48 #define PCI_DEVICE_ID_AMD_PROMONTORYA_1 0x43bc
49 #define PCI_DEVICE_ID_ASMEDIA_1042A_XHCI 0x1142
51 static const char hcd_name
[] = "xhci_hcd";
53 static struct hc_driver __read_mostly xhci_pci_hc_driver
;
55 static int xhci_pci_setup(struct usb_hcd
*hcd
);
57 static const struct xhci_driver_overrides xhci_pci_overrides __initconst
= {
58 .reset
= xhci_pci_setup
,
61 /* called after powerup, by probe or system-pm "wakeup" */
62 static int xhci_pci_reinit(struct xhci_hcd
*xhci
, struct pci_dev
*pdev
)
65 * TODO: Implement finding debug ports later.
66 * TODO: see if there are any quirks that need to be added to handle
67 * new extended capabilities.
70 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
71 if (!pci_set_mwi(pdev
))
72 xhci_dbg(xhci
, "MWI active\n");
74 xhci_dbg(xhci
, "Finished xhci_pci_reinit\n");
78 static void xhci_pci_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
80 struct pci_dev
*pdev
= to_pci_dev(dev
);
82 /* Look for vendor-specific quirks */
83 if (pdev
->vendor
== PCI_VENDOR_ID_FRESCO_LOGIC
&&
84 (pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
||
85 pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_FL1400
)) {
86 if (pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
&&
87 pdev
->revision
== 0x0) {
88 xhci
->quirks
|= XHCI_RESET_EP_QUIRK
;
89 xhci_dbg_trace(xhci
, trace_xhci_dbg_quirks
,
90 "QUIRK: Fresco Logic xHC needs configure"
91 " endpoint cmd after reset endpoint");
93 if (pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
&&
94 pdev
->revision
== 0x4) {
95 xhci
->quirks
|= XHCI_SLOW_SUSPEND
;
96 xhci_dbg_trace(xhci
, trace_xhci_dbg_quirks
,
97 "QUIRK: Fresco Logic xHC revision %u"
98 "must be suspended extra slowly",
101 if (pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
)
102 xhci
->quirks
|= XHCI_BROKEN_STREAMS
;
103 /* Fresco Logic confirms: all revisions of this chip do not
104 * support MSI, even though some of them claim to in their PCI
107 xhci
->quirks
|= XHCI_BROKEN_MSI
;
108 xhci_dbg_trace(xhci
, trace_xhci_dbg_quirks
,
109 "QUIRK: Fresco Logic revision %u "
110 "has broken MSI implementation",
112 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
115 if (pdev
->vendor
== PCI_VENDOR_ID_FRESCO_LOGIC
&&
116 pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_FL1009
)
117 xhci
->quirks
|= XHCI_BROKEN_STREAMS
;
119 if (pdev
->vendor
== PCI_VENDOR_ID_NEC
)
120 xhci
->quirks
|= XHCI_NEC_HOST
;
122 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&& xhci
->hci_version
== 0x96)
123 xhci
->quirks
|= XHCI_AMD_0x96_HOST
;
126 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&& usb_amd_find_chipset_info())
127 xhci
->quirks
|= XHCI_AMD_PLL_FIX
;
129 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&&
130 (pdev
->device
== 0x15e0 ||
131 pdev
->device
== 0x15e1 ||
132 pdev
->device
== 0x43bb))
133 xhci
->quirks
|= XHCI_SUSPEND_DELAY
;
135 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&&
136 (pdev
->device
== 0x15e0 || pdev
->device
== 0x15e1))
137 xhci
->quirks
|= XHCI_SNPS_BROKEN_SUSPEND
;
139 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
)
140 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
142 if ((pdev
->vendor
== PCI_VENDOR_ID_AMD
) &&
143 ((pdev
->device
== PCI_DEVICE_ID_AMD_PROMONTORYA_4
) ||
144 (pdev
->device
== PCI_DEVICE_ID_AMD_PROMONTORYA_3
) ||
145 (pdev
->device
== PCI_DEVICE_ID_AMD_PROMONTORYA_2
) ||
146 (pdev
->device
== PCI_DEVICE_ID_AMD_PROMONTORYA_1
)))
147 xhci
->quirks
|= XHCI_U2_DISABLE_WAKE
;
149 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
) {
150 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
151 xhci
->quirks
|= XHCI_INTEL_HOST
;
152 xhci
->quirks
|= XHCI_AVOID_BEI
;
154 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
155 pdev
->device
== PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI
) {
156 xhci
->quirks
|= XHCI_EP_LIMIT_QUIRK
;
157 xhci
->limit_active_eps
= 64;
158 xhci
->quirks
|= XHCI_SW_BW_CHECKING
;
160 * PPT desktop boards DH77EB and DH77DF will power back on after
161 * a few seconds of being shutdown. The fix for this is to
162 * switch the ports from xHCI to EHCI on shutdown. We can't use
163 * DMI information to find those particular boards (since each
164 * vendor will change the board name), so we have to key off all
167 xhci
->quirks
|= XHCI_SPURIOUS_REBOOT
;
169 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
170 (pdev
->device
== PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI
||
171 pdev
->device
== PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI
)) {
172 xhci
->quirks
|= XHCI_SPURIOUS_REBOOT
;
173 xhci
->quirks
|= XHCI_SPURIOUS_WAKEUP
;
175 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
176 (pdev
->device
== PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI
||
177 pdev
->device
== PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI
||
178 pdev
->device
== PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI
||
179 pdev
->device
== PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI
||
180 pdev
->device
== PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI
||
181 pdev
->device
== PCI_DEVICE_ID_INTEL_APL_XHCI
||
182 pdev
->device
== PCI_DEVICE_ID_INTEL_DNV_XHCI
)) {
183 xhci
->quirks
|= XHCI_PME_STUCK_QUIRK
;
185 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
186 pdev
->device
== PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI
) {
187 xhci
->quirks
|= XHCI_SSIC_PORT_UNUSED
;
189 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
190 (pdev
->device
== PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI
||
191 pdev
->device
== PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI
||
192 pdev
->device
== PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI
||
193 pdev
->device
== PCI_DEVICE_ID_INTEL_APL_XHCI
||
194 pdev
->device
== PCI_DEVICE_ID_INTEL_DNV_XHCI
))
195 xhci
->quirks
|= XHCI_MISSING_CAS
;
197 if (pdev
->vendor
== PCI_VENDOR_ID_ETRON
&&
198 pdev
->device
== PCI_DEVICE_ID_EJ168
) {
199 xhci
->quirks
|= XHCI_RESET_ON_RESUME
;
200 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
201 xhci
->quirks
|= XHCI_BROKEN_STREAMS
;
203 if (pdev
->vendor
== PCI_VENDOR_ID_RENESAS
&&
204 pdev
->device
== 0x0014)
205 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
206 if (pdev
->vendor
== PCI_VENDOR_ID_RENESAS
&&
207 pdev
->device
== 0x0015)
208 xhci
->quirks
|= XHCI_RESET_ON_RESUME
;
209 if (pdev
->vendor
== PCI_VENDOR_ID_VIA
)
210 xhci
->quirks
|= XHCI_RESET_ON_RESUME
;
212 /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
213 if (pdev
->vendor
== PCI_VENDOR_ID_VIA
&&
214 pdev
->device
== 0x3432)
215 xhci
->quirks
|= XHCI_BROKEN_STREAMS
;
217 if (pdev
->vendor
== PCI_VENDOR_ID_ASMEDIA
&&
218 pdev
->device
== 0x1042)
219 xhci
->quirks
|= XHCI_BROKEN_STREAMS
;
220 if (pdev
->vendor
== PCI_VENDOR_ID_ASMEDIA
&&
221 pdev
->device
== 0x1142)
222 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
224 if (pdev
->vendor
== PCI_VENDOR_ID_ASMEDIA
&&
225 pdev
->device
== PCI_DEVICE_ID_ASMEDIA_1042A_XHCI
)
226 xhci
->quirks
|= XHCI_ASMEDIA_MODIFY_FLOWCONTROL
;
228 if (pdev
->vendor
== PCI_VENDOR_ID_TI
&& pdev
->device
== 0x8241)
229 xhci
->quirks
|= XHCI_LIMIT_ENDPOINT_INTERVAL_7
;
231 if ((pdev
->vendor
== PCI_VENDOR_ID_BROADCOM
||
232 pdev
->vendor
== PCI_VENDOR_ID_CAVIUM
) &&
233 pdev
->device
== 0x9026)
234 xhci
->quirks
|= XHCI_RESET_PLL_ON_DISCONNECT
;
236 if (xhci
->quirks
& XHCI_RESET_ON_RESUME
)
237 xhci_dbg_trace(xhci
, trace_xhci_dbg_quirks
,
238 "QUIRK: Resetting on resume");
242 static void xhci_pme_acpi_rtd3_enable(struct pci_dev
*dev
)
244 static const guid_t intel_dsm_guid
=
245 GUID_INIT(0xac340cb7, 0xe901, 0x45bf,
246 0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23);
247 union acpi_object
*obj
;
249 obj
= acpi_evaluate_dsm(ACPI_HANDLE(&dev
->dev
), &intel_dsm_guid
, 3, 1,
254 static void xhci_pme_acpi_rtd3_enable(struct pci_dev
*dev
) { }
255 #endif /* CONFIG_ACPI */
257 /* called during probe() after chip reset completes */
258 static int xhci_pci_setup(struct usb_hcd
*hcd
)
260 struct xhci_hcd
*xhci
;
261 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
264 xhci
= hcd_to_xhci(hcd
);
266 pci_read_config_byte(pdev
, XHCI_SBRN_OFFSET
, &xhci
->sbrn
);
268 retval
= xhci_gen_setup(hcd
, xhci_pci_quirks
);
272 if (!usb_hcd_is_primary_hcd(hcd
))
275 xhci_dbg(xhci
, "Got SBRN %u\n", (unsigned int) xhci
->sbrn
);
277 /* Find any debug ports */
278 return xhci_pci_reinit(xhci
, pdev
);
282 * We need to register our own PCI probe function (instead of the USB core's
283 * function) in order to create a second roothub under xHCI.
285 static int xhci_pci_probe(struct pci_dev
*dev
, const struct pci_device_id
*id
)
288 struct xhci_hcd
*xhci
;
289 struct hc_driver
*driver
;
292 driver
= (struct hc_driver
*)id
->driver_data
;
294 /* For some HW implementation, a XHCI reset is just not enough... */
295 if (usb_xhci_needs_pci_reset(dev
)) {
296 dev_info(&dev
->dev
, "Resetting\n");
297 if (pci_reset_function_locked(dev
))
298 dev_warn(&dev
->dev
, "Reset failed");
301 /* Prevent runtime suspending between USB-2 and USB-3 initialization */
302 pm_runtime_get_noresume(&dev
->dev
);
304 /* Register the USB 2.0 roothub.
305 * FIXME: USB core must know to register the USB 2.0 roothub first.
306 * This is sort of silly, because we could just set the HCD driver flags
307 * to say USB 2.0, but I'm not sure what the implications would be in
308 * the other parts of the HCD code.
310 retval
= usb_hcd_pci_probe(dev
, id
);
315 /* USB 2.0 roothub is stored in the PCI device now. */
316 hcd
= dev_get_drvdata(&dev
->dev
);
317 xhci
= hcd_to_xhci(hcd
);
318 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, &dev
->dev
,
320 if (!xhci
->shared_hcd
) {
322 goto dealloc_usb2_hcd
;
325 retval
= usb_add_hcd(xhci
->shared_hcd
, dev
->irq
,
329 /* Roothub already marked as USB 3.0 speed */
331 if (!(xhci
->quirks
& XHCI_BROKEN_STREAMS
) &&
332 HCC_MAX_PSA(xhci
->hcc_params
) >= 4)
333 xhci
->shared_hcd
->can_do_streams
= 1;
335 if (xhci
->quirks
& XHCI_PME_STUCK_QUIRK
)
336 xhci_pme_acpi_rtd3_enable(dev
);
338 /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
339 pm_runtime_put_noidle(&dev
->dev
);
344 usb_put_hcd(xhci
->shared_hcd
);
346 usb_hcd_pci_remove(dev
);
348 pm_runtime_put_noidle(&dev
->dev
);
352 static void xhci_pci_remove(struct pci_dev
*dev
)
354 struct xhci_hcd
*xhci
;
356 xhci
= hcd_to_xhci(pci_get_drvdata(dev
));
357 xhci
->xhc_state
|= XHCI_STATE_REMOVING
;
358 if (xhci
->shared_hcd
) {
359 usb_remove_hcd(xhci
->shared_hcd
);
360 usb_put_hcd(xhci
->shared_hcd
);
361 xhci
->shared_hcd
= NULL
;
364 /* Workaround for spurious wakeups at shutdown with HSW */
365 if (xhci
->quirks
& XHCI_SPURIOUS_WAKEUP
)
366 pci_set_power_state(dev
, PCI_D3hot
);
368 usb_hcd_pci_remove(dev
);
373 * In some Intel xHCI controllers, in order to get D3 working,
374 * through a vendor specific SSIC CONFIG register at offset 0x883c,
375 * SSIC PORT need to be marked as "unused" before putting xHCI
376 * into D3. After D3 exit, the SSIC port need to be marked as "used".
377 * Without this change, xHCI might not enter D3 state.
379 static void xhci_ssic_port_unused_quirk(struct usb_hcd
*hcd
, bool suspend
)
381 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
386 for (i
= 0; i
< SSIC_PORT_NUM
; i
++) {
387 reg
= (void __iomem
*) xhci
->cap_regs
+
389 i
* SSIC_PORT_CFG2_OFFSET
;
391 /* Notify SSIC that SSIC profile programming is not done. */
392 val
= readl(reg
) & ~PROG_DONE
;
395 /* Mark SSIC port as unused(suspend) or used(resume) */
398 val
|= SSIC_PORT_UNUSED
;
400 val
&= ~SSIC_PORT_UNUSED
;
403 /* Notify SSIC that SSIC profile programming is done */
404 val
= readl(reg
) | PROG_DONE
;
411 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
412 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
414 static void xhci_pme_quirk(struct usb_hcd
*hcd
)
416 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
420 reg
= (void __iomem
*) xhci
->cap_regs
+ 0x80a4;
422 writel(val
| BIT(28), reg
);
426 static int xhci_pci_suspend(struct usb_hcd
*hcd
, bool do_wakeup
)
428 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
429 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
433 * Systems with the TI redriver that loses port status change events
434 * need to have the registers polled during D3, so avoid D3cold.
436 if (xhci
->quirks
& XHCI_COMP_MODE_QUIRK
)
437 pci_d3cold_disable(pdev
);
439 if (xhci
->quirks
& XHCI_PME_STUCK_QUIRK
)
442 if (xhci
->quirks
& XHCI_SSIC_PORT_UNUSED
)
443 xhci_ssic_port_unused_quirk(hcd
, true);
445 ret
= xhci_suspend(xhci
, do_wakeup
);
446 if (ret
&& (xhci
->quirks
& XHCI_SSIC_PORT_UNUSED
))
447 xhci_ssic_port_unused_quirk(hcd
, false);
452 static int xhci_pci_resume(struct usb_hcd
*hcd
, bool hibernated
)
454 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
455 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
458 /* The BIOS on systems with the Intel Panther Point chipset may or may
459 * not support xHCI natively. That means that during system resume, it
460 * may switch the ports back to EHCI so that users can use their
461 * keyboard to select a kernel from GRUB after resume from hibernate.
463 * The BIOS is supposed to remember whether the OS had xHCI ports
464 * enabled before resume, and switch the ports back to xHCI when the
465 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
468 * Unconditionally switch the ports back to xHCI after a system resume.
469 * It should not matter whether the EHCI or xHCI controller is
470 * resumed first. It's enough to do the switchover in xHCI because
471 * USB core won't notice anything as the hub driver doesn't start
472 * running again until after all the devices (including both EHCI and
473 * xHCI host controllers) have been resumed.
476 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
)
477 usb_enable_intel_xhci_ports(pdev
);
479 if (xhci
->quirks
& XHCI_SSIC_PORT_UNUSED
)
480 xhci_ssic_port_unused_quirk(hcd
, false);
482 if (xhci
->quirks
& XHCI_PME_STUCK_QUIRK
)
485 retval
= xhci_resume(xhci
, hibernated
);
489 static void xhci_pci_shutdown(struct usb_hcd
*hcd
)
491 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
492 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
496 /* Yet another workaround for spurious wakeups at shutdown with HSW */
497 if (xhci
->quirks
& XHCI_SPURIOUS_WAKEUP
)
498 pci_set_power_state(pdev
, PCI_D3hot
);
500 #endif /* CONFIG_PM */
502 /*-------------------------------------------------------------------------*/
504 /* PCI driver selection metadata; PCI hotplugging uses this */
505 static const struct pci_device_id pci_ids
[] = { {
506 /* handle any USB 3.0 xHCI controller */
507 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI
, ~0),
508 .driver_data
= (unsigned long) &xhci_pci_hc_driver
,
510 { /* end: all zeroes */ }
512 MODULE_DEVICE_TABLE(pci
, pci_ids
);
514 /* pci driver glue; this is a "new style" PCI driver module */
515 static struct pci_driver xhci_pci_driver
= {
516 .name
= (char *) hcd_name
,
519 .probe
= xhci_pci_probe
,
520 .remove
= xhci_pci_remove
,
521 /* suspend and resume implemented later */
523 .shutdown
= usb_hcd_pci_shutdown
,
526 .pm
= &usb_hcd_pci_pm_ops
531 static int __init
xhci_pci_init(void)
533 xhci_init_driver(&xhci_pci_hc_driver
, &xhci_pci_overrides
);
535 xhci_pci_hc_driver
.pci_suspend
= xhci_pci_suspend
;
536 xhci_pci_hc_driver
.pci_resume
= xhci_pci_resume
;
537 xhci_pci_hc_driver
.shutdown
= xhci_pci_shutdown
;
539 return pci_register_driver(&xhci_pci_driver
);
541 module_init(xhci_pci_init
);
543 static void __exit
xhci_pci_exit(void)
545 pci_unregister_driver(&xhci_pci_driver
);
547 module_exit(xhci_pci_exit
);
549 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
550 MODULE_LICENSE("GPL");