2 * Copyright (c) 2013 Ganbold Tsagaankhuu <ganbold@gmail.com>
3 * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
4 * Copyright (c) 2012 Luiz Otavio O Souza.
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #include <sys/cdefs.h>
30 __FBSDID("$FreeBSD$");
32 #include <sys/param.h>
33 #include <sys/systm.h>
36 #include <sys/kernel.h>
37 #include <sys/module.h>
40 #include <sys/mutex.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>
56 #include "rk30xx_grf.h"
57 #include "rk30xx_pmu.h"
60 * RK3188 has 4 banks of gpio.
62 * PA0 - PA7 | PB0 - PB7
63 * PC0 - PC7 | PD0 - PD7
66 #define RK30_GPIO_PINS 128
67 #define RK30_GPIO_DEFAULT_CAPS (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | \
68 GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN)
70 #define RK30_GPIO_NONE 0
71 #define RK30_GPIO_PULLUP 1
72 #define RK30_GPIO_PULLDOWN 2
74 #define RK30_GPIO_INPUT 0
75 #define RK30_GPIO_OUTPUT 1
77 struct rk30_gpio_softc {
80 struct resource * sc_mem_res;
81 struct resource * sc_irq_res;
82 bus_space_tag_t sc_bst;
83 bus_space_handle_t sc_bsh;
86 struct gpio_pin sc_gpio_pins[RK30_GPIO_PINS];
89 static struct rk30_gpio_softc *rk30_gpio_sc = NULL;
91 typedef int (*gpios_phandler_t)(phandle_t, pcell_t *, int);
93 struct gpio_ctrl_entry {
95 gpios_phandler_t handler;
98 int rk30_gpios_prop_handle(phandle_t ctrl, pcell_t *gpios, int len);
99 int platform_gpio_init(void);
101 struct gpio_ctrl_entry gpio_controllers[] = {
102 { "rockchip,rk30xx-gpio", &rk30_gpios_prop_handle },
103 { "rockchip,rk30xx-gpio", &rk30_gpios_prop_handle },
104 { "rockchip,rk30xx-gpio", &rk30_gpios_prop_handle },
105 { "rockchip,rk30xx-gpio", &rk30_gpios_prop_handle },
109 #define RK30_GPIO_LOCK(_sc) mtx_lock(&_sc->sc_mtx)
110 #define RK30_GPIO_UNLOCK(_sc) mtx_unlock(&_sc->sc_mtx)
111 #define RK30_GPIO_LOCK_ASSERT(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED)
113 #define RK30_GPIO_SWPORT_DR 0x00
114 #define RK30_GPIO_SWPORT_DDR 0x04
115 #define RK30_GPIO_INTEN 0x30
116 #define RK30_GPIO_INTMASK 0x34
117 #define RK30_GPIO_INTTYPE_LEVEL 0x38
118 #define RK30_GPIO_INT_POLARITY 0x3c
119 #define RK30_GPIO_INT_STATUS 0x40
120 #define RK30_GPIO_INT_RAWSTATUS 0x44
121 #define RK30_GPIO_DEBOUNCE 0x48
122 #define RK30_GPIO_PORTS_EOI 0x4c
123 #define RK30_GPIO_EXT_PORT 0x50
124 #define RK30_GPIO_LS_SYNC 0x60
126 #define RK30_GPIO_WRITE(_sc, _off, _val) \
127 bus_space_write_4(_sc->sc_bst, _sc->sc_bsh, _off, _val)
128 #define RK30_GPIO_READ(_sc, _off) \
129 bus_space_read_4(_sc->sc_bst, _sc->sc_bsh, _off)
132 rk30_gpio_get_function(struct rk30_gpio_softc *sc, uint32_t pin)
134 uint32_t bank, func, offset;
140 func = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DDR);
147 rk30_gpio_func_flag(uint32_t nfunc)
151 case RK30_GPIO_INPUT:
152 return (GPIO_PIN_INPUT);
153 case RK30_GPIO_OUTPUT:
154 return (GPIO_PIN_OUTPUT);
160 rk30_gpio_set_function(struct rk30_gpio_softc *sc, uint32_t pin, uint32_t f)
162 uint32_t bank, data, offset;
164 /* Must be called with lock held. */
165 RK30_GPIO_LOCK_ASSERT(sc);
171 data = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DDR);
176 RK30_GPIO_WRITE(sc, RK30_GPIO_SWPORT_DDR, data);
180 rk30_gpio_set_pud(struct rk30_gpio_softc *sc, uint32_t pin, uint32_t state)
186 /* Must be called with lock held. */
187 RK30_GPIO_LOCK_ASSERT(sc);
189 if (bank == 0 && pin < 12)
190 rk30_pmu_gpio_pud(pin, state);
192 rk30_grf_gpio_pud(bank, pin, state);
196 rk30_gpio_pin_configure(struct rk30_gpio_softc *sc, struct gpio_pin *pin,
203 * Manage input/output.
205 if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
206 pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
207 if (flags & GPIO_PIN_OUTPUT) {
208 pin->gp_flags |= GPIO_PIN_OUTPUT;
209 rk30_gpio_set_function(sc, pin->gp_pin,
212 pin->gp_flags |= GPIO_PIN_INPUT;
213 rk30_gpio_set_function(sc, pin->gp_pin,
218 /* Manage Pull-up/pull-down. */
219 pin->gp_flags &= ~(GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN);
220 if (flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) {
221 if (flags & GPIO_PIN_PULLUP) {
222 pin->gp_flags |= GPIO_PIN_PULLUP;
223 rk30_gpio_set_pud(sc, pin->gp_pin,
226 pin->gp_flags |= GPIO_PIN_PULLDOWN;
227 rk30_gpio_set_pud(sc, pin->gp_pin,
231 rk30_gpio_set_pud(sc, pin->gp_pin, RK30_GPIO_NONE);
233 RK30_GPIO_UNLOCK(sc);
237 rk30_gpio_pin_max(device_t dev, int *maxpin)
240 *maxpin = RK30_GPIO_PINS - 1;
245 rk30_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
247 struct rk30_gpio_softc *sc = device_get_softc(dev);
250 for (i = 0; i < sc->sc_gpio_npins; i++) {
251 if (sc->sc_gpio_pins[i].gp_pin == pin)
255 if (i >= sc->sc_gpio_npins)
259 *caps = sc->sc_gpio_pins[i].gp_caps;
260 RK30_GPIO_UNLOCK(sc);
266 rk30_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
268 struct rk30_gpio_softc *sc = device_get_softc(dev);
271 for (i = 0; i < sc->sc_gpio_npins; i++) {
272 if (sc->sc_gpio_pins[i].gp_pin == pin)
276 if (i >= sc->sc_gpio_npins)
280 *flags = sc->sc_gpio_pins[i].gp_flags;
281 RK30_GPIO_UNLOCK(sc);
287 rk30_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
289 struct rk30_gpio_softc *sc = device_get_softc(dev);
292 for (i = 0; i < sc->sc_gpio_npins; i++) {
293 if (sc->sc_gpio_pins[i].gp_pin == pin)
297 if (i >= sc->sc_gpio_npins)
301 memcpy(name, sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME);
302 RK30_GPIO_UNLOCK(sc);
308 rk30_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
310 struct rk30_gpio_softc *sc = device_get_softc(dev);
313 for (i = 0; i < sc->sc_gpio_npins; i++) {
314 if (sc->sc_gpio_pins[i].gp_pin == pin)
318 if (i >= sc->sc_gpio_npins)
321 /* Check for unwanted flags. */
322 if ((flags & sc->sc_gpio_pins[i].gp_caps) != flags)
325 /* Can't mix input/output together. */
326 if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
327 (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
330 /* Can't mix pull-up/pull-down together. */
331 if ((flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) ==
332 (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN))
335 rk30_gpio_pin_configure(sc, &sc->sc_gpio_pins[i], flags);
341 rk30_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
343 struct rk30_gpio_softc *sc = device_get_softc(dev);
344 uint32_t bank, offset, data;
347 for (i = 0; i < sc->sc_gpio_npins; i++) {
348 if (sc->sc_gpio_pins[i].gp_pin == pin)
352 if (i >= sc->sc_gpio_npins)
360 data = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DDR);
362 RK30_GPIO_WRITE(sc, RK30_GPIO_SWPORT_DDR, data);
364 data = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DR);
369 RK30_GPIO_WRITE(sc, RK30_GPIO_SWPORT_DR, data);
370 RK30_GPIO_UNLOCK(sc);
376 rk30_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
378 struct rk30_gpio_softc *sc = device_get_softc(dev);
379 uint32_t bank, offset, reg_data;
382 for (i = 0; i < sc->sc_gpio_npins; i++) {
383 if (sc->sc_gpio_pins[i].gp_pin == pin)
387 if (i >= sc->sc_gpio_npins)
395 reg_data = RK30_GPIO_READ(sc, RK30_GPIO_EXT_PORT);
396 RK30_GPIO_UNLOCK(sc);
397 *val = (reg_data & offset) ? 1 : 0;
403 rk30_gpio_pin_toggle(device_t dev, uint32_t pin)
405 struct rk30_gpio_softc *sc = device_get_softc(dev);
406 uint32_t bank, data, offset;
409 for (i = 0; i < sc->sc_gpio_npins; i++) {
410 if (sc->sc_gpio_pins[i].gp_pin == pin)
414 if (i >= sc->sc_gpio_npins)
422 data = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DDR);
427 RK30_GPIO_WRITE(sc, RK30_GPIO_SWPORT_DDR, data);
429 data = RK30_GPIO_READ(sc, RK30_GPIO_SWPORT_DR);
434 RK30_GPIO_WRITE(sc, RK30_GPIO_SWPORT_DR, data);
435 RK30_GPIO_UNLOCK(sc);
441 rk30_gpio_probe(device_t dev)
444 if (!ofw_bus_status_okay(dev))
447 if (!ofw_bus_is_compatible(dev, "rockchip,rk30xx-gpio"))
450 device_set_desc(dev, "Rockchip RK30XX GPIO controller");
451 return (BUS_PROBE_DEFAULT);
455 rk30_gpio_attach(device_t dev)
457 struct rk30_gpio_softc *sc = device_get_softc(dev);
467 mtx_init(&sc->sc_mtx, "rk30 gpio", "gpio", MTX_DEF);
470 sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
472 if (!sc->sc_mem_res) {
473 device_printf(dev, "cannot allocate memory window\n");
477 sc->sc_bst = rman_get_bustag(sc->sc_mem_res);
478 sc->sc_bsh = rman_get_bushandle(sc->sc_mem_res);
481 sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
483 if (!sc->sc_irq_res) {
484 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
485 device_printf(dev, "cannot allocate interrupt\n");
490 gpio = ofw_bus_get_node(sc->sc_dev);
492 if (!OF_hasprop(gpio, "gpio-controller"))
493 /* Node is not a GPIO controller. */
496 /* Initialize the software controlled pins. */
497 for (i = 0; i < RK30_GPIO_PINS; i++) {
498 snprintf(sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME,
500 func = rk30_gpio_get_function(sc, i);
501 sc->sc_gpio_pins[i].gp_pin = i;
502 sc->sc_gpio_pins[i].gp_caps = RK30_GPIO_DEFAULT_CAPS;
503 sc->sc_gpio_pins[i].gp_flags = rk30_gpio_func_flag(func);
505 sc->sc_gpio_npins = i;
507 device_add_child(dev, "gpioc", device_get_unit(dev));
508 device_add_child(dev, "gpiobus", device_get_unit(dev));
512 platform_gpio_init();
514 return (bus_generic_attach(dev));
518 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
520 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
525 rk30_gpio_detach(device_t dev)
531 static device_method_t rk30_gpio_methods[] = {
532 /* Device interface */
533 DEVMETHOD(device_probe, rk30_gpio_probe),
534 DEVMETHOD(device_attach, rk30_gpio_attach),
535 DEVMETHOD(device_detach, rk30_gpio_detach),
538 DEVMETHOD(gpio_pin_max, rk30_gpio_pin_max),
539 DEVMETHOD(gpio_pin_getname, rk30_gpio_pin_getname),
540 DEVMETHOD(gpio_pin_getflags, rk30_gpio_pin_getflags),
541 DEVMETHOD(gpio_pin_getcaps, rk30_gpio_pin_getcaps),
542 DEVMETHOD(gpio_pin_setflags, rk30_gpio_pin_setflags),
543 DEVMETHOD(gpio_pin_get, rk30_gpio_pin_get),
544 DEVMETHOD(gpio_pin_set, rk30_gpio_pin_set),
545 DEVMETHOD(gpio_pin_toggle, rk30_gpio_pin_toggle),
550 static devclass_t rk30_gpio_devclass;
552 static driver_t rk30_gpio_driver = {
555 sizeof(struct rk30_gpio_softc),
558 DRIVER_MODULE(rk30_gpio, simplebus, rk30_gpio_driver, rk30_gpio_devclass, 0, 0);
561 rk30_gpios_prop_handle(phandle_t ctrl, pcell_t *gpios, int len)
563 struct rk30_gpio_softc *sc;
565 int inc, t, tuples, tuple_size;
566 int dir, flags, pin, i;
567 u_long gpio_ctrl, size;
573 if (OF_getprop(ctrl, "#gpio-cells", &gpio_cells, sizeof(pcell_t)) < 0)
576 gpio_cells = fdt32_to_cpu(gpio_cells);
580 tuple_size = gpio_cells * sizeof(pcell_t) + sizeof(phandle_t);
581 tuples = len / tuple_size;
583 if (fdt_regsize(ctrl, &gpio_ctrl, &size))
587 * Skip controller reference, since controller's phandle is given
588 * explicitly (in a function argument).
590 inc = sizeof(ihandle_t) / sizeof(pcell_t);
592 for (t = 0; t < tuples; t++) {
593 pin = fdt32_to_cpu(gpios[0]);
594 dir = fdt32_to_cpu(gpios[1]);
595 flags = fdt32_to_cpu(gpios[2]);
597 for (i = 0; i < sc->sc_gpio_npins; i++) {
598 if (sc->sc_gpio_pins[i].gp_pin == pin)
601 if (i >= sc->sc_gpio_npins)
604 rk30_gpio_pin_configure(sc, &sc->sc_gpio_pins[i], flags);
608 rk30_gpio_pin_set(sc->sc_dev, pin, RK30_GPIO_INPUT);
611 rk30_gpio_pin_set(sc->sc_dev, pin, RK30_GPIO_OUTPUT);
613 gpios += gpio_cells + inc;
619 #define MAX_PINS_PER_NODE 5
620 #define GPIOS_PROP_CELLS 4
623 platform_gpio_init(void)
625 phandle_t child, parent, root, ctrl;
626 pcell_t gpios[MAX_PINS_PER_NODE * GPIOS_PROP_CELLS];
627 struct gpio_ctrl_entry *e;
630 root = OF_finddevice("/");
634 /* Traverse through entire tree to find nodes with 'gpios' prop */
635 for (child = OF_child(parent); child != 0; child = OF_peer(child)) {
637 /* Find a 'leaf'. Start the search from this node. */
638 while (OF_child(child)) {
640 child = OF_child(child);
642 if ((len = OF_getproplen(child, "gpios")) > 0) {
644 if (len > sizeof(gpios))
647 /* Get 'gpios' property. */
648 OF_getprop(child, "gpios", &gpios, len);
650 e = (struct gpio_ctrl_entry *)&gpio_controllers;
652 /* Find and call a handler. */
653 for (; e->compat; e++) {
655 * First cell of 'gpios' property should
656 * contain a ref. to a node defining GPIO
659 ctrl = OF_xref_phandle(fdt32_to_cpu(gpios[0]));
661 if (fdt_is_compatible(ctrl, e->compat))
662 /* Call a handler. */
663 if ((rv = e->handler(ctrl,
664 (pcell_t *)&gpios, len)))
669 if (OF_peer(child) == 0) {
670 /* No more siblings. */
672 parent = OF_parent(child);