sys/dev/usb/ohci_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 Open Host Controller driver.
  43  *
  44  * OHCI spec: http://www.intel.com/design/usb/ohci11d.pdf
  45  */
  46
  47 /* The low level controller code for OHCI has been split into
  48  * PCI probes and OHCI specific code. This was done to facilitate the
  49  * sharing of code between *BSD's
  50  */
  51
  52 #include "opt_bus.h"
  53
  54 #include <sys/param.h>
  55 #include <sys/systm.h>
  56 #include <sys/kernel.h>
  57 #include <sys/module.h>
  58 #include <sys/bus.h>
  59 #include <sys/queue.h>
  60 #include <machine/bus.h>
  61 #include <sys/rman.h>
  62 #include <machine/resource.h>
  63
  64 #include <dev/pci/pcivar.h>
  65 #include <dev/pci/pcireg.h>
  66
  67 #include <dev/usb/usb.h>
  68 #include <dev/usb/usbdi.h>
  69 #include <dev/usb/usbdivar.h>
  70 #include <dev/usb/usb_mem.h>
  71
  72 #include <dev/usb/ohcireg.h>
  73 #include <dev/usb/ohcivar.h>
  74
  75 #define PCI_OHCI_VENDORID_ACERLABS      0x10b9
  76 #define PCI_OHCI_VENDORID_AMD           0x1022
  77 #define PCI_OHCI_VENDORID_APPLE         0x106b
  78 #define PCI_OHCI_VENDORID_CMDTECH       0x1095
  79 #define PCI_OHCI_VENDORID_NEC           0x1033
  80 #define PCI_OHCI_VENDORID_NVIDIA        0x12D2
  81 #define PCI_OHCI_VENDORID_NVIDIA2       0x10DE
  82 #define PCI_OHCI_VENDORID_OPTI          0x1045
  83 #define PCI_OHCI_VENDORID_SIS           0x1039
  84 #define PCI_OHCI_VENDORID_SUN           0x108e
  85
  86 #define PCI_OHCI_DEVICEID_ALADDIN_V     0x523710b9
  87 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
  88
  89 #define PCI_OHCI_DEVICEID_AMD756        0x740c1022
  90 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
  91
  92 #define PCI_OHCI_DEVICEID_AMD766        0x74141022
  93 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
  94
  95 #define PCI_OHCI_DEVICEID_FIRELINK      0xc8611045
  96 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
  97
  98 #define PCI_OHCI_DEVICEID_NEC           0x00351033
  99 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
 100
 101 #define PCI_OHCI_DEVICEID_NFORCE3       0x00d710de
 102 static const char *ohci_device_nforce3 = "nVidia nForce3 USB Controller";
 103
 104 #define PCI_OHCI_DEVICEID_USB0670       0x06701095
 105 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
 106
 107 #define PCI_OHCI_DEVICEID_USB0673       0x06731095
 108 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
 109
 110 #define PCI_OHCI_DEVICEID_SIS5571       0x70011039
 111 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
 112
 113 #define PCI_OHCI_DEVICEID_KEYLARGO      0x0019106b
 114 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
 115
 116 #define PCI_OHCI_DEVICEID_PCIO2USB      0x1103108e
 117 static const char *ohci_device_pcio2usb = "Sun PCIO-2 USB controller";
 118
 119 static const char *ohci_device_generic = "OHCI (generic) USB controller";
 120
 121 #define PCI_OHCI_BASE_REG       0x10
 122
 123
 124 static int ohci_pci_attach(device_t self);
 125 static int ohci_pci_detach(device_t self);
 126 static int ohci_pci_suspend(device_t self);
 127 static int ohci_pci_resume(device_t self);
 128
 129 static int
 130 ohci_pci_suspend(device_t self)
 131 {
 132         ohci_softc_t *sc = device_get_softc(self);
 133         int err;
 134
 135         err = bus_generic_suspend(self);
 136         if (err)
 137                 return err;
 138         ohci_power(PWR_SUSPEND, sc);
 139
 140         return 0;
 141 }
 142
 143 static int
 144 ohci_pci_resume(device_t self)
 145 {
 146         ohci_softc_t *sc = device_get_softc(self);
 147
 148         ohci_power(PWR_RESUME, sc);
 149         bus_generic_resume(self);
 150
 151         return 0;
 152 }
 153
 154 static const char *
 155 ohci_pci_match(device_t self)
 156 {
 157         u_int32_t device_id = pci_get_devid(self);
 158
 159         switch (device_id) {
 160         case PCI_OHCI_DEVICEID_ALADDIN_V:
 161                 return (ohci_device_aladdin_v);
 162         case PCI_OHCI_DEVICEID_AMD756:
 163                 return (ohci_device_amd756);
 164         case PCI_OHCI_DEVICEID_AMD766:
 165                 return (ohci_device_amd766);
 166         case PCI_OHCI_DEVICEID_USB0670:
 167                 return (ohci_device_usb0670);
 168         case PCI_OHCI_DEVICEID_USB0673:
 169                 return (ohci_device_usb0673);
 170         case PCI_OHCI_DEVICEID_FIRELINK:
 171                 return (ohci_device_firelink);
 172         case PCI_OHCI_DEVICEID_NEC:
 173                 return (ohci_device_nec);
 174         case PCI_OHCI_DEVICEID_NFORCE3:
 175                 return (ohci_device_nforce3);
 176         case PCI_OHCI_DEVICEID_SIS5571:
 177                 return (ohci_device_sis5571);
 178         case PCI_OHCI_DEVICEID_KEYLARGO:
 179                 return (ohci_device_keylargo);
 180         case PCI_OHCI_DEVICEID_PCIO2USB:
 181                 return (ohci_device_pcio2usb);
 182         default:
 183                 if (pci_get_class(self) == PCIC_SERIALBUS
 184                     && pci_get_subclass(self) == PCIS_SERIALBUS_USB
 185                     && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
 186                         return (ohci_device_generic);
 187                 }
 188         }
 189
 190         return NULL;            /* dunno */
 191 }
 192
 193 static int
 194 ohci_pci_probe(device_t self)
 195 {
 196         const char *desc = ohci_pci_match(self);
 197
 198         if (desc) {
 199                 device_set_desc(self, desc);
 200                 return BUS_PROBE_DEFAULT;
 201         } else {
 202                 return ENXIO;
 203         }
 204 }
 205
 206 static int
 207 ohci_pci_attach(device_t self)
 208 {
 209         ohci_softc_t *sc = device_get_softc(self);
 210         int err;
 211         int rid;
 212
 213         /* XXX where does it say so in the spec? */
 214         sc->sc_bus.usbrev = USBREV_1_0;
 215
 216         pci_enable_busmaster(self);
 217
 218         /*
 219          * Some Sun PCIO-2 USB controllers have their intpin register
 220          * bogusly set to 0, although it should be 4. Correct that.
 221          */
 222         if (pci_get_devid(self) == PCI_OHCI_DEVICEID_PCIO2USB &&
 223             pci_get_intpin(self) == 0)
 224                 pci_set_intpin(self, 4);
 225
 226         rid = PCI_CBMEM;
 227         sc->io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
 228             RF_ACTIVE);
 229         if (!sc->io_res) {
 230                 device_printf(self, "Could not map memory\n");
 231                 return ENXIO;
 232         }
 233         sc->iot = rman_get_bustag(sc->io_res);
 234         sc->ioh = rman_get_bushandle(sc->io_res);
 235
 236         rid = 0;
 237         sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 238             RF_SHAREABLE | RF_ACTIVE);
 239         if (sc->irq_res == NULL) {
 240                 device_printf(self, "Could not allocate irq\n");
 241                 ohci_pci_detach(self);
 242                 return ENXIO;
 243         }
 244         sc->sc_bus.bdev = device_add_child(self, "usb", -1);
 245         if (!sc->sc_bus.bdev) {
 246                 device_printf(self, "Could not add USB device\n");
 247                 ohci_pci_detach(self);
 248                 return ENOMEM;
 249         }
 250         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 251
 252         /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
 253         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 254         switch (pci_get_vendor(self)) {
 255         case PCI_OHCI_VENDORID_ACERLABS:
 256                 sprintf(sc->sc_vendor, "AcerLabs");
 257                 break;
 258         case PCI_OHCI_VENDORID_AMD:
 259                 sprintf(sc->sc_vendor, "AMD");
 260                 break;
 261         case PCI_OHCI_VENDORID_APPLE:
 262                 sprintf(sc->sc_vendor, "Apple");
 263                 break;
 264         case PCI_OHCI_VENDORID_CMDTECH:
 265                 sprintf(sc->sc_vendor, "CMDTECH");
 266                 break;
 267         case PCI_OHCI_VENDORID_NEC:
 268                 sprintf(sc->sc_vendor, "NEC");
 269                 break;
 270         case PCI_OHCI_VENDORID_NVIDIA:
 271         case PCI_OHCI_VENDORID_NVIDIA2:
 272                 sprintf(sc->sc_vendor, "nVidia");
 273                 break;
 274         case PCI_OHCI_VENDORID_OPTI:
 275                 sprintf(sc->sc_vendor, "OPTi");
 276                 break;
 277         case PCI_OHCI_VENDORID_SIS:
 278                 sprintf(sc->sc_vendor, "SiS");
 279                 break;
 280         default:
 281                 if (bootverbose)
 282                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 283                             pci_get_devid(self));
 284                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 285         }
 286
 287         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
 288             (driver_intr_t *) ohci_intr, sc, &sc->ih);
 289         if (err) {
 290                 device_printf(self, "Could not setup irq, %d\n", err);
 291                 sc->ih = NULL;
 292                 ohci_pci_detach(self);
 293                 return ENXIO;
 294         }
 295         err = ohci_init(sc);
 296         if (!err) {
 297                 sc->sc_flags |= OHCI_SCFLG_DONEINIT;
 298                 err = device_probe_and_attach(sc->sc_bus.bdev);
 299         }
 300
 301         if (err) {
 302                 device_printf(self, "USB init failed\n");
 303                 ohci_pci_detach(self);
 304                 return EIO;
 305         }
 306         return 0;
 307 }
 308
 309 static int
 310 ohci_pci_detach(device_t self)
 311 {
 312         ohci_softc_t *sc = device_get_softc(self);
 313
 314         if (sc->sc_flags & OHCI_SCFLG_DONEINIT) {
 315                 ohci_detach(sc, 0);
 316                 sc->sc_flags &= ~OHCI_SCFLG_DONEINIT;
 317         }
 318
 319         if (sc->irq_res && sc->ih) {
 320                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 321
 322                 if (err)
 323                         /* XXX or should we panic? */
 324                         device_printf(self, "Could not tear down irq, %d\n",
 325                             err);
 326                 sc->ih = NULL;
 327         }
 328         if (sc->sc_bus.bdev) {
 329                 device_delete_child(self, sc->sc_bus.bdev);
 330                 sc->sc_bus.bdev = NULL;
 331         }
 332         if (sc->irq_res) {
 333                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 334                 sc->irq_res = NULL;
 335         }
 336         if (sc->io_res) {
 337                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
 338                 sc->io_res = NULL;
 339                 sc->iot = 0;
 340                 sc->ioh = 0;
 341         }
 342         return 0;
 343 }
 344
 345 static device_method_t ohci_methods[] = {
 346         /* Device interface */
 347         DEVMETHOD(device_probe, ohci_pci_probe),
 348         DEVMETHOD(device_attach, ohci_pci_attach),
 349         DEVMETHOD(device_detach, ohci_pci_detach),
 350         DEVMETHOD(device_suspend, ohci_pci_suspend),
 351         DEVMETHOD(device_resume, ohci_pci_resume),
 352         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 353
 354         /* Bus interface */
 355         DEVMETHOD(bus_print_child, bus_generic_print_child),
 356
 357         {0, 0}
 358 };
 359
 360 static driver_t ohci_driver = {
 361         "ohci",
 362         ohci_methods,
 363         sizeof(ohci_softc_t),
 364 };
 365
 366 static devclass_t ohci_devclass;
 367
 368 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
 369 DRIVER_MODULE(ohci, cardbus, ohci_driver, ohci_devclass, 0, 0);