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