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.
37 * $FreeBSD: src/sys/dev/usb/ohci_pci.c,v 1.44.2.1 2006/01/29 01:26:46 iedowse Exp $
41 * USB Open Host Controller driver.
43 * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf
46 /* The low level controller code for OHCI has been split into
47 * PCI probes and OHCI specific code. This was done to facilitate the
48 * sharing of code between *BSD's
51 #include <sys/param.h>
52 #include <sys/systm.h>
53 #include <sys/kernel.h>
54 #include <sys/module.h>
56 #include <sys/queue.h>
58 #include <sys/thread2.h>
60 #include <bus/pci/pcivar.h>
61 #include <bus/pci/pcireg.h>
63 #include <bus/usb/usb.h>
64 #include <bus/usb/usbdi.h>
65 #include <bus/usb/usbdivar.h>
66 #include <bus/usb/usb_mem.h>
68 #include <bus/usb/ohcireg.h>
69 #include <bus/usb/ohcivar.h>
71 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9
72 #define PCI_OHCI_VENDORID_AMD 0x1022
73 #define PCI_OHCI_VENDORID_APPLE 0x106b
74 #define PCI_OHCI_VENDORID_ATI 0x1002
75 #define PCI_OHCI_VENDORID_CMDTECH 0x1095
76 #define PCI_OHCI_VENDORID_NEC 0x1033
77 #define PCI_OHCI_VENDORID_NVIDIA 0x12D2
78 #define PCI_OHCI_VENDORID_NVIDIA2 0x10DE
79 #define PCI_OHCI_VENDORID_OPTI 0x1045
80 #define PCI_OHCI_VENDORID_SIS 0x1039
81 #define PCI_OHCI_VENDORID_SUN 0x108e
83 #define PCI_OHCI_DEVICEID_ALADDIN_V 0x523710b9
84 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
86 #define PCI_OHCI_DEVICEID_AMD756 0x740c1022
87 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
89 #define PCI_OHCI_DEVICEID_CS5536 0x20941022
90 static const char *ohci_device_cs5536 = "AMD CS5536 [geode companion] 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_SB400_1 0x43741002
96 #define PCI_OHCI_DEVICEID_SB400_2 0x43751002
97 static const char *ohci_device_sb400 = "ATI SB400 USB Controller";
99 #define PCI_OHCI_DEVICEID_FIRELINK 0xc8611045
100 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
102 #define PCI_OHCI_DEVICEID_NEC 0x00351033
103 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
105 #define PCI_OHCI_DEVICEID_NFORCE3 0x00d710de
106 static const char *ohci_device_nforce3 = "nVidia nForce3 USB Controller";
108 #define PCI_OHCI_DEVICEID_USB0670 0x06701095
109 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
111 #define PCI_OHCI_DEVICEID_USB0673 0x06731095
112 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
114 #define PCI_OHCI_DEVICEID_SIS5571 0x70011039
115 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
117 #define PCI_OHCI_DEVICEID_KEYLARGO 0x0019106b
118 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
120 #define PCI_OHCI_DEVICEID_PCIO2USB 0x1103108e
121 static const char *ohci_device_pcio2usb = "Sun PCIO-2 USB controller";
123 static const char *ohci_device_generic = "OHCI (generic) USB controller";
125 #define PCI_OHCI_BASE_REG 0x10
128 static int ohci_pci_attach(device_t self);
129 static int ohci_pci_detach(device_t self);
130 static int ohci_pci_suspend(device_t self);
131 static int ohci_pci_resume(device_t self);
134 ohci_pci_suspend(device_t self)
136 ohci_softc_t *sc = device_get_softc(self);
139 err = bus_generic_suspend(self);
142 ohci_power(PWR_SUSPEND, sc);
148 ohci_pci_resume(device_t self)
150 ohci_softc_t *sc = device_get_softc(self);
153 uint32_t reg, int_line;
155 if (pci_get_powerstate(self) != PCI_POWERSTATE_D0) {
156 device_printf(self, "chip is in D%d mode "
157 "-- setting to D0\n", pci_get_powerstate(self));
158 reg = pci_read_config(self, PCI_CBMEM, 4);
159 int_line = pci_read_config(self, PCIR_INTLINE, 4);
160 pci_set_powerstate(self, PCI_POWERSTATE_D0);
161 pci_write_config(self, PCI_CBMEM, reg, 4);
162 pci_write_config(self, PCIR_INTLINE, int_line, 4);
164 #endif /* !BURN_BRIDGES */
166 ohci_power(PWR_RESUME, sc);
167 bus_generic_resume(self);
173 ohci_pci_match(device_t self)
175 u_int32_t device_id = pci_get_devid(self);
178 case PCI_OHCI_DEVICEID_ALADDIN_V:
179 return (ohci_device_aladdin_v);
180 case PCI_OHCI_DEVICEID_AMD756:
181 return (ohci_device_amd756);
182 case PCI_OHCI_DEVICEID_AMD766:
183 return (ohci_device_amd766);
184 case PCI_OHCI_DEVICEID_CS5536:
185 return (ohci_device_cs5536);
186 case PCI_OHCI_DEVICEID_SB400_1:
187 case PCI_OHCI_DEVICEID_SB400_2:
188 return (ohci_device_sb400);
189 case PCI_OHCI_DEVICEID_USB0670:
190 return (ohci_device_usb0670);
191 case PCI_OHCI_DEVICEID_USB0673:
192 return (ohci_device_usb0673);
193 case PCI_OHCI_DEVICEID_FIRELINK:
194 return (ohci_device_firelink);
195 case PCI_OHCI_DEVICEID_NEC:
196 return (ohci_device_nec);
197 case PCI_OHCI_DEVICEID_NFORCE3:
198 return (ohci_device_nforce3);
199 case PCI_OHCI_DEVICEID_SIS5571:
200 return (ohci_device_sis5571);
201 case PCI_OHCI_DEVICEID_KEYLARGO:
202 return (ohci_device_keylargo);
203 case PCI_OHCI_DEVICEID_PCIO2USB:
204 return (ohci_device_pcio2usb);
206 if (pci_get_class(self) == PCIC_SERIALBUS
207 && pci_get_subclass(self) == PCIS_SERIALBUS_USB
208 && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
209 return (ohci_device_generic);
213 return NULL; /* dunno */
217 ohci_pci_probe(device_t self)
219 const char *desc = ohci_pci_match(self);
222 device_set_desc(self, desc);
223 device_set_async_attach(self, TRUE);
231 ohci_pci_attach(device_t self)
233 ohci_softc_t *sc = device_get_softc(self);
237 /* XXX where does it say so in the spec? */
238 sc->sc_bus.usbrev = USBREV_1_0;
240 pci_enable_busmaster(self);
243 * Some Sun PCIO-2 USB controllers have their intpin register
244 * bogusly set to 0, although it should be 4. Correct that.
246 if (pci_get_devid(self) == PCI_OHCI_DEVICEID_PCIO2USB &&
247 pci_get_intpin(self) == 0)
248 pci_set_intpin(self, 4);
251 sc->io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
254 device_printf(self, "Could not map memory\n");
257 sc->iot = rman_get_bustag(sc->io_res);
258 sc->ioh = rman_get_bushandle(sc->io_res);
261 sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
262 RF_SHAREABLE | RF_ACTIVE);
263 if (sc->irq_res == NULL) {
264 device_printf(self, "Could not allocate irq\n");
265 ohci_pci_detach(self);
268 sc->sc_bus.bdev = device_add_child(self, "usb", -1);
269 if (!sc->sc_bus.bdev) {
270 device_printf(self, "Could not add USB device\n");
271 ohci_pci_detach(self);
274 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
276 /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
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 ksprintf(sc->sc_vendor, "AcerLabs");
282 case PCI_OHCI_VENDORID_AMD:
283 ksprintf(sc->sc_vendor, "AMD");
285 case PCI_OHCI_VENDORID_APPLE:
286 ksprintf(sc->sc_vendor, "Apple");
288 case PCI_OHCI_VENDORID_ATI:
289 ksprintf(sc->sc_vendor, "ATI");
291 case PCI_OHCI_VENDORID_CMDTECH:
292 ksprintf(sc->sc_vendor, "CMDTECH");
294 case PCI_OHCI_VENDORID_NEC:
295 ksprintf(sc->sc_vendor, "NEC");
297 case PCI_OHCI_VENDORID_NVIDIA:
298 case PCI_OHCI_VENDORID_NVIDIA2:
299 ksprintf(sc->sc_vendor, "nVidia");
301 case PCI_OHCI_VENDORID_OPTI:
302 ksprintf(sc->sc_vendor, "OPTi");
304 case PCI_OHCI_VENDORID_SIS:
305 ksprintf(sc->sc_vendor, "SiS");
309 device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
310 pci_get_devid(self));
311 ksprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
314 err = bus_setup_intr(self, sc->irq_res, 0,
315 (driver_intr_t *) ohci_intr, sc, &sc->ih, NULL);
317 device_printf(self, "Could not setup irq, %d\n", err);
319 ohci_pci_detach(self);
324 * OHCI interrupts which occur early will leave them disabled,
325 * so run the interrupt manually once we're done with the init.
329 err = device_probe_and_attach(sc->sc_bus.bdev);
332 device_printf(self, "USB init failed\n");
333 ohci_pci_detach(self);
340 ohci_pci_detach(device_t self)
342 ohci_softc_t *sc = device_get_softc(self);
344 if (sc->sc_flags & OHCI_SCFLG_DONEINIT) {
346 sc->sc_flags &= ~OHCI_SCFLG_DONEINIT;
349 if (sc->irq_res && sc->ih) {
350 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
353 /* XXX or should we panic? */
354 device_printf(self, "Could not tear down irq, %d\n",
358 if (sc->sc_bus.bdev) {
359 device_delete_child(self, sc->sc_bus.bdev);
360 sc->sc_bus.bdev = NULL;
363 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
367 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
375 static device_method_t ohci_methods[] = {
376 /* Device interface */
377 DEVMETHOD(device_probe, ohci_pci_probe),
378 DEVMETHOD(device_attach, ohci_pci_attach),
379 DEVMETHOD(device_detach, ohci_pci_detach),
380 DEVMETHOD(device_suspend, ohci_pci_suspend),
381 DEVMETHOD(device_resume, ohci_pci_resume),
382 DEVMETHOD(device_shutdown, bus_generic_shutdown),
385 DEVMETHOD(bus_print_child, bus_generic_print_child),
390 static driver_t ohci_driver = {
393 sizeof(ohci_softc_t),
396 static devclass_t ohci_devclass;
398 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, NULL, NULL);
399 DRIVER_MODULE(ohci, cardbus, ohci_driver, ohci_devclass, NULL, NULL);