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/11.0/sys/dev/usb/controller/ehci_pci.c 297387 2016-03-29 12:50:42Z mav $");
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 case 0x78081022:
116 return ("AMD FCH USB 2.0 controller");
117
118 case 0x43451002:
119 return "ATI SB200 USB 2.0 controller";
120 case 0x43731002:
121 return "ATI SB400 USB 2.0 controller";
122 case 0x43961002:
123 return ("AMD SB7x0/SB8x0/SB9x0 USB 2.0 controller");
124
125 case 0x0f348086:
126 return ("Intel BayTrail USB 2.0 controller");
127 case 0x1d268086:
128 return ("Intel Patsburg USB 2.0 controller");
129 case 0x1d2d8086:
130 return ("Intel Patsburg USB 2.0 controller");
131 case 0x1e268086:
132 return ("Intel Panther Point USB 2.0 controller");
133 case 0x1e2d8086:
134 return ("Intel Panther Point USB 2.0 controller");
135 case 0x1f2c8086:
136 return ("Intel Avoton USB 2.0 controller");
137 case 0x25ad8086:
138 return "Intel 6300ESB USB 2.0 controller";
139 case 0x24cd8086:
140 return "Intel 82801DB/L/M (ICH4) USB 2.0 controller";
141 case 0x24dd8086:
142 return "Intel 82801EB/R (ICH5) USB 2.0 controller";
143 case 0x265c8086:
144 return "Intel 82801FB (ICH6) USB 2.0 controller";
145 case 0x268c8086:
146 return ("Intel 63XXESB USB 2.0 controller");
147 case 0x27cc8086:
148 return "Intel 82801GB/R (ICH7) USB 2.0 controller";
149 case 0x28368086:
150 return "Intel 82801H (ICH8) USB 2.0 controller USB2-A";
151 case 0x283a8086:
152 return "Intel 82801H (ICH8) USB 2.0 controller USB2-B";
153 case 0x293a8086:
154 return "Intel 82801I (ICH9) USB 2.0 controller";
155 case 0x293c8086:
156 return "Intel 82801I (ICH9) USB 2.0 controller";
157 case 0x3a3a8086:
158 return "Intel 82801JI (ICH10) USB 2.0 controller USB-A";
159 case 0x3a3c8086:
160 return "Intel 82801JI (ICH10) USB 2.0 controller USB-B";
161 case 0x3b348086:
162 return ("Intel PCH USB 2.0 controller USB-A");
163 case 0x3b3c8086:
164 return ("Intel PCH USB 2.0 controller USB-B");
165 case 0x8c268086:
166 return ("Intel Lynx Point USB 2.0 controller USB-A");
167 case 0x8c2d8086:
168 return ("Intel Lynx Point USB 2.0 controller USB-B");
169 case 0x8ca68086:
170 return ("Intel Wildcat Point USB 2.0 controller USB-A");
171 case 0x8cad8086:
172 return ("Intel Wildcat Point USB 2.0 controller USB-B");
173 case 0x8d268086:
174 return ("Intel Wellsburg USB 2.0 controller");
175 case 0x8d2d8086:
176 return ("Intel Wellsburg USB 2.0 controller");
177 case 0x9c268086:
178 return ("Intel Lynx Point LP USB 2.0 controller USB");
179
180 case 0x00e01033:
181 return ("NEC uPD 72010x USB 2.0 controller");
182
183 case 0x006810de:
184 return "NVIDIA nForce2 USB 2.0 controller";
185 case 0x008810de:
186 return "NVIDIA nForce2 Ultra 400 USB 2.0 controller";
187 case 0x00d810de:
188 return "NVIDIA nForce3 USB 2.0 controller";
189 case 0x00e810de:
190 return "NVIDIA nForce3 250 USB 2.0 controller";
191 case 0x005b10de:
192 return "NVIDIA nForce CK804 USB 2.0 controller";
193 case 0x036d10de:
194 return "NVIDIA nForce MCP55 USB 2.0 controller";
195 case 0x03f210de:
196 return "NVIDIA nForce MCP61 USB 2.0 controller";
197 case 0x0aa610de:
198 return "NVIDIA nForce MCP79 USB 2.0 controller";
199 case 0x0aa910de:
200 return "NVIDIA nForce MCP79 USB 2.0 controller";
201 case 0x0aaa10de:
202 return "NVIDIA nForce MCP79 USB 2.0 controller";
203
204 case 0x15621131:
205 return "Philips ISP156x USB 2.0 controller";
206
207 case 0x31041106:
208 return ("VIA VT6202 USB 2.0 controller");
209
210 default:
211 break;
212 }
213
214 if ((pci_get_class(self) == PCIC_SERIALBUS)
215 && (pci_get_subclass(self) == PCIS_SERIALBUS_USB)
216 && (pci_get_progif(self) == PCI_INTERFACE_EHCI)) {
217 return ("EHCI (generic) USB 2.0 controller");
218 }
219 return (NULL); /* dunno */
220 }
221
222 static int
223 ehci_pci_probe(device_t self)
224 {
225 const char *desc = ehci_pci_match(self);
226
227 if (desc) {
228 device_set_desc(self, desc);
229 return (BUS_PROBE_DEFAULT);
230 } else {
231 return (ENXIO);
232 }
233 }
234
235 static void
236 ehci_pci_ati_quirk(device_t self, uint8_t is_sb700)
237 {
238 device_t smbdev;
239 uint32_t val;
240
241 if (is_sb700) {
242 /* Lookup SMBUS PCI device */
243 smbdev = pci_find_device(PCI_EHCI_VENDORID_ATI, 0x4385);
244 if (smbdev == NULL)
245 return;
246 val = pci_get_revid(smbdev);
247 if (val != 0x3a && val != 0x3b)
248 return;
249 }
250
251 /*
252 * Note: this bit is described as reserved in SB700
253 * Register Reference Guide.
254 */
255 val = pci_read_config(self, 0x53, 1);
256 if (!(val & 0x8)) {
257 val |= 0x8;
258 pci_write_config(self, 0x53, val, 1);
259 device_printf(self, "AMD SB600/700 quirk applied\n");
260 }
261 }
262
263 static void
264 ehci_pci_via_quirk(device_t self)
265 {
266 uint32_t val;
267
268 if ((pci_get_device(self) == 0x3104) &&
269 ((pci_get_revid(self) & 0xf0) == 0x60)) {
270 /* Correct schedule sleep time to 10us */
271 val = pci_read_config(self, 0x4b, 1);
272 if (val & 0x20)
273 return;
274 val |= 0x20;
275 pci_write_config(self, 0x4b, val, 1);
276 device_printf(self, "VIA-quirk applied\n");
277 }
278 }
279
280 static int
281 ehci_pci_attach(device_t self)
282 {
283 ehci_softc_t *sc = device_get_softc(self);
284 int err;
285 int rid;
286
287 /* initialise some bus fields */
288 sc->sc_bus.parent = self;
289 sc->sc_bus.devices = sc->sc_devices;
290 sc->sc_bus.devices_max = EHCI_MAX_DEVICES;
291 sc->sc_bus.dma_bits = 32;
292
293 /* get all DMA memory */
294 if (usb_bus_mem_alloc_all(&sc->sc_bus,
295 USB_GET_DMA_TAG(self), &ehci_iterate_hw_softc)) {
296 return (ENOMEM);
297 }
298
299 pci_enable_busmaster(self);
300
301 switch (pci_read_config(self, PCI_USBREV, 1) & PCI_USB_REV_MASK) {
302 case PCI_USB_REV_PRE_1_0:
303 case PCI_USB_REV_1_0:
304 case PCI_USB_REV_1_1:
305 /*
306 * NOTE: some EHCI USB controllers have the wrong USB
307 * revision number. It appears those controllers are
308 * fully compliant so we just ignore this value in
309 * some common cases.
310 */
311 device_printf(self, "pre-2.0 USB revision (ignored)\n");
312 /* fallthrough */
313 case PCI_USB_REV_2_0:
314 break;
315 default:
316 /* Quirk for Parallels Desktop 4.0 */
317 device_printf(self, "USB revision is unknown. Assuming v2.0.\n");
318 break;
319 }
320
321 rid = PCI_CBMEM;
322 sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
323 RF_ACTIVE);
324 if (!sc->sc_io_res) {
325 device_printf(self, "Could not map memory\n");
326 goto error;
327 }
328 sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
329 sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
330 sc->sc_io_size = rman_get_size(sc->sc_io_res);
331
332 rid = 0;
333 sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
334 RF_SHAREABLE | RF_ACTIVE);
335 if (sc->sc_irq_res == NULL) {
336 device_printf(self, "Could not allocate irq\n");
337 goto error;
338 }
339 sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
340 if (!sc->sc_bus.bdev) {
341 device_printf(self, "Could not add USB device\n");
342 goto error;
343 }
344 device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
345
346 /*
347 * ehci_pci_match will never return NULL if ehci_pci_probe
348 * succeeded
349 */
350 device_set_desc(sc->sc_bus.bdev, ehci_pci_match(self));
351 switch (pci_get_vendor(self)) {
352 case PCI_EHCI_VENDORID_ACERLABS:
353 sprintf(sc->sc_vendor, "AcerLabs");
354 break;
355 case PCI_EHCI_VENDORID_AMD:
356 sprintf(sc->sc_vendor, "AMD");
357 break;
358 case PCI_EHCI_VENDORID_APPLE:
359 sprintf(sc->sc_vendor, "Apple");
360 break;
361 case PCI_EHCI_VENDORID_ATI:
362 sprintf(sc->sc_vendor, "ATI");
363 break;
364 case PCI_EHCI_VENDORID_CMDTECH:
365 sprintf(sc->sc_vendor, "CMDTECH");
366 break;
367 case PCI_EHCI_VENDORID_INTEL:
368 sprintf(sc->sc_vendor, "Intel");
369 break;
370 case PCI_EHCI_VENDORID_NEC:
371 sprintf(sc->sc_vendor, "NEC");
372 break;
373 case PCI_EHCI_VENDORID_OPTI:
374 sprintf(sc->sc_vendor, "OPTi");
375 break;
376 case PCI_EHCI_VENDORID_PHILIPS:
377 sprintf(sc->sc_vendor, "Philips");
378 break;
379 case PCI_EHCI_VENDORID_SIS:
380 sprintf(sc->sc_vendor, "SiS");
381 break;
382 case PCI_EHCI_VENDORID_NVIDIA:
383 case PCI_EHCI_VENDORID_NVIDIA2:
384 sprintf(sc->sc_vendor, "nVidia");
385 break;
386 case PCI_EHCI_VENDORID_VIA:
387 sprintf(sc->sc_vendor, "VIA");
388 break;
389 default:
390 if (bootverbose)
391 device_printf(self, "(New EHCI DeviceId=0x%08x)\n",
392 pci_get_devid(self));
393 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
394 }
395
396 #if (__FreeBSD_version >= 700031)
397 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
398 NULL, (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
399 #else
400 err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
401 (driver_intr_t *)ehci_interrupt, sc, &sc->sc_intr_hdl);
402 #endif
403 if (err) {
404 device_printf(self, "Could not setup irq, %d\n", err);
405 sc->sc_intr_hdl = NULL;
406 goto error;
407 }
408 ehci_pci_take_controller(self);
409
410 /* Undocumented quirks taken from Linux */
411
412 switch (pci_get_vendor(self)) {
413 case PCI_EHCI_VENDORID_ATI:
414 /* SB600 and SB700 EHCI quirk */
415 switch (pci_get_device(self)) {
416 case 0x4386:
417 ehci_pci_ati_quirk(self, 0);
418 break;
419 case 0x4396:
420 ehci_pci_ati_quirk(self, 1);
421 break;
422 default:
423 break;
424 }
425 break;
426
427 case PCI_EHCI_VENDORID_VIA:
428 ehci_pci_via_quirk(self);
429 break;
430
431 default:
432 break;
433 }
434
435 /* Dropped interrupts workaround */
436 switch (pci_get_vendor(self)) {
437 case PCI_EHCI_VENDORID_ATI:
438 case PCI_EHCI_VENDORID_VIA:
439 sc->sc_flags |= EHCI_SCFLG_LOSTINTRBUG;
440 if (bootverbose)
441 device_printf(self,
442 "Dropped interrupts workaround enabled\n");
443 break;
444 default:
445 break;
446 }
447
448 /* Doorbell feature workaround */
449 switch (pci_get_vendor(self)) {
450 case PCI_EHCI_VENDORID_NVIDIA:
451 case PCI_EHCI_VENDORID_NVIDIA2:
452 sc->sc_flags |= EHCI_SCFLG_IAADBUG;
453 if (bootverbose)
454 device_printf(self,
455 "Doorbell workaround enabled\n");
456 break;
457 default:
458 break;
459 }
460
461 err = ehci_init(sc);
462 if (!err) {
463 err = device_probe_and_attach(sc->sc_bus.bdev);
464 }
465 if (err) {
466 device_printf(self, "USB init failed err=%d\n", err);
467 goto error;
468 }
469 return (0);
470
471 error:
472 ehci_pci_detach(self);
473 return (ENXIO);
474 }
475
476 static int
477 ehci_pci_detach(device_t self)
478 {
479 ehci_softc_t *sc = device_get_softc(self);
480 device_t bdev;
481
482 if (sc->sc_bus.bdev) {
483 bdev = sc->sc_bus.bdev;
484 device_detach(bdev);
485 device_delete_child(self, bdev);
486 }
487 /* during module unload there are lots of children leftover */
488 device_delete_children(self);
489
490 pci_disable_busmaster(self);
491
492 if (sc->sc_irq_res && sc->sc_intr_hdl) {
493 /*
494 * only call ehci_detach() after ehci_init()
495 */
496 ehci_detach(sc);
497
498 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
499
500 if (err)
501 /* XXX or should we panic? */
502 device_printf(self, "Could not tear down irq, %d\n",
503 err);
504 sc->sc_intr_hdl = NULL;
505 }
506 if (sc->sc_irq_res) {
507 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
508 sc->sc_irq_res = NULL;
509 }
510 if (sc->sc_io_res) {
511 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
512 sc->sc_io_res);
513 sc->sc_io_res = NULL;
514 }
515 usb_bus_mem_free_all(&sc->sc_bus, &ehci_iterate_hw_softc);
516
517 return (0);
518 }
519
520 static int
521 ehci_pci_take_controller(device_t self)
522 {
523 ehci_softc_t *sc = device_get_softc(self);
524 uint32_t cparams;
525 uint32_t eec;
526 uint16_t to;
527 uint8_t eecp;
528 uint8_t bios_sem;
529
530 cparams = EREAD4(sc, EHCI_HCCPARAMS);
531
532 /* Synchronise with the BIOS if it owns the controller. */
533 for (eecp = EHCI_HCC_EECP(cparams); eecp != 0;
534 eecp = EHCI_EECP_NEXT(eec)) {
535 eec = pci_read_config(self, eecp, 4);
536 if (EHCI_EECP_ID(eec) != EHCI_EC_LEGSUP) {
537 continue;
538 }
539 bios_sem = pci_read_config(self, eecp +
540 EHCI_LEGSUP_BIOS_SEM, 1);
541 if (bios_sem == 0) {
542 continue;
543 }
544 device_printf(sc->sc_bus.bdev, "waiting for BIOS "
545 "to give up control\n");
546 pci_write_config(self, eecp +
547 EHCI_LEGSUP_OS_SEM, 1, 1);
548 to = 500;
549 while (1) {
550 bios_sem = pci_read_config(self, eecp +
551 EHCI_LEGSUP_BIOS_SEM, 1);
552 if (bios_sem == 0)
553 break;
554
555 if (--to == 0) {
556 device_printf(sc->sc_bus.bdev,
557 "timed out waiting for BIOS\n");
558 break;
559 }
560 usb_pause_mtx(NULL, hz / 100); /* wait 10ms */
561 }
562 }
563 return (0);
564 }
565
566 static device_method_t ehci_pci_methods[] = {
567 /* Device interface */
568 DEVMETHOD(device_probe, ehci_pci_probe),
569 DEVMETHOD(device_attach, ehci_pci_attach),
570 DEVMETHOD(device_detach, ehci_pci_detach),
571 DEVMETHOD(device_suspend, bus_generic_suspend),
572 DEVMETHOD(device_resume, bus_generic_resume),
573 DEVMETHOD(device_shutdown, bus_generic_shutdown),
574 DEVMETHOD(usb_take_controller, ehci_pci_take_controller),
575
576 DEVMETHOD_END
577 };
578
579 static driver_t ehci_driver = {
580 .name = "ehci",
581 .methods = ehci_pci_methods,
582 .size = sizeof(struct ehci_softc),
583 };
584
585 static devclass_t ehci_devclass;
586
587 DRIVER_MODULE(ehci, pci, ehci_driver, ehci_devclass, 0, 0);
588 MODULE_DEPEND(ehci, usb, 1, 1, 1);
Cache object: 4542e604b65398cce56a7e58be221dc0
|