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