drivers/irqchip/irq-renesas-irqc.c

   1 /*
   2  * Renesas IRQC Driver
   3  *
   4  *  Copyright (C) 2013 Magnus Damm
   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 as published by
   8  * the Free Software Foundation; either version 2 of the License
   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., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #include <linux/clk.h>
  21 #include <linux/init.h>
  22 #include <linux/platform_device.h>
  23 #include <linux/spinlock.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/ioport.h>
  26 #include <linux/io.h>
  27 #include <linux/irq.h>
  28 #include <linux/irqdomain.h>
  29 #include <linux/err.h>
  30 #include <linux/slab.h>
  31 #include <linux/module.h>
  32 #include <linux/pm_runtime.h>
  33
  34 #define IRQC_IRQ_MAX    32      /* maximum 32 interrupts per driver instance */
  35
  36 #define IRQC_REQ_STS    0x00    /* Interrupt Request Status Register */
  37 #define IRQC_EN_STS     0x04    /* Interrupt Enable Status Register */
  38 #define IRQC_EN_SET     0x08    /* Interrupt Enable Set Register */
  39 #define IRQC_INT_CPU_BASE(n) (0x000 + ((n) * 0x10))
  40                                 /* SYS-CPU vs. RT-CPU */
  41 #define DETECT_STATUS   0x100   /* IRQn Detect Status Register */
  42 #define MONITOR         0x104   /* IRQn Signal Level Monitor Register */
  43 #define HLVL_STS        0x108   /* IRQn High Level Detect Status Register */
  44 #define LLVL_STS        0x10c   /* IRQn Low Level Detect Status Register */
  45 #define S_R_EDGE_STS    0x110   /* IRQn Sync Rising Edge Detect Status Reg. */
  46 #define S_F_EDGE_STS    0x114   /* IRQn Sync Falling Edge Detect Status Reg. */
  47 #define A_R_EDGE_STS    0x118   /* IRQn Async Rising Edge Detect Status Reg. */
  48 #define A_F_EDGE_STS    0x11c   /* IRQn Async Falling Edge Detect Status Reg. */
  49 #define CHTEN_STS       0x120   /* Chattering Reduction Status Register */
  50 #define IRQC_CONFIG(n) (0x180 + ((n) * 0x04))
  51                                 /* IRQn Configuration Register */
  52
  53 struct irqc_irq {
  54         int hw_irq;
  55         int requested_irq;
  56         struct irqc_priv *p;
  57 };
  58
  59 struct irqc_priv {
  60         void __iomem *iomem;
  61         void __iomem *cpu_int_base;
  62         struct irqc_irq irq[IRQC_IRQ_MAX];
  63         unsigned int number_of_irqs;
  64         struct platform_device *pdev;
  65         struct irq_chip irq_chip;
  66         struct irq_domain *irq_domain;
  67         struct clk *clk;
  68 };
  69
  70 static void irqc_dbg(struct irqc_irq *i, char *str)
  71 {
  72         dev_dbg(&i->p->pdev->dev, "%s (%d:%d)\n",
  73                 str, i->requested_irq, i->hw_irq);
  74 }
  75
  76 static void irqc_irq_enable(struct irq_data *d)
  77 {
  78         struct irqc_priv *p = irq_data_get_irq_chip_data(d);
  79         int hw_irq = irqd_to_hwirq(d);
  80
  81         irqc_dbg(&p->irq[hw_irq], "enable");
  82         iowrite32(BIT(hw_irq), p->cpu_int_base + IRQC_EN_SET);
  83 }
  84
  85 static void irqc_irq_disable(struct irq_data *d)
  86 {
  87         struct irqc_priv *p = irq_data_get_irq_chip_data(d);
  88         int hw_irq = irqd_to_hwirq(d);
  89
  90         irqc_dbg(&p->irq[hw_irq], "disable");
  91         iowrite32(BIT(hw_irq), p->cpu_int_base + IRQC_EN_STS);
  92 }
  93
  94 static unsigned char irqc_sense[IRQ_TYPE_SENSE_MASK + 1] = {
  95         [IRQ_TYPE_LEVEL_LOW]    = 0x01,
  96         [IRQ_TYPE_LEVEL_HIGH]   = 0x02,
  97         [IRQ_TYPE_EDGE_FALLING] = 0x04, /* Synchronous */
  98         [IRQ_TYPE_EDGE_RISING]  = 0x08, /* Synchronous */
  99         [IRQ_TYPE_EDGE_BOTH]    = 0x0c, /* Synchronous */
 100 };
 101
 102 static int irqc_irq_set_type(struct irq_data *d, unsigned int type)
 103 {
 104         struct irqc_priv *p = irq_data_get_irq_chip_data(d);
 105         int hw_irq = irqd_to_hwirq(d);
 106         unsigned char value = irqc_sense[type & IRQ_TYPE_SENSE_MASK];
 107         u32 tmp;
 108
 109         irqc_dbg(&p->irq[hw_irq], "sense");
 110
 111         if (!value)
 112                 return -EINVAL;
 113
 114         tmp = ioread32(p->iomem + IRQC_CONFIG(hw_irq));
 115         tmp &= ~0x3f;
 116         tmp |= value;
 117         iowrite32(tmp, p->iomem + IRQC_CONFIG(hw_irq));
 118         return 0;
 119 }
 120
 121 static int irqc_irq_set_wake(struct irq_data *d, unsigned int on)
 122 {
 123         struct irqc_priv *p = irq_data_get_irq_chip_data(d);
 124         int hw_irq = irqd_to_hwirq(d);
 125
 126         irq_set_irq_wake(p->irq[hw_irq].requested_irq, on);
 127
 128         if (!p->clk)
 129                 return 0;
 130
 131         if (on)
 132                 clk_enable(p->clk);
 133         else
 134                 clk_disable(p->clk);
 135
 136         return 0;
 137 }
 138
 139 static irqreturn_t irqc_irq_handler(int irq, void *dev_id)
 140 {
 141         struct irqc_irq *i = dev_id;
 142         struct irqc_priv *p = i->p;
 143         u32 bit = BIT(i->hw_irq);
 144
 145         irqc_dbg(i, "demux1");
 146
 147         if (ioread32(p->iomem + DETECT_STATUS) & bit) {
 148                 iowrite32(bit, p->iomem + DETECT_STATUS);
 149                 irqc_dbg(i, "demux2");
 150                 generic_handle_irq(irq_find_mapping(p->irq_domain, i->hw_irq));
 151                 return IRQ_HANDLED;
 152         }
 153         return IRQ_NONE;
 154 }
 155
 156 /*
 157  * This lock class tells lockdep that IRQC irqs are in a different
 158  * category than their parents, so it won't report false recursion.
 159  */
 160 static struct lock_class_key irqc_irq_lock_class;
 161
 162 static int irqc_irq_domain_map(struct irq_domain *h, unsigned int virq,
 163                                irq_hw_number_t hw)
 164 {
 165         struct irqc_priv *p = h->host_data;
 166
 167         irqc_dbg(&p->irq[hw], "map");
 168         irq_set_chip_data(virq, h->host_data);
 169         irq_set_lockdep_class(virq, &irqc_irq_lock_class);
 170         irq_set_chip_and_handler(virq, &p->irq_chip, handle_level_irq);
 171         return 0;
 172 }
 173
 174 static const struct irq_domain_ops irqc_irq_domain_ops = {
 175         .map    = irqc_irq_domain_map,
 176         .xlate  = irq_domain_xlate_twocell,
 177 };
 178
 179 static int irqc_probe(struct platform_device *pdev)
 180 {
 181         struct irqc_priv *p;
 182         struct resource *io;
 183         struct resource *irq;
 184         struct irq_chip *irq_chip;
 185         const char *name = dev_name(&pdev->dev);
 186         int ret;
 187         int k;
 188
 189         p = kzalloc(sizeof(*p), GFP_KERNEL);
 190         if (!p) {
 191                 dev_err(&pdev->dev, "failed to allocate driver data\n");
 192                 ret = -ENOMEM;
 193                 goto err0;
 194         }
 195
 196         p->pdev = pdev;
 197         platform_set_drvdata(pdev, p);
 198
 199         p->clk = devm_clk_get(&pdev->dev, NULL);
 200         if (IS_ERR(p->clk)) {
 201                 dev_warn(&pdev->dev, "unable to get clock\n");
 202                 p->clk = NULL;
 203         }
 204
 205         pm_runtime_enable(&pdev->dev);
 206         pm_runtime_get_sync(&pdev->dev);
 207
 208         /* get hold of manadatory IOMEM */
 209         io = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 210         if (!io) {
 211                 dev_err(&pdev->dev, "not enough IOMEM resources\n");
 212                 ret = -EINVAL;
 213                 goto err1;
 214         }
 215
 216         /* allow any number of IRQs between 1 and IRQC_IRQ_MAX */
 217         for (k = 0; k < IRQC_IRQ_MAX; k++) {
 218                 irq = platform_get_resource(pdev, IORESOURCE_IRQ, k);
 219                 if (!irq)
 220                         break;
 221
 222                 p->irq[k].p = p;
 223                 p->irq[k].hw_irq = k;
 224                 p->irq[k].requested_irq = irq->start;
 225         }
 226
 227         p->number_of_irqs = k;
 228         if (p->number_of_irqs < 1) {
 229                 dev_err(&pdev->dev, "not enough IRQ resources\n");
 230                 ret = -EINVAL;
 231                 goto err1;
 232         }
 233
 234         /* ioremap IOMEM and setup read/write callbacks */
 235         p->iomem = ioremap_nocache(io->start, resource_size(io));
 236         if (!p->iomem) {
 237                 dev_err(&pdev->dev, "failed to remap IOMEM\n");
 238                 ret = -ENXIO;
 239                 goto err2;
 240         }
 241
 242         p->cpu_int_base = p->iomem + IRQC_INT_CPU_BASE(0); /* SYS-SPI */
 243
 244         irq_chip = &p->irq_chip;
 245         irq_chip->name = name;
 246         irq_chip->irq_mask = irqc_irq_disable;
 247         irq_chip->irq_unmask = irqc_irq_enable;
 248         irq_chip->irq_set_type = irqc_irq_set_type;
 249         irq_chip->irq_set_wake = irqc_irq_set_wake;
 250         irq_chip->flags = IRQCHIP_MASK_ON_SUSPEND;
 251
 252         p->irq_domain = irq_domain_add_linear(pdev->dev.of_node,
 253                                               p->number_of_irqs,
 254                                               &irqc_irq_domain_ops, p);
 255         if (!p->irq_domain) {
 256                 ret = -ENXIO;
 257                 dev_err(&pdev->dev, "cannot initialize irq domain\n");
 258                 goto err2;
 259         }
 260
 261         /* request interrupts one by one */
 262         for (k = 0; k < p->number_of_irqs; k++) {
 263                 if (request_irq(p->irq[k].requested_irq, irqc_irq_handler,
 264                                 0, name, &p->irq[k])) {
 265                         dev_err(&pdev->dev, "failed to request IRQ\n");
 266                         ret = -ENOENT;
 267                         goto err3;
 268                 }
 269         }
 270
 271         dev_info(&pdev->dev, "driving %d irqs\n", p->number_of_irqs);
 272
 273         return 0;
 274 err3:
 275         while (--k >= 0)
 276                 free_irq(p->irq[k].requested_irq, &p->irq[k]);
 277
 278         irq_domain_remove(p->irq_domain);
 279 err2:
 280         iounmap(p->iomem);
 281 err1:
 282         pm_runtime_put(&pdev->dev);
 283         pm_runtime_disable(&pdev->dev);
 284         kfree(p);
 285 err0:
 286         return ret;
 287 }
 288
 289 static int irqc_remove(struct platform_device *pdev)
 290 {
 291         struct irqc_priv *p = platform_get_drvdata(pdev);
 292         int k;
 293
 294         for (k = 0; k < p->number_of_irqs; k++)
 295                 free_irq(p->irq[k].requested_irq, &p->irq[k]);
 296
 297         irq_domain_remove(p->irq_domain);
 298         iounmap(p->iomem);
 299         pm_runtime_put(&pdev->dev);
 300         pm_runtime_disable(&pdev->dev);
 301         kfree(p);
 302         return 0;
 303 }
 304
 305 static const struct of_device_id irqc_dt_ids[] = {
 306         { .compatible = "renesas,irqc", },
 307         {},
 308 };
 309 MODULE_DEVICE_TABLE(of, irqc_dt_ids);
 310
 311 static struct platform_driver irqc_device_driver = {
 312         .probe          = irqc_probe,
 313         .remove         = irqc_remove,
 314         .driver         = {
 315                 .name   = "renesas_irqc",
 316                 .of_match_table = irqc_dt_ids,
 317         }
 318 };
 319
 320 static int __init irqc_init(void)
 321 {
 322         return platform_driver_register(&irqc_device_driver);
 323 }
 324 postcore_initcall(irqc_init);
 325
 326 static void __exit irqc_exit(void)
 327 {
 328         platform_driver_unregister(&irqc_device_driver);
 329 }
 330 module_exit(irqc_exit);
 331
 332 MODULE_AUTHOR("Magnus Damm");
 333 MODULE_DESCRIPTION("Renesas IRQC Driver");
 334 MODULE_LICENSE("GPL v2");