Correct .gbs.conf settings
[platform/adaptation/renesas_rcar/renesas_kernel.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
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_ASROCK_P67        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_XHCI ||
132              pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI)) {
133                 /* Workaround for occasional spurious wakeups from S5 (or
134                  * any other sleep) on Haswell machines with LPT and LPT-LP
135                  * with the new Intel BIOS
136                  */
137                 /* Limit the quirk to only known vendors, as this triggers
138                  * yet another BIOS bug on some other machines
139                  * https://bugzilla.kernel.org/show_bug.cgi?id=66171
140                  */
141                 if (pdev->subsystem_vendor == PCI_VENDOR_ID_HP)
142                         xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
143
144                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
145         }
146         if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
147                         pdev->device == PCI_DEVICE_ID_ASROCK_P67) {
148                 xhci->quirks |= XHCI_RESET_ON_RESUME;
149                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
150                                 "QUIRK: Resetting on resume");
151                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
152         }
153         if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
154                         pdev->device == 0x0015)
155                 xhci->quirks |= XHCI_RESET_ON_RESUME;
156         if (pdev->vendor == PCI_VENDOR_ID_VIA)
157                 xhci->quirks |= XHCI_RESET_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         /* We know the LPM timeout algorithms for this host, let the USB core
236          * enable and disable LPM for devices under the USB 3.0 roothub.
237          */
238         if (xhci->quirks & XHCI_LPM_SUPPORT)
239                 hcd_to_bus(xhci->shared_hcd)->root_hub->lpm_capable = 1;
240
241         /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
242         pm_runtime_put_noidle(&dev->dev);
243
244         return 0;
245
246 put_usb3_hcd:
247         usb_put_hcd(xhci->shared_hcd);
248 dealloc_usb2_hcd:
249         usb_hcd_pci_remove(dev);
250 put_runtime_pm:
251         pm_runtime_put_noidle(&dev->dev);
252         return retval;
253 }
254
255 static void xhci_pci_remove(struct pci_dev *dev)
256 {
257         struct xhci_hcd *xhci;
258
259         xhci = hcd_to_xhci(pci_get_drvdata(dev));
260         if (xhci->shared_hcd) {
261                 usb_remove_hcd(xhci->shared_hcd);
262                 usb_put_hcd(xhci->shared_hcd);
263         }
264         usb_hcd_pci_remove(dev);
265
266         /* Workaround for spurious wakeups at shutdown with HSW */
267         if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
268                 pci_set_power_state(dev, PCI_D3hot);
269
270         kfree(xhci);
271 }
272
273 #ifdef CONFIG_PM
274 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
275 {
276         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
277         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
278
279         /*
280          * Systems with the TI redriver that loses port status change events
281          * need to have the registers polled during D3, so avoid D3cold.
282          */
283         if (xhci_compliance_mode_recovery_timer_quirk_check())
284                 pdev->no_d3cold = true;
285
286         return xhci_suspend(xhci, do_wakeup);
287 }
288
289 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
290 {
291         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
292         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
293         int                     retval = 0;
294
295         /* The BIOS on systems with the Intel Panther Point chipset may or may
296          * not support xHCI natively.  That means that during system resume, it
297          * may switch the ports back to EHCI so that users can use their
298          * keyboard to select a kernel from GRUB after resume from hibernate.
299          *
300          * The BIOS is supposed to remember whether the OS had xHCI ports
301          * enabled before resume, and switch the ports back to xHCI when the
302          * BIOS/OS semaphore is written, but we all know we can't trust BIOS
303          * writers.
304          *
305          * Unconditionally switch the ports back to xHCI after a system resume.
306          * It should not matter whether the EHCI or xHCI controller is
307          * resumed first. It's enough to do the switchover in xHCI because
308          * USB core won't notice anything as the hub driver doesn't start
309          * running again until after all the devices (including both EHCI and
310          * xHCI host controllers) have been resumed.
311          */
312
313         if (pdev->vendor == PCI_VENDOR_ID_INTEL)
314                 usb_enable_intel_xhci_ports(pdev);
315
316         retval = xhci_resume(xhci, hibernated);
317         return retval;
318 }
319 #endif /* CONFIG_PM */
320
321 /*-------------------------------------------------------------------------*/
322
323 /* PCI driver selection metadata; PCI hotplugging uses this */
324 static const struct pci_device_id pci_ids[] = { {
325         /* handle any USB 3.0 xHCI controller */
326         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
327         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
328         },
329         { /* end: all zeroes */ }
330 };
331 MODULE_DEVICE_TABLE(pci, pci_ids);
332
333 /* pci driver glue; this is a "new style" PCI driver module */
334 static struct pci_driver xhci_pci_driver = {
335         .name =         (char *) hcd_name,
336         .id_table =     pci_ids,
337
338         .probe =        xhci_pci_probe,
339         .remove =       xhci_pci_remove,
340         /* suspend and resume implemented later */
341
342         .shutdown =     usb_hcd_pci_shutdown,
343 #ifdef CONFIG_PM
344         .driver = {
345                 .pm = &usb_hcd_pci_pm_ops
346         },
347 #endif
348 };
349
350 int __init xhci_register_pci(void)
351 {
352         xhci_init_driver(&xhci_pci_hc_driver, xhci_pci_setup);
353 #ifdef CONFIG_PM
354         xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
355         xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
356 #endif
357         return pci_register_driver(&xhci_pci_driver);
358 }
359
360 void xhci_unregister_pci(void)
361 {
362         pci_unregister_driver(&xhci_pci_driver);
363 }