drivers/gpio/gpio-langwell.c

   1 /*
   2  * Moorestown platform Langwell chip GPIO driver
   3  *
   4  * Copyright (c) 2008 - 2009,  Intel Corporation.
   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  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18  */
  19
  20 /* Supports:
  21  * Moorestown platform Langwell chip.
  22  * Medfield platform Penwell chip.
  23  * Whitney point.
  24  */
  25
  26 #include <linux/module.h>
  27 #include <linux/pci.h>
  28 #include <linux/platform_device.h>
  29 #include <linux/kernel.h>
  30 #include <linux/delay.h>
  31 #include <linux/stddef.h>
  32 #include <linux/interrupt.h>
  33 #include <linux/init.h>
  34 #include <linux/irq.h>
  35 #include <linux/io.h>
  36 #include <linux/gpio.h>
  37 #include <linux/slab.h>
  38 #include <linux/pm_runtime.h>
  39
  40 /*
  41  * Langwell chip has 64 pins and thus there are 2 32bit registers to control
  42  * each feature, while Penwell chip has 96 pins for each block, and need 3 32bit
  43  * registers to control them, so we only define the order here instead of a
  44  * structure, to get a bit offset for a pin (use GPDR as an example):
  45  *
  46  * nreg = ngpio / 32;
  47  * reg = offset / 32;
  48  * bit = offset % 32;
  49  * reg_addr = reg_base + GPDR * nreg * 4 + reg * 4;
  50  *
  51  * so the bit of reg_addr is to control pin offset's GPDR feature
  52 */
  53
  54 enum GPIO_REG {
  55         GPLR = 0,       /* pin level read-only */
  56         GPDR,           /* pin direction */
  57         GPSR,           /* pin set */
  58         GPCR,           /* pin clear */
  59         GRER,           /* rising edge detect */
  60         GFER,           /* falling edge detect */
  61         GEDR,           /* edge detect result */
  62         GAFR,           /* alt function */
  63 };
  64
  65 struct lnw_gpio {
  66         struct gpio_chip                chip;
  67         void                            *reg_base;
  68         spinlock_t                      lock;
  69         unsigned                        irq_base;
  70         struct pci_dev                  *pdev;
  71 };
  72
  73 static void __iomem *gpio_reg(struct gpio_chip *chip, unsigned offset,
  74                         enum GPIO_REG reg_type)
  75 {
  76         struct lnw_gpio *lnw = container_of(chip, struct lnw_gpio, chip);
  77         unsigned nreg = chip->ngpio / 32;
  78         u8 reg = offset / 32;
  79         void __iomem *ptr;
  80
  81         ptr = (void __iomem *)(lnw->reg_base + reg_type * nreg * 4 + reg * 4);
  82         return ptr;
  83 }
  84
  85 static void __iomem *gpio_reg_2bit(struct gpio_chip *chip, unsigned offset,
  86                                    enum GPIO_REG reg_type)
  87 {
  88         struct lnw_gpio *lnw = container_of(chip, struct lnw_gpio, chip);
  89         unsigned nreg = chip->ngpio / 32;
  90         u8 reg = offset / 16;
  91         void __iomem *ptr;
  92
  93         ptr = (void __iomem *)(lnw->reg_base + reg_type * nreg * 4 + reg * 4);
  94         return ptr;
  95 }
  96
  97 static int lnw_gpio_request(struct gpio_chip *chip, unsigned offset)
  98 {
  99         void __iomem *gafr = gpio_reg_2bit(chip, offset, GAFR);
 100         u32 value = readl(gafr);
 101         int shift = (offset % 16) << 1, af = (value >> shift) & 3;
 102
 103         if (af) {
 104                 value &= ~(3 << shift);
 105                 writel(value, gafr);
 106         }
 107         return 0;
 108 }
 109
 110 static int lnw_gpio_get(struct gpio_chip *chip, unsigned offset)
 111 {
 112         void __iomem *gplr = gpio_reg(chip, offset, GPLR);
 113
 114         return readl(gplr) & BIT(offset % 32);
 115 }
 116
 117 static void lnw_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
 118 {
 119         void __iomem *gpsr, *gpcr;
 120
 121         if (value) {
 122                 gpsr = gpio_reg(chip, offset, GPSR);
 123                 writel(BIT(offset % 32), gpsr);
 124         } else {
 125                 gpcr = gpio_reg(chip, offset, GPCR);
 126                 writel(BIT(offset % 32), gpcr);
 127         }
 128 }
 129
 130 static int lnw_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
 131 {
 132         struct lnw_gpio *lnw = container_of(chip, struct lnw_gpio, chip);
 133         void __iomem *gpdr = gpio_reg(chip, offset, GPDR);
 134         u32 value;
 135         unsigned long flags;
 136
 137         if (lnw->pdev)
 138                 pm_runtime_get(&lnw->pdev->dev);
 139
 140         spin_lock_irqsave(&lnw->lock, flags);
 141         value = readl(gpdr);
 142         value &= ~BIT(offset % 32);
 143         writel(value, gpdr);
 144         spin_unlock_irqrestore(&lnw->lock, flags);
 145
 146         if (lnw->pdev)
 147                 pm_runtime_put(&lnw->pdev->dev);
 148
 149         return 0;
 150 }
 151
 152 static int lnw_gpio_direction_output(struct gpio_chip *chip,
 153                         unsigned offset, int value)
 154 {
 155         struct lnw_gpio *lnw = container_of(chip, struct lnw_gpio, chip);
 156         void __iomem *gpdr = gpio_reg(chip, offset, GPDR);
 157         unsigned long flags;
 158
 159         lnw_gpio_set(chip, offset, value);
 160
 161         if (lnw->pdev)
 162                 pm_runtime_get(&lnw->pdev->dev);
 163
 164         spin_lock_irqsave(&lnw->lock, flags);
 165         value = readl(gpdr);
 166         value |= BIT(offset % 32);
 167         writel(value, gpdr);
 168         spin_unlock_irqrestore(&lnw->lock, flags);
 169
 170         if (lnw->pdev)
 171                 pm_runtime_put(&lnw->pdev->dev);
 172
 173         return 0;
 174 }
 175
 176 static int lnw_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
 177 {
 178         struct lnw_gpio *lnw = container_of(chip, struct lnw_gpio, chip);
 179         return lnw->irq_base + offset;
 180 }
 181
 182 static int lnw_irq_type(struct irq_data *d, unsigned type)
 183 {
 184         struct lnw_gpio *lnw = irq_data_get_irq_chip_data(d);
 185         u32 gpio = d->irq - lnw->irq_base;
 186         unsigned long flags;
 187         u32 value;
 188         void __iomem *grer = gpio_reg(&lnw->chip, gpio, GRER);
 189         void __iomem *gfer = gpio_reg(&lnw->chip, gpio, GFER);
 190
 191         if (gpio >= lnw->chip.ngpio)
 192                 return -EINVAL;
 193
 194         if (lnw->pdev)
 195                 pm_runtime_get(&lnw->pdev->dev);
 196
 197         spin_lock_irqsave(&lnw->lock, flags);
 198         if (type & IRQ_TYPE_EDGE_RISING)
 199                 value = readl(grer) | BIT(gpio % 32);
 200         else
 201                 value = readl(grer) & (~BIT(gpio % 32));
 202         writel(value, grer);
 203
 204         if (type & IRQ_TYPE_EDGE_FALLING)
 205                 value = readl(gfer) | BIT(gpio % 32);
 206         else
 207                 value = readl(gfer) & (~BIT(gpio % 32));
 208         writel(value, gfer);
 209         spin_unlock_irqrestore(&lnw->lock, flags);
 210
 211         if (lnw->pdev)
 212                 pm_runtime_put(&lnw->pdev->dev);
 213
 214         return 0;
 215 }
 216
 217 static void lnw_irq_unmask(struct irq_data *d)
 218 {
 219 }
 220
 221 static void lnw_irq_mask(struct irq_data *d)
 222 {
 223 }
 224
 225 static struct irq_chip lnw_irqchip = {
 226         .name           = "LNW-GPIO",
 227         .irq_mask       = lnw_irq_mask,
 228         .irq_unmask     = lnw_irq_unmask,
 229         .irq_set_type   = lnw_irq_type,
 230 };
 231
 232 static DEFINE_PCI_DEVICE_TABLE(lnw_gpio_ids) = {   /* pin number */
 233         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x080f), .driver_data = 64 },
 234         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x081f), .driver_data = 96 },
 235         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x081a), .driver_data = 96 },
 236         { 0, }
 237 };
 238 MODULE_DEVICE_TABLE(pci, lnw_gpio_ids);
 239
 240 static void lnw_irq_handler(unsigned irq, struct irq_desc *desc)
 241 {
 242         struct irq_data *data = irq_desc_get_irq_data(desc);
 243         struct lnw_gpio *lnw = irq_data_get_irq_handler_data(data);
 244         struct irq_chip *chip = irq_data_get_irq_chip(data);
 245         u32 base, gpio, mask;
 246         unsigned long pending;
 247         void __iomem *gedr;
 248
 249         /* check GPIO controller to check which pin triggered the interrupt */
 250         for (base = 0; base < lnw->chip.ngpio; base += 32) {
 251                 gedr = gpio_reg(&lnw->chip, base, GEDR);
 252                 pending = readl(gedr);
 253                 while (pending) {
 254                         gpio = __ffs(pending);
 255                         mask = BIT(gpio);
 256                         pending &= ~mask;
 257                         /* Clear before handling so we can't lose an edge */
 258                         writel(mask, gedr);
 259                         generic_handle_irq(lnw->irq_base + base + gpio);
 260                 }
 261         }
 262
 263         chip->irq_eoi(data);
 264 }
 265
 266 static void lnw_irq_init_hw(struct lnw_gpio *lnw)
 267 {
 268         void __iomem *reg;
 269         unsigned base;
 270
 271         for (base = 0; base < lnw->chip.ngpio; base += 32) {
 272                 /* Clear the rising-edge detect register */
 273                 reg = gpio_reg(&lnw->chip, base, GRER);
 274                 writel(0, reg);
 275                 /* Clear the falling-edge detect register */
 276                 reg = gpio_reg(&lnw->chip, base, GFER);
 277                 writel(0, reg);
 278                 /* Clear the edge detect status register */
 279                 reg = gpio_reg(&lnw->chip, base, GEDR);
 280                 writel(~0, reg);
 281         }
 282 }
 283
 284 #ifdef CONFIG_PM
 285 static int lnw_gpio_runtime_resume(struct device *dev)
 286 {
 287         return 0;
 288 }
 289
 290 static int lnw_gpio_runtime_suspend(struct device *dev)
 291 {
 292         return 0;
 293 }
 294
 295 static int lnw_gpio_runtime_idle(struct device *dev)
 296 {
 297         int err = pm_schedule_suspend(dev, 500);
 298
 299         if (!err)
 300                 return 0;
 301
 302         return -EBUSY;
 303 }
 304
 305 #else
 306 #define lnw_gpio_runtime_suspend        NULL
 307 #define lnw_gpio_runtime_resume         NULL
 308 #define lnw_gpio_runtime_idle           NULL
 309 #endif
 310
 311 static const struct dev_pm_ops lnw_gpio_pm_ops = {
 312         .runtime_suspend = lnw_gpio_runtime_suspend,
 313         .runtime_resume = lnw_gpio_runtime_resume,
 314         .runtime_idle = lnw_gpio_runtime_idle,
 315 };
 316
 317 static int __devinit lnw_gpio_probe(struct pci_dev *pdev,
 318                         const struct pci_device_id *id)
 319 {
 320         void *base;
 321         int i;
 322         resource_size_t start, len;
 323         struct lnw_gpio *lnw;
 324         u32 irq_base;
 325         u32 gpio_base;
 326         int retval = 0;
 327         int ngpio = id->driver_data;
 328
 329         retval = pci_enable_device(pdev);
 330         if (retval)
 331                 return retval;
 332
 333         retval = pci_request_regions(pdev, "langwell_gpio");
 334         if (retval) {
 335                 dev_err(&pdev->dev, "error requesting resources\n");
 336                 goto err2;
 337         }
 338         /* get the irq_base from bar1 */
 339         start = pci_resource_start(pdev, 1);
 340         len = pci_resource_len(pdev, 1);
 341         base = ioremap_nocache(start, len);
 342         if (!base) {
 343                 dev_err(&pdev->dev, "error mapping bar1\n");
 344                 goto err3;
 345         }
 346         irq_base = *(u32 *)base;
 347         gpio_base = *((u32 *)base + 1);
 348         /* release the IO mapping, since we already get the info from bar1 */
 349         iounmap(base);
 350         /* get the register base from bar0 */
 351         start = pci_resource_start(pdev, 0);
 352         len = pci_resource_len(pdev, 0);
 353         base = devm_ioremap_nocache(&pdev->dev, start, len);
 354         if (!base) {
 355                 dev_err(&pdev->dev, "error mapping bar0\n");
 356                 retval = -EFAULT;
 357                 goto err3;
 358         }
 359
 360         lnw = devm_kzalloc(&pdev->dev, sizeof(struct lnw_gpio), GFP_KERNEL);
 361         if (!lnw) {
 362                 dev_err(&pdev->dev, "can't allocate langwell_gpio chip data\n");
 363                 retval = -ENOMEM;
 364                 goto err3;
 365         }
 366
 367         retval = irq_alloc_descs(-1, irq_base, ngpio, 0);
 368         if (retval < 0) {
 369                 dev_err(&pdev->dev, "can't allocate IRQ descs\n");
 370                 goto err3;
 371         }
 372         lnw->irq_base = retval;
 373
 374         lnw->reg_base = base;
 375         lnw->chip.label = dev_name(&pdev->dev);
 376         lnw->chip.request = lnw_gpio_request;
 377         lnw->chip.direction_input = lnw_gpio_direction_input;
 378         lnw->chip.direction_output = lnw_gpio_direction_output;
 379         lnw->chip.get = lnw_gpio_get;
 380         lnw->chip.set = lnw_gpio_set;
 381         lnw->chip.to_irq = lnw_gpio_to_irq;
 382         lnw->chip.base = gpio_base;
 383         lnw->chip.ngpio = ngpio;
 384         lnw->chip.can_sleep = 0;
 385         lnw->pdev = pdev;
 386         pci_set_drvdata(pdev, lnw);
 387         retval = gpiochip_add(&lnw->chip);
 388         if (retval) {
 389                 dev_err(&pdev->dev, "langwell gpiochip_add error %d\n", retval);
 390                 goto err4;
 391         }
 392
 393         lnw_irq_init_hw(lnw);
 394
 395         irq_set_handler_data(pdev->irq, lnw);
 396         irq_set_chained_handler(pdev->irq, lnw_irq_handler);
 397         for (i = 0; i < lnw->chip.ngpio; i++) {
 398                 irq_set_chip_and_handler_name(i + lnw->irq_base, &lnw_irqchip,
 399                                               handle_simple_irq, "demux");
 400                 irq_set_chip_data(i + lnw->irq_base, lnw);
 401         }
 402
 403         spin_lock_init(&lnw->lock);
 404
 405         pm_runtime_put_noidle(&pdev->dev);
 406         pm_runtime_allow(&pdev->dev);
 407
 408         return 0;
 409
 410 err4:
 411         irq_free_descs(lnw->irq_base, ngpio);
 412 err3:
 413         pci_release_regions(pdev);
 414 err2:
 415         pci_disable_device(pdev);
 416         return retval;
 417 }
 418
 419 static struct pci_driver lnw_gpio_driver = {
 420         .name           = "langwell_gpio",
 421         .id_table       = lnw_gpio_ids,
 422         .probe          = lnw_gpio_probe,
 423         .driver         = {
 424                 .pm     = &lnw_gpio_pm_ops,
 425         },
 426 };
 427
 428
 429 static int __devinit wp_gpio_probe(struct platform_device *pdev)
 430 {
 431         struct lnw_gpio *lnw;
 432         struct gpio_chip *gc;
 433         struct resource *rc;
 434         int retval = 0;
 435
 436         rc = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 437         if (!rc)
 438                 return -EINVAL;
 439
 440         lnw = kzalloc(sizeof(struct lnw_gpio), GFP_KERNEL);
 441         if (!lnw) {
 442                 dev_err(&pdev->dev,
 443                         "can't allocate whitneypoint_gpio chip data\n");
 444                 return -ENOMEM;
 445         }
 446         lnw->reg_base = ioremap_nocache(rc->start, resource_size(rc));
 447         if (lnw->reg_base == NULL) {
 448                 retval = -EINVAL;
 449                 goto err_kmalloc;
 450         }
 451         spin_lock_init(&lnw->lock);
 452         gc = &lnw->chip;
 453         gc->label = dev_name(&pdev->dev);
 454         gc->owner = THIS_MODULE;
 455         gc->direction_input = lnw_gpio_direction_input;
 456         gc->direction_output = lnw_gpio_direction_output;
 457         gc->get = lnw_gpio_get;
 458         gc->set = lnw_gpio_set;
 459         gc->to_irq = NULL;
 460         gc->base = 0;
 461         gc->ngpio = 64;
 462         gc->can_sleep = 0;
 463         retval = gpiochip_add(gc);
 464         if (retval) {
 465                 dev_err(&pdev->dev, "whitneypoint gpiochip_add error %d\n",
 466                                                                 retval);
 467                 goto err_ioremap;
 468         }
 469         platform_set_drvdata(pdev, lnw);
 470         return 0;
 471 err_ioremap:
 472         iounmap(lnw->reg_base);
 473 err_kmalloc:
 474         kfree(lnw);
 475         return retval;
 476 }
 477
 478 static int __devexit wp_gpio_remove(struct platform_device *pdev)
 479 {
 480         struct lnw_gpio *lnw = platform_get_drvdata(pdev);
 481         int err;
 482         err = gpiochip_remove(&lnw->chip);
 483         if (err)
 484                 dev_err(&pdev->dev, "failed to remove gpio_chip.\n");
 485         iounmap(lnw->reg_base);
 486         kfree(lnw);
 487         platform_set_drvdata(pdev, NULL);
 488         return 0;
 489 }
 490
 491 static struct platform_driver wp_gpio_driver = {
 492         .probe          = wp_gpio_probe,
 493         .remove         = __devexit_p(wp_gpio_remove),
 494         .driver         = {
 495                 .name   = "wp_gpio",
 496                 .owner  = THIS_MODULE,
 497         },
 498 };
 499
 500 static int __init lnw_gpio_init(void)
 501 {
 502         int ret;
 503         ret =  pci_register_driver(&lnw_gpio_driver);
 504         if (ret < 0)
 505                 return ret;
 506         ret = platform_driver_register(&wp_gpio_driver);
 507         if (ret < 0)
 508                 pci_unregister_driver(&lnw_gpio_driver);
 509         return ret;
 510 }
 511
 512 device_initcall(lnw_gpio_init);