Version:  2.0.40 2.2.26 2.4.37 3.2 3.3 3.4 3.5 3.6 3.7 3.8 3.9 3.10 3.11 3.12 3.13 3.14 3.15 3.16 3.17 3.18

Linux/drivers/usb/host/xhci-pci.c

  1 /*
  2  * xHCI host controller driver PCI Bus Glue.
  3  *
  4  * Copyright (C) 2008 Intel Corp.
  5  *
  6  * Author: Sarah Sharp
  7  * Some code borrowed from the Linux EHCI driver.
  8  *
  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.
 12  *
 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
 16  * for more details.
 17  *
 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.
 21  */
 22 
 23 #include <linux/pci.h>
 24 #include <linux/slab.h>
 25 #include <linux/module.h>
 26 
 27 #include "xhci.h"
 28 #include "xhci-trace.h"
 29 
 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
 34 
 35 #define PCI_VENDOR_ID_ETRON             0x1b6f
 36 #define PCI_DEVICE_ID_EJ168             0x7023
 37 
 38 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI      0x8c31
 39 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI   0x9c31
 40 
 41 static const char hcd_name[] = "xhci_hcd";
 42 
 43 static struct hc_driver __read_mostly xhci_pci_hc_driver;
 44 
 45 /* called after powerup, by probe or system-pm "wakeup" */
 46 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
 47 {
 48         /*
 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.
 52          */
 53 
 54         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
 55         if (!pci_set_mwi(pdev))
 56                 xhci_dbg(xhci, "MWI active\n");
 57 
 58         xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
 59         return 0;
 60 }
 61 
 62 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
 63 {
 64         struct pci_dev          *pdev = to_pci_dev(dev);
 65 
 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");
 76                 }
 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",
 83                                 pdev->revision);
 84                 }
 85                 /* Fresco Logic confirms: all revisions of this chip do not
 86                  * support MSI, even though some of them claim to in their PCI
 87                  * capabilities.
 88                  */
 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",
 93                                 pdev->revision);
 94                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
 95         }
 96 
 97         if (pdev->vendor == PCI_VENDOR_ID_NEC)
 98                 xhci->quirks |= XHCI_NEC_HOST;
 99 
