sys/arm/allwinner/a10_gpio.c

   1 /*-
   2  * Copyright (c) 2013 Ganbold Tsagaankhuu <ganbold@freebsd.org>
   3  * Copyright (c) 2012 Oleksandr Tymoshenko <gonzo@freebsd.org>
   4  * Copyright (c) 2012 Luiz Otavio O Souza.
   5  * All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  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.
  15  *
  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
  26  * SUCH DAMAGE.
  27  *
  28  */
  29 #include <sys/cdefs.h>
  30 __FBSDID("$FreeBSD$");
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/bus.h>
  35
  36 #include <sys/kernel.h>
  37 #include <sys/module.h>
  38 #include <sys/rman.h>
  39 #include <sys/lock.h>
  40 #include <sys/mutex.h>
  41 #include <sys/gpio.h>
  42
  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>
  49
  50 #include <dev/fdt/fdt_common.h>
  51 #include <dev/ofw/ofw_bus.h>
  52 #include <dev/ofw/ofw_bus_subr.h>
  53
  54 #include "gpio_if.h"
  55 #include "a10_gpio.h"
  56
  57 /*
  58  * A10 have 9 banks of gpio.
  59  * 32 pins per bank:
  60  * PA0 - PA17 | PB0 - PB23 | PC0 - PC24
  61  * PD0 - PD27 | PE0 - PE31 | PF0 - PF5
  62  * PG0 - PG9 | PH0 - PH27 | PI0 - PI12
  63  */
  64
  65 #define A10_GPIO_PINS           288
  66 #define A10_GPIO_DEFAULT_CAPS   (GPIO_PIN_INPUT | GPIO_PIN_OUTPUT |     \
  67     GPIO_PIN_PULLUP | GPIO_PIN_PULLDOWN)
  68
  69 #define A10_GPIO_NONE           0
  70 #define A10_GPIO_PULLUP         1
  71 #define A10_GPIO_PULLDOWN       2
  72
  73 #define A10_GPIO_INPUT          0
  74 #define A10_GPIO_OUTPUT         1
  75
  76 struct a10_gpio_softc {
  77         device_t                sc_dev;
  78         struct mtx              sc_mtx;
  79         struct resource *       sc_mem_res;
  80         struct resource *       sc_irq_res;
  81         bus_space_tag_t         sc_bst;
  82         bus_space_handle_t      sc_bsh;
  83         void *                  sc_intrhand;
  84         int                     sc_gpio_npins;
  85         struct gpio_pin         sc_gpio_pins[A10_GPIO_PINS];
  86 };
  87
  88 #define A10_GPIO_LOCK(_sc)              mtx_lock(&_sc->sc_mtx)
  89 #define A10_GPIO_UNLOCK(_sc)            mtx_unlock(&_sc->sc_mtx)
  90 #define A10_GPIO_LOCK_ASSERT(_sc)       mtx_assert(&_sc->sc_mtx, MA_OWNED)
  91
  92 #define A10_GPIO_GP_CFG(_bank, _pin)    0x00 + ((_bank) * 0x24) + ((_pin)<<2)
  93 #define A10_GPIO_GP_DAT(_bank)          0x10 + ((_bank) * 0x24)
  94 #define A10_GPIO_GP_DRV(_bank, _pin)    0x14 + ((_bank) * 0x24) + ((_pin)<<2)
  95 #define A10_GPIO_GP_PUL(_bank, _pin)    0x1c + ((_bank) * 0x24) + ((_pin)<<2)
  96
  97 #define A10_GPIO_GP_INT_CFG0            0x200
  98 #define A10_GPIO_GP_INT_CFG1            0x204
  99 #define A10_GPIO_GP_INT_CFG2            0x208
 100 #define A10_GPIO_GP_INT_CFG3            0x20c
 101
 102 #define A10_GPIO_GP_INT_CTL             0x210
 103 #define A10_GPIO_GP_INT_STA             0x214
 104 #define A10_GPIO_GP_INT_DEB             0x218
 105
 106 static struct a10_gpio_softc *a10_gpio_sc;
 107
 108 #define A10_GPIO_WRITE(_sc, _off, _val)         \
 109     bus_space_write_4(_sc->sc_bst, _sc->sc_bsh, _off, _val)
 110 #define A10_GPIO_READ(_sc, _off)                \
 111     bus_space_read_4(_sc->sc_bst, _sc->sc_bsh, _off)
 112
 113 static uint32_t
 114 a10_gpio_get_function(struct a10_gpio_softc *sc, uint32_t pin)
 115 {
 116         uint32_t bank, func, offset;
 117
 118         bank = pin / 32;
 119         pin = pin - 32 * bank;
 120         func = pin >> 3;
 121         offset = ((pin & 0x07) << 2);
 122
 123         A10_GPIO_LOCK(sc);
 124         func = (A10_GPIO_READ(sc, A10_GPIO_GP_CFG(bank, func)) >> offset) & 7;
 125         A10_GPIO_UNLOCK(sc);
 126
 127         return (func);
 128 }
 129
 130 static uint32_t
 131 a10_gpio_func_flag(uint32_t nfunc)
 132 {
 133
 134         switch (nfunc) {
 135         case A10_GPIO_INPUT:
 136                 return (GPIO_PIN_INPUT);
 137         case A10_GPIO_OUTPUT:
 138                 return (GPIO_PIN_OUTPUT);
 139         }
 140         return (0);
 141 }
 142
 143 static void
 144 a10_gpio_set_function(struct a10_gpio_softc *sc, uint32_t pin, uint32_t f)
 145 {
 146         uint32_t bank, func, data, offset;
 147
 148         /* Must be called with lock held. */
 149         A10_GPIO_LOCK_ASSERT(sc);
 150
 151         bank = pin / 32;
 152         pin = pin - 32 * bank;
 153         func = pin >> 3;
 154         offset = ((pin & 0x07) << 2);
 155
 156         data = A10_GPIO_READ(sc, A10_GPIO_GP_CFG(bank, func));
 157         data &= ~(7 << offset);
 158         data |= (f << offset);
 159         A10_GPIO_WRITE(sc, A10_GPIO_GP_CFG(bank, func), data);
 160 }
 161
 162 static void
 163 a10_gpio_set_pud(struct a10_gpio_softc *sc, uint32_t pin, uint32_t state)
 164 {
 165         uint32_t bank, offset, pull, val;
 166
 167         /* Must be called with lock held. */
 168         A10_GPIO_LOCK_ASSERT(sc);
 169
 170         bank = pin / 32;
 171         pin = pin - 32 * bank;
 172         pull = pin >> 4;
 173         offset = ((pin & 0x0f) << 1);
 174
 175         val = A10_GPIO_READ(sc, A10_GPIO_GP_PUL(bank, pull));
 176         val &= ~(0x03 << offset);
 177         val |= (state << offset);
 178         A10_GPIO_WRITE(sc, A10_GPIO_GP_PUL(bank, pull), val);
 179 }
 180
 181 static void
 182 a10_gpio_pin_configure(struct a10_gpio_softc *sc, struct gpio_pin *pin,
 183     unsigned int flags)
 184 {
 185
 186         A10_GPIO_LOCK(sc);
 187
 188         /*
 189          * Manage input/output.
 190          */
 191         if (flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) {
 192                 pin->gp_flags &= ~(GPIO_PIN_INPUT|GPIO_PIN_OUTPUT);
 193                 if (flags & GPIO_PIN_OUTPUT) {
 194                         pin->gp_flags |= GPIO_PIN_OUTPUT;
 195                         a10_gpio_set_function(sc, pin->gp_pin,
 196                             A10_GPIO_OUTPUT);
 197                 } else {
 198                         pin->gp_flags |= GPIO_PIN_INPUT;
 199                         a10_gpio_set_function(sc, pin->gp_pin,
 200                             A10_GPIO_INPUT);
 201                 }
 202         }
 203
 204         /* Manage Pull-up/pull-down. */
 205         pin->gp_flags &= ~(GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN);
 206         if (flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) {
 207                 if (flags & GPIO_PIN_PULLUP) {
 208                         pin->gp_flags |= GPIO_PIN_PULLUP;
 209                         a10_gpio_set_pud(sc, pin->gp_pin, A10_GPIO_PULLUP);
 210                 } else {
 211                         pin->gp_flags |= GPIO_PIN_PULLDOWN;
 212                         a10_gpio_set_pud(sc, pin->gp_pin, A10_GPIO_PULLDOWN);
 213                 }
 214         } else
 215                 a10_gpio_set_pud(sc, pin->gp_pin, A10_GPIO_NONE);
 216
 217         A10_GPIO_UNLOCK(sc);
 218 }
 219
 220 static int
 221 a10_gpio_pin_max(device_t dev, int *maxpin)
 222 {
 223
 224         *maxpin = A10_GPIO_PINS - 1;
 225         return (0);
 226 }
 227
 228 static int
 229 a10_gpio_pin_getcaps(device_t dev, uint32_t pin, uint32_t *caps)
 230 {
 231         struct a10_gpio_softc *sc = device_get_softc(dev);
 232         int i;
 233
 234         for (i = 0; i < sc->sc_gpio_npins; i++) {
 235                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 236                         break;
 237         }
 238
 239         if (i >= sc->sc_gpio_npins)
 240                 return (EINVAL);
 241
 242         A10_GPIO_LOCK(sc);
 243         *caps = sc->sc_gpio_pins[i].gp_caps;
 244         A10_GPIO_UNLOCK(sc);
 245
 246         return (0);
 247 }
 248
 249 static int
 250 a10_gpio_pin_getflags(device_t dev, uint32_t pin, uint32_t *flags)
 251 {
 252         struct a10_gpio_softc *sc = device_get_softc(dev);
 253         int i;
 254
 255         for (i = 0; i < sc->sc_gpio_npins; i++) {
 256                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 257                         break;
 258         }
 259
 260         if (i >= sc->sc_gpio_npins)
 261                 return (EINVAL);
 262
 263         A10_GPIO_LOCK(sc);
 264         *flags = sc->sc_gpio_pins[i].gp_flags;
 265         A10_GPIO_UNLOCK(sc);
 266
 267         return (0);
 268 }
 269
 270 static int
 271 a10_gpio_pin_getname(device_t dev, uint32_t pin, char *name)
 272 {
 273         struct a10_gpio_softc *sc = device_get_softc(dev);
 274         int i;
 275
 276         for (i = 0; i < sc->sc_gpio_npins; i++) {
 277                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 278                         break;
 279         }
 280
 281         if (i >= sc->sc_gpio_npins)
 282                 return (EINVAL);
 283
 284         A10_GPIO_LOCK(sc);
 285         memcpy(name, sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME);
 286         A10_GPIO_UNLOCK(sc);
 287
 288         return (0);
 289 }
 290
 291 static int
 292 a10_gpio_pin_setflags(device_t dev, uint32_t pin, uint32_t flags)
 293 {
 294         struct a10_gpio_softc *sc = device_get_softc(dev);
 295         int i;
 296
 297         for (i = 0; i < sc->sc_gpio_npins; i++) {
 298                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 299                         break;
 300         }
 301
 302         if (i >= sc->sc_gpio_npins)
 303                 return (EINVAL);
 304
 305         /* Check for unwanted flags. */
 306         if ((flags & sc->sc_gpio_pins[i].gp_caps) != flags)
 307                 return (EINVAL);
 308
 309         /* Can't mix input/output together. */
 310         if ((flags & (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT)) ==
 311             (GPIO_PIN_INPUT|GPIO_PIN_OUTPUT))
 312                 return (EINVAL);
 313
 314         /* Can't mix pull-up/pull-down together. */
 315         if ((flags & (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN)) ==
 316             (GPIO_PIN_PULLUP|GPIO_PIN_PULLDOWN))
 317                 return (EINVAL);
 318
 319         a10_gpio_pin_configure(sc, &sc->sc_gpio_pins[i], flags);
 320
 321         return (0);
 322 }
 323
 324 static int
 325 a10_gpio_pin_set(device_t dev, uint32_t pin, unsigned int value)
 326 {
 327         struct a10_gpio_softc *sc = device_get_softc(dev);
 328         uint32_t bank, offset, data;
 329         int i;
 330
 331         for (i = 0; i < sc->sc_gpio_npins; i++) {
 332                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 333                         break;
 334         }
 335
 336         if (i >= sc->sc_gpio_npins)
 337                 return (EINVAL);
 338
 339         bank = pin / 32;
 340         pin = pin - 32 * bank;
 341         offset = pin & 0x1f;
 342
 343         A10_GPIO_LOCK(sc);
 344         data = A10_GPIO_READ(sc, A10_GPIO_GP_DAT(bank));
 345         if (value)
 346                 data |= (1 << offset);
 347         else
 348                 data &= ~(1 << offset);
 349         A10_GPIO_WRITE(sc, A10_GPIO_GP_DAT(bank), data);
 350         A10_GPIO_UNLOCK(sc);
 351
 352         return (0);
 353 }
 354
 355 static int
 356 a10_gpio_pin_get(device_t dev, uint32_t pin, unsigned int *val)
 357 {
 358         struct a10_gpio_softc *sc = device_get_softc(dev);
 359         uint32_t bank, offset, reg_data;
 360         int i;
 361
 362         for (i = 0; i < sc->sc_gpio_npins; i++) {
 363                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 364                         break;
 365         }
 366
 367         if (i >= sc->sc_gpio_npins)
 368                 return (EINVAL);
 369
 370         bank = pin / 32;
 371         pin = pin - 32 * bank;
 372         offset = pin & 0x1f;
 373
 374         A10_GPIO_LOCK(sc);
 375         reg_data = A10_GPIO_READ(sc, A10_GPIO_GP_DAT(bank));
 376         A10_GPIO_UNLOCK(sc);
 377         *val = (reg_data & (1 << offset)) ? 1 : 0;
 378
 379         return (0);
 380 }
 381
 382 static int
 383 a10_gpio_pin_toggle(device_t dev, uint32_t pin)
 384 {
 385         struct a10_gpio_softc *sc = device_get_softc(dev);
 386         uint32_t bank, data, offset;
 387         int i;
 388
 389         for (i = 0; i < sc->sc_gpio_npins; i++) {
 390                 if (sc->sc_gpio_pins[i].gp_pin == pin)
 391                         break;
 392         }
 393
 394         if (i >= sc->sc_gpio_npins)
 395                 return (EINVAL);
 396
 397         bank = pin / 32;
 398         pin = pin - 32 * bank;
 399         offset = pin & 0x1f;
 400
 401         A10_GPIO_LOCK(sc);
 402         data = A10_GPIO_READ(sc, A10_GPIO_GP_DAT(bank));
 403         if (data & (1 << offset))
 404                 data &= ~(1 << offset);
 405         else
 406                 data |= (1 << offset);
 407         A10_GPIO_WRITE(sc, A10_GPIO_GP_DAT(bank), data);
 408         A10_GPIO_UNLOCK(sc);
 409
 410         return (0);
 411 }
 412
 413 static int
 414 a10_gpio_probe(device_t dev)
 415 {
 416
 417         if (!ofw_bus_status_okay(dev))
 418                 return (ENXIO);
 419
 420         if (!ofw_bus_is_compatible(dev, "allwinner,sun4i-gpio"))
 421                 return (ENXIO);
 422
 423         device_set_desc(dev, "Allwinner GPIO controller");
 424         return (BUS_PROBE_DEFAULT);
 425 }
 426
 427 static int
 428 a10_gpio_attach(device_t dev)
 429 {
 430         struct a10_gpio_softc *sc = device_get_softc(dev);
 431         uint32_t func;
 432         int i, rid;
 433         phandle_t gpio;
 434
 435         sc->sc_dev = dev;
 436
 437         mtx_init(&sc->sc_mtx, "a10 gpio", "gpio", MTX_DEF);
 438
 439         rid = 0;
 440         sc->sc_mem_res = bus_alloc_resource_any(dev, SYS_RES_MEMORY, &rid,
 441             RF_ACTIVE);
 442         if (!sc->sc_mem_res) {
 443                 device_printf(dev, "cannot allocate memory window\n");
 444                 return (ENXIO);
 445         }
 446
 447         sc->sc_bst = rman_get_bustag(sc->sc_mem_res);
 448         sc->sc_bsh = rman_get_bushandle(sc->sc_mem_res);
 449
 450         rid = 0;
 451         sc->sc_irq_res = bus_alloc_resource_any(dev, SYS_RES_IRQ, &rid,
 452             RF_ACTIVE);
 453         if (!sc->sc_irq_res) {
 454                 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
 455                 device_printf(dev, "cannot allocate interrupt\n");
 456                 return (ENXIO);
 457         }
 458
 459         /* Find our node. */
 460         gpio = ofw_bus_get_node(sc->sc_dev);
 461
 462         if (!OF_hasprop(gpio, "gpio-controller"))
 463                 /* Node is not a GPIO controller. */
 464                 goto fail;
 465
 466         /* Initialize the software controlled pins. */
 467         for (i = 0; i < A10_GPIO_PINS; i++) {
 468                 snprintf(sc->sc_gpio_pins[i].gp_name, GPIOMAXNAME,
 469                     "pin %d", i);
 470                 func = a10_gpio_get_function(sc, i);
 471                 sc->sc_gpio_pins[i].gp_pin = i;
 472                 sc->sc_gpio_pins[i].gp_caps = A10_GPIO_DEFAULT_CAPS;
 473                 sc->sc_gpio_pins[i].gp_flags = a10_gpio_func_flag(func);
 474         }
 475         sc->sc_gpio_npins = i;
 476
 477         device_add_child(dev, "gpioc", device_get_unit(dev));
 478         device_add_child(dev, "gpiobus", device_get_unit(dev));
 479
 480         a10_gpio_sc = sc;
 481
 482         return (bus_generic_attach(dev));
 483
 484 fail:
 485         if (sc->sc_irq_res)
 486                 bus_release_resource(dev, SYS_RES_IRQ, 0, sc->sc_irq_res);
 487         if (sc->sc_mem_res)
 488                 bus_release_resource(dev, SYS_RES_MEMORY, 0, sc->sc_mem_res);
 489         return (ENXIO);
 490 }
 491
 492 static int
 493 a10_gpio_detach(device_t dev)
 494 {
 495
 496         return (EBUSY);
 497 }
 498
 499 static device_method_t a10_gpio_methods[] = {
 500         /* Device interface */
 501         DEVMETHOD(device_probe,         a10_gpio_probe),
 502         DEVMETHOD(device_attach,        a10_gpio_attach),
 503         DEVMETHOD(device_detach,        a10_gpio_detach),
 504
 505         /* GPIO protocol */
 506         DEVMETHOD(gpio_pin_max,         a10_gpio_pin_max),
 507         DEVMETHOD(gpio_pin_getname,     a10_gpio_pin_getname),
 508         DEVMETHOD(gpio_pin_getflags,    a10_gpio_pin_getflags),
 509         DEVMETHOD(gpio_pin_getcaps,     a10_gpio_pin_getcaps),
 510         DEVMETHOD(gpio_pin_setflags,    a10_gpio_pin_setflags),
 511         DEVMETHOD(gpio_pin_get,         a10_gpio_pin_get),
 512         DEVMETHOD(gpio_pin_set,         a10_gpio_pin_set),
 513         DEVMETHOD(gpio_pin_toggle,      a10_gpio_pin_toggle),
 514
 515         DEVMETHOD_END
 516 };
 517
 518 static devclass_t a10_gpio_devclass;
 519
 520 static driver_t a10_gpio_driver = {
 521         "gpio",
 522         a10_gpio_methods,
 523         sizeof(struct a10_gpio_softc),
 524 };
 525
 526 DRIVER_MODULE(a10_gpio, simplebus, a10_gpio_driver, a10_gpio_devclass, 0, 0);
 527
 528 int
 529 a10_emac_gpio_config(uint32_t pin)
 530 {
 531         struct a10_gpio_softc *sc = a10_gpio_sc;
 532
 533         if (sc == NULL)
 534                 return (ENXIO);
 535
 536         /* Configure pin mux settings for MII. */
 537         A10_GPIO_LOCK(sc);
 538         a10_gpio_set_function(sc, pin, A10_GPIO_PULLDOWN);
 539         A10_GPIO_UNLOCK(sc);
 540
 541         return (0);
 542 }