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