2 * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
33 #include "opt_platform.h"
36 #include <sys/mutex.h>
40 #include <dev/ofw/ofw_bus_subr.h>
41 #include <gnu/dts/include/dt-bindings/gpio/gpio.h>
47 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) \
48 &((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo
50 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
52 #define GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d)
53 #define GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
54 #define GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
55 #define GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx, \
56 device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF)
57 #define GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx)
58 #define GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
59 #define GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED)
61 #define GPIOBUS_WAIT 1
62 #define GPIOBUS_DONTWAIT 2
64 struct gpiobus_pin_data
66 int mapped; /* pin is mapped/reserved. */
67 char *name; /* pin name. */
72 struct mtx sc_mtx; /* bus mutex */
73 struct rman sc_intr_rman; /* isr resources */
74 device_t sc_busdev; /* bus device */
75 device_t sc_owner; /* bus owner */
76 device_t sc_dev; /* driver device */
77 int sc_npins; /* total pins on bus */
78 struct gpiobus_pin_data *sc_pins; /* pin data */
83 device_t dev; /* gpio device */
84 uint32_t flags; /* pin flags */
85 uint32_t pin; /* pin number */
87 typedef struct gpiobus_pin *gpio_pin_t;
91 struct resource_list rl; /* isr resource list */
92 uint32_t npins; /* pins total */
93 uint32_t *flags; /* pins flags */
94 uint32_t *pins; /* pins map */
98 struct ofw_gpiobus_devinfo {
99 struct gpiobus_ivar opd_dinfo;
100 struct ofw_bus_devinfo opd_obdinfo;
104 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
105 pcell_t *gpios, uint32_t *pin, uint32_t *flags)
107 return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
110 device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t);
111 int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **);
112 void ofw_gpiobus_register_provider(device_t);
113 void ofw_gpiobus_unregister_provider(device_t);
115 /* Consumers interface. */
116 int gpio_pin_get_by_ofw_name(device_t consumer, char *name, gpio_pin_t *gpio);
117 int gpio_pin_get_by_ofw_idx(device_t consumer, int idx, gpio_pin_t *gpio);
118 int gpio_pin_get_by_ofw_property(device_t consumer, char *name,
120 void gpio_pin_release(gpio_pin_t gpio);
121 int gpio_pin_is_active(gpio_pin_t pin, bool *active);
122 int gpio_pin_set_active(gpio_pin_t pin, bool active);
123 int gpio_pin_setflags(gpio_pin_t pin, uint32_t flags);
125 int gpio_check_flags(uint32_t, uint32_t);
126 device_t gpiobus_attach_bus(device_t);
127 int gpiobus_detach_bus(device_t);
128 int gpiobus_init_softc(device_t);
129 int gpiobus_alloc_ivars(struct gpiobus_ivar *);
130 void gpiobus_free_ivars(struct gpiobus_ivar *);
131 int gpiobus_map_pin(device_t, uint32_t);
133 extern driver_t gpiobus_driver;
135 #endif /* __GPIOBUS_H__ */