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