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 598a4ba038SMichal Meloun gpio_pin_get_by_ofw_impl(device_t consumer_dev, char *prop_name, int idx, 608a4ba038SMichal Meloun gpio_pin_t *out_pin) 618a4ba038SMichal Meloun { 628a4ba038SMichal Meloun phandle_t cnode, xref; 638a4ba038SMichal Meloun pcell_t *cells; 648a4ba038SMichal Meloun device_t busdev; 658a4ba038SMichal Meloun struct gpiobus_pin pin; 668a4ba038SMichal Meloun int ncells, rv; 678a4ba038SMichal Meloun 688a4ba038SMichal Meloun cnode = ofw_bus_get_node(consumer_dev); 698a4ba038SMichal Meloun if (cnode <= 0) { 708a4ba038SMichal Meloun device_printf(consumer_dev, 718a4ba038SMichal Meloun "%s called on not ofw based device\n", __func__); 728a4ba038SMichal Meloun return (ENXIO); 738a4ba038SMichal Meloun } 748a4ba038SMichal Meloun 758a4ba038SMichal Meloun rv = ofw_bus_parse_xref_list_alloc(cnode, prop_name, "#gpio-cells", 768a4ba038SMichal Meloun idx, &xref, &ncells, &cells); 778a4ba038SMichal Meloun if (rv != 0) 788a4ba038SMichal Meloun return (rv); 798a4ba038SMichal Meloun 808a4ba038SMichal Meloun /* Translate provider to device. */ 818a4ba038SMichal Meloun pin.dev = OF_device_from_xref(xref); 828a4ba038SMichal Meloun if (pin.dev == NULL) { 838a4ba038SMichal Meloun free(cells, M_OFWPROP); 848a4ba038SMichal Meloun return (ENODEV); 858a4ba038SMichal Meloun } 868a4ba038SMichal Meloun 878a4ba038SMichal Meloun /* Test if GPIO bus already exist. */ 888a4ba038SMichal Meloun busdev = GPIO_GET_BUS(pin.dev); 898a4ba038SMichal Meloun if (busdev == NULL) { 908a4ba038SMichal Meloun free(cells, M_OFWPROP); 918a4ba038SMichal Meloun return (ENODEV); 928a4ba038SMichal Meloun } 938a4ba038SMichal Meloun 948a4ba038SMichal Meloun /* Map GPIO pin. */ 958a4ba038SMichal Meloun rv = gpio_map_gpios(pin.dev, cnode, OF_node_from_xref(xref), ncells, 968a4ba038SMichal Meloun cells, &pin.pin, &pin.flags); 978a4ba038SMichal Meloun free(cells, M_OFWPROP); 988a4ba038SMichal Meloun if (rv != 0) { 998a4ba038SMichal Meloun device_printf(consumer_dev, "Cannot map the gpio property.\n"); 1008a4ba038SMichal Meloun return (ENXIO); 1018a4ba038SMichal Meloun } 1028a4ba038SMichal Meloun 1038a4ba038SMichal Meloun /* Reserve GPIO pin. */ 1048a4ba038SMichal Meloun rv = gpiobus_map_pin(busdev, pin.pin); 1058a4ba038SMichal Meloun if (rv != 0) { 1068a4ba038SMichal Meloun device_printf(consumer_dev, "Cannot reserve gpio pin.\n"); 1078a4ba038SMichal Meloun return (EBUSY); 1088a4ba038SMichal Meloun } 1098a4ba038SMichal Meloun 1108a4ba038SMichal Meloun *out_pin = malloc(sizeof(struct gpiobus_pin), M_DEVBUF, 1118a4ba038SMichal Meloun M_WAITOK | M_ZERO); 1128a4ba038SMichal Meloun **out_pin = pin; 1138a4ba038SMichal Meloun return (0); 1148a4ba038SMichal Meloun } 1158a4ba038SMichal Meloun 1168a4ba038SMichal Meloun int 1178a4ba038SMichal Meloun gpio_pin_get_by_ofw_idx(device_t consumer_dev, int idx, gpio_pin_t *pin) 1188a4ba038SMichal Meloun { 1198a4ba038SMichal Meloun 1208a4ba038SMichal Meloun return (gpio_pin_get_by_ofw_impl(consumer_dev, "gpios", idx, pin)); 1218a4ba038SMichal Meloun } 1228a4ba038SMichal Meloun 1238a4ba038SMichal Meloun int 1248a4ba038SMichal Meloun gpio_pin_get_by_ofw_property(device_t consumer_dev, char *name, gpio_pin_t *pin) 1258a4ba038SMichal Meloun { 1268a4ba038SMichal Meloun 1278a4ba038SMichal Meloun return (gpio_pin_get_by_ofw_impl(consumer_dev, name, 0, pin)); 1288a4ba038SMichal Meloun } 1298a4ba038SMichal Meloun 1308a4ba038SMichal Meloun int 1318a4ba038SMichal Meloun gpio_pin_get_by_ofw_name(device_t consumer_dev, char *name, gpio_pin_t *pin) 1328a4ba038SMichal Meloun { 1338a4ba038SMichal Meloun int rv, idx; 1348a4ba038SMichal Meloun phandle_t cnode; 1358a4ba038SMichal Meloun 1368a4ba038SMichal Meloun cnode = ofw_bus_get_node(consumer_dev); 1378a4ba038SMichal Meloun if (cnode <= 0) { 1388a4ba038SMichal Meloun device_printf(consumer_dev, 1398a4ba038SMichal Meloun "%s called on not ofw based device\n", __func__); 1408a4ba038SMichal Meloun return (ENXIO); 1418a4ba038SMichal Meloun } 1428a4ba038SMichal Meloun rv = ofw_bus_find_string_index(cnode, "gpio-names", name, &idx); 1438a4ba038SMichal Meloun if (rv != 0) 1448a4ba038SMichal Meloun return (rv); 1458a4ba038SMichal Meloun return (gpio_pin_get_by_ofw_idx(consumer_dev, idx, pin)); 1468a4ba038SMichal Meloun } 1478a4ba038SMichal Meloun 1488a4ba038SMichal Meloun void 1498a4ba038SMichal Meloun gpio_pin_release(gpio_pin_t gpio) 1508a4ba038SMichal Meloun { 1518a4ba038SMichal Meloun 1528a4ba038SMichal Meloun if (gpio == NULL) 1538a4ba038SMichal Meloun return; 1548a4ba038SMichal Meloun 1558a4ba038SMichal Meloun /* XXXX Unreserve pin. */ 1568a4ba038SMichal Meloun free(gpio, M_DEVBUF); 1578a4ba038SMichal Meloun } 1588a4ba038SMichal Meloun 1598a4ba038SMichal Meloun int 1608a4ba038SMichal Meloun gpio_pin_is_active(gpio_pin_t pin, bool *active) 1618a4ba038SMichal Meloun { 1628a4ba038SMichal Meloun int rv; 1638a4ba038SMichal Meloun uint32_t tmp; 1648a4ba038SMichal Meloun 1658a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 1668a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 1678a4ba038SMichal Meloun rv = GPIO_PIN_GET(pin->dev, pin->pin, &tmp); 1688a4ba038SMichal Meloun if (rv != 0) { 1698a4ba038SMichal Meloun return (rv); 1708a4ba038SMichal Meloun } 1718a4ba038SMichal Meloun 1728a4ba038SMichal Meloun *active = tmp != 0; 1738a4ba038SMichal Meloun if (pin->flags & GPIO_ACTIVE_LOW) 1748a4ba038SMichal Meloun *active = !(*active); 1758a4ba038SMichal Meloun return (0); 1768a4ba038SMichal Meloun } 1778a4ba038SMichal Meloun 1788a4ba038SMichal Meloun int 1798a4ba038SMichal Meloun gpio_pin_set_active(gpio_pin_t pin, bool active) 1808a4ba038SMichal Meloun { 1818a4ba038SMichal Meloun int rv; 1828a4ba038SMichal Meloun uint32_t tmp; 1838a4ba038SMichal Meloun 1848a4ba038SMichal Meloun if (pin->flags & GPIO_ACTIVE_LOW) 1858a4ba038SMichal Meloun tmp = active ? 0 : 1; 1868a4ba038SMichal Meloun else 1878a4ba038SMichal Meloun tmp = active ? 1 : 0; 1888a4ba038SMichal Meloun 1898a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 1908a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 1918a4ba038SMichal Meloun rv = GPIO_PIN_SET(pin->dev, pin->pin, tmp); 1928a4ba038SMichal Meloun return (rv); 1938a4ba038SMichal Meloun } 1948a4ba038SMichal Meloun 1958a4ba038SMichal Meloun int 1968a4ba038SMichal Meloun gpio_pin_setflags(gpio_pin_t pin, uint32_t flags) 1978a4ba038SMichal Meloun { 1988a4ba038SMichal Meloun int rv; 1998a4ba038SMichal Meloun 2008a4ba038SMichal Meloun KASSERT(pin != NULL, ("GPIO pin is NULL.")); 2018a4ba038SMichal Meloun KASSERT(pin->dev != NULL, ("GPIO pin device is NULL.")); 2028a4ba038SMichal Meloun 2038a4ba038SMichal Meloun rv = GPIO_PIN_SETFLAGS(pin->dev, pin->pin, flags); 2048a4ba038SMichal Meloun return (rv); 2058a4ba038SMichal Meloun } 2068a4ba038SMichal Meloun 2078a4ba038SMichal Meloun /* 2088a4ba038SMichal Meloun * OFW_GPIOBUS driver. 2098a4ba038SMichal Meloun */ 2106d866ed3SLuiz Otavio O Souza device_t 211e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_add_fdt_child(device_t bus, const char *drvname, phandle_t child) 2126d866ed3SLuiz Otavio O Souza { 2136d866ed3SLuiz Otavio O Souza device_t childdev; 214d752f0f6SLuiz Otavio O Souza int i; 215d752f0f6SLuiz Otavio O Souza struct gpiobus_ivar *devi; 216e8da3e8aSLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 2176d866ed3SLuiz Otavio O Souza 2186d866ed3SLuiz Otavio O Souza /* 2193dede9f3SWarner Losh * Check to see if we already have a child for @p child, and if so 2203dede9f3SWarner Losh * return it. 2213dede9f3SWarner Losh */ 2223dede9f3SWarner Losh childdev = ofw_bus_find_child_device_by_phandle(bus, child); 2233dede9f3SWarner Losh if (childdev != NULL) 2243dede9f3SWarner Losh return (childdev); 2253dede9f3SWarner Losh 2263dede9f3SWarner Losh /* 2276d866ed3SLuiz Otavio O Souza * Set up the GPIO child and OFW bus layer devinfo and add it to bus. 2286d866ed3SLuiz Otavio O Souza */ 229e8da3e8aSLuiz Otavio O Souza childdev = device_add_child(bus, drvname, -1); 230e8da3e8aSLuiz Otavio O Souza if (childdev == NULL) 2316d866ed3SLuiz Otavio O Souza return (NULL); 232e8da3e8aSLuiz Otavio O Souza dinfo = ofw_gpiobus_setup_devinfo(bus, childdev, child); 233e8da3e8aSLuiz Otavio O Souza if (dinfo == NULL) { 234e8da3e8aSLuiz Otavio O Souza device_delete_child(bus, childdev); 2356d866ed3SLuiz Otavio O Souza return (NULL); 2366d866ed3SLuiz Otavio O Souza } 237e8da3e8aSLuiz Otavio O Souza if (device_probe_and_attach(childdev) != 0) { 2386ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 239e8da3e8aSLuiz Otavio O Souza device_delete_child(bus, childdev); 240e8da3e8aSLuiz Otavio O Souza return (NULL); 241e8da3e8aSLuiz Otavio O Souza } 242d752f0f6SLuiz Otavio O Souza /* Use the child name as pin name. */ 243d752f0f6SLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 244d752f0f6SLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) 245d752f0f6SLuiz Otavio O Souza GPIOBUS_PIN_SETNAME(bus, devi->pins[i], 246d752f0f6SLuiz Otavio O Souza device_get_nameunit(childdev)); 2476d866ed3SLuiz Otavio O Souza 2486d866ed3SLuiz Otavio O Souza return (childdev); 2496d866ed3SLuiz Otavio O Souza } 2506d866ed3SLuiz Otavio O Souza 251e8da3e8aSLuiz Otavio O Souza int 252e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_parse_gpios(device_t consumer, char *pname, 253e8da3e8aSLuiz Otavio O Souza struct gpiobus_pin **pins) 2546d866ed3SLuiz Otavio O Souza { 2556d866ed3SLuiz Otavio O Souza 256e8da3e8aSLuiz Otavio O Souza return (ofw_gpiobus_parse_gpios_impl(consumer, 257e8da3e8aSLuiz Otavio O Souza ofw_bus_get_node(consumer), pname, NULL, pins)); 2586d866ed3SLuiz Otavio O Souza } 2596d866ed3SLuiz Otavio O Souza 260dbdb1205SLuiz Otavio O Souza void 261dbdb1205SLuiz Otavio O Souza ofw_gpiobus_register_provider(device_t provider) 262dbdb1205SLuiz Otavio O Souza { 263dbdb1205SLuiz Otavio O Souza phandle_t node; 264dbdb1205SLuiz Otavio O Souza 265dbdb1205SLuiz Otavio O Souza node = ofw_bus_get_node(provider); 266dbdb1205SLuiz Otavio O Souza OF_device_register_xref(OF_xref_from_node(node), provider); 267dbdb1205SLuiz Otavio O Souza } 268dbdb1205SLuiz Otavio O Souza 269dbdb1205SLuiz Otavio O Souza void 270dbdb1205SLuiz Otavio O Souza ofw_gpiobus_unregister_provider(device_t provider) 271dbdb1205SLuiz Otavio O Souza { 272dbdb1205SLuiz Otavio O Souza phandle_t node; 273dbdb1205SLuiz Otavio O Souza 274dbdb1205SLuiz Otavio O Souza node = ofw_bus_get_node(provider); 275dbdb1205SLuiz Otavio O Souza OF_device_register_xref(OF_xref_from_node(node), NULL); 276dbdb1205SLuiz Otavio O Souza } 277dbdb1205SLuiz Otavio O Souza 2786d866ed3SLuiz Otavio O Souza static struct ofw_gpiobus_devinfo * 279e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_setup_devinfo(device_t bus, device_t child, phandle_t node) 2806d866ed3SLuiz Otavio O Souza { 281e8da3e8aSLuiz Otavio O Souza int i, npins; 282e8da3e8aSLuiz Otavio O Souza struct gpiobus_ivar *devi; 283e8da3e8aSLuiz Otavio O Souza struct gpiobus_pin *pins; 2846d866ed3SLuiz Otavio O Souza struct gpiobus_softc *sc; 2856d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 2866d866ed3SLuiz Otavio O Souza 287e8da3e8aSLuiz Otavio O Souza sc = device_get_softc(bus); 2886d866ed3SLuiz Otavio O Souza dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_NOWAIT | M_ZERO); 2896d866ed3SLuiz Otavio O Souza if (dinfo == NULL) 2906d866ed3SLuiz Otavio O Souza return (NULL); 2916d866ed3SLuiz Otavio O Souza if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, node) != 0) { 2926d866ed3SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 2936d866ed3SLuiz Otavio O Souza return (NULL); 2946d866ed3SLuiz Otavio O Souza } 2956d866ed3SLuiz Otavio O Souza /* Parse the gpios property for the child. */ 296e8da3e8aSLuiz Otavio O Souza npins = ofw_gpiobus_parse_gpios_impl(child, node, "gpios", sc, &pins); 2976ad7f491SLuiz Otavio O Souza if (npins <= 0) { 2986ad7f491SLuiz Otavio O Souza ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo); 2996ad7f491SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 3006ad7f491SLuiz Otavio O Souza return (NULL); 3016ad7f491SLuiz Otavio O Souza } 3026ad7f491SLuiz Otavio O Souza /* Initialize the irq resource list. */ 3036ad7f491SLuiz Otavio O Souza resource_list_init(&dinfo->opd_dinfo.rl); 3046ad7f491SLuiz Otavio O Souza /* Allocate the child ivars and copy the parsed pin data. */ 305e8da3e8aSLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 306e8da3e8aSLuiz Otavio O Souza devi->npins = (uint32_t)npins; 307e8da3e8aSLuiz Otavio O Souza if (gpiobus_alloc_ivars(devi) != 0) { 308e8da3e8aSLuiz Otavio O Souza free(pins, M_DEVBUF); 3096ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 3106ad7f491SLuiz Otavio O Souza return (NULL); 3116d866ed3SLuiz Otavio O Souza } 312e8da3e8aSLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) { 313e8da3e8aSLuiz Otavio O Souza devi->flags[i] = pins[i].flags; 314e8da3e8aSLuiz Otavio O Souza devi->pins[i] = pins[i].pin; 315e8da3e8aSLuiz Otavio O Souza } 316e8da3e8aSLuiz Otavio O Souza free(pins, M_DEVBUF); 3176ad7f491SLuiz Otavio O Souza /* Parse the interrupt resources. */ 318a8c5ea04SRuslan Bukin if (ofw_bus_intr_to_rl(bus, node, &dinfo->opd_dinfo.rl, NULL) != 0) { 3196ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(bus, dinfo); 3206ad7f491SLuiz Otavio O Souza return (NULL); 321e8da3e8aSLuiz Otavio O Souza } 322e8da3e8aSLuiz Otavio O Souza device_set_ivars(child, dinfo); 323e8da3e8aSLuiz Otavio O Souza 324e8da3e8aSLuiz Otavio O Souza return (dinfo); 325138bf909SLuiz Otavio O Souza } 3266d866ed3SLuiz Otavio O Souza 3276d866ed3SLuiz Otavio O Souza static void 3286ad7f491SLuiz Otavio O Souza ofw_gpiobus_destroy_devinfo(device_t bus, struct ofw_gpiobus_devinfo *dinfo) 3296d866ed3SLuiz Otavio O Souza { 3306ad7f491SLuiz Otavio O Souza int i; 331e8da3e8aSLuiz Otavio O Souza struct gpiobus_ivar *devi; 3326ad7f491SLuiz Otavio O Souza struct gpiobus_softc *sc; 3336d866ed3SLuiz Otavio O Souza 3346ad7f491SLuiz Otavio O Souza sc = device_get_softc(bus); 335e8da3e8aSLuiz Otavio O Souza devi = &dinfo->opd_dinfo; 3366ad7f491SLuiz Otavio O Souza for (i = 0; i < devi->npins; i++) { 3376ad7f491SLuiz Otavio O Souza if (devi->pins[i] > sc->sc_npins) 3386ad7f491SLuiz Otavio O Souza continue; 339d752f0f6SLuiz Otavio O Souza sc->sc_pins[devi->pins[i]].mapped = 0; 3406ad7f491SLuiz Otavio O Souza } 341e8da3e8aSLuiz Otavio O Souza gpiobus_free_ivars(devi); 342138bf909SLuiz Otavio O Souza resource_list_free(&dinfo->opd_dinfo.rl); 3436d866ed3SLuiz Otavio O Souza ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo); 3446d866ed3SLuiz Otavio O Souza free(dinfo, M_DEVBUF); 3456d866ed3SLuiz Otavio O Souza } 3466d866ed3SLuiz Otavio O Souza 3476d866ed3SLuiz Otavio O Souza static int 348e8da3e8aSLuiz Otavio O Souza ofw_gpiobus_parse_gpios_impl(device_t consumer, phandle_t cnode, char *pname, 349e8da3e8aSLuiz Otavio O Souza struct gpiobus_softc *bussc, struct gpiobus_pin **pins) 350e8da3e8aSLuiz Otavio O Souza { 351e8da3e8aSLuiz Otavio O Souza int gpiocells, i, j, ncells, npins; 352e8da3e8aSLuiz Otavio O Souza pcell_t *gpios; 353e8da3e8aSLuiz Otavio O Souza phandle_t gpio; 354e8da3e8aSLuiz Otavio O Souza 355e8da3e8aSLuiz Otavio O Souza ncells = OF_getencprop_alloc(cnode, pname, sizeof(*gpios), 356e8da3e8aSLuiz Otavio O Souza (void **)&gpios); 357e8da3e8aSLuiz Otavio O Souza if (ncells == -1) { 358e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 359e8da3e8aSLuiz Otavio O Souza "Warning: No %s specified in fdt data; " 360e8da3e8aSLuiz Otavio O Souza "device may not function.\n", pname); 361e8da3e8aSLuiz Otavio O Souza return (-1); 362e8da3e8aSLuiz Otavio O Souza } 363e8da3e8aSLuiz Otavio O Souza /* 364e8da3e8aSLuiz Otavio O Souza * The gpio-specifier is controller independent, the first pcell has 365e8da3e8aSLuiz Otavio O Souza * the reference to the GPIO controller phandler. 366e8da3e8aSLuiz Otavio O Souza * Count the number of encoded gpio-specifiers on the first pass. 367e8da3e8aSLuiz Otavio O Souza */ 368e8da3e8aSLuiz Otavio O Souza i = 0; 369e8da3e8aSLuiz Otavio O Souza npins = 0; 370e8da3e8aSLuiz Otavio O Souza while (i < ncells) { 371e8da3e8aSLuiz Otavio O Souza /* Allow NULL specifiers. */ 372e8da3e8aSLuiz Otavio O Souza if (gpios[i] == 0) { 373e8da3e8aSLuiz Otavio O Souza npins++; 374e8da3e8aSLuiz Otavio O Souza i++; 375e8da3e8aSLuiz Otavio O Souza continue; 376e8da3e8aSLuiz Otavio O Souza } 377e8da3e8aSLuiz Otavio O Souza gpio = OF_node_from_xref(gpios[i]); 378e8da3e8aSLuiz Otavio O Souza /* If we have bussc, ignore devices from other gpios. */ 379e8da3e8aSLuiz Otavio O Souza if (bussc != NULL) 380e8da3e8aSLuiz Otavio O Souza if (ofw_bus_get_node(bussc->sc_dev) != gpio) 381e8da3e8aSLuiz Otavio O Souza return (0); 382e8da3e8aSLuiz Otavio O Souza /* 383e8da3e8aSLuiz Otavio O Souza * Check for gpio-controller property and read the #gpio-cells 384e8da3e8aSLuiz Otavio O Souza * for this GPIO controller. 385e8da3e8aSLuiz Otavio O Souza */ 386e8da3e8aSLuiz Otavio O Souza if (!OF_hasprop(gpio, "gpio-controller") || 387e8da3e8aSLuiz Otavio O Souza OF_getencprop(gpio, "#gpio-cells", &gpiocells, 388e8da3e8aSLuiz Otavio O Souza sizeof(gpiocells)) < 0) { 389e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 390e8da3e8aSLuiz Otavio O Souza "gpio reference is not a gpio-controller.\n"); 391e8da3e8aSLuiz Otavio O Souza free(gpios, M_OFWPROP); 392e8da3e8aSLuiz Otavio O Souza return (-1); 393e8da3e8aSLuiz Otavio O Souza } 394e8da3e8aSLuiz Otavio O Souza if (ncells - i < gpiocells + 1) { 395e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 396e8da3e8aSLuiz Otavio O Souza "%s cells doesn't match #gpio-cells.\n", pname); 397e8da3e8aSLuiz Otavio O Souza return (-1); 398e8da3e8aSLuiz Otavio O Souza } 399e8da3e8aSLuiz Otavio O Souza npins++; 400e8da3e8aSLuiz Otavio O Souza i += gpiocells + 1; 401e8da3e8aSLuiz Otavio O Souza } 402e8da3e8aSLuiz Otavio O Souza if (npins == 0 || pins == NULL) { 403e8da3e8aSLuiz Otavio O Souza if (npins == 0) 404e8da3e8aSLuiz Otavio O Souza device_printf(consumer, "no pin specified in %s.\n", 405e8da3e8aSLuiz Otavio O Souza pname); 406e8da3e8aSLuiz Otavio O Souza free(gpios, M_OFWPROP); 407e8da3e8aSLuiz Otavio O Souza return (npins); 408e8da3e8aSLuiz Otavio O Souza } 409e8da3e8aSLuiz Otavio O Souza *pins = malloc(sizeof(struct gpiobus_pin) * npins, M_DEVBUF, 410e8da3e8aSLuiz Otavio O Souza M_NOWAIT | M_ZERO); 411e8da3e8aSLuiz Otavio O Souza if (*pins == NULL) { 412e8da3e8aSLuiz Otavio O Souza free(gpios, M_OFWPROP); 413e8da3e8aSLuiz Otavio O Souza return (-1); 414e8da3e8aSLuiz Otavio O Souza } 415e8da3e8aSLuiz Otavio O Souza /* Decode the gpio specifier on the second pass. */ 416e8da3e8aSLuiz Otavio O Souza i = 0; 417e8da3e8aSLuiz Otavio O Souza j = 0; 418e8da3e8aSLuiz Otavio O Souza while (i < ncells) { 419e8da3e8aSLuiz Otavio O Souza /* Allow NULL specifiers. */ 420e8da3e8aSLuiz Otavio O Souza if (gpios[i] == 0) { 421e8da3e8aSLuiz Otavio O Souza j++; 422e8da3e8aSLuiz Otavio O Souza i++; 423e8da3e8aSLuiz Otavio O Souza continue; 424e8da3e8aSLuiz Otavio O Souza } 425e8da3e8aSLuiz Otavio O Souza gpio = OF_node_from_xref(gpios[i]); 426e8da3e8aSLuiz Otavio O Souza /* Read gpio-cells property for this GPIO controller. */ 427e8da3e8aSLuiz Otavio O Souza if (OF_getencprop(gpio, "#gpio-cells", &gpiocells, 428e8da3e8aSLuiz Otavio O Souza sizeof(gpiocells)) < 0) { 429e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 430e8da3e8aSLuiz Otavio O Souza "gpio does not have the #gpio-cells property.\n"); 431e8da3e8aSLuiz Otavio O Souza goto fail; 432e8da3e8aSLuiz Otavio O Souza } 433e8da3e8aSLuiz Otavio O Souza /* Return the device reference for the GPIO controller. */ 434e8da3e8aSLuiz Otavio O Souza (*pins)[j].dev = OF_device_from_xref(gpios[i]); 435e8da3e8aSLuiz Otavio O Souza if ((*pins)[j].dev == NULL) { 436e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 437e8da3e8aSLuiz Otavio O Souza "no device registered for the gpio controller.\n"); 438e8da3e8aSLuiz Otavio O Souza goto fail; 439e8da3e8aSLuiz Otavio O Souza } 440e8da3e8aSLuiz Otavio O Souza /* 441e8da3e8aSLuiz Otavio O Souza * If the gpiobus softc is NULL we use the GPIO_GET_BUS() to 442e8da3e8aSLuiz Otavio O Souza * retrieve it. The GPIO_GET_BUS() method is only valid after 443e8da3e8aSLuiz Otavio O Souza * the child is probed and attached. 444e8da3e8aSLuiz Otavio O Souza */ 445e8da3e8aSLuiz Otavio O Souza if (bussc == NULL) { 446e8da3e8aSLuiz Otavio O Souza if (GPIO_GET_BUS((*pins)[j].dev) == NULL) { 447e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 448e8da3e8aSLuiz Otavio O Souza "no gpiobus reference for %s.\n", 449e8da3e8aSLuiz Otavio O Souza device_get_nameunit((*pins)[j].dev)); 450e8da3e8aSLuiz Otavio O Souza goto fail; 451e8da3e8aSLuiz Otavio O Souza } 452e8da3e8aSLuiz Otavio O Souza bussc = device_get_softc(GPIO_GET_BUS((*pins)[j].dev)); 453e8da3e8aSLuiz Otavio O Souza } 454e8da3e8aSLuiz Otavio O Souza /* Get the GPIO pin number and flags. */ 455e8da3e8aSLuiz Otavio O Souza if (gpio_map_gpios((*pins)[j].dev, cnode, gpio, gpiocells, 456e8da3e8aSLuiz Otavio O Souza &gpios[i + 1], &(*pins)[j].pin, &(*pins)[j].flags) != 0) { 457e8da3e8aSLuiz Otavio O Souza device_printf(consumer, 458e8da3e8aSLuiz Otavio O Souza "cannot map the gpios specifier.\n"); 459e8da3e8aSLuiz Otavio O Souza goto fail; 460e8da3e8aSLuiz Otavio O Souza } 461da3b488dSLuiz Otavio O Souza /* Reserve the GPIO pin. */ 4626153d465SLuiz Otavio O Souza if (gpiobus_map_pin(bussc->sc_busdev, (*pins)[j].pin) != 0) 463e8da3e8aSLuiz Otavio O Souza goto fail; 464e8da3e8aSLuiz Otavio O Souza j++; 465e8da3e8aSLuiz Otavio O Souza i += gpiocells + 1; 466e8da3e8aSLuiz Otavio O Souza } 467e8da3e8aSLuiz Otavio O Souza free(gpios, M_OFWPROP); 468e8da3e8aSLuiz Otavio O Souza 469e8da3e8aSLuiz Otavio O Souza return (npins); 470e8da3e8aSLuiz Otavio O Souza 471e8da3e8aSLuiz Otavio O Souza fail: 472e8da3e8aSLuiz Otavio O Souza free(gpios, M_OFWPROP); 473e8da3e8aSLuiz Otavio O Souza free(*pins, M_DEVBUF); 474e8da3e8aSLuiz Otavio O Souza return (-1); 475e8da3e8aSLuiz Otavio O Souza } 476e8da3e8aSLuiz Otavio O Souza 477e8da3e8aSLuiz Otavio O Souza static int 4786d866ed3SLuiz Otavio O Souza ofw_gpiobus_probe(device_t dev) 4796d866ed3SLuiz Otavio O Souza { 4806d866ed3SLuiz Otavio O Souza 4816d866ed3SLuiz Otavio O Souza if (ofw_bus_get_node(dev) == -1) 4826d866ed3SLuiz Otavio O Souza return (ENXIO); 4836d866ed3SLuiz Otavio O Souza device_set_desc(dev, "OFW GPIO bus"); 4846d866ed3SLuiz Otavio O Souza 4856d866ed3SLuiz Otavio O Souza return (0); 4866d866ed3SLuiz Otavio O Souza } 4876d866ed3SLuiz Otavio O Souza 4886d866ed3SLuiz Otavio O Souza static int 4896d866ed3SLuiz Otavio O Souza ofw_gpiobus_attach(device_t dev) 4906d866ed3SLuiz Otavio O Souza { 49188516632SLuiz Otavio O Souza int err; 4926d866ed3SLuiz Otavio O Souza phandle_t child; 4936d866ed3SLuiz Otavio O Souza 49488516632SLuiz Otavio O Souza err = gpiobus_init_softc(dev); 49588516632SLuiz Otavio O Souza if (err != 0) 49688516632SLuiz Otavio O Souza return (err); 4976d866ed3SLuiz Otavio O Souza bus_generic_probe(dev); 4986d866ed3SLuiz Otavio O Souza bus_enumerate_hinted_children(dev); 4996d866ed3SLuiz Otavio O Souza /* 5006d866ed3SLuiz Otavio O Souza * Attach the children represented in the device tree. 5016d866ed3SLuiz Otavio O Souza */ 5026d866ed3SLuiz Otavio O Souza for (child = OF_child(ofw_bus_get_node(dev)); child != 0; 503e8da3e8aSLuiz Otavio O Souza child = OF_peer(child)) { 504e8da3e8aSLuiz Otavio O Souza if (!OF_hasprop(child, "gpios")) 5056d866ed3SLuiz Otavio O Souza continue; 506e8da3e8aSLuiz Otavio O Souza if (ofw_gpiobus_add_fdt_child(dev, NULL, child) == NULL) 507e8da3e8aSLuiz Otavio O Souza continue; 508e8da3e8aSLuiz Otavio O Souza } 5096d866ed3SLuiz Otavio O Souza 5106d866ed3SLuiz Otavio O Souza return (bus_generic_attach(dev)); 5116d866ed3SLuiz Otavio O Souza } 5126d866ed3SLuiz Otavio O Souza 5136d866ed3SLuiz Otavio O Souza static device_t 5146d866ed3SLuiz Otavio O Souza ofw_gpiobus_add_child(device_t dev, u_int order, const char *name, int unit) 5156d866ed3SLuiz Otavio O Souza { 5166d866ed3SLuiz Otavio O Souza device_t child; 5176d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *devi; 5186d866ed3SLuiz Otavio O Souza 5196d866ed3SLuiz Otavio O Souza child = device_add_child_ordered(dev, order, name, unit); 5206d866ed3SLuiz Otavio O Souza if (child == NULL) 5216d866ed3SLuiz Otavio O Souza return (child); 5226d866ed3SLuiz Otavio O Souza devi = malloc(sizeof(struct ofw_gpiobus_devinfo), M_DEVBUF, 5236d866ed3SLuiz Otavio O Souza M_NOWAIT | M_ZERO); 5246d866ed3SLuiz Otavio O Souza if (devi == NULL) { 5256d866ed3SLuiz Otavio O Souza device_delete_child(dev, child); 5266d866ed3SLuiz Otavio O Souza return (0); 5276d866ed3SLuiz Otavio O Souza } 5286d866ed3SLuiz Otavio O Souza 5296d866ed3SLuiz Otavio O Souza /* 5306d866ed3SLuiz Otavio O Souza * NULL all the OFW-related parts of the ivars for non-OFW 5316d866ed3SLuiz Otavio O Souza * children. 5326d866ed3SLuiz Otavio O Souza */ 5336d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_node = -1; 5346d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_name = NULL; 5356d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_compat = NULL; 5366d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_type = NULL; 5376d866ed3SLuiz Otavio O Souza devi->opd_obdinfo.obd_model = NULL; 5386d866ed3SLuiz Otavio O Souza 5396d866ed3SLuiz Otavio O Souza device_set_ivars(child, devi); 5406d866ed3SLuiz Otavio O Souza 5416d866ed3SLuiz Otavio O Souza return (child); 5426d866ed3SLuiz Otavio O Souza } 5436d866ed3SLuiz Otavio O Souza 5446d866ed3SLuiz Otavio O Souza static const struct ofw_bus_devinfo * 5456d866ed3SLuiz Otavio O Souza ofw_gpiobus_get_devinfo(device_t bus, device_t dev) 5466d866ed3SLuiz Otavio O Souza { 5476d866ed3SLuiz Otavio O Souza struct ofw_gpiobus_devinfo *dinfo; 5486d866ed3SLuiz Otavio O Souza 5496d866ed3SLuiz Otavio O Souza dinfo = device_get_ivars(dev); 5506d866ed3SLuiz Otavio O Souza 5516d866ed3SLuiz Otavio O Souza return (&dinfo->opd_obdinfo); 5526d866ed3SLuiz Otavio O Souza } 5536d866ed3SLuiz Otavio O Souza 5546d866ed3SLuiz Otavio O Souza static device_method_t ofw_gpiobus_methods[] = { 5556d866ed3SLuiz Otavio O Souza /* Device interface */ 5566d866ed3SLuiz Otavio O Souza DEVMETHOD(device_probe, ofw_gpiobus_probe), 5576d866ed3SLuiz Otavio O Souza DEVMETHOD(device_attach, ofw_gpiobus_attach), 5586d866ed3SLuiz Otavio O Souza 5596d866ed3SLuiz Otavio O Souza /* Bus interface */ 5606d866ed3SLuiz Otavio O Souza DEVMETHOD(bus_child_pnpinfo_str, ofw_bus_gen_child_pnpinfo_str), 5616d866ed3SLuiz Otavio O Souza DEVMETHOD(bus_add_child, ofw_gpiobus_add_child), 5626d866ed3SLuiz Otavio O Souza 5636d866ed3SLuiz Otavio O Souza /* ofw_bus interface */ 5646d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_devinfo, ofw_gpiobus_get_devinfo), 5656d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_compat, ofw_bus_gen_get_compat), 5666d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_model, ofw_bus_gen_get_model), 5676d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_name, ofw_bus_gen_get_name), 5686d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_node, ofw_bus_gen_get_node), 5696d866ed3SLuiz Otavio O Souza DEVMETHOD(ofw_bus_get_type, ofw_bus_gen_get_type), 5706d866ed3SLuiz Otavio O Souza 5716d866ed3SLuiz Otavio O Souza DEVMETHOD_END 5726d866ed3SLuiz Otavio O Souza }; 5736d866ed3SLuiz Otavio O Souza 5746d866ed3SLuiz Otavio O Souza static devclass_t ofwgpiobus_devclass; 5756d866ed3SLuiz Otavio O Souza 5766d866ed3SLuiz Otavio O Souza DEFINE_CLASS_1(gpiobus, ofw_gpiobus_driver, ofw_gpiobus_methods, 5776d866ed3SLuiz Otavio O Souza sizeof(struct gpiobus_softc), gpiobus_driver); 57812bc2abbSMichal Meloun EARLY_DRIVER_MODULE(ofw_gpiobus, gpio, ofw_gpiobus_driver, ofwgpiobus_devclass, 57912bc2abbSMichal Meloun 0, 0, BUS_PASS_BUS); 5806d866ed3SLuiz Otavio O Souza MODULE_VERSION(ofw_gpiobus, 1); 5816d866ed3SLuiz Otavio O Souza MODULE_DEPEND(ofw_gpiobus, gpiobus, 1, 1, 1); 582