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 #include <linux/errno.h>
  22 #include <linux/list.h>
  23 #include <linux/module.h>
  24 #include <linux/of.h>
  25 #include <linux/of_irq.h>
  26 #include <linux/string.h>
  27 #include <linux/slab.h>
  28
  29 /**
  30  * irq_of_parse_and_map - Parse and map an interrupt into linux virq space
  31  * @dev: Device node of the device whose interrupt is to be mapped
  32  * @index: Index of the interrupt to map
  33  *
  34  * This function is a wrapper that chains of_irq_parse_one() and
  35  * irq_create_of_mapping() to make things easier to callers
  36  */
  37 unsigned int irq_of_parse_and_map(struct device_node *dev, int index)
  38 {
  39         struct of_phandle_args oirq;
  40
  41         if (of_irq_parse_one(dev, index, &oirq))
  42                 return 0;
  43
  44         return irq_create_of_mapping(&oirq);
  45 }
  46 EXPORT_SYMBOL_GPL(irq_of_parse_and_map);
  47
  48 /**
  49  * of_irq_find_parent - Given a device node, find its interrupt parent node
  50  * @child: pointer to device node
  51  *
  52  * Returns a pointer to the interrupt parent node, or NULL if the interrupt
  53  * parent could not be determined.
  54  */
  55 struct device_node *of_irq_find_parent(struct device_node *child)
  56 {
  57         struct device_node *p;
  58         const __be32 *parp;
  59
  60         if (!of_node_get(child))
  61                 return NULL;
  62
  63         do {
  64                 parp = of_get_property(child, "interrupt-parent", NULL);
  65                 if (parp == NULL)
  66                         p = of_get_parent(child);
  67                 else {
  68                         if (of_irq_workarounds & OF_IMAP_NO_PHANDLE)
  69                                 p = of_node_get(of_irq_dflt_pic);
  70                         else
  71                                 p = of_find_node_by_phandle(be32_to_cpup(parp));
  72                 }
  73                 of_node_put(child);
  74                 child = p;
  75         } while (p && of_get_property(p, "#interrupt-cells", NULL) == NULL);
  76
  77         return p;
  78 }
  79
  80 /**
  81  * of_irq_parse_raw - Low level interrupt tree parsing
  82  * @parent:     the device interrupt parent
  83  * @intspec:    interrupt specifier ("interrupts" property of the device)
  84  * @ointsize:   size of the passed in interrupt specifier
  85  * @addr:       address specifier (start of "reg" property of the device)
  86  * @out_irq:    structure of_irq filled by this function
  87  *
  88  * Returns 0 on success and a negative number on error
  89  *
  90  * This function is a low-level interrupt tree walking function. It
  91  * can be used to do a partial walk with synthetized reg and interrupts
  92  * properties, for example when resolving PCI interrupts when no device
  93  * node exist for the parent.
  94  */
  95 int of_irq_parse_raw(struct device_node *parent, const __be32 *intspec,
  96                    u32 ointsize, const __be32 *addr, struct of_phandle_args *out_irq)
  97 {
  98         struct device_node *ipar, *tnode, *old = NULL, *newpar = NULL;
  99         const __be32 *tmp, *imap, *imask;
 100         u32 intsize = 1, addrsize, newintsize = 0, newaddrsize = 0;
 101         int imaplen, match, i;
 102
 103         pr_debug("of_irq_parse_raw: par=%s,intspec=[0x%08x 0x%08x...],ointsize=%d\n",
 104                  of_node_full_name(parent), be32_to_cpup(intspec),
 105                  be32_to_cpup(intspec + 1), ointsize);
 106
 107         ipar = of_node_get(parent);
 108
 109         /* First get the #interrupt-cells property of the current cursor
 110          * that tells us how to interpret the passed-in intspec. If there
 111          * is none, we are nice and just walk up the tree
 112          */
 113         do {
 114                 tmp = of_get_property(ipar, "#interrupt-cells", NULL);
 115                 if (tmp != NULL) {
 116                         intsize = be32_to_cpu(*tmp);
 117                         break;
 118                 }
 119                 tnode = ipar;
 120                 ipar = of_irq_find_parent(ipar);
 121                 of_node_put(tnode);
 122         } while (ipar);
 123         if (ipar == NULL) {
 124                 pr_debug(" -> no parent found !\n");
 125                 goto fail;
 126         }
 127
 128         pr_debug("of_irq_parse_raw: ipar=%s, size=%d\n", of_node_full_name(ipar), intsize);
 129
 130         if (ointsize != intsize)
 131                 return -EINVAL;
 132
 133         /* Look for this #address-cells. We have to implement the old linux
 134          * trick of looking for the parent here as some device-trees rely on it
 135          */
 136         old = of_node_get(ipar);
 137         do {
 138                 tmp = of_get_property(old, "#address-cells", NULL);
 139                 tnode = of_get_parent(old);
 140                 of_node_put(old);
 141                 old = tnode;
 142         } while (old && tmp == NULL);
 143         of_node_put(old);
 144         old = NULL;
 145         addrsize = (tmp == NULL) ? 2 : be32_to_cpu(*tmp);
 146
 147         pr_debug(" -> addrsize=%d\n", addrsize);
 148
 149         /* Now start the actual "proper" walk of the interrupt tree */
 150         while (ipar != NULL) {
 151                 /* Now check if cursor is an interrupt-controller and if it is
 152                  * then we are done
 153                  */
 154                 if (of_get_property(ipar, "interrupt-controller", NULL) !=
 155                                 NULL) {
 156                         pr_debug(" -> got it !\n");
 157                         for (i = 0; i < intsize; i++)
 158                                 out_irq->args[i] =
 159                                                 of_read_number(intspec +i, 1);
 160                         out_irq->args_count = intsize;
 161                         out_irq->np = ipar;
 162                         of_node_put(old);
 163                         return 0;
 164                 }
 165
 166                 /* Now look for an interrupt-map */
 167                 imap = of_get_property(ipar, "interrupt-map", &imaplen);
 168                 /* No interrupt map, check for an interrupt parent */
 169                 if (imap == NULL) {
 170                         pr_debug(" -> no map, getting parent\n");
 171                         newpar = of_irq_find_parent(ipar);
 172                         goto skiplevel;
 173                 }
 174                 imaplen /= sizeof(u32);
 175
 176                 /* Look for a mask */
 177                 imask = of_get_property(ipar, "interrupt-map-mask", NULL);
 178
 179                 /* If we were passed no "reg" property and we attempt to parse
 180                  * an interrupt-map, then #address-cells must be 0.
 181                  * Fail if it's not.
 182                  */
 183                 if (addr == NULL && addrsize != 0) {
 184                         pr_debug(" -> no reg passed in when needed !\n");
 185                         goto fail;
 186                 }
 187
 188                 /* Parse interrupt-map */
 189                 match = 0;
 190                 while (imaplen > (addrsize + intsize + 1) && !match) {
 191                         /* Compare specifiers */
 192                         match = 1;
 193                         for (i = 0; i < addrsize && match; ++i) {
 194                                 __be32 mask = imask ? imask[i]
 195                                                     : cpu_to_be32(0xffffffffu);
 196                                 match = ((addr[i] ^ imap[i]) & mask) == 0;
 197                         }
 198                         for (; i < (addrsize + intsize) && match; ++i) {
 199                                 __be32 mask = imask ? imask[i]
 200                                                     : cpu_to_be32(0xffffffffu);
 201                                 match =
 202                                    ((intspec[i-addrsize] ^ imap[i]) & mask) == 0;
 203                         }
 204                         imap += addrsize + intsize;
 205                         imaplen -= addrsize + intsize;
 206
 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
 213                                 newpar = of_find_node_by_phandle(be32_to_cpup(imap));
 214                         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
 223                         /* Get #interrupt-cells and #address-cells of new
 224                          * parent
 225                          */
 226                         tmp = of_get_property(newpar, "#interrupt-cells", NULL);
 227                         if (tmp == NULL) {
 228                                 pr_debug(" -> parent lacks #interrupt-cells!\n");
 229                                 goto fail;
 230                         }
 231                         newintsize = be32_to_cpu(*tmp);
 232                         tmp = of_get_property(newpar, "#address-cells", NULL);
 233                         newaddrsize = (tmp == NULL) ? 0 : be32_to_cpu(*tmp);
 234
 235                         pr_debug(" -> newintsize=%d, newaddrsize=%d\n",
 236                             newintsize, newaddrsize);
 237
 238                         /* Check for malformed properties */
 239                         if (imaplen < (newaddrsize + newintsize))
 240                                 goto fail;
 241
 242                         imap += newaddrsize + newintsize;
 243                         imaplen -= newaddrsize + newintsize;
 244
 245                         pr_debug(" -> imaplen=%d\n", imaplen);
 246                 }
 247                 if (!match)
 248                         goto fail;
 249
 250                 of_node_put(old);
 251                 old = of_node_get(newpar);
 252                 addrsize = newaddrsize;
 253                 intsize = newintsize;
 254                 intspec = imap - intsize;
 255                 addr = intspec - addrsize;
 256
 257         skiplevel:
 258                 /* Iterate again with new parent */
 259                 pr_debug(" -> new parent: %s\n", of_node_full_name(newpar));
 260                 of_node_put(ipar);
 261                 ipar = newpar;
 262                 newpar = NULL;
 263         }
 264  fail:
 265         of_node_put(ipar);
 266         of_node_put(old);
 267         of_node_put(newpar);
 268
 269         return -EINVAL;
 270 }
 271 EXPORT_SYMBOL_GPL(of_irq_parse_raw);
 272
 273 /**
 274  * of_irq_parse_one - Resolve an interrupt for a device
 275  * @device: the device whose interrupt is to be resolved
 276  * @index: index of the interrupt to resolve
 277  * @out_irq: structure of_irq filled by this function
 278  *
 279  * This function resolves an interrupt, walking the tree, for a given
 280  * device-tree node. It's the high level pendant to of_irq_parse_raw().
 281  */
 282 int of_irq_parse_one(struct device_node *device, int index, struct of_phandle_args *out_irq)
 283 {
 284         struct device_node *p;
 285         const __be32 *intspec, *tmp, *addr;
 286         u32 intsize, intlen;
 287         int res = -EINVAL;
 288
 289         pr_debug("of_irq_parse_one: dev=%s, index=%d\n", of_node_full_name(device), index);
 290
 291         /* OldWorld mac stuff is "special", handle out of line */
 292         if (of_irq_workarounds & OF_IMAP_OLDWORLD_MAC)
 293                 return of_irq_parse_oldworld(device, index, out_irq);
 294
 295         /* Get the interrupts property */
 296         intspec = of_get_property(device, "interrupts", &intlen);
 297         if (intspec == NULL)
 298                 return -EINVAL;
 299         intlen /= sizeof(*intspec);
 300
 301         pr_debug(" intspec=%d intlen=%d\n", be32_to_cpup(intspec), intlen);
 302
 303         /* Get the reg property (if any) */
 304         addr = of_get_property(device, "reg", NULL);
 305
 306         /* Look for the interrupt parent. */
 307         p = of_irq_find_parent(device);
 308         if (p == NULL)
 309                 return -EINVAL;
 310
 311         /* Get size of interrupt specifier */
 312         tmp = of_get_property(p, "#interrupt-cells", NULL);
 313         if (tmp == NULL)
 314                 goto out;
 315         intsize = be32_to_cpu(*tmp);
 316
 317         pr_debug(" intsize=%d intlen=%d\n", intsize, intlen);
 318
 319         /* Check index */
 320         if ((index + 1) * intsize > intlen)
 321                 goto out;
 322
 323         /* Get new specifier and map it */
 324         res = of_irq_parse_raw(p, intspec + index * intsize, intsize,
 325                              addr, out_irq);
 326  out:
 327         of_node_put(p);
 328         return res;
 329 }
 330 EXPORT_SYMBOL_GPL(of_irq_parse_one);
 331
 332 /**
 333  * of_irq_to_resource - Decode a node's IRQ and return it as a resource
 334  * @dev: pointer to device tree node
 335  * @index: zero-based index of the irq
 336  * @r: pointer to resource structure to return result into.
 337  */
 338 int of_irq_to_resource(struct device_node *dev, int index, struct resource *r)
 339 {
 340         int irq = irq_of_parse_and_map(dev, index);
 341
 342         /* Only dereference the resource if both the
 343          * resource and the irq are valid. */
 344         if (r && irq) {
 345                 const char *name = NULL;
 346
 347                 memset(r, 0, sizeof(*r));
 348                 /*
 349                  * Get optional "interrupts-names" property to add a name
 350                  * to the resource.
 351                  */
 352                 of_property_read_string_index(dev, "interrupt-names", index,
 353                                               &name);
 354
 355                 r->start = r->end = irq;
 356                 r->flags = IORESOURCE_IRQ | irqd_get_trigger_type(irq_get_irq_data(irq));
 357                 r->name = name ? name : of_node_full_name(dev);
 358         }
 359
 360         return irq;
 361 }
 362 EXPORT_SYMBOL_GPL(of_irq_to_resource);
 363
 364 /**
 365  * of_irq_count - Count the number of IRQs a node uses
 366  * @dev: pointer to device tree node
 367  */
 368 int of_irq_count(struct device_node *dev)
 369 {
 370         int nr = 0;
 371
 372         while (of_irq_to_resource(dev, nr, NULL))
 373                 nr++;
 374
 375         return nr;
 376 }
 377
 378 /**
 379  * of_irq_to_resource_table - Fill in resource table with node's IRQ info
 380  * @dev: pointer to device tree node
 381  * @res: array of resources to fill in
 382  * @nr_irqs: the number of IRQs (and upper bound for num of @res elements)
 383  *
 384  * Returns the size of the filled in table (up to @nr_irqs).
 385  */
 386 int of_irq_to_resource_table(struct device_node *dev, struct resource *res,
 387                 int nr_irqs)
 388 {
 389         int i;
 390
 391         for (i = 0; i < nr_irqs; i++, res++)
 392                 if (!of_irq_to_resource(dev, i, res))
 393                         break;
 394
 395         return i;
 396 }
 397 EXPORT_SYMBOL_GPL(of_irq_to_resource_table);
 398
 399 struct intc_desc {
 400         struct list_head        list;
 401         struct device_node      *dev;
 402         struct device_node      *interrupt_parent;
 403 };
 404
 405 /**
 406  * of_irq_init - Scan and init matching interrupt controllers in DT
 407  * @matches: 0 terminated array of nodes to match and init function to call
 408  *
 409  * This function scans the device tree for matching interrupt controller nodes,
 410  * and calls their initialization functions in order with parents first.
 411  */
 412 void __init of_irq_init(const struct of_device_id *matches)
 413 {
 414         struct device_node *np, *parent = NULL;
 415         struct intc_desc *desc, *temp_desc;
 416         struct list_head intc_desc_list, intc_parent_list;
 417
 418         INIT_LIST_HEAD(&intc_desc_list);
 419         INIT_LIST_HEAD(&intc_parent_list);
 420
 421         for_each_matching_node(np, matches) {
 422                 if (!of_find_property(np, "interrupt-controller", NULL))
 423                         continue;
 424                 /*
 425                  * Here, we allocate and populate an intc_desc with the node
 426                  * pointer, interrupt-parent device_node etc.
 427                  */
 428                 desc = kzalloc(sizeof(*desc), GFP_KERNEL);
 429                 if (WARN_ON(!desc))
 430                         goto err;
 431
 432                 desc->dev = np;
 433                 desc->interrupt_parent = of_irq_find_parent(np);
 434                 if (desc->interrupt_parent == np)
 435                         desc->interrupt_parent = NULL;
 436                 list_add_tail(&desc->list, &intc_desc_list);
 437         }
 438
 439         /*
 440          * The root irq controller is the one without an interrupt-parent.
 441          * That one goes first, followed by the controllers that reference it,
 442          * followed by the ones that reference the 2nd level controllers, etc.
 443          */
 444         while (!list_empty(&intc_desc_list)) {
 445                 /*
 446                  * Process all controllers with the current 'parent'.
 447                  * First pass will be looking for NULL as the parent.
 448                  * The assumption is that NULL parent means a root controller.
 449                  */
 450                 list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
 451                         const struct of_device_id *match;
 452                         int ret;
 453                         of_irq_init_cb_t irq_init_cb;
 454
 455                         if (desc->interrupt_parent != parent)
 456                                 continue;
 457
 458                         list_del(&desc->list);
 459                         match = of_match_node(matches, desc->dev);
 460                         if (WARN(!match->data,
 461                             "of_irq_init: no init function for %s\n",
 462                             match->compatible)) {
 463                                 kfree(desc);
 464                                 continue;
 465                         }
 466
 467                         pr_debug("of_irq_init: init %s @ %p, parent %p\n",
 468                                  match->compatible,
 469                                  desc->dev, desc->interrupt_parent);
 470                         irq_init_cb = (of_irq_init_cb_t)match->data;
 471                         ret = irq_init_cb(desc->dev, desc->interrupt_parent);
 472                         if (ret) {
 473                                 kfree(desc);
 474                                 continue;
 475                         }
 476
 477                         /*
 478                          * This one is now set up; add it to the parent list so
 479                          * its children can get processed in a subsequent pass.
 480                          */
 481                         list_add_tail(&desc->list, &intc_parent_list);
 482                 }
 483
 484                 /* Get the next pending parent that might have children */
 485                 desc = list_first_entry_or_null(&intc_parent_list,
 486                                                 typeof(*desc), list);
 487                 if (!desc) {
 488                         pr_err("of_irq_init: children remain, but no parents\n");
 489                         break;
 490                 }
 491                 list_del(&desc->list);
 492                 parent = desc->dev;
 493                 kfree(desc);
 494         }
 495
 496         list_for_each_entry_safe(desc, temp_desc, &intc_parent_list, list) {
 497                 list_del(&desc->list);
 498                 kfree(desc);
 499         }
 500 err:
 501         list_for_each_entry_safe(desc, temp_desc, &intc_desc_list, list) {
 502                 list_del(&desc->list);
 503                 kfree(desc);
 504         }
 505 }