sys/dev/usb/controller/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 <sys/stdint.h>
  53 #include <sys/stddef.h>
  54 #include <sys/param.h>
  55 #include <sys/queue.h>
  56 #include <sys/types.h>
  57 #include <sys/systm.h>
  58 #include <sys/kernel.h>
  59 #include <sys/bus.h>
  60 #include <sys/linker_set.h>
  61 #include <sys/module.h>
  62 #include <sys/lock.h>
  63 #include <sys/mutex.h>
  64 #include <sys/condvar.h>
  65 #include <sys/sysctl.h>
  66 #include <sys/sx.h>
  67 #include <sys/unistd.h>
  68 #include <sys/callout.h>
  69 #include <sys/malloc.h>
  70 #include <sys/priv.h>
  71
  72 #include <dev/usb/usb.h>
  73 #include <dev/usb/usbdi.h>
  74
  75 #include <dev/usb/usb_core.h>
  76 #include <dev/usb/usb_busdma.h>
  77 #include <dev/usb/usb_process.h>
  78 #include <dev/usb/usb_util.h>
  79
  80 #include <dev/usb/usb_controller.h>
  81 #include <dev/usb/usb_bus.h>
  82 #include <dev/usb/usb_pci.h>
  83 #include <dev/usb/controller/ohci.h>
  84 #include <dev/usb/controller/ohcireg.h>
  85
  86 #define PCI_OHCI_VENDORID_ACERLABS      0x10b9
  87 #define PCI_OHCI_VENDORID_AMD           0x1022
  88 #define PCI_OHCI_VENDORID_APPLE         0x106b
  89 #define PCI_OHCI_VENDORID_ATI           0x1002
  90 #define PCI_OHCI_VENDORID_CMDTECH       0x1095
  91 #define PCI_OHCI_VENDORID_NEC           0x1033
  92 #define PCI_OHCI_VENDORID_NVIDIA        0x12D2
  93 #define PCI_OHCI_VENDORID_NVIDIA2       0x10DE
  94 #define PCI_OHCI_VENDORID_OPTI          0x1045
  95 #define PCI_OHCI_VENDORID_SIS           0x1039
  96 #define PCI_OHCI_VENDORID_SUN           0x108e
  97
  98 #define PCI_OHCI_BASE_REG       0x10
  99
 100 static device_probe_t ohci_pci_probe;
 101 static device_attach_t ohci_pci_attach;
 102 static device_detach_t ohci_pci_detach;
 103 static device_suspend_t ohci_pci_suspend;
 104 static device_resume_t ohci_pci_resume;
 105
 106 static int
 107 ohci_pci_suspend(device_t self)
 108 {
 109         ohci_softc_t *sc = device_get_softc(self);
 110         int err;
 111
 112         err = bus_generic_suspend(self);
 113         if (err) {
 114                 return (err);
 115         }
 116         ohci_suspend(sc);
 117         return (0);
 118 }
 119
 120 static int
 121 ohci_pci_resume(device_t self)
 122 {
 123         ohci_softc_t *sc = device_get_softc(self);
 124         uint32_t reg, int_line;
 125
 126         if (pci_get_powerstate(self) != PCI_POWERSTATE_D0) {
 127                 device_printf(self, "chip is in D%d mode "
 128                     "-- setting to D0\n", pci_get_powerstate(self));
 129                 reg = pci_read_config(self, PCI_CBMEM, 4);
 130                 int_line = pci_read_config(self, PCIR_INTLINE, 4);
 131                 pci_set_powerstate(self, PCI_POWERSTATE_D0);
 132                 pci_write_config(self, PCI_CBMEM, reg, 4);
 133                 pci_write_config(self, PCIR_INTLINE, int_line, 4);
 134         }
 135         ohci_resume(sc);
 136
 137         bus_generic_resume(self);
 138         return (0);
 139 }
 140
 141 static const char *
 142 ohci_pci_match(device_t self)
 143 {
 144         uint32_t device_id = pci_get_devid(self);
 145
 146         switch (device_id) {
 147         case 0x523710b9:
 148                 return ("AcerLabs M5237 (Aladdin-V) USB controller");
 149
 150         case 0x740c1022:
 151                 return ("AMD-756 USB Controller");
 152
 153         case 0x74141022:
 154                 return ("AMD-766 USB Controller");
 155
 156         case 0x43741002:
 157                 return "ATI SB400 USB Controller";
 158         case 0x43751002:
 159                 return "ATI SB400 USB Controller";
 160
 161         case 0x06701095:
 162                 return ("CMD Tech 670 (USB0670) USB controller");
 163
 164         case 0x06731095:
 165                 return ("CMD Tech 673 (USB0673) USB controller");
 166
 167         case 0xc8611045:
 168                 return ("OPTi 82C861 (FireLink) USB controller");
 169
 170         case 0x00351033:
 171                 return ("NEC uPD 9210 USB controller");
 172
 173         case 0x00d710de:
 174                 return ("nVidia nForce3 USB Controller");
 175
 176         case 0x03f110de:
 177                 return ("nVidia nForce MCP61 USB Controller");
 178         case 0x0aa510de:
 179                 return ("nVidia nForce MCP79 USB Controller");
 180         case 0x0aa710de:
 181                 return ("nVidia nForce MCP79 USB Controller");
 182         case 0x0aa810de:
 183                 return ("nVidia nForce MCP79 USB Controller");
 184
 185         case 0x70011039:
 186                 return ("SiS 5571 USB controller");
 187
 188         case 0x1103108e:
 189                 return "Sun PCIO-2 USB controller";
 190
 191         case 0x0019106b:
 192                 return ("Apple KeyLargo USB controller");
 193
 194         default:
 195                 break;
 196         }
 197         if ((pci_get_class(self) == PCIC_SERIALBUS) &&
 198             (pci_get_subclass(self) == PCIS_SERIALBUS_USB) &&
 199             (pci_get_progif(self) == PCI_INTERFACE_OHCI)) {
 200                 return ("OHCI (generic) USB controller");
 201         }
 202         return (NULL);
 203 }
 204
 205 static int
 206 ohci_pci_probe(device_t self)
 207 {
 208         const char *desc = ohci_pci_match(self);
 209
 210         if (desc) {
 211                 device_set_desc(self, desc);
 212                 return (0);
 213         } else {
 214                 return (ENXIO);
 215         }
 216 }
 217
 218 static int
 219 ohci_pci_attach(device_t self)
 220 {
 221         ohci_softc_t *sc = device_get_softc(self);
 222         int rid;
 223         int err;
 224
 225         /* initialise some bus fields */
 226         sc->sc_bus.parent = self;
 227         sc->sc_bus.devices = sc->sc_devices;
 228         sc->sc_bus.devices_max = OHCI_MAX_DEVICES;
 229
 230         /* get all DMA memory */
 231         if (usb_bus_mem_alloc_all(&sc->sc_bus, USB_GET_DMA_TAG(self),
 232             &ohci_iterate_hw_softc)) {
 233                 return (ENOMEM);
 234         }
 235         sc->sc_dev = self;
 236
 237         pci_enable_busmaster(self);
 238
 239         /*
 240          * Some Sun PCIO-2 USB controllers have their intpin register
 241          * bogusly set to 0, although it should be 4.  Correct that.
 242          */
 243         if (pci_get_devid(self) == 0x1103108e && pci_get_intpin(self) == 0)
 244                 pci_set_intpin(self, 4);
 245
 246         rid = PCI_CBMEM;
 247         sc->sc_io_res = bus_alloc_resource_any(self, SYS_RES_MEMORY, &rid,
 248             RF_ACTIVE);
 249         if (!sc->sc_io_res) {
 250                 device_printf(self, "Could not map memory\n");
 251                 goto error;
 252         }
 253         sc->sc_io_tag = rman_get_bustag(sc->sc_io_res);
 254         sc->sc_io_hdl = rman_get_bushandle(sc->sc_io_res);
 255         sc->sc_io_size = rman_get_size(sc->sc_io_res);
 256
 257         rid = 0;
 258         sc->sc_irq_res = bus_alloc_resource_any(self, SYS_RES_IRQ, &rid,
 259             RF_SHAREABLE | RF_ACTIVE);
 260         if (sc->sc_irq_res == NULL) {
 261                 device_printf(self, "Could not allocate irq\n");
 262                 goto error;
 263         }
 264         sc->sc_bus.bdev = device_add_child(self, "usbus", -1);
 265         if (!sc->sc_bus.bdev) {
 266                 device_printf(self, "Could not add USB device\n");
 267                 goto error;
 268         }
 269         device_set_ivars(sc->sc_bus.bdev, &sc->sc_bus);
 270
 271         /*
 272          * ohci_pci_match will never return NULL if ohci_pci_probe
 273          * succeeded
 274          */
 275         device_set_desc(sc->sc_bus.bdev, ohci_pci_match(self));
 276         switch (pci_get_vendor(self)) {
 277         case PCI_OHCI_VENDORID_ACERLABS:
 278                 sprintf(sc->sc_vendor, "AcerLabs");
 279                 break;
 280         case PCI_OHCI_VENDORID_AMD:
 281                 sprintf(sc->sc_vendor, "AMD");
 282                 break;
 283         case PCI_OHCI_VENDORID_APPLE:
 284                 sprintf(sc->sc_vendor, "Apple");
 285                 break;
 286         case PCI_OHCI_VENDORID_ATI:
 287                 sprintf(sc->sc_vendor, "ATI");
 288                 break;
 289         case PCI_OHCI_VENDORID_CMDTECH:
 290                 sprintf(sc->sc_vendor, "CMDTECH");
 291                 break;
 292         case PCI_OHCI_VENDORID_NEC:
 293                 sprintf(sc->sc_vendor, "NEC");
 294                 break;
 295         case PCI_OHCI_VENDORID_NVIDIA:
 296         case PCI_OHCI_VENDORID_NVIDIA2:
 297                 sprintf(sc->sc_vendor, "nVidia");
 298                 break;
 299         case PCI_OHCI_VENDORID_OPTI:
 300                 sprintf(sc->sc_vendor, "OPTi");
 301                 break;
 302         case PCI_OHCI_VENDORID_SIS:
 303                 sprintf(sc->sc_vendor, "SiS");
 304                 break;
 305         case PCI_OHCI_VENDORID_SUN:
 306                 sprintf(sc->sc_vendor, "SUN");
 307                 break;
 308         default:
 309                 if (bootverbose) {
 310                         device_printf(self, "(New OHCI DeviceId=0x%08x)\n",
 311                             pci_get_devid(self));
 312                 }
 313                 sprintf(sc->sc_vendor, "(0x%04x)", pci_get_vendor(self));
 314         }
 315
 316         /* sc->sc_bus.usbrev; set by ohci_init() */
 317
 318 #if (__FreeBSD_version >= 700031)
 319         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 320             NULL, (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl);
 321 #else
 322         err = bus_setup_intr(self, sc->sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 323             (driver_intr_t *)ohci_interrupt, sc, &sc->sc_intr_hdl);
 324 #endif
 325         if (err) {
 326                 device_printf(self, "Could not setup irq, %d\n", err);
 327                 sc->sc_intr_hdl = NULL;
 328                 goto error;
 329         }
 330         err = ohci_init(sc);
 331         if (!err) {
 332                 err = device_probe_and_attach(sc->sc_bus.bdev);
 333         }
 334         if (err) {
 335                 device_printf(self, "USB init failed\n");
 336                 goto error;
 337         }
 338         return (0);
 339
 340 error:
 341         ohci_pci_detach(self);
 342         return (ENXIO);
 343 }
 344
 345 static int
 346 ohci_pci_detach(device_t self)
 347 {
 348         ohci_softc_t *sc = device_get_softc(self);
 349         device_t bdev;
 350
 351         if (sc->sc_bus.bdev) {
 352                 bdev = sc->sc_bus.bdev;
 353                 device_detach(bdev);
 354                 device_delete_child(self, bdev);
 355         }
 356         /* during module unload there are lots of children leftover */
 357         device_delete_all_children(self);
 358
 359         pci_disable_busmaster(self);
 360
 361         if (sc->sc_irq_res && sc->sc_intr_hdl) {
 362                 /*
 363                  * only call ohci_detach() after ohci_init()
 364                  */
 365                 ohci_detach(sc);
 366
 367                 int err = bus_teardown_intr(self, sc->sc_irq_res, sc->sc_intr_hdl);
 368
 369                 if (err) {
 370                         /* XXX or should we panic? */
 371                         device_printf(self, "Could not tear down irq, %d\n",
 372                             err);
 373                 }
 374                 sc->sc_intr_hdl = NULL;
 375         }
 376         if (sc->sc_irq_res) {
 377                 bus_release_resource(self, SYS_RES_IRQ, 0, sc->sc_irq_res);
 378                 sc->sc_irq_res = NULL;
 379         }
 380         if (sc->sc_io_res) {
 381                 bus_release_resource(self, SYS_RES_MEMORY, PCI_CBMEM,
 382                     sc->sc_io_res);
 383                 sc->sc_io_res = NULL;
 384         }
 385         usb_bus_mem_free_all(&sc->sc_bus, &ohci_iterate_hw_softc);
 386
 387         return (0);
 388 }
 389
 390 static driver_t ohci_driver =
 391 {
 392         .name = "ohci",
 393         .methods = (device_method_t[]){
 394                 /* device interface */
 395                 DEVMETHOD(device_probe, ohci_pci_probe),
 396                 DEVMETHOD(device_attach, ohci_pci_attach),
 397                 DEVMETHOD(device_detach, ohci_pci_detach),
 398                 DEVMETHOD(device_suspend, ohci_pci_suspend),
 399                 DEVMETHOD(device_resume, ohci_pci_resume),
 400                 DEVMETHOD(device_shutdown, bus_generic_shutdown),
 401
 402                 /* bus interface */
 403                 DEVMETHOD(bus_print_child, bus_generic_print_child),
 404
 405                 {0, 0}
 406         },
 407         .size = sizeof(struct ohci_softc),
 408 };
 409
 410 static devclass_t ohci_devclass;
 411
 412 DRIVER_MODULE(ohci, pci, ohci_driver, ohci_devclass, 0, 0);
 413 MODULE_DEPEND(ohci, usb, 1, 1, 1);