ehci_pci.c revision 200305
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: head/sys/dev/usb/controller/ehci_pci.c 200305 2009-12-09 20:17:22Z thompsa $"); 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#include <dev/usb/controller/ehcireg.h> 88 89#define PCI_EHCI_VENDORID_ACERLABS 0x10b9 90#define PCI_EHCI_VENDORID_AMD 0x1022 91#define PCI_EHCI_VENDORID_APPLE 0x106b 92#define PCI_EHCI_VENDORID_ATI 0x1002 93#define PCI_EHCI_VENDORID_CMDTECH 0x1095 94#define PCI_EHCI_VENDORID_INTEL 0x8086 95#define PCI_EHCI_VENDORID_NEC 0x1033 96#define PCI_EHCI_VENDORID_OPTI 0x1045 97#define PCI_EHCI_VENDORID_PHILIPS 0x1131 98#define PCI_EHCI_VENDORID_SIS 0x1039 99#define PCI_EHCI_VENDORID_NVIDIA 0x12D2 100#define PCI_EHCI_VENDORID_NVIDIA2 0x10DE 101#define PCI_EHCI_VENDORID_VIA 0x1106 102 103#define PCI_EHCI_BASE_REG 0x10 104 105static void ehci_pci_takecontroller(device_t self); 106 107static device_probe_t ehci_pci_probe; 108static device_attach_t ehci_pci_attach; 109static device_detach_t ehci_pci_detach; 110static device_suspend_t ehci_pci_suspend; 111static device_resume_t ehci_pci_resume; 112static device_shutdown_t ehci_pci_shutdown; 113 114static int 115ehci_pci_suspend(device_t self) 116{ 117 ehci_softc_t *sc = device_get_softc(self); 118 int err; 119 120 err = bus_generic_suspend(self); 121 if (err) 122 return (err); 123 ehci_suspend(sc); 124 return (0); 125} 126 127static int 128ehci_pci_resume(device_t self) 129{ 130 ehci_softc_t *sc = device_get_softc(self); 131 132 ehci_pci_takecontroller(self); 133 ehci_resume(sc); 134 135 bus_generic_resume(self); 136 137 return (0); 138} 139 140static int 141ehci_pci_shutdown(device_t self) 142{ 143 ehci_softc_t *sc = device_get_softc(self); 144 int err; 145 146 err = bus_generic_shutdown(self); 147 if (err) 148 return (err); 149 ehci_shutdown(sc); 150 151 return (0); 152} 153 154static const char * 155ehci_pci_match(device_t self) 156{ 157 uint32_t device_id = pci_get_devid(self); 158 159 switch (device_id) { 160 case 0x268c8086: 161 return ("Intel 63XXESB USB 2.0 controller"); 162 163 case 0x523910b9: 164 return "ALi M5239 USB 2.0 controller"; 165 166 case 0x10227463: 167 return "AMD 8111 USB 2.0 controller"; 168 169 case 0x20951022: 170 return ("AMD CS5536 (Geode) USB 2.0 controller"); 171 172 case 0x43451002: 173 return "ATI SB200 USB 2.0 controller"; 174 case 0x43731002: 175 return "ATI SB400 USB 2.0 controller"; 176 177 case 0x25ad8086: 178 return "Intel 6300ESB USB 2.0 controller"; 179 case 0x24cd8086: 180 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller"; 181 case 0x24dd8086: 182 return "Intel 82801EB/R (ICH5) USB 2.0 controller"; 183 case 0x265c8086: 184 return "Intel 82801FB (ICH6) USB 2.0 controller"; 185 case 0x27cc8086: 186 return "Intel 82801GB/R (ICH7) USB 2.0 controller"; 187 188 case 0x28368086: 189 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A"; 190 case 0x283a8086: 191 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B"; 192 case 0x293a8086: 193 return "Intel 82801I (ICH9) USB 2.0 controller"; 194 case 0x293c8086: 195 return "Intel 82801I (ICH9) USB 2.0 controller"; 196 case 0x3a3a8086: 197 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A"; 198 case 0x3a3c8086: 199 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B"; 200 201 case 0x00e01033: 202 return ("NEC uPD 720100 USB 2.0 controller"); 203 204 case 0x006810de: 205 return "NVIDIA nForce2 USB 2.0 controller"; 206 case 0x008810de: 207 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller"; 208 case 0x00d810de: 209 return "NVIDIA nForce3 USB 2.0 controller"; 210 case 0x00e810de: 211 return "NVIDIA nForce3 250 USB 2.0 controller"; 212 case 0x005b10de: 213 return "NVIDIA nForce4 USB 2.0 controller"; 214 case 0x03f210de: 215 return "NVIDIA nForce MCP61 USB 2.0 controller"; 216 217 case 0x15621131: 218 return "Philips ISP156x USB 2.0 controller"; 219 220 case 0x31041106: 221 return ("VIA VT6202 USB 2.0 controller"); 222 223 default: 224 break; 225 } 226 227 if ((pci_get_class(self) == PCIC_SERIALBUS) 228 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB) 229 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) { 230 return ("EHCI (generic) USB 2.0 controller"); 231 } 232 return (NULL); /* dunno */ 233} 234 235static int 236ehci_pci_probe(device_t self) 237{ 238 const char *desc = ehci_pci_match(self); 239 240 if (desc) { 241 device_set_desc(self, desc); 242 return (0); 243 } else { 244 return (ENXIO); 245 } 246} 247 248static void 249ehci_pci_ati_quirk(device_t self, uint8_t is_sb700) 250{ 251 device_t smbdev; 252 uint32_t val; 253 254 if (is_sb700) { 255 /* Lookup SMBUS PCI device */ 256 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385); 257 if (smbdev == NULL) 258 return; 259 val = pci_get_revid(smbdev); 260 if (val != 0x3a && val != 0x3b) 261 return; 262 } 263 264 /* 265 * Note: this bit is described as reserved in SB700 266 * Register Reference Guide. 267 */ 268 val = pci_read_config(self, 0x53, 1); 269 if (!(val & 0x8)) { 270 val |= 0x8; 271 pci_write_config(self, 0x53, val, 1); 272 device_printf(self, "AMD SB600/700 quirk applied\n"); 273 } 274} 275 276static void 277ehci_pci_via_quirk(device_t self) 278{ 279 uint32_t val; 280 281 if ((pci_get_device(self) == 0x3104) && 282 ((pci_get_revid(self) & 0xf0) == 0x60)) { 283 /* Correct schedule sleep time to 10us */ 284 val = pci_read_config(self, 0x4b, 1); 285 if (val & 0x20) 286 return; 287 pci_write_config(self, 0x4b, val, 1); 288 device_printf(self, "VIA-quirk applied\n"); 289 } 290} 291 292static int 293ehci_pci_attach(device_t self) 294{ 295 ehci_softc_t *sc = device_get_softc(self); 296 int err; 297 int rid; 298 299 /* initialise some bus fields */ 300 sc->sc_bus.parent = self; 301 sc->sc_bus.devices = sc->sc_devices; 302 sc->sc_bus.devices_max = EHCI_MAX_DEVICES; 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_takecontroller(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 err = ehci_init(sc); 460 if (!err) { 461 err = device_probe_and_attach(sc->sc_bus.bdev); 462 } 463 if (err) { 464 device_printf(self, "USB init failed err=%d\n", err); 465 goto error; 466 } 467 return (0); 468 469error: 470 ehci_pci_detach(self); 471 return (ENXIO); 472} 473 474static int 475ehci_pci_detach(device_t self) 476{ 477 ehci_softc_t *sc = device_get_softc(self); 478 device_t bdev; 479 480 if (sc->sc_bus.bdev) { 481 bdev = sc->sc_bus.bdev; 482 device_detach(bdev); 483 device_delete_child(self, bdev); 484 } 485 /* during module unload there are lots of children leftover */ 486 device_delete_all_children(self); 487 488 pci_disable_busmaster(self); 489 490 /* 491 * disable interrupts that might have been switched on in ehci_init 492 */ 493 if (sc->sc_io_res) { 494 EWRITE4(sc, EHCI_USBINTR, 0); 495 } 496 if (sc->sc_irq_res && sc->sc_intr_hdl) { 497 /* 498 * only call ehci_detach() after ehci_init() 499 */ 500 ehci_detach(sc); 501 502 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 503 504 if (err) 505 /* XXX or should we panic? */ 506 device_printf(self, "Could not tear down irq, %d\n", 507 err); 508 sc->sc_intr_hdl = NULL; 509 } 510 if (sc->sc_irq_res) { 511 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 512 sc->sc_irq_res = NULL; 513 } 514 if (sc->sc_io_res) { 515 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, 516 sc->sc_io_res); 517 sc->sc_io_res = NULL; 518 } 519 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc); 520 521 return (0); 522} 523 524static void 525ehci_pci_takecontroller(device_t self) 526{ 527 ehci_softc_t *sc = device_get_softc(self); 528 uint32_t cparams; 529 uint32_t eec; 530 uint16_t to; 531 uint8_t eecp; 532 uint8_t bios_sem; 533 534 cparams = EREAD4(sc, EHCI_HCCPARAMS); 535 536 /* Synchronise with the BIOS if it owns the controller. */ 537 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0; 538 eecp = EHCI_EECP_NEXT(eec)) { 539 eec = pci_read_config(self, eecp, 4); 540 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) { 541 continue; 542 } 543 bios_sem = pci_read_config(self, eecp + 544 EHCI_LEGSUP_BIOS_SEM, 1); 545 if (bios_sem == 0) { 546 continue; 547 } 548 device_printf(sc->sc_bus.bdev, "waiting for BIOS " 549 "to give up control\n"); 550 pci_write_config(self, eecp + 551 EHCI_LEGSUP_OS_SEM, 1, 1); 552 to = 500; 553 while (1) { 554 bios_sem = pci_read_config(self, eecp + 555 EHCI_LEGSUP_BIOS_SEM, 1); 556 if (bios_sem == 0) 557 break; 558 559 if (--to == 0) { 560 device_printf(sc->sc_bus.bdev, 561 "timed out waiting for BIOS\n"); 562 break; 563 } 564 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */ 565 } 566 } 567} 568 569static driver_t ehci_driver = 570{ 571 .name = "ehci", 572 .methods = (device_method_t[]){ 573 /* device interface */ 574 DEVMETHOD(device_probe, ehci_pci_probe), 575 DEVMETHOD(device_attach, ehci_pci_attach), 576 DEVMETHOD(device_detach, ehci_pci_detach), 577 DEVMETHOD(device_suspend, ehci_pci_suspend), 578 DEVMETHOD(device_resume, ehci_pci_resume), 579 DEVMETHOD(device_shutdown, ehci_pci_shutdown), 580 /* bus interface */ 581 DEVMETHOD(bus_print_child, bus_generic_print_child), 582 583 {0, 0} 584 }, 585 .size = sizeof(struct ehci_softc), 586}; 587 588static devclass_t ehci_devclass; 589 590DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0); 591MODULE_DEPEND(ehci, usb, 1, 1, 1); 592