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