kernel/irq/irqdomain.c

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