1 /*
2  * Driver code for Tegra's Legacy Interrupt Controller
3  *
4  * Author: Marc Zyngier <marc.zyngier@arm.com>
5  *
6  * Heavily based on the original arch/arm/mach-tegra/irq.c code:
7  * Copyright (C) 2011 Google, Inc.
8  *
9  * Author:
10  *	Colin Cross <ccross@android.com>
11  *
12  * Copyright (C) 2010,2013, NVIDIA Corporation
13  *
14  * This software is licensed under the terms of the GNU General Public
15  * License version 2, as published by the Free Software Foundation, and
16  * may be copied, distributed, and modified under those terms.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
21  * GNU General Public License for more details.
22  *
23  */
24 
25 #include <linux/io.h>
26 #include <linux/irq.h>
27 #include <linux/irqdomain.h>
28 #include <linux/of_address.h>
29 #include <linux/slab.h>
30 #include <linux/syscore_ops.h>
31 
32 #include <dt-bindings/interrupt-controller/arm-gic.h>
33 
34 #include "irqchip.h"
35 
36 #define ICTLR_CPU_IEP_VFIQ	0x08
37 #define ICTLR_CPU_IEP_FIR	0x14
38 #define ICTLR_CPU_IEP_FIR_SET	0x18
39 #define ICTLR_CPU_IEP_FIR_CLR	0x1c
40 
41 #define ICTLR_CPU_IER		0x20
42 #define ICTLR_CPU_IER_SET	0x24
43 #define ICTLR_CPU_IER_CLR	0x28
44 #define ICTLR_CPU_IEP_CLASS	0x2C
45 
46 #define ICTLR_COP_IER		0x30
47 #define ICTLR_COP_IER_SET	0x34
48 #define ICTLR_COP_IER_CLR	0x38
49 #define ICTLR_COP_IEP_CLASS	0x3c
50 
51 #define TEGRA_MAX_NUM_ICTLRS	6
52 
53 static unsigned int num_ictlrs;
54 
55 struct tegra_ictlr_soc {
56 	unsigned int num_ictlrs;
57 };
58 
59 static const struct tegra_ictlr_soc tegra20_ictlr_soc = {
60 	.num_ictlrs = 4,
61 };
62 
63 static const struct tegra_ictlr_soc tegra30_ictlr_soc = {
64 	.num_ictlrs = 5,
65 };
66 
67 static const struct tegra_ictlr_soc tegra210_ictlr_soc = {
68 	.num_ictlrs = 6,
69 };
70 
71 static const struct of_device_id ictlr_matches[] = {
72 	{ .compatible = "nvidia,tegra210-ictlr", .data = &tegra210_ictlr_soc },
73 	{ .compatible = "nvidia,tegra30-ictlr", .data = &tegra30_ictlr_soc },
74 	{ .compatible = "nvidia,tegra20-ictlr", .data = &tegra20_ictlr_soc },
75 	{ }
76 };
77 
78 struct tegra_ictlr_info {
79 	void __iomem *base[TEGRA_MAX_NUM_ICTLRS];
80 #ifdef CONFIG_PM_SLEEP
81 	u32 cop_ier[TEGRA_MAX_NUM_ICTLRS];
82 	u32 cop_iep[TEGRA_MAX_NUM_ICTLRS];
83 	u32 cpu_ier[TEGRA_MAX_NUM_ICTLRS];
84 	u32 cpu_iep[TEGRA_MAX_NUM_ICTLRS];
85 
86 	u32 ictlr_wake_mask[TEGRA_MAX_NUM_ICTLRS];
87 #endif
88 };
89 
90 static struct tegra_ictlr_info *lic;
91 
tegra_ictlr_write_mask(struct irq_data * d,unsigned long reg)92 static inline void tegra_ictlr_write_mask(struct irq_data *d, unsigned long reg)
93 {
94 	void __iomem *base = d->chip_data;
95 	u32 mask;
96 
97 	mask = BIT(d->hwirq % 32);
98 	writel_relaxed(mask, base + reg);
99 }
100 
tegra_mask(struct irq_data * d)101 static void tegra_mask(struct irq_data *d)
102 {
103 	tegra_ictlr_write_mask(d, ICTLR_CPU_IER_CLR);
104 	irq_chip_mask_parent(d);
105 }
106 
tegra_unmask(struct irq_data * d)107 static void tegra_unmask(struct irq_data *d)
108 {
109 	tegra_ictlr_write_mask(d, ICTLR_CPU_IER_SET);
110 	irq_chip_unmask_parent(d);
111 }
112 
tegra_eoi(struct irq_data * d)113 static void tegra_eoi(struct irq_data *d)
114 {
115 	tegra_ictlr_write_mask(d, ICTLR_CPU_IEP_FIR_CLR);
116 	irq_chip_eoi_parent(d);
117 }
118 
tegra_retrigger(struct irq_data * d)119 static int tegra_retrigger(struct irq_data *d)
120 {
121 	tegra_ictlr_write_mask(d, ICTLR_CPU_IEP_FIR_SET);
122 	return irq_chip_retrigger_hierarchy(d);
123 }
124 
125 #ifdef CONFIG_PM_SLEEP
tegra_set_wake(struct irq_data * d,unsigned int enable)126 static int tegra_set_wake(struct irq_data *d, unsigned int enable)
127 {
128 	u32 irq = d->hwirq;
129 	u32 index, mask;
130 
131 	index = (irq / 32);
132 	mask = BIT(irq % 32);
133 	if (enable)
134 		lic->ictlr_wake_mask[index] |= mask;
135 	else
136 		lic->ictlr_wake_mask[index] &= ~mask;
137 
138 	/*
139 	 * Do *not* call into the parent, as the GIC doesn't have any
140 	 * wake-up facility...
141 	 */
142 	return 0;
143 }
144 
tegra_ictlr_suspend(void)145 static int tegra_ictlr_suspend(void)
146 {
147 	unsigned long flags;
148 	unsigned int i;
149 
150 	local_irq_save(flags);
151 	for (i = 0; i < num_ictlrs; i++) {
152 		void __iomem *ictlr = lic->base[i];
153 
154 		/* Save interrupt state */
155 		lic->cpu_ier[i] = readl_relaxed(ictlr + ICTLR_CPU_IER);
156 		lic->cpu_iep[i] = readl_relaxed(ictlr + ICTLR_CPU_IEP_CLASS);
157 		lic->cop_ier[i] = readl_relaxed(ictlr + ICTLR_COP_IER);
158 		lic->cop_iep[i] = readl_relaxed(ictlr + ICTLR_COP_IEP_CLASS);
159 
160 		/* Disable COP interrupts */
161 		writel_relaxed(~0ul, ictlr + ICTLR_COP_IER_CLR);
162 
163 		/* Disable CPU interrupts */
164 		writel_relaxed(~0ul, ictlr + ICTLR_CPU_IER_CLR);
165 
166 		/* Enable the wakeup sources of ictlr */
167 		writel_relaxed(lic->ictlr_wake_mask[i], ictlr + ICTLR_CPU_IER_SET);
168 	}
169 	local_irq_restore(flags);
170 
171 	return 0;
172 }
173 
tegra_ictlr_resume(void)174 static void tegra_ictlr_resume(void)
175 {
176 	unsigned long flags;
177 	unsigned int i;
178 
179 	local_irq_save(flags);
180 	for (i = 0; i < num_ictlrs; i++) {
181 		void __iomem *ictlr = lic->base[i];
182 
183 		writel_relaxed(lic->cpu_iep[i],
184 			       ictlr + ICTLR_CPU_IEP_CLASS);
185 		writel_relaxed(~0ul, ictlr + ICTLR_CPU_IER_CLR);
186 		writel_relaxed(lic->cpu_ier[i],
187 			       ictlr + ICTLR_CPU_IER_SET);
188 		writel_relaxed(lic->cop_iep[i],
189 			       ictlr + ICTLR_COP_IEP_CLASS);
190 		writel_relaxed(~0ul, ictlr + ICTLR_COP_IER_CLR);
191 		writel_relaxed(lic->cop_ier[i],
192 			       ictlr + ICTLR_COP_IER_SET);
193 	}
194 	local_irq_restore(flags);
195 }
196 
197 static struct syscore_ops tegra_ictlr_syscore_ops = {
198 	.suspend	= tegra_ictlr_suspend,
199 	.resume		= tegra_ictlr_resume,
200 };
201 
tegra_ictlr_syscore_init(void)202 static void tegra_ictlr_syscore_init(void)
203 {
204 	register_syscore_ops(&tegra_ictlr_syscore_ops);
205 }
206 #else
207 #define tegra_set_wake	NULL
tegra_ictlr_syscore_init(void)208 static inline void tegra_ictlr_syscore_init(void) {}
209 #endif
210 
211 static struct irq_chip tegra_ictlr_chip = {
212 	.name			= "LIC",
213 	.irq_eoi		= tegra_eoi,
214 	.irq_mask		= tegra_mask,
215 	.irq_unmask		= tegra_unmask,
216 	.irq_retrigger		= tegra_retrigger,
217 	.irq_set_wake		= tegra_set_wake,
218 	.irq_set_type		= irq_chip_set_type_parent,
219 	.flags			= IRQCHIP_MASK_ON_SUSPEND,
220 #ifdef CONFIG_SMP
221 	.irq_set_affinity	= irq_chip_set_affinity_parent,
222 #endif
223 };
224 
tegra_ictlr_domain_xlate(struct irq_domain * domain,struct device_node * controller,const u32 * intspec,unsigned int intsize,unsigned long * out_hwirq,unsigned int * out_type)225 static int tegra_ictlr_domain_xlate(struct irq_domain *domain,
226 				    struct device_node *controller,
227 				    const u32 *intspec,
228 				    unsigned int intsize,
229 				    unsigned long *out_hwirq,
230 				    unsigned int *out_type)
231 {
232 	if (domain->of_node != controller)
233 		return -EINVAL;	/* Shouldn't happen, really... */
234 	if (intsize != 3)
235 		return -EINVAL;	/* Not GIC compliant */
236 	if (intspec[0] != GIC_SPI)
237 		return -EINVAL;	/* No PPI should point to this domain */
238 
239 	*out_hwirq = intspec[1];
240 	*out_type = intspec[2];
241 	return 0;
242 }
243 
tegra_ictlr_domain_alloc(struct irq_domain * domain,unsigned int virq,unsigned int nr_irqs,void * data)244 static int tegra_ictlr_domain_alloc(struct irq_domain *domain,
245 				    unsigned int virq,
246 				    unsigned int nr_irqs, void *data)
247 {
248 	struct of_phandle_args *args = data;
249 	struct of_phandle_args parent_args;
250 	struct tegra_ictlr_info *info = domain->host_data;
251 	irq_hw_number_t hwirq;
252 	unsigned int i;
253 
254 	if (args->args_count != 3)
255 		return -EINVAL;	/* Not GIC compliant */
256 	if (args->args[0] != GIC_SPI)
257 		return -EINVAL;	/* No PPI should point to this domain */
258 
259 	hwirq = args->args[1];
260 	if (hwirq >= (num_ictlrs * 32))
261 		return -EINVAL;
262 
263 	for (i = 0; i < nr_irqs; i++) {
264 		int ictlr = (hwirq + i) / 32;
265 
266 		irq_domain_set_hwirq_and_chip(domain, virq + i, hwirq + i,
267 					      &tegra_ictlr_chip,
268 					      info->base[ictlr]);
269 	}
270 
271 	parent_args = *args;
272 	parent_args.np = domain->parent->of_node;
273 	return irq_domain_alloc_irqs_parent(domain, virq, nr_irqs, &parent_args);
274 }
275 
tegra_ictlr_domain_free(struct irq_domain * domain,unsigned int virq,unsigned int nr_irqs)276 static void tegra_ictlr_domain_free(struct irq_domain *domain,
277 				    unsigned int virq,
278 				    unsigned int nr_irqs)
279 {
280 	unsigned int i;
281 
282 	for (i = 0; i < nr_irqs; i++) {
283 		struct irq_data *d = irq_domain_get_irq_data(domain, virq + i);
284 		irq_domain_reset_irq_data(d);
285 	}
286 }
287 
288 static const struct irq_domain_ops tegra_ictlr_domain_ops = {
289 	.xlate	= tegra_ictlr_domain_xlate,
290 	.alloc	= tegra_ictlr_domain_alloc,
291 	.free	= tegra_ictlr_domain_free,
292 };
293 
tegra_ictlr_init(struct device_node * node,struct device_node * parent)294 static int __init tegra_ictlr_init(struct device_node *node,
295 				   struct device_node *parent)
296 {
297 	struct irq_domain *parent_domain, *domain;
298 	const struct of_device_id *match;
299 	const struct tegra_ictlr_soc *soc;
300 	unsigned int i;
301 	int err;
302 
303 	if (!parent) {
304 		pr_err("%s: no parent, giving up\n", node->full_name);
305 		return -ENODEV;
306 	}
307 
308 	parent_domain = irq_find_host(parent);
309 	if (!parent_domain) {
310 		pr_err("%s: unable to obtain parent domain\n", node->full_name);
311 		return -ENXIO;
312 	}
313 
314 	match = of_match_node(ictlr_matches, node);
315 	if (!match)		/* Should never happen... */
316 		return -ENODEV;
317 
318 	soc = match->data;
319 
320 	lic = kzalloc(sizeof(*lic), GFP_KERNEL);
321 	if (!lic)
322 		return -ENOMEM;
323 
324 	for (i = 0; i < TEGRA_MAX_NUM_ICTLRS; i++) {
325 		void __iomem *base;
326 
327 		base = of_iomap(node, i);
328 		if (!base)
329 			break;
330 
331 		lic->base[i] = base;
332 
333 		/* Disable all interrupts */
334 		writel_relaxed(~0UL, base + ICTLR_CPU_IER_CLR);
335 		/* All interrupts target IRQ */
336 		writel_relaxed(0, base + ICTLR_CPU_IEP_CLASS);
337 
338 		num_ictlrs++;
339 	}
340 
341 	if (!num_ictlrs) {
342 		pr_err("%s: no valid regions, giving up\n", node->full_name);
343 		err = -ENOMEM;
344 		goto out_free;
345 	}
346 
347 	WARN(num_ictlrs != soc->num_ictlrs,
348 	     "%s: Found %u interrupt controllers in DT; expected %u.\n",
349 	     node->full_name, num_ictlrs, soc->num_ictlrs);
350 
351 
352 	domain = irq_domain_add_hierarchy(parent_domain, 0, num_ictlrs * 32,
353 					  node, &tegra_ictlr_domain_ops,
354 					  lic);
355 	if (!domain) {
356 		pr_err("%s: failed to allocated domain\n", node->full_name);
357 		err = -ENOMEM;
358 		goto out_unmap;
359 	}
360 
361 	tegra_ictlr_syscore_init();
362 
363 	pr_info("%s: %d interrupts forwarded to %s\n",
364 		node->full_name, num_ictlrs * 32, parent->full_name);
365 
366 	return 0;
367 
368 out_unmap:
369 	for (i = 0; i < num_ictlrs; i++)
370 		iounmap(lic->base[i]);
371 out_free:
372 	kfree(lic);
373 	return err;
374 }
375 
376 IRQCHIP_DECLARE(tegra20_ictlr, "nvidia,tegra20-ictlr", tegra_ictlr_init);
377 IRQCHIP_DECLARE(tegra30_ictlr, "nvidia,tegra30-ictlr", tegra_ictlr_init);
378 IRQCHIP_DECLARE(tegra210_ictlr, "nvidia,tegra210-ictlr", tegra_ictlr_init);
379