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: releng/10.3/sys/dev/usb/controller/uhci_pci.c 289013 2015-10-08 07:24:54Z hselasky $"); 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> 77228483Shselasky#include "usb_if.h" 78184610Salfred 79184610Salfred#define PCI_UHCI_VENDORID_INTEL 0x8086 80289013Shselasky#define PCI_UHCI_VENDORID_HP 0x103c 81184610Salfred#define PCI_UHCI_VENDORID_VIA 0x1106 82184610Salfred 83184610Salfred/* PIIX4E has no separate stepping */ 84184610Salfred 85184610Salfredstatic device_probe_t uhci_pci_probe; 86184610Salfredstatic device_attach_t uhci_pci_attach; 87184610Salfredstatic device_detach_t uhci_pci_detach; 88228483Shselaskystatic usb_take_controller_t uhci_pci_take_controller; 89184610Salfred 90184610Salfredstatic int 91228483Shselaskyuhci_pci_take_controller(device_t self) 92184610Salfred{ 93198501Sthompsa pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 94198501Sthompsa 95184610Salfred return (0); 96184610Salfred} 97184610Salfred 98184610Salfredstatic const char * 99184610Salfreduhci_pci_match(device_t self) 100184610Salfred{ 101184610Salfred uint32_t device_id = pci_get_devid(self); 102184610Salfred 103184610Salfred switch (device_id) { 104184610Salfred case 0x26888086: 105184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-1"); 106184610Salfred 107184610Salfred case 0x26898086: 108184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-2"); 109184610Salfred 110184610Salfred case 0x268a8086: 111184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-3"); 112184610Salfred 113184610Salfred case 0x268b8086: 114184610Salfred return ("Intel 631XESB/632XESB/3100 USB controller USB-4"); 115184610Salfred 116184610Salfred case 0x70208086: 117184610Salfred return ("Intel 82371SB (PIIX3) USB controller"); 118184610Salfred 119184610Salfred case 0x71128086: 120184610Salfred return ("Intel 82371AB/EB (PIIX4) USB controller"); 121184610Salfred 122184610Salfred case 0x24128086: 123184610Salfred return ("Intel 82801AA (ICH) USB controller"); 124184610Salfred 125184610Salfred case 0x24228086: 126184610Salfred return ("Intel 82801AB (ICH0) USB controller"); 127184610Salfred 128184610Salfred case 0x24428086: 129184610Salfred return ("Intel 82801BA/BAM (ICH2) USB controller USB-A"); 130184610Salfred 131184610Salfred case 0x24448086: 132184610Salfred return ("Intel 82801BA/BAM (ICH2) USB controller USB-B"); 133184610Salfred 134184610Salfred case 0x24828086: 135184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-A"); 136184610Salfred 137184610Salfred case 0x24848086: 138184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-B"); 139184610Salfred 140184610Salfred case 0x24878086: 141184610Salfred return ("Intel 82801CA/CAM (ICH3) USB controller USB-C"); 142184610Salfred 143184610Salfred case 0x24c28086: 144184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-A"); 145184610Salfred 146184610Salfred case 0x24c48086: 147184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-B"); 148184610Salfred 149184610Salfred case 0x24c78086: 150184610Salfred return ("Intel 82801DB (ICH4) USB controller USB-C"); 151184610Salfred 152184610Salfred case 0x24d28086: 153184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-A"); 154184610Salfred 155184610Salfred case 0x24d48086: 156184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-B"); 157184610Salfred 158184610Salfred case 0x24d78086: 159184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-C"); 160184610Salfred 161184610Salfred case 0x24de8086: 162184610Salfred return ("Intel 82801EB (ICH5) USB controller USB-D"); 163184610Salfred 164184610Salfred case 0x26588086: 165184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A"); 166184610Salfred 167184610Salfred case 0x26598086: 168184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B"); 169184610Salfred 170184610Salfred case 0x265a8086: 171184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C"); 172184610Salfred 173184610Salfred case 0x265b8086: 174184610Salfred return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D"); 175184610Salfred 176195958Salfred case 0x27c88086: 177195958Salfred return ("Intel 82801G (ICH7) USB controller USB-A"); 178195958Salfred case 0x27c98086: 179195958Salfred return ("Intel 82801G (ICH7) USB controller USB-B"); 180195958Salfred case 0x27ca8086: 181195958Salfred return ("Intel 82801G (ICH7) USB controller USB-C"); 182195958Salfred case 0x27cb8086: 183195958Salfred return ("Intel 82801G (ICH7) USB controller USB-D"); 184195958Salfred 185184610Salfred case 0x28308086: 186184610Salfred return ("Intel 82801H (ICH8) USB controller USB-A"); 187184610Salfred case 0x28318086: 188184610Salfred return ("Intel 82801H (ICH8) USB controller USB-B"); 189184610Salfred case 0x28328086: 190184610Salfred return ("Intel 82801H (ICH8) USB controller USB-C"); 191184610Salfred case 0x28348086: 192184610Salfred return ("Intel 82801H (ICH8) USB controller USB-D"); 193184610Salfred case 0x28358086: 194184610Salfred return ("Intel 82801H (ICH8) USB controller USB-E"); 195184610Salfred case 0x29348086: 196184610Salfred return ("Intel 82801I (ICH9) USB controller"); 197184610Salfred case 0x29358086: 198184610Salfred return ("Intel 82801I (ICH9) USB controller"); 199184610Salfred case 0x29368086: 200184610Salfred return ("Intel 82801I (ICH9) USB controller"); 201184610Salfred case 0x29378086: 202184610Salfred return ("Intel 82801I (ICH9) USB controller"); 203184610Salfred case 0x29388086: 204184610Salfred return ("Intel 82801I (ICH9) USB controller"); 205184610Salfred case 0x29398086: 206184610Salfred return ("Intel 82801I (ICH9) USB controller"); 207200087Sthompsa case 0x3a348086: 208200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-A"); 209200087Sthompsa case 0x3a358086: 210200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-B"); 211200087Sthompsa case 0x3a368086: 212200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-C"); 213200087Sthompsa case 0x3a378086: 214200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-D"); 215200087Sthompsa case 0x3a388086: 216200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-E"); 217200087Sthompsa case 0x3a398086: 218200305Sthompsa return ("Intel 82801JI (ICH10) USB controller USB-F"); 219184610Salfred 220184610Salfred case 0x719a8086: 221184610Salfred return ("Intel 82443MX USB controller"); 222184610Salfred 223184610Salfred case 0x76028086: 224184610Salfred return ("Intel 82372FB/82468GX USB controller"); 225184610Salfred 226289013Shselasky case 0x3300103c: 227289013Shselasky return ("HP iLO Standard Virtual USB controller"); 228289013Shselasky 229184610Salfred case 0x30381106: 230184610Salfred return ("VIA 83C572 USB controller"); 231184610Salfred 232184610Salfred default: 233184610Salfred break; 234184610Salfred } 235184610Salfred 236184610Salfred if ((pci_get_class(self) == PCIC_SERIALBUS) && 237184610Salfred (pci_get_subclass(self) == PCIS_SERIALBUS_USB) && 238184610Salfred (pci_get_progif(self) == PCI_INTERFACE_UHCI)) { 239184610Salfred return ("UHCI (generic) USB controller"); 240184610Salfred } 241184610Salfred return (NULL); 242184610Salfred} 243184610Salfred 244184610Salfredstatic int 245184610Salfreduhci_pci_probe(device_t self) 246184610Salfred{ 247184610Salfred const char *desc = uhci_pci_match(self); 248184610Salfred 249184610Salfred if (desc) { 250184610Salfred device_set_desc(self, desc); 251184610Salfred return (0); 252184610Salfred } else { 253184610Salfred return (ENXIO); 254184610Salfred } 255184610Salfred} 256184610Salfred 257184610Salfredstatic int 258184610Salfreduhci_pci_attach(device_t self) 259184610Salfred{ 260184610Salfred uhci_softc_t *sc = device_get_softc(self); 261184610Salfred int rid; 262184610Salfred int err; 263184610Salfred 264187170Sthompsa /* initialise some bus fields */ 265187170Sthompsa sc->sc_bus.parent = self; 266187170Sthompsa sc->sc_bus.devices = sc->sc_devices; 267187170Sthompsa sc->sc_bus.devices_max = UHCI_MAX_DEVICES; 268278278Shselasky sc->sc_bus.dma_bits = 32; 269187170Sthompsa 270184610Salfred /* get all DMA memory */ 271194228Sthompsa if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self), 272184610Salfred &uhci_iterate_hw_softc)) { 273184610Salfred return ENOMEM; 274184610Salfred } 275184610Salfred sc->sc_dev = self; 276184610Salfred 277184610Salfred pci_enable_busmaster(self); 278184610Salfred 279184610Salfred rid = PCI_UHCI_BASE_REG; 280184610Salfred sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid, 281184610Salfred RF_ACTIVE); 282184610Salfred if (!sc->sc_io_res) { 283184610Salfred device_printf(self, "Could not map ports\n"); 284184610Salfred goto error; 285184610Salfred } 286184610Salfred sc->sc_io_tag = rman_get_bustag(sc->sc_io_res); 287184610Salfred sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res); 288184610Salfred sc->sc_io_size = rman_get_size(sc->sc_io_res); 289184610Salfred 290184610Salfred /* disable interrupts */ 291184610Salfred bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0); 292184610Salfred 293184610Salfred rid = 0; 294184610Salfred sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, 295184610Salfred RF_SHAREABLE | RF_ACTIVE); 296184610Salfred if (sc->sc_irq_res == NULL) { 297184610Salfred device_printf(self, "Could not allocate irq\n"); 298184610Salfred goto error; 299184610Salfred } 300184610Salfred sc->sc_bus.bdev = device_add_child(self, "usbus", -1); 301184610Salfred if (!sc->sc_bus.bdev) { 302184610Salfred device_printf(self, "Could not add USB device\n"); 303184610Salfred goto error; 304184610Salfred } 305184610Salfred device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); 306184610Salfred 307184610Salfred /* 308184610Salfred * uhci_pci_match must never return NULL if uhci_pci_probe 309184610Salfred * succeeded 310184610Salfred */ 311184610Salfred device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self)); 312184610Salfred switch (pci_get_vendor(self)) { 313184610Salfred case PCI_UHCI_VENDORID_INTEL: 314184610Salfred sprintf(sc->sc_vendor, "Intel"); 315184610Salfred break; 316289013Shselasky case PCI_UHCI_VENDORID_HP: 317289013Shselasky sprintf(sc->sc_vendor, "HP"); 318289013Shselasky break; 319184610Salfred case PCI_UHCI_VENDORID_VIA: 320184610Salfred sprintf(sc->sc_vendor, "VIA"); 321184610Salfred break; 322184610Salfred default: 323184610Salfred if (bootverbose) { 324184610Salfred device_printf(self, "(New UHCI DeviceId=0x%08x)\n", 325184610Salfred pci_get_devid(self)); 326184610Salfred } 327184610Salfred sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); 328184610Salfred } 329184610Salfred 330184610Salfred switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) { 331184610Salfred case PCI_USB_REV_PRE_1_0: 332184610Salfred sc->sc_bus.usbrev = USB_REV_PRE_1_0; 333184610Salfred break; 334184610Salfred case PCI_USB_REV_1_0: 335184610Salfred sc->sc_bus.usbrev = USB_REV_1_0; 336184610Salfred break; 337184610Salfred default: 338187186Sthompsa /* Quirk for Parallels Desktop 4.0 */ 339187186Sthompsa device_printf(self, "USB revision is unknown. Assuming v1.1.\n"); 340187186Sthompsa sc->sc_bus.usbrev = USB_REV_1_1; 341184610Salfred break; 342184610Salfred } 343184610Salfred 344184610Salfred#if (__FreeBSD_version >= 700031) 345184610Salfred err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 346190183Sthompsa NULL, (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 347184610Salfred#else 348184610Salfred err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE, 349190183Sthompsa (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl); 350184610Salfred#endif 351184610Salfred 352184610Salfred if (err) { 353184610Salfred device_printf(self, "Could not setup irq, %d\n", err); 354184610Salfred sc->sc_intr_hdl = NULL; 355184610Salfred goto error; 356184610Salfred } 357198501Sthompsa /* 358198501Sthompsa * Set the PIRQD enable bit and switch off all the others. We don't 359198501Sthompsa * want legacy support to interfere with us XXX Does this also mean 360198501Sthompsa * that the BIOS won't touch the keyboard anymore if it is connected 361198501Sthompsa * to the ports of the root hub? 362198501Sthompsa */ 363198501Sthompsa#ifdef USB_DEBUG 364198501Sthompsa if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) { 365198501Sthompsa device_printf(self, "LegSup = 0x%04x\n", 366198501Sthompsa pci_read_config(self, PCI_LEGSUP, 2)); 367198501Sthompsa } 368198501Sthompsa#endif 369198501Sthompsa pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2); 370184610Salfred 371184610Salfred err = uhci_init(sc); 372184610Salfred if (!err) { 373184610Salfred err = device_probe_and_attach(sc->sc_bus.bdev); 374184610Salfred } 375184610Salfred if (err) { 376184610Salfred device_printf(self, "USB init failed\n"); 377184610Salfred goto error; 378184610Salfred } 379184610Salfred return (0); 380184610Salfred 381184610Salfrederror: 382184610Salfred uhci_pci_detach(self); 383184610Salfred return (ENXIO); 384184610Salfred} 385184610Salfred 386184610Salfredint 387184610Salfreduhci_pci_detach(device_t self) 388184610Salfred{ 389184610Salfred uhci_softc_t *sc = device_get_softc(self); 390184610Salfred device_t bdev; 391184610Salfred 392184610Salfred if (sc->sc_bus.bdev) { 393184610Salfred bdev = sc->sc_bus.bdev; 394184610Salfred device_detach(bdev); 395184610Salfred device_delete_child(self, bdev); 396184610Salfred } 397184610Salfred /* during module unload there are lots of children leftover */ 398227849Shselasky device_delete_children(self); 399184610Salfred 400184610Salfred /* 401184610Salfred * disable interrupts that might have been switched on in 402184610Salfred * uhci_init. 403184610Salfred */ 404184610Salfred if (sc->sc_io_res) { 405184824Sthompsa USB_BUS_LOCK(&sc->sc_bus); 406184610Salfred 407184610Salfred /* stop the controller */ 408184610Salfred uhci_reset(sc); 409184610Salfred 410184824Sthompsa USB_BUS_UNLOCK(&sc->sc_bus); 411184610Salfred } 412184610Salfred pci_disable_busmaster(self); 413184610Salfred 414184610Salfred if (sc->sc_irq_res && sc->sc_intr_hdl) { 415184610Salfred int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl); 416184610Salfred 417184610Salfred if (err) { 418184610Salfred /* XXX or should we panic? */ 419184610Salfred device_printf(self, "Could not tear down irq, %d\n", 420184610Salfred err); 421184610Salfred } 422184610Salfred sc->sc_intr_hdl = NULL; 423184610Salfred } 424184610Salfred if (sc->sc_irq_res) { 425184610Salfred bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res); 426184610Salfred sc->sc_irq_res = NULL; 427184610Salfred } 428184610Salfred if (sc->sc_io_res) { 429184610Salfred bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG, 430184610Salfred sc->sc_io_res); 431184610Salfred sc->sc_io_res = NULL; 432184610Salfred } 433194228Sthompsa usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc); 434184610Salfred 435184610Salfred return (0); 436184610Salfred} 437184610Salfred 438228483Shselaskystatic device_method_t uhci_pci_methods[] = { 439228483Shselasky /* Device interface */ 440228483Shselasky DEVMETHOD(device_probe, uhci_pci_probe), 441228483Shselasky DEVMETHOD(device_attach, uhci_pci_attach), 442228483Shselasky DEVMETHOD(device_detach, uhci_pci_detach), 443228483Shselasky DEVMETHOD(device_suspend, bus_generic_suspend), 444228483Shselasky DEVMETHOD(device_resume, bus_generic_resume), 445228483Shselasky DEVMETHOD(device_shutdown, bus_generic_shutdown), 446228483Shselasky DEVMETHOD(usb_take_controller, uhci_pci_take_controller), 447184610Salfred 448228483Shselasky DEVMETHOD_END 449228483Shselasky}; 450184610Salfred 451228483Shselaskystatic driver_t uhci_driver = { 452228483Shselasky .name = "uhci", 453228483Shselasky .methods = uhci_pci_methods, 454184610Salfred .size = sizeof(struct uhci_softc), 455184610Salfred}; 456184610Salfred 457184610Salfredstatic devclass_t uhci_devclass; 458184610Salfred 459184610SalfredDRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0); 460188942SthompsaMODULE_DEPEND(uhci, usb, 1, 1, 1); 461