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