Loading...
1/*
2 * Derived from arch/i386/kernel/irq.c
3 * Copyright (C) 1992 Linus Torvalds
4 * Adapted from arch/i386 by Gary Thomas
5 * Copyright (C) 1995-1996 Gary Thomas (gdt@linuxppc.org)
6 * Updated and modified by Cort Dougan <cort@fsmlabs.com>
7 * Copyright (C) 1996-2001 Cort Dougan
8 * Adapted for Power Macintosh by Paul Mackerras
9 * Copyright (C) 1996 Paul Mackerras (paulus@cs.anu.edu.au)
10 *
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License
13 * as published by the Free Software Foundation; either version
14 * 2 of the License, or (at your option) any later version.
15 *
16 * This file contains the code used to make IRQ descriptions in the
17 * device tree to actual irq numbers on an interrupt controller
18 * driver.
19 */
20
21#include <linux/errno.h>
22#include <linux/list.h>
23#include <linux/module.h>
24#include <linux/of.h>
25#include <linux/of_irq.h>
26#include <linux/string.h>
27#include <linux/slab.h>
28
29/**
30 * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
31 * @device: Device node of the device whose interrupt is to be mapped
32 * @index: Index of the interrupt to map
33 *
34 * This function is a wrapper that chains of_irq_map_one() and
35 * irq_create_of_mapping() to make things easier to callers
36 */
37unsigned int irq_of_parse_and_map(struct device_node *dev, int index)
38{
39 struct of_irq oirq;
40
41 if (of_irq_map_one(dev, index, &oirq))
42 return 0;
43
44 return irq_create_of_mapping(oirq.controller, oirq.specifier,
45 oirq.size);
46}
47EXPORT_SYMBOL_GPL(irq_of_parse_and_map);
48
49/**
50 * of_irq_find_parent - Given a device node, find its interrupt parent node
51 * @child: pointer to device node
52 *
53 * Returns a pointer to the interrupt parent node, or NULL if the interrupt
54 * parent could not be determined.
55 */
56struct device_node *of_irq_find_parent(struct device_node *child)
57{
58 struct device_node *p;
59 const __be32 *parp;
60
61 if (!of_node_get(child))
62 return NULL;
63
64 do {
65 parp = of_get_property(child, "interrupt-parent", NULL);
66 if (parp == NULL)
67 p = of_get_parent(child);
68 else {
69 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
70 p = of_node_get(of_irq_dflt_pic);
71 else
72 p = of_find_node_by_phandle(be32_to_cpup(parp));
73 }
74 of_node_put(child);
75 child = p;
76 } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL);
77
78 return p;
79}
80
81/**
82 * of_irq_map_raw - Low level interrupt tree parsing
83 * @parent: the device interrupt parent
84 * @intspec: interrupt specifier ("interrupts" property of the device)
85 * @ointsize: size of the passed in interrupt specifier
86 * @addr: address specifier (start of "reg" property of the device)
87 * @out_irq: structure of_irq filled by this function
88 *
89 * Returns 0 on success and a negative number on error
90 *
91 * This function is a low-level interrupt tree walking function. It
92 * can be used to do a partial walk with synthetized reg and interrupts
93 * properties, for example when resolving PCI interrupts when no device
94 * node exist for the parent.
95 */
96int of_irq_map_raw(struct device_node *parent, const __be32 *intspec,
97 u32 ointsize, const __be32 *addr, struct of_irq *out_irq)
98{
99 struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
100 const __be32 *tmp, *imap, *imask;
101 u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
102 int imaplen, match, i;
103
104 pr_debug("of_irq_map_raw: par=%s,intspec=[0x%08x 0x%08x...],ointsize=%d\n",
105 parent->full_name, be32_to_cpup(intspec),
106 be32_to_cpup(intspec + 1), ointsize);
107
108 ipar = of_node_get(parent);
109
110 /* First get the #interrupt-cells property of the current cursor
111 * that tells us how to interpret the passed-in intspec. If there
112 * is none, we are nice and just walk up the tree
113 */
114 do {
115 tmp = of_get_property(ipar, "#interrupt-cells", NULL);
116 if (tmp != NULL) {
117 intsize = be32_to_cpu(*tmp);
118 break;
119 }
120 tnode = ipar;
121 ipar = of_irq_find_parent(ipar);
122 of_node_put(tnode);
123 } while (ipar);
124 if (ipar == NULL) {
125 pr_debug(" -> no parent found !\n");
126 goto fail;
127 }
128
129 pr_debug("of_irq_map_raw: ipar=%s, size=%d\n", ipar->full_name, intsize);
130
131 if (ointsize != intsize)
132 return -EINVAL;
133
134 /* Look for this #address-cells. We have to implement the old linux
135 * trick of looking for the parent here as some device-trees rely on it
136 */
137 old = of_node_get(ipar);
138 do {
139 tmp = of_get_property(old, "#address-cells", NULL);
140 tnode = of_get_parent(old);
141 of_node_put(old);
142 old = tnode;
143 } while (old && tmp == NULL);
144 of_node_put(old);
145 old = NULL;
146 addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp);
147
148 pr_debug(" -> addrsize=%d\n", addrsize);
149
150 /* Now start the actual "proper" walk of the interrupt tree */
151 while (ipar != NULL) {
152 /* Now check if cursor is an interrupt-controller and if it is
153 * then we are done
154 */
155 if (of_get_property(ipar, "interrupt-controller", NULL) !=
156 NULL) {
157 pr_debug(" -> got it !\n");
158 for (i = 0; i < intsize; i++)
159 out_irq->specifier[i] =
160 of_read_number(intspec +i, 1);
161 out_irq->size = intsize;
162 out_irq->controller = ipar;
163 of_node_put(old);
164 return 0;
165 }
166
167 /* Now look for an interrupt-map */
168 imap = of_get_property(ipar, "interrupt-map", &imaplen);
169 /* No interrupt map, check for an interrupt parent */
170 if (imap == NULL) {
171 pr_debug(" -> no map, getting parent\n");
172 newpar = of_irq_find_parent(ipar);
173 goto skiplevel;
174 }
175 imaplen /= sizeof(u32);
176
177 /* Look for a mask */
178 imask = of_get_property(ipar, "interrupt-map-mask", NULL);
179
180 /* If we were passed no "reg" property and we attempt to parse
181 * an interrupt-map, then #address-cells must be 0.
182 * Fail if it's not.
183 */
184 if (addr == NULL && addrsize != 0) {
185 pr_debug(" -> no reg passed in when needed !\n");
186 goto fail;
187 }
188
189 /* Parse interrupt-map */
190 match = 0;
191 while (imaplen > (addrsize + intsize + 1) && !match) {
192 /* Compare specifiers */
193 match = 1;
194 for (i = 0; i < addrsize && match; ++i) {
195 u32 mask = imask ? imask[i] : 0xffffffffu;
196 match = ((addr[i] ^ imap[i]) & mask) == 0;
197 }
198 for (; i < (addrsize + intsize) && match; ++i) {
199 u32 mask = imask ? imask[i] : 0xffffffffu;
200 match =
201 ((intspec[i-addrsize] ^ imap[i]) & mask) == 0;
202 }
203 imap += addrsize + intsize;
204 imaplen -= addrsize + intsize;
205
206 pr_debug(" -> match=%d (imaplen=%d)\n", match, imaplen);
207
208 /* Get the interrupt parent */
209 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
210 newpar = of_node_get(of_irq_dflt_pic);
211 else
212 newpar = of_find_node_by_phandle(be32_to_cpup(imap));
213 imap++;
214 --imaplen;
215
216 /* Check if not found */
217 if (newpar == NULL) {
218 pr_debug(" -> imap parent not found !\n");
219 goto fail;
220 }
221
222 /* Get #interrupt-cells and #address-cells of new
223 * parent
224 */
225 tmp = of_get_property(newpar, "#interrupt-cells", NULL);
226 if (tmp == NULL) {
227 pr_debug(" -> parent lacks #interrupt-cells!\n");
228 goto fail;
229 }
230 newintsize = be32_to_cpu(*tmp);
231 tmp = of_get_property(newpar, "#address-cells", NULL);
232 newaddrsize = (tmp == NULL) ? 0 : be32_to_cpu(*tmp);
233
234 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
235 newintsize, newaddrsize);
236
237 /* Check for malformed properties */
238 if (imaplen < (newaddrsize + newintsize))
239 goto fail;
240
241 imap += newaddrsize + newintsize;
242 imaplen -= newaddrsize + newintsize;
243
244 pr_debug(" -> imaplen=%d\n", imaplen);
245 }
246 if (!match)
247 goto fail;
248
249 of_node_put(old);
250 old = of_node_get(newpar);
251 addrsize = newaddrsize;
252 intsize = newintsize;
253 intspec = imap - intsize;
254 addr = intspec - addrsize;
255
256 skiplevel:
257 /* Iterate again with new parent */
258 pr_debug(" -> new parent: %s\n", newpar ? newpar->full_name : "<>");
259 of_node_put(ipar);
260 ipar = newpar;
261 newpar = NULL;
262 }
263 fail:
264 of_node_put(ipar);
265 of_node_put(old);
266 of_node_put(newpar);
267
268 return -EINVAL;
269}
270EXPORT_SYMBOL_GPL(of_irq_map_raw);
271
272/**
273 * of_irq_map_one - Resolve an interrupt for a device
274 * @device: the device whose interrupt is to be resolved
275 * @index: index of the interrupt to resolve
276 * @out_irq: structure of_irq filled by this function
277 *
278 * This function resolves an interrupt, walking the tree, for a given
279 * device-tree node. It's the high level pendant to of_irq_map_raw().
280 */
281int of_irq_map_one(struct device_node *device, int index, struct of_irq *out_irq)
282{
283 struct device_node *p;
284 const __be32 *intspec, *tmp, *addr;
285 u32 intsize, intlen;
286 int res = -EINVAL;
287
288 pr_debug("of_irq_map_one: dev=%s, index=%d\n", device->full_name, index);
289
290 /* OldWorld mac stuff is "special", handle out of line */
291 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
292 return of_irq_map_oldworld(device, index, out_irq);
293
294 /* Get the interrupts property */
295 intspec = of_get_property(device, "interrupts", &intlen);
296 if (intspec == NULL)
297 return -EINVAL;
298 intlen /= sizeof(*intspec);
299
300 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec), intlen);
301
302 /* Get the reg property (if any) */
303 addr = of_get_property(device, "reg", NULL);
304
305 /* Look for the interrupt parent. */
306 p = of_irq_find_parent(device);
307 if (p == NULL)
308 return -EINVAL;
309
310 /* Get size of interrupt specifier */
311 tmp = of_get_property(p, "#interrupt-cells", NULL);
312 if (tmp == NULL)
313 goto out;
314 intsize = be32_to_cpu(*tmp);
315
316 pr_debug(" intsize=%d intlen=%d\n", intsize, intlen);
317
318 /* Check index */
319 if ((index + 1) * intsize > intlen)
320 goto out;
321
322 /* Get new specifier and map it */
323 res = of_irq_map_raw(p, intspec + index * intsize, intsize,
324 addr, out_irq);
325 out:
326 of_node_put(p);
327 return res;
328}
329EXPORT_SYMBOL_GPL(of_irq_map_one);
330
331/**
332 * of_irq_to_resource - Decode a node's IRQ and return it as a resource
333 * @dev: pointer to device tree node
334 * @index: zero-based index of the irq
335 * @r: pointer to resource structure to return result into.
336 */
337int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
338{
339 int irq = irq_of_parse_and_map(dev, index);
340
341 /* Only dereference the resource if both the
342 * resource and the irq are valid. */
343 if (r && irq) {
344 const char *name = NULL;
345
346 /*
347 * Get optional "interrupts-names" property to add a name
348 * to the resource.
349 */
350 of_property_read_string_index(dev, "interrupt-names", index,
351 &name);
352
353 r->start = r->end = irq;
354 r->flags = IORESOURCE_IRQ;
355 r->name = name ? name : dev->full_name;
356 }
357
358 return irq;
359}
360EXPORT_SYMBOL_GPL(of_irq_to_resource);
361
362/**
363 * of_irq_count - Count the number of IRQs a node uses
364 * @dev: pointer to device tree node
365 */
366int of_irq_count(struct device_node *dev)
367{
368 int nr = 0;
369
370 while (of_irq_to_resource(dev, nr, NULL))
371 nr++;
372
373 return nr;
374}
375
376/**
377 * of_irq_to_resource_table - Fill in resource table with node's IRQ info
378 * @dev: pointer to device tree node
379 * @res: array of resources to fill in
380 * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
381 *
382 * Returns the size of the filled in table (up to @nr_irqs).
383 */
384int of_irq_to_resource_table(struct device_node *dev, struct resource *res,
385 int nr_irqs)
386{
387 int i;
388
389 for (i = 0; i < nr_irqs; i++, res++)
390 if (!of_irq_to_resource(dev, i, res))
391 break;
392
393 return i;
394}
395
396struct intc_desc {
397 struct list_head list;
398 struct device_node *dev;
399 struct device_node *interrupt_parent;
400};
401
402/**
403 * of_irq_init - Scan and init matching interrupt controllers in DT
404 * @matches: 0 terminated array of nodes to match and init function to call
405 *
406 * This function scans the device tree for matching interrupt controller nodes,
407 * and calls their initialization functions in order with parents first.
408 */
409void __init of_irq_init(const struct of_device_id *matches)
410{
411 struct device_node *np, *parent = NULL;
412 struct intc_desc *desc, *temp_desc;
413 struct list_head intc_desc_list, intc_parent_list;
414
415 INIT_LIST_HEAD(&intc_desc_list);
416 INIT_LIST_HEAD(&intc_parent_list);
417
418 for_each_matching_node(np, matches) {
419 if (!of_find_property(np, "interrupt-controller", NULL))
420 continue;
421 /*
422 * Here, we allocate and populate an intc_desc with the node
423 * pointer, interrupt-parent device_node etc.
424 */
425 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
426 if (WARN_ON(!desc))
427 goto err;
428
429 desc->dev = np;
430 desc->interrupt_parent = of_irq_find_parent(np);
431 if (desc->interrupt_parent == np)
432 desc->interrupt_parent = NULL;
433 list_add_tail(&desc->list, &intc_desc_list);
434 }
435
436 /*
437 * The root irq controller is the one without an interrupt-parent.
438 * That one goes first, followed by the controllers that reference it,
439 * followed by the ones that reference the 2nd level controllers, etc.
440 */
441 while (!list_empty(&intc_desc_list)) {
442 /*
443 * Process all controllers with the current 'parent'.
444 * First pass will be looking for NULL as the parent.
445 * The assumption is that NULL parent means a root controller.
446 */
447 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
448 const struct of_device_id *match;
449 int ret;
450 of_irq_init_cb_t irq_init_cb;
451
452 if (desc->interrupt_parent != parent)
453 continue;
454
455 list_del(&desc->list);
456 match = of_match_node(matches, desc->dev);
457 if (WARN(!match->data,
458 "of_irq_init: no init function for %s\n",
459 match->compatible)) {
460 kfree(desc);
461 continue;
462 }
463
464 pr_debug("of_irq_init: init %s @ %p, parent %p\n",
465 match->compatible,
466 desc->dev, desc->interrupt_parent);
467 irq_init_cb = match->data;
468 ret = irq_init_cb(desc->dev, desc->interrupt_parent);
469 if (ret) {
470 kfree(desc);
471 continue;
472 }
473
474 /*
475 * This one is now set up; add it to the parent list so
476 * its children can get processed in a subsequent pass.
477 */
478 list_add_tail(&desc->list, &intc_parent_list);
479 }
480
481 /* Get the next pending parent that might have children */
482 desc = list_first_entry(&intc_parent_list, typeof(*desc), list);
483 if (list_empty(&intc_parent_list) || !desc) {
484 pr_err("of_irq_init: children remain, but no parents\n");
485 break;
486 }
487 list_del(&desc->list);
488 parent = desc->dev;
489 kfree(desc);
490 }
491
492 list_for_each_entry_safe(desc, temp_desc, &intc_parent_list, list) {
493 list_del(&desc->list);
494 kfree(desc);
495 }
496err:
497 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
498 list_del(&desc->list);
499 kfree(desc);
500 }
501}
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}