1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 1998 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * This code is derived from software contributed to The NetBSD Foundation 8 * by Lennart Augustsson (augustss@carlstedt.se) at 9 * Carlstedt Research & Technology. 10 * 11 * Redistribution and use in source and binary forms, with or without 12 * modification, are permitted provided that the following conditions 13 * are met: 14 * 1. Redistributions of source code must retain the above copyright 15 * notice, this list of conditions and the following disclaimer. 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in the 18 * documentation and/or other materials provided with the distribution. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 30 * POSSIBILITY OF SUCH DAMAGE. 31 */ 32 33 #include <sys/cdefs.h> 34 __FBSDID("$FreeBSD$"); 35 36 /* Universal Host Controller Interface 37 * 38 * UHCI spec: http://www.intel.com/ 39 */ 40 41 /* The low level controller code for UHCI has been split into 42 * PCI probes and UHCI specific code. This was done to facilitate the 43 * sharing of code between *BSD's 44 */ 45 46 #include <sys/stdint.h> 47 #include <sys/stddef.h> 48 #include <sys/param.h> 49 #include <sys/queue.h> 50 #include <sys/types.h> 51 #include <sys/systm.h> 52 #include <sys/kernel.h> 53 #include <sys/bus.h> 54 #include <sys/module.h> 55 #include <sys/lock.h> 56 #include <sys/mutex.h> 57 #include <sys/condvar.h> 58 #include <sys/sysctl.h> 59 #include <sys/sx.h> 60 #include <sys/unistd.h> 61 #include <sys/callout.h> 62 #include <sys/malloc.h> 63 #include <sys/priv.h> 64 65 #include <dev/usb/usb.h> 66 #include <dev/usb/usbdi.h> 67 68 #include <dev/usb/usb_core.h> 69 #include <dev/usb/usb_busdma.h> 70 #include <dev/usb/usb_process.h> 71 #include <dev/usb/usb_util.h> 72 #include <dev/usb/usb_debug.h> 73 74 #include <dev/usb/usb_controller.h> 75 #include <dev/usb/usb_bus.h> 76 #include <dev/usb/usb_pci.h> 77 #include <dev/usb/controller/uhci.h> 78 #include <dev/usb/controller/uhcireg.h> 79 #include "usb_if.h" 80 81 #define PCI_UHCI_VENDORID_INTEL 0x8086 82 #define PCI_UHCI_VENDORID_HP 0x103c 83 #define PCI_UHCI_VENDORID_VIA 0x1106 84 85 /* PIIX4E has no separate stepping */ 86 87 static device_probe_t uhci_pci_probe; 88 static device_attach_t uhci_pci_attach; 89 static device_detach_t uhci_pci_detach; 90 static usb_take_controller_t uhci_pci_take_controller; 91 92 static int 93 uhci_pci_take_controller(device_t self) 94 { 95 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 96 97 return (0); 98 } 99 100 static const char * 101 uhci_pci_match(device_t self) 102 { 103 uint32_t device_id = pci_get_devid(self); 104 105 switch (device_id) { 106 case 0x26888086: 107 return ("Intel 631XESB/632XESB/3100 USB controller USB-1"); 108 109 case 0x26898086: 110 return ("Intel 631XESB/632XESB/3100 USB controller USB-2"); 111 112 case 0x268a8086: 113 return ("Intel 631XESB/632XESB/3100 USB controller USB-3"); 114 115 case 0x268b8086: 116 return ("Intel 631XESB/632XESB/3100 USB controller USB-4"); 117 118 case 0x70208086: 119 return ("Intel 82371SB (PIIX3) USB controller"); 120 121 case 0x71128086: 122 return ("Intel 82371AB/EB (PIIX4) USB controller"); 123 124 case 0x24128086: 125 return ("Intel 82801AA (ICH) USB controller"); 126 127 case 0x24228086: 128 return ("Intel 82801AB (ICH0) USB controller"); 129 130 case 0x24428086: 131 return ("Intel 82801BA/BAM (ICH2) USB controller USB-A"); 132 133 case 0x24448086: 134 return ("Intel 82801BA/BAM (ICH2) USB controller USB-B"); 135 136 case 0x24828086: 137 return ("Intel 82801CA/CAM (ICH3) USB controller USB-A"); 138 139 case 0x24848086: 140 return ("Intel 82801CA/CAM (ICH3) USB controller USB-B"); 141 142 case 0x24878086: 143 return ("Intel 82801CA/CAM (ICH3) USB controller USB-C"); 144 145 case 0x24c28086: 146 return ("Intel 82801DB (ICH4) USB controller USB-A"); 147 148 case 0x24c48086: 149 return ("Intel 82801DB (ICH4) USB controller USB-B"); 150 151 case 0x24c78086: 152 return ("Intel 82801DB (ICH4) USB controller USB-C"); 153 154 case 0x24d28086: 155 return ("Intel 82801EB (ICH5) USB controller USB-A"); 156 157 case 0x24d48086: 158 return ("Intel 82801EB (ICH5) USB controller USB-B"); 159 160 case 0x24d78086: 161 return ("Intel 82801EB (ICH5) USB controller USB-C"); 162 163 case 0x24de8086: 164 return ("Intel 82801EB (ICH5) USB controller USB-D"); 165 166 case 0x25a98086: 167 return ("Intel 6300ESB USB controller USB-A"); 168 169 case 0x25aa8086: 170 return ("Intel 6300ESB USB controller USB-B"); 171 172 case 0x26588086: 173 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A"); 174 175 case 0x26598086: 176 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B"); 177 178 case 0x265a8086: 179 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C"); 180 181 case 0x265b8086: 182 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D"); 183 184 case 0x27c88086: 185 return ("Intel 82801G (ICH7) USB controller USB-A"); 186 case 0x27c98086: 187 return ("Intel 82801G (ICH7) USB controller USB-B"); 188 case 0x27ca8086: 189 return ("Intel 82801G (ICH7) USB controller USB-C"); 190 case 0x27cb8086: 191 return ("Intel 82801G (ICH7) USB controller USB-D"); 192 193 case 0x28308086: 194 return ("Intel 82801H (ICH8) USB controller USB-A"); 195 case 0x28318086: 196 return ("Intel 82801H (ICH8) USB controller USB-B"); 197 case 0x28328086: 198 return ("Intel 82801H (ICH8) USB controller USB-C"); 199 case 0x28348086: 200 return ("Intel 82801H (ICH8) USB controller USB-D"); 201 case 0x28358086: 202 return ("Intel 82801H (ICH8) USB controller USB-E"); 203 case 0x29348086: 204 return ("Intel 82801I (ICH9) USB controller"); 205 case 0x29358086: 206 return ("Intel 82801I (ICH9) USB controller"); 207 case 0x29368086: 208 return ("Intel 82801I (ICH9) USB controller"); 209 case 0x29378086: 210 return ("Intel 82801I (ICH9) USB controller"); 211 case 0x29388086: 212 return ("Intel 82801I (ICH9) USB controller"); 213 case 0x29398086: 214 return ("Intel 82801I (ICH9) USB controller"); 215 case 0x3a348086: 216 return ("Intel 82801JI (ICH10) USB controller USB-A"); 217 case 0x3a358086: 218 return ("Intel 82801JI (ICH10) USB controller USB-B"); 219 case 0x3a368086: 220 return ("Intel 82801JI (ICH10) USB controller USB-C"); 221 case 0x3a378086: 222 return ("Intel 82801JI (ICH10) USB controller USB-D"); 223 case 0x3a388086: 224 return ("Intel 82801JI (ICH10) USB controller USB-E"); 225 case 0x3a398086: 226 return ("Intel 82801JI (ICH10) USB controller USB-F"); 227 228 case 0x719a8086: 229 return ("Intel 82443MX USB controller"); 230 231 case 0x76028086: 232 return ("Intel 82372FB/82468GX USB controller"); 233 234 case 0x3300103c: 235 return ("HP iLO Standard Virtual USB controller"); 236 237 case 0x30381106: 238 return ("VIA 83C572 USB controller"); 239 240 default: 241 break; 242 } 243 244 if ((pci_get_class(self) == PCIC_SERIALBUS) && 245 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 246 (pci_get_progif(self) == PCI_INTERFACE_UHCI)) { 247 return ("UHCI (generic) USB controller"); 248 } 249 return (NULL); 250 } 251 252 static int 253 uhci_pci_probe(device_t self) 254 { 255 const char *desc = uhci_pci_match(self); 256 257 if (desc) { 258 device_set_desc(self, desc); 259 return (BUS_PROBE_DEFAULT); 260 } else { 261 return (ENXIO); 262 } 263 } 264 265 static int 266 uhci_pci_attach(device_t self) 267 { 268 uhci_softc_t *sc = device_get_softc(self); 269 int rid; 270 int err; 271 272 /* initialise some bus fields */ 273 sc->sc_bus.parent = self; 274 sc->sc_bus.devices = sc->sc_devices; 275 sc->sc_bus.devices_max = UHCI_MAX_DEVICES; 276 sc->sc_bus.dma_bits = 32; 277 278 /* get all DMA memory */ 279 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 280 &uhci_iterate_hw_softc)) { 281 return ENOMEM; 282 } 283 sc->sc_dev = self; 284 285 pci_enable_busmaster(self); 286 287 rid = PCI_UHCI_BASE_REG; 288 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid, 289 RF_ACTIVE); 290 if (!sc->sc_io_res) { 291 device_printf(self, "Could not map ports\n"); 292 goto error; 293 } 294 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 295 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 296 sc->sc_io_size = rman_get_size(sc->sc_io_res); 297 298 /* disable interrupts */ 299 bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0); 300 301 rid = 0; 302 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 303 RF_SHAREABLE | RF_ACTIVE); 304 if (sc->sc_irq_res == NULL) { 305 device_printf(self, "Could not allocate irq\n"); 306 goto error; 307 } 308 sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 309 if (!sc->sc_bus.bdev) { 310 device_printf(self, "Could not add USB device\n"); 311 goto error; 312 } 313 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 314 315 /* 316 * uhci_pci_match must never return NULL if uhci_pci_probe 317 * succeeded 318 */ 319 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self)); 320 switch (pci_get_vendor(self)) { 321 case PCI_UHCI_VENDORID_INTEL: 322 sprintf(sc->sc_vendor, "Intel"); 323 break; 324 case PCI_UHCI_VENDORID_HP: 325 sprintf(sc->sc_vendor, "HP"); 326 break; 327 case PCI_UHCI_VENDORID_VIA: 328 sprintf(sc->sc_vendor, "VIA"); 329 break; 330 default: 331 if (bootverbose) { 332 device_printf(self, "(New UHCI DeviceId=0x%08x)\n", 333 pci_get_devid(self)); 334 } 335 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 336 } 337 338 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 339 case PCI_USB_REV_PRE_1_0: 340 sc->sc_bus.usbrev = USB_REV_PRE_1_0; 341 break; 342 case PCI_USB_REV_1_0: 343 sc->sc_bus.usbrev = USB_REV_1_0; 344 break; 345 default: 346 /* Quirk for Parallels Desktop 4.0 */ 347 device_printf(self, "USB revision is unknown. Assuming v1.1.\n"); 348 sc->sc_bus.usbrev = USB_REV_1_1; 349 break; 350 } 351 352 #if (__FreeBSD_version >= 700031) 353 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 354 NULL, (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 355 #else 356 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 357 (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 358 #endif 359 360 if (err) { 361 device_printf(self, "Could not setup irq, %d\n", err); 362 sc->sc_intr_hdl = NULL; 363 goto error; 364 } 365 /* 366 * Set the PIRQD enable bit and switch off all the others. We don't 367 * want legacy support to interfere with us XXX Does this also mean 368 * that the BIOS won't touch the keyboard anymore if it is connected 369 * to the ports of the root hub? 370 */ 371 #ifdef USB_DEBUG 372 if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) { 373 device_printf(self, "LegSup = 0x%04x\n", 374 pci_read_config(self, PCI_LEGSUP, 2)); 375 } 376 #endif 377 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 378 379 err = uhci_init(sc); 380 if (!err) { 381 err = device_probe_and_attach(sc->sc_bus.bdev); 382 } 383 if (err) { 384 device_printf(self, "USB init failed\n"); 385 goto error; 386 } 387 return (0); 388 389 error: 390 uhci_pci_detach(self); 391 return (ENXIO); 392 } 393 394 int 395 uhci_pci_detach(device_t self) 396 { 397 uhci_softc_t *sc = device_get_softc(self); 398 399 /* during module unload there are lots of children leftover */ 400 device_delete_children(self); 401 402 /* 403 * disable interrupts that might have been switched on in 404 * uhci_init. 405 */ 406 if (sc->sc_io_res) { 407 USB_BUS_LOCK(&sc->sc_bus); 408 409 /* stop the controller */ 410 uhci_reset(sc); 411 412 USB_BUS_UNLOCK(&sc->sc_bus); 413 } 414 pci_disable_busmaster(self); 415 416 if (sc->sc_irq_res && sc->sc_intr_hdl) { 417 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 418 419 if (err) { 420 /* XXX or should we panic? */ 421 device_printf(self, "Could not tear down irq, %d\n", 422 err); 423 } 424 sc->sc_intr_hdl = NULL; 425 } 426 if (sc->sc_irq_res) { 427 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 428 sc->sc_irq_res = NULL; 429 } 430 if (sc->sc_io_res) { 431 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG, 432 sc->sc_io_res); 433 sc->sc_io_res = NULL; 434 } 435 usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc); 436 437 return (0); 438 } 439 440 static device_method_t uhci_pci_methods[] = { 441 /* Device interface */ 442 DEVMETHOD(device_probe, uhci_pci_probe), 443 DEVMETHOD(device_attach, uhci_pci_attach), 444 DEVMETHOD(device_detach, uhci_pci_detach), 445 DEVMETHOD(device_suspend, bus_generic_suspend), 446 DEVMETHOD(device_resume, bus_generic_resume), 447 DEVMETHOD(device_shutdown, bus_generic_shutdown), 448 DEVMETHOD(usb_take_controller, uhci_pci_take_controller), 449 450 DEVMETHOD_END 451 }; 452 453 static driver_t uhci_driver = { 454 .name = "uhci", 455 .methods = uhci_pci_methods, 456 .size = sizeof(struct uhci_softc), 457 }; 458 459 static devclass_t uhci_devclass; 460 461 DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0); 462 MODULE_DEPEND(uhci, usb, 1, 1, 1); 463