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 *
18 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #include <sys/cdefs.h>
32 __FBSDID("$FreeBSD: releng/10.2/sys/dev/usb/controller/ehci_pci.c 278278 2015-02-05 20:03:02Z hselasky $");
33
34 /*
35 * USB Enhanced Host Controller Driver, a.k.a. USB 2.0 controller.
36 *
37 * The EHCI 1.0 spec can be found at
38 * http://developer.intel.com/technology/usb/download/ehci-r10.pdf
39 * and the USB 2.0 spec at
40 * http://www.usb.org/developers/docs/usb_20.zip
41 */
42
43 /* The low level controller code for EHCI has been split into
44 * PCI probes and EHCI specific code. This was done to facilitate the
45 * sharing of code between *BSD's
46 */
47
48 #include <sys/stdint.h>
49 #include <sys/stddef.h>
50 #include <sys/param.h>
51 #include <sys/queue.h>
52 #include <sys/types.h>
53 #include <sys/systm.h>
54 #include <sys/kernel.h>
55 #include <sys/bus.h>
56 #include <sys/module.h>
57 #include <sys/lock.h>
58 #include <sys/mutex.h>
59 #include <sys/condvar.h>
60 #include <sys/sysctl.h>
61 #include <sys/sx.h>
62 #include <sys/unistd.h>
63 #include <sys/callout.h>
64 #include <sys/malloc.h>
65 #include <sys/priv.h>
66
67 #include <dev/usb/usb.h>
68 #include <dev/usb/usbdi.h>
69
70 #include <dev/usb/usb_core.h>
71 #include <dev/usb/usb_busdma.h>
72 #include <dev/usb/usb_process.h>
73 #include <dev/usb/usb_util.h>
74
75 #include <dev/usb/usb_controller.h>
76 #include <dev/usb/usb_bus.h>
77 #include <dev/usb/usb_pci.h>
78 #include <dev/usb/controller/ehci.h>
79 #include <dev/usb/controller/ehcireg.h>
80 #include "usb_if.h"
81
82 #define PCI_EHCI_VENDORID_ACERLABS 0x10b9
83 #define PCI_EHCI_VENDORID_AMD 0x1022
84 #define PCI_EHCI_VENDORID_APPLE 0x106b
85 #define PCI_EHCI_VENDORID_ATI 0x1002
86 #define PCI_EHCI_VENDORID_CMDTECH 0x1095
87 #define PCI_EHCI_VENDORID_INTEL 0x8086
88 #define PCI_EHCI_VENDORID_NEC 0x1033
89 #define PCI_EHCI_VENDORID_OPTI 0x1045
90 #define PCI_EHCI_VENDORID_PHILIPS 0x1131
91 #define PCI_EHCI_VENDORID_SIS 0x1039
92 #define PCI_EHCI_VENDORID_NVIDIA 0x12D2
93 #define PCI_EHCI_VENDORID_NVIDIA2 0x10DE
94 #define PCI_EHCI_VENDORID_VIA 0x1106
95
96 static device_probe_t ehci_pci_probe;
97 static device_attach_t ehci_pci_attach;
98 static device_detach_t ehci_pci_detach;
99 static usb_take_controller_t ehci_pci_take_controller;
100
101 static const char *
102 ehci_pci_match(device_t self)
103 {
104 uint32_t device_id = pci_get_devid(self);
105
106 switch (device_id) {
107 case 0x523910b9:
108 return "ALi M5239 USB 2.0 controller";
109
110 case 0x10227463:
111 return "AMD 8111 USB 2.0 controller";
112
113 case 0x20951022:
114 return ("AMD CS5536 (Geode) USB 2.0 controller");
115
116 case 0x43451002:
117 return "ATI SB200 USB 2.0 controller";
118 case 0x43731002:
119 return "ATI SB400 USB 2.0 controller";
120 case 0x43961002:
121 return ("AMD SB7x0/SB8x0/SB9x0 USB 2.0 controller");
122
123 case 0x0f348086:
124 return ("Intel BayTrail USB 2.0 controller");
125 case 0x1d268086:
126 return ("Intel Patsburg USB 2.0 controller");
127 case 0x1d2d8086:
128 return ("Intel Patsburg USB 2.0 controller");
129 case 0x1e268086:
130 return ("Intel Panther Point USB 2.0 controller");
131 case 0x1e2d8086:
132 return ("Intel Panther Point USB 2.0 controller");
133 case 0x1f2c8086:
134 return ("Intel Avoton USB 2.0 controller");
135 case 0x25ad8086:
136 return "Intel 6300ESB USB 2.0 controller";
137 case 0x24cd8086:
138 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
139 case 0x24dd8086:
140 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
141 case 0x265c8086:
142 return "Intel 82801FB (ICH6) USB 2.0 controller";
143 case 0x268c8086:
144 return ("Intel 63XXESB USB 2.0 controller");
145 case 0x27cc8086:
146 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
147 case 0x28368086:
148 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
149 case 0x283a8086:
150 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
151 case 0x293a8086:
152 return "Intel 82801I (ICH9) USB 2.0 controller";
153 case 0x293c8086:
154 return "Intel 82801I (ICH9) USB 2.0 controller";
155 case 0x3a3a8086:
156 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
157 case 0x3a3c8086:
158 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
159 case 0x3b348086:
160 return ("Intel PCH USB 2.0 controller USB-A");
161 case 0x3b3c8086:
162 return ("Intel PCH USB 2.0 controller USB-B");
163 case 0x8c268086:
164 return ("Intel Lynx Point USB 2.0 controller USB-A");
165 case 0x8c2d8086:
166 return ("Intel Lynx Point USB 2.0 controller USB-B");
167 case 0x8ca68086:
168 return ("Intel Wildcat Point USB 2.0 controller USB-A");
169 case 0x8cad8086:
170 return ("Intel Wildcat Point USB 2.0 controller USB-B");
171
172 case 0x00e01033:
173 return ("NEC uPD 720100 USB 2.0 controller");
174
175 case 0x006810de:
176 return "NVIDIA nForce2 USB 2.0 controller";
177 case 0x008810de:
178 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
179 case 0x00d810de:
180 return "NVIDIA nForce3 USB 2.0 controller";
181 case 0x00e810de:
182 return "NVIDIA nForce3 250 USB 2.0 controller";
183 case 0x005b10de:
184 return "NVIDIA nForce CK804 USB 2.0 controller";
185 case 0x036d10de:
186 return "NVIDIA nForce MCP55 USB 2.0 controller";
187 case 0x03f210de:
188 return "NVIDIA nForce MCP61 USB 2.0 controller";
189 case 0x0aa610de:
190 return "NVIDIA nForce MCP79 USB 2.0 controller";
191 case 0x0aa910de:
192 return "NVIDIA nForce MCP79 USB 2.0 controller";
193 case 0x0aaa10de:
194 return "NVIDIA nForce MCP79 USB 2.0 controller";
195
196 case 0x15621131:
197 return "Philips ISP156x USB 2.0 controller";
198
199 case 0x31041106:
200 return ("VIA VT6202 USB 2.0 controller");
201
202 default:
203 break;
204 }
205
206 if ((pci_get_class(self) == PCIC_SERIALBUS)
207 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
208 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
209 return ("EHCI (generic) USB 2.0 controller");
210 }
211 return (NULL); /* dunno */
212 }
213
214 static int
215 ehci_pci_probe(device_t self)
216 {
217 const char *desc = ehci_pci_match(self);
218
219 if (desc) {
220 device_set_desc(self, desc);
221 return (0);
222 } else {
223 return (ENXIO);
224 }
225 }
226
227 static void
228 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
229 {
230 device_t smbdev;
231 uint32_t val;
232
233 if (is_sb700) {
234 /* Lookup SMBUS PCI device */
235 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
236 if (smbdev == NULL)
237 return;
238 val = pci_get_revid(smbdev);
239 if (val != 0x3a && val != 0x3b)
240 return;
241 }
242
243 /*
244 * Note: this bit is described as reserved in SB700
245 * Register Reference Guide.
246 */
247 val = pci_read_config(self, 0x53, 1);
248 if (!(val & 0x8)) {
249 val |= 0x8;
250 pci_write_config(self, 0x53, val, 1);
251 device_printf(self, "AMD SB600/700 quirk applied\n");
252 }
253 }
254
255 static void
256 ehci_pci_via_quirk(device_t self)
257 {
258 uint32_t val;
259
260 if ((pci_get_device(self) == 0x3104) &&
261 ((pci_get_revid(self) & 0xf0) == 0x60)) {
262 /* Correct schedule sleep time to 10us */
263 val = pci_read_config(self, 0x4b, 1);
264 if (val & 0x20)
265 return;
266 val |= 0x20;
267 pci_write_config(self, 0x4b, val, 1);
268 device_printf(self, "VIA-quirk applied\n");
269 }
270 }
271
272 static int
273 ehci_pci_attach(device_t self)
274 {
275 ehci_softc_t *sc = device_get_softc(self);
276 int err;
277 int rid;
278
279 /* initialise some bus fields */
280 sc->sc_bus.parent = self;
281 sc->sc_bus.devices = sc->sc_devices;
282 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
283 sc->sc_bus.dma_bits = 32;
284
285 /* get all DMA memory */
286 if (usb_bus_mem_alloc_all(&sc->sc_bus,
287 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
288 return (ENOMEM);
289 }
290
291 pci_enable_busmaster(self);
292
293 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
294 case PCI_USB_REV_PRE_1_0:
295 case PCI_USB_REV_1_0:
296 case PCI_USB_REV_1_1:
297 /*
298 * NOTE: some EHCI USB controllers have the wrong USB
299 * revision number. It appears those controllers are
300 * fully compliant so we just ignore this value in
301 * some common cases.
302 */
303 device_printf(self, "pre-2.0 USB revision (ignored)\n");
304 /* fallthrough */
305 case PCI_USB_REV_2_0:
306 break;
307 default:
308 /* Quirk for Parallels Desktop 4.0 */
309 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
310 break;
311 }
312
313 rid = PCI_CBMEM;
314 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
315 RF_ACTIVE);
316 if (!sc->sc_io_res) {
317 device_printf(self, "Could not map memory\n");
318 goto error;
319 }
320 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
321 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
322 sc->sc_io_size = rman_get_size(sc->sc_io_res);
323
324 rid = 0;
325 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
326 RF_SHAREABLE | RF_ACTIVE);
327 if (sc->sc_irq_res == NULL) {
328 device_printf(self, "Could not allocate irq\n");
329 goto error;
330 }
331 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
332 if (!sc->sc_bus.bdev) {
333 device_printf(self, "Could not add USB device\n");
334 goto error;
335 }
336 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
337
338 /*
339 * ehci_pci_match will never return NULL if ehci_pci_probe
340 * succeeded
341 */
342 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
343 switch (pci_get_vendor(self)) {
344 case PCI_EHCI_VENDORID_ACERLABS:
345 sprintf(sc->sc_vendor, "AcerLabs");
346 break;
347 case PCI_EHCI_VENDORID_AMD:
348 sprintf(sc->sc_vendor, "AMD");
349 break;
350 case PCI_EHCI_VENDORID_APPLE:
351 sprintf(sc->sc_vendor, "Apple");
352 break;
353 case PCI_EHCI_VENDORID_ATI:
354 sprintf(sc->sc_vendor, "ATI");
355 break;
356 case PCI_EHCI_VENDORID_CMDTECH:
357 sprintf(sc->sc_vendor, "CMDTECH");
358 break;
359 case PCI_EHCI_VENDORID_INTEL:
360 sprintf(sc->sc_vendor, "Intel");
361 break;
362 case PCI_EHCI_VENDORID_NEC:
363 sprintf(sc->sc_vendor, "NEC");
364 break;
365 case PCI_EHCI_VENDORID_OPTI:
366 sprintf(sc->sc_vendor, "OPTi");
367 break;
368 case PCI_EHCI_VENDORID_PHILIPS:
369 sprintf(sc->sc_vendor, "Philips");
370 break;
371 case PCI_EHCI_VENDORID_SIS:
372 sprintf(sc->sc_vendor, "SiS");
373 break;
374 case PCI_EHCI_VENDORID_NVIDIA:
375 case PCI_EHCI_VENDORID_NVIDIA2:
376 sprintf(sc->sc_vendor, "nVidia");
377 break;
378 case PCI_EHCI_VENDORID_VIA:
379 sprintf(sc->sc_vendor, "VIA");
380 break;
381 default:
382 if (bootverbose)
383 device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
384 pci_get_devid(self));
385 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
386 }
387
388 #if (__FreeBSD_version >= 700031)
389 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
390 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
391 #else
392 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
393 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
394 #endif
395 if (err) {
396 device_printf(self, "Could not setup irq, %d\n", err);
397 sc->sc_intr_hdl = NULL;
398 goto error;
399 }
400 ehci_pci_take_controller(self);
401
402 /* Undocumented quirks taken from Linux */
403
404 switch (pci_get_vendor(self)) {
405 case PCI_EHCI_VENDORID_ATI:
406 /* SB600 and SB700 EHCI quirk */
407 switch (pci_get_device(self)) {
408 case 0x4386:
409 ehci_pci_ati_quirk(self, 0);
410 break;
411 case 0x4396:
412 ehci_pci_ati_quirk(self, 1);
413 break;
414 default:
415 break;
416 }
417 break;
418
419 case PCI_EHCI_VENDORID_VIA:
420 ehci_pci_via_quirk(self);
421 break;
422
423 default:
424 break;
425 }
426
427 /* Dropped interrupts workaround */
428 switch (pci_get_vendor(self)) {
429 case PCI_EHCI_VENDORID_ATI:
430 case PCI_EHCI_VENDORID_VIA:
431 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
432 if (bootverbose)
433 device_printf(self,
434 "Dropped interrupts workaround enabled\n");
435 break;
436 default:
437 break;
438 }
439
440 /* Doorbell feature workaround */
441 switch (pci_get_vendor(self)) {
442 case PCI_EHCI_VENDORID_NVIDIA:
443 case PCI_EHCI_VENDORID_NVIDIA2:
444 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
445 if (bootverbose)
446 device_printf(self,
447 "Doorbell workaround enabled\n");
448 break;
449 default:
450 break;
451 }
452
453 err = ehci_init(sc);
454 if (!err) {
455 err = device_probe_and_attach(sc->sc_bus.bdev);
456 }
457 if (err) {
458 device_printf(self, "USB init failed err=%d\n", err);
459 goto error;
460 }
461 return (0);
462
463 error:
464 ehci_pci_detach(self);
465 return (ENXIO);
466 }
467
468 static int
469 ehci_pci_detach(device_t self)
470 {
471 ehci_softc_t *sc = device_get_softc(self);
472 device_t bdev;
473
474 if (sc->sc_bus.bdev) {
475 bdev = sc->sc_bus.bdev;
476 device_detach(bdev);
477 device_delete_child(self, bdev);
478 }
479 /* during module unload there are lots of children leftover */
480 device_delete_children(self);
481
482 pci_disable_busmaster(self);
483
484 if (sc->sc_irq_res && sc->sc_intr_hdl) {
485 /*
486 * only call ehci_detach() after ehci_init()
487 */
488 ehci_detach(sc);
489
490 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
491
492 if (err)
493 /* XXX or should we panic? */
494 device_printf(self, "Could not tear down irq, %d\n",
495 err);
496 sc->sc_intr_hdl = NULL;
497 }
498 if (sc->sc_irq_res) {
499 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
500 sc->sc_irq_res = NULL;
501 }
502 if (sc->sc_io_res) {
503 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
504 sc->sc_io_res);
505 sc->sc_io_res = NULL;
506 }
507 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
508
509 return (0);
510 }
511
512 static int
513 ehci_pci_take_controller(device_t self)
514 {
515 ehci_softc_t *sc = device_get_softc(self);
516 uint32_t cparams;
517 uint32_t eec;
518 uint16_t to;
519 uint8_t eecp;
520 uint8_t bios_sem;
521
522 cparams = EREAD4(sc, EHCI_HCCPARAMS);
523
524 /* Synchronise with the BIOS if it owns the controller. */
525 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
526 eecp = EHCI_EECP_NEXT(eec)) {
527 eec = pci_read_config(self, eecp, 4);
528 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
529 continue;
530 }
531 bios_sem = pci_read_config(self, eecp +
532 EHCI_LEGSUP_BIOS_SEM, 1);
533 if (bios_sem == 0) {
534 continue;
535 }
536 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
537 "to give up control\n");
538 pci_write_config(self, eecp +
539 EHCI_LEGSUP_OS_SEM, 1, 1);
540 to = 500;
541 while (1) {
542 bios_sem = pci_read_config(self, eecp +
543 EHCI_LEGSUP_BIOS_SEM, 1);
544 if (bios_sem == 0)
545 break;
546
547 if (--to == 0) {
548 device_printf(sc->sc_bus.bdev,
549 "timed out waiting for BIOS\n");
550 break;
551 }
552 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */
553 }
554 }
555 return (0);
556 }
557
558 static device_method_t ehci_pci_methods[] = {
559 /* Device interface */
560 DEVMETHOD(device_probe, ehci_pci_probe),
561 DEVMETHOD(device_attach, ehci_pci_attach),
562 DEVMETHOD(device_detach, ehci_pci_detach),
563 DEVMETHOD(device_suspend, bus_generic_suspend),
564 DEVMETHOD(device_resume, bus_generic_resume),
565 DEVMETHOD(device_shutdown, bus_generic_shutdown),
566 DEVMETHOD(usb_take_controller, ehci_pci_take_controller),
567
568 DEVMETHOD_END
569 };
570
571 static driver_t ehci_driver = {
572 .name = "ehci",
573 .methods = ehci_pci_methods,
574 .size = sizeof(struct ehci_softc),
575 };
576
577 static devclass_t ehci_devclass;
578
579 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
580 MODULE_DEPEND(ehci, usb, 1, 1, 1);
Cache object: 3a2919756be0e795dcca395e5f2ab8ca
|