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 #ifdef INTRNG 45 #include <sys/intr.h> 46 #endif 47 48 #include "gpio_if.h" 49 50 #ifdef FDT 51 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) \ 52 &((struct ofw_gpiobus_devinfo *)device_get_ivars(d))->opd_dinfo 53 #else 54 #define GPIOBUS_IVAR(d) (struct gpiobus_ivar *) device_get_ivars(d) 55 #endif 56 #define GPIOBUS_SOFTC(d) (struct gpiobus_softc *) device_get_softc(d) 57 #define GPIOBUS_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx) 58 #define GPIOBUS_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx) 59 #define GPIOBUS_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx, \ 60 device_get_nameunit(_sc->sc_dev), "gpiobus", MTX_DEF) 61 #define GPIOBUS_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx) 62 #define GPIOBUS_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED) 63 #define GPIOBUS_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED) 64 65 #define GPIOBUS_WAIT 1 66 #define GPIOBUS_DONTWAIT 2 67 68 /* Use default interrupt mode - for gpio_alloc_intr_resource */ 69 #define GPIO_INTR_CONFORM GPIO_INTR_NONE 70 71 struct gpiobus_pin_data 72 { 73 int mapped; /* pin is mapped/reserved. */ 74 char *name; /* pin name. */ 75 }; 76 77 #ifdef INTRNG 78 struct intr_map_data_gpio { 79 struct intr_map_data hdr; 80 u_int gpio_pin_num; 81 u_int gpio_pin_flags; 82 u_int gpio_intr_mode; 83 }; 84 #endif 85 86 struct gpiobus_softc 87 { 88 struct mtx sc_mtx; /* bus mutex */ 89 struct rman sc_intr_rman; /* isr resources */ 90 device_t sc_busdev; /* bus device */ 91 device_t sc_owner; /* bus owner */ 92 device_t sc_dev; /* driver device */ 93 int sc_npins; /* total pins on bus */ 94 struct gpiobus_pin_data *sc_pins; /* pin data */ 95 }; 96 97 struct gpiobus_pin 98 { 99 device_t dev; /* gpio device */ 100 uint32_t flags; /* pin flags */ 101 uint32_t pin; /* pin number */ 102 }; 103 typedef struct gpiobus_pin *gpio_pin_t; 104 105 struct gpiobus_ivar 106 { 107 struct resource_list rl; /* isr resource list */ 108 uint32_t npins; /* pins total */ 109 uint32_t *flags; /* pins flags */ 110 uint32_t *pins; /* pins map */ 111 }; 112 113 #ifdef FDT 114 struct ofw_gpiobus_devinfo { 115 struct gpiobus_ivar opd_dinfo; 116 struct ofw_bus_devinfo opd_obdinfo; 117 }; 118 119 static __inline int 120 gpio_map_gpios(device_t bus, phandle_t dev, phandle_t gparent, int gcells, 121 pcell_t *gpios, uint32_t *pin, uint32_t *flags) 122 { 123 return (GPIO_MAP_GPIOS(bus, dev, gparent, gcells, gpios, pin, flags)); 124 } 125 126 device_t ofw_gpiobus_add_fdt_child(device_t, const char *, phandle_t); 127 int ofw_gpiobus_parse_gpios(device_t, char *, struct gpiobus_pin **); 128 void ofw_gpiobus_register_provider(device_t); 129 void ofw_gpiobus_unregister_provider(device_t); 130 131 /* Consumers interface. */ 132 int gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node, 133 char *name, gpio_pin_t *gpio); 134 int gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node, 135 int idx, gpio_pin_t *gpio); 136 int gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node, 137 char *name, gpio_pin_t *gpio); 138 void gpio_pin_release(gpio_pin_t gpio); 139 int gpio_pin_getcaps(gpio_pin_t pin, uint32_t *caps); 140 int gpio_pin_is_active(gpio_pin_t pin, bool *active); 141 int gpio_pin_set_active(gpio_pin_t pin, bool active); 142 int gpio_pin_setflags(gpio_pin_t pin, uint32_t flags); 143 #endif 144 struct resource *gpio_alloc_intr_resource(device_t consumer_dev, int *rid, 145 u_int alloc_flags, gpio_pin_t pin, uint32_t intr_mode); 146 int gpio_check_flags(uint32_t, uint32_t); 147 device_t gpiobus_attach_bus(device_t); 148 int gpiobus_detach_bus(device_t); 149 int gpiobus_init_softc(device_t); 150 int gpiobus_alloc_ivars(struct gpiobus_ivar *); 151 void gpiobus_free_ivars(struct gpiobus_ivar *); 152 int gpiobus_acquire_pin(device_t, uint32_t); 153 int gpiobus_release_pin(device_t, uint32_t); 154 155 extern driver_t gpiobus_driver; 156 157 #endif /* __GPIOBUS_H__ */ 158