100         if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
101                 xhci->quirks |= XHCI_AMD_0x96_HOST;
102 
103         /* AMD PLL quirk */
104         if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
105                 xhci->quirks |= XHCI_AMD_PLL_FIX;
106 
107         if (pdev->vendor == PCI_VENDOR_ID_AMD)
108                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
109 
110         if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
111                 xhci->quirks |= XHCI_LPM_SUPPORT;
112                 xhci->quirks |= XHCI_INTEL_HOST;
113         }
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;
119                 /*
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
125                  * PPT chipsets.
126                  */
127                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
128                 xhci->quirks |= XHCI_AVOID_BEI;
129         }
130         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
131                 pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI) {
132                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
133         }
134         if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
135                         pdev->device == PCI_DEVICE_ID_EJ168) {
136                 xhci->quirks |= XHCI_RESET_ON_RESUME;
137                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
138                 xhci->quirks |= XHCI_BROKEN_STREAMS;
139         }
140         if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
141                         pdev->device == 0x0015)
142                 xhci->quirks |= XHCI_RESET_ON_RESUME;
143         if (pdev->vendor == PCI_VENDOR_ID_VIA)
144                 xhci->quirks |= XHCI_RESET_ON_RESUME;
145 
146         /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
147         if (pdev->vendor == PCI_VENDOR_ID_VIA &&
148                         pdev->device == 0x3432)
149                 xhci->quirks |= XHCI_BROKEN_STREAMS;
150 
151         if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
152                         pdev->device == 0x1042)
153                 xhci->quirks |= XHCI_BROKEN_STREAMS;
154 
155         if (xhci->quirks & XHCI_RESET_ON_RESUME)
156                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
157                                 "QUIRK: Resetting on resume");
158 }
159 
160 /* called during probe() after chip reset completes */
161 static int xhci_pci_setup(struct usb_hcd *hcd)
162 {
163         struct xhci_hcd         *xhci;
164         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
165         int                     retval;
166 
167         retval = xhci_gen_setup(hcd, xhci_pci_quirks);
168         if (retval)
169                 return retval;
170 
171         xhci = hcd_to_xhci(hcd);
172         if (!usb_hcd_is_primary_hcd(hcd))
173                 return 0;
174 
175         pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
176         xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
177 
178         /* Find any debug ports */
179         retval = xhci_pci_reinit(xhci, pdev);
180         if (!retval)
181                 return retval;
182 
183         kfree(xhci);
184         return retval;
185 }
186 
187 /*
188  * We need to register our own PCI probe function (instead of the USB core's
189  * function) in order to create a second roothub under xHCI.
190  */
191 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
192 {
193         int retval;
194         struct xhci_hcd *xhci;
195         struct hc_driver *driver;
196         struct usb_hcd *hcd;
197 
198         driver = (struct hc_driver *)id->driver_data;
199 
200         /* Prevent runtime suspending between USB-2 and USB-3 initialization */
201         pm_runtime_get_noresume(&dev->dev);
202 
203         /* Register the USB 2.0 roothub.
204          * FIXME: USB core must know to register the USB 2.0 roothub first.
205          * This is sort of silly, because we could just set the HCD driver flags
206          * to say USB 2.0, but I'm not sure what the implications would be in
207          * the other parts of the HCD code.
208          */
209         retval = usb_hcd_pci_probe(dev, id);
210 
211         if (retval)
212                 goto put_runtime_pm;
213 
214         /* USB 2.0 roothub is stored in the PCI device now. */
215         hcd = dev_get_drvdata(&dev->dev);
216         xhci = hcd_to_xhci(hcd);
217         xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
218                                 pci_name(dev), hcd);
219         if (!xhci->shared_hcd) {
220                 retval = -ENOMEM;
221                 goto dealloc_usb2_hcd;
222         }
223 
224         /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
225          * is called by usb_add_hcd().
226          */
227         *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
228 
229         retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
230                         IRQF_SHARED);
231         if (retval)
232                 goto put_usb3_hcd;
233         /* Roothub already marked as USB 3.0 speed */
234 
235         if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
236                         HCC_MAX_PSA(xhci->hcc_params) >= 4)
237                 xhci->shared_hcd->can_do_streams = 1;
238 
239         /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
240         pm_runtime_put_noidle(&dev->dev);
241 
242         return 0;
243 
244 put_usb3_hcd:
245         usb_put_hcd(xhci->shared_hcd);
246 dealloc_usb2_hcd:
247         usb_hcd_pci_remove(dev);
248 put_runtime_pm:
249         pm_runtime_put_noidle(&dev->dev);
250         return retval;
251 }
252 
253 static void xhci_pci_remove(struct pci_dev *dev)
254 {
255         struct xhci_hcd *xhci;
256 
257         xhci = hcd_to_xhci(pci_get_drvdata(dev));
258         if (xhci->shared_hcd) {
259                 usb_remove_hcd(xhci->shared_hcd);
260                 usb_put_hcd(xhci->shared_hcd);
261         }
262         usb_hcd_pci_remove(dev);
263 
264         /* Workaround for spurious wakeups at shutdown with HSW */
265         if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
266                 pci_set_power_state(dev, PCI_D3hot);
267 
268         kfree(xhci);
269 }
270 
271 #ifdef CONFIG_PM
272 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
273 {
274         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
275         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
276 
277         /*
278          * Systems with the TI redriver that loses port status change events
279          * need to have the registers polled during D3, so avoid D3cold.
280          */
281         if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
282                 pdev->no_d3cold = true;
283 
284         return xhci_suspend(xhci, do_wakeup);
285 }
286 
287 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
288 {
289         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
290         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
291         int                     retval = 0;
292 
293         /* The BIOS on systems with the Intel Panther Point chipset may or may
294          * not support xHCI natively.  That means that during system resume, it
295          * may switch the ports back to EHCI so that users can use their
296          * keyboard to select a kernel from GRUB after resume from hibernate.
297          *
298          * The BIOS is supposed to remember whether the OS had xHCI ports
299          * enabled before resume, and switch the ports back to xHCI when the
300          * BIOS/OS semaphore is written, but we all know we can't trust BIOS
301          * writers.
302          *
303          * Unconditionally switch the ports back to xHCI after a system resume.
304          * It should not matter whether the EHCI or xHCI controller is
305          * resumed first. It's enough to do the switchover in xHCI because
306          * USB core won't notice anything as the hub driver doesn't start
307          * running again until after all the devices (including both EHCI and
308          * xHCI host controllers) have been resumed.
309          */
310 
311         if (pdev->vendor == PCI_VENDOR_ID_INTEL)
312                 usb_enable_intel_xhci_ports(pdev);
313 
314         retval = xhci_resume(xhci, hibernated);
315         return retval;
316 }
317 #endif /* CONFIG_PM */
318 
319 /*-------------------------------------------------------------------------*/
320 
321 /* PCI driver selection metadata; PCI hotplugging uses this */
322 static const struct pci_device_id pci_ids[] = { {
323         /* handle any USB 3.0 xHCI controller */
324         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
325         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
326         },
327         { /* end: all zeroes */ }
328 };
329 MODULE_DEVICE_TABLE(pci, pci_ids);
330 
331 /* pci driver glue; this is a "new style" PCI driver module */
332 static struct pci_driver xhci_pci_driver = {
333         .name =         (char *) hcd_name,
334         .id_table =     pci_ids,
335 
336         .probe =        xhci_pci_probe,
337         .remove =       xhci_pci_remove,
338         /* suspend and resume implemented later */
339 
340         .shutdown =     usb_hcd_pci_shutdown,
341 #ifdef CONFIG_PM
342         .driver = {
343                 .pm = &usb_hcd_pci_pm_ops
344         },
345 #endif
346 };
347 
348 static int __init xhci_pci_init(void)
349 {
350         xhci_init_driver(&xhci_pci_hc_driver, xhci_pci_setup);
351 #ifdef CONFIG_PM
352         xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
353         xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
354 #endif
355         return pci_register_driver(&xhci_pci_driver);
356 }
357 module_init(xhci_pci_init);
358 
359 static void __exit xhci_pci_exit(void)
360 {
361         pci_unregister_driver(&xhci_pci_driver);
362 }
363 module_exit(xhci_pci_exit);
364 
365 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
366 MODULE_LICENSE("GPL");
367 

This page was automatically generated by LXR 0.3.1 (source).  •  Linux is a registered trademark of Linus Torvalds  •  Contact us