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/module.h>
  38 #include <sys/lock.h>
  39 #include <sys/mutex.h>
  40 #include <sys/condvar.h>
  41 #include <sys/sysctl.h>
  42 #include <sys/sx.h>
  43 #include <sys/unistd.h>
  44 #include <sys/callout.h>
  45 #include <sys/malloc.h>
  46 #include <sys/priv.h>
  47 #include <sys/rman.h>
  48
  49 #include <dev/usb/usb.h>
  50 #include <dev/usb/usbdi.h>
  51
  52 #include <dev/usb/usb_core.h>
  53 #include <dev/usb/usb_busdma.h>
  54 #include <dev/usb/usb_process.h>
  55 #include <dev/usb/usb_util.h>
  56
  57 #include <dev/usb/usb_controller.h>
  58 #include <dev/usb/usb_bus.h>
  59
  60 #include <contrib/octeon-sdk/cvmx.h>
  61 #include <contrib/octeon-sdk/cvmx-interrupt.h>
  62 #include <contrib/octeon-sdk/cvmx-usb.h>
  63
  64 #include <mips/cavium/usb/octusb.h>
  65
  66 #define MEM_RID 0
  67
  68 static device_identify_t octusb_octeon_identify;
  69 static device_probe_t octusb_octeon_probe;
  70 static device_attach_t octusb_octeon_attach;
  71 static device_detach_t octusb_octeon_detach;
  72 static device_shutdown_t octusb_octeon_shutdown;
  73
  74 struct octusb_octeon_softc {
  75         struct octusb_softc sc_dci;     /* must be first */
  76 };
  77
  78 static void
  79 octusb_octeon_identify(driver_t *drv, device_t parent)
  80 {
  81         if (octeon_has_feature(OCTEON_FEATURE_USB))
  82                 BUS_ADD_CHILD(parent, 0, "octusb", 0);
  83 }
  84
  85 static int
  86 octusb_octeon_probe(device_t dev)
  87 {
  88         device_set_desc(dev, "Cavium Octeon USB controller");
  89         return (0);
  90 }
  91
  92 static int
  93 octusb_octeon_attach(device_t dev)
  94 {
  95         struct octusb_octeon_softc *sc = device_get_softc(dev);
  96         int err;
  97         int rid;
  98
  99         /* setup controller interface softc */
 100
 101         /* initialise some bus fields */
 102         sc->sc_dci.sc_bus.parent = dev;
 103         sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
 104         sc->sc_dci.sc_bus.devices_max = OCTUSB_MAX_DEVICES;
 105
 106         /* get all DMA memory */
 107         if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
 108             USB_GET_DMA_TAG(dev), NULL)) {
 109                 return (ENOMEM);
 110         }
 111         rid = 0;
 112         sc->sc_dci.sc_irq_res =
 113             bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
 114                                CVMX_IRQ_USB, CVMX_IRQ_USB, 1, RF_ACTIVE);
 115         if (!(sc->sc_dci.sc_irq_res)) {
 116                 goto error;
 117         }
 118
 119         sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 120         if (!(sc->sc_dci.sc_bus.bdev)) {
 121                 goto error;
 122         }
 123         device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
 124
 125 #if (__FreeBSD_version >= 700031)
 126         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 127             NULL, (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 128 #else
 129         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 130             (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 131 #endif
 132         if (err) {
 133                 sc->sc_dci.sc_intr_hdl = NULL;
 134                 goto error;
 135         }
 136         err = octusb_init(&sc->sc_dci);
 137         if (!err) {
 138                 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
 139         }
 140         if (err) {
 141                 goto error;
 142         }
 143         return (0);
 144
 145 error:
 146         octusb_octeon_detach(dev);
 147         return (ENXIO);
 148 }
 149
 150 static int
 151 octusb_octeon_detach(device_t dev)
 152 {
 153         struct octusb_octeon_softc *sc = device_get_softc(dev);
 154         device_t bdev;
 155         int err;
 156
 157         if (sc->sc_dci.sc_bus.bdev) {
 158                 bdev = sc->sc_dci.sc_bus.bdev;
 159                 device_detach(bdev);
 160                 device_delete_child(dev, bdev);
 161         }
 162         /* during module unload there are lots of children leftover */
 163         device_delete_all_children(dev);
 164
 165         if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
 166                 /*
 167                  * only call octusb_octeon_uninit() after octusb_octeon_init()
 168                  */
 169                 octusb_uninit(&sc->sc_dci);
 170
 171                 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
 172                     sc->sc_dci.sc_intr_hdl);
 173                 sc->sc_dci.sc_intr_hdl = NULL;
 174         }
 175         if (sc->sc_dci.sc_irq_res) {
 176                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 177                     sc->sc_dci.sc_irq_res);
 178                 sc->sc_dci.sc_irq_res = NULL;
 179         }
 180         usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
 181
 182         return (0);
 183 }
 184
 185 static int
 186 octusb_octeon_shutdown(device_t dev)
 187 {
 188         struct octusb_octeon_softc *sc = device_get_softc(dev);
 189         int err;
 190
 191         err = bus_generic_shutdown(dev);
 192         if (err)
 193                 return (err);
 194
 195         octusb_uninit(&sc->sc_dci);
 196
 197         return (0);
 198 }
 199
 200 static device_method_t octusb_octeon_methods[] = {
 201         /* Device interface */
 202         DEVMETHOD(device_identify, octusb_octeon_identify),
 203         DEVMETHOD(device_probe, octusb_octeon_probe),
 204         DEVMETHOD(device_attach, octusb_octeon_attach),
 205         DEVMETHOD(device_detach, octusb_octeon_detach),
 206         DEVMETHOD(device_shutdown, octusb_octeon_shutdown),
 207
 208         /* Bus interface */
 209         DEVMETHOD(bus_print_child, bus_generic_print_child),
 210
 211         {0, 0}
 212 };
 213
 214 static driver_t octusb_octeon_driver = {
 215         "octusb",
 216         octusb_octeon_methods,
 217         sizeof(struct octusb_octeon_softc),
 218 };
 219
 220 static devclass_t octusb_octeon_devclass;
 221
 222 DRIVER_MODULE(octusb, ciu, octusb_octeon_driver, octusb_octeon_devclass, 0, 0);