xref: /openbmc/linux/drivers/irqchip/irq-mst-intc.c (revision 8be98d2f2a0a262f8bf8a0bc1fdf522b3c7aab17)
1ad4c938cSMark-PK Tsai // SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
2ad4c938cSMark-PK Tsai /*
3ad4c938cSMark-PK Tsai  * Copyright (c) 2020 MediaTek Inc.
4ad4c938cSMark-PK Tsai  * Author Mark-PK Tsai <mark-pk.tsai@mediatek.com>
5ad4c938cSMark-PK Tsai  */
6ad4c938cSMark-PK Tsai #include <linux/interrupt.h>
7ad4c938cSMark-PK Tsai #include <linux/io.h>
8ad4c938cSMark-PK Tsai #include <linux/irq.h>
9ad4c938cSMark-PK Tsai #include <linux/irqchip.h>
10ad4c938cSMark-PK Tsai #include <linux/irqdomain.h>
11ad4c938cSMark-PK Tsai #include <linux/of.h>
12ad4c938cSMark-PK Tsai #include <linux/of_address.h>
13ad4c938cSMark-PK Tsai #include <linux/of_irq.h>
14ad4c938cSMark-PK Tsai #include <linux/slab.h>
15ad4c938cSMark-PK Tsai #include <linux/spinlock.h>
16*ea4aeaa5SMark-PK Tsai #include <linux/syscore_ops.h>
17*ea4aeaa5SMark-PK Tsai 
18*ea4aeaa5SMark-PK Tsai #define MST_INTC_MAX_IRQS	64
19ad4c938cSMark-PK Tsai 
20ad4c938cSMark-PK Tsai #define INTC_MASK		0x0
21*ea4aeaa5SMark-PK Tsai #define INTC_REV_POLARITY	0x10
22ad4c938cSMark-PK Tsai #define INTC_EOI		0x20
23ad4c938cSMark-PK Tsai 
24*ea4aeaa5SMark-PK Tsai #ifdef CONFIG_PM_SLEEP
25*ea4aeaa5SMark-PK Tsai static LIST_HEAD(mst_intc_list);
26*ea4aeaa5SMark-PK Tsai #endif
27*ea4aeaa5SMark-PK Tsai 
28ad4c938cSMark-PK Tsai struct mst_intc_chip_data {
29ad4c938cSMark-PK Tsai 	raw_spinlock_t	lock;
30ad4c938cSMark-PK Tsai 	unsigned int	irq_start, nr_irqs;
31ad4c938cSMark-PK Tsai 	void __iomem	*base;
32ad4c938cSMark-PK Tsai 	bool		no_eoi;
33*ea4aeaa5SMark-PK Tsai #ifdef CONFIG_PM_SLEEP
34*ea4aeaa5SMark-PK Tsai 	struct list_head entry;
35*ea4aeaa5SMark-PK Tsai 	u16 saved_polarity_conf[DIV_ROUND_UP(MST_INTC_MAX_IRQS, 16)];
36*ea4aeaa5SMark-PK Tsai #endif
37ad4c938cSMark-PK Tsai };
38ad4c938cSMark-PK Tsai 
mst_set_irq(struct irq_data * d,u32 offset)39ad4c938cSMark-PK Tsai static void mst_set_irq(struct irq_data *d, u32 offset)
40ad4c938cSMark-PK Tsai {
41ad4c938cSMark-PK Tsai 	irq_hw_number_t hwirq = irqd_to_hwirq(d);
42ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd = irq_data_get_irq_chip_data(d);
43ad4c938cSMark-PK Tsai 	u16 val, mask;
44ad4c938cSMark-PK Tsai 	unsigned long flags;
45ad4c938cSMark-PK Tsai 
46ad4c938cSMark-PK Tsai 	mask = 1 << (hwirq % 16);
47ad4c938cSMark-PK Tsai 	offset += (hwirq / 16) * 4;
48ad4c938cSMark-PK Tsai 
49ad4c938cSMark-PK Tsai 	raw_spin_lock_irqsave(&cd->lock, flags);
50ad4c938cSMark-PK Tsai 	val = readw_relaxed(cd->base + offset) | mask;
51ad4c938cSMark-PK Tsai 	writew_relaxed(val, cd->base + offset);
52ad4c938cSMark-PK Tsai 	raw_spin_unlock_irqrestore(&cd->lock, flags);
53ad4c938cSMark-PK Tsai }
54ad4c938cSMark-PK Tsai 
mst_clear_irq(struct irq_data * d,u32 offset)55ad4c938cSMark-PK Tsai static void mst_clear_irq(struct irq_data *d, u32 offset)
56ad4c938cSMark-PK Tsai {
57ad4c938cSMark-PK Tsai 	irq_hw_number_t hwirq = irqd_to_hwirq(d);
58ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd = irq_data_get_irq_chip_data(d);
59ad4c938cSMark-PK Tsai 	u16 val, mask;
60ad4c938cSMark-PK Tsai 	unsigned long flags;
61ad4c938cSMark-PK Tsai 
62ad4c938cSMark-PK Tsai 	mask = 1 << (hwirq % 16);
63ad4c938cSMark-PK Tsai 	offset += (hwirq / 16) * 4;
64ad4c938cSMark-PK Tsai 
65ad4c938cSMark-PK Tsai 	raw_spin_lock_irqsave(&cd->lock, flags);
66ad4c938cSMark-PK Tsai 	val = readw_relaxed(cd->base + offset) & ~mask;
67ad4c938cSMark-PK Tsai 	writew_relaxed(val, cd->base + offset);
68ad4c938cSMark-PK Tsai 	raw_spin_unlock_irqrestore(&cd->lock, flags);
69ad4c938cSMark-PK Tsai }
70ad4c938cSMark-PK Tsai 
mst_intc_mask_irq(struct irq_data * d)71ad4c938cSMark-PK Tsai static void mst_intc_mask_irq(struct irq_data *d)
72ad4c938cSMark-PK Tsai {
73ad4c938cSMark-PK Tsai 	mst_set_irq(d, INTC_MASK);
74ad4c938cSMark-PK Tsai 	irq_chip_mask_parent(d);
75ad4c938cSMark-PK Tsai }
76ad4c938cSMark-PK Tsai 
mst_intc_unmask_irq(struct irq_data * d)77ad4c938cSMark-PK Tsai static void mst_intc_unmask_irq(struct irq_data *d)
78ad4c938cSMark-PK Tsai {
79ad4c938cSMark-PK Tsai 	mst_clear_irq(d, INTC_MASK);
80ad4c938cSMark-PK Tsai 	irq_chip_unmask_parent(d);
81ad4c938cSMark-PK Tsai }
82ad4c938cSMark-PK Tsai 
mst_intc_eoi_irq(struct irq_data * d)83ad4c938cSMark-PK Tsai static void mst_intc_eoi_irq(struct irq_data *d)
84ad4c938cSMark-PK Tsai {
85ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd = irq_data_get_irq_chip_data(d);
86ad4c938cSMark-PK Tsai 
87ad4c938cSMark-PK Tsai 	if (!cd->no_eoi)
88ad4c938cSMark-PK Tsai 		mst_set_irq(d, INTC_EOI);
89ad4c938cSMark-PK Tsai 
90ad4c938cSMark-PK Tsai 	irq_chip_eoi_parent(d);
91ad4c938cSMark-PK Tsai }
92ad4c938cSMark-PK Tsai 
mst_irq_chip_set_type(struct irq_data * data,unsigned int type)93*ea4aeaa5SMark-PK Tsai static int mst_irq_chip_set_type(struct irq_data *data, unsigned int type)
94*ea4aeaa5SMark-PK Tsai {
95*ea4aeaa5SMark-PK Tsai 	switch (type) {
96*ea4aeaa5SMark-PK Tsai 	case IRQ_TYPE_LEVEL_LOW:
97*ea4aeaa5SMark-PK Tsai 	case IRQ_TYPE_EDGE_FALLING:
98*ea4aeaa5SMark-PK Tsai 		mst_set_irq(data, INTC_REV_POLARITY);
99*ea4aeaa5SMark-PK Tsai 		break;
100*ea4aeaa5SMark-PK Tsai 	case IRQ_TYPE_LEVEL_HIGH:
101*ea4aeaa5SMark-PK Tsai 	case IRQ_TYPE_EDGE_RISING:
102*ea4aeaa5SMark-PK Tsai 		mst_clear_irq(data, INTC_REV_POLARITY);
103*ea4aeaa5SMark-PK Tsai 		break;
104*ea4aeaa5SMark-PK Tsai 	default:
105*ea4aeaa5SMark-PK Tsai 		return -EINVAL;
106*ea4aeaa5SMark-PK Tsai 	}
107*ea4aeaa5SMark-PK Tsai 
108*ea4aeaa5SMark-PK Tsai 	return irq_chip_set_type_parent(data, IRQ_TYPE_LEVEL_HIGH);
109*ea4aeaa5SMark-PK Tsai }
110*ea4aeaa5SMark-PK Tsai 
111ad4c938cSMark-PK Tsai static struct irq_chip mst_intc_chip = {
112ad4c938cSMark-PK Tsai 	.name			= "mst-intc",
113ad4c938cSMark-PK Tsai 	.irq_mask		= mst_intc_mask_irq,
114ad4c938cSMark-PK Tsai 	.irq_unmask		= mst_intc_unmask_irq,
115ad4c938cSMark-PK Tsai 	.irq_eoi		= mst_intc_eoi_irq,
116ad4c938cSMark-PK Tsai 	.irq_get_irqchip_state	= irq_chip_get_parent_state,
117ad4c938cSMark-PK Tsai 	.irq_set_irqchip_state	= irq_chip_set_parent_state,
118ad4c938cSMark-PK Tsai 	.irq_set_affinity	= irq_chip_set_affinity_parent,
119ad4c938cSMark-PK Tsai 	.irq_set_vcpu_affinity	= irq_chip_set_vcpu_affinity_parent,
120*ea4aeaa5SMark-PK Tsai 	.irq_set_type		= mst_irq_chip_set_type,
121ad4c938cSMark-PK Tsai 	.irq_retrigger		= irq_chip_retrigger_hierarchy,
122ad4c938cSMark-PK Tsai 	.flags			= IRQCHIP_SET_TYPE_MASKED |
123ad4c938cSMark-PK Tsai 				  IRQCHIP_SKIP_SET_WAKE |
124ad4c938cSMark-PK Tsai 				  IRQCHIP_MASK_ON_SUSPEND,
125ad4c938cSMark-PK Tsai };
126ad4c938cSMark-PK Tsai 
127*ea4aeaa5SMark-PK Tsai #ifdef CONFIG_PM_SLEEP
mst_intc_polarity_save(struct mst_intc_chip_data * cd)128*ea4aeaa5SMark-PK Tsai static void mst_intc_polarity_save(struct mst_intc_chip_data *cd)
129*ea4aeaa5SMark-PK Tsai {
130*ea4aeaa5SMark-PK Tsai 	int i;
131*ea4aeaa5SMark-PK Tsai 	void __iomem *addr = cd->base + INTC_REV_POLARITY;
132*ea4aeaa5SMark-PK Tsai 
133*ea4aeaa5SMark-PK Tsai 	for (i = 0; i < DIV_ROUND_UP(cd->nr_irqs, 16); i++)
134*ea4aeaa5SMark-PK Tsai 		cd->saved_polarity_conf[i] = readw_relaxed(addr + i * 4);
135*ea4aeaa5SMark-PK Tsai }
136*ea4aeaa5SMark-PK Tsai 
mst_intc_polarity_restore(struct mst_intc_chip_data * cd)137*ea4aeaa5SMark-PK Tsai static void mst_intc_polarity_restore(struct mst_intc_chip_data *cd)
138*ea4aeaa5SMark-PK Tsai {
139*ea4aeaa5SMark-PK Tsai 	int i;
140*ea4aeaa5SMark-PK Tsai 	void __iomem *addr = cd->base + INTC_REV_POLARITY;
141*ea4aeaa5SMark-PK Tsai 
142*ea4aeaa5SMark-PK Tsai 	for (i = 0; i < DIV_ROUND_UP(cd->nr_irqs, 16); i++)
143*ea4aeaa5SMark-PK Tsai 		writew_relaxed(cd->saved_polarity_conf[i], addr + i * 4);
144*ea4aeaa5SMark-PK Tsai }
145*ea4aeaa5SMark-PK Tsai 
mst_irq_resume(void)146*ea4aeaa5SMark-PK Tsai static void mst_irq_resume(void)
147*ea4aeaa5SMark-PK Tsai {
148*ea4aeaa5SMark-PK Tsai 	struct mst_intc_chip_data *cd;
149*ea4aeaa5SMark-PK Tsai 
150*ea4aeaa5SMark-PK Tsai 	list_for_each_entry(cd, &mst_intc_list, entry)
151*ea4aeaa5SMark-PK Tsai 		mst_intc_polarity_restore(cd);
152*ea4aeaa5SMark-PK Tsai }
153*ea4aeaa5SMark-PK Tsai 
mst_irq_suspend(void)154*ea4aeaa5SMark-PK Tsai static int mst_irq_suspend(void)
155*ea4aeaa5SMark-PK Tsai {
156*ea4aeaa5SMark-PK Tsai 	struct mst_intc_chip_data *cd;
157*ea4aeaa5SMark-PK Tsai 
158*ea4aeaa5SMark-PK Tsai 	list_for_each_entry(cd, &mst_intc_list, entry)
159*ea4aeaa5SMark-PK Tsai 		mst_intc_polarity_save(cd);
160*ea4aeaa5SMark-PK Tsai 	return 0;
161*ea4aeaa5SMark-PK Tsai }
162*ea4aeaa5SMark-PK Tsai 
163*ea4aeaa5SMark-PK Tsai static struct syscore_ops mst_irq_syscore_ops = {
164*ea4aeaa5SMark-PK Tsai 	.suspend	= mst_irq_suspend,
165*ea4aeaa5SMark-PK Tsai 	.resume		= mst_irq_resume,
166*ea4aeaa5SMark-PK Tsai };
167*ea4aeaa5SMark-PK Tsai 
mst_irq_pm_init(void)168*ea4aeaa5SMark-PK Tsai static int __init mst_irq_pm_init(void)
169*ea4aeaa5SMark-PK Tsai {
170*ea4aeaa5SMark-PK Tsai 	register_syscore_ops(&mst_irq_syscore_ops);
171*ea4aeaa5SMark-PK Tsai 	return 0;
172*ea4aeaa5SMark-PK Tsai }
173*ea4aeaa5SMark-PK Tsai late_initcall(mst_irq_pm_init);
174*ea4aeaa5SMark-PK Tsai #endif
175*ea4aeaa5SMark-PK Tsai 
mst_intc_domain_translate(struct irq_domain * d,struct irq_fwspec * fwspec,unsigned long * hwirq,unsigned int * type)176ad4c938cSMark-PK Tsai static int mst_intc_domain_translate(struct irq_domain *d,
177ad4c938cSMark-PK Tsai 				     struct irq_fwspec *fwspec,
178ad4c938cSMark-PK Tsai 				     unsigned long *hwirq,
179ad4c938cSMark-PK Tsai 				     unsigned int *type)
180ad4c938cSMark-PK Tsai {
181ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd = d->host_data;
182ad4c938cSMark-PK Tsai 
183ad4c938cSMark-PK Tsai 	if (is_of_node(fwspec->fwnode)) {
184ad4c938cSMark-PK Tsai 		if (fwspec->param_count != 3)
185ad4c938cSMark-PK Tsai 			return -EINVAL;
186ad4c938cSMark-PK Tsai 
187ad4c938cSMark-PK Tsai 		/* No PPI should point to this domain */
188ad4c938cSMark-PK Tsai 		if (fwspec->param[0] != 0)
189ad4c938cSMark-PK Tsai 			return -EINVAL;
190ad4c938cSMark-PK Tsai 
191ad4c938cSMark-PK Tsai 		if (fwspec->param[1] >= cd->nr_irqs)
192ad4c938cSMark-PK Tsai 			return -EINVAL;
193ad4c938cSMark-PK Tsai 
194ad4c938cSMark-PK Tsai 		*hwirq = fwspec->param[1];
195ad4c938cSMark-PK Tsai 		*type = fwspec->param[2] & IRQ_TYPE_SENSE_MASK;
196ad4c938cSMark-PK Tsai 		return 0;
197ad4c938cSMark-PK Tsai 	}
198ad4c938cSMark-PK Tsai 
199ad4c938cSMark-PK Tsai 	return -EINVAL;
200ad4c938cSMark-PK Tsai }
201ad4c938cSMark-PK Tsai 
mst_intc_domain_alloc(struct irq_domain * domain,unsigned int virq,unsigned int nr_irqs,void * data)202ad4c938cSMark-PK Tsai static int mst_intc_domain_alloc(struct irq_domain *domain, unsigned int virq,
203ad4c938cSMark-PK Tsai 				 unsigned int nr_irqs, void *data)
204ad4c938cSMark-PK Tsai {
205ad4c938cSMark-PK Tsai 	int i;
206ad4c938cSMark-PK Tsai 	irq_hw_number_t hwirq;
207ad4c938cSMark-PK Tsai 	struct irq_fwspec parent_fwspec, *fwspec = data;
208ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd = domain->host_data;
209ad4c938cSMark-PK Tsai 
210ad4c938cSMark-PK Tsai 	/* Not GIC compliant */
211ad4c938cSMark-PK Tsai 	if (fwspec->param_count != 3)
212ad4c938cSMark-PK Tsai 		return -EINVAL;
213ad4c938cSMark-PK Tsai 
214ad4c938cSMark-PK Tsai 	/* No PPI should point to this domain */
215ad4c938cSMark-PK Tsai 	if (fwspec->param[0])
216ad4c938cSMark-PK Tsai 		return -EINVAL;
217ad4c938cSMark-PK Tsai 
218ad4c938cSMark-PK Tsai 	hwirq = fwspec->param[1];
219ad4c938cSMark-PK Tsai 	for (i = 0; i < nr_irqs; i++)
220ad4c938cSMark-PK Tsai 		irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
221ad4c938cSMark-PK Tsai 					      &mst_intc_chip,
222ad4c938cSMark-PK Tsai 					      domain->host_data);
223ad4c938cSMark-PK Tsai 
224ad4c938cSMark-PK Tsai 	parent_fwspec = *fwspec;
225ad4c938cSMark-PK Tsai 	parent_fwspec.fwnode = domain->parent->fwnode;
226ad4c938cSMark-PK Tsai 	parent_fwspec.param[1] = cd->irq_start + hwirq;
227*ea4aeaa5SMark-PK Tsai 
228*ea4aeaa5SMark-PK Tsai 	/*
229*ea4aeaa5SMark-PK Tsai 	 * mst-intc latch the interrupt request if it's edge triggered,
230*ea4aeaa5SMark-PK Tsai 	 * so the output signal to parent GIC is always level sensitive.
231*ea4aeaa5SMark-PK Tsai 	 * And if the irq signal is active low, configure it to active high
232*ea4aeaa5SMark-PK Tsai 	 * to meet GIC SPI spec in mst_irq_chip_set_type via REV_POLARITY bit.
233*ea4aeaa5SMark-PK Tsai 	 */
234*ea4aeaa5SMark-PK Tsai 	parent_fwspec.param[2] = IRQ_TYPE_LEVEL_HIGH;
235*ea4aeaa5SMark-PK Tsai 
236ad4c938cSMark-PK Tsai 	return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs, &parent_fwspec);
237ad4c938cSMark-PK Tsai }
238ad4c938cSMark-PK Tsai 
239ad4c938cSMark-PK Tsai static const struct irq_domain_ops mst_intc_domain_ops = {
240ad4c938cSMark-PK Tsai 	.translate	= mst_intc_domain_translate,
241ad4c938cSMark-PK Tsai 	.alloc		= mst_intc_domain_alloc,
242ad4c938cSMark-PK Tsai 	.free		= irq_domain_free_irqs_common,
243ad4c938cSMark-PK Tsai };
244ad4c938cSMark-PK Tsai 
mst_intc_of_init(struct device_node * dn,struct device_node * parent)245893a7cfbSMarc Zyngier static int __init mst_intc_of_init(struct device_node *dn,
246893a7cfbSMarc Zyngier 				   struct device_node *parent)
247ad4c938cSMark-PK Tsai {
248ad4c938cSMark-PK Tsai 	struct irq_domain *domain, *domain_parent;
249ad4c938cSMark-PK Tsai 	struct mst_intc_chip_data *cd;
250ad4c938cSMark-PK Tsai 	u32 irq_start, irq_end;
251ad4c938cSMark-PK Tsai 
252ad4c938cSMark-PK Tsai 	domain_parent = irq_find_host(parent);
253ad4c938cSMark-PK Tsai 	if (!domain_parent) {
254ad4c938cSMark-PK Tsai 		pr_err("mst-intc: interrupt-parent not found\n");
255ad4c938cSMark-PK Tsai 		return -EINVAL;
256ad4c938cSMark-PK Tsai 	}
257ad4c938cSMark-PK Tsai 
258ad4c938cSMark-PK Tsai 	if (of_property_read_u32_index(dn, "mstar,irqs-map-range", 0, &irq_start) ||
259ad4c938cSMark-PK Tsai 	    of_property_read_u32_index(dn, "mstar,irqs-map-range", 1, &irq_end))
260ad4c938cSMark-PK Tsai 		return -EINVAL;
261ad4c938cSMark-PK Tsai 
262ad4c938cSMark-PK Tsai 	cd = kzalloc(sizeof(*cd), GFP_KERNEL);
263ad4c938cSMark-PK Tsai 	if (!cd)
264ad4c938cSMark-PK Tsai 		return -ENOMEM;
265ad4c938cSMark-PK Tsai 
266ad4c938cSMark-PK Tsai 	cd->base = of_iomap(dn, 0);
267ad4c938cSMark-PK Tsai 	if (!cd->base) {
268ad4c938cSMark-PK Tsai 		kfree(cd);
269ad4c938cSMark-PK Tsai 		return -ENOMEM;
270ad4c938cSMark-PK Tsai 	}
271ad4c938cSMark-PK Tsai 
272ad4c938cSMark-PK Tsai 	cd->no_eoi = of_property_read_bool(dn, "mstar,intc-no-eoi");
273ad4c938cSMark-PK Tsai 	raw_spin_lock_init(&cd->lock);
274ad4c938cSMark-PK Tsai 	cd->irq_start = irq_start;
275ad4c938cSMark-PK Tsai 	cd->nr_irqs = irq_end - irq_start + 1;
276ad4c938cSMark-PK Tsai 	domain = irq_domain_add_hierarchy(domain_parent, 0, cd->nr_irqs, dn,
277ad4c938cSMark-PK Tsai 					  &mst_intc_domain_ops, cd);
278ad4c938cSMark-PK Tsai 	if (!domain) {
279ad4c938cSMark-PK Tsai 		iounmap(cd->base);
280ad4c938cSMark-PK Tsai 		kfree(cd);
281ad4c938cSMark-PK Tsai 		return -ENOMEM;
282ad4c938cSMark-PK Tsai 	}
283ad4c938cSMark-PK Tsai 
284*ea4aeaa5SMark-PK Tsai #ifdef CONFIG_PM_SLEEP
285*ea4aeaa5SMark-PK Tsai 	INIT_LIST_HEAD(&cd->entry);
286*ea4aeaa5SMark-PK Tsai 	list_add_tail(&cd->entry, &mst_intc_list);
287*ea4aeaa5SMark-PK Tsai #endif
288ad4c938cSMark-PK Tsai 	return 0;
289ad4c938cSMark-PK Tsai }
290ad4c938cSMark-PK Tsai 
291ad4c938cSMark-PK Tsai IRQCHIP_DECLARE(mst_intc, "mstar,mst-intc", mst_intc_of_init);
292