2 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
3 * Copyright (c) 2012 Luiz Otavio O Souza.
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 #include <sys/cdefs.h>
29 __FBSDID("$FreeBSD$");
31 #include <sys/param.h>
32 #include <sys/systm.h>
35 #include <sys/kernel.h>
36 #include <sys/module.h>
39 #include <sys/mutex.h>
41 #include <sys/sysctl.h>
43 #include <machine/bus.h>
44 #include <machine/cpu.h>
45 #include <machine/cpufunc.h>
46 #include <machine/resource.h>
47 #include <machine/fdt.h>
48 #include <machine/intr.h>
50 #include <dev/fdt/fdt_common.h>
51 #include <dev/ofw/ofw_bus.h>
52 #include <dev/ofw/ofw_bus_subr.h>
54 #include <arm/broadcom/bcm2835/bcm2835_gpio.h>
59 #define dprintf(fmt, args...) do { printf("%s(): ", __func__); \
60 printf(fmt,##args); } while (0)
62 #define dprintf(fmt, args...)
65 #define BCM_GPIO_PINS 54
66 #define BCM_GPIO_DEFAULT_CAPS (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | \
67 GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN)
69 struct bcm_gpio_sysctl {
70 struct bcm_gpio_softc *sc;
74 struct bcm_gpio_softc {
77 struct resource * sc_mem_res;
78 struct resource * sc_irq_res;
79 bus_space_tag_t sc_bst;
80 bus_space_handle_t sc_bsh;
84 int sc_ro_pins[BCM_GPIO_PINS];
85 struct gpio_pin sc_gpio_pins[BCM_GPIO_PINS];
86 struct bcm_gpio_sysctl sc_sysctl[BCM_GPIO_PINS];
95 #define BCM_GPIO_LOCK(_sc) mtx_lock(&_sc->sc_mtx)
96 #define BCM_GPIO_UNLOCK(_sc) mtx_unlock(&_sc->sc_mtx)
97 #define BCM_GPIO_LOCK_ASSERT(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
99 #define BCM_GPIO_GPFSEL(_bank) 0x00 + _bank * 4
100 #define BCM_GPIO_GPSET(_bank) 0x1c + _bank * 4
101 #define BCM_GPIO_GPCLR(_bank) 0x28 + _bank * 4
102 #define BCM_GPIO_GPLEV(_bank) 0x34 + _bank * 4
103 #define BCM_GPIO_GPPUD(_bank) 0x94
104 #define BCM_GPIO_GPPUDCLK(_bank) 0x98 + _bank * 4
106 #define BCM_GPIO_WRITE(_sc, _off, _val) \
107 bus_space_write_4(_sc->sc_bst, _sc->sc_bsh, _off, _val)
108 #define BCM_GPIO_READ(_sc, _off) \
109 bus_space_read_4(_sc->sc_bst, _sc->sc_bsh, _off)
112 bcm_gpio_pin_is_ro(struct bcm_gpio_softc *sc, int pin)
116 for (i = 0; i < sc->sc_ro_npins; i++)
117 if (pin == sc->sc_ro_pins[i])
123 bcm_gpio_get_function(struct bcm_gpio_softc *sc, uint32_t pin)
125 uint32_t bank, func, offset;
127 /* Five banks, 10 pins per bank, 3 bits per pin. */
129 offset = (pin - bank * 10) * 3;
132 func = (BCM_GPIO_READ(sc, BCM_GPIO_GPFSEL(bank)) >> offset) & 7;
139 bcm_gpio_func_str(uint32_t nfunc, char *buf, int bufsize)
144 strncpy(buf, "input", bufsize);
146 case BCM_GPIO_OUTPUT:
147 strncpy(buf, "output", bufsize);
150 strncpy(buf, "alt0", bufsize);
153 strncpy(buf, "alt1", bufsize);
156 strncpy(buf, "alt2", bufsize);
159 strncpy(buf, "alt3", bufsize);
162 strncpy(buf, "alt4", bufsize);
165 strncpy(buf, "alt5", bufsize);
168 strncpy(buf, "invalid", bufsize);
173 bcm_gpio_str_func(char *func, uint32_t *nfunc)
176 if (strcasecmp(func, "input") == 0)
177 *nfunc = BCM_GPIO_INPUT;
178 else if (strcasecmp(func, "output") == 0)
179 *nfunc = BCM_GPIO_OUTPUT;
180 else if (strcasecmp(func, "alt0") == 0)
181 *nfunc = BCM_GPIO_ALT0;
182 else if (strcasecmp(func, "alt1") == 0)
183 *nfunc = BCM_GPIO_ALT1;
184 else if (strcasecmp(func, "alt2") == 0)
185 *nfunc = BCM_GPIO_ALT2;
186 else if (strcasecmp(func, "alt3") == 0)
187 *nfunc = BCM_GPIO_ALT3;
188 else if (strcasecmp(func, "alt4") == 0)
189 *nfunc = BCM_GPIO_ALT4;
190 else if (strcasecmp(func, "alt5") == 0)
191 *nfunc = BCM_GPIO_ALT5;
199 bcm_gpio_func_flag(uint32_t nfunc)
204 return (GPIO_PIN_INPUT);
205 case BCM_GPIO_OUTPUT:
206 return (GPIO_PIN_OUTPUT);
212 bcm_gpio_set_function(struct bcm_gpio_softc *sc, uint32_t pin, uint32_t f)
214 uint32_t bank, data, offset;
216 /* Must be called with lock held. */
217 BCM_GPIO_LOCK_ASSERT(sc);
219 /* Five banks, 10 pins per bank, 3 bits per pin. */
221 offset = (pin - bank * 10) * 3;
223 data = BCM_GPIO_READ(sc, BCM_GPIO_GPFSEL(bank));
224 data &= ~(7 << offset);
225 data |= (f << offset);
226 BCM_GPIO_WRITE(sc, BCM_GPIO_GPFSEL(bank), data);
230 bcm_gpio_set_pud(struct bcm_gpio_softc *sc, uint32_t pin, uint32_t state)
232 uint32_t bank, offset;
234 /* Must be called with lock held. */
235 BCM_GPIO_LOCK_ASSERT(sc);
238 offset = pin - 32 * bank;
240 BCM_GPIO_WRITE(sc, BCM_GPIO_GPPUD(0), state);
242 BCM_GPIO_WRITE(sc, BCM_GPIO_GPPUDCLK(bank), (1 << offset));
244 BCM_GPIO_WRITE(sc, BCM_GPIO_GPPUD(0), 0);
245 BCM_GPIO_WRITE(sc, BCM_GPIO_GPPUDCLK(bank), 0);
249 bcm_gpio_set_alternate(device_t dev, uint32_t pin, uint32_t nfunc)
251 struct bcm_gpio_softc *sc;
254 sc = device_get_softc(dev);
257 /* Disable pull-up or pull-down on pin. */
258 bcm_gpio_set_pud(sc, pin, BCM_GPIO_NONE);
260 /* And now set the pin function. */
261 bcm_gpio_set_function(sc, pin, nfunc);
263 /* Update the pin flags. */
264 for (i = 0; i < sc->sc_gpio_npins; i++) {
265 if (sc->sc_gpio_pins[i].gp_pin == pin)
268 if (i < sc->sc_gpio_npins)
269 sc->sc_gpio_pins[i].gp_flags = bcm_gpio_func_flag(nfunc);
275 bcm_gpio_pin_configure(struct bcm_gpio_softc *sc, struct gpio_pin *pin,
282 * Manage input/output.
284 if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
285 pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
286 if (flags & GPIO_PIN_OUTPUT) {
287 pin->gp_flags |= GPIO_PIN_OUTPUT;
288 bcm_gpio_set_function(sc, pin->gp_pin,
291 pin->gp_flags |= GPIO_PIN_INPUT;
292 bcm_gpio_set_function(sc, pin->gp_pin,
297 /* Manage Pull-up/pull-down. */
298 pin->gp_flags &= ~(GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN);
299 if (flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) {
300 if (flags & GPIO_PIN_PULLUP) {
301 pin->gp_flags |= GPIO_PIN_PULLUP;
302 bcm_gpio_set_pud(sc, pin->gp_pin, BCM_GPIO_PULLUP);
304 pin->gp_flags |= GPIO_PIN_PULLDOWN;
305 bcm_gpio_set_pud(sc, pin->gp_pin, BCM_GPIO_PULLDOWN);
308 bcm_gpio_set_pud(sc, pin->gp_pin, BCM_GPIO_NONE);
314 bcm_gpio_pin_max(device_t dev, int *maxpin)
317 *maxpin = BCM_GPIO_PINS - 1;
322 bcm_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
324 struct bcm_gpio_softc *sc = device_get_softc(dev);
327 for (i = 0; i < sc->sc_gpio_npins; i++) {
328 if (sc->sc_gpio_pins[i].gp_pin == pin)
332 if (i >= sc->sc_gpio_npins)
336 *caps = sc->sc_gpio_pins[i].gp_caps;
343 bcm_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
345 struct bcm_gpio_softc *sc = device_get_softc(dev);
348 for (i = 0; i < sc->sc_gpio_npins; i++) {
349 if (sc->sc_gpio_pins[i].gp_pin == pin)
353 if (i >= sc->sc_gpio_npins)
357 *flags = sc->sc_gpio_pins[i].gp_flags;
364 bcm_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
366 struct bcm_gpio_softc *sc = device_get_softc(dev);
369 for (i = 0; i < sc->sc_gpio_npins; i++) {
370 if (sc->sc_gpio_pins[i].gp_pin == pin)
374 if (i >= sc->sc_gpio_npins)
378 memcpy(name, sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME);
385 bcm_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
387 struct bcm_gpio_softc *sc = device_get_softc(dev);
390 for (i = 0; i < sc->sc_gpio_npins; i++) {
391 if (sc->sc_gpio_pins[i].gp_pin == pin)
395 if (i >= sc->sc_gpio_npins)
398 /* We never touch on read-only/reserved pins. */
399 if (bcm_gpio_pin_is_ro(sc, pin))
402 /* Check for unwanted flags. */
403 if ((flags & sc->sc_gpio_pins[i].gp_caps) != flags)
406 /* Can't mix input/output together. */
407 if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
408 (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
411 /* Can't mix pull-up/pull-down together. */
412 if ((flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) ==
413 (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN))
416 bcm_gpio_pin_configure(sc, &sc->sc_gpio_pins[i], flags);
422 bcm_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
424 struct bcm_gpio_softc *sc = device_get_softc(dev);
425 uint32_t bank, offset;
428 for (i = 0; i < sc->sc_gpio_npins; i++) {
429 if (sc->sc_gpio_pins[i].gp_pin == pin)
433 if (i >= sc->sc_gpio_npins)
436 /* We never write to read-only/reserved pins. */
437 if (bcm_gpio_pin_is_ro(sc, pin))
441 offset = pin - 32 * bank;
445 BCM_GPIO_WRITE(sc, BCM_GPIO_GPSET(bank), (1 << offset));
447 BCM_GPIO_WRITE(sc, BCM_GPIO_GPCLR(bank), (1 << offset));
454 bcm_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
456 struct bcm_gpio_softc *sc = device_get_softc(dev);
457 uint32_t bank, offset, reg_data;
460 for (i = 0; i < sc->sc_gpio_npins; i++) {
461 if (sc->sc_gpio_pins[i].gp_pin == pin)
465 if (i >= sc->sc_gpio_npins)
469 offset = pin - 32 * bank;
472 reg_data = BCM_GPIO_READ(sc, BCM_GPIO_GPLEV(bank));
474 *val = (reg_data & (1 << offset)) ? 1 : 0;
480 bcm_gpio_pin_toggle(device_t dev, uint32_t pin)
482 struct bcm_gpio_softc *sc = device_get_softc(dev);
483 uint32_t bank, data, offset;
486 for (i = 0; i < sc->sc_gpio_npins; i++) {
487 if (sc->sc_gpio_pins[i].gp_pin == pin)
491 if (i >= sc->sc_gpio_npins)
494 /* We never write to read-only/reserved pins. */
495 if (bcm_gpio_pin_is_ro(sc, pin))
499 offset = pin - 32 * bank;
502 data = BCM_GPIO_READ(sc, BCM_GPIO_GPLEV(bank));
503 if (data & (1 << offset))
504 BCM_GPIO_WRITE(sc, BCM_GPIO_GPCLR(bank), (1 << offset));
506 BCM_GPIO_WRITE(sc, BCM_GPIO_GPSET(bank), (1 << offset));
513 bcm_gpio_get_ro_pins(struct bcm_gpio_softc *sc)
516 pcell_t pins[BCM_GPIO_PINS];
519 /* Find the gpio node to start. */
520 gpio = ofw_bus_get_node(sc->sc_dev);
522 len = OF_getproplen(gpio, "broadcom,read-only");
523 if (len < 0 || len > sizeof(pins))
526 if (OF_getprop(gpio, "broadcom,read-only", &pins, len) < 0)
529 sc->sc_ro_npins = len / sizeof(pcell_t);
531 device_printf(sc->sc_dev, "read-only pins: ");
532 for (i = 0; i < sc->sc_ro_npins; i++) {
533 sc->sc_ro_pins[i] = fdt32_to_cpu(pins[i]);
536 printf("%d", sc->sc_ro_pins[i]);
546 bcm_gpio_func_proc(SYSCTL_HANDLER_ARGS)
549 struct bcm_gpio_softc *sc;
550 struct bcm_gpio_sysctl *sc_sysctl;
557 /* Get the current pin function. */
558 nfunc = bcm_gpio_get_function(sc, sc_sysctl->pin);
559 bcm_gpio_func_str(nfunc, buf, sizeof(buf));
561 error = sysctl_handle_string(oidp, buf, sizeof(buf), req);
562 if (error != 0 || req->newptr == NULL)
565 /* Parse the user supplied string and check for a valid pin function. */
566 if (bcm_gpio_str_func(buf, &nfunc) != 0)
569 /* Update the pin alternate function. */
570 bcm_gpio_set_alternate(sc->sc_dev, sc_sysctl->pin, nfunc);
576 bcm_gpio_sysctl_init(struct bcm_gpio_softc *sc)
579 struct bcm_gpio_sysctl *sc_sysctl;
580 struct sysctl_ctx_list *ctx;
581 struct sysctl_oid *tree_node, *pin_node, *pinN_node;
582 struct sysctl_oid_list *tree, *pin_tree, *pinN_tree;
586 * Add per-pin sysctl tree/handlers.
588 ctx = device_get_sysctl_ctx(sc->sc_dev);
589 tree_node = device_get_sysctl_tree(sc->sc_dev);
590 tree = SYSCTL_CHILDREN(tree_node);
591 pin_node = SYSCTL_ADD_NODE(ctx, tree, OID_AUTO, "pin",
592 CTLFLAG_RD, NULL, "GPIO Pins");
593 pin_tree = SYSCTL_CHILDREN(pin_node);
595 for (i = 0; i < sc->sc_gpio_npins; i++) {
597 snprintf(pinbuf, sizeof(pinbuf), "%d", i);
598 pinN_node = SYSCTL_ADD_NODE(ctx, pin_tree, OID_AUTO, pinbuf,
599 CTLFLAG_RD, NULL, "GPIO Pin");
600 pinN_tree = SYSCTL_CHILDREN(pinN_node);
602 sc->sc_sysctl[i].sc = sc;
603 sc_sysctl = &sc->sc_sysctl[i];
605 sc_sysctl->pin = sc->sc_gpio_pins[i].gp_pin;
606 SYSCTL_ADD_PROC(ctx, pinN_tree, OID_AUTO, "function",
607 CTLFLAG_RW | CTLTYPE_STRING, sc_sysctl,
608 sizeof(struct bcm_gpio_sysctl), bcm_gpio_func_proc,
609 "A", "Pin Function");
614 bcm_gpio_get_reserved_pins(struct bcm_gpio_softc *sc)
616 int i, j, len, npins;
617 pcell_t pins[BCM_GPIO_PINS];
618 phandle_t gpio, node, reserved;
621 /* Get read-only pins. */
622 if (bcm_gpio_get_ro_pins(sc) != 0)
625 /* Find the gpio/reserved pins node to start. */
626 gpio = ofw_bus_get_node(sc->sc_dev);
627 node = OF_child(gpio);
633 while ((node != 0) && (reserved == 0)) {
634 len = OF_getprop(node, "name", name,
637 if (strcmp(name, "reserved") == 0)
639 node = OF_peer(node);
645 /* Get the reserved pins. */
646 len = OF_getproplen(reserved, "broadcom,pins");
647 if (len < 0 || len > sizeof(pins))
650 if (OF_getprop(reserved, "broadcom,pins", &pins, len) < 0)
653 npins = len / sizeof(pcell_t);
656 device_printf(sc->sc_dev, "reserved pins: ");
657 for (i = 0; i < npins; i++) {
660 printf("%d", fdt32_to_cpu(pins[i]));
661 /* Some pins maybe already on the list of read-only pins. */
662 if (bcm_gpio_pin_is_ro(sc, fdt32_to_cpu(pins[i])))
664 sc->sc_ro_pins[j++ + sc->sc_ro_npins] = fdt32_to_cpu(pins[i]);
666 sc->sc_ro_npins += j;
675 bcm_gpio_probe(device_t dev)
678 if (!ofw_bus_status_okay(dev))
681 if (!ofw_bus_is_compatible(dev, "broadcom,bcm2835-gpio"))
684 device_set_desc(dev, "BCM2708/2835 GPIO controller");
685 return (BUS_PROBE_DEFAULT);
689 bcm_gpio_attach(device_t dev)
691 struct bcm_gpio_softc *sc = device_get_softc(dev);
698 mtx_init(&sc->sc_mtx, "bcm gpio", "gpio", MTX_DEF);
701 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
703 if (!sc->sc_mem_res) {
704 device_printf(dev, "cannot allocate memory window\n");
708 sc->sc_bst = rman_get_bustag(sc->sc_mem_res);
709 sc->sc_bsh = rman_get_bushandle(sc->sc_mem_res);
712 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
714 if (!sc->sc_irq_res) {
715 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
716 device_printf(dev, "cannot allocate interrupt\n");
721 gpio = ofw_bus_get_node(sc->sc_dev);
723 if (!OF_hasprop(gpio, "gpio-controller"))
724 /* Node is not a GPIO controller. */
728 * Find the read-only pins. These are pins we never touch or bad
729 * things could happen.
731 if (bcm_gpio_get_reserved_pins(sc) == -1)
734 /* Initialize the software controlled pins. */
735 for (i = 0, j = 0; j < BCM_GPIO_PINS; j++) {
736 if (bcm_gpio_pin_is_ro(sc, j))
738 snprintf(sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME,
740 func = bcm_gpio_get_function(sc, j);
741 sc->sc_gpio_pins[i].gp_pin = j;
742 sc->sc_gpio_pins[i].gp_caps = BCM_GPIO_DEFAULT_CAPS;
743 sc->sc_gpio_pins[i].gp_flags = bcm_gpio_func_flag(func);
746 sc->sc_gpio_npins = i;
748 bcm_gpio_sysctl_init(sc);
750 device_add_child(dev, "gpioc", device_get_unit(dev));
751 device_add_child(dev, "gpiobus", device_get_unit(dev));
752 return (bus_generic_attach(dev));
756 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
758 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
763 bcm_gpio_detach(device_t dev)
770 bcm_gpio_get_node(device_t bus, device_t dev)
773 /* We only have one child, the GPIO bus, which needs our own node. */
774 return (ofw_bus_get_node(bus));
777 static device_method_t bcm_gpio_methods[] = {
778 /* Device interface */
779 DEVMETHOD(device_probe, bcm_gpio_probe),
780 DEVMETHOD(device_attach, bcm_gpio_attach),
781 DEVMETHOD(device_detach, bcm_gpio_detach),
784 DEVMETHOD(gpio_pin_max, bcm_gpio_pin_max),
785 DEVMETHOD(gpio_pin_getname, bcm_gpio_pin_getname),
786 DEVMETHOD(gpio_pin_getflags, bcm_gpio_pin_getflags),
787 DEVMETHOD(gpio_pin_getcaps, bcm_gpio_pin_getcaps),
788 DEVMETHOD(gpio_pin_setflags, bcm_gpio_pin_setflags),
789 DEVMETHOD(gpio_pin_get, bcm_gpio_pin_get),
790 DEVMETHOD(gpio_pin_set, bcm_gpio_pin_set),
791 DEVMETHOD(gpio_pin_toggle, bcm_gpio_pin_toggle),
793 /* ofw_bus interface */
794 DEVMETHOD(ofw_bus_get_node, bcm_gpio_get_node),
799 static devclass_t bcm_gpio_devclass;
801 static driver_t bcm_gpio_driver = {
804 sizeof(struct bcm_gpio_softc),
807 DRIVER_MODULE(bcm_gpio, simplebus, bcm_gpio_driver, bcm_gpio_devclass, 0, 0);