2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (augustss@carlstedt.se) at
9 * Carlstedt Research & Technology.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
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.
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.
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 /* Universal Host Controller Interface
38 * UHCI spec: http://www.intel.com/
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
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>
54 #include <sys/module.h>
56 #include <sys/mutex.h>
57 #include <sys/condvar.h>
58 #include <sys/sysctl.h>
60 #include <sys/unistd.h>
61 #include <sys/callout.h>
62 #include <sys/malloc.h>
65 #include <dev/usb/usb.h>
66 #include <dev/usb/usbdi.h>
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>
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>
81 #define PCI_UHCI_VENDORID_INTEL 0x8086
82 #define PCI_UHCI_VENDORID_HP 0x103c
83 #define PCI_UHCI_VENDORID_VIA 0x1106
85 /* PIIX4E has no separate stepping */
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;
93 uhci_pci_take_controller(device_t self)
95 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
101 uhci_pci_match(device_t self)
103 uint32_t device_id = pci_get_devid(self);
107 return ("Intel 631XESB/632XESB/3100 USB controller USB-1");
110 return ("Intel 631XESB/632XESB/3100 USB controller USB-2");
113 return ("Intel 631XESB/632XESB/3100 USB controller USB-3");
116 return ("Intel 631XESB/632XESB/3100 USB controller USB-4");
119 return ("Intel 82371SB (PIIX3) USB controller");
122 return ("Intel 82371AB/EB (PIIX4) USB controller");
125 return ("Intel 82801AA (ICH) USB controller");
128 return ("Intel 82801AB (ICH0) USB controller");
131 return ("Intel 82801BA/BAM (ICH2) USB controller USB-A");
134 return ("Intel 82801BA/BAM (ICH2) USB controller USB-B");
137 return ("Intel 82801CA/CAM (ICH3) USB controller USB-A");
140 return ("Intel 82801CA/CAM (ICH3) USB controller USB-B");
143 return ("Intel 82801CA/CAM (ICH3) USB controller USB-C");
146 return ("Intel 82801DB (ICH4) USB controller USB-A");
149 return ("Intel 82801DB (ICH4) USB controller USB-B");
152 return ("Intel 82801DB (ICH4) USB controller USB-C");
155 return ("Intel 82801EB (ICH5) USB controller USB-A");
158 return ("Intel 82801EB (ICH5) USB controller USB-B");
161 return ("Intel 82801EB (ICH5) USB controller USB-C");
164 return ("Intel 82801EB (ICH5) USB controller USB-D");
167 return ("Intel 6300ESB USB controller USB-A");
170 return ("Intel 6300ESB USB controller USB-B");
173 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A");
176 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B");
179 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C");
182 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D");
185 return ("Intel 82801G (ICH7) USB controller USB-A");
187 return ("Intel 82801G (ICH7) USB controller USB-B");
189 return ("Intel 82801G (ICH7) USB controller USB-C");
191 return ("Intel 82801G (ICH7) USB controller USB-D");
194 return ("Intel 82801H (ICH8) USB controller USB-A");
196 return ("Intel 82801H (ICH8) USB controller USB-B");
198 return ("Intel 82801H (ICH8) USB controller USB-C");
200 return ("Intel 82801H (ICH8) USB controller USB-D");
202 return ("Intel 82801H (ICH8) USB controller USB-E");
204 return ("Intel 82801I (ICH9) USB controller");
206 return ("Intel 82801I (ICH9) USB controller");
208 return ("Intel 82801I (ICH9) USB controller");
210 return ("Intel 82801I (ICH9) USB controller");
212 return ("Intel 82801I (ICH9) USB controller");
214 return ("Intel 82801I (ICH9) USB controller");
216 return ("Intel 82801JI (ICH10) USB controller USB-A");
218 return ("Intel 82801JI (ICH10) USB controller USB-B");
220 return ("Intel 82801JI (ICH10) USB controller USB-C");
222 return ("Intel 82801JI (ICH10) USB controller USB-D");
224 return ("Intel 82801JI (ICH10) USB controller USB-E");
226 return ("Intel 82801JI (ICH10) USB controller USB-F");
229 return ("Intel 82443MX USB controller");
232 return ("Intel 82372FB/82468GX USB controller");
235 return ("HP iLO Standard Virtual USB controller");
238 return ("VIA 83C572 USB controller");
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");
253 uhci_pci_probe(device_t self)
255 const char *desc = uhci_pci_match(self);
258 device_set_desc(self, desc);
259 return (BUS_PROBE_DEFAULT);
266 uhci_pci_attach(device_t self)
268 uhci_softc_t *sc = device_get_softc(self);
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;
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)) {
285 pci_enable_busmaster(self);
287 rid = PCI_UHCI_BASE_REG;
288 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid,
290 if (!sc->sc_io_res) {
291 device_printf(self, "Could not map ports\n");
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);
298 /* disable interrupts */
299 bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 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");
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");
313 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
316 * uhci_pci_match must never return NULL if uhci_pci_probe
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");
324 case PCI_UHCI_VENDORID_HP:
325 sprintf(sc->sc_vendor, "HP");
327 case PCI_UHCI_VENDORID_VIA:
328 sprintf(sc->sc_vendor, "VIA");
332 device_printf(self, "(New UHCI DeviceId=0x%08x)\n",
333 pci_get_devid(self));
335 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
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;
342 case PCI_USB_REV_1_0:
343 sc->sc_bus.usbrev = USB_REV_1_0;
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;
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);
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);
361 device_printf(self, "Could not setup irq, %d\n", err);
362 sc->sc_intr_hdl = NULL;
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?
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));
377 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
381 err = device_probe_and_attach(sc->sc_bus.bdev);
384 device_printf(self, "USB init failed\n");
390 uhci_pci_detach(self);
395 uhci_pci_detach(device_t self)
397 uhci_softc_t *sc = device_get_softc(self);
399 /* during module unload there are lots of children leftover */
400 device_delete_children(self);
403 * disable interrupts that might have been switched on in
407 USB_BUS_LOCK(&sc->sc_bus);
409 /* stop the controller */
412 USB_BUS_UNLOCK(&sc->sc_bus);
414 pci_disable_busmaster(self);
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);
420 /* XXX or should we panic? */
421 device_printf(self, "Could not tear down irq, %d\n",
424 sc->sc_intr_hdl = NULL;
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;
431 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG,
433 sc->sc_io_res = NULL;
435 usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc);
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),
453 static driver_t uhci_driver = {
455 .methods = uhci_pci_methods,
456 .size = sizeof(struct uhci_softc),
459 static devclass_t uhci_devclass;
461 DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0);
462 MODULE_DEPEND(uhci, usb, 1, 1, 1);