drivers/gpio/gpio-pl061.c

   1 /*
   2  * Copyright (C) 2008, 2009 Provigent Ltd.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License version 2 as
   6  * published by the Free Software Foundation.
   7  *
   8  * Driver for the ARM PrimeCell(tm) General Purpose Input/Output (PL061)
   9  *
  10  * Data sheet: ARM DDI 0190B, September 2000
  11  */
  12 #include <linux/spinlock.h>
  13 #include <linux/errno.h>
  14 #include <linux/module.h>
  15 #include <linux/io.h>
  16 #include <linux/ioport.h>
  17 #include <linux/irq.h>
  18 #include <linux/irqdomain.h>
  19 #include <linux/bitops.h>
  20 #include <linux/workqueue.h>
  21 #include <linux/gpio.h>
  22 #include <linux/device.h>
  23 #include <linux/amba/bus.h>
  24 #include <linux/amba/pl061.h>
  25 #include <linux/slab.h>
  26 #include <linux/pm.h>
  27 #include <asm/mach/irq.h>
  28
  29 #define GPIODIR 0x400
  30 #define GPIOIS  0x404
  31 #define GPIOIBE 0x408
  32 #define GPIOIEV 0x40C
  33 #define GPIOIE  0x410
  34 #define GPIORIS 0x414
  35 #define GPIOMIS 0x418
  36 #define GPIOIC  0x41C
  37
  38 #define PL061_GPIO_NR   8
  39
  40 #ifdef CONFIG_PM
  41 struct pl061_context_save_regs {
  42         u8 gpio_data;
  43         u8 gpio_dir;
  44         u8 gpio_is;
  45         u8 gpio_ibe;
  46         u8 gpio_iev;
  47         u8 gpio_ie;
  48 };
  49 #endif
  50
  51 struct pl061_gpio {
  52         spinlock_t              lock;
  53
  54         void __iomem            *base;
  55         struct irq_domain       *domain;
  56         struct gpio_chip        gc;
  57
  58 #ifdef CONFIG_PM
  59         struct pl061_context_save_regs csave_regs;
  60 #endif
  61 };
  62
  63 static int pl061_direction_input(struct gpio_chip *gc, unsigned offset)
  64 {
  65         struct pl061_gpio *chip = container_of(gc, struct pl061_gpio, gc);
  66         unsigned long flags;
  67         unsigned char gpiodir;
  68
  69         if (offset >= gc->ngpio)
  70                 return -EINVAL;
  71
  72         spin_lock_irqsave(&chip->lock, flags);
  73         gpiodir = readb(chip->base + GPIODIR);
  74         gpiodir &= ~(1 << offset);
  75         writeb(gpiodir, chip->base + GPIODIR);
  76         spin_unlock_irqrestore(&chip->lock, flags);
  77
  78         return 0;
  79 }
  80
  81 static int pl061_direction_output(struct gpio_chip *gc, unsigned offset,
  82                 int value)
  83 {
  84         struct pl061_gpio *chip = container_of(gc, struct pl061_gpio, gc);
  85         unsigned long flags;
  86         unsigned char gpiodir;
  87
  88         if (offset >= gc->ngpio)
  89                 return -EINVAL;
  90
  91         spin_lock_irqsave(&chip->lock, flags);
  92         writeb(!!value << offset, chip->base + (1 << (offset + 2)));
  93         gpiodir = readb(chip->base + GPIODIR);
  94         gpiodir |= 1 << offset;
  95         writeb(gpiodir, chip->base + GPIODIR);
  96
  97         /*
  98          * gpio value is set again, because pl061 doesn't allow to set value of
  99          * a gpio pin before configuring it in OUT mode.
 100          */
 101         writeb(!!value << offset, chip->base + (1 << (offset + 2)));
 102         spin_unlock_irqrestore(&chip->lock, flags);
 103
 104         return 0;
 105 }
 106
 107 static int pl061_get_value(struct gpio_chip *gc, unsigned offset)
 108 {
 109         struct pl061_gpio *chip = container_of(gc, struct pl061_gpio, gc);
 110
 111         return !!readb(chip->base + (1 << (offset + 2)));
 112 }
 113
 114 static void pl061_set_value(struct gpio_chip *gc, unsigned offset, int value)
 115 {
 116         struct pl061_gpio *chip = container_of(gc, struct pl061_gpio, gc);
 117
 118         writeb(!!value << offset, chip->base + (1 << (offset + 2)));
 119 }
 120
 121 static int pl061_to_irq(struct gpio_chip *gc, unsigned offset)
 122 {
 123         struct pl061_gpio *chip = container_of(gc, struct pl061_gpio, gc);
 124
 125         return irq_create_mapping(chip->domain, offset);
 126 }
 127
 128 static int pl061_irq_type(struct irq_data *d, unsigned trigger)
 129 {
 130         struct pl061_gpio *chip = irq_data_get_irq_chip_data(d);
 131         int offset = irqd_to_hwirq(d);
 132         unsigned long flags;
 133         u8 gpiois, gpioibe, gpioiev;
 134
 135         if (offset < 0 || offset >= PL061_GPIO_NR)
 136                 return -EINVAL;
 137
 138         spin_lock_irqsave(&chip->lock, flags);
 139
 140         gpioiev = readb(chip->base + GPIOIEV);
 141
 142         gpiois = readb(chip->base + GPIOIS);
 143         if (trigger & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW)) {
 144                 gpiois |= 1 << offset;
 145                 if (trigger & IRQ_TYPE_LEVEL_HIGH)
 146                         gpioiev |= 1 << offset;
 147                 else
 148                         gpioiev &= ~(1 << offset);
 149         } else
 150                 gpiois &= ~(1 << offset);
 151         writeb(gpiois, chip->base + GPIOIS);
 152
 153         gpioibe = readb(chip->base + GPIOIBE);
 154         if ((trigger & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH)
 155                 gpioibe |= 1 << offset;
 156         else {
 157                 gpioibe &= ~(1 << offset);
 158                 if (trigger & IRQ_TYPE_EDGE_RISING)
 159                         gpioiev |= 1 << offset;
 160                 else if (trigger & IRQ_TYPE_EDGE_FALLING)
 161                         gpioiev &= ~(1 << offset);
 162         }
 163         writeb(gpioibe, chip->base + GPIOIBE);
 164
 165         writeb(gpioiev, chip->base + GPIOIEV);
 166
 167         spin_unlock_irqrestore(&chip->lock, flags);
 168
 169         return 0;
 170 }
 171
 172 static void pl061_irq_handler(unsigned irq, struct irq_desc *desc)
 173 {
 174         unsigned long pending;
 175         int offset;
 176         struct pl061_gpio *chip = irq_desc_get_handler_data(desc);
 177         struct irq_chip *irqchip = irq_desc_get_chip(desc);
 178
 179         chained_irq_enter(irqchip, desc);
 180
 181         pending = readb(chip->base + GPIOMIS);
 182         writeb(pending, chip->base + GPIOIC);
 183         if (pending) {
 184                 for_each_set_bit(offset, &pending, PL061_GPIO_NR)
 185                         generic_handle_irq(pl061_to_irq(&chip->gc, offset));
 186         }
 187
 188         chained_irq_exit(irqchip, desc);
 189 }
 190
 191 static void pl061_irq_mask(struct irq_data *d)
 192 {
 193         struct pl061_gpio *chip = irq_data_get_irq_chip_data(d);
 194         u8 mask = 1 << (irqd_to_hwirq(d) % PL061_GPIO_NR);
 195         u8 gpioie;
 196
 197         spin_lock(&chip->lock);
 198         gpioie = readb(chip->base + GPIOIE) & ~mask;
 199         writeb(gpioie, chip->base + GPIOIE);
 200         spin_unlock(&chip->lock);
 201 }
 202
 203 static void pl061_irq_unmask(struct irq_data *d)
 204 {
 205         struct pl061_gpio *chip = irq_data_get_irq_chip_data(d);
 206         u8 mask = 1 << (irqd_to_hwirq(d) % PL061_GPIO_NR);
 207         u8 gpioie;
 208
 209         spin_lock(&chip->lock);
 210         gpioie = readb(chip->base + GPIOIE) | mask;
 211         writeb(gpioie, chip->base + GPIOIE);
 212         spin_unlock(&chip->lock);
 213 }
 214
 215 static struct irq_chip pl061_irqchip = {
 216         .name           = "pl061 gpio",
 217         .irq_mask       = pl061_irq_mask,
 218         .irq_unmask     = pl061_irq_unmask,
 219         .irq_set_type   = pl061_irq_type,
 220 };
 221
 222 static int pl061_irq_map(struct irq_domain *d, unsigned int virq,
 223                          irq_hw_number_t hw)
 224 {
 225         struct pl061_gpio *chip = d->host_data;
 226
 227         irq_set_chip_and_handler_name(virq, &pl061_irqchip, handle_simple_irq,
 228                                       "pl061");
 229         irq_set_chip_data(virq, chip);
 230         irq_set_irq_type(virq, IRQ_TYPE_NONE);
 231
 232         return 0;
 233 }
 234
 235 static const struct irq_domain_ops pl061_domain_ops = {
 236         .map    = pl061_irq_map,
 237         .xlate  = irq_domain_xlate_twocell,
 238 };
 239
 240 static int pl061_probe(struct amba_device *adev, const struct amba_id *id)
 241 {
 242         struct device *dev = &adev->dev;
 243         struct pl061_platform_data *pdata = dev->platform_data;
 244         struct pl061_gpio *chip;
 245         int ret, irq, i, irq_base;
 246
 247         chip = devm_kzalloc(dev, sizeof(*chip), GFP_KERNEL);
 248         if (chip == NULL)
 249                 return -ENOMEM;
 250
 251         if (pdata) {
 252                 chip->gc.base = pdata->gpio_base;
 253                 irq_base = pdata->irq_base;
 254                 if (irq_base <= 0)
 255                         return -ENODEV;
 256         } else {
 257                 chip->gc.base = -1;
 258                 irq_base = 0;
 259         }
 260
 261         if (!devm_request_mem_region(dev, adev->res.start,
 262                                      resource_size(&adev->res), "pl061"))
 263                 return -EBUSY;
 264
 265         chip->base = devm_ioremap(dev, adev->res.start,
 266                                   resource_size(&adev->res));
 267         if (!chip->base)
 268                 return -ENOMEM;
 269
 270         chip->domain = irq_domain_add_simple(adev->dev.of_node, PL061_GPIO_NR,
 271                                              irq_base, &pl061_domain_ops, chip);
 272         if (!chip->domain)
 273                 return -ENODEV;
 274
 275         spin_lock_init(&chip->lock);
 276
 277         chip->gc.direction_input = pl061_direction_input;
 278         chip->gc.direction_output = pl061_direction_output;
 279         chip->gc.get = pl061_get_value;
 280         chip->gc.set = pl061_set_value;
 281         chip->gc.to_irq = pl061_to_irq;
 282         chip->gc.ngpio = PL061_GPIO_NR;
 283         chip->gc.label = dev_name(dev);
 284         chip->gc.dev = dev;
 285         chip->gc.owner = THIS_MODULE;
 286
 287         ret = gpiochip_add(&chip->gc);
 288         if (ret)
 289                 return ret;
 290
 291         /*
 292          * irq_chip support
 293          */
 294         writeb(0, chip->base + GPIOIE); /* disable irqs */
 295         irq = adev->irq[0];
 296         if (irq < 0)
 297                 return -ENODEV;
 298
 299         irq_set_chained_handler(irq, pl061_irq_handler);
 300         irq_set_handler_data(irq, chip);
 301
 302         for (i = 0; i < PL061_GPIO_NR; i++) {
 303                 if (pdata) {
 304                         if (pdata->directions & (1 << i))
 305                                 pl061_direction_output(&chip->gc, i,
 306                                                 pdata->values & (1 << i));
 307                         else
 308                                 pl061_direction_input(&chip->gc, i);
 309                 }
 310         }
 311
 312         amba_set_drvdata(adev, chip);
 313
 314         return 0;
 315 }
 316
 317 #ifdef CONFIG_PM
 318 static int pl061_suspend(struct device *dev)
 319 {
 320         struct pl061_gpio *chip = dev_get_drvdata(dev);
 321         int offset;
 322
 323         chip->csave_regs.gpio_data = 0;
 324         chip->csave_regs.gpio_dir = readb(chip->base + GPIODIR);
 325         chip->csave_regs.gpio_is = readb(chip->base + GPIOIS);
 326         chip->csave_regs.gpio_ibe = readb(chip->base + GPIOIBE);
 327         chip->csave_regs.gpio_iev = readb(chip->base + GPIOIEV);
 328         chip->csave_regs.gpio_ie = readb(chip->base + GPIOIE);
 329
 330         for (offset = 0; offset < PL061_GPIO_NR; offset++) {
 331                 if (chip->csave_regs.gpio_dir & (1 << offset))
 332                         chip->csave_regs.gpio_data |=
 333                                 pl061_get_value(&chip->gc, offset) << offset;
 334         }
 335
 336         return 0;
 337 }
 338
 339 static int pl061_resume(struct device *dev)
 340 {
 341         struct pl061_gpio *chip = dev_get_drvdata(dev);
 342         int offset;
 343
 344         for (offset = 0; offset < PL061_GPIO_NR; offset++) {
 345                 if (chip->csave_regs.gpio_dir & (1 << offset))
 346                         pl061_direction_output(&chip->gc, offset,
 347                                         chip->csave_regs.gpio_data &
 348                                         (1 << offset));
 349                 else
 350                         pl061_direction_input(&chip->gc, offset);
 351         }
 352
 353         writeb(chip->csave_regs.gpio_is, chip->base + GPIOIS);
 354         writeb(chip->csave_regs.gpio_ibe, chip->base + GPIOIBE);
 355         writeb(chip->csave_regs.gpio_iev, chip->base + GPIOIEV);
 356         writeb(chip->csave_regs.gpio_ie, chip->base + GPIOIE);
 357
 358         return 0;
 359 }
 360
 361 static const struct dev_pm_ops pl061_dev_pm_ops = {
 362         .suspend = pl061_suspend,
 363         .resume = pl061_resume,
 364         .freeze = pl061_suspend,
 365         .restore = pl061_resume,
 366 };
 367 #endif
 368
 369 static struct amba_id pl061_ids[] = {
 370         {
 371                 .id     = 0x00041061,
 372                 .mask   = 0x000fffff,
 373         },
 374         { 0, 0 },
 375 };
 376
 377 MODULE_DEVICE_TABLE(amba, pl061_ids);
 378
 379 static struct amba_driver pl061_gpio_driver = {
 380         .drv = {
 381                 .name   = "pl061_gpio",
 382 #ifdef CONFIG_PM
 383                 .pm     = &pl061_dev_pm_ops,
 384 #endif
 385         },
 386         .id_table       = pl061_ids,
 387         .probe          = pl061_probe,
 388 };
 389
 390 static int __init pl061_gpio_init(void)
 391 {
 392         return amba_driver_register(&pl061_gpio_driver);
 393 }
 394 module_init(pl061_gpio_init);
 395
 396 MODULE_AUTHOR("Baruch Siach <baruch@tkos.co.il>");
 397 MODULE_DESCRIPTION("PL061 GPIO driver");
 398 MODULE_LICENSE("GPL");