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>
28 #include "xhci-trace.h"
30 /* Device for a quirk */
31 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
32 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
33 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
35 #define PCI_VENDOR_ID_ETRON 0x1b6f
36 #define PCI_DEVICE_ID_EJ168 0x7023
38 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
39 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
41 static const char hcd_name[] = "xhci_hcd";
43 static struct hc_driver __read_mostly xhci_pci_hc_driver;
45 /* called after powerup, by probe or system-pm "wakeup" */
46 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
49 * TODO: Implement finding debug ports later.
50 * TODO: see if there are any quirks that need to be added to handle
51 * new extended capabilities.
54 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
55 if (!pci_set_mwi(pdev))
56 xhci_dbg(xhci, "MWI active\n");
58 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
62 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
64 struct pci_dev *pdev = to_pci_dev(dev);
66 /* Look for vendor-specific quirks */
67 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
68 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
69 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
70 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
71 pdev->revision == 0x0) {
72 xhci->quirks |= XHCI_RESET_EP_QUIRK;
73 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
74 "QUIRK: Fresco Logic xHC needs configure"
75 " endpoint cmd after reset endpoint");
77 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
78 pdev->revision == 0x4) {
79 xhci->quirks |= XHCI_SLOW_SUSPEND;
80 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
81 "QUIRK: Fresco Logic xHC revision %u"
82 "must be suspended extra slowly",
85 /* Fresco Logic confirms: all revisions of this chip do not
86 * support MSI, even though some of them claim to in their PCI
89 xhci->quirks |= XHCI_BROKEN_MSI;
90 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
91 "QUIRK: Fresco Logic revision %u "
92 "has broken MSI implementation",
94 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
97 if (pdev->vendor == PCI_VENDOR_ID_NEC)
98 xhci->quirks |= XHCI_NEC_HOST;
100 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
101 xhci->quirks |= XHCI_AMD_0x96_HOST;
104 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
105 xhci->quirks |= XHCI_AMD_PLL_FIX;
107 if (pdev->vendor == PCI_VENDOR_ID_AMD)
108 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
110 if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
111 xhci->quirks |= XHCI_LPM_SUPPORT;
112 xhci->quirks |= XHCI_INTEL_HOST;
114 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
115 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
116 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
117 xhci->limit_active_eps = 64;
118 xhci->quirks |= XHCI_SW_BW_CHECKING;
120 * PPT desktop boards DH77EB and DH77DF will power back on after
121 * a few seconds of being shutdown. The fix for this is to
122 * switch the ports from xHCI to EHCI on shutdown. We can't use
123 * DMI information to find those particular boards (since each
124 * vendor will change the board name), so we have to key off all
127 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
128 xhci->quirks |= XHCI_AVOID_BEI;
130 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
131 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI ||
132 pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI)) {
133 /* Workaround for occasional spurious wakeups from S5 (or
134 * any other sleep) on Haswell machines with LPT and LPT-LP
135 * with the new Intel BIOS
137 /* Limit the quirk to only known vendors, as this triggers
138 * yet another BIOS bug on some other machines
139 * https://bugzilla.kernel.org/show_bug.cgi?id=66171
141 if (pdev->subsystem_vendor == PCI_VENDOR_ID_HP)
142 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
144 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
145 pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
146 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
148 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
149 pdev->device == PCI_DEVICE_ID_EJ168) {
150 xhci->quirks |= XHCI_RESET_ON_RESUME;
151 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
152 xhci->quirks |= XHCI_BROKEN_STREAMS;
154 if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
155 pdev->device == 0x0015)
156 xhci->quirks |= XHCI_RESET_ON_RESUME;
157 if (pdev->vendor == PCI_VENDOR_ID_VIA)
158 xhci->quirks |= XHCI_RESET_ON_RESUME;
160 /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
161 if (pdev->vendor == PCI_VENDOR_ID_VIA &&
162 pdev->device == 0x3432)
163 xhci->quirks |= XHCI_BROKEN_STREAMS;
165 if (xhci->quirks & XHCI_RESET_ON_RESUME)
166 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
167 "QUIRK: Resetting on resume");
170 /* called during probe() after chip reset completes */
171 static int xhci_pci_setup(struct usb_hcd *hcd)
173 struct xhci_hcd *xhci;
174 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
177 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
181 xhci = hcd_to_xhci(hcd);
182 if (!usb_hcd_is_primary_hcd(hcd))
185 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
186 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
188 /* Find any debug ports */
189 retval = xhci_pci_reinit(xhci, pdev);
198 * We need to register our own PCI probe function (instead of the USB core's
199 * function) in order to create a second roothub under xHCI.
201 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
204 struct xhci_hcd *xhci;
205 struct hc_driver *driver;
208 driver = (struct hc_driver *)id->driver_data;
210 /* Prevent runtime suspending between USB-2 and USB-3 initialization */
211 pm_runtime_get_noresume(&dev->dev);
213 /* Register the USB 2.0 roothub.
214 * FIXME: USB core must know to register the USB 2.0 roothub first.
215 * This is sort of silly, because we could just set the HCD driver flags
216 * to say USB 2.0, but I'm not sure what the implications would be in
217 * the other parts of the HCD code.
219 retval = usb_hcd_pci_probe(dev, id);
224 /* USB 2.0 roothub is stored in the PCI device now. */
225 hcd = dev_get_drvdata(&dev->dev);
226 xhci = hcd_to_xhci(hcd);
227 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
229 if (!xhci->shared_hcd) {
231 goto dealloc_usb2_hcd;
234 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
235 * is called by usb_add_hcd().
237 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
239 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
243 /* Roothub already marked as USB 3.0 speed */
245 if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
246 HCC_MAX_PSA(xhci->hcc_params) >= 4)
247 xhci->shared_hcd->can_do_streams = 1;
249 /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
250 pm_runtime_put_noidle(&dev->dev);
255 usb_put_hcd(xhci->shared_hcd);
257 usb_hcd_pci_remove(dev);
259 pm_runtime_put_noidle(&dev->dev);
263 static void xhci_pci_remove(struct pci_dev *dev)
265 struct xhci_hcd *xhci;
267 xhci = hcd_to_xhci(pci_get_drvdata(dev));
268 if (xhci->shared_hcd) {
269 usb_remove_hcd(xhci->shared_hcd);
270 usb_put_hcd(xhci->shared_hcd);
272 usb_hcd_pci_remove(dev);
274 /* Workaround for spurious wakeups at shutdown with HSW */
275 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
276 pci_set_power_state(dev, PCI_D3hot);
282 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
284 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
285 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
288 * Systems with the TI redriver that loses port status change events
289 * need to have the registers polled during D3, so avoid D3cold.
291 if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
292 pdev->no_d3cold = true;
294 return xhci_suspend(xhci);
297 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
299 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
300 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
303 /* The BIOS on systems with the Intel Panther Point chipset may or may
304 * not support xHCI natively. That means that during system resume, it
305 * may switch the ports back to EHCI so that users can use their
306 * keyboard to select a kernel from GRUB after resume from hibernate.
308 * The BIOS is supposed to remember whether the OS had xHCI ports
309 * enabled before resume, and switch the ports back to xHCI when the
310 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
313 * Unconditionally switch the ports back to xHCI after a system resume.
314 * It should not matter whether the EHCI or xHCI controller is
315 * resumed first. It's enough to do the switchover in xHCI because
316 * USB core won't notice anything as the hub driver doesn't start
317 * running again until after all the devices (including both EHCI and
318 * xHCI host controllers) have been resumed.
321 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
322 usb_enable_intel_xhci_ports(pdev);
324 retval = xhci_resume(xhci, hibernated);
327 #endif /* CONFIG_PM */
329 /*-------------------------------------------------------------------------*/
331 /* PCI driver selection metadata; PCI hotplugging uses this */
332 static const struct pci_device_id pci_ids[] = { {
333 /* handle any USB 3.0 xHCI controller */
334 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
335 .driver_data = (unsigned long) &xhci_pci_hc_driver,
337 { /* end: all zeroes */ }
339 MODULE_DEVICE_TABLE(pci, pci_ids);
341 /* pci driver glue; this is a "new style" PCI driver module */
342 static struct pci_driver xhci_pci_driver = {
343 .name = (char *) hcd_name,
346 .probe = xhci_pci_probe,
347 .remove = xhci_pci_remove,
348 /* suspend and resume implemented later */
350 .shutdown = usb_hcd_pci_shutdown,
353 .pm = &usb_hcd_pci_pm_ops
358 static int __init xhci_pci_init(void)
360 xhci_init_driver(&xhci_pci_hc_driver, xhci_pci_setup);
362 xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
363 xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
365 return pci_register_driver(&xhci_pci_driver);
367 module_init(xhci_pci_init);
369 static void __exit xhci_pci_exit(void)
371 pci_unregister_driver(&xhci_pci_driver);
373 module_exit(xhci_pci_exit);
375 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
376 MODULE_LICENSE("GPL");