drivers/gpio/gpio-pl061.c

   1 /*
   2  * Copyright (C) 2008, 2009 Provigent Ltd.
   3  *
   4  * Author: Baruch Siach <baruch@tkos.co.il>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 as
   8  * published by the Free Software Foundation.
   9  *
  10  * Driver for the ARM PrimeCell(tm) General Purpose Input/Output (PL061)
  11  *
  12  * Data sheet: ARM DDI 0190B, September 2000
  13  */
  14 #include <linux/spinlock.h>
  15 #include <linux/errno.h>
  16 #include <linux/init.h>
  17 #include <linux/io.h>
  18 #include <linux/ioport.h>
  19 #include <linux/interrupt.h>
  20 #include <linux/irq.h>
  21 #include <linux/irqchip/chained_irq.h>
  22 #include <linux/bitops.h>
  23 #include <linux/gpio.h>
  24 #include <linux/device.h>
  25 #include <linux/amba/bus.h>
  26 #include <linux/amba/pl061.h>
  27 #include <linux/slab.h>
  28 #include <linux/pinctrl/consumer.h>
  29 #include <linux/pm.h>
  30
  31 #define GPIODIR 0x400
  32 #define GPIOIS  0x404
  33 #define GPIOIBE 0x408
  34 #define GPIOIEV 0x40C
  35 #define GPIOIE  0x410
  36 #define GPIORIS 0x414
  37 #define GPIOMIS 0x418
  38 #define GPIOIC  0x41C
  39
  40 #define PL061_GPIO_NR   8
  41
  42 #ifdef CONFIG_PM
  43 struct pl061_context_save_regs {
  44         u8 gpio_data;
  45         u8 gpio_dir;
  46         u8 gpio_is;
  47         u8 gpio_ibe;
  48         u8 gpio_iev;
  49         u8 gpio_ie;
  50 };
  51 #endif
  52
  53 struct pl061 {
  54         spinlock_t              lock;
  55
  56         void __iomem            *base;
  57         struct gpio_chip        gc;
  58         int                     parent_irq;
  59
  60 #ifdef CONFIG_PM
  61         struct pl061_context_save_regs csave_regs;
  62 #endif
  63 };
  64
  65 static int pl061_get_direction(struct gpio_chip *gc, unsigned offset)
  66 {
  67         struct pl061 *chip = gpiochip_get_data(gc);
  68
  69         return !(readb(chip->base + GPIODIR) & BIT(offset));
  70 }
  71
  72 static int pl061_direction_input(struct gpio_chip *gc, unsigned offset)
  73 {
  74         struct pl061 *chip = gpiochip_get_data(gc);
  75         unsigned long flags;
  76         unsigned char gpiodir;
  77
  78         spin_lock_irqsave(&chip->lock, flags);
  79         gpiodir = readb(chip->base + GPIODIR);
  80         gpiodir &= ~(BIT(offset));
  81         writeb(gpiodir, chip->base + GPIODIR);
  82         spin_unlock_irqrestore(&chip->lock, flags);
  83
  84         return 0;
  85 }
  86
  87 static int pl061_direction_output(struct gpio_chip *gc, unsigned offset,
  88                 int value)
  89 {
  90         struct pl061 *chip = gpiochip_get_data(gc);
  91         unsigned long flags;
  92         unsigned char gpiodir;
  93
  94         spin_lock_irqsave(&chip->lock, flags);
  95         writeb(!!value << offset, chip->base + (BIT(offset + 2)));
  96         gpiodir = readb(chip->base + GPIODIR);
  97         gpiodir |= BIT(offset);
  98         writeb(gpiodir, chip->base + GPIODIR);
  99
 100         /*
 101          * gpio value is set again, because pl061 doesn't allow to set value of
 102          * a gpio pin before configuring it in OUT mode.
 103          */
 104         writeb(!!value << offset, chip->base + (BIT(offset + 2)));
 105         spin_unlock_irqrestore(&chip->lock, flags);
 106
 107         return 0;
 108 }
 109
 110 static int pl061_get_value(struct gpio_chip *gc, unsigned offset)
 111 {
 112         struct pl061 *chip = gpiochip_get_data(gc);
 113
 114         return !!readb(chip->base + (BIT(offset + 2)));
 115 }
 116
 117 static void pl061_set_value(struct gpio_chip *gc, unsigned offset, int value)
 118 {
 119         struct pl061 *chip = gpiochip_get_data(gc);
 120
 121         writeb(!!value << offset, chip->base + (BIT(offset + 2)));
 122 }
 123
 124 static int pl061_irq_type(struct irq_data *d, unsigned trigger)
 125 {
 126         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 127         struct pl061 *chip = gpiochip_get_data(gc);
 128         int offset = irqd_to_hwirq(d);
 129         unsigned long flags;
 130         u8 gpiois, gpioibe, gpioiev;
 131         u8 bit = BIT(offset);
 132
 133         if (offset < 0 || offset >= PL061_GPIO_NR)
 134                 return -EINVAL;
 135
 136         if ((trigger & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW)) &&
 137             (trigger & (IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING)))
 138         {
 139                 dev_err(gc->parent,
 140                         "trying to configure line %d for both level and edge "
 141                         "detection, choose one!\n",
 142                         offset);
 143                 return -EINVAL;
 144         }
 145
 146
 147         spin_lock_irqsave(&chip->lock, flags);
 148
 149         gpioiev = readb(chip->base + GPIOIEV);
 150         gpiois = readb(chip->base + GPIOIS);
 151         gpioibe = readb(chip->base + GPIOIBE);
 152
 153         if (trigger & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW)) {
 154                 bool polarity = trigger & IRQ_TYPE_LEVEL_HIGH;
 155
 156                 /* Disable edge detection */
 157                 gpioibe &= ~bit;
 158                 /* Enable level detection */
 159                 gpiois |= bit;
 160                 /* Select polarity */
 161                 if (polarity)
 162                         gpioiev |= bit;
 163                 else
 164                         gpioiev &= ~bit;
 165                 irq_set_handler_locked(d, handle_level_irq);
 166                 dev_dbg(gc->parent, "line %d: IRQ on %s level\n",
 167                         offset,
 168                         polarity ? "HIGH" : "LOW");
 169         } else if ((trigger & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) {
 170                 /* Disable level detection */
 171                 gpiois &= ~bit;
 172                 /* Select both edges, setting this makes GPIOEV be ignored */
 173                 gpioibe |= bit;
 174                 irq_set_handler_locked(d, handle_edge_irq);
 175                 dev_dbg(gc->parent, "line %d: IRQ on both edges\n", offset);
 176         } else if ((trigger & IRQ_TYPE_EDGE_RISING) ||
 177                    (trigger & IRQ_TYPE_EDGE_FALLING)) {
 178                 bool rising = trigger & IRQ_TYPE_EDGE_RISING;
 179
 180                 /* Disable level detection */
 181                 gpiois &= ~bit;
 182                 /* Clear detection on both edges */
 183                 gpioibe &= ~bit;
 184                 /* Select edge */
 185                 if (rising)
 186                         gpioiev |= bit;
 187                 else
 188                         gpioiev &= ~bit;
 189                 irq_set_handler_locked(d, handle_edge_irq);
 190                 dev_dbg(gc->parent, "line %d: IRQ on %s edge\n",
 191                         offset,
 192                         rising ? "RISING" : "FALLING");
 193         } else {
 194                 /* No trigger: disable everything */
 195                 gpiois &= ~bit;
 196                 gpioibe &= ~bit;
 197                 gpioiev &= ~bit;
 198                 irq_set_handler_locked(d, handle_bad_irq);
 199                 dev_warn(gc->parent, "no trigger selected for line %d\n",
 200                          offset);
 201         }
 202
 203         writeb(gpiois, chip->base + GPIOIS);
 204         writeb(gpioibe, chip->base + GPIOIBE);
 205         writeb(gpioiev, chip->base + GPIOIEV);
 206
 207         spin_unlock_irqrestore(&chip->lock, flags);
 208
 209         return 0;
 210 }
 211
 212 static void pl061_irq_handler(struct irq_desc *desc)
 213 {
 214         unsigned long pending;
 215         int offset;
 216         struct gpio_chip *gc = irq_desc_get_handler_data(desc);
 217         struct pl061 *chip = gpiochip_get_data(gc);
 218         struct irq_chip *irqchip = irq_desc_get_chip(desc);
 219
 220         chained_irq_enter(irqchip, desc);
 221
 222         pending = readb(chip->base + GPIOMIS);
 223         if (pending) {
 224                 for_each_set_bit(offset, &pending, PL061_GPIO_NR)
 225                         generic_handle_irq(irq_find_mapping(gc->irqdomain,
 226                                                             offset));
 227         }
 228
 229         chained_irq_exit(irqchip, desc);
 230 }
 231
 232 static void pl061_irq_mask(struct irq_data *d)
 233 {
 234         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 235         struct pl061 *chip = gpiochip_get_data(gc);
 236         u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR);
 237         u8 gpioie;
 238
 239         spin_lock(&chip->lock);
 240         gpioie = readb(chip->base + GPIOIE) & ~mask;
 241         writeb(gpioie, chip->base + GPIOIE);
 242         spin_unlock(&chip->lock);
 243 }
 244
 245 static void pl061_irq_unmask(struct irq_data *d)
 246 {
 247         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 248         struct pl061 *chip = gpiochip_get_data(gc);
 249         u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR);
 250         u8 gpioie;
 251
 252         spin_lock(&chip->lock);
 253         gpioie = readb(chip->base + GPIOIE) | mask;
 254         writeb(gpioie, chip->base + GPIOIE);
 255         spin_unlock(&chip->lock);
 256 }
 257
 258 /**
 259  * pl061_irq_ack() - ACK an edge IRQ
 260  * @d: IRQ data for this IRQ
 261  *
 262  * This gets called from the edge IRQ handler to ACK the edge IRQ
 263  * in the GPIOIC (interrupt-clear) register. For level IRQs this is
 264  * not needed: these go away when the level signal goes away.
 265  */
 266 static void pl061_irq_ack(struct irq_data *d)
 267 {
 268         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 269         struct pl061 *chip = gpiochip_get_data(gc);
 270         u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR);
 271
 272         spin_lock(&chip->lock);
 273         writeb(mask, chip->base + GPIOIC);
 274         spin_unlock(&chip->lock);
 275 }
 276
 277 static int pl061_irq_set_wake(struct irq_data *d, unsigned int state)
 278 {
 279         struct gpio_chip *gc = irq_data_get_irq_chip_data(d);
 280         struct pl061 *chip = gpiochip_get_data(gc);
 281
 282         return irq_set_irq_wake(chip->parent_irq, state);
 283 }
 284
 285 static struct irq_chip pl061_irqchip = {
 286         .name           = "pl061",
 287         .irq_ack        = pl061_irq_ack,
 288         .irq_mask       = pl061_irq_mask,
 289         .irq_unmask     = pl061_irq_unmask,
 290         .irq_set_type   = pl061_irq_type,
 291         .irq_set_wake   = pl061_irq_set_wake,
 292 };
 293
 294 static int pl061_probe(struct amba_device *adev, const struct amba_id *id)
 295 {
 296         struct device *dev = &adev->dev;
 297         struct pl061_platform_data *pdata = dev_get_platdata(dev);
 298         struct pl061 *chip;
 299         int ret, irq, i, irq_base;
 300
 301         chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
 302         if (chip == NULL)
 303                 return -ENOMEM;
 304
 305         if (pdata) {
 306                 chip->gc.base = pdata->gpio_base;
 307                 irq_base = pdata->irq_base;
 308                 if (irq_base <= 0) {
 309                         dev_err(&adev->dev, "invalid IRQ base in pdata\n");
 310                         return -ENODEV;
 311                 }
 312         } else {
 313                 chip->gc.base = -1;
 314                 irq_base = 0;
 315         }
 316
 317         chip->base = devm_ioremap_resource(dev, &adev->res);
 318         if (IS_ERR(chip->base))
 319                 return PTR_ERR(chip->base);
 320
 321         spin_lock_init(&chip->lock);
 322         if (of_property_read_bool(dev->of_node, "gpio-ranges")) {
 323                 chip->gc.request = gpiochip_generic_request;
 324                 chip->gc.free = gpiochip_generic_free;
 325         }
 326
 327         chip->gc.get_direction = pl061_get_direction;
 328         chip->gc.direction_input = pl061_direction_input;
 329         chip->gc.direction_output = pl061_direction_output;
 330         chip->gc.get = pl061_get_value;
 331         chip->gc.set = pl061_set_value;
 332         chip->gc.ngpio = PL061_GPIO_NR;
 333         chip->gc.label = dev_name(dev);
 334         chip->gc.parent = dev;
 335         chip->gc.owner = THIS_MODULE;
 336
 337         ret = gpiochip_add_data(&chip->gc, chip);
 338         if (ret)
 339                 return ret;
 340
 341         /*
 342          * irq_chip support
 343          */
 344         writeb(0, chip->base + GPIOIE); /* disable irqs */
 345         irq = adev->irq[0];
 346         if (irq < 0) {
 347                 dev_err(&adev->dev, "invalid IRQ\n");
 348                 return -ENODEV;
 349         }
 350         chip->parent_irq = irq;
 351
 352         ret = gpiochip_irqchip_add(&chip->gc, &pl061_irqchip,
 353                                    irq_base, handle_bad_irq,
 354                                    IRQ_TYPE_NONE);
 355         if (ret) {
 356                 dev_info(&adev->dev, "could not add irqchip\n");
 357                 return ret;
 358         }
 359         gpiochip_set_chained_irqchip(&chip->gc, &pl061_irqchip,
 360                                      irq, pl061_irq_handler);
 361
 362         for (i = 0; i < PL061_GPIO_NR; i++) {
 363                 if (pdata) {
 364                         if (pdata->directions & (BIT(i)))
 365                                 pl061_direction_output(&chip->gc, i,
 366                                                 pdata->values & (BIT(i)));
 367                         else
 368                                 pl061_direction_input(&chip->gc, i);
 369                 }
 370         }
 371
 372         amba_set_drvdata(adev, chip);
 373         dev_info(&adev->dev, "PL061 GPIO chip @%pa registered\n",
 374                  &adev->res.start);
 375
 376         return 0;
 377 }
 378
 379 #ifdef CONFIG_PM
 380 static int pl061_suspend(struct device *dev)
 381 {
 382         struct pl061 *chip = dev_get_drvdata(dev);
 383         int offset;
 384
 385         chip->csave_regs.gpio_data = 0;
 386         chip->csave_regs.gpio_dir = readb(chip->base + GPIODIR);
 387         chip->csave_regs.gpio_is = readb(chip->base + GPIOIS);
 388         chip->csave_regs.gpio_ibe = readb(chip->base + GPIOIBE);
 389         chip->csave_regs.gpio_iev = readb(chip->base + GPIOIEV);
 390         chip->csave_regs.gpio_ie = readb(chip->base + GPIOIE);
 391
 392         for (offset = 0; offset < PL061_GPIO_NR; offset++) {
 393                 if (chip->csave_regs.gpio_dir & (BIT(offset)))
 394                         chip->csave_regs.gpio_data |=
 395                                 pl061_get_value(&chip->gc, offset) << offset;
 396         }
 397
 398         return 0;
 399 }
 400
 401 static int pl061_resume(struct device *dev)
 402 {
 403         struct pl061 *chip = dev_get_drvdata(dev);
 404         int offset;
 405
 406         for (offset = 0; offset < PL061_GPIO_NR; offset++) {
 407                 if (chip->csave_regs.gpio_dir & (BIT(offset)))
 408                         pl061_direction_output(&chip->gc, offset,
 409                                         chip->csave_regs.gpio_data &
 410                                         (BIT(offset)));
 411                 else
 412                         pl061_direction_input(&chip->gc, offset);
 413         }
 414
 415         writeb(chip->csave_regs.gpio_is, chip->base + GPIOIS);
 416         writeb(chip->csave_regs.gpio_ibe, chip->base + GPIOIBE);
 417         writeb(chip->csave_regs.gpio_iev, chip->base + GPIOIEV);
 418         writeb(chip->csave_regs.gpio_ie, chip->base + GPIOIE);
 419
 420         return 0;
 421 }
 422
 423 static const struct dev_pm_ops pl061_dev_pm_ops = {
 424         .suspend = pl061_suspend,
 425         .resume = pl061_resume,
 426         .freeze = pl061_suspend,
 427         .restore = pl061_resume,
 428 };
 429 #endif
 430
 431 static struct amba_id pl061_ids[] = {
 432         {
 433                 .id     = 0x00041061,
 434                 .mask   = 0x000fffff,
 435         },
 436         { 0, 0 },
 437 };
 438
 439 static struct amba_driver pl061_gpio_driver = {
 440         .drv = {
 441                 .name   = "pl061_gpio",
 442 #ifdef CONFIG_PM
 443                 .pm     = &pl061_dev_pm_ops,
 444 #endif
 445         },
 446         .id_table       = pl061_ids,
 447         .probe          = pl061_probe,
 448 };
 449
 450 static int __init pl061_gpio_init(void)
 451 {
 452         return amba_driver_register(&pl061_gpio_driver);
 453 }
 454 device_initcall(pl061_gpio_init);