sys/dev/usb/controller/musb_otg_atmelarm.c

   1 /*-
   2  * Copyright (c) 2008 Hans Petter Selasky. All rights reserved.
   3  *
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23  * SUCH DAMAGE.
  24  */
  25
  26 #include <sys/cdefs.h>
  27 __FBSDID("$FreeBSD$");
  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
  48 #include <dev/usb/usb.h>
  49 #include <dev/usb/usbdi.h>
  50
  51 #include <dev/usb/usb_core.h>
  52 #include <dev/usb/usb_busdma.h>
  53 #include <dev/usb/usb_process.h>
  54 #include <dev/usb/usb_util.h>
  55
  56 #include <dev/usb/usb_controller.h>
  57 #include <dev/usb/usb_bus.h>
  58 #include <dev/usb/controller/musb_otg.h>
  59
  60 #include <sys/rman.h>
  61
  62 static device_probe_t musbotg_probe;
  63 static device_attach_t musbotg_attach;
  64 static device_detach_t musbotg_detach;
  65
  66 struct musbotg_super_softc {
  67         struct musbotg_softc sc_otg;    /* must be first */
  68 };
  69
  70 static void
  71 musbotg_vbus_poll(struct musbotg_super_softc *sc)
  72 {
  73         uint8_t vbus_val = 1;           /* fake VBUS on - TODO */
  74
  75         /* just forward it */
  76         musbotg_vbus_interrupt(&sc->sc_otg, vbus_val);
  77 }
  78
  79 static void
  80 musbotg_clocks_on(void *arg)
  81 {
  82 #if 0
  83         struct musbotg_super_softc *sc = arg;
  84
  85 #endif
  86 }
  87
  88 static void
  89 musbotg_clocks_off(void *arg)
  90 {
  91 #if 0
  92         struct musbotg_super_softc *sc = arg;
  93
  94 #endif
  95 }
  96
  97 static void
  98 musbotg_wrapper_interrupt(void *arg)
  99 {
 100
 101         /*
 102          * Nothing to do.
 103          * Main driver takes care about everything
 104          */
 105         musbotg_interrupt(arg, 0, 0, 0);
 106 }
 107
 108 static void
 109 musbotg_ep_int_set(struct musbotg_softc *sc, int ep, int on)
 110 {
 111         /*
 112          * Nothing to do.
 113          * Main driver takes care about everything
 114          */
 115 }
 116
 117 static int
 118 musbotg_probe(device_t dev)
 119 {
 120         device_set_desc(dev, "MUSB OTG integrated USB controller");
 121         return (0);
 122 }
 123
 124 static int
 125 musbotg_attach(device_t dev)
 126 {
 127         struct musbotg_super_softc *sc = device_get_softc(dev);
 128         int err;
 129         int rid;
 130
 131         /* setup MUSB OTG USB controller interface softc */
 132         sc->sc_otg.sc_clocks_on = &musbotg_clocks_on;
 133         sc->sc_otg.sc_clocks_off = &musbotg_clocks_off;
 134         sc->sc_otg.sc_clocks_arg = sc;
 135
 136         /* initialise some bus fields */
 137         sc->sc_otg.sc_bus.parent = dev;
 138         sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
 139         sc->sc_otg.sc_bus.devices_max = MUSB2_MAX_DEVICES;
 140
 141         /* get all DMA memory */
 142         if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
 143             USB_GET_DMA_TAG(dev), NULL)) {
 144                 return (ENOMEM);
 145         }
 146         rid = 0;
 147         sc->sc_otg.sc_io_res =
 148             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 149
 150         if (!(sc->sc_otg.sc_io_res)) {
 151                 err = ENOMEM;
 152                 goto error;
 153         }
 154         sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
 155         sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
 156         sc->sc_otg.sc_io_size = rman_get_size(sc->sc_otg.sc_io_res);
 157
 158         rid = 0;
 159         sc->sc_otg.sc_irq_res =
 160             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 161         if (!(sc->sc_otg.sc_irq_res)) {
 162                 goto error;
 163         }
 164         sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 165         if (!(sc->sc_otg.sc_bus.bdev)) {
 166                 goto error;
 167         }
 168         device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
 169
 170         sc->sc_otg.sc_id = 0;
 171         sc->sc_otg.sc_platform_data = sc;
 172         sc->sc_otg.sc_mode = MUSB2_DEVICE_MODE;
 173
 174 #if (__FreeBSD_version >= 700031)
 175         err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 176             NULL, (driver_intr_t *)musbotg_wrapper_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
 177 #else
 178         err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 179             (driver_intr_t *)musbotg_wrapper_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
 180 #endif
 181         if (err) {
 182                 sc->sc_otg.sc_intr_hdl = NULL;
 183                 goto error;
 184         }
 185         err = musbotg_init(&sc->sc_otg);
 186         if (!err) {
 187                 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
 188         }
 189         if (err) {
 190                 goto error;
 191         } else {
 192                 /* poll VBUS one time */
 193                 musbotg_vbus_poll(sc);
 194         }
 195         return (0);
 196
 197 error:
 198         musbotg_detach(dev);
 199         return (ENXIO);
 200 }
 201
 202 static int
 203 musbotg_detach(device_t dev)
 204 {
 205         struct musbotg_super_softc *sc = device_get_softc(dev);
 206         device_t bdev;
 207         int err;
 208
 209         if (sc->sc_otg.sc_bus.bdev) {
 210                 bdev = sc->sc_otg.sc_bus.bdev;
 211                 device_detach(bdev);
 212                 device_delete_child(dev, bdev);
 213         }
 214         /* during module unload there are lots of children leftover */
 215         device_delete_children(dev);
 216
 217         if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
 218                 /*
 219                  * only call musbotg_uninit() after musbotg_init()
 220                  */
 221                 musbotg_uninit(&sc->sc_otg);
 222
 223                 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
 224                     sc->sc_otg.sc_intr_hdl);
 225                 sc->sc_otg.sc_intr_hdl = NULL;
 226         }
 227         /* free IRQ channel, if any */
 228         if (sc->sc_otg.sc_irq_res) {
 229                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 230                     sc->sc_otg.sc_irq_res);
 231                 sc->sc_otg.sc_irq_res = NULL;
 232         }
 233         /* free memory resource, if any */
 234         if (sc->sc_otg.sc_io_res) {
 235                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 236                     sc->sc_otg.sc_io_res);
 237                 sc->sc_otg.sc_io_res = NULL;
 238         }
 239         usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
 240
 241         return (0);
 242 }
 243
 244 static device_method_t musbotg_methods[] = {
 245         /* Device interface */
 246         DEVMETHOD(device_probe, musbotg_probe),
 247         DEVMETHOD(device_attach, musbotg_attach),
 248         DEVMETHOD(device_detach, musbotg_detach),
 249         DEVMETHOD(device_suspend, bus_generic_suspend),
 250         DEVMETHOD(device_resume, bus_generic_resume),
 251         DEVMETHOD(device_shutdown, bus_generic_shutdown),
 252
 253         DEVMETHOD_END
 254 };
 255
 256 static driver_t musbotg_driver = {
 257         .name = "musbotg",
 258         .methods = musbotg_methods,
 259         .size = sizeof(struct musbotg_super_softc),
 260 };
 261
 262 static devclass_t musbotg_devclass;
 263
 264 DRIVER_MODULE(musbotg, atmelarm, musbotg_driver, musbotg_devclass, 0, 0);
 265 MODULE_DEPEND(musbotg, usb, 1, 1, 1);