2 * xHCI host controller driver PCI Bus Glue.
4 * Copyright (C) 2008 Intel Corp.
7 * Some code borrowed from the Linux EHCI driver.
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.
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
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.
23 #include <linux/pci.h>
24 #include <linux/slab.h>
25 #include <linux/module.h>
29 /* Device for a quirk */
30 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
31 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
33 #define PCI_VENDOR_ID_ETRON 0x1b6f
34 #define PCI_DEVICE_ID_ASROCK_P67 0x7023
36 static const char hcd_name
[] = "xhci_hcd";
38 /* called after powerup, by probe or system-pm "wakeup" */
39 static int xhci_pci_reinit(struct xhci_hcd
*xhci
, struct pci_dev
*pdev
)
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.
47 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
48 if (!pci_set_mwi(pdev
))
49 xhci_dbg(xhci
, "MWI active\n");
51 xhci_dbg(xhci
, "Finished xhci_pci_reinit\n");
55 static void xhci_pci_quirks(struct device
*dev
, struct xhci_hcd
*xhci
)
57 struct pci_dev
*pdev
= to_pci_dev(dev
);
59 /* Look for vendor-specific quirks */
60 if (pdev
->vendor
== PCI_VENDOR_ID_FRESCO_LOGIC
&&
61 pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
) {
62 if (pdev
->revision
== 0x0) {
63 xhci
->quirks
|= XHCI_RESET_EP_QUIRK
;
64 xhci_dbg(xhci
, "QUIRK: Fresco Logic xHC needs configure"
65 " endpoint cmd after reset endpoint\n");
67 /* Fresco Logic confirms: all revisions of this chip do not
68 * support MSI, even though some of them claim to in their PCI
71 xhci
->quirks
|= XHCI_BROKEN_MSI
;
72 xhci_dbg(xhci
, "QUIRK: Fresco Logic revision %u "
73 "has broken MSI implementation\n",
75 xhci
->quirks
|= XHCI_TRUST_TX_LENGTH
;
78 if (pdev
->vendor
== PCI_VENDOR_ID_NEC
)
79 xhci
->quirks
|= XHCI_NEC_HOST
;
81 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&& xhci
->hci_version
== 0x96)
82 xhci
->quirks
|= XHCI_AMD_0x96_HOST
;
85 if (pdev
->vendor
== PCI_VENDOR_ID_AMD
&& usb_amd_find_chipset_info())
86 xhci
->quirks
|= XHCI_AMD_PLL_FIX
;
87 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
) {
88 xhci
->quirks
|= XHCI_LPM_SUPPORT
;
89 xhci
->quirks
|= XHCI_INTEL_HOST
;
91 if (pdev
->vendor
== PCI_VENDOR_ID_INTEL
&&
92 pdev
->device
== PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI
) {
93 xhci
->quirks
|= XHCI_SPURIOUS_SUCCESS
;
94 xhci
->quirks
|= XHCI_EP_LIMIT_QUIRK
;
95 xhci
->limit_active_eps
= 64;
96 xhci
->quirks
|= XHCI_SW_BW_CHECKING
;
98 if (pdev
->vendor
== PCI_VENDOR_ID_ETRON
&&
99 pdev
->device
== PCI_DEVICE_ID_ASROCK_P67
) {
100 xhci
->quirks
|= XHCI_RESET_ON_RESUME
;
101 xhci_dbg(xhci
, "QUIRK: Resetting on resume\n");
103 if (pdev
->vendor
== PCI_VENDOR_ID_VIA
)
104 xhci
->quirks
|= XHCI_RESET_ON_RESUME
;
107 /* called during probe() after chip reset completes */
108 static int xhci_pci_setup(struct usb_hcd
*hcd
)
110 struct xhci_hcd
*xhci
;
111 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
114 retval
= xhci_gen_setup(hcd
, xhci_pci_quirks
);
118 xhci
= hcd_to_xhci(hcd
);
119 if (!usb_hcd_is_primary_hcd(hcd
))
122 pci_read_config_byte(pdev
, XHCI_SBRN_OFFSET
, &xhci
->sbrn
);
123 xhci_dbg(xhci
, "Got SBRN %u\n", (unsigned int) xhci
->sbrn
);
125 /* Find any debug ports */
126 retval
= xhci_pci_reinit(xhci
, pdev
);
135 * We need to register our own PCI probe function (instead of the USB core's
136 * function) in order to create a second roothub under xHCI.
138 static int xhci_pci_probe(struct pci_dev
*dev
, const struct pci_device_id
*id
)
141 struct xhci_hcd
*xhci
;
142 struct hc_driver
*driver
;
145 driver
= (struct hc_driver
*)id
->driver_data
;
146 /* Register the USB 2.0 roothub.
147 * FIXME: USB core must know to register the USB 2.0 roothub first.
148 * This is sort of silly, because we could just set the HCD driver flags
149 * to say USB 2.0, but I'm not sure what the implications would be in
150 * the other parts of the HCD code.
152 retval
= usb_hcd_pci_probe(dev
, id
);
157 /* USB 2.0 roothub is stored in the PCI device now. */
158 hcd
= dev_get_drvdata(&dev
->dev
);
159 xhci
= hcd_to_xhci(hcd
);
160 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, &dev
->dev
,
162 if (!xhci
->shared_hcd
) {
164 goto dealloc_usb2_hcd
;
167 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
168 * is called by usb_add_hcd().
170 *((struct xhci_hcd
**) xhci
->shared_hcd
->hcd_priv
) = xhci
;
172 retval
= usb_add_hcd(xhci
->shared_hcd
, dev
->irq
,
176 /* Roothub already marked as USB 3.0 speed */
178 /* We know the LPM timeout algorithms for this host, let the USB core
179 * enable and disable LPM for devices under the USB 3.0 roothub.
181 if (xhci
->quirks
& XHCI_LPM_SUPPORT
)
182 hcd_to_bus(xhci
->shared_hcd
)->root_hub
->lpm_capable
= 1;
187 usb_put_hcd(xhci
->shared_hcd
);
189 usb_hcd_pci_remove(dev
);
193 static void xhci_pci_remove(struct pci_dev
*dev
)
195 struct xhci_hcd
*xhci
;
197 xhci
= hcd_to_xhci(pci_get_drvdata(dev
));
198 if (xhci
->shared_hcd
) {
199 usb_remove_hcd(xhci
->shared_hcd
);
200 usb_put_hcd(xhci
->shared_hcd
);
202 usb_hcd_pci_remove(dev
);
207 static int xhci_pci_suspend(struct usb_hcd
*hcd
, bool do_wakeup
)
209 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
212 if (hcd
->state
!= HC_STATE_SUSPENDED
||
213 xhci
->shared_hcd
->state
!= HC_STATE_SUSPENDED
)
216 retval
= xhci_suspend(xhci
);
221 static int xhci_pci_resume(struct usb_hcd
*hcd
, bool hibernated
)
223 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
224 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
227 /* The BIOS on systems with the Intel Panther Point chipset may or may
228 * not support xHCI natively. That means that during system resume, it
229 * may switch the ports back to EHCI so that users can use their
230 * keyboard to select a kernel from GRUB after resume from hibernate.
232 * The BIOS is supposed to remember whether the OS had xHCI ports
233 * enabled before resume, and switch the ports back to xHCI when the
234 * BIOS/OS semaphore is written, but we all know we can't trust BIOS
237 * Unconditionally switch the ports back to xHCI after a system resume.
238 * We can't tell whether the EHCI or xHCI controller will be resumed
239 * first, so we have to do the port switchover in both drivers. Writing
240 * a '1' to the port switchover registers should have no effect if the
241 * port was already switched over.
243 if (usb_is_intel_switchable_xhci(pdev
))
244 usb_enable_xhci_ports(pdev
);
246 retval
= xhci_resume(xhci
, hibernated
);
249 #endif /* CONFIG_PM */
251 static const struct hc_driver xhci_pci_hc_driver
= {
252 .description
= hcd_name
,
253 .product_desc
= "xHCI Host Controller",
254 .hcd_priv_size
= sizeof(struct xhci_hcd
*),
257 * generic hardware linkage
260 .flags
= HCD_MEMORY
| HCD_USB3
| HCD_SHARED
,
263 * basic lifecycle operations
265 .reset
= xhci_pci_setup
,
268 .pci_suspend
= xhci_pci_suspend
,
269 .pci_resume
= xhci_pci_resume
,
272 .shutdown
= xhci_shutdown
,
275 * managing i/o requests and associated device resources
277 .urb_enqueue
= xhci_urb_enqueue
,
278 .urb_dequeue
= xhci_urb_dequeue
,
279 .alloc_dev
= xhci_alloc_dev
,
280 .free_dev
= xhci_free_dev
,
281 .alloc_streams
= xhci_alloc_streams
,
282 .free_streams
= xhci_free_streams
,
283 .add_endpoint
= xhci_add_endpoint
,
284 .drop_endpoint
= xhci_drop_endpoint
,
285 .endpoint_reset
= xhci_endpoint_reset
,
286 .check_bandwidth
= xhci_check_bandwidth
,
287 .reset_bandwidth
= xhci_reset_bandwidth
,
288 .address_device
= xhci_address_device
,
289 .update_hub_device
= xhci_update_hub_device
,
290 .reset_device
= xhci_discover_or_reset_device
,
295 .get_frame_number
= xhci_get_frame
,
297 /* Root hub support */
298 .hub_control
= xhci_hub_control
,
299 .hub_status_data
= xhci_hub_status_data
,
300 .bus_suspend
= xhci_bus_suspend
,
301 .bus_resume
= xhci_bus_resume
,
303 * call back when device connected and addressed
305 .update_device
= xhci_update_device
,
306 .set_usb2_hw_lpm
= xhci_set_usb2_hardware_lpm
,
307 .enable_usb3_lpm_timeout
= xhci_enable_usb3_lpm_timeout
,
308 .disable_usb3_lpm_timeout
= xhci_disable_usb3_lpm_timeout
,
311 /*-------------------------------------------------------------------------*/
313 /* PCI driver selection metadata; PCI hotplugging uses this */
314 static const struct pci_device_id pci_ids
[] = { {
315 /* handle any USB 3.0 xHCI controller */
316 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI
, ~0),
317 .driver_data
= (unsigned long) &xhci_pci_hc_driver
,
319 { /* end: all zeroes */ }
321 MODULE_DEVICE_TABLE(pci
, pci_ids
);
323 /* pci driver glue; this is a "new style" PCI driver module */
324 static struct pci_driver xhci_pci_driver
= {
325 .name
= (char *) hcd_name
,
328 .probe
= xhci_pci_probe
,
329 .remove
= xhci_pci_remove
,
330 /* suspend and resume implemented later */
332 .shutdown
= usb_hcd_pci_shutdown
,
333 #ifdef CONFIG_PM_SLEEP
335 .pm
= &usb_hcd_pci_pm_ops
340 int __init
xhci_register_pci(void)
342 return pci_register_driver(&xhci_pci_driver
);
345 void xhci_unregister_pci(void)
347 pci_unregister_driver(&xhci_pci_driver
);