1e3873444SGrant Likely /* 2e3873444SGrant Likely * Derived from arch/i386/kernel/irq.c 3e3873444SGrant Likely * Copyright (C) 1992 Linus Torvalds 4e3873444SGrant Likely * Adapted from arch/i386 by Gary Thomas 5e3873444SGrant Likely * Copyright (C) 1995-1996 Gary Thomas (gdt@linuxppc.org) 6e3873444SGrant Likely * Updated and modified by Cort Dougan <cort@fsmlabs.com> 7e3873444SGrant Likely * Copyright (C) 1996-2001 Cort Dougan 8e3873444SGrant Likely * Adapted for Power Macintosh by Paul Mackerras 9e3873444SGrant Likely * Copyright (C) 1996 Paul Mackerras (paulus@cs.anu.edu.au) 10e3873444SGrant Likely * 11e3873444SGrant Likely * This program is free software; you can redistribute it and/or 12e3873444SGrant Likely * modify it under the terms of the GNU General Public License 13e3873444SGrant Likely * as published by the Free Software Foundation; either version 14e3873444SGrant Likely * 2 of the License, or (at your option) any later version. 15e3873444SGrant Likely * 16e3873444SGrant Likely * This file contains the code used to make IRQ descriptions in the 17e3873444SGrant Likely * device tree to actual irq numbers on an interrupt controller 18e3873444SGrant Likely * driver. 19e3873444SGrant Likely */ 20e3873444SGrant Likely 21e3873444SGrant Likely #include <linux/errno.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> 26e3873444SGrant Likely 27e3873444SGrant Likely /** 28e3873444SGrant Likely * irq_of_parse_and_map - Parse and map an interrupt into linux virq space 29e3873444SGrant Likely * @device: Device node of the device whose interrupt is to be mapped 30e3873444SGrant Likely * @index: Index of the interrupt to map 31e3873444SGrant Likely * 32e3873444SGrant Likely * This function is a wrapper that chains of_irq_map_one() and 33e3873444SGrant Likely * irq_create_of_mapping() to make things easier to callers 34e3873444SGrant Likely */ 35e3873444SGrant Likely unsigned int irq_of_parse_and_map(struct device_node *dev, int index) 36e3873444SGrant Likely { 37e3873444SGrant Likely struct of_irq oirq; 38e3873444SGrant Likely 39e3873444SGrant Likely if (of_irq_map_one(dev, index, &oirq)) 40e3873444SGrant Likely return NO_IRQ; 41e3873444SGrant Likely 42e3873444SGrant Likely return irq_create_of_mapping(oirq.controller, oirq.specifier, 43e3873444SGrant Likely oirq.size); 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 */ 547dc2e113SGrant Likely static struct device_node *of_irq_find_parent(struct device_node *child) 557dc2e113SGrant Likely { 567dc2e113SGrant Likely struct device_node *p; 579a6b2e58SGrant Likely const __be32 *parp; 587dc2e113SGrant Likely 597dc2e113SGrant Likely if (!of_node_get(child)) 607dc2e113SGrant Likely return NULL; 617dc2e113SGrant Likely 627dc2e113SGrant Likely do { 637dc2e113SGrant Likely parp = of_get_property(child, "interrupt-parent", NULL); 647dc2e113SGrant Likely if (parp == NULL) 657dc2e113SGrant Likely p = of_get_parent(child); 667dc2e113SGrant Likely else { 677dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) 687dc2e113SGrant Likely p = of_node_get(of_irq_dflt_pic); 697dc2e113SGrant Likely else 709a6b2e58SGrant Likely p = of_find_node_by_phandle(be32_to_cpup(parp)); 717dc2e113SGrant Likely } 727dc2e113SGrant Likely of_node_put(child); 737dc2e113SGrant Likely child = p; 747dc2e113SGrant Likely } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL); 757dc2e113SGrant Likely 767dc2e113SGrant Likely return p; 777dc2e113SGrant Likely } 787dc2e113SGrant Likely 797dc2e113SGrant Likely /** 807dc2e113SGrant Likely * of_irq_map_raw - Low level interrupt tree parsing 817dc2e113SGrant Likely * @parent: the device interrupt parent 827dc2e113SGrant Likely * @intspec: interrupt specifier ("interrupts" property of the device) 837dc2e113SGrant Likely * @ointsize: size of the passed in interrupt specifier 847dc2e113SGrant Likely * @addr: address specifier (start of "reg" property of the device) 857dc2e113SGrant Likely * @out_irq: structure of_irq filled by this function 867dc2e113SGrant Likely * 877dc2e113SGrant Likely * Returns 0 on success and a negative number on error 887dc2e113SGrant Likely * 897dc2e113SGrant Likely * This function is a low-level interrupt tree walking function. It 907dc2e113SGrant Likely * can be used to do a partial walk with synthetized reg and interrupts 917dc2e113SGrant Likely * properties, for example when resolving PCI interrupts when no device 927dc2e113SGrant Likely * node exist for the parent. 937dc2e113SGrant Likely */ 94d2f71839SGrant Likely int of_irq_map_raw(struct device_node *parent, const __be32 *intspec, 95d2f71839SGrant Likely u32 ointsize, const __be32 *addr, struct of_irq *out_irq) 967dc2e113SGrant Likely { 977dc2e113SGrant Likely struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL; 98a7c194b0SRob Herring const __be32 *tmp, *imap, *imask; 997dc2e113SGrant Likely u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0; 1007dc2e113SGrant Likely int imaplen, match, i; 1017dc2e113SGrant Likely 1027dc2e113SGrant Likely pr_debug("of_irq_map_raw: par=%s,intspec=[0x%08x 0x%08x...],ointsize=%d\n", 103d2f71839SGrant Likely parent->full_name, be32_to_cpup(intspec), 104d2f71839SGrant Likely be32_to_cpup(intspec + 1), ointsize); 1057dc2e113SGrant Likely 1067dc2e113SGrant Likely ipar = of_node_get(parent); 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 { 1137dc2e113SGrant Likely tmp = of_get_property(ipar, "#interrupt-cells", NULL); 1147dc2e113SGrant Likely if (tmp != NULL) { 115a7c194b0SRob Herring intsize = be32_to_cpu(*tmp); 1167dc2e113SGrant Likely break; 1177dc2e113SGrant Likely } 1187dc2e113SGrant Likely tnode = ipar; 1197dc2e113SGrant Likely ipar = of_irq_find_parent(ipar); 1207dc2e113SGrant Likely of_node_put(tnode); 1217dc2e113SGrant Likely } while (ipar); 1227dc2e113SGrant Likely if (ipar == NULL) { 1237dc2e113SGrant Likely pr_debug(" -> no parent found !\n"); 1247dc2e113SGrant Likely goto fail; 1257dc2e113SGrant Likely } 1267dc2e113SGrant Likely 1277dc2e113SGrant Likely pr_debug("of_irq_map_raw: ipar=%s, size=%d\n", ipar->full_name, intsize); 1287dc2e113SGrant Likely 1297dc2e113SGrant Likely if (ointsize != intsize) 1307dc2e113SGrant Likely return -EINVAL; 1317dc2e113SGrant Likely 1327dc2e113SGrant Likely /* Look for this #address-cells. We have to implement the old linux 1337dc2e113SGrant Likely * trick of looking for the parent here as some device-trees rely on it 1347dc2e113SGrant Likely */ 1357dc2e113SGrant Likely old = of_node_get(ipar); 1367dc2e113SGrant Likely do { 1377dc2e113SGrant Likely tmp = of_get_property(old, "#address-cells", NULL); 1387dc2e113SGrant Likely tnode = of_get_parent(old); 1397dc2e113SGrant Likely of_node_put(old); 1407dc2e113SGrant Likely old = tnode; 1417dc2e113SGrant Likely } while (old && tmp == NULL); 1427dc2e113SGrant Likely of_node_put(old); 1437dc2e113SGrant Likely old = NULL; 144a7c194b0SRob Herring addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp); 1457dc2e113SGrant Likely 1467dc2e113SGrant Likely pr_debug(" -> addrsize=%d\n", addrsize); 1477dc2e113SGrant Likely 1487dc2e113SGrant Likely /* Now start the actual "proper" walk of the interrupt tree */ 1497dc2e113SGrant Likely while (ipar != NULL) { 1507dc2e113SGrant Likely /* Now check if cursor is an interrupt-controller and if it is 1517dc2e113SGrant Likely * then we are done 1527dc2e113SGrant Likely */ 1537dc2e113SGrant Likely if (of_get_property(ipar, "interrupt-controller", NULL) != 1547dc2e113SGrant Likely NULL) { 1557dc2e113SGrant Likely pr_debug(" -> got it !\n"); 156a7c194b0SRob Herring for (i = 0; i < intsize; i++) 157a7c194b0SRob Herring out_irq->specifier[i] = 158a7c194b0SRob Herring of_read_number(intspec +i, 1); 1597dc2e113SGrant Likely out_irq->size = intsize; 1607dc2e113SGrant Likely out_irq->controller = ipar; 1617dc2e113SGrant Likely of_node_put(old); 1627dc2e113SGrant Likely return 0; 1637dc2e113SGrant Likely } 1647dc2e113SGrant Likely 1657dc2e113SGrant Likely /* Now look for an interrupt-map */ 1667dc2e113SGrant Likely imap = of_get_property(ipar, "interrupt-map", &imaplen); 1677dc2e113SGrant Likely /* No interrupt map, check for an interrupt parent */ 1687dc2e113SGrant Likely if (imap == NULL) { 1697dc2e113SGrant Likely pr_debug(" -> no map, getting parent\n"); 1707dc2e113SGrant Likely newpar = of_irq_find_parent(ipar); 1717dc2e113SGrant Likely goto skiplevel; 1727dc2e113SGrant Likely } 1737dc2e113SGrant Likely imaplen /= sizeof(u32); 1747dc2e113SGrant Likely 1757dc2e113SGrant Likely /* Look for a mask */ 1767dc2e113SGrant Likely imask = of_get_property(ipar, "interrupt-map-mask", NULL); 1777dc2e113SGrant Likely 1787dc2e113SGrant Likely /* If we were passed no "reg" property and we attempt to parse 1797dc2e113SGrant Likely * an interrupt-map, then #address-cells must be 0. 1807dc2e113SGrant Likely * Fail if it's not. 1817dc2e113SGrant Likely */ 1827dc2e113SGrant Likely if (addr == NULL && addrsize != 0) { 1837dc2e113SGrant Likely pr_debug(" -> no reg passed in when needed !\n"); 1847dc2e113SGrant Likely goto fail; 1857dc2e113SGrant Likely } 1867dc2e113SGrant Likely 1877dc2e113SGrant Likely /* Parse interrupt-map */ 1887dc2e113SGrant Likely match = 0; 1897dc2e113SGrant Likely while (imaplen > (addrsize + intsize + 1) && !match) { 1907dc2e113SGrant Likely /* Compare specifiers */ 1917dc2e113SGrant Likely match = 1; 1927dc2e113SGrant Likely for (i = 0; i < addrsize && match; ++i) { 1937dc2e113SGrant Likely u32 mask = imask ? imask[i] : 0xffffffffu; 1947dc2e113SGrant Likely match = ((addr[i] ^ imap[i]) & mask) == 0; 1957dc2e113SGrant Likely } 1967dc2e113SGrant Likely for (; i < (addrsize + intsize) && match; ++i) { 1977dc2e113SGrant Likely u32 mask = imask ? imask[i] : 0xffffffffu; 1987dc2e113SGrant Likely match = 1997dc2e113SGrant Likely ((intspec[i-addrsize] ^ imap[i]) & mask) == 0; 2007dc2e113SGrant Likely } 2017dc2e113SGrant Likely imap += addrsize + intsize; 2027dc2e113SGrant Likely imaplen -= addrsize + intsize; 2037dc2e113SGrant Likely 2047dc2e113SGrant Likely pr_debug(" -> match=%d (imaplen=%d)\n", match, imaplen); 2057dc2e113SGrant Likely 2067dc2e113SGrant Likely /* Get the interrupt parent */ 2077dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_NO_PHANDLE) 2087dc2e113SGrant Likely newpar = of_node_get(of_irq_dflt_pic); 2097dc2e113SGrant Likely else 2109a6b2e58SGrant Likely newpar = of_find_node_by_phandle(be32_to_cpup(imap)); 2117dc2e113SGrant Likely imap++; 2127dc2e113SGrant Likely --imaplen; 2137dc2e113SGrant Likely 2147dc2e113SGrant Likely /* Check if not found */ 2157dc2e113SGrant Likely if (newpar == NULL) { 2167dc2e113SGrant Likely pr_debug(" -> imap parent not found !\n"); 2177dc2e113SGrant Likely goto fail; 2187dc2e113SGrant Likely } 2197dc2e113SGrant Likely 2207dc2e113SGrant Likely /* Get #interrupt-cells and #address-cells of new 2217dc2e113SGrant Likely * parent 2227dc2e113SGrant Likely */ 2237dc2e113SGrant Likely tmp = of_get_property(newpar, "#interrupt-cells", NULL); 2247dc2e113SGrant Likely if (tmp == NULL) { 2257dc2e113SGrant Likely pr_debug(" -> parent lacks #interrupt-cells!\n"); 2267dc2e113SGrant Likely goto fail; 2277dc2e113SGrant Likely } 228a7c194b0SRob Herring newintsize = be32_to_cpu(*tmp); 2297dc2e113SGrant Likely tmp = of_get_property(newpar, "#address-cells", NULL); 230a7c194b0SRob Herring newaddrsize = (tmp == NULL) ? 0 : be32_to_cpu(*tmp); 2317dc2e113SGrant Likely 2327dc2e113SGrant Likely pr_debug(" -> newintsize=%d, newaddrsize=%d\n", 2337dc2e113SGrant Likely newintsize, newaddrsize); 2347dc2e113SGrant Likely 2357dc2e113SGrant Likely /* Check for malformed properties */ 2367dc2e113SGrant Likely if (imaplen < (newaddrsize + newintsize)) 2377dc2e113SGrant Likely goto fail; 2387dc2e113SGrant Likely 2397dc2e113SGrant Likely imap += newaddrsize + newintsize; 2407dc2e113SGrant Likely imaplen -= newaddrsize + newintsize; 2417dc2e113SGrant Likely 2427dc2e113SGrant Likely pr_debug(" -> imaplen=%d\n", imaplen); 2437dc2e113SGrant Likely } 2447dc2e113SGrant Likely if (!match) 2457dc2e113SGrant Likely goto fail; 2467dc2e113SGrant Likely 2477dc2e113SGrant Likely of_node_put(old); 2487dc2e113SGrant Likely old = of_node_get(newpar); 2497dc2e113SGrant Likely addrsize = newaddrsize; 2507dc2e113SGrant Likely intsize = newintsize; 2517dc2e113SGrant Likely intspec = imap - intsize; 2527dc2e113SGrant Likely addr = intspec - addrsize; 2537dc2e113SGrant Likely 2547dc2e113SGrant Likely skiplevel: 2557dc2e113SGrant Likely /* Iterate again with new parent */ 2567dc2e113SGrant Likely pr_debug(" -> new parent: %s\n", newpar ? newpar->full_name : "<>"); 2577dc2e113SGrant Likely of_node_put(ipar); 2587dc2e113SGrant Likely ipar = newpar; 2597dc2e113SGrant Likely newpar = NULL; 2607dc2e113SGrant Likely } 2617dc2e113SGrant Likely fail: 2627dc2e113SGrant Likely of_node_put(ipar); 2637dc2e113SGrant Likely of_node_put(old); 2647dc2e113SGrant Likely of_node_put(newpar); 2657dc2e113SGrant Likely 2667dc2e113SGrant Likely return -EINVAL; 2677dc2e113SGrant Likely } 2687dc2e113SGrant Likely EXPORT_SYMBOL_GPL(of_irq_map_raw); 2697dc2e113SGrant Likely 2707dc2e113SGrant Likely /** 2717dc2e113SGrant Likely * of_irq_map_one - Resolve an interrupt for a device 2727dc2e113SGrant Likely * @device: the device whose interrupt is to be resolved 2737dc2e113SGrant Likely * @index: index of the interrupt to resolve 2747dc2e113SGrant Likely * @out_irq: structure of_irq filled by this function 2757dc2e113SGrant Likely * 2767dc2e113SGrant Likely * This function resolves an interrupt, walking the tree, for a given 2777dc2e113SGrant Likely * device-tree node. It's the high level pendant to of_irq_map_raw(). 2787dc2e113SGrant Likely */ 2797dc2e113SGrant Likely int of_irq_map_one(struct device_node *device, int index, struct of_irq *out_irq) 2807dc2e113SGrant Likely { 2817dc2e113SGrant Likely struct device_node *p; 282d2f71839SGrant Likely const __be32 *intspec, *tmp, *addr; 2837dc2e113SGrant Likely u32 intsize, intlen; 2847dc2e113SGrant Likely int res = -EINVAL; 2857dc2e113SGrant Likely 2867dc2e113SGrant Likely pr_debug("of_irq_map_one: dev=%s, index=%d\n", device->full_name, index); 2877dc2e113SGrant Likely 2887dc2e113SGrant Likely /* OldWorld mac stuff is "special", handle out of line */ 2897dc2e113SGrant Likely if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC) 2907dc2e113SGrant Likely return of_irq_map_oldworld(device, index, out_irq); 2917dc2e113SGrant Likely 2927dc2e113SGrant Likely /* Get the interrupts property */ 2937dc2e113SGrant Likely intspec = of_get_property(device, "interrupts", &intlen); 2947dc2e113SGrant Likely if (intspec == NULL) 2957dc2e113SGrant Likely return -EINVAL; 296d2f71839SGrant Likely intlen /= sizeof(*intspec); 2977dc2e113SGrant Likely 298d2f71839SGrant Likely pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec), intlen); 2997dc2e113SGrant Likely 3007dc2e113SGrant Likely /* Get the reg property (if any) */ 3017dc2e113SGrant Likely addr = of_get_property(device, "reg", NULL); 3027dc2e113SGrant Likely 3037dc2e113SGrant Likely /* Look for the interrupt parent. */ 3047dc2e113SGrant Likely p = of_irq_find_parent(device); 3057dc2e113SGrant Likely if (p == NULL) 3067dc2e113SGrant Likely return -EINVAL; 3077dc2e113SGrant Likely 3087dc2e113SGrant Likely /* Get size of interrupt specifier */ 3097dc2e113SGrant Likely tmp = of_get_property(p, "#interrupt-cells", NULL); 3107dc2e113SGrant Likely if (tmp == NULL) 3117dc2e113SGrant Likely goto out; 312a7c194b0SRob Herring intsize = be32_to_cpu(*tmp); 3137dc2e113SGrant Likely 3147dc2e113SGrant Likely pr_debug(" intsize=%d intlen=%d\n", intsize, intlen); 3157dc2e113SGrant Likely 3167dc2e113SGrant Likely /* Check index */ 3177dc2e113SGrant Likely if ((index + 1) * intsize > intlen) 3187dc2e113SGrant Likely goto out; 3197dc2e113SGrant Likely 3207dc2e113SGrant Likely /* Get new specifier and map it */ 3217dc2e113SGrant Likely res = of_irq_map_raw(p, intspec + index * intsize, intsize, 3227dc2e113SGrant Likely addr, out_irq); 3237dc2e113SGrant Likely out: 3247dc2e113SGrant Likely of_node_put(p); 3257dc2e113SGrant Likely return res; 3267dc2e113SGrant Likely } 3277dc2e113SGrant Likely EXPORT_SYMBOL_GPL(of_irq_map_one); 3287dc2e113SGrant Likely 3297dc2e113SGrant Likely /** 3307dc2e113SGrant Likely * of_irq_to_resource - Decode a node's IRQ and return it as a resource 3317dc2e113SGrant Likely * @dev: pointer to device tree node 3327dc2e113SGrant Likely * @index: zero-based index of the irq 3337dc2e113SGrant Likely * @r: pointer to resource structure to return result into. 3347dc2e113SGrant Likely */ 3357dc2e113SGrant Likely int of_irq_to_resource(struct device_node *dev, int index, struct resource *r) 3367dc2e113SGrant Likely { 3377dc2e113SGrant Likely int irq = irq_of_parse_and_map(dev, index); 3387dc2e113SGrant Likely 3397dc2e113SGrant Likely /* Only dereference the resource if both the 3407dc2e113SGrant Likely * resource and the irq are valid. */ 3417dc2e113SGrant Likely if (r && irq != NO_IRQ) { 3427dc2e113SGrant Likely r->start = r->end = irq; 3437dc2e113SGrant Likely r->flags = IORESOURCE_IRQ; 344d3571c3aSGrant Likely r->name = dev->full_name; 3457dc2e113SGrant Likely } 3467dc2e113SGrant Likely 3477dc2e113SGrant Likely return irq; 3487dc2e113SGrant Likely } 3497dc2e113SGrant Likely EXPORT_SYMBOL_GPL(of_irq_to_resource); 350