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