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