kernel/irq/irqdomain.c

   1 // SPDX-License-Identifier: GPL-2.0
   2
   3 #define pr_fmt(fmt)  "irq: " fmt
   4
   5 #include <linux/acpi.h>
   6 #include <linux/debugfs.h>
   7 #include <linux/hardirq.h>
   8 #include <linux/interrupt.h>
   9 #include <linux/irq.h>
  10 #include <linux/irqdesc.h>
  11 #include <linux/irqdomain.h>
  12 #include <linux/module.h>
  13 #include <linux/mutex.h>
  14 #include <linux/of.h>
  15 #include <linux/of_address.h>
  16 #include <linux/of_irq.h>
  17 #include <linux/topology.h>
  18 #include <linux/seq_file.h>
  19 #include <linux/slab.h>
  20 #include <linux/smp.h>
  21 #include <linux/fs.h>
  22
  23 static LIST_HEAD(irq_domain_list);
  24 static DEFINE_MUTEX(irq_domain_mutex);
  25
  26 static struct irq_domain *irq_default_domain;
  27
  28 static void irq_domain_check_hierarchy(struct irq_domain *domain);
  29
  30 struct irqchip_fwid {
  31         struct fwnode_handle    fwnode;
  32         unsigned int            type;
  33         char                    *name;
  34         phys_addr_t             *pa;
  35 };
  36
  37 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
  38 static void debugfs_add_domain_dir(struct irq_domain *d);
  39 static void debugfs_remove_domain_dir(struct irq_domain *d);
  40 #else
  41 static inline void debugfs_add_domain_dir(struct irq_domain *d) { }
  42 static inline void debugfs_remove_domain_dir(struct irq_domain *d) { }
  43 #endif
  44
  45 static const char *irqchip_fwnode_get_name(const struct fwnode_handle *fwnode)
  46 {
  47         struct irqchip_fwid *fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
  48
  49         return fwid->name;
  50 }
  51
  52 const struct fwnode_operations irqchip_fwnode_ops = {
  53         .get_name = irqchip_fwnode_get_name,
  54 };
  55 EXPORT_SYMBOL_GPL(irqchip_fwnode_ops);
  56
  57 /**
  58  * __irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
  59  *                           identifying an irq domain
  60  * @type:       Type of irqchip_fwnode. See linux/irqdomain.h
  61  * @id:         Optional user provided id if name != NULL
  62  * @name:       Optional user provided domain name
  63  * @pa:         Optional user-provided physical address
  64  *
  65  * Allocate a struct irqchip_fwid, and return a pointer to the embedded
  66  * fwnode_handle (or NULL on failure).
  67  *
  68  * Note: The types IRQCHIP_FWNODE_NAMED and IRQCHIP_FWNODE_NAMED_ID are
  69  * solely to transport name information to irqdomain creation code. The
  70  * node is not stored. For other types the pointer is kept in the irq
  71  * domain struct.
  72  */
  73 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
  74                                                 const char *name,
  75                                                 phys_addr_t *pa)
  76 {
  77         struct irqchip_fwid *fwid;
  78         char *n;
  79
  80         fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
  81
  82         switch (type) {
  83         case IRQCHIP_FWNODE_NAMED:
  84                 n = kasprintf(GFP_KERNEL, "%s", name);
  85                 break;
  86         case IRQCHIP_FWNODE_NAMED_ID:
  87                 n = kasprintf(GFP_KERNEL, "%s-%d", name, id);
  88                 break;
  89         default:
  90                 n = kasprintf(GFP_KERNEL, "irqchip@%pa", pa);
  91                 break;
  92         }
  93
  94         if (!fwid || !n) {
  95                 kfree(fwid);
  96                 kfree(n);
  97                 return NULL;
  98         }
  99
 100         fwid->type = type;
 101         fwid->name = n;
 102         fwid->pa = pa;
 103         fwnode_init(&fwid->fwnode, &irqchip_fwnode_ops);
 104         return &fwid->fwnode;
 105 }
 106 EXPORT_SYMBOL_GPL(__irq_domain_alloc_fwnode);
 107
 108 /**
 109  * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
 110  *
 111  * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
 112  */
 113 void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
 114 {
 115         struct irqchip_fwid *fwid;
 116
 117         if (WARN_ON(!is_fwnode_irqchip(fwnode)))
 118                 return;
 119
 120         fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
 121         kfree(fwid->name);
 122         kfree(fwid);
 123 }
 124 EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
 125
 126 /**
 127  * __irq_domain_add() - Allocate a new irq_domain data structure
 128  * @fwnode: firmware node for the interrupt controller
 129  * @size: Size of linear map; 0 for radix mapping only
 130  * @hwirq_max: Maximum number of interrupts supported by controller
 131  * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
 132  *              direct mapping
 133  * @ops: domain callbacks
 134  * @host_data: Controller private data pointer
 135  *
 136  * Allocates and initializes an irq_domain structure.
 137  * Returns pointer to IRQ domain, or NULL on failure.
 138  */
 139 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
 140                                     irq_hw_number_t hwirq_max, int direct_max,
 141                                     const struct irq_domain_ops *ops,
 142                                     void *host_data)
 143 {
 144         struct irqchip_fwid *fwid;
 145         struct irq_domain *domain;
 146
 147         static atomic_t unknown_domains;
 148
 149         domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
 150                               GFP_KERNEL, of_node_to_nid(to_of_node(fwnode)));
 151         if (!domain)
 152                 return NULL;
 153
 154         if (is_fwnode_irqchip(fwnode)) {
 155                 fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
 156
 157                 switch (fwid->type) {
 158                 case IRQCHIP_FWNODE_NAMED:
 159                 case IRQCHIP_FWNODE_NAMED_ID:
 160                         domain->fwnode = fwnode;
 161                         domain->name = kstrdup(fwid->name, GFP_KERNEL);
 162                         if (!domain->name) {
 163                                 kfree(domain);
 164                                 return NULL;
 165                         }
 166                         domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 167                         break;
 168                 default:
 169                         domain->fwnode = fwnode;
 170                         domain->name = fwid->name;
 171                         break;
 172                 }
 173         } else if (is_of_node(fwnode) || is_acpi_device_node(fwnode) ||
 174                    is_software_node(fwnode)) {
 175                 char *name;
 176
 177                 /*
 178                  * fwnode paths contain '/', which debugfs is legitimately
 179                  * unhappy about. Replace them with ':', which does
 180                  * the trick and is not as offensive as '\'...
 181                  */
 182                 name = kasprintf(GFP_KERNEL, "%pfw", fwnode);
 183                 if (!name) {
 184                         kfree(domain);
 185                         return NULL;
 186                 }
 187
 188                 strreplace(name, '/', ':');
 189
 190                 domain->name = name;
 191                 domain->fwnode = fwnode;
 192                 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 193         }
 194
 195         if (!domain->name) {
 196                 if (fwnode)
 197                         pr_err("Invalid fwnode type for irqdomain\n");
 198                 domain->name = kasprintf(GFP_KERNEL, "unknown-%d",
 199                                          atomic_inc_return(&unknown_domains));
 200                 if (!domain->name) {
 201                         kfree(domain);
 202                         return NULL;
 203                 }
 204                 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 205         }
 206
 207         fwnode_handle_get(fwnode);
 208         fwnode_dev_initialized(fwnode, true);
 209
 210         /* Fill structure */
 211         INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
 212         mutex_init(&domain->revmap_tree_mutex);
 213         domain->ops = ops;
 214         domain->host_data = host_data;
 215         domain->hwirq_max = hwirq_max;
 216         domain->revmap_size = size;
 217         domain->revmap_direct_max_irq = direct_max;
 218         irq_domain_check_hierarchy(domain);
 219
 220         mutex_lock(&irq_domain_mutex);
 221         debugfs_add_domain_dir(domain);
 222         list_add(&domain->link, &irq_domain_list);
 223         mutex_unlock(&irq_domain_mutex);
 224
 225         pr_debug("Added domain %s\n", domain->name);
 226         return domain;
 227 }
 228 EXPORT_SYMBOL_GPL(__irq_domain_add);
 229
 230 /**
 231  * irq_domain_remove() - Remove an irq domain.
 232  * @domain: domain to remove
 233  *
 234  * This routine is used to remove an irq domain. The caller must ensure
 235  * that all mappings within the domain have been disposed of prior to
 236  * use, depending on the revmap type.
 237  */
 238 void irq_domain_remove(struct irq_domain *domain)
 239 {
 240         mutex_lock(&irq_domain_mutex);
 241         debugfs_remove_domain_dir(domain);
 242
 243         WARN_ON(!radix_tree_empty(&domain->revmap_tree));
 244
 245         list_del(&domain->link);
 246
 247         /*
 248          * If the going away domain is the default one, reset it.
 249          */
 250         if (unlikely(irq_default_domain == domain))
 251                 irq_set_default_host(NULL);
 252
 253         mutex_unlock(&irq_domain_mutex);
 254
 255         pr_debug("Removed domain %s\n", domain->name);
 256
 257         fwnode_dev_initialized(domain->fwnode, false);
 258         fwnode_handle_put(domain->fwnode);
 259         if (domain->flags & IRQ_DOMAIN_NAME_ALLOCATED)
 260                 kfree(domain->name);
 261         kfree(domain);
 262 }
 263 EXPORT_SYMBOL_GPL(irq_domain_remove);
 264
 265 void irq_domain_update_bus_token(struct irq_domain *domain,
 266                                  enum irq_domain_bus_token bus_token)
 267 {
 268         char *name;
 269
 270         if (domain->bus_token == bus_token)
 271                 return;
 272
 273         mutex_lock(&irq_domain_mutex);
 274
 275         domain->bus_token = bus_token;
 276
 277         name = kasprintf(GFP_KERNEL, "%s-%d", domain->name, bus_token);
 278         if (!name) {
 279                 mutex_unlock(&irq_domain_mutex);
 280                 return;
 281         }
 282
 283         debugfs_remove_domain_dir(domain);
 284
 285         if (domain->flags & IRQ_DOMAIN_NAME_ALLOCATED)
 286                 kfree(domain->name);
 287         else
 288                 domain->flags |= IRQ_DOMAIN_NAME_ALLOCATED;
 289
 290         domain->name = name;
 291         debugfs_add_domain_dir(domain);
 292
 293         mutex_unlock(&irq_domain_mutex);
 294 }
 295 EXPORT_SYMBOL_GPL(irq_domain_update_bus_token);
 296
 297 /**
 298  * irq_domain_create_simple() - Register an irq_domain and optionally map a range of irqs
 299  * @fwnode: firmware node for the interrupt controller
 300  * @size: total number of irqs in mapping
 301  * @first_irq: first number of irq block assigned to the domain,
 302  *      pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
 303  *      pre-map all of the irqs in the domain to virqs starting at first_irq.
 304  * @ops: domain callbacks
 305  * @host_data: Controller private data pointer
 306  *
 307  * Allocates an irq_domain, and optionally if first_irq is positive then also
 308  * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
 309  *
 310  * This is intended to implement the expected behaviour for most
 311  * interrupt controllers. If device tree is used, then first_irq will be 0 and
 312  * irqs get mapped dynamically on the fly. However, if the controller requires
 313  * static virq assignments (non-DT boot) then it will set that up correctly.
 314  */
 315 struct irq_domain *irq_domain_create_simple(struct fwnode_handle *fwnode,
 316                                             unsigned int size,
 317                                             unsigned int first_irq,
 318                                             const struct irq_domain_ops *ops,
 319                                             void *host_data)
 320 {
 321         struct irq_domain *domain;
 322
 323         domain = __irq_domain_add(fwnode, size, size, 0, ops, host_data);
 324         if (!domain)
 325                 return NULL;
 326
 327         if (first_irq > 0) {
 328                 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
 329                         /* attempt to allocated irq_descs */
 330                         int rc = irq_alloc_descs(first_irq, first_irq, size,
 331                                                  of_node_to_nid(to_of_node(fwnode)));
 332                         if (rc < 0)
 333                                 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
 334                                         first_irq);
 335                 }
 336                 irq_domain_associate_many(domain, first_irq, 0, size);
 337         }
 338
 339         return domain;
 340 }
 341 EXPORT_SYMBOL_GPL(irq_domain_create_simple);
 342
 343 /**
 344  * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
 345  * @of_node: pointer to interrupt controller's device tree node.
 346  * @size: total number of irqs in legacy mapping
 347  * @first_irq: first number of irq block assigned to the domain
 348  * @first_hwirq: first hwirq number to use for the translation. Should normally
 349  *               be '0', but a positive integer can be used if the effective
 350  *               hwirqs numbering does not begin at zero.
 351  * @ops: map/unmap domain callbacks
 352  * @host_data: Controller private data pointer
 353  *
 354  * Note: the map() callback will be called before this function returns
 355  * for all legacy interrupts except 0 (which is always the invalid irq for
 356  * a legacy controller).
 357  */
 358 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
 359                                          unsigned int size,
 360                                          unsigned int first_irq,
 361                                          irq_hw_number_t first_hwirq,
 362                                          const struct irq_domain_ops *ops,
 363                                          void *host_data)
 364 {
 365         return irq_domain_create_legacy(of_node_to_fwnode(of_node), size,
 366                                         first_irq, first_hwirq, ops, host_data);
 367 }
 368 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
 369
 370 struct irq_domain *irq_domain_create_legacy(struct fwnode_handle *fwnode,
 371                                          unsigned int size,
 372                                          unsigned int first_irq,
 373                                          irq_hw_number_t first_hwirq,
 374                                          const struct irq_domain_ops *ops,
 375                                          void *host_data)
 376 {
 377         struct irq_domain *domain;
 378
 379         domain = __irq_domain_add(fwnode, first_hwirq + size, first_hwirq + size, 0, ops, host_data);
 380         if (domain)
 381                 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
 382
 383         return domain;
 384 }
 385 EXPORT_SYMBOL_GPL(irq_domain_create_legacy);
 386
 387 /**
 388  * irq_find_matching_fwspec() - Locates a domain for a given fwspec
 389  * @fwspec: FW specifier for an interrupt
 390  * @bus_token: domain-specific data
 391  */
 392 struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
 393                                             enum irq_domain_bus_token bus_token)
 394 {
 395         struct irq_domain *h, *found = NULL;
 396         struct fwnode_handle *fwnode = fwspec->fwnode;
 397         int rc;
 398
 399         /* We might want to match the legacy controller last since
 400          * it might potentially be set to match all interrupts in
 401          * the absence of a device node. This isn't a problem so far
 402          * yet though...
 403          *
 404          * bus_token == DOMAIN_BUS_ANY matches any domain, any other
 405          * values must generate an exact match for the domain to be
 406          * selected.
 407          */
 408         mutex_lock(&irq_domain_mutex);
 409         list_for_each_entry(h, &irq_domain_list, link) {
 410                 if (h->ops->select && fwspec->param_count)
 411                         rc = h->ops->select(h, fwspec, bus_token);
 412                 else if (h->ops->match)
 413                         rc = h->ops->match(h, to_of_node(fwnode), bus_token);
 414                 else
 415                         rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
 416                               ((bus_token == DOMAIN_BUS_ANY) ||
 417                                (h->bus_token == bus_token)));
 418
 419                 if (rc) {
 420                         found = h;
 421                         break;
 422                 }
 423         }
 424         mutex_unlock(&irq_domain_mutex);
 425         return found;
 426 }
 427 EXPORT_SYMBOL_GPL(irq_find_matching_fwspec);
 428
 429 /**
 430  * irq_domain_check_msi_remap - Check whether all MSI irq domains implement
 431  * IRQ remapping
 432  *
 433  * Return: false if any MSI irq domain does not support IRQ remapping,
 434  * true otherwise (including if there is no MSI irq domain)
 435  */
 436 bool irq_domain_check_msi_remap(void)
 437 {
 438         struct irq_domain *h;
 439         bool ret = true;
 440
 441         mutex_lock(&irq_domain_mutex);
 442         list_for_each_entry(h, &irq_domain_list, link) {
 443                 if (irq_domain_is_msi(h) &&
 444                     !irq_domain_hierarchical_is_msi_remap(h)) {
 445                         ret = false;
 446                         break;
 447                 }
 448         }
 449         mutex_unlock(&irq_domain_mutex);
 450         return ret;
 451 }
 452 EXPORT_SYMBOL_GPL(irq_domain_check_msi_remap);
 453
 454 /**
 455  * irq_set_default_host() - Set a "default" irq domain
 456  * @domain: default domain pointer
 457  *
 458  * For convenience, it's possible to set a "default" domain that will be used
 459  * whenever NULL is passed to irq_create_mapping(). It makes life easier for
 460  * platforms that want to manipulate a few hard coded interrupt numbers that
 461  * aren't properly represented in the device-tree.
 462  */
 463 void irq_set_default_host(struct irq_domain *domain)
 464 {
 465         pr_debug("Default domain set to @0x%p\n", domain);
 466
 467         irq_default_domain = domain;
 468 }
 469 EXPORT_SYMBOL_GPL(irq_set_default_host);
 470
 471 /**
 472  * irq_get_default_host() - Retrieve the "default" irq domain
 473  *
 474  * Returns: the default domain, if any.
 475  *
 476  * Modern code should never use this. This should only be used on
 477  * systems that cannot implement a firmware->fwnode mapping (which
 478  * both DT and ACPI provide).
 479  */
 480 struct irq_domain *irq_get_default_host(void)
 481 {
 482         return irq_default_domain;
 483 }
 484
 485 static void irq_domain_clear_mapping(struct irq_domain *domain,
 486                                      irq_hw_number_t hwirq)
 487 {
 488         if (hwirq < domain->revmap_size) {
 489                 domain->linear_revmap[hwirq] = 0;
 490         } else {
 491                 mutex_lock(&domain->revmap_tree_mutex);
 492                 radix_tree_delete(&domain->revmap_tree, hwirq);
 493                 mutex_unlock(&domain->revmap_tree_mutex);
 494         }
 495 }
 496
 497 static void irq_domain_set_mapping(struct irq_domain *domain,
 498                                    irq_hw_number_t hwirq,
 499                                    struct irq_data *irq_data)
 500 {
 501         if (hwirq < domain->revmap_size) {
 502                 domain->linear_revmap[hwirq] = irq_data->irq;
 503         } else {
 504                 mutex_lock(&domain->revmap_tree_mutex);
 505                 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
 506                 mutex_unlock(&domain->revmap_tree_mutex);
 507         }
 508 }
 509
 510 static void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
 511 {
 512         struct irq_data *irq_data = irq_get_irq_data(irq);
 513         irq_hw_number_t hwirq;
 514
 515         if (WARN(!irq_data || irq_data->domain != domain,
 516                  "virq%i doesn't exist; cannot disassociate\n", irq))
 517                 return;
 518
 519         hwirq = irq_data->hwirq;
 520         irq_set_status_flags(irq, IRQ_NOREQUEST);
 521
 522         /* remove chip and handler */
 523         irq_set_chip_and_handler(irq, NULL, NULL);
 524
 525         /* Make sure it's completed */
 526         synchronize_irq(irq);
 527
 528         /* Tell the PIC about it */
 529         if (domain->ops->unmap)
 530                 domain->ops->unmap(domain, irq);
 531         smp_mb();
 532
 533         irq_data->domain = NULL;
 534         irq_data->hwirq = 0;
 535         domain->mapcount--;
 536
 537         /* Clear reverse map for this hwirq */
 538         irq_domain_clear_mapping(domain, hwirq);
 539 }
 540
 541 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
 542                          irq_hw_number_t hwirq)
 543 {
 544         struct irq_data *irq_data = irq_get_irq_data(virq);
 545         int ret;
 546
 547         if (WARN(hwirq >= domain->hwirq_max,
 548                  "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
 549                 return -EINVAL;
 550         if (WARN(!irq_data, "error: virq%i is not allocated", virq))
 551                 return -EINVAL;
 552         if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
 553                 return -EINVAL;
 554
 555         mutex_lock(&irq_domain_mutex);
 556         irq_data->hwirq = hwirq;
 557         irq_data->domain = domain;
 558         if (domain->ops->map) {
 559                 ret = domain->ops->map(domain, virq, hwirq);
 560                 if (ret != 0) {
 561                         /*
 562                          * If map() returns -EPERM, this interrupt is protected
 563                          * by the firmware or some other service and shall not
 564                          * be mapped. Don't bother telling the user about it.
 565                          */
 566                         if (ret != -EPERM) {
 567                                 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
 568                                        domain->name, hwirq, virq, ret);
 569                         }
 570                         irq_data->domain = NULL;
 571                         irq_data->hwirq = 0;
 572                         mutex_unlock(&irq_domain_mutex);
 573                         return ret;
 574                 }
 575
 576                 /* If not already assigned, give the domain the chip's name */
 577                 if (!domain->name && irq_data->chip)
 578                         domain->name = irq_data->chip->name;
 579         }
 580
 581         domain->mapcount++;
 582         irq_domain_set_mapping(domain, hwirq, irq_data);
 583         mutex_unlock(&irq_domain_mutex);
 584
 585         irq_clear_status_flags(virq, IRQ_NOREQUEST);
 586
 587         return 0;
 588 }
 589 EXPORT_SYMBOL_GPL(irq_domain_associate);
 590
 591 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
 592                                irq_hw_number_t hwirq_base, int count)
 593 {
 594         struct device_node *of_node;
 595         int i;
 596
 597         of_node = irq_domain_get_of_node(domain);
 598         pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
 599                 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
 600
 601         for (i = 0; i < count; i++) {
 602                 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
 603         }
 604 }
 605 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
 606
 607 /**
 608  * irq_create_direct_mapping() - Allocate an irq for direct mapping
 609  * @domain: domain to allocate the irq for or NULL for default domain
 610  *
 611  * This routine is used for irq controllers which can choose the hardware
 612  * interrupt numbers they generate. In such a case it's simplest to use
 613  * the linux irq as the hardware interrupt number. It still uses the linear
 614  * or radix tree to store the mapping, but the irq controller can optimize
 615  * the revmap path by using the hwirq directly.
 616  */
 617 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
 618 {
 619         struct device_node *of_node;
 620         unsigned int virq;
 621
 622         if (domain == NULL)
 623                 domain = irq_default_domain;
 624
 625         of_node = irq_domain_get_of_node(domain);
 626         virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
 627         if (!virq) {
 628                 pr_debug("create_direct virq allocation failed\n");
 629                 return 0;
 630         }
 631         if (virq >= domain->revmap_direct_max_irq) {
 632                 pr_err("ERROR: no free irqs available below %i maximum\n",
 633                         domain->revmap_direct_max_irq);
 634                 irq_free_desc(virq);
 635                 return 0;
 636         }
 637         pr_debug("create_direct obtained virq %d\n", virq);
 638
 639         if (irq_domain_associate(domain, virq, virq)) {
 640                 irq_free_desc(virq);
 641                 return 0;
 642         }
 643
 644         return virq;
 645 }
 646 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
 647
 648 /**
 649  * irq_create_mapping_affinity() - Map a hardware interrupt into linux irq space
 650  * @domain: domain owning this hardware interrupt or NULL for default domain
 651  * @hwirq: hardware irq number in that domain space
 652  * @affinity: irq affinity
 653  *
 654  * Only one mapping per hardware interrupt is permitted. Returns a linux
 655  * irq number.
 656  * If the sense/trigger is to be specified, set_irq_type() should be called
 657  * on the number returned from that call.
 658  */
 659 unsigned int irq_create_mapping_affinity(struct irq_domain *domain,
 660                                        irq_hw_number_t hwirq,
 661                                        const struct irq_affinity_desc *affinity)
 662 {
 663         struct device_node *of_node;
 664         int virq;
 665
 666         pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
 667
 668         /* Look for default domain if necessary */
 669         if (domain == NULL)
 670                 domain = irq_default_domain;
 671         if (domain == NULL) {
 672                 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
 673                 return 0;
 674         }
 675         pr_debug("-> using domain @%p\n", domain);
 676
 677         of_node = irq_domain_get_of_node(domain);
 678
 679         /* Check if mapping already exists */
 680         virq = irq_find_mapping(domain, hwirq);
 681         if (virq) {
 682                 pr_debug("-> existing mapping on virq %d\n", virq);
 683                 return virq;
 684         }
 685
 686         /* Allocate a virtual interrupt number */
 687         virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node),
 688                                       affinity);
 689         if (virq <= 0) {
 690                 pr_debug("-> virq allocation failed\n");
 691                 return 0;
 692         }
 693
 694         if (irq_domain_associate(domain, virq, hwirq)) {
 695                 irq_free_desc(virq);
 696                 return 0;
 697         }
 698
 699         pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
 700                 hwirq, of_node_full_name(of_node), virq);
 701
 702         return virq;
 703 }
 704 EXPORT_SYMBOL_GPL(irq_create_mapping_affinity);
 705
 706 static int irq_domain_translate(struct irq_domain *d,
 707                                 struct irq_fwspec *fwspec,
 708                                 irq_hw_number_t *hwirq, unsigned int *type)
 709 {
 710 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
 711         if (d->ops->translate)
 712                 return d->ops->translate(d, fwspec, hwirq, type);
 713 #endif
 714         if (d->ops->xlate)
 715                 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
 716                                      fwspec->param, fwspec->param_count,
 717                                      hwirq, type);
 718
 719         /* If domain has no translation, then we assume interrupt line */
 720         *hwirq = fwspec->param[0];
 721         return 0;
 722 }
 723
 724 static void of_phandle_args_to_fwspec(struct device_node *np, const u32 *args,
 725                                       unsigned int count,
 726                                       struct irq_fwspec *fwspec)
 727 {
 728         int i;
 729
 730         fwspec->fwnode = of_node_to_fwnode(np);
 731         fwspec->param_count = count;
 732
 733         for (i = 0; i < count; i++)
 734                 fwspec->param[i] = args[i];
 735 }
 736
 737 unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
 738 {
 739         struct irq_domain *domain;
 740         struct irq_data *irq_data;
 741         irq_hw_number_t hwirq;
 742         unsigned int type = IRQ_TYPE_NONE;
 743         int virq;
 744
 745         if (fwspec->fwnode) {
 746                 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_WIRED);
 747                 if (!domain)
 748                         domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_ANY);
 749         } else {
 750                 domain = irq_default_domain;
 751         }
 752
 753         if (!domain) {
 754                 pr_warn("no irq domain found for %s !\n",
 755                         of_node_full_name(to_of_node(fwspec->fwnode)));
 756                 return 0;
 757         }
 758
 759         if (irq_domain_translate(domain, fwspec, &hwirq, &type))
 760                 return 0;
 761
 762         /*
 763          * WARN if the irqchip returns a type with bits
 764          * outside the sense mask set and clear these bits.
 765          */
 766         if (WARN_ON(type & ~IRQ_TYPE_SENSE_MASK))
 767                 type &= IRQ_TYPE_SENSE_MASK;
 768
 769         /*
 770          * If we've already configured this interrupt,
 771          * don't do it again, or hell will break loose.
 772          */
 773         virq = irq_find_mapping(domain, hwirq);
 774         if (virq) {
 775                 /*
 776                  * If the trigger type is not specified or matches the
 777                  * current trigger type then we are done so return the
 778                  * interrupt number.
 779                  */
 780                 if (type == IRQ_TYPE_NONE || type == irq_get_trigger_type(virq))
 781                         return virq;
 782
 783                 /*
 784                  * If the trigger type has not been set yet, then set
 785                  * it now and return the interrupt number.
 786                  */
 787                 if (irq_get_trigger_type(virq) == IRQ_TYPE_NONE) {
 788                         irq_data = irq_get_irq_data(virq);
 789                         if (!irq_data)
 790                                 return 0;
 791
 792                         irqd_set_trigger_type(irq_data, type);
 793                         return virq;
 794                 }
 795
 796                 pr_warn("type mismatch, failed to map hwirq-%lu for %s!\n",
 797                         hwirq, of_node_full_name(to_of_node(fwspec->fwnode)));
 798                 return 0;
 799         }
 800
 801         if (irq_domain_is_hierarchy(domain)) {
 802                 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
 803                 if (virq <= 0)
 804                         return 0;
 805         } else {
 806                 /* Create mapping */
 807                 virq = irq_create_mapping(domain, hwirq);
 808                 if (!virq)
 809                         return virq;
 810         }
 811
 812         irq_data = irq_get_irq_data(virq);
 813         if (!irq_data) {
 814                 if (irq_domain_is_hierarchy(domain))
 815                         irq_domain_free_irqs(virq, 1);
 816                 else
 817                         irq_dispose_mapping(virq);
 818                 return 0;
 819         }
 820
 821         /* Store trigger type */
 822         irqd_set_trigger_type(irq_data, type);
 823
 824         return virq;
 825 }
 826 EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
 827
 828 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
 829 {
 830         struct irq_fwspec fwspec;
 831
 832         of_phandle_args_to_fwspec(irq_data->np, irq_data->args,
 833                                   irq_data->args_count, &fwspec);
 834
 835         return irq_create_fwspec_mapping(&fwspec);
 836 }
 837 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
 838
 839 /**
 840  * irq_dispose_mapping() - Unmap an interrupt
 841  * @virq: linux irq number of the interrupt to unmap
 842  */
 843 void irq_dispose_mapping(unsigned int virq)
 844 {
 845         struct irq_data *irq_data = irq_get_irq_data(virq);
 846         struct irq_domain *domain;
 847
 848         if (!virq || !irq_data)
 849                 return;
 850
 851         domain = irq_data->domain;
 852         if (WARN_ON(domain == NULL))
 853                 return;
 854
 855         if (irq_domain_is_hierarchy(domain)) {
 856                 irq_domain_free_irqs(virq, 1);
 857         } else {
 858                 irq_domain_disassociate(domain, virq);
 859                 irq_free_desc(virq);
 860         }
 861 }
 862 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
 863
 864 /**
 865  * irq_find_mapping() - Find a linux irq from a hw irq number.
 866  * @domain: domain owning this hardware interrupt
 867  * @hwirq: hardware irq number in that domain space
 868  */
 869 unsigned int irq_find_mapping(struct irq_domain *domain,
 870                               irq_hw_number_t hwirq)
 871 {
 872         struct irq_data *data;
 873
 874         /* Look for default domain if necessary */
 875         if (domain == NULL)
 876                 domain = irq_default_domain;
 877         if (domain == NULL)
 878                 return 0;
 879
 880         if (hwirq < domain->revmap_direct_max_irq) {
 881                 data = irq_domain_get_irq_data(domain, hwirq);
 882                 if (data && data->hwirq == hwirq)
 883                         return hwirq;
 884         }
 885
 886         /* Check if the hwirq is in the linear revmap. */
 887         if (hwirq < domain->revmap_size)
 888                 return domain->linear_revmap[hwirq];
 889
 890         rcu_read_lock();
 891         data = radix_tree_lookup(&domain->revmap_tree, hwirq);
 892         rcu_read_unlock();
 893         return data ? data->irq : 0;
 894 }
 895 EXPORT_SYMBOL_GPL(irq_find_mapping);
 896
 897 /**
 898  * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
 899  *
 900  * Device Tree IRQ specifier translation function which works with one cell
 901  * bindings where the cell value maps directly to the hwirq number.
 902  */
 903 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
 904                              const u32 *intspec, unsigned int intsize,
 905                              unsigned long *out_hwirq, unsigned int *out_type)
 906 {
 907         if (WARN_ON(intsize < 1))
 908                 return -EINVAL;
 909         *out_hwirq = intspec[0];
 910         *out_type = IRQ_TYPE_NONE;
 911         return 0;
 912 }
 913 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
 914
 915 /**
 916  * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
 917  *
 918  * Device Tree IRQ specifier translation function which works with two cell
 919  * bindings where the cell values map directly to the hwirq number
 920  * and linux irq flags.
 921  */
 922 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
 923                         const u32 *intspec, unsigned int intsize,
 924                         irq_hw_number_t *out_hwirq, unsigned int *out_type)
 925 {
 926         struct irq_fwspec fwspec;
 927
 928         of_phandle_args_to_fwspec(ctrlr, intspec, intsize, &fwspec);
 929         return irq_domain_translate_twocell(d, &fwspec, out_hwirq, out_type);
 930 }
 931 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
 932
 933 /**
 934  * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
 935  *
 936  * Device Tree IRQ specifier translation function which works with either one
 937  * or two cell bindings where the cell values map directly to the hwirq number
 938  * and linux irq flags.
 939  *
 940  * Note: don't use this function unless your interrupt controller explicitly
 941  * supports both one and two cell bindings.  For the majority of controllers
 942  * the _onecell() or _twocell() variants above should be used.
 943  */
 944 int irq_domain_xlate_onetwocell(struct irq_domain *d,
 945                                 struct device_node *ctrlr,
 946                                 const u32 *intspec, unsigned int intsize,
 947                                 unsigned long *out_hwirq, unsigned int *out_type)
 948 {
 949         if (WARN_ON(intsize < 1))
 950                 return -EINVAL;
 951         *out_hwirq = intspec[0];
 952         if (intsize > 1)
 953                 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
 954         else
 955                 *out_type = IRQ_TYPE_NONE;
 956         return 0;
 957 }
 958 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
 959
 960 const struct irq_domain_ops irq_domain_simple_ops = {
 961         .xlate = irq_domain_xlate_onetwocell,
 962 };
 963 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
 964
 965 /**
 966  * irq_domain_translate_onecell() - Generic translate for direct one cell
 967  * bindings
 968  */
 969 int irq_domain_translate_onecell(struct irq_domain *d,
 970                                  struct irq_fwspec *fwspec,
 971                                  unsigned long *out_hwirq,
 972                                  unsigned int *out_type)
 973 {
 974         if (WARN_ON(fwspec->param_count < 1))
 975                 return -EINVAL;
 976         *out_hwirq = fwspec->param[0];
 977         *out_type = IRQ_TYPE_NONE;
 978         return 0;
 979 }
 980 EXPORT_SYMBOL_GPL(irq_domain_translate_onecell);
 981
 982 /**
 983  * irq_domain_translate_twocell() - Generic translate for direct two cell
 984  * bindings
 985  *
 986  * Device Tree IRQ specifier translation function which works with two cell
 987  * bindings where the cell values map directly to the hwirq number
 988  * and linux irq flags.
 989  */
 990 int irq_domain_translate_twocell(struct irq_domain *d,
 991                                  struct irq_fwspec *fwspec,
 992                                  unsigned long *out_hwirq,
 993                                  unsigned int *out_type)
 994 {
 995         if (WARN_ON(fwspec->param_count < 2))
 996                 return -EINVAL;
 997         *out_hwirq = fwspec->param[0];
 998         *out_type = fwspec->param[1] & IRQ_TYPE_SENSE_MASK;
 999         return 0;
1000 }
1001 EXPORT_SYMBOL_GPL(irq_domain_translate_twocell);
1002
1003 int irq_domain_alloc_descs(int virq, unsigned int cnt, irq_hw_number_t hwirq,
1004                            int node, const struct irq_affinity_desc *affinity)
1005 {
1006         unsigned int hint;
1007
1008         if (virq >= 0) {
1009                 virq = __irq_alloc_descs(virq, virq, cnt, node, THIS_MODULE,
1010                                          affinity);
1011         } else {
1012                 hint = hwirq % nr_irqs;
1013                 if (hint == 0)
1014                         hint++;
1015                 virq = __irq_alloc_descs(-1, hint, cnt, node, THIS_MODULE,
1016                                          affinity);
1017                 if (virq <= 0 && hint > 1) {
1018                         virq = __irq_alloc_descs(-1, 1, cnt, node, THIS_MODULE,
1019                                                  affinity);
1020                 }
1021         }
1022
1023         return virq;
1024 }
1025
1026 /**
1027  * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1028  * @irq_data:   The pointer to irq_data
1029  */
1030 void irq_domain_reset_irq_data(struct irq_data *irq_data)
1031 {
1032         irq_data->hwirq = 0;
1033         irq_data->chip = &no_irq_chip;
1034         irq_data->chip_data = NULL;
1035 }
1036 EXPORT_SYMBOL_GPL(irq_domain_reset_irq_data);
1037
1038 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
1039 /**
1040  * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
1041  * @parent:     Parent irq domain to associate with the new domain
1042  * @flags:      Irq domain flags associated to the domain
1043  * @size:       Size of the domain. See below
1044  * @fwnode:     Optional fwnode of the interrupt controller
1045  * @ops:        Pointer to the interrupt domain callbacks
1046  * @host_data:  Controller private data pointer
1047  *
1048  * If @size is 0 a tree domain is created, otherwise a linear domain.
1049  *
1050  * If successful the parent is associated to the new domain and the
1051  * domain flags are set.
1052  * Returns pointer to IRQ domain, or NULL on failure.
1053  */
1054 struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
1055                                             unsigned int flags,
1056                                             unsigned int size,
1057                                             struct fwnode_handle *fwnode,
1058                                             const struct irq_domain_ops *ops,
1059                                             void *host_data)
1060 {
1061         struct irq_domain *domain;
1062
1063         if (size)
1064                 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
1065         else
1066                 domain = irq_domain_create_tree(fwnode, ops, host_data);
1067         if (domain) {
1068                 domain->parent = parent;
1069                 domain->flags |= flags;
1070         }
1071
1072         return domain;
1073 }
1074 EXPORT_SYMBOL_GPL(irq_domain_create_hierarchy);
1075
1076 static void irq_domain_insert_irq(int virq)
1077 {
1078         struct irq_data *data;
1079
1080         for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
1081                 struct irq_domain *domain = data->domain;
1082
1083                 domain->mapcount++;
1084                 irq_domain_set_mapping(domain, data->hwirq, data);
1085
1086                 /* If not already assigned, give the domain the chip's name */
1087                 if (!domain->name && data->chip)
1088                         domain->name = data->chip->name;
1089         }
1090
1091         irq_clear_status_flags(virq, IRQ_NOREQUEST);
1092 }
1093
1094 static void irq_domain_remove_irq(int virq)
1095 {
1096         struct irq_data *data;
1097
1098         irq_set_status_flags(virq, IRQ_NOREQUEST);
1099         irq_set_chip_and_handler(virq, NULL, NULL);
1100         synchronize_irq(virq);
1101         smp_mb();
1102
1103         for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
1104                 struct irq_domain *domain = data->domain;
1105                 irq_hw_number_t hwirq = data->hwirq;
1106
1107                 domain->mapcount--;
1108                 irq_domain_clear_mapping(domain, hwirq);
1109         }
1110 }
1111
1112 static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
1113                                                    struct irq_data *child)
1114 {
1115         struct irq_data *irq_data;
1116
1117         irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
1118                                 irq_data_get_node(child));
1119         if (irq_data) {
1120                 child->parent_data = irq_data;
1121                 irq_data->irq = child->irq;
1122                 irq_data->common = child->common;
1123                 irq_data->domain = domain;
1124         }
1125
1126         return irq_data;
1127 }
1128
1129 static void __irq_domain_free_hierarchy(struct irq_data *irq_data)
1130 {
1131         struct irq_data *tmp;
1132
1133         while (irq_data) {
1134                 tmp = irq_data;
1135                 irq_data = irq_data->parent_data;
1136                 kfree(tmp);
1137         }
1138 }
1139
1140 static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
1141 {
1142         struct irq_data *irq_data, *tmp;
1143         int i;
1144
1145         for (i = 0; i < nr_irqs; i++) {
1146                 irq_data = irq_get_irq_data(virq + i);
1147                 tmp = irq_data->parent_data;
1148                 irq_data->parent_data = NULL;
1149                 irq_data->domain = NULL;
1150
1151                 __irq_domain_free_hierarchy(tmp);
1152         }
1153 }
1154
1155 /**
1156  * irq_domain_disconnect_hierarchy - Mark the first unused level of a hierarchy
1157  * @domain:     IRQ domain from which the hierarchy is to be disconnected
1158  * @virq:       IRQ number where the hierarchy is to be trimmed
1159  *
1160  * Marks the @virq level belonging to @domain as disconnected.
1161  * Returns -EINVAL if @virq doesn't have a valid irq_data pointing
1162  * to @domain.
1163  *
1164  * Its only use is to be able to trim levels of hierarchy that do not
1165  * have any real meaning for this interrupt, and that the driver marks
1166  * as such from its .alloc() callback.
1167  */
1168 int irq_domain_disconnect_hierarchy(struct irq_domain *domain,
1169                                     unsigned int virq)
1170 {
1171         struct irq_data *irqd;
1172
1173         irqd = irq_domain_get_irq_data(domain, virq);
1174         if (!irqd)
1175                 return -EINVAL;
1176
1177         irqd->chip = ERR_PTR(-ENOTCONN);
1178         return 0;
1179 }
1180
1181 static int irq_domain_trim_hierarchy(unsigned int virq)
1182 {
1183         struct irq_data *tail, *irqd, *irq_data;
1184
1185         irq_data = irq_get_irq_data(virq);
1186         tail = NULL;
1187
1188         /* The first entry must have a valid irqchip */
1189         if (!irq_data->chip || IS_ERR(irq_data->chip))
1190                 return -EINVAL;
1191
1192         /*
1193          * Validate that the irq_data chain is sane in the presence of
1194          * a hierarchy trimming marker.
1195          */
1196         for (irqd = irq_data->parent_data; irqd; irq_data = irqd, irqd = irqd->parent_data) {
1197                 /* Can't have a valid irqchip after a trim marker */
1198                 if (irqd->chip && tail)
1199                         return -EINVAL;
1200
1201                 /* Can't have an empty irqchip before a trim marker */
1202                 if (!irqd->chip && !tail)
1203                         return -EINVAL;
1204
1205                 if (IS_ERR(irqd->chip)) {
1206                         /* Only -ENOTCONN is a valid trim marker */
1207                         if (PTR_ERR(irqd->chip) != -ENOTCONN)
1208                                 return -EINVAL;
1209
1210                         tail = irq_data;
1211                 }
1212         }
1213
1214         /* No trim marker, nothing to do */
1215         if (!tail)
1216                 return 0;
1217
1218         pr_info("IRQ%d: trimming hierarchy from %s\n",
1219                 virq, tail->parent_data->domain->name);
1220
1221         /* Sever the inner part of the hierarchy...  */
1222         irqd = tail;
1223         tail = tail->parent_data;
1224         irqd->parent_data = NULL;
1225         __irq_domain_free_hierarchy(tail);
1226
1227         return 0;
1228 }
1229
1230 static int irq_domain_alloc_irq_data(struct irq_domain *domain,
1231                                      unsigned int virq, unsigned int nr_irqs)
1232 {
1233         struct irq_data *irq_data;
1234         struct irq_domain *parent;
1235         int i;
1236
1237         /* The outermost irq_data is embedded in struct irq_desc */
1238         for (i = 0; i < nr_irqs; i++) {
1239                 irq_data = irq_get_irq_data(virq + i);
1240                 irq_data->domain = domain;
1241
1242                 for (parent = domain->parent; parent; parent = parent->parent) {
1243                         irq_data = irq_domain_insert_irq_data(parent, irq_data);
1244                         if (!irq_data) {
1245                                 irq_domain_free_irq_data(virq, i + 1);
1246                                 return -ENOMEM;
1247                         }
1248                 }
1249         }
1250
1251         return 0;
1252 }
1253
1254 /**
1255  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1256  * @domain:     domain to match
1257  * @virq:       IRQ number to get irq_data
1258  */
1259 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1260                                          unsigned int virq)
1261 {
1262         struct irq_data *irq_data;
1263
1264         for (irq_data = irq_get_irq_data(virq); irq_data;
1265              irq_data = irq_data->parent_data)
1266                 if (irq_data->domain == domain)
1267                         return irq_data;
1268
1269         return NULL;
1270 }
1271 EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1272
1273 /**
1274  * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1275  * @domain:     Interrupt domain to match
1276  * @virq:       IRQ number
1277  * @hwirq:      The hwirq number
1278  * @chip:       The associated interrupt chip
1279  * @chip_data:  The associated chip data
1280  */
1281 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1282                                   irq_hw_number_t hwirq, struct irq_chip *chip,
1283                                   void *chip_data)
1284 {
1285         struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1286
1287         if (!irq_data)
1288                 return -ENOENT;
1289
1290         irq_data->hwirq = hwirq;
1291         irq_data->chip = chip ? chip : &no_irq_chip;
1292         irq_data->chip_data = chip_data;
1293
1294         return 0;
1295 }
1296 EXPORT_SYMBOL_GPL(irq_domain_set_hwirq_and_chip);
1297
1298 /**
1299  * irq_domain_set_info - Set the complete data for a @virq in @domain
1300  * @domain:             Interrupt domain to match
1301  * @virq:               IRQ number
1302  * @hwirq:              The hardware interrupt number
1303  * @chip:               The associated interrupt chip
1304  * @chip_data:          The associated interrupt chip data
1305  * @handler:            The interrupt flow handler
1306  * @handler_data:       The interrupt flow handler data
1307  * @handler_name:       The interrupt handler name
1308  */
1309 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1310                          irq_hw_number_t hwirq, struct irq_chip *chip,
1311                          void *chip_data, irq_flow_handler_t handler,
1312                          void *handler_data, const char *handler_name)
1313 {
1314         irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1315         __irq_set_handler(virq, handler, 0, handler_name);
1316         irq_set_handler_data(virq, handler_data);
1317 }
1318 EXPORT_SYMBOL(irq_domain_set_info);
1319
1320 /**
1321  * irq_domain_free_irqs_common - Clear irq_data and free the parent
1322  * @domain:     Interrupt domain to match
1323  * @virq:       IRQ number to start with
1324  * @nr_irqs:    The number of irqs to free
1325  */
1326 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1327                                  unsigned int nr_irqs)
1328 {
1329         struct irq_data *irq_data;
1330         int i;
1331
1332         for (i = 0; i < nr_irqs; i++) {
1333                 irq_data = irq_domain_get_irq_data(domain, virq + i);
1334                 if (irq_data)
1335                         irq_domain_reset_irq_data(irq_data);
1336         }
1337         irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1338 }
1339 EXPORT_SYMBOL_GPL(irq_domain_free_irqs_common);
1340
1341 /**
1342  * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1343  * @domain:     Interrupt domain to match
1344  * @virq:       IRQ number to start with
1345  * @nr_irqs:    The number of irqs to free
1346  */
1347 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1348                               unsigned int nr_irqs)
1349 {
1350         int i;
1351
1352         for (i = 0; i < nr_irqs; i++) {
1353                 irq_set_handler_data(virq + i, NULL);
1354                 irq_set_handler(virq + i, NULL);
1355         }
1356         irq_domain_free_irqs_common(domain, virq, nr_irqs);
1357 }
1358
1359 static void irq_domain_free_irqs_hierarchy(struct irq_domain *domain,
1360                                            unsigned int irq_base,
1361                                            unsigned int nr_irqs)
1362 {
1363         unsigned int i;
1364
1365         if (!domain->ops->free)
1366                 return;
1367
1368         for (i = 0; i < nr_irqs; i++) {
1369                 if (irq_domain_get_irq_data(domain, irq_base + i))
1370                         domain->ops->free(domain, irq_base + i, 1);
1371         }
1372 }
1373
1374 int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
1375                                     unsigned int irq_base,
1376                                     unsigned int nr_irqs, void *arg)
1377 {
1378         if (!domain->ops->alloc) {
1379                 pr_debug("domain->ops->alloc() is NULL\n");
1380                 return -ENOSYS;
1381         }
1382
1383         return domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1384 }
1385
1386 /**
1387  * __irq_domain_alloc_irqs - Allocate IRQs from domain
1388  * @domain:     domain to allocate from
1389  * @irq_base:   allocate specified IRQ number if irq_base >= 0
1390  * @nr_irqs:    number of IRQs to allocate
1391  * @node:       NUMA node id for memory allocation
1392  * @arg:        domain specific argument
1393  * @realloc:    IRQ descriptors have already been allocated if true
1394  * @affinity:   Optional irq affinity mask for multiqueue devices
1395  *
1396  * Allocate IRQ numbers and initialized all data structures to support
1397  * hierarchy IRQ domains.
1398  * Parameter @realloc is mainly to support legacy IRQs.
1399  * Returns error code or allocated IRQ number
1400  *
1401  * The whole process to setup an IRQ has been split into two steps.
1402  * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1403  * descriptor and required hardware resources. The second step,
1404  * irq_domain_activate_irq(), is to program the hardware with preallocated
1405  * resources. In this way, it's easier to rollback when failing to
1406  * allocate resources.
1407  */
1408 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1409                             unsigned int nr_irqs, int node, void *arg,
1410                             bool realloc, const struct irq_affinity_desc *affinity)
1411 {
1412         int i, ret, virq;
1413
1414         if (domain == NULL) {
1415                 domain = irq_default_domain;
1416                 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1417                         return -EINVAL;
1418         }
1419
1420         if (realloc && irq_base >= 0) {
1421                 virq = irq_base;
1422         } else {
1423                 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node,
1424                                               affinity);
1425                 if (virq < 0) {
1426                         pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1427                                  irq_base, nr_irqs);
1428                         return virq;
1429                 }
1430         }
1431
1432         if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1433                 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1434                 ret = -ENOMEM;
1435                 goto out_free_desc;
1436         }
1437
1438         mutex_lock(&irq_domain_mutex);
1439         ret = irq_domain_alloc_irqs_hierarchy(domain, virq, nr_irqs, arg);
1440         if (ret < 0) {
1441                 mutex_unlock(&irq_domain_mutex);
1442                 goto out_free_irq_data;
1443         }
1444
1445         for (i = 0; i < nr_irqs; i++) {
1446                 ret = irq_domain_trim_hierarchy(virq + i);
1447                 if (ret) {
1448                         mutex_unlock(&irq_domain_mutex);
1449                         goto out_free_irq_data;
1450                 }
1451         }
1452
1453         for (i = 0; i < nr_irqs; i++)
1454                 irq_domain_insert_irq(virq + i);
1455         mutex_unlock(&irq_domain_mutex);
1456
1457         return virq;
1458
1459 out_free_irq_data:
1460         irq_domain_free_irq_data(virq, nr_irqs);
1461 out_free_desc:
1462         irq_free_descs(virq, nr_irqs);
1463         return ret;
1464 }
1465
1466 /* The irq_data was moved, fix the revmap to refer to the new location */
1467 static void irq_domain_fix_revmap(struct irq_data *d)
1468 {
1469         void __rcu **slot;
1470
1471         if (d->hwirq < d->domain->revmap_size)
1472                 return; /* Not using radix tree. */
1473
1474         /* Fix up the revmap. */
1475         mutex_lock(&d->domain->revmap_tree_mutex);
1476         slot = radix_tree_lookup_slot(&d->domain->revmap_tree, d->hwirq);
1477         if (slot)
1478                 radix_tree_replace_slot(&d->domain->revmap_tree, slot, d);
1479         mutex_unlock(&d->domain->revmap_tree_mutex);
1480 }
1481
1482 /**
1483  * irq_domain_push_irq() - Push a domain in to the top of a hierarchy.
1484  * @domain:     Domain to push.
1485  * @virq:       Irq to push the domain in to.
1486  * @arg:        Passed to the irq_domain_ops alloc() function.
1487  *
1488  * For an already existing irqdomain hierarchy, as might be obtained
1489  * via a call to pci_enable_msix(), add an additional domain to the
1490  * head of the processing chain.  Must be called before request_irq()
1491  * has been called.
1492  */
1493 int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg)
1494 {
1495         struct irq_data *child_irq_data;
1496         struct irq_data *root_irq_data = irq_get_irq_data(virq);
1497         struct irq_desc *desc;
1498         int rv = 0;
1499
1500         /*
1501          * Check that no action has been set, which indicates the virq
1502          * is in a state where this function doesn't have to deal with
1503          * races between interrupt handling and maintaining the
1504          * hierarchy.  This will catch gross misuse.  Attempting to
1505          * make the check race free would require holding locks across
1506          * calls to struct irq_domain_ops->alloc(), which could lead
1507          * to deadlock, so we just do a simple check before starting.
1508          */
1509         desc = irq_to_desc(virq);
1510         if (!desc)
1511                 return -EINVAL;
1512         if (WARN_ON(desc->action))
1513                 return -EBUSY;
1514
1515         if (domain == NULL)
1516                 return -EINVAL;
1517
1518         if (WARN_ON(!irq_domain_is_hierarchy(domain)))
1519                 return -EINVAL;
1520
1521         if (!root_irq_data)
1522                 return -EINVAL;
1523
1524         if (domain->parent != root_irq_data->domain)
1525                 return -EINVAL;
1526
1527         child_irq_data = kzalloc_node(sizeof(*child_irq_data), GFP_KERNEL,
1528                                       irq_data_get_node(root_irq_data));
1529         if (!child_irq_data)
1530                 return -ENOMEM;
1531
1532         mutex_lock(&irq_domain_mutex);
1533
1534         /* Copy the original irq_data. */
1535         *child_irq_data = *root_irq_data;
1536
1537         /*
1538          * Overwrite the root_irq_data, which is embedded in struct
1539          * irq_desc, with values for this domain.
1540          */
1541         root_irq_data->parent_data = child_irq_data;
1542         root_irq_data->domain = domain;
1543         root_irq_data->mask = 0;
1544         root_irq_data->hwirq = 0;
1545         root_irq_data->chip = NULL;
1546         root_irq_data->chip_data = NULL;
1547
1548         /* May (probably does) set hwirq, chip, etc. */
1549         rv = irq_domain_alloc_irqs_hierarchy(domain, virq, 1, arg);
1550         if (rv) {
1551                 /* Restore the original irq_data. */
1552                 *root_irq_data = *child_irq_data;
1553                 kfree(child_irq_data);
1554                 goto error;
1555         }
1556
1557         irq_domain_fix_revmap(child_irq_data);
1558         irq_domain_set_mapping(domain, root_irq_data->hwirq, root_irq_data);
1559
1560 error:
1561         mutex_unlock(&irq_domain_mutex);
1562
1563         return rv;
1564 }
1565 EXPORT_SYMBOL_GPL(irq_domain_push_irq);
1566
1567 /**
1568  * irq_domain_pop_irq() - Remove a domain from the top of a hierarchy.
1569  * @domain:     Domain to remove.
1570  * @virq:       Irq to remove the domain from.
1571  *
1572  * Undo the effects of a call to irq_domain_push_irq().  Must be
1573  * called either before request_irq() or after free_irq().
1574  */
1575 int irq_domain_pop_irq(struct irq_domain *domain, int virq)
1576 {
1577         struct irq_data *root_irq_data = irq_get_irq_data(virq);
1578         struct irq_data *child_irq_data;
1579         struct irq_data *tmp_irq_data;
1580         struct irq_desc *desc;
1581
1582         /*
1583          * Check that no action is set, which indicates the virq is in
1584          * a state where this function doesn't have to deal with races
1585          * between interrupt handling and maintaining the hierarchy.
1586          * This will catch gross misuse.  Attempting to make the check
1587          * race free would require holding locks across calls to
1588          * struct irq_domain_ops->free(), which could lead to
1589          * deadlock, so we just do a simple check before starting.
1590          */
1591         desc = irq_to_desc(virq);
1592         if (!desc)
1593                 return -EINVAL;
1594         if (WARN_ON(desc->action))
1595                 return -EBUSY;
1596
1597         if (domain == NULL)
1598                 return -EINVAL;
1599
1600         if (!root_irq_data)
1601                 return -EINVAL;
1602
1603         tmp_irq_data = irq_domain_get_irq_data(domain, virq);
1604
1605         /* We can only "pop" if this domain is at the top of the list */
1606         if (WARN_ON(root_irq_data != tmp_irq_data))
1607                 return -EINVAL;
1608
1609         if (WARN_ON(root_irq_data->domain != domain))
1610                 return -EINVAL;
1611
1612         child_irq_data = root_irq_data->parent_data;
1613         if (WARN_ON(!child_irq_data))
1614                 return -EINVAL;
1615
1616         mutex_lock(&irq_domain_mutex);
1617
1618         root_irq_data->parent_data = NULL;
1619
1620         irq_domain_clear_mapping(domain, root_irq_data->hwirq);
1621         irq_domain_free_irqs_hierarchy(domain, virq, 1);
1622
1623         /* Restore the original irq_data. */
1624         *root_irq_data = *child_irq_data;
1625
1626         irq_domain_fix_revmap(root_irq_data);
1627
1628         mutex_unlock(&irq_domain_mutex);
1629
1630         kfree(child_irq_data);
1631
1632         return 0;
1633 }
1634 EXPORT_SYMBOL_GPL(irq_domain_pop_irq);
1635
1636 /**
1637  * irq_domain_free_irqs - Free IRQ number and associated data structures
1638  * @virq:       base IRQ number
1639  * @nr_irqs:    number of IRQs to free
1640  */
1641 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1642 {
1643         struct irq_data *data = irq_get_irq_data(virq);
1644         int i;
1645
1646         if (WARN(!data || !data->domain || !data->domain->ops->free,
1647                  "NULL pointer, cannot free irq\n"))
1648                 return;
1649
1650         mutex_lock(&irq_domain_mutex);
1651         for (i = 0; i < nr_irqs; i++)
1652                 irq_domain_remove_irq(virq + i);
1653         irq_domain_free_irqs_hierarchy(data->domain, virq, nr_irqs);
1654         mutex_unlock(&irq_domain_mutex);
1655
1656         irq_domain_free_irq_data(virq, nr_irqs);
1657         irq_free_descs(virq, nr_irqs);
1658 }
1659
1660 /**
1661  * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1662  * @domain:     Domain below which interrupts must be allocated
1663  * @irq_base:   Base IRQ number
1664  * @nr_irqs:    Number of IRQs to allocate
1665  * @arg:        Allocation data (arch/domain specific)
1666  */
1667 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1668                                  unsigned int irq_base, unsigned int nr_irqs,
1669                                  void *arg)
1670 {
1671         if (!domain->parent)
1672                 return -ENOSYS;
1673
1674         return irq_domain_alloc_irqs_hierarchy(domain->parent, irq_base,
1675                                                nr_irqs, arg);
1676 }
1677 EXPORT_SYMBOL_GPL(irq_domain_alloc_irqs_parent);
1678
1679 /**
1680  * irq_domain_free_irqs_parent - Free interrupts from parent domain
1681  * @domain:     Domain below which interrupts must be freed
1682  * @irq_base:   Base IRQ number
1683  * @nr_irqs:    Number of IRQs to free
1684  */
1685 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1686                                  unsigned int irq_base, unsigned int nr_irqs)
1687 {
1688         if (!domain->parent)
1689                 return;
1690
1691         irq_domain_free_irqs_hierarchy(domain->parent, irq_base, nr_irqs);
1692 }
1693 EXPORT_SYMBOL_GPL(irq_domain_free_irqs_parent);
1694
1695 static void __irq_domain_deactivate_irq(struct irq_data *irq_data)
1696 {
1697         if (irq_data && irq_data->domain) {
1698                 struct irq_domain *domain = irq_data->domain;
1699
1700                 if (domain->ops->deactivate)
1701                         domain->ops->deactivate(domain, irq_data);
1702                 if (irq_data->parent_data)
1703                         __irq_domain_deactivate_irq(irq_data->parent_data);
1704         }
1705 }
1706
1707 static int __irq_domain_activate_irq(struct irq_data *irqd, bool reserve)
1708 {
1709         int ret = 0;
1710
1711         if (irqd && irqd->domain) {
1712                 struct irq_domain *domain = irqd->domain;
1713
1714                 if (irqd->parent_data)
1715                         ret = __irq_domain_activate_irq(irqd->parent_data,
1716                                                         reserve);
1717                 if (!ret && domain->ops->activate) {
1718                         ret = domain->ops->activate(domain, irqd, reserve);
1719                         /* Rollback in case of error */
1720                         if (ret && irqd->parent_data)
1721                                 __irq_domain_deactivate_irq(irqd->parent_data);
1722                 }
1723         }
1724         return ret;
1725 }
1726
1727 /**
1728  * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1729  *                           interrupt
1730  * @irq_data:   Outermost irq_data associated with interrupt
1731  * @reserve:    If set only reserve an interrupt vector instead of assigning one
1732  *
1733  * This is the second step to call domain_ops->activate to program interrupt
1734  * controllers, so the interrupt could actually get delivered.
1735  */
1736 int irq_domain_activate_irq(struct irq_data *irq_data, bool reserve)
1737 {
1738         int ret = 0;
1739
1740         if (!irqd_is_activated(irq_data))
1741                 ret = __irq_domain_activate_irq(irq_data, reserve);
1742         if (!ret)
1743                 irqd_set_activated(irq_data);
1744         return ret;
1745 }
1746
1747 /**
1748  * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1749  *                             deactivate interrupt
1750  * @irq_data: outermost irq_data associated with interrupt
1751  *
1752  * It calls domain_ops->deactivate to program interrupt controllers to disable
1753  * interrupt delivery.
1754  */
1755 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1756 {
1757         if (irqd_is_activated(irq_data)) {
1758                 __irq_domain_deactivate_irq(irq_data);
1759                 irqd_clr_activated(irq_data);
1760         }
1761 }
1762
1763 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1764 {
1765         /* Hierarchy irq_domains must implement callback alloc() */
1766         if (domain->ops->alloc)
1767                 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1768 }
1769
1770 /**
1771  * irq_domain_hierarchical_is_msi_remap - Check if the domain or any
1772  * parent has MSI remapping support
1773  * @domain: domain pointer
1774  */
1775 bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
1776 {
1777         for (; domain; domain = domain->parent) {
1778                 if (irq_domain_is_msi_remap(domain))
1779                         return true;
1780         }
1781         return false;
1782 }
1783 #else   /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1784 /**
1785  * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1786  * @domain:     domain to match
1787  * @virq:       IRQ number to get irq_data
1788  */
1789 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1790                                          unsigned int virq)
1791 {
1792         struct irq_data *irq_data = irq_get_irq_data(virq);
1793
1794         return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1795 }
1796 EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1797
1798 /**
1799  * irq_domain_set_info - Set the complete data for a @virq in @domain
1800  * @domain:             Interrupt domain to match
1801  * @virq:               IRQ number
1802  * @hwirq:              The hardware interrupt number
1803  * @chip:               The associated interrupt chip
1804  * @chip_data:          The associated interrupt chip data
1805  * @handler:            The interrupt flow handler
1806  * @handler_data:       The interrupt flow handler data
1807  * @handler_name:       The interrupt handler name
1808  */
1809 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1810                          irq_hw_number_t hwirq, struct irq_chip *chip,
1811                          void *chip_data, irq_flow_handler_t handler,
1812                          void *handler_data, const char *handler_name)
1813 {
1814         irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1815         irq_set_chip_data(virq, chip_data);
1816         irq_set_handler_data(virq, handler_data);
1817 }
1818
1819 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1820 {
1821 }
1822 #endif  /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1823
1824 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
1825 static struct dentry *domain_dir;
1826
1827 static void
1828 irq_domain_debug_show_one(struct seq_file *m, struct irq_domain *d, int ind)
1829 {
1830         seq_printf(m, "%*sname:   %s\n", ind, "", d->name);
1831         seq_printf(m, "%*ssize:   %u\n", ind + 1, "",
1832                    d->revmap_size + d->revmap_direct_max_irq);
1833         seq_printf(m, "%*smapped: %u\n", ind + 1, "", d->mapcount);
1834         seq_printf(m, "%*sflags:  0x%08x\n", ind +1 , "", d->flags);
1835         if (d->ops && d->ops->debug_show)
1836                 d->ops->debug_show(m, d, NULL, ind + 1);
1837 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
1838         if (!d->parent)
1839                 return;
1840         seq_printf(m, "%*sparent: %s\n", ind + 1, "", d->parent->name);
1841         irq_domain_debug_show_one(m, d->parent, ind + 4);
1842 #endif
1843 }
1844
1845 static int irq_domain_debug_show(struct seq_file *m, void *p)
1846 {
1847         struct irq_domain *d = m->private;
1848
1849         /* Default domain? Might be NULL */
1850         if (!d) {
1851                 if (!irq_default_domain)
1852                         return 0;
1853                 d = irq_default_domain;
1854         }
1855         irq_domain_debug_show_one(m, d, 0);
1856         return 0;
1857 }
1858 DEFINE_SHOW_ATTRIBUTE(irq_domain_debug);
1859
1860 static void debugfs_add_domain_dir(struct irq_domain *d)
1861 {
1862         if (!d->name || !domain_dir)
1863                 return;
1864         debugfs_create_file(d->name, 0444, domain_dir, d,
1865                             &irq_domain_debug_fops);
1866 }
1867
1868 static void debugfs_remove_domain_dir(struct irq_domain *d)
1869 {
1870         debugfs_remove(debugfs_lookup(d->name, domain_dir));
1871 }
1872
1873 void __init irq_domain_debugfs_init(struct dentry *root)
1874 {
1875         struct irq_domain *d;
1876
1877         domain_dir = debugfs_create_dir("domains", root);
1878
1879         debugfs_create_file("default", 0444, domain_dir, NULL,
1880                             &irq_domain_debug_fops);
1881         mutex_lock(&irq_domain_mutex);
1882         list_for_each_entry(d, &irq_domain_list, link)
1883                 debugfs_add_domain_dir(d);
1884         mutex_unlock(&irq_domain_mutex);
1885 }
1886 #endif