xref: /OK3568_Linux_fs/kernel/drivers/irqchip/irq-renesas-irqc.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Renesas IRQC Driver
4*4882a593Smuzhiyun  *
5*4882a593Smuzhiyun  *  Copyright (C) 2013 Magnus Damm
6*4882a593Smuzhiyun  */
7*4882a593Smuzhiyun 
8*4882a593Smuzhiyun #include <linux/init.h>
9*4882a593Smuzhiyun #include <linux/platform_device.h>
10*4882a593Smuzhiyun #include <linux/interrupt.h>
11*4882a593Smuzhiyun #include <linux/ioport.h>
12*4882a593Smuzhiyun #include <linux/io.h>
13*4882a593Smuzhiyun #include <linux/irq.h>
14*4882a593Smuzhiyun #include <linux/irqdomain.h>
15*4882a593Smuzhiyun #include <linux/err.h>
16*4882a593Smuzhiyun #include <linux/slab.h>
17*4882a593Smuzhiyun #include <linux/module.h>
18*4882a593Smuzhiyun #include <linux/pm_runtime.h>
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define IRQC_IRQ_MAX	32	/* maximum 32 interrupts per driver instance */
21*4882a593Smuzhiyun 
22*4882a593Smuzhiyun #define IRQC_REQ_STS	0x00	/* Interrupt Request Status Register */
23*4882a593Smuzhiyun #define IRQC_EN_STS	0x04	/* Interrupt Enable Status Register */
24*4882a593Smuzhiyun #define IRQC_EN_SET	0x08	/* Interrupt Enable Set Register */
25*4882a593Smuzhiyun #define IRQC_INT_CPU_BASE(n) (0x000 + ((n) * 0x10))
26*4882a593Smuzhiyun 				/* SYS-CPU vs. RT-CPU */
27*4882a593Smuzhiyun #define DETECT_STATUS	0x100	/* IRQn Detect Status Register */
28*4882a593Smuzhiyun #define MONITOR		0x104	/* IRQn Signal Level Monitor Register */
29*4882a593Smuzhiyun #define HLVL_STS	0x108	/* IRQn High Level Detect Status Register */
30*4882a593Smuzhiyun #define LLVL_STS	0x10c	/* IRQn Low Level Detect Status Register */
31*4882a593Smuzhiyun #define S_R_EDGE_STS	0x110	/* IRQn Sync Rising Edge Detect Status Reg. */
32*4882a593Smuzhiyun #define S_F_EDGE_STS	0x114	/* IRQn Sync Falling Edge Detect Status Reg. */
33*4882a593Smuzhiyun #define A_R_EDGE_STS	0x118	/* IRQn Async Rising Edge Detect Status Reg. */
34*4882a593Smuzhiyun #define A_F_EDGE_STS	0x11c	/* IRQn Async Falling Edge Detect Status Reg. */
35*4882a593Smuzhiyun #define CHTEN_STS	0x120	/* Chattering Reduction Status Register */
36*4882a593Smuzhiyun #define IRQC_CONFIG(n) (0x180 + ((n) * 0x04))
37*4882a593Smuzhiyun 				/* IRQn Configuration Register */
38*4882a593Smuzhiyun 
39*4882a593Smuzhiyun struct irqc_irq {
40*4882a593Smuzhiyun 	int hw_irq;
41*4882a593Smuzhiyun 	int requested_irq;
42*4882a593Smuzhiyun 	struct irqc_priv *p;
43*4882a593Smuzhiyun };
44*4882a593Smuzhiyun 
45*4882a593Smuzhiyun struct irqc_priv {
46*4882a593Smuzhiyun 	void __iomem *iomem;
47*4882a593Smuzhiyun 	void __iomem *cpu_int_base;
48*4882a593Smuzhiyun 	struct irqc_irq irq[IRQC_IRQ_MAX];
49*4882a593Smuzhiyun 	unsigned int number_of_irqs;
50*4882a593Smuzhiyun 	struct device *dev;
51*4882a593Smuzhiyun 	struct irq_chip_generic *gc;
52*4882a593Smuzhiyun 	struct irq_domain *irq_domain;
53*4882a593Smuzhiyun 	atomic_t wakeup_path;
54*4882a593Smuzhiyun };
55*4882a593Smuzhiyun 
irq_data_to_priv(struct irq_data * data)56*4882a593Smuzhiyun static struct irqc_priv *irq_data_to_priv(struct irq_data *data)
57*4882a593Smuzhiyun {
58*4882a593Smuzhiyun 	return data->domain->host_data;
59*4882a593Smuzhiyun }
60*4882a593Smuzhiyun 
irqc_dbg(struct irqc_irq * i,char * str)61*4882a593Smuzhiyun static void irqc_dbg(struct irqc_irq *i, char *str)
62*4882a593Smuzhiyun {
63*4882a593Smuzhiyun 	dev_dbg(i->p->dev, "%s (%d:%d)\n", str, i->requested_irq, i->hw_irq);
64*4882a593Smuzhiyun }
65*4882a593Smuzhiyun 
66*4882a593Smuzhiyun static unsigned char irqc_sense[IRQ_TYPE_SENSE_MASK + 1] = {
67*4882a593Smuzhiyun 	[IRQ_TYPE_LEVEL_LOW]	= 0x01,
68*4882a593Smuzhiyun 	[IRQ_TYPE_LEVEL_HIGH]	= 0x02,
69*4882a593Smuzhiyun 	[IRQ_TYPE_EDGE_FALLING]	= 0x04,	/* Synchronous */
70*4882a593Smuzhiyun 	[IRQ_TYPE_EDGE_RISING]	= 0x08,	/* Synchronous */
71*4882a593Smuzhiyun 	[IRQ_TYPE_EDGE_BOTH]	= 0x0c,	/* Synchronous */
72*4882a593Smuzhiyun };
73*4882a593Smuzhiyun 
irqc_irq_set_type(struct irq_data * d,unsigned int type)74*4882a593Smuzhiyun static int irqc_irq_set_type(struct irq_data *d, unsigned int type)
75*4882a593Smuzhiyun {
76*4882a593Smuzhiyun 	struct irqc_priv *p = irq_data_to_priv(d);
77*4882a593Smuzhiyun 	int hw_irq = irqd_to_hwirq(d);
78*4882a593Smuzhiyun 	unsigned char value = irqc_sense[type & IRQ_TYPE_SENSE_MASK];
79*4882a593Smuzhiyun 	u32 tmp;
80*4882a593Smuzhiyun 
81*4882a593Smuzhiyun 	irqc_dbg(&p->irq[hw_irq], "sense");
82*4882a593Smuzhiyun 
83*4882a593Smuzhiyun 	if (!value)
84*4882a593Smuzhiyun 		return -EINVAL;
85*4882a593Smuzhiyun 
86*4882a593Smuzhiyun 	tmp = ioread32(p->iomem + IRQC_CONFIG(hw_irq));
87*4882a593Smuzhiyun 	tmp &= ~0x3f;
88*4882a593Smuzhiyun 	tmp |= value;
89*4882a593Smuzhiyun 	iowrite32(tmp, p->iomem + IRQC_CONFIG(hw_irq));
90*4882a593Smuzhiyun 	return 0;
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun 
irqc_irq_set_wake(struct irq_data * d,unsigned int on)93*4882a593Smuzhiyun static int irqc_irq_set_wake(struct irq_data *d, unsigned int on)
94*4882a593Smuzhiyun {
95*4882a593Smuzhiyun 	struct irqc_priv *p = irq_data_to_priv(d);
96*4882a593Smuzhiyun 	int hw_irq = irqd_to_hwirq(d);
97*4882a593Smuzhiyun 
98*4882a593Smuzhiyun 	irq_set_irq_wake(p->irq[hw_irq].requested_irq, on);
99*4882a593Smuzhiyun 	if (on)
100*4882a593Smuzhiyun 		atomic_inc(&p->wakeup_path);
101*4882a593Smuzhiyun 	else
102*4882a593Smuzhiyun 		atomic_dec(&p->wakeup_path);
103*4882a593Smuzhiyun 
104*4882a593Smuzhiyun 	return 0;
105*4882a593Smuzhiyun }
106*4882a593Smuzhiyun 
irqc_irq_handler(int irq,void * dev_id)107*4882a593Smuzhiyun static irqreturn_t irqc_irq_handler(int irq, void *dev_id)
108*4882a593Smuzhiyun {
109*4882a593Smuzhiyun 	struct irqc_irq *i = dev_id;
110*4882a593Smuzhiyun 	struct irqc_priv *p = i->p;
111*4882a593Smuzhiyun 	u32 bit = BIT(i->hw_irq);
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	irqc_dbg(i, "demux1");
114*4882a593Smuzhiyun 
115*4882a593Smuzhiyun 	if (ioread32(p->iomem + DETECT_STATUS) & bit) {
116*4882a593Smuzhiyun 		iowrite32(bit, p->iomem + DETECT_STATUS);
117*4882a593Smuzhiyun 		irqc_dbg(i, "demux2");
118*4882a593Smuzhiyun 		generic_handle_irq(irq_find_mapping(p->irq_domain, i->hw_irq));
119*4882a593Smuzhiyun 		return IRQ_HANDLED;
120*4882a593Smuzhiyun 	}
121*4882a593Smuzhiyun 	return IRQ_NONE;
122*4882a593Smuzhiyun }
123*4882a593Smuzhiyun 
irqc_probe(struct platform_device * pdev)124*4882a593Smuzhiyun static int irqc_probe(struct platform_device *pdev)
125*4882a593Smuzhiyun {
126*4882a593Smuzhiyun 	struct device *dev = &pdev->dev;
127*4882a593Smuzhiyun 	const char *name = dev_name(dev);
128*4882a593Smuzhiyun 	struct irqc_priv *p;
129*4882a593Smuzhiyun 	struct resource *irq;
130*4882a593Smuzhiyun 	int ret;
131*4882a593Smuzhiyun 	int k;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	p = devm_kzalloc(dev, sizeof(*p), GFP_KERNEL);
134*4882a593Smuzhiyun 	if (!p)
135*4882a593Smuzhiyun 		return -ENOMEM;
136*4882a593Smuzhiyun 
137*4882a593Smuzhiyun 	p->dev = dev;
138*4882a593Smuzhiyun 	platform_set_drvdata(pdev, p);
139*4882a593Smuzhiyun 
140*4882a593Smuzhiyun 	pm_runtime_enable(dev);
141*4882a593Smuzhiyun 	pm_runtime_get_sync(dev);
142*4882a593Smuzhiyun 
143*4882a593Smuzhiyun 	/* allow any number of IRQs between 1 and IRQC_IRQ_MAX */
144*4882a593Smuzhiyun 	for (k = 0; k < IRQC_IRQ_MAX; k++) {
145*4882a593Smuzhiyun 		irq = platform_get_resource(pdev, IORESOURCE_IRQ, k);
146*4882a593Smuzhiyun 		if (!irq)
147*4882a593Smuzhiyun 			break;
148*4882a593Smuzhiyun 
149*4882a593Smuzhiyun 		p->irq[k].p = p;
150*4882a593Smuzhiyun 		p->irq[k].hw_irq = k;
151*4882a593Smuzhiyun 		p->irq[k].requested_irq = irq->start;
152*4882a593Smuzhiyun 	}
153*4882a593Smuzhiyun 
154*4882a593Smuzhiyun 	p->number_of_irqs = k;
155*4882a593Smuzhiyun 	if (p->number_of_irqs < 1) {
156*4882a593Smuzhiyun 		dev_err(dev, "not enough IRQ resources\n");
157*4882a593Smuzhiyun 		ret = -EINVAL;
158*4882a593Smuzhiyun 		goto err_runtime_pm_disable;
159*4882a593Smuzhiyun 	}
160*4882a593Smuzhiyun 
161*4882a593Smuzhiyun 	/* ioremap IOMEM and setup read/write callbacks */
162*4882a593Smuzhiyun 	p->iomem = devm_platform_ioremap_resource(pdev, 0);
163*4882a593Smuzhiyun 	if (IS_ERR(p->iomem)) {
164*4882a593Smuzhiyun 		ret = PTR_ERR(p->iomem);
165*4882a593Smuzhiyun 		goto err_runtime_pm_disable;
166*4882a593Smuzhiyun 	}
167*4882a593Smuzhiyun 
168*4882a593Smuzhiyun 	p->cpu_int_base = p->iomem + IRQC_INT_CPU_BASE(0); /* SYS-SPI */
169*4882a593Smuzhiyun 
170*4882a593Smuzhiyun 	p->irq_domain = irq_domain_add_linear(dev->of_node, p->number_of_irqs,
171*4882a593Smuzhiyun 					      &irq_generic_chip_ops, p);
172*4882a593Smuzhiyun 	if (!p->irq_domain) {
173*4882a593Smuzhiyun 		ret = -ENXIO;
174*4882a593Smuzhiyun 		dev_err(dev, "cannot initialize irq domain\n");
175*4882a593Smuzhiyun 		goto err_runtime_pm_disable;
176*4882a593Smuzhiyun 	}
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	ret = irq_alloc_domain_generic_chips(p->irq_domain, p->number_of_irqs,
179*4882a593Smuzhiyun 					     1, "irqc", handle_level_irq,
180*4882a593Smuzhiyun 					     0, 0, IRQ_GC_INIT_NESTED_LOCK);
181*4882a593Smuzhiyun 	if (ret) {
182*4882a593Smuzhiyun 		dev_err(dev, "cannot allocate generic chip\n");
183*4882a593Smuzhiyun 		goto err_remove_domain;
184*4882a593Smuzhiyun 	}
185*4882a593Smuzhiyun 
186*4882a593Smuzhiyun 	p->gc = irq_get_domain_generic_chip(p->irq_domain, 0);
187*4882a593Smuzhiyun 	p->gc->reg_base = p->cpu_int_base;
188*4882a593Smuzhiyun 	p->gc->chip_types[0].regs.enable = IRQC_EN_SET;
189*4882a593Smuzhiyun 	p->gc->chip_types[0].regs.disable = IRQC_EN_STS;
190*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.parent_device = dev;
191*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.irq_mask = irq_gc_mask_disable_reg;
192*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.irq_unmask = irq_gc_unmask_enable_reg;
193*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.irq_set_type	= irqc_irq_set_type;
194*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.irq_set_wake	= irqc_irq_set_wake;
195*4882a593Smuzhiyun 	p->gc->chip_types[0].chip.flags	= IRQCHIP_MASK_ON_SUSPEND;
196*4882a593Smuzhiyun 
197*4882a593Smuzhiyun 	/* request interrupts one by one */
198*4882a593Smuzhiyun 	for (k = 0; k < p->number_of_irqs; k++) {
199*4882a593Smuzhiyun 		if (devm_request_irq(dev, p->irq[k].requested_irq,
200*4882a593Smuzhiyun 				     irqc_irq_handler, 0, name, &p->irq[k])) {
201*4882a593Smuzhiyun 			dev_err(dev, "failed to request IRQ\n");
202*4882a593Smuzhiyun 			ret = -ENOENT;
203*4882a593Smuzhiyun 			goto err_remove_domain;
204*4882a593Smuzhiyun 		}
205*4882a593Smuzhiyun 	}
206*4882a593Smuzhiyun 
207*4882a593Smuzhiyun 	dev_info(dev, "driving %d irqs\n", p->number_of_irqs);
208*4882a593Smuzhiyun 
209*4882a593Smuzhiyun 	return 0;
210*4882a593Smuzhiyun 
211*4882a593Smuzhiyun err_remove_domain:
212*4882a593Smuzhiyun 	irq_domain_remove(p->irq_domain);
213*4882a593Smuzhiyun err_runtime_pm_disable:
214*4882a593Smuzhiyun 	pm_runtime_put(dev);
215*4882a593Smuzhiyun 	pm_runtime_disable(dev);
216*4882a593Smuzhiyun 	return ret;
217*4882a593Smuzhiyun }
218*4882a593Smuzhiyun 
irqc_remove(struct platform_device * pdev)219*4882a593Smuzhiyun static int irqc_remove(struct platform_device *pdev)
220*4882a593Smuzhiyun {
221*4882a593Smuzhiyun 	struct irqc_priv *p = platform_get_drvdata(pdev);
222*4882a593Smuzhiyun 
223*4882a593Smuzhiyun 	irq_domain_remove(p->irq_domain);
224*4882a593Smuzhiyun 	pm_runtime_put(&pdev->dev);
225*4882a593Smuzhiyun 	pm_runtime_disable(&pdev->dev);
226*4882a593Smuzhiyun 	return 0;
227*4882a593Smuzhiyun }
228*4882a593Smuzhiyun 
irqc_suspend(struct device * dev)229*4882a593Smuzhiyun static int __maybe_unused irqc_suspend(struct device *dev)
230*4882a593Smuzhiyun {
231*4882a593Smuzhiyun 	struct irqc_priv *p = dev_get_drvdata(dev);
232*4882a593Smuzhiyun 
233*4882a593Smuzhiyun 	if (atomic_read(&p->wakeup_path))
234*4882a593Smuzhiyun 		device_set_wakeup_path(dev);
235*4882a593Smuzhiyun 
236*4882a593Smuzhiyun 	return 0;
237*4882a593Smuzhiyun }
238*4882a593Smuzhiyun 
239*4882a593Smuzhiyun static SIMPLE_DEV_PM_OPS(irqc_pm_ops, irqc_suspend, NULL);
240*4882a593Smuzhiyun 
241*4882a593Smuzhiyun static const struct of_device_id irqc_dt_ids[] = {
242*4882a593Smuzhiyun 	{ .compatible = "renesas,irqc", },
243*4882a593Smuzhiyun 	{},
244*4882a593Smuzhiyun };
245*4882a593Smuzhiyun MODULE_DEVICE_TABLE(of, irqc_dt_ids);
246*4882a593Smuzhiyun 
247*4882a593Smuzhiyun static struct platform_driver irqc_device_driver = {
248*4882a593Smuzhiyun 	.probe		= irqc_probe,
249*4882a593Smuzhiyun 	.remove		= irqc_remove,
250*4882a593Smuzhiyun 	.driver		= {
251*4882a593Smuzhiyun 		.name	= "renesas_irqc",
252*4882a593Smuzhiyun 		.of_match_table	= irqc_dt_ids,
253*4882a593Smuzhiyun 		.pm	= &irqc_pm_ops,
254*4882a593Smuzhiyun 	}
255*4882a593Smuzhiyun };
256*4882a593Smuzhiyun 
irqc_init(void)257*4882a593Smuzhiyun static int __init irqc_init(void)
258*4882a593Smuzhiyun {
259*4882a593Smuzhiyun 	return platform_driver_register(&irqc_device_driver);
260*4882a593Smuzhiyun }
261*4882a593Smuzhiyun postcore_initcall(irqc_init);
262*4882a593Smuzhiyun 
irqc_exit(void)263*4882a593Smuzhiyun static void __exit irqc_exit(void)
264*4882a593Smuzhiyun {
265*4882a593Smuzhiyun 	platform_driver_unregister(&irqc_device_driver);
266*4882a593Smuzhiyun }
267*4882a593Smuzhiyun module_exit(irqc_exit);
268*4882a593Smuzhiyun 
269*4882a593Smuzhiyun MODULE_AUTHOR("Magnus Damm");
270*4882a593Smuzhiyun MODULE_DESCRIPTION("Renesas IRQC Driver");
271*4882a593Smuzhiyun MODULE_LICENSE("GPL v2");
272