1184610Salfred/*- 2184610Salfred * Copyright (c) 1998 The NetBSD Foundation, Inc. 3184610Salfred * All rights reserved. 4184610Salfred * 5184610Salfred * This code is derived from software contributed to The NetBSD Foundation 6184610Salfred * by Lennart Augustsson (augustss@carlstedt.se) at 7184610Salfred * Carlstedt Research & Technology. 8184610Salfred * 9184610Salfred * Redistribution and use in source and binary forms, with or without 10184610Salfred * modification, are permitted provided that the following conditions 11184610Salfred * are met: 12184610Salfred * 1. Redistributions of source code must retain the above copyright 13184610Salfred * notice, this list of conditions and the following disclaimer. 14184610Salfred * 2. Redistributions in binary form must reproduce the above copyright 15184610Salfred * notice, this list of conditions and the following disclaimer in the 16184610Salfred * documentation and/or other materials provided with the distribution. 17184610Salfred * 18184610Salfred * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19184610Salfred * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20184610Salfred * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21184610Salfred * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22184610Salfred * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23184610Salfred * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24184610Salfred * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25184610Salfred * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26184610Salfred * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27184610Salfred * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28184610Salfred * POSSIBILITY OF SUCH DAMAGE. 29184610Salfred */ 30184610Salfred 31184610Salfred#include <sys/cdefs.h> 32184610Salfred__FBSDID("$FreeBSD$"); 33184610Salfred 34184610Salfred/* Universal Host Controller Interface 35184610Salfred * 36184610Salfred * UHCI spec: http://www.intel.com/ 37184610Salfred */ 38184610Salfred 39184610Salfred/* The low level controller code for UHCI has been split into 40184610Salfred * PCI probes and UHCI specific code. This was done to facilitate the 41184610Salfred * sharing of code between *BSD's 42184610Salfred */ 43184610Salfred 44194677Sthompsa#include <sys/stdint.h> 45194677Sthompsa#include <sys/stddef.h> 46194677Sthompsa#include <sys/param.h> 47194677Sthompsa#include <sys/queue.h> 48194677Sthompsa#include <sys/types.h> 49194677Sthompsa#include <sys/systm.h> 50194677Sthompsa#include <sys/kernel.h> 51194677Sthompsa#include <sys/bus.h> 52194677Sthompsa#include <sys/module.h> 53194677Sthompsa#include <sys/lock.h> 54194677Sthompsa#include <sys/mutex.h> 55194677Sthompsa#include <sys/condvar.h> 56194677Sthompsa#include <sys/sysctl.h> 57194677Sthompsa#include <sys/sx.h> 58194677Sthompsa#include <sys/unistd.h> 59194677Sthompsa#include <sys/callout.h> 60194677Sthompsa#include <sys/malloc.h> 61194677Sthompsa#include <sys/priv.h> 62194677Sthompsa 63188942Sthompsa#include <dev/usb/usb.h> 64194677Sthompsa#include <dev/usb/usbdi.h> 65184610Salfred 66188942Sthompsa#include <dev/usb/usb_core.h> 67188942Sthompsa#include <dev/usb/usb_busdma.h> 68188942Sthompsa#include <dev/usb/usb_process.h> 69188942Sthompsa#include <dev/usb/usb_util.h> 70188942Sthompsa#include <dev/usb/usb_debug.h> 71184610Salfred 72188942Sthompsa#include <dev/usb/usb_controller.h> 73188942Sthompsa#include <dev/usb/usb_bus.h> 74188942Sthompsa#include <dev/usb/usb_pci.h> 75188942Sthompsa#include <dev/usb/controller/uhci.h> 76198151Sthompsa#include <dev/usb/controller/uhcireg.h> 77229096Shselasky#include "usb_if.h" 78184610Salfred 79184610Salfred#define PCI_UHCI_VENDORID_INTEL 0x8086 80184610Salfred#define PCI_UHCI_VENDORID_VIA 0x1106 81184610Salfred 82184610Salfred/* PIIX4E has no separate stepping */ 83184610Salfred 84184610Salfredstatic device_probe_t uhci_pci_probe; 85184610Salfredstatic device_attach_t uhci_pci_attach; 86184610Salfredstatic device_detach_t uhci_pci_detach; 87229096Shselaskystatic usb_take_controller_t uhci_pci_take_controller; 88184610Salfred 89184610Salfredstatic int 90229096Shselaskyuhci_pci_take_controller(device_t self) 91184610Salfred{ 92198501Sthompsa pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 93198501Sthompsa 94184610Salfred return (0); 95184610Salfred} 96184610Salfred 97184610Salfredstatic const char * 98184610Salfreduhci_pci_match(device_t self) 99184610Salfred{ 100184610Salfred uint32_t device_id = pci_get_devid(self); 101184610Salfred 102184610Salfred switch (device_id) { 103184610Salfred case 0x26888086: 104184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-1"); 105184610Salfred 106184610Salfred case 0x26898086: 107184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-2"); 108184610Salfred 109184610Salfred case 0x268a8086: 110184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-3"); 111184610Salfred 112184610Salfred case 0x268b8086: 113184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-4"); 114184610Salfred 115184610Salfred case 0x70208086: 116184610Salfred return ("Intel 82371SB (PIIX3) USB controller"); 117184610Salfred 118184610Salfred case 0x71128086: 119184610Salfred return ("Intel 82371AB/EB (PIIX4) USB controller"); 120184610Salfred 121184610Salfred case 0x24128086: 122184610Salfred return ("Intel 82801AA (ICH) USB controller"); 123184610Salfred 124184610Salfred case 0x24228086: 125184610Salfred return ("Intel 82801AB (ICH0) USB controller"); 126184610Salfred 127184610Salfred case 0x24428086: 128184610Salfred return ("Intel 82801BA/BAM (ICH2) USB controller USB-A"); 129184610Salfred 130184610Salfred case 0x24448086: 131184610Salfred return ("Intel 82801BA/BAM (ICH2) USB controller USB-B"); 132184610Salfred 133184610Salfred case 0x24828086: 134184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-A"); 135184610Salfred 136184610Salfred case 0x24848086: 137184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-B"); 138184610Salfred 139184610Salfred case 0x24878086: 140184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-C"); 141184610Salfred 142184610Salfred case 0x24c28086: 143184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-A"); 144184610Salfred 145184610Salfred case 0x24c48086: 146184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-B"); 147184610Salfred 148184610Salfred case 0x24c78086: 149184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-C"); 150184610Salfred 151184610Salfred case 0x24d28086: 152184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-A"); 153184610Salfred 154184610Salfred case 0x24d48086: 155184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-B"); 156184610Salfred 157184610Salfred case 0x24d78086: 158184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-C"); 159184610Salfred 160184610Salfred case 0x24de8086: 161184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-D"); 162184610Salfred 163184610Salfred case 0x26588086: 164184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A"); 165184610Salfred 166184610Salfred case 0x26598086: 167184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B"); 168184610Salfred 169184610Salfred case 0x265a8086: 170184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C"); 171184610Salfred 172184610Salfred case 0x265b8086: 173184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D"); 174184610Salfred 175195958Salfred case 0x27c88086: 176195958Salfred return ("Intel 82801G (ICH7) USB controller USB-A"); 177195958Salfred case 0x27c98086: 178195958Salfred return ("Intel 82801G (ICH7) USB controller USB-B"); 179195958Salfred case 0x27ca8086: 180195958Salfred return ("Intel 82801G (ICH7) USB controller USB-C"); 181195958Salfred case 0x27cb8086: 182195958Salfred return ("Intel 82801G (ICH7) USB controller USB-D"); 183195958Salfred 184184610Salfred case 0x28308086: 185184610Salfred return ("Intel 82801H (ICH8) USB controller USB-A"); 186184610Salfred case 0x28318086: 187184610Salfred return ("Intel 82801H (ICH8) USB controller USB-B"); 188184610Salfred case 0x28328086: 189184610Salfred return ("Intel 82801H (ICH8) USB controller USB-C"); 190184610Salfred case 0x28348086: 191184610Salfred return ("Intel 82801H (ICH8) USB controller USB-D"); 192184610Salfred case 0x28358086: 193184610Salfred return ("Intel 82801H (ICH8) USB controller USB-E"); 194184610Salfred case 0x29348086: 195184610Salfred return ("Intel 82801I (ICH9) USB controller"); 196184610Salfred case 0x29358086: 197184610Salfred return ("Intel 82801I (ICH9) USB controller"); 198184610Salfred case 0x29368086: 199184610Salfred return ("Intel 82801I (ICH9) USB controller"); 200184610Salfred case 0x29378086: 201184610Salfred return ("Intel 82801I (ICH9) USB controller"); 202184610Salfred case 0x29388086: 203184610Salfred return ("Intel 82801I (ICH9) USB controller"); 204184610Salfred case 0x29398086: 205184610Salfred return ("Intel 82801I (ICH9) USB controller"); 206200087Sthompsa case 0x3a348086: 207200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-A"); 208200087Sthompsa case 0x3a358086: 209200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-B"); 210200087Sthompsa case 0x3a368086: 211200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-C"); 212200087Sthompsa case 0x3a378086: 213200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-D"); 214200087Sthompsa case 0x3a388086: 215200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-E"); 216200087Sthompsa case 0x3a398086: 217200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-F"); 218184610Salfred 219184610Salfred case 0x719a8086: 220184610Salfred return ("Intel 82443MX USB controller"); 221184610Salfred 222184610Salfred case 0x76028086: 223184610Salfred return ("Intel 82372FB/82468GX USB controller"); 224184610Salfred 225184610Salfred case 0x30381106: 226184610Salfred return ("VIA 83C572 USB controller"); 227184610Salfred 228184610Salfred default: 229184610Salfred break; 230184610Salfred } 231184610Salfred 232184610Salfred if ((pci_get_class(self) == PCIC_SERIALBUS) && 233184610Salfred (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 234184610Salfred (pci_get_progif(self) == PCI_INTERFACE_UHCI)) { 235184610Salfred return ("UHCI (generic) USB controller"); 236184610Salfred } 237184610Salfred return (NULL); 238184610Salfred} 239184610Salfred 240184610Salfredstatic int 241184610Salfreduhci_pci_probe(device_t self) 242184610Salfred{ 243184610Salfred const char *desc = uhci_pci_match(self); 244184610Salfred 245184610Salfred if (desc) { 246184610Salfred device_set_desc(self, desc); 247184610Salfred return (0); 248184610Salfred } else { 249184610Salfred return (ENXIO); 250184610Salfred } 251184610Salfred} 252184610Salfred 253184610Salfredstatic int 254184610Salfreduhci_pci_attach(device_t self) 255184610Salfred{ 256184610Salfred uhci_softc_t *sc = device_get_softc(self); 257184610Salfred int rid; 258184610Salfred int err; 259184610Salfred 260187170Sthompsa /* initialise some bus fields */ 261187170Sthompsa sc->sc_bus.parent = self; 262187170Sthompsa sc->sc_bus.devices = sc->sc_devices; 263187170Sthompsa sc->sc_bus.devices_max = UHCI_MAX_DEVICES; 264187170Sthompsa 265184610Salfred /* get all DMA memory */ 266194228Sthompsa if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 267184610Salfred &uhci_iterate_hw_softc)) { 268184610Salfred return ENOMEM; 269184610Salfred } 270184610Salfred sc->sc_dev = self; 271184610Salfred 272184610Salfred pci_enable_busmaster(self); 273184610Salfred 274184610Salfred rid = PCI_UHCI_BASE_REG; 275184610Salfred sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid, 276184610Salfred RF_ACTIVE); 277184610Salfred if (!sc->sc_io_res) { 278184610Salfred device_printf(self, "Could not map ports\n"); 279184610Salfred goto error; 280184610Salfred } 281184610Salfred sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 282184610Salfred sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 283184610Salfred sc->sc_io_size = rman_get_size(sc->sc_io_res); 284184610Salfred 285184610Salfred /* disable interrupts */ 286184610Salfred bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0); 287184610Salfred 288184610Salfred rid = 0; 289184610Salfred sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 290184610Salfred RF_SHAREABLE | RF_ACTIVE); 291184610Salfred if (sc->sc_irq_res == NULL) { 292184610Salfred device_printf(self, "Could not allocate irq\n"); 293184610Salfred goto error; 294184610Salfred } 295184610Salfred sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 296184610Salfred if (!sc->sc_bus.bdev) { 297184610Salfred device_printf(self, "Could not add USB device\n"); 298184610Salfred goto error; 299184610Salfred } 300184610Salfred device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 301184610Salfred 302184610Salfred /* 303184610Salfred * uhci_pci_match must never return NULL if uhci_pci_probe 304184610Salfred * succeeded 305184610Salfred */ 306184610Salfred device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self)); 307184610Salfred switch (pci_get_vendor(self)) { 308184610Salfred case PCI_UHCI_VENDORID_INTEL: 309184610Salfred sprintf(sc->sc_vendor, "Intel"); 310184610Salfred break; 311184610Salfred case PCI_UHCI_VENDORID_VIA: 312184610Salfred sprintf(sc->sc_vendor, "VIA"); 313184610Salfred break; 314184610Salfred default: 315184610Salfred if (bootverbose) { 316184610Salfred device_printf(self, "(New UHCI DeviceId=0x%08x)\n", 317184610Salfred pci_get_devid(self)); 318184610Salfred } 319184610Salfred sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 320184610Salfred } 321184610Salfred 322184610Salfred switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 323184610Salfred case PCI_USB_REV_PRE_1_0: 324184610Salfred sc->sc_bus.usbrev = USB_REV_PRE_1_0; 325184610Salfred break; 326184610Salfred case PCI_USB_REV_1_0: 327184610Salfred sc->sc_bus.usbrev = USB_REV_1_0; 328184610Salfred break; 329184610Salfred default: 330187186Sthompsa /* Quirk for Parallels Desktop 4.0 */ 331187186Sthompsa device_printf(self, "USB revision is unknown. Assuming v1.1.\n"); 332187186Sthompsa sc->sc_bus.usbrev = USB_REV_1_1; 333184610Salfred break; 334184610Salfred } 335184610Salfred 336184610Salfred#if (__FreeBSD_version >= 700031) 337184610Salfred err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 338190183Sthompsa NULL, (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 339184610Salfred#else 340184610Salfred err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 341190183Sthompsa (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 342184610Salfred#endif 343184610Salfred 344184610Salfred if (err) { 345184610Salfred device_printf(self, "Could not setup irq, %d\n", err); 346184610Salfred sc->sc_intr_hdl = NULL; 347184610Salfred goto error; 348184610Salfred } 349198501Sthompsa /* 350198501Sthompsa * Set the PIRQD enable bit and switch off all the others. We don't 351198501Sthompsa * want legacy support to interfere with us XXX Does this also mean 352198501Sthompsa * that the BIOS won't touch the keyboard anymore if it is connected 353198501Sthompsa * to the ports of the root hub? 354198501Sthompsa */ 355198501Sthompsa#ifdef USB_DEBUG 356198501Sthompsa if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) { 357198501Sthompsa device_printf(self, "LegSup = 0x%04x\n", 358198501Sthompsa pci_read_config(self, PCI_LEGSUP, 2)); 359198501Sthompsa } 360198501Sthompsa#endif 361198501Sthompsa pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 362184610Salfred 363184610Salfred err = uhci_init(sc); 364184610Salfred if (!err) { 365184610Salfred err = device_probe_and_attach(sc->sc_bus.bdev); 366184610Salfred } 367184610Salfred if (err) { 368184610Salfred device_printf(self, "USB init failed\n"); 369184610Salfred goto error; 370184610Salfred } 371184610Salfred return (0); 372184610Salfred 373184610Salfrederror: 374184610Salfred uhci_pci_detach(self); 375184610Salfred return (ENXIO); 376184610Salfred} 377184610Salfred 378184610Salfredint 379184610Salfreduhci_pci_detach(device_t self) 380184610Salfred{ 381184610Salfred uhci_softc_t *sc = device_get_softc(self); 382184610Salfred device_t bdev; 383184610Salfred 384184610Salfred if (sc->sc_bus.bdev) { 385184610Salfred bdev = sc->sc_bus.bdev; 386184610Salfred device_detach(bdev); 387184610Salfred device_delete_child(self, bdev); 388184610Salfred } 389184610Salfred /* during module unload there are lots of children leftover */ 390229118Shselasky device_delete_children(self); 391184610Salfred 392184610Salfred /* 393184610Salfred * disable interrupts that might have been switched on in 394184610Salfred * uhci_init. 395184610Salfred */ 396184610Salfred if (sc->sc_io_res) { 397184824Sthompsa USB_BUS_LOCK(&sc->sc_bus); 398184610Salfred 399184610Salfred /* stop the controller */ 400184610Salfred uhci_reset(sc); 401184610Salfred 402184824Sthompsa USB_BUS_UNLOCK(&sc->sc_bus); 403184610Salfred } 404184610Salfred pci_disable_busmaster(self); 405184610Salfred 406184610Salfred if (sc->sc_irq_res && sc->sc_intr_hdl) { 407184610Salfred int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 408184610Salfred 409184610Salfred if (err) { 410184610Salfred /* XXX or should we panic? */ 411184610Salfred device_printf(self, "Could not tear down irq, %d\n", 412184610Salfred err); 413184610Salfred } 414184610Salfred sc->sc_intr_hdl = NULL; 415184610Salfred } 416184610Salfred if (sc->sc_irq_res) { 417184610Salfred bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 418184610Salfred sc->sc_irq_res = NULL; 419184610Salfred } 420184610Salfred if (sc->sc_io_res) { 421184610Salfred bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG, 422184610Salfred sc->sc_io_res); 423184610Salfred sc->sc_io_res = NULL; 424184610Salfred } 425194228Sthompsa usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc); 426184610Salfred 427184610Salfred return (0); 428184610Salfred} 429184610Salfred 430229096Shselaskystatic device_method_t uhci_pci_methods[] = { 431229096Shselasky /* Device interface */ 432229096Shselasky DEVMETHOD(device_probe, uhci_pci_probe), 433229096Shselasky DEVMETHOD(device_attach, uhci_pci_attach), 434229096Shselasky DEVMETHOD(device_detach, uhci_pci_detach), 435229096Shselasky DEVMETHOD(device_suspend, bus_generic_suspend), 436229096Shselasky DEVMETHOD(device_resume, bus_generic_resume), 437229096Shselasky DEVMETHOD(device_shutdown, bus_generic_shutdown), 438229096Shselasky DEVMETHOD(usb_take_controller, uhci_pci_take_controller), 439184610Salfred 440229096Shselasky DEVMETHOD_END 441229096Shselasky}; 442184610Salfred 443229096Shselaskystatic driver_t uhci_driver = { 444229096Shselasky .name = "uhci", 445229096Shselasky .methods = uhci_pci_methods, 446184610Salfred .size = sizeof(struct uhci_softc), 447184610Salfred}; 448184610Salfred 449184610Salfredstatic devclass_t uhci_devclass; 450184610Salfred 451184610SalfredDRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0); 452188942SthompsaMODULE_DEPEND(uhci, usb, 1, 1, 1); 453