blob: 89a71c6074fc9d23fbc3dc2ac5bed7e4d69ce49b [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
Rob Herring606ad422016-06-15 08:32:18 -050021#define pr_fmt(fmt) "OF: " fmt
22
Marc Zyngierc706c232015-07-28 14:46:15 +010023#include <linux/device.h>
Grant Likelye3873442010-06-18 11:09:59 -060024#include <linux/errno.h>
Rob Herringc71a54b2011-09-20 15:13:50 -050025#include <linux/list.h>
Grant Likelye3873442010-06-18 11:09:59 -060026#include <linux/module.h>
27#include <linux/of.h>
28#include <linux/of_irq.h>
29#include <linux/string.h>
Rob Herringc71a54b2011-09-20 15:13:50 -050030#include <linux/slab.h>
Grant Likelye3873442010-06-18 11:09:59 -060031
32/**
33 * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
Yijing Wangd84ff462013-08-31 09:44:10 +080034 * @dev: Device node of the device whose interrupt is to be mapped
Grant Likelye3873442010-06-18 11:09:59 -060035 * @index: Index of the interrupt to map
36 *
Grant Likely0c02c802013-09-19 11:22:36 -050037 * This function is a wrapper that chains of_irq_parse_one() and
Grant Likelye3873442010-06-18 11:09:59 -060038 * irq_create_of_mapping() to make things easier to callers
39 */
40unsigned int irq_of_parse_and_map(struct device_node *dev, int index)
41{
Grant Likely530210c2013-09-15 16:39:11 +010042 struct of_phandle_args oirq;
Grant Likelye3873442010-06-18 11:09:59 -060043
Grant Likely0c02c802013-09-19 11:22:36 -050044 if (of_irq_parse_one(dev, index, &oirq))
Anton Vorontsov77a73002011-12-07 03:16:26 +040045 return 0;
Grant Likelye3873442010-06-18 11:09:59 -060046
Grant Likelye6d30ab2013-09-15 16:55:53 +010047 return irq_create_of_mapping(&oirq);
Grant Likelye3873442010-06-18 11:09:59 -060048}
49EXPORT_SYMBOL_GPL(irq_of_parse_and_map);
Grant Likely7dc2e112010-06-08 07:48:06 -060050
51/**
52 * of_irq_find_parent - Given a device node, find its interrupt parent node
53 * @child: pointer to device node
54 *
55 * Returns a pointer to the interrupt parent node, or NULL if the interrupt
56 * parent could not be determined.
57 */
Carlo Caione4c3141e2015-12-01 17:24:17 +010058struct device_node *of_irq_find_parent(struct device_node *child)
Grant Likely7dc2e112010-06-08 07:48:06 -060059{
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080060 struct device_node *p;
Grant Likely9a6b2e52010-07-23 01:48:25 -060061 const __be32 *parp;
Grant Likely7dc2e112010-06-08 07:48:06 -060062
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080063 if (!of_node_get(child))
Grant Likely7dc2e112010-06-08 07:48:06 -060064 return NULL;
65
66 do {
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080067 parp = of_get_property(child, "interrupt-parent", NULL);
Grant Likely7dc2e112010-06-08 07:48:06 -060068 if (parp == NULL)
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080069 p = of_get_parent(child);
Grant Likely7dc2e112010-06-08 07:48:06 -060070 else {
71 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
72 p = of_node_get(of_irq_dflt_pic);
73 else
Grant Likely9a6b2e52010-07-23 01:48:25 -060074 p = of_find_node_by_phandle(be32_to_cpup(parp));
Grant Likely7dc2e112010-06-08 07:48:06 -060075 }
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080076 of_node_put(child);
77 child = p;
Grant Likely7dc2e112010-06-08 07:48:06 -060078 } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL);
79
Linus Torvaldsb4bbb022011-11-22 15:09:20 -080080 return p;
Grant Likely7dc2e112010-06-08 07:48:06 -060081}
Carlo Caione4c3141e2015-12-01 17:24:17 +010082EXPORT_SYMBOL_GPL(of_irq_find_parent);
Grant Likely7dc2e112010-06-08 07:48:06 -060083
84/**
Grant Likely0c02c802013-09-19 11:22:36 -050085 * of_irq_parse_raw - Low level interrupt tree parsing
Grant Likely7dc2e112010-06-08 07:48:06 -060086 * @parent: the device interrupt parent
Grant Likely23616132013-09-15 22:32:39 +010087 * @addr: address specifier (start of "reg" property of the device) in be32 format
88 * @out_irq: structure of_irq updated by this function
Grant Likely7dc2e112010-06-08 07:48:06 -060089 *
90 * Returns 0 on success and a negative number on error
91 *
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
Grant Likely23616132013-09-15 22:32:39 +010095 * 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.
Grant Likely7dc2e112010-06-08 07:48:06 -060098 */
Grant Likely23616132013-09-15 22:32:39 +010099int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq)
Grant Likely7dc2e112010-06-08 07:48:06 -0600100{
101 struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
Grant Likely355e62f2013-11-02 00:11:02 -0700102 __be32 initial_match_array[MAX_PHANDLE_ARGS];
Grant Likely23616132013-09-15 22:32:39 +0100103 const __be32 *match_array = initial_match_array;
Grant Likely355e62f2013-11-02 00:11:02 -0700104 const __be32 *tmp, *imap, *imask, dummy_imask[] = { [0 ... MAX_PHANDLE_ARGS] = ~0 };
Grant Likely7dc2e112010-06-08 07:48:06 -0600105 u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
106 int imaplen, match, i;
107
Grant Likely624cfca2013-10-11 22:05:10 +0100108#ifdef DEBUG
109 of_print_phandle_args("of_irq_parse_raw: ", out_irq);
110#endif
Grant Likely7dc2e112010-06-08 07:48:06 -0600111
Grant Likely23616132013-09-15 22:32:39 +0100112 ipar = of_node_get(out_irq->np);
Grant Likely7dc2e112010-06-08 07:48:06 -0600113
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
117 */
118 do {
119 tmp = of_get_property(ipar, "#interrupt-cells", NULL);
120 if (tmp != NULL) {
Rob Herringa7c194b2010-06-08 07:48:08 -0600121 intsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600122 break;
123 }
124 tnode = ipar;
125 ipar = of_irq_find_parent(ipar);
126 of_node_put(tnode);
127 } while (ipar);
128 if (ipar == NULL) {
129 pr_debug(" -> no parent found !\n");
130 goto fail;
131 }
132
Grant Likely0c02c802013-09-19 11:22:36 -0500133 pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar), intsize);
Grant Likely7dc2e112010-06-08 07:48:06 -0600134
Grant Likely23616132013-09-15 22:32:39 +0100135 if (out_irq->args_count != intsize)
Grant Likely7dc2e112010-06-08 07:48:06 -0600136 return -EINVAL;
137
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
140 */
141 old = of_node_get(ipar);
142 do {
143 tmp = of_get_property(old, "#address-cells", NULL);
144 tnode = of_get_parent(old);
145 of_node_put(old);
146 old = tnode;
147 } while (old && tmp == NULL);
148 of_node_put(old);
149 old = NULL;
Rob Herringa7c194b2010-06-08 07:48:08 -0600150 addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600151
152 pr_debug(" -> addrsize=%d\n", addrsize);
153
Grant Likely355e62f2013-11-02 00:11:02 -0700154 /* Range check so that the temporary buffer doesn't overflow */
155 if (WARN_ON(addrsize + intsize > MAX_PHANDLE_ARGS))
156 goto fail;
157
Grant Likely23616132013-09-15 22:32:39 +0100158 /* Precalculate the match array - this simplifies match loop */
159 for (i = 0; i < addrsize; i++)
Grant Likely78119fd2013-11-01 10:50:50 -0700160 initial_match_array[i] = addr ? addr[i] : 0;
Grant Likely23616132013-09-15 22:32:39 +0100161 for (i = 0; i < intsize; i++)
162 initial_match_array[addrsize + i] = cpu_to_be32(out_irq->args[i]);
163
Grant Likely7dc2e112010-06-08 07:48:06 -0600164 /* 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
167 * then we are done
168 */
169 if (of_get_property(ipar, "interrupt-controller", NULL) !=
170 NULL) {
171 pr_debug(" -> got it !\n");
Grant Likely7dc2e112010-06-08 07:48:06 -0600172 return 0;
173 }
174
Grant Likely78119fd2013-11-01 10:50:50 -0700175 /*
176 * interrupt-map parsing does not work without a reg
177 * property when #address-cells != 0
178 */
179 if (addrsize && !addr) {
180 pr_debug(" -> no reg passed in when needed !\n");
181 goto fail;
182 }
183
Grant Likely7dc2e112010-06-08 07:48:06 -0600184 /* Now look for an interrupt-map */
185 imap = of_get_property(ipar, "interrupt-map", &imaplen);
186 /* No interrupt map, check for an interrupt parent */
187 if (imap == NULL) {
188 pr_debug(" -> no map, getting parent\n");
189 newpar = of_irq_find_parent(ipar);
190 goto skiplevel;
191 }
192 imaplen /= sizeof(u32);
193
194 /* Look for a mask */
195 imask = of_get_property(ipar, "interrupt-map-mask", NULL);
Grant Likely23616132013-09-15 22:32:39 +0100196 if (!imask)
197 imask = dummy_imask;
Grant Likely7dc2e112010-06-08 07:48:06 -0600198
199 /* Parse interrupt-map */
200 match = 0;
201 while (imaplen > (addrsize + intsize + 1) && !match) {
202 /* Compare specifiers */
203 match = 1;
Grant Likely23616132013-09-15 22:32:39 +0100204 for (i = 0; i < (addrsize + intsize); i++, imaplen--)
Tomasz Figa74dac2e2013-11-05 16:21:18 +0100205 match &= !((match_array[i] ^ *imap++) & imask[i]);
Grant Likely7dc2e112010-06-08 07:48:06 -0600206
207 pr_debug(" -> match=%d (imaplen=%d)\n", match, imaplen);
208
209 /* Get the interrupt parent */
210 if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
211 newpar = of_node_get(of_irq_dflt_pic);
212 else
Grant Likely9a6b2e52010-07-23 01:48:25 -0600213 newpar = of_find_node_by_phandle(be32_to_cpup(imap));
Grant Likely7dc2e112010-06-08 07:48:06 -0600214 imap++;
215 --imaplen;
216
217 /* Check if not found */
218 if (newpar == NULL) {
219 pr_debug(" -> imap parent not found !\n");
220 goto fail;
221 }
222
Peter Crosthwaite1ca56e72013-11-27 23:26:12 -0800223 if (!of_device_is_available(newpar))
224 match = 0;
225
Grant Likely7dc2e112010-06-08 07:48:06 -0600226 /* Get #interrupt-cells and #address-cells of new
227 * parent
228 */
229 tmp = of_get_property(newpar, "#interrupt-cells", NULL);
230 if (tmp == NULL) {
231 pr_debug(" -> parent lacks #interrupt-cells!\n");
232 goto fail;
233 }
Rob Herringa7c194b2010-06-08 07:48:08 -0600234 newintsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600235 tmp = of_get_property(newpar, "#address-cells", NULL);
Rob Herringa7c194b2010-06-08 07:48:08 -0600236 newaddrsize = (tmp == NULL) ? 0 : be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600237
238 pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
239 newintsize, newaddrsize);
240
241 /* Check for malformed properties */
Grant Likely355e62f2013-11-02 00:11:02 -0700242 if (WARN_ON(newaddrsize + newintsize > MAX_PHANDLE_ARGS))
243 goto fail;
Grant Likely7dc2e112010-06-08 07:48:06 -0600244 if (imaplen < (newaddrsize + newintsize))
245 goto fail;
246
247 imap += newaddrsize + newintsize;
248 imaplen -= newaddrsize + newintsize;
249
250 pr_debug(" -> imaplen=%d\n", imaplen);
251 }
252 if (!match)
253 goto fail;
254
Grant Likely23616132013-09-15 22:32:39 +0100255 /*
256 * Successfully parsed an interrrupt-map translation; copy new
257 * interrupt specifier into the out_irq structure
258 */
Grant Likely23616132013-09-15 22:32:39 +0100259 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;
Grant Likely7dc2e112010-06-08 07:48:06 -0600263 addrsize = newaddrsize;
Grant Likely7dc2e112010-06-08 07:48:06 -0600264
265 skiplevel:
266 /* Iterate again with new parent */
Jeremy Lintond23b2512015-06-29 18:50:55 -0500267 out_irq->np = newpar;
Grant Likely74a7f082012-06-15 11:50:25 -0600268 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar));
Grant Likely7dc2e112010-06-08 07:48:06 -0600269 of_node_put(ipar);
270 ipar = newpar;
271 newpar = NULL;
272 }
273 fail:
274 of_node_put(ipar);
Grant Likely7dc2e112010-06-08 07:48:06 -0600275 of_node_put(newpar);
276
277 return -EINVAL;
278}
Grant Likely0c02c802013-09-19 11:22:36 -0500279EXPORT_SYMBOL_GPL(of_irq_parse_raw);
Grant Likely7dc2e112010-06-08 07:48:06 -0600280
281/**
Grant Likely0c02c802013-09-19 11:22:36 -0500282 * of_irq_parse_one - Resolve an interrupt for a device
Grant Likely7dc2e112010-06-08 07:48:06 -0600283 * @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
286 *
Grant Likely23616132013-09-15 22:32:39 +0100287 * 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.
Grant Likely7dc2e112010-06-08 07:48:06 -0600290 */
Grant Likely530210c2013-09-15 16:39:11 +0100291int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq)
Grant Likely7dc2e112010-06-08 07:48:06 -0600292{
293 struct device_node *p;
Grant Likelyd2f71832010-07-23 16:56:19 -0600294 const __be32 *intspec, *tmp, *addr;
Grant Likely7dc2e112010-06-08 07:48:06 -0600295 u32 intsize, intlen;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200296 int i, res;
Grant Likely7dc2e112010-06-08 07:48:06 -0600297
Grant Likely0c02c802013-09-19 11:22:36 -0500298 pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device), index);
Grant Likely7dc2e112010-06-08 07:48:06 -0600299
300 /* OldWorld mac stuff is "special", handle out of line */
301 if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
Grant Likely0c02c802013-09-19 11:22:36 -0500302 return of_irq_parse_oldworld(device, index, out_irq);
Grant Likely7dc2e112010-06-08 07:48:06 -0600303
Grant Likely79d97012013-09-19 16:47:37 -0500304 /* Get the reg property (if any) */
305 addr = of_get_property(device, "reg", NULL);
306
Florian Fainellia9ecdc02014-08-06 13:02:27 -0700307 /* Try the new-style interrupts-extended first */
308 res = of_parse_phandle_with_args(device, "interrupts-extended",
309 "#interrupt-cells", index, out_irq);
310 if (!res)
311 return of_irq_parse_raw(addr, out_irq);
312
Grant Likely7dc2e112010-06-08 07:48:06 -0600313 /* Get the interrupts property */
314 intspec = of_get_property(device, "interrupts", &intlen);
Florian Fainellia9ecdc02014-08-06 13:02:27 -0700315 if (intspec == NULL)
316 return -EINVAL;
317
Grant Likelyd2f71832010-07-23 16:56:19 -0600318 intlen /= sizeof(*intspec);
Grant Likely7dc2e112010-06-08 07:48:06 -0600319
Grant Likelyd2f71832010-07-23 16:56:19 -0600320 pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec), intlen);
Grant Likely7dc2e112010-06-08 07:48:06 -0600321
Grant Likely7dc2e112010-06-08 07:48:06 -0600322 /* Look for the interrupt parent. */
323 p = of_irq_find_parent(device);
324 if (p == NULL)
325 return -EINVAL;
326
327 /* Get size of interrupt specifier */
328 tmp = of_get_property(p, "#interrupt-cells", NULL);
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200329 if (tmp == NULL) {
330 res = -EINVAL;
Grant Likely7dc2e112010-06-08 07:48:06 -0600331 goto out;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200332 }
Rob Herringa7c194b2010-06-08 07:48:08 -0600333 intsize = be32_to_cpu(*tmp);
Grant Likely7dc2e112010-06-08 07:48:06 -0600334
335 pr_debug(" intsize=%d intlen=%d\n", intsize, intlen);
336
337 /* Check index */
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200338 if ((index + 1) * intsize > intlen) {
339 res = -EINVAL;
Grant Likely7dc2e112010-06-08 07:48:06 -0600340 goto out;
Laurent Pinchartd7c14602015-03-18 00:21:32 +0200341 }
Grant Likely7dc2e112010-06-08 07:48:06 -0600342
Grant Likely23616132013-09-15 22:32:39 +0100343 /* Copy intspec into irq structure */
344 intspec += index * intsize;
345 out_irq->np = p;
346 out_irq->args_count = intsize;
347 for (i = 0; i < intsize; i++)
348 out_irq->args[i] = be32_to_cpup(intspec++);
349
350 /* Check if there are any interrupt-map translations to process */
351 res = of_irq_parse_raw(addr, out_irq);
Grant Likely7dc2e112010-06-08 07:48:06 -0600352 out:
353 of_node_put(p);
354 return res;
355}
Grant Likely0c02c802013-09-19 11:22:36 -0500356EXPORT_SYMBOL_GPL(of_irq_parse_one);
Grant Likely7dc2e112010-06-08 07:48:06 -0600357
358/**
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.
363 */
364int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
365{
366 int irq = irq_of_parse_and_map(dev, index);
367
368 /* Only dereference the resource if both the
369 * resource and the irq are valid. */
Anton Vorontsov77a73002011-12-07 03:16:26 +0400370 if (r && irq) {
Benoit Cousson661db792011-12-05 15:23:56 +0100371 const char *name = NULL;
372
Sebastian Andrzej Siewiorcf9e2362013-07-18 12:24:10 +0200373 memset(r, 0, sizeof(*r));
Benoit Cousson661db792011-12-05 15:23:56 +0100374 /*
Geert Uytterhoevenae107d02014-04-22 20:40:25 +0200375 * Get optional "interrupt-names" property to add a name
Benoit Cousson661db792011-12-05 15:23:56 +0100376 * to the resource.
377 */
378 of_property_read_string_index(dev, "interrupt-names", index,
379 &name);
380
Grant Likely7dc2e112010-06-08 07:48:06 -0600381 r->start = r->end = irq;
Tomasz Figa4a43d682013-09-28 19:52:51 +0200382 r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq));
Grant Likely88048272013-09-19 11:01:52 -0500383 r->name = name ? name : of_node_full_name(dev);
Grant Likely7dc2e112010-06-08 07:48:06 -0600384 }
385
386 return irq;
387}
388EXPORT_SYMBOL_GPL(of_irq_to_resource);
Andres Salomon52f65372010-10-10 21:35:05 -0600389
390/**
Sergei Shtylyov39935462016-05-28 23:02:50 +0300391 * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number
Rob Herring9ec36ca2014-04-23 17:57:41 -0500392 * @dev: pointer to device tree node
Sergei Shtylyov39935462016-05-28 23:02:50 +0300393 * @index: zero-based index of the IRQ
Rob Herring9ec36ca2014-04-23 17:57:41 -0500394 *
Sergei Shtylyov39935462016-05-28 23:02:50 +0300395 * 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.
Rob Herring9ec36ca2014-04-23 17:57:41 -0500398 */
399int of_irq_get(struct device_node *dev, int index)
400{
401 int rc;
402 struct of_phandle_args oirq;
403 struct irq_domain *domain;
404
405 rc = of_irq_parse_one(dev, index, &oirq);
406 if (rc)
407 return rc;
408
409 domain = irq_find_host(oirq.np);
410 if (!domain)
411 return -EPROBE_DEFER;
412
413 return irq_create_of_mapping(&oirq);
414}
Laurent Pinchart9eb08fb2014-10-30 15:59:36 +0200415EXPORT_SYMBOL_GPL(of_irq_get);
Rob Herring9ec36ca2014-04-23 17:57:41 -0500416
417/**
Sergei Shtylyov39935462016-05-28 23:02:50 +0300418 * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number
Grygorii Strashkoad696742014-05-20 13:42:02 +0300419 * @dev: pointer to device tree node
Sergei Shtylyov39935462016-05-28 23:02:50 +0300420 * @name: IRQ name
Grygorii Strashkoad696742014-05-20 13:42:02 +0300421 *
Sergei Shtylyov39935462016-05-28 23:02:50 +0300422 * 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.
Grygorii Strashkoad696742014-05-20 13:42:02 +0300425 */
426int of_irq_get_byname(struct device_node *dev, const char *name)
427{
428 int index;
429
430 if (unlikely(!name))
431 return -EINVAL;
432
433 index = of_property_match_string(dev, "interrupt-names", name);
434 if (index < 0)
435 return index;
436
437 return of_irq_get(dev, index);
438}
Dmitry Torokhov6602c452015-08-25 17:04:02 -0700439EXPORT_SYMBOL_GPL(of_irq_get_byname);
Grygorii Strashkoad696742014-05-20 13:42:02 +0300440
441/**
Andres Salomon52f65372010-10-10 21:35:05 -0600442 * of_irq_count - Count the number of IRQs a node uses
443 * @dev: pointer to device tree node
444 */
445int of_irq_count(struct device_node *dev)
446{
Thierry Reding3da52782013-09-18 15:24:43 +0200447 struct of_phandle_args irq;
Andres Salomon52f65372010-10-10 21:35:05 -0600448 int nr = 0;
449
Thierry Reding3da52782013-09-18 15:24:43 +0200450 while (of_irq_parse_one(dev, nr, &irq) == 0)
Andres Salomon52f65372010-10-10 21:35:05 -0600451 nr++;
452
453 return nr;
454}
455
456/**
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)
461 *
462 * Returns the size of the filled in table (up to @nr_irqs).
463 */
464int of_irq_to_resource_table(struct device_node *dev, struct resource *res,
465 int nr_irqs)
466{
467 int i;
468
469 for (i = 0; i < nr_irqs; i++, res++)
Anton Vorontsov77a73002011-12-07 03:16:26 +0400470 if (!of_irq_to_resource(dev, i, res))
Andres Salomon52f65372010-10-10 21:35:05 -0600471 break;
472
473 return i;
474}
John Crispina4f8bf22012-08-26 09:13:09 +0200475EXPORT_SYMBOL_GPL(of_irq_to_resource_table);
Rob Herringc71a54b2011-09-20 15:13:50 -0500476
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200477struct of_intc_desc {
Rob Herringc71a54b2011-09-20 15:13:50 -0500478 struct list_head list;
Masahiro Yamada264041e2015-11-24 22:10:26 +0900479 of_irq_init_cb_t irq_init_cb;
Rob Herringc71a54b2011-09-20 15:13:50 -0500480 struct device_node *dev;
481 struct device_node *interrupt_parent;
482};
483
484/**
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
487 *
488 * This function scans the device tree for matching interrupt controller nodes,
489 * and calls their initialization functions in order with parents first.
490 */
491void __init of_irq_init(const struct of_device_id *matches)
492{
Masahiro Yamada264041e2015-11-24 22:10:26 +0900493 const struct of_device_id *match;
Rob Herringc71a54b2011-09-20 15:13:50 -0500494 struct device_node *np, *parent = NULL;
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200495 struct of_intc_desc *desc, *temp_desc;
Rob Herringc71a54b2011-09-20 15:13:50 -0500496 struct list_head intc_desc_list, intc_parent_list;
497
498 INIT_LIST_HEAD(&intc_desc_list);
499 INIT_LIST_HEAD(&intc_parent_list);
500
Masahiro Yamada264041e2015-11-24 22:10:26 +0900501 for_each_matching_node_and_match(np, matches, &match) {
Peter Crosthwaitebf49be02013-11-27 23:26:13 -0800502 if (!of_find_property(np, "interrupt-controller", NULL) ||
503 !of_device_is_available(np))
Rob Herringc71a54b2011-09-20 15:13:50 -0500504 continue;
Masahiro Yamada264041e2015-11-24 22:10:26 +0900505
506 if (WARN(!match->data, "of_irq_init: no init function for %s\n",
507 match->compatible))
508 continue;
509
Rob Herringc71a54b2011-09-20 15:13:50 -0500510 /*
Geert Uytterhoeven48a9b732015-06-26 14:42:45 +0200511 * Here, we allocate and populate an of_intc_desc with the node
Rob Herringc71a54b2011-09-20 15:13:50 -0500512 * pointer, interrupt-parent device_node etc.
513 */
514 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
Julia Lawall8363ccb2015-10-22 11:02:51 +0200515 if (WARN_ON(!desc)) {
516 of_node_put(np);
Rob Herringc71a54b2011-09-20 15:13:50 -0500517 goto err;
Julia Lawall8363ccb2015-10-22 11:02:51 +0200518 }
Rob Herringc71a54b2011-09-20 15:13:50 -0500519
Masahiro Yamada264041e2015-11-24 22:10:26 +0900520 desc->irq_init_cb = match->data;
Julia Lawall8363ccb2015-10-22 11:02:51 +0200521 desc->dev = of_node_get(np);
Rob Herringc71a54b2011-09-20 15:13:50 -0500522 desc->interrupt_parent = of_irq_find_parent(np);
Rob Herringd7fb6d02011-11-27 20:16:33 -0600523 if (desc->interrupt_parent == np)
524 desc->interrupt_parent = NULL;
Rob Herringc71a54b2011-09-20 15:13:50 -0500525 list_add_tail(&desc->list, &intc_desc_list);
526 }
527
528 /*
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.
532 */
533 while (!list_empty(&intc_desc_list)) {
534 /*
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.
538 */
539 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
Rob Herringc71a54b2011-09-20 15:13:50 -0500540 int ret;
Rob Herringc71a54b2011-09-20 15:13:50 -0500541
542 if (desc->interrupt_parent != parent)
543 continue;
544
545 list_del(&desc->list);
Rob Herringc71a54b2011-09-20 15:13:50 -0500546
Masahiro Yamada264041e2015-11-24 22:10:26 +0900547 pr_debug("of_irq_init: init %s (%p), parent %p\n",
548 desc->dev->full_name,
Rob Herringc71a54b2011-09-20 15:13:50 -0500549 desc->dev, desc->interrupt_parent);
Masahiro Yamada264041e2015-11-24 22:10:26 +0900550 ret = desc->irq_init_cb(desc->dev,
551 desc->interrupt_parent);
Rob Herringc71a54b2011-09-20 15:13:50 -0500552 if (ret) {
553 kfree(desc);
554 continue;
555 }
556
557 /*
558 * This one is now set up; add it to the parent list so
559 * its children can get processed in a subsequent pass.
560 */
561 list_add_tail(&desc->list, &intc_parent_list);
Jon Hunter15cc2ed2016-06-20 14:49:18 +0100562
563 of_node_set_flag(desc->dev, OF_POPULATED);
Rob Herringc71a54b2011-09-20 15:13:50 -0500564 }
565
566 /* Get the next pending parent that might have children */
Axel Linc0cdfaa2013-06-23 15:50:07 +0800567 desc = list_first_entry_or_null(&intc_parent_list,
568 typeof(*desc), list);
569 if (!desc) {
Rob Herringc71a54b2011-09-20 15:13:50 -0500570 pr_err("of_irq_init: children remain, but no parents\n");
571 break;
572 }
573 list_del(&desc->list);
574 parent = desc->dev;
575 kfree(desc);
576 }
577
578 list_for_each_entry_safe(desc, temp_desc, &intc_parent_list, list) {
579 list_del(&desc->list);
580 kfree(desc);
581 }
582err:
583 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
584 list_del(&desc->list);
Julia Lawall8363ccb2015-10-22 11:02:51 +0200585 of_node_put(desc->dev);
Rob Herringc71a54b2011-09-20 15:13:50 -0500586 kfree(desc);
587 }
588}
Marc Zyngierc706c232015-07-28 14:46:15 +0100589
Marc Zyngiera251b262015-10-01 17:05:45 +0100590static u32 __of_msi_map_rid(struct device *dev, struct device_node **np,
591 u32 rid_in)
David Daney8db02d82015-10-08 15:10:48 -0700592{
593 struct device *parent_dev;
594 struct device_node *msi_controller_node;
Marc Zyngiera251b262015-10-01 17:05:45 +0100595 struct device_node *msi_np = *np;
David Daney8db02d82015-10-08 15:10:48 -0700596 u32 map_mask, masked_rid, rid_base, msi_base, rid_len, phandle;
597 int msi_map_len;
598 bool matched;
599 u32 rid_out = rid_in;
600 const __be32 *msi_map = NULL;
601
602 /*
603 * Walk up the device parent links looking for one with a
604 * "msi-map" property.
605 */
606 for (parent_dev = dev; parent_dev; parent_dev = parent_dev->parent) {
607 if (!parent_dev->of_node)
608 continue;
609
610 msi_map = of_get_property(parent_dev->of_node,
611 "msi-map", &msi_map_len);
612 if (!msi_map)
613 continue;
614
615 if (msi_map_len % (4 * sizeof(__be32))) {
616 dev_err(parent_dev, "Error: Bad msi-map length: %d\n",
617 msi_map_len);
618 return rid_out;
619 }
620 /* We have a good parent_dev and msi_map, let's use them. */
621 break;
622 }
623 if (!msi_map)
624 return rid_out;
625
626 /* The default is to select all bits. */
627 map_mask = 0xffffffff;
628
629 /*
630 * Can be overridden by "msi-map-mask" property. If
631 * of_property_read_u32() fails, the default is used.
632 */
633 of_property_read_u32(parent_dev->of_node, "msi-map-mask", &map_mask);
634
635 masked_rid = map_mask & rid_in;
636 matched = false;
637 while (!matched && msi_map_len >= 4 * sizeof(__be32)) {
638 rid_base = be32_to_cpup(msi_map + 0);
639 phandle = be32_to_cpup(msi_map + 1);
640 msi_base = be32_to_cpup(msi_map + 2);
641 rid_len = be32_to_cpup(msi_map + 3);
642
Robin Murphy5d589d82016-02-09 11:04:45 +0000643 if (rid_base & ~map_mask) {
644 dev_err(parent_dev,
645 "Invalid msi-map translation - msi-map-mask (0x%x) ignores rid-base (0x%x)\n",
646 map_mask, rid_base);
647 return rid_out;
648 }
649
David Daney8db02d82015-10-08 15:10:48 -0700650 msi_controller_node = of_find_node_by_phandle(phandle);
651
Marc Zyngiera251b262015-10-01 17:05:45 +0100652 matched = (masked_rid >= rid_base &&
653 masked_rid < rid_base + rid_len);
654 if (msi_np)
655 matched &= msi_np == msi_controller_node;
656
657 if (matched && !msi_np) {
658 *np = msi_np = msi_controller_node;
659 break;
660 }
David Daney8db02d82015-10-08 15:10:48 -0700661
662 of_node_put(msi_controller_node);
663 msi_map_len -= 4 * sizeof(__be32);
664 msi_map += 4;
665 }
666 if (!matched)
667 return rid_out;
668
Robin Murphy5d589d82016-02-09 11:04:45 +0000669 rid_out = masked_rid - rid_base + msi_base;
David Daney8db02d82015-10-08 15:10:48 -0700670 dev_dbg(dev,
671 "msi-map at: %s, using mask %08x, rid-base: %08x, msi-base: %08x, length: %08x, rid: %08x -> %08x\n",
672 dev_name(parent_dev), map_mask, rid_base, msi_base,
673 rid_len, rid_in, rid_out);
674
675 return rid_out;
676}
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100677
Marc Zyngiera251b262015-10-01 17:05:45 +0100678/**
679 * of_msi_map_rid - Map a MSI requester ID for a device.
680 * @dev: device for which the mapping is to be done.
681 * @msi_np: device node of the expected msi controller.
682 * @rid_in: unmapped MSI requester ID for the device.
683 *
684 * Walk up the device hierarchy looking for devices with a "msi-map"
685 * property. If found, apply the mapping to @rid_in.
686 *
687 * Returns the mapped MSI requester ID.
688 */
689u32 of_msi_map_rid(struct device *dev, struct device_node *msi_np, u32 rid_in)
690{
691 return __of_msi_map_rid(dev, &msi_np, rid_in);
692}
693
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100694/**
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);
Marc Zyngier14a0db32016-01-26 13:52:26 +0000709 return irq_find_matching_host(np, DOMAIN_BUS_PCI_MSI);
Marc Zyngier82b9b422015-10-02 14:38:55 +0100710}
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")) {
Marc Zyngier14a0db32016-01-26 13:52:26 +0000733 d = irq_find_matching_host(msi_np, token);
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100734 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)) {
Marc Zyngier14a0db32016-01-26 13:52:26 +0000747 d = irq_find_matching_host(args.np, token);
Marc Zyngier48ae34f2015-09-18 14:07:40 +0100748 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}