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>
27 /* Device for a quirk */
28 #define PCI_VENDOR_ID_FRESCO_LOGIC 0x1b73
29 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK 0x1000
31 static const char hcd_name
[] = "xhci_hcd";
33 /* called after powerup, by probe or system-pm "wakeup" */
34 static int xhci_pci_reinit(struct xhci_hcd
*xhci
, struct pci_dev
*pdev
)
37 * TODO: Implement finding debug ports later.
38 * TODO: see if there are any quirks that need to be added to handle
39 * new extended capabilities.
42 /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
43 if (!pci_set_mwi(pdev
))
44 xhci_dbg(xhci
, "MWI active\n");
46 xhci_dbg(xhci
, "Finished xhci_pci_reinit\n");
50 /* called during probe() after chip reset completes */
51 static int xhci_pci_setup(struct usb_hcd
*hcd
)
53 struct xhci_hcd
*xhci
;
54 struct pci_dev
*pdev
= to_pci_dev(hcd
->self
.controller
);
58 hcd
->self
.sg_tablesize
= TRBS_PER_SEGMENT
- 2;
60 if (usb_hcd_is_primary_hcd(hcd
)) {
61 xhci
= kzalloc(sizeof(struct xhci_hcd
), GFP_KERNEL
);
64 *((struct xhci_hcd
**) hcd
->hcd_priv
) = xhci
;
66 /* Mark the first roothub as being USB 2.0.
67 * The xHCI driver will register the USB 3.0 roothub.
69 hcd
->speed
= HCD_USB2
;
70 hcd
->self
.root_hub
->speed
= USB_SPEED_HIGH
;
72 * USB 2.0 roothub under xHCI has an integrated TT,
73 * (rate matching hub) as opposed to having an OHCI/UHCI
74 * companion controller.
78 /* xHCI private pointer was set in xhci_pci_probe for the second
81 xhci
= hcd_to_xhci(hcd
);
82 temp
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
83 if (HCC_64BIT_ADDR(temp
)) {
84 xhci_dbg(xhci
, "Enabling 64-bit DMA addresses.\n");
85 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64));
87 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(32));
92 xhci
->cap_regs
= hcd
->regs
;
93 xhci
->op_regs
= hcd
->regs
+
94 HC_LENGTH(xhci_readl(xhci
, &xhci
->cap_regs
->hc_capbase
));
95 xhci
->run_regs
= hcd
->regs
+
96 (xhci_readl(xhci
, &xhci
->cap_regs
->run_regs_off
) & RTSOFF_MASK
);
97 /* Cache read-only capability registers */
98 xhci
->hcs_params1
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params1
);
99 xhci
->hcs_params2
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params2
);
100 xhci
->hcs_params3
= xhci_readl(xhci
, &xhci
->cap_regs
->hcs_params3
);
101 xhci
->hcc_params
= xhci_readl(xhci
, &xhci
->cap_regs
->hc_capbase
);
102 xhci
->hci_version
= HC_VERSION(xhci
->hcc_params
);
103 xhci
->hcc_params
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
104 xhci_print_registers(xhci
);
106 /* Look for vendor-specific quirks */
107 if (pdev
->vendor
== PCI_VENDOR_ID_FRESCO_LOGIC
&&
108 pdev
->device
== PCI_DEVICE_ID_FRESCO_LOGIC_PDK
&&
109 pdev
->revision
== 0x0) {
110 xhci
->quirks
|= XHCI_RESET_EP_QUIRK
;
111 xhci_dbg(xhci
, "QUIRK: Fresco Logic xHC needs configure"
112 " endpoint cmd after reset endpoint\n");
114 if (pdev
->vendor
== PCI_VENDOR_ID_NEC
)
115 xhci
->quirks
|= XHCI_NEC_HOST
;
117 /* Make sure the HC is halted. */
118 retval
= xhci_halt(xhci
);
122 xhci_dbg(xhci
, "Resetting HCD\n");
123 /* Reset the internal HC memory state and registers. */
124 retval
= xhci_reset(xhci
);
127 xhci_dbg(xhci
, "Reset complete\n");
129 temp
= xhci_readl(xhci
, &xhci
->cap_regs
->hcc_params
);
130 if (HCC_64BIT_ADDR(temp
)) {
131 xhci_dbg(xhci
, "Enabling 64-bit DMA addresses.\n");
132 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(64));
134 dma_set_mask(hcd
->self
.controller
, DMA_BIT_MASK(32));
137 xhci_dbg(xhci
, "Calling HCD init\n");
138 /* Initialize HCD and host controller data structures. */
139 retval
= xhci_init(hcd
);
142 xhci_dbg(xhci
, "Called HCD init\n");
144 pci_read_config_byte(pdev
, XHCI_SBRN_OFFSET
, &xhci
->sbrn
);
145 xhci_dbg(xhci
, "Got SBRN %u\n", (unsigned int) xhci
->sbrn
);
147 /* Find any debug ports */
148 retval
= xhci_pci_reinit(xhci
, pdev
);
158 * We need to register our own PCI probe function (instead of the USB core's
159 * function) in order to create a second roothub under xHCI.
161 static int xhci_pci_probe(struct pci_dev
*dev
, const struct pci_device_id
*id
)
164 struct xhci_hcd
*xhci
;
165 struct hc_driver
*driver
;
168 driver
= (struct hc_driver
*)id
->driver_data
;
169 /* Register the USB 2.0 roothub.
170 * FIXME: USB core must know to register the USB 2.0 roothub first.
171 * This is sort of silly, because we could just set the HCD driver flags
172 * to say USB 2.0, but I'm not sure what the implications would be in
173 * the other parts of the HCD code.
175 retval
= usb_hcd_pci_probe(dev
, id
);
180 /* USB 2.0 roothub is stored in the PCI device now. */
181 hcd
= dev_get_drvdata(&dev
->dev
);
182 xhci
= hcd_to_xhci(hcd
);
183 xhci
->shared_hcd
= usb_create_shared_hcd(driver
, &dev
->dev
,
185 if (!xhci
->shared_hcd
) {
187 goto dealloc_usb2_hcd
;
190 /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
191 * is called by usb_add_hcd().
193 *((struct xhci_hcd
**) xhci
->shared_hcd
->hcd_priv
) = xhci
;
195 retval
= usb_add_hcd(xhci
->shared_hcd
, dev
->irq
,
196 IRQF_DISABLED
| IRQF_SHARED
);
199 /* Roothub already marked as USB 3.0 speed */
203 usb_put_hcd(xhci
->shared_hcd
);
205 usb_hcd_pci_remove(dev
);
209 static void xhci_pci_remove(struct pci_dev
*dev
)
211 struct xhci_hcd
*xhci
;
213 xhci
= hcd_to_xhci(pci_get_drvdata(dev
));
214 if (xhci
->shared_hcd
) {
215 usb_remove_hcd(xhci
->shared_hcd
);
216 usb_put_hcd(xhci
->shared_hcd
);
218 usb_hcd_pci_remove(dev
);
223 static int xhci_pci_suspend(struct usb_hcd
*hcd
, bool do_wakeup
)
225 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
228 if (hcd
->state
!= HC_STATE_SUSPENDED
||
229 xhci
->shared_hcd
->state
!= HC_STATE_SUSPENDED
)
232 retval
= xhci_suspend(xhci
);
237 static int xhci_pci_resume(struct usb_hcd
*hcd
, bool hibernated
)
239 struct xhci_hcd
*xhci
= hcd_to_xhci(hcd
);
242 retval
= xhci_resume(xhci
, hibernated
);
245 #endif /* CONFIG_PM */
247 static const struct hc_driver xhci_pci_hc_driver
= {
248 .description
= hcd_name
,
249 .product_desc
= "xHCI Host Controller",
250 .hcd_priv_size
= sizeof(struct xhci_hcd
*),
253 * generic hardware linkage
256 .flags
= HCD_MEMORY
| HCD_USB3
| HCD_SHARED
,
259 * basic lifecycle operations
261 .reset
= xhci_pci_setup
,
264 .pci_suspend
= xhci_pci_suspend
,
265 .pci_resume
= xhci_pci_resume
,
268 .shutdown
= xhci_shutdown
,
271 * managing i/o requests and associated device resources
273 .urb_enqueue
= xhci_urb_enqueue
,
274 .urb_dequeue
= xhci_urb_dequeue
,
275 .alloc_dev
= xhci_alloc_dev
,
276 .free_dev
= xhci_free_dev
,
277 .alloc_streams
= xhci_alloc_streams
,
278 .free_streams
= xhci_free_streams
,
279 .add_endpoint
= xhci_add_endpoint
,
280 .drop_endpoint
= xhci_drop_endpoint
,
281 .endpoint_reset
= xhci_endpoint_reset
,
282 .check_bandwidth
= xhci_check_bandwidth
,
283 .reset_bandwidth
= xhci_reset_bandwidth
,
284 .address_device
= xhci_address_device
,
285 .update_hub_device
= xhci_update_hub_device
,
286 .reset_device
= xhci_discover_or_reset_device
,
291 .get_frame_number
= xhci_get_frame
,
293 /* Root hub support */
294 .hub_control
= xhci_hub_control
,
295 .hub_status_data
= xhci_hub_status_data
,
296 .bus_suspend
= xhci_bus_suspend
,
297 .bus_resume
= xhci_bus_resume
,
300 /*-------------------------------------------------------------------------*/
302 /* PCI driver selection metadata; PCI hotplugging uses this */
303 static const struct pci_device_id pci_ids
[] = { {
304 /* handle any USB 3.0 xHCI controller */
305 PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI
, ~0),
306 .driver_data
= (unsigned long) &xhci_pci_hc_driver
,
308 { /* end: all zeroes */ }
310 MODULE_DEVICE_TABLE(pci
, pci_ids
);
312 /* pci driver glue; this is a "new style" PCI driver module */
313 static struct pci_driver xhci_pci_driver
= {
314 .name
= (char *) hcd_name
,
317 .probe
= xhci_pci_probe
,
318 .remove
= xhci_pci_remove
,
319 /* suspend and resume implemented later */
321 .shutdown
= usb_hcd_pci_shutdown
,
322 #ifdef CONFIG_PM_SLEEP
324 .pm
= &usb_hcd_pci_pm_ops
329 int xhci_register_pci(void)
331 return pci_register_driver(&xhci_pci_driver
);
334 void xhci_unregister_pci(void)
336 pci_unregister_driver(&xhci_pci_driver
);