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.3 2003/08/07 21:16:47 dillon 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_OPTI          0x1045
  82 #define PCI_OHCI_VENDORID_SIS           0x1039
  83
  84 #define PCI_OHCI_DEVICEID_ALADDIN_V     0x523710b9
  85 static const char *ohci_device_aladdin_v = "AcerLabs M5237 (Aladdin-V) USB controller";
  86
  87 #define PCI_OHCI_DEVICEID_AMD756        0x740c1022
  88 static const char *ohci_device_amd756 = "AMD-756 USB Controller";
  89
  90 #define PCI_OHCI_DEVICEID_AMD766        0x74141022
  91 static const char *ohci_device_amd766 = "AMD-766 USB Controller";
  92
  93 #define PCI_OHCI_DEVICEID_FIRELINK      0xc8611045
  94 static const char *ohci_device_firelink = "OPTi 82C861 (FireLink) USB controller";
  95
  96 #define PCI_OHCI_DEVICEID_NEC           0x00351033
  97 static const char *ohci_device_nec = "NEC uPD 9210 USB controller";
  98
  99 #define PCI_OHCI_DEVICEID_USB0670       0x06701095
 100 static const char *ohci_device_usb0670 = "CMD Tech 670 (USB0670) USB controller";
 101
 102 #define PCI_OHCI_DEVICEID_USB0673       0x06731095
 103 static const char *ohci_device_usb0673 = "CMD Tech 673 (USB0673) USB controller";
 104
 105 #define PCI_OHCI_DEVICEID_SIS5571       0x70011039
 106 static const char *ohci_device_sis5571 = "SiS 5571 USB controller";
 107
 108 #define PCI_OHCI_DEVICEID_KEYLARGO      0x0019106b
 109 static const char *ohci_device_keylargo = "Apple KeyLargo USB controller";
 110
 111 static const char *ohci_device_generic = "OHCI (generic) USB controller";
 112
 113 #define PCI_OHCI_BASE_REG       0x10
 114
 115
 116 static int ohci_pci_attach(device_t self);
 117 static int ohci_pci_detach(device_t self);
 118
 119 static const char *
 120 ohci_pci_match(device_t self)
 121 {
 122         u_int32_t device_id = pci_get_devid(self);
 123
 124         switch (device_id) {
 125         case PCI_OHCI_DEVICEID_ALADDIN_V:
 126                 return (ohci_device_aladdin_v);
 127         case PCI_OHCI_DEVICEID_AMD756:
 128                 return (ohci_device_amd756);
 129         case PCI_OHCI_DEVICEID_AMD766:
 130                 return (ohci_device_amd766);
 131         case PCI_OHCI_DEVICEID_USB0670:
 132                 return (ohci_device_usb0670);
 133         case PCI_OHCI_DEVICEID_USB0673:
 134                 return (ohci_device_usb0673);
 135         case PCI_OHCI_DEVICEID_FIRELINK:
 136                 return (ohci_device_firelink);
 137         case PCI_OHCI_DEVICEID_NEC:
 138                 return (ohci_device_nec);
 139         case PCI_OHCI_DEVICEID_SIS5571:
 140                 return (ohci_device_sis5571);
 141         case PCI_OHCI_DEVICEID_KEYLARGO:
 142                 return (ohci_device_keylargo);
 143         default:
 144                 if (pci_get_class(self) == PCIC_SERIALBUS
 145                     && pci_get_subclass(self) == PCIS_SERIALBUS_USB
 146                     && pci_get_progif(self) == PCI_INTERFACE_OHCI) {
 147                         return (ohci_device_generic);
 148                 }
 149         }
 150
 151         return NULL;            /* dunno */
 152 }
 153
 154 static int
 155 ohci_pci_probe(device_t self)
 156 {
 157         const char *desc = ohci_pci_match(self);
 158
 159         if (desc) {
 160                 device_set_desc(self, desc);
 161                 return 0;
 162         } else {
 163                 return ENXIO;
 164         }
 165 }
 166
 167 static int
 168 ohci_pci_attach(device_t self)
 169 {
 170         ohci_softc_t *sc = device_get_softc(self);
 171         int err;
 172         int rid;
 173
 174         /* XXX where does it say so in the spec? */
 175         sc->sc_bus.usbrev = USBREV_1_0;
 176
 177         rid = PCI_CBMEM;
 178         sc->io_res = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
 179             0, ~0, 1, RF_ACTIVE);
 180         if (!sc->io_res) {
 181                 device_printf(self, "Could not map memory\n");
 182                 return ENXIO;
 183         }
 184         sc->iot = rman_get_bustag(sc->io_res);
 185         sc->ioh = rman_get_bushandle(sc->io_res);
 186
 187         rid = 0;
 188         sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1,
 189             RF_SHAREABLE | RF_ACTIVE);
 190         if (sc->irq_res == NULL) {
 191                 device_printf(self, "Could not allocate irq\n");
 192                 ohci_pci_detach(self);
 193                 return ENXIO;
 194         }
 195         sc->sc_bus.bdev = device_add_child(self, "usb", -1);
 196         if (!sc->sc_bus.bdev) {
 197                 device_printf(self, "Could not add USB device\n");
 198                 ohci_pci_detach(self);
 199                 return ENOMEM;
 200         }
 201         device_set_ivars(sc->sc_bus.bdev, sc);
 202
 203         /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
 204         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 205         switch (pci_get_vendor(self)) {
 206         case PCI_OHCI_VENDORID_ACERLABS:
 207                 sprintf(sc->sc_vendor, "AcerLabs");
 208                 break;
 209         case PCI_OHCI_VENDORID_AMD:
 210                 sprintf(sc->sc_vendor, "AMD");
 211                 break;
 212         case PCI_OHCI_VENDORID_APPLE:
 213                 sprintf(sc->sc_vendor, "Apple");
 214                 break;
 215         case PCI_OHCI_VENDORID_CMDTECH:
 216                 sprintf(sc->sc_vendor, "CMDTECH");
 217                 break;
 218         case PCI_OHCI_VENDORID_NEC:
 219                 sprintf(sc->sc_vendor, "NEC");
 220                 break;
 221         case PCI_OHCI_VENDORID_OPTI:
 222                 sprintf(sc->sc_vendor, "OPTi");
 223                 break;
 224         case PCI_OHCI_VENDORID_SIS:
 225                 sprintf(sc->sc_vendor, "SiS");
 226                 break;
 227         default:
 228                 if (bootverbose)
 229                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 230                             pci_get_devid(self));
 231                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 232         }
 233
 234         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
 235             (driver_intr_t *) ohci_intr, sc, &sc->ih);
 236         if (err) {
 237                 device_printf(self, "Could not setup irq, %d\n", err);
 238                 sc->ih = NULL;
 239                 ohci_pci_detach(self);
 240                 return ENXIO;
 241         }
 242         err = ohci_init(sc);
 243         if (!err)
 244                 err = device_probe_and_attach(sc->sc_bus.bdev);
 245
 246         if (err) {
 247                 device_printf(self, "USB init failed\n");
 248                 ohci_pci_detach(self);
 249                 return EIO;
 250         }
 251         return 0;
 252 }
 253
 254 static int
 255 ohci_pci_detach(device_t self)
 256 {
 257         ohci_softc_t *sc = device_get_softc(self);
 258
 259         /*
 260          * XXX this code is not yet fit to be used as detach for the OHCI
 261          * controller
 262          */
 263
 264         /*
 265          * disable interrupts that might have been switched on in ohci_init
 266          */
 267         if (sc->iot && sc->ioh)
 268                 bus_space_write_4(sc->iot, sc->ioh,
 269                     OHCI_INTERRUPT_DISABLE, OHCI_ALL_INTRS);
 270
 271         if (sc->irq_res && sc->ih) {
 272                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 273
 274                 if (err)
 275                         /* XXX or should we panic? */
 276                         device_printf(self, "Could not tear down irq, %d\n",
 277                             err);
 278                 sc->ih = NULL;
 279         }
 280         if (sc->sc_bus.bdev) {
 281                 device_delete_child(self, sc->sc_bus.bdev);
 282                 sc->sc_bus.bdev = NULL;
 283         }
 284         if (sc->irq_res) {
 285                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 286                 sc->irq_res = NULL;
 287         }
 288         if (sc->io_res) {
 289                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
 290                 sc->io_res = NULL;
 291                 sc->iot = 0;
 292                 sc->ioh = 0;
 293         }
 294         return 0;
 295 }
 296
 297 static device_method_t ohci_methods[] = {
 298         /* Device interface */
 299         DEVMETHOD(device_probe, ohci_pci_probe),
 300         DEVMETHOD(device_attach, ohci_pci_attach),
 301         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 302
 303         /* Bus interface */
 304         DEVMETHOD(bus_print_child, bus_generic_print_child),
 305
 306         {0, 0}
 307 };
 308
 309 static driver_t ohci_driver = {
 310         "ohci",
 311         ohci_methods,
 312         sizeof(ohci_softc_t),
 313 };
 314
 315 static devclass_t ohci_devclass;
 316
 317 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);