2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
35 #include "opt_platform.h"
38 #include <sys/mutex.h>
42 #include <dev/ofw/ofw_bus_subr.h>
52 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) \
53 &((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo
55 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
57 #define GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d)
58 #define GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
59 #define GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
60 #define GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx, \
61 device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF)
62 #define GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx)
63 #define GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
64 #define GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED)
66 #define GPIOBUS_WAIT 1
67 #define GPIOBUS_DONTWAIT 2
69 /* Use default interrupt mode - for gpio_alloc_intr_resource */
70 #define GPIO_INTR_CONFORM GPIO_INTR_NONE
72 struct gpiobus_pin_data
74 int mapped; /* pin is mapped/reserved. */
75 char *name; /* pin name. */
79 struct intr_map_data_gpio {
80 struct intr_map_data hdr;
89 struct mtx sc_mtx; /* bus mutex */
90 struct rman sc_intr_rman; /* isr resources */
91 device_t sc_busdev; /* bus device */
92 device_t sc_owner; /* bus owner */
93 device_t sc_dev; /* driver device */
94 int sc_npins; /* total pins on bus */
95 struct gpiobus_pin_data *sc_pins; /* pin data */
100 device_t dev; /* gpio device */
101 uint32_t flags; /* pin flags */
102 uint32_t pin; /* pin number */
104 typedef struct gpiobus_pin *gpio_pin_t;
108 struct resource_list rl; /* isr resource list */
109 uint32_t npins; /* pins total */
110 uint32_t *flags; /* pins flags */
111 uint32_t *pins; /* pins map */
115 struct ofw_gpiobus_devinfo {
116 struct gpiobus_ivar opd_dinfo;
117 struct ofw_bus_devinfo opd_obdinfo;
121 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
122 pcell_t *gpios, uint32_t *pin, uint32_t *flags)
124 return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
127 device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t);
128 int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **);
129 void ofw_gpiobus_register_provider(device_t);
130 void ofw_gpiobus_unregister_provider(device_t);
132 /* Consumers interface. */
133 int gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node,
134 char *name, gpio_pin_t *gpio);
135 int gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node,
136 int idx, gpio_pin_t *gpio);
137 int gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node,
138 char *name, gpio_pin_t *gpio);
139 void gpio_pin_release(gpio_pin_t gpio);
140 int gpio_pin_getcaps(gpio_pin_t pin, uint32_t *caps);
141 int gpio_pin_is_active(gpio_pin_t pin, bool *active);
142 int gpio_pin_set_active(gpio_pin_t pin, bool active);
143 int gpio_pin_setflags(gpio_pin_t pin, uint32_t flags);
145 struct resource *gpio_alloc_intr_resource(device_t consumer_dev, int *rid,
146 u_int alloc_flags, gpio_pin_t pin, uint32_t intr_mode);
147 int gpio_check_flags(uint32_t, uint32_t);
148 device_t gpiobus_attach_bus(device_t);
149 int gpiobus_detach_bus(device_t);
150 int gpiobus_init_softc(device_t);
151 int gpiobus_alloc_ivars(struct gpiobus_ivar *);
152 void gpiobus_free_ivars(struct gpiobus_ivar *);
153 int gpiobus_acquire_pin(device_t, uint32_t);
154 int gpiobus_release_pin(device_t, uint32_t);
156 extern driver_t gpiobus_driver;
158 #endif /* __GPIOBUS_H__ */