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>
29 /* Device for a quirk */
30 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
31 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
32 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400 0x1400
34 #define PCI_VENDOR_ID_ETRON 0x1b6f
35 #define PCI_DEVICE_ID_ASROCK_P67 0x7023
37 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI 0x8c31
38 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI 0x9c31
39 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI 0x9cb1
40 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI 0x22b5
41 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI 0xa12f
42 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI 0x9d2f
43 #define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI 0x0aa8
44 #define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI 0x1aa8
45 #define PCI_DEVICE_ID_INTEL_APL_XHCI 0x5aa8
46 #define PCI_DEVICE_ID_INTEL_DNV_XHCI 0x19d0
48 #define PCI_DEVICE_ID_AMD_PROMONTORYA_4 0x43b9
49 #define PCI_DEVICE_ID_AMD_PROMONTORYA_3 0x43ba
50 #define PCI_DEVICE_ID_AMD_PROMONTORYA_2 0x43bb
51 #define PCI_DEVICE_ID_AMD_PROMONTORYA_1 0x43bc
53 static const char hcd_name[] = "xhci_hcd";
55 /* called after powerup, by probe or system-pm "wakeup" */
56 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
59 * TODO: Implement finding debug ports later.
60 * TODO: see if there are any quirks that need to be added to handle
61 * new extended capabilities.
64 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
65 if (!pci_set_mwi(pdev))
66 xhci_dbg(xhci, "MWI active\n");
68 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
72 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
74 struct pci_dev *pdev = to_pci_dev(dev);
76 /* Look for vendor-specific quirks */
77 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
78 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
79 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
80 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
81 pdev->revision == 0x0) {
82 xhci->quirks |= XHCI_RESET_EP_QUIRK;
83 xhci_dbg(xhci, "QUIRK: Fresco Logic xHC needs configure"
84 " endpoint cmd after reset endpoint\n");
86 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
87 pdev->revision == 0x4) {
88 xhci->quirks |= XHCI_SLOW_SUSPEND;
90 "QUIRK: Fresco Logic xHC revision %u"
91 "must be suspended extra slowly",
94 /* Fresco Logic confirms: all revisions of this chip do not
95 * support MSI, even though some of them claim to in their PCI
98 xhci->quirks |= XHCI_BROKEN_MSI;
99 xhci_dbg(xhci, "QUIRK: Fresco Logic revision %u "
100 "has broken MSI implementation\n",
102 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
105 if (pdev->vendor == PCI_VENDOR_ID_NEC)
106 xhci->quirks |= XHCI_NEC_HOST;
108 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
109 xhci->quirks |= XHCI_AMD_0x96_HOST;
112 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
113 xhci->quirks |= XHCI_AMD_PLL_FIX;
115 if (pdev->vendor == PCI_VENDOR_ID_AMD && pdev->device == 0x43bb)
116 xhci->quirks |= XHCI_SUSPEND_DELAY;
118 if (pdev->vendor == PCI_VENDOR_ID_AMD)
119 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
121 if ((pdev->vendor == PCI_VENDOR_ID_AMD) &&
122 ((pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_4) ||
123 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_3) ||
124 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_2) ||
125 (pdev->device == PCI_DEVICE_ID_AMD_PROMONTORYA_1)))
126 xhci->quirks |= XHCI_U2_DISABLE_WAKE;
128 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
129 xhci->quirks |= XHCI_INTEL_HOST;
130 if (pdev->vendor == PCI_VENDOR_ID_INTEL)
131 xhci->quirks |= XHCI_AVOID_BEI;
132 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
133 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
134 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
135 xhci->limit_active_eps = 64;
136 xhci->quirks |= XHCI_SW_BW_CHECKING;
138 * PPT desktop boards DH77EB and DH77DF will power back on after
139 * a few seconds of being shutdown. The fix for this is to
140 * switch the ports from xHCI to EHCI on shutdown. We can't use
141 * DMI information to find those particular boards (since each
142 * vendor will change the board name), so we have to key off all
145 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
147 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
148 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI ||
149 pdev->device == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI)) {
150 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
151 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
153 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
154 (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
155 pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
156 pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
157 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI ||
158 pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI ||
159 pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
160 pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI)) {
161 xhci->quirks |= XHCI_PME_STUCK_QUIRK;
163 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
164 (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
165 pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
166 pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI))
167 xhci->quirks |= XHCI_MISSING_CAS;
169 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
170 pdev->device == PCI_DEVICE_ID_ASROCK_P67) {
171 xhci->quirks |= XHCI_RESET_ON_RESUME;
172 xhci_dbg(xhci, "QUIRK: Resetting on resume\n");
173 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
175 if (pdev->vendor == PCI_VENDOR_ID_VIA)
176 xhci->quirks |= XHCI_RESET_ON_RESUME;
178 if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
179 pdev->device == 0x1142)
180 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
184 * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
185 * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
187 static void xhci_pme_quirk(struct xhci_hcd *xhci)
192 reg = (void __iomem *) xhci->cap_regs + 0x80a4;
194 writel(val | BIT(28), reg);
198 /* called during probe() after chip reset completes */
199 static int xhci_pci_setup(struct usb_hcd *hcd)
201 struct xhci_hcd *xhci;
202 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
205 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
209 xhci = hcd_to_xhci(hcd);
210 if (!usb_hcd_is_primary_hcd(hcd))
213 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
214 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
216 /* Find any debug ports */
217 retval = xhci_pci_reinit(xhci, pdev);
226 * We need to register our own PCI probe function (instead of the USB core's
227 * function) in order to create a second roothub under xHCI.
229 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
232 struct xhci_hcd *xhci;
233 struct hc_driver *driver;
236 driver = (struct hc_driver *)id->driver_data;
237 /* Register the USB 2.0 roothub.
238 * FIXME: USB core must know to register the USB 2.0 roothub first.
239 * This is sort of silly, because we could just set the HCD driver flags
240 * to say USB 2.0, but I'm not sure what the implications would be in
241 * the other parts of the HCD code.
243 retval = usb_hcd_pci_probe(dev, id);
248 /* USB 2.0 roothub is stored in the PCI device now. */
249 hcd = dev_get_drvdata(&dev->dev);
250 xhci = hcd_to_xhci(hcd);
251 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
253 if (!xhci->shared_hcd) {
255 goto dealloc_usb2_hcd;
258 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
259 * is called by usb_add_hcd().
261 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
263 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
267 /* Roothub already marked as USB 3.0 speed */
271 usb_put_hcd(xhci->shared_hcd);
273 usb_hcd_pci_remove(dev);
277 static void xhci_pci_remove(struct pci_dev *dev)
279 struct xhci_hcd *xhci;
281 xhci = hcd_to_xhci(pci_get_drvdata(dev));
282 if (xhci->shared_hcd) {
283 usb_remove_hcd(xhci->shared_hcd);
284 usb_put_hcd(xhci->shared_hcd);
287 /* Workaround for spurious wakeups at shutdown with HSW */
288 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
289 pci_set_power_state(dev, PCI_D3hot);
291 usb_hcd_pci_remove(dev);
297 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
299 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
302 if (hcd->state != HC_STATE_SUSPENDED ||
303 xhci->shared_hcd->state != HC_STATE_SUSPENDED)
306 if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
307 xhci_pme_quirk(xhci);
309 retval = xhci_suspend(xhci, do_wakeup);
314 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
316 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
317 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
320 /* The BIOS on systems with the Intel Panther Point chipset may or may
321 * not support xHCI natively. That means that during system resume, it
322 * may switch the ports back to EHCI so that users can use their
323 * keyboard to select a kernel from GRUB after resume from hibernate.
325 * The BIOS is supposed to remember whether the OS had xHCI ports
326 * enabled before resume, and switch the ports back to xHCI when the
327 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
330 * Unconditionally switch the ports back to xHCI after a system resume.
331 * We can't tell whether the EHCI or xHCI controller will be resumed
332 * first, so we have to do the port switchover in both drivers. Writing
333 * a '1' to the port switchover registers should have no effect if the
334 * port was already switched over.
336 if (usb_is_intel_switchable_xhci(pdev))
337 usb_enable_xhci_ports(pdev);
339 if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
340 xhci_pme_quirk(xhci);
342 retval = xhci_resume(xhci, hibernated);
345 #endif /* CONFIG_PM */
347 static const struct hc_driver xhci_pci_hc_driver = {
348 .description = hcd_name,
349 .product_desc = "xHCI Host Controller",
350 .hcd_priv_size = sizeof(struct xhci_hcd *),
353 * generic hardware linkage
356 .flags = HCD_MEMORY | HCD_USB3 | HCD_SHARED,
359 * basic lifecycle operations
361 .reset = xhci_pci_setup,
364 .pci_suspend = xhci_pci_suspend,
365 .pci_resume = xhci_pci_resume,
368 .shutdown = xhci_shutdown,
371 * managing i/o requests and associated device resources
373 .urb_enqueue = xhci_urb_enqueue,
374 .urb_dequeue = xhci_urb_dequeue,
375 .alloc_dev = xhci_alloc_dev,
376 .free_dev = xhci_free_dev,
377 .alloc_streams = xhci_alloc_streams,
378 .free_streams = xhci_free_streams,
379 .add_endpoint = xhci_add_endpoint,
380 .drop_endpoint = xhci_drop_endpoint,
381 .endpoint_reset = xhci_endpoint_reset,
382 .check_bandwidth = xhci_check_bandwidth,
383 .reset_bandwidth = xhci_reset_bandwidth,
384 .address_device = xhci_address_device,
385 .update_hub_device = xhci_update_hub_device,
386 .reset_device = xhci_discover_or_reset_device,
391 .get_frame_number = xhci_get_frame,
393 /* Root hub support */
394 .hub_control = xhci_hub_control,
395 .hub_status_data = xhci_hub_status_data,
396 .bus_suspend = xhci_bus_suspend,
397 .bus_resume = xhci_bus_resume,
399 * call back when device connected and addressed
401 .update_device = xhci_update_device,
402 .set_usb2_hw_lpm = xhci_set_usb2_hardware_lpm,
405 /*-------------------------------------------------------------------------*/
407 /* PCI driver selection metadata; PCI hotplugging uses this */
408 static const struct pci_device_id pci_ids[] = { {
409 /* handle any USB 3.0 xHCI controller */
410 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
411 .driver_data = (unsigned long) &xhci_pci_hc_driver,
413 { /* end: all zeroes */ }
415 MODULE_DEVICE_TABLE(pci, pci_ids);
417 /* pci driver glue; this is a "new style" PCI driver module */
418 static struct pci_driver xhci_pci_driver = {
419 .name = (char *) hcd_name,
422 .probe = xhci_pci_probe,
423 .remove = xhci_pci_remove,
424 /* suspend and resume implemented later */
426 .shutdown = usb_hcd_pci_shutdown,
429 .pm = &usb_hcd_pci_pm_ops
434 int __init xhci_register_pci(void)
436 return pci_register_driver(&xhci_pci_driver);
439 void __exit xhci_unregister_pci(void)
441 pci_unregister_driver(&xhci_pci_driver);