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 $
38 * $DragonFly: src/sys/bus/usb/ohci_pci.c,v 1.9 2007/08/24 16:02:47 dillon Exp $
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>
62 #include <bus/pci/pcivar.h>
63 #include <bus/pci/pcireg.h>
65 #include <bus/usb/usb.h>
66 #include <bus/usb/usbdi.h>
67 #include <bus/usb/usbdivar.h>
68 #include <bus/usb/usb_mem.h>
70 #include <bus/usb/ohcireg.h>
71 #include <bus/usb/ohcivar.h>
73 #define PCI_OHCI_VENDORID_ACERLABS 0x10b9
74 #define PCI_OHCI_VENDORID_AMD 0x1022
75 #define PCI_OHCI_VENDORID_APPLE 0x106b
76 #define PCI_OHCI_VENDORID_ATI 0x1002
77 #define PCI_OHCI_VENDORID_CMDTECH 0x1095
78 #define PCI_OHCI_VENDORID_NEC 0x1033
79 #define PCI_OHCI_VENDORID_NVIDIA 0x12D2
80 #define PCI_OHCI_VENDORID_NVIDIA2 0x10DE
81 #define PCI_OHCI_VENDORID_OPTI 0x1045
82 #define PCI_OHCI_VENDORID_SIS 0x1039
83 #define PCI_OHCI_VENDORID_SUN 0x108e
85 #define PCI_OHCI_DEVICEID_ALADDIN_V 0x523710b9
86 static const char *ohci_device_aladdin_v
= "AcerLabs M5237 (Aladdin-V) USB controller";
88 #define PCI_OHCI_DEVICEID_AMD756 0x740c1022
89 static const char *ohci_device_amd756
= "AMD-756 USB Controller";
91 #define PCI_OHCI_DEVICEID_CS5536 0x20941022
92 static const char *ohci_device_cs5536
= "AMD CS5536 [geode companion] USB Controller";
94 #define PCI_OHCI_DEVICEID_AMD766 0x74141022
95 static const char *ohci_device_amd766
= "AMD-766 USB Controller";
97 #define PCI_OHCI_DEVICEID_SB400_1 0x43741002
98 #define PCI_OHCI_DEVICEID_SB400_2 0x43751002
99 static const char *ohci_device_sb400
= "ATI SB400 USB Controller";
101 #define PCI_OHCI_DEVICEID_FIRELINK 0xc8611045
102 static const char *ohci_device_firelink
= "OPTi 82C861 (FireLink) USB controller";
104 #define PCI_OHCI_DEVICEID_NEC 0x00351033
105 static const char *ohci_device_nec
= "NEC uPD 9210 USB controller";
107 #define PCI_OHCI_DEVICEID_NFORCE3 0x00d710de
108 static const char *ohci_device_nforce3
= "nVidia nForce3 USB Controller";
110 #define PCI_OHCI_DEVICEID_USB0670 0x06701095
111 static const char *ohci_device_usb0670
= "CMD Tech 670 (USB0670) USB controller";
113 #define PCI_OHCI_DEVICEID_USB0673 0x06731095
114 static const char *ohci_device_usb0673
= "CMD Tech 673 (USB0673) USB controller";
116 #define PCI_OHCI_DEVICEID_SIS5571 0x70011039
117 static const char *ohci_device_sis5571
= "SiS 5571 USB controller";
119 #define PCI_OHCI_DEVICEID_KEYLARGO 0x0019106b
120 static const char *ohci_device_keylargo
= "Apple KeyLargo USB controller";
122 #define PCI_OHCI_DEVICEID_PCIO2USB 0x1103108e
123 static const char *ohci_device_pcio2usb
= "Sun PCIO-2 USB controller";
125 static const char *ohci_device_generic
= "OHCI (generic) USB controller";
127 #define PCI_OHCI_BASE_REG 0x10
130 static int ohci_pci_attach(device_t self
);
131 static int ohci_pci_detach(device_t self
);
132 static int ohci_pci_suspend(device_t self
);
133 static int ohci_pci_resume(device_t self
);
136 ohci_pci_suspend(device_t self
)
138 ohci_softc_t
*sc
= device_get_softc(self
);
141 err
= bus_generic_suspend(self
);
144 ohci_power(PWR_SUSPEND
, sc
);
150 ohci_pci_resume(device_t self
)
152 ohci_softc_t
*sc
= device_get_softc(self
);
155 uint32_t reg
, int_line
;
157 if (pci_get_powerstate(self
) != PCI_POWERSTATE_D0
) {
158 device_printf(self
, "chip is in D%d mode "
159 "-- setting to D0\n", pci_get_powerstate(self
));
160 reg
= pci_read_config(self
, PCI_CBMEM
, 4);
161 int_line
= pci_read_config(self
, PCIR_INTLINE
, 4);
162 pci_set_powerstate(self
, PCI_POWERSTATE_D0
);
163 pci_write_config(self
, PCI_CBMEM
, reg
, 4);
164 pci_write_config(self
, PCIR_INTLINE
, int_line
, 4);
166 #endif /* !BURN_BRIDGES */
168 ohci_power(PWR_RESUME
, sc
);
169 bus_generic_resume(self
);
175 ohci_pci_match(device_t self
)
177 u_int32_t device_id
= pci_get_devid(self
);
180 case PCI_OHCI_DEVICEID_ALADDIN_V
:
181 return (ohci_device_aladdin_v
);
182 case PCI_OHCI_DEVICEID_AMD756
:
183 return (ohci_device_amd756
);
184 case PCI_OHCI_DEVICEID_AMD766
:
185 return (ohci_device_amd766
);
186 case PCI_OHCI_DEVICEID_CS5536
:
187 return (ohci_device_cs5536
);
188 case PCI_OHCI_DEVICEID_SB400_1
:
189 case PCI_OHCI_DEVICEID_SB400_2
:
190 return (ohci_device_sb400
);
191 case PCI_OHCI_DEVICEID_USB0670
:
192 return (ohci_device_usb0670
);
193 case PCI_OHCI_DEVICEID_USB0673
:
194 return (ohci_device_usb0673
);
195 case PCI_OHCI_DEVICEID_FIRELINK
:
196 return (ohci_device_firelink
);
197 case PCI_OHCI_DEVICEID_NEC
:
198 return (ohci_device_nec
);
199 case PCI_OHCI_DEVICEID_NFORCE3
:
200 return (ohci_device_nforce3
);
201 case PCI_OHCI_DEVICEID_SIS5571
:
202 return (ohci_device_sis5571
);
203 case PCI_OHCI_DEVICEID_KEYLARGO
:
204 return (ohci_device_keylargo
);
205 case PCI_OHCI_DEVICEID_PCIO2USB
:
206 return (ohci_device_pcio2usb
);
208 if (pci_get_class(self
) == PCIC_SERIALBUS
209 && pci_get_subclass(self
) == PCIS_SERIALBUS_USB
210 && pci_get_progif(self
) == PCI_INTERFACE_OHCI
) {
211 return (ohci_device_generic
);
215 return NULL
; /* dunno */
219 ohci_pci_probe(device_t self
)
221 const char *desc
= ohci_pci_match(self
);
224 device_set_desc(self
, desc
);
225 device_set_async_attach(self
, TRUE
);
233 ohci_pci_attach(device_t self
)
235 ohci_softc_t
*sc
= device_get_softc(self
);
239 /* XXX where does it say so in the spec? */
240 sc
->sc_bus
.usbrev
= USBREV_1_0
;
242 pci_enable_busmaster(self
);
245 * Some Sun PCIO-2 USB controllers have their intpin register
246 * bogusly set to 0, although it should be 4. Correct that.
248 if (pci_get_devid(self
) == PCI_OHCI_DEVICEID_PCIO2USB
&&
249 pci_get_intpin(self
) == 0)
250 pci_set_intpin(self
, 4);
253 sc
->io_res
= bus_alloc_resource_any(self
, SYS_RES_MEMORY
, &rid
,
256 device_printf(self
, "Could not map memory\n");
259 sc
->iot
= rman_get_bustag(sc
->io_res
);
260 sc
->ioh
= rman_get_bushandle(sc
->io_res
);
263 sc
->irq_res
= bus_alloc_resource_any(self
, SYS_RES_IRQ
, &rid
,
264 RF_SHAREABLE
| RF_ACTIVE
);
265 if (sc
->irq_res
== NULL
) {
266 device_printf(self
, "Could not allocate irq\n");
267 ohci_pci_detach(self
);
270 sc
->sc_bus
.bdev
= device_add_child(self
, "usb", -1);
271 if (!sc
->sc_bus
.bdev
) {
272 device_printf(self
, "Could not add USB device\n");
273 ohci_pci_detach(self
);
276 device_set_ivars(sc
->sc_bus
.bdev
, &sc
->sc_bus
);
278 /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
279 device_set_desc(sc
->sc_bus
.bdev
, ohci_pci_match(self
));
280 switch (pci_get_vendor(self
)) {
281 case PCI_OHCI_VENDORID_ACERLABS
:
282 ksprintf(sc
->sc_vendor
, "AcerLabs");
284 case PCI_OHCI_VENDORID_AMD
:
285 ksprintf(sc
->sc_vendor
, "AMD");
287 case PCI_OHCI_VENDORID_APPLE
:
288 ksprintf(sc
->sc_vendor
, "Apple");
290 case PCI_OHCI_VENDORID_ATI
:
291 ksprintf(sc
->sc_vendor
, "ATI");
293 case PCI_OHCI_VENDORID_CMDTECH
:
294 ksprintf(sc
->sc_vendor
, "CMDTECH");
296 case PCI_OHCI_VENDORID_NEC
:
297 ksprintf(sc
->sc_vendor
, "NEC");
299 case PCI_OHCI_VENDORID_NVIDIA
:
300 case PCI_OHCI_VENDORID_NVIDIA2
:
301 ksprintf(sc
->sc_vendor
, "nVidia");
303 case PCI_OHCI_VENDORID_OPTI
:
304 ksprintf(sc
->sc_vendor
, "OPTi");
306 case PCI_OHCI_VENDORID_SIS
:
307 ksprintf(sc
->sc_vendor
, "SiS");
311 device_printf(self
, "(New OHCI DeviceId=0x%08x)\n",
312 pci_get_devid(self
));
313 ksprintf(sc
->sc_vendor
, "(0x%04x)", pci_get_vendor(self
));
316 err
= bus_setup_intr(self
, sc
->irq_res
, 0,
317 (driver_intr_t
*) ohci_intr
, sc
, &sc
->ih
, NULL
);
319 device_printf(self
, "Could not setup irq, %d\n", err
);
321 ohci_pci_detach(self
);
326 sc
->sc_flags
|= OHCI_SCFLG_DONEINIT
;
327 err
= device_probe_and_attach(sc
->sc_bus
.bdev
);
331 device_printf(self
, "USB init failed\n");
332 ohci_pci_detach(self
);
339 ohci_pci_detach(device_t self
)
341 ohci_softc_t
*sc
= device_get_softc(self
);
343 if (sc
->sc_flags
& OHCI_SCFLG_DONEINIT
) {
345 sc
->sc_flags
&= ~OHCI_SCFLG_DONEINIT
;
348 if (sc
->irq_res
&& sc
->ih
) {
349 int err
= bus_teardown_intr(self
, sc
->irq_res
, sc
->ih
);
352 /* XXX or should we panic? */
353 device_printf(self
, "Could not tear down irq, %d\n",
357 if (sc
->sc_bus
.bdev
) {
358 device_delete_child(self
, sc
->sc_bus
.bdev
);
359 sc
->sc_bus
.bdev
= NULL
;
362 bus_release_resource(self
, SYS_RES_IRQ
, 0, sc
->irq_res
);
366 bus_release_resource(self
, SYS_RES_MEMORY
, PCI_CBMEM
, sc
->io_res
);
374 static device_method_t ohci_methods
[] = {
375 /* Device interface */
376 DEVMETHOD(device_probe
, ohci_pci_probe
),
377 DEVMETHOD(device_attach
, ohci_pci_attach
),
378 DEVMETHOD(device_detach
, ohci_pci_detach
),
379 DEVMETHOD(device_suspend
, ohci_pci_suspend
),
380 DEVMETHOD(device_resume
, ohci_pci_resume
),
381 DEVMETHOD(device_shutdown
, bus_generic_shutdown
),
384 DEVMETHOD(bus_print_child
, bus_generic_print_child
),
389 static driver_t ohci_driver
= {
392 sizeof(ohci_softc_t
),
395 static devclass_t ohci_devclass
;
397 DRIVER_MODULE(ohci
, pci
, ohci_driver
, ohci_devclass
, 0, 0);
398 DRIVER_MODULE(ohci
, cardbus
, ohci_driver
, ohci_devclass
, 0, 0);