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