drivers/gpio/gpio-intel-mid.c

   1 /*
   2  * Moorestown platform Langwell chip GPIO driver
   3  *
   4  * Copyright (c) 2008, 2009, 2013, 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  * Clovertrail platform Cloverview chip.
  24  * Merrifield platform Tangier chip.
  25  */
  26
  27 #include <linux/module.h>
  28 #include <linux/pci.h>
  29 #include <linux/platform_device.h>
  30 #include <linux/kernel.h>
  31 #include <linux/delay.h>
  32 #include <linux/stddef.h>
  33 #include <linux/interrupt.h>
  34 #include <linux/init.h>
  35 #include <linux/irq.h>
  36 #include <linux/io.h>
  37 #include <linux/gpio.h>
  38 #include <linux/slab.h>
  39 #include <linux/pm_runtime.h>
  40 #include <linux/irqdomain.h>
  41
  42 #define INTEL_MID_IRQ_TYPE_EDGE         (1 << 0)
  43 #define INTEL_MID_IRQ_TYPE_LEVEL        (1 << 1)
  44
  45 /*
  46  * Langwell chip has 64 pins and thus there are 2 32bit registers to control
  47  * each feature, while Penwell chip has 96 pins for each block, and need 3 32bit
  48  * registers to control them, so we only define the order here instead of a
  49  * structure, to get a bit offset for a pin (use GPDR as an example):
  50  *
  51  * nreg = ngpio / 32;
  52  * reg = offset / 32;
  53  * bit = offset % 32;
  54  * reg_addr = reg_base + GPDR * nreg * 4 + reg * 4;
  55  *
  56  * so the bit of reg_addr is to control pin offset's GPDR feature
  57 */
  58
  59 enum GPIO_REG {
  60         GPLR = 0,       /* pin level read-only */
  61         GPDR,           /* pin direction */
  62         GPSR,           /* pin set */
  63         GPCR,           /* pin clear */
  64         GRER,           /* rising edge detect */
  65         GFER,           /* falling edge detect */
  66         GEDR,           /* edge detect result */
  67         GAFR,           /* alt function */
  68 };
  69
  70 /* intel_mid gpio driver data */
  71 struct intel_mid_gpio_ddata {
  72         u16 ngpio;              /* number of gpio pins */
  73         u32 gplr_offset;        /* offset of first GPLR register from base */
  74         u32 flis_base;          /* base address of FLIS registers */
  75         u32 flis_len;           /* length of FLIS registers */
  76         u32 (*get_flis_offset)(int gpio);
  77         u32 chip_irq_type;      /* chip interrupt type */
  78 };
  79
  80 struct intel_mid_gpio {
  81         struct gpio_chip                chip;
  82         void __iomem                    *reg_base;
  83         spinlock_t                      lock;
  84         struct pci_dev                  *pdev;
  85         struct irq_domain               *domain;
  86 };
  87
  88 #define to_intel_gpio_priv(chip) container_of(chip, struct intel_mid_gpio, chip)
  89
  90 static void __iomem *gpio_reg(struct gpio_chip *chip, unsigned offset,
  91                               enum GPIO_REG reg_type)
  92 {
  93         struct intel_mid_gpio *priv = to_intel_gpio_priv(chip);
  94         unsigned nreg = chip->ngpio / 32;
  95         u8 reg = offset / 32;
  96
  97         return priv->reg_base + reg_type * nreg * 4 + reg * 4;
  98 }
  99
 100 static void __iomem *gpio_reg_2bit(struct gpio_chip *chip, unsigned offset,
 101                                    enum GPIO_REG reg_type)
 102 {
 103         struct intel_mid_gpio *priv = to_intel_gpio_priv(chip);
 104         unsigned nreg = chip->ngpio / 32;
 105         u8 reg = offset / 16;
 106
 107         return priv->reg_base + reg_type * nreg * 4 + reg * 4;
 108 }
 109
 110 static int intel_gpio_request(struct gpio_chip *chip, unsigned offset)
 111 {
 112         void __iomem *gafr = gpio_reg_2bit(chip, offset, GAFR);
 113         u32 value = readl(gafr);
 114         int shift = (offset % 16) << 1, af = (value >> shift) & 3;
 115
 116         if (af) {
 117                 value &= ~(3 << shift);
 118                 writel(value, gafr);
 119         }
 120         return 0;
 121 }
 122
 123 static int intel_gpio_get(struct gpio_chip *chip, unsigned offset)
 124 {
 125         void __iomem *gplr = gpio_reg(chip, offset, GPLR);
 126
 127         return readl(gplr) & BIT(offset % 32);
 128 }
 129
 130 static void intel_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
 131 {
 132         void __iomem *gpsr, *gpcr;
 133
 134         if (value) {
 135                 gpsr = gpio_reg(chip, offset, GPSR);
 136                 writel(BIT(offset % 32), gpsr);
 137         } else {
 138                 gpcr = gpio_reg(chip, offset, GPCR);
 139                 writel(BIT(offset % 32), gpcr);
 140         }
 141 }
 142
 143 static int intel_gpio_direction_input(struct gpio_chip *chip, unsigned offset)
 144 {
 145         struct intel_mid_gpio *priv = to_intel_gpio_priv(chip);
 146         void __iomem *gpdr = gpio_reg(chip, offset, GPDR);
 147         u32 value;
 148         unsigned long flags;
 149
 150         if (priv->pdev)
 151                 pm_runtime_get(&priv->pdev->dev);
 152
 153         spin_lock_irqsave(&priv->lock, flags);
 154         value = readl(gpdr);
 155         value &= ~BIT(offset % 32);
 156         writel(value, gpdr);
 157         spin_unlock_irqrestore(&priv->lock, flags);
 158
 159         if (priv->pdev)
 160                 pm_runtime_put(&priv->pdev->dev);
 161
 162         return 0;
 163 }
 164
 165 static int intel_gpio_direction_output(struct gpio_chip *chip,
 166                         unsigned offset, int value)
 167 {
 168         struct intel_mid_gpio *priv = to_intel_gpio_priv(chip);
 169         void __iomem *gpdr = gpio_reg(chip, offset, GPDR);
 170         unsigned long flags;
 171
 172         intel_gpio_set(chip, offset, value);
 173
 174         if (priv->pdev)
 175                 pm_runtime_get(&priv->pdev->dev);
 176
 177         spin_lock_irqsave(&priv->lock, flags);
 178         value = readl(gpdr);
 179         value |= BIT(offset % 32);
 180         writel(value, gpdr);
 181         spin_unlock_irqrestore(&priv->lock, flags);
 182
 183         if (priv->pdev)
 184                 pm_runtime_put(&priv->pdev->dev);
 185
 186         return 0;
 187 }
 188
 189 static int intel_gpio_to_irq(struct gpio_chip *chip, unsigned offset)
 190 {
 191         struct intel_mid_gpio *priv = to_intel_gpio_priv(chip);
 192         return irq_create_mapping(priv->domain, offset);
 193 }
 194
 195 static int intel_mid_irq_type(struct irq_data *d, unsigned type)
 196 {
 197         struct intel_mid_gpio *priv = irq_data_get_irq_chip_data(d);
 198         u32 gpio = irqd_to_hwirq(d);
 199         unsigned long flags;
 200         u32 value;
 201         void __iomem *grer = gpio_reg(&priv->chip, gpio, GRER);
 202         void __iomem *gfer = gpio_reg(&priv->chip, gpio, GFER);
 203
 204         if (gpio >= priv->chip.ngpio)
 205                 return -EINVAL;
 206
 207         if (priv->pdev)
 208                 pm_runtime_get(&priv->pdev->dev);
 209
 210         spin_lock_irqsave(&priv->lock, flags);
 211         if (type & IRQ_TYPE_EDGE_RISING)
 212                 value = readl(grer) | BIT(gpio % 32);
 213         else
 214                 value = readl(grer) & (~BIT(gpio % 32));
 215         writel(value, grer);
 216
 217         if (type & IRQ_TYPE_EDGE_FALLING)
 218                 value = readl(gfer) | BIT(gpio % 32);
 219         else
 220                 value = readl(gfer) & (~BIT(gpio % 32));
 221         writel(value, gfer);
 222         spin_unlock_irqrestore(&priv->lock, flags);
 223
 224         if (priv->pdev)
 225                 pm_runtime_put(&priv->pdev->dev);
 226
 227         return 0;
 228 }
 229
 230 static void intel_mid_irq_unmask(struct irq_data *d)
 231 {
 232 }
 233
 234 static void intel_mid_irq_mask(struct irq_data *d)
 235 {
 236 }
 237
 238 static unsigned int intel_mid_irq_startup(struct irq_data *d)
 239 {
 240         struct intel_mid_gpio *priv = irq_data_get_irq_chip_data(d);
 241
 242         if (gpio_lock_as_irq(&priv->chip, irqd_to_hwirq(d)))
 243                 dev_err(priv->chip.dev,
 244                         "unable to lock HW IRQ %lu for IRQ\n",
 245                         irqd_to_hwirq(d));
 246         intel_mid_irq_unmask(d);
 247         return 0;
 248 }
 249
 250 static void intel_mid_irq_shutdown(struct irq_data *d)
 251 {
 252         struct intel_mid_gpio *priv = irq_data_get_irq_chip_data(d);
 253
 254         intel_mid_irq_mask(d);
 255         gpio_unlock_as_irq(&priv->chip, irqd_to_hwirq(d));
 256 }
 257
 258 static struct irq_chip intel_mid_irqchip = {
 259         .name           = "INTEL_MID-GPIO",
 260         .irq_mask       = intel_mid_irq_mask,
 261         .irq_unmask     = intel_mid_irq_unmask,
 262         .irq_set_type   = intel_mid_irq_type,
 263         .irq_startup    = intel_mid_irq_startup,
 264         .irq_shutdown   = intel_mid_irq_shutdown,
 265 };
 266
 267 static const struct intel_mid_gpio_ddata gpio_lincroft = {
 268         .ngpio = 64,
 269 };
 270
 271 static const struct intel_mid_gpio_ddata gpio_penwell_aon = {
 272         .ngpio = 96,
 273         .chip_irq_type = INTEL_MID_IRQ_TYPE_EDGE,
 274 };
 275
 276 static const struct intel_mid_gpio_ddata gpio_penwell_core = {
 277         .ngpio = 96,
 278         .chip_irq_type = INTEL_MID_IRQ_TYPE_EDGE,
 279 };
 280
 281 static const struct intel_mid_gpio_ddata gpio_cloverview_aon = {
 282         .ngpio = 96,
 283         .chip_irq_type = INTEL_MID_IRQ_TYPE_EDGE | INTEL_MID_IRQ_TYPE_LEVEL,
 284 };
 285
 286 static const struct intel_mid_gpio_ddata gpio_cloverview_core = {
 287         .ngpio = 96,
 288         .chip_irq_type = INTEL_MID_IRQ_TYPE_EDGE,
 289 };
 290
 291 static const struct intel_mid_gpio_ddata gpio_tangier = {
 292         .ngpio = 192,
 293         .gplr_offset = 4,
 294         .flis_base = 0xff0c0000,
 295         .flis_len = 0x8000,
 296         .get_flis_offset = NULL,
 297         .chip_irq_type = INTEL_MID_IRQ_TYPE_EDGE,
 298 };
 299
 300 static const struct pci_device_id intel_gpio_ids[] = {
 301         {
 302                 /* Lincroft */
 303                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x080f),
 304                 .driver_data = (kernel_ulong_t)&gpio_lincroft,
 305         },
 306         {
 307                 /* Penwell AON */
 308                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x081f),
 309                 .driver_data = (kernel_ulong_t)&gpio_penwell_aon,
 310         },
 311         {
 312                 /* Penwell Core */
 313                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x081a),
 314                 .driver_data = (kernel_ulong_t)&gpio_penwell_core,
 315         },
 316         {
 317                 /* Cloverview Aon */
 318                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x08eb),
 319                 .driver_data = (kernel_ulong_t)&gpio_cloverview_aon,
 320         },
 321         {
 322                 /* Cloverview Core */
 323                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x08f7),
 324                 .driver_data = (kernel_ulong_t)&gpio_cloverview_core,
 325         },
 326         {
 327                 /* Tangier */
 328                 PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x1199),
 329                 .driver_data = (kernel_ulong_t)&gpio_tangier,
 330         },
 331         { 0 }
 332 };
 333 MODULE_DEVICE_TABLE(pci, intel_gpio_ids);
 334
 335 static void intel_mid_irq_handler(unsigned irq, struct irq_desc *desc)
 336 {
 337         struct irq_data *data = irq_desc_get_irq_data(desc);
 338         struct intel_mid_gpio *priv = irq_data_get_irq_handler_data(data);
 339         struct irq_chip *chip = irq_data_get_irq_chip(data);
 340         u32 base, gpio, mask;
 341         unsigned long pending;
 342         void __iomem *gedr;
 343
 344         /* check GPIO controller to check which pin triggered the interrupt */
 345         for (base = 0; base < priv->chip.ngpio; base += 32) {
 346                 gedr = gpio_reg(&priv->chip, base, GEDR);
 347                 while ((pending = readl(gedr))) {
 348                         gpio = __ffs(pending);
 349                         mask = BIT(gpio);
 350                         /* Clear before handling so we can't lose an edge */
 351                         writel(mask, gedr);
 352                         generic_handle_irq(irq_find_mapping(priv->domain,
 353                                                             base + gpio));
 354                 }
 355         }
 356
 357         chip->irq_eoi(data);
 358 }
 359
 360 static void intel_mid_irq_init_hw(struct intel_mid_gpio *priv)
 361 {
 362         void __iomem *reg;
 363         unsigned base;
 364
 365         for (base = 0; base < priv->chip.ngpio; base += 32) {
 366                 /* Clear the rising-edge detect register */
 367                 reg = gpio_reg(&priv->chip, base, GRER);
 368                 writel(0, reg);
 369                 /* Clear the falling-edge detect register */
 370                 reg = gpio_reg(&priv->chip, base, GFER);
 371                 writel(0, reg);
 372                 /* Clear the edge detect status register */
 373                 reg = gpio_reg(&priv->chip, base, GEDR);
 374                 writel(~0, reg);
 375         }
 376 }
 377
 378 static int intel_gpio_irq_map(struct irq_domain *d, unsigned int irq,
 379                             irq_hw_number_t hwirq)
 380 {
 381         struct intel_mid_gpio *priv = d->host_data;
 382
 383         irq_set_chip_and_handler(irq, &intel_mid_irqchip, handle_simple_irq);
 384         irq_set_chip_data(irq, priv);
 385         irq_set_irq_type(irq, IRQ_TYPE_NONE);
 386
 387         return 0;
 388 }
 389
 390 static const struct irq_domain_ops intel_gpio_irq_ops = {
 391         .map = intel_gpio_irq_map,
 392         .xlate = irq_domain_xlate_twocell,
 393 };
 394
 395 static int intel_gpio_runtime_idle(struct device *dev)
 396 {
 397         int err = pm_schedule_suspend(dev, 500);
 398         return err ?: -EBUSY;
 399 }
 400
 401 static const struct dev_pm_ops intel_gpio_pm_ops = {
 402         SET_RUNTIME_PM_OPS(NULL, NULL, intel_gpio_runtime_idle)
 403 };
 404
 405 static int intel_gpio_probe(struct pci_dev *pdev,
 406                           const struct pci_device_id *id)
 407 {
 408         void __iomem *base;
 409         struct intel_mid_gpio *priv;
 410         u32 gpio_base;
 411         u32 irq_base;
 412         int retval;
 413         struct intel_mid_gpio_ddata *ddata =
 414                                 (struct intel_mid_gpio_ddata *)id->driver_data;
 415
 416         retval = pcim_enable_device(pdev);
 417         if (retval)
 418                 return retval;
 419
 420         retval = pcim_iomap_regions(pdev, 1 << 0 | 1 << 1, pci_name(pdev));
 421         if (retval) {
 422                 dev_err(&pdev->dev, "I/O memory mapping error\n");
 423                 return retval;
 424         }
 425
 426         base = pcim_iomap_table(pdev)[1];
 427
 428         irq_base = readl(base);
 429         gpio_base = readl(sizeof(u32) + base);
 430
 431         /* release the IO mapping, since we already get the info from bar1 */
 432         pcim_iounmap_regions(pdev, 1 << 1);
 433
 434         priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
 435         if (!priv) {
 436                 dev_err(&pdev->dev, "can't allocate chip data\n");
 437                 return -ENOMEM;
 438         }
 439
 440         priv->reg_base = pcim_iomap_table(pdev)[0];
 441         priv->chip.label = dev_name(&pdev->dev);
 442         priv->chip.dev = &pdev->dev;
 443         priv->chip.request = intel_gpio_request;
 444         priv->chip.direction_input = intel_gpio_direction_input;
 445         priv->chip.direction_output = intel_gpio_direction_output;
 446         priv->chip.get = intel_gpio_get;
 447         priv->chip.set = intel_gpio_set;
 448         priv->chip.to_irq = intel_gpio_to_irq;
 449         priv->chip.base = gpio_base;
 450         priv->chip.ngpio = ddata->ngpio;
 451         priv->chip.can_sleep = false;
 452         priv->pdev = pdev;
 453
 454         spin_lock_init(&priv->lock);
 455
 456         priv->domain = irq_domain_add_simple(pdev->dev.of_node, ddata->ngpio,
 457                                         irq_base, &intel_gpio_irq_ops, priv);
 458         if (!priv->domain)
 459                 return -ENOMEM;
 460
 461         pci_set_drvdata(pdev, priv);
 462         retval = gpiochip_add(&priv->chip);
 463         if (retval) {
 464                 dev_err(&pdev->dev, "gpiochip_add error %d\n", retval);
 465                 return retval;
 466         }
 467
 468         intel_mid_irq_init_hw(priv);
 469
 470         irq_set_handler_data(pdev->irq, priv);
 471         irq_set_chained_handler(pdev->irq, intel_mid_irq_handler);
 472
 473         pm_runtime_put_noidle(&pdev->dev);
 474         pm_runtime_allow(&pdev->dev);
 475
 476         return 0;
 477 }
 478
 479 static struct pci_driver intel_gpio_driver = {
 480         .name           = "intel_mid_gpio",
 481         .id_table       = intel_gpio_ids,
 482         .probe          = intel_gpio_probe,
 483         .driver         = {
 484                 .pm     = &intel_gpio_pm_ops,
 485         },
 486 };
 487
 488 static int __init intel_gpio_init(void)
 489 {
 490         return pci_register_driver(&intel_gpio_driver);
 491 }
 492
 493 device_initcall(intel_gpio_init);