kernel/irq/irqdomain.c

   1 #define pr_fmt(fmt)  "irq: " fmt
   2
   3 #include <linux/debugfs.h>
   4 #include <linux/hardirq.h>
   5 #include <linux/interrupt.h>
   6 #include <linux/irq.h>
   7 #include <linux/irqdesc.h>
   8 #include <linux/irqdomain.h>
   9 #include <linux/module.h>
  10 #include <linux/mutex.h>
  11 #include <linux/of.h>
  12 #include <linux/of_address.h>
  13 #include <linux/of_irq.h>
  14 #include <linux/topology.h>
  15 #include <linux/seq_file.h>
  16 #include <linux/slab.h>
  17 #include <linux/smp.h>
  18 #include <linux/fs.h>
  19
  20 static LIST_HEAD(irq_domain_list);
  21 static DEFINE_MUTEX(irq_domain_mutex);
  22
  23 static DEFINE_MUTEX(revmap_trees_mutex);
  24 static struct irq_domain *irq_default_domain;
  25
  26 static int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
  27                                   irq_hw_number_t hwirq, int node);
  28 static void irq_domain_check_hierarchy(struct irq_domain *domain);
  29
  30 struct irqchip_fwid {
  31         struct fwnode_handle fwnode;
  32         char *name;
  33         void *data;
  34 };
  35
  36 /**
  37  * irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
  38  *                           identifying an irq domain
  39  * @data: optional user-provided data
  40  *
  41  * Allocate a struct device_node, and return a poiner to the embedded
  42  * fwnode_handle (or NULL on failure).
  43  */
  44 struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
  45 {
  46         struct irqchip_fwid *fwid;
  47         char *name;
  48
  49         fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
  50         name = kasprintf(GFP_KERNEL, "irqchip@%p", data);
  51
  52         if (!fwid || !name) {
  53                 kfree(fwid);
  54                 kfree(name);
  55                 return NULL;
  56         }
  57
  58         fwid->name = name;
  59         fwid->data = data;
  60         fwid->fwnode.type = FWNODE_IRQCHIP;
  61         return &fwid->fwnode;
  62 }
  63
  64 /**
  65  * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
  66  *
  67  * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
  68  */
  69 void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
  70 {
  71         struct irqchip_fwid *fwid;
  72
  73         if (WARN_ON(!is_fwnode_irqchip(fwnode)))
  74                 return;
  75
  76         fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
  77         kfree(fwid->name);
  78         kfree(fwid);
  79 }
  80
  81 /**
  82  * __irq_domain_add() - Allocate a new irq_domain data structure
  83  * @of_node: optional device-tree node of the interrupt controller
  84  * @size: Size of linear map; 0 for radix mapping only
  85  * @hwirq_max: Maximum number of interrupts supported by controller
  86  * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
  87  *              direct mapping
  88  * @ops: domain callbacks
  89  * @host_data: Controller private data pointer
  90  *
  91  * Allocates and initialize and irq_domain structure.
  92  * Returns pointer to IRQ domain, or NULL on failure.
  93  */
  94 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
  95                                     irq_hw_number_t hwirq_max, int direct_max,
  96                                     const struct irq_domain_ops *ops,
  97                                     void *host_data)
  98 {
  99         struct irq_domain *domain;
 100         struct device_node *of_node;
 101
 102         of_node = to_of_node(fwnode);
 103
 104         domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
 105                               GFP_KERNEL, of_node_to_nid(of_node));
 106         if (WARN_ON(!domain))
 107                 return NULL;
 108
 109         of_node_get(of_node);
 110
 111         /* Fill structure */
 112         INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
 113         domain->ops = ops;
 114         domain->host_data = host_data;
 115         domain->fwnode = fwnode;
 116         domain->hwirq_max = hwirq_max;
 117         domain->revmap_size = size;
 118         domain->revmap_direct_max_irq = direct_max;
 119         irq_domain_check_hierarchy(domain);
 120
 121         mutex_lock(&irq_domain_mutex);
 122         list_add(&domain->link, &irq_domain_list);
 123         mutex_unlock(&irq_domain_mutex);
 124
 125         pr_debug("Added domain %s\n", domain->name);
 126         return domain;
 127 }
 128 EXPORT_SYMBOL_GPL(__irq_domain_add);
 129
 130 /**
 131  * irq_domain_remove() - Remove an irq domain.
 132  * @domain: domain to remove
 133  *
 134  * This routine is used to remove an irq domain. The caller must ensure
 135  * that all mappings within the domain have been disposed of prior to
 136  * use, depending on the revmap type.
 137  */
 138 void irq_domain_remove(struct irq_domain *domain)
 139 {
 140         mutex_lock(&irq_domain_mutex);
 141
 142         /*
 143          * radix_tree_delete() takes care of destroying the root
 144          * node when all entries are removed. Shout if there are
 145          * any mappings left.
 146          */
 147         WARN_ON(domain->revmap_tree.height);
 148
 149         list_del(&domain->link);
 150
 151         /*
 152          * If the going away domain is the default one, reset it.
 153          */
 154         if (unlikely(irq_default_domain == domain))
 155                 irq_set_default_host(NULL);
 156
 157         mutex_unlock(&irq_domain_mutex);
 158
 159         pr_debug("Removed domain %s\n", domain->name);
 160
 161         of_node_put(irq_domain_get_of_node(domain));
 162         kfree(domain);
 163 }
 164 EXPORT_SYMBOL_GPL(irq_domain_remove);
 165
 166 /**
 167  * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
 168  * @of_node: pointer to interrupt controller's device tree node.
 169  * @size: total number of irqs in mapping
 170  * @first_irq: first number of irq block assigned to the domain,
 171  *      pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
 172  *      pre-map all of the irqs in the domain to virqs starting at first_irq.
 173  * @ops: domain callbacks
 174  * @host_data: Controller private data pointer
 175  *
 176  * Allocates an irq_domain, and optionally if first_irq is positive then also
 177  * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
 178  *
 179  * This is intended to implement the expected behaviour for most
 180  * interrupt controllers. If device tree is used, then first_irq will be 0 and
 181  * irqs get mapped dynamically on the fly. However, if the controller requires
 182  * static virq assignments (non-DT boot) then it will set that up correctly.
 183  */
 184 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
 185                                          unsigned int size,
 186                                          unsigned int first_irq,
 187                                          const struct irq_domain_ops *ops,
 188                                          void *host_data)
 189 {
 190         struct irq_domain *domain;
 191
 192         domain = __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
 193         if (!domain)
 194                 return NULL;
 195
 196         if (first_irq > 0) {
 197                 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
 198                         /* attempt to allocated irq_descs */
 199                         int rc = irq_alloc_descs(first_irq, first_irq, size,
 200                                                  of_node_to_nid(of_node));
 201                         if (rc < 0)
 202                                 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
 203                                         first_irq);
 204                 }
 205                 irq_domain_associate_many(domain, first_irq, 0, size);
 206         }
 207
 208         return domain;
 209 }
 210 EXPORT_SYMBOL_GPL(irq_domain_add_simple);
 211
 212 /**
 213  * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
 214  * @of_node: pointer to interrupt controller's device tree node.
 215  * @size: total number of irqs in legacy mapping
 216  * @first_irq: first number of irq block assigned to the domain
 217  * @first_hwirq: first hwirq number to use for the translation. Should normally
 218  *               be '0', but a positive integer can be used if the effective
 219  *               hwirqs numbering does not begin at zero.
 220  * @ops: map/unmap domain callbacks
 221  * @host_data: Controller private data pointer
 222  *
 223  * Note: the map() callback will be called before this function returns
 224  * for all legacy interrupts except 0 (which is always the invalid irq for
 225  * a legacy controller).
 226  */
 227 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
 228                                          unsigned int size,
 229                                          unsigned int first_irq,
 230                                          irq_hw_number_t first_hwirq,
 231                                          const struct irq_domain_ops *ops,
 232                                          void *host_data)
 233 {
 234         struct irq_domain *domain;
 235
 236         domain = __irq_domain_add(of_node_to_fwnode(of_node), first_hwirq + size,
 237                                   first_hwirq + size, 0, ops, host_data);
 238         if (domain)
 239                 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
 240
 241         return domain;
 242 }
 243 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
 244
 245 /**
 246  * irq_find_matching_fwnode() - Locates a domain for a given fwnode
 247  * @fwnode: FW descriptor of the interrupt controller
 248  * @bus_token: domain-specific data
 249  */
 250 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
 251                                             enum irq_domain_bus_token bus_token)
 252 {
 253         struct irq_domain *h, *found = NULL;
 254         int rc;
 255
 256         /* We might want to match the legacy controller last since
 257          * it might potentially be set to match all interrupts in
 258          * the absence of a device node. This isn't a problem so far
 259          * yet though...
 260          *
 261          * bus_token == DOMAIN_BUS_ANY matches any domain, any other
 262          * values must generate an exact match for the domain to be
 263          * selected.
 264          */
 265         mutex_lock(&irq_domain_mutex);
 266         list_for_each_entry(h, &irq_domain_list, link) {
 267                 if (h->ops->match)
 268                         rc = h->ops->match(h, to_of_node(fwnode), bus_token);
 269                 else
 270                         rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
 271                               ((bus_token == DOMAIN_BUS_ANY) ||
 272                                (h->bus_token == bus_token)));
 273
 274                 if (rc) {
 275                         found = h;
 276                         break;
 277                 }
 278         }
 279         mutex_unlock(&irq_domain_mutex);
 280         return found;
 281 }
 282 EXPORT_SYMBOL_GPL(irq_find_matching_fwnode);
 283
 284 /**
 285  * irq_set_default_host() - Set a "default" irq domain
 286  * @domain: default domain pointer
 287  *
 288  * For convenience, it's possible to set a "default" domain that will be used
 289  * whenever NULL is passed to irq_create_mapping(). It makes life easier for
 290  * platforms that want to manipulate a few hard coded interrupt numbers that
 291  * aren't properly represented in the device-tree.
 292  */
 293 void irq_set_default_host(struct irq_domain *domain)
 294 {
 295         pr_debug("Default domain set to @0x%p\n", domain);
 296
 297         irq_default_domain = domain;
 298 }
 299 EXPORT_SYMBOL_GPL(irq_set_default_host);
 300
 301 void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
 302 {
 303         struct irq_data *irq_data = irq_get_irq_data(irq);
 304         irq_hw_number_t hwirq;
 305
 306         if (WARN(!irq_data || irq_data->domain != domain,
 307                  "virq%i doesn't exist; cannot disassociate\n", irq))
 308                 return;
 309
 310         hwirq = irq_data->hwirq;
 311         irq_set_status_flags(irq, IRQ_NOREQUEST);
 312
 313         /* remove chip and handler */
 314         irq_set_chip_and_handler(irq, NULL, NULL);
 315
 316         /* Make sure it's completed */
 317         synchronize_irq(irq);
 318
 319         /* Tell the PIC about it */
 320         if (domain->ops->unmap)
 321                 domain->ops->unmap(domain, irq);
 322         smp_mb();
 323
 324         irq_data->domain = NULL;
 325         irq_data->hwirq = 0;
 326
 327         /* Clear reverse map for this hwirq */
 328         if (hwirq < domain->revmap_size) {
 329                 domain->linear_revmap[hwirq] = 0;
 330         } else {
 331                 mutex_lock(&revmap_trees_mutex);
 332                 radix_tree_delete(&domain->revmap_tree, hwirq);
 333                 mutex_unlock(&revmap_trees_mutex);
 334         }
 335 }
 336
 337 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
 338                          irq_hw_number_t hwirq)
 339 {
 340         struct irq_data *irq_data = irq_get_irq_data(virq);
 341         int ret;
 342
 343         if (WARN(hwirq >= domain->hwirq_max,
 344                  "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
 345                 return -EINVAL;
 346         if (WARN(!irq_data, "error: virq%i is not allocated", virq))
 347                 return -EINVAL;
 348         if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
 349                 return -EINVAL;
 350
 351         mutex_lock(&irq_domain_mutex);
 352         irq_data->hwirq = hwirq;
 353         irq_data->domain = domain;
 354         if (domain->ops->map) {
 355                 ret = domain->ops->map(domain, virq, hwirq);
 356                 if (ret != 0) {
 357                         /*
 358                          * If map() returns -EPERM, this interrupt is protected
 359                          * by the firmware or some other service and shall not
 360                          * be mapped. Don't bother telling the user about it.
 361                          */
 362                         if (ret != -EPERM) {
 363                                 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
 364                                        domain->name, hwirq, virq, ret);
 365                         }
 366                         irq_data->domain = NULL;
 367                         irq_data->hwirq = 0;
 368                         mutex_unlock(&irq_domain_mutex);
 369                         return ret;
 370                 }
 371
 372                 /* If not already assigned, give the domain the chip's name */
 373                 if (!domain->name && irq_data->chip)
 374                         domain->name = irq_data->chip->name;
 375         }
 376
 377         if (hwirq < domain->revmap_size) {
 378                 domain->linear_revmap[hwirq] = virq;
 379         } else {
 380                 mutex_lock(&revmap_trees_mutex);
 381                 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
 382                 mutex_unlock(&revmap_trees_mutex);
 383         }
 384         mutex_unlock(&irq_domain_mutex);
 385
 386         irq_clear_status_flags(virq, IRQ_NOREQUEST);
 387
 388         return 0;
 389 }
 390 EXPORT_SYMBOL_GPL(irq_domain_associate);
 391
 392 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
 393                                irq_hw_number_t hwirq_base, int count)
 394 {
 395         struct device_node *of_node;
 396         int i;
 397
 398         of_node = irq_domain_get_of_node(domain);
 399         pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
 400                 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
 401
 402         for (i = 0; i < count; i++) {
 403                 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
 404         }
 405 }
 406 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
 407
 408 /**
 409  * irq_create_direct_mapping() - Allocate an irq for direct mapping
 410  * @domain: domain to allocate the irq for or NULL for default domain
 411  *
 412  * This routine is used for irq controllers which can choose the hardware
 413  * interrupt numbers they generate. In such a case it's simplest to use
 414  * the linux irq as the hardware interrupt number. It still uses the linear
 415  * or radix tree to store the mapping, but the irq controller can optimize
 416  * the revmap path by using the hwirq directly.
 417  */
 418 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
 419 {
 420         struct device_node *of_node;
 421         unsigned int virq;
 422
 423         if (domain == NULL)
 424                 domain = irq_default_domain;
 425
 426         of_node = irq_domain_get_of_node(domain);
 427         virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
 428         if (!virq) {
 429                 pr_debug("create_direct virq allocation failed\n");
 430                 return 0;
 431         }
 432         if (virq >= domain->revmap_direct_max_irq) {
 433                 pr_err("ERROR: no free irqs available below %i maximum\n",
 434                         domain->revmap_direct_max_irq);
 435                 irq_free_desc(virq);
 436                 return 0;
 437         }
 438         pr_debug("create_direct obtained virq %d\n", virq);
 439
 440         if (irq_domain_associate(domain, virq, virq)) {
 441                 irq_free_desc(virq);
 442                 return 0;
 443         }
 444
 445         return virq;
 446 }
 447 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
 448
 449 /**
 450  * irq_create_mapping() - Map a hardware interrupt into linux irq space
 451  * @domain: domain owning this hardware interrupt or NULL for default domain
 452  * @hwirq: hardware irq number in that domain space
 453  *
 454  * Only one mapping per hardware interrupt is permitted. Returns a linux
 455  * irq number.
 456  * If the sense/trigger is to be specified, set_irq_type() should be called
 457  * on the number returned from that call.
 458  */
 459 unsigned int irq_create_mapping(struct irq_domain *domain,
 460                                 irq_hw_number_t hwirq)
 461 {
 462         struct device_node *of_node;
 463         int virq;
 464
 465         pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
 466
 467         /* Look for default domain if nececssary */
 468         if (domain == NULL)
 469                 domain = irq_default_domain;
 470         if (domain == NULL) {
 471                 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
 472                 return 0;
 473         }
 474         pr_debug("-> using domain @%p\n", domain);
 475
 476         of_node = irq_domain_get_of_node(domain);
 477
 478         /* Check if mapping already exists */
 479         virq = irq_find_mapping(domain, hwirq);
 480         if (virq) {
 481                 pr_debug("-> existing mapping on virq %d\n", virq);
 482                 return virq;
 483         }
 484
 485         /* Allocate a virtual interrupt number */
 486         virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node));
 487         if (virq <= 0) {
 488                 pr_debug("-> virq allocation failed\n");
 489                 return 0;
 490         }
 491
 492         if (irq_domain_associate(domain, virq, hwirq)) {
 493                 irq_free_desc(virq);
 494                 return 0;
 495         }
 496
 497         pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
 498                 hwirq, of_node_full_name(of_node), virq);
 499
 500         return virq;
 501 }
 502 EXPORT_SYMBOL_GPL(irq_create_mapping);
 503
 504 /**
 505  * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
 506  * @domain: domain owning the interrupt range
 507  * @irq_base: beginning of linux IRQ range
 508  * @hwirq_base: beginning of hardware IRQ range
 509  * @count: Number of interrupts to map
 510  *
 511  * This routine is used for allocating and mapping a range of hardware
 512  * irqs to linux irqs where the linux irq numbers are at pre-defined
 513  * locations. For use by controllers that already have static mappings
 514  * to insert in to the domain.
 515  *
 516  * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
 517  * domain insertion.
 518  *
 519  * 0 is returned upon success, while any failure to establish a static
 520  * mapping is treated as an error.
 521  */
 522 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
 523                                irq_hw_number_t hwirq_base, int count)
 524 {
 525         struct device_node *of_node;
 526         int ret;
 527
 528         of_node = irq_domain_get_of_node(domain);
 529         ret = irq_alloc_descs(irq_base, irq_base, count,
 530                               of_node_to_nid(of_node));
 531         if (unlikely(ret < 0))
 532                 return ret;
 533
 534         irq_domain_associate_many(domain, irq_base, hwirq_base, count);
 535         return 0;
 536 }
 537 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
 538
 539 static int irq_domain_translate(struct irq_domain *d,
 540                                 struct irq_fwspec *fwspec,
 541                                 irq_hw_number_t *hwirq, unsigned int *type)
 542 {
 543 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
 544         if (d->ops->translate)
 545                 return d->ops->translate(d, fwspec, hwirq, type);
 546 #endif
 547         if (d->ops->xlate)
 548                 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
 549                                      fwspec->param, fwspec->param_count,
 550                                      hwirq, type);
 551
 552         /* If domain has no translation, then we assume interrupt line */
 553         *hwirq = fwspec->param[0];
 554         return 0;
 555 }
 556
 557 static void of_phandle_args_to_fwspec(struct of_phandle_args *irq_data,
 558                                       struct irq_fwspec *fwspec)
 559 {
 560         int i;
 561
 562         fwspec->fwnode = irq_data->np ? &irq_data->np->fwnode : NULL;
 563         fwspec->param_count = irq_data->args_count;
 564
 565         for (i = 0; i < irq_data->args_count; i++)
 566                 fwspec->param[i] = irq_data->args[i];
 567 }
 568
 569 unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
 570 {
 571         struct irq_domain *domain;
 572         irq_hw_number_t hwirq;
 573         unsigned int type = IRQ_TYPE_NONE;
 574         int virq;
 575
 576         if (fwspec->fwnode) {
 577                 domain = irq_find_matching_fwnode(fwspec->fwnode,
 578                                                   DOMAIN_BUS_WIRED);
 579                 if (!domain)
 580                         domain = irq_find_matching_fwnode(fwspec->fwnode,
 581                                                           DOMAIN_BUS_ANY);
 582         } else {
 583                 domain = irq_default_domain;
 584         }
 585
 586         if (!domain) {
 587                 pr_warn("no irq domain found for %s !\n",
 588                         of_node_full_name(to_of_node(fwspec->fwnode)));
 589                 return 0;
 590         }
 591
 592         if (irq_domain_translate(domain, fwspec, &hwirq, &type))
 593                 return 0;
 594
 595         if (irq_domain_is_hierarchy(domain)) {
 596                 /*
 597                  * If we've already configured this interrupt,
 598                  * don't do it again, or hell will break loose.
 599                  */
 600                 virq = irq_find_mapping(domain, hwirq);
 601                 if (virq)
 602                         return virq;
 603
 604                 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
 605                 if (virq <= 0)
 606                         return 0;
 607         } else {
 608                 /* Create mapping */
 609                 virq = irq_create_mapping(domain, hwirq);
 610                 if (!virq)
 611                         return virq;
 612         }
 613
 614         /* Set type if specified and different than the current one */
 615         if (type != IRQ_TYPE_NONE &&
 616             type != irq_get_trigger_type(virq))
 617                 irq_set_irq_type(virq, type);
 618         return virq;
 619 }
 620 EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
 621
 622 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
 623 {
 624         struct irq_fwspec fwspec;
 625
 626         of_phandle_args_to_fwspec(irq_data, &fwspec);
 627         return irq_create_fwspec_mapping(&fwspec);
 628 }
 629 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
 630
 631 /**
 632  * irq_dispose_mapping() - Unmap an interrupt
 633  * @virq: linux irq number of the interrupt to unmap
 634  */
 635 void irq_dispose_mapping(unsigned int virq)
 636 {
 637         struct irq_data *irq_data = irq_get_irq_data(virq);
 638         struct irq_domain *domain;
 639
 640         if (!virq || !irq_data)
 641                 return;
 642
 643         domain = irq_data->domain;
 644         if (WARN_ON(domain == NULL))
 645                 return;
 646
 647         irq_domain_disassociate(domain, virq);
 648         irq_free_desc(virq);
 649 }
 650 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
 651
 652 /**
 653  * irq_find_mapping() - Find a linux irq from an hw irq number.
 654  * @domain: domain owning this hardware interrupt
 655  * @hwirq: hardware irq number in that domain space
 656  */
 657 unsigned int irq_find_mapping(struct irq_domain *domain,
 658                               irq_hw_number_t hwirq)
 659 {
 660         struct irq_data *data;
 661
 662         /* Look for default domain if nececssary */
 663         if (domain == NULL)
 664                 domain = irq_default_domain;
 665         if (domain == NULL)
 666                 return 0;
 667
 668         if (hwirq < domain->revmap_direct_max_irq) {
 669                 data = irq_domain_get_irq_data(domain, hwirq);
 670                 if (data && data->hwirq == hwirq)
 671                         return hwirq;
 672         }
 673
 674         /* Check if the hwirq is in the linear revmap. */
 675         if (hwirq < domain->revmap_size)
 676                 return domain->linear_revmap[hwirq];
 677
 678         rcu_read_lock();
 679         data = radix_tree_lookup(&domain->revmap_tree, hwirq);
 680         rcu_read_unlock();
 681         return data ? data->irq : 0;
 682 }
 683 EXPORT_SYMBOL_GPL(irq_find_mapping);
 684
 685 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
 686 static int virq_debug_show(struct seq_file *m, void *private)
 687 {
 688         unsigned long flags;
 689         struct irq_desc *desc;
 690         struct irq_domain *domain;
 691         struct radix_tree_iter iter;
 692         void *data, **slot;
 693         int i;
 694
 695         seq_printf(m, " %-16s  %-6s  %-10s  %-10s  %s\n",
 696                    "name", "mapped", "linear-max", "direct-max", "devtree-node");
 697         mutex_lock(&irq_domain_mutex);
 698         list_for_each_entry(domain, &irq_domain_list, link) {
 699                 struct device_node *of_node;
 700                 int count = 0;
 701                 of_node = irq_domain_get_of_node(domain);
 702                 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
 703                         count++;
 704                 seq_printf(m, "%c%-16s  %6u  %10u  %10u  %s\n",
 705                            domain == irq_default_domain ? '*' : ' ', domain->name,
 706                            domain->revmap_size + count, domain->revmap_size,
 707                            domain->revmap_direct_max_irq,
 708                            of_node ? of_node_full_name(of_node) : "");
 709         }
 710         mutex_unlock(&irq_domain_mutex);
 711
 712         seq_printf(m, "%-5s  %-7s  %-15s  %-*s  %6s  %-14s  %s\n", "irq", "hwirq",
 713                       "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
 714                       "active", "type", "domain");
 715
 716         for (i = 1; i < nr_irqs; i++) {
 717                 desc = irq_to_desc(i);
 718                 if (!desc)
 719                         continue;
 720
 721                 raw_spin_lock_irqsave(&desc->lock, flags);
 722                 domain = desc->irq_data.domain;
 723
 724                 if (domain) {
 725                         struct irq_chip *chip;
 726                         int hwirq = desc->irq_data.hwirq;
 727                         bool direct;
 728
 729                         seq_printf(m, "%5d  ", i);
 730                         seq_printf(m, "0x%05x  ", hwirq);
 731
 732                         chip = irq_desc_get_chip(desc);
 733                         seq_printf(m, "%-15s  ", (chip && chip->name) ? chip->name : "none");
 734
 735                         data = irq_desc_get_chip_data(desc);
 736                         seq_printf(m, data ? "0x%p  " : "  %p  ", data);
 737
 738                         seq_printf(m, "   %c    ", (desc->action && desc->action->handler) ? '*' : ' ');
 739                         direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
 740                         seq_printf(m, "%6s%-8s  ",
 741                                    (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
 742                                    direct ? "(DIRECT)" : "");
 743                         seq_printf(m, "%s\n", desc->irq_data.domain->name);
 744                 }
 745
 746                 raw_spin_unlock_irqrestore(&desc->lock, flags);
 747         }
 748
 749         return 0;
 750 }
 751
 752 static int virq_debug_open(struct inode *inode, struct file *file)
 753 {
 754         return single_open(file, virq_debug_show, inode->i_private);
 755 }
 756
 757 static const struct file_operations virq_debug_fops = {
 758         .open = virq_debug_open,
 759         .read = seq_read,
 760         .llseek = seq_lseek,
 761         .release = single_release,
 762 };
 763
 764 static int __init irq_debugfs_init(void)
 765 {
 766         if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
 767                                  NULL, &virq_debug_fops) == NULL)
 768                 return -ENOMEM;
 769
 770         return 0;
 771 }
 772 __initcall(irq_debugfs_init);
 773 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
 774
 775 /**
 776  * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
 777  *
 778  * Device Tree IRQ specifier translation function which works with one cell
 779  * bindings where the cell value maps directly to the hwirq number.
 780  */
 781 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
 782                              const u32 *intspec, unsigned int intsize,
 783                              unsigned long *out_hwirq, unsigned int *out_type)
 784 {
 785         if (WARN_ON(intsize < 1))
 786                 return -EINVAL;
 787         *out_hwirq = intspec[0];
 788         *out_type = IRQ_TYPE_NONE;
 789         return 0;
 790 }
 791 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
 792
 793 /**
 794  * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
 795  *
 796  * Device Tree IRQ specifier translation function which works with two cell
 797  * bindings where the cell values map directly to the hwirq number
 798  * and linux irq flags.
 799  */
 800 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
 801                         const u32 *intspec, unsigned int intsize,
 802                         irq_hw_number_t *out_hwirq, unsigned int *out_type)
 803 {
 804         if (WARN_ON(intsize < 2))
 805                 return -EINVAL;
 806         *out_hwirq = intspec[0];
 807         *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
 808         return 0;
 809 }
 810 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
 811
 812 /**
 813  * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
 814  *
 815  * Device Tree IRQ specifier translation function which works with either one
 816  * or two cell bindings where the cell values map directly to the hwirq number
 817  * and linux irq flags.
 818  *
 819  * Note: don't use this function unless your interrupt controller explicitly
 820  * supports both one and two cell bindings.  For the majority of controllers
 821  * the _onecell() or _twocell() variants above should be used.
 822  */
 823 int irq_domain_xlate_onetwocell(struct irq_domain *d,
 824                                 struct device_node *ctrlr,
 825                                 const u32 *intspec, unsigned int intsize,
 826                                 unsigned long *out_hwirq, unsigned int *out_type)
 827 {
 828         if (WARN_ON(intsize < 1))
 829                 return -EINVAL;
 830         *out_hwirq = intspec[0];
 831         *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
 832         return 0;
 833 }
 834 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
 835
 836 const struct irq_domain_ops irq_domain_simple_ops = {
 837         .xlate = irq_domain_xlate_onetwocell,
 838 };
 839 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
 840
 841 static int irq_domain_alloc_descs(int virq, unsigned int cnt,
 842                                   irq_hw_number_t hwirq, int node)
 843 {
 844         unsigned int hint;
 845
 846         if (virq >= 0) {
 847                 virq = irq_alloc_descs(virq, virq, cnt, node);
 848         } else {
 849                 hint = hwirq % nr_irqs;
 850                 if (hint == 0)
 851                         hint++;
 852                 virq = irq_alloc_descs_from(hint, cnt, node);
 853                 if (virq <= 0 && hint > 1)
 854                         virq = irq_alloc_descs_from(1, cnt, node);
 855         }
 856
 857         return virq;
 858 }
 859
 860 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 861 /**
 862  * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
 863  * @parent:     Parent irq domain to associate with the new domain
 864  * @flags:      Irq domain flags associated to the domain
 865  * @size:       Size of the domain. See below
 866  * @fwnode:     Optional fwnode of the interrupt controller
 867  * @ops:        Pointer to the interrupt domain callbacks
 868  * @host_data:  Controller private data pointer
 869  *
 870  * If @size is 0 a tree domain is created, otherwise a linear domain.
 871  *
 872  * If successful the parent is associated to the new domain and the
 873  * domain flags are set.
 874  * Returns pointer to IRQ domain, or NULL on failure.
 875  */
 876 struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
 877                                             unsigned int flags,
 878                                             unsigned int size,
 879                                             struct fwnode_handle *fwnode,
 880                                             const struct irq_domain_ops *ops,
 881                                             void *host_data)
 882 {
 883         struct irq_domain *domain;
 884
 885         if (size)
 886                 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
 887         else
 888                 domain = irq_domain_create_tree(fwnode, ops, host_data);
 889         if (domain) {
 890                 domain->parent = parent;
 891                 domain->flags |= flags;
 892         }
 893
 894         return domain;
 895 }
 896
 897 static void irq_domain_insert_irq(int virq)
 898 {
 899         struct irq_data *data;
 900
 901         for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
 902                 struct irq_domain *domain = data->domain;
 903                 irq_hw_number_t hwirq = data->hwirq;
 904
 905                 if (hwirq < domain->revmap_size) {
 906                         domain->linear_revmap[hwirq] = virq;
 907                 } else {
 908                         mutex_lock(&revmap_trees_mutex);
 909                         radix_tree_insert(&domain->revmap_tree, hwirq, data);
 910                         mutex_unlock(&revmap_trees_mutex);
 911                 }
 912
 913                 /* If not already assigned, give the domain the chip's name */
 914                 if (!domain->name && data->chip)
 915                         domain->name = data->chip->name;
 916         }
 917
 918         irq_clear_status_flags(virq, IRQ_NOREQUEST);
 919 }
 920
 921 static void irq_domain_remove_irq(int virq)
 922 {
 923         struct irq_data *data;
 924
 925         irq_set_status_flags(virq, IRQ_NOREQUEST);
 926         irq_set_chip_and_handler(virq, NULL, NULL);
 927         synchronize_irq(virq);
 928         smp_mb();
 929
 930         for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
 931                 struct irq_domain *domain = data->domain;
 932                 irq_hw_number_t hwirq = data->hwirq;
 933
 934                 if (hwirq < domain->revmap_size) {
 935                         domain->linear_revmap[hwirq] = 0;
 936                 } else {
 937                         mutex_lock(&revmap_trees_mutex);
 938                         radix_tree_delete(&domain->revmap_tree, hwirq);
 939                         mutex_unlock(&revmap_trees_mutex);
 940                 }
 941         }
 942 }
 943
 944 static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
 945                                                    struct irq_data *child)
 946 {
 947         struct irq_data *irq_data;
 948
 949         irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
 950                                 irq_data_get_node(child));
 951         if (irq_data) {
 952                 child->parent_data = irq_data;
 953                 irq_data->irq = child->irq;
 954                 irq_data->common = child->common;
 955                 irq_data->domain = domain;
 956         }
 957
 958         return irq_data;
 959 }
 960
 961 static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
 962 {
 963         struct irq_data *irq_data, *tmp;
 964         int i;
 965
 966         for (i = 0; i < nr_irqs; i++) {
 967                 irq_data = irq_get_irq_data(virq + i);
 968                 tmp = irq_data->parent_data;
 969                 irq_data->parent_data = NULL;
 970                 irq_data->domain = NULL;
 971
 972                 while (tmp) {
 973                         irq_data = tmp;
 974                         tmp = tmp->parent_data;
 975                         kfree(irq_data);
 976                 }
 977         }
 978 }
 979
 980 static int irq_domain_alloc_irq_data(struct irq_domain *domain,
 981                                      unsigned int virq, unsigned int nr_irqs)
 982 {
 983         struct irq_data *irq_data;
 984         struct irq_domain *parent;
 985         int i;
 986
 987         /* The outermost irq_data is embedded in struct irq_desc */
 988         for (i = 0; i < nr_irqs; i++) {
 989                 irq_data = irq_get_irq_data(virq + i);
 990                 irq_data->domain = domain;
 991
 992                 for (parent = domain->parent; parent; parent = parent->parent) {
 993                         irq_data = irq_domain_insert_irq_data(parent, irq_data);
 994                         if (!irq_data) {
 995                                 irq_domain_free_irq_data(virq, i + 1);
 996                                 return -ENOMEM;
 997                         }
 998                 }
 999         }
1000
1001         return 0;
1002 }
1003
1004 /**
1005  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1006  * @domain:     domain to match
1007  * @virq:       IRQ number to get irq_data
1008  */
1009 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1010                                          unsigned int virq)
1011 {
1012         struct irq_data *irq_data;
1013
1014         for (irq_data = irq_get_irq_data(virq); irq_data;
1015              irq_data = irq_data->parent_data)
1016                 if (irq_data->domain == domain)
1017                         return irq_data;
1018
1019         return NULL;
1020 }
1021
1022 /**
1023  * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1024  * @domain:     Interrupt domain to match
1025  * @virq:       IRQ number
1026  * @hwirq:      The hwirq number
1027  * @chip:       The associated interrupt chip
1028  * @chip_data:  The associated chip data
1029  */
1030 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1031                                   irq_hw_number_t hwirq, struct irq_chip *chip,
1032                                   void *chip_data)
1033 {
1034         struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1035
1036         if (!irq_data)
1037                 return -ENOENT;
1038
1039         irq_data->hwirq = hwirq;
1040         irq_data->chip = chip ? chip : &no_irq_chip;
1041         irq_data->chip_data = chip_data;
1042
1043         return 0;
1044 }
1045
1046 /**
1047  * irq_domain_set_info - Set the complete data for a @virq in @domain
1048  * @domain:             Interrupt domain to match
1049  * @virq:               IRQ number
1050  * @hwirq:              The hardware interrupt number
1051  * @chip:               The associated interrupt chip
1052  * @chip_data:          The associated interrupt chip data
1053  * @handler:            The interrupt flow handler
1054  * @handler_data:       The interrupt flow handler data
1055  * @handler_name:       The interrupt handler name
1056  */
1057 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1058                          irq_hw_number_t hwirq, struct irq_chip *chip,
1059                          void *chip_data, irq_flow_handler_t handler,
1060                          void *handler_data, const char *handler_name)
1061 {
1062         irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1063         __irq_set_handler(virq, handler, 0, handler_name);
1064         irq_set_handler_data(virq, handler_data);
1065 }
1066
1067 /**
1068  * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1069  * @irq_data:   The pointer to irq_data
1070  */
1071 void irq_domain_reset_irq_data(struct irq_data *irq_data)
1072 {
1073         irq_data->hwirq = 0;
1074         irq_data->chip = &no_irq_chip;
1075         irq_data->chip_data = NULL;
1076 }
1077
1078 /**
1079  * irq_domain_free_irqs_common - Clear irq_data and free the parent
1080  * @domain:     Interrupt domain to match
1081  * @virq:       IRQ number to start with
1082  * @nr_irqs:    The number of irqs to free
1083  */
1084 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1085                                  unsigned int nr_irqs)
1086 {
1087         struct irq_data *irq_data;
1088         int i;
1089
1090         for (i = 0; i < nr_irqs; i++) {
1091                 irq_data = irq_domain_get_irq_data(domain, virq + i);
1092                 if (irq_data)
1093                         irq_domain_reset_irq_data(irq_data);
1094         }
1095         irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1096 }
1097
1098 /**
1099  * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1100  * @domain:     Interrupt domain to match
1101  * @virq:       IRQ number to start with
1102  * @nr_irqs:    The number of irqs to free
1103  */
1104 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1105                               unsigned int nr_irqs)
1106 {
1107         int i;
1108
1109         for (i = 0; i < nr_irqs; i++) {
1110                 irq_set_handler_data(virq + i, NULL);
1111                 irq_set_handler(virq + i, NULL);
1112         }
1113         irq_domain_free_irqs_common(domain, virq, nr_irqs);
1114 }
1115
1116 static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1117 {
1118         return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1119 }
1120
1121 static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1122                                            unsigned int irq_base,
1123                                            unsigned int nr_irqs)
1124 {
1125         domain->ops->free(domain, irq_base, nr_irqs);
1126         if (irq_domain_is_auto_recursive(domain)) {
1127                 BUG_ON(!domain->parent);
1128                 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1129                                                nr_irqs);
1130         }
1131 }
1132
1133 static int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1134                                            unsigned int irq_base,
1135                                            unsigned int nr_irqs, void *arg)
1136 {
1137         int ret = 0;
1138         struct irq_domain *parent = domain->parent;
1139         bool recursive = irq_domain_is_auto_recursive(domain);
1140
1141         BUG_ON(recursive && !parent);
1142         if (recursive)
1143                 ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1144                                                       nr_irqs, arg);
1145         if (ret >= 0)
1146                 ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1147         if (ret < 0 && recursive)
1148                 irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1149
1150         return ret;
1151 }
1152
1153 /**
1154  * __irq_domain_alloc_irqs - Allocate IRQs from domain
1155  * @domain:     domain to allocate from
1156  * @irq_base:   allocate specified IRQ nubmer if irq_base >= 0
1157  * @nr_irqs:    number of IRQs to allocate
1158  * @node:       NUMA node id for memory allocation
1159  * @arg:        domain specific argument
1160  * @realloc:    IRQ descriptors have already been allocated if true
1161  *
1162  * Allocate IRQ numbers and initialized all data structures to support
1163  * hierarchy IRQ domains.
1164  * Parameter @realloc is mainly to support legacy IRQs.
1165  * Returns error code or allocated IRQ number
1166  *
1167  * The whole process to setup an IRQ has been split into two steps.
1168  * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1169  * descriptor and required hardware resources. The second step,
1170  * irq_domain_activate_irq(), is to program hardwares with preallocated
1171  * resources. In this way, it's easier to rollback when failing to
1172  * allocate resources.
1173  */
1174 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1175                             unsigned int nr_irqs, int node, void *arg,
1176                             bool realloc)
1177 {
1178         int i, ret, virq;
1179
1180         if (domain == NULL) {
1181                 domain = irq_default_domain;
1182                 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1183                         return -EINVAL;
1184         }
1185
1186         if (!domain->ops->alloc) {
1187                 pr_debug("domain->ops->alloc() is NULL\n");
1188                 return -ENOSYS;
1189         }
1190
1191         if (realloc && irq_base >= 0) {
1192                 virq = irq_base;
1193         } else {
1194                 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node);
1195                 if (virq < 0) {
1196                         pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1197                                  irq_base, nr_irqs);
1198                         return virq;
1199                 }
1200         }
1201
1202         if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1203                 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1204                 ret = -ENOMEM;
1205                 goto out_free_desc;
1206         }
1207
1208         mutex_lock(&irq_domain_mutex);
1209         ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1210         if (ret < 0) {
1211                 mutex_unlock(&irq_domain_mutex);
1212                 goto out_free_irq_data;
1213         }
1214         for (i = 0; i < nr_irqs; i++)
1215                 irq_domain_insert_irq(virq + i);
1216         mutex_unlock(&irq_domain_mutex);
1217
1218         return virq;
1219
1220 out_free_irq_data:
1221         irq_domain_free_irq_data(virq, nr_irqs);
1222 out_free_desc:
1223         irq_free_descs(virq, nr_irqs);
1224         return ret;
1225 }
1226
1227 /**
1228  * irq_domain_free_irqs - Free IRQ number and associated data structures
1229  * @virq:       base IRQ number
1230  * @nr_irqs:    number of IRQs to free
1231  */
1232 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1233 {
1234         struct irq_data *data = irq_get_irq_data(virq);
1235         int i;
1236
1237         if (WARN(!data || !data->domain || !data->domain->ops->free,
1238                  "NULL pointer, cannot free irq\n"))
1239                 return;
1240
1241         mutex_lock(&irq_domain_mutex);
1242         for (i = 0; i < nr_irqs; i++)
1243                 irq_domain_remove_irq(virq + i);
1244         irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1245         mutex_unlock(&irq_domain_mutex);
1246
1247         irq_domain_free_irq_data(virq, nr_irqs);
1248         irq_free_descs(virq, nr_irqs);
1249 }
1250
1251 /**
1252  * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1253  * @irq_base:   Base IRQ number
1254  * @nr_irqs:    Number of IRQs to allocate
1255  * @arg:        Allocation data (arch/domain specific)
1256  *
1257  * Check whether the domain has been setup recursive. If not allocate
1258  * through the parent domain.
1259  */
1260 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1261                                  unsigned int irq_base, unsigned int nr_irqs,
1262                                  void *arg)
1263 {
1264         /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1265         if (irq_domain_is_auto_recursive(domain))
1266                 return 0;
1267
1268         domain = domain->parent;
1269         if (domain)
1270                 return irq_domain_alloc_irqs_recursive(domain, irq_base,
1271                                                        nr_irqs, arg);
1272         return -ENOSYS;
1273 }
1274
1275 /**
1276  * irq_domain_free_irqs_parent - Free interrupts from parent domain
1277  * @irq_base:   Base IRQ number
1278  * @nr_irqs:    Number of IRQs to free
1279  *
1280  * Check whether the domain has been setup recursive. If not free
1281  * through the parent domain.
1282  */
1283 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1284                                  unsigned int irq_base, unsigned int nr_irqs)
1285 {
1286         /* irq_domain_free_irqs_recursive() will call parent's free */
1287         if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1288                 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1289                                                nr_irqs);
1290 }
1291
1292 /**
1293  * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1294  *                           interrupt
1295  * @irq_data:   outermost irq_data associated with interrupt
1296  *
1297  * This is the second step to call domain_ops->activate to program interrupt
1298  * controllers, so the interrupt could actually get delivered.
1299  */
1300 void irq_domain_activate_irq(struct irq_data *irq_data)
1301 {
1302         if (irq_data && irq_data->domain) {
1303                 struct irq_domain *domain = irq_data->domain;
1304
1305                 if (irq_data->parent_data)
1306                         irq_domain_activate_irq(irq_data->parent_data);
1307                 if (domain->ops->activate)
1308                         domain->ops->activate(domain, irq_data);
1309         }
1310 }
1311
1312 /**
1313  * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1314  *                             deactivate interrupt
1315  * @irq_data: outermost irq_data associated with interrupt
1316  *
1317  * It calls domain_ops->deactivate to program interrupt controllers to disable
1318  * interrupt delivery.
1319  */
1320 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1321 {
1322         if (irq_data && irq_data->domain) {
1323                 struct irq_domain *domain = irq_data->domain;
1324
1325                 if (domain->ops->deactivate)
1326                         domain->ops->deactivate(domain, irq_data);
1327                 if (irq_data->parent_data)
1328                         irq_domain_deactivate_irq(irq_data->parent_data);
1329         }
1330 }
1331
1332 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1333 {
1334         /* Hierarchy irq_domains must implement callback alloc() */
1335         if (domain->ops->alloc)
1336                 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1337 }
1338 #else   /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1339 /**
1340  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1341  * @domain:     domain to match
1342  * @virq:       IRQ number to get irq_data
1343  */
1344 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1345                                          unsigned int virq)
1346 {
1347         struct irq_data *irq_data = irq_get_irq_data(virq);
1348
1349         return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1350 }
1351
1352 /**
1353  * irq_domain_set_info - Set the complete data for a @virq in @domain
1354  * @domain:             Interrupt domain to match
1355  * @virq:               IRQ number
1356  * @hwirq:              The hardware interrupt number
1357  * @chip:               The associated interrupt chip
1358  * @chip_data:          The associated interrupt chip data
1359  * @handler:            The interrupt flow handler
1360  * @handler_data:       The interrupt flow handler data
1361  * @handler_name:       The interrupt handler name
1362  */
1363 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1364                          irq_hw_number_t hwirq, struct irq_chip *chip,
1365                          void *chip_data, irq_flow_handler_t handler,
1366                          void *handler_data, const char *handler_name)
1367 {
1368         irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1369         irq_set_chip_data(virq, chip_data);
1370         irq_set_handler_data(virq, handler_data);
1371 }
1372
1373 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1374 {
1375 }
1376 #endif  /* CONFIG_IRQ_DOMAIN_HIERARCHY */