Merge branch 'perf-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[sfrench/cifs-2.6.git] / 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 #include <linux/acpi.h>
27
28 #include "xhci.h"
29 #include "xhci-trace.h"
30
31 #define SSIC_PORT_NUM           2
32 #define SSIC_PORT_CFG2          0x880c
33 #define SSIC_PORT_CFG2_OFFSET   0x30
34 #define PROG_DONE               (1 << 30)
35 #define SSIC_PORT_UNUSED        (1 << 31)
36
37 /* Device for a quirk */
38 #define PCI_VENDOR_ID_FRESCO_LOGIC      0x1b73
39 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK  0x1000
40 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009       0x1009
41 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400       0x1400
42
43 #define PCI_VENDOR_ID_ETRON             0x1b6f
44 #define PCI_DEVICE_ID_EJ168             0x7023
45
46 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI      0x8c31
47 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI   0x9c31
48 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI        0x9cb1
49 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI             0x22b5
50 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI         0xa12f
51 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI        0x9d2f
52 #define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI              0x0aa8
53 #define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI              0x1aa8
54 #define PCI_DEVICE_ID_INTEL_APL_XHCI                    0x5aa8
55 #define PCI_DEVICE_ID_INTEL_DNV_XHCI                    0x19d0
56
57 static const char hcd_name[] = "xhci_hcd";
58
59 static struct hc_driver __read_mostly xhci_pci_hc_driver;
60
61 static int xhci_pci_setup(struct usb_hcd *hcd);
62
63 static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
64         .reset = xhci_pci_setup,
65 };
66
67 /* called after powerup, by probe or system-pm "wakeup" */
68 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
69 {
70         /*
71          * TODO: Implement finding debug ports later.
72          * TODO: see if there are any quirks that need to be added to handle
73          * new extended capabilities.
74          */
75
76         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
77         if (!pci_set_mwi(pdev))
78                 xhci_dbg(xhci, "MWI active\n");
79
80         xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
81         return 0;
82 }
83
84 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
85 {
86         struct pci_dev          *pdev = to_pci_dev(dev);
87
88         /* Look for vendor-specific quirks */
89         if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
90                         (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
91                          pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
92                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
93                                 pdev->revision == 0x0) {
94                         xhci->quirks |= XHCI_RESET_EP_QUIRK;
95                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
96                                 "QUIRK: Fresco Logic xHC needs configure"
97                                 " endpoint cmd after reset endpoint");
98                 }
99                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
100                                 pdev->revision == 0x4) {
101                         xhci->quirks |= XHCI_SLOW_SUSPEND;
102                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
103                                 "QUIRK: Fresco Logic xHC revision %u"
104                                 "must be suspended extra slowly",
105                                 pdev->revision);
106                 }
107                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
108                         xhci->quirks |= XHCI_BROKEN_STREAMS;
109                 /* Fresco Logic confirms: all revisions of this chip do not
110                  * support MSI, even though some of them claim to in their PCI
111                  * capabilities.
112                  */
113                 xhci->quirks |= XHCI_BROKEN_MSI;
114                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
115                                 "QUIRK: Fresco Logic revision %u "
116                                 "has broken MSI implementation",
117                                 pdev->revision);
118                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
119         }
120
121         if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
122                         pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009)
123                 xhci->quirks |= XHCI_BROKEN_STREAMS;
124
125         if (pdev->vendor == PCI_VENDOR_ID_NEC)
126                 xhci->quirks |= XHCI_NEC_HOST;
127
128         if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
129                 xhci->quirks |= XHCI_AMD_0x96_HOST;
130
131         /* AMD PLL quirk */
132         if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
133                 xhci->quirks |= XHCI_AMD_PLL_FIX;
134
135         if (pdev->vendor == PCI_VENDOR_ID_AMD)
136                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
137
138         if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
139                 xhci->quirks |= XHCI_LPM_SUPPORT;
140                 xhci->quirks |= XHCI_INTEL_HOST;
141                 xhci->quirks |= XHCI_AVOID_BEI;
142         }
143         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
144                         pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
145                 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
146                 xhci->limit_active_eps = 64;
147                 xhci->quirks |= XHCI_SW_BW_CHECKING;
148                 /*
149                  * PPT desktop boards DH77EB and DH77DF will power back on after
150                  * a few seconds of being shutdown.  The fix for this is to
151                  * switch the ports from xHCI to EHCI on shutdown.  We can't use
152                  * DMI information to find those particular boards (since each
153                  * vendor will change the board name), so we have to key off all
154                  * PPT chipsets.
155                  */
156                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
157         }
158         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
159                 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI ||
160                  pdev->device == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI)) {
161                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
162                 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
163         }
164         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
165                 (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
166                  pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
167                  pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
168                  pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI ||
169                  pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI ||
170                  pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
171                  pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI)) {
172                 xhci->quirks |= XHCI_PME_STUCK_QUIRK;
173         }
174         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
175                  pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
176                 xhci->quirks |= XHCI_SSIC_PORT_UNUSED;
177         }
178         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
179             (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
180              pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI ||
181              pdev->device == PCI_DEVICE_ID_INTEL_DNV_XHCI))
182                 xhci->quirks |= XHCI_MISSING_CAS;
183
184         if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
185                         pdev->device == PCI_DEVICE_ID_EJ168) {
186                 xhci->quirks |= XHCI_RESET_ON_RESUME;
187                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
188                 xhci->quirks |= XHCI_BROKEN_STREAMS;
189         }
190         if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
191                         pdev->device == 0x0015)
192                 xhci->quirks |= XHCI_RESET_ON_RESUME;
193         if (pdev->vendor == PCI_VENDOR_ID_VIA)
194                 xhci->quirks |= XHCI_RESET_ON_RESUME;
195
196         /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
197         if (pdev->vendor == PCI_VENDOR_ID_VIA &&
198                         pdev->device == 0x3432)
199                 xhci->quirks |= XHCI_BROKEN_STREAMS;
200
201         if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
202                         pdev->device == 0x1042)
203                 xhci->quirks |= XHCI_BROKEN_STREAMS;
204         if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
205                         pdev->device == 0x1142)
206                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
207
208         if (pdev->vendor == PCI_VENDOR_ID_TI && pdev->device == 0x8241)
209                 xhci->quirks |= XHCI_LIMIT_ENDPOINT_INTERVAL_7;
210
211         if (xhci->quirks & XHCI_RESET_ON_RESUME)
212                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
213                                 "QUIRK: Resetting on resume");
214 }
215
216 #ifdef CONFIG_ACPI
217 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
218 {
219         static const u8 intel_dsm_uuid[] = {
220                 0xb7, 0x0c, 0x34, 0xac, 0x01, 0xe9, 0xbf, 0x45,
221                 0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23,
222         };
223         union acpi_object *obj;
224
225         obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), intel_dsm_uuid, 3, 1,
226                                 NULL);
227         ACPI_FREE(obj);
228 }
229 #else
230 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
231 #endif /* CONFIG_ACPI */
232
233 /* called during probe() after chip reset completes */
234 static int xhci_pci_setup(struct usb_hcd *hcd)
235 {
236         struct xhci_hcd         *xhci;
237         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
238         int                     retval;
239
240         xhci = hcd_to_xhci(hcd);
241         if (!xhci->sbrn)
242                 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
243
244         retval = xhci_gen_setup(hcd, xhci_pci_quirks);
245         if (retval)
246                 return retval;
247
248         if (!usb_hcd_is_primary_hcd(hcd))
249                 return 0;
250
251         xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
252
253         /* Find any debug ports */
254         return xhci_pci_reinit(xhci, pdev);
255 }
256
257 /*
258  * We need to register our own PCI probe function (instead of the USB core's
259  * function) in order to create a second roothub under xHCI.
260  */
261 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
262 {
263         int retval;
264         struct xhci_hcd *xhci;
265         struct hc_driver *driver;
266         struct usb_hcd *hcd;
267
268         driver = (struct hc_driver *)id->driver_data;
269
270         /* Prevent runtime suspending between USB-2 and USB-3 initialization */
271         pm_runtime_get_noresume(&dev->dev);
272
273         /* Register the USB 2.0 roothub.
274          * FIXME: USB core must know to register the USB 2.0 roothub first.
275          * This is sort of silly, because we could just set the HCD driver flags
276          * to say USB 2.0, but I'm not sure what the implications would be in
277          * the other parts of the HCD code.
278          */
279         retval = usb_hcd_pci_probe(dev, id);
280
281         if (retval)
282                 goto put_runtime_pm;
283
284         /* USB 2.0 roothub is stored in the PCI device now. */
285         hcd = dev_get_drvdata(&dev->dev);
286         xhci = hcd_to_xhci(hcd);
287         xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
288                                 pci_name(dev), hcd);
289         if (!xhci->shared_hcd) {
290                 retval = -ENOMEM;
291                 goto dealloc_usb2_hcd;
292         }
293
294         retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
295                         IRQF_SHARED);
296         if (retval)
297                 goto put_usb3_hcd;
298         /* Roothub already marked as USB 3.0 speed */
299
300         if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
301                         HCC_MAX_PSA(xhci->hcc_params) >= 4)
302                 xhci->shared_hcd->can_do_streams = 1;
303
304         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
305                 xhci_pme_acpi_rtd3_enable(dev);
306
307         /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
308         pm_runtime_put_noidle(&dev->dev);
309
310         return 0;
311
312 put_usb3_hcd:
313         usb_put_hcd(xhci->shared_hcd);
314 dealloc_usb2_hcd:
315         usb_hcd_pci_remove(dev);
316 put_runtime_pm:
317         pm_runtime_put_noidle(&dev->dev);
318         return retval;
319 }
320
321 static void xhci_pci_remove(struct pci_dev *dev)
322 {
323         struct xhci_hcd *xhci;
324
325         xhci = hcd_to_xhci(pci_get_drvdata(dev));
326         xhci->xhc_state |= XHCI_STATE_REMOVING;
327         if (xhci->shared_hcd) {
328                 usb_remove_hcd(xhci->shared_hcd);
329                 usb_put_hcd(xhci->shared_hcd);
330         }
331
332         /* Workaround for spurious wakeups at shutdown with HSW */
333         if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
334                 pci_set_power_state(dev, PCI_D3hot);
335
336         usb_hcd_pci_remove(dev);
337 }
338
339 #ifdef CONFIG_PM
340 /*
341  * In some Intel xHCI controllers, in order to get D3 working,
342  * through a vendor specific SSIC CONFIG register at offset 0x883c,
343  * SSIC PORT need to be marked as "unused" before putting xHCI
344  * into D3. After D3 exit, the SSIC port need to be marked as "used".
345  * Without this change, xHCI might not enter D3 state.
346  */
347 static void xhci_ssic_port_unused_quirk(struct usb_hcd *hcd, bool suspend)
348 {
349         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
350         u32 val;
351         void __iomem *reg;
352         int i;
353
354         for (i = 0; i < SSIC_PORT_NUM; i++) {
355                 reg = (void __iomem *) xhci->cap_regs +
356                                 SSIC_PORT_CFG2 +
357                                 i * SSIC_PORT_CFG2_OFFSET;
358
359                 /* Notify SSIC that SSIC profile programming is not done. */
360                 val = readl(reg) & ~PROG_DONE;
361                 writel(val, reg);
362
363                 /* Mark SSIC port as unused(suspend) or used(resume) */
364                 val = readl(reg);
365                 if (suspend)
366                         val |= SSIC_PORT_UNUSED;
367                 else
368                         val &= ~SSIC_PORT_UNUSED;
369                 writel(val, reg);
370
371                 /* Notify SSIC that SSIC profile programming is done */
372                 val = readl(reg) | PROG_DONE;
373                 writel(val, reg);
374                 readl(reg);
375         }
376 }
377
378 /*
379  * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
380  * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
381  */
382 static void xhci_pme_quirk(struct usb_hcd *hcd)
383 {
384         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
385         void __iomem *reg;
386         u32 val;
387
388         reg = (void __iomem *) xhci->cap_regs + 0x80a4;
389         val = readl(reg);
390         writel(val | BIT(28), reg);
391         readl(reg);
392 }
393
394 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
395 {
396         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
397         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
398         int                     ret;
399
400         /*
401          * Systems with the TI redriver that loses port status change events
402          * need to have the registers polled during D3, so avoid D3cold.
403          */
404         if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
405                 pci_d3cold_disable(pdev);
406
407         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
408                 xhci_pme_quirk(hcd);
409
410         if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
411                 xhci_ssic_port_unused_quirk(hcd, true);
412
413         ret = xhci_suspend(xhci, do_wakeup);
414         if (ret && (xhci->quirks & XHCI_SSIC_PORT_UNUSED))
415                 xhci_ssic_port_unused_quirk(hcd, false);
416
417         return ret;
418 }
419
420 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
421 {
422         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
423         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
424         int                     retval = 0;
425
426         /* The BIOS on systems with the Intel Panther Point chipset may or may
427          * not support xHCI natively.  That means that during system resume, it
428          * may switch the ports back to EHCI so that users can use their
429          * keyboard to select a kernel from GRUB after resume from hibernate.
430          *
431          * The BIOS is supposed to remember whether the OS had xHCI ports
432          * enabled before resume, and switch the ports back to xHCI when the
433          * BIOS/OS semaphore is written, but we all know we can't trust BIOS
434          * writers.
435          *
436          * Unconditionally switch the ports back to xHCI after a system resume.
437          * It should not matter whether the EHCI or xHCI controller is
438          * resumed first. It's enough to do the switchover in xHCI because
439          * USB core won't notice anything as the hub driver doesn't start
440          * running again until after all the devices (including both EHCI and
441          * xHCI host controllers) have been resumed.
442          */
443
444         if (pdev->vendor == PCI_VENDOR_ID_INTEL)
445                 usb_enable_intel_xhci_ports(pdev);
446
447         if (xhci->quirks & XHCI_SSIC_PORT_UNUSED)
448                 xhci_ssic_port_unused_quirk(hcd, false);
449
450         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
451                 xhci_pme_quirk(hcd);
452
453         retval = xhci_resume(xhci, hibernated);
454         return retval;
455 }
456 #endif /* CONFIG_PM */
457
458 /*-------------------------------------------------------------------------*/
459
460 /* PCI driver selection metadata; PCI hotplugging uses this */
461 static const struct pci_device_id pci_ids[] = { {
462         /* handle any USB 3.0 xHCI controller */
463         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
464         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
465         },
466         { /* end: all zeroes */ }
467 };
468 MODULE_DEVICE_TABLE(pci, pci_ids);
469
470 /* pci driver glue; this is a "new style" PCI driver module */
471 static struct pci_driver xhci_pci_driver = {
472         .name =         (char *) hcd_name,
473         .id_table =     pci_ids,
474
475         .probe =        xhci_pci_probe,
476         .remove =       xhci_pci_remove,
477         /* suspend and resume implemented later */
478
479         .shutdown =     usb_hcd_pci_shutdown,
480 #ifdef CONFIG_PM
481         .driver = {
482                 .pm = &usb_hcd_pci_pm_ops
483         },
484 #endif
485 };
486
487 static int __init xhci_pci_init(void)
488 {
489         xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
490 #ifdef CONFIG_PM
491         xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
492         xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
493 #endif
494         return pci_register_driver(&xhci_pci_driver);
495 }
496 module_init(xhci_pci_init);
497
498 static void __exit xhci_pci_exit(void)
499 {
500         pci_unregister_driver(&xhci_pci_driver);
501 }
502 module_exit(xhci_pci_exit);
503
504 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
505 MODULE_LICENSE("GPL");