/*- * Copyright (c) 1998 The NetBSD Foundation, Inc. * All rights reserved. * * This code is derived from software contributed to The NetBSD Foundation * by Lennart Augustsson (augustss@carlstedt.se) at * Carlstedt Research & Technology. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * 3. All advertising materials mentioning features or use of this software * must display the following acknowledgement: * This product includes software developed by the NetBSD * Foundation, Inc. and its contributors. * 4. Neither the name of The NetBSD Foundation nor the names of its * contributors may be used to endorse or promote products derived * from this software without specific prior written permission. * * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE * POSSIBILITY OF SUCH DAMAGE. */ #include __FBSDID("$FreeBSD$"); /* * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller. * * The EHCI 1.0 spec can be found at * http://developer.intel.com/technology/usb/download/ehci-r10.pdf * and the USB 2.0 spec at * http://www.usb.org/developers/docs/usb_20.zip */ /* The low level controller code for EHCI has been split into * PCI probes and EHCI specific code. This was done to facilitate the * sharing of code between *BSD's */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define PCI_EHCI_VENDORID_ACERLABS 0x10b9 #define PCI_EHCI_VENDORID_AMD 0x1022 #define PCI_EHCI_VENDORID_APPLE 0x106b #define PCI_EHCI_VENDORID_ATI 0x1002 #define PCI_EHCI_VENDORID_CMDTECH 0x1095 #define PCI_EHCI_VENDORID_INTEL 0x8086 #define PCI_EHCI_VENDORID_NEC 0x1033 #define PCI_EHCI_VENDORID_OPTI 0x1045 #define PCI_EHCI_VENDORID_PHILIPS 0x1131 #define PCI_EHCI_VENDORID_SIS 0x1039 #define PCI_EHCI_VENDORID_NVIDIA 0x12D2 #define PCI_EHCI_VENDORID_NVIDIA2 0x10DE #define PCI_EHCI_VENDORID_VIA 0x1106 /* AcerLabs/ALi */ #define PCI_EHCI_DEVICEID_M5239 0x523910b9 static const char *ehci_device_m5239 = "ALi M5239 USB 2.0 controller"; /* AMD */ #define PCI_EHCI_DEVICEID_8111 0x10227463 static const char *ehci_device_8111 = "AMD 8111 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_CS5536 0x20951022 static const char *ehci_device_cs5536 = "AMD CS5536 (Geode) USB 2.0 controller"; /* ATI */ #define PCI_EHCI_DEVICEID_SB200 0x43451002 static const char *ehci_device_sb200 = "ATI SB200 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_SB400 0x43731002 static const char *ehci_device_sb400 = "ATI SB400 USB 2.0 controller"; /* Intel */ #define PCI_EHCI_DEVICEID_6300 0x25ad8086 static const char *ehci_device_6300 = "Intel 6300ESB USB 2.0 controller"; #define PCI_EHCI_DEVICEID_ICH4 0x24cd8086 static const char *ehci_device_ich4 = "Intel 82801DB/L/M (ICH4) USB 2.0 controller"; #define PCI_EHCI_DEVICEID_ICH5 0x24dd8086 static const char *ehci_device_ich5 = "Intel 82801EB/R (ICH5) USB 2.0 controller"; #define PCI_EHCI_DEVICEID_ICH6 0x265c8086 static const char *ehci_device_ich6 = "Intel 82801FB (ICH6) USB 2.0 controller"; #define PCI_EHCI_DEVICEID_ICH7 0x27cc8086 static const char *ehci_device_ich7 = "Intel 82801GB/R (ICH7) USB 2.0 controller"; #define PCI_EHCI_DEVICEID_ICH8_A 0x28368086 static const char *ehci_device_ich8_a = "Intel 82801H (ICH8) USB 2.0 controller USB2-A"; #define PCI_EHCI_DEVICEID_ICH8_B 0x283a8086 static const char *ehci_device_ich8_b = "Intel 82801H (ICH8) USB 2.0 controller USB2-B"; #define PCI_EHCI_DEVICEID_ICH9_A 0x293a8086 #define PCI_EHCI_DEVICEID_ICH9_B 0x293c8086 static const char *ehci_device_ich9 = "Intel 82801I (ICH9) USB 2.0 controller"; #define PCI_EHCI_DEVICEID_63XX 0x268c8086 static const char *ehci_device_63XX = "Intel 63XXESB USB 2.0 controller"; /* NEC */ #define PCI_EHCI_DEVICEID_NEC 0x00e01033 static const char *ehci_device_nec = "NEC uPD 720100 USB 2.0 controller"; /* NVIDIA */ #define PCI_EHCI_DEVICEID_NF2 0x006810de static const char *ehci_device_nf2 = "NVIDIA nForce2 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_NF2_400 0x008810de static const char *ehci_device_nf2_400 = "NVIDIA nForce2 Ultra 400 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_NF3 0x00d810de static const char *ehci_device_nf3 = "NVIDIA nForce3 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_NF3_250 0x00e810de static const char *ehci_device_nf3_250 = "NVIDIA nForce3 250 USB 2.0 controller"; #define PCI_EHCI_DEVICEID_NF4 0x005b10de static const char *ehci_device_nf4 = "NVIDIA nForce4 USB 2.0 controller"; /* Philips */ #define PCI_EHCI_DEVICEID_ISP156X 0x15621131 static const char *ehci_device_isp156x = "Philips ISP156x USB 2.0 controller"; #define PCI_EHCI_DEVICEID_VIA 0x31041106 static const char *ehci_device_via = "VIA VT6202 USB 2.0 controller"; static const char *ehci_device_generic = "EHCI (generic) USB 2.0 controller"; #define PCI_EHCI_BASE_REG 0x10 #ifdef USB_DEBUG #define EHCI_DEBUG USB_DEBUG #define DPRINTF(x) do { if (ehcidebug) printf x; } while (0) extern int ehcidebug; #else #define DPRINTF(x) #endif static device_attach_t ehci_pci_attach; static device_detach_t ehci_pci_detach; static device_shutdown_t ehci_pci_shutdown; static device_suspend_t ehci_pci_suspend; static device_resume_t ehci_pci_resume; static void ehci_pci_givecontroller(device_t self); static void ehci_pci_takecontroller(device_t self); static int ehci_pci_suspend(device_t self) { ehci_softc_t *sc = device_get_softc(self); int err; err = bus_generic_suspend(self); if (err) return (err); ehci_power(PWR_SUSPEND, sc); return 0; } static int ehci_pci_resume(device_t self) { ehci_softc_t *sc = device_get_softc(self); ehci_pci_takecontroller(self); ehci_power(PWR_RESUME, sc); bus_generic_resume(self); return 0; } static int ehci_pci_shutdown(device_t self) { ehci_softc_t *sc = device_get_softc(self); int err; err = bus_generic_shutdown(self); if (err) return (err); ehci_shutdown(sc); ehci_pci_givecontroller(self); return 0; } static const char * ehci_pci_match(device_t self) { u_int32_t device_id = pci_get_devid(self); switch (device_id) { case PCI_EHCI_DEVICEID_M5239: return (ehci_device_m5239); case PCI_EHCI_DEVICEID_8111: return (ehci_device_8111); case PCI_EHCI_DEVICEID_CS5536: return (ehci_device_cs5536); case PCI_EHCI_DEVICEID_SB200: return (ehci_device_sb200); case PCI_EHCI_DEVICEID_SB400: return (ehci_device_sb400); case PCI_EHCI_DEVICEID_6300: return (ehci_device_6300); case PCI_EHCI_DEVICEID_63XX: return (ehci_device_63XX); case PCI_EHCI_DEVICEID_ICH4: return (ehci_device_ich4); case PCI_EHCI_DEVICEID_ICH5: return (ehci_device_ich5); case PCI_EHCI_DEVICEID_ICH6: return (ehci_device_ich6); case PCI_EHCI_DEVICEID_ICH7: return (ehci_device_ich7); case PCI_EHCI_DEVICEID_ICH8_A: return (ehci_device_ich8_a); case PCI_EHCI_DEVICEID_ICH8_B: return (ehci_device_ich8_b); case PCI_EHCI_DEVICEID_ICH9_A: case PCI_EHCI_DEVICEID_ICH9_B: return (ehci_device_ich9); case PCI_EHCI_DEVICEID_NEC: return (ehci_device_nec); case PCI_EHCI_DEVICEID_NF2: return (ehci_device_nf2); case PCI_EHCI_DEVICEID_NF2_400: return (ehci_device_nf2_400); case PCI_EHCI_DEVICEID_NF3: return (ehci_device_nf3); case PCI_EHCI_DEVICEID_NF3_250: return (ehci_device_nf3_250); case PCI_EHCI_DEVICEID_NF4: return (ehci_device_nf4); case PCI_EHCI_DEVICEID_ISP156X: return (ehci_device_isp156x); case PCI_EHCI_DEVICEID_VIA: return (ehci_device_via); default: if (pci_get_class(self) == PCIC_SERIALBUS && pci_get_subclass(self) == PCIS_SERIALBUS_USB && pci_get_progif(self) == PCI_INTERFACE_EHCI) { return (ehci_device_generic); } } return NULL; /* dunno */ } static int ehci_pci_probe(device_t self) { const char *desc = ehci_pci_match(self); if (desc) { device_set_desc(self, desc); return BUS_PROBE_DEFAULT; } else { return ENXIO; } } static int ehci_pci_attach(device_t self) { ehci_softc_t *sc = device_get_softc(self); devclass_t dc; device_t parent; device_t *neighbors; device_t *nbus; struct usbd_bus *bsc; int err; int rid; int ncomp; int count, buscount; int slot, function; int res; int i; switch(pci_read_config(self, PCI_USBREV, 1) & PCI_USBREV_MASK) { case PCI_USBREV_PRE_1_0: case PCI_USBREV_1_0: case PCI_USBREV_1_1: device_printf(self, "pre-2.0 USB rev\n"); if (pci_get_devid(self) == PCI_EHCI_DEVICEID_CS5536) { sc->sc_bus.usbrev = USBREV_2_0; device_printf(self, "Quirk for CS5536 USB 2.0 enabled\n"); break; } sc->sc_bus.usbrev = USBREV_UNKNOWN; return ENXIO; case PCI_USBREV_2_0: sc->sc_bus.usbrev = USBREV_2_0; break; default: sc->sc_bus.usbrev = USBREV_UNKNOWN; break; } pci_enable_busmaster(self); rid = PCI_CBMEM; sc->io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid, RF_ACTIVE); if (!sc->io_res) { device_printf(self, "Could not map memory\n"); return ENXIO; } sc->iot = rman_get_bustag(sc->io_res); sc->ioh = rman_get_bushandle(sc->io_res); rid = 0; sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid, RF_SHAREABLE | RF_ACTIVE); if (sc->irq_res == NULL) { device_printf(self, "Could not allocate irq\n"); ehci_pci_detach(self); return ENXIO; } sc->sc_bus.bdev = device_add_child(self, "usb", -1); if (!sc->sc_bus.bdev) { device_printf(self, "Could not add USB device\n"); ehci_pci_detach(self); return ENOMEM; } device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus); /* ehci_pci_match will never return NULL if ehci_pci_probe succeeded */ device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self)); switch (pci_get_vendor(self)) { case PCI_EHCI_VENDORID_ACERLABS: sprintf(sc->sc_vendor, "AcerLabs"); break; case PCI_EHCI_VENDORID_AMD: sprintf(sc->sc_vendor, "AMD"); break; case PCI_EHCI_VENDORID_APPLE: sprintf(sc->sc_vendor, "Apple"); break; case PCI_EHCI_VENDORID_ATI: sprintf(sc->sc_vendor, "ATI"); break; case PCI_EHCI_VENDORID_CMDTECH: sprintf(sc->sc_vendor, "CMDTECH"); break; case PCI_EHCI_VENDORID_INTEL: sprintf(sc->sc_vendor, "Intel"); break; case PCI_EHCI_VENDORID_NEC: sprintf(sc->sc_vendor, "NEC"); break; case PCI_EHCI_VENDORID_OPTI: sprintf(sc->sc_vendor, "OPTi"); break; case PCI_EHCI_VENDORID_SIS: sprintf(sc->sc_vendor, "SiS"); break; case PCI_EHCI_VENDORID_NVIDIA: case PCI_EHCI_VENDORID_NVIDIA2: sprintf(sc->sc_vendor, "nVidia"); break; case PCI_EHCI_VENDORID_VIA: sprintf(sc->sc_vendor, "VIA"); break; default: if (bootverbose) device_printf(self, "(New EHCI DeviceId=0x%08x)\n", pci_get_devid(self)); sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self)); } err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO, NULL, (driver_intr_t *)ehci_intr, sc, &sc->ih); if (err) { device_printf(self, "Could not setup irq, %d\n", err); sc->ih = NULL; ehci_pci_detach(self); return ENXIO; } /* Enable workaround for dropped interrupts as required */ switch (pci_get_vendor(self)) { case PCI_EHCI_VENDORID_ATI: case PCI_EHCI_VENDORID_VIA: sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG; if (bootverbose) device_printf(self, "Dropped interrupts workaround enabled\n"); break; default: break; } /* * Find companion controllers. According to the spec they always * have lower function numbers so they should be enumerated already. */ parent = device_get_parent(self); res = device_get_children(parent, &neighbors, &count); if (res != 0) { device_printf(self, "Error finding companion busses\n"); ehci_pci_detach(self); return ENXIO; } ncomp = 0; dc = devclass_find("usb"); slot = pci_get_slot(self); function = pci_get_function(self); for (i = 0; i < count; i++) { if (pci_get_slot(neighbors[i]) == slot && \ pci_get_function(neighbors[i]) < function) { res = device_get_children(neighbors[i], &nbus, &buscount); if (res != 0) continue; if (buscount != 1) { free(nbus, M_TEMP); continue; } if (device_get_devclass(nbus[0]) != dc) { free(nbus, M_TEMP); continue; } bsc = device_get_softc(nbus[0]); free(nbus, M_TEMP); DPRINTF(("ehci_pci_attach: companion %s\n", device_get_nameunit(bsc->bdev))); sc->sc_comps[ncomp++] = bsc; if (ncomp >= EHCI_COMPANION_MAX) break; } } sc->sc_ncomp = ncomp; /* Allocate a parent dma tag for DMA maps */ err = bus_dma_tag_create(bus_get_dma_tag(self), 1, 0, BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL, BUS_SPACE_MAXSIZE_32BIT, USB_DMA_NSEG, BUS_SPACE_MAXSIZE_32BIT, 0, NULL, NULL, &sc->sc_bus.parent_dmatag); if (err) { device_printf(self, "Could not allocate parent DMA tag (%d)\n", err); ehci_pci_detach(self); return ENXIO; } /* Allocate a dma tag for transfer buffers */ err = bus_dma_tag_create(sc->sc_bus.parent_dmatag, 1, 0, BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL, BUS_SPACE_MAXSIZE_32BIT, USB_DMA_NSEG, BUS_SPACE_MAXSIZE_32BIT, 0, busdma_lock_mutex, &Giant, &sc->sc_bus.buffer_dmatag); if (err) { device_printf(self, "Could not allocate buffer DMA tag (%d)\n", err); ehci_pci_detach(self); return ENXIO; } ehci_pci_takecontroller(self); err = ehci_init(sc); if (!err) { sc->sc_flags |= EHCI_SCFLG_DONEINIT; err = device_probe_and_attach(sc->sc_bus.bdev); } if (err) { device_printf(self, "USB init failed err=%d\n", err); ehci_pci_detach(self); return EIO; } return 0; } static int ehci_pci_detach(device_t self) { ehci_softc_t *sc = device_get_softc(self); if (sc->sc_flags & EHCI_SCFLG_DONEINIT) { ehci_detach(sc, 0); sc->sc_flags &= ~EHCI_SCFLG_DONEINIT; } /* * disable interrupts that might have been switched on in ehci_init */ if (sc->iot && sc->ioh) bus_space_write_4(sc->iot, sc->ioh, EHCI_USBINTR, 0); if (sc->sc_bus.parent_dmatag != NULL) bus_dma_tag_destroy(sc->sc_bus.parent_dmatag); if (sc->sc_bus.buffer_dmatag != NULL) bus_dma_tag_destroy(sc->sc_bus.buffer_dmatag); if (sc->irq_res && sc->ih) { int err = bus_teardown_intr(self, sc->irq_res, sc->ih); if (err) /* XXX or should we panic? */ device_printf(self, "Could not tear down irq, %d\n", err); sc->ih = NULL; } if (sc->sc_bus.bdev) { device_delete_child(self, sc->sc_bus.bdev); sc->sc_bus.bdev = NULL; } if (sc->irq_res) { bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res); sc->irq_res = NULL; } if (sc->io_res) { bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res); sc->io_res = NULL; sc->iot = 0; sc->ioh = 0; } return 0; } static void ehci_pci_takecontroller(device_t self) { ehci_softc_t *sc = device_get_softc(self); u_int32_t cparams, eec; uint8_t bios_sem; int eecp, i; cparams = EREAD4(sc, EHCI_HCCPARAMS); /* Synchronise with the BIOS if it owns the controller. */ for (eecp = EHCI_HCC_EECP(cparams); eecp != 0; eecp = EHCI_EECP_NEXT(eec)) { eec = pci_read_config(self, eecp, 4); if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) continue; bios_sem = pci_read_config(self, eecp + EHCI_LEGSUP_BIOS_SEM, 1); if (bios_sem) { pci_write_config(self, eecp + EHCI_LEGSUP_OS_SEM, 1, 1); printf("%s: waiting for BIOS to give up control\n", device_get_nameunit(sc->sc_bus.bdev)); for (i = 0; i < 5000; i++) { bios_sem = pci_read_config(self, eecp + EHCI_LEGSUP_BIOS_SEM, 1); if (bios_sem == 0) break; DELAY(1000); } if (bios_sem) printf("%s: timed out waiting for BIOS\n", device_get_nameunit(sc->sc_bus.bdev)); } } } static void ehci_pci_givecontroller(device_t self) { #if 0 ehci_softc_t *sc = device_get_softc(self); u_int32_t cparams, eec; int eecp; cparams = EREAD4(sc, EHCI_HCCPARAMS); for (eecp = EHCI_HCC_EECP(cparams); eecp != 0; eecp = EHCI_EECP_NEXT(eec)) { eec = pci_read_config(self, eecp, 4); if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) continue; pci_write_config(self, eecp + EHCI_LEGSUP_OS_SEM, 0, 1); } #endif } static device_method_t ehci_methods[] = { /* Device interface */ DEVMETHOD(device_probe, ehci_pci_probe), DEVMETHOD(device_attach, ehci_pci_attach), DEVMETHOD(device_detach, ehci_pci_detach), DEVMETHOD(device_suspend, ehci_pci_suspend), DEVMETHOD(device_resume, ehci_pci_resume), DEVMETHOD(device_shutdown, ehci_pci_shutdown), /* Bus interface */ DEVMETHOD(bus_print_child, bus_generic_print_child), {0, 0} }; static driver_t ehci_driver = { "ehci", ehci_methods, sizeof(ehci_softc_t), }; static devclass_t ehci_devclass; DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0); DRIVER_MODULE(ehci, cardbus, ehci_driver, ehci_devclass, 0, 0); MODULE_DEPEND(ehci, usb, 1, 1, 1);