source: rtems-libbsd/freebsd/sys/dev/gpio/ofw_gpiobus.c @ 847de24

55-freebsd-126-freebsd-12
Last change on this file since 847de24 was 847de24, checked in by Sebastian Huber <sebastian.huber@…>, on Nov 10, 2017 at 12:32:14 PM

Fix build for non-FDT platforms

  • Property mode set to 100644
File size: 15.0 KB
Line 
1#include <machine/rtems-bsd-kernel-space.h>
2
3/*-
4 * Copyright (c) 2009, Nathan Whitehorn <nwhitehorn@FreeBSD.org>
5 * Copyright (c) 2013, Luiz Otavio O Souza <loos@FreeBSD.org>
6 * Copyright (c) 2013 The FreeBSD Foundation
7 * All rights reserved.
8 *
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
11 * are met:
12 * 1. Redistributions of source code must retain the above copyright
13 *    notice unmodified, this list of conditions, and the following
14 *    disclaimer.
15 * 2. Redistributions in binary form must reproduce the above copyright
16 *    notice, this list of conditions and the following disclaimer in the
17 *    documentation and/or other materials provided with the distribution.
18 *
19 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
20 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
21 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
22 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
23 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
24 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
28 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#include <sys/cdefs.h>
32__FBSDID("$FreeBSD$");
33
34#include <sys/param.h>
35#include <sys/systm.h>
36#include <sys/bus.h>
37#include <sys/kernel.h>
38#include <sys/malloc.h>
39#include <sys/module.h>
40
41#ifdef __rtems__
42#include <rtems/bsd/local/opt_platform.h>
43#endif /* __rtems__ */
44#if defined(__rtems__) && defined(FDT)
45#include <dev/gpio/gpiobusvar.h>
46#include <dev/ofw/ofw_bus.h>
47
48#include <rtems/bsd/local/gpiobus_if.h>
49
50#define GPIO_ACTIVE_LOW         1
51
52static struct ofw_gpiobus_devinfo *ofw_gpiobus_setup_devinfo(device_t,
53        device_t, phandle_t);
54static void ofw_gpiobus_destroy_devinfo(device_t, struct ofw_gpiobus_devinfo *);
55static int ofw_gpiobus_parse_gpios_impl(device_t, phandle_t, char *,
56        struct gpiobus_softc *, struct gpiobus_pin **);
57
58/*
59 * Utility functions for easier handling of OFW GPIO pins.
60 *
61 * !!! BEWARE !!!
62 * GPIOBUS uses children's IVARs, so we cannot use this interface for cross
63 * tree consumers.
64 *
65 */
66static int
67gpio_pin_get_by_ofw_impl(device_t consumer, phandle_t cnode,
68    char *prop_name, int idx, gpio_pin_t *out_pin)
69{
70        phandle_t xref;
71        pcell_t *cells;
72        device_t busdev;
73        struct gpiobus_pin pin;
74        int ncells, rv;
75
76        KASSERT(consumer != NULL && cnode > 0,
77            ("both consumer and cnode required"));
78
79        rv = ofw_bus_parse_xref_list_alloc(cnode, prop_name, "#gpio-cells",
80            idx, &xref, &ncells, &cells);
81        if (rv != 0)
82                return (rv);
83
84        /* Translate provider to device. */
85        pin.dev = OF_device_from_xref(xref);
86        if (pin.dev == NULL) {
87                OF_prop_free(cells);
88                return (ENODEV);
89        }
90
91        /* Test if GPIO bus already exist. */
92        busdev = GPIO_GET_BUS(pin.dev);
93        if (busdev == NULL) {
94                OF_prop_free(cells);
95                return (ENODEV);
96        }
97
98        /* Map GPIO pin. */
99        rv = gpio_map_gpios(pin.dev, cnode, OF_node_from_xref(xref), ncells,
100            cells, &pin.pin, &pin.flags);
101        OF_prop_free(cells);
102        if (rv != 0)
103                return (ENXIO);
104
105        /* Reserve GPIO pin. */
106        rv = gpiobus_acquire_pin(busdev, pin.pin);
107        if (rv != 0)
108                return (EBUSY);
109
110        *out_pin = malloc(sizeof(struct gpiobus_pin), M_DEVBUF,
111            M_WAITOK | M_ZERO);
112        **out_pin = pin;
113        return (0);
114}
115
116int
117gpio_pin_get_by_ofw_idx(device_t consumer, phandle_t node,
118    int idx, gpio_pin_t *pin)
119{
120
121        return (gpio_pin_get_by_ofw_impl(consumer, node, "gpios", idx, pin));
122}
123
124int
125gpio_pin_get_by_ofw_property(device_t consumer, phandle_t node,
126    char *name, gpio_pin_t *pin)
127{
128
129        return (gpio_pin_get_by_ofw_impl(consumer, node, name, 0, pin));
130}
131
132int
133gpio_pin_get_by_ofw_name(device_t consumer, phandle_t node,
134    char *name, gpio_pin_t *pin)
135{
136        int rv, idx;
137
138        KASSERT(consumer != NULL && node > 0,
139            ("both consumer and node required"));
140
141        rv = ofw_bus_find_string_index(node, "gpio-names", name, &idx);
142        if (rv != 0)
143                return (rv);
144        return (gpio_pin_get_by_ofw_idx(consumer, node, idx, pin));
145}
146
147void
148gpio_pin_release(gpio_pin_t gpio)
149{
150        device_t busdev;
151
152        if (gpio == NULL)
153                return;
154
155        KASSERT(gpio->dev != NULL, ("invalid pin state"));
156
157        busdev = GPIO_GET_BUS(gpio->dev);
158        if (busdev != NULL)
159                gpiobus_release_pin(busdev, gpio->pin);
160
161        /* XXXX Unreserve pin. */
162        free(gpio, M_DEVBUF);
163}
164
165int
166gpio_pin_getcaps(gpio_pin_t pin, uint32_t *caps)
167{
168
169        KASSERT(pin != NULL, ("GPIO pin is NULL."));
170        KASSERT(pin->dev != NULL, ("GPIO pin device is NULL."));
171        return (GPIO_PIN_GETCAPS(pin->dev, pin->pin, caps));
172}
173
174int
175gpio_pin_is_active(gpio_pin_t pin, bool *active)
176{
177        int rv;
178        uint32_t tmp;
179
180        KASSERT(pin != NULL, ("GPIO pin is NULL."));
181        KASSERT(pin->dev != NULL, ("GPIO pin device is NULL."));
182        rv = GPIO_PIN_GET(pin->dev, pin->pin, &tmp);
183        if (rv  != 0) {
184                return (rv);
185        }
186
187        if (pin->flags & GPIO_ACTIVE_LOW)
188                *active = tmp == 0;
189        else
190                *active = tmp != 0;
191        return (0);
192}
193
194int
195gpio_pin_set_active(gpio_pin_t pin, bool active)
196{
197        int rv;
198        uint32_t tmp;
199
200        if (pin->flags & GPIO_ACTIVE_LOW)
201                tmp = active ? 0 : 1;
202        else
203                tmp = active ? 1 : 0;
204
205        KASSERT(pin != NULL, ("GPIO pin is NULL."));
206        KASSERT(pin->dev != NULL, ("GPIO pin device is NULL."));
207        rv = GPIO_PIN_SET(pin->dev, pin->pin, tmp);
208        return (rv);
209}
210
211int
212gpio_pin_setflags(gpio_pin_t pin, uint32_t flags)
213{
214        int rv;
215
216        KASSERT(pin != NULL, ("GPIO pin is NULL."));
217        KASSERT(pin->dev != NULL, ("GPIO pin device is NULL."));
218
219        rv = GPIO_PIN_SETFLAGS(pin->dev, pin->pin, flags);
220        return (rv);
221}
222
223/*
224 * OFW_GPIOBUS driver.
225 */
226device_t
227ofw_gpiobus_add_fdt_child(device_t bus, const char *drvname, phandle_t child)
228{
229        device_t childdev;
230        int i;
231        struct gpiobus_ivar *devi;
232        struct ofw_gpiobus_devinfo *dinfo;
233
234        /*
235         * Check to see if we already have a child for @p child, and if so
236         * return it.
237         */
238        childdev = ofw_bus_find_child_device_by_phandle(bus, child);
239        if (childdev != NULL)
240                return (childdev);
241
242        /*
243         * Set up the GPIO child and OFW bus layer devinfo and add it to bus.
244         */
245        childdev = device_add_child(bus, drvname, -1);
246        if (childdev == NULL)
247                return (NULL);
248        dinfo = ofw_gpiobus_setup_devinfo(bus, childdev, child);
249        if (dinfo == NULL) {
250                device_delete_child(bus, childdev);
251                return (NULL);
252        }
253        if (device_probe_and_attach(childdev) != 0) {
254                ofw_gpiobus_destroy_devinfo(bus, dinfo);
255                device_delete_child(bus, childdev);
256                return (NULL);
257        }
258        /* Use the child name as pin name. */
259        devi = &dinfo->opd_dinfo;
260        for (i = 0; i < devi->npins; i++)
261                GPIOBUS_PIN_SETNAME(bus, devi->pins[i],
262                    device_get_nameunit(childdev));
263
264        return (childdev);
265}
266
267int
268ofw_gpiobus_parse_gpios(device_t consumer, char *pname,
269        struct gpiobus_pin **pins)
270{
271
272        return (ofw_gpiobus_parse_gpios_impl(consumer,
273            ofw_bus_get_node(consumer), pname, NULL, pins));
274}
275
276void
277ofw_gpiobus_register_provider(device_t provider)
278{
279        phandle_t node;
280
281        node = ofw_bus_get_node(provider);
282        OF_device_register_xref(OF_xref_from_node(node), provider);
283}
284
285void
286ofw_gpiobus_unregister_provider(device_t provider)
287{
288        phandle_t node;
289
290        node = ofw_bus_get_node(provider);
291        OF_device_register_xref(OF_xref_from_node(node), NULL);
292}
293
294static struct ofw_gpiobus_devinfo *
295ofw_gpiobus_setup_devinfo(device_t bus, device_t child, phandle_t node)
296{
297        int i, npins;
298        struct gpiobus_ivar *devi;
299        struct gpiobus_pin *pins;
300        struct gpiobus_softc *sc;
301        struct ofw_gpiobus_devinfo *dinfo;
302
303        sc = device_get_softc(bus);
304        dinfo = malloc(sizeof(*dinfo), M_DEVBUF, M_NOWAIT | M_ZERO);
305        if (dinfo == NULL)
306                return (NULL);
307        if (ofw_bus_gen_setup_devinfo(&dinfo->opd_obdinfo, node) != 0) {
308                free(dinfo, M_DEVBUF);
309                return (NULL);
310        }
311        /* Parse the gpios property for the child. */
312        npins = ofw_gpiobus_parse_gpios_impl(child, node, "gpios", sc, &pins);
313        if (npins <= 0) {
314                ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo);
315                free(dinfo, M_DEVBUF);
316                return (NULL);
317        }
318        /* Initialize the irq resource list. */
319        resource_list_init(&dinfo->opd_dinfo.rl);
320        /* Allocate the child ivars and copy the parsed pin data. */
321        devi = &dinfo->opd_dinfo;
322        devi->npins = (uint32_t)npins;
323        if (gpiobus_alloc_ivars(devi) != 0) {
324                free(pins, M_DEVBUF);
325                ofw_gpiobus_destroy_devinfo(bus, dinfo);
326                return (NULL);
327        }
328        for (i = 0; i < devi->npins; i++) {
329                devi->flags[i] = pins[i].flags;
330                devi->pins[i] = pins[i].pin;
331        }
332        free(pins, M_DEVBUF);
333        /* Parse the interrupt resources. */
334        if (ofw_bus_intr_to_rl(bus, node, &dinfo->opd_dinfo.rl, NULL) != 0) {
335                ofw_gpiobus_destroy_devinfo(bus, dinfo);
336                return (NULL);
337        }
338        device_set_ivars(child, dinfo);
339
340        return (dinfo);
341}
342
343static void
344ofw_gpiobus_destroy_devinfo(device_t bus, struct ofw_gpiobus_devinfo *dinfo)
345{
346        int i;
347        struct gpiobus_ivar *devi;
348        struct gpiobus_softc *sc;
349
350        sc = device_get_softc(bus);
351        devi = &dinfo->opd_dinfo;
352        for (i = 0; i < devi->npins; i++) {
353                if (devi->pins[i] > sc->sc_npins)
354                        continue;
355                sc->sc_pins[devi->pins[i]].mapped = 0;
356        }
357        gpiobus_free_ivars(devi);
358        resource_list_free(&dinfo->opd_dinfo.rl);
359        ofw_bus_gen_destroy_devinfo(&dinfo->opd_obdinfo);
360        free(dinfo, M_DEVBUF);
361}
362
363static int
364ofw_gpiobus_parse_gpios_impl(device_t consumer, phandle_t cnode, char *pname,
365        struct gpiobus_softc *bussc, struct gpiobus_pin **pins)
366{
367        int gpiocells, i, j, ncells, npins;
368        pcell_t *gpios;
369        phandle_t gpio;
370
371        ncells = OF_getencprop_alloc(cnode, pname, sizeof(*gpios),
372            (void **)&gpios);
373        if (ncells == -1) {
374                device_printf(consumer,
375                    "Warning: No %s specified in fdt data; "
376                    "device may not function.\n", pname);
377                return (-1);
378        }
379        /*
380         * The gpio-specifier is controller independent, the first pcell has
381         * the reference to the GPIO controller phandler.
382         * Count the number of encoded gpio-specifiers on the first pass.
383         */
384        i = 0;
385        npins = 0;
386        while (i < ncells) {
387                /* Allow NULL specifiers. */
388                if (gpios[i] == 0) {
389                        npins++;
390                        i++;
391                        continue;
392                }
393                gpio = OF_node_from_xref(gpios[i]);
394                /* If we have bussc, ignore devices from other gpios. */
395                if (bussc != NULL)
396                        if (ofw_bus_get_node(bussc->sc_dev) != gpio)
397                                return (0);
398                /*
399                 * Check for gpio-controller property and read the #gpio-cells
400                 * for this GPIO controller.
401                 */
402                if (!OF_hasprop(gpio, "gpio-controller") ||
403                    OF_getencprop(gpio, "#gpio-cells", &gpiocells,
404                    sizeof(gpiocells)) < 0) {
405                        device_printf(consumer,
406                            "gpio reference is not a gpio-controller.\n");
407                        OF_prop_free(gpios);
408                        return (-1);
409                }
410                if (ncells - i < gpiocells + 1) {
411                        device_printf(consumer,
412                            "%s cells doesn't match #gpio-cells.\n", pname);
413                        return (-1);
414                }
415                npins++;
416                i += gpiocells + 1;
417        }
418        if (npins == 0 || pins == NULL) {
419                if (npins == 0)
420                        device_printf(consumer, "no pin specified in %s.\n",
421                            pname);
422                OF_prop_free(gpios);
423                return (npins);
424        }
425        *pins = malloc(sizeof(struct gpiobus_pin) * npins, M_DEVBUF,
426            M_NOWAIT | M_ZERO);
427        if (*pins == NULL) {
428                OF_prop_free(gpios);
429                return (-1);
430        }
431        /* Decode the gpio specifier on the second pass. */
432        i = 0;
433        j = 0;
434        while (i < ncells) {
435                /* Allow NULL specifiers. */
436                if (gpios[i] == 0) {
437                        j++;
438                        i++;
439                        continue;
440                }
441                gpio = OF_node_from_xref(gpios[i]);
442                /* Read gpio-cells property for this GPIO controller. */
443                if (OF_getencprop(gpio, "#gpio-cells", &gpiocells,
444                    sizeof(gpiocells)) < 0) {
445                        device_printf(consumer,
446                            "gpio does not have the #gpio-cells property.\n");
447                        goto fail;
448                }
449                /* Return the device reference for the GPIO controller. */
450                (*pins)[j].dev = OF_device_from_xref(gpios[i]);
451                if ((*pins)[j].dev == NULL) {
452                        device_printf(consumer,
453                            "no device registered for the gpio controller.\n");
454                        goto fail;
455                }
456                /*
457                 * If the gpiobus softc is NULL we use the GPIO_GET_BUS() to
458                 * retrieve it.  The GPIO_GET_BUS() method is only valid after
459                 * the child is probed and attached.
460                 */
461                if (bussc == NULL) {
462                        if (GPIO_GET_BUS((*pins)[j].dev) == NULL) {
463                                device_printf(consumer,
464                                    "no gpiobus reference for %s.\n",
465                                    device_get_nameunit((*pins)[j].dev));
466                                goto fail;
467                        }
468                        bussc = device_get_softc(GPIO_GET_BUS((*pins)[j].dev));
469                }
470                /* Get the GPIO pin number and flags. */
471                if (gpio_map_gpios((*pins)[j].dev, cnode, gpio, gpiocells,
472                    &gpios[i + 1], &(*pins)[j].pin, &(*pins)[j].flags) != 0) {
473                        device_printf(consumer,
474                            "cannot map the gpios specifier.\n");
475                        goto fail;
476                }
477                /* Reserve the GPIO pin. */
478                if (gpiobus_acquire_pin(bussc->sc_busdev, (*pins)[j].pin) != 0)
479                        goto fail;
480                j++;
481                i += gpiocells + 1;
482        }
483        OF_prop_free(gpios);
484
485        return (npins);
486
487fail:
488        OF_prop_free(gpios);
489        free(*pins, M_DEVBUF);
490        return (-1);
491}
492
493static int
494ofw_gpiobus_probe(device_t dev)
495{
496
497        if (ofw_bus_get_node(dev) == -1)
498                return (ENXIO);
499        device_set_desc(dev, "OFW GPIO bus");
500
501        return (0);
502}
503
504static int
505ofw_gpiobus_attach(device_t dev)
506{
507        int err;
508        phandle_t child;
509
510        err = gpiobus_init_softc(dev);
511        if (err != 0)
512                return (err);
513        bus_generic_probe(dev);
514        bus_enumerate_hinted_children(dev);
515        /*
516         * Attach the children represented in the device tree.
517         */
518        for (child = OF_child(ofw_bus_get_node(dev)); child != 0;
519            child = OF_peer(child)) {
520                if (!OF_hasprop(child, "gpios"))
521                        continue;
522                if (ofw_gpiobus_add_fdt_child(dev, NULL, child) == NULL)
523                        continue;
524        }
525
526        return (bus_generic_attach(dev));
527}
528
529static device_t
530ofw_gpiobus_add_child(device_t dev, u_int order, const char *name, int unit)
531{
532        device_t child;
533        struct ofw_gpiobus_devinfo *devi;
534
535        child = device_add_child_ordered(dev, order, name, unit);
536        if (child == NULL)
537                return (child);
538        devi = malloc(sizeof(struct ofw_gpiobus_devinfo), M_DEVBUF,
539            M_NOWAIT | M_ZERO);
540        if (devi == NULL) {
541                device_delete_child(dev, child);
542                return (0);
543        }
544
545        /*
546         * NULL all the OFW-related parts of the ivars for non-OFW
547         * children.
548         */
549        devi->opd_obdinfo.obd_node = -1;
550        devi->opd_obdinfo.obd_name = NULL;
551        devi->opd_obdinfo.obd_compat = NULL;
552        devi->opd_obdinfo.obd_type = NULL;
553        devi->opd_obdinfo.obd_model = NULL;
554
555        device_set_ivars(child, devi);
556
557        return (child);
558}
559
560static const struct ofw_bus_devinfo *
561ofw_gpiobus_get_devinfo(device_t bus, device_t dev)
562{
563        struct ofw_gpiobus_devinfo *dinfo;
564
565        dinfo = device_get_ivars(dev);
566
567        return (&dinfo->opd_obdinfo);
568}
569
570static device_method_t ofw_gpiobus_methods[] = {
571        /* Device interface */
572        DEVMETHOD(device_probe,         ofw_gpiobus_probe),
573        DEVMETHOD(device_attach,        ofw_gpiobus_attach),
574
575        /* Bus interface */
576        DEVMETHOD(bus_child_pnpinfo_str,        ofw_bus_gen_child_pnpinfo_str),
577        DEVMETHOD(bus_add_child,        ofw_gpiobus_add_child),
578
579        /* ofw_bus interface */
580        DEVMETHOD(ofw_bus_get_devinfo,  ofw_gpiobus_get_devinfo),
581        DEVMETHOD(ofw_bus_get_compat,   ofw_bus_gen_get_compat),
582        DEVMETHOD(ofw_bus_get_model,    ofw_bus_gen_get_model),
583        DEVMETHOD(ofw_bus_get_name,     ofw_bus_gen_get_name),
584        DEVMETHOD(ofw_bus_get_node,     ofw_bus_gen_get_node),
585        DEVMETHOD(ofw_bus_get_type,     ofw_bus_gen_get_type),
586
587        DEVMETHOD_END
588};
589
590devclass_t ofwgpiobus_devclass;
591
592DEFINE_CLASS_1(gpiobus, ofw_gpiobus_driver, ofw_gpiobus_methods,
593    sizeof(struct gpiobus_softc), gpiobus_driver);
594EARLY_DRIVER_MODULE(ofw_gpiobus, gpio, ofw_gpiobus_driver, ofwgpiobus_devclass,
595    0, 0, BUS_PASS_BUS);
596MODULE_VERSION(ofw_gpiobus, 1);
597MODULE_DEPEND(ofw_gpiobus, gpiobus, 1, 1, 1);
598#endif /* __rtems__ && FDT */
Note: See TracBrowser for help on using the repository browser.