Linux 4.16.11
[linux/fpc-iii.git] / drivers / irqchip / irq-renesas-intc-irqpin.c
blobcee59fe1321c44f9e37c9b6e5bcfc1a57fb98f41
1 /*
2 * Renesas INTC External IRQ Pin Driver
4 * Copyright (C) 2013 Magnus Damm
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
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.
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
20 #include <linux/clk.h>
21 #include <linux/init.h>
22 #include <linux/of.h>
23 #include <linux/platform_device.h>
24 #include <linux/spinlock.h>
25 #include <linux/interrupt.h>
26 #include <linux/ioport.h>
27 #include <linux/io.h>
28 #include <linux/irq.h>
29 #include <linux/irqdomain.h>
30 #include <linux/err.h>
31 #include <linux/slab.h>
32 #include <linux/module.h>
33 #include <linux/of_device.h>
34 #include <linux/pm_runtime.h>
36 #define INTC_IRQPIN_MAX 8 /* maximum 8 interrupts per driver instance */
38 #define INTC_IRQPIN_REG_SENSE 0 /* ICRn */
39 #define INTC_IRQPIN_REG_PRIO 1 /* INTPRInn */
40 #define INTC_IRQPIN_REG_SOURCE 2 /* INTREQnn */
41 #define INTC_IRQPIN_REG_MASK 3 /* INTMSKnn */
42 #define INTC_IRQPIN_REG_CLEAR 4 /* INTMSKCLRnn */
43 #define INTC_IRQPIN_REG_NR_MANDATORY 5
44 #define INTC_IRQPIN_REG_IRLM 5 /* ICR0 with IRLM bit (optional) */
45 #define INTC_IRQPIN_REG_NR 6
47 /* INTC external IRQ PIN hardware register access:
49 * SENSE is read-write 32-bit with 2-bits or 4-bits per IRQ (*)
50 * PRIO is read-write 32-bit with 4-bits per IRQ (**)
51 * SOURCE is read-only 32-bit or 8-bit with 1-bit per IRQ (***)
52 * MASK is write-only 32-bit or 8-bit with 1-bit per IRQ (***)
53 * CLEAR is write-only 32-bit or 8-bit with 1-bit per IRQ (***)
55 * (*) May be accessed by more than one driver instance - lock needed
56 * (**) Read-modify-write access by one driver instance - lock needed
57 * (***) Accessed by one driver instance only - no locking needed
60 struct intc_irqpin_iomem {
61 void __iomem *iomem;
62 unsigned long (*read)(void __iomem *iomem);
63 void (*write)(void __iomem *iomem, unsigned long data);
64 int width;
67 struct intc_irqpin_irq {
68 int hw_irq;
69 int requested_irq;
70 int domain_irq;
71 struct intc_irqpin_priv *p;
74 struct intc_irqpin_priv {
75 struct intc_irqpin_iomem iomem[INTC_IRQPIN_REG_NR];
76 struct intc_irqpin_irq irq[INTC_IRQPIN_MAX];
77 unsigned int sense_bitfield_width;
78 struct platform_device *pdev;
79 struct irq_chip irq_chip;
80 struct irq_domain *irq_domain;
81 struct clk *clk;
82 unsigned shared_irqs:1;
83 unsigned needs_clk:1;
84 u8 shared_irq_mask;
87 struct intc_irqpin_config {
88 unsigned int irlm_bit;
89 unsigned needs_irlm:1;
90 unsigned needs_clk:1;
93 static unsigned long intc_irqpin_read32(void __iomem *iomem)
95 return ioread32(iomem);
98 static unsigned long intc_irqpin_read8(void __iomem *iomem)
100 return ioread8(iomem);
103 static void intc_irqpin_write32(void __iomem *iomem, unsigned long data)
105 iowrite32(data, iomem);
108 static void intc_irqpin_write8(void __iomem *iomem, unsigned long data)
110 iowrite8(data, iomem);
113 static inline unsigned long intc_irqpin_read(struct intc_irqpin_priv *p,
114 int reg)
116 struct intc_irqpin_iomem *i = &p->iomem[reg];
118 return i->read(i->iomem);
121 static inline void intc_irqpin_write(struct intc_irqpin_priv *p,
122 int reg, unsigned long data)
124 struct intc_irqpin_iomem *i = &p->iomem[reg];
126 i->write(i->iomem, data);
129 static inline unsigned long intc_irqpin_hwirq_mask(struct intc_irqpin_priv *p,
130 int reg, int hw_irq)
132 return BIT((p->iomem[reg].width - 1) - hw_irq);
135 static inline void intc_irqpin_irq_write_hwirq(struct intc_irqpin_priv *p,
136 int reg, int hw_irq)
138 intc_irqpin_write(p, reg, intc_irqpin_hwirq_mask(p, reg, hw_irq));
141 static DEFINE_RAW_SPINLOCK(intc_irqpin_lock); /* only used by slow path */
143 static void intc_irqpin_read_modify_write(struct intc_irqpin_priv *p,
144 int reg, int shift,
145 int width, int value)
147 unsigned long flags;
148 unsigned long tmp;
150 raw_spin_lock_irqsave(&intc_irqpin_lock, flags);
152 tmp = intc_irqpin_read(p, reg);
153 tmp &= ~(((1 << width) - 1) << shift);
154 tmp |= value << shift;
155 intc_irqpin_write(p, reg, tmp);
157 raw_spin_unlock_irqrestore(&intc_irqpin_lock, flags);
160 static void intc_irqpin_mask_unmask_prio(struct intc_irqpin_priv *p,
161 int irq, int do_mask)
163 /* The PRIO register is assumed to be 32-bit with fixed 4-bit fields. */
164 int bitfield_width = 4;
165 int shift = 32 - (irq + 1) * bitfield_width;
167 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_PRIO,
168 shift, bitfield_width,
169 do_mask ? 0 : (1 << bitfield_width) - 1);
172 static int intc_irqpin_set_sense(struct intc_irqpin_priv *p, int irq, int value)
174 /* The SENSE register is assumed to be 32-bit. */
175 int bitfield_width = p->sense_bitfield_width;
176 int shift = 32 - (irq + 1) * bitfield_width;
178 dev_dbg(&p->pdev->dev, "sense irq = %d, mode = %d\n", irq, value);
180 if (value >= (1 << bitfield_width))
181 return -EINVAL;
183 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_SENSE, shift,
184 bitfield_width, value);
185 return 0;
188 static void intc_irqpin_dbg(struct intc_irqpin_irq *i, char *str)
190 dev_dbg(&i->p->pdev->dev, "%s (%d:%d:%d)\n",
191 str, i->requested_irq, i->hw_irq, i->domain_irq);
194 static void intc_irqpin_irq_enable(struct irq_data *d)
196 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
197 int hw_irq = irqd_to_hwirq(d);
199 intc_irqpin_dbg(&p->irq[hw_irq], "enable");
200 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_CLEAR, hw_irq);
203 static void intc_irqpin_irq_disable(struct irq_data *d)
205 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
206 int hw_irq = irqd_to_hwirq(d);
208 intc_irqpin_dbg(&p->irq[hw_irq], "disable");
209 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_MASK, hw_irq);
212 static void intc_irqpin_shared_irq_enable(struct irq_data *d)
214 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
215 int hw_irq = irqd_to_hwirq(d);
217 intc_irqpin_dbg(&p->irq[hw_irq], "shared enable");
218 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_CLEAR, hw_irq);
220 p->shared_irq_mask &= ~BIT(hw_irq);
223 static void intc_irqpin_shared_irq_disable(struct irq_data *d)
225 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
226 int hw_irq = irqd_to_hwirq(d);
228 intc_irqpin_dbg(&p->irq[hw_irq], "shared disable");
229 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_MASK, hw_irq);
231 p->shared_irq_mask |= BIT(hw_irq);
234 static void intc_irqpin_irq_enable_force(struct irq_data *d)
236 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
237 int irq = p->irq[irqd_to_hwirq(d)].requested_irq;
239 intc_irqpin_irq_enable(d);
241 /* enable interrupt through parent interrupt controller,
242 * assumes non-shared interrupt with 1:1 mapping
243 * needed for busted IRQs on some SoCs like sh73a0
245 irq_get_chip(irq)->irq_unmask(irq_get_irq_data(irq));
248 static void intc_irqpin_irq_disable_force(struct irq_data *d)
250 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
251 int irq = p->irq[irqd_to_hwirq(d)].requested_irq;
253 /* disable interrupt through parent interrupt controller,
254 * assumes non-shared interrupt with 1:1 mapping
255 * needed for busted IRQs on some SoCs like sh73a0
257 irq_get_chip(irq)->irq_mask(irq_get_irq_data(irq));
258 intc_irqpin_irq_disable(d);
261 #define INTC_IRQ_SENSE_VALID 0x10
262 #define INTC_IRQ_SENSE(x) (x + INTC_IRQ_SENSE_VALID)
264 static unsigned char intc_irqpin_sense[IRQ_TYPE_SENSE_MASK + 1] = {
265 [IRQ_TYPE_EDGE_FALLING] = INTC_IRQ_SENSE(0x00),
266 [IRQ_TYPE_EDGE_RISING] = INTC_IRQ_SENSE(0x01),
267 [IRQ_TYPE_LEVEL_LOW] = INTC_IRQ_SENSE(0x02),
268 [IRQ_TYPE_LEVEL_HIGH] = INTC_IRQ_SENSE(0x03),
269 [IRQ_TYPE_EDGE_BOTH] = INTC_IRQ_SENSE(0x04),
272 static int intc_irqpin_irq_set_type(struct irq_data *d, unsigned int type)
274 unsigned char value = intc_irqpin_sense[type & IRQ_TYPE_SENSE_MASK];
275 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
277 if (!(value & INTC_IRQ_SENSE_VALID))
278 return -EINVAL;
280 return intc_irqpin_set_sense(p, irqd_to_hwirq(d),
281 value ^ INTC_IRQ_SENSE_VALID);
284 static int intc_irqpin_irq_set_wake(struct irq_data *d, unsigned int on)
286 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
287 int hw_irq = irqd_to_hwirq(d);
289 irq_set_irq_wake(p->irq[hw_irq].requested_irq, on);
291 if (!p->clk)
292 return 0;
294 if (on)
295 clk_enable(p->clk);
296 else
297 clk_disable(p->clk);
299 return 0;
302 static irqreturn_t intc_irqpin_irq_handler(int irq, void *dev_id)
304 struct intc_irqpin_irq *i = dev_id;
305 struct intc_irqpin_priv *p = i->p;
306 unsigned long bit;
308 intc_irqpin_dbg(i, "demux1");
309 bit = intc_irqpin_hwirq_mask(p, INTC_IRQPIN_REG_SOURCE, i->hw_irq);
311 if (intc_irqpin_read(p, INTC_IRQPIN_REG_SOURCE) & bit) {
312 intc_irqpin_write(p, INTC_IRQPIN_REG_SOURCE, ~bit);
313 intc_irqpin_dbg(i, "demux2");
314 generic_handle_irq(i->domain_irq);
315 return IRQ_HANDLED;
317 return IRQ_NONE;
320 static irqreturn_t intc_irqpin_shared_irq_handler(int irq, void *dev_id)
322 struct intc_irqpin_priv *p = dev_id;
323 unsigned int reg_source = intc_irqpin_read(p, INTC_IRQPIN_REG_SOURCE);
324 irqreturn_t status = IRQ_NONE;
325 int k;
327 for (k = 0; k < 8; k++) {
328 if (reg_source & BIT(7 - k)) {
329 if (BIT(k) & p->shared_irq_mask)
330 continue;
332 status |= intc_irqpin_irq_handler(irq, &p->irq[k]);
336 return status;
340 * This lock class tells lockdep that INTC External IRQ Pin irqs are in a
341 * different category than their parents, so it won't report false recursion.
343 static struct lock_class_key intc_irqpin_irq_lock_class;
345 /* And this is for the request mutex */
346 static struct lock_class_key intc_irqpin_irq_request_class;
348 static int intc_irqpin_irq_domain_map(struct irq_domain *h, unsigned int virq,
349 irq_hw_number_t hw)
351 struct intc_irqpin_priv *p = h->host_data;
353 p->irq[hw].domain_irq = virq;
354 p->irq[hw].hw_irq = hw;
356 intc_irqpin_dbg(&p->irq[hw], "map");
357 irq_set_chip_data(virq, h->host_data);
358 irq_set_lockdep_class(virq, &intc_irqpin_irq_lock_class,
359 &intc_irqpin_irq_request_class);
360 irq_set_chip_and_handler(virq, &p->irq_chip, handle_level_irq);
361 return 0;
364 static const struct irq_domain_ops intc_irqpin_irq_domain_ops = {
365 .map = intc_irqpin_irq_domain_map,
366 .xlate = irq_domain_xlate_twocell,
369 static const struct intc_irqpin_config intc_irqpin_irlm_r8a777x = {
370 .irlm_bit = 23, /* ICR0.IRLM0 */
371 .needs_irlm = 1,
372 .needs_clk = 0,
375 static const struct intc_irqpin_config intc_irqpin_rmobile = {
376 .needs_irlm = 0,
377 .needs_clk = 1,
380 static const struct of_device_id intc_irqpin_dt_ids[] = {
381 { .compatible = "renesas,intc-irqpin", },
382 { .compatible = "renesas,intc-irqpin-r8a7778",
383 .data = &intc_irqpin_irlm_r8a777x },
384 { .compatible = "renesas,intc-irqpin-r8a7779",
385 .data = &intc_irqpin_irlm_r8a777x },
386 { .compatible = "renesas,intc-irqpin-r8a7740",
387 .data = &intc_irqpin_rmobile },
388 { .compatible = "renesas,intc-irqpin-sh73a0",
389 .data = &intc_irqpin_rmobile },
392 MODULE_DEVICE_TABLE(of, intc_irqpin_dt_ids);
394 static int intc_irqpin_probe(struct platform_device *pdev)
396 const struct intc_irqpin_config *config;
397 struct device *dev = &pdev->dev;
398 struct intc_irqpin_priv *p;
399 struct intc_irqpin_iomem *i;
400 struct resource *io[INTC_IRQPIN_REG_NR];
401 struct resource *irq;
402 struct irq_chip *irq_chip;
403 void (*enable_fn)(struct irq_data *d);
404 void (*disable_fn)(struct irq_data *d);
405 const char *name = dev_name(dev);
406 bool control_parent;
407 unsigned int nirqs;
408 int ref_irq;
409 int ret;
410 int k;
412 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
413 if (!p) {
414 dev_err(dev, "failed to allocate driver data\n");
415 return -ENOMEM;
418 /* deal with driver instance configuration */
419 of_property_read_u32(dev->of_node, "sense-bitfield-width",
420 &p->sense_bitfield_width);
421 control_parent = of_property_read_bool(dev->of_node, "control-parent");
422 if (!p->sense_bitfield_width)
423 p->sense_bitfield_width = 4; /* default to 4 bits */
425 p->pdev = pdev;
426 platform_set_drvdata(pdev, p);
428 config = of_device_get_match_data(dev);
429 if (config)
430 p->needs_clk = config->needs_clk;
432 p->clk = devm_clk_get(dev, NULL);
433 if (IS_ERR(p->clk)) {
434 if (p->needs_clk) {
435 dev_err(dev, "unable to get clock\n");
436 ret = PTR_ERR(p->clk);
437 goto err0;
439 p->clk = NULL;
442 pm_runtime_enable(dev);
443 pm_runtime_get_sync(dev);
445 /* get hold of register banks */
446 memset(io, 0, sizeof(io));
447 for (k = 0; k < INTC_IRQPIN_REG_NR; k++) {
448 io[k] = platform_get_resource(pdev, IORESOURCE_MEM, k);
449 if (!io[k] && k < INTC_IRQPIN_REG_NR_MANDATORY) {
450 dev_err(dev, "not enough IOMEM resources\n");
451 ret = -EINVAL;
452 goto err0;
456 /* allow any number of IRQs between 1 and INTC_IRQPIN_MAX */
457 for (k = 0; k < INTC_IRQPIN_MAX; k++) {
458 irq = platform_get_resource(pdev, IORESOURCE_IRQ, k);
459 if (!irq)
460 break;
462 p->irq[k].p = p;
463 p->irq[k].requested_irq = irq->start;
466 nirqs = k;
467 if (nirqs < 1) {
468 dev_err(dev, "not enough IRQ resources\n");
469 ret = -EINVAL;
470 goto err0;
473 /* ioremap IOMEM and setup read/write callbacks */
474 for (k = 0; k < INTC_IRQPIN_REG_NR; k++) {
475 i = &p->iomem[k];
477 /* handle optional registers */
478 if (!io[k])
479 continue;
481 switch (resource_size(io[k])) {
482 case 1:
483 i->width = 8;
484 i->read = intc_irqpin_read8;
485 i->write = intc_irqpin_write8;
486 break;
487 case 4:
488 i->width = 32;
489 i->read = intc_irqpin_read32;
490 i->write = intc_irqpin_write32;
491 break;
492 default:
493 dev_err(dev, "IOMEM size mismatch\n");
494 ret = -EINVAL;
495 goto err0;
498 i->iomem = devm_ioremap_nocache(dev, io[k]->start,
499 resource_size(io[k]));
500 if (!i->iomem) {
501 dev_err(dev, "failed to remap IOMEM\n");
502 ret = -ENXIO;
503 goto err0;
507 /* configure "individual IRQ mode" where needed */
508 if (config && config->needs_irlm) {
509 if (io[INTC_IRQPIN_REG_IRLM])
510 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_IRLM,
511 config->irlm_bit, 1, 1);
512 else
513 dev_warn(dev, "unable to select IRLM mode\n");
516 /* mask all interrupts using priority */
517 for (k = 0; k < nirqs; k++)
518 intc_irqpin_mask_unmask_prio(p, k, 1);
520 /* clear all pending interrupts */
521 intc_irqpin_write(p, INTC_IRQPIN_REG_SOURCE, 0x0);
523 /* scan for shared interrupt lines */
524 ref_irq = p->irq[0].requested_irq;
525 p->shared_irqs = 1;
526 for (k = 1; k < nirqs; k++) {
527 if (ref_irq != p->irq[k].requested_irq) {
528 p->shared_irqs = 0;
529 break;
533 /* use more severe masking method if requested */
534 if (control_parent) {
535 enable_fn = intc_irqpin_irq_enable_force;
536 disable_fn = intc_irqpin_irq_disable_force;
537 } else if (!p->shared_irqs) {
538 enable_fn = intc_irqpin_irq_enable;
539 disable_fn = intc_irqpin_irq_disable;
540 } else {
541 enable_fn = intc_irqpin_shared_irq_enable;
542 disable_fn = intc_irqpin_shared_irq_disable;
545 irq_chip = &p->irq_chip;
546 irq_chip->name = name;
547 irq_chip->irq_mask = disable_fn;
548 irq_chip->irq_unmask = enable_fn;
549 irq_chip->irq_set_type = intc_irqpin_irq_set_type;
550 irq_chip->irq_set_wake = intc_irqpin_irq_set_wake;
551 irq_chip->flags = IRQCHIP_MASK_ON_SUSPEND;
553 p->irq_domain = irq_domain_add_simple(dev->of_node, nirqs, 0,
554 &intc_irqpin_irq_domain_ops, p);
555 if (!p->irq_domain) {
556 ret = -ENXIO;
557 dev_err(dev, "cannot initialize irq domain\n");
558 goto err0;
561 if (p->shared_irqs) {
562 /* request one shared interrupt */
563 if (devm_request_irq(dev, p->irq[0].requested_irq,
564 intc_irqpin_shared_irq_handler,
565 IRQF_SHARED, name, p)) {
566 dev_err(dev, "failed to request low IRQ\n");
567 ret = -ENOENT;
568 goto err1;
570 } else {
571 /* request interrupts one by one */
572 for (k = 0; k < nirqs; k++) {
573 if (devm_request_irq(dev, p->irq[k].requested_irq,
574 intc_irqpin_irq_handler, 0, name,
575 &p->irq[k])) {
576 dev_err(dev, "failed to request low IRQ\n");
577 ret = -ENOENT;
578 goto err1;
583 /* unmask all interrupts on prio level */
584 for (k = 0; k < nirqs; k++)
585 intc_irqpin_mask_unmask_prio(p, k, 0);
587 dev_info(dev, "driving %d irqs\n", nirqs);
589 return 0;
591 err1:
592 irq_domain_remove(p->irq_domain);
593 err0:
594 pm_runtime_put(dev);
595 pm_runtime_disable(dev);
596 return ret;
599 static int intc_irqpin_remove(struct platform_device *pdev)
601 struct intc_irqpin_priv *p = platform_get_drvdata(pdev);
603 irq_domain_remove(p->irq_domain);
604 pm_runtime_put(&pdev->dev);
605 pm_runtime_disable(&pdev->dev);
606 return 0;
609 static struct platform_driver intc_irqpin_device_driver = {
610 .probe = intc_irqpin_probe,
611 .remove = intc_irqpin_remove,
612 .driver = {
613 .name = "renesas_intc_irqpin",
614 .of_match_table = intc_irqpin_dt_ids,
618 static int __init intc_irqpin_init(void)
620 return platform_driver_register(&intc_irqpin_device_driver);
622 postcore_initcall(intc_irqpin_init);
624 static void __exit intc_irqpin_exit(void)
626 platform_driver_unregister(&intc_irqpin_device_driver);
628 module_exit(intc_irqpin_exit);
630 MODULE_AUTHOR("Magnus Damm");
631 MODULE_DESCRIPTION("Renesas INTC External IRQ Pin Driver");
632 MODULE_LICENSE("GPL v2");