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