FreeBSD/Linux Kernel Cross Reference
sys/mips/atheros/ar71xx_gpio.c

     /*-
      * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
      * Copyright (c) 2009, Luiz Otavio O Souza. 
      * All rights reserved.
      *
      * Redistribution and use in source and binary forms, with or without
      * modification, are permitted provided that the following conditions
      * are met:
      * 1. Redistributions of source code must retain the above copyright
     *    notice unmodified, this list of conditions, and the following
     *    disclaimer.
     * 2. Redistributions in binary form must reproduce the above copyright
     *    notice, this list of conditions and the following disclaimer in the
     *    documentation and/or other materials provided with the distribution.
     *
     * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
     * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
     * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
     * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
     * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
     * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
     * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
     * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
     * SUCH DAMAGE.
     */
    
    /*
     * GPIO driver for AR71xx 
     */
    
    #include <sys/cdefs.h>
    __FBSDID("$FreeBSD: releng/8.4/sys/mips/atheros/ar71xx_gpio.c 215938 2010-11-27 12:26:40Z jchandra $");
    
    #include <sys/param.h>
    #include <sys/systm.h>
    #include <sys/bus.h>
    
    #include <sys/kernel.h>
    #include <sys/module.h>
    #include <sys/rman.h>
    #include <sys/lock.h>
    #include <sys/mutex.h>
    #include <sys/gpio.h>
    
    #include <machine/bus.h>
    #include <machine/resource.h>
    #include <mips/atheros/ar71xxreg.h>
    #include <mips/atheros/ar71xx_gpiovar.h>
    
    #include "gpio_if.h"
    
    #define DEFAULT_CAPS    (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT)
    
    struct ar71xx_gpio_pin {
            const char *name;
            int pin;
            int flags;
    };
    
    static struct ar71xx_gpio_pin ar71xx_gpio_pins[] = {
            { "RFled", 2, GPIO_PIN_OUTPUT},
            { "SW4", 8,  GPIO_PIN_INPUT},
            { NULL, 0, 0},
    };
    
    /*
     * Helpers
     */
    static void ar71xx_gpio_function_enable(struct ar71xx_gpio_softc *sc, 
        uint32_t mask);
    static void ar71xx_gpio_function_disable(struct ar71xx_gpio_softc *sc, 
        uint32_t mask);
    static void ar71xx_gpio_pin_configure(struct ar71xx_gpio_softc *sc, 
        struct gpio_pin *pin, uint32_t flags);
    
    /*
     * Driver stuff
     */
    static int ar71xx_gpio_probe(device_t dev);
    static int ar71xx_gpio_attach(device_t dev);
    static int ar71xx_gpio_detach(device_t dev);
    static int ar71xx_gpio_filter(void *arg);
    static void ar71xx_gpio_intr(void *arg);
    
    /*
     * GPIO interface
     */
    static int ar71xx_gpio_pin_max(device_t dev, int *maxpin);
    static int ar71xx_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps);
    static int ar71xx_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t
        *flags);
    static int ar71xx_gpio_pin_getname(device_t dev, uint32_t pin, char *name);
    static int ar71xx_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags);
    static int ar71xx_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value);
    static int ar71xx_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val);
    static int ar71xx_gpio_pin_toggle(device_t dev, uint32_t pin);
    
   static void
   ar71xx_gpio_function_enable(struct ar71xx_gpio_softc *sc, uint32_t mask)
   {
           GPIO_LOCK(sc);
           GPIO_SET_BITS(sc, AR71XX_GPIO_FUNCTION, mask);
           GPIO_UNLOCK(sc);
   }
   
   static void
   ar71xx_gpio_function_disable(struct ar71xx_gpio_softc *sc, uint32_t mask)
   {
           GPIO_LOCK(sc);
           GPIO_CLEAR_BITS(sc, AR71XX_GPIO_FUNCTION, mask);
           GPIO_UNLOCK(sc);
   }
   
   static void
   ar71xx_gpio_pin_configure(struct ar71xx_gpio_softc *sc, struct gpio_pin *pin,
       unsigned int flags)
   {
           uint32_t mask;
   
           mask = 1 << pin->gp_pin;
           GPIO_LOCK(sc);
   
           /*
            * Manage input/output
            */
           if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
                   pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
                   if (flags & GPIO_PIN_OUTPUT) {
                           pin->gp_flags |= GPIO_PIN_OUTPUT;
                           GPIO_SET_BITS(sc, AR71XX_GPIO_OE, mask);
                   }
                   else {
                           pin->gp_flags |= GPIO_PIN_INPUT;
                           GPIO_CLEAR_BITS(sc, AR71XX_GPIO_OE, mask);
                   }
           }
   
           GPIO_UNLOCK(sc);
   }
   
   static int
   ar71xx_gpio_pin_max(device_t dev, int *maxpin)
   {
   
           *maxpin = AR71XX_GPIO_PINS - 1;
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int i;
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           *caps = sc->gpio_pins[i].gp_caps;
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int i;
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           *flags = sc->gpio_pins[i].gp_flags;
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int i;
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           memcpy(name, sc->gpio_pins[i].gp_name, GPIOMAXNAME);
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
   {
           int i;
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           /* Filter out unwanted flags */
           if ((flags &= sc->gpio_pins[i].gp_caps) != flags)
                   return (EINVAL);
   
           /* Can't mix input/output together */
           if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
               (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
                   return (EINVAL);
   
           ar71xx_gpio_pin_configure(sc, &sc->gpio_pins[i], flags);
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int i;
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           if (value)
                   GPIO_WRITE(sc, AR71XX_GPIO_SET, (1 << pin));
           else
                   GPIO_WRITE(sc, AR71XX_GPIO_CLEAR, (1 << pin));
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int i;
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           *val = (GPIO_READ(sc, AR71XX_GPIO_IN) & (1 << pin)) ? 1 : 0;
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_pin_toggle(device_t dev, uint32_t pin)
   {
           int res, i;
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
   
           for (i = 0; i < sc->gpio_npins; i++) {
                   if (sc->gpio_pins[i].gp_pin == pin)
                           break;
           }
   
           if (i >= sc->gpio_npins)
                   return (EINVAL);
   
           GPIO_LOCK(sc);
           res = (GPIO_READ(sc, AR71XX_GPIO_IN) & (1 << pin)) ? 1 : 0;
           if (res)
                   GPIO_WRITE(sc, AR71XX_GPIO_CLEAR, (1 << pin));
           else
                   GPIO_WRITE(sc, AR71XX_GPIO_SET, (1 << pin));
           GPIO_UNLOCK(sc);
   
           return (0);
   }
   
   static int
   ar71xx_gpio_filter(void *arg)
   {
   
           /* TODO: something useful */
           return (FILTER_STRAY);
   }
   
   
   
   static void
   ar71xx_gpio_intr(void *arg)
   {
           struct ar71xx_gpio_softc *sc = arg;
           GPIO_LOCK(sc);
           /* TODO: something useful */
           GPIO_UNLOCK(sc);
   }
   
   static int
   ar71xx_gpio_probe(device_t dev)
   {
   
           device_set_desc(dev, "Atheros AR71XX GPIO driver");
           return (0);
   }
   
   static int
   ar71xx_gpio_attach(device_t dev)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
           int error = 0;
           struct ar71xx_gpio_pin *pinp;
           int i;
   
           KASSERT((device_get_unit(dev) == 0),
               ("ar71xx_gpio: Only one gpio module supported"));
   
           mtx_init(&sc->gpio_mtx, device_get_nameunit(dev), MTX_NETWORK_LOCK,
               MTX_DEF);
   
           /* Map control/status registers. */
           sc->gpio_mem_rid = 0;
           sc->gpio_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY,
               &sc->gpio_mem_rid, RF_ACTIVE);
   
           if (sc->gpio_mem_res == NULL) {
                   device_printf(dev, "couldn't map memory\n");
                   error = ENXIO;
                   ar71xx_gpio_detach(dev);
                   return(error);
           }
   
           if ((sc->gpio_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, 
               &sc->gpio_irq_rid, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
                   device_printf(dev, "unable to allocate IRQ resource\n");
                   return (ENXIO);
           }
   
           if ((bus_setup_intr(dev, sc->gpio_irq_res, INTR_TYPE_MISC, 
               ar71xx_gpio_filter, ar71xx_gpio_intr, sc, &sc->gpio_ih))) {
                   device_printf(dev,
                       "WARNING: unable to register interrupt handler\n");
                   return (ENXIO);
           }
   
           sc->dev = dev;
           ar71xx_gpio_function_enable(sc, GPIO_FUNC_SPI_CS1_EN);
           ar71xx_gpio_function_enable(sc, GPIO_FUNC_SPI_CS2_EN);
           /* Configure all pins as input */
           /* disable interrupts for all pins */
           GPIO_WRITE(sc, AR71XX_GPIO_INT_MASK, 0);
           pinp = ar71xx_gpio_pins;
           i = 0;
           while (pinp->name) {
                   strncpy(sc->gpio_pins[i].gp_name, pinp->name, GPIOMAXNAME);
                   sc->gpio_pins[i].gp_pin = pinp->pin;
                   sc->gpio_pins[i].gp_caps = DEFAULT_CAPS;
                   sc->gpio_pins[i].gp_flags = 0;
                   ar71xx_gpio_pin_configure(sc, &sc->gpio_pins[i], pinp->flags);
                   pinp++;
                   i++;
           }
   
           sc->gpio_npins = i;
   
           device_add_child(dev, "gpioc", device_get_unit(dev));
           device_add_child(dev, "gpiobus", device_get_unit(dev));
           return (bus_generic_attach(dev));
   }
   
   static int
   ar71xx_gpio_detach(device_t dev)
   {
           struct ar71xx_gpio_softc *sc = device_get_softc(dev);
   
           KASSERT(mtx_initialized(&sc->gpio_mtx), ("gpio mutex not initialized"));
   
           ar71xx_gpio_function_disable(sc, GPIO_FUNC_SPI_CS1_EN);
           ar71xx_gpio_function_disable(sc, GPIO_FUNC_SPI_CS2_EN);
           bus_generic_detach(dev);
   
           if (sc->gpio_mem_res)
                   bus_release_resource(dev, SYS_RES_MEMORY, sc->gpio_mem_rid,
                       sc->gpio_mem_res);
   
           mtx_destroy(&sc->gpio_mtx);
   
           return(0);
   }
   
   static device_method_t ar71xx_gpio_methods[] = {
           DEVMETHOD(device_probe, ar71xx_gpio_probe),
           DEVMETHOD(device_attach, ar71xx_gpio_attach),
           DEVMETHOD(device_detach, ar71xx_gpio_detach),
   
           /* GPIO protocol */
           DEVMETHOD(gpio_pin_max, ar71xx_gpio_pin_max),
           DEVMETHOD(gpio_pin_getname, ar71xx_gpio_pin_getname),
           DEVMETHOD(gpio_pin_getflags, ar71xx_gpio_pin_getflags),
           DEVMETHOD(gpio_pin_getcaps, ar71xx_gpio_pin_getcaps),
           DEVMETHOD(gpio_pin_setflags, ar71xx_gpio_pin_setflags),
           DEVMETHOD(gpio_pin_get, ar71xx_gpio_pin_get),
           DEVMETHOD(gpio_pin_set, ar71xx_gpio_pin_set),
           DEVMETHOD(gpio_pin_toggle, ar71xx_gpio_pin_toggle),
           {0, 0},
   };
   
   static driver_t ar71xx_gpio_driver = {
           "gpio",
           ar71xx_gpio_methods,
           sizeof(struct ar71xx_gpio_softc),
   };
   static devclass_t ar71xx_gpio_devclass;
   
   DRIVER_MODULE(ar71xx_gpio, apb, ar71xx_gpio_driver, ar71xx_gpio_devclass, 0, 0);

Cache object: 67fc43d744fff393ccb2ec8f224b588e