blob: 706e3ff67f8b02f4403a841c8b92f66f3c0e5678 [file] [log] [blame]
Grant Likelye3873442010-06-18 11:09:59 -06001/*
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
Marc Zyngierc706c232015-07-28 14:46:15 +010021#include <linux/device.h>
Grant Likelye3873442010-06-18 11:09:59 -060022#include <linux/errno.h>
Rob Herringc71a54b2011-09-20 15:13:50 -050023#include <linux/list.h>
Grant Likelye3873442010-06-18 11:09:59 -060024#include <linux/module.h>
25#include <linux/of.h>
26#include <linux/of_irq.h>
27#include <linux/string.h>
Rob Herringc71a54b2011-09-20 15:13:50 -050028#include <linux/slab.h>
Grant Likelye3873442010-06-18 11:09:59 -060029
30/**
31 * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
Yijing Wangd84ff462013-08-31 09:44:10 +080032 * @dev: Device node of the device whose interrupt is to be mapped
Grant Likelye3873442010-06-18 11:09:59 -060033 * @index: Index of the interrupt to map
34 *
Grant Likely0c02c802013-09-19 11:22:36 -050035 * This function is a wrapper that chains of_irq_parse_one() and
Grant Likelye3873442010-06-18 11:09:59 -060036 * 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{
Grant Likely530210c2013-09-15 16:39:11 +010040 struct of_phandle_args oirq;
Grant Likelye3873442010-06-18 11:09:59 -060041
Grant Likely0c02c802013-09-19 11:22:36 -050042 if (of_irq_parse_one(dev, index, &oirq))
Anton Vorontsov77a73002011-12-07 03:16:26 +040043 return 0;
Grant Likelye3873442010-06-18 11:09:59 -060044
Grant Likelye6d30ab2013-09-15 16:55:53 +010045 return irq_create_of_mapping(&oirq);
Grant Likelye3873442010-06-18 11:09:59 -060046}
47EXPORT_SYMBOL_GPL(irq_of_parse_and_map);
Grant Likely7dc2e112010-06-08 07:48:06 -060048
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 */
Carlo Caione4c3141e2015-12-01 17:24:17 +010056struct device_node *of_irq_find_parent(struct device_node *child)
Grant Likely7dc2e112010-06-08 07:48:06 -060057{
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080058 struct device_node *p;
Grant Likely9a6b2e52010-07-23 01:48:25 -060059 const __be32 *parp;
Grant Likely7dc2e112010-06-08 07:48:06 -060060
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080061 if (!of_node_get(child))
Grant Likely7dc2e112010-06-08 07:48:06 -060062 return NULL;
63
64 do {
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080065 parp = of_get_property(child, "interrupt-parent", NULL);
Grant Likely7dc2e112010-06-08 07:48:06 -060066 if (parp == NULL)
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080067 p = of_get_parent(child);
Grant Likely7dc2e112010-06-08 07:48:06 -060068 else {
69 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
70 p = of_node_get(of_irq_dflt_pic);
71 else
Grant Likely9a6b2e52010-07-23 01:48:25 -060072 p = of_find_node_by_phandle(be32_to_cpup(parp));
Grant Likely7dc2e112010-06-08 07:48:06 -060073 }
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080074 of_node_put(child);
75 child = p;
Grant Likely7dc2e112010-06-08 07:48:06 -060076 } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL);
77
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080078 return p;
Grant Likely7dc2e112010-06-08 07:48:06 -060079}
Carlo Caione4c3141e2015-12-01 17:24:17 +010080EXPORT_SYMBOL_GPL(of_irq_find_parent);
Grant Likely7dc2e112010-06-08 07:48:06 -060081
82/**
Grant Likely0c02c802013-09-19 11:22:36 -050083 * of_irq_parse_raw - Low level interrupt tree parsing
Grant Likely7dc2e112010-06-08 07:48:06 -060084 * @parent: the device interrupt parent
Grant Likely23616132013-09-15 22:32:39 +010085 * @addr: address specifier (start of "reg" property of the device) in be32 format
86 * @out_irq: structure of_irq updated by this function
Grant Likely7dc2e112010-06-08 07:48:06 -060087 *
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
Grant Likely23616132013-09-15 22:32:39 +010093 * 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.
Grant Likely7dc2e112010-06-08 07:48:06 -060096 */
Grant Likely23616132013-09-15 22:32:39 +010097int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq)
Grant Likely7dc2e112010-06-08 07:48:06 -060098{
99 struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
Grant Likely355e62f2013-11-02 00:11:02 -0700100 __be32 initial_match_array[MAX_PHANDLE_ARGS];
Grant Likely23616132013-09-15 22:32:39 +0100101 const __be32 *match_array = initial_match_array;
Grant Likely355e62f2013-11-02 00:11:02 -0700102 const __be32 *tmp, *imap, *imask, dummy_imask[] = { [0 ... MAX_PHANDLE_ARGS] = ~0 };
Grant Likely7dc2e112010-06-08 07:48:06 -0600103 u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
104 int imaplen, match, i;
105
Grant Likely624cfca2013-10-11 22:05:10 +0100106#ifdef DEBUG
107 of_print_phandle_args("of_irq_parse_raw: ", out_irq);
108#endif
Grant Likely7dc2e112010-06-08 07:48:06 -0600109
Grant Likely23616132013-09-15 22:32:39 +0100110 ipar = of_node_get(out_irq->np);
Grant Likely7dc2e112010-06-08 07:48:06 -0600111
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) {
Rob Herringa7c194b2010-06-08 07:48:08 -0600119 intsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600120 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
Grant Likely0c02c802013-09-19 11:22:36 -0500131 pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar), intsize);
Grant Likely7dc2e112010-06-08 07:48:06 -0600132
Grant Likely23616132013-09-15 22:32:39 +0100133 if (out_irq->args_count != intsize)
Grant Likely7dc2e112010-06-08 07:48:06 -0600134 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;
Rob Herringa7c194b2010-06-08 07:48:08 -0600148 addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600149
150 pr_debug(" -> addrsize=%d\n", addrsize);
151
Grant Likely355e62f2013-11-02 00:11:02 -0700152 /* Range check so that the temporary buffer doesn't overflow */
153 if (WARN_ON(addrsize + intsize > MAX_PHANDLE_ARGS))
154 goto fail;
155
Grant Likely23616132013-09-15 22:32:39 +0100156 /* Precalculate the match array - this simplifies match loop */
157 for (i = 0; i < addrsize; i++)
Grant Likely78119fd2013-11-01 10:50:50 -0700158 initial_match_array[i] = addr ? addr[i] : 0;
Grant Likely23616132013-09-15 22:32:39 +0100159 for (i = 0; i < intsize; i++)
160 initial_match_array[addrsize + i] = cpu_to_be32(out_irq->args[i]);
161
Grant Likely7dc2e112010-06-08 07:48:06 -0600162 /* 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");
Grant Likely7dc2e112010-06-08 07:48:06 -0600170 return 0;
171 }
172
Grant Likely78119fd2013-11-01 10:50:50 -0700173 /*
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
Grant Likely7dc2e112010-06-08 07:48:06 -0600182 /* 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);
Grant Likely23616132013-09-15 22:32:39 +0100194 if (!imask)
195 imask = dummy_imask;
Grant Likely7dc2e112010-06-08 07:48:06 -0600196
197 /* Parse interrupt-map */
198 match = 0;
199 while (imaplen > (addrsize + intsize + 1) && !match) {
200 /* Compare specifiers */
201 match = 1;
Grant Likely23616132013-09-15 22:32:39 +0100202 for (i = 0; i < (addrsize + intsize); i++, imaplen--)
Tomasz Figa74dac2e2013-11-05 16:21:18 +0100203 match &= !((match_array[i] ^ *imap++) & imask[i]);
Grant Likely7dc2e112010-06-08 07:48:06 -0600204
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
Grant Likely9a6b2e52010-07-23 01:48:25 -0600211 newpar = of_find_node_by_phandle(be32_to_cpup(imap));
Grant Likely7dc2e112010-06-08 07:48:06 -0600212 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
Peter Crosthwaite1ca56e72013-11-27 23:26:12 -0800221 if (!of_device_is_available(newpar))
222 match = 0;
223
Grant Likely7dc2e112010-06-08 07:48:06 -0600224 /* 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 }
Rob Herringa7c194b2010-06-08 07:48:08 -0600232 newintsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600233 tmp = of_get_property(newpar, "#address-cells", NULL);
Rob Herringa7c194b2010-06-08 07:48:08 -0600234 newaddrsize = (tmp == NULL) ? 0 : be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600235
236 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
237 newintsize, newaddrsize);
238
239 /* Check for malformed properties */
Grant Likely355e62f2013-11-02 00:11:02 -0700240 if (WARN_ON(newaddrsize + newintsize > MAX_PHANDLE_ARGS))
241 goto fail;
Grant Likely7dc2e112010-06-08 07:48:06 -0600242 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
Grant Likely23616132013-09-15 22:32:39 +0100253 /*
254 * Successfully parsed an interrrupt-map translation; copy new
255 * interrupt specifier into the out_irq structure
256 */
Grant Likely23616132013-09-15 22:32:39 +0100257 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;
Grant Likely7dc2e112010-06-08 07:48:06 -0600261 addrsize = newaddrsize;
Grant Likely7dc2e112010-06-08 07:48:06 -0600262
263 skiplevel:
264 /* Iterate again with new parent */
Jeremy Lintond23b2512015-06-29 18:50:55 -0500265 out_irq->np = newpar;
Grant Likely74a7f082012-06-15 11:50:25 -0600266 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar));
Grant Likely7dc2e112010-06-08 07:48:06 -0600267 of_node_put(ipar);
268 ipar = newpar;
269 newpar = NULL;
270 }
271 fail:
272 of_node_put(ipar);
Grant Likely7dc2e112010-06-08 07:48:06 -0600273 of_node_put(newpar);
274
275 return -EINVAL;
276}
Grant Likely0c02c802013-09-19 11:22:36 -0500277EXPORT_SYMBOL_GPL(of_irq_parse_raw);
Grant Likely7dc2e112010-06-08 07:48:06 -0600278
279/**
Grant Likely0c02c802013-09-19 11:22:36 -0500280 * of_irq_parse_one - Resolve an interrupt for a device
Grant Likely7dc2e112010-06-08 07:48:06 -0600281 * @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 *
Grant Likely23616132013-09-15 22:32:39 +0100285 * 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.
Grant Likely7dc2e112010-06-08 07:48:06 -0600288 */
Grant Likely530210c2013-09-15 16:39:11 +0100289int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq)
Grant Likely7dc2e112010-06-08 07:48:06 -0600290{
291 struct device_node *p;
Grant Likelyd2f71832010-07-23 16:56:19 -0600292 const __be32 *intspec, *tmp, *addr;
Grant Likely7dc2e112010-06-08 07:48:06 -0600293 u32 intsize, intlen;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200294 int i, res;
Grant Likely7dc2e112010-06-08 07:48:06 -0600295
Grant Likely0c02c802013-09-19 11:22:36 -0500296 pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device), index);
Grant Likely7dc2e112010-06-08 07:48:06 -0600297
298 /* OldWorld mac stuff is "special", handle out of line */
299 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
Grant Likely0c02c802013-09-19 11:22:36 -0500300 return of_irq_parse_oldworld(device, index, out_irq);
Grant Likely7dc2e112010-06-08 07:48:06 -0600301
Grant Likely79d97012013-09-19 16:47:37 -0500302 /* Get the reg property (if any) */
303 addr = of_get_property(device, "reg", NULL);
304
Florian Fainellia9ecdc02014-08-06 13:02:27 -0700305 /* 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
Grant Likely7dc2e112010-06-08 07:48:06 -0600311 /* Get the interrupts property */
312 intspec = of_get_property(device, "interrupts", &intlen);
Florian Fainellia9ecdc02014-08-06 13:02:27 -0700313 if (intspec == NULL)
314 return -EINVAL;
315
Grant Likelyd2f71832010-07-23 16:56:19 -0600316 intlen /= sizeof(*intspec);
Grant Likely7dc2e112010-06-08 07:48:06 -0600317
Grant Likelyd2f71832010-07-23 16:56:19 -0600318 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec), intlen);
Grant Likely7dc2e112010-06-08 07:48:06 -0600319
Grant Likely7dc2e112010-06-08 07:48:06 -0600320 /* 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);
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200327 if (tmp == NULL) {
328 res = -EINVAL;
Grant Likely7dc2e112010-06-08 07:48:06 -0600329 goto out;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200330 }
Rob Herringa7c194b2010-06-08 07:48:08 -0600331 intsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600332
333 pr_debug(" intsize=%d intlen=%d\n", intsize, intlen);
334
335 /* Check index */
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200336 if ((index + 1) * intsize > intlen) {
337 res = -EINVAL;
Grant Likely7dc2e112010-06-08 07:48:06 -0600338 goto out;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200339 }
Grant Likely7dc2e112010-06-08 07:48:06 -0600340
Grant Likely23616132013-09-15 22:32:39 +0100341 /* 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);
Grant Likely7dc2e112010-06-08 07:48:06 -0600350 out:
351 of_node_put(p);
352 return res;
353}
Grant Likely0c02c802013-09-19 11:22:36 -0500354EXPORT_SYMBOL_GPL(of_irq_parse_one);
Grant Likely7dc2e112010-06-08 07:48:06 -0600355
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. */
Anton Vorontsov77a73002011-12-07 03:16:26 +0400368 if (r && irq) {
Benoit Cousson661db792011-12-05 15:23:56 +0100369 const char *name = NULL;
370
Sebastian Andrzej Siewiorcf9e2362013-07-18 12:24:10 +0200371 memset(r, 0, sizeof(*r));
Benoit Cousson661db792011-12-05 15:23:56 +0100372 /*
Geert Uytterhoevenae107d02014-04-22 20:40:25 +0200373 * Get optional "interrupt-names" property to add a name
Benoit Cousson661db792011-12-05 15:23:56 +0100374 * to the resource.
375 */
376 of_property_read_string_index(dev, "interrupt-names", index,
377 &name);
378
Grant Likely7dc2e112010-06-08 07:48:06 -0600379 r->start = r->end = irq;
Tomasz Figa4a43d682013-09-28 19:52:51 +0200380 r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq));
Grant Likely88048272013-09-19 11:01:52 -0500381 r->name = name ? name : of_node_full_name(dev);
Grant Likely7dc2e112010-06-08 07:48:06 -0600382 }
383
384 return irq;
385}
386EXPORT_SYMBOL_GPL(of_irq_to_resource);
Andres Salomon52f65372010-10-10 21:35:05 -0600387
388/**
Rob Herring9ec36ca2014-04-23 17:57:41 -0500389 * 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}
Laurent Pinchart9eb08fb2014-10-30 15:59:36 +0200413EXPORT_SYMBOL_GPL(of_irq_get);
Rob Herring9ec36ca2014-04-23 17:57:41 -0500414
415/**
Grygorii Strashkoad696742014-05-20 13:42:02 +0300416 * 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}
Dmitry Torokhov6602c452015-08-25 17:04:02 -0700436EXPORT_SYMBOL_GPL(of_irq_get_byname);
Grygorii Strashkoad696742014-05-20 13:42:02 +0300437
438/**
Andres Salomon52f65372010-10-10 21:35:05 -0600439 * 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{
Thierry Reding3da52782013-09-18 15:24:43 +0200444 struct of_phandle_args irq;
Andres Salomon52f65372010-10-10 21:35:05 -0600445 int nr = 0;
446
Thierry Reding3da52782013-09-18 15:24:43 +0200447 while (of_irq_parse_one(dev, nr, &irq) == 0)
Andres Salomon52f65372010-10-10 21:35:05 -0600448 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++)
Anton Vorontsov77a73002011-12-07 03:16:26 +0400467 if (!of_irq_to_resource(dev, i, res))
Andres Salomon52f65372010-10-10 21:35:05 -0600468 break;
469
470 return i;
471}
John Crispina4f8bf22012-08-26 09:13:09 +0200472EXPORT_SYMBOL_GPL(of_irq_to_resource_table);
Rob Herringc71a54b2011-09-20 15:13:50 -0500473
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200474struct of_intc_desc {
Rob Herringc71a54b2011-09-20 15:13:50 -0500475 struct list_head list;
Masahiro Yamada264041e2015-11-24 22:10:26 +0900476 of_irq_init_cb_t irq_init_cb;
Rob Herringc71a54b2011-09-20 15:13:50 -0500477 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{
Masahiro Yamada264041e2015-11-24 22:10:26 +0900490 const struct of_device_id *match;
Rob Herringc71a54b2011-09-20 15:13:50 -0500491 struct device_node *np, *parent = NULL;
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200492 struct of_intc_desc *desc, *temp_desc;
Rob Herringc71a54b2011-09-20 15:13:50 -0500493 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
Masahiro Yamada264041e2015-11-24 22:10:26 +0900498 for_each_matching_node_and_match(np, matches, &match) {
Peter Crosthwaitebf49be02013-11-27 23:26:13 -0800499 if (!of_find_property(np, "interrupt-controller", NULL) ||
500 !of_device_is_available(np))
Rob Herringc71a54b2011-09-20 15:13:50 -0500501 continue;
Masahiro Yamada264041e2015-11-24 22:10:26 +0900502
503 if (WARN(!match->data, "of_irq_init: no init function for %s\n",
504 match->compatible))
505 continue;
506
Rob Herringc71a54b2011-09-20 15:13:50 -0500507 /*
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200508 * Here, we allocate and populate an of_intc_desc with the node
Rob Herringc71a54b2011-09-20 15:13:50 -0500509 * pointer, interrupt-parent device_node etc.
510 */
511 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
Julia Lawall8363ccb2015-10-22 11:02:51 +0200512 if (WARN_ON(!desc)) {
513 of_node_put(np);
Rob Herringc71a54b2011-09-20 15:13:50 -0500514 goto err;
Julia Lawall8363ccb2015-10-22 11:02:51 +0200515 }
Rob Herringc71a54b2011-09-20 15:13:50 -0500516
Masahiro Yamada264041e2015-11-24 22:10:26 +0900517 desc->irq_init_cb = match->data;
Julia Lawall8363ccb2015-10-22 11:02:51 +0200518 desc->dev = of_node_get(np);
Rob Herringc71a54b2011-09-20 15:13:50 -0500519 desc->interrupt_parent = of_irq_find_parent(np);
Rob Herringd7fb6d02011-11-27 20:16:33 -0600520 if (desc->interrupt_parent == np)
521 desc->interrupt_parent = NULL;
Rob Herringc71a54b2011-09-20 15:13:50 -0500522 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) {
Rob Herringc71a54b2011-09-20 15:13:50 -0500537 int ret;
Rob Herringc71a54b2011-09-20 15:13:50 -0500538
539 if (desc->interrupt_parent != parent)
540 continue;
541
542 list_del(&desc->list);
Rob Herringc71a54b2011-09-20 15:13:50 -0500543
Masahiro Yamada264041e2015-11-24 22:10:26 +0900544 pr_debug("of_irq_init: init %s (%p), parent %p\n",
545 desc->dev->full_name,
Rob Herringc71a54b2011-09-20 15:13:50 -0500546 desc->dev, desc->interrupt_parent);
Masahiro Yamada264041e2015-11-24 22:10:26 +0900547 ret = desc->irq_init_cb(desc->dev,
548 desc->interrupt_parent);
Rob Herringc71a54b2011-09-20 15:13:50 -0500549 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 */
Axel Linc0cdfaa2013-06-23 15:50:07 +0800562 desc = list_first_entry_or_null(&intc_parent_list,
563 typeof(*desc), list);
564 if (!desc) {
Rob Herringc71a54b2011-09-20 15:13:50 -0500565 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);
Julia Lawall8363ccb2015-10-22 11:02:51 +0200580 of_node_put(desc->dev);
Rob Herringc71a54b2011-09-20 15:13:50 -0500581 kfree(desc);
582 }
583}
Marc Zyngierc706c232015-07-28 14:46:15 +0100584
Marc Zyngiera251b262015-10-01 17:05:45 +0100585static u32 __of_msi_map_rid(struct device *dev, struct device_node **np,
586 u32 rid_in)
David Daney8db02d82015-10-08 15:10:48 -0700587{
588 struct device *parent_dev;
589 struct device_node *msi_controller_node;
Marc Zyngiera251b262015-10-01 17:05:45 +0100590 struct device_node *msi_np = *np;
David Daney8db02d82015-10-08 15:10:48 -0700591 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 msi_controller_node = of_find_node_by_phandle(phandle);
639
Marc Zyngiera251b262015-10-01 17:05:45 +0100640 matched = (masked_rid >= rid_base &&
641 masked_rid < rid_base + rid_len);
642 if (msi_np)
643 matched &= msi_np == msi_controller_node;
644
645 if (matched && !msi_np) {
646 *np = msi_np = msi_controller_node;
647 break;
648 }
David Daney8db02d82015-10-08 15:10:48 -0700649
650 of_node_put(msi_controller_node);
651 msi_map_len -= 4 * sizeof(__be32);
652 msi_map += 4;
653 }
654 if (!matched)
655 return rid_out;
656
657 rid_out = masked_rid + msi_base;
658 dev_dbg(dev,
659 "msi-map at: %s, using mask %08x, rid-base: %08x, msi-base: %08x, length: %08x, rid: %08x -> %08x\n",
660 dev_name(parent_dev), map_mask, rid_base, msi_base,
661 rid_len, rid_in, rid_out);
662
663 return rid_out;
664}
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100665
Marc Zyngiera251b262015-10-01 17:05:45 +0100666/**
667 * of_msi_map_rid - Map a MSI requester ID for a device.
668 * @dev: device for which the mapping is to be done.
669 * @msi_np: device node of the expected msi controller.
670 * @rid_in: unmapped MSI requester ID for the device.
671 *
672 * Walk up the device hierarchy looking for devices with a "msi-map"
673 * property. If found, apply the mapping to @rid_in.
674 *
675 * Returns the mapped MSI requester ID.
676 */
677u32 of_msi_map_rid(struct device *dev, struct device_node *msi_np, u32 rid_in)
678{
679 return __of_msi_map_rid(dev, &msi_np, rid_in);
680}
681
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100682static struct irq_domain *__of_get_msi_domain(struct device_node *np,
683 enum irq_domain_bus_token token)
684{
685 struct irq_domain *d;
686
687 d = irq_find_matching_host(np, token);
688 if (!d)
689 d = irq_find_host(np);
690
691 return d;
692}
693
694/**
Marc Zyngier82b9b422015-10-02 14:38:55 +0100695 * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain
696 * @dev: device for which the mapping is to be done.
697 * @rid: Requester ID for the device.
698 *
699 * Walk up the device hierarchy looking for devices with a "msi-map"
700 * property.
701 *
702 * Returns: the MSI domain for this device (or NULL on failure)
703 */
704struct irq_domain *of_msi_map_get_device_domain(struct device *dev, u32 rid)
705{
706 struct device_node *np = NULL;
707
708 __of_msi_map_rid(dev, &np, rid);
709 return __of_get_msi_domain(np, DOMAIN_BUS_PCI_MSI);
710}
711
712/**
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100713 * of_msi_get_domain - Use msi-parent to find the relevant MSI domain
714 * @dev: device for which the domain is requested
715 * @np: device node for @dev
716 * @token: bus type for this domain
717 *
718 * Parse the msi-parent property (both the simple and the complex
719 * versions), and returns the corresponding MSI domain.
720 *
721 * Returns: the MSI domain for this device (or NULL on failure).
722 */
723struct irq_domain *of_msi_get_domain(struct device *dev,
724 struct device_node *np,
725 enum irq_domain_bus_token token)
726{
727 struct device_node *msi_np;
728 struct irq_domain *d;
729
730 /* Check for a single msi-parent property */
731 msi_np = of_parse_phandle(np, "msi-parent", 0);
732 if (msi_np && !of_property_read_bool(msi_np, "#msi-cells")) {
733 d = __of_get_msi_domain(msi_np, token);
734 if (!d)
735 of_node_put(msi_np);
736 return d;
737 }
738
739 if (token == DOMAIN_BUS_PLATFORM_MSI) {
740 /* Check for the complex msi-parent version */
741 struct of_phandle_args args;
742 int index = 0;
743
744 while (!of_parse_phandle_with_args(np, "msi-parent",
745 "#msi-cells",
746 index, &args)) {
747 d = __of_get_msi_domain(args.np, token);
748 if (d)
749 return d;
750
751 of_node_put(args.np);
752 index++;
753 }
754 }
755
756 return NULL;
757}
Marc Zyngier61c08242015-09-18 14:07:40 +0100758
759/**
760 * of_msi_configure - Set the msi_domain field of a device
761 * @dev: device structure to associate with an MSI irq domain
762 * @np: device node for that device
763 */
764void of_msi_configure(struct device *dev, struct device_node *np)
765{
766 dev_set_msi_domain(dev,
767 of_msi_get_domain(dev, np, DOMAIN_BUS_PLATFORM_MSI));
768}