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/module.h>
58 #include <sys/mutex.h>
59 #include <sys/condvar.h>
60 #include <sys/sysctl.h>
62 #include <sys/unistd.h>
63 #include <sys/callout.h>
64 #include <sys/malloc.h>
67 #include <dev/usb/usb.h>
68 #include <dev/usb/usbdi.h>
70 #include <dev/usb/usb_core.h>
71 #include <dev/usb/usb_busdma.h>
72 #include <dev/usb/usb_process.h>
73 #include <dev/usb/usb_util.h>
75 #include <dev/usb/usb_controller.h>
76 #include <dev/usb/usb_bus.h>
77 #include <dev/usb/usb_pci.h>
78 #include <dev/usb/controller/ehci.h>
79 #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 device_probe_t ehci_pci_probe;
97 static device_attach_t ehci_pci_attach;
98 static device_detach_t ehci_pci_detach;
99 static usb_take_controller_t ehci_pci_take_controller;
102 ehci_pci_match(device_t self)
104 uint32_t device_id = pci_get_devid(self);
108 return "ALi M5239 USB 2.0 controller";
111 return "AMD 8111 USB 2.0 controller";
114 return ("AMD CS5536 (Geode) USB 2.0 controller");
117 return "ATI SB200 USB 2.0 controller";
119 return "ATI SB400 USB 2.0 controller";
121 return ("AMD SB7x0/SB8x0/SB9x0 USB 2.0 controller");
124 return ("Intel BayTrail USB 2.0 controller");
126 return ("Intel Patsburg USB 2.0 controller");
128 return ("Intel Patsburg USB 2.0 controller");
130 return ("Intel Panther Point USB 2.0 controller");
132 return ("Intel Panther Point USB 2.0 controller");
134 return ("Intel Avoton USB 2.0 controller");
136 return "Intel 6300ESB USB 2.0 controller";
138 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
140 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
142 return "Intel 82801FB (ICH6) USB 2.0 controller";
144 return ("Intel 63XXESB USB 2.0 controller");
146 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
148 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
150 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
152 return "Intel 82801I (ICH9) USB 2.0 controller";
154 return "Intel 82801I (ICH9) USB 2.0 controller";
156 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
158 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
160 return ("Intel PCH USB 2.0 controller USB-A");
162 return ("Intel PCH USB 2.0 controller USB-B");
164 return ("Intel Lynx Point USB 2.0 controller USB-A");
166 return ("Intel Lynx Point USB 2.0 controller USB-B");
168 return ("Intel Wildcat Point USB 2.0 controller USB-A");
170 return ("Intel Wildcat Point USB 2.0 controller USB-B");
172 return ("Intel Lynx Point LP USB 2.0 controller USB");
175 return ("NEC uPD 72010x USB 2.0 controller");
178 return "NVIDIA nForce2 USB 2.0 controller";
180 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
182 return "NVIDIA nForce3 USB 2.0 controller";
184 return "NVIDIA nForce3 250 USB 2.0 controller";
186 return "NVIDIA nForce CK804 USB 2.0 controller";
188 return "NVIDIA nForce MCP55 USB 2.0 controller";
190 return "NVIDIA nForce MCP61 USB 2.0 controller";
192 return "NVIDIA nForce MCP79 USB 2.0 controller";
194 return "NVIDIA nForce MCP79 USB 2.0 controller";
196 return "NVIDIA nForce MCP79 USB 2.0 controller";
199 return "Philips ISP156x USB 2.0 controller";
202 return ("VIA VT6202 USB 2.0 controller");
208 if ((pci_get_class(self) == PCIC_SERIALBUS)
209 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
210 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
211 return ("EHCI (generic) USB 2.0 controller");
213 return (NULL); /* dunno */
217 ehci_pci_probe(device_t self)
219 const char *desc = ehci_pci_match(self);
222 device_set_desc(self, desc);
223 return (BUS_PROBE_DEFAULT);
230 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
236 /* Lookup SMBUS PCI device */
237 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
240 val = pci_get_revid(smbdev);
241 if (val != 0x3a && val != 0x3b)
246 * Note: this bit is described as reserved in SB700
247 * Register Reference Guide.
249 val = pci_read_config(self, 0x53, 1);
252 pci_write_config(self, 0x53, val, 1);
253 device_printf(self, "AMD SB600/700 quirk applied\n");
258 ehci_pci_via_quirk(device_t self)
262 if ((pci_get_device(self) == 0x3104) &&
263 ((pci_get_revid(self) & 0xf0) == 0x60)) {
264 /* Correct schedule sleep time to 10us */
265 val = pci_read_config(self, 0x4b, 1);
269 pci_write_config(self, 0x4b, val, 1);
270 device_printf(self, "VIA-quirk applied\n");
275 ehci_pci_attach(device_t self)
277 ehci_softc_t *sc = device_get_softc(self);
281 /* initialise some bus fields */
282 sc->sc_bus.parent = self;
283 sc->sc_bus.devices = sc->sc_devices;
284 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
285 sc->sc_bus.dma_bits = 32;
287 /* get all DMA memory */
288 if (usb_bus_mem_alloc_all(&sc->sc_bus,
289 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
293 pci_enable_busmaster(self);
295 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
296 case PCI_USB_REV_PRE_1_0:
297 case PCI_USB_REV_1_0:
298 case PCI_USB_REV_1_1:
300 * NOTE: some EHCI USB controllers have the wrong USB
301 * revision number. It appears those controllers are
302 * fully compliant so we just ignore this value in
305 device_printf(self, "pre-2.0 USB revision (ignored)\n");
307 case PCI_USB_REV_2_0:
310 /* Quirk for Parallels Desktop 4.0 */
311 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
316 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
318 if (!sc->sc_io_res) {
319 device_printf(self, "Could not map memory\n");
322 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
323 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
324 sc->sc_io_size = rman_get_size(sc->sc_io_res);
327 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
328 RF_SHAREABLE | RF_ACTIVE);
329 if (sc->sc_irq_res == NULL) {
330 device_printf(self, "Could not allocate irq\n");
333 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
334 if (!sc->sc_bus.bdev) {
335 device_printf(self, "Could not add USB device\n");
338 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
341 * ehci_pci_match will never return NULL if ehci_pci_probe
344 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
345 switch (pci_get_vendor(self)) {
346 case PCI_EHCI_VENDORID_ACERLABS:
347 sprintf(sc->sc_vendor, "AcerLabs");
349 case PCI_EHCI_VENDORID_AMD:
350 sprintf(sc->sc_vendor, "AMD");
352 case PCI_EHCI_VENDORID_APPLE:
353 sprintf(sc->sc_vendor, "Apple");
355 case PCI_EHCI_VENDORID_ATI:
356 sprintf(sc->sc_vendor, "ATI");
358 case PCI_EHCI_VENDORID_CMDTECH:
359 sprintf(sc->sc_vendor, "CMDTECH");
361 case PCI_EHCI_VENDORID_INTEL:
362 sprintf(sc->sc_vendor, "Intel");
364 case PCI_EHCI_VENDORID_NEC:
365 sprintf(sc->sc_vendor, "NEC");
367 case PCI_EHCI_VENDORID_OPTI:
368 sprintf(sc->sc_vendor, "OPTi");
370 case PCI_EHCI_VENDORID_PHILIPS:
371 sprintf(sc->sc_vendor, "Philips");
373 case PCI_EHCI_VENDORID_SIS:
374 sprintf(sc->sc_vendor, "SiS");
376 case PCI_EHCI_VENDORID_NVIDIA:
377 case PCI_EHCI_VENDORID_NVIDIA2:
378 sprintf(sc->sc_vendor, "nVidia");
380 case PCI_EHCI_VENDORID_VIA:
381 sprintf(sc->sc_vendor, "VIA");
385 device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
386 pci_get_devid(self));
387 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
390 #if (__FreeBSD_version >= 700031)
391 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
392 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
394 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
395 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
398 device_printf(self, "Could not setup irq, %d\n", err);
399 sc->sc_intr_hdl = NULL;
402 ehci_pci_take_controller(self);
404 /* Undocumented quirks taken from Linux */
406 switch (pci_get_vendor(self)) {
407 case PCI_EHCI_VENDORID_ATI:
408 /* SB600 and SB700 EHCI quirk */
409 switch (pci_get_device(self)) {
411 ehci_pci_ati_quirk(self, 0);
414 ehci_pci_ati_quirk(self, 1);
421 case PCI_EHCI_VENDORID_VIA:
422 ehci_pci_via_quirk(self);
429 /* Dropped interrupts workaround */
430 switch (pci_get_vendor(self)) {
431 case PCI_EHCI_VENDORID_ATI:
432 case PCI_EHCI_VENDORID_VIA:
433 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
436 "Dropped interrupts workaround enabled\n");
442 /* Doorbell feature workaround */
443 switch (pci_get_vendor(self)) {
444 case PCI_EHCI_VENDORID_NVIDIA:
445 case PCI_EHCI_VENDORID_NVIDIA2:
446 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
449 "Doorbell workaround enabled\n");
457 err = device_probe_and_attach(sc->sc_bus.bdev);
460 device_printf(self, "USB init failed err=%d\n", err);
466 ehci_pci_detach(self);
471 ehci_pci_detach(device_t self)
473 ehci_softc_t *sc = device_get_softc(self);
476 if (sc->sc_bus.bdev) {
477 bdev = sc->sc_bus.bdev;
479 device_delete_child(self, bdev);
481 /* during module unload there are lots of children leftover */
482 device_delete_children(self);
484 pci_disable_busmaster(self);
486 if (sc->sc_irq_res && sc->sc_intr_hdl) {
488 * only call ehci_detach() after ehci_init()
492 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
495 /* XXX or should we panic? */
496 device_printf(self, "Could not tear down irq, %d\n",
498 sc->sc_intr_hdl = NULL;
500 if (sc->sc_irq_res) {
501 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
502 sc->sc_irq_res = NULL;
505 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
507 sc->sc_io_res = NULL;
509 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
515 ehci_pci_take_controller(device_t self)
517 ehci_softc_t *sc = device_get_softc(self);
524 cparams = EREAD4(sc, EHCI_HCCPARAMS);
526 /* Synchronise with the BIOS if it owns the controller. */
527 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
528 eecp = EHCI_EECP_NEXT(eec)) {
529 eec = pci_read_config(self, eecp, 4);
530 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
533 bios_sem = pci_read_config(self, eecp +
534 EHCI_LEGSUP_BIOS_SEM, 1);
538 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
539 "to give up control\n");
540 pci_write_config(self, eecp +
541 EHCI_LEGSUP_OS_SEM, 1, 1);
544 bios_sem = pci_read_config(self, eecp +
545 EHCI_LEGSUP_BIOS_SEM, 1);
550 device_printf(sc->sc_bus.bdev,
551 "timed out waiting for BIOS\n");
554 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */
560 static device_method_t ehci_pci_methods[] = {
561 /* Device interface */
562 DEVMETHOD(device_probe, ehci_pci_probe),
563 DEVMETHOD(device_attach, ehci_pci_attach),
564 DEVMETHOD(device_detach, ehci_pci_detach),
565 DEVMETHOD(device_suspend, bus_generic_suspend),
566 DEVMETHOD(device_resume, bus_generic_resume),
567 DEVMETHOD(device_shutdown, bus_generic_shutdown),
568 DEVMETHOD(usb_take_controller, ehci_pci_take_controller),
573 static driver_t ehci_driver = {
575 .methods = ehci_pci_methods,
576 .size = sizeof(struct ehci_softc),
579 static devclass_t ehci_devclass;
581 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
582 MODULE_DEPEND(ehci, usb, 1, 1, 1);