sys/dev/usb/ohci_pci.c

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