1 /*-
2 * SPDX-License-Identifier: BSD-2-Clause
3 *
4 * Copyright (c) 2009 Oleksandr Tymoshenko <gonzo@freebsd.org>
5 * All rights reserved.
6 *
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
9 * are met:
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.
15 *
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
26 * SUCH DAMAGE.
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 #endif
42
43 #ifdef INTRNG
44 #include <sys/intr.h>
45 #endif
46
47 #include "gpio_if.h"
48
49 #ifdef FDT
50 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) \
51 &((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo
52 #else
53 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d)
54 #endif
55 #define GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d)
56 #define GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
57 #define GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
58 #define GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx, \
59 device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF)
60 #define GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx)
61 #define GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
62 #define GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED)
63
64 #define GPIOBUS_WAIT 1
65 #define GPIOBUS_DONTWAIT 2
66
67 /* Use default interrupt mode - for gpio_alloc_intr_resource */
68 #define GPIO_INTR_CONFORM GPIO_INTR_NONE
69
70 struct gpiobus_pin_data
71 {
72 int mapped; /* pin is mapped/reserved. */
73 char *name; /* pin name. */
74 };
75
76 #ifdef INTRNG
77 struct intr_map_data_gpio {
78 struct intr_map_data hdr;
79 u_int gpio_pin_num;
80 u_int gpio_pin_flags;
81 u_int gpio_intr_mode;
82 };
83 #endif
84
85 struct gpiobus_softc
86 {
87 struct mtx sc_mtx; /* bus mutex */
88 struct rman sc_intr_rman; /* isr resources */
89 device_t sc_busdev; /* bus device */
90 device_t sc_owner; /* bus owner */
91 device_t sc_dev; /* driver device */
92 int sc_npins; /* total pins on bus */
93 struct gpiobus_pin_data *sc_pins; /* pin data */
94 };
95
96 struct gpiobus_pin
97 {
98 device_t dev; /* gpio device */
99 uint32_t flags; /* pin flags */
100 uint32_t pin; /* pin number */
101 };
102 typedef struct gpiobus_pin *gpio_pin_t;
103
104 struct gpiobus_ivar
105 {
106 struct resource_list rl; /* isr resource list */
107 uint32_t npins; /* pins total */
108 uint32_t *pins; /* pins map */
109 };
110
111 enum gpiobus_ivars {
112 GPIOBUS_IVAR_NPINS = 10500,
113 GPIOBUS_IVAR_PINS,
114 };
115
116 #define GPIOBUS_ACCESSOR(var, ivar, type) \
117 __BUS_ACCESSOR(gpiobus, var, GPIOBUS, ivar, type)
118
119 GPIOBUS_ACCESSOR(npins, NPINS, uint32_t)
120 GPIOBUS_ACCESSOR(pins, PINS, const uint32_t *)
121
122 #undef GPIOBUS_ACCESSOR
123
124 #ifdef FDT
125 struct ofw_gpiobus_devinfo {
126 struct gpiobus_ivar opd_dinfo;
127 struct ofw_bus_devinfo opd_obdinfo;
128 };
129
130 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)131 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells,
132 pcell_t *gpios, uint32_t *pin, uint32_t *flags)
133 {
134 return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags));
135 }
136
137 device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t);
138 int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **);
139 void ofw_gpiobus_register_provider(device_t);
140 void ofw_gpiobus_unregister_provider(device_t);
141
142 /* Acquire a pin by parsing FDT data. */
143 int gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node,
144 char *name, gpio_pin_t *gpio);
145 int gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node,
146 int idx, gpio_pin_t *gpio);
147 int gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node,
148 char *name, gpio_pin_t *gpio);
149 int gpio_pin_get_by_ofw_propidx(device_t consumer, phandle_t node,
150 char *name, int idx, gpio_pin_t *gpio);
151 #endif /* FDT */
152
153 /* Acquire a pin by bus and pin number. */
154 int gpio_pin_get_by_bus_pinnum(device_t _bus, uint32_t _pinnum, gpio_pin_t *_gp);
155
156 /* Acquire a pin by child and index (used by direct children of gpiobus). */
157 int gpio_pin_get_by_child_index(device_t _child, uint32_t _idx, gpio_pin_t *_gp);
158
159 /* Release a pin acquired via any gpio_pin_get_xxx() function. */
160 void gpio_pin_release(gpio_pin_t gpio);
161
162 /* Work with gpio pins acquired using the functions above. */
163 int gpio_pin_getcaps(gpio_pin_t pin, uint32_t *caps);
164 int gpio_pin_is_active(gpio_pin_t pin, bool *active);
165 int gpio_pin_set_active(gpio_pin_t pin, bool active);
166 int gpio_pin_setflags(gpio_pin_t pin, uint32_t flags);
167 struct resource *gpio_alloc_intr_resource(device_t consumer_dev, int *rid,
168 u_int alloc_flags, gpio_pin_t pin, uint32_t intr_mode);
169
170 /*
171 * Functions shared between gpiobus and other bus classes that derive from it;
172 * these should not be called directly by other drivers.
173 */
174 int gpio_check_flags(uint32_t, uint32_t);
175 device_t gpiobus_attach_bus(device_t);
176 int gpiobus_detach_bus(device_t);
177 int gpiobus_init_softc(device_t);
178 int gpiobus_alloc_ivars(struct gpiobus_ivar *);
179 void gpiobus_free_ivars(struct gpiobus_ivar *);
180 int gpiobus_acquire_pin(device_t, uint32_t);
181 int gpiobus_release_pin(device_t, uint32_t);
182
183 extern driver_t gpiobus_driver;
184
185 #endif /* __GPIOBUS_H__ */
186