2 * Copyright (c) 2012, 2013 The FreeBSD Foundation
5 * This software was developed by Oleksandr Rybalko under sponsorship
6 * from the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 * Freescale i.MX515 GPIO driver.
34 #include <sys/cdefs.h>
35 __FBSDID("$FreeBSD$");
37 #include <sys/param.h>
38 #include <sys/systm.h>
41 #include <sys/kernel.h>
42 #include <sys/module.h>
45 #include <sys/mutex.h>
48 #include <machine/bus.h>
49 #include <machine/resource.h>
51 #include <dev/fdt/fdt_common.h>
52 #include <dev/ofw/openfirm.h>
53 #include <dev/ofw/ofw_bus.h>
54 #include <dev/ofw/ofw_bus_subr.h>
58 #define GPIO_LOCK(_sc) mtx_lock(&(_sc)->sc_mtx)
59 #define GPIO_UNLOCK(_sc) mtx_unlock(&(_sc)->sc_mtx)
60 #define GPIO_LOCK_INIT(_sc) mtx_init(&_sc->sc_mtx, \
61 device_get_nameunit(_sc->sc_dev), "imx_gpio", MTX_DEF)
62 #define GPIO_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx);
63 #define GPIO_ASSERT_LOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_OWNED);
64 #define GPIO_ASSERT_UNLOCKED(_sc) mtx_assert(&_sc->sc_mtx, MA_NOTOWNED);
66 #define WRITE4(_sc, _r, _v) \
67 bus_space_write_4((_sc)->sc_iot, (_sc)->sc_ioh, (_r), (_v))
68 #define READ4(_sc, _r) \
69 bus_space_read_4((_sc)->sc_iot, (_sc)->sc_ioh, (_r))
70 #define SET4(_sc, _r, _m) \
71 WRITE4((_sc), (_r), READ4((_sc), (_r)) | (_m))
72 #define CLEAR4(_sc, _r, _m) \
73 WRITE4((_sc), (_r), READ4((_sc), (_r)) & ~(_m))
75 /* Registers definition for Freescale i.MX515 GPIO controller */
77 #define IMX_GPIO_DR_REG 0x000 /* Pin Data */
78 #define IMX_GPIO_OE_REG 0x004 /* Set Pin Output */
79 #define IMX_GPIO_PSR_REG 0x008 /* Pad Status */
80 #define IMX_GPIO_ICR1_REG 0x00C /* Interrupt Configuration */
81 #define IMX_GPIO_ICR2_REG 0x010 /* Interrupt Configuration */
82 #define GPIO_ICR_COND_LOW 0
83 #define GPIO_ICR_COND_HIGH 1
84 #define GPIO_ICR_COND_RISE 2
85 #define GPIO_ICR_COND_FALL 3
86 #define IMX_GPIO_IMR_REG 0x014 /* Interrupt Mask Register */
87 #define IMX_GPIO_ISR_REG 0x018 /* Interrupt Status Register */
88 #define IMX_GPIO_EDGE_REG 0x01C /* Edge Detect Register */
90 #define DEFAULT_CAPS (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT)
93 struct imx51_gpio_softc {
96 struct resource *sc_res[11]; /* 1 x mem, 2 x IRQ, 8 x IRQ */
97 void *gpio_ih[11]; /* 1 ptr is not a big waste */
98 int sc_l_irq; /* Last irq resource */
99 bus_space_tag_t sc_iot;
100 bus_space_handle_t sc_ioh;
102 struct gpio_pin gpio_pins[NGPIO];
105 static struct resource_spec imx_gpio_spec[] = {
106 { SYS_RES_MEMORY, 0, RF_ACTIVE },
107 { SYS_RES_IRQ, 0, RF_ACTIVE },
108 { SYS_RES_IRQ, 1, RF_ACTIVE },
112 static struct resource_spec imx_gpio0irq_spec[] = {
113 { SYS_RES_IRQ, 2, RF_ACTIVE },
114 { SYS_RES_IRQ, 3, RF_ACTIVE },
115 { SYS_RES_IRQ, 4, RF_ACTIVE },
116 { SYS_RES_IRQ, 5, RF_ACTIVE },
117 { SYS_RES_IRQ, 6, RF_ACTIVE },
118 { SYS_RES_IRQ, 7, RF_ACTIVE },
119 { SYS_RES_IRQ, 8, RF_ACTIVE },
120 { SYS_RES_IRQ, 9, RF_ACTIVE },
127 static void imx51_gpio_pin_configure(struct imx51_gpio_softc *,
128 struct gpio_pin *, uint32_t);
133 static int imx51_gpio_probe(device_t);
134 static int imx51_gpio_attach(device_t);
135 static int imx51_gpio_detach(device_t);
136 static int imx51_gpio_intr(void *);
141 static int imx51_gpio_pin_max(device_t, int *);
142 static int imx51_gpio_pin_getcaps(device_t, uint32_t, uint32_t *);
143 static int imx51_gpio_pin_getflags(device_t, uint32_t, uint32_t *);
144 static int imx51_gpio_pin_getname(device_t, uint32_t, char *);
145 static int imx51_gpio_pin_setflags(device_t, uint32_t, uint32_t);
146 static int imx51_gpio_pin_set(device_t, uint32_t, unsigned int);
147 static int imx51_gpio_pin_get(device_t, uint32_t, unsigned int *);
148 static int imx51_gpio_pin_toggle(device_t, uint32_t pin);
151 imx51_gpio_pin_configure(struct imx51_gpio_softc *sc, struct gpio_pin *pin,
158 * Manage input/output
160 if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
161 pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
162 if (flags & GPIO_PIN_OUTPUT) {
163 pin->gp_flags |= GPIO_PIN_OUTPUT;
164 SET4(sc, IMX_GPIO_OE_REG, (1 << pin->gp_pin));
167 pin->gp_flags |= GPIO_PIN_INPUT;
168 CLEAR4(sc, IMX_GPIO_OE_REG, (1 << pin->gp_pin));
176 imx51_gpio_pin_max(device_t dev, int *maxpin)
184 imx51_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
186 struct imx51_gpio_softc *sc;
189 sc = device_get_softc(dev);
190 for (i = 0; i < sc->gpio_npins; i++) {
191 if (sc->gpio_pins[i].gp_pin == pin)
195 if (i >= sc->gpio_npins)
199 *caps = sc->gpio_pins[i].gp_caps;
206 imx51_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
208 struct imx51_gpio_softc *sc;
211 sc = device_get_softc(dev);
212 for (i = 0; i < sc->gpio_npins; i++) {
213 if (sc->gpio_pins[i].gp_pin == pin)
217 if (i >= sc->gpio_npins)
221 *flags = sc->gpio_pins[i].gp_flags;
228 imx51_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
230 struct imx51_gpio_softc *sc;
233 sc = device_get_softc(dev);
234 for (i = 0; i < sc->gpio_npins; i++) {
235 if (sc->gpio_pins[i].gp_pin == pin)
239 if (i >= sc->gpio_npins)
243 memcpy(name, sc->gpio_pins[i].gp_name, GPIOMAXNAME);
250 imx51_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
252 struct imx51_gpio_softc *sc;
255 sc = device_get_softc(dev);
256 for (i = 0; i < sc->gpio_npins; i++) {
257 if (sc->gpio_pins[i].gp_pin == pin)
261 if (i >= sc->gpio_npins)
264 /* Check for unwanted flags. */
265 if ((flags & sc->gpio_pins[i].gp_caps) != flags)
268 /* Can't mix input/output together */
269 if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
270 (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
273 imx51_gpio_pin_configure(sc, &sc->gpio_pins[i], flags);
280 imx51_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
282 struct imx51_gpio_softc *sc;
285 sc = device_get_softc(dev);
286 for (i = 0; i < sc->gpio_npins; i++) {
287 if (sc->gpio_pins[i].gp_pin == pin)
291 if (i >= sc->gpio_npins)
296 SET4(sc, IMX_GPIO_DR_REG, (1 << i));
298 CLEAR4(sc, IMX_GPIO_DR_REG, (1 << i));
305 imx51_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
307 struct imx51_gpio_softc *sc;
310 sc = device_get_softc(dev);
311 for (i = 0; i < sc->gpio_npins; i++) {
312 if (sc->gpio_pins[i].gp_pin == pin)
316 if (i >= sc->gpio_npins)
320 *val = (READ4(sc, IMX_GPIO_DR_REG) >> i) & 1;
327 imx51_gpio_pin_toggle(device_t dev, uint32_t pin)
329 struct imx51_gpio_softc *sc;
332 sc = device_get_softc(dev);
333 for (i = 0; i < sc->gpio_npins; i++) {
334 if (sc->gpio_pins[i].gp_pin == pin)
338 if (i >= sc->gpio_npins)
342 WRITE4(sc, IMX_GPIO_DR_REG,
343 (READ4(sc, IMX_GPIO_DR_REG) ^ (1 << i)));
350 imx51_gpio_intr(void *arg)
352 struct imx51_gpio_softc *sc;
353 uint32_t input, value;
356 input = READ4(sc, IMX_GPIO_ISR_REG);
357 value = input & READ4(sc, IMX_GPIO_IMR_REG);
358 WRITE4(sc, IMX_GPIO_DR_REG, input);
363 /* TODO: interrupt handling */
366 return (FILTER_HANDLED);
370 imx51_gpio_probe(device_t dev)
373 if (ofw_bus_is_compatible(dev, "fsl,imx51-gpio") ||
374 ofw_bus_is_compatible(dev, "fsl,imx53-gpio")) {
375 device_set_desc(dev, "i.MX515 GPIO Controller");
376 return (BUS_PROBE_DEFAULT);
383 imx51_gpio_attach(device_t dev)
385 struct imx51_gpio_softc *sc;
388 sc = device_get_softc(dev);
389 mtx_init(&sc->sc_mtx, device_get_nameunit(dev), NULL, MTX_DEF);
391 if (bus_alloc_resources(dev, imx_gpio_spec, sc->sc_res)) {
392 device_printf(dev, "could not allocate resources\n");
397 sc->gpio_npins = NGPIO;
399 sc->sc_iot = rman_get_bustag(sc->sc_res[0]);
400 sc->sc_ioh = rman_get_bushandle(sc->sc_res[0]);
402 if (bus_alloc_resources(dev, imx_gpio0irq_spec, &sc->sc_res[3]) == 0) {
404 * First GPIO unit able to serve +8 interrupts for 8 first
410 for (irq = 1; irq <= sc->sc_l_irq; irq ++) {
411 if ((bus_setup_intr(dev, sc->sc_res[irq], INTR_TYPE_MISC,
412 imx51_gpio_intr, NULL, sc, &sc->gpio_ih[irq]))) {
414 "WARNING: unable to register interrupt handler\n");
419 for (i = 0; i < sc->gpio_npins; i++) {
420 sc->gpio_pins[i].gp_pin = i;
421 sc->gpio_pins[i].gp_caps = DEFAULT_CAPS;
422 sc->gpio_pins[i].gp_flags =
423 (READ4(sc, IMX_GPIO_OE_REG) & (1 << i)) ? GPIO_PIN_OUTPUT:
425 snprintf(sc->gpio_pins[i].gp_name, GPIOMAXNAME,
426 "imx_gpio%d.%d", device_get_unit(dev), i);
429 device_add_child(dev, "gpioc", device_get_unit(dev));
430 device_add_child(dev, "gpiobus", device_get_unit(dev));
432 return (bus_generic_attach(dev));
436 imx51_gpio_detach(device_t dev)
438 struct imx51_gpio_softc *sc;
440 sc = device_get_softc(dev);
442 KASSERT(mtx_initialized(&sc->sc_mtx), ("gpio mutex not initialized"));
444 bus_generic_detach(dev);
447 bus_release_resources(dev, imx_gpio0irq_spec, &sc->sc_res[3]);
450 bus_release_resources(dev, imx_gpio_spec, sc->sc_res);
452 mtx_destroy(&sc->sc_mtx);
457 static device_method_t imx51_gpio_methods[] = {
458 DEVMETHOD(device_probe, imx51_gpio_probe),
459 DEVMETHOD(device_attach, imx51_gpio_attach),
460 DEVMETHOD(device_detach, imx51_gpio_detach),
463 DEVMETHOD(gpio_pin_max, imx51_gpio_pin_max),
464 DEVMETHOD(gpio_pin_getname, imx51_gpio_pin_getname),
465 DEVMETHOD(gpio_pin_getflags, imx51_gpio_pin_getflags),
466 DEVMETHOD(gpio_pin_getcaps, imx51_gpio_pin_getcaps),
467 DEVMETHOD(gpio_pin_setflags, imx51_gpio_pin_setflags),
468 DEVMETHOD(gpio_pin_get, imx51_gpio_pin_get),
469 DEVMETHOD(gpio_pin_set, imx51_gpio_pin_set),
470 DEVMETHOD(gpio_pin_toggle, imx51_gpio_pin_toggle),
474 static driver_t imx51_gpio_driver = {
477 sizeof(struct imx51_gpio_softc),
479 static devclass_t imx51_gpio_devclass;
481 DRIVER_MODULE(imx51_gpio, simplebus, imx51_gpio_driver, imx51_gpio_devclass,