drivers/gpio/gpio-mxs.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,
  20  * MA  02110-1301, USA.
  21  */
  22
  23 #include <linux/err.h>
  24 #include <linux/init.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/io.h>
  27 #include <linux/irq.h>
  28 #include <linux/irqdomain.h>
  29 #include <linux/of.h>
  30 #include <linux/of_address.h>
  31 #include <linux/of_device.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/slab.h>
  34 #include <linux/gpio/driver.h>
  35 #include <linux/module.h>
  36
  37 #define MXS_SET         0x4
  38 #define MXS_CLR         0x8
  39
  40 #define PINCTRL_DOUT(p)         ((is_imx23_gpio(p) ? 0x0500 : 0x0700) + (p->id) * 0x10)
  41 #define PINCTRL_DIN(p)          ((is_imx23_gpio(p) ? 0x0600 : 0x0900) + (p->id) * 0x10)
  42 #define PINCTRL_DOE(p)          ((is_imx23_gpio(p) ? 0x0700 : 0x0b00) + (p->id) * 0x10)
  43 #define PINCTRL_PIN2IRQ(p)      ((is_imx23_gpio(p) ? 0x0800 : 0x1000) + (p->id) * 0x10)
  44 #define PINCTRL_IRQEN(p)        ((is_imx23_gpio(p) ? 0x0900 : 0x1100) + (p->id) * 0x10)
  45 #define PINCTRL_IRQLEV(p)       ((is_imx23_gpio(p) ? 0x0a00 : 0x1200) + (p->id) * 0x10)
  46 #define PINCTRL_IRQPOL(p)       ((is_imx23_gpio(p) ? 0x0b00 : 0x1300) + (p->id) * 0x10)
  47 #define PINCTRL_IRQSTAT(p)      ((is_imx23_gpio(p) ? 0x0c00 : 0x1400) + (p->id) * 0x10)
  48
  49 #define GPIO_INT_FALL_EDGE      0x0
  50 #define GPIO_INT_LOW_LEV        0x1
  51 #define GPIO_INT_RISE_EDGE      0x2
  52 #define GPIO_INT_HIGH_LEV       0x3
  53 #define GPIO_INT_LEV_MASK       (1 << 0)
  54 #define GPIO_INT_POL_MASK       (1 << 1)
  55
  56 enum mxs_gpio_id {
  57         IMX23_GPIO,
  58         IMX28_GPIO,
  59 };
  60
  61 struct mxs_gpio_port {
  62         void __iomem *base;
  63         int id;
  64         int irq;
  65         struct irq_domain *domain;
  66         struct gpio_chip gc;
  67         struct device *dev;
  68         enum mxs_gpio_id devid;
  69         u32 both_edges;
  70 };
  71
  72 static inline int is_imx23_gpio(struct mxs_gpio_port *port)
  73 {
  74         return port->devid == IMX23_GPIO;
  75 }
  76
  77 static inline int is_imx28_gpio(struct mxs_gpio_port *port)
  78 {
  79         return port->devid == IMX28_GPIO;
  80 }
  81
  82 /* Note: This driver assumes 32 GPIOs are handled in one register */
  83
  84 static int mxs_gpio_set_irq_type(struct irq_data *d, unsigned int type)
  85 {
  86         u32 val;
  87         u32 pin_mask = 1 << d->hwirq;
  88         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
  89         struct irq_chip_type *ct = irq_data_get_chip_type(d);
  90         struct mxs_gpio_port *port = gc->private;
  91         void __iomem *pin_addr;
  92         int edge;
  93
  94         if (!(ct->type & type))
  95                 if (irq_setup_alt_chip(d, type))
  96                         return -EINVAL;
  97
  98         port->both_edges &= ~pin_mask;
  99         switch (type) {
 100         case IRQ_TYPE_EDGE_BOTH:
 101                 val = port->gc.get(&port->gc, d->hwirq);
 102                 if (val)
 103                         edge = GPIO_INT_FALL_EDGE;
 104                 else
 105                         edge = GPIO_INT_RISE_EDGE;
 106                 port->both_edges |= pin_mask;
 107                 break;
 108         case IRQ_TYPE_EDGE_RISING:
 109                 edge = GPIO_INT_RISE_EDGE;
 110                 break;
 111         case IRQ_TYPE_EDGE_FALLING:
 112                 edge = GPIO_INT_FALL_EDGE;
 113                 break;
 114         case IRQ_TYPE_LEVEL_LOW:
 115                 edge = GPIO_INT_LOW_LEV;
 116                 break;
 117         case IRQ_TYPE_LEVEL_HIGH:
 118                 edge = GPIO_INT_HIGH_LEV;
 119                 break;
 120         default:
 121                 return -EINVAL;
 122         }
 123
 124         /* set level or edge */
 125         pin_addr = port->base + PINCTRL_IRQLEV(port);
 126         if (edge & GPIO_INT_LEV_MASK) {
 127                 writel(pin_mask, pin_addr + MXS_SET);
 128                 writel(pin_mask, port->base + PINCTRL_IRQEN(port) + MXS_SET);
 129         } else {
 130                 writel(pin_mask, pin_addr + MXS_CLR);
 131                 writel(pin_mask, port->base + PINCTRL_PIN2IRQ(port) + MXS_SET);
 132         }
 133
 134         /* set polarity */
 135         pin_addr = port->base + PINCTRL_IRQPOL(port);
 136         if (edge & GPIO_INT_POL_MASK)
 137                 writel(pin_mask, pin_addr + MXS_SET);
 138         else
 139                 writel(pin_mask, pin_addr + MXS_CLR);
 140
 141         writel(pin_mask,
 142                port->base + PINCTRL_IRQSTAT(port) + MXS_CLR);
 143
 144         return 0;
 145 }
 146
 147 static void mxs_flip_edge(struct mxs_gpio_port *port, u32 gpio)
 148 {
 149         u32 bit, val, edge;
 150         void __iomem *pin_addr;
 151
 152         bit = 1 << gpio;
 153
 154         pin_addr = port->base + PINCTRL_IRQPOL(port);
 155         val = readl(pin_addr);
 156         edge = val & bit;
 157
 158         if (edge)
 159                 writel(bit, pin_addr + MXS_CLR);
 160         else
 161                 writel(bit, pin_addr + MXS_SET);
 162 }
 163
 164 /* MXS has one interrupt *per* gpio port */
 165 static void mxs_gpio_irq_handler(struct irq_desc *desc)
 166 {
 167         u32 irq_stat;
 168         struct mxs_gpio_port *port = irq_desc_get_handler_data(desc);
 169
 170         desc->irq_data.chip->irq_ack(&desc->irq_data);
 171
 172         irq_stat = readl(port->base + PINCTRL_IRQSTAT(port)) &
 173                         readl(port->base + PINCTRL_IRQEN(port));
 174
 175         while (irq_stat != 0) {
 176                 int irqoffset = fls(irq_stat) - 1;
 177                 if (port->both_edges & (1 << irqoffset))
 178                         mxs_flip_edge(port, irqoffset);
 179
 180                 generic_handle_irq(irq_find_mapping(port->domain, irqoffset));
 181                 irq_stat &= ~(1 << irqoffset);
 182         }
 183 }
 184
 185 /*
 186  * Set interrupt number "irq" in the GPIO as a wake-up source.
 187  * While system is running, all registered GPIO interrupts need to have
 188  * wake-up enabled. When system is suspended, only selected GPIO interrupts
 189  * need to have wake-up enabled.
 190  * @param  irq          interrupt source number
 191  * @param  enable       enable as wake-up if equal to non-zero
 192  * @return       This function returns 0 on success.
 193  */
 194 static int mxs_gpio_set_wake_irq(struct irq_data *d, unsigned int enable)
 195 {
 196         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 197         struct mxs_gpio_port *port = gc->private;
 198
 199         if (enable)
 200                 enable_irq_wake(port->irq);
 201         else
 202                 disable_irq_wake(port->irq);
 203
 204         return 0;
 205 }
 206
 207 static int mxs_gpio_init_gc(struct mxs_gpio_port *port, int irq_base)
 208 {
 209         struct irq_chip_generic *gc;
 210         struct irq_chip_type *ct;
 211         int rv;
 212
 213         gc = devm_irq_alloc_generic_chip(port->dev, "gpio-mxs", 2, irq_base,
 214                                          port->base, handle_level_irq);
 215         if (!gc)
 216                 return -ENOMEM;
 217
 218         gc->private = port;
 219
 220         ct = &gc->chip_types[0];
 221         ct->type = IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW;
 222         ct->chip.irq_ack = irq_gc_ack_set_bit;
 223         ct->chip.irq_mask = irq_gc_mask_disable_reg;
 224         ct->chip.irq_unmask = irq_gc_unmask_enable_reg;
 225         ct->chip.irq_set_type = mxs_gpio_set_irq_type;
 226         ct->chip.irq_set_wake = mxs_gpio_set_wake_irq;
 227         ct->chip.flags = IRQCHIP_SET_TYPE_MASKED;
 228         ct->regs.ack = PINCTRL_IRQSTAT(port) + MXS_CLR;
 229         ct->regs.enable = PINCTRL_PIN2IRQ(port) + MXS_SET;
 230         ct->regs.disable = PINCTRL_PIN2IRQ(port) + MXS_CLR;
 231
 232         ct = &gc->chip_types[1];
 233         ct->type = IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING;
 234         ct->chip.irq_ack = irq_gc_ack_set_bit;
 235         ct->chip.irq_mask = irq_gc_mask_disable_reg;
 236         ct->chip.irq_unmask = irq_gc_unmask_enable_reg;
 237         ct->chip.irq_set_type = mxs_gpio_set_irq_type;
 238         ct->chip.irq_set_wake = mxs_gpio_set_wake_irq;
 239         ct->chip.flags = IRQCHIP_SET_TYPE_MASKED;
 240         ct->regs.ack = PINCTRL_IRQSTAT(port) + MXS_CLR;
 241         ct->regs.enable = PINCTRL_IRQEN(port) + MXS_SET;
 242         ct->regs.disable = PINCTRL_IRQEN(port) + MXS_CLR;
 243         ct->handler = handle_level_irq;
 244
 245         rv = devm_irq_setup_generic_chip(port->dev, gc, IRQ_MSK(32),
 246                                          IRQ_GC_INIT_NESTED_LOCK,
 247                                          IRQ_NOREQUEST, 0);
 248
 249         return rv;
 250 }
 251
 252 static int mxs_gpio_to_irq(struct gpio_chip *gc, unsigned offset)
 253 {
 254         struct mxs_gpio_port *port = gpiochip_get_data(gc);
 255
 256         return irq_find_mapping(port->domain, offset);
 257 }
 258
 259 static int mxs_gpio_get_direction(struct gpio_chip *gc, unsigned offset)
 260 {
 261         struct mxs_gpio_port *port = gpiochip_get_data(gc);
 262         u32 mask = 1 << offset;
 263         u32 dir;
 264
 265         dir = readl(port->base + PINCTRL_DOE(port));
 266         return !(dir & mask);
 267 }
 268
 269 static const struct platform_device_id mxs_gpio_ids[] = {
 270         {
 271                 .name = "imx23-gpio",
 272                 .driver_data = IMX23_GPIO,
 273         }, {
 274                 .name = "imx28-gpio",
 275                 .driver_data = IMX28_GPIO,
 276         }, {
 277                 /* sentinel */
 278         }
 279 };
 280 MODULE_DEVICE_TABLE(platform, mxs_gpio_ids);
 281
 282 static const struct of_device_id mxs_gpio_dt_ids[] = {
 283         { .compatible = "fsl,imx23-gpio", .data = (void *) IMX23_GPIO, },
 284         { .compatible = "fsl,imx28-gpio", .data = (void *) IMX28_GPIO, },
 285         { /* sentinel */ }
 286 };
 287 MODULE_DEVICE_TABLE(of, mxs_gpio_dt_ids);
 288
 289 static int mxs_gpio_probe(struct platform_device *pdev)
 290 {
 291         const struct of_device_id *of_id =
 292                         of_match_device(mxs_gpio_dt_ids, &pdev->dev);
 293         struct device_node *np = pdev->dev.of_node;
 294         struct device_node *parent;
 295         static void __iomem *base;
 296         struct mxs_gpio_port *port;
 297         int irq_base;
 298         int err;
 299
 300         port = devm_kzalloc(&pdev->dev, sizeof(*port), GFP_KERNEL);
 301         if (!port)
 302                 return -ENOMEM;
 303
 304         port->id = of_alias_get_id(np, "gpio");
 305         if (port->id < 0)
 306                 return port->id;
 307         port->devid = (enum mxs_gpio_id) of_id->data;
 308         port->dev = &pdev->dev;
 309         port->irq = platform_get_irq(pdev, 0);
 310         if (port->irq < 0)
 311                 return port->irq;
 312
 313         /*
 314          * map memory region only once, as all the gpio ports
 315          * share the same one
 316          */
 317         if (!base) {
 318                 parent = of_get_parent(np);
 319                 base = of_iomap(parent, 0);
 320                 of_node_put(parent);
 321                 if (!base)
 322                         return -EADDRNOTAVAIL;
 323         }
 324         port->base = base;
 325
 326         /* initially disable the interrupts */
 327         writel(0, port->base + PINCTRL_PIN2IRQ(port));
 328         writel(0, port->base + PINCTRL_IRQEN(port));
 329
 330         /* clear address has to be used to clear IRQSTAT bits */
 331         writel(~0U, port->base + PINCTRL_IRQSTAT(port) + MXS_CLR);
 332
 333         irq_base = devm_irq_alloc_descs(&pdev->dev, -1, 0, 32, numa_node_id());
 334         if (irq_base < 0) {
 335                 err = irq_base;
 336                 goto out_iounmap;
 337         }
 338
 339         port->domain = irq_domain_add_legacy(np, 32, irq_base, 0,
 340                                              &irq_domain_simple_ops, NULL);
 341         if (!port->domain) {
 342                 err = -ENODEV;
 343                 goto out_iounmap;
 344         }
 345
 346         /* gpio-mxs can be a generic irq chip */
 347         err = mxs_gpio_init_gc(port, irq_base);
 348         if (err < 0)
 349                 goto out_irqdomain_remove;
 350
 351         /* setup one handler for each entry */
 352         irq_set_chained_handler_and_data(port->irq, mxs_gpio_irq_handler,
 353                                          port);
 354
 355         err = bgpio_init(&port->gc, &pdev->dev, 4,
 356                          port->base + PINCTRL_DIN(port),
 357                          port->base + PINCTRL_DOUT(port) + MXS_SET,
 358                          port->base + PINCTRL_DOUT(port) + MXS_CLR,
 359                          port->base + PINCTRL_DOE(port), NULL, 0);
 360         if (err)
 361                 goto out_irqdomain_remove;
 362
 363         port->gc.to_irq = mxs_gpio_to_irq;
 364         port->gc.get_direction = mxs_gpio_get_direction;
 365         port->gc.base = port->id * 32;
 366
 367         err = gpiochip_add_data(&port->gc, port);
 368         if (err)
 369                 goto out_irqdomain_remove;
 370
 371         return 0;
 372
 373 out_irqdomain_remove:
 374         irq_domain_remove(port->domain);
 375 out_iounmap:
 376         iounmap(port->base);
 377         return err;
 378 }
 379
 380 static struct platform_driver mxs_gpio_driver = {
 381         .driver         = {
 382                 .name   = "gpio-mxs",
 383                 .of_match_table = mxs_gpio_dt_ids,
 384                 .suppress_bind_attrs = true,
 385         },
 386         .probe          = mxs_gpio_probe,
 387         .id_table       = mxs_gpio_ids,
 388 };
 389
 390 static int __init mxs_gpio_init(void)
 391 {
 392         return platform_driver_register(&mxs_gpio_driver);
 393 }
 394 postcore_initcall(mxs_gpio_init);
 395
 396 MODULE_AUTHOR("Freescale Semiconductor, "
 397               "Daniel Mack <danielncaiaq.de>, "
 398               "Juergen Beisert <kernel@pengutronix.de>");
 399 MODULE_DESCRIPTION("Freescale MXS GPIO");
 400 MODULE_LICENSE("GPL");