1 /* $FreeBSD: src/sys/pci/ohci_pci.c,v 1.16.2.5 2002/08/28 20:51:56 joe Exp $ */
2 /* $DragonFly: src/sys/bus/pci/Attic/ohci_pci.c,v 1.3 2003/08/07 21:16:47 dillon Exp $ */
5 * Copyright (c) 1998 The NetBSD Foundation, Inc.
8 * This code is derived from software contributed to The NetBSD Foundation
9 * by Lennart Augustsson (augustss@carlstedt.se) at
10 * Carlstedt Research & Technology.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions and the following disclaimer.
17 * 2. Redistributions in binary form must reproduce the above copyright
18 * notice, this list of conditions and the following disclaimer in the
19 * documentation and/or other materials provided with the distribution.
20 * 3. All advertising materials mentioning features or use of this software
21 * must display the following acknowledgement:
22 * This product includes software developed by the NetBSD
23 * Foundation, Inc. and its contributors.
24 * 4. Neither the name of The NetBSD Foundation nor the names of its
25 * contributors may be used to endorse or promote products derived
26 * from this software without specific prior written permission.
28 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
29 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
30 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
31 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
32 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
33 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
34 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
35 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
36 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
37 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
38 * POSSIBILITY OF SUCH DAMAGE.
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
55 #include <sys/param.h>
56 #include <sys/systm.h>
57 #include <sys/kernel.h>
58 #include <sys/module.h>
60 #include <sys/queue.h>
61 #include <machine/bus.h>
63 #include <machine/resource.h>
68 #include <bus/usb/usb.h>
69 #include <bus/usb/usbdi.h>
70 #include <bus/usb/usbdivar.h>
71 #include <bus/usb/usb_mem.h>
73 #include <bus/usb/ohcireg.h>
74 #include <bus/usb/ohcivar.h>
76 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9
77 #define PCI_OHCI_VENDORID_AMD 0x1022
78 #define PCI_OHCI_VENDORID_APPLE 0x106b
79 #define PCI_OHCI_VENDORID_CMDTECH 0x1095
80 #define PCI_OHCI_VENDORID_NEC 0x1033
81 #define PCI_OHCI_VENDORID_OPTI 0x1045
82 #define PCI_OHCI_VENDORID_SIS 0x1039
84 #define PCI_OHCI_DEVICEID_ALADDIN_V 0x523710b9
85 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
87 #define PCI_OHCI_DEVICEID_AMD756 0x740c1022
88 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
90 #define PCI_OHCI_DEVICEID_AMD766 0x74141022
91 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
93 #define PCI_OHCI_DEVICEID_FIRELINK 0xc8611045
94 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
96 #define PCI_OHCI_DEVICEID_NEC 0x00351033
97 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
99 #define PCI_OHCI_DEVICEID_USB0670 0x06701095
100 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
102 #define PCI_OHCI_DEVICEID_USB0673 0x06731095
103 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
105 #define PCI_OHCI_DEVICEID_SIS5571 0x70011039
106 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
108 #define PCI_OHCI_DEVICEID_KEYLARGO 0x0019106b
109 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
111 static const char *ohci_device_generic = "OHCI (generic) USB controller";
113 #define PCI_OHCI_BASE_REG 0x10
116 static int ohci_pci_attach(device_t self);
117 static int ohci_pci_detach(device_t self);
120 ohci_pci_match(device_t self)
122 u_int32_t device_id = pci_get_devid(self);
125 case PCI_OHCI_DEVICEID_ALADDIN_V:
126 return (ohci_device_aladdin_v);
127 case PCI_OHCI_DEVICEID_AMD756:
128 return (ohci_device_amd756);
129 case PCI_OHCI_DEVICEID_AMD766:
130 return (ohci_device_amd766);
131 case PCI_OHCI_DEVICEID_USB0670:
132 return (ohci_device_usb0670);
133 case PCI_OHCI_DEVICEID_USB0673:
134 return (ohci_device_usb0673);
135 case PCI_OHCI_DEVICEID_FIRELINK:
136 return (ohci_device_firelink);
137 case PCI_OHCI_DEVICEID_NEC:
138 return (ohci_device_nec);
139 case PCI_OHCI_DEVICEID_SIS5571:
140 return (ohci_device_sis5571);
141 case PCI_OHCI_DEVICEID_KEYLARGO:
142 return (ohci_device_keylargo);
144 if (pci_get_class(self) == PCIC_SERIALBUS
145 && pci_get_subclass(self) == PCIS_SERIALBUS_USB
146 && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
147 return (ohci_device_generic);
151 return NULL; /* dunno */
155 ohci_pci_probe(device_t self)
157 const char *desc = ohci_pci_match(self);
160 device_set_desc(self, desc);
168 ohci_pci_attach(device_t self)
170 ohci_softc_t *sc = device_get_softc(self);
174 /* XXX where does it say so in the spec? */
175 sc->sc_bus.usbrev = USBREV_1_0;
178 sc->io_res = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
179 0, ~0, 1, RF_ACTIVE);
181 device_printf(self, "Could not map memory\n");
184 sc->iot = rman_get_bustag(sc->io_res);
185 sc->ioh = rman_get_bushandle(sc->io_res);
188 sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1,
189 RF_SHAREABLE | RF_ACTIVE);
190 if (sc->irq_res == NULL) {
191 device_printf(self, "Could not allocate irq\n");
192 ohci_pci_detach(self);
195 sc->sc_bus.bdev = device_add_child(self, "usb", -1);
196 if (!sc->sc_bus.bdev) {
197 device_printf(self, "Could not add USB device\n");
198 ohci_pci_detach(self);
201 device_set_ivars(sc->sc_bus.bdev, sc);
203 /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
204 device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
205 switch (pci_get_vendor(self)) {
206 case PCI_OHCI_VENDORID_ACERLABS:
207 sprintf(sc->sc_vendor, "AcerLabs");
209 case PCI_OHCI_VENDORID_AMD:
210 sprintf(sc->sc_vendor, "AMD");
212 case PCI_OHCI_VENDORID_APPLE:
213 sprintf(sc->sc_vendor, "Apple");
215 case PCI_OHCI_VENDORID_CMDTECH:
216 sprintf(sc->sc_vendor, "CMDTECH");
218 case PCI_OHCI_VENDORID_NEC:
219 sprintf(sc->sc_vendor, "NEC");
221 case PCI_OHCI_VENDORID_OPTI:
222 sprintf(sc->sc_vendor, "OPTi");
224 case PCI_OHCI_VENDORID_SIS:
225 sprintf(sc->sc_vendor, "SiS");
229 device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
230 pci_get_devid(self));
231 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
234 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
235 (driver_intr_t *) ohci_intr, sc, &sc->ih);
237 device_printf(self, "Could not setup irq, %d\n", err);
239 ohci_pci_detach(self);
244 err = device_probe_and_attach(sc->sc_bus.bdev);
247 device_printf(self, "USB init failed\n");
248 ohci_pci_detach(self);
255 ohci_pci_detach(device_t self)
257 ohci_softc_t *sc = device_get_softc(self);
260 * XXX this code is not yet fit to be used as detach for the OHCI
265 * disable interrupts that might have been switched on in ohci_init
267 if (sc->iot && sc->ioh)
268 bus_space_write_4(sc->iot, sc->ioh,
269 OHCI_INTERRUPT_DISABLE, OHCI_ALL_INTRS);
271 if (sc->irq_res && sc->ih) {
272 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
275 /* XXX or should we panic? */
276 device_printf(self, "Could not tear down irq, %d\n",
280 if (sc->sc_bus.bdev) {
281 device_delete_child(self, sc->sc_bus.bdev);
282 sc->sc_bus.bdev = NULL;
285 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
289 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
297 static device_method_t ohci_methods[] = {
298 /* Device interface */
299 DEVMETHOD(device_probe, ohci_pci_probe),
300 DEVMETHOD(device_attach, ohci_pci_attach),
301 DEVMETHOD(device_shutdown, bus_generic_shutdown),
304 DEVMETHOD(bus_print_child, bus_generic_print_child),
309 static driver_t ohci_driver = {
312 sizeof(ohci_softc_t),
315 static devclass_t ohci_devclass;
317 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);