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_SUNRISEPOINT_LP_XHCI ||
 127                  pdev->device == PCI_DEVICE_ID_INTEL_SUNRISEPOINT_H_XHCI ||
 128                  pdev->device == PCI_DEVICE_ID_INTEL_CHERRYVIEW_XHCI)) {
 129                 xhci->quirks |= XHCI_PME_STUCK_QUIRK;
 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 /*
 142  * Make sure PME works on some Intel xHCI controllers by writing 1 to clear
 143  * the Internal PME flag bit in vendor specific PMCTRL register at offset 0x80a4
 144  */
 145 static void xhci_pme_quirk(struct xhci_hcd *xhci)
 146 {
 147         u32 val;
 148         void __iomem *reg;
 149
 150         reg = (void __iomem *) xhci->cap_regs + 0x80a4;
 151         val = readl(reg);
 152         writel(val | BIT(28), reg);
 153         readl(reg);
 154 }
 155
 156 /* called during probe() after chip reset completes */
 157 static int xhci_pci_setup(struct usb_hcd *hcd)
 158 {
 159         struct xhci_hcd         *xhci;
 160         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 161         int                     retval;
 162
 163         retval = xhci_gen_setup(hcd, xhci_pci_quirks);
 164         if (retval)
 165                 return retval;
 166
 167         xhci = hcd_to_xhci(hcd);
 168         if (!usb_hcd_is_primary_hcd(hcd))
 169                 return 0;
 170
 171         pci_read_config_byte(pdev, XHCI_SBRN_OFFSET, &xhci->sbrn);
 172         xhci_dbg(xhci, "Got SBRN %u\n", (unsigned int) xhci->sbrn);
 173
 174         /* Find any debug ports */
 175         retval = xhci_pci_reinit(xhci, pdev);
 176         if (!retval)
 177                 return retval;
 178
 179         kfree(xhci);
 180         return retval;
 181 }
 182
 183 /*
 184  * We need to register our own PCI probe function (instead of the USB core's
 185  * function) in order to create a second roothub under xHCI.
 186  */
 187 static int xhci_pci_probe(struct pci_dev *dev, const struct pci_device_id *id)
 188 {
 189         int retval;
 190         struct xhci_hcd *xhci;
 191         struct hc_driver *driver;
 192         struct usb_hcd *hcd;
 193
 194         driver = (struct hc_driver *)id->driver_data;
 195         /* Register the USB 2.0 roothub.
 196          * FIXME: USB core must know to register the USB 2.0 roothub first.
 197          * This is sort of silly, because we could just set the HCD driver flags
 198          * to say USB 2.0, but I'm not sure what the implications would be in
 199          * the other parts of the HCD code.
 200          */
 201         retval = usb_hcd_pci_probe(dev, id);
 202
 203         if (retval)
 204                 return retval;
 205
 206         /* USB 2.0 roothub is stored in the PCI device now. */
 207         hcd = dev_get_drvdata(&dev->dev);
 208         xhci = hcd_to_xhci(hcd);
 209         xhci->shared_hcd = usb_create_shared_hcd(driver, &dev->dev,
 210                                 pci_name(dev), hcd);
 211         if (!xhci->shared_hcd) {
 212                 retval = -ENOMEM;
 213                 goto dealloc_usb2_hcd;
 214         }
 215
 216         /* Set the xHCI pointer before xhci_pci_setup() (aka hcd_driver.reset)
 217          * is called by usb_add_hcd().
 218          */
 219         *((struct xhci_hcd **) xhci->shared_hcd->hcd_priv) = xhci;
 220
 221         retval = usb_add_hcd(xhci->shared_hcd, dev->irq,
 222                         IRQF_SHARED);
 223         if (retval)
 224                 goto put_usb3_hcd;
 225         /* Roothub already marked as USB 3.0 speed */
 226         return 0;
 227
 228 put_usb3_hcd:
 229         usb_put_hcd(xhci->shared_hcd);
 230 dealloc_usb2_hcd:
 231         usb_hcd_pci_remove(dev);
 232         return retval;
 233 }
 234
 235 static void xhci_pci_remove(struct pci_dev *dev)
 236 {
 237         struct xhci_hcd *xhci;
 238
 239         xhci = hcd_to_xhci(pci_get_drvdata(dev));
 240         if (xhci->shared_hcd) {
 241                 usb_remove_hcd(xhci->shared_hcd);
 242                 usb_put_hcd(xhci->shared_hcd);
 243         }
 244         usb_hcd_pci_remove(dev);
 245
 246         /* Workaround for spurious wakeups at shutdown with HSW */
 247         if (xhci->quirks & XHCI_SPURIOUS_WAKEUP)
 248                 pci_set_power_state(dev, PCI_D3hot);
 249
 250         kfree(xhci);
 251 }
 252
 253 #ifdef CONFIG_PM
 254 static int xhci_pci_suspend(struct usb_hcd *hcd, bool do_wakeup)
 255 {
 256         struct xhci_hcd *xhci = hcd_to_xhci(hcd);
 257         int     retval = 0;
 258
 259         if (hcd->state != HC_STATE_SUSPENDED ||
 260                         xhci->shared_hcd->state != HC_STATE_SUSPENDED)
 261                 return -EINVAL;
 262
 263         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
 264                 xhci_pme_quirk(xhci);
 265
 266         retval = xhci_suspend(xhci, do_wakeup);
 267
 268         return retval;
 269 }
 270
 271 static int xhci_pci_resume(struct usb_hcd *hcd, bool hibernated)
 272 {
 273         struct xhci_hcd         *xhci = hcd_to_xhci(hcd);
 274         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 275         int                     retval = 0;
 276
 277         /* The BIOS on systems with the Intel Panther Point chipset may or may
 278          * not support xHCI natively.  That means that during system resume, it
 279          * may switch the ports back to EHCI so that users can use their
 280          * keyboard to select a kernel from GRUB after resume from hibernate.
 281          *
 282          * The BIOS is supposed to remember whether the OS had xHCI ports
 283          * enabled before resume, and switch the ports back to xHCI when the
 284          * BIOS/OS semaphore is written, but we all know we can't trust BIOS
 285          * writers.
 286          *
 287          * Unconditionally switch the ports back to xHCI after a system resume.
 288          * We can't tell whether the EHCI or xHCI controller will be resumed
 289          * first, so we have to do the port switchover in both drivers.  Writing
 290          * a '1' to the port switchover registers should have no effect if the
 291          * port was already switched over.
 292          */
 293         if (usb_is_intel_switchable_xhci(pdev))
 294                 usb_enable_xhci_ports(pdev);
 295
 296         if (xhci->quirks & XHCI_PME_STUCK_QUIRK)
 297                 xhci_pme_quirk(xhci);
 298
 299         retval = xhci_resume(xhci, hibernated);
 300         return retval;
 301 }
 302 #endif /* CONFIG_PM */
 303
 304 static const struct hc_driver xhci_pci_hc_driver = {
 305         .description =          hcd_name,
 306         .product_desc =         "xHCI Host Controller",
 307         .hcd_priv_size =        sizeof(struct xhci_hcd *),
 308
 309         /*
 310          * generic hardware linkage
 311          */
 312         .irq =                  xhci_irq,
 313         .flags =                HCD_MEMORY | HCD_USB3 | HCD_SHARED,
 314
 315         /*
 316          * basic lifecycle operations
 317          */
 318         .reset =                xhci_pci_setup,
 319         .start =                xhci_run,
 320 #ifdef CONFIG_PM
 321         .pci_suspend =          xhci_pci_suspend,
 322         .pci_resume =           xhci_pci_resume,
 323 #endif
 324         .stop =                 xhci_stop,
 325         .shutdown =             xhci_shutdown,
 326
 327         /*
 328          * managing i/o requests and associated device resources
 329          */
 330         .urb_enqueue =          xhci_urb_enqueue,
 331         .urb_dequeue =          xhci_urb_dequeue,
 332         .alloc_dev =            xhci_alloc_dev,
 333         .free_dev =             xhci_free_dev,
 334         .alloc_streams =        xhci_alloc_streams,
 335         .free_streams =         xhci_free_streams,
 336         .add_endpoint =         xhci_add_endpoint,
 337         .drop_endpoint =        xhci_drop_endpoint,
 338         .endpoint_reset =       xhci_endpoint_reset,
 339         .check_bandwidth =      xhci_check_bandwidth,
 340         .reset_bandwidth =      xhci_reset_bandwidth,
 341         .address_device =       xhci_address_device,
 342         .update_hub_device =    xhci_update_hub_device,
 343         .reset_device =         xhci_discover_or_reset_device,
 344
 345         /*
 346          * scheduling support
 347          */
 348         .get_frame_number =     xhci_get_frame,
 349
 350         /* Root hub support */
 351         .hub_control =          xhci_hub_control,
 352         .hub_status_data =      xhci_hub_status_data,
 353         .bus_suspend =          xhci_bus_suspend,
 354         .bus_resume =           xhci_bus_resume,
 355         /*
 356          * call back when device connected and addressed
 357          */
 358         .update_device =        xhci_update_device,
 359         .set_usb2_hw_lpm =      xhci_set_usb2_hardware_lpm,
 360 };
 361
 362 /*-------------------------------------------------------------------------*/
 363
 364 /* PCI driver selection metadata; PCI hotplugging uses this */
 365 static const struct pci_device_id pci_ids[] = { {
 366         /* handle any USB 3.0 xHCI controller */
 367         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_XHCI, ~0),
 368         .driver_data =  (unsigned long) &xhci_pci_hc_driver,
 369         },
 370         { /* end: all zeroes */ }
 371 };
 372 MODULE_DEVICE_TABLE(pci, pci_ids);
 373
 374 /* pci driver glue; this is a "new style" PCI driver module */
 375 static struct pci_driver xhci_pci_driver = {
 376         .name =         (char *) hcd_name,
 377         .id_table =     pci_ids,
 378
 379         .probe =        xhci_pci_probe,
 380         .remove =       xhci_pci_remove,
 381         /* suspend and resume implemented later */
 382
 383         .shutdown =     usb_hcd_pci_shutdown,
 384 #ifdef CONFIG_PM
 385         .driver = {
 386                 .pm = &usb_hcd_pci_pm_ops
 387         },
 388 #endif
 389 };
 390
 391 int __init xhci_register_pci(void)
 392 {
 393         return pci_register_driver(&xhci_pci_driver);
 394 }
 395
 396 void __exit xhci_unregister_pci(void)
 397 {
 398         pci_unregister_driver(&xhci_pci_driver);
 399 }