2 * SPDX-License-Identifier: BSD-2-Clause-NetBSD
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$");
37 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
39 * The EHCI 1.0 spec can be found at
40 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
41 * and the USB 2.0 spec at
42 * http://www.usb.org/developers/docs/usb_20.zip
45 /* The low level controller code for EHCI has been split into
46 * PCI probes and EHCI specific code. This was done to facilitate the
47 * sharing of code between *BSD's
50 #include <sys/stdint.h>
51 #include <sys/stddef.h>
52 #include <sys/param.h>
53 #include <sys/queue.h>
54 #include <sys/types.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
58 #include <sys/module.h>
60 #include <sys/mutex.h>
61 #include <sys/condvar.h>
62 #include <sys/sysctl.h>
64 #include <sys/unistd.h>
65 #include <sys/callout.h>
66 #include <sys/malloc.h>
69 #include <dev/usb/usb.h>
70 #include <dev/usb/usbdi.h>
72 #include <dev/usb/usb_core.h>
73 #include <dev/usb/usb_busdma.h>
74 #include <dev/usb/usb_process.h>
75 #include <dev/usb/usb_util.h>
77 #include <dev/usb/usb_controller.h>
78 #include <dev/usb/usb_bus.h>
79 #include <dev/usb/usb_pci.h>
80 #include <dev/usb/controller/ehci.h>
81 #include <dev/usb/controller/ehcireg.h>
84 #define PCI_EHCI_VENDORID_ACERLABS 0x10b9
85 #define PCI_EHCI_VENDORID_AMD 0x1022
86 #define PCI_EHCI_VENDORID_APPLE 0x106b
87 #define PCI_EHCI_VENDORID_ATI 0x1002
88 #define PCI_EHCI_VENDORID_CMDTECH 0x1095
89 #define PCI_EHCI_VENDORID_HYGON 0x1d94
90 #define PCI_EHCI_VENDORID_INTEL 0x8086
91 #define PCI_EHCI_VENDORID_NEC 0x1033
92 #define PCI_EHCI_VENDORID_OPTI 0x1045
93 #define PCI_EHCI_VENDORID_PHILIPS 0x1131
94 #define PCI_EHCI_VENDORID_SIS 0x1039
95 #define PCI_EHCI_VENDORID_NVIDIA 0x12D2
96 #define PCI_EHCI_VENDORID_NVIDIA2 0x10DE
97 #define PCI_EHCI_VENDORID_VIA 0x1106
99 static device_probe_t ehci_pci_probe;
100 static device_attach_t ehci_pci_attach;
101 static device_detach_t ehci_pci_detach;
102 static usb_take_controller_t ehci_pci_take_controller;
105 ehci_pci_match(device_t self)
107 uint32_t device_id = pci_get_devid(self);
111 return "ALi M5239 USB 2.0 controller";
114 return "AMD 8111 USB 2.0 controller";
117 return ("AMD CS5536 (Geode) USB 2.0 controller");
119 return ("AMD FCH USB 2.0 controller");
122 return "ATI SB200 USB 2.0 controller";
124 return "ATI SB400 USB 2.0 controller";
126 return ("AMD SB7x0/SB8x0/SB9x0 USB 2.0 controller");
129 return ("Intel BayTrail USB 2.0 controller");
131 return ("Intel Cougar Point USB 2.0 controller");
133 return ("Intel Cougar Point USB 2.0 controller");
135 return ("Intel Patsburg USB 2.0 controller");
137 return ("Intel Patsburg USB 2.0 controller");
139 return ("Intel Panther Point USB 2.0 controller");
141 return ("Intel Panther Point USB 2.0 controller");
143 return ("Intel Avoton USB 2.0 controller");
145 return "Intel 6300ESB USB 2.0 controller";
147 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
149 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
151 return "Intel 82801FB (ICH6) USB 2.0 controller";
153 return ("Intel 63XXESB USB 2.0 controller");
155 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
157 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
159 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
161 return "Intel 82801I (ICH9) USB 2.0 controller";
163 return "Intel 82801I (ICH9) USB 2.0 controller";
165 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
167 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
169 return ("Intel PCH USB 2.0 controller USB-A");
171 return ("Intel PCH USB 2.0 controller USB-B");
173 return ("Intel Lynx Point USB 2.0 controller USB-A");
175 return ("Intel Lynx Point USB 2.0 controller USB-B");
177 return ("Intel Wildcat Point USB 2.0 controller USB-A");
179 return ("Intel Wildcat Point USB 2.0 controller USB-B");
181 return ("Intel Wellsburg USB 2.0 controller");
183 return ("Intel Wellsburg USB 2.0 controller");
185 return ("Intel Lynx Point-LP USB 2.0 controller");
187 return ("Intel Wildcat Point-LP USB 2.0 controller");
190 return ("NEC uPD 72010x USB 2.0 controller");
193 return "NVIDIA nForce2 USB 2.0 controller";
195 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
197 return "NVIDIA nForce3 USB 2.0 controller";
199 return "NVIDIA nForce3 250 USB 2.0 controller";
201 return "NVIDIA nForce CK804 USB 2.0 controller";
203 return "NVIDIA nForce MCP55 USB 2.0 controller";
205 return "NVIDIA nForce MCP61 USB 2.0 controller";
207 return "NVIDIA nForce MCP79 USB 2.0 controller";
209 return "NVIDIA nForce MCP79 USB 2.0 controller";
211 return "NVIDIA nForce MCP79 USB 2.0 controller";
214 return "Philips ISP156x USB 2.0 controller";
217 return "SiS 968 USB 2.0 controller";
220 return ("VIA VT6202 USB 2.0 controller");
226 if ((pci_get_class(self) == PCIC_SERIALBUS)
227 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
228 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
229 return ("EHCI (generic) USB 2.0 controller");
231 return (NULL); /* dunno */
235 ehci_pci_probe(device_t self)
237 const char *desc = ehci_pci_match(self);
240 device_set_desc(self, desc);
241 return (BUS_PROBE_DEFAULT);
248 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
254 /* Lookup SMBUS PCI device */
255 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
258 val = pci_get_revid(smbdev);
259 if (val != 0x3a && val != 0x3b)
264 * Note: this bit is described as reserved in SB700
265 * Register Reference Guide.
267 val = pci_read_config(self, 0x53, 1);
270 pci_write_config(self, 0x53, val, 1);
271 device_printf(self, "AMD SB600/700 quirk applied\n");
276 ehci_pci_via_quirk(device_t self)
280 if ((pci_get_device(self) == 0x3104) &&
281 ((pci_get_revid(self) & 0xf0) == 0x60)) {
282 /* Correct schedule sleep time to 10us */
283 val = pci_read_config(self, 0x4b, 1);
287 pci_write_config(self, 0x4b, val, 1);
288 device_printf(self, "VIA-quirk applied\n");
293 ehci_pci_attach(device_t self)
295 ehci_softc_t *sc = device_get_softc(self);
299 /* initialise some bus fields */
300 sc->sc_bus.parent = self;
301 sc->sc_bus.devices = sc->sc_devices;
302 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
303 sc->sc_bus.dma_bits = 32;
305 /* get all DMA memory */
306 if (usb_bus_mem_alloc_all(&sc->sc_bus,
307 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
311 pci_enable_busmaster(self);
313 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
314 case PCI_USB_REV_PRE_1_0:
315 case PCI_USB_REV_1_0:
316 case PCI_USB_REV_1_1:
318 * NOTE: some EHCI USB controllers have the wrong USB
319 * revision number. It appears those controllers are
320 * fully compliant so we just ignore this value in
323 device_printf(self, "pre-2.0 USB revision (ignored)\n");
325 case PCI_USB_REV_2_0:
328 /* Quirk for Parallels Desktop 4.0 */
329 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
334 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
336 if (!sc->sc_io_res) {
337 device_printf(self, "Could not map memory\n");
340 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
341 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
342 sc->sc_io_size = rman_get_size(sc->sc_io_res);
345 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
346 RF_SHAREABLE | RF_ACTIVE);
347 if (sc->sc_irq_res == NULL) {
348 device_printf(self, "Could not allocate irq\n");
351 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
352 if (!sc->sc_bus.bdev) {
353 device_printf(self, "Could not add USB device\n");
356 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
359 * ehci_pci_match will never return NULL if ehci_pci_probe
362 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
363 switch (pci_get_vendor(self)) {
364 case PCI_EHCI_VENDORID_ACERLABS:
365 sprintf(sc->sc_vendor, "AcerLabs");
367 case PCI_EHCI_VENDORID_AMD:
368 sprintf(sc->sc_vendor, "AMD");
370 case PCI_EHCI_VENDORID_APPLE:
371 sprintf(sc->sc_vendor, "Apple");
373 case PCI_EHCI_VENDORID_ATI:
374 sprintf(sc->sc_vendor, "ATI");
376 case PCI_EHCI_VENDORID_CMDTECH:
377 sprintf(sc->sc_vendor, "CMDTECH");
379 case PCI_EHCI_VENDORID_HYGON:
380 sprintf(sc->sc_vendor, "Hygon");
382 case PCI_EHCI_VENDORID_INTEL:
383 sprintf(sc->sc_vendor, "Intel");
385 case PCI_EHCI_VENDORID_NEC:
386 sprintf(sc->sc_vendor, "NEC");
388 case PCI_EHCI_VENDORID_OPTI:
389 sprintf(sc->sc_vendor, "OPTi");
391 case PCI_EHCI_VENDORID_PHILIPS:
392 sprintf(sc->sc_vendor, "Philips");
394 case PCI_EHCI_VENDORID_SIS:
395 sprintf(sc->sc_vendor, "SiS");
397 case PCI_EHCI_VENDORID_NVIDIA:
398 case PCI_EHCI_VENDORID_NVIDIA2:
399 sprintf(sc->sc_vendor, "nVidia");
401 case PCI_EHCI_VENDORID_VIA:
402 sprintf(sc->sc_vendor, "VIA");
406 device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
407 pci_get_devid(self));
408 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
411 #if (__FreeBSD_version >= 700031)
412 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
413 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
415 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
416 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
419 device_printf(self, "Could not setup irq, %d\n", err);
420 sc->sc_intr_hdl = NULL;
423 ehci_pci_take_controller(self);
425 /* Undocumented quirks taken from Linux */
427 switch (pci_get_vendor(self)) {
428 case PCI_EHCI_VENDORID_ATI:
429 /* SB600 and SB700 EHCI quirk */
430 switch (pci_get_device(self)) {
432 ehci_pci_ati_quirk(self, 0);
435 ehci_pci_ati_quirk(self, 1);
442 case PCI_EHCI_VENDORID_VIA:
443 ehci_pci_via_quirk(self);
450 /* Dropped interrupts workaround */
451 switch (pci_get_vendor(self)) {
452 case PCI_EHCI_VENDORID_ATI:
453 case PCI_EHCI_VENDORID_VIA:
454 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
457 "Dropped interrupts workaround enabled\n");
463 /* Doorbell feature workaround */
464 switch (pci_get_vendor(self)) {
465 case PCI_EHCI_VENDORID_NVIDIA:
466 case PCI_EHCI_VENDORID_NVIDIA2:
467 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
470 "Doorbell workaround enabled\n");
478 err = device_probe_and_attach(sc->sc_bus.bdev);
481 device_printf(self, "USB init failed err=%d\n", err);
487 ehci_pci_detach(self);
492 ehci_pci_detach(device_t self)
494 ehci_softc_t *sc = device_get_softc(self);
496 /* during module unload there are lots of children leftover */
497 device_delete_children(self);
499 pci_disable_busmaster(self);
501 if (sc->sc_irq_res && sc->sc_intr_hdl) {
503 * only call ehci_detach() after ehci_init()
507 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
510 /* XXX or should we panic? */
511 device_printf(self, "Could not tear down irq, %d\n",
513 sc->sc_intr_hdl = NULL;
515 if (sc->sc_irq_res) {
516 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
517 sc->sc_irq_res = NULL;
520 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
522 sc->sc_io_res = NULL;
524 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
530 ehci_pci_take_controller(device_t self)
532 ehci_softc_t *sc = device_get_softc(self);
539 cparams = EREAD4(sc, EHCI_HCCPARAMS);
541 /* Synchronise with the BIOS if it owns the controller. */
542 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
543 eecp = EHCI_EECP_NEXT(eec)) {
544 eec = pci_read_config(self, eecp, 4);
545 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
548 bios_sem = pci_read_config(self, eecp +
549 EHCI_LEGSUP_BIOS_SEM, 1);
553 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
554 "to give up control\n");
555 pci_write_config(self, eecp +
556 EHCI_LEGSUP_OS_SEM, 1, 1);
559 bios_sem = pci_read_config(self, eecp +
560 EHCI_LEGSUP_BIOS_SEM, 1);
565 device_printf(sc->sc_bus.bdev,
566 "timed out waiting for BIOS\n");
569 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */
575 static device_method_t ehci_pci_methods[] = {
576 /* Device interface */
577 DEVMETHOD(device_probe, ehci_pci_probe),
578 DEVMETHOD(device_attach, ehci_pci_attach),
579 DEVMETHOD(device_detach, ehci_pci_detach),
580 DEVMETHOD(device_suspend, bus_generic_suspend),
581 DEVMETHOD(device_resume, bus_generic_resume),
582 DEVMETHOD(device_shutdown, bus_generic_shutdown),
583 DEVMETHOD(usb_take_controller, ehci_pci_take_controller),
588 static driver_t ehci_driver = {
590 .methods = ehci_pci_methods,
591 .size = sizeof(struct ehci_softc),
594 static devclass_t ehci_devclass;
596 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
597 MODULE_DEPEND(ehci, usb, 1, 1, 1);