Commit | Line | Data |
---|---|---|
af6074fc | 1 | // SPDX-License-Identifier: GPL-2.0+ |
e3873444 GL |
2 | /* |
3 | * Derived from arch/i386/kernel/irq.c | |
4 | * Copyright (C) 1992 Linus Torvalds | |
5 | * Adapted from arch/i386 by Gary Thomas | |
6 | * Copyright (C) 1995-1996 Gary Thomas (gdt@linuxppc.org) | |
7 | * Updated and modified by Cort Dougan <cort@fsmlabs.com> | |
8 | * Copyright (C) 1996-2001 Cort Dougan | |
9 | * Adapted for Power Macintosh by Paul Mackerras | |
10 | * Copyright (C) 1996 Paul Mackerras (paulus@cs.anu.edu.au) | |
11 | * | |
e3873444 GL |
12 | * This file contains the code used to make IRQ descriptions in the |
13 | * device tree to actual irq numbers on an interrupt controller | |
14 | * driver. | |
15 | */ | |
16 | ||
606ad42a RH |
17 | #define pr_fmt(fmt) "OF: " fmt |
18 | ||
c706c239 | 19 | #include <linux/device.h> |
e3873444 | 20 | #include <linux/errno.h> |
c71a54b0 | 21 | #include <linux/list.h> |
e3873444 GL |
22 | #include <linux/module.h> |
23 | #include <linux/of.h> | |
24 | #include <linux/of_irq.h> | |
25 | #include <linux/string.h> | |
c71a54b0 | 26 | #include <linux/slab.h> |
e3873444 GL |
27 | |
28 | /** | |
29 | * irq_of_parse_and_map - Parse and map an interrupt into linux virq space | |
d84ff46a | 30 | * @dev: Device node of the device whose interrupt is to be mapped |
e3873444 GL |
31 | * @index: Index of the interrupt to map |
32 | * | |
0c02c800 | 33 | * This function is a wrapper that chains of_irq_parse_one() and |
e3873444 GL |
34 | * irq_create_of_mapping() to make things easier to callers |
35 | */ | |
36 | unsigned int irq_of_parse_and_map(struct device_node *dev, int index) | |
37 | { | |
530210c7 | 38 | struct of_phandle_args oirq; |
e3873444 | 39 | |
0c02c800 | 40 | if (of_irq_parse_one(dev, index, &oirq)) |
77a7300a | 41 | return 0; |
e3873444 | 42 | |
e6d30ab1 | 43 | return irq_create_of_mapping(&oirq); |
e3873444 GL |
44 | } |
45 | EXPORT_SYMBOL_GPL(irq_of_parse_and_map); | |
7dc2e113 GL |
46 | |
47 | /** | |
48 | * of_irq_find_parent - Given a device node, find its interrupt parent node | |
49 | * @child: pointer to device node | |
50 | * | |
8c8239c2 | 51 | * Return: A pointer to the interrupt parent node, or NULL if the interrupt |
7dc2e113 GL |
52 | * parent could not be determined. |
53 | */ | |
4c3141e0 | 54 | struct device_node *of_irq_find_parent(struct device_node *child) |
7dc2e113 | 55 | { |
b4bbb029 | 56 | struct device_node *p; |
fa976ff7 | 57 | phandle parent; |
7dc2e113 | 58 | |
b4bbb029 | 59 | if (!of_node_get(child)) |
7dc2e113 GL |
60 | return NULL; |
61 | ||
62 | do { | |
fa976ff7 | 63 | if (of_property_read_u32(child, "interrupt-parent", &parent)) { |
b4bbb029 | 64 | p = of_get_parent(child); |
fa976ff7 | 65 | } else { |
7dc2e113 GL |
66 | if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) |
67 | p = of_node_get(of_irq_dflt_pic); | |
68 | else | |
fa976ff7 | 69 | p = of_find_node_by_phandle(parent); |
7dc2e113 | 70 | } |
b4bbb029 LT |
71 | of_node_put(child); |
72 | child = p; | |
7dc2e113 GL |
73 | } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL); |
74 | ||
b4bbb029 | 75 | return p; |
7dc2e113 | 76 | } |
4c3141e0 | 77 | EXPORT_SYMBOL_GPL(of_irq_find_parent); |
7dc2e113 | 78 | |
de4adddc MZ |
79 | /* |
80 | * These interrupt controllers abuse interrupt-map for unspeakable | |
81 | * reasons and rely on the core code to *ignore* it (the drivers do | |
82 | * their own parsing of the property). | |
83 | * | |
84 | * If you think of adding to the list for something *new*, think | |
85 | * again. There is a high chance that you will be sent back to the | |
86 | * drawing board. | |
87 | */ | |
88 | static const char * const of_irq_imap_abusers[] = { | |
89 | "CBEA,platform-spider-pic", | |
90 | "sti,platform-spider-pic", | |
91 | "realtek,rtl-intc", | |
92 | "fsl,ls1021a-extirq", | |
93 | "fsl,ls1043a-extirq", | |
94 | "fsl,ls1088a-extirq", | |
95 | "renesas,rza1-irqc", | |
96 | NULL, | |
97 | }; | |
98 | ||
7dc2e113 | 99 | /** |
0c02c800 | 100 | * of_irq_parse_raw - Low level interrupt tree parsing |
23616132 | 101 | * @addr: address specifier (start of "reg" property of the device) in be32 format |
fae3b9cd | 102 | * @out_irq: structure of_phandle_args updated by this function |
7dc2e113 | 103 | * |
7dc2e113 GL |
104 | * This function is a low-level interrupt tree walking function. It |
105 | * can be used to do a partial walk with synthetized reg and interrupts | |
106 | * properties, for example when resolving PCI interrupts when no device | |
23616132 GL |
107 | * node exist for the parent. It takes an interrupt specifier structure as |
108 | * input, walks the tree looking for any interrupt-map properties, translates | |
109 | * the specifier for each map, and then returns the translated map. | |
8c8239c2 RH |
110 | * |
111 | * Return: 0 on success and a negative number on error | |
7dc2e113 | 112 | */ |
23616132 | 113 | int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq) |
7dc2e113 GL |
114 | { |
115 | struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL; | |
355e62f5 | 116 | __be32 initial_match_array[MAX_PHANDLE_ARGS]; |
23616132 | 117 | const __be32 *match_array = initial_match_array; |
17a70355 | 118 | const __be32 *tmp, *imap, *imask, dummy_imask[] = { [0 ... MAX_PHANDLE_ARGS] = cpu_to_be32(~0) }; |
7dc2e113 | 119 | u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0; |
f1aa5484 | 120 | int imaplen, match, i, rc = -EINVAL; |
7dc2e113 | 121 | |
624cfca5 GL |
122 | #ifdef DEBUG |
123 | of_print_phandle_args("of_irq_parse_raw: ", out_irq); | |
124 | #endif | |
7dc2e113 | 125 | |
23616132 | 126 | ipar = of_node_get(out_irq->np); |
7dc2e113 GL |
127 | |
128 | /* First get the #interrupt-cells property of the current cursor | |
129 | * that tells us how to interpret the passed-in intspec. If there | |
130 | * is none, we are nice and just walk up the tree | |
131 | */ | |
132 | do { | |
fa976ff7 | 133 | if (!of_property_read_u32(ipar, "#interrupt-cells", &intsize)) |
7dc2e113 | 134 | break; |
7dc2e113 GL |
135 | tnode = ipar; |
136 | ipar = of_irq_find_parent(ipar); | |
137 | of_node_put(tnode); | |
138 | } while (ipar); | |
139 | if (ipar == NULL) { | |
140 | pr_debug(" -> no parent found !\n"); | |
141 | goto fail; | |
142 | } | |
143 | ||
0d638a07 | 144 | pr_debug("of_irq_parse_raw: ipar=%pOF, size=%d\n", ipar, intsize); |
7dc2e113 | 145 | |
23616132 | 146 | if (out_irq->args_count != intsize) |
f1aa5484 | 147 | goto fail; |
7dc2e113 GL |
148 | |
149 | /* Look for this #address-cells. We have to implement the old linux | |
150 | * trick of looking for the parent here as some device-trees rely on it | |
151 | */ | |
152 | old = of_node_get(ipar); | |
153 | do { | |
154 | tmp = of_get_property(old, "#address-cells", NULL); | |
155 | tnode = of_get_parent(old); | |
156 | of_node_put(old); | |
157 | old = tnode; | |
158 | } while (old && tmp == NULL); | |
159 | of_node_put(old); | |
160 | old = NULL; | |
a7c194b0 | 161 | addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp); |
7dc2e113 GL |
162 | |
163 | pr_debug(" -> addrsize=%d\n", addrsize); | |
164 | ||
355e62f5 | 165 | /* Range check so that the temporary buffer doesn't overflow */ |
f1aa5484 GP |
166 | if (WARN_ON(addrsize + intsize > MAX_PHANDLE_ARGS)) { |
167 | rc = -EFAULT; | |
355e62f5 | 168 | goto fail; |
f1aa5484 | 169 | } |
355e62f5 | 170 | |
23616132 GL |
171 | /* Precalculate the match array - this simplifies match loop */ |
172 | for (i = 0; i < addrsize; i++) | |
78119fd1 | 173 | initial_match_array[i] = addr ? addr[i] : 0; |
23616132 GL |
174 | for (i = 0; i < intsize; i++) |
175 | initial_match_array[addrsize + i] = cpu_to_be32(out_irq->args[i]); | |
176 | ||
7dc2e113 GL |
177 | /* Now start the actual "proper" walk of the interrupt tree */ |
178 | while (ipar != NULL) { | |
04128418 MZ |
179 | /* |
180 | * Now check if cursor is an interrupt-controller and | |
181 | * if it is then we are done, unless there is an | |
de4adddc MZ |
182 | * interrupt-map which takes precedence except on one |
183 | * of these broken platforms that want to parse | |
184 | * interrupt-map themselves for $reason. | |
7dc2e113 | 185 | */ |
10a20b34 MZ |
186 | bool intc = of_property_read_bool(ipar, "interrupt-controller"); |
187 | ||
04128418 | 188 | imap = of_get_property(ipar, "interrupt-map", &imaplen); |
de4adddc MZ |
189 | if (intc && |
190 | (!imap || of_device_compatible_match(ipar, of_irq_imap_abusers))) { | |
7dc2e113 | 191 | pr_debug(" -> got it !\n"); |
7dc2e113 GL |
192 | return 0; |
193 | } | |
194 | ||
78119fd1 GL |
195 | /* |
196 | * interrupt-map parsing does not work without a reg | |
197 | * property when #address-cells != 0 | |
198 | */ | |
199 | if (addrsize && !addr) { | |
200 | pr_debug(" -> no reg passed in when needed !\n"); | |
201 | goto fail; | |
202 | } | |
203 | ||
7dc2e113 GL |
204 | /* No interrupt map, check for an interrupt parent */ |
205 | if (imap == NULL) { | |
206 | pr_debug(" -> no map, getting parent\n"); | |
207 | newpar = of_irq_find_parent(ipar); | |
208 | goto skiplevel; | |
209 | } | |
210 | imaplen /= sizeof(u32); | |
211 | ||
212 | /* Look for a mask */ | |
213 | imask = of_get_property(ipar, "interrupt-map-mask", NULL); | |
23616132 GL |
214 | if (!imask) |
215 | imask = dummy_imask; | |
7dc2e113 GL |
216 | |
217 | /* Parse interrupt-map */ | |
218 | match = 0; | |
219 | while (imaplen > (addrsize + intsize + 1) && !match) { | |
220 | /* Compare specifiers */ | |
221 | match = 1; | |
23616132 | 222 | for (i = 0; i < (addrsize + intsize); i++, imaplen--) |
74dac2ed | 223 | match &= !((match_array[i] ^ *imap++) & imask[i]); |
7dc2e113 GL |
224 | |
225 | pr_debug(" -> match=%d (imaplen=%d)\n", match, imaplen); | |
226 | ||
227 | /* Get the interrupt parent */ | |
228 | if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) | |
229 | newpar = of_node_get(of_irq_dflt_pic); | |
230 | else | |
9a6b2e58 | 231 | newpar = of_find_node_by_phandle(be32_to_cpup(imap)); |
7dc2e113 GL |
232 | imap++; |
233 | --imaplen; | |
234 | ||
235 | /* Check if not found */ | |
236 | if (newpar == NULL) { | |
237 | pr_debug(" -> imap parent not found !\n"); | |
238 | goto fail; | |
239 | } | |
240 | ||
1ca56e7d PC |
241 | if (!of_device_is_available(newpar)) |
242 | match = 0; | |
243 | ||
7dc2e113 GL |
244 | /* Get #interrupt-cells and #address-cells of new |
245 | * parent | |
246 | */ | |
fa976ff7 SS |
247 | if (of_property_read_u32(newpar, "#interrupt-cells", |
248 | &newintsize)) { | |
7dc2e113 GL |
249 | pr_debug(" -> parent lacks #interrupt-cells!\n"); |
250 | goto fail; | |
251 | } | |
fa976ff7 SS |
252 | if (of_property_read_u32(newpar, "#address-cells", |
253 | &newaddrsize)) | |
254 | newaddrsize = 0; | |
7dc2e113 GL |
255 | |
256 | pr_debug(" -> newintsize=%d, newaddrsize=%d\n", | |
257 | newintsize, newaddrsize); | |
258 | ||
259 | /* Check for malformed properties */ | |
f1aa5484 GP |
260 | if (WARN_ON(newaddrsize + newintsize > MAX_PHANDLE_ARGS) |
261 | || (imaplen < (newaddrsize + newintsize))) { | |
262 | rc = -EFAULT; | |
7dc2e113 | 263 | goto fail; |
f1aa5484 | 264 | } |
7dc2e113 GL |
265 | |
266 | imap += newaddrsize + newintsize; | |
267 | imaplen -= newaddrsize + newintsize; | |
268 | ||
269 | pr_debug(" -> imaplen=%d\n", imaplen); | |
270 | } | |
10a20b34 MZ |
271 | if (!match) { |
272 | if (intc) { | |
273 | /* | |
274 | * The PASEMI Nemo is a known offender, so | |
275 | * let's only warn for anyone else. | |
276 | */ | |
277 | WARN(!IS_ENABLED(CONFIG_PPC_PASEMI), | |
278 | "%pOF interrupt-map failed, using interrupt-controller\n", | |
279 | ipar); | |
280 | return 0; | |
281 | } | |
282 | ||
7dc2e113 | 283 | goto fail; |
10a20b34 | 284 | } |
7dc2e113 | 285 | |
23616132 | 286 | /* |
d036d915 | 287 | * Successfully parsed an interrupt-map translation; copy new |
23616132 GL |
288 | * interrupt specifier into the out_irq structure |
289 | */ | |
23616132 GL |
290 | match_array = imap - newaddrsize - newintsize; |
291 | for (i = 0; i < newintsize; i++) | |
292 | out_irq->args[i] = be32_to_cpup(imap - newintsize + i); | |
293 | out_irq->args_count = intsize = newintsize; | |
7dc2e113 | 294 | addrsize = newaddrsize; |
7dc2e113 | 295 | |
04128418 MZ |
296 | if (ipar == newpar) { |
297 | pr_debug("%pOF interrupt-map entry to self\n", ipar); | |
298 | return 0; | |
299 | } | |
300 | ||
7dc2e113 GL |
301 | skiplevel: |
302 | /* Iterate again with new parent */ | |
d23b2516 | 303 | out_irq->np = newpar; |
0d638a07 | 304 | pr_debug(" -> new parent: %pOF\n", newpar); |
7dc2e113 GL |
305 | of_node_put(ipar); |
306 | ipar = newpar; | |
307 | newpar = NULL; | |
308 | } | |
f1aa5484 GP |
309 | rc = -ENOENT; /* No interrupt-map found */ |
310 | ||
7dc2e113 GL |
311 | fail: |
312 | of_node_put(ipar); | |
7dc2e113 GL |
313 | of_node_put(newpar); |
314 | ||
f1aa5484 | 315 | return rc; |
7dc2e113 | 316 | } |
0c02c800 | 317 | EXPORT_SYMBOL_GPL(of_irq_parse_raw); |
7dc2e113 GL |
318 | |
319 | /** | |
0c02c800 | 320 | * of_irq_parse_one - Resolve an interrupt for a device |
7dc2e113 GL |
321 | * @device: the device whose interrupt is to be resolved |
322 | * @index: index of the interrupt to resolve | |
83f82d7a | 323 | * @out_irq: structure of_phandle_args filled by this function |
7dc2e113 | 324 | * |
23616132 GL |
325 | * This function resolves an interrupt for a node by walking the interrupt tree, |
326 | * finding which interrupt controller node it is attached to, and returning the | |
327 | * interrupt specifier that can be used to retrieve a Linux IRQ number. | |
7dc2e113 | 328 | */ |
530210c7 | 329 | int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq) |
7dc2e113 GL |
330 | { |
331 | struct device_node *p; | |
b47fe22d RH |
332 | const __be32 *addr; |
333 | u32 intsize; | |
d7c14605 | 334 | int i, res; |
7dc2e113 | 335 | |
0d638a07 | 336 | pr_debug("of_irq_parse_one: dev=%pOF, index=%d\n", device, index); |
7dc2e113 GL |
337 | |
338 | /* OldWorld mac stuff is "special", handle out of line */ | |
339 | if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC) | |
0c02c800 | 340 | return of_irq_parse_oldworld(device, index, out_irq); |
7dc2e113 | 341 | |
79d97015 GL |
342 | /* Get the reg property (if any) */ |
343 | addr = of_get_property(device, "reg", NULL); | |
344 | ||
a9ecdc0f FF |
345 | /* Try the new-style interrupts-extended first */ |
346 | res = of_parse_phandle_with_args(device, "interrupts-extended", | |
347 | "#interrupt-cells", index, out_irq); | |
348 | if (!res) | |
349 | return of_irq_parse_raw(addr, out_irq); | |
350 | ||
7dc2e113 GL |
351 | /* Look for the interrupt parent. */ |
352 | p = of_irq_find_parent(device); | |
353 | if (p == NULL) | |
354 | return -EINVAL; | |
355 | ||
356 | /* Get size of interrupt specifier */ | |
fa976ff7 | 357 | if (of_property_read_u32(p, "#interrupt-cells", &intsize)) { |
d7c14605 | 358 | res = -EINVAL; |
7dc2e113 | 359 | goto out; |
d7c14605 | 360 | } |
7dc2e113 | 361 | |
b47fe22d | 362 | pr_debug(" parent=%pOF, intsize=%d\n", p, intsize); |
7dc2e113 | 363 | |
23616132 | 364 | /* Copy intspec into irq structure */ |
23616132 GL |
365 | out_irq->np = p; |
366 | out_irq->args_count = intsize; | |
b47fe22d RH |
367 | for (i = 0; i < intsize; i++) { |
368 | res = of_property_read_u32_index(device, "interrupts", | |
369 | (index * intsize) + i, | |
370 | out_irq->args + i); | |
371 | if (res) | |
372 | goto out; | |
373 | } | |
374 | ||
375 | pr_debug(" intspec=%d\n", *out_irq->args); | |
376 | ||
23616132 GL |
377 | |
378 | /* Check if there are any interrupt-map translations to process */ | |
379 | res = of_irq_parse_raw(addr, out_irq); | |
7dc2e113 GL |
380 | out: |
381 | of_node_put(p); | |
382 | return res; | |
383 | } | |
0c02c800 | 384 | EXPORT_SYMBOL_GPL(of_irq_parse_one); |
7dc2e113 GL |
385 | |
386 | /** | |
387 | * of_irq_to_resource - Decode a node's IRQ and return it as a resource | |
388 | * @dev: pointer to device tree node | |
389 | * @index: zero-based index of the irq | |
390 | * @r: pointer to resource structure to return result into. | |
391 | */ | |
392 | int of_irq_to_resource(struct device_node *dev, int index, struct resource *r) | |
393 | { | |
7a4228bb TP |
394 | int irq = of_irq_get(dev, index); |
395 | ||
396 | if (irq < 0) | |
397 | return irq; | |
7dc2e113 GL |
398 | |
399 | /* Only dereference the resource if both the | |
400 | * resource and the irq are valid. */ | |
77a7300a | 401 | if (r && irq) { |
661db794 BC |
402 | const char *name = NULL; |
403 | ||
cf9e2368 | 404 | memset(r, 0, sizeof(*r)); |
661db794 | 405 | /* |
ae107d06 | 406 | * Get optional "interrupt-names" property to add a name |
661db794 BC |
407 | * to the resource. |
408 | */ | |
409 | of_property_read_string_index(dev, "interrupt-names", index, | |
410 | &name); | |
411 | ||
7dc2e113 | 412 | r->start = r->end = irq; |
4a43d686 | 413 | r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq)); |
8804827b | 414 | r->name = name ? name : of_node_full_name(dev); |
7dc2e113 GL |
415 | } |
416 | ||
417 | return irq; | |
418 | } | |
419 | EXPORT_SYMBOL_GPL(of_irq_to_resource); | |
52f6537c | 420 | |
9ec36caf | 421 | /** |
39935466 | 422 | * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number |
9ec36caf | 423 | * @dev: pointer to device tree node |
39935466 | 424 | * @index: zero-based index of the IRQ |
9ec36caf | 425 | * |
8c8239c2 | 426 | * Return: Linux IRQ number on success, or 0 on the IRQ mapping failure, or |
39935466 SS |
427 | * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case |
428 | * of any other failure. | |
9ec36caf RH |
429 | */ |
430 | int of_irq_get(struct device_node *dev, int index) | |
431 | { | |
432 | int rc; | |
433 | struct of_phandle_args oirq; | |
434 | struct irq_domain *domain; | |
435 | ||
436 | rc = of_irq_parse_one(dev, index, &oirq); | |
437 | if (rc) | |
438 | return rc; | |
439 | ||
440 | domain = irq_find_host(oirq.np); | |
441 | if (!domain) | |
442 | return -EPROBE_DEFER; | |
443 | ||
444 | return irq_create_of_mapping(&oirq); | |
445 | } | |
9eb08fb3 | 446 | EXPORT_SYMBOL_GPL(of_irq_get); |
9ec36caf | 447 | |
ad69674e | 448 | /** |
39935466 | 449 | * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number |
ad69674e | 450 | * @dev: pointer to device tree node |
39935466 | 451 | * @name: IRQ name |
ad69674e | 452 | * |
8c8239c2 | 453 | * Return: Linux IRQ number on success, or 0 on the IRQ mapping failure, or |
39935466 SS |
454 | * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case |
455 | * of any other failure. | |
ad69674e GS |
456 | */ |
457 | int of_irq_get_byname(struct device_node *dev, const char *name) | |
458 | { | |
459 | int index; | |
460 | ||
461 | if (unlikely(!name)) | |
462 | return -EINVAL; | |
463 | ||
464 | index = of_property_match_string(dev, "interrupt-names", name); | |
465 | if (index < 0) | |
466 | return index; | |
467 | ||
468 | return of_irq_get(dev, index); | |
469 | } | |
6602c452 | 470 | EXPORT_SYMBOL_GPL(of_irq_get_byname); |
ad69674e | 471 | |
52f6537c AS |
472 | /** |
473 | * of_irq_count - Count the number of IRQs a node uses | |
474 | * @dev: pointer to device tree node | |
475 | */ | |
476 | int of_irq_count(struct device_node *dev) | |
477 | { | |
3da52787 | 478 | struct of_phandle_args irq; |
52f6537c AS |
479 | int nr = 0; |
480 | ||
3da52787 | 481 | while (of_irq_parse_one(dev, nr, &irq) == 0) |
52f6537c AS |
482 | nr++; |
483 | ||
484 | return nr; | |
485 | } | |
486 | ||
487 | /** | |
488 | * of_irq_to_resource_table - Fill in resource table with node's IRQ info | |
489 | * @dev: pointer to device tree node | |
490 | * @res: array of resources to fill in | |
491 | * @nr_irqs: the number of IRQs (and upper bound for num of @res elements) | |
492 | * | |
8c8239c2 | 493 | * Return: The size of the filled in table (up to @nr_irqs). |
52f6537c AS |
494 | */ |
495 | int of_irq_to_resource_table(struct device_node *dev, struct resource *res, | |
496 | int nr_irqs) | |
497 | { | |
498 | int i; | |
499 | ||
500 | for (i = 0; i < nr_irqs; i++, res++) | |
531da740 | 501 | if (of_irq_to_resource(dev, i, res) <= 0) |
52f6537c AS |
502 | break; |
503 | ||
504 | return i; | |
505 | } | |
a4f8bf22 | 506 | EXPORT_SYMBOL_GPL(of_irq_to_resource_table); |
c71a54b0 | 507 | |
48a9b733 | 508 | struct of_intc_desc { |
c71a54b0 | 509 | struct list_head list; |
264041e3 | 510 | of_irq_init_cb_t irq_init_cb; |
c71a54b0 RH |
511 | struct device_node *dev; |
512 | struct device_node *interrupt_parent; | |
513 | }; | |
514 | ||
515 | /** | |
516 | * of_irq_init - Scan and init matching interrupt controllers in DT | |
517 | * @matches: 0 terminated array of nodes to match and init function to call | |
518 | * | |
519 | * This function scans the device tree for matching interrupt controller nodes, | |
520 | * and calls their initialization functions in order with parents first. | |
521 | */ | |
522 | void __init of_irq_init(const struct of_device_id *matches) | |
523 | { | |
264041e3 | 524 | const struct of_device_id *match; |
c71a54b0 | 525 | struct device_node *np, *parent = NULL; |
48a9b733 | 526 | struct of_intc_desc *desc, *temp_desc; |
c71a54b0 RH |
527 | struct list_head intc_desc_list, intc_parent_list; |
528 | ||
529 | INIT_LIST_HEAD(&intc_desc_list); | |
530 | INIT_LIST_HEAD(&intc_parent_list); | |
531 | ||
264041e3 | 532 | for_each_matching_node_and_match(np, matches, &match) { |
6a245d95 | 533 | if (!of_property_read_bool(np, "interrupt-controller") || |
bf49be02 | 534 | !of_device_is_available(np)) |
c71a54b0 | 535 | continue; |
264041e3 MY |
536 | |
537 | if (WARN(!match->data, "of_irq_init: no init function for %s\n", | |
538 | match->compatible)) | |
539 | continue; | |
540 | ||
c71a54b0 | 541 | /* |
48a9b733 | 542 | * Here, we allocate and populate an of_intc_desc with the node |
c71a54b0 RH |
543 | * pointer, interrupt-parent device_node etc. |
544 | */ | |
545 | desc = kzalloc(sizeof(*desc), GFP_KERNEL); | |
6f7dc9a3 | 546 | if (!desc) { |
8363ccb9 | 547 | of_node_put(np); |
c71a54b0 | 548 | goto err; |
8363ccb9 | 549 | } |
c71a54b0 | 550 | |
264041e3 | 551 | desc->irq_init_cb = match->data; |
8363ccb9 | 552 | desc->dev = of_node_get(np); |
e9103362 SH |
553 | /* |
554 | * interrupts-extended can reference multiple parent domains. | |
555 | * Arbitrarily pick the first one; assume any other parents | |
556 | * are the same distance away from the root irq controller. | |
557 | */ | |
558 | desc->interrupt_parent = of_parse_phandle(np, "interrupts-extended", 0); | |
559 | if (!desc->interrupt_parent) | |
560 | desc->interrupt_parent = of_irq_find_parent(np); | |
561 | if (desc->interrupt_parent == np) { | |
562 | of_node_put(desc->interrupt_parent); | |
d7fb6d0a | 563 | desc->interrupt_parent = NULL; |
e9103362 | 564 | } |
c71a54b0 RH |
565 | list_add_tail(&desc->list, &intc_desc_list); |
566 | } | |
567 | ||
568 | /* | |
569 | * The root irq controller is the one without an interrupt-parent. | |
570 | * That one goes first, followed by the controllers that reference it, | |
571 | * followed by the ones that reference the 2nd level controllers, etc. | |
572 | */ | |
573 | while (!list_empty(&intc_desc_list)) { | |
574 | /* | |
575 | * Process all controllers with the current 'parent'. | |
576 | * First pass will be looking for NULL as the parent. | |
577 | * The assumption is that NULL parent means a root controller. | |
578 | */ | |
579 | list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) { | |
c71a54b0 | 580 | int ret; |
c71a54b0 RH |
581 | |
582 | if (desc->interrupt_parent != parent) | |
583 | continue; | |
584 | ||
585 | list_del(&desc->list); | |
c71a54b0 | 586 | |
e55aeb6b PZ |
587 | of_node_set_flag(desc->dev, OF_POPULATED); |
588 | ||
0d638a07 RH |
589 | pr_debug("of_irq_init: init %pOF (%p), parent %p\n", |
590 | desc->dev, | |
c71a54b0 | 591 | desc->dev, desc->interrupt_parent); |
264041e3 MY |
592 | ret = desc->irq_init_cb(desc->dev, |
593 | desc->interrupt_parent); | |
c71a54b0 | 594 | if (ret) { |
27244cbd AS |
595 | pr_err("%s: Failed to init %pOF (%p), parent %p\n", |
596 | __func__, desc->dev, desc->dev, | |
597 | desc->interrupt_parent); | |
e55aeb6b | 598 | of_node_clear_flag(desc->dev, OF_POPULATED); |
c71a54b0 RH |
599 | kfree(desc); |
600 | continue; | |
601 | } | |
602 | ||
603 | /* | |
604 | * This one is now set up; add it to the parent list so | |
605 | * its children can get processed in a subsequent pass. | |
606 | */ | |
607 | list_add_tail(&desc->list, &intc_parent_list); | |
608 | } | |
609 | ||
610 | /* Get the next pending parent that might have children */ | |
c0cdfaa0 AL |
611 | desc = list_first_entry_or_null(&intc_parent_list, |
612 | typeof(*desc), list); | |
613 | if (!desc) { | |
c71a54b0 RH |
614 | pr_err("of_irq_init: children remain, but no parents\n"); |
615 | break; | |
616 | } | |
617 | list_del(&desc->list); | |
618 | parent = desc->dev; | |
619 | kfree(desc); | |
620 | } | |
621 | ||
622 | list_for_each_entry_safe(desc, temp_desc, &intc_parent_list, list) { | |
623 | list_del(&desc->list); | |
624 | kfree(desc); | |
625 | } | |
626 | err: | |
627 | list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) { | |
628 | list_del(&desc->list); | |
8363ccb9 | 629 | of_node_put(desc->dev); |
c71a54b0 RH |
630 | kfree(desc); |
631 | } | |
632 | } | |
c706c239 | 633 | |
2bcdd8f2 LP |
634 | static u32 __of_msi_map_id(struct device *dev, struct device_node **np, |
635 | u32 id_in) | |
8db02d8b DD |
636 | { |
637 | struct device *parent_dev; | |
2bcdd8f2 | 638 | u32 id_out = id_in; |
8db02d8b DD |
639 | |
640 | /* | |
641 | * Walk up the device parent links looking for one with a | |
642 | * "msi-map" property. | |
643 | */ | |
987068fc | 644 | for (parent_dev = dev; parent_dev; parent_dev = parent_dev->parent) |
2bcdd8f2 LP |
645 | if (!of_map_id(parent_dev->of_node, id_in, "msi-map", |
646 | "msi-map-mask", np, &id_out)) | |
a251b263 | 647 | break; |
2bcdd8f2 | 648 | return id_out; |
8db02d8b | 649 | } |
48ae34fb | 650 | |
a251b263 | 651 | /** |
2bcdd8f2 | 652 | * of_msi_map_id - Map a MSI ID for a device. |
a251b263 MZ |
653 | * @dev: device for which the mapping is to be done. |
654 | * @msi_np: device node of the expected msi controller. | |
2bcdd8f2 | 655 | * @id_in: unmapped MSI ID for the device. |
a251b263 MZ |
656 | * |
657 | * Walk up the device hierarchy looking for devices with a "msi-map" | |
2bcdd8f2 | 658 | * property. If found, apply the mapping to @id_in. |
a251b263 | 659 | * |
8c8239c2 | 660 | * Return: The mapped MSI ID. |
a251b263 | 661 | */ |
2bcdd8f2 | 662 | u32 of_msi_map_id(struct device *dev, struct device_node *msi_np, u32 id_in) |
a251b263 | 663 | { |
2bcdd8f2 | 664 | return __of_msi_map_id(dev, &msi_np, id_in); |
a251b263 MZ |
665 | } |
666 | ||
82b9b424 MZ |
667 | /** |
668 | * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain | |
669 | * @dev: device for which the mapping is to be done. | |
2bcdd8f2 | 670 | * @id: Device ID. |
6f881aba | 671 | * @bus_token: Bus token |
82b9b424 MZ |
672 | * |
673 | * Walk up the device hierarchy looking for devices with a "msi-map" | |
674 | * property. | |
675 | * | |
676 | * Returns: the MSI domain for this device (or NULL on failure) | |
677 | */ | |
6f881aba DC |
678 | struct irq_domain *of_msi_map_get_device_domain(struct device *dev, u32 id, |
679 | u32 bus_token) | |
82b9b424 MZ |
680 | { |
681 | struct device_node *np = NULL; | |
682 | ||
2bcdd8f2 | 683 | __of_msi_map_id(dev, &np, id); |
6f881aba | 684 | return irq_find_matching_host(np, bus_token); |
82b9b424 MZ |
685 | } |
686 | ||
48ae34fb MZ |
687 | /** |
688 | * of_msi_get_domain - Use msi-parent to find the relevant MSI domain | |
689 | * @dev: device for which the domain is requested | |
690 | * @np: device node for @dev | |
691 | * @token: bus type for this domain | |
692 | * | |
693 | * Parse the msi-parent property (both the simple and the complex | |
694 | * versions), and returns the corresponding MSI domain. | |
695 | * | |
696 | * Returns: the MSI domain for this device (or NULL on failure). | |
697 | */ | |
698 | struct irq_domain *of_msi_get_domain(struct device *dev, | |
699 | struct device_node *np, | |
700 | enum irq_domain_bus_token token) | |
701 | { | |
702 | struct device_node *msi_np; | |
703 | struct irq_domain *d; | |
704 | ||
705 | /* Check for a single msi-parent property */ | |
706 | msi_np = of_parse_phandle(np, "msi-parent", 0); | |
707 | if (msi_np && !of_property_read_bool(msi_np, "#msi-cells")) { | |
14a0db3c | 708 | d = irq_find_matching_host(msi_np, token); |
48ae34fb MZ |
709 | if (!d) |
710 | of_node_put(msi_np); | |
711 | return d; | |
712 | } | |
713 | ||
714 | if (token == DOMAIN_BUS_PLATFORM_MSI) { | |
715 | /* Check for the complex msi-parent version */ | |
716 | struct of_phandle_args args; | |
717 | int index = 0; | |
718 | ||
719 | while (!of_parse_phandle_with_args(np, "msi-parent", | |
720 | "#msi-cells", | |
721 | index, &args)) { | |
14a0db3c | 722 | d = irq_find_matching_host(args.np, token); |
48ae34fb MZ |
723 | if (d) |
724 | return d; | |
725 | ||
726 | of_node_put(args.np); | |
727 | index++; | |
728 | } | |
729 | } | |
730 | ||
731 | return NULL; | |
732 | } | |
beb6f649 | 733 | EXPORT_SYMBOL_GPL(of_msi_get_domain); |
61c08240 MZ |
734 | |
735 | /** | |
736 | * of_msi_configure - Set the msi_domain field of a device | |
737 | * @dev: device structure to associate with an MSI irq domain | |
738 | * @np: device node for that device | |
739 | */ | |
740 | void of_msi_configure(struct device *dev, struct device_node *np) | |
741 | { | |
742 | dev_set_msi_domain(dev, | |
743 | of_msi_get_domain(dev, np, DOMAIN_BUS_PLATFORM_MSI)); | |
744 | } | |
5282c181 | 745 | EXPORT_SYMBOL_GPL(of_msi_configure); |