sys/mips/cavium/usb/octusb_octeon.c

   1 #include <sys/cdefs.h>
   2 __FBSDID("$FreeBSD$");
   3
   4 /*-
   5  * Copyright (c) 2007-2008 Hans Petter Selasky. All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  * 1. Redistributions of source code must retain the above copyright
  11  *    notice, this list of conditions and the following disclaimer.
  12  * 2. Redistributions in binary form must reproduce the above copyright
  13  *    notice, this list of conditions and the following disclaimer in the
  14  *    documentation and/or other materials provided with the distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  */
  28
  29 #include <sys/stdint.h>
  30 #include <sys/stddef.h>
  31 #include <sys/param.h>
  32 #include <sys/queue.h>
  33 #include <sys/types.h>
  34 #include <sys/systm.h>
  35 #include <sys/kernel.h>
  36 #include <sys/bus.h>
  37 #include <sys/linker_set.h>
  38 #include <sys/module.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41 #include <sys/condvar.h>
  42 #include <sys/sysctl.h>
  43 #include <sys/sx.h>
  44 #include <sys/unistd.h>
  45 #include <sys/callout.h>
  46 #include <sys/malloc.h>
  47 #include <sys/priv.h>
  48 #include <sys/rman.h>
  49
  50 #include <dev/usb/usb.h>
  51 #include <dev/usb/usbdi.h>
  52
  53 #include <dev/usb/usb_core.h>
  54 #include <dev/usb/usb_busdma.h>
  55 #include <dev/usb/usb_process.h>
  56 #include <dev/usb/usb_util.h>
  57
  58 #include <dev/usb/usb_controller.h>
  59 #include <dev/usb/usb_bus.h>
  60
  61 #include <contrib/octeon-sdk/cvmx.h>
  62 #include <contrib/octeon-sdk/cvmx-interrupt.h>
  63 #include <contrib/octeon-sdk/cvmx-usb.h>
  64
  65 #include <mips/cavium/usb/octusb.h>
  66
  67 #define MEM_RID 0
  68
  69 static device_identify_t octusb_octeon_identify;
  70 static device_probe_t octusb_octeon_probe;
  71 static device_attach_t octusb_octeon_attach;
  72 static device_detach_t octusb_octeon_detach;
  73 static device_shutdown_t octusb_octeon_shutdown;
  74
  75 struct octusb_octeon_softc {
  76         struct octusb_softc sc_dci;     /* must be first */
  77 };
  78
  79 static void
  80 octusb_octeon_identify(driver_t *drv, device_t parent)
  81 {
  82         if (octeon_has_feature(OCTEON_FEATURE_USB))
  83                 BUS_ADD_CHILD(parent, 0, "octusb", 0);
  84 }
  85
  86 static int
  87 octusb_octeon_probe(device_t dev)
  88 {
  89         device_set_desc(dev, "Cavium Octeon USB controller");
  90         return (0);
  91 }
  92
  93 static int
  94 octusb_octeon_attach(device_t dev)
  95 {
  96         struct octusb_octeon_softc *sc = device_get_softc(dev);
  97         int err;
  98         int rid;
  99
 100         /* setup controller interface softc */
 101
 102         /* initialise some bus fields */
 103         sc->sc_dci.sc_bus.parent = dev;
 104         sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
 105         sc->sc_dci.sc_bus.devices_max = OCTUSB_MAX_DEVICES;
 106
 107         /* get all DMA memory */
 108         if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
 109             USB_GET_DMA_TAG(dev), NULL)) {
 110                 return (ENOMEM);
 111         }
 112         rid = 0;
 113         sc->sc_dci.sc_irq_res =
 114             bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
 115                                CVMX_IRQ_USB, CVMX_IRQ_USB, 1, RF_ACTIVE);
 116         if (!(sc->sc_dci.sc_irq_res)) {
 117                 goto error;
 118         }
 119
 120         sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 121         if (!(sc->sc_dci.sc_bus.bdev)) {
 122                 goto error;
 123         }
 124         device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
 125
 126 #if (__FreeBSD_version >= 700031)
 127         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 128             NULL, (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 129 #else
 130         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 131             (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 132 #endif
 133         if (err) {
 134                 sc->sc_dci.sc_intr_hdl = NULL;
 135                 goto error;
 136         }
 137         err = octusb_init(&sc->sc_dci);
 138         if (!err) {
 139                 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
 140         }
 141         if (err) {
 142                 goto error;
 143         }
 144         return (0);
 145
 146 error:
 147         octusb_octeon_detach(dev);
 148         return (ENXIO);
 149 }
 150
 151 static int
 152 octusb_octeon_detach(device_t dev)
 153 {
 154         struct octusb_octeon_softc *sc = device_get_softc(dev);
 155         device_t bdev;
 156         int err;
 157
 158         if (sc->sc_dci.sc_bus.bdev) {
 159                 bdev = sc->sc_dci.sc_bus.bdev;
 160                 device_detach(bdev);
 161                 device_delete_child(dev, bdev);
 162         }
 163         /* during module unload there are lots of children leftover */
 164         device_delete_all_children(dev);
 165
 166         if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
 167                 /*
 168                  * only call octusb_octeon_uninit() after octusb_octeon_init()
 169                  */
 170                 octusb_uninit(&sc->sc_dci);
 171
 172                 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
 173                     sc->sc_dci.sc_intr_hdl);
 174                 sc->sc_dci.sc_intr_hdl = NULL;
 175         }
 176         if (sc->sc_dci.sc_irq_res) {
 177                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 178                     sc->sc_dci.sc_irq_res);
 179                 sc->sc_dci.sc_irq_res = NULL;
 180         }
 181         usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
 182
 183         return (0);
 184 }
 185
 186 static int
 187 octusb_octeon_shutdown(device_t dev)
 188 {
 189         struct octusb_octeon_softc *sc = device_get_softc(dev);
 190         int err;
 191
 192         err = bus_generic_shutdown(dev);
 193         if (err)
 194                 return (err);
 195
 196         octusb_uninit(&sc->sc_dci);
 197
 198         return (0);
 199 }
 200
 201 static device_method_t octusb_octeon_methods[] = {
 202         /* Device interface */
 203         DEVMETHOD(device_identify, octusb_octeon_identify),
 204         DEVMETHOD(device_probe, octusb_octeon_probe),
 205         DEVMETHOD(device_attach, octusb_octeon_attach),
 206         DEVMETHOD(device_detach, octusb_octeon_detach),
 207         DEVMETHOD(device_shutdown, octusb_octeon_shutdown),
 208
 209         /* Bus interface */
 210         DEVMETHOD(bus_print_child, bus_generic_print_child),
 211
 212         {0, 0}
 213 };
 214
 215 static driver_t octusb_octeon_driver = {
 216         "octusb",
 217         octusb_octeon_methods,
 218         sizeof(struct octusb_octeon_softc),
 219 };
 220
 221 static devclass_t octusb_octeon_devclass;
 222
 223 DRIVER_MODULE(octusb, ciu, octusb_octeon_driver, octusb_octeon_devclass, 0, 0);