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
40 static const char hcd_name[] = "xhci_hcd";
42 /* called after powerup, by probe or system-pm "wakeup" */
43 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
46 * TODO: Implement finding debug ports later.
47 * TODO: see if there are any quirks that need to be added to handle
48 * new extended capabilities.
51 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
52 if (!pci_set_mwi(pdev))
53 xhci_dbg(xhci, "MWI active\n");
55 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
59 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
61 struct pci_dev *pdev = to_pci_dev(dev);
63 /* Look for vendor-specific quirks */
64 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
65 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
66 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
67 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
68 pdev->revision == 0x0) {
69 xhci->quirks |= XHCI_RESET_EP_QUIRK;
70 xhci_dbg(xhci, "QUIRK: Fresco Logic xHC needs configure"
71 " endpoint cmd after reset endpoint\n");
73 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
74 pdev->revision == 0x4) {
75 xhci->quirks |= XHCI_SLOW_SUSPEND;
77 "QUIRK: Fresco Logic xHC revision %u"
78 "must be suspended extra slowly",
81 /* Fresco Logic confirms: all revisions of this chip do not
82 * support MSI, even though some of them claim to in their PCI
85 xhci->quirks |= XHCI_BROKEN_MSI;
86 xhci_dbg(xhci, "QUIRK: Fresco Logic revision %u "
87 "has broken MSI implementation\n",
89 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
92 if (pdev->vendor == PCI_VENDOR_ID_NEC)
93 xhci->quirks |= XHCI_NEC_HOST;
95 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
96 xhci->quirks |= XHCI_AMD_0x96_HOST;
99 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
100 xhci->quirks |= XHCI_AMD_PLL_FIX;
101 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
102 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
103 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
104 xhci->limit_active_eps = 64;
105 xhci->quirks |= XHCI_SW_BW_CHECKING;
107 * PPT desktop boards DH77EB and DH77DF will power back on after
108 * a few seconds of being shutdown. The fix for this is to
109 * switch the ports from xHCI to EHCI on shutdown. We can't use
110 * DMI information to find those particular boards (since each
111 * vendor will change the board name), so we have to key off all
114 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
115 xhci->quirks |= XHCI_AVOID_BEI;
117 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
118 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI ||
119 pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI)) {
120 /* Workaround for occasional spurious wakeups from S5 (or
121 * any other sleep) on Haswell machines with LPT and LPT-LP
122 * with the new Intel BIOS
124 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
126 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
127 pdev->device == PCI_DEVICE_ID_ASROCK_P67) {
128 xhci->quirks |= XHCI_RESET_ON_RESUME;
129 xhci_dbg(xhci, "QUIRK: Resetting on resume\n");
130 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
132 if (pdev->vendor == PCI_VENDOR_ID_VIA)
133 xhci->quirks |= XHCI_RESET_ON_RESUME;
136 /* called during probe() after chip reset completes */
137 static int xhci_pci_setup(struct usb_hcd *hcd)
139 struct xhci_hcd *xhci;
140 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
143 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
147 xhci = hcd_to_xhci(hcd);
148 if (!usb_hcd_is_primary_hcd(hcd))
151 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
152 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
154 /* Find any debug ports */
155 retval = xhci_pci_reinit(xhci, pdev);
164 * We need to register our own PCI probe function (instead of the USB core's
165 * function) in order to create a second roothub under xHCI.
167 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
170 struct xhci_hcd *xhci;
171 struct hc_driver *driver;
174 driver = (struct hc_driver *)id->driver_data;
175 /* Register the USB 2.0 roothub.
176 * FIXME: USB core must know to register the USB 2.0 roothub first.
177 * This is sort of silly, because we could just set the HCD driver flags
178 * to say USB 2.0, but I'm not sure what the implications would be in
179 * the other parts of the HCD code.
181 retval = usb_hcd_pci_probe(dev, id);
186 /* USB 2.0 roothub is stored in the PCI device now. */
187 hcd = dev_get_drvdata(&dev->dev);
188 xhci = hcd_to_xhci(hcd);
189 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
191 if (!xhci->shared_hcd) {
193 goto dealloc_usb2_hcd;
196 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
197 * is called by usb_add_hcd().
199 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
201 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
205 /* Roothub already marked as USB 3.0 speed */
209 usb_put_hcd(xhci->shared_hcd);
211 usb_hcd_pci_remove(dev);
215 static void xhci_pci_remove(struct pci_dev *dev)
217 struct xhci_hcd *xhci;
219 xhci = hcd_to_xhci(pci_get_drvdata(dev));
220 if (xhci->shared_hcd) {
221 usb_remove_hcd(xhci->shared_hcd);
222 usb_put_hcd(xhci->shared_hcd);
224 usb_hcd_pci_remove(dev);
226 /* Workaround for spurious wakeups at shutdown with HSW */
227 if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
228 pci_set_power_state(dev, PCI_D3hot);
234 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
236 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
239 if (hcd->state != HC_STATE_SUSPENDED ||
240 xhci->shared_hcd->state != HC_STATE_SUSPENDED)
243 retval = xhci_suspend(xhci);
248 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
250 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
251 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
254 /* The BIOS on systems with the Intel Panther Point chipset may or may
255 * not support xHCI natively. That means that during system resume, it
256 * may switch the ports back to EHCI so that users can use their
257 * keyboard to select a kernel from GRUB after resume from hibernate.
259 * The BIOS is supposed to remember whether the OS had xHCI ports
260 * enabled before resume, and switch the ports back to xHCI when the
261 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
264 * Unconditionally switch the ports back to xHCI after a system resume.
265 * We can't tell whether the EHCI or xHCI controller will be resumed
266 * first, so we have to do the port switchover in both drivers. Writing
267 * a '1' to the port switchover registers should have no effect if the
268 * port was already switched over.
270 if (usb_is_intel_switchable_xhci(pdev))
271 usb_enable_xhci_ports(pdev);
273 retval = xhci_resume(xhci, hibernated);
276 #endif /* CONFIG_PM */
278 static const struct hc_driver xhci_pci_hc_driver = {
279 .description = hcd_name,
280 .product_desc = "xHCI Host Controller",
281 .hcd_priv_size = sizeof(struct xhci_hcd *),
284 * generic hardware linkage
287 .flags = HCD_MEMORY | HCD_USB3 | HCD_SHARED,
290 * basic lifecycle operations
292 .reset = xhci_pci_setup,
295 .pci_suspend = xhci_pci_suspend,
296 .pci_resume = xhci_pci_resume,
299 .shutdown = xhci_shutdown,
302 * managing i/o requests and associated device resources
304 .urb_enqueue = xhci_urb_enqueue,
305 .urb_dequeue = xhci_urb_dequeue,
306 .alloc_dev = xhci_alloc_dev,
307 .free_dev = xhci_free_dev,
308 .alloc_streams = xhci_alloc_streams,
309 .free_streams = xhci_free_streams,
310 .add_endpoint = xhci_add_endpoint,
311 .drop_endpoint = xhci_drop_endpoint,
312 .endpoint_reset = xhci_endpoint_reset,
313 .check_bandwidth = xhci_check_bandwidth,
314 .reset_bandwidth = xhci_reset_bandwidth,
315 .address_device = xhci_address_device,
316 .update_hub_device = xhci_update_hub_device,
317 .reset_device = xhci_discover_or_reset_device,
322 .get_frame_number = xhci_get_frame,
324 /* Root hub support */
325 .hub_control = xhci_hub_control,
326 .hub_status_data = xhci_hub_status_data,
327 .bus_suspend = xhci_bus_suspend,
328 .bus_resume = xhci_bus_resume,
330 * call back when device connected and addressed
332 .update_device = xhci_update_device,
333 .set_usb2_hw_lpm = xhci_set_usb2_hardware_lpm,
336 /*-------------------------------------------------------------------------*/
338 /* PCI driver selection metadata; PCI hotplugging uses this */
339 static const struct pci_device_id pci_ids[] = { {
340 /* handle any USB 3.0 xHCI controller */
341 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
342 .driver_data = (unsigned long) &xhci_pci_hc_driver,
344 { /* end: all zeroes */ }
346 MODULE_DEVICE_TABLE(pci, pci_ids);
348 /* pci driver glue; this is a "new style" PCI driver module */
349 static struct pci_driver xhci_pci_driver = {
350 .name = (char *) hcd_name,
353 .probe = xhci_pci_probe,
354 .remove = xhci_pci_remove,
355 /* suspend and resume implemented later */
357 .shutdown = usb_hcd_pci_shutdown,
360 .pm = &usb_hcd_pci_pm_ops
365 int __init xhci_register_pci(void)
367 return pci_register_driver(&xhci_pci_driver);
370 void __exit xhci_unregister_pci(void)
372 pci_unregister_driver(&xhci_pci_driver);