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