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 struct fwnode_handle fwnode;
37 * irq_domain_alloc_fwnode - Allocate a fwnode_handle suitable for
38 * identifying an irq domain
39 * @data: optional user-provided data
41 * Allocate a struct device_node, and return a poiner to the embedded
42 * fwnode_handle (or NULL on failure).
44 struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
46 struct irqchip_fwid *fwid;
49 fwid = kzalloc(sizeof(*fwid), GFP_KERNEL);
50 name = kasprintf(GFP_KERNEL, "irqchip@%p", data);
60 fwid->fwnode.type = FWNODE_IRQCHIP;
65 * irq_domain_free_fwnode - Free a non-OF-backed fwnode_handle
67 * Free a fwnode_handle allocated with irq_domain_alloc_fwnode.
69 void irq_domain_free_fwnode(struct fwnode_handle *fwnode)
71 struct irqchip_fwid *fwid;
73 if (WARN_ON(!is_fwnode_irqchip(fwnode)))
76 fwid = container_of(fwnode, struct irqchip_fwid, 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_fwspec() - Locates a domain for a given fwspec
247 * @fwspec: FW specifier for an interrupt
248 * @bus_token: domain-specific data
250 struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
251 enum irq_domain_bus_token bus_token)
253 struct irq_domain *h, *found = NULL;
254 struct fwnode_handle *fwnode = fwspec->fwnode;
257 /* We might want to match the legacy controller last since
258 * it might potentially be set to match all interrupts in
259 * the absence of a device node. This isn't a problem so far
262 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
263 * values must generate an exact match for the domain to be
266 mutex_lock(&irq_domain_mutex);
267 list_for_each_entry(h, &irq_domain_list, link) {
268 if (h->ops->select && fwspec->param_count)
269 rc = h->ops->select(h, fwspec, bus_token);
270 else if (h->ops->match)
271 rc = h->ops->match(h, to_of_node(fwnode), bus_token);
273 rc = ((fwnode != NULL) && (h->fwnode == fwnode) &&
274 ((bus_token == DOMAIN_BUS_ANY) ||
275 (h->bus_token == bus_token)));
282 mutex_unlock(&irq_domain_mutex);
285 EXPORT_SYMBOL_GPL(irq_find_matching_fwspec);
288 * irq_set_default_host() - Set a "default" irq domain
289 * @domain: default domain pointer
291 * For convenience, it's possible to set a "default" domain that will be used
292 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
293 * platforms that want to manipulate a few hard coded interrupt numbers that
294 * aren't properly represented in the device-tree.
296 void irq_set_default_host(struct irq_domain *domain)
298 pr_debug("Default domain set to @0x%p\n", domain);
300 irq_default_domain = domain;
302 EXPORT_SYMBOL_GPL(irq_set_default_host);
304 void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
306 struct irq_data *irq_data = irq_get_irq_data(irq);
307 irq_hw_number_t hwirq;
309 if (WARN(!irq_data || irq_data->domain != domain,
310 "virq%i doesn't exist; cannot disassociate\n", irq))
313 hwirq = irq_data->hwirq;
314 irq_set_status_flags(irq, IRQ_NOREQUEST);
316 /* remove chip and handler */
317 irq_set_chip_and_handler(irq, NULL, NULL);
319 /* Make sure it's completed */
320 synchronize_irq(irq);
322 /* Tell the PIC about it */
323 if (domain->ops->unmap)
324 domain->ops->unmap(domain, irq);
327 irq_data->domain = NULL;
330 /* Clear reverse map for this hwirq */
331 if (hwirq < domain->revmap_size) {
332 domain->linear_revmap[hwirq] = 0;
334 mutex_lock(&revmap_trees_mutex);
335 radix_tree_delete(&domain->revmap_tree, hwirq);
336 mutex_unlock(&revmap_trees_mutex);
340 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
341 irq_hw_number_t hwirq)
343 struct irq_data *irq_data = irq_get_irq_data(virq);
346 if (WARN(hwirq >= domain->hwirq_max,
347 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
349 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
351 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
354 mutex_lock(&irq_domain_mutex);
355 irq_data->hwirq = hwirq;
356 irq_data->domain = domain;
357 if (domain->ops->map) {
358 ret = domain->ops->map(domain, virq, hwirq);
361 * If map() returns -EPERM, this interrupt is protected
362 * by the firmware or some other service and shall not
363 * be mapped. Don't bother telling the user about it.
366 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
367 domain->name, hwirq, virq, ret);
369 irq_data->domain = NULL;
371 mutex_unlock(&irq_domain_mutex);
375 /* If not already assigned, give the domain the chip's name */
376 if (!domain->name && irq_data->chip)
377 domain->name = irq_data->chip->name;
380 if (hwirq < domain->revmap_size) {
381 domain->linear_revmap[hwirq] = virq;
383 mutex_lock(&revmap_trees_mutex);
384 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
385 mutex_unlock(&revmap_trees_mutex);
387 mutex_unlock(&irq_domain_mutex);
389 irq_clear_status_flags(virq, IRQ_NOREQUEST);
393 EXPORT_SYMBOL_GPL(irq_domain_associate);
395 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
396 irq_hw_number_t hwirq_base, int count)
398 struct device_node *of_node;
401 of_node = irq_domain_get_of_node(domain);
402 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
403 of_node_full_name(of_node), irq_base, (int)hwirq_base, count);
405 for (i = 0; i < count; i++) {
406 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
409 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
412 * irq_create_direct_mapping() - Allocate an irq for direct mapping
413 * @domain: domain to allocate the irq for or NULL for default domain
415 * This routine is used for irq controllers which can choose the hardware
416 * interrupt numbers they generate. In such a case it's simplest to use
417 * the linux irq as the hardware interrupt number. It still uses the linear
418 * or radix tree to store the mapping, but the irq controller can optimize
419 * the revmap path by using the hwirq directly.
421 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
423 struct device_node *of_node;
427 domain = irq_default_domain;
429 of_node = irq_domain_get_of_node(domain);
430 virq = irq_alloc_desc_from(1, of_node_to_nid(of_node));
432 pr_debug("create_direct virq allocation failed\n");
435 if (virq >= domain->revmap_direct_max_irq) {
436 pr_err("ERROR: no free irqs available below %i maximum\n",
437 domain->revmap_direct_max_irq);
441 pr_debug("create_direct obtained virq %d\n", virq);
443 if (irq_domain_associate(domain, virq, virq)) {
450 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
453 * irq_create_mapping() - Map a hardware interrupt into linux irq space
454 * @domain: domain owning this hardware interrupt or NULL for default domain
455 * @hwirq: hardware irq number in that domain space
457 * Only one mapping per hardware interrupt is permitted. Returns a linux
459 * If the sense/trigger is to be specified, set_irq_type() should be called
460 * on the number returned from that call.
462 unsigned int irq_create_mapping(struct irq_domain *domain,
463 irq_hw_number_t hwirq)
465 struct device_node *of_node;
468 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
470 /* Look for default domain if nececssary */
472 domain = irq_default_domain;
473 if (domain == NULL) {
474 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
477 pr_debug("-> using domain @%p\n", domain);
479 of_node = irq_domain_get_of_node(domain);
481 /* Check if mapping already exists */
482 virq = irq_find_mapping(domain, hwirq);
484 pr_debug("-> existing mapping on virq %d\n", virq);
488 /* Allocate a virtual interrupt number */
489 virq = irq_domain_alloc_descs(-1, 1, hwirq, of_node_to_nid(of_node));
491 pr_debug("-> virq allocation failed\n");
495 if (irq_domain_associate(domain, virq, hwirq)) {
500 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
501 hwirq, of_node_full_name(of_node), virq);
505 EXPORT_SYMBOL_GPL(irq_create_mapping);
508 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
509 * @domain: domain owning the interrupt range
510 * @irq_base: beginning of linux IRQ range
511 * @hwirq_base: beginning of hardware IRQ range
512 * @count: Number of interrupts to map
514 * This routine is used for allocating and mapping a range of hardware
515 * irqs to linux irqs where the linux irq numbers are at pre-defined
516 * locations. For use by controllers that already have static mappings
517 * to insert in to the domain.
519 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
522 * 0 is returned upon success, while any failure to establish a static
523 * mapping is treated as an error.
525 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
526 irq_hw_number_t hwirq_base, int count)
528 struct device_node *of_node;
531 of_node = irq_domain_get_of_node(domain);
532 ret = irq_alloc_descs(irq_base, irq_base, count,
533 of_node_to_nid(of_node));
534 if (unlikely(ret < 0))
537 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
540 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
542 static int irq_domain_translate(struct irq_domain *d,
543 struct irq_fwspec *fwspec,
544 irq_hw_number_t *hwirq, unsigned int *type)
546 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
547 if (d->ops->translate)
548 return d->ops->translate(d, fwspec, hwirq, type);
551 return d->ops->xlate(d, to_of_node(fwspec->fwnode),
552 fwspec->param, fwspec->param_count,
555 /* If domain has no translation, then we assume interrupt line */
556 *hwirq = fwspec->param[0];
560 static void of_phandle_args_to_fwspec(struct of_phandle_args *irq_data,
561 struct irq_fwspec *fwspec)
565 fwspec->fwnode = irq_data->np ? &irq_data->np->fwnode : NULL;
566 fwspec->param_count = irq_data->args_count;
568 for (i = 0; i < irq_data->args_count; i++)
569 fwspec->param[i] = irq_data->args[i];
572 unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec)
574 struct irq_domain *domain;
575 irq_hw_number_t hwirq;
576 unsigned int type = IRQ_TYPE_NONE;
579 if (fwspec->fwnode) {
580 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_WIRED);
582 domain = irq_find_matching_fwspec(fwspec, DOMAIN_BUS_ANY);
584 domain = irq_default_domain;
588 pr_warn("no irq domain found for %s !\n",
589 of_node_full_name(to_of_node(fwspec->fwnode)));
593 if (irq_domain_translate(domain, fwspec, &hwirq, &type))
596 if (irq_domain_is_hierarchy(domain)) {
598 * If we've already configured this interrupt,
599 * don't do it again, or hell will break loose.
601 virq = irq_find_mapping(domain, hwirq);
605 virq = irq_domain_alloc_irqs(domain, 1, NUMA_NO_NODE, fwspec);
610 virq = irq_create_mapping(domain, hwirq);
615 /* Set type if specified and different than the current one */
616 if (type != IRQ_TYPE_NONE &&
617 type != irq_get_trigger_type(virq))
618 irq_set_irq_type(virq, type);
621 EXPORT_SYMBOL_GPL(irq_create_fwspec_mapping);
623 unsigned int irq_create_of_mapping(struct of_phandle_args *irq_data)
625 struct irq_fwspec fwspec;
627 of_phandle_args_to_fwspec(irq_data, &fwspec);
628 return irq_create_fwspec_mapping(&fwspec);
630 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
633 * irq_dispose_mapping() - Unmap an interrupt
634 * @virq: linux irq number of the interrupt to unmap
636 void irq_dispose_mapping(unsigned int virq)
638 struct irq_data *irq_data = irq_get_irq_data(virq);
639 struct irq_domain *domain;
641 if (!virq || !irq_data)
644 domain = irq_data->domain;
645 if (WARN_ON(domain == NULL))
648 irq_domain_disassociate(domain, virq);
651 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
654 * irq_find_mapping() - Find a linux irq from an hw irq number.
655 * @domain: domain owning this hardware interrupt
656 * @hwirq: hardware irq number in that domain space
658 unsigned int irq_find_mapping(struct irq_domain *domain,
659 irq_hw_number_t hwirq)
661 struct irq_data *data;
663 /* Look for default domain if nececssary */
665 domain = irq_default_domain;
669 if (hwirq < domain->revmap_direct_max_irq) {
670 data = irq_domain_get_irq_data(domain, hwirq);
671 if (data && data->hwirq == hwirq)
675 /* Check if the hwirq is in the linear revmap. */
676 if (hwirq < domain->revmap_size)
677 return domain->linear_revmap[hwirq];
680 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
682 return data ? data->irq : 0;
684 EXPORT_SYMBOL_GPL(irq_find_mapping);
686 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
687 static int virq_debug_show(struct seq_file *m, void *private)
690 struct irq_desc *desc;
691 struct irq_domain *domain;
692 struct radix_tree_iter iter;
696 seq_printf(m, " %-16s %-6s %-10s %-10s %s\n",
697 "name", "mapped", "linear-max", "direct-max", "devtree-node");
698 mutex_lock(&irq_domain_mutex);
699 list_for_each_entry(domain, &irq_domain_list, link) {
700 struct device_node *of_node;
702 of_node = irq_domain_get_of_node(domain);
703 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
705 seq_printf(m, "%c%-16s %6u %10u %10u %s\n",
706 domain == irq_default_domain ? '*' : ' ', domain->name,
707 domain->revmap_size + count, domain->revmap_size,
708 domain->revmap_direct_max_irq,
709 of_node ? of_node_full_name(of_node) : "");
711 mutex_unlock(&irq_domain_mutex);
713 seq_printf(m, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
714 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
715 "active", "type", "domain");
717 for (i = 1; i < nr_irqs; i++) {
718 desc = irq_to_desc(i);
722 raw_spin_lock_irqsave(&desc->lock, flags);
723 domain = desc->irq_data.domain;
726 struct irq_chip *chip;
727 int hwirq = desc->irq_data.hwirq;
730 seq_printf(m, "%5d ", i);
731 seq_printf(m, "0x%05x ", hwirq);
733 chip = irq_desc_get_chip(desc);
734 seq_printf(m, "%-15s ", (chip && chip->name) ? chip->name : "none");
736 data = irq_desc_get_chip_data(desc);
737 seq_printf(m, data ? "0x%p " : " %p ", data);
739 seq_printf(m, " %c ", (desc->action && desc->action->handler) ? '*' : ' ');
740 direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
741 seq_printf(m, "%6s%-8s ",
742 (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
743 direct ? "(DIRECT)" : "");
744 seq_printf(m, "%s\n", desc->irq_data.domain->name);
747 raw_spin_unlock_irqrestore(&desc->lock, flags);
753 static int virq_debug_open(struct inode *inode, struct file *file)
755 return single_open(file, virq_debug_show, inode->i_private);
758 static const struct file_operations virq_debug_fops = {
759 .open = virq_debug_open,
762 .release = single_release,
765 static int __init irq_debugfs_init(void)
767 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
768 NULL, &virq_debug_fops) == NULL)
773 __initcall(irq_debugfs_init);
774 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
777 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
779 * Device Tree IRQ specifier translation function which works with one cell
780 * bindings where the cell value maps directly to the hwirq number.
782 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
783 const u32 *intspec, unsigned int intsize,
784 unsigned long *out_hwirq, unsigned int *out_type)
786 if (WARN_ON(intsize < 1))
788 *out_hwirq = intspec[0];
789 *out_type = IRQ_TYPE_NONE;
792 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
795 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
797 * Device Tree IRQ specifier translation function which works with two cell
798 * bindings where the cell values map directly to the hwirq number
799 * and linux irq flags.
801 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
802 const u32 *intspec, unsigned int intsize,
803 irq_hw_number_t *out_hwirq, unsigned int *out_type)
805 if (WARN_ON(intsize < 2))
807 *out_hwirq = intspec[0];
808 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
811 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
814 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
816 * Device Tree IRQ specifier translation function which works with either one
817 * or two cell bindings where the cell values map directly to the hwirq number
818 * and linux irq flags.
820 * Note: don't use this function unless your interrupt controller explicitly
821 * supports both one and two cell bindings. For the majority of controllers
822 * the _onecell() or _twocell() variants above should be used.
824 int irq_domain_xlate_onetwocell(struct irq_domain *d,
825 struct device_node *ctrlr,
826 const u32 *intspec, unsigned int intsize,
827 unsigned long *out_hwirq, unsigned int *out_type)
829 if (WARN_ON(intsize < 1))
831 *out_hwirq = intspec[0];
832 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
835 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
837 const struct irq_domain_ops irq_domain_simple_ops = {
838 .xlate = irq_domain_xlate_onetwocell,
840 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
842 static int irq_domain_alloc_descs(int virq, unsigned int cnt,
843 irq_hw_number_t hwirq, int node)
848 virq = irq_alloc_descs(virq, virq, cnt, node);
850 hint = hwirq % nr_irqs;
853 virq = irq_alloc_descs_from(hint, cnt, node);
854 if (virq <= 0 && hint > 1)
855 virq = irq_alloc_descs_from(1, cnt, node);
861 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
863 * irq_domain_create_hierarchy - Add a irqdomain into the hierarchy
864 * @parent: Parent irq domain to associate with the new domain
865 * @flags: Irq domain flags associated to the domain
866 * @size: Size of the domain. See below
867 * @fwnode: Optional fwnode of the interrupt controller
868 * @ops: Pointer to the interrupt domain callbacks
869 * @host_data: Controller private data pointer
871 * If @size is 0 a tree domain is created, otherwise a linear domain.
873 * If successful the parent is associated to the new domain and the
874 * domain flags are set.
875 * Returns pointer to IRQ domain, or NULL on failure.
877 struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
880 struct fwnode_handle *fwnode,
881 const struct irq_domain_ops *ops,
884 struct irq_domain *domain;
887 domain = irq_domain_create_linear(fwnode, size, ops, host_data);
889 domain = irq_domain_create_tree(fwnode, ops, host_data);
891 domain->parent = parent;
892 domain->flags |= flags;
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)
1024 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
1025 * @domain: Interrupt domain to match
1027 * @hwirq: The hwirq number
1028 * @chip: The associated interrupt chip
1029 * @chip_data: The associated chip data
1031 int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, unsigned int virq,
1032 irq_hw_number_t hwirq, struct irq_chip *chip,
1035 struct irq_data *irq_data = irq_domain_get_irq_data(domain, virq);
1040 irq_data->hwirq = hwirq;
1041 irq_data->chip = chip ? chip : &no_irq_chip;
1042 irq_data->chip_data = chip_data;
1048 * irq_domain_set_info - Set the complete data for a @virq in @domain
1049 * @domain: Interrupt domain to match
1051 * @hwirq: The hardware interrupt number
1052 * @chip: The associated interrupt chip
1053 * @chip_data: The associated interrupt chip data
1054 * @handler: The interrupt flow handler
1055 * @handler_data: The interrupt flow handler data
1056 * @handler_name: The interrupt handler name
1058 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1059 irq_hw_number_t hwirq, struct irq_chip *chip,
1060 void *chip_data, irq_flow_handler_t handler,
1061 void *handler_data, const char *handler_name)
1063 irq_domain_set_hwirq_and_chip(domain, virq, hwirq, chip, chip_data);
1064 __irq_set_handler(virq, handler, 0, handler_name);
1065 irq_set_handler_data(virq, handler_data);
1069 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
1070 * @irq_data: The pointer to irq_data
1072 void irq_domain_reset_irq_data(struct irq_data *irq_data)
1074 irq_data->hwirq = 0;
1075 irq_data->chip = &no_irq_chip;
1076 irq_data->chip_data = NULL;
1080 * irq_domain_free_irqs_common - Clear irq_data and free the parent
1081 * @domain: Interrupt domain to match
1082 * @virq: IRQ number to start with
1083 * @nr_irqs: The number of irqs to free
1085 void irq_domain_free_irqs_common(struct irq_domain *domain, unsigned int virq,
1086 unsigned int nr_irqs)
1088 struct irq_data *irq_data;
1091 for (i = 0; i < nr_irqs; i++) {
1092 irq_data = irq_domain_get_irq_data(domain, virq + i);
1094 irq_domain_reset_irq_data(irq_data);
1096 irq_domain_free_irqs_parent(domain, virq, nr_irqs);
1100 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
1101 * @domain: Interrupt domain to match
1102 * @virq: IRQ number to start with
1103 * @nr_irqs: The number of irqs to free
1105 void irq_domain_free_irqs_top(struct irq_domain *domain, unsigned int virq,
1106 unsigned int nr_irqs)
1110 for (i = 0; i < nr_irqs; i++) {
1111 irq_set_handler_data(virq + i, NULL);
1112 irq_set_handler(virq + i, NULL);
1114 irq_domain_free_irqs_common(domain, virq, nr_irqs);
1117 static bool irq_domain_is_auto_recursive(struct irq_domain *domain)
1119 return domain->flags & IRQ_DOMAIN_FLAG_AUTO_RECURSIVE;
1122 static void irq_domain_free_irqs_recursive(struct irq_domain *domain,
1123 unsigned int irq_base,
1124 unsigned int nr_irqs)
1126 domain->ops->free(domain, irq_base, nr_irqs);
1127 if (irq_domain_is_auto_recursive(domain)) {
1128 BUG_ON(!domain->parent);
1129 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1134 static int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
1135 unsigned int irq_base,
1136 unsigned int nr_irqs, void *arg)
1139 struct irq_domain *parent = domain->parent;
1140 bool recursive = irq_domain_is_auto_recursive(domain);
1142 BUG_ON(recursive && !parent);
1144 ret = irq_domain_alloc_irqs_recursive(parent, irq_base,
1147 ret = domain->ops->alloc(domain, irq_base, nr_irqs, arg);
1148 if (ret < 0 && recursive)
1149 irq_domain_free_irqs_recursive(parent, irq_base, nr_irqs);
1155 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1156 * @domain: domain to allocate from
1157 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1158 * @nr_irqs: number of IRQs to allocate
1159 * @node: NUMA node id for memory allocation
1160 * @arg: domain specific argument
1161 * @realloc: IRQ descriptors have already been allocated if true
1163 * Allocate IRQ numbers and initialized all data structures to support
1164 * hierarchy IRQ domains.
1165 * Parameter @realloc is mainly to support legacy IRQs.
1166 * Returns error code or allocated IRQ number
1168 * The whole process to setup an IRQ has been split into two steps.
1169 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1170 * descriptor and required hardware resources. The second step,
1171 * irq_domain_activate_irq(), is to program hardwares with preallocated
1172 * resources. In this way, it's easier to rollback when failing to
1173 * allocate resources.
1175 int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
1176 unsigned int nr_irqs, int node, void *arg,
1181 if (domain == NULL) {
1182 domain = irq_default_domain;
1183 if (WARN(!domain, "domain is NULL; cannot allocate IRQ\n"))
1187 if (!domain->ops->alloc) {
1188 pr_debug("domain->ops->alloc() is NULL\n");
1192 if (realloc && irq_base >= 0) {
1195 virq = irq_domain_alloc_descs(irq_base, nr_irqs, 0, node);
1197 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1203 if (irq_domain_alloc_irq_data(domain, virq, nr_irqs)) {
1204 pr_debug("cannot allocate memory for IRQ%d\n", virq);
1209 mutex_lock(&irq_domain_mutex);
1210 ret = irq_domain_alloc_irqs_recursive(domain, virq, nr_irqs, arg);
1212 mutex_unlock(&irq_domain_mutex);
1213 goto out_free_irq_data;
1215 for (i = 0; i < nr_irqs; i++)
1216 irq_domain_insert_irq(virq + i);
1217 mutex_unlock(&irq_domain_mutex);
1222 irq_domain_free_irq_data(virq, nr_irqs);
1224 irq_free_descs(virq, nr_irqs);
1229 * irq_domain_free_irqs - Free IRQ number and associated data structures
1230 * @virq: base IRQ number
1231 * @nr_irqs: number of IRQs to free
1233 void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs)
1235 struct irq_data *data = irq_get_irq_data(virq);
1238 if (WARN(!data || !data->domain || !data->domain->ops->free,
1239 "NULL pointer, cannot free irq\n"))
1242 mutex_lock(&irq_domain_mutex);
1243 for (i = 0; i < nr_irqs; i++)
1244 irq_domain_remove_irq(virq + i);
1245 irq_domain_free_irqs_recursive(data->domain, virq, nr_irqs);
1246 mutex_unlock(&irq_domain_mutex);
1248 irq_domain_free_irq_data(virq, nr_irqs);
1249 irq_free_descs(virq, nr_irqs);
1253 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1254 * @irq_base: Base IRQ number
1255 * @nr_irqs: Number of IRQs to allocate
1256 * @arg: Allocation data (arch/domain specific)
1258 * Check whether the domain has been setup recursive. If not allocate
1259 * through the parent domain.
1261 int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
1262 unsigned int irq_base, unsigned int nr_irqs,
1265 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1266 if (irq_domain_is_auto_recursive(domain))
1269 domain = domain->parent;
1271 return irq_domain_alloc_irqs_recursive(domain, irq_base,
1277 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1278 * @irq_base: Base IRQ number
1279 * @nr_irqs: Number of IRQs to free
1281 * Check whether the domain has been setup recursive. If not free
1282 * through the parent domain.
1284 void irq_domain_free_irqs_parent(struct irq_domain *domain,
1285 unsigned int irq_base, unsigned int nr_irqs)
1287 /* irq_domain_free_irqs_recursive() will call parent's free */
1288 if (!irq_domain_is_auto_recursive(domain) && domain->parent)
1289 irq_domain_free_irqs_recursive(domain->parent, irq_base,
1294 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1296 * @irq_data: outermost irq_data associated with interrupt
1298 * This is the second step to call domain_ops->activate to program interrupt
1299 * controllers, so the interrupt could actually get delivered.
1301 void irq_domain_activate_irq(struct irq_data *irq_data)
1303 if (irq_data && irq_data->domain) {
1304 struct irq_domain *domain = irq_data->domain;
1306 if (irq_data->parent_data)
1307 irq_domain_activate_irq(irq_data->parent_data);
1308 if (domain->ops->activate)
1309 domain->ops->activate(domain, irq_data);
1314 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1315 * deactivate interrupt
1316 * @irq_data: outermost irq_data associated with interrupt
1318 * It calls domain_ops->deactivate to program interrupt controllers to disable
1319 * interrupt delivery.
1321 void irq_domain_deactivate_irq(struct irq_data *irq_data)
1323 if (irq_data && irq_data->domain) {
1324 struct irq_domain *domain = irq_data->domain;
1326 if (domain->ops->deactivate)
1327 domain->ops->deactivate(domain, irq_data);
1328 if (irq_data->parent_data)
1329 irq_domain_deactivate_irq(irq_data->parent_data);
1333 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1335 /* Hierarchy irq_domains must implement callback alloc() */
1336 if (domain->ops->alloc)
1337 domain->flags |= IRQ_DOMAIN_FLAG_HIERARCHY;
1339 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1341 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1342 * @domain: domain to match
1343 * @virq: IRQ number to get irq_data
1345 struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
1348 struct irq_data *irq_data = irq_get_irq_data(virq);
1350 return (irq_data && irq_data->domain == domain) ? irq_data : NULL;
1354 * irq_domain_set_info - Set the complete data for a @virq in @domain
1355 * @domain: Interrupt domain to match
1357 * @hwirq: The hardware interrupt number
1358 * @chip: The associated interrupt chip
1359 * @chip_data: The associated interrupt chip data
1360 * @handler: The interrupt flow handler
1361 * @handler_data: The interrupt flow handler data
1362 * @handler_name: The interrupt handler name
1364 void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
1365 irq_hw_number_t hwirq, struct irq_chip *chip,
1366 void *chip_data, irq_flow_handler_t handler,
1367 void *handler_data, const char *handler_name)
1369 irq_set_chip_and_handler_name(virq, chip, handler, handler_name);
1370 irq_set_chip_data(virq, chip_data);
1371 irq_set_handler_data(virq, handler_data);
1374 static void irq_domain_check_hierarchy(struct irq_domain *domain)
1377 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */