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 void irq_domain_check_hierarchy(struct irq_domain *domain);
29 struct fwnode_handle fwnode;
35 * irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
36 * identifying an irq domain
37 * @data: optional user-provided data
39 * Allocate a struct device_node, and return a poiner to the embedded
40 * fwnode_handle (or NULL on failure).
42 struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
44 struct irqchip_fwid *fwid;
47 fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
48 name = kasprintf(GFP_KERNEL, "irqchip@%p", data);
58 fwid->fwnode.type = FWNODE_IRQCHIP;
61 EXPORT_SYMBOL_GPL(irq_domain_alloc_fwnode);
64 * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
66 * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
68 void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
70 struct irqchip_fwid *fwid;
72 if (WARN_ON(!is_fwnode_irqchip(fwnode)))
75 fwid = container_of(fwnode, struct irqchip_fwid, fwnode);
79 EXPORT_SYMBOL_GPL(irq_domain_free_fwnode);
82 * __irq_domain_add() - Allocate a new irq_domain data structure
83 * @of_node: optional device-tree node of the interrupt controller
84 * @size: Size of linear map; 0 for radix mapping only
85 * @hwirq_max: Maximum number of interrupts supported by controller
86 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
88 * @ops: domain callbacks
89 * @host_data: Controller private data pointer
91 * Allocates and initialize and irq_domain structure.
92 * Returns pointer to IRQ domain, or NULL on failure.
94 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
95 irq_hw_number_t hwirq_max, int direct_max,
96 const struct irq_domain_ops *ops,
99 struct irq_domain *domain;
100 struct device_node *of_node;
102 of_node = to_of_node(fwnode);
104 domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
105 GFP_KERNEL, of_node_to_nid(of_node));
106 if (WARN_ON(!domain))
109 of_node_get(of_node);
112 INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
114 domain->host_data = host_data;
115 domain->fwnode = fwnode;
116 domain->hwirq_max = hwirq_max;
117 domain->revmap_size = size;
118 domain->revmap_direct_max_irq = direct_max;
119 irq_domain_check_hierarchy(domain);
121 mutex_lock(&irq_domain_mutex);
122 list_add(&domain->link, &irq_domain_list);
123 mutex_unlock(&irq_domain_mutex);
125 pr_debug("Added domain %s\n", domain->name);
128 EXPORT_SYMBOL_GPL(__irq_domain_add);
131 * irq_domain_remove() - Remove an irq domain.
132 * @domain: domain to remove
134 * This routine is used to remove an irq domain. The caller must ensure
135 * that all mappings within the domain have been disposed of prior to
136 * use, depending on the revmap type.
138 void irq_domain_remove(struct irq_domain *domain)
140 mutex_lock(&irq_domain_mutex);
143 * radix_tree_delete() takes care of destroying the root
144 * node when all entries are removed. Shout if there are
147 WARN_ON(domain->revmap_tree.height);
149 list_del(&domain->link);
152 * If the going away domain is the default one, reset it.
154 if (unlikely(irq_default_domain == domain))
155 irq_set_default_host(NULL);
157 mutex_unlock(&irq_domain_mutex);
159 pr_debug("Removed domain %s\n", domain->name);
161 of_node_put(irq_domain_get_of_node(domain));
164 EXPORT_SYMBOL_GPL(irq_domain_remove);
167 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
168 * @of_node: pointer to interrupt controller's device tree node.
169 * @size: total number of irqs in mapping
170 * @first_irq: first number of irq block assigned to the domain,
171 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
172 * pre-map all of the irqs in the domain to virqs starting at first_irq.
173 * @ops: domain callbacks
174 * @host_data: Controller private data pointer
176 * Allocates an irq_domain, and optionally if first_irq is positive then also
177 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
179 * This is intended to implement the expected behaviour for most
180 * interrupt controllers. If device tree is used, then first_irq will be 0 and
181 * irqs get mapped dynamically on the fly. However, if the controller requires
182 * static virq assignments (non-DT boot) then it will set that up correctly.
184 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
186 unsigned int first_irq,
187 const struct irq_domain_ops *ops,
190 struct irq_domain *domain;
192 domain = __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
197 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
198 /* attempt to allocated irq_descs */
199 int rc = irq_alloc_descs(first_irq, first_irq, size,
200 of_node_to_nid(of_node));
202 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
205 irq_domain_associate_many(domain, first_irq, 0, size);
210 EXPORT_SYMBOL_GPL(irq_domain_add_simple);
213 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
214 * @of_node: pointer to interrupt controller's device tree node.
215 * @size: total number of irqs in legacy mapping
216 * @first_irq: first number of irq block assigned to the domain
217 * @first_hwirq: first hwirq number to use for the translation. Should normally
218 * be '0', but a positive integer can be used if the effective
219 * hwirqs numbering does not begin at zero.
220 * @ops: map/unmap domain callbacks
221 * @host_data: Controller private data pointer
223 * Note: the map() callback will be called before this function returns
224 * for all legacy interrupts except 0 (which is always the invalid irq for
225 * a legacy controller).
227 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
229 unsigned int first_irq,
230 irq_hw_number_t first_hwirq,
231 const struct irq_domain_ops *ops,
234 struct irq_domain *domain;
236 domain = __irq_domain_add(of_node_to_fwnode(of_node), first_hwirq + size,
237 first_hwirq + size, 0, ops, host_data);
239 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
243 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
246 * irq_find_matching_fwnode() - Locates a domain for a given fwnode
247 * @fwnode: FW descriptor of the interrupt controller
248 * @bus_token: domain-specific data
250 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
251 enum irq_domain_bus_token bus_token)
253 struct irq_domain *h, *found = NULL;
256 /* We might want to match the legacy controller last since
257 * it might potentially be set to match all interrupts in
258 * the absence of a device node. This isn't a problem so far
261 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
262 * values must generate an exact match for the domain to be
265 mutex_lock(&irq_domain_mutex);
266 list_for_each_entry(h, &irq_domain_list, link) {
268 rc = h->ops->match(h, to_of_node(fwnode), bus_token);
270 rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
271 ((bus_token == DOMAIN_BUS_ANY) ||
272 (h->bus_token == bus_token)));
279 mutex_unlock(&irq_domain_mutex);
282 EXPORT_SYMBOL_GPL(irq_find_matching_fwnode);
285 * irq_set_default_host() - Set a "default" irq domain
286 * @domain: default domain pointer
288 * For convenience, it's possible to set a "default" domain that will be used
289 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
290 * platforms that want to manipulate a few hard coded interrupt numbers that
291 * aren't properly represented in the device-tree.
293 void irq_set_default_host(struct irq_domain *domain)
295 pr_debug("Default domain set to @0x%p\n", domain);
297 irq_default_domain = domain;
299 EXPORT_SYMBOL_GPL(irq_set_default_host);
301 void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
303 struct irq_data *irq_data = irq_get_irq_data(irq);
304 irq_hw_number_t hwirq;
306 if (WARN(!irq_data || irq_data->domain != domain,
307 "virq%i doesn't exist; cannot disassociate\n", irq))
310 hwirq = irq_data->hwirq;
311 irq_set_status_flags(irq, IRQ_NOREQUEST);
313 /* remove chip and handler */
314 irq_set_chip_and_handler(irq, NULL, NULL);
316 /* Make sure it's completed */
317 synchronize_irq(irq);
319 /* Tell the PIC about it */
320 if (domain->ops->unmap)
321 domain->ops->unmap(domain, irq);
324 irq_data->domain = NULL;
327 /* Clear reverse map for this hwirq */
328 if (hwirq < domain->revmap_size) {
329 domain->linear_revmap[hwirq] = 0;
331 mutex_lock(&revmap_trees_mutex);
332 radix_tree_delete(&domain->revmap_tree, hwirq);
333 mutex_unlock(&revmap_trees_mutex);
337 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
338 irq_hw_number_t hwirq)
340 struct irq_data *irq_data = irq_get_irq_data(virq);
343 if (WARN(hwirq >= domain->hwirq_max,
344 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
346 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
348 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
351 mutex_lock(&irq_domain_mutex);
352 irq_data->hwirq = hwirq;
353 irq_data->domain = domain;
354 if (domain->ops->map) {
355 ret = domain->ops->map(domain, virq, hwirq);
358 * If map() returns -EPERM, this interrupt is protected
359 * by the firmware or some other service and shall not
360 * be mapped. Don't bother telling the user about it.
363 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
364 domain->name, hwirq, virq, ret);
366 irq_data->domain = NULL;
368 mutex_unlock(&irq_domain_mutex);
372 /* If not already assigned, give the domain the chip's name */
373 if (!domain->name && irq_data->chip)
374 domain->name = irq_data->chip->name;
377 if (hwirq < domain->revmap_size) {
378 domain->linear_revmap[hwirq] = virq;
380 mutex_lock(&revmap_trees_mutex);
381 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
382 mutex_unlock(&revmap_trees_mutex);
384 mutex_unlock(&irq_domain_mutex);
386 irq_clear_status_flags(virq, IRQ_NOREQUEST);
390 EXPORT_SYMBOL_GPL(irq_domain_associate);
392 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
393 irq_hw_number_t hwirq_base, int count)
395 struct device_node *of_node;
398 of_node = irq_domain_get_of_node(domain);
399 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
400 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
402 for (i = 0; i < count; i++) {
403 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
406 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
409 * irq_create_direct_mapping() - Allocate an irq for direct mapping
410 * @domain: domain to allocate the irq for or NULL for default domain
412 * This routine is used for irq controllers which can choose the hardware
413 * interrupt numbers they generate. In such a case it's simplest to use
414 * the linux irq as the hardware interrupt number. It still uses the linear
415 * or radix tree to store the mapping, but the irq controller can optimize
416 * the revmap path by using the hwirq directly.
418 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
420 struct device_node *of_node;
424 domain = irq_default_domain;
426 of_node = irq_domain_get_of_node(domain);
427 virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
429 pr_debug("create_direct virq allocation failed\n");
432 if (virq >= domain->revmap_direct_max_irq) {
433 pr_err("ERROR: no free irqs available below %i maximum\n",
434 domain->revmap_direct_max_irq);
438 pr_debug("create_direct obtained virq %d\n", virq);
440 if (irq_domain_associate(domain, virq, virq)) {
447 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
450 * irq_create_mapping() - Map a hardware interrupt into linux irq space
451 * @domain: domain owning this hardware interrupt or NULL for default domain
452 * @hwirq: hardware irq number in that domain space
454 * Only one mapping per hardware interrupt is permitted. Returns a linux
456 * If the sense/trigger is to be specified, set_irq_type() should be called
457 * on the number returned from that call.
459 unsigned int irq_create_mapping(struct irq_domain *domain,
460 irq_hw_number_t hwirq)
462 struct device_node *of_node;
465 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
467 /* Look for default domain if nececssary */
469 domain = irq_default_domain;
470 if (domain == NULL) {
471 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
474 pr_debug("-> using domain @%p\n", domain);
476 of_node = irq_domain_get_of_node(domain);
478 /* Check if mapping already exists */
479 virq = irq_find_mapping(domain, hwirq);
481 pr_debug("-> existing mapping on virq %d\n", virq);
485 /* Allocate a virtual interrupt number */
486 virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node));
488 pr_debug("-> virq allocation failed\n");
492 if (irq_domain_associate(domain, virq, hwirq)) {
497 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
498 hwirq, of_node_full_name(of_node), virq);
502 EXPORT_SYMBOL_GPL(irq_create_mapping);
505 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
506 * @domain: domain owning the interrupt range
507 * @irq_base: beginning of linux IRQ range
508 * @hwirq_base: beginning of hardware IRQ range
509 * @count: Number of interrupts to map
511 * This routine is used for allocating and mapping a range of hardware
512 * irqs to linux irqs where the linux irq numbers are at pre-defined
513 * locations. For use by controllers that already have static mappings
514 * to insert in to the domain.
516 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
519 * 0 is returned upon success, while any failure to establish a static
520 * mapping is treated as an error.
522 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
523 irq_hw_number_t hwirq_base, int count)
525 struct device_node *of_node;
528 of_node = irq_domain_get_of_node(domain);
529 ret = irq_alloc_descs(irq_base, irq_base, count,
530 of_node_to_nid(of_node));
531 if (unlikely(ret < 0))
534 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
537 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
539 static int irq_domain_translate(struct irq_domain *d,
540 struct irq_fwspec *fwspec,
541 irq_hw_number_t *hwirq, unsigned int *type)
543 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
544 if (d->ops->translate)
545 return d->ops->translate(d, fwspec, hwirq, type);
548 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
549 fwspec->param, fwspec->param_count,
552 /* If domain has no translation, then we assume interrupt line */
553 *hwirq = fwspec->param[0];
557 static void of_phandle_args_to_fwspec(struct of_phandle_args *irq_data,
558 struct irq_fwspec *fwspec)
562 fwspec->fwnode = irq_data->np ? &irq_data->np->fwnode : NULL;
563 fwspec->param_count = irq_data->args_count;
565 for (i = 0; i < irq_data->args_count; i++)
566 fwspec->param[i] = irq_data->args[i];
569 unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
571 struct irq_domain *domain;
572 irq_hw_number_t hwirq;
573 unsigned int type = IRQ_TYPE_NONE;
576 if (fwspec->fwnode) {
577 domain = irq_find_matching_fwnode(fwspec->fwnode,
580 domain = irq_find_matching_fwnode(fwspec->fwnode,
583 domain = irq_default_domain;
587 pr_warn("no irq domain found for %s !\n",
588 of_node_full_name(to_of_node(fwspec->fwnode)));
592 if (irq_domain_translate(domain, fwspec, &hwirq, &type))
595 if (irq_domain_is_hierarchy(domain)) {
597 * If we've already configured this interrupt,
598 * don't do it again, or hell will break loose.
600 virq = irq_find_mapping(domain, hwirq);
604 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
609 virq = irq_create_mapping(domain, hwirq);
614 /* Set type if specified and different than the current one */
615 if (type != IRQ_TYPE_NONE &&
616 type != irq_get_trigger_type(virq))
617 irq_set_irq_type(virq, type);
620 EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
622 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
624 struct irq_fwspec fwspec;
626 of_phandle_args_to_fwspec(irq_data, &fwspec);
627 return irq_create_fwspec_mapping(&fwspec);
629 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
632 * irq_dispose_mapping() - Unmap an interrupt
633 * @virq: linux irq number of the interrupt to unmap
635 void irq_dispose_mapping(unsigned int virq)
637 struct irq_data *irq_data = irq_get_irq_data(virq);
638 struct irq_domain *domain;
640 if (!virq || !irq_data)
643 domain = irq_data->domain;
644 if (WARN_ON(domain == NULL))
647 irq_domain_disassociate(domain, virq);
650 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
653 * irq_find_mapping() - Find a linux irq from an hw irq number.
654 * @domain: domain owning this hardware interrupt
655 * @hwirq: hardware irq number in that domain space
657 unsigned int irq_find_mapping(struct irq_domain *domain,
658 irq_hw_number_t hwirq)
660 struct irq_data *data;
662 /* Look for default domain if nececssary */
664 domain = irq_default_domain;
668 if (hwirq < domain->revmap_direct_max_irq) {
669 data = irq_domain_get_irq_data(domain, hwirq);
670 if (data && data->hwirq == hwirq)
674 /* Check if the hwirq is in the linear revmap. */
675 if (hwirq < domain->revmap_size)
676 return domain->linear_revmap[hwirq];
679 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
681 return data ? data->irq : 0;
683 EXPORT_SYMBOL_GPL(irq_find_mapping);
685 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
686 static int virq_debug_show(struct seq_file *m, void *private)
689 struct irq_desc *desc;
690 struct irq_domain *domain;
691 struct radix_tree_iter iter;
695 seq_printf(m, " %-16s %-6s %-10s %-10s %s\n",
696 "name", "mapped", "linear-max", "direct-max", "devtree-node");
697 mutex_lock(&irq_domain_mutex);
698 list_for_each_entry(domain, &irq_domain_list, link) {
699 struct device_node *of_node;
701 of_node = irq_domain_get_of_node(domain);
702 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
704 seq_printf(m, "%c%-16s %6u %10u %10u %s\n",
705 domain == irq_default_domain ? '*' : ' ', domain->name,
706 domain->revmap_size + count, domain->revmap_size,
707 domain->revmap_direct_max_irq,
708 of_node ? of_node_full_name(of_node) : "");
710 mutex_unlock(&irq_domain_mutex);
712 seq_printf(m, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
713 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
714 "active", "type", "domain");
716 for (i = 1; i < nr_irqs; i++) {
717 desc = irq_to_desc(i);
721 raw_spin_lock_irqsave(&desc->lock, flags);
722 domain = desc->irq_data.domain;
725 struct irq_chip *chip;
726 int hwirq = desc->irq_data.hwirq;
729 seq_printf(m, "%5d ", i);
730 seq_printf(m, "0x%05x ", hwirq);
732 chip = irq_desc_get_chip(desc);
733 seq_printf(m, "%-15s ", (chip && chip->name) ? chip->name : "none");
735 data = irq_desc_get_chip_data(desc);
736 seq_printf(m, data ? "0x%p " : " %p ", data);
738 seq_printf(m, " %c ", (desc->action && desc->action->handler) ? '*' : ' ');
739 direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
740 seq_printf(m, "%6s%-8s ",
741 (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
742 direct ? "(DIRECT)" : "");
743 seq_printf(m, "%s\n", desc->irq_data.domain->name);
746 raw_spin_unlock_irqrestore(&desc->lock, flags);
752 static int virq_debug_open(struct inode *inode, struct file *file)
754 return single_open(file, virq_debug_show, inode->i_private);
757 static const struct file_operations virq_debug_fops = {
758 .open = virq_debug_open,
761 .release = single_release,
764 static int __init irq_debugfs_init(void)
766 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
767 NULL, &virq_debug_fops) == NULL)
772 __initcall(irq_debugfs_init);
773 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
776 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
778 * Device Tree IRQ specifier translation function which works with one cell
779 * bindings where the cell value maps directly to the hwirq number.
781 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
782 const u32 *intspec, unsigned int intsize,
783 unsigned long *out_hwirq, unsigned int *out_type)
785 if (WARN_ON(intsize < 1))
787 *out_hwirq = intspec[0];
788 *out_type = IRQ_TYPE_NONE;
791 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
794 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
796 * Device Tree IRQ specifier translation function which works with two cell
797 * bindings where the cell values map directly to the hwirq number
798 * and linux irq flags.
800 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
801 const u32 *intspec, unsigned int intsize,
802 irq_hw_number_t *out_hwirq, unsigned int *out_type)
804 if (WARN_ON(intsize < 2))
806 *out_hwirq = intspec[0];
807 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
810 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
813 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
815 * Device Tree IRQ specifier translation function which works with either one
816 * or two cell bindings where the cell values map directly to the hwirq number
817 * and linux irq flags.
819 * Note: don't use this function unless your interrupt controller explicitly
820 * supports both one and two cell bindings. For the majority of controllers
821 * the _onecell() or _twocell() variants above should be used.
823 int irq_domain_xlate_onetwocell(struct irq_domain *d,
824 struct device_node *ctrlr,
825 const u32 *intspec, unsigned int intsize,
826 unsigned long *out_hwirq, unsigned int *out_type)
828 if (WARN_ON(intsize < 1))
830 *out_hwirq = intspec[0];
831 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
834 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
836 const struct irq_domain_ops irq_domain_simple_ops = {
837 .xlate = irq_domain_xlate_onetwocell,
839 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
841 int irq_domain_alloc_descs(int virq, unsigned int cnt, irq_hw_number_t hwirq,
847 virq = irq_alloc_descs(virq, virq, cnt, node);
849 hint = hwirq % nr_irqs;
852 virq = irq_alloc_descs_from(hint, cnt, node);
853 if (virq <= 0 && hint > 1)
854 virq = irq_alloc_descs_from(1, cnt, node);
860 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
862 * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
863 * @parent: Parent irq domain to associate with the new domain
864 * @flags: Irq domain flags associated to the domain
865 * @size: Size of the domain. See below
866 * @fwnode: Optional fwnode of the interrupt controller
867 * @ops: Pointer to the interrupt domain callbacks
868 * @host_data: Controller private data pointer
870 * If @size is 0 a tree domain is created, otherwise a linear domain.
872 * If successful the parent is associated to the new domain and the
873 * domain flags are set.
874 * Returns pointer to IRQ domain, or NULL on failure.
876 struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
879 struct fwnode_handle *fwnode,
880 const struct irq_domain_ops *ops,
883 struct irq_domain *domain;
886 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
888 domain = irq_domain_create_tree(fwnode, ops, host_data);
890 domain->parent = parent;
891 domain->flags |= flags;
896 EXPORT_SYMBOL_GPL(irq_domain_create_hierarchy);
898 static void irq_domain_insert_irq(int virq)
900 struct irq_data *data;
902 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
903 struct irq_domain *domain = data->domain;
904 irq_hw_number_t hwirq = data->hwirq;
906 if (hwirq < domain->revmap_size) {
907 domain->linear_revmap[hwirq] = virq;
909 mutex_lock(&revmap_trees_mutex);
910 radix_tree_insert(&domain->revmap_tree, hwirq, data);
911 mutex_unlock(&revmap_trees_mutex);
914 /* If not already assigned, give the domain the chip's name */
915 if (!domain->name && data->chip)
916 domain->name = data->chip->name;
919 irq_clear_status_flags(virq, IRQ_NOREQUEST);
922 static void irq_domain_remove_irq(int virq)
924 struct irq_data *data;
926 irq_set_status_flags(virq, IRQ_NOREQUEST);
927 irq_set_chip_and_handler(virq, NULL, NULL);
928 synchronize_irq(virq);
931 for (data = irq_get_irq_data(virq); data; data = data->parent_data) {
932 struct irq_domain *domain = data->domain;
933 irq_hw_number_t hwirq = data->hwirq;
935 if (hwirq < domain->revmap_size) {
936 domain->linear_revmap[hwirq] = 0;
938 mutex_lock(&revmap_trees_mutex);
939 radix_tree_delete(&domain->revmap_tree, hwirq);
940 mutex_unlock(&revmap_trees_mutex);
945 static struct irq_data *irq_domain_insert_irq_data(struct irq_domain *domain,
946 struct irq_data *child)
948 struct irq_data *irq_data;
950 irq_data = kzalloc_node(sizeof(*irq_data), GFP_KERNEL,
951 irq_data_get_node(child));
953 child->parent_data = irq_data;
954 irq_data->irq = child->irq;
955 irq_data->common = child->common;
956 irq_data->domain = domain;
962 static void irq_domain_free_irq_data(unsigned int virq, unsigned int nr_irqs)
964 struct irq_data *irq_data, *tmp;
967 for (i = 0; i < nr_irqs; i++) {
968 irq_data = irq_get_irq_data(virq + i);
969 tmp = irq_data->parent_data;
970 irq_data->parent_data = NULL;
971 irq_data->domain = NULL;
975 tmp = tmp->parent_data;
981 static int irq_domain_alloc_irq_data(struct irq_domain *domain,
982 unsigned int virq, unsigned int nr_irqs)
984 struct irq_data *irq_data;
985 struct irq_domain *parent;
988 /* The outermost irq_data is embedded in struct irq_desc */
989 for (i = 0; i < nr_irqs; i++) {
990 irq_data = irq_get_irq_data(virq + i);
991 irq_data->domain = domain;
993 for (parent = domain->parent; parent; parent = parent->parent) {
994 irq_data = irq_domain_insert_irq_data(parent, irq_data);
996 irq_domain_free_irq_data(virq, i + 1);
1006 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1007 * @domain: domain to match
1008 * @virq: IRQ number to get irq_data
1010 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1013 struct irq_data *irq_data;
1015 for (irq_data = irq_get_irq_data(virq); irq_data;
1016 irq_data = irq_data->parent_data)
1017 if (irq_data->domain == domain)
1022 EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1025 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1026 * @domain: Interrupt domain to match
1028 * @hwirq: The hwirq number
1029 * @chip: The associated interrupt chip
1030 * @chip_data: The associated chip data
1032 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1033 irq_hw_number_t hwirq, struct irq_chip *chip,
1036 struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1041 irq_data->hwirq = hwirq;
1042 irq_data->chip = chip ? chip : &no_irq_chip;
1043 irq_data->chip_data = chip_data;
1047 EXPORT_SYMBOL_GPL(irq_domain_set_hwirq_and_chip);
1050 * irq_domain_set_info - Set the complete data for a @virq in @domain
1051 * @domain: Interrupt domain to match
1053 * @hwirq: The hardware interrupt number
1054 * @chip: The associated interrupt chip
1055 * @chip_data: The associated interrupt chip data
1056 * @handler: The interrupt flow handler
1057 * @handler_data: The interrupt flow handler data
1058 * @handler_name: The interrupt handler name
1060 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1061 irq_hw_number_t hwirq, struct irq_chip *chip,
1062 void *chip_data, irq_flow_handler_t handler,
1063 void *handler_data, const char *handler_name)
1065 irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1066 __irq_set_handler(virq, handler, 0, handler_name);
1067 irq_set_handler_data(virq, handler_data);
1069 EXPORT_SYMBOL(irq_domain_set_info);
1072 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1073 * @irq_data: The pointer to irq_data
1075 void irq_domain_reset_irq_data(struct irq_data *irq_data)
1077 irq_data->hwirq = 0;
1078 irq_data->chip = &no_irq_chip;
1079 irq_data->chip_data = NULL;
1081 EXPORT_SYMBOL_GPL(irq_domain_reset_irq_data);
1084 * irq_domain_free_irqs_common - Clear irq_data and free the parent
1085 * @domain: Interrupt domain to match
1086 * @virq: IRQ number to start with
1087 * @nr_irqs: The number of irqs to free
1089 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1090 unsigned int nr_irqs)
1092 struct irq_data *irq_data;
1095 for (i = 0; i < nr_irqs; i++) {
1096 irq_data = irq_domain_get_irq_data(domain, virq + i);
1098 irq_domain_reset_irq_data(irq_data);
1100 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1104 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1105 * @domain: Interrupt domain to match
1106 * @virq: IRQ number to start with
1107 * @nr_irqs: The number of irqs to free
1109 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1110 unsigned int nr_irqs)
1114 for (i = 0; i < nr_irqs; i++) {
1115 irq_set_handler_data(virq + i, NULL);
1116 irq_set_handler(virq + i, NULL);
1118 irq_domain_free_irqs_common(domain, virq, nr_irqs);
1121 static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1123 return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1126 static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1127 unsigned int irq_base,
1128 unsigned int nr_irqs)
1130 domain->ops->free(domain, irq_base, nr_irqs);
1131 if (irq_domain_is_auto_recursive(domain)) {
1132 BUG_ON(!domain->parent);
1133 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1138 int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1139 unsigned int irq_base,
1140 unsigned int nr_irqs, void *arg)
1143 struct irq_domain *parent = domain->parent;
1144 bool recursive = irq_domain_is_auto_recursive(domain);
1146 BUG_ON(recursive && !parent);
1148 ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1151 ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1152 if (ret < 0 && recursive)
1153 irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1159 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1160 * @domain: domain to allocate from
1161 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1162 * @nr_irqs: number of IRQs to allocate
1163 * @node: NUMA node id for memory allocation
1164 * @arg: domain specific argument
1165 * @realloc: IRQ descriptors have already been allocated if true
1167 * Allocate IRQ numbers and initialized all data structures to support
1168 * hierarchy IRQ domains.
1169 * Parameter @realloc is mainly to support legacy IRQs.
1170 * Returns error code or allocated IRQ number
1172 * The whole process to setup an IRQ has been split into two steps.
1173 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1174 * descriptor and required hardware resources. The second step,
1175 * irq_domain_activate_irq(), is to program hardwares with preallocated
1176 * resources. In this way, it's easier to rollback when failing to
1177 * allocate resources.
1179 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1180 unsigned int nr_irqs, int node, void *arg,
1185 if (domain == NULL) {
1186 domain = irq_default_domain;
1187 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1191 if (!domain->ops->alloc) {
1192 pr_debug("domain->ops->alloc() is NULL\n");
1196 if (realloc && irq_base >= 0) {
1199 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node);
1201 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1207 if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1208 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1213 mutex_lock(&irq_domain_mutex);
1214 ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1216 mutex_unlock(&irq_domain_mutex);
1217 goto out_free_irq_data;
1219 for (i = 0; i < nr_irqs; i++)
1220 irq_domain_insert_irq(virq + i);
1221 mutex_unlock(&irq_domain_mutex);
1226 irq_domain_free_irq_data(virq, nr_irqs);
1228 irq_free_descs(virq, nr_irqs);
1233 * irq_domain_free_irqs - Free IRQ number and associated data structures
1234 * @virq: base IRQ number
1235 * @nr_irqs: number of IRQs to free
1237 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1239 struct irq_data *data = irq_get_irq_data(virq);
1242 if (WARN(!data || !data->domain || !data->domain->ops->free,
1243 "NULL pointer, cannot free irq\n"))
1246 mutex_lock(&irq_domain_mutex);
1247 for (i = 0; i < nr_irqs; i++)
1248 irq_domain_remove_irq(virq + i);
1249 irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1250 mutex_unlock(&irq_domain_mutex);
1252 irq_domain_free_irq_data(virq, nr_irqs);
1253 irq_free_descs(virq, nr_irqs);
1257 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1258 * @irq_base: Base IRQ number
1259 * @nr_irqs: Number of IRQs to allocate
1260 * @arg: Allocation data (arch/domain specific)
1262 * Check whether the domain has been setup recursive. If not allocate
1263 * through the parent domain.
1265 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1266 unsigned int irq_base, unsigned int nr_irqs,
1269 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1270 if (irq_domain_is_auto_recursive(domain))
1273 domain = domain->parent;
1275 return irq_domain_alloc_irqs_recursive(domain, irq_base,
1279 EXPORT_SYMBOL_GPL(irq_domain_alloc_irqs_parent);
1282 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1283 * @irq_base: Base IRQ number
1284 * @nr_irqs: Number of IRQs to free
1286 * Check whether the domain has been setup recursive. If not free
1287 * through the parent domain.
1289 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1290 unsigned int irq_base, unsigned int nr_irqs)
1292 /* irq_domain_free_irqs_recursive() will call parent's free */
1293 if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1294 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1297 EXPORT_SYMBOL_GPL(irq_domain_free_irqs_parent);
1300 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1302 * @irq_data: outermost irq_data associated with interrupt
1304 * This is the second step to call domain_ops->activate to program interrupt
1305 * controllers, so the interrupt could actually get delivered.
1307 void irq_domain_activate_irq(struct irq_data *irq_data)
1309 if (irq_data && irq_data->domain) {
1310 struct irq_domain *domain = irq_data->domain;
1312 if (irq_data->parent_data)
1313 irq_domain_activate_irq(irq_data->parent_data);
1314 if (domain->ops->activate)
1315 domain->ops->activate(domain, irq_data);
1320 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1321 * deactivate interrupt
1322 * @irq_data: outermost irq_data associated with interrupt
1324 * It calls domain_ops->deactivate to program interrupt controllers to disable
1325 * interrupt delivery.
1327 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1329 if (irq_data && irq_data->domain) {
1330 struct irq_domain *domain = irq_data->domain;
1332 if (domain->ops->deactivate)
1333 domain->ops->deactivate(domain, irq_data);
1334 if (irq_data->parent_data)
1335 irq_domain_deactivate_irq(irq_data->parent_data);
1339 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1341 /* Hierarchy irq_domains must implement callback alloc() */
1342 if (domain->ops->alloc)
1343 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1345 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1347 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1348 * @domain: domain to match
1349 * @virq: IRQ number to get irq_data
1351 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1354 struct irq_data *irq_data = irq_get_irq_data(virq);
1356 return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1358 EXPORT_SYMBOL_GPL(irq_domain_get_irq_data);
1361 * irq_domain_set_info - Set the complete data for a @virq in @domain
1362 * @domain: Interrupt domain to match
1364 * @hwirq: The hardware interrupt number
1365 * @chip: The associated interrupt chip
1366 * @chip_data: The associated interrupt chip data
1367 * @handler: The interrupt flow handler
1368 * @handler_data: The interrupt flow handler data
1369 * @handler_name: The interrupt handler name
1371 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1372 irq_hw_number_t hwirq, struct irq_chip *chip,
1373 void *chip_data, irq_flow_handler_t handler,
1374 void *handler_data, const char *handler_name)
1376 irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1377 irq_set_chip_data(virq, chip_data);
1378 irq_set_handler_data(virq, handler_data);
1381 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1384 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */