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