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 "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 <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_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         pci_enable_busmaster(self);
 177
 178         rid = PCI_CBMEM;
 179         sc->io_res = bus_alloc_resource(self, SYS_RES_MEMORY, &rid,
 180             0, ~0, 1, RF_ACTIVE);
 181         if (!sc->io_res) {
 182                 device_printf(self, "Could not map memory\n");
 183                 return ENXIO;
 184         }
 185         sc->iot = rman_get_bustag(sc->io_res);
 186         sc->ioh = rman_get_bushandle(sc->io_res);
 187
 188         rid = 0;
 189         sc->irq_res = bus_alloc_resource(self, SYS_RES_IRQ, &rid, 0, ~0, 1,
 190             RF_SHAREABLE | RF_ACTIVE);
 191         if (sc->irq_res == NULL) {
 192                 device_printf(self, "Could not allocate irq\n");
 193                 ohci_pci_detach(self);
 194                 return ENXIO;
 195         }
 196         sc->sc_bus.bdev = device_add_child(self, "usb", -1);
 197         if (!sc->sc_bus.bdev) {
 198                 device_printf(self, "Could not add USB device\n");
 199                 ohci_pci_detach(self);
 200                 return ENOMEM;
 201         }
 202         device_set_ivars(sc->sc_bus.bdev, sc);
 203
 204         /* ohci_pci_match will never return NULL if ohci_pci_probe succeeded */
 205         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 206         switch (pci_get_vendor(self)) {
 207         case PCI_OHCI_VENDORID_ACERLABS:
 208                 sprintf(sc->sc_vendor, "AcerLabs");
 209                 break;
 210         case PCI_OHCI_VENDORID_AMD:
 211                 sprintf(sc->sc_vendor, "AMD");
 212                 break;
 213         case PCI_OHCI_VENDORID_APPLE:
 214                 sprintf(sc->sc_vendor, "Apple");
 215                 break;
 216         case PCI_OHCI_VENDORID_CMDTECH:
 217                 sprintf(sc->sc_vendor, "CMDTECH");
 218                 break;
 219         case PCI_OHCI_VENDORID_NEC:
 220                 sprintf(sc->sc_vendor, "NEC");
 221                 break;
 222         case PCI_OHCI_VENDORID_OPTI:
 223                 sprintf(sc->sc_vendor, "OPTi");
 224                 break;
 225         case PCI_OHCI_VENDORID_SIS:
 226                 sprintf(sc->sc_vendor, "SiS");
 227                 break;
 228         default:
 229                 if (bootverbose)
 230                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 231                             pci_get_devid(self));
 232                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 233         }
 234
 235         err = bus_setup_intr(self, sc->irq_res, INTR_TYPE_BIO,
 236             (driver_intr_t *) ohci_intr, sc, &sc->ih);
 237         if (err) {
 238                 device_printf(self, "Could not setup irq, %d\n", err);
 239                 sc->ih = NULL;
 240                 ohci_pci_detach(self);
 241                 return ENXIO;
 242         }
 243         err = ohci_init(sc);
 244         if (!err)
 245                 err = device_probe_and_attach(sc->sc_bus.bdev);
 246
 247         if (err) {
 248                 device_printf(self, "USB init failed\n");
 249                 ohci_pci_detach(self);
 250                 return EIO;
 251         }
 252         return 0;
 253 }
 254
 255 static int
 256 ohci_pci_detach(device_t self)
 257 {
 258         ohci_softc_t *sc = device_get_softc(self);
 259
 260         /*
 261          * XXX this code is not yet fit to be used as detach for the OHCI
 262          * controller
 263          */
 264
 265         /*
 266          * disable interrupts that might have been switched on in ohci_init
 267          */
 268         if (sc->iot && sc->ioh)
 269                 bus_space_write_4(sc->iot, sc->ioh,
 270                     OHCI_INTERRUPT_DISABLE, OHCI_ALL_INTRS);
 271
 272         if (sc->irq_res && sc->ih) {
 273                 int err = bus_teardown_intr(self, sc->irq_res, sc->ih);
 274
 275                 if (err)
 276                         /* XXX or should we panic? */
 277                         device_printf(self, "Could not tear down irq, %d\n",
 278                             err);
 279                 sc->ih = NULL;
 280         }
 281         if (sc->sc_bus.bdev) {
 282                 device_delete_child(self, sc->sc_bus.bdev);
 283                 sc->sc_bus.bdev = NULL;
 284         }
 285         if (sc->irq_res) {
 286                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->irq_res);
 287                 sc->irq_res = NULL;
 288         }
 289         if (sc->io_res) {
 290                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM, sc->io_res);
 291                 sc->io_res = NULL;
 292                 sc->iot = 0;
 293                 sc->ioh = 0;
 294         }
 295         return 0;
 296 }
 297
 298 static device_method_t ohci_methods[] = {
 299         /* Device interface */
 300         DEVMETHOD(device_probe, ohci_pci_probe),
 301         DEVMETHOD(device_attach, ohci_pci_attach),
 302         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 303
 304         /* Bus interface */
 305         DEVMETHOD(bus_print_child, bus_generic_print_child),
 306
 307         {0, 0}
 308 };
 309
 310 static driver_t ohci_driver = {
 311         "ohci",
 312         ohci_methods,
 313         sizeof(ohci_softc_t),
 314 };
 315
 316 static devclass_t ohci_devclass;
 317
 318 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
 319 DRIVER_MODULE(ohci, cardbus, ohci_driver, ohci_devclass, 0, 0);