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