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 static const char hcd_name[] = "xhci_hcd";
39 /* called after powerup, by probe or system-pm "wakeup" */
40 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
43 * TODO: Implement finding debug ports later.
44 * TODO: see if there are any quirks that need to be added to handle
45 * new extended capabilities.
48 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
49 if (!pci_set_mwi(pdev))
50 xhci_dbg(xhci, "MWI active\n");
52 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
56 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
58 struct pci_dev *pdev = to_pci_dev(dev);
60 /* Look for vendor-specific quirks */
61 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
62 (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
63 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
64 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
65 pdev->revision == 0x0) {
66 xhci->quirks |= XHCI_RESET_EP_QUIRK;
67 xhci_dbg(xhci, "QUIRK: Fresco Logic xHC needs configure"
68 " endpoint cmd after reset endpoint\n");
70 /* Fresco Logic confirms: all revisions of this chip do not
71 * support MSI, even though some of them claim to in their PCI
74 xhci->quirks |= XHCI_BROKEN_MSI;
75 xhci_dbg(xhci, "QUIRK: Fresco Logic revision %u "
76 "has broken MSI implementation\n",
78 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
81 if (pdev->vendor == PCI_VENDOR_ID_NEC)
82 xhci->quirks |= XHCI_NEC_HOST;
84 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
85 xhci->quirks |= XHCI_AMD_0x96_HOST;
88 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
89 xhci->quirks |= XHCI_AMD_PLL_FIX;
90 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
91 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
92 xhci->quirks |= XHCI_SPURIOUS_SUCCESS;
93 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
94 xhci->limit_active_eps = 64;
95 xhci->quirks |= XHCI_SW_BW_CHECKING;
97 * PPT desktop boards DH77EB and DH77DF will power back on after
98 * a few seconds of being shutdown. The fix for this is to
99 * switch the ports from xHCI to EHCI on shutdown. We can't use
100 * DMI information to find those particular boards (since each
101 * vendor will change the board name), so we have to key off all
104 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
105 xhci->quirks |= XHCI_AVOID_BEI;
107 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
108 pdev->device == PCI_DEVICE_ID_ASROCK_P67) {
109 xhci->quirks |= XHCI_RESET_ON_RESUME;
110 xhci_dbg(xhci, "QUIRK: Resetting on resume\n");
111 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
113 if (pdev->vendor == PCI_VENDOR_ID_VIA)
114 xhci->quirks |= XHCI_RESET_ON_RESUME;
117 /* called during probe() after chip reset completes */
118 static int xhci_pci_setup(struct usb_hcd *hcd)
120 struct xhci_hcd *xhci;
121 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
124 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
128 xhci = hcd_to_xhci(hcd);
129 if (!usb_hcd_is_primary_hcd(hcd))
132 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
133 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
135 /* Find any debug ports */
136 retval = xhci_pci_reinit(xhci, pdev);
145 * We need to register our own PCI probe function (instead of the USB core's
146 * function) in order to create a second roothub under xHCI.
148 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
151 struct xhci_hcd *xhci;
152 struct hc_driver *driver;
155 driver = (struct hc_driver *)id->driver_data;
156 /* Register the USB 2.0 roothub.
157 * FIXME: USB core must know to register the USB 2.0 roothub first.
158 * This is sort of silly, because we could just set the HCD driver flags
159 * to say USB 2.0, but I'm not sure what the implications would be in
160 * the other parts of the HCD code.
162 retval = usb_hcd_pci_probe(dev, id);
167 /* USB 2.0 roothub is stored in the PCI device now. */
168 hcd = dev_get_drvdata(&dev->dev);
169 xhci = hcd_to_xhci(hcd);
170 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
172 if (!xhci->shared_hcd) {
174 goto dealloc_usb2_hcd;
177 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
178 * is called by usb_add_hcd().
180 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
182 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
186 /* Roothub already marked as USB 3.0 speed */
190 usb_put_hcd(xhci->shared_hcd);
192 usb_hcd_pci_remove(dev);
196 static void xhci_pci_remove(struct pci_dev *dev)
198 struct xhci_hcd *xhci;
200 xhci = hcd_to_xhci(pci_get_drvdata(dev));
201 if (xhci->shared_hcd) {
202 usb_remove_hcd(xhci->shared_hcd);
203 usb_put_hcd(xhci->shared_hcd);
205 usb_hcd_pci_remove(dev);
210 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
212 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
215 if (hcd->state != HC_STATE_SUSPENDED ||
216 xhci->shared_hcd->state != HC_STATE_SUSPENDED)
219 retval = xhci_suspend(xhci);
224 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
226 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
227 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
230 /* The BIOS on systems with the Intel Panther Point chipset may or may
231 * not support xHCI natively. That means that during system resume, it
232 * may switch the ports back to EHCI so that users can use their
233 * keyboard to select a kernel from GRUB after resume from hibernate.
235 * The BIOS is supposed to remember whether the OS had xHCI ports
236 * enabled before resume, and switch the ports back to xHCI when the
237 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
240 * Unconditionally switch the ports back to xHCI after a system resume.
241 * We can't tell whether the EHCI or xHCI controller will be resumed
242 * first, so we have to do the port switchover in both drivers. Writing
243 * a '1' to the port switchover registers should have no effect if the
244 * port was already switched over.
246 if (usb_is_intel_switchable_xhci(pdev))
247 usb_enable_xhci_ports(pdev);
249 retval = xhci_resume(xhci, hibernated);
252 #endif /* CONFIG_PM */
254 static const struct hc_driver xhci_pci_hc_driver = {
255 .description = hcd_name,
256 .product_desc = "xHCI Host Controller",
257 .hcd_priv_size = sizeof(struct xhci_hcd *),
260 * generic hardware linkage
263 .flags = HCD_MEMORY | HCD_USB3 | HCD_SHARED,
266 * basic lifecycle operations
268 .reset = xhci_pci_setup,
271 .pci_suspend = xhci_pci_suspend,
272 .pci_resume = xhci_pci_resume,
275 .shutdown = xhci_shutdown,
278 * managing i/o requests and associated device resources
280 .urb_enqueue = xhci_urb_enqueue,
281 .urb_dequeue = xhci_urb_dequeue,
282 .alloc_dev = xhci_alloc_dev,
283 .free_dev = xhci_free_dev,
284 .alloc_streams = xhci_alloc_streams,
285 .free_streams = xhci_free_streams,
286 .add_endpoint = xhci_add_endpoint,
287 .drop_endpoint = xhci_drop_endpoint,
288 .endpoint_reset = xhci_endpoint_reset,
289 .check_bandwidth = xhci_check_bandwidth,
290 .reset_bandwidth = xhci_reset_bandwidth,
291 .address_device = xhci_address_device,
292 .update_hub_device = xhci_update_hub_device,
293 .reset_device = xhci_discover_or_reset_device,
298 .get_frame_number = xhci_get_frame,
300 /* Root hub support */
301 .hub_control = xhci_hub_control,
302 .hub_status_data = xhci_hub_status_data,
303 .bus_suspend = xhci_bus_suspend,
304 .bus_resume = xhci_bus_resume,
306 * call back when device connected and addressed
308 .update_device = xhci_update_device,
309 .set_usb2_hw_lpm = xhci_set_usb2_hardware_lpm,
312 /*-------------------------------------------------------------------------*/
314 /* PCI driver selection metadata; PCI hotplugging uses this */
315 static const struct pci_device_id pci_ids[] = { {
316 /* handle any USB 3.0 xHCI controller */
317 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
318 .driver_data = (unsigned long) &xhci_pci_hc_driver,
320 { /* end: all zeroes */ }
322 MODULE_DEVICE_TABLE(pci, pci_ids);
324 /* pci driver glue; this is a "new style" PCI driver module */
325 static struct pci_driver xhci_pci_driver = {
326 .name = (char *) hcd_name,
329 .probe = xhci_pci_probe,
330 .remove = xhci_pci_remove,
331 /* suspend and resume implemented later */
333 .shutdown = usb_hcd_pci_shutdown,
334 #ifdef CONFIG_PM_SLEEP
336 .pm = &usb_hcd_pci_pm_ops
341 int __init xhci_register_pci(void)
343 return pci_register_driver(&xhci_pci_driver);
346 void __exit xhci_unregister_pci(void)
348 pci_unregister_driver(&xhci_pci_driver);