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