USB: xhci: Add quirk for Fresco Logic xHCI hardware.
[linux-flexiantxendom0.git] / drivers / usb / host / xhci-pci.c
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
25 #include "xhci.h"
26
27 /* Device for a quirk */
28 #define PCI_VENDOR_ID_FRESCO_LOGIC      0x1b73
29 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK  0x1000
30
31 static const char hcd_name[] = "xhci_hcd";
32
33 /* called after powerup, by probe or system-pm "wakeup" */
34 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
35 {
36         /*
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.
40          */
41
42         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
43         if (!pci_set_mwi(pdev))
44                 xhci_dbg(xhci, "MWI active\n");
45
46         xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
47         return 0;
48 }
49
50 /* called during probe() after chip reset completes */
51 static int xhci_pci_setup(struct usb_hcd *hcd)
52 {
53         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
54         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
55         int                     retval;
56
57         xhci->cap_regs = hcd->regs;
58         xhci->op_regs = hcd->regs +
59                 HC_LENGTH(xhci_readl(xhci, &xhci->cap_regs->hc_capbase));
60         xhci->run_regs = hcd->regs +
61                 (xhci_readl(xhci, &xhci->cap_regs->run_regs_off) & RTSOFF_MASK);
62         /* Cache read-only capability registers */
63         xhci->hcs_params1 = xhci_readl(xhci, &xhci->cap_regs->hcs_params1);
64         xhci->hcs_params2 = xhci_readl(xhci, &xhci->cap_regs->hcs_params2);
65         xhci->hcs_params3 = xhci_readl(xhci, &xhci->cap_regs->hcs_params3);
66         xhci->hcc_params = xhci_readl(xhci, &xhci->cap_regs->hcc_params);
67         xhci_print_registers(xhci);
68
69         /* Look for vendor-specific quirks */
70         if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
71                         pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
72                         pdev->revision == 0x0) {
73                         xhci->quirks |= XHCI_RESET_EP_QUIRK;
74                         xhci_dbg(xhci, "QUIRK: Fresco Logic xHC needs configure"
75                                         " endpoint cmd after reset endpoint\n");
76         }
77
78         /* Make sure the HC is halted. */
79         retval = xhci_halt(xhci);
80         if (retval)
81                 return retval;
82
83         xhci_dbg(xhci, "Resetting HCD\n");
84         /* Reset the internal HC memory state and registers. */
85         retval = xhci_reset(xhci);
86         if (retval)
87                 return retval;
88         xhci_dbg(xhci, "Reset complete\n");
89
90         xhci_dbg(xhci, "Calling HCD init\n");
91         /* Initialize HCD and host controller data structures. */
92         retval = xhci_init(hcd);
93         if (retval)
94                 return retval;
95         xhci_dbg(xhci, "Called HCD init\n");
96
97         pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
98         xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
99
100         /* Find any debug ports */
101         return xhci_pci_reinit(xhci, pdev);
102 }
103
104 static const struct hc_driver xhci_pci_hc_driver = {
105         .description =          hcd_name,
106         .product_desc =         "xHCI Host Controller",
107         .hcd_priv_size =        sizeof(struct xhci_hcd),
108
109         /*
110          * generic hardware linkage
111          */
112         .irq =                  xhci_irq,
113         .flags =                HCD_MEMORY | HCD_USB3,
114
115         /*
116          * basic lifecycle operations
117          */
118         .reset =                xhci_pci_setup,
119         .start =                xhci_run,
120         /* suspend and resume implemented later */
121         .stop =                 xhci_stop,
122         .shutdown =             xhci_shutdown,
123
124         /*
125          * managing i/o requests and associated device resources
126          */
127         .urb_enqueue =          xhci_urb_enqueue,
128         .urb_dequeue =          xhci_urb_dequeue,
129         .alloc_dev =            xhci_alloc_dev,
130         .free_dev =             xhci_free_dev,
131         .add_endpoint =         xhci_add_endpoint,
132         .drop_endpoint =        xhci_drop_endpoint,
133         .endpoint_reset =       xhci_endpoint_reset,
134         .check_bandwidth =      xhci_check_bandwidth,
135         .reset_bandwidth =      xhci_reset_bandwidth,
136         .address_device =       xhci_address_device,
137
138         /*
139          * scheduling support
140          */
141         .get_frame_number =     xhci_get_frame,
142
143         /* Root hub support */
144         .hub_control =          xhci_hub_control,
145         .hub_status_data =      xhci_hub_status_data,
146 };
147
148 /*-------------------------------------------------------------------------*/
149
150 /* PCI driver selection metadata; PCI hotplugging uses this */
151 static const struct pci_device_id pci_ids[] = { {
152         /* handle any USB 3.0 xHCI controller */
153         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
154         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
155         },
156         { /* end: all zeroes */ }
157 };
158 MODULE_DEVICE_TABLE(pci, pci_ids);
159
160 /* pci driver glue; this is a "new style" PCI driver module */
161 static struct pci_driver xhci_pci_driver = {
162         .name =         (char *) hcd_name,
163         .id_table =     pci_ids,
164
165         .probe =        usb_hcd_pci_probe,
166         .remove =       usb_hcd_pci_remove,
167         /* suspend and resume implemented later */
168
169         .shutdown =     usb_hcd_pci_shutdown,
170 };
171
172 int xhci_register_pci()
173 {
174         return pci_register_driver(&xhci_pci_driver);
175 }
176
177 void xhci_unregister_pci()
178 {
179         pci_unregister_driver(&xhci_pci_driver);
180 }