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
  73 struct octusb_octeon_softc {
  74         struct octusb_softc sc_dci;     /* must be first */
  75 };
  76
  77 static void
  78 octusb_octeon_identify(driver_t *drv, device_t parent)
  79 {
  80         if (octeon_has_feature(OCTEON_FEATURE_USB))
  81                 BUS_ADD_CHILD(parent, 0, "octusb", 0);
  82 }
  83
  84 static int
  85 octusb_octeon_probe(device_t dev)
  86 {
  87         device_set_desc(dev, "Cavium Octeon USB controller");
  88         return (0);
  89 }
  90
  91 static int
  92 octusb_octeon_attach(device_t dev)
  93 {
  94         struct octusb_octeon_softc *sc = device_get_softc(dev);
  95         int err;
  96         int rid;
  97
  98         /* setup controller interface softc */
  99
 100         /* initialise some bus fields */
 101         sc->sc_dci.sc_bus.parent = dev;
 102         sc->sc_dci.sc_bus.devices = sc->sc_dci.sc_devices;
 103         sc->sc_dci.sc_bus.devices_max = OCTUSB_MAX_DEVICES;
 104
 105         /* get all DMA memory */
 106         if (usb_bus_mem_alloc_all(&sc->sc_dci.sc_bus,
 107             USB_GET_DMA_TAG(dev), NULL)) {
 108                 return (ENOMEM);
 109         }
 110         rid = 0;
 111         sc->sc_dci.sc_irq_res =
 112             bus_alloc_resource(dev, SYS_RES_IRQ, &rid,
 113                                CVMX_IRQ_USB, CVMX_IRQ_USB, 1, RF_ACTIVE);
 114         if (!(sc->sc_dci.sc_irq_res)) {
 115                 goto error;
 116         }
 117
 118         sc->sc_dci.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 119         if (!(sc->sc_dci.sc_bus.bdev)) {
 120                 goto error;
 121         }
 122         device_set_ivars(sc->sc_dci.sc_bus.bdev, &sc->sc_dci.sc_bus);
 123
 124 #if (__FreeBSD_version >= 700031)
 125         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 126             NULL, (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 127 #else
 128         err = bus_setup_intr(dev, sc->sc_dci.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 129             (driver_intr_t *)octusb_interrupt, sc, &sc->sc_dci.sc_intr_hdl);
 130 #endif
 131         if (err) {
 132                 sc->sc_dci.sc_intr_hdl = NULL;
 133                 goto error;
 134         }
 135         err = octusb_init(&sc->sc_dci);
 136         if (!err) {
 137                 err = device_probe_and_attach(sc->sc_dci.sc_bus.bdev);
 138         }
 139         if (err) {
 140                 goto error;
 141         }
 142         return (0);
 143
 144 error:
 145         octusb_octeon_detach(dev);
 146         return (ENXIO);
 147 }
 148
 149 static int
 150 octusb_octeon_detach(device_t dev)
 151 {
 152         struct octusb_octeon_softc *sc = device_get_softc(dev);
 153         device_t bdev;
 154         int err;
 155
 156         if (sc->sc_dci.sc_bus.bdev) {
 157                 bdev = sc->sc_dci.sc_bus.bdev;
 158                 device_detach(bdev);
 159                 device_delete_child(dev, bdev);
 160         }
 161         /* during module unload there are lots of children leftover */
 162         device_delete_children(dev);
 163
 164         if (sc->sc_dci.sc_irq_res && sc->sc_dci.sc_intr_hdl) {
 165                 /*
 166                  * only call octusb_octeon_uninit() after octusb_octeon_init()
 167                  */
 168                 octusb_uninit(&sc->sc_dci);
 169
 170                 err = bus_teardown_intr(dev, sc->sc_dci.sc_irq_res,
 171                     sc->sc_dci.sc_intr_hdl);
 172                 sc->sc_dci.sc_intr_hdl = NULL;
 173         }
 174         if (sc->sc_dci.sc_irq_res) {
 175                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 176                     sc->sc_dci.sc_irq_res);
 177                 sc->sc_dci.sc_irq_res = NULL;
 178         }
 179         usb_bus_mem_free_all(&sc->sc_dci.sc_bus, NULL);
 180
 181         return (0);
 182 }
 183
 184 static device_method_t octusb_octeon_methods[] = {
 185         /* Device interface */
 186         DEVMETHOD(device_identify, octusb_octeon_identify),
 187         DEVMETHOD(device_probe, octusb_octeon_probe),
 188         DEVMETHOD(device_attach, octusb_octeon_attach),
 189         DEVMETHOD(device_detach, octusb_octeon_detach),
 190         DEVMETHOD(device_resume, bus_generic_resume),
 191         DEVMETHOD(device_suspend, bus_generic_suspend),
 192         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 193
 194         DEVMETHOD_END
 195 };
 196
 197 static driver_t octusb_octeon_driver = {
 198         .name = "octusb",
 199         .methods = octusb_octeon_methods,
 200         .size = sizeof(struct octusb_octeon_softc),
 201 };
 202
 203 static devclass_t octusb_octeon_devclass;
 204
 205 DRIVER_MODULE(octusb, ciu, octusb_octeon_driver, octusb_octeon_devclass, 0, 0);