sys/dev/usb/controller/atmegadci_atmelarm.c

   1 #include <sys/cdefs.h>
   2 __FBSDID("$FreeBSD$");
   3
   4 /*-
   5  * Copyright (c) 2009 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
  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 #include <dev/usb/controller/atmegadci.h>
  60
  61 #include <sys/rman.h>
  62
  63 static device_probe_t atmegadci_probe;
  64 static device_attach_t atmegadci_attach;
  65 static device_detach_t atmegadci_detach;
  66 static device_shutdown_t atmegadci_shutdown;
  67
  68 struct atmegadci_super_softc {
  69         struct atmegadci_softc sc_otg;  /* must be first */
  70 };
  71
  72 static void
  73 atmegadci_clocks_on(struct usb_bus *bus)
  74 {
  75         /* TODO */
  76 }
  77
  78 static void
  79 atmegadci_clocks_off(struct usb_bus *bus)
  80 {
  81         /* TODO */
  82 }
  83
  84 static int
  85 atmegadci_probe(device_t dev)
  86 {
  87         device_set_desc(dev, "ATMEL OTG integrated USB controller");
  88         return (0);
  89 }
  90
  91 static int
  92 atmegadci_attach(device_t dev)
  93 {
  94         struct atmegadci_super_softc *sc = device_get_softc(dev);
  95         int err;
  96         int rid;
  97
  98         /* setup MUSB OTG USB controller interface softc */
  99         sc->sc_otg.sc_clocks_on = &atmegadci_clocks_on;
 100         sc->sc_otg.sc_clocks_off = &atmegadci_clocks_off;
 101
 102         /* initialise some bus fields */
 103         sc->sc_otg.sc_bus.parent = dev;
 104         sc->sc_otg.sc_bus.devices = sc->sc_otg.sc_devices;
 105         sc->sc_otg.sc_bus.devices_max = ATMEGA_MAX_DEVICES;
 106
 107         /* get all DMA memory */
 108         if (usb_bus_mem_alloc_all(&sc->sc_otg.sc_bus,
 109             USB_GET_DMA_TAG(dev), NULL)) {
 110                 return (ENOMEM);
 111         }
 112         rid = 0;
 113         sc->sc_otg.sc_io_res =
 114             bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid, RF_ACTIVE);
 115
 116         if (!(sc->sc_otg.sc_io_res)) {
 117                 err = ENOMEM;
 118                 goto error;
 119         }
 120         sc->sc_otg.sc_io_tag = rman_get_bustag(sc->sc_otg.sc_io_res);
 121         sc->sc_otg.sc_io_hdl = rman_get_bushandle(sc->sc_otg.sc_io_res);
 122
 123         rid = 0;
 124         sc->sc_otg.sc_irq_res =
 125             bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid, RF_ACTIVE);
 126         if (!(sc->sc_otg.sc_irq_res)) {
 127                 goto error;
 128         }
 129         sc->sc_otg.sc_bus.bdev = device_add_child(dev, "usbus", -1);
 130         if (!(sc->sc_otg.sc_bus.bdev)) {
 131                 goto error;
 132         }
 133         device_set_ivars(sc->sc_otg.sc_bus.bdev, &sc->sc_otg.sc_bus);
 134
 135         err = bus_setup_intr(dev, sc->sc_otg.sc_irq_res, INTR_TYPE_BIO | INTR_MPSAFE,
 136             NULL, (driver_intr_t *)atmegadci_interrupt, sc, &sc->sc_otg.sc_intr_hdl);
 137         if (err) {
 138                 sc->sc_otg.sc_intr_hdl = NULL;
 139                 goto error;
 140         }
 141         err = atmegadci_init(&sc->sc_otg);
 142         if (!err) {
 143                 err = device_probe_and_attach(sc->sc_otg.sc_bus.bdev);
 144         }
 145         if (err) {
 146                 goto error;
 147         }
 148         return (0);
 149
 150 error:
 151         atmegadci_detach(dev);
 152         return (ENXIO);
 153 }
 154
 155 static int
 156 atmegadci_detach(device_t dev)
 157 {
 158         struct atmegadci_super_softc *sc = device_get_softc(dev);
 159         device_t bdev;
 160         int err;
 161
 162         if (sc->sc_otg.sc_bus.bdev) {
 163                 bdev = sc->sc_otg.sc_bus.bdev;
 164                 device_detach(bdev);
 165                 device_delete_child(dev, bdev);
 166         }
 167         /* during module unload there are lots of children leftover */
 168         device_delete_all_children(dev);
 169
 170         if (sc->sc_otg.sc_irq_res && sc->sc_otg.sc_intr_hdl) {
 171                 /*
 172                  * only call atmegadci_uninit() after atmegadci_init()
 173                  */
 174                 atmegadci_uninit(&sc->sc_otg);
 175
 176                 err = bus_teardown_intr(dev, sc->sc_otg.sc_irq_res,
 177                     sc->sc_otg.sc_intr_hdl);
 178                 sc->sc_otg.sc_intr_hdl = NULL;
 179         }
 180         /* free IRQ channel, if any */
 181         if (sc->sc_otg.sc_irq_res) {
 182                 bus_release_resource(dev, SYS_RES_IRQ, 0,
 183                     sc->sc_otg.sc_irq_res);
 184                 sc->sc_otg.sc_irq_res = NULL;
 185         }
 186         /* free memory resource, if any */
 187         if (sc->sc_otg.sc_io_res) {
 188                 bus_release_resource(dev, SYS_RES_MEMORY, 0,
 189                     sc->sc_otg.sc_io_res);
 190                 sc->sc_otg.sc_io_res = NULL;
 191         }
 192         usb_bus_mem_free_all(&sc->sc_otg.sc_bus, NULL);
 193
 194         return (0);
 195 }
 196
 197 static int
 198 atmegadci_shutdown(device_t dev)
 199 {
 200         struct atmegadci_super_softc *sc = device_get_softc(dev);
 201         int err;
 202
 203         err = bus_generic_shutdown(dev);
 204         if (err)
 205                 return (err);
 206
 207         atmegadci_uninit(&sc->sc_otg);
 208
 209         return (0);
 210 }
 211
 212 static device_method_t atmegadci_methods[] = {
 213         /* Device interface */
 214         DEVMETHOD(device_probe, atmegadci_probe),
 215         DEVMETHOD(device_attach, atmegadci_attach),
 216         DEVMETHOD(device_detach, atmegadci_detach),
 217         DEVMETHOD(device_shutdown, atmegadci_shutdown),
 218
 219         /* Bus interface */
 220         DEVMETHOD(bus_print_child, bus_generic_print_child),
 221
 222         {0, 0}
 223 };
 224
 225 static driver_t atmegadci_driver = {
 226         "atmegadci",
 227         atmegadci_methods,
 228         sizeof(struct atmegadci_super_softc),
 229 };
 230
 231 static devclass_t atmegadci_devclass;
 232
 233 DRIVER_MODULE(atmegadci, atmelarm, atmegadci_driver, atmegadci_devclass, 0, 0);
 234 MODULE_DEPEND(atmegadci, usb, 1, 1, 1);