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