kernel/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 #include <linux/acpi.h>
  27
  28 #include "xhci.h"
  29 #include "xhci-trace.h"
  30
  31 #define SSIC_PORT_NUM           2
  32 #define SSIC_PORT_CFG2          0x880c
  33 #define SSIC_PORT_CFG2_OFFSET   0x30
  34 #define PROG_DONE               (1 << 30)
  35 #define SSIC_PORT_UNUSED        (1 << 31)
  36
  37 /* Device for a quirk */
  38 #define PCI_VENDOR_ID_FRESCO_LOGIC      0x1b73
  39 #define PCI_DEVICE_ID_FRESCO_LOGIC_PDK  0x1000
  40 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1009       0x1009
  41 #define PCI_DEVICE_ID_FRESCO_LOGIC_FL1400       0x1400
  42
  43 #define PCI_VENDOR_ID_ETRON             0x1b6f
  44 #define PCI_DEVICE_ID_EJ168             0x7023
  45
  46 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_XHCI      0x8c31
  47 #define PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI   0x9c31
  48 #define PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI        0x9cb1
  49 #define PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI             0x22b5
  50 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI         0xa12f
  51 #define PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI        0x9d2f
  52 #define PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI              0x0aa8
  53 #define PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI              0x1aa8
  54 #define PCI_DEVICE_ID_INTEL_APL_XHCI                    0x5aa8
  55
  56 static const char hcd_name[] = "xhci_hcd";
  57
  58 static struct hc_driver __read_mostly xhci_pci_hc_driver;
  59
  60 static int xhci_pci_setup(struct usb_hcd *hcd);
  61
  62 static const struct xhci_driver_overrides xhci_pci_overrides __initconst = {
  63         .extra_priv_size = sizeof(struct xhci_hcd),
  64         .reset = xhci_pci_setup,
  65 };
  66
  67 /* called after powerup, by probe or system-pm "wakeup" */
  68 static int xhci_pci_reinit(struct xhci_hcd *xhci, struct pci_dev *pdev)
  69 {
  70         /*
  71          * TODO: Implement finding debug ports later.
  72          * TODO: see if there are any quirks that need to be added to handle
  73          * new extended capabilities.
  74          */
  75
  76         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
  77         if (!pci_set_mwi(pdev))
  78                 xhci_dbg(xhci, "MWI active\n");
  79
  80         xhci_dbg(xhci, "Finished xhci_pci_reinit\n");
  81         return 0;
  82 }
  83
  84 static void xhci_pci_quirks(struct device *dev, struct xhci_hcd *xhci)
  85 {
  86         struct pci_dev          *pdev = to_pci_dev(dev);
  87
  88         /* Look for vendor-specific quirks */
  89         if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
  90                         (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK ||
  91                          pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1400)) {
  92                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
  93                                 pdev->revision == 0x0) {
  94                         xhci->quirks |= XHCI_RESET_EP_QUIRK;
  95                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
  96                                 "QUIRK: Fresco Logic xHC needs configure"
  97                                 " endpoint cmd after reset endpoint");
  98                 }
  99                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK &&
 100                                 pdev->revision == 0x4) {
 101                         xhci->quirks |= XHCI_SLOW_SUSPEND;
 102                         xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 103                                 "QUIRK: Fresco Logic xHC revision %u"
 104                                 "must be suspended extra slowly",
 105                                 pdev->revision);
 106                 }
 107                 if (pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_PDK)
 108                         xhci->quirks |= XHCI_BROKEN_STREAMS;
 109                 /* Fresco Logic confirms: all revisions of this chip do not
 110                  * support MSI, even though some of them claim to in their PCI
 111                  * capabilities.
 112                  */
 113                 xhci->quirks |= XHCI_BROKEN_MSI;
 114                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 115                                 "QUIRK: Fresco Logic revision %u "
 116                                 "has broken MSI implementation",
 117                                 pdev->revision);
 118                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
 119         }
 120
 121         if (pdev->vendor == PCI_VENDOR_ID_FRESCO_LOGIC &&
 122                         pdev->device == PCI_DEVICE_ID_FRESCO_LOGIC_FL1009)
 123                 xhci->quirks |= XHCI_BROKEN_STREAMS;
 124
 125         if (pdev->vendor == PCI_VENDOR_ID_NEC)
 126                 xhci->quirks |= XHCI_NEC_HOST;
 127
 128         if (pdev->vendor == PCI_VENDOR_ID_AMD && xhci->hci_version == 0x96)
 129                 xhci->quirks |= XHCI_AMD_0x96_HOST;
 130
 131         /* AMD PLL quirk */
 132         if (pdev->vendor == PCI_VENDOR_ID_AMD && usb_amd_find_chipset_info())
 133                 xhci->quirks |= XHCI_AMD_PLL_FIX;
 134
 135         if (pdev->vendor == PCI_VENDOR_ID_AMD)
 136                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
 137
 138         if (pdev->vendor == PCI_VENDOR_ID_INTEL) {
 139                 xhci->quirks |= XHCI_LPM_SUPPORT;
 140                 xhci->quirks |= XHCI_INTEL_HOST;
 141                 xhci->quirks |= XHCI_AVOID_BEI;
 142         }
 143         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
 144                         pdev->device == PCI_DEVICE_ID_INTEL_PANTHERPOINT_XHCI) {
 145                 xhci->quirks |= XHCI_EP_LIMIT_QUIRK;
 146                 xhci->limit_active_eps = 64;
 147                 xhci->quirks |= XHCI_SW_BW_CHECKING;
 148                 /*
 149                  * PPT desktop boards DH77EB and DH77DF will power back on after
 150                  * a few seconds of being shutdown.  The fix for this is to
 151                  * switch the ports from xHCI to EHCI on shutdown.  We can't use
 152                  * DMI information to find those particular boards (since each
 153                  * vendor will change the board name), so we have to key off all
 154                  * PPT chipsets.
 155                  */
 156                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
 157         }
 158         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
 159                 (pdev->device == PCI_DEVICE_ID_INTEL_LYNXPOINT_LP_XHCI ||
 160                  pdev->device == PCI_DEVICE_ID_INTEL_WILDCATPOINT_LP_XHCI)) {
 161                 xhci->quirks |= XHCI_SPURIOUS_REBOOT;
 162                 xhci->quirks |= XHCI_SPURIOUS_WAKEUP;
 163         }
 164         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
 165                 (pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_LP_XHCI ||
 166                  pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
 167                  pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
 168                  pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_M_XHCI ||
 169                  pdev->device == PCI_DEVICE_ID_INTEL_BROXTON_B_XHCI ||
 170                  pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI)) {
 171                 xhci->quirks |= XHCI_PME_STUCK_QUIRK;
 172         }
 173         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
 174             (pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI ||
 175              pdev->device == PCI_DEVICE_ID_INTEL_APL_XHCI))
 176                 xhci->quirks |= XHCI_MISSING_CAS;
 177
 178         if (pdev->vendor == PCI_VENDOR_ID_ETRON &&
 179                         pdev->device == PCI_DEVICE_ID_EJ168) {
 180                 xhci->quirks |= XHCI_RESET_ON_RESUME;
 181                 xhci->quirks |= XHCI_TRUST_TX_LENGTH;
 182                 xhci->quirks |= XHCI_BROKEN_STREAMS;
 183         }
 184         if (pdev->vendor == PCI_VENDOR_ID_RENESAS &&
 185                         pdev->device == 0x0015)
 186                 xhci->quirks |= XHCI_RESET_ON_RESUME;
 187         if (pdev->vendor == PCI_VENDOR_ID_VIA)
 188                 xhci->quirks |= XHCI_RESET_ON_RESUME;
 189
 190         /* See https://bugzilla.kernel.org/show_bug.cgi?id=79511 */
 191         if (pdev->vendor == PCI_VENDOR_ID_VIA &&
 192                         pdev->device == 0x3432)
 193                 xhci->quirks |= XHCI_BROKEN_STREAMS;
 194
 195         if (pdev->vendor == PCI_VENDOR_ID_ASMEDIA &&
 196                         pdev->device == 0x1042)
 197                 xhci->quirks |= XHCI_BROKEN_STREAMS;
 198
 199         if (xhci->quirks & XHCI_RESET_ON_RESUME)
 200                 xhci_dbg_trace(xhci, trace_xhci_dbg_quirks,
 201                                 "QUIRK: Resetting on resume");
 202 }
 203
 204 #ifdef CONFIG_ACPI
 205 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev)
 206 {
 207         static const u8 intel_dsm_uuid[] = {
 208                 0xb7, 0x0c, 0x34, 0xac, 0x01, 0xe9, 0xbf, 0x45,
 209                 0xb7, 0xe6, 0x2b, 0x34, 0xec, 0x93, 0x1e, 0x23,
 210         };
 211         union acpi_object *obj;
 212
 213         obj = acpi_evaluate_dsm(ACPI_HANDLE(&dev->dev), intel_dsm_uuid, 3, 1,
 214                                 NULL);
 215         ACPI_FREE(obj);
 216 }
 217 #else
 218 static void xhci_pme_acpi_rtd3_enable(struct pci_dev *dev) { }
 219 #endif /* CONFIG_ACPI */
 220
 221 /* called during probe() after chip reset completes */
 222 static int xhci_pci_setup(struct usb_hcd *hcd)
 223 {
 224         struct xhci_hcd         *xhci;
 225         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 226         int                     retval;
 227
 228         xhci = hcd_to_xhci(hcd);
 229         if (!xhci->sbrn)
 230                 pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
 231
 232         retval = xhci_gen_setup(hcd, xhci_pci_quirks);
 233         if (retval)
 234                 return retval;
 235
 236         if (!usb_hcd_is_primary_hcd(hcd))
 237                 return 0;
 238
 239         xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
 240
 241         /* Find any debug ports */
 242         retval = xhci_pci_reinit(xhci, pdev);
 243         if (!retval)
 244                 return retval;
 245
 246         return retval;
 247 }
 248
 249 /*
 250  * We need to register our own PCI probe function (instead of the USB core's
 251  * function) in order to create a second roothub under xHCI.
 252  */
 253 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
 254 {
 255         int retval;
 256         struct xhci_hcd *xhci;
 257         struct hc_driver *driver;
 258         struct usb_hcd *hcd;
 259
 260         driver = (struct hc_driver *)id->driver_data;
 261
 262         /* Prevent runtime suspending between USB-2 and USB-3 initialization */
 263         pm_runtime_get_noresume(&dev->dev);
 264
 265         /* Register the USB 2.0 roothub.
 266          * FIXME: USB core must know to register the USB 2.0 roothub first.
 267          * This is sort of silly, because we could just set the HCD driver flags
 268          * to say USB 2.0, but I'm not sure what the implications would be in
 269          * the other parts of the HCD code.
 270          */
 271         retval = usb_hcd_pci_probe(dev, id);
 272
 273         if (retval)
 274                 goto put_runtime_pm;
 275
 276         /* USB 2.0 roothub is stored in the PCI device now. */
 277         hcd = dev_get_drvdata(&dev->dev);
 278         xhci = hcd_to_xhci(hcd);
 279         xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
 280                                 pci_name(dev), hcd);
 281         if (!xhci->shared_hcd) {
 282                 retval = -ENOMEM;
 283                 goto dealloc_usb2_hcd;
 284         }
 285
 286         retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
 287                         IRQF_SHARED);
 288         if (retval)
 289                 goto put_usb3_hcd;
 290         /* Roothub already marked as USB 3.0 speed */
 291
 292         if (!(xhci->quirks & XHCI_BROKEN_STREAMS) &&
 293                         HCC_MAX_PSA(xhci->hcc_params) >= 4)
 294                 xhci->shared_hcd->can_do_streams = 1;
 295
 296         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
 297                 xhci_pme_acpi_rtd3_enable(dev);
 298
 299         /* USB-2 and USB-3 roothubs initialized, allow runtime pm suspend */
 300         pm_runtime_put_noidle(&dev->dev);
 301
 302         return 0;
 303
 304 put_usb3_hcd:
 305         usb_put_hcd(xhci->shared_hcd);
 306 dealloc_usb2_hcd:
 307         usb_hcd_pci_remove(dev);
 308 put_runtime_pm:
 309         pm_runtime_put_noidle(&dev->dev);
 310         return retval;
 311 }
 312
 313 static void xhci_pci_remove(struct pci_dev *dev)
 314 {
 315         struct xhci_hcd *xhci;
 316
 317         xhci = hcd_to_xhci(pci_get_drvdata(dev));
 318         xhci->xhc_state |= XHCI_STATE_REMOVING;
 319         if (xhci->shared_hcd) {
 320                 usb_remove_hcd(xhci->shared_hcd);
 321                 usb_put_hcd(xhci->shared_hcd);
 322         }
 323
 324         /* Workaround for spurious wakeups at shutdown with HSW */
 325         if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
 326                 pci_set_power_state(dev, PCI_D3hot);
 327
 328         usb_hcd_pci_remove(dev);
 329 }
 330
 331 #ifdef CONFIG_PM
 332 /*
 333  * In some Intel xHCI controllers, in order to get D3 working,
 334  * through a vendor specific SSIC CONFIG register at offset 0x883c,
 335  * SSIC PORT need to be marked as "unused" before putting xHCI
 336  * into D3. After D3 exit, the SSIC port need to be marked as "used".
 337  * Without this change, xHCI might not enter D3 state.
 338  * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
 339  * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
 340  */
 341 static void xhci_pme_quirk(struct usb_hcd *hcd, bool suspend)
 342 {
 343         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 344         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 345         u32 val;
 346         void __iomem *reg;
 347         int i;
 348
 349         if (pdev->vendor == PCI_VENDOR_ID_INTEL &&
 350                  pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI) {
 351
 352                 for (i = 0; i < SSIC_PORT_NUM; i++) {
 353                         reg = (void __iomem *) xhci->cap_regs +
 354                                         SSIC_PORT_CFG2 +
 355                                         i * SSIC_PORT_CFG2_OFFSET;
 356
 357                         /*
 358                          * Notify SSIC that SSIC profile programming
 359                          * is not done.
 360                          */
 361                         val = readl(reg) & ~PROG_DONE;
 362                         writel(val, reg);
 363
 364                         /* Mark SSIC port as unused(suspend) or used(resume) */
 365                         val = readl(reg);
 366                         if (suspend)
 367                                 val |= SSIC_PORT_UNUSED;
 368                         else
 369                                 val &= ~SSIC_PORT_UNUSED;
 370                         writel(val, reg);
 371
 372                         /* Notify SSIC that SSIC profile programming is done */
 373                         val = readl(reg) | PROG_DONE;
 374                         writel(val, reg);
 375                         readl(reg);
 376                 }
 377         }
 378
 379         reg = (void __iomem *) xhci->cap_regs + 0x80a4;
 380         val = readl(reg);
 381         writel(val | BIT(28), reg);
 382         readl(reg);
 383 }
 384
 385 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
 386 {
 387         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 388         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 389
 390         /*
 391          * Systems with the TI redriver that loses port status change events
 392          * need to have the registers polled during D3, so avoid D3cold.
 393          */
 394         if (xhci->quirks & XHCI_COMP_MODE_QUIRK)
 395                 pdev->no_d3cold = true;
 396
 397         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
 398                 xhci_pme_quirk(hcd, true);
 399
 400         return xhci_suspend(xhci, do_wakeup);
 401 }
 402
 403 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
 404 {
 405         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
 406         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 407         int                     retval = 0;
 408
 409         /* The BIOS on systems with the Intel Panther Point chipset may or may
 410          * not support xHCI natively.  That means that during system resume, it
 411          * may switch the ports back to EHCI so that users can use their
 412          * keyboard to select a kernel from GRUB after resume from hibernate.
 413          *
 414          * The BIOS is supposed to remember whether the OS had xHCI ports
 415          * enabled before resume, and switch the ports back to xHCI when the
 416          * BIOS/OS semaphore is written, but we all know we can't trust BIOS
 417          * writers.
 418          *
 419          * Unconditionally switch the ports back to xHCI after a system resume.
 420          * It should not matter whether the EHCI or xHCI controller is
 421          * resumed first. It's enough to do the switchover in xHCI because
 422          * USB core won't notice anything as the hub driver doesn't start
 423          * running again until after all the devices (including both EHCI and
 424          * xHCI host controllers) have been resumed.
 425          */
 426
 427         if (pdev->vendor == PCI_VENDOR_ID_INTEL)
 428                 usb_enable_intel_xhci_ports(pdev);
 429
 430         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
 431                 xhci_pme_quirk(hcd, false);
 432
 433         retval = xhci_resume(xhci, hibernated);
 434         return retval;
 435 }
 436 #endif /* CONFIG_PM */
 437
 438 /*-------------------------------------------------------------------------*/
 439
 440 /* PCI driver selection metadata; PCI hotplugging uses this */
 441 static const struct pci_device_id pci_ids[] = { {
 442         /* handle any USB 3.0 xHCI controller */
 443         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
 444         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
 445         },
 446         { /* end: all zeroes */ }
 447 };
 448 MODULE_DEVICE_TABLE(pci, pci_ids);
 449
 450 /* pci driver glue; this is a "new style" PCI driver module */
 451 static struct pci_driver xhci_pci_driver = {
 452         .name =         (char *) hcd_name,
 453         .id_table =     pci_ids,
 454
 455         .probe =        xhci_pci_probe,
 456         .remove =       xhci_pci_remove,
 457         /* suspend and resume implemented later */
 458
 459         .shutdown =     usb_hcd_pci_shutdown,
 460 #ifdef CONFIG_PM
 461         .driver = {
 462                 .pm = &usb_hcd_pci_pm_ops
 463         },
 464 #endif
 465 };
 466
 467 static int __init xhci_pci_init(void)
 468 {
 469         xhci_init_driver(&xhci_pci_hc_driver, &xhci_pci_overrides);
 470 #ifdef CONFIG_PM
 471         xhci_pci_hc_driver.pci_suspend = xhci_pci_suspend;
 472         xhci_pci_hc_driver.pci_resume = xhci_pci_resume;
 473 #endif
 474         return pci_register_driver(&xhci_pci_driver);
 475 }
 476 module_init(xhci_pci_init);
 477
 478 static void __exit xhci_pci_exit(void)
 479 {
 480         pci_unregister_driver(&xhci_pci_driver);
 481 }
 482 module_exit(xhci_pci_exit);
 483
 484 MODULE_DESCRIPTION("xHCI PCI Host Controller Driver");
 485 MODULE_LICENSE("GPL");