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 * 3. All advertising materials mentioning features or use of this software 18 * must display the following acknowledgement: 19 * This product includes software developed by the NetBSD 20 * Foundation, Inc. and its contributors. 21 * 4. Neither the name of The NetBSD Foundation nor the names of its 22 * contributors may be used to endorse or promote products derived 23 * from this software without specific prior written permission. 24 * 25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 35 * POSSIBILITY OF SUCH DAMAGE. 36 */ 37 38 #include <sys/cdefs.h> 39 __FBSDID("$FreeBSD$"); 40 41 /* 42 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller. 43 * 44 * The EHCI 1.0 spec can be found at 45 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf 46 * and the USB 2.0 spec at 47 * http://www.usb.org/developers/docs/usb_20.zip 48 */ 49 50 /* The low level controller code for EHCI has been split into 51 * PCI probes and EHCI specific code. This was done to facilitate the 52 * sharing of code between *BSD's 53 */ 54 55 #include <sys/stdint.h> 56 #include <sys/stddef.h> 57 #include <sys/param.h> 58 #include <sys/queue.h> 59 #include <sys/types.h> 60 #include <sys/systm.h> 61 #include <sys/kernel.h> 62 #include <sys/bus.h> 63 #include <sys/linker_set.h> 64 #include <sys/module.h> 65 #include <sys/lock.h> 66 #include <sys/mutex.h> 67 #include <sys/condvar.h> 68 #include <sys/sysctl.h> 69 #include <sys/sx.h> 70 #include <sys/unistd.h> 71 #include <sys/callout.h> 72 #include <sys/malloc.h> 73 #include <sys/priv.h> 74 75 #include <dev/usb/usb.h> 76 #include <dev/usb/usbdi.h> 77 78 #include <dev/usb/usb_core.h> 79 #include <dev/usb/usb_busdma.h> 80 #include <dev/usb/usb_process.h> 81 #include <dev/usb/usb_util.h> 82 83 #include <dev/usb/usb_controller.h> 84 #include <dev/usb/usb_bus.h> 85 #include <dev/usb/usb_pci.h> 86 #include <dev/usb/controller/ehci.h> 87 88 #define PCI_EHCI_VENDORID_ACERLABS 0x10b9 89 #define PCI_EHCI_VENDORID_AMD 0x1022 90 #define PCI_EHCI_VENDORID_APPLE 0x106b 91 #define PCI_EHCI_VENDORID_ATI 0x1002 92 #define PCI_EHCI_VENDORID_CMDTECH 0x1095 93 #define PCI_EHCI_VENDORID_INTEL 0x8086 94 #define PCI_EHCI_VENDORID_NEC 0x1033 95 #define PCI_EHCI_VENDORID_OPTI 0x1045 96 #define PCI_EHCI_VENDORID_PHILIPS 0x1131 97 #define PCI_EHCI_VENDORID_SIS 0x1039 98 #define PCI_EHCI_VENDORID_NVIDIA 0x12D2 99 #define PCI_EHCI_VENDORID_NVIDIA2 0x10DE 100 #define PCI_EHCI_VENDORID_VIA 0x1106 101 102 #define PCI_EHCI_BASE_REG 0x10 103 104 static void ehci_pci_takecontroller(device_t self); 105 106 static device_probe_t ehci_pci_probe; 107 static device_attach_t ehci_pci_attach; 108 static device_detach_t ehci_pci_detach; 109 static device_suspend_t ehci_pci_suspend; 110 static device_resume_t ehci_pci_resume; 111 static device_shutdown_t ehci_pci_shutdown; 112 113 static int 114 ehci_pci_suspend(device_t self) 115 { 116 ehci_softc_t *sc = device_get_softc(self); 117 int err; 118 119 err = bus_generic_suspend(self); 120 if (err) 121 return (err); 122 ehci_suspend(sc); 123 return (0); 124 } 125 126 static int 127 ehci_pci_resume(device_t self) 128 { 129 ehci_softc_t *sc = device_get_softc(self); 130 131 ehci_pci_takecontroller(self); 132 ehci_resume(sc); 133 134 bus_generic_resume(self); 135 136 return (0); 137 } 138 139 static int 140 ehci_pci_shutdown(device_t self) 141 { 142 ehci_softc_t *sc = device_get_softc(self); 143 int err; 144 145 err = bus_generic_shutdown(self); 146 if (err) 147 return (err); 148 ehci_shutdown(sc); 149 150 return (0); 151 } 152 153 static const char * 154 ehci_pci_match(device_t self) 155 { 156 uint32_t device_id = pci_get_devid(self); 157 158 switch (device_id) { 159 case 0x268c8086: 160 return ("Intel 63XXESB USB 2.0 controller"); 161 162 case 0x523910b9: 163 return "ALi M5239 USB 2.0 controller"; 164 165 case 0x10227463: 166 return "AMD 8111 USB 2.0 controller"; 167 168 case 0x20951022: 169 return ("AMD CS5536 (Geode) USB 2.0 controller"); 170 171 case 0x43451002: 172 return "ATI SB200 USB 2.0 controller"; 173 case 0x43731002: 174 return "ATI SB400 USB 2.0 controller"; 175 176 case 0x25ad8086: 177 return "Intel 6300ESB USB 2.0 controller"; 178 case 0x24cd8086: 179 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller"; 180 case 0x24dd8086: 181 return "Intel 82801EB/R (ICH5) USB 2.0 controller"; 182 case 0x265c8086: 183 return "Intel 82801FB (ICH6) USB 2.0 controller"; 184 case 0x27cc8086: 185 return "Intel 82801GB/R (ICH7) USB 2.0 controller"; 186 187 case 0x28368086: 188 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A"; 189 case 0x283a8086: 190 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B"; 191 case 0x293a8086: 192 return "Intel 82801I (ICH9) USB 2.0 controller"; 193 case 0x293c8086: 194 return "Intel 82801I (ICH9) USB 2.0 controller"; 195 196 case 0x00e01033: 197 return ("NEC uPD 720100 USB 2.0 controller"); 198 199 case 0x006810de: 200 return "NVIDIA nForce2 USB 2.0 controller"; 201 case 0x008810de: 202 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller"; 203 case 0x00d810de: 204 return "NVIDIA nForce3 USB 2.0 controller"; 205 case 0x00e810de: 206 return "NVIDIA nForce3 250 USB 2.0 controller"; 207 case 0x005b10de: 208 return "NVIDIA nForce4 USB 2.0 controller"; 209 210 case 0x15621131: 211 return "Philips ISP156x USB 2.0 controller"; 212 213 case 0x31041106: 214 return ("VIA VT6202 USB 2.0 controller"); 215 216 default: 217 break; 218 } 219 220 if ((pci_get_class(self) == PCIC_SERIALBUS) 221 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 222 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) { 223 return ("EHCI (generic) USB 2.0 controller"); 224 } 225 return (NULL); /* dunno */ 226 } 227 228 static int 229 ehci_pci_probe(device_t self) 230 { 231 const char *desc = ehci_pci_match(self); 232 233 if (desc) { 234 device_set_desc(self, desc); 235 return (0); 236 } else { 237 return (ENXIO); 238 } 239 } 240 241 static int 242 ehci_pci_attach(device_t self) 243 { 244 ehci_softc_t *sc = device_get_softc(self); 245 int err; 246 int rid; 247 248 /* initialise some bus fields */ 249 sc->sc_bus.parent = self; 250 sc->sc_bus.devices = sc->sc_devices; 251 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 252 253 /* get all DMA memory */ 254 if (usb_bus_mem_alloc_all(&sc->sc_bus, 255 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) { 256 return (ENOMEM); 257 } 258 259 pci_enable_busmaster(self); 260 261 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 262 case PCI_USB_REV_PRE_1_0: 263 case PCI_USB_REV_1_0: 264 case PCI_USB_REV_1_1: 265 /* 266 * NOTE: some EHCI USB controllers have the wrong USB 267 * revision number. It appears those controllers are 268 * fully compliant so we just ignore this value in 269 * some common cases. 270 */ 271 device_printf(self, "pre-2.0 USB revision (ignored)\n"); 272 /* fallthrough */ 273 case PCI_USB_REV_2_0: 274 sc->sc_bus.usbrev = USB_REV_2_0; 275 break; 276 default: 277 /* Quirk for Parallels Desktop 4.0 */ 278 device_printf(self, "USB revision is unknown. Assuming v2.0.\n"); 279 sc->sc_bus.usbrev = USB_REV_2_0; 280 break; 281 } 282 283 rid = PCI_CBMEM; 284 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, 285 RF_ACTIVE); 286 if (!sc->sc_io_res) { 287 device_printf(self, "Could not map memory\n"); 288 goto error; 289 } 290 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 291 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 292 sc->sc_io_size = rman_get_size(sc->sc_io_res); 293 294 rid = 0; 295 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 296 RF_SHAREABLE | RF_ACTIVE); 297 if (sc->sc_irq_res == NULL) { 298 device_printf(self, "Could not allocate irq\n"); 299 goto error; 300 } 301 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 302 if (!sc->sc_bus.bdev) { 303 device_printf(self, "Could not add USB device\n"); 304 goto error; 305 } 306 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 307 308 /* 309 * ehci_pci_match will never return NULL if ehci_pci_probe 310 * succeeded 311 */ 312 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self)); 313 switch (pci_get_vendor(self)) { 314 case PCI_EHCI_VENDORID_ACERLABS: 315 sprintf(sc->sc_vendor, "AcerLabs"); 316 break; 317 case PCI_EHCI_VENDORID_AMD: 318 sprintf(sc->sc_vendor, "AMD"); 319 break; 320 case PCI_EHCI_VENDORID_APPLE: 321 sprintf(sc->sc_vendor, "Apple"); 322 break; 323 case PCI_EHCI_VENDORID_ATI: 324 sprintf(sc->sc_vendor, "ATI"); 325 break; 326 case PCI_EHCI_VENDORID_CMDTECH: 327 sprintf(sc->sc_vendor, "CMDTECH"); 328 break; 329 case PCI_EHCI_VENDORID_INTEL: 330 sprintf(sc->sc_vendor, "Intel"); 331 break; 332 case PCI_EHCI_VENDORID_NEC: 333 sprintf(sc->sc_vendor, "NEC"); 334 break; 335 case PCI_EHCI_VENDORID_OPTI: 336 sprintf(sc->sc_vendor, "OPTi"); 337 break; 338 case PCI_EHCI_VENDORID_PHILIPS: 339 sprintf(sc->sc_vendor, "Philips"); 340 break; 341 case PCI_EHCI_VENDORID_SIS: 342 sprintf(sc->sc_vendor, "SiS"); 343 break; 344 case PCI_EHCI_VENDORID_NVIDIA: 345 case PCI_EHCI_VENDORID_NVIDIA2: 346 sprintf(sc->sc_vendor, "nVidia"); 347 break; 348 case PCI_EHCI_VENDORID_VIA: 349 sprintf(sc->sc_vendor, "VIA"); 350 break; 351 default: 352 if (bootverbose) 353 device_printf(self, "(New EHCI DeviceId=0x%08x)\n", 354 pci_get_devid(self)); 355 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 356 } 357 358 #if (__FreeBSD_version >= 700031) 359 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 360 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 361 #else 362 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 363 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl); 364 #endif 365 if (err) { 366 device_printf(self, "Could not setup irq, %d\n", err); 367 sc->sc_intr_hdl = NULL; 368 goto error; 369 } 370 ehci_pci_takecontroller(self); 371 err = ehci_init(sc); 372 if (!err) { 373 err = device_probe_and_attach(sc->sc_bus.bdev); 374 } 375 if (err) { 376 device_printf(self, "USB init failed err=%d\n", err); 377 goto error; 378 } 379 return (0); 380 381 error: 382 ehci_pci_detach(self); 383 return (ENXIO); 384 } 385 386 static int 387 ehci_pci_detach(device_t self) 388 { 389 ehci_softc_t *sc = device_get_softc(self); 390 device_t bdev; 391 392 if (sc->sc_bus.bdev) { 393 bdev = sc->sc_bus.bdev; 394 device_detach(bdev); 395 device_delete_child(self, bdev); 396 } 397 /* during module unload there are lots of children leftover */ 398 device_delete_all_children(self); 399 400 pci_disable_busmaster(self); 401 402 /* 403 * disable interrupts that might have been switched on in ehci_init 404 */ 405 if (sc->sc_io_res) { 406 EWRITE4(sc, EHCI_USBINTR, 0); 407 } 408 if (sc->sc_irq_res && sc->sc_intr_hdl) { 409 /* 410 * only call ehci_detach() after ehci_init() 411 */ 412 ehci_detach(sc); 413 414 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 415 416 if (err) 417 /* XXX or should we panic? */ 418 device_printf(self, "Could not tear down irq, %d\n", 419 err); 420 sc->sc_intr_hdl = NULL; 421 } 422 if (sc->sc_irq_res) { 423 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 424 sc->sc_irq_res = NULL; 425 } 426 if (sc->sc_io_res) { 427 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, 428 sc->sc_io_res); 429 sc->sc_io_res = NULL; 430 } 431 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 432 433 return (0); 434 } 435 436 static void 437 ehci_pci_takecontroller(device_t self) 438 { 439 ehci_softc_t *sc = device_get_softc(self); 440 uint32_t cparams; 441 uint32_t eec; 442 uint16_t to; 443 uint8_t eecp; 444 uint8_t bios_sem; 445 446 cparams = EREAD4(sc, EHCI_HCCPARAMS); 447 448 /* Synchronise with the BIOS if it owns the controller. */ 449 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0; 450 eecp = EHCI_EECP_NEXT(eec)) { 451 eec = pci_read_config(self, eecp, 4); 452 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) { 453 continue; 454 } 455 bios_sem = pci_read_config(self, eecp + 456 EHCI_LEGSUP_BIOS_SEM, 1); 457 if (bios_sem == 0) { 458 continue; 459 } 460 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 461 "to give up control\n"); 462 pci_write_config(self, eecp + 463 EHCI_LEGSUP_OS_SEM, 1, 1); 464 to = 500; 465 while (1) { 466 bios_sem = pci_read_config(self, eecp + 467 EHCI_LEGSUP_BIOS_SEM, 1); 468 if (bios_sem == 0) 469 break; 470 471 if (--to == 0) { 472 device_printf(sc->sc_bus.bdev, 473 "timed out waiting for BIOS\n"); 474 break; 475 } 476 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 477 } 478 } 479 } 480 481 static driver_t ehci_driver = 482 { 483 .name = "ehci", 484 .methods = (device_method_t[]){ 485 /* device interface */ 486 DEVMETHOD(device_probe, ehci_pci_probe), 487 DEVMETHOD(device_attach, ehci_pci_attach), 488 DEVMETHOD(device_detach, ehci_pci_detach), 489 DEVMETHOD(device_suspend, ehci_pci_suspend), 490 DEVMETHOD(device_resume, ehci_pci_resume), 491 DEVMETHOD(device_shutdown, ehci_pci_shutdown), 492 /* bus interface */ 493 DEVMETHOD(bus_print_child, bus_generic_print_child), 494 495 {0, 0} 496 }, 497 .size = sizeof(struct ehci_softc), 498 }; 499 500 static devclass_t ehci_devclass; 501 502 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0); 503 MODULE_DEPEND(ehci, usb, 1, 1, 1); 504