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