2 * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Lennart Augustsson (augustss@carlstedt.se) at
7 * Carlstedt Research & Technology.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
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.
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.
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD$");
35 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
37 * The EHCI 1.0 spec can be found at
38 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
39 * and the USB 2.0 spec at
40 * http://www.usb.org/developers/docs/usb_20.zip
43 /* The low level controller code for EHCI has been split into
44 * PCI probes and EHCI specific code. This was done to facilitate the
45 * sharing of code between *BSD's
48 #include <sys/stdint.h>
49 #include <sys/stddef.h>
50 #include <sys/param.h>
51 #include <sys/queue.h>
52 #include <sys/types.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
56 #include <sys/linker_set.h>
57 #include <sys/module.h>
59 #include <sys/mutex.h>
60 #include <sys/condvar.h>
61 #include <sys/sysctl.h>
63 #include <sys/unistd.h>
64 #include <sys/callout.h>
65 #include <sys/malloc.h>
68 #include <dev/usb/usb.h>
69 #include <dev/usb/usbdi.h>
71 #include <dev/usb/usb_core.h>
72 #include <dev/usb/usb_busdma.h>
73 #include <dev/usb/usb_process.h>
74 #include <dev/usb/usb_util.h>
76 #include <dev/usb/usb_controller.h>
77 #include <dev/usb/usb_bus.h>
78 #include <dev/usb/usb_pci.h>
79 #include <dev/usb/controller/ehci.h>
80 #include <dev/usb/controller/ehcireg.h>
82 #define PCI_EHCI_VENDORID_ACERLABS 0x10b9
83 #define PCI_EHCI_VENDORID_AMD 0x1022
84 #define PCI_EHCI_VENDORID_APPLE 0x106b
85 #define PCI_EHCI_VENDORID_ATI 0x1002
86 #define PCI_EHCI_VENDORID_CMDTECH 0x1095
87 #define PCI_EHCI_VENDORID_INTEL 0x8086
88 #define PCI_EHCI_VENDORID_NEC 0x1033
89 #define PCI_EHCI_VENDORID_OPTI 0x1045
90 #define PCI_EHCI_VENDORID_PHILIPS 0x1131
91 #define PCI_EHCI_VENDORID_SIS 0x1039
92 #define PCI_EHCI_VENDORID_NVIDIA 0x12D2
93 #define PCI_EHCI_VENDORID_NVIDIA2 0x10DE
94 #define PCI_EHCI_VENDORID_VIA 0x1106
96 static void ehci_pci_takecontroller(device_t self);
98 static device_probe_t ehci_pci_probe;
99 static device_attach_t ehci_pci_attach;
100 static device_detach_t ehci_pci_detach;
101 static device_suspend_t ehci_pci_suspend;
102 static device_resume_t ehci_pci_resume;
103 static device_shutdown_t ehci_pci_shutdown;
106 ehci_pci_suspend(device_t self)
108 ehci_softc_t *sc = device_get_softc(self);
111 err = bus_generic_suspend(self);
119 ehci_pci_resume(device_t self)
121 ehci_softc_t *sc = device_get_softc(self);
123 ehci_pci_takecontroller(self);
126 bus_generic_resume(self);
132 ehci_pci_shutdown(device_t self)
134 ehci_softc_t *sc = device_get_softc(self);
137 err = bus_generic_shutdown(self);
146 ehci_pci_match(device_t self)
148 uint32_t device_id = pci_get_devid(self);
152 return ("Intel 63XXESB USB 2.0 controller");
155 return "ALi M5239 USB 2.0 controller";
158 return "AMD 8111 USB 2.0 controller";
161 return ("AMD CS5536 (Geode) USB 2.0 controller");
164 return "ATI SB200 USB 2.0 controller";
166 return "ATI SB400 USB 2.0 controller";
169 return "Intel 6300ESB USB 2.0 controller";
171 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
173 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
175 return "Intel 82801FB (ICH6) USB 2.0 controller";
177 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
180 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
182 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
184 return "Intel 82801I (ICH9) USB 2.0 controller";
186 return "Intel 82801I (ICH9) USB 2.0 controller";
188 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
190 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
192 return ("Intel PCH USB 2.0 controller USB-A");
194 return ("Intel PCH USB 2.0 controller USB-B");
197 return ("NEC uPD 720100 USB 2.0 controller");
200 return "NVIDIA nForce2 USB 2.0 controller";
202 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
204 return "NVIDIA nForce3 USB 2.0 controller";
206 return "NVIDIA nForce3 250 USB 2.0 controller";
208 return "NVIDIA nForce4 USB 2.0 controller";
210 return "NVIDIA nForce MCP55 USB 2.0 controller";
212 return "NVIDIA nForce MCP61 USB 2.0 controller";
214 return "NVIDIA nForce MCP79 USB 2.0 controller";
216 return "NVIDIA nForce MCP79 USB 2.0 controller";
218 return "NVIDIA nForce MCP79 USB 2.0 controller";
221 return "Philips ISP156x USB 2.0 controller";
224 return ("VIA VT6202 USB 2.0 controller");
230 if ((pci_get_class(self) == PCIC_SERIALBUS)
231 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
232 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
233 return ("EHCI (generic) USB 2.0 controller");
235 return (NULL); /* dunno */
239 ehci_pci_probe(device_t self)
241 const char *desc = ehci_pci_match(self);
244 device_set_desc(self, desc);
252 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
258 /* Lookup SMBUS PCI device */
259 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
262 val = pci_get_revid(smbdev);
263 if (val != 0x3a && val != 0x3b)
268 * Note: this bit is described as reserved in SB700
269 * Register Reference Guide.
271 val = pci_read_config(self, 0x53, 1);
274 pci_write_config(self, 0x53, val, 1);
275 device_printf(self, "AMD SB600/700 quirk applied\n");
280 ehci_pci_via_quirk(device_t self)
284 if ((pci_get_device(self) == 0x3104) &&
285 ((pci_get_revid(self) & 0xf0) == 0x60)) {
286 /* Correct schedule sleep time to 10us */
287 val = pci_read_config(self, 0x4b, 1);
290 pci_write_config(self, 0x4b, val, 1);
291 device_printf(self, "VIA-quirk applied\n");
296 ehci_pci_attach(device_t self)
298 ehci_softc_t *sc = device_get_softc(self);
302 /* initialise some bus fields */
303 sc->sc_bus.parent = self;
304 sc->sc_bus.devices = sc->sc_devices;
305 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
307 /* get all DMA memory */
308 if (usb_bus_mem_alloc_all(&sc->sc_bus,
309 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
313 pci_enable_busmaster(self);
315 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
316 case PCI_USB_REV_PRE_1_0:
317 case PCI_USB_REV_1_0:
318 case PCI_USB_REV_1_1:
320 * NOTE: some EHCI USB controllers have the wrong USB
321 * revision number. It appears those controllers are
322 * fully compliant so we just ignore this value in
325 device_printf(self, "pre-2.0 USB revision (ignored)\n");
327 case PCI_USB_REV_2_0:
330 /* Quirk for Parallels Desktop 4.0 */
331 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
336 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
338 if (!sc->sc_io_res) {
339 device_printf(self, "Could not map memory\n");
342 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
343 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
344 sc->sc_io_size = rman_get_size(sc->sc_io_res);
347 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
348 RF_SHAREABLE | RF_ACTIVE);
349 if (sc->sc_irq_res == NULL) {
350 device_printf(self, "Could not allocate irq\n");
353 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
354 if (!sc->sc_bus.bdev) {
355 device_printf(self, "Could not add USB device\n");
358 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
361 * ehci_pci_match will never return NULL if ehci_pci_probe
364 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
365 switch (pci_get_vendor(self)) {
366 case PCI_EHCI_VENDORID_ACERLABS:
367 sprintf(sc->sc_vendor, "AcerLabs");
369 case PCI_EHCI_VENDORID_AMD:
370 sprintf(sc->sc_vendor, "AMD");
372 case PCI_EHCI_VENDORID_APPLE:
373 sprintf(sc->sc_vendor, "Apple");
375 case PCI_EHCI_VENDORID_ATI:
376 sprintf(sc->sc_vendor, "ATI");
378 case PCI_EHCI_VENDORID_CMDTECH:
379 sprintf(sc->sc_vendor, "CMDTECH");
381 case PCI_EHCI_VENDORID_INTEL:
382 sprintf(sc->sc_vendor, "Intel");
384 case PCI_EHCI_VENDORID_NEC:
385 sprintf(sc->sc_vendor, "NEC");
387 case PCI_EHCI_VENDORID_OPTI:
388 sprintf(sc->sc_vendor, "OPTi");
390 case PCI_EHCI_VENDORID_PHILIPS:
391 sprintf(sc->sc_vendor, "Philips");
393 case PCI_EHCI_VENDORID_SIS:
394 sprintf(sc->sc_vendor, "SiS");
396 case PCI_EHCI_VENDORID_NVIDIA:
397 case PCI_EHCI_VENDORID_NVIDIA2:
398 sprintf(sc->sc_vendor, "nVidia");
400 case PCI_EHCI_VENDORID_VIA:
401 sprintf(sc->sc_vendor, "VIA");
405 device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
406 pci_get_devid(self));
407 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
410 #if (__FreeBSD_version >= 700031)
411 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
412 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
414 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
415 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
418 device_printf(self, "Could not setup irq, %d\n", err);
419 sc->sc_intr_hdl = NULL;
422 ehci_pci_takecontroller(self);
424 /* Undocumented quirks taken from Linux */
426 switch (pci_get_vendor(self)) {
427 case PCI_EHCI_VENDORID_ATI:
428 /* SB600 and SB700 EHCI quirk */
429 switch (pci_get_device(self)) {
431 ehci_pci_ati_quirk(self, 0);
434 ehci_pci_ati_quirk(self, 1);
441 case PCI_EHCI_VENDORID_VIA:
442 ehci_pci_via_quirk(self);
449 /* Dropped interrupts workaround */
450 switch (pci_get_vendor(self)) {
451 case PCI_EHCI_VENDORID_ATI:
452 case PCI_EHCI_VENDORID_VIA:
453 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
456 "Dropped interrupts workaround enabled\n");
462 /* Doorbell feature workaround */
463 switch (pci_get_vendor(self)) {
464 case PCI_EHCI_VENDORID_NVIDIA:
465 case PCI_EHCI_VENDORID_NVIDIA2:
466 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
469 "Doorbell workaround enabled\n");
477 err = device_probe_and_attach(sc->sc_bus.bdev);
480 device_printf(self, "USB init failed err=%d\n", err);
486 ehci_pci_detach(self);
491 ehci_pci_detach(device_t self)
493 ehci_softc_t *sc = device_get_softc(self);
496 if (sc->sc_bus.bdev) {
497 bdev = sc->sc_bus.bdev;
499 device_delete_child(self, bdev);
501 /* during module unload there are lots of children leftover */
502 device_delete_all_children(self);
504 pci_disable_busmaster(self);
506 if (sc->sc_irq_res && sc->sc_intr_hdl) {
508 * only call ehci_detach() after ehci_init()
512 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
515 /* XXX or should we panic? */
516 device_printf(self, "Could not tear down irq, %d\n",
518 sc->sc_intr_hdl = NULL;
520 if (sc->sc_irq_res) {
521 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
522 sc->sc_irq_res = NULL;
525 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
527 sc->sc_io_res = NULL;
529 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
535 ehci_pci_takecontroller(device_t self)
537 ehci_softc_t *sc = device_get_softc(self);
544 cparams = EREAD4(sc, EHCI_HCCPARAMS);
546 /* Synchronise with the BIOS if it owns the controller. */
547 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
548 eecp = EHCI_EECP_NEXT(eec)) {
549 eec = pci_read_config(self, eecp, 4);
550 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
553 bios_sem = pci_read_config(self, eecp +
554 EHCI_LEGSUP_BIOS_SEM, 1);
558 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
559 "to give up control\n");
560 pci_write_config(self, eecp +
561 EHCI_LEGSUP_OS_SEM, 1, 1);
564 bios_sem = pci_read_config(self, eecp +
565 EHCI_LEGSUP_BIOS_SEM, 1);
570 device_printf(sc->sc_bus.bdev,
571 "timed out waiting for BIOS\n");
574 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */
579 static driver_t ehci_driver =
582 .methods = (device_method_t[]){
583 /* device interface */
584 DEVMETHOD(device_probe, ehci_pci_probe),
585 DEVMETHOD(device_attach, ehci_pci_attach),
586 DEVMETHOD(device_detach, ehci_pci_detach),
587 DEVMETHOD(device_suspend, ehci_pci_suspend),
588 DEVMETHOD(device_resume, ehci_pci_resume),
589 DEVMETHOD(device_shutdown, ehci_pci_shutdown),
591 DEVMETHOD(bus_print_child, bus_generic_print_child),
595 .size = sizeof(struct ehci_softc),
598 static devclass_t ehci_devclass;
600 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
601 MODULE_DEPEND(ehci, usb, 1, 1, 1);