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