sys/dev/gpio/gpioled.c

   1 /*-
   2  * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  */
  26
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_platform.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/bus.h>
  35 #include <sys/gpio.h>
  36 #include <sys/kernel.h>
  37 #include <sys/lock.h>
  38 #include <sys/malloc.h>
  39 #include <sys/module.h>
  40 #include <sys/mutex.h>
  41
  42 #ifdef FDT
  43 #include <dev/fdt/fdt_common.h>
  44 #include <dev/ofw/ofw_bus.h>
  45 #endif
  46
  47 #include <dev/gpio/gpiobusvar.h>
  48 #include <dev/led/led.h>
  49
  50 #include "gpiobus_if.h"
  51
  52 /*
  53  * Only one pin for led
  54  */
  55 #define GPIOLED_PIN     0
  56
  57 #define GPIOLED_LOCK(_sc)               mtx_lock(&(_sc)->sc_mtx)
  58 #define GPIOLED_UNLOCK(_sc)             mtx_unlock(&(_sc)->sc_mtx)
  59 #define GPIOLED_LOCK_INIT(_sc) \
  60         mtx_init(&_sc->sc_mtx, device_get_nameunit(_sc->sc_dev), \
  61             "gpioled", MTX_DEF)
  62 #define GPIOLED_LOCK_DESTROY(_sc)       mtx_destroy(&_sc->sc_mtx);
  63
  64 struct gpioled_softc
  65 {
  66         device_t        sc_dev;
  67         device_t        sc_busdev;
  68         struct mtx      sc_mtx;
  69         struct cdev     *sc_leddev;
  70 };
  71
  72 static void gpioled_control(void *, int);
  73 static int gpioled_probe(device_t);
  74 static int gpioled_attach(device_t);
  75 static int gpioled_detach(device_t);
  76
  77 static void
  78 gpioled_control(void *priv, int onoff)
  79 {
  80         int error;
  81         struct gpioled_softc *sc;
  82
  83         sc = (struct gpioled_softc *)priv;
  84         GPIOLED_LOCK(sc);
  85         error = GPIOBUS_ACQUIRE_BUS(sc->sc_busdev, sc->sc_dev,
  86             GPIOBUS_DONTWAIT);
  87         if (error != 0) {
  88                 GPIOLED_UNLOCK(sc);
  89                 return;
  90         }
  91         error = GPIOBUS_PIN_SETFLAGS(sc->sc_busdev, sc->sc_dev,
  92             GPIOLED_PIN, GPIO_PIN_OUTPUT);
  93         if (error == 0)
  94                 GPIOBUS_PIN_SET(sc->sc_busdev, sc->sc_dev, GPIOLED_PIN,
  95                     onoff ? GPIO_PIN_HIGH : GPIO_PIN_LOW);
  96         GPIOBUS_RELEASE_BUS(sc->sc_busdev, sc->sc_dev);
  97         GPIOLED_UNLOCK(sc);
  98 }
  99
 100 #ifdef FDT
 101 static void
 102 gpioled_identify(driver_t *driver, device_t bus)
 103 {
 104         phandle_t child, leds, root;
 105
 106         root = OF_finddevice("/");
 107         if (root == 0)
 108                 return;
 109         for (leds = OF_child(root); leds != 0; leds = OF_peer(leds)) {
 110                 if (!fdt_is_compatible_strict(leds, "gpio-leds"))
 111                         continue;
 112                 /* Traverse the 'gpio-leds' node and add its children. */
 113                 for (child = OF_child(leds); child != 0; child = OF_peer(child)) {
 114                         if (!OF_hasprop(child, "gpios"))
 115                                 continue;
 116                         if (ofw_gpiobus_add_fdt_child(bus, driver->name, child) == NULL)
 117                                 continue;
 118                 }
 119         }
 120 }
 121 #endif
 122
 123 static int
 124 gpioled_probe(device_t dev)
 125 {
 126 #ifdef FDT
 127         int match;
 128         phandle_t node;
 129         char *compat;
 130
 131         /*
 132          * We can match against our own node compatible string and also against
 133          * our parent node compatible string.  The first is normally used to
 134          * describe leds on a gpiobus and the later when there is a common node
 135          * compatible with 'gpio-leds' which is used to concentrate all the
 136          * leds nodes on the dts.
 137          */
 138         match = 0;
 139         if (ofw_bus_is_compatible(dev, "gpioled"))
 140                 match = 1;
 141
 142         if (match == 0) {
 143                 if ((node = ofw_bus_get_node(dev)) == -1)
 144                         return (ENXIO);
 145                 if ((node = OF_parent(node)) == -1)
 146                         return (ENXIO);
 147                 if (OF_getprop_alloc(node, "compatible", 1,
 148                     (void **)&compat) == -1)
 149                         return (ENXIO);
 150
 151                 if (strcasecmp(compat, "gpio-leds") == 0)
 152                         match = 1;
 153
 154                 free(compat, M_OFWPROP);
 155         }
 156
 157         if (match == 0)
 158                 return (ENXIO);
 159 #endif
 160         device_set_desc(dev, "GPIO led");
 161
 162         return (0);
 163 }
 164
 165 static int
 166 gpioled_attach(device_t dev)
 167 {
 168         struct gpioled_softc *sc;
 169         int state;
 170 #ifdef FDT
 171         phandle_t node;
 172         char *default_state;
 173         char *name;
 174 #else
 175         const char *name;
 176 #endif
 177
 178         sc = device_get_softc(dev);
 179         sc->sc_dev = dev;
 180         sc->sc_busdev = device_get_parent(dev);
 181         GPIOLED_LOCK_INIT(sc);
 182
 183         state = 0;
 184
 185 #ifdef FDT
 186         if ((node = ofw_bus_get_node(dev)) == -1)
 187                 return (ENXIO);
 188
 189         if (OF_getprop_alloc(node, "default-state",
 190             sizeof(char), (void **)&default_state) != -1) {
 191                 if (strcasecmp(default_state, "on") == 0)
 192                         state = 1;
 193                 else if (strcasecmp(default_state, "off") == 0)
 194                         state = 0;
 195                 else if (strcasecmp(default_state, "keep") == 0)
 196                         state = -1;
 197                 else {
 198                         device_printf(dev,
 199                             "unknown value for default-state in FDT\n");
 200                 }
 201                 free(default_state, M_OFWPROP);
 202         }
 203
 204         name = NULL;
 205         if (OF_getprop_alloc(node, "label", 1, (void **)&name) == -1)
 206                 OF_getprop_alloc(node, "name", 1, (void **)&name);
 207 #else
 208         if (resource_string_value(device_get_name(dev),
 209             device_get_unit(dev), "name", &name))
 210                 name = NULL;
 211 #endif
 212
 213         sc->sc_leddev = led_create_state(gpioled_control, sc, name ? name :
 214             device_get_nameunit(dev), state);
 215 #ifdef FDT
 216         if (name != NULL)
 217                 free(name, M_OFWPROP);
 218 #endif
 219
 220         return (0);
 221 }
 222
 223 static int
 224 gpioled_detach(device_t dev)
 225 {
 226         struct gpioled_softc *sc;
 227
 228         sc = device_get_softc(dev);
 229         if (sc->sc_leddev) {
 230                 led_destroy(sc->sc_leddev);
 231                 sc->sc_leddev = NULL;
 232         }
 233         GPIOLED_LOCK_DESTROY(sc);
 234         return (0);
 235 }
 236
 237 static devclass_t gpioled_devclass;
 238
 239 static device_method_t gpioled_methods[] = {
 240         /* Device interface */
 241 #ifdef FDT
 242         DEVMETHOD(device_identify,      gpioled_identify),
 243 #endif
 244         DEVMETHOD(device_probe,         gpioled_probe),
 245         DEVMETHOD(device_attach,        gpioled_attach),
 246         DEVMETHOD(device_detach,        gpioled_detach),
 247
 248         { 0, 0 }
 249 };
 250
 251 static driver_t gpioled_driver = {
 252         "gpioled",
 253         gpioled_methods,
 254         sizeof(struct gpioled_softc),
 255 };
 256
 257 DRIVER_MODULE(gpioled, gpiobus, gpioled_driver, gpioled_devclass, 0, 0);