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 #define pr_fmt(fmt) "OF: " fmt
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/list.h>
26 #include <linux/module.h>
28 #include <linux/of_irq.h>
29 #include <linux/string.h>
30 #include <linux/slab.h>
33 * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
34 * @dev: Device node of the device whose interrupt is to be mapped
35 * @index: Index of the interrupt to map
37 * This function is a wrapper that chains of_irq_parse_one() and
38 * irq_create_of_mapping() to make things easier to callers
40 unsigned int irq_of_parse_and_map(struct device_node
*dev
, int index
)
42 struct of_phandle_args oirq
;
44 if (of_irq_parse_one(dev
, index
, &oirq
))
47 return irq_create_of_mapping(&oirq
);
49 EXPORT_SYMBOL_GPL(irq_of_parse_and_map
);
52 * of_irq_find_parent - Given a device node, find its interrupt parent node
53 * @child: pointer to device node
55 * Returns a pointer to the interrupt parent node, or NULL if the interrupt
56 * parent could not be determined.
58 struct device_node
*of_irq_find_parent(struct device_node
*child
)
60 struct device_node
*p
;
63 if (!of_node_get(child
))
67 parp
= of_get_property(child
, "interrupt-parent", NULL
);
69 p
= of_get_parent(child
);
71 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
72 p
= of_node_get(of_irq_dflt_pic
);
74 p
= of_find_node_by_phandle(be32_to_cpup(parp
));
78 } while (p
&& of_get_property(p
, "#interrupt-cells", NULL
) == NULL
);
82 EXPORT_SYMBOL_GPL(of_irq_find_parent
);
85 * of_irq_parse_raw - Low level interrupt tree parsing
86 * @parent: the device interrupt parent
87 * @addr: address specifier (start of "reg" property of the device) in be32 format
88 * @out_irq: structure of_irq updated by this function
90 * Returns 0 on success and a negative number on error
92 * This function is a low-level interrupt tree walking function. It
93 * can be used to do a partial walk with synthetized reg and interrupts
94 * properties, for example when resolving PCI interrupts when no device
95 * node exist for the parent. It takes an interrupt specifier structure as
96 * input, walks the tree looking for any interrupt-map properties, translates
97 * the specifier for each map, and then returns the translated map.
99 int of_irq_parse_raw(const __be32
*addr
, struct of_phandle_args
*out_irq
)
101 struct device_node
*ipar
, *tnode
, *old
= NULL
, *newpar
= NULL
;
102 __be32 initial_match_array
[MAX_PHANDLE_ARGS
];
103 const __be32
*match_array
= initial_match_array
;
104 const __be32
*tmp
, *imap
, *imask
, dummy_imask
[] = { [0 ... MAX_PHANDLE_ARGS
] = ~0 };
105 u32 intsize
= 1, addrsize
, newintsize
= 0, newaddrsize
= 0;
106 int imaplen
, match
, i
;
109 of_print_phandle_args("of_irq_parse_raw: ", out_irq
);
112 ipar
= of_node_get(out_irq
->np
);
114 /* First get the #interrupt-cells property of the current cursor
115 * that tells us how to interpret the passed-in intspec. If there
116 * is none, we are nice and just walk up the tree
119 tmp
= of_get_property(ipar
, "#interrupt-cells", NULL
);
121 intsize
= be32_to_cpu(*tmp
);
125 ipar
= of_irq_find_parent(ipar
);
129 pr_debug(" -> no parent found !\n");
133 pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar
), intsize
);
135 if (out_irq
->args_count
!= intsize
)
138 /* Look for this #address-cells. We have to implement the old linux
139 * trick of looking for the parent here as some device-trees rely on it
141 old
= of_node_get(ipar
);
143 tmp
= of_get_property(old
, "#address-cells", NULL
);
144 tnode
= of_get_parent(old
);
147 } while (old
&& tmp
== NULL
);
150 addrsize
= (tmp
== NULL
) ? 2 : be32_to_cpu(*tmp
);
152 pr_debug(" -> addrsize=%d\n", addrsize
);
154 /* Range check so that the temporary buffer doesn't overflow */
155 if (WARN_ON(addrsize
+ intsize
> MAX_PHANDLE_ARGS
))
158 /* Precalculate the match array - this simplifies match loop */
159 for (i
= 0; i
< addrsize
; i
++)
160 initial_match_array
[i
] = addr
? addr
[i
] : 0;
161 for (i
= 0; i
< intsize
; i
++)
162 initial_match_array
[addrsize
+ i
] = cpu_to_be32(out_irq
->args
[i
]);
164 /* Now start the actual "proper" walk of the interrupt tree */
165 while (ipar
!= NULL
) {
166 /* Now check if cursor is an interrupt-controller and if it is
169 if (of_get_property(ipar
, "interrupt-controller", NULL
) !=
171 pr_debug(" -> got it !\n");
176 * interrupt-map parsing does not work without a reg
177 * property when #address-cells != 0
179 if (addrsize
&& !addr
) {
180 pr_debug(" -> no reg passed in when needed !\n");
184 /* Now look for an interrupt-map */
185 imap
= of_get_property(ipar
, "interrupt-map", &imaplen
);
186 /* No interrupt map, check for an interrupt parent */
188 pr_debug(" -> no map, getting parent\n");
189 newpar
= of_irq_find_parent(ipar
);
192 imaplen
/= sizeof(u32
);
194 /* Look for a mask */
195 imask
= of_get_property(ipar
, "interrupt-map-mask", NULL
);
199 /* Parse interrupt-map */
201 while (imaplen
> (addrsize
+ intsize
+ 1) && !match
) {
202 /* Compare specifiers */
204 for (i
= 0; i
< (addrsize
+ intsize
); i
++, imaplen
--)
205 match
&= !((match_array
[i
] ^ *imap
++) & imask
[i
]);
207 pr_debug(" -> match=%d (imaplen=%d)\n", match
, imaplen
);
209 /* Get the interrupt parent */
210 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
211 newpar
= of_node_get(of_irq_dflt_pic
);
213 newpar
= of_find_node_by_phandle(be32_to_cpup(imap
));
217 /* Check if not found */
218 if (newpar
== NULL
) {
219 pr_debug(" -> imap parent not found !\n");
223 if (!of_device_is_available(newpar
))
226 /* Get #interrupt-cells and #address-cells of new
229 tmp
= of_get_property(newpar
, "#interrupt-cells", NULL
);
231 pr_debug(" -> parent lacks #interrupt-cells!\n");
234 newintsize
= be32_to_cpu(*tmp
);
235 tmp
= of_get_property(newpar
, "#address-cells", NULL
);
236 newaddrsize
= (tmp
== NULL
) ? 0 : be32_to_cpu(*tmp
);
238 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
239 newintsize
, newaddrsize
);
241 /* Check for malformed properties */
242 if (WARN_ON(newaddrsize
+ newintsize
> MAX_PHANDLE_ARGS
))
244 if (imaplen
< (newaddrsize
+ newintsize
))
247 imap
+= newaddrsize
+ newintsize
;
248 imaplen
-= newaddrsize
+ newintsize
;
250 pr_debug(" -> imaplen=%d\n", imaplen
);
256 * Successfully parsed an interrrupt-map translation; copy new
257 * interrupt specifier into the out_irq structure
259 match_array
= imap
- newaddrsize
- newintsize
;
260 for (i
= 0; i
< newintsize
; i
++)
261 out_irq
->args
[i
] = be32_to_cpup(imap
- newintsize
+ i
);
262 out_irq
->args_count
= intsize
= newintsize
;
263 addrsize
= newaddrsize
;
266 /* Iterate again with new parent */
267 out_irq
->np
= newpar
;
268 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar
));
279 EXPORT_SYMBOL_GPL(of_irq_parse_raw
);
282 * of_irq_parse_one - Resolve an interrupt for a device
283 * @device: the device whose interrupt is to be resolved
284 * @index: index of the interrupt to resolve
285 * @out_irq: structure of_irq filled by this function
287 * This function resolves an interrupt for a node by walking the interrupt tree,
288 * finding which interrupt controller node it is attached to, and returning the
289 * interrupt specifier that can be used to retrieve a Linux IRQ number.
291 int of_irq_parse_one(struct device_node
*device
, int index
, struct of_phandle_args
*out_irq
)
293 struct device_node
*p
;
294 const __be32
*intspec
, *tmp
, *addr
;
298 pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device
), index
);
300 /* OldWorld mac stuff is "special", handle out of line */
301 if (of_irq_workarounds
& OF_IMAP_OLDWORLD_MAC
)
302 return of_irq_parse_oldworld(device
, index
, out_irq
);
304 /* Get the reg property (if any) */
305 addr
= of_get_property(device
, "reg", NULL
);
307 /* Try the new-style interrupts-extended first */
308 res
= of_parse_phandle_with_args(device
, "interrupts-extended",
309 "#interrupt-cells", index
, out_irq
);
311 return of_irq_parse_raw(addr
, out_irq
);
313 /* Get the interrupts property */
314 intspec
= of_get_property(device
, "interrupts", &intlen
);
318 intlen
/= sizeof(*intspec
);
320 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec
), intlen
);
322 /* Look for the interrupt parent. */
323 p
= of_irq_find_parent(device
);
327 /* Get size of interrupt specifier */
328 tmp
= of_get_property(p
, "#interrupt-cells", NULL
);
333 intsize
= be32_to_cpu(*tmp
);
335 pr_debug(" intsize=%d intlen=%d\n", intsize
, intlen
);
338 if ((index
+ 1) * intsize
> intlen
) {
343 /* Copy intspec into irq structure */
344 intspec
+= index
* intsize
;
346 out_irq
->args_count
= intsize
;
347 for (i
= 0; i
< intsize
; i
++)
348 out_irq
->args
[i
] = be32_to_cpup(intspec
++);
350 /* Check if there are any interrupt-map translations to process */
351 res
= of_irq_parse_raw(addr
, out_irq
);
356 EXPORT_SYMBOL_GPL(of_irq_parse_one
);
359 * of_irq_to_resource - Decode a node's IRQ and return it as a resource
360 * @dev: pointer to device tree node
361 * @index: zero-based index of the irq
362 * @r: pointer to resource structure to return result into.
364 int of_irq_to_resource(struct device_node
*dev
, int index
, struct resource
*r
)
366 int irq
= irq_of_parse_and_map(dev
, index
);
368 /* Only dereference the resource if both the
369 * resource and the irq are valid. */
371 const char *name
= NULL
;
373 memset(r
, 0, sizeof(*r
));
375 * Get optional "interrupt-names" property to add a name
378 of_property_read_string_index(dev
, "interrupt-names", index
,
381 r
->start
= r
->end
= irq
;
382 r
->flags
= IORESOURCE_IRQ
| irqd_get_trigger_type(irq_get_irq_data(irq
));
383 r
->name
= name
? name
: of_node_full_name(dev
);
388 EXPORT_SYMBOL_GPL(of_irq_to_resource
);
391 * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number
392 * @dev: pointer to device tree node
393 * @index: zero-based index of the IRQ
395 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
396 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
397 * of any other failure.
399 int of_irq_get(struct device_node
*dev
, int index
)
402 struct of_phandle_args oirq
;
403 struct irq_domain
*domain
;
405 rc
= of_irq_parse_one(dev
, index
, &oirq
);
409 domain
= irq_find_host(oirq
.np
);
411 return -EPROBE_DEFER
;
413 return irq_create_of_mapping(&oirq
);
415 EXPORT_SYMBOL_GPL(of_irq_get
);
418 * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number
419 * @dev: pointer to device tree node
422 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
423 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
424 * of any other failure.
426 int of_irq_get_byname(struct device_node
*dev
, const char *name
)
433 index
= of_property_match_string(dev
, "interrupt-names", name
);
437 return of_irq_get(dev
, index
);
439 EXPORT_SYMBOL_GPL(of_irq_get_byname
);
442 * of_irq_count - Count the number of IRQs a node uses
443 * @dev: pointer to device tree node
445 int of_irq_count(struct device_node
*dev
)
447 struct of_phandle_args irq
;
450 while (of_irq_parse_one(dev
, nr
, &irq
) == 0)
457 * of_irq_to_resource_table - Fill in resource table with node's IRQ info
458 * @dev: pointer to device tree node
459 * @res: array of resources to fill in
460 * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
462 * Returns the size of the filled in table (up to @nr_irqs).
464 int of_irq_to_resource_table(struct device_node
*dev
, struct resource
*res
,
469 for (i
= 0; i
< nr_irqs
; i
++, res
++)
470 if (!of_irq_to_resource(dev
, i
, res
))
475 EXPORT_SYMBOL_GPL(of_irq_to_resource_table
);
477 struct of_intc_desc
{
478 struct list_head list
;
479 of_irq_init_cb_t irq_init_cb
;
480 struct device_node
*dev
;
481 struct device_node
*interrupt_parent
;
485 * of_irq_init - Scan and init matching interrupt controllers in DT
486 * @matches: 0 terminated array of nodes to match and init function to call
488 * This function scans the device tree for matching interrupt controller nodes,
489 * and calls their initialization functions in order with parents first.
491 void __init
of_irq_init(const struct of_device_id
*matches
)
493 const struct of_device_id
*match
;
494 struct device_node
*np
, *parent
= NULL
;
495 struct of_intc_desc
*desc
, *temp_desc
;
496 struct list_head intc_desc_list
, intc_parent_list
;
498 INIT_LIST_HEAD(&intc_desc_list
);
499 INIT_LIST_HEAD(&intc_parent_list
);
501 for_each_matching_node_and_match(np
, matches
, &match
) {
502 if (!of_find_property(np
, "interrupt-controller", NULL
) ||
503 !of_device_is_available(np
))
506 if (WARN(!match
->data
, "of_irq_init: no init function for %s\n",
511 * Here, we allocate and populate an of_intc_desc with the node
512 * pointer, interrupt-parent device_node etc.
514 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
515 if (WARN_ON(!desc
)) {
520 desc
->irq_init_cb
= match
->data
;
521 desc
->dev
= of_node_get(np
);
522 desc
->interrupt_parent
= of_irq_find_parent(np
);
523 if (desc
->interrupt_parent
== np
)
524 desc
->interrupt_parent
= NULL
;
525 list_add_tail(&desc
->list
, &intc_desc_list
);
529 * The root irq controller is the one without an interrupt-parent.
530 * That one goes first, followed by the controllers that reference it,
531 * followed by the ones that reference the 2nd level controllers, etc.
533 while (!list_empty(&intc_desc_list
)) {
535 * Process all controllers with the current 'parent'.
536 * First pass will be looking for NULL as the parent.
537 * The assumption is that NULL parent means a root controller.
539 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
542 if (desc
->interrupt_parent
!= parent
)
545 list_del(&desc
->list
);
547 of_node_set_flag(desc
->dev
, OF_POPULATED
);
549 pr_debug("of_irq_init: init %s (%p), parent %p\n",
550 desc
->dev
->full_name
,
551 desc
->dev
, desc
->interrupt_parent
);
552 ret
= desc
->irq_init_cb(desc
->dev
,
553 desc
->interrupt_parent
);
555 of_node_clear_flag(desc
->dev
, OF_POPULATED
);
561 * This one is now set up; add it to the parent list so
562 * its children can get processed in a subsequent pass.
564 list_add_tail(&desc
->list
, &intc_parent_list
);
567 /* Get the next pending parent that might have children */
568 desc
= list_first_entry_or_null(&intc_parent_list
,
569 typeof(*desc
), list
);
571 pr_err("of_irq_init: children remain, but no parents\n");
574 list_del(&desc
->list
);
579 list_for_each_entry_safe(desc
, temp_desc
, &intc_parent_list
, list
) {
580 list_del(&desc
->list
);
584 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
585 list_del(&desc
->list
);
586 of_node_put(desc
->dev
);
591 static u32
__of_msi_map_rid(struct device
*dev
, struct device_node
**np
,
594 struct device
*parent_dev
;
595 struct device_node
*msi_controller_node
;
596 struct device_node
*msi_np
= *np
;
597 u32 map_mask
, masked_rid
, rid_base
, msi_base
, rid_len
, phandle
;
600 u32 rid_out
= rid_in
;
601 const __be32
*msi_map
= NULL
;
604 * Walk up the device parent links looking for one with a
605 * "msi-map" property.
607 for (parent_dev
= dev
; parent_dev
; parent_dev
= parent_dev
->parent
) {
608 if (!parent_dev
->of_node
)
611 msi_map
= of_get_property(parent_dev
->of_node
,
612 "msi-map", &msi_map_len
);
616 if (msi_map_len
% (4 * sizeof(__be32
))) {
617 dev_err(parent_dev
, "Error: Bad msi-map length: %d\n",
621 /* We have a good parent_dev and msi_map, let's use them. */
627 /* The default is to select all bits. */
628 map_mask
= 0xffffffff;
631 * Can be overridden by "msi-map-mask" property. If
632 * of_property_read_u32() fails, the default is used.
634 of_property_read_u32(parent_dev
->of_node
, "msi-map-mask", &map_mask
);
636 masked_rid
= map_mask
& rid_in
;
638 while (!matched
&& msi_map_len
>= 4 * sizeof(__be32
)) {
639 rid_base
= be32_to_cpup(msi_map
+ 0);
640 phandle
= be32_to_cpup(msi_map
+ 1);
641 msi_base
= be32_to_cpup(msi_map
+ 2);
642 rid_len
= be32_to_cpup(msi_map
+ 3);
644 if (rid_base
& ~map_mask
) {
646 "Invalid msi-map translation - msi-map-mask (0x%x) ignores rid-base (0x%x)\n",
651 msi_controller_node
= of_find_node_by_phandle(phandle
);
653 matched
= (masked_rid
>= rid_base
&&
654 masked_rid
< rid_base
+ rid_len
);
656 matched
&= msi_np
== msi_controller_node
;
658 if (matched
&& !msi_np
) {
659 *np
= msi_np
= msi_controller_node
;
663 of_node_put(msi_controller_node
);
664 msi_map_len
-= 4 * sizeof(__be32
);
670 rid_out
= masked_rid
- rid_base
+ msi_base
;
672 "msi-map at: %s, using mask %08x, rid-base: %08x, msi-base: %08x, length: %08x, rid: %08x -> %08x\n",
673 dev_name(parent_dev
), map_mask
, rid_base
, msi_base
,
674 rid_len
, rid_in
, rid_out
);
680 * of_msi_map_rid - Map a MSI requester ID for a device.
681 * @dev: device for which the mapping is to be done.
682 * @msi_np: device node of the expected msi controller.
683 * @rid_in: unmapped MSI requester ID for the device.
685 * Walk up the device hierarchy looking for devices with a "msi-map"
686 * property. If found, apply the mapping to @rid_in.
688 * Returns the mapped MSI requester ID.
690 u32
of_msi_map_rid(struct device
*dev
, struct device_node
*msi_np
, u32 rid_in
)
692 return __of_msi_map_rid(dev
, &msi_np
, rid_in
);
696 * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain
697 * @dev: device for which the mapping is to be done.
698 * @rid: Requester ID for the device.
700 * Walk up the device hierarchy looking for devices with a "msi-map"
703 * Returns: the MSI domain for this device (or NULL on failure)
705 struct irq_domain
*of_msi_map_get_device_domain(struct device
*dev
, u32 rid
)
707 struct device_node
*np
= NULL
;
709 __of_msi_map_rid(dev
, &np
, rid
);
710 return irq_find_matching_host(np
, DOMAIN_BUS_PCI_MSI
);
714 * of_msi_get_domain - Use msi-parent to find the relevant MSI domain
715 * @dev: device for which the domain is requested
716 * @np: device node for @dev
717 * @token: bus type for this domain
719 * Parse the msi-parent property (both the simple and the complex
720 * versions), and returns the corresponding MSI domain.
722 * Returns: the MSI domain for this device (or NULL on failure).
724 struct irq_domain
*of_msi_get_domain(struct device
*dev
,
725 struct device_node
*np
,
726 enum irq_domain_bus_token token
)
728 struct device_node
*msi_np
;
729 struct irq_domain
*d
;
731 /* Check for a single msi-parent property */
732 msi_np
= of_parse_phandle(np
, "msi-parent", 0);
733 if (msi_np
&& !of_property_read_bool(msi_np
, "#msi-cells")) {
734 d
= irq_find_matching_host(msi_np
, token
);
740 if (token
== DOMAIN_BUS_PLATFORM_MSI
) {
741 /* Check for the complex msi-parent version */
742 struct of_phandle_args args
;
745 while (!of_parse_phandle_with_args(np
, "msi-parent",
748 d
= irq_find_matching_host(args
.np
, token
);
752 of_node_put(args
.np
);
761 * of_msi_configure - Set the msi_domain field of a device
762 * @dev: device structure to associate with an MSI irq domain
763 * @np: device node for that device
765 void of_msi_configure(struct device
*dev
, struct device_node
*np
)
767 dev_set_msi_domain(dev
,
768 of_msi_get_domain(dev
, np
, DOMAIN_BUS_PLATFORM_MSI
));