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