16d866ed3SLuiz Otavio O Souza /*- 26d866ed3SLuiz Otavio O Souza * Copyright (c) 2009, Nathan Whitehorn <nwhitehorn@FreeBSD.org> 36d866ed3SLuiz Otavio O Souza * Copyright (c) 2013, Luiz Otavio O Souza <loos@FreeBSD.org> 46d866ed3SLuiz Otavio O Souza * Copyright (c) 2013 The FreeBSD Foundation 56d866ed3SLuiz Otavio O Souza * All rights reserved. 66d866ed3SLuiz Otavio O Souza * 76d866ed3SLuiz Otavio O Souza * Redistribution and use in source and binary forms, with or without 86d866ed3SLuiz Otavio O Souza * modification, are permitted provided that the following conditions 96d866ed3SLuiz Otavio O Souza * are met: 106d866ed3SLuiz Otavio O Souza * 1. Redistributions of source code must retain the above copyright 116d866ed3SLuiz Otavio O Souza * notice unmodified, this list of conditions, and the following 126d866ed3SLuiz Otavio O Souza * disclaimer. 136d866ed3SLuiz Otavio O Souza * 2. Redistributions in binary form must reproduce the above copyright 146d866ed3SLuiz Otavio O Souza * notice, this list of conditions and the following disclaimer in the 156d866ed3SLuiz Otavio O Souza * documentation and/or other materials provided with the distribution. 166d866ed3SLuiz Otavio O Souza * 176d866ed3SLuiz Otavio O Souza * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 186d866ed3SLuiz Otavio O Souza * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 196d866ed3SLuiz Otavio O Souza * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 206d866ed3SLuiz Otavio O Souza * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 216d866ed3SLuiz Otavio O Souza * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 226d866ed3SLuiz Otavio O Souza * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 236d866ed3SLuiz Otavio O Souza * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 246d866ed3SLuiz Otavio O Souza * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 256d866ed3SLuiz Otavio O Souza * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 266d866ed3SLuiz Otavio O Souza * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 276d866ed3SLuiz Otavio O Souza */ 286d866ed3SLuiz Otavio O Souza 296d866ed3SLuiz Otavio O Souza #include <sys/cdefs.h> 306d866ed3SLuiz Otavio O Souza __FBSDID("$FreeBSD$"); 316d866ed3SLuiz Otavio O Souza 326d866ed3SLuiz Otavio O Souza #include <sys/param.h> 33160ca719SLuiz Otavio O Souza #include <sys/systm.h> 34002381dfSLuiz Otavio O Souza #include <sys/bus.h> 35002381dfSLuiz Otavio O Souza #include <sys/kernel.h> 36002381dfSLuiz Otavio O Souza #include <sys/malloc.h> 37002381dfSLuiz Otavio O Souza #include <sys/module.h> 386d866ed3SLuiz Otavio O Souza 396d866ed3SLuiz Otavio O Souza #include <dev/gpio/gpiobusvar.h> 406d866ed3SLuiz Otavio O Souza #include <dev/ofw/ofw_bus.h> 416d866ed3SLuiz Otavio O Souza 42d752f0f6SLuiz Otavio O Souza #include "gpiobus_if.h" 43d752f0f6SLuiz Otavio O Souza 446d866ed3SLuiz Otavio O Souza static struct ofw_gpiobus_devinfo *ofw_gpiobus_setup_devinfo(device_t, 45e8da3e8aSLuiz Otavio O Souza device_t, phandle_t); 466ad7f491SLuiz Otavio O Souza static void ofw_gpiobus_destroy_devinfo(device_t, struct ofw_gpiobus_devinfo *); 47e8da3e8aSLuiz Otavio O Souza static int ofw_gpiobus_parse_gpios_impl(device_t, phandle_t, char *, 48e8da3e8aSLuiz Otavio O Souza struct gpiobus_softc *, struct gpiobus_pin **); 496d866ed3SLuiz Otavio O Souza 508a4ba038SMichal Meloun /* 518a4ba038SMichal Meloun * Utility functions for easier handling of OFW GPIO pins. 528a4ba038SMichal Meloun * 538a4ba038SMichal Meloun * !!! BEWARE !!! 548a4ba038SMichal Meloun * GPIOBUS uses children's IVARs, so we cannot use this interface for cross 558a4ba038SMichal Meloun * tree consumers. 568a4ba038SMichal Meloun * 578a4ba038SMichal Meloun */ 588a4ba038SMichal Meloun static int 5951702162SOleksandr Tymoshenko gpio_pin_get_by_ofw_impl(device_t consumer, phandle_t cnode, 6051702162SOleksandr Tymoshenko char *prop_name, int idx, gpio_pin_t *out_pin) 618a4ba038SMichal Meloun { 6251702162SOleksandr Tymoshenko phandle_t xref; 638a4ba038SMichal Meloun pcell_t *cells; 648a4ba038SMichal Meloun device_t busdev; 658a4ba038SMichal Meloun struct gpiobus_pin pin; 668a4ba038SMichal Meloun int ncells, rv; 678a4ba038SMichal Meloun 6851702162SOleksandr Tymoshenko KASSERT(consumer != NULL && cnode > 0, 6951702162SOleksandr Tymoshenko ("both consumer and cnode required")); 708a4ba038SMichal Meloun 718a4ba038SMichal Meloun rv = ofw_bus_parse_xref_list_alloc(cnode, prop_name, "#gpio-cells", 728a4ba038SMichal Meloun idx, &xref, &ncells, &cells); 738a4ba038SMichal Meloun if (rv != 0) 748a4ba038SMichal Meloun return (rv); 758a4ba038SMichal Meloun 768a4ba038SMichal Meloun /* Translate provider to device. */ 778a4ba038SMichal Meloun pin.dev = OF_device_from_xref(xref); 788a4ba038SMichal Meloun if (pin.dev == NULL) { 79bc90a48cSOleksandr Tymoshenko OF_prop_free(cells); 808a4ba038SMichal Meloun return (ENODEV); 818a4ba038SMichal Meloun } 828a4ba038SMichal Meloun 838a4ba038SMichal Meloun /* Test if GPIO bus already exist. */ 848a4ba038SMichal Meloun busdev = GPIO_GET_BUS(pin.dev); 858a4ba038SMichal Meloun if (busdev == NULL) { 86bc90a48cSOleksandr Tymoshenko OF_prop_free(cells); 878a4ba038SMichal Meloun return (ENODEV); 888a4ba038SMichal Meloun } 898a4ba038SMichal Meloun 908a4ba038SMichal Meloun /* Map GPIO pin. */ 918a4ba038SMichal Meloun rv = gpio_map_gpios(pin.dev, cnode, OF_node_from_xref(xref), ncells, 928a4ba038SMichal Meloun cells, &pin.pin, &pin.flags); 93bc90a48cSOleksandr Tymoshenko OF_prop_free(cells); 9451702162SOleksandr Tymoshenko if (rv != 0) 958a4ba038SMichal Meloun return (ENXIO); 968a4ba038SMichal Meloun 978a4ba038SMichal Meloun /* Reserve GPIO pin. */ 988a4ba038SMichal Meloun rv = gpiobus_map_pin(busdev, pin.pin); 9951702162SOleksandr Tymoshenko if (rv != 0) 1008a4ba038SMichal Meloun return (EBUSY); 1018a4ba038SMichal Meloun 1028a4ba038SMichal Meloun *out_pin = malloc(sizeof(struct gpiobus_pin), M_DEVBUF, 1038a4ba038SMichal Meloun M_WAITOK | M_ZERO); 1048a4ba038SMichal Meloun **out_pin = pin; 1058a4ba038SMichal Meloun return (0); 1068a4ba038SMichal Meloun } 1078a4ba038SMichal Meloun 1088a4ba038SMichal Meloun int 10951702162SOleksandr Tymoshenko gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node, 11051702162SOleksandr Tymoshenko int idx, gpio_pin_t *pin) 1118a4ba038SMichal Meloun { 1128a4ba038SMichal Meloun 11351702162SOleksandr Tymoshenko return (gpio_pin_get_by_ofw_impl(consumer, node, "gpios", idx, pin)); 1148a4ba038SMichal Meloun } 1158a4ba038SMichal Meloun 1168a4ba038SMichal Meloun int 11751702162SOleksandr Tymoshenko gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node, 11851702162SOleksandr Tymoshenko char *name, gpio_pin_t *pin) 1198a4ba038SMichal Meloun { 1208a4ba038SMichal Meloun 12151702162SOleksandr Tymoshenko return (gpio_pin_get_by_ofw_impl(consumer, node, name, 0, pin)); 1228a4ba038SMichal Meloun } 1238a4ba038SMichal Meloun 1248a4ba038SMichal Meloun int 12551702162SOleksandr Tymoshenko gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node, 12651702162SOleksandr Tymoshenko char *name, gpio_pin_t *pin) 1278a4ba038SMichal Meloun { 1288a4ba038SMichal Meloun int rv, idx; 1298a4ba038SMichal Meloun 13051702162SOleksandr Tymoshenko KASSERT(consumer != NULL && node > 0, 13151702162SOleksandr Tymoshenko ("both consumer and node required")); 13251702162SOleksandr Tymoshenko 13351702162SOleksandr Tymoshenko rv = ofw_bus_find_string_index(node, "gpio-names", name, &idx); 1348a4ba038SMichal Meloun if (rv != 0) 1358a4ba038SMichal Meloun return (rv); 13651702162SOleksandr Tymoshenko return (gpio_pin_get_by_ofw_idx(consumer, node, idx, pin)); 1378a4ba038SMichal Meloun } 1388a4ba038SMichal Meloun 1398a4ba038SMichal Meloun void 1408a4ba038SMichal Meloun gpio_pin_release(gpio_pin_t gpio) 1418a4ba038SMichal Meloun { 142f058b6fbSOleksandr Tymoshenko device_t busdev; 1438a4ba038SMichal Meloun 1448a4ba038SMichal Meloun if (gpio == NULL) 1458a4ba038SMichal Meloun return; 1468a4ba038SMichal Meloun 147f058b6fbSOleksandr Tymoshenko KASSERT(gpio->dev != NULL, ("invalid pin state")); 148f058b6fbSOleksandr Tymoshenko 149f058b6fbSOleksandr Tymoshenko busdev = GPIO_GET_BUS(gpio->dev); 150f058b6fbSOleksandr Tymoshenko if (busdev != NULL) 151f058b6fbSOleksandr Tymoshenko gpiobus_release_pin(busdev, gpio->pin); 152f058b6fbSOleksandr Tymoshenko 1538a4ba038SMichal Meloun /* XXXX Unreserve pin. */ 1548a4ba038SMichal Meloun free(gpio, M_DEVBUF); 1558a4ba038SMichal Meloun } 1568a4ba038SMichal Meloun 1578a4ba038SMichal Meloun int 1588a4ba038SMichal Meloun gpio_pin_is_active(gpio_pin_t pin, bool *active) 1598a4ba038SMichal Meloun { 1608a4ba038SMichal Meloun int rv; 1618a4ba038SMichal Meloun uint32_t tmp; 1628a4ba038SMichal Meloun 1638a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 1648a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 1658a4ba038SMichal Meloun rv = GPIO_PIN_GET(pin->dev, pin->pin, &tmp); 1668a4ba038SMichal Meloun if (rv != 0) { 1678a4ba038SMichal Meloun return (rv); 1688a4ba038SMichal Meloun } 1698a4ba038SMichal Meloun 1708a4ba038SMichal Meloun *active = tmp != 0; 1718a4ba038SMichal Meloun if (pin->flags & GPIO_ACTIVE_LOW) 1728a4ba038SMichal Meloun *active = !(*active); 1738a4ba038SMichal Meloun return (0); 1748a4ba038SMichal Meloun } 1758a4ba038SMichal Meloun 1768a4ba038SMichal Meloun int 1778a4ba038SMichal Meloun gpio_pin_set_active(gpio_pin_t pin, bool active) 1788a4ba038SMichal Meloun { 1798a4ba038SMichal Meloun int rv; 1808a4ba038SMichal Meloun uint32_t tmp; 1818a4ba038SMichal Meloun 1828a4ba038SMichal Meloun if (pin->flags & GPIO_ACTIVE_LOW) 1838a4ba038SMichal Meloun tmp = active ? 0 : 1; 1848a4ba038SMichal Meloun else 1858a4ba038SMichal Meloun tmp = active ? 1 : 0; 1868a4ba038SMichal Meloun 1878a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 1888a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 1898a4ba038SMichal Meloun rv = GPIO_PIN_SET(pin->dev, pin->pin, tmp); 1908a4ba038SMichal Meloun return (rv); 1918a4ba038SMichal Meloun } 1928a4ba038SMichal Meloun 1938a4ba038SMichal Meloun int 1948a4ba038SMichal Meloun gpio_pin_setflags(gpio_pin_t pin, uint32_t flags) 1958a4ba038SMichal Meloun { 1968a4ba038SMichal Meloun int rv; 1978a4ba038SMichal Meloun 1988a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 1998a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 2008a4ba038SMichal Meloun 2018a4ba038SMichal Meloun rv = GPIO_PIN_SETFLAGS(pin->dev, pin->pin, flags); 2028a4ba038SMichal Meloun return (rv); 2038a4ba038SMichal Meloun } 2048a4ba038SMichal Meloun 2058a4ba038SMichal Meloun /* 2068a4ba038SMichal Meloun * OFW_GPIOBUS driver. 2078a4ba038SMichal Meloun */ 2086d866ed3SLuiz Otavio O Souza device_t 209e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_add_fdt_child(device_t bus, const char *drvname, phandle_t child) 2106d866ed3SLuiz Otavio O Souza { 2116d866ed3SLuiz Otavio O Souza device_t childdev; 212d752f0f6SLuiz Otavio O Souza int i; 213d752f0f6SLuiz Otavio O Souza struct gpiobus_ivar *devi; 214e8da3e8aSLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 2156d866ed3SLuiz Otavio O Souza 2166d866ed3SLuiz Otavio O Souza /* 2173dede9f3SWarner Losh * Check to see if we already have a child for @p child, and if so 2183dede9f3SWarner Losh * return it. 2193dede9f3SWarner Losh */ 2203dede9f3SWarner Losh childdev = ofw_bus_find_child_device_by_phandle(bus, child); 2213dede9f3SWarner Losh if (childdev != NULL) 2223dede9f3SWarner Losh return (childdev); 2233dede9f3SWarner Losh 2243dede9f3SWarner Losh /* 2256d866ed3SLuiz Otavio O Souza * Set up the GPIO child and OFW bus layer devinfo and add it to bus. 2266d866ed3SLuiz Otavio O Souza */ 227e8da3e8aSLuiz Otavio O Souza childdev = device_add_child(bus, drvname, -1); 228e8da3e8aSLuiz Otavio O Souza if (childdev == NULL) 2296d866ed3SLuiz Otavio O Souza return (NULL); 230e8da3e8aSLuiz Otavio O Souza dinfo = ofw_gpiobus_setup_devinfo(bus, childdev, child); 231e8da3e8aSLuiz Otavio O Souza if (dinfo == NULL) { 232e8da3e8aSLuiz Otavio O Souza device_delete_child(bus, childdev); 2336d866ed3SLuiz Otavio O Souza return (NULL); 2346d866ed3SLuiz Otavio O Souza } 235e8da3e8aSLuiz Otavio O Souza if (device_probe_and_attach(childdev) != 0) { 2366ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 237e8da3e8aSLuiz Otavio O Souza device_delete_child(bus, childdev); 238e8da3e8aSLuiz Otavio O Souza return (NULL); 239e8da3e8aSLuiz Otavio O Souza } 240d752f0f6SLuiz Otavio O Souza /* Use the child name as pin name. */ 241d752f0f6SLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 242d752f0f6SLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) 243d752f0f6SLuiz Otavio O Souza GPIOBUS_PIN_SETNAME(bus, devi->pins[i], 244d752f0f6SLuiz Otavio O Souza device_get_nameunit(childdev)); 2456d866ed3SLuiz Otavio O Souza 2466d866ed3SLuiz Otavio O Souza return (childdev); 2476d866ed3SLuiz Otavio O Souza } 2486d866ed3SLuiz Otavio O Souza 249e8da3e8aSLuiz Otavio O Souza int 250e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_parse_gpios(device_t consumer, char *pname, 251e8da3e8aSLuiz Otavio O Souza struct gpiobus_pin **pins) 2526d866ed3SLuiz Otavio O Souza { 2536d866ed3SLuiz Otavio O Souza 254e8da3e8aSLuiz Otavio O Souza return (ofw_gpiobus_parse_gpios_impl(consumer, 255e8da3e8aSLuiz Otavio O Souza ofw_bus_get_node(consumer), pname, NULL, pins)); 2566d866ed3SLuiz Otavio O Souza } 2576d866ed3SLuiz Otavio O Souza 258dbdb1205SLuiz Otavio O Souza void 259dbdb1205SLuiz Otavio O Souza ofw_gpiobus_register_provider(device_t provider) 260dbdb1205SLuiz Otavio O Souza { 261dbdb1205SLuiz Otavio O Souza phandle_t node; 262dbdb1205SLuiz Otavio O Souza 263dbdb1205SLuiz Otavio O Souza node = ofw_bus_get_node(provider); 264dbdb1205SLuiz Otavio O Souza OF_device_register_xref(OF_xref_from_node(node), provider); 265dbdb1205SLuiz Otavio O Souza } 266dbdb1205SLuiz Otavio O Souza 267dbdb1205SLuiz Otavio O Souza void 268dbdb1205SLuiz Otavio O Souza ofw_gpiobus_unregister_provider(device_t provider) 269dbdb1205SLuiz Otavio O Souza { 270dbdb1205SLuiz Otavio O Souza phandle_t node; 271dbdb1205SLuiz Otavio O Souza 272dbdb1205SLuiz Otavio O Souza node = ofw_bus_get_node(provider); 273dbdb1205SLuiz Otavio O Souza OF_device_register_xref(OF_xref_from_node(node), NULL); 274dbdb1205SLuiz Otavio O Souza } 275dbdb1205SLuiz Otavio O Souza 2766d866ed3SLuiz Otavio O Souza static struct ofw_gpiobus_devinfo * 277e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_setup_devinfo(device_t bus, device_t child, phandle_t node) 2786d866ed3SLuiz Otavio O Souza { 279e8da3e8aSLuiz Otavio O Souza int i, npins; 280e8da3e8aSLuiz Otavio O Souza struct gpiobus_ivar *devi; 281e8da3e8aSLuiz Otavio O Souza struct gpiobus_pin *pins; 2826d866ed3SLuiz Otavio O Souza struct gpiobus_softc *sc; 2836d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 2846d866ed3SLuiz Otavio O Souza 285e8da3e8aSLuiz Otavio O Souza sc = device_get_softc(bus); 2866d866ed3SLuiz Otavio O Souza dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_NOWAIT | M_ZERO); 2876d866ed3SLuiz Otavio O Souza if (dinfo == NULL) 2886d866ed3SLuiz Otavio O Souza return (NULL); 2896d866ed3SLuiz Otavio O Souza if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, node) != 0) { 2906d866ed3SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 2916d866ed3SLuiz Otavio O Souza return (NULL); 2926d866ed3SLuiz Otavio O Souza } 2936d866ed3SLuiz Otavio O Souza /* Parse the gpios property for the child. */ 294e8da3e8aSLuiz Otavio O Souza npins = ofw_gpiobus_parse_gpios_impl(child, node, "gpios", sc, &pins); 2956ad7f491SLuiz Otavio O Souza if (npins <= 0) { 2966ad7f491SLuiz Otavio O Souza ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo); 2976ad7f491SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 2986ad7f491SLuiz Otavio O Souza return (NULL); 2996ad7f491SLuiz Otavio O Souza } 3006ad7f491SLuiz Otavio O Souza /* Initialize the irq resource list. */ 3016ad7f491SLuiz Otavio O Souza resource_list_init(&dinfo->opd_dinfo.rl); 3026ad7f491SLuiz Otavio O Souza /* Allocate the child ivars and copy the parsed pin data. */ 303e8da3e8aSLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 304e8da3e8aSLuiz Otavio O Souza devi->npins = (uint32_t)npins; 305e8da3e8aSLuiz Otavio O Souza if (gpiobus_alloc_ivars(devi) != 0) { 306e8da3e8aSLuiz Otavio O Souza free(pins, M_DEVBUF); 3076ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 3086ad7f491SLuiz Otavio O Souza return (NULL); 3096d866ed3SLuiz Otavio O Souza } 310e8da3e8aSLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) { 311e8da3e8aSLuiz Otavio O Souza devi->flags[i] = pins[i].flags; 312e8da3e8aSLuiz Otavio O Souza devi->pins[i] = pins[i].pin; 313e8da3e8aSLuiz Otavio O Souza } 314e8da3e8aSLuiz Otavio O Souza free(pins, M_DEVBUF); 3156ad7f491SLuiz Otavio O Souza /* Parse the interrupt resources. */ 316a8c5ea04SRuslan Bukin if (ofw_bus_intr_to_rl(bus, node, &dinfo->opd_dinfo.rl, NULL) != 0) { 3176ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 3186ad7f491SLuiz Otavio O Souza return (NULL); 319e8da3e8aSLuiz Otavio O Souza } 320e8da3e8aSLuiz Otavio O Souza device_set_ivars(child, dinfo); 321e8da3e8aSLuiz Otavio O Souza 322e8da3e8aSLuiz Otavio O Souza return (dinfo); 323138bf909SLuiz Otavio O Souza } 3246d866ed3SLuiz Otavio O Souza 3256d866ed3SLuiz Otavio O Souza static void 3266ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(device_t bus, struct ofw_gpiobus_devinfo *dinfo) 3276d866ed3SLuiz Otavio O Souza { 3286ad7f491SLuiz Otavio O Souza int i; 329e8da3e8aSLuiz Otavio O Souza struct gpiobus_ivar *devi; 3306ad7f491SLuiz Otavio O Souza struct gpiobus_softc *sc; 3316d866ed3SLuiz Otavio O Souza 3326ad7f491SLuiz Otavio O Souza sc = device_get_softc(bus); 333e8da3e8aSLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 3346ad7f491SLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) { 3356ad7f491SLuiz Otavio O Souza if (devi->pins[i] > sc->sc_npins) 3366ad7f491SLuiz Otavio O Souza continue; 337d752f0f6SLuiz Otavio O Souza sc->sc_pins[devi->pins[i]].mapped = 0; 3386ad7f491SLuiz Otavio O Souza } 339e8da3e8aSLuiz Otavio O Souza gpiobus_free_ivars(devi); 340138bf909SLuiz Otavio O Souza resource_list_free(&dinfo->opd_dinfo.rl); 3416d866ed3SLuiz Otavio O Souza ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo); 3426d866ed3SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 3436d866ed3SLuiz Otavio O Souza } 3446d866ed3SLuiz Otavio O Souza 3456d866ed3SLuiz Otavio O Souza static int 346e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_parse_gpios_impl(device_t consumer, phandle_t cnode, char *pname, 347e8da3e8aSLuiz Otavio O Souza struct gpiobus_softc *bussc, struct gpiobus_pin **pins) 348e8da3e8aSLuiz Otavio O Souza { 349e8da3e8aSLuiz Otavio O Souza int gpiocells, i, j, ncells, npins; 350e8da3e8aSLuiz Otavio O Souza pcell_t *gpios; 351e8da3e8aSLuiz Otavio O Souza phandle_t gpio; 352e8da3e8aSLuiz Otavio O Souza 353e8da3e8aSLuiz Otavio O Souza ncells = OF_getencprop_alloc(cnode, pname, sizeof(*gpios), 354e8da3e8aSLuiz Otavio O Souza (void **)&gpios); 355e8da3e8aSLuiz Otavio O Souza if (ncells == -1) { 356e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 357e8da3e8aSLuiz Otavio O Souza "Warning: No %s specified in fdt data; " 358e8da3e8aSLuiz Otavio O Souza "device may not function.\n", pname); 359e8da3e8aSLuiz Otavio O Souza return (-1); 360e8da3e8aSLuiz Otavio O Souza } 361e8da3e8aSLuiz Otavio O Souza /* 362e8da3e8aSLuiz Otavio O Souza * The gpio-specifier is controller independent, the first pcell has 363e8da3e8aSLuiz Otavio O Souza * the reference to the GPIO controller phandler. 364e8da3e8aSLuiz Otavio O Souza * Count the number of encoded gpio-specifiers on the first pass. 365e8da3e8aSLuiz Otavio O Souza */ 366e8da3e8aSLuiz Otavio O Souza i = 0; 367e8da3e8aSLuiz Otavio O Souza npins = 0; 368e8da3e8aSLuiz Otavio O Souza while (i < ncells) { 369e8da3e8aSLuiz Otavio O Souza /* Allow NULL specifiers. */ 370e8da3e8aSLuiz Otavio O Souza if (gpios[i] == 0) { 371e8da3e8aSLuiz Otavio O Souza npins++; 372e8da3e8aSLuiz Otavio O Souza i++; 373e8da3e8aSLuiz Otavio O Souza continue; 374e8da3e8aSLuiz Otavio O Souza } 375e8da3e8aSLuiz Otavio O Souza gpio = OF_node_from_xref(gpios[i]); 376e8da3e8aSLuiz Otavio O Souza /* If we have bussc, ignore devices from other gpios. */ 377e8da3e8aSLuiz Otavio O Souza if (bussc != NULL) 378e8da3e8aSLuiz Otavio O Souza if (ofw_bus_get_node(bussc->sc_dev) != gpio) 379e8da3e8aSLuiz Otavio O Souza return (0); 380e8da3e8aSLuiz Otavio O Souza /* 381e8da3e8aSLuiz Otavio O Souza * Check for gpio-controller property and read the #gpio-cells 382e8da3e8aSLuiz Otavio O Souza * for this GPIO controller. 383e8da3e8aSLuiz Otavio O Souza */ 384e8da3e8aSLuiz Otavio O Souza if (!OF_hasprop(gpio, "gpio-controller") || 385e8da3e8aSLuiz Otavio O Souza OF_getencprop(gpio, "#gpio-cells", &gpiocells, 386e8da3e8aSLuiz Otavio O Souza sizeof(gpiocells)) < 0) { 387e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 388e8da3e8aSLuiz Otavio O Souza "gpio reference is not a gpio-controller.\n"); 389bc90a48cSOleksandr Tymoshenko OF_prop_free(gpios); 390e8da3e8aSLuiz Otavio O Souza return (-1); 391e8da3e8aSLuiz Otavio O Souza } 392e8da3e8aSLuiz Otavio O Souza if (ncells - i < gpiocells + 1) { 393e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 394e8da3e8aSLuiz Otavio O Souza "%s cells doesn't match #gpio-cells.\n", pname); 395e8da3e8aSLuiz Otavio O Souza return (-1); 396e8da3e8aSLuiz Otavio O Souza } 397e8da3e8aSLuiz Otavio O Souza npins++; 398e8da3e8aSLuiz Otavio O Souza i += gpiocells + 1; 399e8da3e8aSLuiz Otavio O Souza } 400e8da3e8aSLuiz Otavio O Souza if (npins == 0 || pins == NULL) { 401e8da3e8aSLuiz Otavio O Souza if (npins == 0) 402e8da3e8aSLuiz Otavio O Souza device_printf(consumer, "no pin specified in %s.\n", 403e8da3e8aSLuiz Otavio O Souza pname); 404bc90a48cSOleksandr Tymoshenko OF_prop_free(gpios); 405e8da3e8aSLuiz Otavio O Souza return (npins); 406e8da3e8aSLuiz Otavio O Souza } 407e8da3e8aSLuiz Otavio O Souza *pins = malloc(sizeof(struct gpiobus_pin) * npins, M_DEVBUF, 408e8da3e8aSLuiz Otavio O Souza M_NOWAIT | M_ZERO); 409e8da3e8aSLuiz Otavio O Souza if (*pins == NULL) { 410bc90a48cSOleksandr Tymoshenko OF_prop_free(gpios); 411e8da3e8aSLuiz Otavio O Souza return (-1); 412e8da3e8aSLuiz Otavio O Souza } 413e8da3e8aSLuiz Otavio O Souza /* Decode the gpio specifier on the second pass. */ 414e8da3e8aSLuiz Otavio O Souza i = 0; 415e8da3e8aSLuiz Otavio O Souza j = 0; 416e8da3e8aSLuiz Otavio O Souza while (i < ncells) { 417e8da3e8aSLuiz Otavio O Souza /* Allow NULL specifiers. */ 418e8da3e8aSLuiz Otavio O Souza if (gpios[i] == 0) { 419e8da3e8aSLuiz Otavio O Souza j++; 420e8da3e8aSLuiz Otavio O Souza i++; 421e8da3e8aSLuiz Otavio O Souza continue; 422e8da3e8aSLuiz Otavio O Souza } 423e8da3e8aSLuiz Otavio O Souza gpio = OF_node_from_xref(gpios[i]); 424e8da3e8aSLuiz Otavio O Souza /* Read gpio-cells property for this GPIO controller. */ 425e8da3e8aSLuiz Otavio O Souza if (OF_getencprop(gpio, "#gpio-cells", &gpiocells, 426e8da3e8aSLuiz Otavio O Souza sizeof(gpiocells)) < 0) { 427e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 428e8da3e8aSLuiz Otavio O Souza "gpio does not have the #gpio-cells property.\n"); 429e8da3e8aSLuiz Otavio O Souza goto fail; 430e8da3e8aSLuiz Otavio O Souza } 431e8da3e8aSLuiz Otavio O Souza /* Return the device reference for the GPIO controller. */ 432e8da3e8aSLuiz Otavio O Souza (*pins)[j].dev = OF_device_from_xref(gpios[i]); 433e8da3e8aSLuiz Otavio O Souza if ((*pins)[j].dev == NULL) { 434e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 435e8da3e8aSLuiz Otavio O Souza "no device registered for the gpio controller.\n"); 436e8da3e8aSLuiz Otavio O Souza goto fail; 437e8da3e8aSLuiz Otavio O Souza } 438e8da3e8aSLuiz Otavio O Souza /* 439e8da3e8aSLuiz Otavio O Souza * If the gpiobus softc is NULL we use the GPIO_GET_BUS() to 440e8da3e8aSLuiz Otavio O Souza * retrieve it. The GPIO_GET_BUS() method is only valid after 441e8da3e8aSLuiz Otavio O Souza * the child is probed and attached. 442e8da3e8aSLuiz Otavio O Souza */ 443e8da3e8aSLuiz Otavio O Souza if (bussc == NULL) { 444e8da3e8aSLuiz Otavio O Souza if (GPIO_GET_BUS((*pins)[j].dev) == NULL) { 445e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 446e8da3e8aSLuiz Otavio O Souza "no gpiobus reference for %s.\n", 447e8da3e8aSLuiz Otavio O Souza device_get_nameunit((*pins)[j].dev)); 448e8da3e8aSLuiz Otavio O Souza goto fail; 449e8da3e8aSLuiz Otavio O Souza } 450e8da3e8aSLuiz Otavio O Souza bussc = device_get_softc(GPIO_GET_BUS((*pins)[j].dev)); 451e8da3e8aSLuiz Otavio O Souza } 452e8da3e8aSLuiz Otavio O Souza /* Get the GPIO pin number and flags. */ 453e8da3e8aSLuiz Otavio O Souza if (gpio_map_gpios((*pins)[j].dev, cnode, gpio, gpiocells, 454e8da3e8aSLuiz Otavio O Souza &gpios[i + 1], &(*pins)[j].pin, &(*pins)[j].flags) != 0) { 455e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 456e8da3e8aSLuiz Otavio O Souza "cannot map the gpios specifier.\n"); 457e8da3e8aSLuiz Otavio O Souza goto fail; 458e8da3e8aSLuiz Otavio O Souza } 459da3b488dSLuiz Otavio O Souza /* Reserve the GPIO pin. */ 4606153d465SLuiz Otavio O Souza if (gpiobus_map_pin(bussc->sc_busdev, (*pins)[j].pin) != 0) 461e8da3e8aSLuiz Otavio O Souza goto fail; 462e8da3e8aSLuiz Otavio O Souza j++; 463e8da3e8aSLuiz Otavio O Souza i += gpiocells + 1; 464e8da3e8aSLuiz Otavio O Souza } 465bc90a48cSOleksandr Tymoshenko OF_prop_free(gpios); 466e8da3e8aSLuiz Otavio O Souza 467e8da3e8aSLuiz Otavio O Souza return (npins); 468e8da3e8aSLuiz Otavio O Souza 469e8da3e8aSLuiz Otavio O Souza fail: 470bc90a48cSOleksandr Tymoshenko OF_prop_free(gpios); 471e8da3e8aSLuiz Otavio O Souza free(*pins, M_DEVBUF); 472e8da3e8aSLuiz Otavio O Souza return (-1); 473e8da3e8aSLuiz Otavio O Souza } 474e8da3e8aSLuiz Otavio O Souza 475e8da3e8aSLuiz Otavio O Souza static int 4766d866ed3SLuiz Otavio O Souza ofw_gpiobus_probe(device_t dev) 4776d866ed3SLuiz Otavio O Souza { 4786d866ed3SLuiz Otavio O Souza 4796d866ed3SLuiz Otavio O Souza if (ofw_bus_get_node(dev) == -1) 4806d866ed3SLuiz Otavio O Souza return (ENXIO); 4816d866ed3SLuiz Otavio O Souza device_set_desc(dev, "OFW GPIO bus"); 4826d866ed3SLuiz Otavio O Souza 4836d866ed3SLuiz Otavio O Souza return (0); 4846d866ed3SLuiz Otavio O Souza } 4856d866ed3SLuiz Otavio O Souza 4866d866ed3SLuiz Otavio O Souza static int 4876d866ed3SLuiz Otavio O Souza ofw_gpiobus_attach(device_t dev) 4886d866ed3SLuiz Otavio O Souza { 48988516632SLuiz Otavio O Souza int err; 4906d866ed3SLuiz Otavio O Souza phandle_t child; 4916d866ed3SLuiz Otavio O Souza 49288516632SLuiz Otavio O Souza err = gpiobus_init_softc(dev); 49388516632SLuiz Otavio O Souza if (err != 0) 49488516632SLuiz Otavio O Souza return (err); 4956d866ed3SLuiz Otavio O Souza bus_generic_probe(dev); 4966d866ed3SLuiz Otavio O Souza bus_enumerate_hinted_children(dev); 4976d866ed3SLuiz Otavio O Souza /* 4986d866ed3SLuiz Otavio O Souza * Attach the children represented in the device tree. 4996d866ed3SLuiz Otavio O Souza */ 5006d866ed3SLuiz Otavio O Souza for (child = OF_child(ofw_bus_get_node(dev)); child != 0; 501e8da3e8aSLuiz Otavio O Souza child = OF_peer(child)) { 502e8da3e8aSLuiz Otavio O Souza if (!OF_hasprop(child, "gpios")) 5036d866ed3SLuiz Otavio O Souza continue; 504e8da3e8aSLuiz Otavio O Souza if (ofw_gpiobus_add_fdt_child(dev, NULL, child) == NULL) 505e8da3e8aSLuiz Otavio O Souza continue; 506e8da3e8aSLuiz Otavio O Souza } 5076d866ed3SLuiz Otavio O Souza 5086d866ed3SLuiz Otavio O Souza return (bus_generic_attach(dev)); 5096d866ed3SLuiz Otavio O Souza } 5106d866ed3SLuiz Otavio O Souza 5116d866ed3SLuiz Otavio O Souza static device_t 5126d866ed3SLuiz Otavio O Souza ofw_gpiobus_add_child(device_t dev, u_int order, const char *name, int unit) 5136d866ed3SLuiz Otavio O Souza { 5146d866ed3SLuiz Otavio O Souza device_t child; 5156d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *devi; 5166d866ed3SLuiz Otavio O Souza 5176d866ed3SLuiz Otavio O Souza child = device_add_child_ordered(dev, order, name, unit); 5186d866ed3SLuiz Otavio O Souza if (child == NULL) 5196d866ed3SLuiz Otavio O Souza return (child); 5206d866ed3SLuiz Otavio O Souza devi = malloc(sizeof(struct ofw_gpiobus_devinfo), M_DEVBUF, 5216d866ed3SLuiz Otavio O Souza M_NOWAIT | M_ZERO); 5226d866ed3SLuiz Otavio O Souza if (devi == NULL) { 5236d866ed3SLuiz Otavio O Souza device_delete_child(dev, child); 5246d866ed3SLuiz Otavio O Souza return (0); 5256d866ed3SLuiz Otavio O Souza } 5266d866ed3SLuiz Otavio O Souza 5276d866ed3SLuiz Otavio O Souza /* 5286d866ed3SLuiz Otavio O Souza * NULL all the OFW-related parts of the ivars for non-OFW 5296d866ed3SLuiz Otavio O Souza * children. 5306d866ed3SLuiz Otavio O Souza */ 5316d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_node = -1; 5326d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_name = NULL; 5336d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_compat = NULL; 5346d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_type = NULL; 5356d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_model = NULL; 5366d866ed3SLuiz Otavio O Souza 5376d866ed3SLuiz Otavio O Souza device_set_ivars(child, devi); 5386d866ed3SLuiz Otavio O Souza 5396d866ed3SLuiz Otavio O Souza return (child); 5406d866ed3SLuiz Otavio O Souza } 5416d866ed3SLuiz Otavio O Souza 5426d866ed3SLuiz Otavio O Souza static const struct ofw_bus_devinfo * 5436d866ed3SLuiz Otavio O Souza ofw_gpiobus_get_devinfo(device_t bus, device_t dev) 5446d866ed3SLuiz Otavio O Souza { 5456d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 5466d866ed3SLuiz Otavio O Souza 5476d866ed3SLuiz Otavio O Souza dinfo = device_get_ivars(dev); 5486d866ed3SLuiz Otavio O Souza 5496d866ed3SLuiz Otavio O Souza return (&dinfo->opd_obdinfo); 5506d866ed3SLuiz Otavio O Souza } 5516d866ed3SLuiz Otavio O Souza 5526d866ed3SLuiz Otavio O Souza static device_method_t ofw_gpiobus_methods[] = { 5536d866ed3SLuiz Otavio O Souza /* Device interface */ 5546d866ed3SLuiz Otavio O Souza DEVMETHOD(device_probe, ofw_gpiobus_probe), 5556d866ed3SLuiz Otavio O Souza DEVMETHOD(device_attach, ofw_gpiobus_attach), 5566d866ed3SLuiz Otavio O Souza 5576d866ed3SLuiz Otavio O Souza /* Bus interface */ 5586d866ed3SLuiz Otavio O Souza DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str), 5596d866ed3SLuiz Otavio O Souza DEVMETHOD(bus_add_child, ofw_gpiobus_add_child), 5606d866ed3SLuiz Otavio O Souza 5616d866ed3SLuiz Otavio O Souza /* ofw_bus interface */ 5626d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_devinfo, ofw_gpiobus_get_devinfo), 5636d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 5646d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 5656d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 5666d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 5676d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 5686d866ed3SLuiz Otavio O Souza 5696d866ed3SLuiz Otavio O Souza DEVMETHOD_END 5706d866ed3SLuiz Otavio O Souza }; 5716d866ed3SLuiz Otavio O Souza 572e3da01a3SMichal Meloun devclass_t ofwgpiobus_devclass; 5736d866ed3SLuiz Otavio O Souza 5746d866ed3SLuiz Otavio O Souza DEFINE_CLASS_1(gpiobus, ofw_gpiobus_driver, ofw_gpiobus_methods, 5756d866ed3SLuiz Otavio O Souza sizeof(struct gpiobus_softc), gpiobus_driver); 57612bc2abbSMichal Meloun EARLY_DRIVER_MODULE(ofw_gpiobus, gpio, ofw_gpiobus_driver, ofwgpiobus_devclass, 57712bc2abbSMichal Meloun 0, 0, BUS_PASS_BUS); 5786d866ed3SLuiz Otavio O Souza MODULE_VERSION(ofw_gpiobus, 1); 5796d866ed3SLuiz Otavio O Souza MODULE_DEPEND(ofw_gpiobus, gpiobus, 1, 1, 1); 580