drivers/gpio/gpio-pch.c

   1 /*
   2  * Copyright (C) 2011 LAPIS Semiconductor Co., 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 as published by
   6  * the Free Software Foundation; version 2 of the License.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License
  14  * along with this program; if not, write to the Free Software
  15  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
  16  */
  17 #include <linux/module.h>
  18 #include <linux/kernel.h>
  19 #include <linux/pci.h>
  20 #include <linux/gpio.h>
  21 #include <linux/interrupt.h>
  22 #include <linux/irq.h>
  23
  24 #define PCH_EDGE_FALLING        0
  25 #define PCH_EDGE_RISING         BIT(0)
  26 #define PCH_LEVEL_L             BIT(1)
  27 #define PCH_LEVEL_H             (BIT(0) | BIT(1))
  28 #define PCH_EDGE_BOTH           BIT(2)
  29 #define PCH_IM_MASK             (BIT(0) | BIT(1) | BIT(2))
  30
  31 #define PCH_IRQ_BASE            24
  32
  33 struct pch_regs {
  34         u32     ien;
  35         u32     istatus;
  36         u32     idisp;
  37         u32     iclr;
  38         u32     imask;
  39         u32     imaskclr;
  40         u32     po;
  41         u32     pi;
  42         u32     pm;
  43         u32     im0;
  44         u32     im1;
  45         u32     reserved[3];
  46         u32     gpio_use_sel;
  47         u32     reset;
  48 };
  49
  50 enum pch_type_t {
  51         INTEL_EG20T_PCH,
  52         OKISEMI_ML7223m_IOH, /* LAPIS Semiconductor ML7223 IOH PCIe Bus-m */
  53         OKISEMI_ML7223n_IOH  /* LAPIS Semiconductor ML7223 IOH PCIe Bus-n */
  54 };
  55
  56 /* Specifies number of GPIO PINS */
  57 static int gpio_pins[] = {
  58         [INTEL_EG20T_PCH] = 12,
  59         [OKISEMI_ML7223m_IOH] = 8,
  60         [OKISEMI_ML7223n_IOH] = 8,
  61 };
  62
  63 /**
  64  * struct pch_gpio_reg_data - The register store data.
  65  * @ien_reg:    To store contents of IEN register.
  66  * @imask_reg:  To store contents of IMASK register.
  67  * @po_reg:     To store contents of PO register.
  68  * @pm_reg:     To store contents of PM register.
  69  * @im0_reg:    To store contents of IM0 register.
  70  * @im1_reg:    To store contents of IM1 register.
  71  * @gpio_use_sel_reg : To store contents of GPIO_USE_SEL register.
  72  *                     (Only ML7223 Bus-n)
  73  */
  74 struct pch_gpio_reg_data {
  75         u32 ien_reg;
  76         u32 imask_reg;
  77         u32 po_reg;
  78         u32 pm_reg;
  79         u32 im0_reg;
  80         u32 im1_reg;
  81         u32 gpio_use_sel_reg;
  82 };
  83
  84 /**
  85  * struct pch_gpio - GPIO private data structure.
  86  * @base:                       PCI base address of Memory mapped I/O register.
  87  * @reg:                        Memory mapped PCH GPIO register list.
  88  * @dev:                        Pointer to device structure.
  89  * @gpio:                       Data for GPIO infrastructure.
  90  * @pch_gpio_reg:               Memory mapped Register data is saved here
  91  *                              when suspend.
  92  * @lock:                       Used for register access protection
  93  * @irq_base:           Save base of IRQ number for interrupt
  94  * @ioh:                IOH ID
  95  * @spinlock:           Used for register access protection in
  96  *                              interrupt context pch_irq_mask,
  97  *                              pch_irq_unmask and pch_irq_type;
  98  */
  99 struct pch_gpio {
 100         void __iomem *base;
 101         struct pch_regs __iomem *reg;
 102         struct device *dev;
 103         struct gpio_chip gpio;
 104         struct pch_gpio_reg_data pch_gpio_reg;
 105         struct mutex lock;
 106         int irq_base;
 107         enum pch_type_t ioh;
 108         spinlock_t spinlock;
 109 };
 110
 111 static void pch_gpio_set(struct gpio_chip *gpio, unsigned nr, int val)
 112 {
 113         u32 reg_val;
 114         struct pch_gpio *chip = container_of(gpio, struct pch_gpio, gpio);
 115
 116         mutex_lock(&chip->lock);
 117         reg_val = ioread32(&chip->reg->po);
 118         if (val)
 119                 reg_val |= (1 << nr);
 120         else
 121                 reg_val &= ~(1 << nr);
 122
 123         iowrite32(reg_val, &chip->reg->po);
 124         mutex_unlock(&chip->lock);
 125 }
 126
 127 static int pch_gpio_get(struct gpio_chip *gpio, unsigned nr)
 128 {
 129         struct pch_gpio *chip = container_of(gpio, struct pch_gpio, gpio);
 130
 131         return ioread32(&chip->reg->pi) & (1 << nr);
 132 }
 133
 134 static int pch_gpio_direction_output(struct gpio_chip *gpio, unsigned nr,
 135                                      int val)
 136 {
 137         struct pch_gpio *chip = container_of(gpio, struct pch_gpio, gpio);
 138         u32 pm;
 139         u32 reg_val;
 140
 141         mutex_lock(&chip->lock);
 142         pm = ioread32(&chip->reg->pm) & ((1 << gpio_pins[chip->ioh]) - 1);
 143         pm |= (1 << nr);
 144         iowrite32(pm, &chip->reg->pm);
 145
 146         reg_val = ioread32(&chip->reg->po);
 147         if (val)
 148                 reg_val |= (1 << nr);
 149         else
 150                 reg_val &= ~(1 << nr);
 151         iowrite32(reg_val, &chip->reg->po);
 152
 153         mutex_unlock(&chip->lock);
 154
 155         return 0;
 156 }
 157
 158 static int pch_gpio_direction_input(struct gpio_chip *gpio, unsigned nr)
 159 {
 160         struct pch_gpio *chip = container_of(gpio, struct pch_gpio, gpio);
 161         u32 pm;
 162
 163         mutex_lock(&chip->lock);
 164         pm = ioread32(&chip->reg->pm) & ((1 << gpio_pins[chip->ioh]) - 1);
 165         pm &= ~(1 << nr);
 166         iowrite32(pm, &chip->reg->pm);
 167         mutex_unlock(&chip->lock);
 168
 169         return 0;
 170 }
 171
 172 /*
 173  * Save register configuration and disable interrupts.
 174  */
 175 static void pch_gpio_save_reg_conf(struct pch_gpio *chip)
 176 {
 177         chip->pch_gpio_reg.ien_reg = ioread32(&chip->reg->ien);
 178         chip->pch_gpio_reg.imask_reg = ioread32(&chip->reg->imask);
 179         chip->pch_gpio_reg.po_reg = ioread32(&chip->reg->po);
 180         chip->pch_gpio_reg.pm_reg = ioread32(&chip->reg->pm);
 181         chip->pch_gpio_reg.im0_reg = ioread32(&chip->reg->im0);
 182         if (chip->ioh == INTEL_EG20T_PCH)
 183                 chip->pch_gpio_reg.im1_reg = ioread32(&chip->reg->im1);
 184         if (chip->ioh == OKISEMI_ML7223n_IOH)
 185                 chip->pch_gpio_reg.gpio_use_sel_reg =\
 186                                             ioread32(&chip->reg->gpio_use_sel);
 187 }
 188
 189 /*
 190  * This function restores the register configuration of the GPIO device.
 191  */
 192 static void pch_gpio_restore_reg_conf(struct pch_gpio *chip)
 193 {
 194         iowrite32(chip->pch_gpio_reg.ien_reg, &chip->reg->ien);
 195         iowrite32(chip->pch_gpio_reg.imask_reg, &chip->reg->imask);
 196         /* to store contents of PO register */
 197         iowrite32(chip->pch_gpio_reg.po_reg, &chip->reg->po);
 198         /* to store contents of PM register */
 199         iowrite32(chip->pch_gpio_reg.pm_reg, &chip->reg->pm);
 200         iowrite32(chip->pch_gpio_reg.im0_reg, &chip->reg->im0);
 201         if (chip->ioh == INTEL_EG20T_PCH)
 202                 iowrite32(chip->pch_gpio_reg.im1_reg, &chip->reg->im1);
 203         if (chip->ioh == OKISEMI_ML7223n_IOH)
 204                 iowrite32(chip->pch_gpio_reg.gpio_use_sel_reg,
 205                           &chip->reg->gpio_use_sel);
 206 }
 207
 208 static int pch_gpio_to_irq(struct gpio_chip *gpio, unsigned offset)
 209 {
 210         struct pch_gpio *chip = container_of(gpio, struct pch_gpio, gpio);
 211         return chip->irq_base + offset;
 212 }
 213
 214 static void pch_gpio_setup(struct pch_gpio *chip)
 215 {
 216         struct gpio_chip *gpio = &chip->gpio;
 217
 218         gpio->label = dev_name(chip->dev);
 219         gpio->owner = THIS_MODULE;
 220         gpio->direction_input = pch_gpio_direction_input;
 221         gpio->get = pch_gpio_get;
 222         gpio->direction_output = pch_gpio_direction_output;
 223         gpio->set = pch_gpio_set;
 224         gpio->dbg_show = NULL;
 225         gpio->base = -1;
 226         gpio->ngpio = gpio_pins[chip->ioh];
 227         gpio->can_sleep = 0;
 228         gpio->to_irq = pch_gpio_to_irq;
 229 }
 230
 231 static int pch_irq_type(struct irq_data *d, unsigned int type)
 232 {
 233         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 234         struct pch_gpio *chip = gc->private;
 235         u32 im, im_pos, val;
 236         u32 __iomem *im_reg;
 237         unsigned long flags;
 238         int ch, irq = d->irq;
 239
 240         ch = irq - chip->irq_base;
 241         if (irq <= chip->irq_base + 7) {
 242                 im_reg = &chip->reg->im0;
 243                 im_pos = ch;
 244         } else {
 245                 im_reg = &chip->reg->im1;
 246                 im_pos = ch - 8;
 247         }
 248         dev_dbg(chip->dev, "%s:irq=%d type=%d ch=%d pos=%d\n",
 249                 __func__, irq, type, ch, im_pos);
 250
 251         spin_lock_irqsave(&chip->spinlock, flags);
 252
 253         switch (type) {
 254         case IRQ_TYPE_EDGE_RISING:
 255                 val = PCH_EDGE_RISING;
 256                 break;
 257         case IRQ_TYPE_EDGE_FALLING:
 258                 val = PCH_EDGE_FALLING;
 259                 break;
 260         case IRQ_TYPE_EDGE_BOTH:
 261                 val = PCH_EDGE_BOTH;
 262                 break;
 263         case IRQ_TYPE_LEVEL_HIGH:
 264                 val = PCH_LEVEL_H;
 265                 break;
 266         case IRQ_TYPE_LEVEL_LOW:
 267                 val = PCH_LEVEL_L;
 268                 break;
 269         default:
 270                 goto unlock;
 271         }
 272
 273         /* Set interrupt mode */
 274         im = ioread32(im_reg) & ~(PCH_IM_MASK << (im_pos * 4));
 275         iowrite32(im | (val << (im_pos * 4)), im_reg);
 276
 277         /* And the handler */
 278         if (type & (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH))
 279                 __irq_set_handler_locked(d->irq, handle_level_irq);
 280         else if (type & (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING))
 281                 __irq_set_handler_locked(d->irq, handle_edge_irq);
 282
 283 unlock:
 284         spin_unlock_irqrestore(&chip->spinlock, flags);
 285         return 0;
 286 }
 287
 288 static void pch_irq_unmask(struct irq_data *d)
 289 {
 290         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 291         struct pch_gpio *chip = gc->private;
 292
 293         iowrite32(1 << (d->irq - chip->irq_base), &chip->reg->imaskclr);
 294 }
 295
 296 static void pch_irq_mask(struct irq_data *d)
 297 {
 298         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 299         struct pch_gpio *chip = gc->private;
 300
 301         iowrite32(1 << (d->irq - chip->irq_base), &chip->reg->imask);
 302 }
 303
 304 static void pch_irq_ack(struct irq_data *d)
 305 {
 306         struct irq_chip_generic *gc = irq_data_get_irq_chip_data(d);
 307         struct pch_gpio *chip = gc->private;
 308
 309         iowrite32(1 << (d->irq - chip->irq_base), &chip->reg->iclr);
 310 }
 311
 312 static irqreturn_t pch_gpio_handler(int irq, void *dev_id)
 313 {
 314         struct pch_gpio *chip = dev_id;
 315         u32 reg_val = ioread32(&chip->reg->istatus);
 316         int i, ret = IRQ_NONE;
 317
 318         for (i = 0; i < gpio_pins[chip->ioh]; i++) {
 319                 if (reg_val & BIT(i)) {
 320                         dev_dbg(chip->dev, "%s:[%d]:irq=%d  status=0x%x\n",
 321                                 __func__, i, irq, reg_val);
 322                         generic_handle_irq(chip->irq_base + i);
 323                         ret = IRQ_HANDLED;
 324                 }
 325         }
 326         return ret;
 327 }
 328
 329 static __devinit void pch_gpio_alloc_generic_chip(struct pch_gpio *chip,
 330                                 unsigned int irq_start, unsigned int num)
 331 {
 332         struct irq_chip_generic *gc;
 333         struct irq_chip_type *ct;
 334
 335         gc = irq_alloc_generic_chip("pch_gpio", 1, irq_start, chip->base,
 336                                     handle_simple_irq);
 337         gc->private = chip;
 338         ct = gc->chip_types;
 339
 340         ct->chip.irq_ack = pch_irq_ack;
 341         ct->chip.irq_mask = pch_irq_mask;
 342         ct->chip.irq_unmask = pch_irq_unmask;
 343         ct->chip.irq_set_type = pch_irq_type;
 344
 345         irq_setup_generic_chip(gc, IRQ_MSK(num), IRQ_GC_INIT_MASK_CACHE,
 346                                IRQ_NOREQUEST | IRQ_NOPROBE, 0);
 347 }
 348
 349 static int __devinit pch_gpio_probe(struct pci_dev *pdev,
 350                                     const struct pci_device_id *id)
 351 {
 352         s32 ret;
 353         struct pch_gpio *chip;
 354         int irq_base;
 355         u32 msk;
 356
 357         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
 358         if (chip == NULL)
 359                 return -ENOMEM;
 360
 361         chip->dev = &pdev->dev;
 362         ret = pci_enable_device(pdev);
 363         if (ret) {
 364                 dev_err(&pdev->dev, "%s : pci_enable_device FAILED", __func__);
 365                 goto err_pci_enable;
 366         }
 367
 368         ret = pci_request_regions(pdev, KBUILD_MODNAME);
 369         if (ret) {
 370                 dev_err(&pdev->dev, "pci_request_regions FAILED-%d", ret);
 371                 goto err_request_regions;
 372         }
 373
 374         chip->base = pci_iomap(pdev, 1, 0);
 375         if (!chip->base) {
 376                 dev_err(&pdev->dev, "%s : pci_iomap FAILED", __func__);
 377                 ret = -ENOMEM;
 378                 goto err_iomap;
 379         }
 380
 381         if (pdev->device == 0x8803)
 382                 chip->ioh = INTEL_EG20T_PCH;
 383         else if (pdev->device == 0x8014)
 384                 chip->ioh = OKISEMI_ML7223m_IOH;
 385         else if (pdev->device == 0x8043)
 386                 chip->ioh = OKISEMI_ML7223n_IOH;
 387
 388         chip->reg = chip->base;
 389         pci_set_drvdata(pdev, chip);
 390         mutex_init(&chip->lock);
 391         spin_lock_init(&chip->spinlock);
 392         pch_gpio_setup(chip);
 393         ret = gpiochip_add(&chip->gpio);
 394         if (ret) {
 395                 dev_err(&pdev->dev, "PCH gpio: Failed to register GPIO\n");
 396                 goto err_gpiochip_add;
 397         }
 398
 399         irq_base = irq_alloc_descs(-1, 0, gpio_pins[chip->ioh], NUMA_NO_NODE);
 400         if (irq_base < 0) {
 401                 dev_warn(&pdev->dev, "PCH gpio: Failed to get IRQ base num\n");
 402                 chip->irq_base = -1;
 403                 goto end;
 404         }
 405         chip->irq_base = irq_base;
 406
 407         /* Mask all interrupts, but enable them */
 408         msk = (1 << gpio_pins[chip->ioh]) - 1;
 409         iowrite32(msk, &chip->reg->imask);
 410         iowrite32(msk, &chip->reg->ien);
 411
 412         ret = request_irq(pdev->irq, pch_gpio_handler,
 413                           IRQF_SHARED, KBUILD_MODNAME, chip);
 414         if (ret != 0) {
 415                 dev_err(&pdev->dev,
 416                         "%s request_irq failed\n", __func__);
 417                 goto err_request_irq;
 418         }
 419
 420         pch_gpio_alloc_generic_chip(chip, irq_base, gpio_pins[chip->ioh]);
 421
 422 end:
 423         return 0;
 424
 425 err_request_irq:
 426         irq_free_descs(irq_base, gpio_pins[chip->ioh]);
 427
 428         ret = gpiochip_remove(&chip->gpio);
 429         if (ret)
 430                 dev_err(&pdev->dev, "%s gpiochip_remove failed\n", __func__);
 431
 432 err_gpiochip_add:
 433         pci_iounmap(pdev, chip->base);
 434
 435 err_iomap:
 436         pci_release_regions(pdev);
 437
 438 err_request_regions:
 439         pci_disable_device(pdev);
 440
 441 err_pci_enable:
 442         kfree(chip);
 443         dev_err(&pdev->dev, "%s Failed returns %d\n", __func__, ret);
 444         return ret;
 445 }
 446
 447 static void __devexit pch_gpio_remove(struct pci_dev *pdev)
 448 {
 449         int err;
 450         struct pch_gpio *chip = pci_get_drvdata(pdev);
 451
 452         if (chip->irq_base != -1) {
 453                 free_irq(pdev->irq, chip);
 454
 455                 irq_free_descs(chip->irq_base, gpio_pins[chip->ioh]);
 456         }
 457
 458         err = gpiochip_remove(&chip->gpio);
 459         if (err)
 460                 dev_err(&pdev->dev, "Failed gpiochip_remove\n");
 461
 462         pci_iounmap(pdev, chip->base);
 463         pci_release_regions(pdev);
 464         pci_disable_device(pdev);
 465         kfree(chip);
 466 }
 467
 468 #ifdef CONFIG_PM
 469 static int pch_gpio_suspend(struct pci_dev *pdev, pm_message_t state)
 470 {
 471         s32 ret;
 472         struct pch_gpio *chip = pci_get_drvdata(pdev);
 473         unsigned long flags;
 474
 475         spin_lock_irqsave(&chip->spinlock, flags);
 476         pch_gpio_save_reg_conf(chip);
 477         spin_unlock_irqrestore(&chip->spinlock, flags);
 478
 479         ret = pci_save_state(pdev);
 480         if (ret) {
 481                 dev_err(&pdev->dev, "pci_save_state Failed-%d\n", ret);
 482                 return ret;
 483         }
 484         pci_disable_device(pdev);
 485         pci_set_power_state(pdev, PCI_D0);
 486         ret = pci_enable_wake(pdev, PCI_D0, 1);
 487         if (ret)
 488                 dev_err(&pdev->dev, "pci_enable_wake Failed -%d\n", ret);
 489
 490         return 0;
 491 }
 492
 493 static int pch_gpio_resume(struct pci_dev *pdev)
 494 {
 495         s32 ret;
 496         struct pch_gpio *chip = pci_get_drvdata(pdev);
 497         unsigned long flags;
 498
 499         ret = pci_enable_wake(pdev, PCI_D0, 0);
 500
 501         pci_set_power_state(pdev, PCI_D0);
 502         ret = pci_enable_device(pdev);
 503         if (ret) {
 504                 dev_err(&pdev->dev, "pci_enable_device Failed-%d ", ret);
 505                 return ret;
 506         }
 507         pci_restore_state(pdev);
 508
 509         spin_lock_irqsave(&chip->spinlock, flags);
 510         iowrite32(0x01, &chip->reg->reset);
 511         iowrite32(0x00, &chip->reg->reset);
 512         pch_gpio_restore_reg_conf(chip);
 513         spin_unlock_irqrestore(&chip->spinlock, flags);
 514
 515         return 0;
 516 }
 517 #else
 518 #define pch_gpio_suspend NULL
 519 #define pch_gpio_resume NULL
 520 #endif
 521
 522 #define PCI_VENDOR_ID_ROHM             0x10DB
 523 static DEFINE_PCI_DEVICE_TABLE(pch_gpio_pcidev_id) = {
 524         { PCI_DEVICE(PCI_VENDOR_ID_INTEL, 0x8803) },
 525         { PCI_DEVICE(PCI_VENDOR_ID_ROHM, 0x8014) },
 526         { PCI_DEVICE(PCI_VENDOR_ID_ROHM, 0x8043) },
 527         { PCI_DEVICE(PCI_VENDOR_ID_ROHM, 0x8803) },
 528         { 0, }
 529 };
 530 MODULE_DEVICE_TABLE(pci, pch_gpio_pcidev_id);
 531
 532 static struct pci_driver pch_gpio_driver = {
 533         .name = "pch_gpio",
 534         .id_table = pch_gpio_pcidev_id,
 535         .probe = pch_gpio_probe,
 536         .remove = __devexit_p(pch_gpio_remove),
 537         .suspend = pch_gpio_suspend,
 538         .resume = pch_gpio_resume
 539 };
 540
 541 static int __init pch_gpio_pci_init(void)
 542 {
 543         return pci_register_driver(&pch_gpio_driver);
 544 }
 545 module_init(pch_gpio_pci_init);
 546
 547 static void __exit pch_gpio_pci_exit(void)
 548 {
 549         pci_unregister_driver(&pch_gpio_driver);
 550 }
 551 module_exit(pch_gpio_pci_exit);
 552
 553 MODULE_DESCRIPTION("PCH GPIO PCI Driver");
 554 MODULE_LICENSE("GPL");