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.
17 * 3. All advertising materials mentioning features or use of this software
18 * must display the following acknowledgement:
19 * This product includes software developed by the NetBSD
20 * Foundation, Inc. and its contributors.
21 * 4. Neither the name of The NetBSD Foundation nor the names of its
22 * contributors may be used to endorse or promote products derived
23 * from this software without specific prior written permission.
25 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35 * POSSIBILITY OF SUCH DAMAGE.
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
42 * USB Open Host Controller driver.
44 * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf
47 /* The low level controller code for OHCI has been split into
48 * PCI probes and OHCI specific code. This was done to facilitate the
49 * sharing of code between *BSD's
52 #include <sys/stdint.h>
53 #include <sys/stddef.h>
54 #include <sys/param.h>
55 #include <sys/queue.h>
56 #include <sys/types.h>
57 #include <sys/systm.h>
58 #include <sys/kernel.h>
60 #include <sys/linker_set.h>
61 #include <sys/module.h>
63 #include <sys/mutex.h>
64 #include <sys/condvar.h>
65 #include <sys/sysctl.h>
67 #include <sys/unistd.h>
68 #include <sys/callout.h>
69 #include <sys/malloc.h>
72 #include <dev/usb/usb.h>
73 #include <dev/usb/usbdi.h>
75 #include <dev/usb/usb_core.h>
76 #include <dev/usb/usb_busdma.h>
77 #include <dev/usb/usb_process.h>
78 #include <dev/usb/usb_util.h>
80 #include <dev/usb/usb_controller.h>
81 #include <dev/usb/usb_bus.h>
82 #include <dev/usb/usb_pci.h>
83 #include <dev/usb/controller/ohci.h>
84 #include <dev/usb/controller/ohcireg.h>
86 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9
87 #define PCI_OHCI_VENDORID_AMD 0x1022
88 #define PCI_OHCI_VENDORID_APPLE 0x106b
89 #define PCI_OHCI_VENDORID_ATI 0x1002
90 #define PCI_OHCI_VENDORID_CMDTECH 0x1095
91 #define PCI_OHCI_VENDORID_NEC 0x1033
92 #define PCI_OHCI_VENDORID_NVIDIA 0x12D2
93 #define PCI_OHCI_VENDORID_NVIDIA2 0x10DE
94 #define PCI_OHCI_VENDORID_OPTI 0x1045
95 #define PCI_OHCI_VENDORID_SIS 0x1039
96 #define PCI_OHCI_VENDORID_SUN 0x108e
98 #define PCI_OHCI_BASE_REG 0x10
100 static device_probe_t ohci_pci_probe;
101 static device_attach_t ohci_pci_attach;
102 static device_detach_t ohci_pci_detach;
103 static device_suspend_t ohci_pci_suspend;
104 static device_resume_t ohci_pci_resume;
107 ohci_pci_suspend(device_t self)
109 ohci_softc_t *sc = device_get_softc(self);
112 err = bus_generic_suspend(self);
121 ohci_pci_resume(device_t self)
123 ohci_softc_t *sc = device_get_softc(self);
124 uint32_t reg, int_line;
126 if (pci_get_powerstate(self) != PCI_POWERSTATE_D0) {
127 device_printf(self, "chip is in D%d mode "
128 "-- setting to D0\n", pci_get_powerstate(self));
129 reg = pci_read_config(self, PCI_CBMEM, 4);
130 int_line = pci_read_config(self, PCIR_INTLINE, 4);
131 pci_set_powerstate(self, PCI_POWERSTATE_D0);
132 pci_write_config(self, PCI_CBMEM, reg, 4);
133 pci_write_config(self, PCIR_INTLINE, int_line, 4);
137 bus_generic_resume(self);
142 ohci_pci_match(device_t self)
144 uint32_t device_id = pci_get_devid(self);
148 return ("AcerLabs M5237 (Aladdin-V) USB controller");
151 return ("AMD-756 USB Controller");
154 return ("AMD-766 USB Controller");
157 return "ATI SB400 USB Controller";
159 return "ATI SB400 USB Controller";
162 return ("CMD Tech 670 (USB0670) USB controller");
165 return ("CMD Tech 673 (USB0673) USB controller");
168 return ("OPTi 82C861 (FireLink) USB controller");
171 return ("NEC uPD 9210 USB controller");
174 return ("nVidia nForce3 USB Controller");
177 return ("nVidia nForce MCP55 USB Controller");
179 return ("nVidia nForce MCP61 USB Controller");
181 return ("nVidia nForce MCP79 USB Controller");
183 return ("nVidia nForce MCP79 USB Controller");
185 return ("nVidia nForce MCP79 USB Controller");
188 return ("SiS 5571 USB controller");
191 return "Sun PCIO-2 USB controller";
194 return ("Apple KeyLargo USB controller");
199 if ((pci_get_class(self) == PCIC_SERIALBUS) &&
200 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) &&
201 (pci_get_progif(self) == PCI_INTERFACE_OHCI)) {
202 return ("OHCI (generic) USB controller");
208 ohci_pci_probe(device_t self)
210 const char *desc = ohci_pci_match(self);
213 device_set_desc(self, desc);
221 ohci_pci_attach(device_t self)
223 ohci_softc_t *sc = device_get_softc(self);
227 /* initialise some bus fields */
228 sc->sc_bus.parent = self;
229 sc->sc_bus.devices = sc->sc_devices;
230 sc->sc_bus.devices_max = OHCI_MAX_DEVICES;
232 /* get all DMA memory */
233 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self),
234 &ohci_iterate_hw_softc)) {
239 pci_enable_busmaster(self);
242 * Some Sun PCIO-2 USB controllers have their intpin register
243 * bogusly set to 0, although it should be 4. Correct that.
245 if (pci_get_devid(self) == 0x1103108e && pci_get_intpin(self) == 0)
246 pci_set_intpin(self, 4);
249 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
251 if (!sc->sc_io_res) {
252 device_printf(self, "Could not map memory\n");
255 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
256 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
257 sc->sc_io_size = rman_get_size(sc->sc_io_res);
260 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
261 RF_SHAREABLE | RF_ACTIVE);
262 if (sc->sc_irq_res == NULL) {
263 device_printf(self, "Could not allocate irq\n");
266 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
267 if (!sc->sc_bus.bdev) {
268 device_printf(self, "Could not add USB device\n");
271 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
274 * ohci_pci_match will never return NULL if ohci_pci_probe
277 device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
278 switch (pci_get_vendor(self)) {
279 case PCI_OHCI_VENDORID_ACERLABS:
280 sprintf(sc->sc_vendor, "AcerLabs");
282 case PCI_OHCI_VENDORID_AMD:
283 sprintf(sc->sc_vendor, "AMD");
285 case PCI_OHCI_VENDORID_APPLE:
286 sprintf(sc->sc_vendor, "Apple");
288 case PCI_OHCI_VENDORID_ATI:
289 sprintf(sc->sc_vendor, "ATI");
291 case PCI_OHCI_VENDORID_CMDTECH:
292 sprintf(sc->sc_vendor, "CMDTECH");
294 case PCI_OHCI_VENDORID_NEC:
295 sprintf(sc->sc_vendor, "NEC");
297 case PCI_OHCI_VENDORID_NVIDIA:
298 case PCI_OHCI_VENDORID_NVIDIA2:
299 sprintf(sc->sc_vendor, "nVidia");
301 case PCI_OHCI_VENDORID_OPTI:
302 sprintf(sc->sc_vendor, "OPTi");
304 case PCI_OHCI_VENDORID_SIS:
305 sprintf(sc->sc_vendor, "SiS");
307 case PCI_OHCI_VENDORID_SUN:
308 sprintf(sc->sc_vendor, "SUN");
312 device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
313 pci_get_devid(self));
315 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
318 /* sc->sc_bus.usbrev; set by ohci_init() */
320 #if (__FreeBSD_version >= 700031)
321 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
322 NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl);
324 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
325 (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl);
328 device_printf(self, "Could not setup irq, %d\n", err);
329 sc->sc_intr_hdl = NULL;
334 err = device_probe_and_attach(sc->sc_bus.bdev);
337 device_printf(self, "USB init failed\n");
343 ohci_pci_detach(self);
348 ohci_pci_detach(device_t self)
350 ohci_softc_t *sc = device_get_softc(self);
353 if (sc->sc_bus.bdev) {
354 bdev = sc->sc_bus.bdev;
356 device_delete_child(self, bdev);
358 /* during module unload there are lots of children leftover */
359 device_delete_all_children(self);
361 pci_disable_busmaster(self);
363 if (sc->sc_irq_res && sc->sc_intr_hdl) {
365 * only call ohci_detach() after ohci_init()
369 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
372 /* XXX or should we panic? */
373 device_printf(self, "Could not tear down irq, %d\n",
376 sc->sc_intr_hdl = NULL;
378 if (sc->sc_irq_res) {
379 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
380 sc->sc_irq_res = NULL;
383 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
385 sc->sc_io_res = NULL;
387 usb_bus_mem_free_all(&sc->sc_bus, &ohci_iterate_hw_softc);
392 static driver_t ohci_driver =
395 .methods = (device_method_t[]){
396 /* device interface */
397 DEVMETHOD(device_probe, ohci_pci_probe),
398 DEVMETHOD(device_attach, ohci_pci_attach),
399 DEVMETHOD(device_detach, ohci_pci_detach),
400 DEVMETHOD(device_suspend, ohci_pci_suspend),
401 DEVMETHOD(device_resume, ohci_pci_resume),
402 DEVMETHOD(device_shutdown, bus_generic_shutdown),
405 DEVMETHOD(bus_print_child, bus_generic_print_child),
409 .size = sizeof(struct ohci_softc),
412 static devclass_t ohci_devclass;
414 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
415 MODULE_DEPEND(ohci, usb, 1, 1, 1);