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