FreeBSD/Linux Kernel Cross Reference
sys/pci/uhci_pci.c
1 /*
2 * Copyright (c) 1998 The NetBSD Foundation, Inc.
3 * All rights reserved.
4 *
5 * This code is derived from software contributed to The NetBSD Foundation
6 * by Lennart Augustsson (augustss@carlstedt.se) at
7 * Carlstedt Research & Technology.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
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.
24 *
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.
36 *
37 * $FreeBSD: releng/5.0/sys/pci/uhci_pci.c 102537 2002-08-28 20:24:49Z joe $
38 */
39
40 /* Universal Host Controller Interface
41 *
42 * UHCI spec: http://www.intel.com/
43 */
44
45 /* The low level controller code for UHCI has been split into
46 * PCI probes and UHCI specific code. This was done to facilitate the
47 * sharing of code between *BSD's
48 */
49
50 #include "opt_bus.h"
51
52 #include <sys/param.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/module.h>
56 #include <sys/bus.h>
57 #include <sys/queue.h>
58 #if defined(__FreeBSD__)
59 #include <sys/bus.h>
60
61 #include <machine/bus.h>
62 #include <machine/resource.h>
63 #include <sys/rman.h>
64 #endif
65
66 #include <pci/pcivar.h>
67 #include <pci/pcireg.h>
68
69 #include <dev/usb/usb.h>
70 #include <dev/usb/usbdi.h>
71 #include <dev/usb/usbdivar.h>
72 #include <dev/usb/usb_mem.h>
73
74 #include <dev/usb/uhcireg.h>
75 #include <dev/usb/uhcivar.h>
76
77 #define PCI_UHCI_VENDORID_INTEL 0x8086
78 #define PCI_UHCI_VENDORID_VIA 0x1106
79
80 #define PCI_UHCI_DEVICEID_PIIX3 0x70208086
81 static const char *uhci_device_piix3 = "Intel 82371SB (PIIX3) USB controller";
82
83 #define PCI_UHCI_DEVICEID_PIIX4 0x71128086
84 #define PCI_UHCI_DEVICEID_PIIX4E 0x71128086 /* no separate stepping */
85 static const char *uhci_device_piix4 = "Intel 82371AB/EB (PIIX4) USB controller";
86
87 #define PCI_UHCI_DEVICEID_ICH 0x24128086
88 static const char *uhci_device_ich = "Intel 82801AA (ICH) USB controller";
89
90 #define PCI_UHCI_DEVICEID_ICH0 0x24228086
91 static const char *uhci_device_ich0 = "Intel 82801AB (ICH0) USB controller";
92
93 #define PCI_UHCI_DEVICEID_ICH2_A 0x24428086
94 static const char *uhci_device_ich2_a = "Intel 82801BA/BAM (ICH2) USB controller USB-A";
95
96 #define PCI_UHCI_DEVICEID_ICH2_B 0x24448086
97 static const char *uhci_device_ich2_b = "Intel 82801BA/BAM (ICH2) USB controller USB-B";
98
99 #define PCI_UHCI_DEVICEID_ICH3_A 0x24828086
100 static const char *uhci_device_ich3_a = "Intel 82801CA/CAM (ICH3) USB controller USB-A";
101
102 #define PCI_UHCI_DEVICEID_ICH3_B 0x24848086
103 static const char *uhci_device_ich3_b = "Intel 82801CA/CAM (ICH3) USB controller USB-B";
104
105 #define PCI_UHCI_DEVICEID_ICH3_C 0x24878086
106 static const char *uhci_device_ich3_c = "Intel 82801CA/CAM (ICH3) USB controller USB-C";
107
108 #define PCI_UHCI_DEVICEID_ICH4_A 0x24c28086
109 static const char *uhci_device_ich4_a = "Intel 82801DB (ICH4) USB controller USB-A";
110
111 #define PCI_UHCI_DEVICEID_ICH4_B 0x24c48086
112 static const char *uhci_device_ich4_b = "Intel 82801DB (ICH4) USB controller USB-B";
113
114 #define PCI_UHCI_DEVICEID_ICH4_C 0x24c78086
115 static const char *uhci_device_ich4_c = "Intel 82801DB (ICH4) USB controller USB-C";
116
117 #define PCI_UHCI_DEVICEID_440MX 0x719a8086
118 static const char *uhci_device_440mx = "Intel 82443MX USB controller";
119
120 #define PCI_UHCI_DEVICEID_460GX 0x76028086
121 static const char *uhci_device_460gx = "Intel 82372FB/82468GX USB controller";
122
123 #define PCI_UHCI_DEVICEID_VT83C572 0x30381106
124 static const char *uhci_device_vt83c572 = "VIA 83C572 USB controller";
125
126 static const char *uhci_device_generic = "UHCI (generic) USB controller";
127
128 #define PCI_UHCI_BASE_REG 0x20
129
130
131 static int uhci_pci_attach(device_t self);
132 static int uhci_pci_detach(device_t self);
133 static int uhci_pci_suspend(device_t self);
134 static int uhci_pci_resume(device_t self);
135
136
137 static int
138 uhci_pci_suspend(device_t self)
139 {
140 uhci_softc_t *sc = device_get_softc(self);
141 int err;
142
143 err = bus_generic_suspend(self);
144 if (err)
145 return err;
146 uhci_power(PWR_SUSPEND, sc);
147
148 return 0;
149 }
150
151 static int
152 uhci_pci_resume(device_t self)
153 {
154 uhci_softc_t *sc = device_get_softc(self);
155
156 uhci_power(PWR_RESUME, sc);
157 bus_generic_resume(self);
158
159 return 0;
160 }
161
162 static const char *
163 uhci_pci_match(device_t self)
164 {
165 u_int32_t device_id = pci_get_devid(self);
166
167 if (device_id == PCI_UHCI_DEVICEID_PIIX3) {
168 return (uhci_device_piix3);
169 } else if (device_id == PCI_UHCI_DEVICEID_PIIX4) {
170 return (uhci_device_piix4);
171 } else if (device_id == PCI_UHCI_DEVICEID_ICH) {
172 return (uhci_device_ich);
173 } else if (device_id == PCI_UHCI_DEVICEID_ICH0) {
174 return (uhci_device_ich0);
175 } else if (device_id == PCI_UHCI_DEVICEID_ICH2_A) {
176 return (uhci_device_ich2_a);
177 } else if (device_id == PCI_UHCI_DEVICEID_ICH2_B) {
178 return (uhci_device_ich2_b);
179 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_A) {
180 return (uhci_device_ich3_a);
181 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_B) {
182 return (uhci_device_ich3_b);
183 } else if (device_id == PCI_UHCI_DEVICEID_ICH3_C) {
184 return (uhci_device_ich3_c);
185 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_A) {
186 return (uhci_device_ich4_a);
187 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_B) {
188 return (uhci_device_ich4_b);
189 } else if (device_id == PCI_UHCI_DEVICEID_ICH4_C) {
190 return (uhci_device_ich4_c);
191 } else if (device_id == PCI_UHCI_DEVICEID_440MX) {
192 return (uhci_device_440mx);
193 } else if (device_id == PCI_UHCI_DEVICEID_460GX) {
194 return (uhci_device_460gx);
195 } else if (device_id == PCI_UHCI_DEVICEID_VT83C572) {
196 return (uhci_device_vt83c572);
197 } else {
198 if (pci_get_class(self) == PCIC_SERIALBUS
199 && pci_get_subclass(self) == PCIS_SERIALBUS_USB
200 && pci_get_progif(self) == PCI_INTERFACE_UHCI) {
201 return (uhci_device_generic);
202 }
203 }
204
205 return NULL; /* dunno... */
206 }
207
208 static int
209 uhci_pci_probe(device_t self)
210 {
211 const char *desc = uhci_pci_match(self);
212
213 if (desc) {
214 device_set_desc(self, desc);
215 return 0;
216 } else {
217 return ENXIO;
218 }
219 }
220
221 static int
222 uhci_pci_attach(device_t self)
223 {
224 uhci_softc_t *sc = device_get_softc(self);
225 int rid;
226 int err;
227
228 rid = PCI_UHCI_BASE_REG;
229 sc->io_res = bus_alloc_resource(self, SYS_RES_IOPORT, &rid,
230 0, ~0, 1, RF_ACTIVE);
231 if (!sc->io_res) {
232 device_printf(self, "Could not map ports\n");
233 return ENXIO;
234 }
235 sc->iot = rman_get_bustag(sc->io_res);
236 sc->ioh = rman_get_bushandle(sc->io_res);
237
238 /* disable interrupts */
239 bus_space_write_2(sc->iot, sc->ioh, UHCI_INTR, 0);
240
241 rid = 0;
242 sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid,
243 0, ~0, 1,
244 RF_SHAREABLE | RF_ACTIVE);
245 if (sc->irq_res == NULL) {
246 device_printf(self, "Could not allocate irq\n");
247 uhci_pci_detach(self);
248 return ENXIO;
249 }
250 sc->sc_bus.bdev = device_add_child(self, "usb", -1);
251 if (!sc->sc_bus.bdev) {
252 device_printf(self, "Could not add USB device\n");
253 uhci_pci_detach(self);
254 return ENOMEM;
255 }
256 device_set_ivars(sc->sc_bus.bdev, sc);
257
258 /* uhci_pci_match must never return NULL if uhci_pci_probe succeeded */
259 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self));
260 switch (pci_get_vendor(self)) {
261 case PCI_UHCI_VENDORID_INTEL:
262 sprintf(sc->sc_vendor, "Intel");
263 break;
264 case PCI_UHCI_VENDORID_VIA:
265 sprintf(sc->sc_vendor, "VIA");
266 break;
267 default:
268 if (bootverbose)
269 device_printf(self, "(New UHCI DeviceId=0x%08x)\n",
270 pci_get_devid(self));
271 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
272 }
273
274 switch (pci_read_config(self, PCI_USBREV, 4) & PCI_USBREV_MASK) {
275 case PCI_USBREV_PRE_1_0:
276 sc->sc_bus.usbrev = USBREV_PRE_1_0;
277 break;
278 case PCI_USBREV_1_0:
279 sc->sc_bus.usbrev = USBREV_1_0;
280 break;
281 default:
282 sc->sc_bus.usbrev = USBREV_UNKNOWN;
283 break;
284 }
285
286 err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
287 (driver_intr_t *) uhci_intr, sc, &sc->ih);
288 if (err) {
289 device_printf(self, "Could not setup irq, %d\n", err);
290 sc->ih = NULL;
291 uhci_pci_detach(self);
292 return ENXIO;
293 }
294 /*
295 * Set the PIRQD enable bit and switch off all the others. We don't
296 * want legacy support to interfere with us XXX Does this also mean
297 * that the BIOS won't touch the keyboard anymore if it is connected
298 * to the ports of the root hub?
299 */
300 #ifdef USB_DEBUG
301 if (pci_read_config(self, PCI_LEGSUP, 4) != PCI_LEGSUP_USBPIRQDEN)
302 device_printf(self, "LegSup = 0x%08x\n",
303 pci_read_config(self, PCI_LEGSUP, 4));
304 #endif
305 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 4);
306
307 err = uhci_init(sc);
308 if (!err)
309 err = device_probe_and_attach(sc->sc_bus.bdev);
310
311 if (err) {
312 device_printf(self, "USB init failed\n");
313 uhci_pci_detach(self);
314 return EIO;
315 }
316 return 0; /* success */
317 }
318
319 int
320 uhci_pci_detach(device_t self)
321 {
322 uhci_softc_t *sc = device_get_softc(self);
323
324 /*
325 * XXX This function is not yet complete and should not be added
326 * method list.
327 */
328 #if 0
329 if uhci_init
330 was successful
331 we should call something like uhci_deinit
332 #endif
333
334 /*
335 * disable interrupts that might have been switched on in
336 * uhci_init.
337 */
338 if (sc->iot && sc->ioh)
339 bus_space_write_2(sc->iot, sc->ioh, UHCI_INTR, 0);
340
341 if (sc->irq_res && sc->ih) {
342 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
343
344 if (err)
345 /* XXX or should we panic? */
346 device_printf(self, "Could not tear down irq, %d\n",
347 err);
348 sc->ih = NULL;
349 }
350 if (sc->sc_bus.bdev) {
351 device_delete_child(self, sc->sc_bus.bdev);
352 sc->sc_bus.bdev = NULL;
353 }
354 if (sc->irq_res) {
355 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
356 sc->irq_res = NULL;
357 }
358 if (sc->io_res) {
359 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG,
360 sc->io_res);
361 sc->io_res = NULL;
362 sc->iot = 0;
363 sc->ioh = 0;
364 }
365 return 0;
366 }
367
368
369 static device_method_t uhci_methods[] = {
370 /* Device interface */
371 DEVMETHOD(device_probe, uhci_pci_probe),
372 DEVMETHOD(device_attach, uhci_pci_attach),
373 DEVMETHOD(device_suspend, uhci_pci_suspend),
374 DEVMETHOD(device_resume, uhci_pci_resume),
375 DEVMETHOD(device_shutdown, bus_generic_shutdown),
376
377 /* Bus interface */
378 DEVMETHOD(bus_print_child, bus_generic_print_child),
379
380 {0, 0}
381 };
382
383 static driver_t uhci_driver = {
384 "uhci",
385 uhci_methods,
386 sizeof(uhci_softc_t),
387 };
388
389 static devclass_t uhci_devclass;
390
391 DRIVER_MODULE(uhci, pci, uhci_driver, uhci_devclass, 0, 0);
Cache object: c8a89836b8bdddd16086003d2a1752b1
|