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