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