drivers/usb/host/ehci-pci.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * EHCI HCD (Host Controller Driver) PCI Bus Glue.
   4  *
   5  * Copyright (c) 2000-2004 by David Brownell
   6  */
   7
   8 #include <linux/kernel.h>
   9 #include <linux/module.h>
  10 #include <linux/pci.h>
  11 #include <linux/usb.h>
  12 #include <linux/usb/hcd.h>
  13
  14 #include "ehci.h"
  15 #include "pci-quirks.h"
  16
  17 #define DRIVER_DESC "EHCI PCI platform driver"
  18
  19 static const char hcd_name[] = "ehci-pci";
  20
  21 /* defined here to avoid adding to pci_ids.h for single instance use */
  22 #define PCI_DEVICE_ID_INTEL_CE4100_USB  0x2e70
  23
  24 #define PCI_VENDOR_ID_ASPEED            0x1a03
  25 #define PCI_DEVICE_ID_ASPEED_EHCI       0x2603
  26
  27 /*-------------------------------------------------------------------------*/
  28 #define PCI_DEVICE_ID_INTEL_QUARK_X1000_SOC             0x0939
  29 static inline bool is_intel_quark_x1000(struct pci_dev *pdev)
  30 {
  31         return pdev->vendor == PCI_VENDOR_ID_INTEL &&
  32                 pdev->device == PCI_DEVICE_ID_INTEL_QUARK_X1000_SOC;
  33 }
  34
  35 /*
  36  * This is the list of PCI IDs for the devices that have EHCI USB class and
  37  * specific drivers for that. One of the example is a ChipIdea device installed
  38  * on some Intel MID platforms.
  39  */
  40 static const struct pci_device_id bypass_pci_id_table[] = {
  41         /* ChipIdea on Intel MID platform */
  42         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x0811), },
  43         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x0829), },
  44         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0xe006), },
  45         {}
  46 };
  47
  48 static inline bool is_bypassed_id(struct pci_dev *pdev)
  49 {
  50         return !!pci_match_id(bypass_pci_id_table, pdev);
  51 }
  52
  53 /*
  54  * 0x84 is the offset of in/out threshold register,
  55  * and it is the same offset as the register of 'hostpc'.
  56  */
  57 #define intel_quark_x1000_insnreg01     hostpc
  58
  59 /* Maximum usable threshold value is 0x7f dwords for both IN and OUT */
  60 #define INTEL_QUARK_X1000_EHCI_MAX_THRESHOLD    0x007f007f
  61
  62 /* called after powerup, by probe or system-pm "wakeup" */
  63 static int ehci_pci_reinit(struct ehci_hcd *ehci, struct pci_dev *pdev)
  64 {
  65         int                     retval;
  66
  67         /* we expect static quirk code to handle the "extended capabilities"
  68          * (currently just BIOS handoff) allowed starting with EHCI 0.96
  69          */
  70
  71         /* PCI Memory-Write-Invalidate cycle support is optional (uncommon) */
  72         retval = pci_set_mwi(pdev);
  73         if (!retval)
  74                 ehci_dbg(ehci, "MWI active\n");
  75
  76         /* Reset the threshold limit */
  77         if (is_intel_quark_x1000(pdev)) {
  78                 /*
  79                  * For the Intel QUARK X1000, raise the I/O threshold to the
  80                  * maximum usable value in order to improve performance.
  81                  */
  82                 ehci_writel(ehci, INTEL_QUARK_X1000_EHCI_MAX_THRESHOLD,
  83                         ehci->regs->intel_quark_x1000_insnreg01);
  84         }
  85
  86         return 0;
  87 }
  88
  89 /* called during probe() after chip reset completes */
  90 static int ehci_pci_setup(struct usb_hcd *hcd)
  91 {
  92         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
  93         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
  94         u32                     temp;
  95         int                     retval;
  96
  97         ehci->caps = hcd->regs;
  98
  99         /*
 100          * ehci_init() causes memory for DMA transfers to be
 101          * allocated.  Thus, any vendor-specific workarounds based on
 102          * limiting the type of memory used for DMA transfers must
 103          * happen before ehci_setup() is called.
 104          *
 105          * Most other workarounds can be done either before or after
 106          * init and reset; they are located here too.
 107          */
 108         switch (pdev->vendor) {
 109         case PCI_VENDOR_ID_TOSHIBA_2:
 110                 /* celleb's companion chip */
 111                 if (pdev->device == 0x01b5) {
 112 #ifdef CONFIG_USB_EHCI_BIG_ENDIAN_MMIO
 113                         ehci->big_endian_mmio = 1;
 114 #else
 115                         ehci_warn(ehci,
 116                                   "unsupported big endian Toshiba quirk\n");
 117 #endif
 118                 }
 119                 break;
 120         case PCI_VENDOR_ID_NVIDIA:
 121                 /* NVidia reports that certain chips don't handle
 122                  * QH, ITD, or SITD addresses above 2GB.  (But TD,
 123                  * data buffer, and periodic schedule are normal.)
 124                  */
 125                 switch (pdev->device) {
 126                 case 0x003c:    /* MCP04 */
 127                 case 0x005b:    /* CK804 */
 128                 case 0x00d8:    /* CK8 */
 129                 case 0x00e8:    /* CK8S */
 130                         if (pci_set_consistent_dma_mask(pdev,
 131                                                 DMA_BIT_MASK(31)) < 0)
 132                                 ehci_warn(ehci, "can't enable NVidia "
 133                                         "workaround for >2GB RAM\n");
 134                         break;
 135
 136                 /* Some NForce2 chips have problems with selective suspend;
 137                  * fixed in newer silicon.
 138                  */
 139                 case 0x0068:
 140                         if (pdev->revision < 0xa4)
 141                                 ehci->no_selective_suspend = 1;
 142                         break;
 143                 }
 144                 break;
 145         case PCI_VENDOR_ID_INTEL:
 146                 if (pdev->device == PCI_DEVICE_ID_INTEL_CE4100_USB)
 147                         hcd->has_tt = 1;
 148                 break;
 149         case PCI_VENDOR_ID_TDI:
 150                 if (pdev->device == PCI_DEVICE_ID_TDI_EHCI)
 151                         hcd->has_tt = 1;
 152                 break;
 153         case PCI_VENDOR_ID_AMD:
 154                 /* AMD PLL quirk */
 155                 if (usb_amd_find_chipset_info())
 156                         ehci->amd_pll_fix = 1;
 157                 /* AMD8111 EHCI doesn't work, according to AMD errata */
 158                 if (pdev->device == 0x7463) {
 159                         ehci_info(ehci, "ignoring AMD8111 (errata)\n");
 160                         retval = -EIO;
 161                         goto done;
 162                 }
 163
 164                 /*
 165                  * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
 166                  * read/write memory space which does not belong to it when
 167                  * there is NULL pointer with T-bit set to 1 in the frame list
 168                  * table. To avoid the issue, the frame list link pointer
 169                  * should always contain a valid pointer to a inactive qh.
 170                  */
 171                 if (pdev->device == 0x7808) {
 172                         ehci->use_dummy_qh = 1;
 173                         ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
 174                 }
 175                 break;
 176         case PCI_VENDOR_ID_VIA:
 177                 if (pdev->device == 0x3104 && (pdev->revision & 0xf0) == 0x60) {
 178                         u8 tmp;
 179
 180                         /* The VT6212 defaults to a 1 usec EHCI sleep time which
 181                          * hogs the PCI bus *badly*. Setting bit 5 of 0x4B makes
 182                          * that sleep time use the conventional 10 usec.
 183                          */
 184                         pci_read_config_byte(pdev, 0x4b, &tmp);
 185                         if (tmp & 0x20)
 186                                 break;
 187                         pci_write_config_byte(pdev, 0x4b, tmp | 0x20);
 188                 }
 189                 break;
 190         case PCI_VENDOR_ID_ATI:
 191                 /* AMD PLL quirk */
 192                 if (usb_amd_find_chipset_info())
 193                         ehci->amd_pll_fix = 1;
 194
 195                 /*
 196                  * EHCI controller on AMD SB700/SB800/Hudson-2/3 platforms may
 197                  * read/write memory space which does not belong to it when
 198                  * there is NULL pointer with T-bit set to 1 in the frame list
 199                  * table. To avoid the issue, the frame list link pointer
 200                  * should always contain a valid pointer to a inactive qh.
 201                  */
 202                 if (pdev->device == 0x4396) {
 203                         ehci->use_dummy_qh = 1;
 204                         ehci_info(ehci, "applying AMD SB700/SB800/Hudson-2/3 EHCI dummy qh workaround\n");
 205                 }
 206                 /* SB600 and old version of SB700 have a bug in EHCI controller,
 207                  * which causes usb devices lose response in some cases.
 208                  */
 209                 if ((pdev->device == 0x4386 || pdev->device == 0x4396) &&
 210                                 usb_amd_hang_symptom_quirk()) {
 211                         u8 tmp;
 212                         ehci_info(ehci, "applying AMD SB600/SB700 USB freeze workaround\n");
 213                         pci_read_config_byte(pdev, 0x53, &tmp);
 214                         pci_write_config_byte(pdev, 0x53, tmp | (1<<3));
 215                 }
 216                 break;
 217         case PCI_VENDOR_ID_NETMOS:
 218                 /* MosChip frame-index-register bug */
 219                 ehci_info(ehci, "applying MosChip frame-index workaround\n");
 220                 ehci->frame_index_bug = 1;
 221                 break;
 222         case PCI_VENDOR_ID_HUAWEI:
 223                 /* Synopsys HC bug */
 224                 if (pdev->device == 0xa239) {
 225                         ehci_info(ehci, "applying Synopsys HC workaround\n");
 226                         ehci->has_synopsys_hc_bug = 1;
 227                 }
 228                 break;
 229         case PCI_VENDOR_ID_ASPEED:
 230                 if (pdev->device == PCI_DEVICE_ID_ASPEED_EHCI) {
 231                         ehci_info(ehci, "applying Aspeed HC workaround\n");
 232                         ehci->is_aspeed = 1;
 233                 }
 234                 break;
 235         }
 236
 237         /* optional debug port, normally in the first BAR */
 238         temp = pci_find_capability(pdev, PCI_CAP_ID_DBG);
 239         if (temp) {
 240                 pci_read_config_dword(pdev, temp, &temp);
 241                 temp >>= 16;
 242                 if (((temp >> 13) & 7) == 1) {
 243                         u32 hcs_params = ehci_readl(ehci,
 244                                                     &ehci->caps->hcs_params);
 245
 246                         temp &= 0x1fff;
 247                         ehci->debug = hcd->regs + temp;
 248                         temp = ehci_readl(ehci, &ehci->debug->control);
 249                         ehci_info(ehci, "debug port %d%s\n",
 250                                   HCS_DEBUG_PORT(hcs_params),
 251                                   (temp & DBGP_ENABLED) ? " IN USE" : "");
 252                         if (!(temp & DBGP_ENABLED))
 253                                 ehci->debug = NULL;
 254                 }
 255         }
 256
 257         retval = ehci_setup(hcd);
 258         if (retval)
 259                 return retval;
 260
 261         /* These workarounds need to be applied after ehci_setup() */
 262         switch (pdev->vendor) {
 263         case PCI_VENDOR_ID_NEC:
 264         case PCI_VENDOR_ID_INTEL:
 265         case PCI_VENDOR_ID_AMD:
 266                 ehci->need_io_watchdog = 0;
 267                 break;
 268         case PCI_VENDOR_ID_NVIDIA:
 269                 switch (pdev->device) {
 270                 /* MCP89 chips on the MacBookAir3,1 give EPROTO when
 271                  * fetching device descriptors unless LPM is disabled.
 272                  * There are also intermittent problems enumerating
 273                  * devices with PPCD enabled.
 274                  */
 275                 case 0x0d9d:
 276                         ehci_info(ehci, "disable ppcd for nvidia mcp89\n");
 277                         ehci->has_ppcd = 0;
 278                         ehci->command &= ~CMD_PPCEE;
 279                         break;
 280                 }
 281                 break;
 282         }
 283
 284         /* at least the Genesys GL880S needs fixup here */
 285         temp = HCS_N_CC(ehci->hcs_params) * HCS_N_PCC(ehci->hcs_params);
 286         temp &= 0x0f;
 287         if (temp && HCS_N_PORTS(ehci->hcs_params) > temp) {
 288                 ehci_dbg(ehci, "bogus port configuration: "
 289                         "cc=%d x pcc=%d < ports=%d\n",
 290                         HCS_N_CC(ehci->hcs_params),
 291                         HCS_N_PCC(ehci->hcs_params),
 292                         HCS_N_PORTS(ehci->hcs_params));
 293
 294                 switch (pdev->vendor) {
 295                 case 0x17a0:            /* GENESYS */
 296                         /* GL880S: should be PORTS=2 */
 297                         temp |= (ehci->hcs_params & ~0xf);
 298                         ehci->hcs_params = temp;
 299                         break;
 300                 case PCI_VENDOR_ID_NVIDIA:
 301                         /* NF4: should be PCC=10 */
 302                         break;
 303                 }
 304         }
 305
 306         /* Serial Bus Release Number is at PCI 0x60 offset */
 307         if (pdev->vendor == PCI_VENDOR_ID_STMICRO
 308             && pdev->device == PCI_DEVICE_ID_STMICRO_USB_HOST)
 309                 ;       /* ConneXT has no sbrn register */
 310         else if (pdev->vendor == PCI_VENDOR_ID_HUAWEI
 311                          && pdev->device == 0xa239)
 312                 ;       /* HUAWEI Kunpeng920 USB EHCI has no sbrn register */
 313         else
 314                 pci_read_config_byte(pdev, 0x60, &ehci->sbrn);
 315
 316         /* Keep this around for a while just in case some EHCI
 317          * implementation uses legacy PCI PM support.  This test
 318          * can be removed on 17 Dec 2009 if the dev_warn() hasn't
 319          * been triggered by then.
 320          */
 321         if (!device_can_wakeup(&pdev->dev)) {
 322                 u16     port_wake;
 323
 324                 pci_read_config_word(pdev, 0x62, &port_wake);
 325                 if (port_wake & 0x0001) {
 326                         dev_warn(&pdev->dev, "Enabling legacy PCI PM\n");
 327                         device_set_wakeup_capable(&pdev->dev, 1);
 328                 }
 329         }
 330
 331 #ifdef  CONFIG_PM
 332         if (ehci->no_selective_suspend && device_can_wakeup(&pdev->dev))
 333                 ehci_warn(ehci, "selective suspend/wakeup unavailable\n");
 334 #endif
 335
 336         retval = ehci_pci_reinit(ehci, pdev);
 337 done:
 338         return retval;
 339 }
 340
 341 /*-------------------------------------------------------------------------*/
 342
 343 #ifdef  CONFIG_PM
 344
 345 /* suspend/resume, section 4.3 */
 346
 347 /* These routines rely on the PCI bus glue
 348  * to handle powerdown and wakeup, and currently also on
 349  * transceivers that don't need any software attention to set up
 350  * the right sort of wakeup.
 351  * Also they depend on separate root hub suspend/resume.
 352  */
 353
 354 static int ehci_pci_resume(struct usb_hcd *hcd, bool hibernated)
 355 {
 356         struct ehci_hcd         *ehci = hcd_to_ehci(hcd);
 357         struct pci_dev          *pdev = to_pci_dev(hcd->self.controller);
 358
 359         if (ehci_resume(hcd, hibernated) != 0)
 360                 (void) ehci_pci_reinit(ehci, pdev);
 361         return 0;
 362 }
 363
 364 #else
 365
 366 #define ehci_suspend            NULL
 367 #define ehci_pci_resume         NULL
 368 #endif  /* CONFIG_PM */
 369
 370 static struct hc_driver __read_mostly ehci_pci_hc_driver;
 371
 372 static const struct ehci_driver_overrides pci_overrides __initconst = {
 373         .reset =                ehci_pci_setup,
 374 };
 375
 376 /*-------------------------------------------------------------------------*/
 377
 378 static int ehci_pci_probe(struct pci_dev *pdev, const struct pci_device_id *id)
 379 {
 380         if (is_bypassed_id(pdev))
 381                 return -ENODEV;
 382         return usb_hcd_pci_probe(pdev, id);
 383 }
 384
 385 static void ehci_pci_remove(struct pci_dev *pdev)
 386 {
 387         pci_clear_mwi(pdev);
 388         usb_hcd_pci_remove(pdev);
 389 }
 390
 391 /* PCI driver selection metadata; PCI hotplugging uses this */
 392 static const struct pci_device_id pci_ids [] = { {
 393         /* handle any USB 2.0 EHCI controller */
 394         PCI_DEVICE_CLASS(PCI_CLASS_SERIAL_USB_EHCI, ~0),
 395         .driver_data =  (unsigned long) &ehci_pci_hc_driver,
 396         }, {
 397         PCI_VDEVICE(STMICRO, PCI_DEVICE_ID_STMICRO_USB_HOST),
 398         .driver_data = (unsigned long) &ehci_pci_hc_driver,
 399         },
 400         { /* end: all zeroes */ }
 401 };
 402 MODULE_DEVICE_TABLE(pci, pci_ids);
 403
 404 /* pci driver glue; this is a "new style" PCI driver module */
 405 static struct pci_driver ehci_pci_driver = {
 406         .name =         (char *) hcd_name,
 407         .id_table =     pci_ids,
 408
 409         .probe =        ehci_pci_probe,
 410         .remove =       ehci_pci_remove,
 411         .shutdown =     usb_hcd_pci_shutdown,
 412
 413 #ifdef CONFIG_PM
 414         .driver =       {
 415                 .pm =   &usb_hcd_pci_pm_ops
 416         },
 417 #endif
 418 };
 419
 420 static int __init ehci_pci_init(void)
 421 {
 422         if (usb_disabled())
 423                 return -ENODEV;
 424
 425         pr_info("%s: " DRIVER_DESC "\n", hcd_name);
 426
 427         ehci_init_driver(&ehci_pci_hc_driver, &pci_overrides);
 428
 429         /* Entries for the PCI suspend/resume callbacks are special */
 430         ehci_pci_hc_driver.pci_suspend = ehci_suspend;
 431         ehci_pci_hc_driver.pci_resume = ehci_pci_resume;
 432
 433         return pci_register_driver(&ehci_pci_driver);
 434 }
 435 module_init(ehci_pci_init);
 436
 437 static void __exit ehci_pci_cleanup(void)
 438 {
 439         pci_unregister_driver(&ehci_pci_driver);
 440 }
 441 module_exit(ehci_pci_cleanup);
 442
 443 MODULE_DESCRIPTION(DRIVER_DESC);
 444 MODULE_AUTHOR("David Brownell");
 445 MODULE_AUTHOR("Alan Stern");
 446 MODULE_LICENSE("GPL");