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
54 #include <sys/param.h>
55 #include <sys/systm.h>
56 #include <sys/kernel.h>
57 #include <sys/module.h>
59 #include <sys/queue.h>
60 #include <machine/bus.h>
62 #include <machine/resource.h>
64 #include <dev/pci/pcivar.h>
65 #include <dev/pci/pcireg.h>
67 #include <dev/usb/usb.h>
68 #include <dev/usb/usbdi.h>
69 #include <dev/usb/usbdivar.h>
70 #include <dev/usb/usb_mem.h>
72 #include <dev/usb/ohcireg.h>
73 #include <dev/usb/ohcivar.h>
75 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9
76 #define PCI_OHCI_VENDORID_AMD 0x1022
77 #define PCI_OHCI_VENDORID_APPLE 0x106b
78 #define PCI_OHCI_VENDORID_CMDTECH 0x1095
79 #define PCI_OHCI_VENDORID_NEC 0x1033
80 #define PCI_OHCI_VENDORID_NVIDIA 0x12D2
81 #define PCI_OHCI_VENDORID_NVIDIA2 0x10DE
82 #define PCI_OHCI_VENDORID_OPTI 0x1045
83 #define PCI_OHCI_VENDORID_SIS 0x1039
84 #define PCI_OHCI_VENDORID_SUN 0x108e
86 #define PCI_OHCI_DEVICEID_ALADDIN_V 0x523710b9
87 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
89 #define PCI_OHCI_DEVICEID_AMD756 0x740c1022
90 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
92 #define PCI_OHCI_DEVICEID_AMD766 0x74141022
93 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
95 #define PCI_OHCI_DEVICEID_FIRELINK 0xc8611045
96 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
98 #define PCI_OHCI_DEVICEID_NEC 0x00351033
99 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
101 #define PCI_OHCI_DEVICEID_NFORCE3 0x00d710de
102 static const char *ohci_device_nforce3 = "nVidia nForce3 USB Controller";
104 #define PCI_OHCI_DEVICEID_USB0670 0x06701095
105 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
107 #define PCI_OHCI_DEVICEID_USB0673 0x06731095
108 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
110 #define PCI_OHCI_DEVICEID_SIS5571 0x70011039
111 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
113 #define PCI_OHCI_DEVICEID_KEYLARGO 0x0019106b
114 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
116 #define PCI_OHCI_DEVICEID_PCIO2USB 0x1103108e
117 static const char *ohci_device_pcio2usb = "Sun PCIO-2 USB controller";
119 static const char *ohci_device_generic = "OHCI (generic) USB controller";
121 #define PCI_OHCI_BASE_REG 0x10
124 static int ohci_pci_attach(device_t self);
125 static int ohci_pci_detach(device_t self);
126 static int ohci_pci_suspend(device_t self);
127 static int ohci_pci_resume(device_t self);
130 ohci_pci_suspend(device_t self)
132 ohci_softc_t *sc = device_get_softc(self);
135 err = bus_generic_suspend(self);
138 ohci_power(PWR_SUSPEND, sc);
144 ohci_pci_resume(device_t self)
146 ohci_softc_t *sc = device_get_softc(self);
148 ohci_power(PWR_RESUME, sc);
149 bus_generic_resume(self);
155 ohci_pci_match(device_t self)
157 u_int32_t device_id = pci_get_devid(self);
160 case PCI_OHCI_DEVICEID_ALADDIN_V:
161 return (ohci_device_aladdin_v);
162 case PCI_OHCI_DEVICEID_AMD756:
163 return (ohci_device_amd756);
164 case PCI_OHCI_DEVICEID_AMD766:
165 return (ohci_device_amd766);
166 case PCI_OHCI_DEVICEID_USB0670:
167 return (ohci_device_usb0670);
168 case PCI_OHCI_DEVICEID_USB0673:
169 return (ohci_device_usb0673);
170 case PCI_OHCI_DEVICEID_FIRELINK:
171 return (ohci_device_firelink);
172 case PCI_OHCI_DEVICEID_NEC:
173 return (ohci_device_nec);
174 case PCI_OHCI_DEVICEID_NFORCE3:
175 return (ohci_device_nforce3);
176 case PCI_OHCI_DEVICEID_SIS5571:
177 return (ohci_device_sis5571);
178 case PCI_OHCI_DEVICEID_KEYLARGO:
179 return (ohci_device_keylargo);
180 case PCI_OHCI_DEVICEID_PCIO2USB:
181 return (ohci_device_pcio2usb);
183 if (pci_get_class(self) == PCIC_SERIALBUS
184 && pci_get_subclass(self) == PCIS_SERIALBUS_USB
185 && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
186 return (ohci_device_generic);
190 return NULL; /* dunno */
194 ohci_pci_probe(device_t self)
196 const char *desc = ohci_pci_match(self);
199 device_set_desc(self, desc);
200 return BUS_PROBE_DEFAULT;
207 ohci_pci_attach(device_t self)
209 ohci_softc_t *sc = device_get_softc(self);
213 /* XXX where does it say so in the spec? */
214 sc->sc_bus.usbrev = USBREV_1_0;
216 pci_enable_busmaster(self);
219 * Some Sun PCIO-2 USB controllers have their intpin register
220 * bogusly set to 0, although it should be 4. Correct that.
222 if (pci_get_devid(self) == PCI_OHCI_DEVICEID_PCIO2USB &&
223 pci_get_intpin(self) == 0)
224 pci_set_intpin(self, 4);
227 sc->io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
230 device_printf(self, "Could not map memory\n");
233 sc->iot = rman_get_bustag(sc->io_res);
234 sc->ioh = rman_get_bushandle(sc->io_res);
237 sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
238 RF_SHAREABLE | RF_ACTIVE);
239 if (sc->irq_res == NULL) {
240 device_printf(self, "Could not allocate irq\n");
241 ohci_pci_detach(self);
244 sc->sc_bus.bdev = device_add_child(self, "usb", -1);
245 if (!sc->sc_bus.bdev) {
246 device_printf(self, "Could not add USB device\n");
247 ohci_pci_detach(self);
250 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
252 /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
253 device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
254 switch (pci_get_vendor(self)) {
255 case PCI_OHCI_VENDORID_ACERLABS:
256 sprintf(sc->sc_vendor, "AcerLabs");
258 case PCI_OHCI_VENDORID_AMD:
259 sprintf(sc->sc_vendor, "AMD");
261 case PCI_OHCI_VENDORID_APPLE:
262 sprintf(sc->sc_vendor, "Apple");
264 case PCI_OHCI_VENDORID_CMDTECH:
265 sprintf(sc->sc_vendor, "CMDTECH");
267 case PCI_OHCI_VENDORID_NEC:
268 sprintf(sc->sc_vendor, "NEC");
270 case PCI_OHCI_VENDORID_NVIDIA:
271 case PCI_OHCI_VENDORID_NVIDIA2:
272 sprintf(sc->sc_vendor, "nVidia");
274 case PCI_OHCI_VENDORID_OPTI:
275 sprintf(sc->sc_vendor, "OPTi");
277 case PCI_OHCI_VENDORID_SIS:
278 sprintf(sc->sc_vendor, "SiS");
282 device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
283 pci_get_devid(self));
284 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
287 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
288 (driver_intr_t *) ohci_intr, sc, &sc->ih);
290 device_printf(self, "Could not setup irq, %d\n", err);
292 ohci_pci_detach(self);
297 sc->sc_flags |= OHCI_SCFLG_DONEINIT;
298 err = device_probe_and_attach(sc->sc_bus.bdev);
302 device_printf(self, "USB init failed\n");
303 ohci_pci_detach(self);
310 ohci_pci_detach(device_t self)
312 ohci_softc_t *sc = device_get_softc(self);
314 if (sc->sc_flags & OHCI_SCFLG_DONEINIT) {
316 sc->sc_flags &= ~OHCI_SCFLG_DONEINIT;
319 if (sc->irq_res && sc->ih) {
320 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
323 /* XXX or should we panic? */
324 device_printf(self, "Could not tear down irq, %d\n",
328 if (sc->sc_bus.bdev) {
329 device_delete_child(self, sc->sc_bus.bdev);
330 sc->sc_bus.bdev = NULL;
333 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
337 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
345 static device_method_t ohci_methods[] = {
346 /* Device interface */
347 DEVMETHOD(device_probe, ohci_pci_probe),
348 DEVMETHOD(device_attach, ohci_pci_attach),
349 DEVMETHOD(device_detach, ohci_pci_detach),
350 DEVMETHOD(device_suspend, ohci_pci_suspend),
351 DEVMETHOD(device_resume, ohci_pci_resume),
352 DEVMETHOD(device_shutdown, bus_generic_shutdown),
355 DEVMETHOD(bus_print_child, bus_generic_print_child),
360 static driver_t ohci_driver = {
363 sizeof(ohci_softc_t),
366 static devclass_t ohci_devclass;
368 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
369 DRIVER_MODULE(ohci, cardbus, ohci_driver, ohci_devclass, 0, 0);