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