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