zy7_gpio.c revision 249997
1249997Swkoszek/*- 2249997Swkoszek * Copyright (C) 2013, Thomas Skibo. 3249997Swkoszek * All rights reserved. 4249997Swkoszek * 5249997Swkoszek * Redistribution and use in source and binary forms, with or without 6249997Swkoszek * modification, are permitted provided that the following conditions are met: 7249997Swkoszek * * Redistributions of source code must retain the above copyright 8249997Swkoszek * notice, this list of conditions and the following disclaimer. 9249997Swkoszek * * Redistributions in binary form must reproduce the above copyright 10249997Swkoszek * notice, this list of conditions and the following disclaimer in the 11249997Swkoszek * documentation and/or other materials provided with the distribution. 12249997Swkoszek * * The names of contributors may not be used to endorse or promote products 13249997Swkoszek * derived from this software without specific prior written permission. 14249997Swkoszek * 15249997Swkoszek * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 16249997Swkoszek * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17249997Swkoszek * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18249997Swkoszek * ARE DISCLAIMED. IN NO EVENT SHALL AUTHORS OR CONTRIBUTORS BE LIABLE FOR 19249997Swkoszek * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20249997Swkoszek * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 21249997Swkoszek * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 22249997Swkoszek * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23249997Swkoszek * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24249997Swkoszek * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH 25249997Swkoszek * DAMAGE. 26249997Swkoszek * 27249997Swkoszek */ 28249997Swkoszek 29249997Swkoszek/* A GPIO driver for Xilinx Zynq-7000. 30249997Swkoszek * 31249997Swkoszek * The GPIO peripheral on Zynq allows controlling 114 general purpose I/Os. 32249997Swkoszek * 33249997Swkoszek * Pins 53-0 are sent to the MIO. Any MIO pins not used by a PS peripheral are 34249997Swkoszek * available as a GPIO pin. Pins 64-127 are sent to the PL (FPGA) section of 35249997Swkoszek * Zynq as EMIO signals. 36249997Swkoszek * 37249997Swkoszek * The hardware provides a way to use IOs as interrupt sources but the 38249997Swkoszek * gpio framework doesn't seem to have hooks for this. 39249997Swkoszek * 40249997Swkoszek * Reference: Zynq-7000 All Programmable SoC Technical Reference Manual. 41249997Swkoszek * (v1.4) November 16, 2012. Xilinx doc UG585. GPIO is covered in 42249997Swkoszek * chater 14. Register definitions are in appendix B.19. 43249997Swkoszek */ 44249997Swkoszek 45249997Swkoszek#include <sys/cdefs.h> 46249997Swkoszek__FBSDID("$FreeBSD: head/sys/arm/xilinx/zy7_gpio.c 249997 2013-04-27 22:38:29Z wkoszek $"); 47249997Swkoszek 48249997Swkoszek#include <sys/param.h> 49249997Swkoszek#include <sys/systm.h> 50249997Swkoszek#include <sys/conf.h> 51249997Swkoszek#include <sys/bus.h> 52249997Swkoszek#include <sys/kernel.h> 53249997Swkoszek#include <sys/module.h> 54249997Swkoszek#include <sys/lock.h> 55249997Swkoszek#include <sys/mutex.h> 56249997Swkoszek#include <sys/resource.h> 57249997Swkoszek#include <sys/rman.h> 58249997Swkoszek#include <sys/gpio.h> 59249997Swkoszek 60249997Swkoszek#include <machine/bus.h> 61249997Swkoszek#include <machine/resource.h> 62249997Swkoszek#include <machine/stdarg.h> 63249997Swkoszek 64249997Swkoszek#include <dev/fdt/fdt_common.h> 65249997Swkoszek#include <dev/ofw/ofw_bus.h> 66249997Swkoszek#include <dev/ofw/ofw_bus_subr.h> 67249997Swkoszek 68249997Swkoszek#include "gpio_if.h" 69249997Swkoszek 70249997Swkoszek#define NUMBANKS 4 71249997Swkoszek#define MAXPIN (32*NUMBANKS) 72249997Swkoszek 73249997Swkoszek#define MIO_PIN 0 /* pins 0-53 go to MIO */ 74249997Swkoszek#define NUM_MIO_PINS 54 75249997Swkoszek#define EMIO_PIN 64 /* pins 64-127 go to PL */ 76249997Swkoszek#define NUM_EMIO_PINS 64 77249997Swkoszek 78249997Swkoszek#define VALID_PIN(u) (((u) >= MIO_PIN && (u) < MIO_PIN + NUM_MIO_PINS) || \ 79249997Swkoszek ((u) >= EMIO_PIN && (u) < EMIO_PIN + NUM_EMIO_PINS)) 80249997Swkoszek 81249997Swkoszek#define ZGPIO_LOCK(sc) mtx_lock(&(sc)->sc_mtx) 82249997Swkoszek#define ZGPIO_UNLOCK(sc) mtx_unlock(&(sc)->sc_mtx) 83249997Swkoszek#define ZGPIO_LOCK_INIT(sc) \ 84249997Swkoszek mtx_init(&(sc)->sc_mtx, device_get_nameunit((sc)->dev), \ 85249997Swkoszek "gpio", MTX_DEF) 86249997Swkoszek#define ZGPIO_LOCK_DESTROY(_sc) mtx_destroy(&_sc->sc_mtx); 87249997Swkoszek 88249997Swkoszekstruct zy7_gpio_softc { 89249997Swkoszek device_t dev; 90249997Swkoszek struct mtx sc_mtx; 91249997Swkoszek struct resource *mem_res; /* Memory resource */ 92249997Swkoszek}; 93249997Swkoszek 94249997Swkoszek#define WR4(sc, off, val) bus_write_4((sc)->mem_res, (off), (val)) 95249997Swkoszek#define RD4(sc, off) bus_read_4((sc)->mem_res, (off)) 96249997Swkoszek 97249997Swkoszek 98249997Swkoszek/* Xilinx Zynq-7000 GPIO register definitions: 99249997Swkoszek */ 100249997Swkoszek#define ZY7_GPIO_MASK_DATA_LSW(b) (0x0000+8*(b)) /* maskable wr lo */ 101249997Swkoszek#define ZY7_GPIO_MASK_DATA_MSW(b) (0x0004+8*(b)) /* maskable wr hi */ 102249997Swkoszek#define ZY7_GPIO_DATA(b) (0x0040+4*(b)) /* in/out data */ 103249997Swkoszek#define ZY7_GPIO_DATA_RO(b) (0x0060+4*(b)) /* input data */ 104249997Swkoszek 105249997Swkoszek#define ZY7_GPIO_DIRM(b) (0x0204+0x40*(b)) /* direction mode */ 106249997Swkoszek#define ZY7_GPIO_OEN(b) (0x0208+0x40*(b)) /* output enable */ 107249997Swkoszek#define ZY7_GPIO_INT_MASK(b) (0x020c+0x40*(b)) /* int mask */ 108249997Swkoszek#define ZY7_GPIO_INT_EN(b) (0x0210+0x40*(b)) /* int enable */ 109249997Swkoszek#define ZY7_GPIO_INT_DIS(b) (0x0214+0x40*(b)) /* int disable */ 110249997Swkoszek#define ZY7_GPIO_INT_STAT(b) (0x0218+0x40*(b)) /* int status */ 111249997Swkoszek#define ZY7_GPIO_INT_TYPE(b) (0x021c+0x40*(b)) /* int type */ 112249997Swkoszek#define ZY7_GPIO_INT_POLARITY(b) (0x0220+0x40*(b)) /* int polarity */ 113249997Swkoszek#define ZY7_GPIO_INT_ANY(b) (0x0224+0x40*(b)) /* any edge */ 114249997Swkoszek 115249997Swkoszek 116249997Swkoszekstatic int 117249997Swkoszekzy7_gpio_pin_max(device_t dev, int *maxpin) 118249997Swkoszek{ 119249997Swkoszek 120249997Swkoszek *maxpin = MAXPIN; 121249997Swkoszek return (0); 122249997Swkoszek} 123249997Swkoszek 124249997Swkoszek/* Get a specific pin's capabilities. */ 125249997Swkoszekstatic int 126249997Swkoszekzy7_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps) 127249997Swkoszek{ 128249997Swkoszek 129249997Swkoszek if (!VALID_PIN(pin)) 130249997Swkoszek return (EINVAL); 131249997Swkoszek 132249997Swkoszek *caps = (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT | GPIO_PIN_TRISTATE); 133249997Swkoszek 134249997Swkoszek return (0); 135249997Swkoszek} 136249997Swkoszek 137249997Swkoszek/* Get a specific pin's name. */ 138249997Swkoszekstatic int 139249997Swkoszekzy7_gpio_pin_getname(device_t dev, uint32_t pin, char *name) 140249997Swkoszek{ 141249997Swkoszek 142249997Swkoszek if (!VALID_PIN(pin)) 143249997Swkoszek return (EINVAL); 144249997Swkoszek 145249997Swkoszek if (pin < NUM_MIO_PINS) { 146249997Swkoszek snprintf(name, GPIOMAXNAME, "MIO_%d", pin); 147249997Swkoszek name[GPIOMAXNAME - 1] = '\0'; 148249997Swkoszek } else { 149249997Swkoszek snprintf(name, GPIOMAXNAME, "EMIO_%d", pin - EMIO_PIN); 150249997Swkoszek name[GPIOMAXNAME - 1] = '\0'; 151249997Swkoszek } 152249997Swkoszek 153249997Swkoszek return (0); 154249997Swkoszek} 155249997Swkoszek 156249997Swkoszek/* Get a specific pin's current in/out/tri state. */ 157249997Swkoszekstatic int 158249997Swkoszekzy7_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags) 159249997Swkoszek{ 160249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 161249997Swkoszek 162249997Swkoszek if (!VALID_PIN(pin)) 163249997Swkoszek return (EINVAL); 164249997Swkoszek 165249997Swkoszek ZGPIO_LOCK(sc); 166249997Swkoszek 167249997Swkoszek if ((RD4(sc, ZY7_GPIO_DIRM(pin >> 5)) & (1 << (pin & 31))) != 0) { 168249997Swkoszek /* output */ 169249997Swkoszek if ((RD4(sc, ZY7_GPIO_OEN(pin >> 5)) & (1 << (pin & 31))) == 0) 170249997Swkoszek *flags = (GPIO_PIN_OUTPUT | GPIO_PIN_TRISTATE); 171249997Swkoszek else 172249997Swkoszek *flags = GPIO_PIN_OUTPUT; 173249997Swkoszek } else 174249997Swkoszek /* input */ 175249997Swkoszek *flags = GPIO_PIN_INPUT; 176249997Swkoszek 177249997Swkoszek ZGPIO_UNLOCK(sc); 178249997Swkoszek 179249997Swkoszek return (0); 180249997Swkoszek} 181249997Swkoszek 182249997Swkoszek/* Set a specific pin's in/out/tri state. */ 183249997Swkoszekstatic int 184249997Swkoszekzy7_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags) 185249997Swkoszek{ 186249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 187249997Swkoszek 188249997Swkoszek if (!VALID_PIN(pin)) 189249997Swkoszek return (EINVAL); 190249997Swkoszek 191249997Swkoszek ZGPIO_LOCK(sc); 192249997Swkoszek 193249997Swkoszek if ((flags & GPIO_PIN_OUTPUT) != 0) { 194249997Swkoszek /* Output. Set or reset OEN too. */ 195249997Swkoszek WR4(sc, ZY7_GPIO_DIRM(pin >> 5), 196249997Swkoszek RD4(sc, ZY7_GPIO_DIRM(pin >> 5)) | (1 << (pin & 31))); 197249997Swkoszek 198249997Swkoszek if ((flags & GPIO_PIN_TRISTATE) != 0) 199249997Swkoszek WR4(sc, ZY7_GPIO_OEN(pin >> 5), 200249997Swkoszek RD4(sc, ZY7_GPIO_OEN(pin >> 5)) & 201249997Swkoszek ~(1 << (pin & 31))); 202249997Swkoszek else 203249997Swkoszek WR4(sc, ZY7_GPIO_OEN(pin >> 5), 204249997Swkoszek RD4(sc, ZY7_GPIO_OEN(pin >> 5)) | 205249997Swkoszek (1 << (pin & 31))); 206249997Swkoszek } else { 207249997Swkoszek /* Input. Turn off OEN. */ 208249997Swkoszek WR4(sc, ZY7_GPIO_DIRM(pin >> 5), 209249997Swkoszek RD4(sc, ZY7_GPIO_DIRM(pin >> 5)) & ~(1 << (pin & 31))); 210249997Swkoszek WR4(sc, ZY7_GPIO_OEN(pin >> 5), 211249997Swkoszek RD4(sc, ZY7_GPIO_OEN(pin >> 5)) & ~(1 << (pin & 31))); 212249997Swkoszek } 213249997Swkoszek 214249997Swkoszek ZGPIO_UNLOCK(sc); 215249997Swkoszek 216249997Swkoszek return (0); 217249997Swkoszek} 218249997Swkoszek 219249997Swkoszek/* Set a specific output pin's value. */ 220249997Swkoszekstatic int 221249997Swkoszekzy7_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value) 222249997Swkoszek{ 223249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 224249997Swkoszek 225249997Swkoszek if (!VALID_PIN(pin) || value > 1) 226249997Swkoszek return (EINVAL); 227249997Swkoszek 228249997Swkoszek /* Fancy register tricks allow atomic set or reset. */ 229249997Swkoszek if ((pin & 16) != 0) 230249997Swkoszek WR4(sc, ZY7_GPIO_MASK_DATA_MSW(pin >> 5), 231249997Swkoszek (0xffff0000 ^ (0x10000 << (pin & 15))) | 232249997Swkoszek (value << (pin & 15))); 233249997Swkoszek else 234249997Swkoszek WR4(sc, ZY7_GPIO_MASK_DATA_LSW(pin >> 5), 235249997Swkoszek (0xffff0000 ^ (0x10000 << (pin & 15))) | 236249997Swkoszek (value << (pin & 15))); 237249997Swkoszek 238249997Swkoszek return (0); 239249997Swkoszek} 240249997Swkoszek 241249997Swkoszek/* Get a specific pin's input value. */ 242249997Swkoszekstatic int 243249997Swkoszekzy7_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *value) 244249997Swkoszek{ 245249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 246249997Swkoszek 247249997Swkoszek if (!VALID_PIN(pin)) 248249997Swkoszek return (EINVAL); 249249997Swkoszek 250249997Swkoszek *value = (RD4(sc, ZY7_GPIO_DATA_RO(pin >> 5)) >> (pin & 31)) & 1; 251249997Swkoszek 252249997Swkoszek return (0); 253249997Swkoszek} 254249997Swkoszek 255249997Swkoszek/* Toggle a pin's output value. */ 256249997Swkoszekstatic int 257249997Swkoszekzy7_gpio_pin_toggle(device_t dev, uint32_t pin) 258249997Swkoszek{ 259249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 260249997Swkoszek 261249997Swkoszek if (!VALID_PIN(pin)) 262249997Swkoszek return (EINVAL); 263249997Swkoszek 264249997Swkoszek ZGPIO_LOCK(sc); 265249997Swkoszek 266249997Swkoszek WR4(sc, ZY7_GPIO_DATA(pin >> 5), 267249997Swkoszek RD4(sc, ZY7_GPIO_DATA(pin >> 5)) ^ (1 << (pin & 31))); 268249997Swkoszek 269249997Swkoszek ZGPIO_UNLOCK(sc); 270249997Swkoszek 271249997Swkoszek return (0); 272249997Swkoszek} 273249997Swkoszek 274249997Swkoszekstatic int 275249997Swkoszekzy7_gpio_probe(device_t dev) 276249997Swkoszek{ 277249997Swkoszek 278249997Swkoszek if (!ofw_bus_is_compatible(dev, "xlnx,zy7_gpio")) 279249997Swkoszek return (ENXIO); 280249997Swkoszek 281249997Swkoszek device_set_desc(dev, "Zynq-7000 GPIO driver"); 282249997Swkoszek return (0); 283249997Swkoszek} 284249997Swkoszek 285249997Swkoszekstatic void 286249997Swkoszekzy7_gpio_hw_reset(struct zy7_gpio_softc *sc) 287249997Swkoszek{ 288249997Swkoszek int i; 289249997Swkoszek 290249997Swkoszek for (i = 0; i < NUMBANKS; i++) { 291249997Swkoszek WR4(sc, ZY7_GPIO_DATA(i), 0); 292249997Swkoszek WR4(sc, ZY7_GPIO_DIRM(i), 0); 293249997Swkoszek WR4(sc, ZY7_GPIO_OEN(i), 0); 294249997Swkoszek WR4(sc, ZY7_GPIO_INT_DIS(i), 0xffffffff); 295249997Swkoszek WR4(sc, ZY7_GPIO_INT_POLARITY(i), 0); 296249997Swkoszek WR4(sc, ZY7_GPIO_INT_TYPE(i), 297249997Swkoszek i == 1 ? 0x003fffff : 0xffffffff); 298249997Swkoszek WR4(sc, ZY7_GPIO_INT_ANY(i), 0); 299249997Swkoszek WR4(sc, ZY7_GPIO_INT_STAT(i), 0xffffffff); 300249997Swkoszek } 301249997Swkoszek} 302249997Swkoszek 303249997Swkoszekstatic int zy7_gpio_detach(device_t dev); 304249997Swkoszek 305249997Swkoszekstatic int 306249997Swkoszekzy7_gpio_attach(device_t dev) 307249997Swkoszek{ 308249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 309249997Swkoszek int rid; 310249997Swkoszek 311249997Swkoszek sc->dev = dev; 312249997Swkoszek 313249997Swkoszek ZGPIO_LOCK_INIT(sc); 314249997Swkoszek 315249997Swkoszek /* Allocate memory. */ 316249997Swkoszek rid = 0; 317249997Swkoszek sc->mem_res = bus_alloc_resource_any(dev, 318249997Swkoszek SYS_RES_MEMORY, &rid, RF_ACTIVE); 319249997Swkoszek if (sc->mem_res == NULL) { 320249997Swkoszek device_printf(dev, "Can't allocate memory for device"); 321249997Swkoszek zy7_gpio_detach(dev); 322249997Swkoszek return (ENOMEM); 323249997Swkoszek } 324249997Swkoszek 325249997Swkoszek /* Completely reset. */ 326249997Swkoszek zy7_gpio_hw_reset(sc); 327249997Swkoszek 328249997Swkoszek device_add_child(dev, "gpioc", device_get_unit(dev)); 329249997Swkoszek device_add_child(dev, "gpiobus", device_get_unit(dev)); 330249997Swkoszek 331249997Swkoszek return (bus_generic_attach(dev)); 332249997Swkoszek} 333249997Swkoszek 334249997Swkoszekstatic int 335249997Swkoszekzy7_gpio_detach(device_t dev) 336249997Swkoszek{ 337249997Swkoszek struct zy7_gpio_softc *sc = device_get_softc(dev); 338249997Swkoszek 339249997Swkoszek bus_generic_detach(dev); 340249997Swkoszek 341249997Swkoszek if (sc->mem_res != NULL) { 342249997Swkoszek /* Release memory resource. */ 343249997Swkoszek bus_release_resource(dev, SYS_RES_MEMORY, 344249997Swkoszek rman_get_rid(sc->mem_res), sc->mem_res); 345249997Swkoszek } 346249997Swkoszek 347249997Swkoszek ZGPIO_LOCK_DESTROY(sc); 348249997Swkoszek 349249997Swkoszek return (0); 350249997Swkoszek} 351249997Swkoszek 352249997Swkoszekstatic device_method_t zy7_gpio_methods[] = { 353249997Swkoszek /* device_if */ 354249997Swkoszek DEVMETHOD(device_probe, zy7_gpio_probe), 355249997Swkoszek DEVMETHOD(device_attach, zy7_gpio_attach), 356249997Swkoszek DEVMETHOD(device_detach, zy7_gpio_detach), 357249997Swkoszek 358249997Swkoszek /* GPIO protocol */ 359249997Swkoszek DEVMETHOD(gpio_pin_max, zy7_gpio_pin_max), 360249997Swkoszek DEVMETHOD(gpio_pin_getname, zy7_gpio_pin_getname), 361249997Swkoszek DEVMETHOD(gpio_pin_getflags, zy7_gpio_pin_getflags), 362249997Swkoszek DEVMETHOD(gpio_pin_getcaps, zy7_gpio_pin_getcaps), 363249997Swkoszek DEVMETHOD(gpio_pin_setflags, zy7_gpio_pin_setflags), 364249997Swkoszek DEVMETHOD(gpio_pin_get, zy7_gpio_pin_get), 365249997Swkoszek DEVMETHOD(gpio_pin_set, zy7_gpio_pin_set), 366249997Swkoszek DEVMETHOD(gpio_pin_toggle, zy7_gpio_pin_toggle), 367249997Swkoszek 368249997Swkoszek DEVMETHOD_END 369249997Swkoszek}; 370249997Swkoszek 371249997Swkoszekstatic driver_t zy7_gpio_driver = { 372249997Swkoszek "zy7_gpio", 373249997Swkoszek zy7_gpio_methods, 374249997Swkoszek sizeof(struct zy7_gpio_softc), 375249997Swkoszek}; 376249997Swkoszekstatic devclass_t zy7_gpio_devclass; 377249997Swkoszek 378249997Swkoszekextern devclass_t gpiobus_devclass, gpioc_devclass; 379249997Swkoszekextern driver_t gpiobus_driver, gpioc_driver; 380249997Swkoszek 381249997SwkoszekDRIVER_MODULE(zy7_gpio, simplebus, zy7_gpio_driver, zy7_gpio_devclass, \ 382249997Swkoszek NULL, NULL); 383249997SwkoszekDRIVER_MODULE(gpiobus, zy7_gpio, gpiobus_driver, gpiobus_devclass, 0, 0); 384249997SwkoszekDRIVER_MODULE(gpioc, zy7_gpio, gpioc_driver, gpioc_devclass, 0, 0); 385