1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 1998 The NetBSD Foundation, Inc.
5 * All rights reserved.
6 *
7 * This code is derived from software contributed to The NetBSD Foundation
8 * by Lennart Augustsson (augustss@carlstedt.se) at
9 * Carlstedt Research & Technology.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 * notice, this list of conditions and the following disclaimer in the
18 * documentation and/or other materials provided with the distribution.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
24 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 /* Universal Host Controller Interface
34 *
35 * UHCI spec: http://www.intel.com/
36 */
37
38 /* The low level controller code for UHCI has been split into
39 * PCI probes and UHCI specific code. This was done to facilitate the
40 * sharing of code between *BSD's
41 */
42
43 #include <sys/stdint.h>
44 #include <sys/stddef.h>
45 #include <sys/param.h>
46 #include <sys/queue.h>
47 #include <sys/types.h>
48 #include <sys/systm.h>
49 #include <sys/kernel.h>
50 #include <sys/bus.h>
51 #include <sys/module.h>
52 #include <sys/lock.h>
53 #include <sys/mutex.h>
54 #include <sys/condvar.h>
55 #include <sys/sysctl.h>
56 #include <sys/sx.h>
57 #include <sys/unistd.h>
58 #include <sys/callout.h>
59 #include <sys/malloc.h>
60 #include <sys/priv.h>
61
62 #include <dev/usb/usb.h>
63 #include <dev/usb/usbdi.h>
64
65 #include <dev/usb/usb_core.h>
66 #include <dev/usb/usb_busdma.h>
67 #include <dev/usb/usb_process.h>
68 #include <dev/usb/usb_util.h>
69 #include <dev/usb/usb_debug.h>
70
71 #include <dev/usb/usb_controller.h>
72 #include <dev/usb/usb_bus.h>
73 #include <dev/usb/usb_pci.h>
74 #include <dev/usb/controller/uhci.h>
75 #include <dev/usb/controller/uhcireg.h>
76 #include "usb_if.h"
77
78 #define PCI_UHCI_VENDORID_INTEL 0x8086
79 #define PCI_UHCI_VENDORID_HP 0x103c
80 #define PCI_UHCI_VENDORID_VIA 0x1106
81 #define PCI_UHCI_VENDORID_VMWARE 0x15ad
82 #define PCI_UHCI_VENDORID_ZHAOXIN 0x1d17
83
84 /* PIIX4E has no separate stepping */
85
86 static device_probe_t uhci_pci_probe;
87 static device_attach_t uhci_pci_attach;
88 static device_detach_t uhci_pci_detach;
89 static usb_take_controller_t uhci_pci_take_controller;
90
91 static int
uhci_pci_take_controller(device_t self)92 uhci_pci_take_controller(device_t self)
93 {
94 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
95
96 return (0);
97 }
98
99 static const char *
uhci_pci_match(device_t self)100 uhci_pci_match(device_t self)
101 {
102 uint32_t device_id = pci_get_devid(self);
103
104 switch (device_id) {
105 case 0x26888086:
106 return ("Intel 631XESB/632XESB/3100 USB controller USB-1");
107
108 case 0x26898086:
109 return ("Intel 631XESB/632XESB/3100 USB controller USB-2");
110
111 case 0x268a8086:
112 return ("Intel 631XESB/632XESB/3100 USB controller USB-3");
113
114 case 0x268b8086:
115 return ("Intel 631XESB/632XESB/3100 USB controller USB-4");
116
117 case 0x70208086:
118 return ("Intel 82371SB (PIIX3) USB controller");
119
120 case 0x71128086:
121 return ("Intel 82371AB/EB (PIIX4) USB controller");
122
123 case 0x24128086:
124 return ("Intel 82801AA (ICH) USB controller");
125
126 case 0x24228086:
127 return ("Intel 82801AB (ICH0) USB controller");
128
129 case 0x24428086:
130 return ("Intel 82801BA/BAM (ICH2) USB controller USB-A");
131
132 case 0x24448086:
133 return ("Intel 82801BA/BAM (ICH2) USB controller USB-B");
134
135 case 0x24828086:
136 return ("Intel 82801CA/CAM (ICH3) USB controller USB-A");
137
138 case 0x24848086:
139 return ("Intel 82801CA/CAM (ICH3) USB controller USB-B");
140
141 case 0x24878086:
142 return ("Intel 82801CA/CAM (ICH3) USB controller USB-C");
143
144 case 0x24c28086:
145 return ("Intel 82801DB (ICH4) USB controller USB-A");
146
147 case 0x24c48086:
148 return ("Intel 82801DB (ICH4) USB controller USB-B");
149
150 case 0x24c78086:
151 return ("Intel 82801DB (ICH4) USB controller USB-C");
152
153 case 0x24d28086:
154 return ("Intel 82801EB (ICH5) USB controller USB-A");
155
156 case 0x24d48086:
157 return ("Intel 82801EB (ICH5) USB controller USB-B");
158
159 case 0x24d78086:
160 return ("Intel 82801EB (ICH5) USB controller USB-C");
161
162 case 0x24de8086:
163 return ("Intel 82801EB (ICH5) USB controller USB-D");
164
165 case 0x25a98086:
166 return ("Intel 6300ESB USB controller USB-A");
167
168 case 0x25aa8086:
169 return ("Intel 6300ESB USB controller USB-B");
170
171 case 0x26588086:
172 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-A");
173
174 case 0x26598086:
175 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-B");
176
177 case 0x265a8086:
178 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-C");
179
180 case 0x265b8086:
181 return ("Intel 82801FB/FR/FW/FRW (ICH6) USB controller USB-D");
182
183 case 0x27c88086:
184 return ("Intel 82801G (ICH7) USB controller USB-A");
185 case 0x27c98086:
186 return ("Intel 82801G (ICH7) USB controller USB-B");
187 case 0x27ca8086:
188 return ("Intel 82801G (ICH7) USB controller USB-C");
189 case 0x27cb8086:
190 return ("Intel 82801G (ICH7) USB controller USB-D");
191
192 case 0x28308086:
193 return ("Intel 82801H (ICH8) USB controller USB-A");
194 case 0x28318086:
195 return ("Intel 82801H (ICH8) USB controller USB-B");
196 case 0x28328086:
197 return ("Intel 82801H (ICH8) USB controller USB-C");
198 case 0x28348086:
199 return ("Intel 82801H (ICH8) USB controller USB-D");
200 case 0x28358086:
201 return ("Intel 82801H (ICH8) USB controller USB-E");
202 case 0x29348086:
203 return ("Intel 82801I (ICH9) USB controller");
204 case 0x29358086:
205 return ("Intel 82801I (ICH9) USB controller");
206 case 0x29368086:
207 return ("Intel 82801I (ICH9) USB controller");
208 case 0x29378086:
209 return ("Intel 82801I (ICH9) USB controller");
210 case 0x29388086:
211 return ("Intel 82801I (ICH9) USB controller");
212 case 0x29398086:
213 return ("Intel 82801I (ICH9) USB controller");
214 case 0x3a348086:
215 return ("Intel 82801JI (ICH10) USB controller USB-A");
216 case 0x3a358086:
217 return ("Intel 82801JI (ICH10) USB controller USB-B");
218 case 0x3a368086:
219 return ("Intel 82801JI (ICH10) USB controller USB-C");
220 case 0x3a378086:
221 return ("Intel 82801JI (ICH10) USB controller USB-D");
222 case 0x3a388086:
223 return ("Intel 82801JI (ICH10) USB controller USB-E");
224 case 0x3a398086:
225 return ("Intel 82801JI (ICH10) USB controller USB-F");
226 case 0x3a678086:
227 return ("Intel 82801JD (ICH10) USB controller USB-A");
228 case 0x3a688086:
229 return ("Intel 82801JD (ICH10) USB controller USB-B");
230 case 0x3a698086:
231 return ("Intel 82801JD (ICH10) USB controller USB-C");
232 case 0x3a648086:
233 return ("Intel 82801JD (ICH10) USB controller USB-D");
234 case 0x3a658086:
235 return ("Intel 82801JD (ICH10) USB controller USB-E");
236 case 0x3a668086:
237 return ("Intel 82801JD (ICH10) USB controller USB-F");
238
239 case 0x719a8086:
240 return ("Intel 82443MX USB controller");
241
242 case 0x76028086:
243 return ("Intel 82372FB/82468GX USB controller");
244
245 case 0x3300103c:
246 return ("HP iLO Standard Virtual USB controller");
247
248 case 0x30381106:
249 return ("VIA 83C572 USB controller");
250
251 case 0x077415ad:
252 return ("VMware USB controller");
253
254 case 0x30381d17:
255 return ("Zhaoxin ZX-100/ZX-200/ZX-E USB controller");
256
257 default:
258 break;
259 }
260
261 if ((pci_get_class(self) == PCIC_SERIALBUS) &&
262 (pci_get_subclass(self) == PCIS_SERIALBUS_USB) &&
263 (pci_get_progif(self) == PCI_INTERFACE_UHCI)) {
264 return ("UHCI (generic) USB controller");
265 }
266 return (NULL);
267 }
268
269 static int
uhci_pci_probe(device_t self)270 uhci_pci_probe(device_t self)
271 {
272 const char *desc = uhci_pci_match(self);
273
274 if (desc) {
275 device_set_desc(self, desc);
276 return (BUS_PROBE_DEFAULT);
277 } else {
278 return (ENXIO);
279 }
280 }
281
282 static int
uhci_pci_attach(device_t self)283 uhci_pci_attach(device_t self)
284 {
285 uhci_softc_t *sc = device_get_softc(self);
286 int rid;
287 int err;
288
289 /* initialise some bus fields */
290 sc->sc_bus.parent = self;
291 sc->sc_bus.devices = sc->sc_devices;
292 sc->sc_bus.devices_max = UHCI_MAX_DEVICES;
293 sc->sc_bus.dma_bits = 32;
294
295 /* get all DMA memory */
296 if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self),
297 &uhci_iterate_hw_softc)) {
298 return ENOMEM;
299 }
300 sc->sc_dev = self;
301
302 pci_enable_busmaster(self);
303
304 rid = PCI_UHCI_BASE_REG;
305 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_IOPORT, &rid,
306 RF_ACTIVE);
307 if (!sc->sc_io_res) {
308 device_printf(self, "Could not map ports\n");
309 goto error;
310 }
311 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
312 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
313 sc->sc_io_size = rman_get_size(sc->sc_io_res);
314
315 /* disable interrupts */
316 bus_space_write_2(sc->sc_io_tag, sc->sc_io_hdl, UHCI_INTR, 0);
317
318 rid = 0;
319 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
320 RF_SHAREABLE | RF_ACTIVE);
321 if (sc->sc_irq_res == NULL) {
322 device_printf(self, "Could not allocate irq\n");
323 goto error;
324 }
325 sc->sc_bus.bdev = device_add_child(self, "usbus", DEVICE_UNIT_ANY);
326 if (!sc->sc_bus.bdev) {
327 device_printf(self, "Could not add USB device\n");
328 goto error;
329 }
330 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
331
332 /*
333 * uhci_pci_match must never return NULL if uhci_pci_probe
334 * succeeded
335 */
336 device_set_desc(sc->sc_bus.bdev, uhci_pci_match(self));
337 switch (pci_get_vendor(self)) {
338 case PCI_UHCI_VENDORID_INTEL:
339 sprintf(sc->sc_vendor, "Intel");
340 break;
341 case PCI_UHCI_VENDORID_HP:
342 sprintf(sc->sc_vendor, "HP");
343 break;
344 case PCI_UHCI_VENDORID_VIA:
345 sprintf(sc->sc_vendor, "VIA");
346 break;
347 case PCI_UHCI_VENDORID_VMWARE:
348 sprintf(sc->sc_vendor, "VMware");
349 break;
350 case PCI_UHCI_VENDORID_ZHAOXIN:
351 sprintf(sc->sc_vendor, "Zhaoxin");
352 break;
353 default:
354 if (bootverbose) {
355 device_printf(self, "(New UHCI DeviceId=0x%08x)\n",
356 pci_get_devid(self));
357 }
358 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
359 }
360
361 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
362 case PCI_USB_REV_PRE_1_0:
363 sc->sc_bus.usbrev = USB_REV_PRE_1_0;
364 break;
365 case PCI_USB_REV_1_0:
366 sc->sc_bus.usbrev = USB_REV_1_0;
367 break;
368 default:
369 /* Quirk for Parallels Desktop 4.0 */
370 device_printf(self, "USB revision is unknown. Assuming v1.1.\n");
371 sc->sc_bus.usbrev = USB_REV_1_1;
372 break;
373 }
374
375 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
376 NULL, (driver_intr_t *)uhci_interrupt, sc, &sc->sc_intr_hdl);
377
378 if (err) {
379 device_printf(self, "Could not setup irq, %d\n", err);
380 sc->sc_intr_hdl = NULL;
381 goto error;
382 }
383 /*
384 * Set the PIRQD enable bit and switch off all the others. We don't
385 * want legacy support to interfere with us XXX Does this also mean
386 * that the BIOS won't touch the keyboard anymore if it is connected
387 * to the ports of the root hub?
388 */
389 #ifdef USB_DEBUG
390 if (pci_read_config(self, PCI_LEGSUP, 2) != PCI_LEGSUP_USBPIRQDEN) {
391 device_printf(self, "LegSup = 0x%04x\n",
392 pci_read_config(self, PCI_LEGSUP, 2));
393 }
394 #endif
395 pci_write_config(self, PCI_LEGSUP, PCI_LEGSUP_USBPIRQDEN, 2);
396
397 err = uhci_init(sc);
398 if (!err) {
399 err = device_probe_and_attach(sc->sc_bus.bdev);
400 }
401 if (err) {
402 device_printf(self, "USB init failed\n");
403 goto error;
404 }
405 return (0);
406
407 error:
408 uhci_pci_detach(self);
409 return (ENXIO);
410 }
411
412 int
uhci_pci_detach(device_t self)413 uhci_pci_detach(device_t self)
414 {
415 uhci_softc_t *sc = device_get_softc(self);
416 int error;
417
418 /* during module unload there are lots of children leftover */
419 error = bus_generic_detach(self);
420 if (error != 0)
421 return (error);
422
423 /*
424 * disable interrupts that might have been switched on in
425 * uhci_init.
426 */
427 if (sc->sc_io_res) {
428 USB_BUS_LOCK(&sc->sc_bus);
429
430 /* stop the controller */
431 uhci_reset(sc);
432
433 USB_BUS_UNLOCK(&sc->sc_bus);
434 }
435 pci_disable_busmaster(self);
436
437 if (sc->sc_irq_res && sc->sc_intr_hdl) {
438 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
439
440 if (err) {
441 /* XXX or should we panic? */
442 device_printf(self, "Could not tear down irq, %d\n",
443 err);
444 }
445 sc->sc_intr_hdl = NULL;
446 }
447 if (sc->sc_irq_res) {
448 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
449 sc->sc_irq_res = NULL;
450 }
451 if (sc->sc_io_res) {
452 bus_release_resource(self, SYS_RES_IOPORT, PCI_UHCI_BASE_REG,
453 sc->sc_io_res);
454 sc->sc_io_res = NULL;
455 }
456 usb_bus_mem_free_all(&sc->sc_bus, &uhci_iterate_hw_softc);
457
458 return (0);
459 }
460
461 static device_method_t uhci_pci_methods[] = {
462 /* Device interface */
463 DEVMETHOD(device_probe, uhci_pci_probe),
464 DEVMETHOD(device_attach, uhci_pci_attach),
465 DEVMETHOD(device_detach, uhci_pci_detach),
466 DEVMETHOD(device_suspend, bus_generic_suspend),
467 DEVMETHOD(device_resume, bus_generic_resume),
468 DEVMETHOD(device_shutdown, bus_generic_shutdown),
469 DEVMETHOD(usb_take_controller, uhci_pci_take_controller),
470
471 DEVMETHOD_END
472 };
473
474 static driver_t uhci_driver = {
475 .name = "uhci",
476 .methods = uhci_pci_methods,
477 .size = sizeof(struct uhci_softc),
478 };
479
480 DRIVER_MODULE(uhci, pci, uhci_driver, 0, 0);
481 MODULE_DEPEND(uhci, usb, 1, 1, 1);
482