1 #define pr_fmt(fmt) "irq: " fmt
3 #include <linux/debugfs.h>
4 #include <linux/hardirq.h>
5 #include <linux/interrupt.h>
7 #include <linux/irqdesc.h>
8 #include <linux/irqdomain.h>
9 #include <linux/module.h>
10 #include <linux/mutex.h>
12 #include <linux/of_address.h>
13 #include <linux/of_irq.h>
14 #include <linux/topology.h>
15 #include <linux/seq_file.h>
16 #include <linux/slab.h>
17 #include <linux/smp.h>
20 static LIST_HEAD(irq_domain_list);
21 static DEFINE_MUTEX(irq_domain_mutex);
23 static DEFINE_MUTEX(revmap_trees_mutex);
24 static struct irq_domain *irq_default_domain;
26 static int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
27 irq_hw_number_t hwirq, int node);
28 static void irq_domain_check_hierarchy(struct irq_domain *domain);
31 * __irq_domain_add() - Allocate a new irq_domain data structure
32 * @of_node: optional device-tree node of the interrupt controller
33 * @size: Size of linear map; 0 for radix mapping only
34 * @hwirq_max: Maximum number of interrupts supported by controller
35 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
37 * @ops: domain callbacks
38 * @host_data: Controller private data pointer
40 * Allocates and initialize and irq_domain structure.
41 * Returns pointer to IRQ domain, or NULL on failure.
43 struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
44 irq_hw_number_t hwirq_max, int direct_max,
45 const struct irq_domain_ops *ops,
48 struct irq_domain *domain;
49 struct fwnode_handle *fwnode;
51 domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
52 GFP_KERNEL, of_node_to_nid(of_node));
57 fwnode = of_node ? &of_node->fwnode : NULL;
60 INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
62 domain->host_data = host_data;
63 domain->fwnode = fwnode;
64 domain->hwirq_max = hwirq_max;
65 domain->revmap_size = size;
66 domain->revmap_direct_max_irq = direct_max;
67 irq_domain_check_hierarchy(domain);
69 mutex_lock(&irq_domain_mutex);
70 list_add(&domain->link, &irq_domain_list);
71 mutex_unlock(&irq_domain_mutex);
73 pr_debug("Added domain %s\n", domain->name);
76 EXPORT_SYMBOL_GPL(__irq_domain_add);
79 * irq_domain_remove() - Remove an irq domain.
80 * @domain: domain to remove
82 * This routine is used to remove an irq domain. The caller must ensure
83 * that all mappings within the domain have been disposed of prior to
84 * use, depending on the revmap type.
86 void irq_domain_remove(struct irq_domain *domain)
88 mutex_lock(&irq_domain_mutex);
91 * radix_tree_delete() takes care of destroying the root
92 * node when all entries are removed. Shout if there are
95 WARN_ON(domain->revmap_tree.height);
97 list_del(&domain->link);
100 * If the going away domain is the default one, reset it.
102 if (unlikely(irq_default_domain == domain))
103 irq_set_default_host(NULL);
105 mutex_unlock(&irq_domain_mutex);
107 pr_debug("Removed domain %s\n", domain->name);
109 of_node_put(irq_domain_get_of_node(domain));
112 EXPORT_SYMBOL_GPL(irq_domain_remove);
115 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
116 * @of_node: pointer to interrupt controller's device tree node.
117 * @size: total number of irqs in mapping
118 * @first_irq: first number of irq block assigned to the domain,
119 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
120 * pre-map all of the irqs in the domain to virqs starting at first_irq.
121 * @ops: domain callbacks
122 * @host_data: Controller private data pointer
124 * Allocates an irq_domain, and optionally if first_irq is positive then also
125 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
127 * This is intended to implement the expected behaviour for most
128 * interrupt controllers. If device tree is used, then first_irq will be 0 and
129 * irqs get mapped dynamically on the fly. However, if the controller requires
130 * static virq assignments (non-DT boot) then it will set that up correctly.
132 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
134 unsigned int first_irq,
135 const struct irq_domain_ops *ops,
138 struct irq_domain *domain;
140 domain = __irq_domain_add(of_node, size, size, 0, ops, host_data);
145 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
146 /* attempt to allocated irq_descs */
147 int rc = irq_alloc_descs(first_irq, first_irq, size,
148 of_node_to_nid(of_node));
150 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
153 irq_domain_associate_many(domain, first_irq, 0, size);
158 EXPORT_SYMBOL_GPL(irq_domain_add_simple);
161 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
162 * @of_node: pointer to interrupt controller's device tree node.
163 * @size: total number of irqs in legacy mapping
164 * @first_irq: first number of irq block assigned to the domain
165 * @first_hwirq: first hwirq number to use for the translation. Should normally
166 * be '0', but a positive integer can be used if the effective
167 * hwirqs numbering does not begin at zero.
168 * @ops: map/unmap domain callbacks
169 * @host_data: Controller private data pointer
171 * Note: the map() callback will be called before this function returns
172 * for all legacy interrupts except 0 (which is always the invalid irq for
173 * a legacy controller).
175 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
177 unsigned int first_irq,
178 irq_hw_number_t first_hwirq,
179 const struct irq_domain_ops *ops,
182 struct irq_domain *domain;
184 domain = __irq_domain_add(of_node, first_hwirq + size,
185 first_hwirq + size, 0, ops, host_data);
187 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
191 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
194 * irq_find_matching_fwnode() - Locates a domain for a given fwnode
195 * @fwnode: FW descriptor of the interrupt controller
196 * @bus_token: domain-specific data
198 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
199 enum irq_domain_bus_token bus_token)
201 struct irq_domain *h, *found = NULL;
204 /* We might want to match the legacy controller last since
205 * it might potentially be set to match all interrupts in
206 * the absence of a device node. This isn't a problem so far
209 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
210 * values must generate an exact match for the domain to be
213 mutex_lock(&irq_domain_mutex);
214 list_for_each_entry(h, &irq_domain_list, link) {
216 rc = h->ops->match(h, to_of_node(fwnode), bus_token);
218 rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
219 ((bus_token == DOMAIN_BUS_ANY) ||
220 (h->bus_token == bus_token)));
227 mutex_unlock(&irq_domain_mutex);
230 EXPORT_SYMBOL_GPL(irq_find_matching_fwnode);
233 * irq_set_default_host() - Set a "default" irq domain
234 * @domain: default domain pointer
236 * For convenience, it's possible to set a "default" domain that will be used
237 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
238 * platforms that want to manipulate a few hard coded interrupt numbers that
239 * aren't properly represented in the device-tree.
241 void irq_set_default_host(struct irq_domain *domain)
243 pr_debug("Default domain set to @0x%p\n", domain);
245 irq_default_domain = domain;
247 EXPORT_SYMBOL_GPL(irq_set_default_host);
249 void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
251 struct irq_data *irq_data = irq_get_irq_data(irq);
252 irq_hw_number_t hwirq;
254 if (WARN(!irq_data || irq_data->domain != domain,
255 "virq%i doesn't exist; cannot disassociate\n", irq))
258 hwirq = irq_data->hwirq;
259 irq_set_status_flags(irq, IRQ_NOREQUEST);
261 /* remove chip and handler */
262 irq_set_chip_and_handler(irq, NULL, NULL);
264 /* Make sure it's completed */
265 synchronize_irq(irq);
267 /* Tell the PIC about it */
268 if (domain->ops->unmap)
269 domain->ops->unmap(domain, irq);
272 irq_data->domain = NULL;
275 /* Clear reverse map for this hwirq */
276 if (hwirq < domain->revmap_size) {
277 domain->linear_revmap[hwirq] = 0;
279 mutex_lock(&revmap_trees_mutex);
280 radix_tree_delete(&domain->revmap_tree, hwirq);
281 mutex_unlock(&revmap_trees_mutex);
285 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
286 irq_hw_number_t hwirq)
288 struct irq_data *irq_data = irq_get_irq_data(virq);
291 if (WARN(hwirq >= domain->hwirq_max,
292 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
294 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
296 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
299 mutex_lock(&irq_domain_mutex);
300 irq_data->hwirq = hwirq;
301 irq_data->domain = domain;
302 if (domain->ops->map) {
303 ret = domain->ops->map(domain, virq, hwirq);
306 * If map() returns -EPERM, this interrupt is protected
307 * by the firmware or some other service and shall not
308 * be mapped. Don't bother telling the user about it.
311 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
312 domain->name, hwirq, virq, ret);
314 irq_data->domain = NULL;
316 mutex_unlock(&irq_domain_mutex);
320 /* If not already assigned, give the domain the chip's name */
321 if (!domain->name && irq_data->chip)
322 domain->name = irq_data->chip->name;
325 if (hwirq < domain->revmap_size) {
326 domain->linear_revmap[hwirq] = virq;
328 mutex_lock(&revmap_trees_mutex);
329 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
330 mutex_unlock(&revmap_trees_mutex);
332 mutex_unlock(&irq_domain_mutex);
334 irq_clear_status_flags(virq, IRQ_NOREQUEST);
338 EXPORT_SYMBOL_GPL(irq_domain_associate);
340 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
341 irq_hw_number_t hwirq_base, int count)
343 struct device_node *of_node;
346 of_node = irq_domain_get_of_node(domain);
347 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
348 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
350 for (i = 0; i < count; i++) {
351 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
354 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
357 * irq_create_direct_mapping() - Allocate an irq for direct mapping
358 * @domain: domain to allocate the irq for or NULL for default domain
360 * This routine is used for irq controllers which can choose the hardware
361 * interrupt numbers they generate. In such a case it's simplest to use
362 * the linux irq as the hardware interrupt number. It still uses the linear
363 * or radix tree to store the mapping, but the irq controller can optimize
364 * the revmap path by using the hwirq directly.
366 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
368 struct device_node *of_node;
372 domain = irq_default_domain;
374 of_node = irq_domain_get_of_node(domain);
375 virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
377 pr_debug("create_direct virq allocation failed\n");
380 if (virq >= domain->revmap_direct_max_irq) {
381 pr_err("ERROR: no free irqs available below %i maximum\n",
382 domain->revmap_direct_max_irq);
386 pr_debug("create_direct obtained virq %d\n", virq);
388 if (irq_domain_associate(domain, virq, virq)) {
395 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
398 * irq_create_mapping() - Map a hardware interrupt into linux irq space
399 * @domain: domain owning this hardware interrupt or NULL for default domain
400 * @hwirq: hardware irq number in that domain space
402 * Only one mapping per hardware interrupt is permitted. Returns a linux
404 * If the sense/trigger is to be specified, set_irq_type() should be called
405 * on the number returned from that call.
407 unsigned int irq_create_mapping(struct irq_domain *domain,
408 irq_hw_number_t hwirq)
410 struct device_node *of_node;
413 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
415 /* Look for default domain if nececssary */
417 domain = irq_default_domain;
418 if (domain == NULL) {
419 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
422 pr_debug("-> using domain @%p\n", domain);
424 of_node = irq_domain_get_of_node(domain);
426 /* Check if mapping already exists */
427 virq = irq_find_mapping(domain, hwirq);
429 pr_debug("-> existing mapping on virq %d\n", virq);
433 /* Allocate a virtual interrupt number */
434 virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node));
436 pr_debug("-> virq allocation failed\n");
440 if (irq_domain_associate(domain, virq, hwirq)) {
445 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
446 hwirq, of_node_full_name(of_node), virq);
450 EXPORT_SYMBOL_GPL(irq_create_mapping);
453 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
454 * @domain: domain owning the interrupt range
455 * @irq_base: beginning of linux IRQ range
456 * @hwirq_base: beginning of hardware IRQ range
457 * @count: Number of interrupts to map
459 * This routine is used for allocating and mapping a range of hardware
460 * irqs to linux irqs where the linux irq numbers are at pre-defined
461 * locations. For use by controllers that already have static mappings
462 * to insert in to the domain.
464 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
467 * 0 is returned upon success, while any failure to establish a static
468 * mapping is treated as an error.
470 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
471 irq_hw_number_t hwirq_base, int count)
473 struct device_node *of_node;
476 of_node = irq_domain_get_of_node(domain);
477 ret = irq_alloc_descs(irq_base, irq_base, count,
478 of_node_to_nid(of_node));
479 if (unlikely(ret < 0))
482 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
485 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
487 static int irq_domain_translate(struct irq_domain *d,
488 struct irq_fwspec *fwspec,
489 irq_hw_number_t *hwirq, unsigned int *type)
491 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
492 if (d->ops->translate)
493 return d->ops->translate(d, fwspec, hwirq, type);
496 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
497 fwspec->param, fwspec->param_count,
500 /* If domain has no translation, then we assume interrupt line */
501 *hwirq = fwspec->param[0];
505 static void of_phandle_args_to_fwspec(struct of_phandle_args *irq_data,
506 struct irq_fwspec *fwspec)
510 fwspec->fwnode = irq_data->np ? &irq_data->np->fwnode : NULL;
511 fwspec->param_count = irq_data->args_count;
513 for (i = 0; i < irq_data->args_count; i++)
514 fwspec->param[i] = irq_data->args[i];
517 unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
519 struct irq_domain *domain;
520 irq_hw_number_t hwirq;
521 unsigned int type = IRQ_TYPE_NONE;
525 domain = irq_find_matching_fwnode(fwspec->fwnode, DOMAIN_BUS_ANY);
527 domain = irq_default_domain;
530 pr_warn("no irq domain found for %s !\n",
531 of_node_full_name(to_of_node(fwspec->fwnode)));
535 if (irq_domain_translate(domain, fwspec, &hwirq, &type))
538 if (irq_domain_is_hierarchy(domain)) {
540 * If we've already configured this interrupt,
541 * don't do it again, or hell will break loose.
543 virq = irq_find_mapping(domain, hwirq);
547 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
552 virq = irq_create_mapping(domain, hwirq);
557 /* Set type if specified and different than the current one */
558 if (type != IRQ_TYPE_NONE &&
559 type != irq_get_trigger_type(virq))
560 irq_set_irq_type(virq, type);
563 EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
565 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
567 struct irq_fwspec fwspec;
569 of_phandle_args_to_fwspec(irq_data, &fwspec);
570 return irq_create_fwspec_mapping(&fwspec);
572 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
575 * irq_dispose_mapping() - Unmap an interrupt
576 * @virq: linux irq number of the interrupt to unmap
578 void irq_dispose_mapping(unsigned int virq)
580 struct irq_data *irq_data = irq_get_irq_data(virq);
581 struct irq_domain *domain;
583 if (!virq || !irq_data)
586 domain = irq_data->domain;
587 if (WARN_ON(domain == NULL))
590 irq_domain_disassociate(domain, virq);
593 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
596 * irq_find_mapping() - Find a linux irq from an hw irq number.
597 * @domain: domain owning this hardware interrupt
598 * @hwirq: hardware irq number in that domain space
600 unsigned int irq_find_mapping(struct irq_domain *domain,
601 irq_hw_number_t hwirq)
603 struct irq_data *data;
605 /* Look for default domain if nececssary */
607 domain = irq_default_domain;
611 if (hwirq < domain->revmap_direct_max_irq) {
612 data = irq_domain_get_irq_data(domain, hwirq);
613 if (data && data->hwirq == hwirq)
617 /* Check if the hwirq is in the linear revmap. */
618 if (hwirq < domain->revmap_size)
619 return domain->linear_revmap[hwirq];
622 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
624 return data ? data->irq : 0;
626 EXPORT_SYMBOL_GPL(irq_find_mapping);
628 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
629 static int virq_debug_show(struct seq_file *m, void *private)
632 struct irq_desc *desc;
633 struct irq_domain *domain;
634 struct radix_tree_iter iter;
638 seq_printf(m, " %-16s %-6s %-10s %-10s %s\n",
639 "name", "mapped", "linear-max", "direct-max", "devtree-node");
640 mutex_lock(&irq_domain_mutex);
641 list_for_each_entry(domain, &irq_domain_list, link) {
642 struct device_node *of_node;
644 of_node = irq_domain_get_of_node(domain);
645 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
647 seq_printf(m, "%c%-16s %6u %10u %10u %s\n",
648 domain == irq_default_domain ? '*' : ' ', domain->name,
649 domain->revmap_size + count, domain->revmap_size,
650 domain->revmap_direct_max_irq,
651 of_node ? of_node_full_name(of_node) : "");
653 mutex_unlock(&irq_domain_mutex);
655 seq_printf(m, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
656 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
657 "active", "type", "domain");
659 for (i = 1; i < nr_irqs; i++) {
660 desc = irq_to_desc(i);
664 raw_spin_lock_irqsave(&desc->lock, flags);
665 domain = desc->irq_data.domain;
668 struct irq_chip *chip;
669 int hwirq = desc->irq_data.hwirq;
672 seq_printf(m, "%5d ", i);
673 seq_printf(m, "0x%05x ", hwirq);
675 chip = irq_desc_get_chip(desc);
676 seq_printf(m, "%-15s ", (chip && chip->name) ? chip->name : "none");
678 data = irq_desc_get_chip_data(desc);
679 seq_printf(m, data ? "0x%p " : " %p ", data);
681 seq_printf(m, " %c ", (desc->action && desc->action->handler) ? '*' : ' ');
682 direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
683 seq_printf(m, "%6s%-8s ",
684 (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
685 direct ? "(DIRECT)" : "");
686 seq_printf(m, "%s\n", desc->irq_data.domain->name);
689 raw_spin_unlock_irqrestore(&desc->lock, flags);
695 static int virq_debug_open(struct inode *inode, struct file *file)
697 return single_open(file, virq_debug_show, inode->i_private);
700 static const struct file_operations virq_debug_fops = {
701 .open = virq_debug_open,
704 .release = single_release,
707 static int __init irq_debugfs_init(void)
709 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
710 NULL, &virq_debug_fops) == NULL)
715 __initcall(irq_debugfs_init);
716 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
719 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
721 * Device Tree IRQ specifier translation function which works with one cell
722 * bindings where the cell value maps directly to the hwirq number.
724 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
725 const u32 *intspec, unsigned int intsize,
726 unsigned long *out_hwirq, unsigned int *out_type)
728 if (WARN_ON(intsize < 1))
730 *out_hwirq = intspec[0];
731 *out_type = IRQ_TYPE_NONE;
734 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
737 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
739 * Device Tree IRQ specifier translation function which works with two cell
740 * bindings where the cell values map directly to the hwirq number
741 * and linux irq flags.
743 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
744 const u32 *intspec, unsigned int intsize,
745 irq_hw_number_t *out_hwirq, unsigned int *out_type)
747 if (WARN_ON(intsize < 2))
749 *out_hwirq = intspec[0];
750 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
753 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
756 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
758 * Device Tree IRQ specifier translation function which works with either one
759 * or two cell bindings where the cell values map directly to the hwirq number
760 * and linux irq flags.
762 * Note: don't use this function unless your interrupt controller explicitly
763 * supports both one and two cell bindings. For the majority of controllers
764 * the _onecell() or _twocell() variants above should be used.
766 int irq_domain_xlate_onetwocell(struct irq_domain *d,
767 struct device_node *ctrlr,
768 const u32 *intspec, unsigned int intsize,
769 unsigned long *out_hwirq, unsigned int *out_type)
771 if (WARN_ON(intsize < 1))
773 *out_hwirq = intspec[0];
774 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
777 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
779 const struct irq_domain_ops irq_domain_simple_ops = {
780 .xlate = irq_domain_xlate_onetwocell,
782 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
784 static int irq_domain_alloc_descs(int virq, unsigned int cnt,
785 irq_hw_number_t hwirq, int node)
790 virq = irq_alloc_descs(virq, virq, cnt, node);
792 hint = hwirq % nr_irqs;
795 virq = irq_alloc_descs_from(hint, cnt, node);
796 if (virq <= 0 && hint > 1)
797 virq = irq_alloc_descs_from(1, cnt, node);
803 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
805 * irq_domain_add_hierarchy - Add a irqdomain into the hierarchy
806 * @parent: Parent irq domain to associate with the new domain
807 * @flags: Irq domain flags associated to the domain
808 * @size: Size of the domain. See below
809 * @node: Optional device-tree node of the interrupt controller
810 * @ops: Pointer to the interrupt domain callbacks
811 * @host_data: Controller private data pointer
813 * If @size is 0 a tree domain is created, otherwise a linear domain.
815 * If successful the parent is associated to the new domain and the
816 * domain flags are set.
817 * Returns pointer to IRQ domain, or NULL on failure.
819 struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
822 struct device_node *node,
823 const struct irq_domain_ops *ops,
826 struct irq_domain *domain;
829 domain = irq_domain_add_linear(node, size, ops, host_data);
831 domain = irq_domain_add_tree(node, ops, host_data);
833 domain->parent = parent;
834 domain->flags |= flags;
840 static void irq_domain_insert_irq(int virq)
842 struct irq_data *data;
844 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
845 struct irq_domain *domain = data->domain;
846 irq_hw_number_t hwirq = data->hwirq;
848 if (hwirq < domain->revmap_size) {
849 domain->linear_revmap[hwirq] = virq;
851 mutex_lock(&revmap_trees_mutex);
852 radix_tree_insert(&domain->revmap_tree, hwirq, data);
853 mutex_unlock(&revmap_trees_mutex);
856 /* If not already assigned, give the domain the chip's name */
857 if (!domain->name && data->chip)
858 domain->name = data->chip->name;
861 irq_clear_status_flags(virq, IRQ_NOREQUEST);
864 static void irq_domain_remove_irq(int virq)
866 struct irq_data *data;
868 irq_set_status_flags(virq, IRQ_NOREQUEST);
869 irq_set_chip_and_handler(virq, NULL, NULL);
870 synchronize_irq(virq);
873 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
874 struct irq_domain *domain = data->domain;
875 irq_hw_number_t hwirq = data->hwirq;
877 if (hwirq < domain->revmap_size) {
878 domain->linear_revmap[hwirq] = 0;
880 mutex_lock(&revmap_trees_mutex);
881 radix_tree_delete(&domain->revmap_tree, hwirq);
882 mutex_unlock(&revmap_trees_mutex);
887 static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
888 struct irq_data *child)
890 struct irq_data *irq_data;
892 irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
893 irq_data_get_node(child));
895 child->parent_data = irq_data;
896 irq_data->irq = child->irq;
897 irq_data->common = child->common;
898 irq_data->domain = domain;
904 static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
906 struct irq_data *irq_data, *tmp;
909 for (i = 0; i < nr_irqs; i++) {
910 irq_data = irq_get_irq_data(virq + i);
911 tmp = irq_data->parent_data;
912 irq_data->parent_data = NULL;
913 irq_data->domain = NULL;
917 tmp = tmp->parent_data;
923 static int irq_domain_alloc_irq_data(struct irq_domain *domain,
924 unsigned int virq, unsigned int nr_irqs)
926 struct irq_data *irq_data;
927 struct irq_domain *parent;
930 /* The outermost irq_data is embedded in struct irq_desc */
931 for (i = 0; i < nr_irqs; i++) {
932 irq_data = irq_get_irq_data(virq + i);
933 irq_data->domain = domain;
935 for (parent = domain->parent; parent; parent = parent->parent) {
936 irq_data = irq_domain_insert_irq_data(parent, irq_data);
938 irq_domain_free_irq_data(virq, i + 1);
948 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
949 * @domain: domain to match
950 * @virq: IRQ number to get irq_data
952 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
955 struct irq_data *irq_data;
957 for (irq_data = irq_get_irq_data(virq); irq_data;
958 irq_data = irq_data->parent_data)
959 if (irq_data->domain == domain)
966 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
967 * @domain: Interrupt domain to match
969 * @hwirq: The hwirq number
970 * @chip: The associated interrupt chip
971 * @chip_data: The associated chip data
973 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
974 irq_hw_number_t hwirq, struct irq_chip *chip,
977 struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
982 irq_data->hwirq = hwirq;
983 irq_data->chip = chip ? chip : &no_irq_chip;
984 irq_data->chip_data = chip_data;
990 * irq_domain_set_info - Set the complete data for a @virq in @domain
991 * @domain: Interrupt domain to match
993 * @hwirq: The hardware interrupt number
994 * @chip: The associated interrupt chip
995 * @chip_data: The associated interrupt chip data
996 * @handler: The interrupt flow handler
997 * @handler_data: The interrupt flow handler data
998 * @handler_name: The interrupt handler name
1000 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1001 irq_hw_number_t hwirq, struct irq_chip *chip,
1002 void *chip_data, irq_flow_handler_t handler,
1003 void *handler_data, const char *handler_name)
1005 irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1006 __irq_set_handler(virq, handler, 0, handler_name);
1007 irq_set_handler_data(virq, handler_data);
1011 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1012 * @irq_data: The pointer to irq_data
1014 void irq_domain_reset_irq_data(struct irq_data *irq_data)
1016 irq_data->hwirq = 0;
1017 irq_data->chip = &no_irq_chip;
1018 irq_data->chip_data = NULL;
1022 * irq_domain_free_irqs_common - Clear irq_data and free the parent
1023 * @domain: Interrupt domain to match
1024 * @virq: IRQ number to start with
1025 * @nr_irqs: The number of irqs to free
1027 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1028 unsigned int nr_irqs)
1030 struct irq_data *irq_data;
1033 for (i = 0; i < nr_irqs; i++) {
1034 irq_data = irq_domain_get_irq_data(domain, virq + i);
1036 irq_domain_reset_irq_data(irq_data);
1038 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1042 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1043 * @domain: Interrupt domain to match
1044 * @virq: IRQ number to start with
1045 * @nr_irqs: The number of irqs to free
1047 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1048 unsigned int nr_irqs)
1052 for (i = 0; i < nr_irqs; i++) {
1053 irq_set_handler_data(virq + i, NULL);
1054 irq_set_handler(virq + i, NULL);
1056 irq_domain_free_irqs_common(domain, virq, nr_irqs);
1059 static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1061 return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1064 static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1065 unsigned int irq_base,
1066 unsigned int nr_irqs)
1068 domain->ops->free(domain, irq_base, nr_irqs);
1069 if (irq_domain_is_auto_recursive(domain)) {
1070 BUG_ON(!domain->parent);
1071 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1076 static int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1077 unsigned int irq_base,
1078 unsigned int nr_irqs, void *arg)
1081 struct irq_domain *parent = domain->parent;
1082 bool recursive = irq_domain_is_auto_recursive(domain);
1084 BUG_ON(recursive && !parent);
1086 ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1089 ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1090 if (ret < 0 && recursive)
1091 irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1097 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1098 * @domain: domain to allocate from
1099 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1100 * @nr_irqs: number of IRQs to allocate
1101 * @node: NUMA node id for memory allocation
1102 * @arg: domain specific argument
1103 * @realloc: IRQ descriptors have already been allocated if true
1105 * Allocate IRQ numbers and initialized all data structures to support
1106 * hierarchy IRQ domains.
1107 * Parameter @realloc is mainly to support legacy IRQs.
1108 * Returns error code or allocated IRQ number
1110 * The whole process to setup an IRQ has been split into two steps.
1111 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1112 * descriptor and required hardware resources. The second step,
1113 * irq_domain_activate_irq(), is to program hardwares with preallocated
1114 * resources. In this way, it's easier to rollback when failing to
1115 * allocate resources.
1117 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1118 unsigned int nr_irqs, int node, void *arg,
1123 if (domain == NULL) {
1124 domain = irq_default_domain;
1125 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1129 if (!domain->ops->alloc) {
1130 pr_debug("domain->ops->alloc() is NULL\n");
1134 if (realloc && irq_base >= 0) {
1137 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node);
1139 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1145 if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1146 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1151 mutex_lock(&irq_domain_mutex);
1152 ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1154 mutex_unlock(&irq_domain_mutex);
1155 goto out_free_irq_data;
1157 for (i = 0; i < nr_irqs; i++)
1158 irq_domain_insert_irq(virq + i);
1159 mutex_unlock(&irq_domain_mutex);
1164 irq_domain_free_irq_data(virq, nr_irqs);
1166 irq_free_descs(virq, nr_irqs);
1171 * irq_domain_free_irqs - Free IRQ number and associated data structures
1172 * @virq: base IRQ number
1173 * @nr_irqs: number of IRQs to free
1175 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1177 struct irq_data *data = irq_get_irq_data(virq);
1180 if (WARN(!data || !data->domain || !data->domain->ops->free,
1181 "NULL pointer, cannot free irq\n"))
1184 mutex_lock(&irq_domain_mutex);
1185 for (i = 0; i < nr_irqs; i++)
1186 irq_domain_remove_irq(virq + i);
1187 irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1188 mutex_unlock(&irq_domain_mutex);
1190 irq_domain_free_irq_data(virq, nr_irqs);
1191 irq_free_descs(virq, nr_irqs);
1195 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1196 * @irq_base: Base IRQ number
1197 * @nr_irqs: Number of IRQs to allocate
1198 * @arg: Allocation data (arch/domain specific)
1200 * Check whether the domain has been setup recursive. If not allocate
1201 * through the parent domain.
1203 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1204 unsigned int irq_base, unsigned int nr_irqs,
1207 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1208 if (irq_domain_is_auto_recursive(domain))
1211 domain = domain->parent;
1213 return irq_domain_alloc_irqs_recursive(domain, irq_base,
1219 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1220 * @irq_base: Base IRQ number
1221 * @nr_irqs: Number of IRQs to free
1223 * Check whether the domain has been setup recursive. If not free
1224 * through the parent domain.
1226 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1227 unsigned int irq_base, unsigned int nr_irqs)
1229 /* irq_domain_free_irqs_recursive() will call parent's free */
1230 if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1231 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1236 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1238 * @irq_data: outermost irq_data associated with interrupt
1240 * This is the second step to call domain_ops->activate to program interrupt
1241 * controllers, so the interrupt could actually get delivered.
1243 void irq_domain_activate_irq(struct irq_data *irq_data)
1245 if (irq_data && irq_data->domain) {
1246 struct irq_domain *domain = irq_data->domain;
1248 if (irq_data->parent_data)
1249 irq_domain_activate_irq(irq_data->parent_data);
1250 if (domain->ops->activate)
1251 domain->ops->activate(domain, irq_data);
1256 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1257 * deactivate interrupt
1258 * @irq_data: outermost irq_data associated with interrupt
1260 * It calls domain_ops->deactivate to program interrupt controllers to disable
1261 * interrupt delivery.
1263 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1265 if (irq_data && irq_data->domain) {
1266 struct irq_domain *domain = irq_data->domain;
1268 if (domain->ops->deactivate)
1269 domain->ops->deactivate(domain, irq_data);
1270 if (irq_data->parent_data)
1271 irq_domain_deactivate_irq(irq_data->parent_data);
1275 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1277 /* Hierarchy irq_domains must implement callback alloc() */
1278 if (domain->ops->alloc)
1279 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1281 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1283 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1284 * @domain: domain to match
1285 * @virq: IRQ number to get irq_data
1287 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1290 struct irq_data *irq_data = irq_get_irq_data(virq);
1292 return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1296 * irq_domain_set_info - Set the complete data for a @virq in @domain
1297 * @domain: Interrupt domain to match
1299 * @hwirq: The hardware interrupt number
1300 * @chip: The associated interrupt chip
1301 * @chip_data: The associated interrupt chip data
1302 * @handler: The interrupt flow handler
1303 * @handler_data: The interrupt flow handler data
1304 * @handler_name: The interrupt handler name
1306 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1307 irq_hw_number_t hwirq, struct irq_chip *chip,
1308 void *chip_data, irq_flow_handler_t handler,
1309 void *handler_data, const char *handler_name)
1311 irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1312 irq_set_chip_data(virq, chip_data);
1313 irq_set_handler_data(virq, handler_data);
1316 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1319 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */