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