1af6074fcSRob Herring // SPDX-License-Identifier: GPL-2.0+ 2e3873444SGrant Likely /* 3e3873444SGrant Likely * Derived from arch/i386/kernel/irq.c 4e3873444SGrant Likely * Copyright (C) 1992 Linus Torvalds 5e3873444SGrant Likely * Adapted from arch/i386 by Gary Thomas 6e3873444SGrant Likely * Copyright (C) 1995-1996 Gary Thomas (gdt@linuxppc.org) 7e3873444SGrant Likely * Updated and modified by Cort Dougan <cort@fsmlabs.com> 8e3873444SGrant Likely * Copyright (C) 1996-2001 Cort Dougan 9e3873444SGrant Likely * Adapted for Power Macintosh by Paul Mackerras 10e3873444SGrant Likely * Copyright (C) 1996 Paul Mackerras (paulus@cs.anu.edu.au) 11e3873444SGrant Likely * 12e3873444SGrant Likely * This file contains the code used to make IRQ descriptions in the 13e3873444SGrant Likely * device tree to actual irq numbers on an interrupt controller 14e3873444SGrant Likely * driver. 15e3873444SGrant Likely */ 16e3873444SGrant Likely 17606ad42aSRob Herring #define pr_fmt(fmt) "OF: " fmt 18606ad42aSRob Herring 19c706c239SMarc Zyngier #include <linux/device.h> 20e3873444SGrant Likely #include <linux/errno.h> 21c71a54b0SRob Herring #include <linux/list.h> 22e3873444SGrant Likely #include <linux/module.h> 23e3873444SGrant Likely #include <linux/of.h> 24e3873444SGrant Likely #include <linux/of_irq.h> 25e3873444SGrant Likely #include <linux/string.h> 26c71a54b0SRob Herring #include <linux/slab.h> 27e3873444SGrant Likely 28e3873444SGrant Likely /** 29e3873444SGrant Likely * irq_of_parse_and_map - Parse and map an interrupt into linux virq space 30d84ff46aSYijing Wang * @dev: Device node of the device whose interrupt is to be mapped 31e3873444SGrant Likely * @index: Index of the interrupt to map 32e3873444SGrant Likely * 330c02c800SGrant Likely * This function is a wrapper that chains of_irq_parse_one() and 34e3873444SGrant Likely * irq_create_of_mapping() to make things easier to callers 35e3873444SGrant Likely */ 36e3873444SGrant Likely unsigned int irq_of_parse_and_map(struct device_node *dev, int index) 37e3873444SGrant Likely { 38530210c7SGrant Likely struct of_phandle_args oirq; 39e3873444SGrant Likely 400c02c800SGrant Likely if (of_irq_parse_one(dev, index, &oirq)) 4177a7300aSAnton Vorontsov return 0; 42e3873444SGrant Likely 43e6d30ab1SGrant Likely return irq_create_of_mapping(&oirq); 44e3873444SGrant Likely } 45e3873444SGrant Likely EXPORT_SYMBOL_GPL(irq_of_parse_and_map); 467dc2e113SGrant Likely 477dc2e113SGrant Likely /** 487dc2e113SGrant Likely * of_irq_find_parent - Given a device node, find its interrupt parent node 497dc2e113SGrant Likely * @child: pointer to device node 507dc2e113SGrant Likely * 517dc2e113SGrant Likely * Returns a pointer to the interrupt parent node, or NULL if the interrupt 527dc2e113SGrant Likely * parent could not be determined. 537dc2e113SGrant Likely */ 544c3141e0SCarlo Caione struct device_node *of_irq_find_parent(struct device_node *child) 557dc2e113SGrant Likely { 56b4bbb029SLinus Torvalds struct device_node *p; 57fa976ff7SSergei Shtylyov phandle parent; 587dc2e113SGrant Likely 59b4bbb029SLinus Torvalds if (!of_node_get(child)) 607dc2e113SGrant Likely return NULL; 617dc2e113SGrant Likely 627dc2e113SGrant Likely do { 63fa976ff7SSergei Shtylyov if (of_property_read_u32(child, "interrupt-parent", &parent)) { 64b4bbb029SLinus Torvalds p = of_get_parent(child); 65fa976ff7SSergei Shtylyov } else { 667dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) 677dc2e113SGrant Likely p = of_node_get(of_irq_dflt_pic); 687dc2e113SGrant Likely else 69fa976ff7SSergei Shtylyov p = of_find_node_by_phandle(parent); 707dc2e113SGrant Likely } 71b4bbb029SLinus Torvalds of_node_put(child); 72b4bbb029SLinus Torvalds child = p; 737dc2e113SGrant Likely } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL); 747dc2e113SGrant Likely 75b4bbb029SLinus Torvalds return p; 767dc2e113SGrant Likely } 774c3141e0SCarlo Caione EXPORT_SYMBOL_GPL(of_irq_find_parent); 787dc2e113SGrant Likely 797dc2e113SGrant Likely /** 800c02c800SGrant Likely * of_irq_parse_raw - Low level interrupt tree parsing 8123616132SGrant Likely * @addr: address specifier (start of "reg" property of the device) in be32 format 82fae3b9cdSVasyl Gomonovych * @out_irq: structure of_phandle_args updated by this function 837dc2e113SGrant Likely * 847dc2e113SGrant Likely * Returns 0 on success and a negative number on error 857dc2e113SGrant Likely * 867dc2e113SGrant Likely * This function is a low-level interrupt tree walking function. It 877dc2e113SGrant Likely * can be used to do a partial walk with synthetized reg and interrupts 887dc2e113SGrant Likely * properties, for example when resolving PCI interrupts when no device 8923616132SGrant Likely * node exist for the parent. It takes an interrupt specifier structure as 9023616132SGrant Likely * input, walks the tree looking for any interrupt-map properties, translates 9123616132SGrant Likely * the specifier for each map, and then returns the translated map. 927dc2e113SGrant Likely */ 9323616132SGrant Likely int of_irq_parse_raw(const __be32 *addr, struct of_phandle_args *out_irq) 947dc2e113SGrant Likely { 957dc2e113SGrant Likely struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL; 96355e62f5SGrant Likely __be32 initial_match_array[MAX_PHANDLE_ARGS]; 9723616132SGrant Likely const __be32 *match_array = initial_match_array; 9817a70355SRob Herring const __be32 *tmp, *imap, *imask, dummy_imask[] = { [0 ... MAX_PHANDLE_ARGS] = cpu_to_be32(~0) }; 997dc2e113SGrant Likely u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0; 100f1aa5484SGuilherme G. Piccoli int imaplen, match, i, rc = -EINVAL; 1017dc2e113SGrant Likely 102624cfca5SGrant Likely #ifdef DEBUG 103624cfca5SGrant Likely of_print_phandle_args("of_irq_parse_raw: ", out_irq); 104624cfca5SGrant Likely #endif 1057dc2e113SGrant Likely 10623616132SGrant Likely ipar = of_node_get(out_irq->np); 1077dc2e113SGrant Likely 1087dc2e113SGrant Likely /* First get the #interrupt-cells property of the current cursor 1097dc2e113SGrant Likely * that tells us how to interpret the passed-in intspec. If there 1107dc2e113SGrant Likely * is none, we are nice and just walk up the tree 1117dc2e113SGrant Likely */ 1127dc2e113SGrant Likely do { 113fa976ff7SSergei Shtylyov if (!of_property_read_u32(ipar, "#interrupt-cells", &intsize)) 1147dc2e113SGrant Likely break; 1157dc2e113SGrant Likely tnode = ipar; 1167dc2e113SGrant Likely ipar = of_irq_find_parent(ipar); 1177dc2e113SGrant Likely of_node_put(tnode); 1187dc2e113SGrant Likely } while (ipar); 1197dc2e113SGrant Likely if (ipar == NULL) { 1207dc2e113SGrant Likely pr_debug(" -> no parent found !\n"); 1217dc2e113SGrant Likely goto fail; 1227dc2e113SGrant Likely } 1237dc2e113SGrant Likely 1240d638a07SRob Herring pr_debug("of_irq_parse_raw: ipar=%pOF, size=%d\n", ipar, intsize); 1257dc2e113SGrant Likely 12623616132SGrant Likely if (out_irq->args_count != intsize) 127f1aa5484SGuilherme G. Piccoli goto fail; 1287dc2e113SGrant Likely 1297dc2e113SGrant Likely /* Look for this #address-cells. We have to implement the old linux 1307dc2e113SGrant Likely * trick of looking for the parent here as some device-trees rely on it 1317dc2e113SGrant Likely */ 1327dc2e113SGrant Likely old = of_node_get(ipar); 1337dc2e113SGrant Likely do { 1347dc2e113SGrant Likely tmp = of_get_property(old, "#address-cells", NULL); 1357dc2e113SGrant Likely tnode = of_get_parent(old); 1367dc2e113SGrant Likely of_node_put(old); 1377dc2e113SGrant Likely old = tnode; 1387dc2e113SGrant Likely } while (old && tmp == NULL); 1397dc2e113SGrant Likely of_node_put(old); 1407dc2e113SGrant Likely old = NULL; 141a7c194b0SRob Herring addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp); 1427dc2e113SGrant Likely 1437dc2e113SGrant Likely pr_debug(" -> addrsize=%d\n", addrsize); 1447dc2e113SGrant Likely 145355e62f5SGrant Likely /* Range check so that the temporary buffer doesn't overflow */ 146f1aa5484SGuilherme G. Piccoli if (WARN_ON(addrsize + intsize > MAX_PHANDLE_ARGS)) { 147f1aa5484SGuilherme G. Piccoli rc = -EFAULT; 148355e62f5SGrant Likely goto fail; 149f1aa5484SGuilherme G. Piccoli } 150355e62f5SGrant Likely 15123616132SGrant Likely /* Precalculate the match array - this simplifies match loop */ 15223616132SGrant Likely for (i = 0; i < addrsize; i++) 15378119fd1SGrant Likely initial_match_array[i] = addr ? addr[i] : 0; 15423616132SGrant Likely for (i = 0; i < intsize; i++) 15523616132SGrant Likely initial_match_array[addrsize + i] = cpu_to_be32(out_irq->args[i]); 15623616132SGrant Likely 1577dc2e113SGrant Likely /* Now start the actual "proper" walk of the interrupt tree */ 1587dc2e113SGrant Likely while (ipar != NULL) { 1597dc2e113SGrant Likely /* Now check if cursor is an interrupt-controller and if it is 1607dc2e113SGrant Likely * then we are done 1617dc2e113SGrant Likely */ 1626a245d95SSergei Shtylyov if (of_property_read_bool(ipar, "interrupt-controller")) { 1637dc2e113SGrant Likely pr_debug(" -> got it !\n"); 1647dc2e113SGrant Likely return 0; 1657dc2e113SGrant Likely } 1667dc2e113SGrant Likely 16778119fd1SGrant Likely /* 16878119fd1SGrant Likely * interrupt-map parsing does not work without a reg 16978119fd1SGrant Likely * property when #address-cells != 0 17078119fd1SGrant Likely */ 17178119fd1SGrant Likely if (addrsize && !addr) { 17278119fd1SGrant Likely pr_debug(" -> no reg passed in when needed !\n"); 17378119fd1SGrant Likely goto fail; 17478119fd1SGrant Likely } 17578119fd1SGrant Likely 1767dc2e113SGrant Likely /* Now look for an interrupt-map */ 1777dc2e113SGrant Likely imap = of_get_property(ipar, "interrupt-map", &imaplen); 1787dc2e113SGrant Likely /* No interrupt map, check for an interrupt parent */ 1797dc2e113SGrant Likely if (imap == NULL) { 1807dc2e113SGrant Likely pr_debug(" -> no map, getting parent\n"); 1817dc2e113SGrant Likely newpar = of_irq_find_parent(ipar); 1827dc2e113SGrant Likely goto skiplevel; 1837dc2e113SGrant Likely } 1847dc2e113SGrant Likely imaplen /= sizeof(u32); 1857dc2e113SGrant Likely 1867dc2e113SGrant Likely /* Look for a mask */ 1877dc2e113SGrant Likely imask = of_get_property(ipar, "interrupt-map-mask", NULL); 18823616132SGrant Likely if (!imask) 18923616132SGrant Likely imask = dummy_imask; 1907dc2e113SGrant Likely 1917dc2e113SGrant Likely /* Parse interrupt-map */ 1927dc2e113SGrant Likely match = 0; 1937dc2e113SGrant Likely while (imaplen > (addrsize + intsize + 1) && !match) { 1947dc2e113SGrant Likely /* Compare specifiers */ 1957dc2e113SGrant Likely match = 1; 19623616132SGrant Likely for (i = 0; i < (addrsize + intsize); i++, imaplen--) 19774dac2edSTomasz Figa match &= !((match_array[i] ^ *imap++) & imask[i]); 1987dc2e113SGrant Likely 1997dc2e113SGrant Likely pr_debug(" -> match=%d (imaplen=%d)\n", match, imaplen); 2007dc2e113SGrant Likely 2017dc2e113SGrant Likely /* Get the interrupt parent */ 2027dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) 2037dc2e113SGrant Likely newpar = of_node_get(of_irq_dflt_pic); 2047dc2e113SGrant Likely else 2059a6b2e58SGrant Likely newpar = of_find_node_by_phandle(be32_to_cpup(imap)); 2067dc2e113SGrant Likely imap++; 2077dc2e113SGrant Likely --imaplen; 2087dc2e113SGrant Likely 2097dc2e113SGrant Likely /* Check if not found */ 2107dc2e113SGrant Likely if (newpar == NULL) { 2117dc2e113SGrant Likely pr_debug(" -> imap parent not found !\n"); 2127dc2e113SGrant Likely goto fail; 2137dc2e113SGrant Likely } 2147dc2e113SGrant Likely 2151ca56e7dSPeter Crosthwaite if (!of_device_is_available(newpar)) 2161ca56e7dSPeter Crosthwaite match = 0; 2171ca56e7dSPeter Crosthwaite 2187dc2e113SGrant Likely /* Get #interrupt-cells and #address-cells of new 2197dc2e113SGrant Likely * parent 2207dc2e113SGrant Likely */ 221fa976ff7SSergei Shtylyov if (of_property_read_u32(newpar, "#interrupt-cells", 222fa976ff7SSergei Shtylyov &newintsize)) { 2237dc2e113SGrant Likely pr_debug(" -> parent lacks #interrupt-cells!\n"); 2247dc2e113SGrant Likely goto fail; 2257dc2e113SGrant Likely } 226fa976ff7SSergei Shtylyov if (of_property_read_u32(newpar, "#address-cells", 227fa976ff7SSergei Shtylyov &newaddrsize)) 228fa976ff7SSergei Shtylyov newaddrsize = 0; 2297dc2e113SGrant Likely 2307dc2e113SGrant Likely pr_debug(" -> newintsize=%d, newaddrsize=%d\n", 2317dc2e113SGrant Likely newintsize, newaddrsize); 2327dc2e113SGrant Likely 2337dc2e113SGrant Likely /* Check for malformed properties */ 234f1aa5484SGuilherme G. Piccoli if (WARN_ON(newaddrsize + newintsize > MAX_PHANDLE_ARGS) 235f1aa5484SGuilherme G. Piccoli || (imaplen < (newaddrsize + newintsize))) { 236f1aa5484SGuilherme G. Piccoli rc = -EFAULT; 237355e62f5SGrant Likely goto fail; 238f1aa5484SGuilherme G. Piccoli } 2397dc2e113SGrant Likely 2407dc2e113SGrant Likely imap += newaddrsize + newintsize; 2417dc2e113SGrant Likely imaplen -= newaddrsize + newintsize; 2427dc2e113SGrant Likely 2437dc2e113SGrant Likely pr_debug(" -> imaplen=%d\n", imaplen); 2447dc2e113SGrant Likely } 2457dc2e113SGrant Likely if (!match) 2467dc2e113SGrant Likely goto fail; 2477dc2e113SGrant Likely 24823616132SGrant Likely /* 24923616132SGrant Likely * Successfully parsed an interrrupt-map translation; copy new 25023616132SGrant Likely * interrupt specifier into the out_irq structure 25123616132SGrant Likely */ 25223616132SGrant Likely match_array = imap - newaddrsize - newintsize; 25323616132SGrant Likely for (i = 0; i < newintsize; i++) 25423616132SGrant Likely out_irq->args[i] = be32_to_cpup(imap - newintsize + i); 25523616132SGrant Likely out_irq->args_count = intsize = newintsize; 2567dc2e113SGrant Likely addrsize = newaddrsize; 2577dc2e113SGrant Likely 2587dc2e113SGrant Likely skiplevel: 2597dc2e113SGrant Likely /* Iterate again with new parent */ 260d23b2516SJeremy Linton out_irq->np = newpar; 2610d638a07SRob Herring pr_debug(" -> new parent: %pOF\n", newpar); 2627dc2e113SGrant Likely of_node_put(ipar); 2637dc2e113SGrant Likely ipar = newpar; 2647dc2e113SGrant Likely newpar = NULL; 2657dc2e113SGrant Likely } 266f1aa5484SGuilherme G. Piccoli rc = -ENOENT; /* No interrupt-map found */ 267f1aa5484SGuilherme G. Piccoli 2687dc2e113SGrant Likely fail: 2697dc2e113SGrant Likely of_node_put(ipar); 2707dc2e113SGrant Likely of_node_put(newpar); 2717dc2e113SGrant Likely 272f1aa5484SGuilherme G. Piccoli return rc; 2737dc2e113SGrant Likely } 2740c02c800SGrant Likely EXPORT_SYMBOL_GPL(of_irq_parse_raw); 2757dc2e113SGrant Likely 2767dc2e113SGrant Likely /** 2770c02c800SGrant Likely * of_irq_parse_one - Resolve an interrupt for a device 2787dc2e113SGrant Likely * @device: the device whose interrupt is to be resolved 2797dc2e113SGrant Likely * @index: index of the interrupt to resolve 28083f82d7aSLubomir Rintel * @out_irq: structure of_phandle_args filled by this function 2817dc2e113SGrant Likely * 28223616132SGrant Likely * This function resolves an interrupt for a node by walking the interrupt tree, 28323616132SGrant Likely * finding which interrupt controller node it is attached to, and returning the 28423616132SGrant Likely * interrupt specifier that can be used to retrieve a Linux IRQ number. 2857dc2e113SGrant Likely */ 286530210c7SGrant Likely int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq) 2877dc2e113SGrant Likely { 2887dc2e113SGrant Likely struct device_node *p; 289b47fe22dSRob Herring const __be32 *addr; 290b47fe22dSRob Herring u32 intsize; 291d7c14605SLaurent Pinchart int i, res; 2927dc2e113SGrant Likely 2930d638a07SRob Herring pr_debug("of_irq_parse_one: dev=%pOF, index=%d\n", device, index); 2947dc2e113SGrant Likely 2957dc2e113SGrant Likely /* OldWorld mac stuff is "special", handle out of line */ 2967dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC) 2970c02c800SGrant Likely return of_irq_parse_oldworld(device, index, out_irq); 2987dc2e113SGrant Likely 29979d97015SGrant Likely /* Get the reg property (if any) */ 30079d97015SGrant Likely addr = of_get_property(device, "reg", NULL); 30179d97015SGrant Likely 302a9ecdc0fSFlorian Fainelli /* Try the new-style interrupts-extended first */ 30379d97015SGrant Likely res = of_parse_phandle_with_args(device, "interrupts-extended", 30479d97015SGrant Likely "#interrupt-cells", index, out_irq); 305a9ecdc0fSFlorian Fainelli if (!res) 30679d97015SGrant Likely return of_irq_parse_raw(addr, out_irq); 307a9ecdc0fSFlorian Fainelli 3087dc2e113SGrant Likely /* Look for the interrupt parent. */ 3097dc2e113SGrant Likely p = of_irq_find_parent(device); 3107dc2e113SGrant Likely if (p == NULL) 3117dc2e113SGrant Likely return -EINVAL; 3127dc2e113SGrant Likely 3137dc2e113SGrant Likely /* Get size of interrupt specifier */ 314fa976ff7SSergei Shtylyov if (of_property_read_u32(p, "#interrupt-cells", &intsize)) { 315d7c14605SLaurent Pinchart res = -EINVAL; 3167dc2e113SGrant Likely goto out; 317d7c14605SLaurent Pinchart } 3187dc2e113SGrant Likely 319b47fe22dSRob Herring pr_debug(" parent=%pOF, intsize=%d\n", p, intsize); 3207dc2e113SGrant Likely 32123616132SGrant Likely /* Copy intspec into irq structure */ 32223616132SGrant Likely out_irq->np = p; 32323616132SGrant Likely out_irq->args_count = intsize; 324b47fe22dSRob Herring for (i = 0; i < intsize; i++) { 325b47fe22dSRob Herring res = of_property_read_u32_index(device, "interrupts", 326b47fe22dSRob Herring (index * intsize) + i, 327b47fe22dSRob Herring out_irq->args + i); 328b47fe22dSRob Herring if (res) 32923616132SGrant Likely goto out; 33023616132SGrant Likely } 33123616132SGrant Likely 332b47fe22dSRob Herring pr_debug(" intspec=%d\n", *out_irq->args); 333b47fe22dSRob Herring 33423616132SGrant Likely 33523616132SGrant Likely /* Check if there are any interrupt-map translations to process */ 33623616132SGrant Likely res = of_irq_parse_raw(addr, out_irq); 3377dc2e113SGrant Likely out: 3387dc2e113SGrant Likely of_node_put(p); 3397dc2e113SGrant Likely return res; 3407dc2e113SGrant Likely } 3410c02c800SGrant Likely EXPORT_SYMBOL_GPL(of_irq_parse_one); 3427dc2e113SGrant Likely 3437dc2e113SGrant Likely /** 3447dc2e113SGrant Likely * of_irq_to_resource - Decode a node's IRQ and return it as a resource 3457dc2e113SGrant Likely * @dev: pointer to device tree node 3467dc2e113SGrant Likely * @index: zero-based index of the irq 3477dc2e113SGrant Likely * @r: pointer to resource structure to return result into. 3487dc2e113SGrant Likely */ 3497dc2e113SGrant Likely int of_irq_to_resource(struct device_node *dev, int index, struct resource *r) 3507dc2e113SGrant Likely { 3517a4228bbSThomas Petazzoni int irq = of_irq_get(dev, index); 3527a4228bbSThomas Petazzoni 3537a4228bbSThomas Petazzoni if (irq < 0) 3547a4228bbSThomas Petazzoni return irq; 3557dc2e113SGrant Likely 3567dc2e113SGrant Likely /* Only dereference the resource if both the 3577dc2e113SGrant Likely * resource and the irq are valid. */ 35877a7300aSAnton Vorontsov if (r && irq) { 359661db794SBenoit Cousson const char *name = NULL; 360661db794SBenoit Cousson 361cf9e2368SSebastian Andrzej Siewior memset(r, 0, sizeof(*r)); 362661db794SBenoit Cousson /* 363ae107d06SGeert Uytterhoeven * Get optional "interrupt-names" property to add a name 364661db794SBenoit Cousson * to the resource. 365661db794SBenoit Cousson */ 366661db794SBenoit Cousson of_property_read_string_index(dev, "interrupt-names", index, 367661db794SBenoit Cousson &name); 368661db794SBenoit Cousson 3697dc2e113SGrant Likely r->start = r->end = irq; 3704a43d686STomasz Figa r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq)); 3718804827bSGrant Likely r->name = name ? name : of_node_full_name(dev); 3727dc2e113SGrant Likely } 3737dc2e113SGrant Likely 3747dc2e113SGrant Likely return irq; 3757dc2e113SGrant Likely } 3767dc2e113SGrant Likely EXPORT_SYMBOL_GPL(of_irq_to_resource); 37752f6537cSAndres Salomon 37852f6537cSAndres Salomon /** 37939935466SSergei Shtylyov * of_irq_get - Decode a node's IRQ and return it as a Linux IRQ number 3809ec36cafSRob Herring * @dev: pointer to device tree node 38139935466SSergei Shtylyov * @index: zero-based index of the IRQ 3829ec36cafSRob Herring * 38339935466SSergei Shtylyov * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or 38439935466SSergei Shtylyov * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case 38539935466SSergei Shtylyov * of any other failure. 3869ec36cafSRob Herring */ 3879ec36cafSRob Herring int of_irq_get(struct device_node *dev, int index) 3889ec36cafSRob Herring { 3899ec36cafSRob Herring int rc; 3909ec36cafSRob Herring struct of_phandle_args oirq; 3919ec36cafSRob Herring struct irq_domain *domain; 3929ec36cafSRob Herring 3939ec36cafSRob Herring rc = of_irq_parse_one(dev, index, &oirq); 3949ec36cafSRob Herring if (rc) 3959ec36cafSRob Herring return rc; 3969ec36cafSRob Herring 3979ec36cafSRob Herring domain = irq_find_host(oirq.np); 3989ec36cafSRob Herring if (!domain) 3999ec36cafSRob Herring return -EPROBE_DEFER; 4009ec36cafSRob Herring 4019ec36cafSRob Herring return irq_create_of_mapping(&oirq); 4029ec36cafSRob Herring } 4039eb08fb3SLaurent Pinchart EXPORT_SYMBOL_GPL(of_irq_get); 4049ec36cafSRob Herring 4059ec36cafSRob Herring /** 40639935466SSergei Shtylyov * of_irq_get_byname - Decode a node's IRQ and return it as a Linux IRQ number 407ad69674eSGrygorii Strashko * @dev: pointer to device tree node 40839935466SSergei Shtylyov * @name: IRQ name 409ad69674eSGrygorii Strashko * 41039935466SSergei Shtylyov * Returns Linux IRQ number on success, or 0 on the IRQ mapping failure, or 41139935466SSergei Shtylyov * -EPROBE_DEFER if the IRQ domain is not yet created, or error code in case 41239935466SSergei Shtylyov * of any other failure. 413ad69674eSGrygorii Strashko */ 414ad69674eSGrygorii Strashko int of_irq_get_byname(struct device_node *dev, const char *name) 415ad69674eSGrygorii Strashko { 416ad69674eSGrygorii Strashko int index; 417ad69674eSGrygorii Strashko 418ad69674eSGrygorii Strashko if (unlikely(!name)) 419ad69674eSGrygorii Strashko return -EINVAL; 420ad69674eSGrygorii Strashko 421ad69674eSGrygorii Strashko index = of_property_match_string(dev, "interrupt-names", name); 422ad69674eSGrygorii Strashko if (index < 0) 423ad69674eSGrygorii Strashko return index; 424ad69674eSGrygorii Strashko 425ad69674eSGrygorii Strashko return of_irq_get(dev, index); 426ad69674eSGrygorii Strashko } 4276602c452SDmitry Torokhov EXPORT_SYMBOL_GPL(of_irq_get_byname); 428ad69674eSGrygorii Strashko 429ad69674eSGrygorii Strashko /** 43052f6537cSAndres Salomon * of_irq_count - Count the number of IRQs a node uses 43152f6537cSAndres Salomon * @dev: pointer to device tree node 43252f6537cSAndres Salomon */ 43352f6537cSAndres Salomon int of_irq_count(struct device_node *dev) 43452f6537cSAndres Salomon { 4353da52787SThierry Reding struct of_phandle_args irq; 43652f6537cSAndres Salomon int nr = 0; 43752f6537cSAndres Salomon 4383da52787SThierry Reding while (of_irq_parse_one(dev, nr, &irq) == 0) 43952f6537cSAndres Salomon nr++; 44052f6537cSAndres Salomon 44152f6537cSAndres Salomon return nr; 44252f6537cSAndres Salomon } 44352f6537cSAndres Salomon 44452f6537cSAndres Salomon /** 44552f6537cSAndres Salomon * of_irq_to_resource_table - Fill in resource table with node's IRQ info 44652f6537cSAndres Salomon * @dev: pointer to device tree node 44752f6537cSAndres Salomon * @res: array of resources to fill in 44852f6537cSAndres Salomon * @nr_irqs: the number of IRQs (and upper bound for num of @res elements) 44952f6537cSAndres Salomon * 45052f6537cSAndres Salomon * Returns the size of the filled in table (up to @nr_irqs). 45152f6537cSAndres Salomon */ 45252f6537cSAndres Salomon int of_irq_to_resource_table(struct device_node *dev, struct resource *res, 45352f6537cSAndres Salomon int nr_irqs) 45452f6537cSAndres Salomon { 45552f6537cSAndres Salomon int i; 45652f6537cSAndres Salomon 45752f6537cSAndres Salomon for (i = 0; i < nr_irqs; i++, res++) 458531da740SSergei Shtylyov if (of_irq_to_resource(dev, i, res) <= 0) 45952f6537cSAndres Salomon break; 46052f6537cSAndres Salomon 46152f6537cSAndres Salomon return i; 46252f6537cSAndres Salomon } 463a4f8bf22SJohn Crispin EXPORT_SYMBOL_GPL(of_irq_to_resource_table); 464c71a54b0SRob Herring 46548a9b733SGeert Uytterhoeven struct of_intc_desc { 466c71a54b0SRob Herring struct list_head list; 467264041e3SMasahiro Yamada of_irq_init_cb_t irq_init_cb; 468c71a54b0SRob Herring struct device_node *dev; 469c71a54b0SRob Herring struct device_node *interrupt_parent; 470c71a54b0SRob Herring }; 471c71a54b0SRob Herring 472c71a54b0SRob Herring /** 473c71a54b0SRob Herring * of_irq_init - Scan and init matching interrupt controllers in DT 474c71a54b0SRob Herring * @matches: 0 terminated array of nodes to match and init function to call 475c71a54b0SRob Herring * 476c71a54b0SRob Herring * This function scans the device tree for matching interrupt controller nodes, 477c71a54b0SRob Herring * and calls their initialization functions in order with parents first. 478c71a54b0SRob Herring */ 479c71a54b0SRob Herring void __init of_irq_init(const struct of_device_id *matches) 480c71a54b0SRob Herring { 481264041e3SMasahiro Yamada const struct of_device_id *match; 482c71a54b0SRob Herring struct device_node *np, *parent = NULL; 48348a9b733SGeert Uytterhoeven struct of_intc_desc *desc, *temp_desc; 484c71a54b0SRob Herring struct list_head intc_desc_list, intc_parent_list; 485c71a54b0SRob Herring 486c71a54b0SRob Herring INIT_LIST_HEAD(&intc_desc_list); 487c71a54b0SRob Herring INIT_LIST_HEAD(&intc_parent_list); 488c71a54b0SRob Herring 489264041e3SMasahiro Yamada for_each_matching_node_and_match(np, matches, &match) { 4906a245d95SSergei Shtylyov if (!of_property_read_bool(np, "interrupt-controller") || 491bf49be02SPeter Crosthwaite !of_device_is_available(np)) 492c71a54b0SRob Herring continue; 493264041e3SMasahiro Yamada 494264041e3SMasahiro Yamada if (WARN(!match->data, "of_irq_init: no init function for %s\n", 495264041e3SMasahiro Yamada match->compatible)) 496264041e3SMasahiro Yamada continue; 497264041e3SMasahiro Yamada 498c71a54b0SRob Herring /* 49948a9b733SGeert Uytterhoeven * Here, we allocate and populate an of_intc_desc with the node 500c71a54b0SRob Herring * pointer, interrupt-parent device_node etc. 501c71a54b0SRob Herring */ 502c71a54b0SRob Herring desc = kzalloc(sizeof(*desc), GFP_KERNEL); 5036f7dc9a3SGeert Uytterhoeven if (!desc) { 5048363ccb9SJulia Lawall of_node_put(np); 505c71a54b0SRob Herring goto err; 5068363ccb9SJulia Lawall } 507c71a54b0SRob Herring 508264041e3SMasahiro Yamada desc->irq_init_cb = match->data; 5098363ccb9SJulia Lawall desc->dev = of_node_get(np); 510c71a54b0SRob Herring desc->interrupt_parent = of_irq_find_parent(np); 511d7fb6d0aSRob Herring if (desc->interrupt_parent == np) 512d7fb6d0aSRob Herring desc->interrupt_parent = NULL; 513c71a54b0SRob Herring list_add_tail(&desc->list, &intc_desc_list); 514c71a54b0SRob Herring } 515c71a54b0SRob Herring 516c71a54b0SRob Herring /* 517c71a54b0SRob Herring * The root irq controller is the one without an interrupt-parent. 518c71a54b0SRob Herring * That one goes first, followed by the controllers that reference it, 519c71a54b0SRob Herring * followed by the ones that reference the 2nd level controllers, etc. 520c71a54b0SRob Herring */ 521c71a54b0SRob Herring while (!list_empty(&intc_desc_list)) { 522c71a54b0SRob Herring /* 523c71a54b0SRob Herring * Process all controllers with the current 'parent'. 524c71a54b0SRob Herring * First pass will be looking for NULL as the parent. 525c71a54b0SRob Herring * The assumption is that NULL parent means a root controller. 526c71a54b0SRob Herring */ 527c71a54b0SRob Herring list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) { 528c71a54b0SRob Herring int ret; 529c71a54b0SRob Herring 530c71a54b0SRob Herring if (desc->interrupt_parent != parent) 531c71a54b0SRob Herring continue; 532c71a54b0SRob Herring 533c71a54b0SRob Herring list_del(&desc->list); 534c71a54b0SRob Herring 535e55aeb6bSPhilipp Zabel of_node_set_flag(desc->dev, OF_POPULATED); 536e55aeb6bSPhilipp Zabel 5370d638a07SRob Herring pr_debug("of_irq_init: init %pOF (%p), parent %p\n", 5380d638a07SRob Herring desc->dev, 539c71a54b0SRob Herring desc->dev, desc->interrupt_parent); 540264041e3SMasahiro Yamada ret = desc->irq_init_cb(desc->dev, 541264041e3SMasahiro Yamada desc->interrupt_parent); 542c71a54b0SRob Herring if (ret) { 543e55aeb6bSPhilipp Zabel of_node_clear_flag(desc->dev, OF_POPULATED); 544c71a54b0SRob Herring kfree(desc); 545c71a54b0SRob Herring continue; 546c71a54b0SRob Herring } 547c71a54b0SRob Herring 548c71a54b0SRob Herring /* 549c71a54b0SRob Herring * This one is now set up; add it to the parent list so 550c71a54b0SRob Herring * its children can get processed in a subsequent pass. 551c71a54b0SRob Herring */ 552c71a54b0SRob Herring list_add_tail(&desc->list, &intc_parent_list); 553c71a54b0SRob Herring } 554c71a54b0SRob Herring 555c71a54b0SRob Herring /* Get the next pending parent that might have children */ 556c0cdfaa0SAxel Lin desc = list_first_entry_or_null(&intc_parent_list, 557c0cdfaa0SAxel Lin typeof(*desc), list); 558c0cdfaa0SAxel Lin if (!desc) { 559c71a54b0SRob Herring pr_err("of_irq_init: children remain, but no parents\n"); 560c71a54b0SRob Herring break; 561c71a54b0SRob Herring } 562c71a54b0SRob Herring list_del(&desc->list); 563c71a54b0SRob Herring parent = desc->dev; 564c71a54b0SRob Herring kfree(desc); 565c71a54b0SRob Herring } 566c71a54b0SRob Herring 567c71a54b0SRob Herring list_for_each_entry_safe(desc, temp_desc, &intc_parent_list, list) { 568c71a54b0SRob Herring list_del(&desc->list); 569c71a54b0SRob Herring kfree(desc); 570c71a54b0SRob Herring } 571c71a54b0SRob Herring err: 572c71a54b0SRob Herring list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) { 573c71a54b0SRob Herring list_del(&desc->list); 5748363ccb9SJulia Lawall of_node_put(desc->dev); 575c71a54b0SRob Herring kfree(desc); 576c71a54b0SRob Herring } 577c71a54b0SRob Herring } 578c706c239SMarc Zyngier 579a251b263SMarc Zyngier static u32 __of_msi_map_rid(struct device *dev, struct device_node **np, 580a251b263SMarc Zyngier u32 rid_in) 5818db02d8bSDavid Daney { 5828db02d8bSDavid Daney struct device *parent_dev; 5838db02d8bSDavid Daney u32 rid_out = rid_in; 5848db02d8bSDavid Daney 5858db02d8bSDavid Daney /* 5868db02d8bSDavid Daney * Walk up the device parent links looking for one with a 5878db02d8bSDavid Daney * "msi-map" property. 5888db02d8bSDavid Daney */ 589987068fcSRobin Murphy for (parent_dev = dev; parent_dev; parent_dev = parent_dev->parent) 590746a71d0SLorenzo Pieralisi if (!of_map_id(parent_dev->of_node, rid_in, "msi-map", 591987068fcSRobin Murphy "msi-map-mask", np, &rid_out)) 5928db02d8bSDavid Daney break; 5938db02d8bSDavid Daney return rid_out; 5948db02d8bSDavid Daney } 59548ae34fbSMarc Zyngier 596a251b263SMarc Zyngier /** 597a251b263SMarc Zyngier * of_msi_map_rid - Map a MSI requester ID for a device. 598a251b263SMarc Zyngier * @dev: device for which the mapping is to be done. 599a251b263SMarc Zyngier * @msi_np: device node of the expected msi controller. 600a251b263SMarc Zyngier * @rid_in: unmapped MSI requester ID for the device. 601a251b263SMarc Zyngier * 602a251b263SMarc Zyngier * Walk up the device hierarchy looking for devices with a "msi-map" 603a251b263SMarc Zyngier * property. If found, apply the mapping to @rid_in. 604a251b263SMarc Zyngier * 605a251b263SMarc Zyngier * Returns the mapped MSI requester ID. 606a251b263SMarc Zyngier */ 607a251b263SMarc Zyngier u32 of_msi_map_rid(struct device *dev, struct device_node *msi_np, u32 rid_in) 608a251b263SMarc Zyngier { 609a251b263SMarc Zyngier return __of_msi_map_rid(dev, &msi_np, rid_in); 610a251b263SMarc Zyngier } 611a251b263SMarc Zyngier 61248ae34fbSMarc Zyngier /** 61382b9b424SMarc Zyngier * of_msi_map_get_device_domain - Use msi-map to find the relevant MSI domain 61482b9b424SMarc Zyngier * @dev: device for which the mapping is to be done. 61582b9b424SMarc Zyngier * @rid: Requester ID for the device. 616*6f881abaSDiana Craciun * @bus_token: Bus token 61782b9b424SMarc Zyngier * 61882b9b424SMarc Zyngier * Walk up the device hierarchy looking for devices with a "msi-map" 61982b9b424SMarc Zyngier * property. 62082b9b424SMarc Zyngier * 62182b9b424SMarc Zyngier * Returns: the MSI domain for this device (or NULL on failure) 62282b9b424SMarc Zyngier */ 623*6f881abaSDiana Craciun struct irq_domain *of_msi_map_get_device_domain(struct device *dev, u32 id, 624*6f881abaSDiana Craciun u32 bus_token) 62582b9b424SMarc Zyngier { 62682b9b424SMarc Zyngier struct device_node *np = NULL; 62782b9b424SMarc Zyngier 628*6f881abaSDiana Craciun __of_msi_map_rid(dev, &np, id); 629*6f881abaSDiana Craciun return irq_find_matching_host(np, bus_token); 63082b9b424SMarc Zyngier } 63182b9b424SMarc Zyngier 63282b9b424SMarc Zyngier /** 63348ae34fbSMarc Zyngier * of_msi_get_domain - Use msi-parent to find the relevant MSI domain 63448ae34fbSMarc Zyngier * @dev: device for which the domain is requested 63548ae34fbSMarc Zyngier * @np: device node for @dev 63648ae34fbSMarc Zyngier * @token: bus type for this domain 63748ae34fbSMarc Zyngier * 63848ae34fbSMarc Zyngier * Parse the msi-parent property (both the simple and the complex 63948ae34fbSMarc Zyngier * versions), and returns the corresponding MSI domain. 64048ae34fbSMarc Zyngier * 64148ae34fbSMarc Zyngier * Returns: the MSI domain for this device (or NULL on failure). 64248ae34fbSMarc Zyngier */ 64348ae34fbSMarc Zyngier struct irq_domain *of_msi_get_domain(struct device *dev, 64448ae34fbSMarc Zyngier struct device_node *np, 64548ae34fbSMarc Zyngier enum irq_domain_bus_token token) 64648ae34fbSMarc Zyngier { 64748ae34fbSMarc Zyngier struct device_node *msi_np; 64848ae34fbSMarc Zyngier struct irq_domain *d; 64948ae34fbSMarc Zyngier 65048ae34fbSMarc Zyngier /* Check for a single msi-parent property */ 65148ae34fbSMarc Zyngier msi_np = of_parse_phandle(np, "msi-parent", 0); 65248ae34fbSMarc Zyngier if (msi_np && !of_property_read_bool(msi_np, "#msi-cells")) { 65314a0db3cSMarc Zyngier d = irq_find_matching_host(msi_np, token); 65448ae34fbSMarc Zyngier if (!d) 65548ae34fbSMarc Zyngier of_node_put(msi_np); 65648ae34fbSMarc Zyngier return d; 65748ae34fbSMarc Zyngier } 65848ae34fbSMarc Zyngier 65948ae34fbSMarc Zyngier if (token == DOMAIN_BUS_PLATFORM_MSI) { 66048ae34fbSMarc Zyngier /* Check for the complex msi-parent version */ 66148ae34fbSMarc Zyngier struct of_phandle_args args; 66248ae34fbSMarc Zyngier int index = 0; 66348ae34fbSMarc Zyngier 66448ae34fbSMarc Zyngier while (!of_parse_phandle_with_args(np, "msi-parent", 66548ae34fbSMarc Zyngier "#msi-cells", 66648ae34fbSMarc Zyngier index, &args)) { 66714a0db3cSMarc Zyngier d = irq_find_matching_host(args.np, token); 66848ae34fbSMarc Zyngier if (d) 66948ae34fbSMarc Zyngier return d; 67048ae34fbSMarc Zyngier 67148ae34fbSMarc Zyngier of_node_put(args.np); 67248ae34fbSMarc Zyngier index++; 67348ae34fbSMarc Zyngier } 67448ae34fbSMarc Zyngier } 67548ae34fbSMarc Zyngier 67648ae34fbSMarc Zyngier return NULL; 67748ae34fbSMarc Zyngier } 67861c08240SMarc Zyngier 67961c08240SMarc Zyngier /** 68061c08240SMarc Zyngier * of_msi_configure - Set the msi_domain field of a device 68161c08240SMarc Zyngier * @dev: device structure to associate with an MSI irq domain 68261c08240SMarc Zyngier * @np: device node for that device 68361c08240SMarc Zyngier */ 68461c08240SMarc Zyngier void of_msi_configure(struct device *dev, struct device_node *np) 68561c08240SMarc Zyngier { 68661c08240SMarc Zyngier dev_set_msi_domain(dev, 68761c08240SMarc Zyngier of_msi_get_domain(dev, np, DOMAIN_BUS_PLATFORM_MSI)); 68861c08240SMarc Zyngier } 6895282c181SSinan Kaya EXPORT_SYMBOL_GPL(of_msi_configure); 690