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 /* Universal Host Controller Interface 42 * 43 * UHCI spec: http://www.intel.com/ 44 */ 45 46 /* The low level controller code for UHCI has been split into 47 * PCI probes and UHCI specific code. This was done to facilitate the 48 * sharing of code between *BSD's 49 */ 50 51 #include <sys/stdint.h> 52 #include <sys/stddef.h> 53 #include <sys/param.h> 54 #include <sys/queue.h> 55 #include <sys/types.h> 56 #include <sys/systm.h> 57 #include <sys/kernel.h> 58 #include <sys/bus.h> 59 #include <sys/linker_set.h> 60 #include <sys/module.h> 61 #include <sys/lock.h> 62 #include <sys/mutex.h> 63 #include <sys/condvar.h> 64 #include <sys/sysctl.h> 65 #include <sys/sx.h> 66 #include <sys/unistd.h> 67 #include <sys/callout.h> 68 #include <sys/malloc.h> 69 #include <sys/priv.h> 70 71 #include <dev/usb/usb.h> 72 #include <dev/usb/usbdi.h> 73 74 #include <dev/usb/usb_core.h> 75 #include <dev/usb/usb_busdma.h> 76 #include <dev/usb/usb_process.h> 77 #include <dev/usb/usb_util.h> 78 #include <dev/usb/usb_debug.h> 79 80 #include <dev/usb/usb_controller.h> 81 #include <dev/usb/usb_bus.h> 82 #include <dev/usb/usb_pci.h> 83 #include <dev/usb/controller/uhci.h> 84 #include <dev/usb/controller/uhcireg.h> 85 86 #define PCI_UHCI_VENDORID_INTEL 0x8086 87 #define PCI_UHCI_VENDORID_VIA 0x1106 88 89 /* PIIX4E has no separate stepping */ 90 91 #define PCI_UHCI_BASE_REG 0x20 92 93 static device_probe_t uhci_pci_probe; 94 static device_attach_t uhci_pci_attach; 95 static device_detach_t uhci_pci_detach; 96 static device_suspend_t uhci_pci_suspend; 97 static device_resume_t uhci_pci_resume; 98 99 static int 100 uhci_pci_suspend(device_t self) 101 { 102 uhci_softc_t *sc = device_get_softc(self); 103 int err; 104 105 err = bus_generic_suspend(self); 106 if (err) { 107 return (err); 108 } 109 uhci_suspend(sc); 110 return (0); 111 } 112 113 static int 114 uhci_pci_resume(device_t self) 115 { 116 uhci_softc_t *sc = device_get_softc(self); 117 118 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 119 120 uhci_resume(sc); 121 122 bus_generic_resume(self); 123 return (0); 124 } 125 126 static const char * 127 uhci_pci_match(device_t self) 128 { 129 uint32_t device_id = pci_get_devid(self); 130 131 switch (device_id) { 132 case 0x26888086: 133 return ("Intel 631XESB/632XESB/3100 USB controller USB-1"); 134 135 case 0x26898086: 136 return ("Intel 631XESB/632XESB/3100 USB controller USB-2"); 137 138 case 0x268a8086: 139 return ("Intel 631XESB/632XESB/3100 USB controller USB-3"); 140 141 case 0x268b8086: 142 return ("Intel 631XESB/632XESB/3100 USB controller USB-4"); 143 144 case 0x70208086: 145 return ("Intel 82371SB (PIIX3) USB controller"); 146 147 case 0x71128086: 148 return ("Intel 82371AB/EB (PIIX4) USB controller"); 149 150 case 0x24128086: 151 return ("Intel 82801AA (ICH) USB controller"); 152 153 case 0x24228086: 154 return ("Intel 82801AB (ICH0) USB controller"); 155 156 case 0x24428086: 157 return ("Intel 82801BA/BAM (ICH2) USB controller USB-A"); 158 159 case 0x24448086: 160 return ("Intel 82801BA/BAM (ICH2) USB controller USB-B"); 161 162 case 0x24828086: 163 return ("Intel 82801CA/CAM (ICH3) USB controller USB-A"); 164 165 case 0x24848086: 166 return ("Intel 82801CA/CAM (ICH3) USB controller USB-B"); 167 168 case 0x24878086: 169 return ("Intel 82801CA/CAM (ICH3) USB controller USB-C"); 170 171 case 0x24c28086: 172 return ("Intel 82801DB (ICH4) USB controller USB-A"); 173 174 case 0x24c48086: 175 return ("Intel 82801DB (ICH4) USB controller USB-B"); 176 177 case 0x24c78086: 178 return ("Intel 82801DB (ICH4) USB controller USB-C"); 179 180 case 0x24d28086: 181 return ("Intel 82801EB (ICH5) USB controller USB-A"); 182 183 case 0x24d48086: 184 return ("Intel 82801EB (ICH5) USB controller USB-B"); 185 186 case 0x24d78086: 187 return ("Intel 82801EB (ICH5) USB controller USB-C"); 188 189 case 0x24de8086: 190 return ("Intel 82801EB (ICH5) USB controller USB-D"); 191 192 case 0x26588086: 193 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A"); 194 195 case 0x26598086: 196 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B"); 197 198 case 0x265a8086: 199 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C"); 200 201 case 0x265b8086: 202 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D"); 203 204 case 0x27c88086: 205 return ("Intel 82801G (ICH7) USB controller USB-A"); 206 case 0x27c98086: 207 return ("Intel 82801G (ICH7) USB controller USB-B"); 208 case 0x27ca8086: 209 return ("Intel 82801G (ICH7) USB controller USB-C"); 210 case 0x27cb8086: 211 return ("Intel 82801G (ICH7) USB controller USB-D"); 212 213 case 0x28308086: 214 return ("Intel 82801H (ICH8) USB controller USB-A"); 215 case 0x28318086: 216 return ("Intel 82801H (ICH8) USB controller USB-B"); 217 case 0x28328086: 218 return ("Intel 82801H (ICH8) USB controller USB-C"); 219 case 0x28348086: 220 return ("Intel 82801H (ICH8) USB controller USB-D"); 221 case 0x28358086: 222 return ("Intel 82801H (ICH8) USB controller USB-E"); 223 case 0x29348086: 224 return ("Intel 82801I (ICH9) USB controller"); 225 case 0x29358086: 226 return ("Intel 82801I (ICH9) USB controller"); 227 case 0x29368086: 228 return ("Intel 82801I (ICH9) USB controller"); 229 case 0x29378086: 230 return ("Intel 82801I (ICH9) USB controller"); 231 case 0x29388086: 232 return ("Intel 82801I (ICH9) USB controller"); 233 case 0x29398086: 234 return ("Intel 82801I (ICH9) USB controller"); 235 236 case 0x719a8086: 237 return ("Intel 82443MX USB controller"); 238 239 case 0x76028086: 240 return ("Intel 82372FB/82468GX USB controller"); 241 242 case 0x30381106: 243 return ("VIA 83C572 USB controller"); 244 245 default: 246 break; 247 } 248 249 if ((pci_get_class(self) == PCIC_SERIALBUS) && 250 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 251 (pci_get_progif(self) == PCI_INTERFACE_UHCI)) { 252 return ("UHCI (generic) USB controller"); 253 } 254 return (NULL); 255 } 256 257 static int 258 uhci_pci_probe(device_t self) 259 { 260 const char *desc = uhci_pci_match(self); 261 262 if (desc) { 263 device_set_desc(self, desc); 264 return (0); 265 } else { 266 return (ENXIO); 267 } 268 } 269 270 static int 271 uhci_pci_attach(device_t self) 272 { 273 uhci_softc_t *sc = device_get_softc(self); 274 int rid; 275 int err; 276 277 /* initialise some bus fields */ 278 sc->sc_bus.parent = self; 279 sc->sc_bus.devices = sc->sc_devices; 280 sc->sc_bus.devices_max = UHCI_MAX_DEVICES; 281 282 /* get all DMA memory */ 283 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 284 &uhci_iterate_hw_softc)) { 285 return ENOMEM; 286 } 287 sc->sc_dev = self; 288 289 pci_enable_busmaster(self); 290 291 rid = PCI_UHCI_BASE_REG; 292 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid, 293 RF_ACTIVE); 294 if (!sc->sc_io_res) { 295 device_printf(self, "Could not map ports\n"); 296 goto error; 297 } 298 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 299 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 300 sc->sc_io_size = rman_get_size(sc->sc_io_res); 301 302 /* disable interrupts */ 303 bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0); 304 305 rid = 0; 306 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 307 RF_SHAREABLE | RF_ACTIVE); 308 if (sc->sc_irq_res == NULL) { 309 device_printf(self, "Could not allocate irq\n"); 310 goto error; 311 } 312 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 313 if (!sc->sc_bus.bdev) { 314 device_printf(self, "Could not add USB device\n"); 315 goto error; 316 } 317 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 318 319 /* 320 * uhci_pci_match must never return NULL if uhci_pci_probe 321 * succeeded 322 */ 323 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self)); 324 switch (pci_get_vendor(self)) { 325 case PCI_UHCI_VENDORID_INTEL: 326 sprintf(sc->sc_vendor, "Intel"); 327 break; 328 case PCI_UHCI_VENDORID_VIA: 329 sprintf(sc->sc_vendor, "VIA"); 330 break; 331 default: 332 if (bootverbose) { 333 device_printf(self, "(New UHCI DeviceId=0x%08x)\n", 334 pci_get_devid(self)); 335 } 336 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 337 } 338 339 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 340 case PCI_USB_REV_PRE_1_0: 341 sc->sc_bus.usbrev = USB_REV_PRE_1_0; 342 break; 343 case PCI_USB_REV_1_0: 344 sc->sc_bus.usbrev = USB_REV_1_0; 345 break; 346 default: 347 /* Quirk for Parallels Desktop 4.0 */ 348 device_printf(self, "USB revision is unknown. Assuming v1.1.\n"); 349 sc->sc_bus.usbrev = USB_REV_1_1; 350 break; 351 } 352 353 #if (__FreeBSD_version >= 700031) 354 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 355 NULL, (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 356 #else 357 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 358 (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 359 #endif 360 361 if (err) { 362 device_printf(self, "Could not setup irq, %d\n", err); 363 sc->sc_intr_hdl = NULL; 364 goto error; 365 } 366 /* 367 * Set the PIRQD enable bit and switch off all the others. We don't 368 * want legacy support to interfere with us XXX Does this also mean 369 * that the BIOS won't touch the keyboard anymore if it is connected 370 * to the ports of the root hub? 371 */ 372 #ifdef USB_DEBUG 373 if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) { 374 device_printf(self, "LegSup = 0x%04x\n", 375 pci_read_config(self, PCI_LEGSUP, 2)); 376 } 377 #endif 378 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 379 380 err = uhci_init(sc); 381 if (!err) { 382 err = device_probe_and_attach(sc->sc_bus.bdev); 383 } 384 if (err) { 385 device_printf(self, "USB init failed\n"); 386 goto error; 387 } 388 return (0); 389 390 error: 391 uhci_pci_detach(self); 392 return (ENXIO); 393 } 394 395 int 396 uhci_pci_detach(device_t self) 397 { 398 uhci_softc_t *sc = device_get_softc(self); 399 device_t bdev; 400 401 if (sc->sc_bus.bdev) { 402 bdev = sc->sc_bus.bdev; 403 device_detach(bdev); 404 device_delete_child(self, bdev); 405 } 406 /* during module unload there are lots of children leftover */ 407 device_delete_all_children(self); 408 409 /* 410 * disable interrupts that might have been switched on in 411 * uhci_init. 412 */ 413 if (sc->sc_io_res) { 414 USB_BUS_LOCK(&sc->sc_bus); 415 416 /* stop the controller */ 417 uhci_reset(sc); 418 419 USB_BUS_UNLOCK(&sc->sc_bus); 420 } 421 pci_disable_busmaster(self); 422 423 if (sc->sc_irq_res && sc->sc_intr_hdl) { 424 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 425 426 if (err) { 427 /* XXX or should we panic? */ 428 device_printf(self, "Could not tear down irq, %d\n", 429 err); 430 } 431 sc->sc_intr_hdl = NULL; 432 } 433 if (sc->sc_irq_res) { 434 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 435 sc->sc_irq_res = NULL; 436 } 437 if (sc->sc_io_res) { 438 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG, 439 sc->sc_io_res); 440 sc->sc_io_res = NULL; 441 } 442 usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc); 443 444 return (0); 445 } 446 447 static driver_t uhci_driver = 448 { 449 .name = "uhci", 450 .methods = (device_method_t[]){ 451 /* device interface */ 452 DEVMETHOD(device_probe, uhci_pci_probe), 453 DEVMETHOD(device_attach, uhci_pci_attach), 454 DEVMETHOD(device_detach, uhci_pci_detach), 455 456 DEVMETHOD(device_suspend, uhci_pci_suspend), 457 DEVMETHOD(device_resume, uhci_pci_resume), 458 DEVMETHOD(device_shutdown, bus_generic_shutdown), 459 460 /* Bus interface */ 461 DEVMETHOD(bus_print_child, bus_generic_print_child), 462 {0, 0} 463 }, 464 .size = sizeof(struct uhci_softc), 465 }; 466 467 static devclass_t uhci_devclass; 468 469 DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0); 470 MODULE_DEPEND(uhci, usb, 1, 1, 1); 471