drivers/gpio/gpio-mxc.c

   1 /*
   2  * MXC GPIO support. (c) 2008 Daniel Mack <daniel@caiaq.de>
   3  * Copyright 2008 Juergen Beisert, kernel@pengutronix.de
   4  *
   5  * Based on code from Freescale,
   6  * Copyright (C) 2004-2010 Freescale Semiconductor, Inc. All Rights Reserved.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20  */
  21
  22 #include <linux/init.h>
  23 #include <linux/interrupt.h>
  24 #include <linux/io.h>
  25 #include <linux/irq.h>
  26 #include <linux/irqdomain.h>
  27 #include <linux/gpio.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/slab.h>
  30 #include <linux/basic_mmio_gpio.h>
  31 #include <linux/of.h>
  32 #include <linux/of_device.h>
  33 #include <linux/module.h>
  34 #include <asm-generic/bug.h>
  35 #include <asm/mach/irq.h>
  36
  37 enum mxc_gpio_hwtype {
  38         IMX1_GPIO,      /* runs on i.mx1 */
  39         IMX21_GPIO,     /* runs on i.mx21 and i.mx27 */
  40         IMX31_GPIO,     /* runs on all other i.mx */
  41 };
  42
  43 /* device type dependent stuff */
  44 struct mxc_gpio_hwdata {
  45         unsigned dr_reg;
  46         unsigned gdir_reg;
  47         unsigned psr_reg;
  48         unsigned icr1_reg;
  49         unsigned icr2_reg;
  50         unsigned imr_reg;
  51         unsigned isr_reg;
  52         unsigned low_level;
  53         unsigned high_level;
  54         unsigned rise_edge;
  55         unsigned fall_edge;
  56 };
  57
  58 struct mxc_gpio_port {
  59         struct list_head node;
  60         void __iomem *base;
  61         int irq;
  62         int irq_high;
  63         struct irq_domain *domain;
  64         struct bgpio_chip bgc;
  65         u32 both_edges;
  66 };
  67
  68 static struct mxc_gpio_hwdata imx1_imx21_gpio_hwdata = {
  69         .dr_reg         = 0x1c,
  70         .gdir_reg       = 0x00,
  71         .psr_reg        = 0x24,
  72         .icr1_reg       = 0x28,
  73         .icr2_reg       = 0x2c,
  74         .imr_reg        = 0x30,
  75         .isr_reg        = 0x34,
  76         .low_level      = 0x03,
  77         .high_level     = 0x02,
  78         .rise_edge      = 0x00,
  79         .fall_edge      = 0x01,
  80 };
  81
  82 static struct mxc_gpio_hwdata imx31_gpio_hwdata = {
  83         .dr_reg         = 0x00,
  84         .gdir_reg       = 0x04,
  85         .psr_reg        = 0x08,
  86         .icr1_reg       = 0x0c,
  87         .icr2_reg       = 0x10,
  88         .imr_reg        = 0x14,
  89         .isr_reg        = 0x18,
  90         .low_level      = 0x00,
  91         .high_level     = 0x01,
  92         .rise_edge      = 0x02,
  93         .fall_edge      = 0x03,
  94 };
  95
  96 static enum mxc_gpio_hwtype mxc_gpio_hwtype;
  97 static struct mxc_gpio_hwdata *mxc_gpio_hwdata;
  98
  99 #define GPIO_DR                 (mxc_gpio_hwdata->dr_reg)
 100 #define GPIO_GDIR               (mxc_gpio_hwdata->gdir_reg)
 101 #define GPIO_PSR                (mxc_gpio_hwdata->psr_reg)
 102 #define GPIO_ICR1               (mxc_gpio_hwdata->icr1_reg)
 103 #define GPIO_ICR2               (mxc_gpio_hwdata->icr2_reg)
 104 #define GPIO_IMR                (mxc_gpio_hwdata->imr_reg)
 105 #define GPIO_ISR                (mxc_gpio_hwdata->isr_reg)
 106
 107 #define GPIO_INT_LOW_LEV        (mxc_gpio_hwdata->low_level)
 108 #define GPIO_INT_HIGH_LEV       (mxc_gpio_hwdata->high_level)
 109 #define GPIO_INT_RISE_EDGE      (mxc_gpio_hwdata->rise_edge)
 110 #define GPIO_INT_FALL_EDGE      (mxc_gpio_hwdata->fall_edge)
 111 #define GPIO_INT_NONE           0x4
 112
 113 static struct platform_device_id mxc_gpio_devtype[] = {
 114         {
 115                 .name = "imx1-gpio",
 116                 .driver_data = IMX1_GPIO,
 117         }, {
 118                 .name = "imx21-gpio",
 119                 .driver_data = IMX21_GPIO,
 120         }, {
 121                 .name = "imx31-gpio",
 122                 .driver_data = IMX31_GPIO,
 123         }, {
 124                 /* sentinel */
 125         }
 126 };
 127
 128 static const struct of_device_id mxc_gpio_dt_ids[] = {
 129         { .compatible = "fsl,imx1-gpio", .data = &mxc_gpio_devtype[IMX1_GPIO], },
 130         { .compatible = "fsl,imx21-gpio", .data = &mxc_gpio_devtype[IMX21_GPIO], },
 131         { .compatible = "fsl,imx31-gpio", .data = &mxc_gpio_devtype[IMX31_GPIO], },
 132         { /* sentinel */ }
 133 };
 134
 135 /*
 136  * MX2 has one interrupt *for all* gpio ports. The list is used
 137  * to save the references to all ports, so that mx2_gpio_irq_handler
 138  * can walk through all interrupt status registers.
 139  */
 140 static LIST_HEAD(mxc_gpio_ports);
 141
 142 /* Note: This driver assumes 32 GPIOs are handled in one register */
 143
 144 static int gpio_set_irq_type(struct irq_data *d, u32 type)
 145 {
 146         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 147         struct mxc_gpio_port *port = gc->private;
 148         u32 bit, val;
 149         u32 gpio_idx = d->hwirq;
 150         u32 gpio = port->bgc.gc.base + gpio_idx;
 151         int edge;
 152         void __iomem *reg = port->base;
 153
 154         port->both_edges &= ~(1 << gpio_idx);
 155         switch (type) {
 156         case IRQ_TYPE_EDGE_RISING:
 157                 edge = GPIO_INT_RISE_EDGE;
 158                 break;
 159         case IRQ_TYPE_EDGE_FALLING:
 160                 edge = GPIO_INT_FALL_EDGE;
 161                 break;
 162         case IRQ_TYPE_EDGE_BOTH:
 163                 val = gpio_get_value(gpio);
 164                 if (val) {
 165                         edge = GPIO_INT_LOW_LEV;
 166                         pr_debug("mxc: set GPIO %d to low trigger\n", gpio);
 167                 } else {
 168                         edge = GPIO_INT_HIGH_LEV;
 169                         pr_debug("mxc: set GPIO %d to high trigger\n", gpio);
 170                 }
 171                 port->both_edges |= 1 << gpio_idx;
 172                 break;
 173         case IRQ_TYPE_LEVEL_LOW:
 174                 edge = GPIO_INT_LOW_LEV;
 175                 break;
 176         case IRQ_TYPE_LEVEL_HIGH:
 177                 edge = GPIO_INT_HIGH_LEV;
 178                 break;
 179         default:
 180                 return -EINVAL;
 181         }
 182
 183         reg += GPIO_ICR1 + ((gpio_idx & 0x10) >> 2); /* ICR1 or ICR2 */
 184         bit = gpio_idx & 0xf;
 185         val = readl(reg) & ~(0x3 << (bit << 1));
 186         writel(val | (edge << (bit << 1)), reg);
 187         writel(1 << gpio_idx, port->base + GPIO_ISR);
 188
 189         return 0;
 190 }
 191
 192 static void mxc_flip_edge(struct mxc_gpio_port *port, u32 gpio)
 193 {
 194         void __iomem *reg = port->base;
 195         u32 bit, val;
 196         int edge;
 197
 198         reg += GPIO_ICR1 + ((gpio & 0x10) >> 2); /* lower or upper register */
 199         bit = gpio & 0xf;
 200         val = readl(reg);
 201         edge = (val >> (bit << 1)) & 3;
 202         val &= ~(0x3 << (bit << 1));
 203         if (edge == GPIO_INT_HIGH_LEV) {
 204                 edge = GPIO_INT_LOW_LEV;
 205                 pr_debug("mxc: switch GPIO %d to low trigger\n", gpio);
 206         } else if (edge == GPIO_INT_LOW_LEV) {
 207                 edge = GPIO_INT_HIGH_LEV;
 208                 pr_debug("mxc: switch GPIO %d to high trigger\n", gpio);
 209         } else {
 210                 pr_err("mxc: invalid configuration for GPIO %d: %x\n",
 211                        gpio, edge);
 212                 return;
 213         }
 214         writel(val | (edge << (bit << 1)), reg);
 215 }
 216
 217 /* handle 32 interrupts in one status register */
 218 static void mxc_gpio_irq_handler(struct mxc_gpio_port *port, u32 irq_stat)
 219 {
 220         while (irq_stat != 0) {
 221                 int irqoffset = fls(irq_stat) - 1;
 222
 223                 if (port->both_edges & (1 << irqoffset))
 224                         mxc_flip_edge(port, irqoffset);
 225
 226                 generic_handle_irq(irq_find_mapping(port->domain, irqoffset));
 227
 228                 irq_stat &= ~(1 << irqoffset);
 229         }
 230 }
 231
 232 /* MX1 and MX3 has one interrupt *per* gpio port */
 233 static void mx3_gpio_irq_handler(u32 irq, struct irq_desc *desc)
 234 {
 235         u32 irq_stat;
 236         struct mxc_gpio_port *port = irq_get_handler_data(irq);
 237         struct irq_chip *chip = irq_get_chip(irq);
 238
 239         chained_irq_enter(chip, desc);
 240
 241         irq_stat = readl(port->base + GPIO_ISR) & readl(port->base + GPIO_IMR);
 242
 243         mxc_gpio_irq_handler(port, irq_stat);
 244
 245         chained_irq_exit(chip, desc);
 246 }
 247
 248 /* MX2 has one interrupt *for all* gpio ports */
 249 static void mx2_gpio_irq_handler(u32 irq, struct irq_desc *desc)
 250 {
 251         u32 irq_msk, irq_stat;
 252         struct mxc_gpio_port *port;
 253
 254         /* walk through all interrupt status registers */
 255         list_for_each_entry(port, &mxc_gpio_ports, node) {
 256                 irq_msk = readl(port->base + GPIO_IMR);
 257                 if (!irq_msk)
 258                         continue;
 259
 260                 irq_stat = readl(port->base + GPIO_ISR) & irq_msk;
 261                 if (irq_stat)
 262                         mxc_gpio_irq_handler(port, irq_stat);
 263         }
 264 }
 265
 266 /*
 267  * Set interrupt number "irq" in the GPIO as a wake-up source.
 268  * While system is running, all registered GPIO interrupts need to have
 269  * wake-up enabled. When system is suspended, only selected GPIO interrupts
 270  * need to have wake-up enabled.
 271  * @param  irq          interrupt source number
 272  * @param  enable       enable as wake-up if equal to non-zero
 273  * @return       This function returns 0 on success.
 274  */
 275 static int gpio_set_wake_irq(struct irq_data *d, u32 enable)
 276 {
 277         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 278         struct mxc_gpio_port *port = gc->private;
 279         u32 gpio_idx = d->hwirq;
 280
 281         if (enable) {
 282                 if (port->irq_high && (gpio_idx >= 16))
 283                         enable_irq_wake(port->irq_high);
 284                 else
 285                         enable_irq_wake(port->irq);
 286         } else {
 287                 if (port->irq_high && (gpio_idx >= 16))
 288                         disable_irq_wake(port->irq_high);
 289                 else
 290                         disable_irq_wake(port->irq);
 291         }
 292
 293         return 0;
 294 }
 295
 296 static void __init mxc_gpio_init_gc(struct mxc_gpio_port *port, int irq_base)
 297 {
 298         struct irq_chip_generic *gc;
 299         struct irq_chip_type *ct;
 300
 301         gc = irq_alloc_generic_chip("gpio-mxc", 1, irq_base,
 302                                     port->base, handle_level_irq);
 303         gc->private = port;
 304
 305         ct = gc->chip_types;
 306         ct->chip.irq_ack = irq_gc_ack_set_bit;
 307         ct->chip.irq_mask = irq_gc_mask_clr_bit;
 308         ct->chip.irq_unmask = irq_gc_mask_set_bit;
 309         ct->chip.irq_set_type = gpio_set_irq_type;
 310         ct->chip.irq_set_wake = gpio_set_wake_irq;
 311         ct->regs.ack = GPIO_ISR;
 312         ct->regs.mask = GPIO_IMR;
 313
 314         irq_setup_generic_chip(gc, IRQ_MSK(32), IRQ_GC_INIT_NESTED_LOCK,
 315                                IRQ_NOREQUEST, 0);
 316 }
 317
 318 static void __devinit mxc_gpio_get_hw(struct platform_device *pdev)
 319 {
 320         const struct of_device_id *of_id =
 321                         of_match_device(mxc_gpio_dt_ids, &pdev->dev);
 322         enum mxc_gpio_hwtype hwtype;
 323
 324         if (of_id)
 325                 pdev->id_entry = of_id->data;
 326         hwtype = pdev->id_entry->driver_data;
 327
 328         if (mxc_gpio_hwtype) {
 329                 /*
 330                  * The driver works with a reasonable presupposition,
 331                  * that is all gpio ports must be the same type when
 332                  * running on one soc.
 333                  */
 334                 BUG_ON(mxc_gpio_hwtype != hwtype);
 335                 return;
 336         }
 337
 338         if (hwtype == IMX31_GPIO)
 339                 mxc_gpio_hwdata = &imx31_gpio_hwdata;
 340         else
 341                 mxc_gpio_hwdata = &imx1_imx21_gpio_hwdata;
 342
 343         mxc_gpio_hwtype = hwtype;
 344 }
 345
 346 static int mxc_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
 347 {
 348         struct bgpio_chip *bgc = to_bgpio_chip(gc);
 349         struct mxc_gpio_port *port =
 350                 container_of(bgc, struct mxc_gpio_port, bgc);
 351
 352         return irq_find_mapping(port->domain, offset);
 353 }
 354
 355 static int __devinit mxc_gpio_probe(struct platform_device *pdev)
 356 {
 357         struct device_node *np = pdev->dev.of_node;
 358         struct mxc_gpio_port *port;
 359         struct resource *iores;
 360         int irq_base;
 361         int err;
 362
 363         mxc_gpio_get_hw(pdev);
 364
 365         port = kzalloc(sizeof(struct mxc_gpio_port), GFP_KERNEL);
 366         if (!port)
 367                 return -ENOMEM;
 368
 369         iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 370         if (!iores) {
 371                 err = -ENODEV;
 372                 goto out_kfree;
 373         }
 374
 375         if (!request_mem_region(iores->start, resource_size(iores),
 376                                 pdev->name)) {
 377                 err = -EBUSY;
 378                 goto out_kfree;
 379         }
 380
 381         port->base = ioremap(iores->start, resource_size(iores));
 382         if (!port->base) {
 383                 err = -ENOMEM;
 384                 goto out_release_mem;
 385         }
 386
 387         port->irq_high = platform_get_irq(pdev, 1);
 388         port->irq = platform_get_irq(pdev, 0);
 389         if (port->irq < 0) {
 390                 err = -EINVAL;
 391                 goto out_iounmap;
 392         }
 393
 394         /* disable the interrupt and clear the status */
 395         writel(0, port->base + GPIO_IMR);
 396         writel(~0, port->base + GPIO_ISR);
 397
 398         if (mxc_gpio_hwtype == IMX21_GPIO) {
 399                 /*
 400                  * Setup one handler for all GPIO interrupts. Actually setting
 401                  * the handler is needed only once, but doing it for every port
 402                  * is more robust and easier.
 403                  */
 404                 irq_set_chained_handler(port->irq, mx2_gpio_irq_handler);
 405         } else {
 406                 /* setup one handler for each entry */
 407                 irq_set_chained_handler(port->irq, mx3_gpio_irq_handler);
 408                 irq_set_handler_data(port->irq, port);
 409                 if (port->irq_high > 0) {
 410                         /* setup handler for GPIO 16 to 31 */
 411                         irq_set_chained_handler(port->irq_high,
 412                                                 mx3_gpio_irq_handler);
 413                         irq_set_handler_data(port->irq_high, port);
 414                 }
 415         }
 416
 417         err = bgpio_init(&port->bgc, &pdev->dev, 4,
 418                          port->base + GPIO_PSR,
 419                          port->base + GPIO_DR, NULL,
 420                          port->base + GPIO_GDIR, NULL, 0);
 421         if (err)
 422                 goto out_iounmap;
 423
 424         port->bgc.gc.to_irq = mxc_gpio_to_irq;
 425         port->bgc.gc.base = pdev->id * 32;
 426         port->bgc.dir = port->bgc.read_reg(port->bgc.reg_dir);
 427         port->bgc.data = port->bgc.read_reg(port->bgc.reg_set);
 428
 429         err = gpiochip_add(&port->bgc.gc);
 430         if (err)
 431                 goto out_bgpio_remove;
 432
 433         irq_base = irq_alloc_descs(-1, 0, 32, numa_node_id());
 434         if (irq_base < 0) {
 435                 err = irq_base;
 436                 goto out_gpiochip_remove;
 437         }
 438
 439         port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
 440                                              &irq_domain_simple_ops, NULL);
 441         if (!port->domain) {
 442                 err = -ENODEV;
 443                 goto out_irqdesc_free;
 444         }
 445
 446         /* gpio-mxc can be a generic irq chip */
 447         mxc_gpio_init_gc(port, irq_base);
 448
 449         list_add_tail(&port->node, &mxc_gpio_ports);
 450
 451         return 0;
 452
 453 out_irqdesc_free:
 454         irq_free_descs(irq_base, 32);
 455 out_gpiochip_remove:
 456         WARN_ON(gpiochip_remove(&port->bgc.gc) < 0);
 457 out_bgpio_remove:
 458         bgpio_remove(&port->bgc);
 459 out_iounmap:
 460         iounmap(port->base);
 461 out_release_mem:
 462         release_mem_region(iores->start, resource_size(iores));
 463 out_kfree:
 464         kfree(port);
 465         dev_info(&pdev->dev, "%s failed with errno %d\n", __func__, err);
 466         return err;
 467 }
 468
 469 static struct platform_driver mxc_gpio_driver = {
 470         .driver         = {
 471                 .name   = "gpio-mxc",
 472                 .owner  = THIS_MODULE,
 473                 .of_match_table = mxc_gpio_dt_ids,
 474         },
 475         .probe          = mxc_gpio_probe,
 476         .id_table       = mxc_gpio_devtype,
 477 };
 478
 479 static int __init gpio_mxc_init(void)
 480 {
 481         return platform_driver_register(&mxc_gpio_driver);
 482 }
 483 postcore_initcall(gpio_mxc_init);
 484
 485 MODULE_AUTHOR("Freescale Semiconductor, "
 486               "Daniel Mack <danielncaiaq.de>, "
 487               "Juergen Beisert <kernel@pengutronix.de>");
 488 MODULE_DESCRIPTION("Freescale MXC GPIO");
 489 MODULE_LICENSE("GPL");