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$");
41 /* Universal Host Controller Interface
43 * UHCI spec: http://www.intel.com/
46 /* The low level controller code for UHCI has been split into
47 * PCI probes and UHCI specific code. This was done to facilitate the
48 * sharing of code between *BSD's
53 #include <sys/param.h>
54 #include <sys/systm.h>
55 #include <sys/kernel.h>
56 #include <sys/module.h>
58 #include <sys/queue.h>
59 #if defined(__FreeBSD__)
62 #include <machine/bus.h>
63 #include <machine/resource.h>
67 #include <dev/pci/pcivar.h>
68 #include <dev/pci/pcireg.h>
70 #include <dev/usb/usb.h>
71 #include <dev/usb/usbdi.h>
72 #include <dev/usb/usbdivar.h>
73 #include <dev/usb/usb_mem.h>
75 #include <dev/usb/uhcireg.h>
76 #include <dev/usb/uhcivar.h>
78 #define PCI_UHCI_VENDORID_INTEL 0x8086
79 #define PCI_UHCI_VENDORID_VIA 0x1106
81 #define PCI_UHCI_DEVICEID_PIIX3 0x70208086
82 static const char *uhci_device_piix3 = "Intel 82371SB (PIIX3) USB controller";
84 #define PCI_UHCI_DEVICEID_PIIX4 0x71128086
85 #define PCI_UHCI_DEVICEID_PIIX4E 0x71128086 /* no separate stepping */
86 static const char *uhci_device_piix4 = "Intel 82371AB/EB (PIIX4) USB controller";
88 #define PCI_UHCI_DEVICEID_ICH 0x24128086
89 static const char *uhci_device_ich = "Intel 82801AA (ICH) USB controller";
91 #define PCI_UHCI_DEVICEID_ICH0 0x24228086
92 static const char *uhci_device_ich0 = "Intel 82801AB (ICH0) USB controller";
94 #define PCI_UHCI_DEVICEID_ICH2_A 0x24428086
95 static const char *uhci_device_ich2_a = "Intel 82801BA/BAM (ICH2) USB controller USB-A";
97 #define PCI_UHCI_DEVICEID_ICH2_B 0x24448086
98 static const char *uhci_device_ich2_b = "Intel 82801BA/BAM (ICH2) USB controller USB-B";
100 #define PCI_UHCI_DEVICEID_ICH3_A 0x24828086
101 static const char *uhci_device_ich3_a = "Intel 82801CA/CAM (ICH3) USB controller USB-A";
103 #define PCI_UHCI_DEVICEID_ICH3_B 0x24848086
104 static const char *uhci_device_ich3_b = "Intel 82801CA/CAM (ICH3) USB controller USB-B";
106 #define PCI_UHCI_DEVICEID_ICH3_C 0x24878086
107 static const char *uhci_device_ich3_c = "Intel 82801CA/CAM (ICH3) USB controller USB-C";
109 #define PCI_UHCI_DEVICEID_ICH4_A 0x24c28086
110 static const char *uhci_device_ich4_a = "Intel 82801DB (ICH4) USB controller USB-A";
112 #define PCI_UHCI_DEVICEID_ICH4_B 0x24c48086
113 static const char *uhci_device_ich4_b = "Intel 82801DB (ICH4) USB controller USB-B";
115 #define PCI_UHCI_DEVICEID_ICH4_C 0x24c78086
116 static const char *uhci_device_ich4_c = "Intel 82801DB (ICH4) USB controller USB-C";
118 #define PCI_UHCI_DEVICEID_ICH5_A 0x24d28086
119 static const char *uhci_device_ich5_a = "Intel 82801EB (ICH5) USB controller USB-A";
121 #define PCI_UHCI_DEVICEID_ICH5_B 0x24d48086
122 static const char *uhci_device_ich5_b = "Intel 82801EB (ICH5) USB controller USB-B";
124 #define PCI_UHCI_DEVICEID_ICH5_C 0x24d78086
125 static const char *uhci_device_ich5_c = "Intel 82801EB (ICH5) USB controller USB-C";
127 #define PCI_UHCI_DEVICEID_ICH5_D 0x24de8086
128 static const char *uhci_device_ich5_d = "Intel 82801EB (ICH5) USB controller USB-D";
130 #define PCI_UHCI_DEVICEID_ICH6_A 0x26588086
131 static const char *uhci_device_ich6_a = "Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A";
133 #define PCI_UHCI_DEVICEID_ICH6_B 0x26598086
134 static const char *uhci_device_ich6_b = "Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B";
136 #define PCI_UHCI_DEVICEID_ICH6_C 0x265a8086
137 static const char *uhci_device_ich6_c = "Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C";
139 #define PCI_UHCI_DEVICEID_ICH6_D 0x265b8086
140 static const char *uhci_device_ich6_d = "Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D";
142 #define PCI_UHCI_DEVICEID_440MX 0x719a8086
143 static const char *uhci_device_440mx = "Intel 82443MX USB controller";
145 #define PCI_UHCI_DEVICEID_460GX 0x76028086
146 static const char *uhci_device_460gx = "Intel 82372FB/82468GX USB controller";
148 #define PCI_UHCI_DEVICEID_VT83C572 0x30381106
149 static const char *uhci_device_vt83c572 = "VIA 83C572 USB controller";
151 static const char *uhci_device_generic = "UHCI (generic) USB controller";
153 #define PCI_UHCI_BASE_REG 0x20
156 static int uhci_pci_attach(device_t self);
157 static int uhci_pci_detach(device_t self);
158 static int uhci_pci_suspend(device_t self);
159 static int uhci_pci_resume(device_t self);
163 uhci_pci_suspend(device_t self)
165 uhci_softc_t *sc = device_get_softc(self);
168 err = bus_generic_suspend(self);
171 uhci_power(PWR_SUSPEND, sc);
177 uhci_pci_resume(device_t self)
179 uhci_softc_t *sc = device_get_softc(self);
181 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
183 uhci_power(PWR_RESUME, sc);
184 bus_generic_resume(self);
190 uhci_pci_match(device_t self)
192 u_int32_t device_id = pci_get_devid(self);
194 if (device_id == PCI_UHCI_DEVICEID_PIIX3) {
195 return (uhci_device_piix3);
196 } else if (device_id == PCI_UHCI_DEVICEID_PIIX4) {
197 return (uhci_device_piix4);
198 } else if (device_id == PCI_UHCI_DEVICEID_ICH) {
199 return (uhci_device_ich);
200 } else if (device_id == PCI_UHCI_DEVICEID_ICH0) {
201 return (uhci_device_ich0);
202 } else if (device_id == PCI_UHCI_DEVICEID_ICH2_A) {
203 return (uhci_device_ich2_a);
204 } else if (device_id == PCI_UHCI_DEVICEID_ICH2_B) {
205 return (uhci_device_ich2_b);
206 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_A) {
207 return (uhci_device_ich3_a);
208 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_B) {
209 return (uhci_device_ich3_b);
210 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_C) {
211 return (uhci_device_ich3_c);
212 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_A) {
213 return (uhci_device_ich4_a);
214 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_B) {
215 return (uhci_device_ich4_b);
216 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_C) {
217 return (uhci_device_ich4_c);
218 } else if (device_id == PCI_UHCI_DEVICEID_ICH5_A) {
219 return (uhci_device_ich5_a);
220 } else if (device_id == PCI_UHCI_DEVICEID_ICH5_B) {
221 return (uhci_device_ich5_b);
222 } else if (device_id == PCI_UHCI_DEVICEID_ICH5_C) {
223 return (uhci_device_ich5_c);
224 } else if (device_id == PCI_UHCI_DEVICEID_ICH5_D) {
225 return (uhci_device_ich5_d);
226 } else if (device_id == PCI_UHCI_DEVICEID_ICH6_A) {
227 return (uhci_device_ich6_a);
228 } else if (device_id == PCI_UHCI_DEVICEID_ICH6_B) {
229 return (uhci_device_ich6_b);
230 } else if (device_id == PCI_UHCI_DEVICEID_ICH6_C) {
231 return (uhci_device_ich6_c);
232 } else if (device_id == PCI_UHCI_DEVICEID_ICH6_D) {
233 return (uhci_device_ich6_d);
234 } else if (device_id == PCI_UHCI_DEVICEID_440MX) {
235 return (uhci_device_440mx);
236 } else if (device_id == PCI_UHCI_DEVICEID_460GX) {
237 return (uhci_device_460gx);
238 } else if (device_id == PCI_UHCI_DEVICEID_VT83C572) {
239 return (uhci_device_vt83c572);
241 if (pci_get_class(self) == PCIC_SERIALBUS
242 && pci_get_subclass(self) == PCIS_SERIALBUS_USB
243 && pci_get_progif(self) == PCI_INTERFACE_UHCI) {
244 return (uhci_device_generic);
248 return NULL; /* dunno... */
252 uhci_pci_probe(device_t self)
254 const char *desc = uhci_pci_match(self);
257 device_set_desc(self, desc);
258 return BUS_PROBE_DEFAULT;
265 uhci_pci_attach(device_t self)
267 uhci_softc_t *sc = device_get_softc(self);
271 pci_enable_busmaster(self);
273 rid = PCI_UHCI_BASE_REG;
274 sc->io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid,
277 device_printf(self, "Could not map ports\n");
280 sc->iot = rman_get_bustag(sc->io_res);
281 sc->ioh = rman_get_bushandle(sc->io_res);
283 /* disable interrupts */
284 bus_space_write_2(sc->iot, sc->ioh, UHCI_INTR, 0);
287 sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
288 RF_SHAREABLE | RF_ACTIVE);
289 if (sc->irq_res == NULL) {
290 device_printf(self, "Could not allocate irq\n");
291 uhci_pci_detach(self);
294 sc->sc_bus.bdev = device_add_child(self, "usb", -1);
295 if (!sc->sc_bus.bdev) {
296 device_printf(self, "Could not add USB device\n");
297 uhci_pci_detach(self);
300 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
302 /* uhci_pci_match must never return NULL if uhci_pci_probe succeeded */
303 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self));
304 switch (pci_get_vendor(self)) {
305 case PCI_UHCI_VENDORID_INTEL:
306 sprintf(sc->sc_vendor, "Intel");
308 case PCI_UHCI_VENDORID_VIA:
309 sprintf(sc->sc_vendor, "VIA");
313 device_printf(self, "(New UHCI DeviceId=0x%08x)\n",
314 pci_get_devid(self));
315 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
318 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USBREV_MASK) {
319 case PCI_USBREV_PRE_1_0:
320 sc->sc_bus.usbrev = USBREV_PRE_1_0;
323 sc->sc_bus.usbrev = USBREV_1_0;
326 sc->sc_bus.usbrev = USBREV_UNKNOWN;
330 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
331 (driver_intr_t *) uhci_intr, sc, &sc->ih);
333 device_printf(self, "Could not setup irq, %d\n", err);
335 uhci_pci_detach(self);
339 * Set the PIRQD enable bit and switch off all the others. We don't
340 * want legacy support to interfere with us XXX Does this also mean
341 * that the BIOS won't touch the keyboard anymore if it is connected
342 * to the ports of the root hub?
345 if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN)
346 device_printf(self, "LegSup = 0x%04x\n",
347 pci_read_config(self, PCI_LEGSUP, 2));
349 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
353 sc->sc_flags |= UHCI_SCFLG_DONEINIT;
354 err = device_probe_and_attach(sc->sc_bus.bdev);
358 device_printf(self, "USB init failed\n");
359 uhci_pci_detach(self);
362 return 0; /* success */
366 uhci_pci_detach(device_t self)
368 uhci_softc_t *sc = device_get_softc(self);
370 if (sc->sc_flags & UHCI_SCFLG_DONEINIT) {
372 sc->sc_flags &= ~UHCI_SCFLG_DONEINIT;
376 if (sc->irq_res && sc->ih) {
377 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
380 /* XXX or should we panic? */
381 device_printf(self, "Could not tear down irq, %d\n",
385 if (sc->sc_bus.bdev) {
386 device_delete_child(self, sc->sc_bus.bdev);
387 sc->sc_bus.bdev = NULL;
390 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
394 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG,
404 static device_method_t uhci_methods[] = {
405 /* Device interface */
406 DEVMETHOD(device_probe, uhci_pci_probe),
407 DEVMETHOD(device_attach, uhci_pci_attach),
408 DEVMETHOD(device_detach, uhci_pci_detach),
409 DEVMETHOD(device_suspend, uhci_pci_suspend),
410 DEVMETHOD(device_resume, uhci_pci_resume),
411 DEVMETHOD(device_shutdown, bus_generic_shutdown),
414 DEVMETHOD(bus_print_child, bus_generic_print_child),
419 static driver_t uhci_driver = {
422 sizeof(uhci_softc_t),
425 static devclass_t uhci_devclass;
427 DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0);
428 DRIVER_MODULE(uhci, cardbus, uhci_driver, uhci_devclass, 0, 0);