sys/bus/pci/ohci_pci.c

   1 /*      $FreeBSD: src/sys/pci/ohci_pci.c,v 1.16.2.5 2002/08/28 20:51:56 joe Exp $ */
   2 /*      $DragonFly: src/sys/bus/pci/Attic/ohci_pci.c,v 1.4 2003/10/27 21:39:27 asmodai Exp $ */
   3
   4 /*
   5  * Copyright (c) 1998 The NetBSD Foundation, Inc.
   6  * All rights reserved.
   7  *
   8  * This code is derived from software contributed to The NetBSD Foundation
   9  * by Lennart Augustsson (augustss@carlstedt.se) at
  10  * Carlstedt Research & Technology.
  11  *
  12  * Redistribution and use in source and binary forms, with or without
  13  * modification, are permitted provided that the following conditions
  14  * are met:
  15  * 1. Redistributions of source code must retain the above copyright
  16  *    notice, this list of conditions and the following disclaimer.
  17  * 2. Redistributions in binary form must reproduce the above copyright
  18  *    notice, this list of conditions and the following disclaimer in the
  19  *    documentation and/or other materials provided with the distribution.
  20  * 3. All advertising materials mentioning features or use of this software
  21  *    must display the following acknowledgement:
  22  *        This product includes software developed by the NetBSD
  23  *        Foundation, Inc. and its contributors.
  24  * 4. Neither the name of The NetBSD Foundation nor the names of its
  25  *    contributors may be used to endorse or promote products derived
  26  *    from this software without specific prior written permission.
  27  *
  28  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  29  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  30  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  31  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  32  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  33  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  34  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  35  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  36  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  37  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  38  * POSSIBILITY OF SUCH DAMAGE.
  39  */
  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
  53 #include "opt_bus.h"
  54
  55 #include <sys/param.h>
  56 #include <sys/systm.h>
  57 #include <sys/kernel.h>
  58 #include <sys/module.h>
  59 #include <sys/bus.h>
  60 #include <sys/queue.h>
  61 #include <machine/bus.h>
  62 #include <sys/rman.h>
  63 #include <machine/resource.h>
  64
  65 #include "pcivar.h"
  66 #include "pcireg.h"
  67
  68 #include <bus/usb/usb.h>
  69 #include <bus/usb/usbdi.h>
  70 #include <bus/usb/usbdivar.h>
  71 #include <bus/usb/usb_mem.h>
  72
  73 #include <bus/usb/ohcireg.h>
  74 #include <bus/usb/ohcivar.h>
  75
  76 #define PCI_OHCI_VENDORID_ACERLABS      0x10b9
  77 #define PCI_OHCI_VENDORID_AMD           0x1022
  78 #define PCI_OHCI_VENDORID_APPLE         0x106b
  79 #define PCI_OHCI_VENDORID_CMDTECH       0x1095
  80 #define PCI_OHCI_VENDORID_NEC           0x1033
  81 #define PCI_OHCI_VENDORID_NVIDIA        0x10de
  82 #define PCI_OHCI_VENDORID_OPTI          0x1045
  83 #define PCI_OHCI_VENDORID_SIS           0x1039
  84
  85 #define PCI_OHCI_DEVICEID_ALADDIN_V     0x523710b9
  86 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
  87
  88 #define PCI_OHCI_DEVICEID_AMD756        0x740c1022
  89 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
  90
  91 #define PCI_OHCI_DEVICEID_AMD766        0x74141022
  92 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
  93
  94 #define PCI_OHCI_DEVICEID_NVIDIANF2     0x006710de
  95 static const char *ohci_device_nvidianf2 = "NVIDIA nForce2 USB Controller";
  96
  97 #define PCI_OHCI_DEVICEID_FIRELINK      0xc8611045
  98 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
  99
 100 #define PCI_OHCI_DEVICEID_NEC           0x00351033
 101 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
 102
 103 #define PCI_OHCI_DEVICEID_USB0670       0x06701095
 104 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
 105
 106 #define PCI_OHCI_DEVICEID_USB0673       0x06731095
 107 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
 108
 109 #define PCI_OHCI_DEVICEID_SIS5571       0x70011039
 110 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
 111
 112 #define PCI_OHCI_DEVICEID_KEYLARGO      0x0019106b
 113 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
 114
 115 static const char *ohci_device_generic = "OHCI (generic) USB controller";
 116
 117 #define PCI_OHCI_BASE_REG       0x10
 118
 119
 120 static int ohci_pci_attach(device_t self);
 121 static int ohci_pci_detach(device_t self);
 122
 123 static const char *
 124 ohci_pci_match(device_t self)
 125 {
 126         u_int32_t device_id = pci_get_devid(self);
 127
 128         switch (device_id) {
 129         case PCI_OHCI_DEVICEID_ALADDIN_V:
 130                 return (ohci_device_aladdin_v);
 131         case PCI_OHCI_DEVICEID_AMD756:
 132                 return (ohci_device_amd756);
 133         case PCI_OHCI_DEVICEID_AMD766:
 134                 return (ohci_device_amd766);
 135         case PCI_OHCI_DEVICEID_NVIDIANF2:
 136                 return (ohci_device_nvidianf2);
 137         case PCI_OHCI_DEVICEID_USB0670:
 138                 return (ohci_device_usb0670);
 139         case PCI_OHCI_DEVICEID_USB0673:
 140                 return (ohci_device_usb0673);
 141         case PCI_OHCI_DEVICEID_FIRELINK:
 142                 return (ohci_device_firelink);
 143         case PCI_OHCI_DEVICEID_NEC:
 144                 return (ohci_device_nec);
 145         case PCI_OHCI_DEVICEID_SIS5571:
 146                 return (ohci_device_sis5571);
 147         case PCI_OHCI_DEVICEID_KEYLARGO:
 148                 return (ohci_device_keylargo);
 149         default:
 150                 if (pci_get_class(self) == PCIC_SERIALBUS
 151                     && pci_get_subclass(self) == PCIS_SERIALBUS_USB
 152                     && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
 153                         return (ohci_device_generic);
 154                 }
 155         }
 156
 157         return NULL;            /* dunno */
 158 }
 159
 160 static int
 161 ohci_pci_probe(device_t self)
 162 {
 163         const char *desc = ohci_pci_match(self);
 164
 165         if (desc) {
 166                 device_set_desc(self, desc);
 167                 return 0;
 168         } else {
 169                 return ENXIO;
 170         }
 171 }
 172
 173 static int
 174 ohci_pci_attach(device_t self)
 175 {
 176         ohci_softc_t *sc = device_get_softc(self);
 177         int err;
 178         int rid;
 179
 180         /* XXX where does it say so in the spec? */
 181         sc->sc_bus.usbrev = USBREV_1_0;
 182
 183         rid = PCI_CBMEM;
 184         sc->io_res = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
 185             0, ~0, 1, RF_ACTIVE);
 186         if (!sc->io_res) {
 187                 device_printf(self, "Could not map memory\n");
 188                 return ENXIO;
 189         }
 190         sc->iot = rman_get_bustag(sc->io_res);
 191         sc->ioh = rman_get_bushandle(sc->io_res);
 192
 193         rid = 0;
 194         sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1,
 195             RF_SHAREABLE | RF_ACTIVE);
 196         if (sc->irq_res == NULL) {
 197                 device_printf(self, "Could not allocate irq\n");
 198                 ohci_pci_detach(self);
 199                 return ENXIO;
 200         }
 201         sc->sc_bus.bdev = device_add_child(self, "usb", -1);
 202         if (!sc->sc_bus.bdev) {
 203                 device_printf(self, "Could not add USB device\n");
 204                 ohci_pci_detach(self);
 205                 return ENOMEM;
 206         }
 207         device_set_ivars(sc->sc_bus.bdev, sc);
 208
 209         /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
 210         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 211         switch (pci_get_vendor(self)) {
 212         case PCI_OHCI_VENDORID_ACERLABS:
 213                 sprintf(sc->sc_vendor, "AcerLabs");
 214                 break;
 215         case PCI_OHCI_VENDORID_AMD:
 216                 sprintf(sc->sc_vendor, "AMD");
 217                 break;
 218         case PCI_OHCI_VENDORID_APPLE:
 219                 sprintf(sc->sc_vendor, "Apple");
 220                 break;
 221         case PCI_OHCI_VENDORID_CMDTECH:
 222                 sprintf(sc->sc_vendor, "CMDTECH");
 223                 break;
 224         case PCI_OHCI_VENDORID_NEC:
 225                 sprintf(sc->sc_vendor, "NEC");
 226                 break;
 227         case PCI_OHCI_VENDORID_NVIDIA:
 228                 sprintf(sc->sc_vendor, "NVIDIA");
 229                 break;
 230         case PCI_OHCI_VENDORID_OPTI:
 231                 sprintf(sc->sc_vendor, "OPTi");
 232                 break;
 233         case PCI_OHCI_VENDORID_SIS:
 234                 sprintf(sc->sc_vendor, "SiS");
 235                 break;
 236         default:
 237                 if (bootverbose)
 238                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 239                             pci_get_devid(self));
 240                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 241         }
 242
 243         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
 244             (driver_intr_t *) ohci_intr, sc, &sc->ih);
 245         if (err) {
 246                 device_printf(self, "Could not setup irq, %d\n", err);
 247                 sc->ih = NULL;
 248                 ohci_pci_detach(self);
 249                 return ENXIO;
 250         }
 251         err = ohci_init(sc);
 252         if (!err)
 253                 err = device_probe_and_attach(sc->sc_bus.bdev);
 254
 255         if (err) {
 256                 device_printf(self, "USB init failed\n");
 257                 ohci_pci_detach(self);
 258                 return EIO;
 259         }
 260         return 0;
 261 }
 262
 263 static int
 264 ohci_pci_detach(device_t self)
 265 {
 266         ohci_softc_t *sc = device_get_softc(self);
 267
 268         /*
 269          * XXX this code is not yet fit to be used as detach for the OHCI
 270          * controller
 271          */
 272
 273         /*
 274          * disable interrupts that might have been switched on in ohci_init
 275          */
 276         if (sc->iot && sc->ioh)
 277                 bus_space_write_4(sc->iot, sc->ioh,
 278                     OHCI_INTERRUPT_DISABLE, OHCI_ALL_INTRS);
 279
 280         if (sc->irq_res && sc->ih) {
 281                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 282
 283                 if (err)
 284                         /* XXX or should we panic? */
 285                         device_printf(self, "Could not tear down irq, %d\n",
 286                             err);
 287                 sc->ih = NULL;
 288         }
 289         if (sc->sc_bus.bdev) {
 290                 device_delete_child(self, sc->sc_bus.bdev);
 291                 sc->sc_bus.bdev = NULL;
 292         }
 293         if (sc->irq_res) {
 294                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 295                 sc->irq_res = NULL;
 296         }
 297         if (sc->io_res) {
 298                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
 299                 sc->io_res = NULL;
 300                 sc->iot = 0;
 301                 sc->ioh = 0;
 302         }
 303         return 0;
 304 }
 305
 306 static device_method_t ohci_methods[] = {
 307         /* Device interface */
 308         DEVMETHOD(device_probe, ohci_pci_probe),
 309         DEVMETHOD(device_attach, ohci_pci_attach),
 310         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 311
 312         /* Bus interface */
 313         DEVMETHOD(bus_print_child, bus_generic_print_child),
 314
 315         {0, 0}
 316 };
 317
 318 static driver_t ohci_driver = {
 319         "ohci",
 320         ohci_methods,
 321         sizeof(ohci_softc_t),
 322 };
 323
 324 static devclass_t ohci_devclass;
 325
 326 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);