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 <sys/param.h>
  53 #include <sys/systm.h>
  54 #include <sys/kernel.h>
  55 #include <sys/module.h>
  56 #include <sys/lock.h>
  57 #include <sys/mutex.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_ATI           0x1002
  79 #define PCI_OHCI_VENDORID_CMDTECH       0x1095
  80 #define PCI_OHCI_VENDORID_NEC           0x1033
  81 #define PCI_OHCI_VENDORID_NVIDIA        0x12D2
  82 #define PCI_OHCI_VENDORID_NVIDIA2       0x10DE
  83 #define PCI_OHCI_VENDORID_OPTI          0x1045
  84 #define PCI_OHCI_VENDORID_SIS           0x1039
  85 #define PCI_OHCI_VENDORID_SUN           0x108e
  86
  87 #define PCI_OHCI_DEVICEID_ALADDIN_V     0x523710b9
  88 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
  89
  90 #define PCI_OHCI_DEVICEID_AMD756        0x740c1022
  91 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
  92
  93 #define PCI_OHCI_DEVICEID_AMD766        0x74141022
  94 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
  95
  96 #define PCI_OHCI_DEVICEID_SB400_1       0x43741002
  97 #define PCI_OHCI_DEVICEID_SB400_2       0x43751002
  98 static const char *ohci_device_sb400 = "ATI SB400 USB Controller";
  99
 100 #define PCI_OHCI_DEVICEID_FIRELINK      0xc8611045
 101 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
 102
 103 #define PCI_OHCI_DEVICEID_NEC           0x00351033
 104 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
 105
 106 #define PCI_OHCI_DEVICEID_NFORCE3       0x00d710de
 107 static const char *ohci_device_nforce3 = "nVidia nForce3 USB Controller";
 108
 109 #define PCI_OHCI_DEVICEID_USB0670       0x06701095
 110 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
 111
 112 #define PCI_OHCI_DEVICEID_USB0673       0x06731095
 113 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
 114
 115 #define PCI_OHCI_DEVICEID_SIS5571       0x70011039
 116 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
 117
 118 #define PCI_OHCI_DEVICEID_KEYLARGO      0x0019106b
 119 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
 120
 121 #define PCI_OHCI_DEVICEID_PCIO2USB      0x1103108e
 122 static const char *ohci_device_pcio2usb = "Sun PCIO-2 USB controller";
 123
 124 static const char *ohci_device_generic = "OHCI (generic) USB controller";
 125
 126 #define PCI_OHCI_BASE_REG       0x10
 127
 128
 129 static device_attach_t ohci_pci_attach;
 130 static device_detach_t ohci_pci_detach;
 131 static device_suspend_t ohci_pci_suspend;
 132 static device_resume_t ohci_pci_resume;
 133
 134 static int
 135 ohci_pci_suspend(device_t self)
 136 {
 137         ohci_softc_t *sc = device_get_softc(self);
 138         int err;
 139
 140         err = bus_generic_suspend(self);
 141         if (err)
 142                 return err;
 143         ohci_power(PWR_SUSPEND, sc);
 144
 145         return 0;
 146 }
 147
 148 static int
 149 ohci_pci_resume(device_t self)
 150 {
 151         ohci_softc_t *sc = device_get_softc(self);
 152
 153         ohci_power(PWR_RESUME, sc);
 154         bus_generic_resume(self);
 155
 156         return 0;
 157 }
 158
 159 static const char *
 160 ohci_pci_match(device_t self)
 161 {
 162         u_int32_t device_id = pci_get_devid(self);
 163
 164         switch (device_id) {
 165         case PCI_OHCI_DEVICEID_ALADDIN_V:
 166                 return (ohci_device_aladdin_v);
 167         case PCI_OHCI_DEVICEID_AMD756:
 168                 return (ohci_device_amd756);
 169         case PCI_OHCI_DEVICEID_AMD766:
 170                 return (ohci_device_amd766);
 171         case PCI_OHCI_DEVICEID_SB400_1:
 172         case PCI_OHCI_DEVICEID_SB400_2:
 173                 return (ohci_device_sb400);
 174         case PCI_OHCI_DEVICEID_USB0670:
 175                 return (ohci_device_usb0670);
 176         case PCI_OHCI_DEVICEID_USB0673:
 177                 return (ohci_device_usb0673);
 178         case PCI_OHCI_DEVICEID_FIRELINK:
 179                 return (ohci_device_firelink);
 180         case PCI_OHCI_DEVICEID_NEC:
 181                 return (ohci_device_nec);
 182         case PCI_OHCI_DEVICEID_NFORCE3:
 183                 return (ohci_device_nforce3);
 184         case PCI_OHCI_DEVICEID_SIS5571:
 185                 return (ohci_device_sis5571);
 186         case PCI_OHCI_DEVICEID_KEYLARGO:
 187                 return (ohci_device_keylargo);
 188         case PCI_OHCI_DEVICEID_PCIO2USB:
 189                 return (ohci_device_pcio2usb);
 190         default:
 191                 if (pci_get_class(self) == PCIC_SERIALBUS
 192                     && pci_get_subclass(self) == PCIS_SERIALBUS_USB
 193                     && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
 194                         return (ohci_device_generic);
 195                 }
 196         }
 197
 198         return NULL;            /* dunno */
 199 }
 200
 201 static int
 202 ohci_pci_probe(device_t self)
 203 {
 204         const char *desc = ohci_pci_match(self);
 205
 206         if (desc) {
 207                 device_set_desc(self, desc);
 208                 return BUS_PROBE_DEFAULT;
 209         } else {
 210                 return ENXIO;
 211         }
 212 }
 213
 214 static int
 215 ohci_pci_attach(device_t self)
 216 {
 217         ohci_softc_t *sc = device_get_softc(self);
 218         int err;
 219         int rid;
 220
 221         /* XXX where does it say so in the spec? */
 222         sc->sc_bus.usbrev = USBREV_1_0;
 223
 224         pci_enable_busmaster(self);
 225
 226         /*
 227          * Some Sun PCIO-2 USB controllers have their intpin register
 228          * bogusly set to 0, although it should be 4. Correct that.
 229          */
 230         if (pci_get_devid(self) == PCI_OHCI_DEVICEID_PCIO2USB &&
 231             pci_get_intpin(self) == 0)
 232                 pci_set_intpin(self, 4);
 233
 234         rid = PCI_CBMEM;
 235         sc->io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
 236             RF_ACTIVE);
 237         if (!sc->io_res) {
 238                 device_printf(self, "Could not map memory\n");
 239                 return ENXIO;
 240         }
 241         sc->iot = rman_get_bustag(sc->io_res);
 242         sc->ioh = rman_get_bushandle(sc->io_res);
 243
 244         rid = 0;
 245         sc->irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 246             RF_SHAREABLE | RF_ACTIVE);
 247         if (sc->irq_res == NULL) {
 248                 device_printf(self, "Could not allocate irq\n");
 249                 ohci_pci_detach(self);
 250                 return ENXIO;
 251         }
 252         sc->sc_bus.bdev = device_add_child(self, "usb", -1);
 253         if (!sc->sc_bus.bdev) {
 254                 device_printf(self, "Could not add USB device\n");
 255                 ohci_pci_detach(self);
 256                 return ENOMEM;
 257         }
 258         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 259
 260         /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
 261         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 262         switch (pci_get_vendor(self)) {
 263         case PCI_OHCI_VENDORID_ACERLABS:
 264                 sprintf(sc->sc_vendor, "AcerLabs");
 265                 break;
 266         case PCI_OHCI_VENDORID_AMD:
 267                 sprintf(sc->sc_vendor, "AMD");
 268                 break;
 269         case PCI_OHCI_VENDORID_APPLE:
 270                 sprintf(sc->sc_vendor, "Apple");
 271                 break;
 272         case PCI_OHCI_VENDORID_ATI:
 273                 sprintf(sc->sc_vendor, "ATI");
 274                 break;
 275         case PCI_OHCI_VENDORID_CMDTECH:
 276                 sprintf(sc->sc_vendor, "CMDTECH");
 277                 break;
 278         case PCI_OHCI_VENDORID_NEC:
 279                 sprintf(sc->sc_vendor, "NEC");
 280                 break;
 281         case PCI_OHCI_VENDORID_NVIDIA:
 282         case PCI_OHCI_VENDORID_NVIDIA2:
 283                 sprintf(sc->sc_vendor, "nVidia");
 284                 break;
 285         case PCI_OHCI_VENDORID_OPTI:
 286                 sprintf(sc->sc_vendor, "OPTi");
 287                 break;
 288         case PCI_OHCI_VENDORID_SIS:
 289                 sprintf(sc->sc_vendor, "SiS");
 290                 break;
 291         default:
 292                 if (bootverbose)
 293                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 294                             pci_get_devid(self));
 295                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 296         }
 297
 298         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO, NULL, ohci_intr,
 299                              sc, &sc->ih);
 300         if (err) {
 301                 device_printf(self, "Could not setup irq, %d\n", err);
 302                 sc->ih = NULL;
 303                 ohci_pci_detach(self);
 304                 return ENXIO;
 305         }
 306
 307         /* Allocate a parent dma tag for DMA maps */
 308         err = bus_dma_tag_create(bus_get_dma_tag(self), 1, 0,
 309             BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
 310             BUS_SPACE_MAXSIZE_32BIT, USB_DMA_NSEG, BUS_SPACE_MAXSIZE_32BIT, 0,
 311             NULL, NULL, &sc->sc_bus.parent_dmatag);
 312         if (err) {
 313                 device_printf(self, "Could not allocate parent DMA tag (%d)\n",
 314                     err);
 315                 ohci_pci_detach(self);
 316                 return ENXIO;
 317         }
 318         /* Allocate a dma tag for transfer buffers */
 319         err = bus_dma_tag_create(sc->sc_bus.parent_dmatag, 1, 0,
 320             BUS_SPACE_MAXADDR_32BIT, BUS_SPACE_MAXADDR, NULL, NULL,
 321             BUS_SPACE_MAXSIZE_32BIT, USB_DMA_NSEG, BUS_SPACE_MAXSIZE_32BIT, 0,
 322             busdma_lock_mutex, &Giant, &sc->sc_bus.buffer_dmatag);
 323         if (err) {
 324                 device_printf(self, "Could not allocate transfer tag (%d)\n",
 325                     err);
 326                 ohci_pci_detach(self);
 327                 return ENXIO;
 328         }
 329
 330         err = ohci_init(sc);
 331         if (!err) {
 332                 sc->sc_flags |= OHCI_SCFLG_DONEINIT;
 333                 err = device_probe_and_attach(sc->sc_bus.bdev);
 334         }
 335
 336         if (err) {
 337                 device_printf(self, "USB init failed\n");
 338                 ohci_pci_detach(self);
 339                 return EIO;
 340         }
 341         return 0;
 342 }
 343
 344 static int
 345 ohci_pci_detach(device_t self)
 346 {
 347         ohci_softc_t *sc = device_get_softc(self);
 348
 349         if (sc->sc_flags & OHCI_SCFLG_DONEINIT) {
 350                 ohci_detach(sc, 0);
 351                 sc->sc_flags &= ~OHCI_SCFLG_DONEINIT;
 352         }
 353
 354         if (sc->sc_bus.parent_dmatag != NULL)
 355                 bus_dma_tag_destroy(sc->sc_bus.parent_dmatag);
 356         if (sc->sc_bus.buffer_dmatag != NULL)
 357                 bus_dma_tag_destroy(sc->sc_bus.buffer_dmatag);
 358
 359         if (sc->irq_res && sc->ih) {
 360                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 361
 362                 if (err)
 363                         /* XXX or should we panic? */
 364                         device_printf(self, "Could not tear down irq, %d\n",
 365                             err);
 366                 sc->ih = NULL;
 367         }
 368         if (sc->sc_bus.bdev) {
 369                 device_delete_child(self, sc->sc_bus.bdev);
 370                 sc->sc_bus.bdev = NULL;
 371         }
 372         if (sc->irq_res) {
 373                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 374                 sc->irq_res = NULL;
 375         }
 376         if (sc->io_res) {
 377                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
 378                     sc->io_res);
 379                 sc->io_res = NULL;
 380                 sc->iot = 0;
 381                 sc->ioh = 0;
 382         }
 383         return 0;
 384 }
 385
 386 static device_method_t ohci_methods[] = {
 387         /* Device interface */
 388         DEVMETHOD(device_probe, ohci_pci_probe),
 389         DEVMETHOD(device_attach, ohci_pci_attach),
 390         DEVMETHOD(device_detach, ohci_pci_detach),
 391         DEVMETHOD(device_suspend, ohci_pci_suspend),
 392         DEVMETHOD(device_resume, ohci_pci_resume),
 393         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 394
 395         /* Bus interface */
 396         DEVMETHOD(bus_print_child, bus_generic_print_child),
 397
 398         {0, 0}
 399 };
 400
 401 static driver_t ohci_driver = {
 402         "ohci",
 403         ohci_methods,
 404         sizeof(ohci_softc_t),
 405 };
 406
 407 static devclass_t ohci_devclass;
 408
 409 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
 410 DRIVER_MODULE(ohci, cardbus, ohci_driver, ohci_devclass, 0, 0);
 411 MODULE_DEPEND(ohci, usb, 1, 1, 1);