2 * Copyright (c) 2009, Oleksandr Tymoshenko <gonzo@FreeBSD.org>
3 * Copyright (c) 2009, Luiz Otavio O Souza.
4 * Copyright (c) 2010, Andrew Thompson <thompsa@FreeBSD.org>
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 unmodified, this list of conditions, and the following
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 * GPIO driver for Gateworks Avilia
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>
50 #include <arm/xscale/ixp425/ixp425reg.h>
51 #include <arm/xscale/ixp425/ixp425var.h>
55 #define GPIO_SET_BITS(sc, reg, bits) \
56 GPIO_CONF_WRITE_4(sc, reg, GPIO_CONF_READ_4(sc, (reg)) | (bits))
58 #define GPIO_CLEAR_BITS(sc, reg, bits) \
59 GPIO_CONF_WRITE_4(sc, reg, GPIO_CONF_READ_4(sc, (reg)) & ~(bits))
61 struct avila_gpio_softc {
63 bus_space_tag_t sc_iot;
64 bus_space_handle_t sc_gpio_ioh;
66 struct gpio_pin sc_pins[IXP4XX_GPIO_PINS];
69 struct avila_gpio_pin {
75 #define GPIO_PIN_IO (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)
76 static struct avila_gpio_pin avila_gpio_pins[] = {
77 { "GPIO0", 0, GPIO_PIN_IO },
78 { "GPIO1", 1, GPIO_PIN_IO },
79 { "GPIO2", 2, GPIO_PIN_IO },
80 { "GPIO3", 3, GPIO_PIN_IO },
81 { "GPIO4", 4, GPIO_PIN_IO },
83 * The following pins are connected to system devices and should not
87 { "SER_ENA", 5, GPIO_PIN_IO },
88 { "I2C_SCL", 6, GPIO_PIN_IO },
89 { "I2C_SDA", 7, GPIO_PIN_IO },
90 { "PCI_INTD", 8, GPIO_PIN_IO },
91 { "PCI_INTC", 9, GPIO_PIN_IO },
92 { "PCI_INTB", 10, GPIO_PIN_IO },
93 { "PCI_INTA", 11, GPIO_PIN_IO },
94 { "ATA_INT", 12, GPIO_PIN_IO },
95 { "PCI_RST", 13, GPIO_PIN_IO },
96 { "PCI_CLK", 14, GPIO_PIN_OUTPUT },
97 { "EX_CLK", 15, GPIO_PIN_OUTPUT },
105 static void avila_gpio_pin_configure(struct avila_gpio_softc *sc,
106 struct gpio_pin *pin, uint32_t flags);
107 static int avila_gpio_pin_flags(struct avila_gpio_softc *sc, uint32_t pin);
112 static int avila_gpio_probe(device_t dev);
113 static int avila_gpio_attach(device_t dev);
114 static int avila_gpio_detach(device_t dev);
119 static int avila_gpio_pin_max(device_t dev, int *maxpin);
120 static int avila_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps);
121 static int avila_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t
123 static int avila_gpio_pin_getname(device_t dev, uint32_t pin, char *name);
124 static int avila_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags);
125 static int avila_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value);
126 static int avila_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val);
127 static int avila_gpio_pin_toggle(device_t dev, uint32_t pin);
130 avila_gpio_pin_flags(struct avila_gpio_softc *sc, uint32_t pin)
134 v = GPIO_CONF_READ_4(sc, IXP425_GPIO_GPINR) & (1 << pin);
136 return (v ? GPIO_PIN_INPUT : GPIO_PIN_OUTPUT);
140 avila_gpio_pin_configure(struct avila_gpio_softc *sc, struct gpio_pin *pin,
145 mask = 1 << pin->gp_pin;
148 * Manage input/output
150 if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
152 pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
153 if (flags & GPIO_PIN_OUTPUT) {
154 pin->gp_flags |= GPIO_PIN_OUTPUT;
155 GPIO_CLEAR_BITS(sc, IXP425_GPIO_GPOER, mask);
158 pin->gp_flags |= GPIO_PIN_INPUT;
159 GPIO_SET_BITS(sc, IXP425_GPIO_GPOER, mask);
161 IXP4XX_GPIO_UNLOCK();
166 avila_gpio_pin_max(device_t dev, int *maxpin)
169 *maxpin = IXP4XX_GPIO_PINS - 1;
174 avila_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
176 struct avila_gpio_softc *sc = device_get_softc(dev);
178 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & (1 << pin)))
181 *caps = sc->sc_pins[pin].gp_caps;
186 avila_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
188 struct avila_gpio_softc *sc = device_get_softc(dev);
190 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & (1 << pin)))
194 /* refresh since we do not own all the pins */
195 sc->sc_pins[pin].gp_flags = avila_gpio_pin_flags(sc, pin);
196 *flags = sc->sc_pins[pin].gp_flags;
197 IXP4XX_GPIO_UNLOCK();
203 avila_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
205 struct avila_gpio_softc *sc = device_get_softc(dev);
207 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & (1 << pin)))
210 memcpy(name, sc->sc_pins[pin].gp_name, GPIOMAXNAME);
215 avila_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
217 struct avila_gpio_softc *sc = device_get_softc(dev);
218 uint32_t mask = 1 << pin;
220 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & mask))
223 /* Check for unwanted flags. */
224 if ((flags & sc->sc_pins[pin].gp_caps) != flags)
227 /* Can't mix input/output together */
228 if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
229 (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
232 avila_gpio_pin_configure(sc, &sc->sc_pins[pin], flags);
237 avila_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
239 struct avila_gpio_softc *sc = device_get_softc(dev);
240 uint32_t mask = 1 << pin;
242 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & mask))
247 GPIO_SET_BITS(sc, IXP425_GPIO_GPOUTR, mask);
249 GPIO_CLEAR_BITS(sc, IXP425_GPIO_GPOUTR, mask);
250 IXP4XX_GPIO_UNLOCK();
256 avila_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
258 struct avila_gpio_softc *sc = device_get_softc(dev);
260 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & (1 << pin)))
264 *val = (GPIO_CONF_READ_4(sc, IXP425_GPIO_GPINR) & (1 << pin)) ? 1 : 0;
265 IXP4XX_GPIO_UNLOCK();
271 avila_gpio_pin_toggle(device_t dev, uint32_t pin)
273 struct avila_gpio_softc *sc = device_get_softc(dev);
274 uint32_t mask = 1 << pin;
277 if (pin >= IXP4XX_GPIO_PINS || !(sc->sc_valid & mask))
281 res = GPIO_CONF_READ_4(sc, IXP425_GPIO_GPINR) & mask;
283 GPIO_CLEAR_BITS(sc, IXP425_GPIO_GPOUTR, mask);
285 GPIO_SET_BITS(sc, IXP425_GPIO_GPOUTR, mask);
286 IXP4XX_GPIO_UNLOCK();
292 avila_gpio_probe(device_t dev)
295 device_set_desc(dev, "Gateworks Avila GPIO driver");
300 avila_gpio_attach(device_t dev)
302 #define N(a) (sizeof(a) / sizeof(a[0]))
303 struct avila_gpio_softc *sc = device_get_softc(dev);
304 struct ixp425_softc *sa = device_get_softc(device_get_parent(dev));
308 sc->sc_iot = sa->sc_iot;
309 sc->sc_gpio_ioh = sa->sc_gpio_ioh;
311 for (i = 0; i < N(avila_gpio_pins); i++) {
312 struct avila_gpio_pin *p = &avila_gpio_pins[i];
314 strncpy(sc->sc_pins[p->pin].gp_name, p->name, GPIOMAXNAME);
315 sc->sc_pins[p->pin].gp_pin = p->pin;
316 sc->sc_pins[p->pin].gp_caps = p->caps;
317 sc->sc_pins[p->pin].gp_flags = avila_gpio_pin_flags(sc, p->pin);
318 sc->sc_valid |= 1 << p->pin;
321 device_add_child(dev, "gpioc", device_get_unit(dev));
322 device_add_child(dev, "gpiobus", device_get_unit(dev));
323 return (bus_generic_attach(dev));
328 avila_gpio_detach(device_t dev)
331 bus_generic_detach(dev);
336 static device_method_t gpio_avila_methods[] = {
337 DEVMETHOD(device_probe, avila_gpio_probe),
338 DEVMETHOD(device_attach, avila_gpio_attach),
339 DEVMETHOD(device_detach, avila_gpio_detach),
342 DEVMETHOD(gpio_pin_max, avila_gpio_pin_max),
343 DEVMETHOD(gpio_pin_getname, avila_gpio_pin_getname),
344 DEVMETHOD(gpio_pin_getflags, avila_gpio_pin_getflags),
345 DEVMETHOD(gpio_pin_getcaps, avila_gpio_pin_getcaps),
346 DEVMETHOD(gpio_pin_setflags, avila_gpio_pin_setflags),
347 DEVMETHOD(gpio_pin_get, avila_gpio_pin_get),
348 DEVMETHOD(gpio_pin_set, avila_gpio_pin_set),
349 DEVMETHOD(gpio_pin_toggle, avila_gpio_pin_toggle),
353 static driver_t gpio_avila_driver = {
356 sizeof(struct avila_gpio_softc),
358 static devclass_t gpio_avila_devclass;
359 extern devclass_t gpiobus_devclass, gpioc_devclass;
360 extern driver_t gpiobus_driver, gpioc_driver;
362 DRIVER_MODULE(gpio_avila, ixp, gpio_avila_driver, gpio_avila_devclass, 0, 0);
363 DRIVER_MODULE(gpiobus, gpio_avila, gpiobus_driver, gpiobus_devclass, 0, 0);
364 DRIVER_MODULE(gpioc, gpio_avila, gpioc_driver, gpioc_devclass, 0, 0);
365 MODULE_VERSION(gpio_avila, 1);