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