sys/bus/u4b/controller/ehci_pci.c

   1 /*-
   2  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   3  * All rights reserved.
   4  *
   5  * This code is derived from software contributed to The NetBSD Foundation
   6  * by Lennart Augustsson (augustss@carlstedt.se) at
   7  * Carlstedt Research & Technology.
   8  *
   9  * Redistribution and use in source and binary forms, with or without
  10  * modification, are permitted provided that the following conditions
  11  * are met:
  12  * 1. Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in the
  16  *    documentation and/or other materials provided with the distribution.
  17  *
  18  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28  * POSSIBILITY OF SUCH DAMAGE.
  29  */
  30
  31 #include <sys/cdefs.h>
  32 __FBSDID("$FreeBSD$");
  33
  34 /*
  35  * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
  36  *
  37  * The EHCI 1.0 spec can be found at
  38  * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
  39  * and the USB 2.0 spec at
  40  * http://www.usb.org/developers/docs/usb_20.zip
  41  */
  42
  43 /* The low level controller code for EHCI has been split into
  44  * PCI probes and EHCI specific code. This was done to facilitate the
  45  * sharing of code between *BSD's
  46  */
  47
  48 #include <sys/stdint.h>
  49 #include <sys/stddef.h>
  50 #include <sys/param.h>
  51 #include <sys/queue.h>
  52 #include <sys/types.h>
  53 #include <sys/systm.h>
  54 #include <sys/kernel.h>
  55 #include <sys/bus.h>
  56 #include <sys/module.h>
  57 #include <sys/lock.h>
  58 #include <sys/mutex.h>
  59 #include <sys/condvar.h>
  60 #include <sys/sysctl.h>
  61 #include <sys/sx.h>
  62 #include <sys/unistd.h>
  63 #include <sys/callout.h>
  64 #include <sys/malloc.h>
  65 #include <sys/priv.h>
  66
  67 #include <dev/usb/usb.h>
  68 #include <dev/usb/usbdi.h>
  69
  70 #include <dev/usb/usb_core.h>
  71 #include <dev/usb/usb_busdma.h>
  72 #include <dev/usb/usb_process.h>
  73 #include <dev/usb/usb_util.h>
  74
  75 #include <dev/usb/usb_controller.h>
  76 #include <dev/usb/usb_bus.h>
  77 #include <dev/usb/usb_pci.h>
  78 #include <dev/usb/controller/ehci.h>
  79 #include <dev/usb/controller/ehcireg.h>
  80 #include "usb_if.h"
  81
  82 #define PCI_EHCI_VENDORID_ACERLABS      0x10b9
  83 #define PCI_EHCI_VENDORID_AMD           0x1022
  84 #define PCI_EHCI_VENDORID_APPLE         0x106b
  85 #define PCI_EHCI_VENDORID_ATI           0x1002
  86 #define PCI_EHCI_VENDORID_CMDTECH       0x1095
  87 #define PCI_EHCI_VENDORID_INTEL         0x8086
  88 #define PCI_EHCI_VENDORID_NEC           0x1033
  89 #define PCI_EHCI_VENDORID_OPTI          0x1045
  90 #define PCI_EHCI_VENDORID_PHILIPS       0x1131
  91 #define PCI_EHCI_VENDORID_SIS           0x1039
  92 #define PCI_EHCI_VENDORID_NVIDIA        0x12D2
  93 #define PCI_EHCI_VENDORID_NVIDIA2       0x10DE
  94 #define PCI_EHCI_VENDORID_VIA           0x1106
  95
  96 static device_probe_t ehci_pci_probe;
  97 static device_attach_t ehci_pci_attach;
  98 static device_detach_t ehci_pci_detach;
  99 static usb_take_controller_t ehci_pci_take_controller;
 100
 101 static const char *
 102 ehci_pci_match(device_t self)
 103 {
 104         uint32_t device_id = pci_get_devid(self);
 105
 106         switch (device_id) {
 107         case 0x268c8086:
 108                 return ("Intel 63XXESB USB 2.0 controller");
 109
 110         case 0x523910b9:
 111                 return "ALi M5239 USB 2.0 controller";
 112
 113         case 0x10227463:
 114                 return "AMD 8111 USB 2.0 controller";
 115
 116         case 0x20951022:
 117                 return ("AMD CS5536 (Geode) USB 2.0 controller");
 118
 119         case 0x43451002:
 120                 return "ATI SB200 USB 2.0 controller";
 121         case 0x43731002:
 122                 return "ATI SB400 USB 2.0 controller";
 123
 124         case 0x25ad8086:
 125                 return "Intel 6300ESB USB 2.0 controller";
 126         case 0x24cd8086:
 127                 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
 128         case 0x24dd8086:
 129                 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
 130         case 0x265c8086:
 131                 return "Intel 82801FB (ICH6) USB 2.0 controller";
 132         case 0x27cc8086:
 133                 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
 134
 135         case 0x28368086:
 136                 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
 137         case 0x283a8086:
 138                 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
 139         case 0x293a8086:
 140                 return "Intel 82801I (ICH9) USB 2.0 controller";
 141         case 0x293c8086:
 142                 return "Intel 82801I (ICH9) USB 2.0 controller";
 143         case 0x3a3a8086:
 144                 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
 145         case 0x3a3c8086:
 146                 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
 147         case 0x3b348086:
 148                 return ("Intel PCH USB 2.0 controller USB-A");
 149         case 0x3b3c8086:
 150                 return ("Intel PCH USB 2.0 controller USB-B");
 151
 152         case 0x00e01033:
 153                 return ("NEC uPD 720100 USB 2.0 controller");
 154
 155         case 0x006810de:
 156                 return "NVIDIA nForce2 USB 2.0 controller";
 157         case 0x008810de:
 158                 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
 159         case 0x00d810de:
 160                 return "NVIDIA nForce3 USB 2.0 controller";
 161         case 0x00e810de:
 162                 return "NVIDIA nForce3 250 USB 2.0 controller";
 163         case 0x005b10de:
 164                 return "NVIDIA nForce4 USB 2.0 controller";
 165         case 0x036d10de:
 166                 return "NVIDIA nForce MCP55 USB 2.0 controller";
 167         case 0x03f210de:
 168                 return "NVIDIA nForce MCP61 USB 2.0 controller";
 169         case 0x0aa610de:
 170                 return "NVIDIA nForce MCP79 USB 2.0 controller";
 171         case 0x0aa910de:
 172                 return "NVIDIA nForce MCP79 USB 2.0 controller";
 173         case 0x0aaa10de:
 174                 return "NVIDIA nForce MCP79 USB 2.0 controller";
 175
 176         case 0x15621131:
 177                 return "Philips ISP156x USB 2.0 controller";
 178
 179         case 0x31041106:
 180                 return ("VIA VT6202 USB 2.0 controller");
 181
 182         default:
 183                 break;
 184         }
 185
 186         if ((pci_get_class(self) == PCIC_SERIALBUS)
 187             && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
 188             && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
 189                 return ("EHCI (generic) USB 2.0 controller");
 190         }
 191         return (NULL);                  /* dunno */
 192 }
 193
 194 static int
 195 ehci_pci_probe(device_t self)
 196 {
 197         const char *desc = ehci_pci_match(self);
 198
 199         if (desc) {
 200                 device_set_desc(self, desc);
 201                 return (0);
 202         } else {
 203                 return (ENXIO);
 204         }
 205 }
 206
 207 static void
 208 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
 209 {
 210         device_t smbdev;
 211         uint32_t val;
 212
 213         if (is_sb700) {
 214                 /* Lookup SMBUS PCI device */
 215                 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
 216                 if (smbdev == NULL)
 217                         return;
 218                 val = pci_get_revid(smbdev);
 219                 if (val != 0x3a && val != 0x3b)
 220                         return;
 221         }
 222
 223         /*
 224          * Note: this bit is described as reserved in SB700
 225          * Register Reference Guide.
 226          */
 227         val = pci_read_config(self, 0x53, 1);
 228         if (!(val & 0x8)) {
 229                 val |= 0x8;
 230                 pci_write_config(self, 0x53, val, 1);
 231                 device_printf(self, "AMD SB600/700 quirk applied\n");
 232         }
 233 }
 234
 235 static void
 236 ehci_pci_via_quirk(device_t self)
 237 {
 238         uint32_t val;
 239
 240         if ((pci_get_device(self) == 0x3104) &&
 241             ((pci_get_revid(self) & 0xf0) == 0x60)) {
 242                 /* Correct schedule sleep time to 10us */
 243                 val = pci_read_config(self, 0x4b, 1);
 244                 if (val & 0x20)
 245                         return;
 246                 pci_write_config(self, 0x4b, val, 1);
 247                 device_printf(self, "VIA-quirk applied\n");
 248         }
 249 }
 250
 251 static int
 252 ehci_pci_attach(device_t self)
 253 {
 254         ehci_softc_t *sc = device_get_softc(self);
 255         int err;
 256         int rid;
 257
 258         /* initialise some bus fields */
 259         sc->sc_bus.parent = self;
 260         sc->sc_bus.devices = sc->sc_devices;
 261         sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
 262
 263         /* get all DMA memory */
 264         if (usb_bus_mem_alloc_all(&sc->sc_bus,
 265             USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
 266                 return (ENOMEM);
 267         }
 268
 269         pci_enable_busmaster(self);
 270
 271         switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
 272         case PCI_USB_REV_PRE_1_0:
 273         case PCI_USB_REV_1_0:
 274         case PCI_USB_REV_1_1:
 275                 /*
 276                  * NOTE: some EHCI USB controllers have the wrong USB
 277                  * revision number. It appears those controllers are
 278                  * fully compliant so we just ignore this value in
 279                  * some common cases.
 280                  */
 281                 device_printf(self, "pre-2.0 USB revision (ignored)\n");
 282                 /* fallthrough */
 283         case PCI_USB_REV_2_0:
 284                 break;
 285         default:
 286                 /* Quirk for Parallels Desktop 4.0 */
 287                 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
 288                 break;
 289         }
 290
 291         rid = PCI_CBMEM;
 292         sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
 293             RF_ACTIVE);
 294         if (!sc->sc_io_res) {
 295                 device_printf(self, "Could not map memory\n");
 296                 goto error;
 297         }
 298         sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
 299         sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
 300         sc->sc_io_size = rman_get_size(sc->sc_io_res);
 301
 302         rid = 0;
 303         sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 304             RF_SHAREABLE | RF_ACTIVE);
 305         if (sc->sc_irq_res == NULL) {
 306                 device_printf(self, "Could not allocate irq\n");
 307                 goto error;
 308         }
 309         sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
 310         if (!sc->sc_bus.bdev) {
 311                 device_printf(self, "Could not add USB device\n");
 312                 goto error;
 313         }
 314         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 315
 316         /*
 317          * ehci_pci_match will never return NULL if ehci_pci_probe
 318          * succeeded
 319          */
 320         device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
 321         switch (pci_get_vendor(self)) {
 322         case PCI_EHCI_VENDORID_ACERLABS:
 323                 sprintf(sc->sc_vendor, "AcerLabs");
 324                 break;
 325         case PCI_EHCI_VENDORID_AMD:
 326                 sprintf(sc->sc_vendor, "AMD");
 327                 break;
 328         case PCI_EHCI_VENDORID_APPLE:
 329                 sprintf(sc->sc_vendor, "Apple");
 330                 break;
 331         case PCI_EHCI_VENDORID_ATI:
 332                 sprintf(sc->sc_vendor, "ATI");
 333                 break;
 334         case PCI_EHCI_VENDORID_CMDTECH:
 335                 sprintf(sc->sc_vendor, "CMDTECH");
 336                 break;
 337         case PCI_EHCI_VENDORID_INTEL:
 338                 sprintf(sc->sc_vendor, "Intel");
 339                 break;
 340         case PCI_EHCI_VENDORID_NEC:
 341                 sprintf(sc->sc_vendor, "NEC");
 342                 break;
 343         case PCI_EHCI_VENDORID_OPTI:
 344                 sprintf(sc->sc_vendor, "OPTi");
 345                 break;
 346         case PCI_EHCI_VENDORID_PHILIPS:
 347                 sprintf(sc->sc_vendor, "Philips");
 348                 break;
 349         case PCI_EHCI_VENDORID_SIS:
 350                 sprintf(sc->sc_vendor, "SiS");
 351                 break;
 352         case PCI_EHCI_VENDORID_NVIDIA:
 353         case PCI_EHCI_VENDORID_NVIDIA2:
 354                 sprintf(sc->sc_vendor, "nVidia");
 355                 break;
 356         case PCI_EHCI_VENDORID_VIA:
 357                 sprintf(sc->sc_vendor, "VIA");
 358                 break;
 359         default:
 360                 if (bootverbose)
 361                         device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
 362                             pci_get_devid(self));
 363                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 364         }
 365
 366 #if (__FreeBSD_version >= 700031)
 367         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 368             NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
 369 #else
 370         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 371             (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
 372 #endif
 373         if (err) {
 374                 device_printf(self, "Could not setup irq, %d\n", err);
 375                 sc->sc_intr_hdl = NULL;
 376                 goto error;
 377         }
 378         ehci_pci_take_controller(self);
 379
 380         /* Undocumented quirks taken from Linux */
 381
 382         switch (pci_get_vendor(self)) {
 383         case PCI_EHCI_VENDORID_ATI:
 384                 /* SB600 and SB700 EHCI quirk */
 385                 switch (pci_get_device(self)) {
 386                 case 0x4386:
 387                         ehci_pci_ati_quirk(self, 0);
 388                         break;
 389                 case 0x4396:
 390                         ehci_pci_ati_quirk(self, 1);
 391                         break;
 392                 default:
 393                         break;
 394                 }
 395                 break;
 396
 397         case PCI_EHCI_VENDORID_VIA:
 398                 ehci_pci_via_quirk(self);
 399                 break;
 400
 401         default:
 402                 break;
 403         }
 404
 405         /* Dropped interrupts workaround */
 406         switch (pci_get_vendor(self)) {
 407         case PCI_EHCI_VENDORID_ATI:
 408         case PCI_EHCI_VENDORID_VIA:
 409                 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
 410                 if (bootverbose)
 411                         device_printf(self,
 412                             "Dropped interrupts workaround enabled\n");
 413                 break;
 414         default:
 415                 break;
 416         }
 417
 418         /* Doorbell feature workaround */
 419         switch (pci_get_vendor(self)) {
 420         case PCI_EHCI_VENDORID_NVIDIA:
 421         case PCI_EHCI_VENDORID_NVIDIA2:
 422                 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
 423                 if (bootverbose)
 424                         device_printf(self,
 425                             "Doorbell workaround enabled\n");
 426                 break;
 427         default:
 428                 break;
 429         }
 430
 431         err = ehci_init(sc);
 432         if (!err) {
 433                 err = device_probe_and_attach(sc->sc_bus.bdev);
 434         }
 435         if (err) {
 436                 device_printf(self, "USB init failed err=%d\n", err);
 437                 goto error;
 438         }
 439         return (0);
 440
 441 error:
 442         ehci_pci_detach(self);
 443         return (ENXIO);
 444 }
 445
 446 static int
 447 ehci_pci_detach(device_t self)
 448 {
 449         ehci_softc_t *sc = device_get_softc(self);
 450         device_t bdev;
 451
 452         if (sc->sc_bus.bdev) {
 453                 bdev = sc->sc_bus.bdev;
 454                 device_detach(bdev);
 455                 device_delete_child(self, bdev);
 456         }
 457         /* during module unload there are lots of children leftover */
 458         device_delete_children(self);
 459
 460         pci_disable_busmaster(self);
 461
 462         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 463                 /*
 464                  * only call ehci_detach() after ehci_init()
 465                  */
 466                 ehci_detach(sc);
 467
 468                 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
 469
 470                 if (err)
 471                         /* XXX or should we panic? */
 472                         device_printf(self, "Could not tear down irq, %d\n",
 473                             err);
 474                 sc->sc_intr_hdl = NULL;
 475         }
 476         if (sc->sc_irq_res) {
 477                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
 478                 sc->sc_irq_res = NULL;
 479         }
 480         if (sc->sc_io_res) {
 481                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
 482                     sc->sc_io_res);
 483                 sc->sc_io_res = NULL;
 484         }
 485         usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
 486
 487         return (0);
 488 }
 489
 490 static int
 491 ehci_pci_take_controller(device_t self)
 492 {
 493         ehci_softc_t *sc = device_get_softc(self);
 494         uint32_t cparams;
 495         uint32_t eec;
 496         uint16_t to;
 497         uint8_t eecp;
 498         uint8_t bios_sem;
 499
 500         cparams = EREAD4(sc, EHCI_HCCPARAMS);
 501
 502         /* Synchronise with the BIOS if it owns the controller. */
 503         for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
 504             eecp = EHCI_EECP_NEXT(eec)) {
 505                 eec = pci_read_config(self, eecp, 4);
 506                 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
 507                         continue;
 508                 }
 509                 bios_sem = pci_read_config(self, eecp +
 510                     EHCI_LEGSUP_BIOS_SEM, 1);
 511                 if (bios_sem == 0) {
 512                         continue;
 513                 }
 514                 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
 515                     "to give up control\n");
 516                 pci_write_config(self, eecp +
 517                     EHCI_LEGSUP_OS_SEM, 1, 1);
 518                 to = 500;
 519                 while (1) {
 520                         bios_sem = pci_read_config(self, eecp +
 521                             EHCI_LEGSUP_BIOS_SEM, 1);
 522                         if (bios_sem == 0)
 523                                 break;
 524
 525                         if (--to == 0) {
 526                                 device_printf(sc->sc_bus.bdev,
 527                                     "timed out waiting for BIOS\n");
 528                                 break;
 529                         }
 530                         usb_pause_mtx(NULL, hz / 100);  /* wait 10ms */
 531                 }
 532         }
 533         return (0);
 534 }
 535
 536 static device_method_t ehci_pci_methods[] = {
 537         /* Device interface */
 538         DEVMETHOD(device_probe, ehci_pci_probe),
 539         DEVMETHOD(device_attach, ehci_pci_attach),
 540         DEVMETHOD(device_detach, ehci_pci_detach),
 541         DEVMETHOD(device_suspend, bus_generic_suspend),
 542         DEVMETHOD(device_resume, bus_generic_resume),
 543         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 544         DEVMETHOD(usb_take_controller, ehci_pci_take_controller),
 545
 546         DEVMETHOD_END
 547 };
 548
 549 static driver_t ehci_driver = {
 550         .name = "ehci",
 551         .methods = ehci_pci_methods,
 552         .size = sizeof(struct ehci_softc),
 553 };
 554
 555 static devclass_t ehci_devclass;
 556
 557 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
 558 MODULE_DEPEND(ehci, usb, 1, 1, 1);