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/of_pci.h>
30 #include <linux/string.h>
31 #include <linux/slab.h>
34 * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
35 * @dev: Device node of the device whose interrupt is to be mapped
36 * @index: Index of the interrupt to map
38 * This function is a wrapper that chains of_irq_parse_one() and
39 * irq_create_of_mapping() to make things easier to callers
41 unsigned int irq_of_parse_and_map(struct device_node
*dev
, int index
)
43 struct of_phandle_args oirq
;
45 if (of_irq_parse_one(dev
, index
, &oirq
))
48 return irq_create_of_mapping(&oirq
);
50 EXPORT_SYMBOL_GPL(irq_of_parse_and_map
);
53 * of_irq_find_parent - Given a device node, find its interrupt parent node
54 * @child: pointer to device node
56 * Returns a pointer to the interrupt parent node, or NULL if the interrupt
57 * parent could not be determined.
59 struct device_node
*of_irq_find_parent(struct device_node
*child
)
61 struct device_node
*p
;
64 if (!of_node_get(child
))
68 parp
= of_get_property(child
, "interrupt-parent", NULL
);
70 p
= of_get_parent(child
);
72 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
73 p
= of_node_get(of_irq_dflt_pic
);
75 p
= of_find_node_by_phandle(be32_to_cpup(parp
));
79 } while (p
&& of_get_property(p
, "#interrupt-cells", NULL
) == NULL
);
83 EXPORT_SYMBOL_GPL(of_irq_find_parent
);
86 * of_irq_parse_raw - Low level interrupt tree parsing
87 * @parent: the device interrupt parent
88 * @addr: address specifier (start of "reg" property of the device) in be32 format
89 * @out_irq: structure of_irq updated by this function
91 * Returns 0 on success and a negative number on error
93 * This function is a low-level interrupt tree walking function. It
94 * can be used to do a partial walk with synthetized reg and interrupts
95 * properties, for example when resolving PCI interrupts when no device
96 * node exist for the parent. It takes an interrupt specifier structure as
97 * input, walks the tree looking for any interrupt-map properties, translates
98 * the specifier for each map, and then returns the translated map.
100 int of_irq_parse_raw(const __be32
*addr
, struct of_phandle_args
*out_irq
)
102 struct device_node
*ipar
, *tnode
, *old
= NULL
, *newpar
= NULL
;
103 __be32 initial_match_array
[MAX_PHANDLE_ARGS
];
104 const __be32
*match_array
= initial_match_array
;
105 const __be32
*tmp
, *imap
, *imask
, dummy_imask
[] = { [0 ... MAX_PHANDLE_ARGS
] = ~0 };
106 u32 intsize
= 1, addrsize
, newintsize
= 0, newaddrsize
= 0;
107 int imaplen
, match
, i
, rc
= -EINVAL
;
110 of_print_phandle_args("of_irq_parse_raw: ", out_irq
);
113 ipar
= of_node_get(out_irq
->np
);
115 /* First get the #interrupt-cells property of the current cursor
116 * that tells us how to interpret the passed-in intspec. If there
117 * is none, we are nice and just walk up the tree
120 tmp
= of_get_property(ipar
, "#interrupt-cells", NULL
);
122 intsize
= be32_to_cpu(*tmp
);
126 ipar
= of_irq_find_parent(ipar
);
130 pr_debug(" -> no parent found !\n");
134 pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar
), intsize
);
136 if (out_irq
->args_count
!= intsize
)
139 /* Look for this #address-cells. We have to implement the old linux
140 * trick of looking for the parent here as some device-trees rely on it
142 old
= of_node_get(ipar
);
144 tmp
= of_get_property(old
, "#address-cells", NULL
);
145 tnode
= of_get_parent(old
);
148 } while (old
&& tmp
== NULL
);
151 addrsize
= (tmp
== NULL
) ? 2 : be32_to_cpu(*tmp
);
153 pr_debug(" -> addrsize=%d\n", addrsize
);
155 /* Range check so that the temporary buffer doesn't overflow */
156 if (WARN_ON(addrsize
+ intsize
> MAX_PHANDLE_ARGS
)) {
161 /* Precalculate the match array - this simplifies match loop */
162 for (i
= 0; i
< addrsize
; i
++)
163 initial_match_array
[i
] = addr
? addr
[i
] : 0;
164 for (i
= 0; i
< intsize
; i
++)
165 initial_match_array
[addrsize
+ i
] = cpu_to_be32(out_irq
->args
[i
]);
167 /* Now start the actual "proper" walk of the interrupt tree */
168 while (ipar
!= NULL
) {
169 /* Now check if cursor is an interrupt-controller and if it is
172 if (of_get_property(ipar
, "interrupt-controller", NULL
) !=
174 pr_debug(" -> got it !\n");
179 * interrupt-map parsing does not work without a reg
180 * property when #address-cells != 0
182 if (addrsize
&& !addr
) {
183 pr_debug(" -> no reg passed in when needed !\n");
187 /* Now look for an interrupt-map */
188 imap
= of_get_property(ipar
, "interrupt-map", &imaplen
);
189 /* No interrupt map, check for an interrupt parent */
191 pr_debug(" -> no map, getting parent\n");
192 newpar
= of_irq_find_parent(ipar
);
195 imaplen
/= sizeof(u32
);
197 /* Look for a mask */
198 imask
= of_get_property(ipar
, "interrupt-map-mask", NULL
);
202 /* Parse interrupt-map */
204 while (imaplen
> (addrsize
+ intsize
+ 1) && !match
) {
205 /* Compare specifiers */
207 for (i
= 0; i
< (addrsize
+ intsize
); i
++, imaplen
--)
208 match
&= !((match_array
[i
] ^ *imap
++) & imask
[i
]);
210 pr_debug(" -> match=%d (imaplen=%d)\n", match
, imaplen
);
212 /* Get the interrupt parent */
213 if (of_irq_workarounds
& OF_IMAP_NO_PHANDLE
)
214 newpar
= of_node_get(of_irq_dflt_pic
);
216 newpar
= of_find_node_by_phandle(be32_to_cpup(imap
));
220 /* Check if not found */
221 if (newpar
== NULL
) {
222 pr_debug(" -> imap parent not found !\n");
226 if (!of_device_is_available(newpar
))
229 /* Get #interrupt-cells and #address-cells of new
232 tmp
= of_get_property(newpar
, "#interrupt-cells", NULL
);
234 pr_debug(" -> parent lacks #interrupt-cells!\n");
237 newintsize
= be32_to_cpu(*tmp
);
238 tmp
= of_get_property(newpar
, "#address-cells", NULL
);
239 newaddrsize
= (tmp
== NULL
) ? 0 : be32_to_cpu(*tmp
);
241 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
242 newintsize
, newaddrsize
);
244 /* Check for malformed properties */
245 if (WARN_ON(newaddrsize
+ newintsize
> MAX_PHANDLE_ARGS
)
246 || (imaplen
< (newaddrsize
+ newintsize
))) {
251 imap
+= newaddrsize
+ newintsize
;
252 imaplen
-= newaddrsize
+ newintsize
;
254 pr_debug(" -> imaplen=%d\n", imaplen
);
260 * Successfully parsed an interrrupt-map translation; copy new
261 * interrupt specifier into the out_irq structure
263 match_array
= imap
- newaddrsize
- newintsize
;
264 for (i
= 0; i
< newintsize
; i
++)
265 out_irq
->args
[i
] = be32_to_cpup(imap
- newintsize
+ i
);
266 out_irq
->args_count
= intsize
= newintsize
;
267 addrsize
= newaddrsize
;
270 /* Iterate again with new parent */
271 out_irq
->np
= newpar
;
272 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar
));
277 rc
= -ENOENT
; /* No interrupt-map found */
285 EXPORT_SYMBOL_GPL(of_irq_parse_raw
);
288 * of_irq_parse_one - Resolve an interrupt for a device
289 * @device: the device whose interrupt is to be resolved
290 * @index: index of the interrupt to resolve
291 * @out_irq: structure of_irq filled by this function
293 * This function resolves an interrupt for a node by walking the interrupt tree,
294 * finding which interrupt controller node it is attached to, and returning the
295 * interrupt specifier that can be used to retrieve a Linux IRQ number.
297 int of_irq_parse_one(struct device_node
*device
, int index
, struct of_phandle_args
*out_irq
)
299 struct device_node
*p
;
300 const __be32
*intspec
, *tmp
, *addr
;
304 pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device
), index
);
306 /* OldWorld mac stuff is "special", handle out of line */
307 if (of_irq_workarounds
& OF_IMAP_OLDWORLD_MAC
)
308 return of_irq_parse_oldworld(device
, index
, out_irq
);
310 /* Get the reg property (if any) */
311 addr
= of_get_property(device
, "reg", NULL
);
313 /* Try the new-style interrupts-extended first */
314 res
= of_parse_phandle_with_args(device
, "interrupts-extended",
315 "#interrupt-cells", index
, out_irq
);
317 return of_irq_parse_raw(addr
, out_irq
);
319 /* Get the interrupts property */
320 intspec
= of_get_property(device
, "interrupts", &intlen
);
324 intlen
/= sizeof(*intspec
);
326 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec
), intlen
);
328 /* Look for the interrupt parent. */
329 p
= of_irq_find_parent(device
);
333 /* Get size of interrupt specifier */
334 tmp
= of_get_property(p
, "#interrupt-cells", NULL
);
339 intsize
= be32_to_cpu(*tmp
);
341 pr_debug(" intsize=%d intlen=%d\n", intsize
, intlen
);
344 if ((index
+ 1) * intsize
> intlen
) {
349 /* Copy intspec into irq structure */
350 intspec
+= index
* intsize
;
352 out_irq
->args_count
= intsize
;
353 for (i
= 0; i
< intsize
; i
++)
354 out_irq
->args
[i
] = be32_to_cpup(intspec
++);
356 /* Check if there are any interrupt-map translations to process */
357 res
= of_irq_parse_raw(addr
, out_irq
);
362 EXPORT_SYMBOL_GPL(of_irq_parse_one
);
365 * of_irq_to_resource - Decode a node's IRQ and return it as a resource
366 * @dev: pointer to device tree node
367 * @index: zero-based index of the irq
368 * @r: pointer to resource structure to return result into.
370 int of_irq_to_resource(struct device_node
*dev
, int index
, struct resource
*r
)
372 int irq
= irq_of_parse_and_map(dev
, index
);
374 /* Only dereference the resource if both the
375 * resource and the irq are valid. */
377 const char *name
= NULL
;
379 memset(r
, 0, sizeof(*r
));
381 * Get optional "interrupt-names" property to add a name
384 of_property_read_string_index(dev
, "interrupt-names", index
,
387 r
->start
= r
->end
= irq
;
388 r
->flags
= IORESOURCE_IRQ
| irqd_get_trigger_type(irq_get_irq_data(irq
));
389 r
->name
= name
? name
: of_node_full_name(dev
);
394 EXPORT_SYMBOL_GPL(of_irq_to_resource
);
397 * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number
398 * @dev: pointer to device tree node
399 * @index: zero-based index of the IRQ
401 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
402 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
403 * of any other failure.
405 int of_irq_get(struct device_node
*dev
, int index
)
408 struct of_phandle_args oirq
;
409 struct irq_domain
*domain
;
411 rc
= of_irq_parse_one(dev
, index
, &oirq
);
415 domain
= irq_find_host(oirq
.np
);
417 return -EPROBE_DEFER
;
419 return irq_create_of_mapping(&oirq
);
421 EXPORT_SYMBOL_GPL(of_irq_get
);
424 * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number
425 * @dev: pointer to device tree node
428 * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
429 * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
430 * of any other failure.
432 int of_irq_get_byname(struct device_node
*dev
, const char *name
)
439 index
= of_property_match_string(dev
, "interrupt-names", name
);
443 return of_irq_get(dev
, index
);
445 EXPORT_SYMBOL_GPL(of_irq_get_byname
);
448 * of_irq_count - Count the number of IRQs a node uses
449 * @dev: pointer to device tree node
451 int of_irq_count(struct device_node
*dev
)
453 struct of_phandle_args irq
;
456 while (of_irq_parse_one(dev
, nr
, &irq
) == 0)
463 * of_irq_to_resource_table - Fill in resource table with node's IRQ info
464 * @dev: pointer to device tree node
465 * @res: array of resources to fill in
466 * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
468 * Returns the size of the filled in table (up to @nr_irqs).
470 int of_irq_to_resource_table(struct device_node
*dev
, struct resource
*res
,
475 for (i
= 0; i
< nr_irqs
; i
++, res
++)
476 if (!of_irq_to_resource(dev
, i
, res
))
481 EXPORT_SYMBOL_GPL(of_irq_to_resource_table
);
483 struct of_intc_desc
{
484 struct list_head list
;
485 of_irq_init_cb_t irq_init_cb
;
486 struct device_node
*dev
;
487 struct device_node
*interrupt_parent
;
491 * of_irq_init - Scan and init matching interrupt controllers in DT
492 * @matches: 0 terminated array of nodes to match and init function to call
494 * This function scans the device tree for matching interrupt controller nodes,
495 * and calls their initialization functions in order with parents first.
497 void __init
of_irq_init(const struct of_device_id
*matches
)
499 const struct of_device_id
*match
;
500 struct device_node
*np
, *parent
= NULL
;
501 struct of_intc_desc
*desc
, *temp_desc
;
502 struct list_head intc_desc_list
, intc_parent_list
;
504 INIT_LIST_HEAD(&intc_desc_list
);
505 INIT_LIST_HEAD(&intc_parent_list
);
507 for_each_matching_node_and_match(np
, matches
, &match
) {
508 if (!of_find_property(np
, "interrupt-controller", NULL
) ||
509 !of_device_is_available(np
))
512 if (WARN(!match
->data
, "of_irq_init: no init function for %s\n",
517 * Here, we allocate and populate an of_intc_desc with the node
518 * pointer, interrupt-parent device_node etc.
520 desc
= kzalloc(sizeof(*desc
), GFP_KERNEL
);
521 if (WARN_ON(!desc
)) {
526 desc
->irq_init_cb
= match
->data
;
527 desc
->dev
= of_node_get(np
);
528 desc
->interrupt_parent
= of_irq_find_parent(np
);
529 if (desc
->interrupt_parent
== np
)
530 desc
->interrupt_parent
= NULL
;
531 list_add_tail(&desc
->list
, &intc_desc_list
);
535 * The root irq controller is the one without an interrupt-parent.
536 * That one goes first, followed by the controllers that reference it,
537 * followed by the ones that reference the 2nd level controllers, etc.
539 while (!list_empty(&intc_desc_list
)) {
541 * Process all controllers with the current 'parent'.
542 * First pass will be looking for NULL as the parent.
543 * The assumption is that NULL parent means a root controller.
545 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
548 if (desc
->interrupt_parent
!= parent
)
551 list_del(&desc
->list
);
553 of_node_set_flag(desc
->dev
, OF_POPULATED
);
555 pr_debug("of_irq_init: init %s (%p), parent %p\n",
556 desc
->dev
->full_name
,
557 desc
->dev
, desc
->interrupt_parent
);
558 ret
= desc
->irq_init_cb(desc
->dev
,
559 desc
->interrupt_parent
);
561 of_node_clear_flag(desc
->dev
, OF_POPULATED
);
567 * This one is now set up; add it to the parent list so
568 * its children can get processed in a subsequent pass.
570 list_add_tail(&desc
->list
, &intc_parent_list
);
573 /* Get the next pending parent that might have children */
574 desc
= list_first_entry_or_null(&intc_parent_list
,
575 typeof(*desc
), list
);
577 pr_err("of_irq_init: children remain, but no parents\n");
580 list_del(&desc
->list
);
585 list_for_each_entry_safe(desc
, temp_desc
, &intc_parent_list
, list
) {
586 list_del(&desc
->list
);
590 list_for_each_entry_safe(desc
, temp_desc
, &intc_desc_list
, list
) {
591 list_del(&desc
->list
);
592 of_node_put(desc
->dev
);
597 static u32
__of_msi_map_rid(struct device
*dev
, struct device_node
**np
,
600 struct device
*parent_dev
;
601 u32 rid_out
= rid_in
;
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 (!of_pci_map_rid(parent_dev
->of_node
, rid_in
, "msi-map",
609 "msi-map-mask", np
, &rid_out
))
615 * of_msi_map_rid - Map a MSI requester ID for a device.
616 * @dev: device for which the mapping is to be done.
617 * @msi_np: device node of the expected msi controller.
618 * @rid_in: unmapped MSI requester ID for the device.
620 * Walk up the device hierarchy looking for devices with a "msi-map"
621 * property. If found, apply the mapping to @rid_in.
623 * Returns the mapped MSI requester ID.
625 u32
of_msi_map_rid(struct device
*dev
, struct device_node
*msi_np
, u32 rid_in
)
627 return __of_msi_map_rid(dev
, &msi_np
, rid_in
);
631 * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain
632 * @dev: device for which the mapping is to be done.
633 * @rid: Requester ID for the device.
635 * Walk up the device hierarchy looking for devices with a "msi-map"
638 * Returns: the MSI domain for this device (or NULL on failure)
640 struct irq_domain
*of_msi_map_get_device_domain(struct device
*dev
, u32 rid
)
642 struct device_node
*np
= NULL
;
644 __of_msi_map_rid(dev
, &np
, rid
);
645 return irq_find_matching_host(np
, DOMAIN_BUS_PCI_MSI
);
649 * of_msi_get_domain - Use msi-parent to find the relevant MSI domain
650 * @dev: device for which the domain is requested
651 * @np: device node for @dev
652 * @token: bus type for this domain
654 * Parse the msi-parent property (both the simple and the complex
655 * versions), and returns the corresponding MSI domain.
657 * Returns: the MSI domain for this device (or NULL on failure).
659 struct irq_domain
*of_msi_get_domain(struct device
*dev
,
660 struct device_node
*np
,
661 enum irq_domain_bus_token token
)
663 struct device_node
*msi_np
;
664 struct irq_domain
*d
;
666 /* Check for a single msi-parent property */
667 msi_np
= of_parse_phandle(np
, "msi-parent", 0);
668 if (msi_np
&& !of_property_read_bool(msi_np
, "#msi-cells")) {
669 d
= irq_find_matching_host(msi_np
, token
);
675 if (token
== DOMAIN_BUS_PLATFORM_MSI
) {
676 /* Check for the complex msi-parent version */
677 struct of_phandle_args args
;
680 while (!of_parse_phandle_with_args(np
, "msi-parent",
683 d
= irq_find_matching_host(args
.np
, token
);
687 of_node_put(args
.np
);
696 * of_msi_configure - Set the msi_domain field of a device
697 * @dev: device structure to associate with an MSI irq domain
698 * @np: device node for that device
700 void of_msi_configure(struct device
*dev
, struct device_node
*np
)
702 dev_set_msi_domain(dev
,
703 of_msi_get_domain(dev
, np
, DOMAIN_BUS_PLATFORM_MSI
));
705 EXPORT_SYMBOL_GPL(of_msi_configure
);