GNU Linux-libre 4.14.332-gnu1
[releases.git] / drivers / of / irq.c
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 #define pr_fmt(fmt)     "OF: " fmt
22
23 #include <linux/device.h>
24 #include <linux/errno.h>
25 #include <linux/list.h>
26 #include <linux/module.h>
27 #include <linux/of.h>
28 #include <linux/of_irq.h>
29 #include <linux/of_pci.h>
30 #include <linux/string.h>
31 #include <linux/slab.h>
32
33 /**
34  * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
35  * @dev: Device node of the device whose interrupt is to be mapped
36  * @index: Index of the interrupt to map
37  *
38  * This function is a wrapper that chains of_irq_parse_one() and
39  * irq_create_of_mapping() to make things easier to callers
40  */
41 unsigned int irq_of_parse_and_map(struct device_node *dev, int index)
42 {
43         struct of_phandle_args oirq;
44
45         if (of_irq_parse_one(dev, index, &oirq))
46                 return 0;
47
48         return irq_create_of_mapping(&oirq);
49 }
50 EXPORT_SYMBOL_GPL(irq_of_parse_and_map);
51
52 /**
53  * of_irq_find_parent - Given a device node, find its interrupt parent node
54  * @child: pointer to device node
55  *
56  * Returns a pointer to the interrupt parent node, or NULL if the interrupt
57  * parent could not be determined.
58  */
59 struct device_node *of_irq_find_parent(struct device_node *child)
60 {
61         struct device_node *p;
62         phandle parent;
63
64         if (!of_node_get(child))
65                 return NULL;
66
67         do {
68                 if (of_property_read_u32(child, "interrupt-parent", &parent)) {
69                         p = of_get_parent(child);
70                 } else  {
71                         if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
72                                 p = of_node_get(of_irq_dflt_pic);
73                         else
74                                 p = of_find_node_by_phandle(parent);
75                 }
76                 of_node_put(child);
77                 child = p;
78         } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL);
79
80         return p;
81 }
82 EXPORT_SYMBOL_GPL(of_irq_find_parent);
83
84 /**
85  * of_irq_parse_raw - Low level interrupt tree parsing
86  * @parent:     the device interrupt parent
87  * @addr:       address specifier (start of "reg" property of the device) in be32 format
88  * @out_irq:    structure of_irq updated by this function
89  *
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
95  * node exist for the parent. It takes an interrupt specifier structure as
96  * input, walks the tree looking for any interrupt-map properties, translates
97  * the specifier for each map, and then returns the translated map.
98  */
99 int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq)
100 {
101         struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
102         __be32 initial_match_array[MAX_PHANDLE_ARGS];
103         const __be32 *match_array = initial_match_array;
104         const __be32 *tmp, *imap, *imask, dummy_imask[] = { [0 ... MAX_PHANDLE_ARGS] = cpu_to_be32(~0) };
105         u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
106         int imaplen, match, i, rc = -EINVAL;
107
108 #ifdef DEBUG
109         of_print_phandle_args("of_irq_parse_raw: ", out_irq);
110 #endif
111
112         ipar = of_node_get(out_irq->np);
113
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                 if (!of_property_read_u32(ipar, "#interrupt-cells", &intsize))
120                         break;
121                 tnode = ipar;
122                 ipar = of_irq_find_parent(ipar);
123                 of_node_put(tnode);
124         } while (ipar);
125         if (ipar == NULL) {
126                 pr_debug(" -> no parent found !\n");
127                 goto fail;
128         }
129
130         pr_debug("of_irq_parse_raw: ipar=%pOF, size=%d\n", ipar, intsize);
131
132         if (out_irq->args_count != intsize)
133                 goto fail;
134
135         /* Look for this #address-cells. We have to implement the old linux
136          * trick of looking for the parent here as some device-trees rely on it
137          */
138         old = of_node_get(ipar);
139         do {
140                 tmp = of_get_property(old, "#address-cells", NULL);
141                 tnode = of_get_parent(old);
142                 of_node_put(old);
143                 old = tnode;
144         } while (old && tmp == NULL);
145         of_node_put(old);
146         old = NULL;
147         addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp);
148
149         pr_debug(" -> addrsize=%d\n", addrsize);
150
151         /* Range check so that the temporary buffer doesn't overflow */
152         if (WARN_ON(addrsize + intsize > MAX_PHANDLE_ARGS)) {
153                 rc = -EFAULT;
154                 goto fail;
155         }
156
157         /* Precalculate the match array - this simplifies match loop */
158         for (i = 0; i < addrsize; i++)
159                 initial_match_array[i] = addr ? addr[i] : 0;
160         for (i = 0; i < intsize; i++)
161                 initial_match_array[addrsize + i] = cpu_to_be32(out_irq->args[i]);
162
163         /* Now start the actual "proper" walk of the interrupt tree */
164         while (ipar != NULL) {
165                 /* Now check if cursor is an interrupt-controller and if it is
166                  * then we are done
167                  */
168                 if (of_property_read_bool(ipar, "interrupt-controller")) {
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                         if (of_property_read_u32(newpar, "#interrupt-cells",
228                                                  &newintsize)) {
229                                 pr_debug(" -> parent lacks #interrupt-cells!\n");
230                                 goto fail;
231                         }
232                         if (of_property_read_u32(newpar, "#address-cells",
233                                                  &newaddrsize))
234                                 newaddrsize = 0;
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                             || (imaplen < (newaddrsize + newintsize))) {
242                                 rc = -EFAULT;
243                                 goto fail;
244                         }
245
246                         imap += newaddrsize + newintsize;
247                         imaplen -= newaddrsize + newintsize;
248
249                         pr_debug(" -> imaplen=%d\n", imaplen);
250                 }
251                 if (!match)
252                         goto fail;
253
254                 /*
255                  * Successfully parsed an interrrupt-map translation; copy new
256                  * interrupt specifier into the out_irq structure
257                  */
258                 match_array = imap - newaddrsize - newintsize;
259                 for (i = 0; i < newintsize; i++)
260                         out_irq->args[i] = be32_to_cpup(imap - newintsize + i);
261                 out_irq->args_count = intsize = newintsize;
262                 addrsize = newaddrsize;
263
264         skiplevel:
265                 /* Iterate again with new parent */
266                 out_irq->np = newpar;
267                 pr_debug(" -> new parent: %pOF\n", newpar);
268                 of_node_put(ipar);
269                 ipar = newpar;
270                 newpar = NULL;
271         }
272         rc = -ENOENT; /* No interrupt-map found */
273
274  fail:
275         of_node_put(ipar);
276         of_node_put(newpar);
277
278         return rc;
279 }
280 EXPORT_SYMBOL_GPL(of_irq_parse_raw);
281
282 /**
283  * of_irq_parse_one - Resolve an interrupt for a device
284  * @device: the device whose interrupt is to be resolved
285  * @index: index of the interrupt to resolve
286  * @out_irq: structure of_irq filled by this function
287  *
288  * This function resolves an interrupt for a node by walking the interrupt tree,
289  * finding which interrupt controller node it is attached to, and returning the
290  * interrupt specifier that can be used to retrieve a Linux IRQ number.
291  */
292 int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq)
293 {
294         struct device_node *p;
295         const __be32 *addr;
296         u32 intsize;
297         int i, res;
298
299         pr_debug("of_irq_parse_one: dev=%pOF, index=%d\n", device, index);
300
301         /* OldWorld mac stuff is "special", handle out of line */
302         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
303                 return of_irq_parse_oldworld(device, index, out_irq);
304
305         /* Get the reg property (if any) */
306         addr = of_get_property(device, "reg", NULL);
307
308         /* Try the new-style interrupts-extended first */
309         res = of_parse_phandle_with_args(device, "interrupts-extended",
310                                         "#interrupt-cells", index, out_irq);
311         if (!res)
312                 return of_irq_parse_raw(addr, out_irq);
313
314         /* Look for the interrupt parent. */
315         p = of_irq_find_parent(device);
316         if (p == NULL)
317                 return -EINVAL;
318
319         /* Get size of interrupt specifier */
320         if (of_property_read_u32(p, "#interrupt-cells", &intsize)) {
321                 res = -EINVAL;
322                 goto out;
323         }
324
325         pr_debug(" parent=%pOF, intsize=%d\n", p, intsize);
326
327         /* Copy intspec into irq structure */
328         out_irq->np = p;
329         out_irq->args_count = intsize;
330         for (i = 0; i < intsize; i++) {
331                 res = of_property_read_u32_index(device, "interrupts",
332                                                  (index * intsize) + i,
333                                                  out_irq->args + i);
334                 if (res)
335                         goto out;
336         }
337
338         pr_debug(" intspec=%d\n", *out_irq->args);
339
340
341         /* Check if there are any interrupt-map translations to process */
342         res = of_irq_parse_raw(addr, out_irq);
343  out:
344         of_node_put(p);
345         return res;
346 }
347 EXPORT_SYMBOL_GPL(of_irq_parse_one);
348
349 /**
350  * of_irq_to_resource - Decode a node's IRQ and return it as a resource
351  * @dev: pointer to device tree node
352  * @index: zero-based index of the irq
353  * @r: pointer to resource structure to return result into.
354  */
355 int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
356 {
357         int irq = of_irq_get(dev, index);
358
359         if (irq < 0)
360                 return irq;
361
362         /* Only dereference the resource if both the
363          * resource and the irq are valid. */
364         if (r && irq) {
365                 const char *name = NULL;
366
367                 memset(r, 0, sizeof(*r));
368                 /*
369                  * Get optional "interrupt-names" property to add a name
370                  * to the resource.
371                  */
372                 of_property_read_string_index(dev, "interrupt-names", index,
373                                               &name);
374
375                 r->start = r->end = irq;
376                 r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq));
377                 r->name = name ? name : of_node_full_name(dev);
378         }
379
380         return irq;
381 }
382 EXPORT_SYMBOL_GPL(of_irq_to_resource);
383
384 /**
385  * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number
386  * @dev: pointer to device tree node
387  * @index: zero-based index of the IRQ
388  *
389  * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
390  * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
391  * of any other failure.
392  */
393 int of_irq_get(struct device_node *dev, int index)
394 {
395         int rc;
396         struct of_phandle_args oirq;
397         struct irq_domain *domain;
398
399         rc = of_irq_parse_one(dev, index, &oirq);
400         if (rc)
401                 return rc;
402
403         domain = irq_find_host(oirq.np);
404         if (!domain)
405                 return -EPROBE_DEFER;
406
407         return irq_create_of_mapping(&oirq);
408 }
409 EXPORT_SYMBOL_GPL(of_irq_get);
410
411 /**
412  * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number
413  * @dev: pointer to device tree node
414  * @name: IRQ name
415  *
416  * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or
417  * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case
418  * of any other failure.
419  */
420 int of_irq_get_byname(struct device_node *dev, const char *name)
421 {
422         int index;
423
424         if (unlikely(!name))
425                 return -EINVAL;
426
427         index = of_property_match_string(dev, "interrupt-names", name);
428         if (index < 0)
429                 return index;
430
431         return of_irq_get(dev, index);
432 }
433 EXPORT_SYMBOL_GPL(of_irq_get_byname);
434
435 /**
436  * of_irq_count - Count the number of IRQs a node uses
437  * @dev: pointer to device tree node
438  */
439 int of_irq_count(struct device_node *dev)
440 {
441         struct of_phandle_args irq;
442         int nr = 0;
443
444         while (of_irq_parse_one(dev, nr, &irq) == 0)
445                 nr++;
446
447         return nr;
448 }
449
450 /**
451  * of_irq_to_resource_table - Fill in resource table with node's IRQ info
452  * @dev: pointer to device tree node
453  * @res: array of resources to fill in
454  * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
455  *
456  * Returns the size of the filled in table (up to @nr_irqs).
457  */
458 int of_irq_to_resource_table(struct device_node *dev, struct resource *res,
459                 int nr_irqs)
460 {
461         int i;
462
463         for (i = 0; i < nr_irqs; i++, res++)
464                 if (of_irq_to_resource(dev, i, res) <= 0)
465                         break;
466
467         return i;
468 }
469 EXPORT_SYMBOL_GPL(of_irq_to_resource_table);
470
471 struct of_intc_desc {
472         struct list_head        list;
473         of_irq_init_cb_t        irq_init_cb;
474         struct device_node      *dev;
475         struct device_node      *interrupt_parent;
476 };
477
478 /**
479  * of_irq_init - Scan and init matching interrupt controllers in DT
480  * @matches: 0 terminated array of nodes to match and init function to call
481  *
482  * This function scans the device tree for matching interrupt controller nodes,
483  * and calls their initialization functions in order with parents first.
484  */
485 void __init of_irq_init(const struct of_device_id *matches)
486 {
487         const struct of_device_id *match;
488         struct device_node *np, *parent = NULL;
489         struct of_intc_desc *desc, *temp_desc;
490         struct list_head intc_desc_list, intc_parent_list;
491
492         INIT_LIST_HEAD(&intc_desc_list);
493         INIT_LIST_HEAD(&intc_parent_list);
494
495         for_each_matching_node_and_match(np, matches, &match) {
496                 if (!of_property_read_bool(np, "interrupt-controller") ||
497                                 !of_device_is_available(np))
498                         continue;
499
500                 if (WARN(!match->data, "of_irq_init: no init function for %s\n",
501                          match->compatible))
502                         continue;
503
504                 /*
505                  * Here, we allocate and populate an of_intc_desc with the node
506                  * pointer, interrupt-parent device_node etc.
507                  */
508                 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
509                 if (WARN_ON(!desc)) {
510                         of_node_put(np);
511                         goto err;
512                 }
513
514                 desc->irq_init_cb = match->data;
515                 desc->dev = of_node_get(np);
516                 desc->interrupt_parent = of_irq_find_parent(np);
517                 if (desc->interrupt_parent == np)
518                         desc->interrupt_parent = NULL;
519                 list_add_tail(&desc->list, &intc_desc_list);
520         }
521
522         /*
523          * The root irq controller is the one without an interrupt-parent.
524          * That one goes first, followed by the controllers that reference it,
525          * followed by the ones that reference the 2nd level controllers, etc.
526          */
527         while (!list_empty(&intc_desc_list)) {
528                 /*
529                  * Process all controllers with the current 'parent'.
530                  * First pass will be looking for NULL as the parent.
531                  * The assumption is that NULL parent means a root controller.
532                  */
533                 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
534                         int ret;
535
536                         if (desc->interrupt_parent != parent)
537                                 continue;
538
539                         list_del(&desc->list);
540
541                         of_node_set_flag(desc->dev, OF_POPULATED);
542
543                         pr_debug("of_irq_init: init %pOF (%p), parent %p\n",
544                                  desc->dev,
545                                  desc->dev, desc->interrupt_parent);
546                         ret = desc->irq_init_cb(desc->dev,
547                                                 desc->interrupt_parent);
548                         if (ret) {
549                                 of_node_clear_flag(desc->dev, OF_POPULATED);
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         }
577 err:
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
585 static u32 __of_msi_map_rid(struct device *dev, struct device_node **np,
586                             u32 rid_in)
587 {
588         struct device *parent_dev;
589         u32 rid_out = rid_in;
590
591         /*
592          * Walk up the device parent links looking for one with a
593          * "msi-map" property.
594          */
595         for (parent_dev = dev; parent_dev; parent_dev = parent_dev->parent)
596                 if (!of_pci_map_rid(parent_dev->of_node, rid_in, "msi-map",
597                                     "msi-map-mask", np, &rid_out))
598                         break;
599         return rid_out;
600 }
601
602 /**
603  * of_msi_map_rid - Map a MSI requester ID for a device.
604  * @dev: device for which the mapping is to be done.
605  * @msi_np: device node of the expected msi controller.
606  * @rid_in: unmapped MSI requester ID for the device.
607  *
608  * Walk up the device hierarchy looking for devices with a "msi-map"
609  * property.  If found, apply the mapping to @rid_in.
610  *
611  * Returns the mapped MSI requester ID.
612  */
613 u32 of_msi_map_rid(struct device *dev, struct device_node *msi_np, u32 rid_in)
614 {
615         return __of_msi_map_rid(dev, &msi_np, rid_in);
616 }
617
618 /**
619  * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain
620  * @dev: device for which the mapping is to be done.
621  * @rid: Requester ID for the device.
622  *
623  * Walk up the device hierarchy looking for devices with a "msi-map"
624  * property.
625  *
626  * Returns: the MSI domain for this device (or NULL on failure)
627  */
628 struct irq_domain *of_msi_map_get_device_domain(struct device *dev, u32 rid)
629 {
630         struct device_node *np = NULL;
631
632         __of_msi_map_rid(dev, &np, rid);
633         return irq_find_matching_host(np, DOMAIN_BUS_PCI_MSI);
634 }
635
636 /**
637  * of_msi_get_domain - Use msi-parent to find the relevant MSI domain
638  * @dev: device for which the domain is requested
639  * @np: device node for @dev
640  * @token: bus type for this domain
641  *
642  * Parse the msi-parent property (both the simple and the complex
643  * versions), and returns the corresponding MSI domain.
644  *
645  * Returns: the MSI domain for this device (or NULL on failure).
646  */
647 struct irq_domain *of_msi_get_domain(struct device *dev,
648                                      struct device_node *np,
649                                      enum irq_domain_bus_token token)
650 {
651         struct device_node *msi_np;
652         struct irq_domain *d;
653
654         /* Check for a single msi-parent property */
655         msi_np = of_parse_phandle(np, "msi-parent", 0);
656         if (msi_np && !of_property_read_bool(msi_np, "#msi-cells")) {
657                 d = irq_find_matching_host(msi_np, token);
658                 if (!d)
659                         of_node_put(msi_np);
660                 return d;
661         }
662
663         if (token == DOMAIN_BUS_PLATFORM_MSI) {
664                 /* Check for the complex msi-parent version */
665                 struct of_phandle_args args;
666                 int index = 0;
667
668                 while (!of_parse_phandle_with_args(np, "msi-parent",
669                                                    "#msi-cells",
670                                                    index, &args)) {
671                         d = irq_find_matching_host(args.np, token);
672                         if (d)
673                                 return d;
674
675                         of_node_put(args.np);
676                         index++;
677                 }
678         }
679
680         return NULL;
681 }
682
683 /**
684  * of_msi_configure - Set the msi_domain field of a device
685  * @dev: device structure to associate with an MSI irq domain
686  * @np: device node for that device
687  */
688 void of_msi_configure(struct device *dev, struct device_node *np)
689 {
690         dev_set_msi_domain(dev,
691                            of_msi_get_domain(dev, np, DOMAIN_BUS_PLATFORM_MSI));
692 }
693 EXPORT_SYMBOL_GPL(of_msi_configure);