]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/usb/host/xhci-pci.c
xhci: Add infrastructure for host-specific LPM policies.
[mirror_ubuntu-bionic-kernel.git] / drivers / usb / host / xhci-pci.c
CommitLineData
66d4eadd
SS
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>
7fc2a616 24#include <linux/slab.h>
6eb0de82 25#include <linux/module.h>
66d4eadd
SS
26
27#include "xhci.h"
28
ac9d8fe7
SS
29/* Device for a quirk */
30#define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
31#define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
32
c877b3b2
ML
33#define PCI_VENDOR_ID_ETRON 0x1b6f
34#define PCI_DEVICE_ID_ASROCK_P67 0x7023
35
66d4eadd
SS
36static const char hcd_name[] = "xhci_hcd";
37
38/* called after powerup, by probe or system-pm "wakeup" */
39static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
40{
41 /*
42 * TODO: Implement finding debug ports later.
43 * TODO: see if there are any quirks that need to be added to handle
44 * new extended capabilities.
45 */
46
47 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
48 if (!pci_set_mwi(pdev))
49 xhci_dbg(xhci, "MWI active\n");
50
51 xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
52 return 0;
53}
54
da3c9c4f
SAS
55static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
56{
57 struct pci_dev *pdev = to_pci_dev(dev);
58
ac9d8fe7
SS
59 /* Look for vendor-specific quirks */
60 if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
f5182b41
SS
61 pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK) {
62 if (pdev->revision == 0x0) {
ac9d8fe7
SS
63 xhci->quirks |= XHCI_RESET_EP_QUIRK;
64 xhci_dbg(xhci, "QUIRK: Fresco Logic xHC needs configure"
65 " endpoint cmd after reset endpoint\n");
f5182b41
SS
66 }
67 /* Fresco Logic confirms: all revisions of this chip do not
68 * support MSI, even though some of them claim to in their PCI
69 * capabilities.
70 */
71 xhci->quirks |= XHCI_BROKEN_MSI;
72 xhci_dbg(xhci, "QUIRK: Fresco Logic revision %u "
73 "has broken MSI implementation\n",
74 pdev->revision);
1530bbc6 75 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
ac9d8fe7 76 }
f5182b41 77
0238634d
SS
78 if (pdev->vendor == PCI_VENDOR_ID_NEC)
79 xhci->quirks |= XHCI_NEC_HOST;
ac9d8fe7 80
7e393a83
AX
81 if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
82 xhci->quirks |= XHCI_AMD_0x96_HOST;
83
c41136b0
AX
84 /* AMD PLL quirk */
85 if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
86 xhci->quirks |= XHCI_AMD_PLL_FIX;
ad808333
SS
87 if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
88 pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
89 xhci->quirks |= XHCI_SPURIOUS_SUCCESS;
2cf95c18
SS
90 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
91 xhci->limit_active_eps = 64;
86cc558e 92 xhci->quirks |= XHCI_SW_BW_CHECKING;
ad808333 93 }
c877b3b2
ML
94 if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
95 pdev->device == PCI_DEVICE_ID_ASROCK_P67) {
96 xhci->quirks |= XHCI_RESET_ON_RESUME;
97 xhci_dbg(xhci, "QUIRK: Resetting on resume\n");
98 }
457a4f61
EF
99 if (pdev->vendor == PCI_VENDOR_ID_VIA)
100 xhci->quirks |= XHCI_RESET_ON_RESUME;
da3c9c4f 101}
c41136b0 102
da3c9c4f
SAS
103/* called during probe() after chip reset completes */
104static int xhci_pci_setup(struct usb_hcd *hcd)
105{
106 struct xhci_hcd *xhci;
107 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
108 int retval;
66d4eadd 109
da3c9c4f 110 retval = xhci_gen_setup(hcd, xhci_pci_quirks);
66d4eadd 111 if (retval)
da3c9c4f 112 return retval;
006d5820 113
da3c9c4f
SAS
114 xhci = hcd_to_xhci(hcd);
115 if (!usb_hcd_is_primary_hcd(hcd))
116 return 0;
66d4eadd
SS
117
118 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
119 xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
120
121 /* Find any debug ports */
b02d0ed6
SS
122 retval = xhci_pci_reinit(xhci, pdev);
123 if (!retval)
124 return retval;
125
b02d0ed6
SS
126 kfree(xhci);
127 return retval;
128}
129
f6ff0ac8
SS
130/*
131 * We need to register our own PCI probe function (instead of the USB core's
132 * function) in order to create a second roothub under xHCI.
133 */
134static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
135{
136 int retval;
137 struct xhci_hcd *xhci;
138 struct hc_driver *driver;
139 struct usb_hcd *hcd;
140
141 driver = (struct hc_driver *)id->driver_data;
142 /* Register the USB 2.0 roothub.
143 * FIXME: USB core must know to register the USB 2.0 roothub first.
144 * This is sort of silly, because we could just set the HCD driver flags
145 * to say USB 2.0, but I'm not sure what the implications would be in
146 * the other parts of the HCD code.
147 */
148 retval = usb_hcd_pci_probe(dev, id);
149
150 if (retval)
151 return retval;
152
153 /* USB 2.0 roothub is stored in the PCI device now. */
154 hcd = dev_get_drvdata(&dev->dev);
155 xhci = hcd_to_xhci(hcd);
156 xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
157 pci_name(dev), hcd);
158 if (!xhci->shared_hcd) {
159 retval = -ENOMEM;
160 goto dealloc_usb2_hcd;
161 }
162
163 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
164 * is called by usb_add_hcd().
165 */
166 *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
167
168 retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
b5dd18d8 169 IRQF_SHARED);
f6ff0ac8
SS
170 if (retval)
171 goto put_usb3_hcd;
172 /* Roothub already marked as USB 3.0 speed */
3b3db026
SS
173
174 /* We know the LPM timeout algorithms for this host, let the USB core
175 * enable and disable LPM for devices under the USB 3.0 roothub.
176 */
177 if (xhci->quirks & XHCI_LPM_SUPPORT)
178 hcd_to_bus(xhci->shared_hcd)->root_hub->lpm_capable = 1;
179
f6ff0ac8
SS
180 return 0;
181
182put_usb3_hcd:
183 usb_put_hcd(xhci->shared_hcd);
184dealloc_usb2_hcd:
185 usb_hcd_pci_remove(dev);
186 return retval;
187}
188
b02d0ed6
SS
189static void xhci_pci_remove(struct pci_dev *dev)
190{
191 struct xhci_hcd *xhci;
192
193 xhci = hcd_to_xhci(pci_get_drvdata(dev));
f6ff0ac8
SS
194 if (xhci->shared_hcd) {
195 usb_remove_hcd(xhci->shared_hcd);
196 usb_put_hcd(xhci->shared_hcd);
197 }
b02d0ed6
SS
198 usb_hcd_pci_remove(dev);
199 kfree(xhci);
66d4eadd
SS
200}
201
5535b1d5
AX
202#ifdef CONFIG_PM
203static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
204{
205 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
206 int retval = 0;
207
b3209379
SS
208 if (hcd->state != HC_STATE_SUSPENDED ||
209 xhci->shared_hcd->state != HC_STATE_SUSPENDED)
5535b1d5
AX
210 return -EINVAL;
211
212 retval = xhci_suspend(xhci);
213
214 return retval;
215}
216
217static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
218{
219 struct xhci_hcd *xhci = hcd_to_xhci(hcd);
69e848c2 220 struct pci_dev *pdev = to_pci_dev(hcd->self.controller);
5535b1d5
AX
221 int retval = 0;
222
69e848c2
SS
223 /* The BIOS on systems with the Intel Panther Point chipset may or may
224 * not support xHCI natively. That means that during system resume, it
225 * may switch the ports back to EHCI so that users can use their
226 * keyboard to select a kernel from GRUB after resume from hibernate.
227 *
228 * The BIOS is supposed to remember whether the OS had xHCI ports
229 * enabled before resume, and switch the ports back to xHCI when the
230 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
231 * writers.
232 *
233 * Unconditionally switch the ports back to xHCI after a system resume.
234 * We can't tell whether the EHCI or xHCI controller will be resumed
235 * first, so we have to do the port switchover in both drivers. Writing
236 * a '1' to the port switchover registers should have no effect if the
237 * port was already switched over.
238 */
239 if (usb_is_intel_switchable_xhci(pdev))
240 usb_enable_xhci_ports(pdev);
241
5535b1d5
AX
242 retval = xhci_resume(xhci, hibernated);
243 return retval;
244}
245#endif /* CONFIG_PM */
246
66d4eadd
SS
247static const struct hc_driver xhci_pci_hc_driver = {
248 .description = hcd_name,
249 .product_desc = "xHCI Host Controller",
b02d0ed6 250 .hcd_priv_size = sizeof(struct xhci_hcd *),
66d4eadd
SS
251
252 /*
253 * generic hardware linkage
254 */
7f84eef0 255 .irq = xhci_irq,
f6ff0ac8 256 .flags = HCD_MEMORY | HCD_USB3 | HCD_SHARED,
66d4eadd
SS
257
258 /*
259 * basic lifecycle operations
260 */
261 .reset = xhci_pci_setup,
262 .start = xhci_run,
5535b1d5
AX
263#ifdef CONFIG_PM
264 .pci_suspend = xhci_pci_suspend,
265 .pci_resume = xhci_pci_resume,
266#endif
66d4eadd
SS
267 .stop = xhci_stop,
268 .shutdown = xhci_shutdown,
269
3ffbba95
SS
270 /*
271 * managing i/o requests and associated device resources
272 */
d0e96f5a
SS
273 .urb_enqueue = xhci_urb_enqueue,
274 .urb_dequeue = xhci_urb_dequeue,
3ffbba95
SS
275 .alloc_dev = xhci_alloc_dev,
276 .free_dev = xhci_free_dev,
eab1cafc
SS
277 .alloc_streams = xhci_alloc_streams,
278 .free_streams = xhci_free_streams,
f94e0186
SS
279 .add_endpoint = xhci_add_endpoint,
280 .drop_endpoint = xhci_drop_endpoint,
a1587d97 281 .endpoint_reset = xhci_endpoint_reset,
f94e0186
SS
282 .check_bandwidth = xhci_check_bandwidth,
283 .reset_bandwidth = xhci_reset_bandwidth,
3ffbba95 284 .address_device = xhci_address_device,
b356b7c7 285 .update_hub_device = xhci_update_hub_device,
f0615c45 286 .reset_device = xhci_discover_or_reset_device,
3ffbba95 287
66d4eadd
SS
288 /*
289 * scheduling support
290 */
291 .get_frame_number = xhci_get_frame,
292
0f2a7930
SS
293 /* Root hub support */
294 .hub_control = xhci_hub_control,
295 .hub_status_data = xhci_hub_status_data,
9777e3ce
AX
296 .bus_suspend = xhci_bus_suspend,
297 .bus_resume = xhci_bus_resume,
9574323c
AX
298 /*
299 * call back when device connected and addressed
300 */
301 .update_device = xhci_update_device,
65580b43 302 .set_usb2_hw_lpm = xhci_set_usb2_hardware_lpm,
3b3db026
SS
303 .enable_usb3_lpm_timeout = xhci_enable_usb3_lpm_timeout,
304 .disable_usb3_lpm_timeout = xhci_disable_usb3_lpm_timeout,
66d4eadd
SS
305};
306
307/*-------------------------------------------------------------------------*/
308
309/* PCI driver selection metadata; PCI hotplugging uses this */
310static const struct pci_device_id pci_ids[] = { {
311 /* handle any USB 3.0 xHCI controller */
312 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
313 .driver_data = (unsigned long) &xhci_pci_hc_driver,
314 },
315 { /* end: all zeroes */ }
316};
317MODULE_DEVICE_TABLE(pci, pci_ids);
318
319/* pci driver glue; this is a "new style" PCI driver module */
320static struct pci_driver xhci_pci_driver = {
321 .name = (char *) hcd_name,
322 .id_table = pci_ids,
323
f6ff0ac8 324 .probe = xhci_pci_probe,
b02d0ed6 325 .remove = xhci_pci_remove,
66d4eadd
SS
326 /* suspend and resume implemented later */
327
328 .shutdown = usb_hcd_pci_shutdown,
5535b1d5
AX
329#ifdef CONFIG_PM_SLEEP
330 .driver = {
331 .pm = &usb_hcd_pci_pm_ops
332 },
333#endif
66d4eadd
SS
334};
335
0cc47d54 336int __init xhci_register_pci(void)
66d4eadd
SS
337{
338 return pci_register_driver(&xhci_pci_driver);
339}
340
a46c46a1 341void xhci_unregister_pci(void)
66d4eadd
SS
342{
343 pci_unregister_driver(&xhci_pci_driver);
344}