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