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