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 #include <sys/rman.h>
38
39 #ifdef FDT
40 #include <dev/ofw/ofw_bus_subr.h>
41 #include <gnu/dts/include/dt-bindings/gpio/gpio.h>
42 #endif
43
44 #include "gpio_if.h"
45
46 #ifdef FDT
47 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) \
48 &((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo
49 #else
50 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
51 #endif
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)
60
61 #define GPIOBUS_WAIT 1
62 #define GPIOBUS_DONTWAIT 2
63
64 /* Use default interrupt mode - for gpio_alloc_intr_resource */
65 #define GPIO_INTR_CONFORM GPIO_INTR_NONE
66
67 struct gpiobus_pin_data
68 {
69 int mapped; /* pin is mapped/reserved. */
70 char *name; /* pin name. */
71 };
72
73 #ifdef INTRNG
74 struct intr_map_data_gpio {
75 struct intr_map_data hdr;
76 u_int gpio_pin_num;
77 u_int gpio_pin_flags;
78 u_int gpio_intr_mode;
79 };
80 #endif
81
82 struct gpiobus_softc
83 {
84 struct mtx sc_mtx; /* bus mutex */
85 struct rman sc_intr_rman; /* isr resources */
86 device_t sc_busdev; /* bus device */
87 device_t sc_owner; /* bus owner */
88 device_t sc_dev; /* driver device */
89 int sc_npins; /* total pins on bus */
90 struct gpiobus_pin_data *sc_pins; /* pin data */
91 };
92
93 struct gpiobus_pin
94 {
95 device_t dev; /* gpio device */
96 uint32_t flags; /* pin flags */
97 uint32_t pin; /* pin number */
98 };
99 typedef struct gpiobus_pin *gpio_pin_t;
100
101 struct gpiobus_ivar
102 {
103 struct resource_list rl; /* isr resource list */
104 uint32_t npins; /* pins total */
105 uint32_t *pins; /* pins map */
106 };
107
108 enum gpiobus_ivars {
109 GPIOBUS_IVAR_NPINS = 10500,
110 GPIOBUS_IVAR_PINS,
111 };
112
113 #define GPIOBUS_ACCESSOR(var, ivar, type) \
114 __BUS_ACCESSOR(gpiobus, var, GPIOBUS, ivar, type)
115
116 GPIOBUS_ACCESSOR(npins, NPINS, uint32_t)
117 GPIOBUS_ACCESSOR(pins, PINS, const uint32_t *)
118
119 #undef GPIOBUS_ACCESSOR
120
121 #ifdef FDT
122 struct ofw_gpiobus_devinfo {
123 struct gpiobus_ivar opd_dinfo;
124 struct ofw_bus_devinfo opd_obdinfo;
125 };
126
127 static __inline int
gpio_map_gpios(device_t bus,phandle_t dev,phandle_t gparent,int gcells,pcell_t * gpios,uint32_t * pin,uint32_t * flags)128 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
129 pcell_t *gpios, uint32_t *pin, uint32_t *flags)
130 {
131 return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
132 }
133
134 device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t);
135 int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **);
136 void ofw_gpiobus_register_provider(device_t);
137 void ofw_gpiobus_unregister_provider(device_t);
138
139 /* Consumers interface. */
140 int gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node,
141 char *name, gpio_pin_t *gpio);
142 int gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node,
143 int idx, gpio_pin_t *gpio);
144 int gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node,
145 char *name, gpio_pin_t *gpio);
146 int gpio_pin_get_by_ofw_propidx(device_t consumer, phandle_t node,
147 char *name, int idx, gpio_pin_t *gpio);
148 void gpio_pin_release(gpio_pin_t gpio);
149 int gpio_pin_getcaps(gpio_pin_t pin, uint32_t *caps);
150 int gpio_pin_is_active(gpio_pin_t pin, bool *active);
151 int gpio_pin_set_active(gpio_pin_t pin, bool active);
152 int gpio_pin_setflags(gpio_pin_t pin, uint32_t flags);
153 #endif
154 struct resource *gpio_alloc_intr_resource(device_t consumer_dev, int *rid,
155 u_int alloc_flags, gpio_pin_t pin, uint32_t intr_mode);
156 int gpio_check_flags(uint32_t, uint32_t);
157 device_t gpiobus_attach_bus(device_t);
158 int gpiobus_detach_bus(device_t);
159 int gpiobus_init_softc(device_t);
160 int gpiobus_alloc_ivars(struct gpiobus_ivar *);
161 void gpiobus_free_ivars(struct gpiobus_ivar *);
162 int gpiobus_acquire_pin(device_t, uint32_t);
163 int gpiobus_release_pin(device_t, uint32_t);
164
165 extern driver_t gpiobus_driver;
166
167 #endif /* __GPIOBUS_H__ */
168