arm64: futex: Avoid copying out uninitialised stack in failed cmpxchg()
[linux/fpc-iii.git] / drivers / irqchip / irq-renesas-intc-irqpin.c
blobc6e6c9e9137ad1d2ee61b8e71292173875c1f8f9
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/init.h>
21 #include <linux/of.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/of_device.h>
33 #include <linux/pm_runtime.h>
35 #define INTC_IRQPIN_MAX 8 /* maximum 8 interrupts per driver instance */
37 #define INTC_IRQPIN_REG_SENSE 0 /* ICRn */
38 #define INTC_IRQPIN_REG_PRIO 1 /* INTPRInn */
39 #define INTC_IRQPIN_REG_SOURCE 2 /* INTREQnn */
40 #define INTC_IRQPIN_REG_MASK 3 /* INTMSKnn */
41 #define INTC_IRQPIN_REG_CLEAR 4 /* INTMSKCLRnn */
42 #define INTC_IRQPIN_REG_NR_MANDATORY 5
43 #define INTC_IRQPIN_REG_IRLM 5 /* ICR0 with IRLM bit (optional) */
44 #define INTC_IRQPIN_REG_NR 6
46 /* INTC external IRQ PIN hardware register access:
48 * SENSE is read-write 32-bit with 2-bits or 4-bits per IRQ (*)
49 * PRIO is read-write 32-bit with 4-bits per IRQ (**)
50 * SOURCE is read-only 32-bit or 8-bit with 1-bit per IRQ (***)
51 * MASK is write-only 32-bit or 8-bit with 1-bit per IRQ (***)
52 * CLEAR is write-only 32-bit or 8-bit with 1-bit per IRQ (***)
54 * (*) May be accessed by more than one driver instance - lock needed
55 * (**) Read-modify-write access by one driver instance - lock needed
56 * (***) Accessed by one driver instance only - no locking needed
59 struct intc_irqpin_iomem {
60 void __iomem *iomem;
61 unsigned long (*read)(void __iomem *iomem);
62 void (*write)(void __iomem *iomem, unsigned long data);
63 int width;
66 struct intc_irqpin_irq {
67 int hw_irq;
68 int requested_irq;
69 int domain_irq;
70 struct intc_irqpin_priv *p;
73 struct intc_irqpin_priv {
74 struct intc_irqpin_iomem iomem[INTC_IRQPIN_REG_NR];
75 struct intc_irqpin_irq irq[INTC_IRQPIN_MAX];
76 unsigned int sense_bitfield_width;
77 struct platform_device *pdev;
78 struct irq_chip irq_chip;
79 struct irq_domain *irq_domain;
80 atomic_t wakeup_path;
81 unsigned shared_irqs:1;
82 u8 shared_irq_mask;
85 struct intc_irqpin_config {
86 unsigned int irlm_bit;
87 unsigned needs_irlm:1;
90 static unsigned long intc_irqpin_read32(void __iomem *iomem)
92 return ioread32(iomem);
95 static unsigned long intc_irqpin_read8(void __iomem *iomem)
97 return ioread8(iomem);
100 static void intc_irqpin_write32(void __iomem *iomem, unsigned long data)
102 iowrite32(data, iomem);
105 static void intc_irqpin_write8(void __iomem *iomem, unsigned long data)
107 iowrite8(data, iomem);
110 static inline unsigned long intc_irqpin_read(struct intc_irqpin_priv *p,
111 int reg)
113 struct intc_irqpin_iomem *i = &p->iomem[reg];
115 return i->read(i->iomem);
118 static inline void intc_irqpin_write(struct intc_irqpin_priv *p,
119 int reg, unsigned long data)
121 struct intc_irqpin_iomem *i = &p->iomem[reg];
123 i->write(i->iomem, data);
126 static inline unsigned long intc_irqpin_hwirq_mask(struct intc_irqpin_priv *p,
127 int reg, int hw_irq)
129 return BIT((p->iomem[reg].width - 1) - hw_irq);
132 static inline void intc_irqpin_irq_write_hwirq(struct intc_irqpin_priv *p,
133 int reg, int hw_irq)
135 intc_irqpin_write(p, reg, intc_irqpin_hwirq_mask(p, reg, hw_irq));
138 static DEFINE_RAW_SPINLOCK(intc_irqpin_lock); /* only used by slow path */
140 static void intc_irqpin_read_modify_write(struct intc_irqpin_priv *p,
141 int reg, int shift,
142 int width, int value)
144 unsigned long flags;
145 unsigned long tmp;
147 raw_spin_lock_irqsave(&intc_irqpin_lock, flags);
149 tmp = intc_irqpin_read(p, reg);
150 tmp &= ~(((1 << width) - 1) << shift);
151 tmp |= value << shift;
152 intc_irqpin_write(p, reg, tmp);
154 raw_spin_unlock_irqrestore(&intc_irqpin_lock, flags);
157 static void intc_irqpin_mask_unmask_prio(struct intc_irqpin_priv *p,
158 int irq, int do_mask)
160 /* The PRIO register is assumed to be 32-bit with fixed 4-bit fields. */
161 int bitfield_width = 4;
162 int shift = 32 - (irq + 1) * bitfield_width;
164 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_PRIO,
165 shift, bitfield_width,
166 do_mask ? 0 : (1 << bitfield_width) - 1);
169 static int intc_irqpin_set_sense(struct intc_irqpin_priv *p, int irq, int value)
171 /* The SENSE register is assumed to be 32-bit. */
172 int bitfield_width = p->sense_bitfield_width;
173 int shift = 32 - (irq + 1) * bitfield_width;
175 dev_dbg(&p->pdev->dev, "sense irq = %d, mode = %d\n", irq, value);
177 if (value >= (1 << bitfield_width))
178 return -EINVAL;
180 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_SENSE, shift,
181 bitfield_width, value);
182 return 0;
185 static void intc_irqpin_dbg(struct intc_irqpin_irq *i, char *str)
187 dev_dbg(&i->p->pdev->dev, "%s (%d:%d:%d)\n",
188 str, i->requested_irq, i->hw_irq, i->domain_irq);
191 static void intc_irqpin_irq_enable(struct irq_data *d)
193 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
194 int hw_irq = irqd_to_hwirq(d);
196 intc_irqpin_dbg(&p->irq[hw_irq], "enable");
197 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_CLEAR, hw_irq);
200 static void intc_irqpin_irq_disable(struct irq_data *d)
202 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
203 int hw_irq = irqd_to_hwirq(d);
205 intc_irqpin_dbg(&p->irq[hw_irq], "disable");
206 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_MASK, hw_irq);
209 static void intc_irqpin_shared_irq_enable(struct irq_data *d)
211 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
212 int hw_irq = irqd_to_hwirq(d);
214 intc_irqpin_dbg(&p->irq[hw_irq], "shared enable");
215 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_CLEAR, hw_irq);
217 p->shared_irq_mask &= ~BIT(hw_irq);
220 static void intc_irqpin_shared_irq_disable(struct irq_data *d)
222 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
223 int hw_irq = irqd_to_hwirq(d);
225 intc_irqpin_dbg(&p->irq[hw_irq], "shared disable");
226 intc_irqpin_irq_write_hwirq(p, INTC_IRQPIN_REG_MASK, hw_irq);
228 p->shared_irq_mask |= BIT(hw_irq);
231 static void intc_irqpin_irq_enable_force(struct irq_data *d)
233 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
234 int irq = p->irq[irqd_to_hwirq(d)].requested_irq;
236 intc_irqpin_irq_enable(d);
238 /* enable interrupt through parent interrupt controller,
239 * assumes non-shared interrupt with 1:1 mapping
240 * needed for busted IRQs on some SoCs like sh73a0
242 irq_get_chip(irq)->irq_unmask(irq_get_irq_data(irq));
245 static void intc_irqpin_irq_disable_force(struct irq_data *d)
247 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
248 int irq = p->irq[irqd_to_hwirq(d)].requested_irq;
250 /* disable interrupt through parent interrupt controller,
251 * assumes non-shared interrupt with 1:1 mapping
252 * needed for busted IRQs on some SoCs like sh73a0
254 irq_get_chip(irq)->irq_mask(irq_get_irq_data(irq));
255 intc_irqpin_irq_disable(d);
258 #define INTC_IRQ_SENSE_VALID 0x10
259 #define INTC_IRQ_SENSE(x) (x + INTC_IRQ_SENSE_VALID)
261 static unsigned char intc_irqpin_sense[IRQ_TYPE_SENSE_MASK + 1] = {
262 [IRQ_TYPE_EDGE_FALLING] = INTC_IRQ_SENSE(0x00),
263 [IRQ_TYPE_EDGE_RISING] = INTC_IRQ_SENSE(0x01),
264 [IRQ_TYPE_LEVEL_LOW] = INTC_IRQ_SENSE(0x02),
265 [IRQ_TYPE_LEVEL_HIGH] = INTC_IRQ_SENSE(0x03),
266 [IRQ_TYPE_EDGE_BOTH] = INTC_IRQ_SENSE(0x04),
269 static int intc_irqpin_irq_set_type(struct irq_data *d, unsigned int type)
271 unsigned char value = intc_irqpin_sense[type & IRQ_TYPE_SENSE_MASK];
272 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
274 if (!(value & INTC_IRQ_SENSE_VALID))
275 return -EINVAL;
277 return intc_irqpin_set_sense(p, irqd_to_hwirq(d),
278 value ^ INTC_IRQ_SENSE_VALID);
281 static int intc_irqpin_irq_set_wake(struct irq_data *d, unsigned int on)
283 struct intc_irqpin_priv *p = irq_data_get_irq_chip_data(d);
284 int hw_irq = irqd_to_hwirq(d);
286 irq_set_irq_wake(p->irq[hw_irq].requested_irq, on);
287 if (on)
288 atomic_inc(&p->wakeup_path);
289 else
290 atomic_dec(&p->wakeup_path);
292 return 0;
295 static irqreturn_t intc_irqpin_irq_handler(int irq, void *dev_id)
297 struct intc_irqpin_irq *i = dev_id;
298 struct intc_irqpin_priv *p = i->p;
299 unsigned long bit;
301 intc_irqpin_dbg(i, "demux1");
302 bit = intc_irqpin_hwirq_mask(p, INTC_IRQPIN_REG_SOURCE, i->hw_irq);
304 if (intc_irqpin_read(p, INTC_IRQPIN_REG_SOURCE) & bit) {
305 intc_irqpin_write(p, INTC_IRQPIN_REG_SOURCE, ~bit);
306 intc_irqpin_dbg(i, "demux2");
307 generic_handle_irq(i->domain_irq);
308 return IRQ_HANDLED;
310 return IRQ_NONE;
313 static irqreturn_t intc_irqpin_shared_irq_handler(int irq, void *dev_id)
315 struct intc_irqpin_priv *p = dev_id;
316 unsigned int reg_source = intc_irqpin_read(p, INTC_IRQPIN_REG_SOURCE);
317 irqreturn_t status = IRQ_NONE;
318 int k;
320 for (k = 0; k < 8; k++) {
321 if (reg_source & BIT(7 - k)) {
322 if (BIT(k) & p->shared_irq_mask)
323 continue;
325 status |= intc_irqpin_irq_handler(irq, &p->irq[k]);
329 return status;
333 * This lock class tells lockdep that INTC External IRQ Pin irqs are in a
334 * different category than their parents, so it won't report false recursion.
336 static struct lock_class_key intc_irqpin_irq_lock_class;
338 /* And this is for the request mutex */
339 static struct lock_class_key intc_irqpin_irq_request_class;
341 static int intc_irqpin_irq_domain_map(struct irq_domain *h, unsigned int virq,
342 irq_hw_number_t hw)
344 struct intc_irqpin_priv *p = h->host_data;
346 p->irq[hw].domain_irq = virq;
347 p->irq[hw].hw_irq = hw;
349 intc_irqpin_dbg(&p->irq[hw], "map");
350 irq_set_chip_data(virq, h->host_data);
351 irq_set_lockdep_class(virq, &intc_irqpin_irq_lock_class,
352 &intc_irqpin_irq_request_class);
353 irq_set_chip_and_handler(virq, &p->irq_chip, handle_level_irq);
354 return 0;
357 static const struct irq_domain_ops intc_irqpin_irq_domain_ops = {
358 .map = intc_irqpin_irq_domain_map,
359 .xlate = irq_domain_xlate_twocell,
362 static const struct intc_irqpin_config intc_irqpin_irlm_r8a777x = {
363 .irlm_bit = 23, /* ICR0.IRLM0 */
364 .needs_irlm = 1,
367 static const struct intc_irqpin_config intc_irqpin_rmobile = {
368 .needs_irlm = 0,
371 static const struct of_device_id intc_irqpin_dt_ids[] = {
372 { .compatible = "renesas,intc-irqpin", },
373 { .compatible = "renesas,intc-irqpin-r8a7778",
374 .data = &intc_irqpin_irlm_r8a777x },
375 { .compatible = "renesas,intc-irqpin-r8a7779",
376 .data = &intc_irqpin_irlm_r8a777x },
377 { .compatible = "renesas,intc-irqpin-r8a7740",
378 .data = &intc_irqpin_rmobile },
379 { .compatible = "renesas,intc-irqpin-sh73a0",
380 .data = &intc_irqpin_rmobile },
383 MODULE_DEVICE_TABLE(of, intc_irqpin_dt_ids);
385 static int intc_irqpin_probe(struct platform_device *pdev)
387 const struct intc_irqpin_config *config;
388 struct device *dev = &pdev->dev;
389 struct intc_irqpin_priv *p;
390 struct intc_irqpin_iomem *i;
391 struct resource *io[INTC_IRQPIN_REG_NR];
392 struct resource *irq;
393 struct irq_chip *irq_chip;
394 void (*enable_fn)(struct irq_data *d);
395 void (*disable_fn)(struct irq_data *d);
396 const char *name = dev_name(dev);
397 bool control_parent;
398 unsigned int nirqs;
399 int ref_irq;
400 int ret;
401 int k;
403 p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
404 if (!p) {
405 dev_err(dev, "failed to allocate driver data\n");
406 return -ENOMEM;
409 /* deal with driver instance configuration */
410 of_property_read_u32(dev->of_node, "sense-bitfield-width",
411 &p->sense_bitfield_width);
412 control_parent = of_property_read_bool(dev->of_node, "control-parent");
413 if (!p->sense_bitfield_width)
414 p->sense_bitfield_width = 4; /* default to 4 bits */
416 p->pdev = pdev;
417 platform_set_drvdata(pdev, p);
419 config = of_device_get_match_data(dev);
421 pm_runtime_enable(dev);
422 pm_runtime_get_sync(dev);
424 /* get hold of register banks */
425 memset(io, 0, sizeof(io));
426 for (k = 0; k < INTC_IRQPIN_REG_NR; k++) {
427 io[k] = platform_get_resource(pdev, IORESOURCE_MEM, k);
428 if (!io[k] && k < INTC_IRQPIN_REG_NR_MANDATORY) {
429 dev_err(dev, "not enough IOMEM resources\n");
430 ret = -EINVAL;
431 goto err0;
435 /* allow any number of IRQs between 1 and INTC_IRQPIN_MAX */
436 for (k = 0; k < INTC_IRQPIN_MAX; k++) {
437 irq = platform_get_resource(pdev, IORESOURCE_IRQ, k);
438 if (!irq)
439 break;
441 p->irq[k].p = p;
442 p->irq[k].requested_irq = irq->start;
445 nirqs = k;
446 if (nirqs < 1) {
447 dev_err(dev, "not enough IRQ resources\n");
448 ret = -EINVAL;
449 goto err0;
452 /* ioremap IOMEM and setup read/write callbacks */
453 for (k = 0; k < INTC_IRQPIN_REG_NR; k++) {
454 i = &p->iomem[k];
456 /* handle optional registers */
457 if (!io[k])
458 continue;
460 switch (resource_size(io[k])) {
461 case 1:
462 i->width = 8;
463 i->read = intc_irqpin_read8;
464 i->write = intc_irqpin_write8;
465 break;
466 case 4:
467 i->width = 32;
468 i->read = intc_irqpin_read32;
469 i->write = intc_irqpin_write32;
470 break;
471 default:
472 dev_err(dev, "IOMEM size mismatch\n");
473 ret = -EINVAL;
474 goto err0;
477 i->iomem = devm_ioremap_nocache(dev, io[k]->start,
478 resource_size(io[k]));
479 if (!i->iomem) {
480 dev_err(dev, "failed to remap IOMEM\n");
481 ret = -ENXIO;
482 goto err0;
486 /* configure "individual IRQ mode" where needed */
487 if (config && config->needs_irlm) {
488 if (io[INTC_IRQPIN_REG_IRLM])
489 intc_irqpin_read_modify_write(p, INTC_IRQPIN_REG_IRLM,
490 config->irlm_bit, 1, 1);
491 else
492 dev_warn(dev, "unable to select IRLM mode\n");
495 /* mask all interrupts using priority */
496 for (k = 0; k < nirqs; k++)
497 intc_irqpin_mask_unmask_prio(p, k, 1);
499 /* clear all pending interrupts */
500 intc_irqpin_write(p, INTC_IRQPIN_REG_SOURCE, 0x0);
502 /* scan for shared interrupt lines */
503 ref_irq = p->irq[0].requested_irq;
504 p->shared_irqs = 1;
505 for (k = 1; k < nirqs; k++) {
506 if (ref_irq != p->irq[k].requested_irq) {
507 p->shared_irqs = 0;
508 break;
512 /* use more severe masking method if requested */
513 if (control_parent) {
514 enable_fn = intc_irqpin_irq_enable_force;
515 disable_fn = intc_irqpin_irq_disable_force;
516 } else if (!p->shared_irqs) {
517 enable_fn = intc_irqpin_irq_enable;
518 disable_fn = intc_irqpin_irq_disable;
519 } else {
520 enable_fn = intc_irqpin_shared_irq_enable;
521 disable_fn = intc_irqpin_shared_irq_disable;
524 irq_chip = &p->irq_chip;
525 irq_chip->name = name;
526 irq_chip->irq_mask = disable_fn;
527 irq_chip->irq_unmask = enable_fn;
528 irq_chip->irq_set_type = intc_irqpin_irq_set_type;
529 irq_chip->irq_set_wake = intc_irqpin_irq_set_wake;
530 irq_chip->flags = IRQCHIP_MASK_ON_SUSPEND;
532 p->irq_domain = irq_domain_add_simple(dev->of_node, nirqs, 0,
533 &intc_irqpin_irq_domain_ops, p);
534 if (!p->irq_domain) {
535 ret = -ENXIO;
536 dev_err(dev, "cannot initialize irq domain\n");
537 goto err0;
540 if (p->shared_irqs) {
541 /* request one shared interrupt */
542 if (devm_request_irq(dev, p->irq[0].requested_irq,
543 intc_irqpin_shared_irq_handler,
544 IRQF_SHARED, name, p)) {
545 dev_err(dev, "failed to request low IRQ\n");
546 ret = -ENOENT;
547 goto err1;
549 } else {
550 /* request interrupts one by one */
551 for (k = 0; k < nirqs; k++) {
552 if (devm_request_irq(dev, p->irq[k].requested_irq,
553 intc_irqpin_irq_handler, 0, name,
554 &p->irq[k])) {
555 dev_err(dev, "failed to request low IRQ\n");
556 ret = -ENOENT;
557 goto err1;
562 /* unmask all interrupts on prio level */
563 for (k = 0; k < nirqs; k++)
564 intc_irqpin_mask_unmask_prio(p, k, 0);
566 dev_info(dev, "driving %d irqs\n", nirqs);
568 return 0;
570 err1:
571 irq_domain_remove(p->irq_domain);
572 err0:
573 pm_runtime_put(dev);
574 pm_runtime_disable(dev);
575 return ret;
578 static int intc_irqpin_remove(struct platform_device *pdev)
580 struct intc_irqpin_priv *p = platform_get_drvdata(pdev);
582 irq_domain_remove(p->irq_domain);
583 pm_runtime_put(&pdev->dev);
584 pm_runtime_disable(&pdev->dev);
585 return 0;
588 static int __maybe_unused intc_irqpin_suspend(struct device *dev)
590 struct intc_irqpin_priv *p = dev_get_drvdata(dev);
592 if (atomic_read(&p->wakeup_path))
593 device_set_wakeup_path(dev);
595 return 0;
598 static SIMPLE_DEV_PM_OPS(intc_irqpin_pm_ops, intc_irqpin_suspend, NULL);
600 static struct platform_driver intc_irqpin_device_driver = {
601 .probe = intc_irqpin_probe,
602 .remove = intc_irqpin_remove,
603 .driver = {
604 .name = "renesas_intc_irqpin",
605 .of_match_table = intc_irqpin_dt_ids,
606 .pm = &intc_irqpin_pm_ops,
610 static int __init intc_irqpin_init(void)
612 return platform_driver_register(&intc_irqpin_device_driver);
614 postcore_initcall(intc_irqpin_init);
616 static void __exit intc_irqpin_exit(void)
618 platform_driver_unregister(&intc_irqpin_device_driver);
620 module_exit(intc_irqpin_exit);
622 MODULE_AUTHOR("Magnus Damm");
623 MODULE_DESCRIPTION("Renesas INTC External IRQ Pin Driver");
624 MODULE_LICENSE("GPL v2");