sys/dev/gpio/gpiobusvar.h

   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  * $FreeBSD$
  27  *
  28  */
  29
  30 #ifndef __GPIOBUS_H__
  31 #define __GPIOBUS_H__
  32
  33 #include "opt_platform.h"
  34
  35 #include <sys/lock.h>
  36 #include <sys/mutex.h>
  37
  38 #ifdef FDT
  39 #include <dev/ofw/ofw_bus_subr.h>
  40 #endif
  41
  42 #include "gpio_if.h"
  43
  44 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
  45 #define GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d)
  46 #define GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
  47 #define GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
  48 #define GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx,                   \
  49             device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF)
  50 #define GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx)
  51 #define GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
  52 #define GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED)
  53
  54 struct gpiobus_softc
  55 {
  56         struct mtx      sc_mtx;         /* bus mutex */
  57         device_t        sc_busdev;      /* bus device */
  58         device_t        sc_owner;       /* bus owner */
  59         device_t        sc_dev;         /* driver device */
  60         int             sc_npins;       /* total pins on bus */
  61         int             *sc_pins_mapped; /* mark mapped pins */
  62 };
  63
  64 struct gpiobus_ivar
  65 {
  66         uint32_t        npins;  /* pins total */
  67         uint32_t        *flags; /* pins flags */
  68         uint32_t        *pins;  /* pins map */
  69 };
  70
  71 #ifdef FDT
  72 struct ofw_gpiobus_devinfo {
  73         struct gpiobus_ivar     opd_dinfo;
  74         struct ofw_bus_devinfo  opd_obdinfo;
  75 };
  76
  77 static __inline int
  78 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
  79     pcell_t *gpios, uint32_t *pin, uint32_t *flags)
  80 {
  81         return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
  82 }
  83
  84 device_t ofw_gpiobus_add_fdt_child(device_t, phandle_t);
  85 #endif
  86 void gpiobus_print_pins(struct gpiobus_ivar *);
  87
  88 extern driver_t gpiobus_driver;
  89
  90 #endif  /* __GPIOBUS_H__ */