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)
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.
16 * This file contains the code used to make IRQ descriptions in the
17 * device tree to actual irq numbers on an interrupt controller
21 #include <linux/device.h>
22 #include <linux/errno.h>
23 #include <linux/list.h>
24 #include <linux/module.h>
26 #include <linux/of_irq.h>
27 #include <linux/string.h>
28 #include <linux/slab.h>
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
35 * This function is a wrapper that chains of_irq_parse_one() and
36 * irq_create_of_mapping() to make things easier to callers
38 unsigned int irq_of_parse_and_map(struct device_node
*dev
, int index
)
40 struct of_phandle_args oirq
;
42 if (of_irq_parse_one(dev
, index
, &oirq
))
45 return irq_create_of_mapping(&oirq
);
47 EXPORT_SYMBOL_GPL(irq_of_parse_and_map
);
50 * of_irq_find_parent - Given a device node, find its interrupt parent node
51 * @child: pointer to device node
53 * Returns a pointer to the interrupt parent node, or NULL if the interrupt
54 * parent could not be determined.
56 struct device_node
*of_irq_find_parent(struct device_node
*child
)
58 struct device_node
*p
;
61 if (!of_node_get(child
))
65 parp
= of_get_property(child
, "interrupt-parent", NULL
);
67 p
= of_get_parent(child
);
69 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
70 p
= of_node_get(of_irq_dflt_pic
);
72 p
= of_find_node_by_phandle(be32_to_cpup(parp
));
76 } while (p
&& of_get_property(p
, "#interrupt-cells", NULL
) == NULL
);
80 EXPORT_SYMBOL_GPL(of_irq_find_parent
);
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
88 * Returns 0 on success and a negative number on error
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.
97 int of_irq_parse_raw(const __be32
*addr
, struct of_phandle_args
*out_irq
)
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
;
107 of_print_phandle_args("of_irq_parse_raw: ", out_irq
);
110 ipar
= of_node_get(out_irq
->np
);
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
117 tmp
= of_get_property(ipar
, "#interrupt-cells", NULL
);
119 intsize
= be32_to_cpu(*tmp
);
123 ipar
= of_irq_find_parent(ipar
);
127 pr_debug(" -> no parent found !\n");
131 pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar
), intsize
);
133 if (out_irq
->args_count
!= intsize
)
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
139 old
= of_node_get(ipar
);
141 tmp
= of_get_property(old
, "#address-cells", NULL
);
142 tnode
= of_get_parent(old
);
145 } while (old
&& tmp
== NULL
);
148 addrsize
= (tmp
== NULL
) ? 2 : be32_to_cpu(*tmp
);
150 pr_debug(" -> addrsize=%d\n", addrsize
);
152 /* Range check so that the temporary buffer doesn't overflow */
153 if (WARN_ON(addrsize
+ intsize
> MAX_PHANDLE_ARGS
))
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
]);
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
167 if (of_get_property(ipar
, "interrupt-controller", NULL
) !=
169 pr_debug(" -> got it !\n");
174 * interrupt-map parsing does not work without a reg
175 * property when #address-cells != 0
177 if (addrsize
&& !addr
) {
178 pr_debug(" -> no reg passed in when needed !\n");
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 */
186 pr_debug(" -> no map, getting parent\n");
187 newpar
= of_irq_find_parent(ipar
);
190 imaplen
/= sizeof(u32
);
192 /* Look for a mask */
193 imask
= of_get_property(ipar
, "interrupt-map-mask", NULL
);
197 /* Parse interrupt-map */
199 while (imaplen
> (addrsize
+ intsize
+ 1) && !match
) {
200 /* Compare specifiers */
202 for (i
= 0; i
< (addrsize
+ intsize
); i
++, imaplen
--)
203 match
&= !((match_array
[i
] ^ *imap
++) & imask
[i
]);
205 pr_debug(" -> match=%d (imaplen=%d)\n", match
, imaplen
);
207 /* Get the interrupt parent */
208 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
209 newpar
= of_node_get(of_irq_dflt_pic
);
211 newpar
= of_find_node_by_phandle(be32_to_cpup(imap
));
215 /* Check if not found */
216 if (newpar
== NULL
) {
217 pr_debug(" -> imap parent not found !\n");
221 if (!of_device_is_available(newpar
))
224 /* Get #interrupt-cells and #address-cells of new
227 tmp
= of_get_property(newpar
, "#interrupt-cells", NULL
);
229 pr_debug(" -> parent lacks #interrupt-cells!\n");
232 newintsize
= be32_to_cpu(*tmp
);
233 tmp
= of_get_property(newpar
, "#address-cells", NULL
);
234 newaddrsize
= (tmp
== NULL
) ? 0 : be32_to_cpu(*tmp
);
236 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
237 newintsize
, newaddrsize
);
239 /* Check for malformed properties */
240 if (WARN_ON(newaddrsize
+ newintsize
> MAX_PHANDLE_ARGS
))
242 if (imaplen
< (newaddrsize
+ newintsize
))
245 imap
+= newaddrsize
+ newintsize
;
246 imaplen
-= newaddrsize
+ newintsize
;
248 pr_debug(" -> imaplen=%d\n", imaplen
);
254 * Successfully parsed an interrrupt-map translation; copy new
255 * interrupt specifier into the out_irq structure
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
;
264 /* Iterate again with new parent */
265 out_irq
->np
= newpar
;
266 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar
));
277 EXPORT_SYMBOL_GPL(of_irq_parse_raw
);
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
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.
289 int of_irq_parse_one(struct device_node
*device
, int index
, struct of_phandle_args
*out_irq
)
291 struct device_node
*p
;
292 const __be32
*intspec
, *tmp
, *addr
;
296 pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device
), index
);
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
);
302 /* Get the reg property (if any) */
303 addr
= of_get_property(device
, "reg", NULL
);
305 /* Try the new-style interrupts-extended first */
306 res
= of_parse_phandle_with_args(device
, "interrupts-extended",
307 "#interrupt-cells", index
, out_irq
);
309 return of_irq_parse_raw(addr
, out_irq
);
311 /* Get the interrupts property */
312 intspec
= of_get_property(device
, "interrupts", &intlen
);
316 intlen
/= sizeof(*intspec
);
318 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec
), intlen
);
320 /* Look for the interrupt parent. */
321 p
= of_irq_find_parent(device
);
325 /* Get size of interrupt specifier */
326 tmp
= of_get_property(p
, "#interrupt-cells", NULL
);
331 intsize
= be32_to_cpu(*tmp
);
333 pr_debug(" intsize=%d intlen=%d\n", intsize
, intlen
);
336 if ((index
+ 1) * intsize
> intlen
) {
341 /* Copy intspec into irq structure */
342 intspec
+= index
* intsize
;
344 out_irq
->args_count
= intsize
;
345 for (i
= 0; i
< intsize
; i
++)
346 out_irq
->args
[i
] = be32_to_cpup(intspec
++);
348 /* Check if there are any interrupt-map translations to process */
349 res
= of_irq_parse_raw(addr
, out_irq
);
354 EXPORT_SYMBOL_GPL(of_irq_parse_one
);
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.
362 int of_irq_to_resource(struct device_node
*dev
, int index
, struct resource
*r
)
364 int irq
= irq_of_parse_and_map(dev
, index
);
366 /* Only dereference the resource if both the
367 * resource and the irq are valid. */
369 const char *name
= NULL
;
371 memset(r
, 0, sizeof(*r
));
373 * Get optional "interrupt-names" property to add a name
376 of_property_read_string_index(dev
, "interrupt-names", index
,
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
);
386 EXPORT_SYMBOL_GPL(of_irq_to_resource
);
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
393 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
394 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
395 * of any other failure.
397 int of_irq_get(struct device_node
*dev
, int index
)
400 struct of_phandle_args oirq
;
401 struct irq_domain
*domain
;
403 rc
= of_irq_parse_one(dev
, index
, &oirq
);
407 domain
= irq_find_host(oirq
.np
);
409 return -EPROBE_DEFER
;
411 return irq_create_of_mapping(&oirq
);
413 EXPORT_SYMBOL_GPL(of_irq_get
);
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
420 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
421 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
422 * of any other failure.
424 int of_irq_get_byname(struct device_node
*dev
, const char *name
)
431 index
= of_property_match_string(dev
, "interrupt-names", name
);
435 return of_irq_get(dev
, index
);
437 EXPORT_SYMBOL_GPL(of_irq_get_byname
);
440 * of_irq_count - Count the number of IRQs a node uses
441 * @dev: pointer to device tree node
443 int of_irq_count(struct device_node
*dev
)
445 struct of_phandle_args irq
;
448 while (of_irq_parse_one(dev
, nr
, &irq
) == 0)
455 * of_irq_to_resource_table - Fill in resource table with node's IRQ info
456 * @dev: pointer to device tree node
457 * @res: array of resources to fill in
458 * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
460 * Returns the size of the filled in table (up to @nr_irqs).
462 int of_irq_to_resource_table(struct device_node
*dev
, struct resource
*res
,
467 for (i
= 0; i
< nr_irqs
; i
++, res
++)
468 if (!of_irq_to_resource(dev
, i
, res
))
473 EXPORT_SYMBOL_GPL(of_irq_to_resource_table
);
475 struct of_intc_desc
{
476 struct list_head list
;
477 struct device_node
*dev
;
478 struct device_node
*interrupt_parent
;
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
485 * This function scans the device tree for matching interrupt controller nodes,
486 * and calls their initialization functions in order with parents first.
488 void __init
of_irq_init(const struct of_device_id
*matches
)
490 struct device_node
*np
, *parent
= NULL
;
491 struct of_intc_desc
*desc
, *temp_desc
;
492 struct list_head intc_desc_list
, intc_parent_list
;
494 INIT_LIST_HEAD(&intc_desc_list
);
495 INIT_LIST_HEAD(&intc_parent_list
);
497 for_each_matching_node(np
, matches
) {
498 if (!of_find_property(np
, "interrupt-controller", NULL
) ||
499 !of_device_is_available(np
))
502 * Here, we allocate and populate an of_intc_desc with the node
503 * pointer, interrupt-parent device_node etc.
505 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
506 if (WARN_ON(!desc
)) {
511 desc
->dev
= of_node_get(np
);
512 desc
->interrupt_parent
= of_irq_find_parent(np
);
513 if (desc
->interrupt_parent
== np
)
514 desc
->interrupt_parent
= NULL
;
515 list_add_tail(&desc
->list
, &intc_desc_list
);
519 * The root irq controller is the one without an interrupt-parent.
520 * That one goes first, followed by the controllers that reference it,
521 * followed by the ones that reference the 2nd level controllers, etc.
523 while (!list_empty(&intc_desc_list
)) {
525 * Process all controllers with the current 'parent'.
526 * First pass will be looking for NULL as the parent.
527 * The assumption is that NULL parent means a root controller.
529 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
530 const struct of_device_id
*match
;
532 of_irq_init_cb_t irq_init_cb
;
534 if (desc
->interrupt_parent
!= parent
)
537 list_del(&desc
->list
);
538 match
= of_match_node(matches
, desc
->dev
);
539 if (WARN(!match
->data
,
540 "of_irq_init: no init function for %s\n",
541 match
->compatible
)) {
546 pr_debug("of_irq_init: init %s @ %p, parent %p\n",
548 desc
->dev
, desc
->interrupt_parent
);
549 irq_init_cb
= (of_irq_init_cb_t
)match
->data
;
550 ret
= irq_init_cb(desc
->dev
, desc
->interrupt_parent
);
557 * This one is now set up; add it to the parent list so
558 * its children can get processed in a subsequent pass.
560 list_add_tail(&desc
->list
, &intc_parent_list
);
563 /* Get the next pending parent that might have children */
564 desc
= list_first_entry_or_null(&intc_parent_list
,
565 typeof(*desc
), list
);
567 pr_err("of_irq_init: children remain, but no parents\n");
570 list_del(&desc
->list
);
575 list_for_each_entry_safe(desc
, temp_desc
, &intc_parent_list
, list
) {
576 list_del(&desc
->list
);
580 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
581 list_del(&desc
->list
);
582 of_node_put(desc
->dev
);
587 static u32
__of_msi_map_rid(struct device
*dev
, struct device_node
**np
,
590 struct device
*parent_dev
;
591 struct device_node
*msi_controller_node
;
592 struct device_node
*msi_np
= *np
;
593 u32 map_mask
, masked_rid
, rid_base
, msi_base
, rid_len
, phandle
;
596 u32 rid_out
= rid_in
;
597 const __be32
*msi_map
= NULL
;
600 * Walk up the device parent links looking for one with a
601 * "msi-map" property.
603 for (parent_dev
= dev
; parent_dev
; parent_dev
= parent_dev
->parent
) {
604 if (!parent_dev
->of_node
)
607 msi_map
= of_get_property(parent_dev
->of_node
,
608 "msi-map", &msi_map_len
);
612 if (msi_map_len
% (4 * sizeof(__be32
))) {
613 dev_err(parent_dev
, "Error: Bad msi-map length: %d\n",
617 /* We have a good parent_dev and msi_map, let's use them. */
623 /* The default is to select all bits. */
624 map_mask
= 0xffffffff;
627 * Can be overridden by "msi-map-mask" property. If
628 * of_property_read_u32() fails, the default is used.
630 of_property_read_u32(parent_dev
->of_node
, "msi-map-mask", &map_mask
);
632 masked_rid
= map_mask
& rid_in
;
634 while (!matched
&& msi_map_len
>= 4 * sizeof(__be32
)) {
635 rid_base
= be32_to_cpup(msi_map
+ 0);
636 phandle
= be32_to_cpup(msi_map
+ 1);
637 msi_base
= be32_to_cpup(msi_map
+ 2);
638 rid_len
= be32_to_cpup(msi_map
+ 3);
640 if (rid_base
& ~map_mask
) {
642 "Invalid msi-map translation - msi-map-mask (0x%x) ignores rid-base (0x%x)\n",
647 msi_controller_node
= of_find_node_by_phandle(phandle
);
649 matched
= (masked_rid
>= rid_base
&&
650 masked_rid
< rid_base
+ rid_len
);
652 matched
&= msi_np
== msi_controller_node
;
654 if (matched
&& !msi_np
) {
655 *np
= msi_np
= msi_controller_node
;
659 of_node_put(msi_controller_node
);
660 msi_map_len
-= 4 * sizeof(__be32
);
666 rid_out
= masked_rid
- rid_base
+ msi_base
;
668 "msi-map at: %s, using mask %08x, rid-base: %08x, msi-base: %08x, length: %08x, rid: %08x -> %08x\n",
669 dev_name(parent_dev
), map_mask
, rid_base
, msi_base
,
670 rid_len
, rid_in
, rid_out
);
676 * of_msi_map_rid - Map a MSI requester ID for a device.
677 * @dev: device for which the mapping is to be done.
678 * @msi_np: device node of the expected msi controller.
679 * @rid_in: unmapped MSI requester ID for the device.
681 * Walk up the device hierarchy looking for devices with a "msi-map"
682 * property. If found, apply the mapping to @rid_in.
684 * Returns the mapped MSI requester ID.
686 u32
of_msi_map_rid(struct device
*dev
, struct device_node
*msi_np
, u32 rid_in
)
688 return __of_msi_map_rid(dev
, &msi_np
, rid_in
);
691 static struct irq_domain
*__of_get_msi_domain(struct device_node
*np
,
692 enum irq_domain_bus_token token
)
694 struct irq_domain
*d
;
696 d
= irq_find_matching_host(np
, token
);
698 d
= irq_find_host(np
);
704 * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain
705 * @dev: device for which the mapping is to be done.
706 * @rid: Requester ID for the device.
708 * Walk up the device hierarchy looking for devices with a "msi-map"
711 * Returns: the MSI domain for this device (or NULL on failure)
713 struct irq_domain
*of_msi_map_get_device_domain(struct device
*dev
, u32 rid
)
715 struct device_node
*np
= NULL
;
717 __of_msi_map_rid(dev
, &np
, rid
);
718 return __of_get_msi_domain(np
, DOMAIN_BUS_PCI_MSI
);
722 * of_msi_get_domain - Use msi-parent to find the relevant MSI domain
723 * @dev: device for which the domain is requested
724 * @np: device node for @dev
725 * @token: bus type for this domain
727 * Parse the msi-parent property (both the simple and the complex
728 * versions), and returns the corresponding MSI domain.
730 * Returns: the MSI domain for this device (or NULL on failure).
732 struct irq_domain
*of_msi_get_domain(struct device
*dev
,
733 struct device_node
*np
,
734 enum irq_domain_bus_token token
)
736 struct device_node
*msi_np
;
737 struct irq_domain
*d
;
739 /* Check for a single msi-parent property */
740 msi_np
= of_parse_phandle(np
, "msi-parent", 0);
741 if (msi_np
&& !of_property_read_bool(msi_np
, "#msi-cells")) {
742 d
= __of_get_msi_domain(msi_np
, token
);
748 if (token
== DOMAIN_BUS_PLATFORM_MSI
) {
749 /* Check for the complex msi-parent version */
750 struct of_phandle_args args
;
753 while (!of_parse_phandle_with_args(np
, "msi-parent",
756 d
= __of_get_msi_domain(args
.np
, token
);
760 of_node_put(args
.np
);
769 * of_msi_configure - Set the msi_domain field of a device
770 * @dev: device structure to associate with an MSI irq domain
771 * @np: device node for that device
773 void of_msi_configure(struct device
*dev
, struct device_node
*np
)
775 dev_set_msi_domain(dev
,
776 of_msi_get_domain(dev
, np
, DOMAIN_BUS_PLATFORM_MSI
));