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