2 * xHCI host controller driver PCI Bus Glue.
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/slab.h>
25 #include <linux/module.h>
26 #include <linux/acpi.h>
29 #include "xhci-trace.h"
31 #define PORT2_SSIC_CONFIG_REG2 0x883c
32 #define PROG_DONE (1 << 30)
33 #define SSIC_PORT_UNUSED (1 << 31)
35 /* Device for a quirk */
36 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
37 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
38 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
40 #define PCI_VENDOR_ID_ETRON 0x1b6f
41 #define PCI_DEVICE_ID_EJ168 0x7023
43 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
44 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
45 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI 0x22b5
46 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI 0xa12f
47 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI 0x9d2f
49 static const char hcd_name[] = "xhci_hcd";
51 static struct hc_driver __read_mostly xhci_pci_hc_driver;
53 static int xhci_pci_setup(struct usb_hcd *hcd);
55 static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
56 .reset = xhci_pci_setup,
59 /* called after powerup, by probe or system-pm "wakeup" */
60 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
63 * TODO: Implement finding debug ports later.
64 * TODO: see if there are any quirks that need to be added to handle
65 * new extended capabilities.
68 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
69 if (!pci_set_mwi(pdev))
70 xhci_dbg(xhci, "MWI active\n");
72 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
76 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
78 struct pci_dev *pdev = to_pci_dev(dev);
80 /* Look for vendor-specific quirks */
81 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
82 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
83 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
84 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
85 pdev->revision == 0x0) {
86 xhci->quirks |= XHCI_RESET_EP_QUIRK;
87 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
88 "QUIRK: Fresco Logic xHC needs configure"
89 " endpoint cmd after reset endpoint");
91 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
92 pdev->revision == 0x4) {
93 xhci->quirks |= XHCI_SLOW_SUSPEND;
94 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
95 "QUIRK: Fresco Logic xHC revision %u"
96 "must be suspended extra slowly",
99 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
100 xhci->quirks |= XHCI_BROKEN_STREAMS;
101 /* Fresco Logic confirms: all revisions of this chip do not
102 * support MSI, even though some of them claim to in their PCI
105 xhci->quirks |= XHCI_BROKEN_MSI;
106 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
107 "QUIRK: Fresco Logic revision %u "
108 "has broken MSI implementation",
110 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
113 if (pdev->vendor == PCI_VENDOR_ID_NEC)
114 xhci->quirks |= XHCI_NEC_HOST;
116 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
117 xhci->quirks |= XHCI_AMD_0x96_HOST;
120 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
121 xhci->quirks |= XHCI_AMD_PLL_FIX;
123 if (pdev->vendor == PCI_VENDOR_ID_AMD)
124 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
126 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
127 xhci->quirks |= XHCI_LPM_SUPPORT;
128 xhci->quirks |= XHCI_INTEL_HOST;
129 xhci->quirks |= XHCI_AVOID_BEI;
131 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
132 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
133 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
134 xhci->limit_active_eps = 64;
135 xhci->quirks |= XHCI_SW_BW_CHECKING;
137 * PPT desktop boards DH77EB and DH77DF will power back on after
138 * a few seconds of being shutdown. The fix for this is to
139 * switch the ports from xHCI to EHCI on shutdown. We can't use
140 * DMI information to find those particular boards (since each
141 * vendor will change the board name), so we have to key off all
144 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
146 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
147 pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
148 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
149 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
151 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
152 (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
153 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
154 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI)) {
155 xhci->quirks |= XHCI_PME_STUCK_QUIRK;
157 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
158 pdev->device == PCI_DEVICE_ID_EJ168) {
159 xhci->quirks |= XHCI_RESET_ON_RESUME;
160 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
161 xhci->quirks |= XHCI_BROKEN_STREAMS;
163 if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
164 pdev->device == 0x0015)
165 xhci->quirks |= XHCI_RESET_ON_RESUME;
166 if (pdev->vendor == PCI_VENDOR_ID_VIA)
167 xhci->quirks |= XHCI_RESET_ON_RESUME;
169 /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
170 if (pdev->vendor == PCI_VENDOR_ID_VIA &&
171 pdev->device == 0x3432)
172 xhci->quirks |= XHCI_BROKEN_STREAMS;
174 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
175 pdev->device == 0x1042)
176 xhci->quirks |= XHCI_BROKEN_STREAMS;
178 if (xhci->quirks & XHCI_RESET_ON_RESUME)
179 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
180 "QUIRK: Resetting on resume");
184 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
186 static const u8 intel_dsm_uuid[] = {
187 0xb7, 0x0c, 0x34, 0xac, 0x01, 0xe9, 0xbf, 0x45,
188 0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23,
190 union acpi_object *obj;
192 obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), intel_dsm_uuid, 3, 1,
197 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
198 #endif /* CONFIG_ACPI */
200 /* called during probe() after chip reset completes */
201 static int xhci_pci_setup(struct usb_hcd *hcd)
203 struct xhci_hcd *xhci;
204 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
207 xhci = hcd_to_xhci(hcd);
209 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
211 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
215 if (!usb_hcd_is_primary_hcd(hcd))
218 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
220 /* Find any debug ports */
221 retval = xhci_pci_reinit(xhci, pdev);
229 * We need to register our own PCI probe function (instead of the USB core's
230 * function) in order to create a second roothub under xHCI.
232 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
235 struct xhci_hcd *xhci;
236 struct hc_driver *driver;
239 driver = (struct hc_driver *)id->driver_data;
241 /* Prevent runtime suspending between USB-2 and USB-3 initialization */
242 pm_runtime_get_noresume(&dev->dev);
244 /* Register the USB 2.0 roothub.
245 * FIXME: USB core must know to register the USB 2.0 roothub first.
246 * This is sort of silly, because we could just set the HCD driver flags
247 * to say USB 2.0, but I'm not sure what the implications would be in
248 * the other parts of the HCD code.
250 retval = usb_hcd_pci_probe(dev, id);
255 /* USB 2.0 roothub is stored in the PCI device now. */
256 hcd = dev_get_drvdata(&dev->dev);
257 xhci = hcd_to_xhci(hcd);
258 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
260 if (!xhci->shared_hcd) {
262 goto dealloc_usb2_hcd;
265 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
269 /* Roothub already marked as USB 3.0 speed */
271 if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
272 HCC_MAX_PSA(xhci->hcc_params) >= 4)
273 xhci->shared_hcd->can_do_streams = 1;
275 if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
276 xhci_pme_acpi_rtd3_enable(dev);
278 /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
279 pm_runtime_put_noidle(&dev->dev);
284 usb_put_hcd(xhci->shared_hcd);
286 usb_hcd_pci_remove(dev);
288 pm_runtime_put_noidle(&dev->dev);
292 static void xhci_pci_remove(struct pci_dev *dev)
294 struct xhci_hcd *xhci;
296 xhci = hcd_to_xhci(pci_get_drvdata(dev));
297 if (xhci->shared_hcd) {
298 usb_remove_hcd(xhci->shared_hcd);
299 usb_put_hcd(xhci->shared_hcd);
301 usb_hcd_pci_remove(dev);
303 /* Workaround for spurious wakeups at shutdown with HSW */
304 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
305 pci_set_power_state(dev, PCI_D3hot);
310 * In some Intel xHCI controllers, in order to get D3 working,
311 * through a vendor specific SSIC CONFIG register at offset 0x883c,
312 * SSIC PORT need to be marked as "unused" before putting xHCI
313 * into D3. After D3 exit, the SSIC port need to be marked as "used".
314 * Without this change, xHCI might not enter D3 state.
315 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
316 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
318 static void xhci_pme_quirk(struct usb_hcd *hcd, bool suspend)
320 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
321 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
325 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
326 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
328 reg = (void __iomem *) xhci->cap_regs + PORT2_SSIC_CONFIG_REG2;
330 /* Notify SSIC that SSIC profile programming is not done */
331 val = readl(reg) & ~PROG_DONE;
334 /* Mark SSIC port as unused(suspend) or used(resume) */
337 val |= SSIC_PORT_UNUSED;
339 val &= ~SSIC_PORT_UNUSED;
342 /* Notify SSIC that SSIC profile programming is done */
343 val = readl(reg) | PROG_DONE;
348 reg = (void __iomem *) xhci->cap_regs + 0x80a4;
350 writel(val | BIT(28), reg);
354 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
356 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
357 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
360 * Systems with the TI redriver that loses port status change events
361 * need to have the registers polled during D3, so avoid D3cold.
363 if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
364 pdev->no_d3cold = true;
366 if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
367 xhci_pme_quirk(hcd, true);
369 return xhci_suspend(xhci, do_wakeup);
372 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
374 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
375 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
378 /* The BIOS on systems with the Intel Panther Point chipset may or may
379 * not support xHCI natively. That means that during system resume, it
380 * may switch the ports back to EHCI so that users can use their
381 * keyboard to select a kernel from GRUB after resume from hibernate.
383 * The BIOS is supposed to remember whether the OS had xHCI ports
384 * enabled before resume, and switch the ports back to xHCI when the
385 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
388 * Unconditionally switch the ports back to xHCI after a system resume.
389 * It should not matter whether the EHCI or xHCI controller is
390 * resumed first. It's enough to do the switchover in xHCI because
391 * USB core won't notice anything as the hub driver doesn't start
392 * running again until after all the devices (including both EHCI and
393 * xHCI host controllers) have been resumed.
396 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
397 usb_enable_intel_xhci_ports(pdev);
399 if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
400 xhci_pme_quirk(hcd, false);
402 retval = xhci_resume(xhci, hibernated);
405 #endif /* CONFIG_PM */
407 /*-------------------------------------------------------------------------*/
409 /* PCI driver selection metadata; PCI hotplugging uses this */
410 static const struct pci_device_id pci_ids[] = { {
411 /* handle any USB 3.0 xHCI controller */
412 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
413 .driver_data = (unsigned long) &xhci_pci_hc_driver,
415 { /* end: all zeroes */ }
417 MODULE_DEVICE_TABLE(pci, pci_ids);
419 /* pci driver glue; this is a "new style" PCI driver module */
420 static struct pci_driver xhci_pci_driver = {
421 .name = (char *) hcd_name,
424 .probe = xhci_pci_probe,
425 .remove = xhci_pci_remove,
426 /* suspend and resume implemented later */
428 .shutdown = usb_hcd_pci_shutdown,
431 .pm = &usb_hcd_pci_pm_ops
436 static int __init xhci_pci_init(void)
438 xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
440 xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
441 xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
443 return pci_register_driver(&xhci_pci_driver);
445 module_init(xhci_pci_init);
447 static void __exit xhci_pci_exit(void)
449 pci_unregister_driver(&xhci_pci_driver);
451 module_exit(xhci_pci_exit);
453 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
454 MODULE_LICENSE("GPL");