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/linker_set.h> 57 #include <sys/module.h> 58 #include <sys/lock.h> 59 #include <sys/mutex.h> 60 #include <sys/condvar.h> 61 #include <sys/sysctl.h> 62 #include <sys/sx.h> 63 #include <sys/unistd.h> 64 #include <sys/callout.h> 65 #include <sys/malloc.h> 66 #include <sys/priv.h> 67 68 #include <dev/usb/usb.h> 69 #include <dev/usb/usbdi.h> 70 71 #include <dev/usb/usb_core.h> 72 #include <dev/usb/usb_busdma.h> 73 #include <dev/usb/usb_process.h> 74 #include <dev/usb/usb_util.h> 75 76 #include <dev/usb/usb_controller.h> 77 #include <dev/usb/usb_bus.h> 78 #include <dev/usb/usb_pci.h> 79 #include <dev/usb/controller/ehci.h> 80 #include <dev/usb/controller/ehcireg.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 #define PCI_EHCI_BASE_REG 0x10 97 98 static void ehci_pci_takecontroller(device_t self); 99 100 static device_probe_t ehci_pci_probe; 101 static device_attach_t ehci_pci_attach; 102 static device_detach_t ehci_pci_detach; 103 static device_suspend_t ehci_pci_suspend; 104 static device_resume_t ehci_pci_resume; 105 static device_shutdown_t ehci_pci_shutdown; 106 107 static int 108 ehci_pci_suspend(device_t self) 109 { 110 ehci_softc_t *sc = device_get_softc(self); 111 int err; 112 113 err = bus_generic_suspend(self); 114 if (err) 115 return (err); 116 ehci_suspend(sc); 117 return (0); 118 } 119 120 static int 121 ehci_pci_resume(device_t self) 122 { 123 ehci_softc_t *sc = device_get_softc(self); 124 125 ehci_pci_takecontroller(self); 126 ehci_resume(sc); 127 128 bus_generic_resume(self); 129 130 return (0); 131 } 132 133 static int 134 ehci_pci_shutdown(device_t self) 135 { 136 ehci_softc_t *sc = device_get_softc(self); 137 int err; 138 139 err = bus_generic_shutdown(self); 140 if (err) 141 return (err); 142 ehci_shutdown(sc); 143 144 return (0); 145 } 146 147 static const char * 148 ehci_pci_match(device_t self) 149 { 150 uint32_t device_id = pci_get_devid(self); 151 152 switch (device_id) { 153 case 0x268c8086: 154 return ("Intel 63XXESB USB 2.0 controller"); 155 156 case 0x523910b9: 157 return "ALi M5239 USB 2.0 controller"; 158 159 case 0x10227463: 160 return "AMD 8111 USB 2.0 controller"; 161 162 case 0x20951022: 163 return ("AMD CS5536 (Geode) USB 2.0 controller"); 164 165 case 0x43451002: 166 return "ATI SB200 USB 2.0 controller"; 167 case 0x43731002: 168 return "ATI SB400 USB 2.0 controller"; 169 170 case 0x25ad8086: 171 return "Intel 6300ESB USB 2.0 controller"; 172 case 0x24cd8086: 173 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller"; 174 case 0x24dd8086: 175 return "Intel 82801EB/R (ICH5) USB 2.0 controller"; 176 case 0x265c8086: 177 return "Intel 82801FB (ICH6) USB 2.0 controller"; 178 case 0x27cc8086: 179 return "Intel 82801GB/R (ICH7) USB 2.0 controller"; 180 181 case 0x28368086: 182 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A"; 183 case 0x283a8086: 184 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B"; 185 case 0x293a8086: 186 return "Intel 82801I (ICH9) USB 2.0 controller"; 187 case 0x293c8086: 188 return "Intel 82801I (ICH9) USB 2.0 controller"; 189 case 0x3a3a8086: 190 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A"; 191 case 0x3a3c8086: 192 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B"; 193 case 0x3b348086: 194 return ("Intel PCH USB 2.0 controller USB-A"); 195 case 0x3b3c8086: 196 return ("Intel PCH USB 2.0 controller USB-B"); 197 198 case 0x00e01033: 199 return ("NEC uPD 720100 USB 2.0 controller"); 200 201 case 0x006810de: 202 return "NVIDIA nForce2 USB 2.0 controller"; 203 case 0x008810de: 204 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller"; 205 case 0x00d810de: 206 return "NVIDIA nForce3 USB 2.0 controller"; 207 case 0x00e810de: 208 return "NVIDIA nForce3 250 USB 2.0 controller"; 209 case 0x005b10de: 210 return "NVIDIA nForce4 USB 2.0 controller"; 211 case 0x036d10de: 212 return "NVIDIA nForce MCP55 USB 2.0 controller"; 213 case 0x03f210de: 214 return "NVIDIA nForce MCP61 USB 2.0 controller"; 215 case 0x0aa610de: 216 return "NVIDIA nForce MCP79 USB 2.0 controller"; 217 case 0x0aa910de: 218 return "NVIDIA nForce MCP79 USB 2.0 controller"; 219 case 0x0aaa10de: 220 return "NVIDIA nForce MCP79 USB 2.0 controller"; 221 222 case 0x15621131: 223 return "Philips ISP156x USB 2.0 controller"; 224 225 case 0x31041106: 226 return ("VIA VT6202 USB 2.0 controller"); 227 228 default: 229 break; 230 } 231 232 if ((pci_get_class(self) == PCIC_SERIALBUS) 233 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 234 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) { 235 return ("EHCI (generic) USB 2.0 controller"); 236 } 237 return (NULL); /* dunno */ 238 } 239 240 static int 241 ehci_pci_probe(device_t self) 242 { 243 const char *desc = ehci_pci_match(self); 244 245 if (desc) { 246 device_set_desc(self, desc); 247 return (0); 248 } else { 249 return (ENXIO); 250 } 251 } 252 253 static void 254 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700) 255 { 256 device_t smbdev; 257 uint32_t val; 258 259 if (is_sb700) { 260 /* Lookup SMBUS PCI device */ 261 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385); 262 if (smbdev == NULL) 263 return; 264 val = pci_get_revid(smbdev); 265 if (val != 0x3a && val != 0x3b) 266 return; 267 } 268 269 /* 270 * Note: this bit is described as reserved in SB700 271 * Register Reference Guide. 272 */ 273 val = pci_read_config(self, 0x53, 1); 274 if (!(val & 0x8)) { 275 val |= 0x8; 276 pci_write_config(self, 0x53, val, 1); 277 device_printf(self, "AMD SB600/700 quirk applied\n"); 278 } 279 } 280 281 static void 282 ehci_pci_via_quirk(device_t self) 283 { 284 uint32_t val; 285 286 if ((pci_get_device(self) == 0x3104) && 287 ((pci_get_revid(self) & 0xf0) == 0x60)) { 288 /* Correct schedule sleep time to 10us */ 289 val = pci_read_config(self, 0x4b, 1); 290 if (val & 0x20) 291 return; 292 pci_write_config(self, 0x4b, val, 1); 293 device_printf(self, "VIA-quirk applied\n"); 294 } 295 } 296 297 static int 298 ehci_pci_attach(device_t self) 299 { 300 ehci_softc_t *sc = device_get_softc(self); 301 int err; 302 int rid; 303 304 /* initialise some bus fields */ 305 sc->sc_bus.parent = self; 306 sc->sc_bus.devices = sc->sc_devices; 307 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 308 309 /* get all DMA memory */ 310 if (usb_bus_mem_alloc_all(&sc->sc_bus, 311 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 312 return (ENOMEM); 313 } 314 315 pci_enable_busmaster(self); 316 317 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 318 case PCI_USB_REV_PRE_1_0: 319 case PCI_USB_REV_1_0: 320 case PCI_USB_REV_1_1: 321 /* 322 * NOTE: some EHCI USB controllers have the wrong USB 323 * revision number. It appears those controllers are 324 * fully compliant so we just ignore this value in 325 * some common cases. 326 */ 327 device_printf(self, "pre-2.0 USB revision (ignored)\n"); 328 /* fallthrough */ 329 case PCI_USB_REV_2_0: 330 break; 331 default: 332 /* Quirk for Parallels Desktop 4.0 */ 333 device_printf(self, "USB revision is unknown. Assuming v2.0.\n"); 334 break; 335 } 336 337 rid = PCI_CBMEM; 338 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 339 RF_ACTIVE); 340 if (!sc->sc_io_res) { 341 device_printf(self, "Could not map memory\n"); 342 goto error; 343 } 344 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 345 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 346 sc->sc_io_size = rman_get_size(sc->sc_io_res); 347 348 rid = 0; 349 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 350 RF_SHAREABLE | RF_ACTIVE); 351 if (sc->sc_irq_res == NULL) { 352 device_printf(self, "Could not allocate irq\n"); 353 goto error; 354 } 355 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 356 if (!sc->sc_bus.bdev) { 357 device_printf(self, "Could not add USB device\n"); 358 goto error; 359 } 360 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 361 362 /* 363 * ehci_pci_match will never return NULL if ehci_pci_probe 364 * succeeded 365 */ 366 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self)); 367 switch (pci_get_vendor(self)) { 368 case PCI_EHCI_VENDORID_ACERLABS: 369 sprintf(sc->sc_vendor, "AcerLabs"); 370 break; 371 case PCI_EHCI_VENDORID_AMD: 372 sprintf(sc->sc_vendor, "AMD"); 373 break; 374 case PCI_EHCI_VENDORID_APPLE: 375 sprintf(sc->sc_vendor, "Apple"); 376 break; 377 case PCI_EHCI_VENDORID_ATI: 378 sprintf(sc->sc_vendor, "ATI"); 379 break; 380 case PCI_EHCI_VENDORID_CMDTECH: 381 sprintf(sc->sc_vendor, "CMDTECH"); 382 break; 383 case PCI_EHCI_VENDORID_INTEL: 384 sprintf(sc->sc_vendor, "Intel"); 385 break; 386 case PCI_EHCI_VENDORID_NEC: 387 sprintf(sc->sc_vendor, "NEC"); 388 break; 389 case PCI_EHCI_VENDORID_OPTI: 390 sprintf(sc->sc_vendor, "OPTi"); 391 break; 392 case PCI_EHCI_VENDORID_PHILIPS: 393 sprintf(sc->sc_vendor, "Philips"); 394 break; 395 case PCI_EHCI_VENDORID_SIS: 396 sprintf(sc->sc_vendor, "SiS"); 397 break; 398 case PCI_EHCI_VENDORID_NVIDIA: 399 case PCI_EHCI_VENDORID_NVIDIA2: 400 sprintf(sc->sc_vendor, "nVidia"); 401 break; 402 case PCI_EHCI_VENDORID_VIA: 403 sprintf(sc->sc_vendor, "VIA"); 404 break; 405 default: 406 if (bootverbose) 407 device_printf(self, "(New EHCI DeviceId=0x%08x)\n", 408 pci_get_devid(self)); 409 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 410 } 411 412 #if (__FreeBSD_version >= 700031) 413 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 414 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 415 #else 416 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 417 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 418 #endif 419 if (err) { 420 device_printf(self, "Could not setup irq, %d\n", err); 421 sc->sc_intr_hdl = NULL; 422 goto error; 423 } 424 ehci_pci_takecontroller(self); 425 426 /* Undocumented quirks taken from Linux */ 427 428 switch (pci_get_vendor(self)) { 429 case PCI_EHCI_VENDORID_ATI: 430 /* SB600 and SB700 EHCI quirk */ 431 switch (pci_get_device(self)) { 432 case 0x4386: 433 ehci_pci_ati_quirk(self, 0); 434 break; 435 case 0x4396: 436 ehci_pci_ati_quirk(self, 1); 437 break; 438 default: 439 break; 440 } 441 break; 442 443 case PCI_EHCI_VENDORID_VIA: 444 ehci_pci_via_quirk(self); 445 break; 446 447 default: 448 break; 449 } 450 451 /* Dropped interrupts workaround */ 452 switch (pci_get_vendor(self)) { 453 case PCI_EHCI_VENDORID_ATI: 454 case PCI_EHCI_VENDORID_VIA: 455 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG; 456 if (bootverbose) 457 device_printf(self, 458 "Dropped interrupts workaround enabled\n"); 459 break; 460 default: 461 break; 462 } 463 464 /* Doorbell feature workaround */ 465 switch (pci_get_vendor(self)) { 466 case PCI_EHCI_VENDORID_NVIDIA: 467 case PCI_EHCI_VENDORID_NVIDIA2: 468 sc->sc_flags |= EHCI_SCFLG_IAADBUG; 469 if (bootverbose) 470 device_printf(self, 471 "Doorbell workaround enabled\n"); 472 break; 473 default: 474 break; 475 } 476 477 err = ehci_init(sc); 478 if (!err) { 479 err = device_probe_and_attach(sc->sc_bus.bdev); 480 } 481 if (err) { 482 device_printf(self, "USB init failed err=%d\n", err); 483 goto error; 484 } 485 return (0); 486 487 error: 488 ehci_pci_detach(self); 489 return (ENXIO); 490 } 491 492 static int 493 ehci_pci_detach(device_t self) 494 { 495 ehci_softc_t *sc = device_get_softc(self); 496 device_t bdev; 497 498 if (sc->sc_bus.bdev) { 499 bdev = sc->sc_bus.bdev; 500 device_detach(bdev); 501 device_delete_child(self, bdev); 502 } 503 /* during module unload there are lots of children leftover */ 504 device_delete_all_children(self); 505 506 pci_disable_busmaster(self); 507 508 /* 509 * disable interrupts that might have been switched on in ehci_init 510 */ 511 if (sc->sc_io_res) { 512 EWRITE4(sc, EHCI_USBINTR, 0); 513 } 514 if (sc->sc_irq_res && sc->sc_intr_hdl) { 515 /* 516 * only call ehci_detach() after ehci_init() 517 */ 518 ehci_detach(sc); 519 520 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 521 522 if (err) 523 /* XXX or should we panic? */ 524 device_printf(self, "Could not tear down irq, %d\n", 525 err); 526 sc->sc_intr_hdl = NULL; 527 } 528 if (sc->sc_irq_res) { 529 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 530 sc->sc_irq_res = NULL; 531 } 532 if (sc->sc_io_res) { 533 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, 534 sc->sc_io_res); 535 sc->sc_io_res = NULL; 536 } 537 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 538 539 return (0); 540 } 541 542 static void 543 ehci_pci_takecontroller(device_t self) 544 { 545 ehci_softc_t *sc = device_get_softc(self); 546 uint32_t cparams; 547 uint32_t eec; 548 uint16_t to; 549 uint8_t eecp; 550 uint8_t bios_sem; 551 552 cparams = EREAD4(sc, EHCI_HCCPARAMS); 553 554 /* Synchronise with the BIOS if it owns the controller. */ 555 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0; 556 eecp = EHCI_EECP_NEXT(eec)) { 557 eec = pci_read_config(self, eecp, 4); 558 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) { 559 continue; 560 } 561 bios_sem = pci_read_config(self, eecp + 562 EHCI_LEGSUP_BIOS_SEM, 1); 563 if (bios_sem == 0) { 564 continue; 565 } 566 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 567 "to give up control\n"); 568 pci_write_config(self, eecp + 569 EHCI_LEGSUP_OS_SEM, 1, 1); 570 to = 500; 571 while (1) { 572 bios_sem = pci_read_config(self, eecp + 573 EHCI_LEGSUP_BIOS_SEM, 1); 574 if (bios_sem == 0) 575 break; 576 577 if (--to == 0) { 578 device_printf(sc->sc_bus.bdev, 579 "timed out waiting for BIOS\n"); 580 break; 581 } 582 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 583 } 584 } 585 } 586 587 static driver_t ehci_driver = 588 { 589 .name = "ehci", 590 .methods = (device_method_t[]){ 591 /* device interface */ 592 DEVMETHOD(device_probe, ehci_pci_probe), 593 DEVMETHOD(device_attach, ehci_pci_attach), 594 DEVMETHOD(device_detach, ehci_pci_detach), 595 DEVMETHOD(device_suspend, ehci_pci_suspend), 596 DEVMETHOD(device_resume, ehci_pci_resume), 597 DEVMETHOD(device_shutdown, ehci_pci_shutdown), 598 /* bus interface */ 599 DEVMETHOD(bus_print_child, bus_generic_print_child), 600 601 {0, 0} 602 }, 603 .size = sizeof(struct ehci_softc), 604 }; 605 606 static devclass_t ehci_devclass; 607 608 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0); 609 MODULE_DEPEND(ehci, usb, 1, 1, 1); 610