1 #include <linux/debugfs.h>
2 #include <linux/hardirq.h>
3 #include <linux/interrupt.h>
5 #include <linux/irqdesc.h>
6 #include <linux/irqdomain.h>
7 #include <linux/module.h>
8 #include <linux/mutex.h>
10 #include <linux/of_address.h>
11 #include <linux/seq_file.h>
12 #include <linux/slab.h>
13 #include <linux/smp.h>
16 #define IRQ_DOMAIN_MAP_LEGACY 0 /* driver allocated fixed range of irqs.
17 * ie. legacy 8259, gets irqs 1..15 */
18 #define IRQ_DOMAIN_MAP_NOMAP 1 /* no fast reverse mapping */
19 #define IRQ_DOMAIN_MAP_LINEAR 2 /* linear map of interrupts */
20 #define IRQ_DOMAIN_MAP_TREE 3 /* radix tree */
22 static LIST_HEAD(irq_domain_list);
23 static DEFINE_MUTEX(irq_domain_mutex);
25 static DEFINE_MUTEX(revmap_trees_mutex);
26 static unsigned int irq_virq_count = NR_IRQS;
27 static struct irq_domain *irq_default_domain;
30 * irq_domain_alloc() - Allocate a new irq_domain data structure
31 * @of_node: optional device-tree node of the interrupt controller
32 * @revmap_type: type of reverse mapping to use
33 * @ops: map/unmap domain callbacks
34 * @host_data: Controller private data pointer
36 * Allocates and initialize and irq_domain structure. Caller is expected to
37 * register allocated irq_domain with irq_domain_register(). Returns pointer
38 * to IRQ domain, or NULL on failure.
40 static struct irq_domain *irq_domain_alloc(struct device_node *of_node,
41 unsigned int revmap_type,
42 const struct irq_domain_ops *ops,
45 struct irq_domain *domain;
47 domain = kzalloc(sizeof(*domain), GFP_KERNEL);
52 domain->revmap_type = revmap_type;
54 domain->host_data = host_data;
55 domain->of_node = of_node_get(of_node);
60 static void irq_domain_add(struct irq_domain *domain)
62 mutex_lock(&irq_domain_mutex);
63 list_add(&domain->link, &irq_domain_list);
64 mutex_unlock(&irq_domain_mutex);
65 pr_debug("irq: Allocated domain of type %d @0x%p\n",
66 domain->revmap_type, domain);
69 static unsigned int irq_domain_legacy_revmap(struct irq_domain *domain,
70 irq_hw_number_t hwirq)
72 irq_hw_number_t first_hwirq = domain->revmap_data.legacy.first_hwirq;
73 int size = domain->revmap_data.legacy.size;
75 if (WARN_ON(hwirq < first_hwirq || hwirq >= first_hwirq + size))
77 return hwirq - first_hwirq + domain->revmap_data.legacy.first_irq;
81 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
82 * @of_node: pointer to interrupt controller's device tree node.
83 * @size: total number of irqs in legacy mapping
84 * @first_irq: first number of irq block assigned to the domain
85 * @first_hwirq: first hwirq number to use for the translation. Should normally
86 * be '0', but a positive integer can be used if the effective
87 * hwirqs numbering does not begin at zero.
88 * @ops: map/unmap domain callbacks
89 * @host_data: Controller private data pointer
91 * Note: the map() callback will be called before this function returns
92 * for all legacy interrupts except 0 (which is always the invalid irq for
93 * a legacy controller).
95 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
97 unsigned int first_irq,
98 irq_hw_number_t first_hwirq,
99 const struct irq_domain_ops *ops,
102 struct irq_domain *domain;
105 domain = irq_domain_alloc(of_node, IRQ_DOMAIN_MAP_LEGACY, ops, host_data);
109 domain->revmap_data.legacy.first_irq = first_irq;
110 domain->revmap_data.legacy.first_hwirq = first_hwirq;
111 domain->revmap_data.legacy.size = size;
113 mutex_lock(&irq_domain_mutex);
114 /* Verify that all the irqs are available */
115 for (i = 0; i < size; i++) {
116 int irq = first_irq + i;
117 struct irq_data *irq_data = irq_get_irq_data(irq);
119 if (WARN_ON(!irq_data || irq_data->domain)) {
120 mutex_unlock(&irq_domain_mutex);
121 of_node_put(domain->of_node);
127 /* Claim all of the irqs before registering a legacy domain */
128 for (i = 0; i < size; i++) {
129 struct irq_data *irq_data = irq_get_irq_data(first_irq + i);
130 irq_data->hwirq = first_hwirq + i;
131 irq_data->domain = domain;
133 mutex_unlock(&irq_domain_mutex);
135 for (i = 0; i < size; i++) {
136 int irq = first_irq + i;
137 int hwirq = first_hwirq + i;
139 /* IRQ0 gets ignored */
143 /* Legacy flags are left to default at this point,
144 * one can then use irq_create_mapping() to
145 * explicitly change them
147 ops->map(domain, irq, hwirq);
149 /* Clear norequest flags */
150 irq_clear_status_flags(irq, IRQ_NOREQUEST);
153 irq_domain_add(domain);
158 * irq_domain_add_linear() - Allocate and register a legacy revmap irq_domain.
159 * @of_node: pointer to interrupt controller's device tree node.
160 * @ops: map/unmap domain callbacks
161 * @host_data: Controller private data pointer
163 struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
165 const struct irq_domain_ops *ops,
168 struct irq_domain *domain;
169 unsigned int *revmap;
171 revmap = kzalloc(sizeof(*revmap) * size, GFP_KERNEL);
172 if (WARN_ON(!revmap))
175 domain = irq_domain_alloc(of_node, IRQ_DOMAIN_MAP_LINEAR, ops, host_data);
180 domain->revmap_data.linear.size = size;
181 domain->revmap_data.linear.revmap = revmap;
182 irq_domain_add(domain);
186 struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
187 const struct irq_domain_ops *ops,
190 struct irq_domain *domain = irq_domain_alloc(of_node,
191 IRQ_DOMAIN_MAP_NOMAP, ops, host_data);
193 irq_domain_add(domain);
198 * irq_domain_add_tree()
199 * @of_node: pointer to interrupt controller's device tree node.
200 * @ops: map/unmap domain callbacks
202 * Note: The radix tree will be allocated later during boot automatically
203 * (the reverse mapping will use the slow path until that happens).
205 struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
206 const struct irq_domain_ops *ops,
209 struct irq_domain *domain = irq_domain_alloc(of_node,
210 IRQ_DOMAIN_MAP_TREE, ops, host_data);
212 INIT_RADIX_TREE(&domain->revmap_data.tree, GFP_KERNEL);
213 irq_domain_add(domain);
219 * irq_find_host() - Locates a domain for a given device node
220 * @node: device-tree node of the interrupt controller
222 struct irq_domain *irq_find_host(struct device_node *node)
224 struct irq_domain *h, *found = NULL;
227 /* We might want to match the legacy controller last since
228 * it might potentially be set to match all interrupts in
229 * the absence of a device node. This isn't a problem so far
232 mutex_lock(&irq_domain_mutex);
233 list_for_each_entry(h, &irq_domain_list, link) {
235 rc = h->ops->match(h, node);
237 rc = (h->of_node != NULL) && (h->of_node == node);
244 mutex_unlock(&irq_domain_mutex);
247 EXPORT_SYMBOL_GPL(irq_find_host);
250 * irq_set_default_host() - Set a "default" irq domain
251 * @domain: default domain pointer
253 * For convenience, it's possible to set a "default" domain that will be used
254 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
255 * platforms that want to manipulate a few hard coded interrupt numbers that
256 * aren't properly represented in the device-tree.
258 void irq_set_default_host(struct irq_domain *domain)
260 pr_debug("irq: Default domain set to @0x%p\n", domain);
262 irq_default_domain = domain;
266 * irq_set_virq_count() - Set the maximum number of linux irqs
267 * @count: number of linux irqs, capped with NR_IRQS
269 * This is mainly for use by platforms like iSeries who want to program
270 * the virtual irq number in the controller to avoid the reverse mapping
272 void irq_set_virq_count(unsigned int count)
274 pr_debug("irq: Trying to set virq count to %d\n", count);
276 BUG_ON(count < NUM_ISA_INTERRUPTS);
278 irq_virq_count = count;
281 static int irq_setup_virq(struct irq_domain *domain, unsigned int virq,
282 irq_hw_number_t hwirq)
284 struct irq_data *irq_data = irq_get_irq_data(virq);
286 irq_data->hwirq = hwirq;
287 irq_data->domain = domain;
288 if (domain->ops->map(domain, virq, hwirq)) {
289 pr_debug("irq: -> mapping failed, freeing\n");
290 irq_data->domain = NULL;
295 irq_clear_status_flags(virq, IRQ_NOREQUEST);
301 * irq_create_direct_mapping() - Allocate an irq for direct mapping
302 * @domain: domain to allocate the irq for or NULL for default domain
304 * This routine is used for irq controllers which can choose the hardware
305 * interrupt numbers they generate. In such a case it's simplest to use
306 * the linux irq as the hardware interrupt number.
308 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
313 domain = irq_default_domain;
315 BUG_ON(domain == NULL);
316 WARN_ON(domain->revmap_type != IRQ_DOMAIN_MAP_NOMAP);
318 virq = irq_alloc_desc_from(1, 0);
320 pr_debug("irq: create_direct virq allocation failed\n");
323 if (virq >= irq_virq_count) {
324 pr_err("ERROR: no free irqs available below %i maximum\n",
330 pr_debug("irq: create_direct obtained virq %d\n", virq);
332 if (irq_setup_virq(domain, virq, virq)) {
341 * irq_create_mapping() - Map a hardware interrupt into linux irq space
342 * @domain: domain owning this hardware interrupt or NULL for default domain
343 * @hwirq: hardware irq number in that domain space
345 * Only one mapping per hardware interrupt is permitted. Returns a linux
347 * If the sense/trigger is to be specified, set_irq_type() should be called
348 * on the number returned from that call.
350 unsigned int irq_create_mapping(struct irq_domain *domain,
351 irq_hw_number_t hwirq)
356 pr_debug("irq: irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
358 /* Look for default domain if nececssary */
360 domain = irq_default_domain;
361 if (domain == NULL) {
362 printk(KERN_WARNING "irq_create_mapping called for"
363 " NULL domain, hwirq=%lx\n", hwirq);
367 pr_debug("irq: -> using domain @%p\n", domain);
369 /* Check if mapping already exists */
370 virq = irq_find_mapping(domain, hwirq);
372 pr_debug("irq: -> existing mapping on virq %d\n", virq);
376 /* Get a virtual interrupt number */
377 if (domain->revmap_type == IRQ_DOMAIN_MAP_LEGACY)
378 return irq_domain_legacy_revmap(domain, hwirq);
380 /* Allocate a virtual interrupt number */
381 hint = hwirq % irq_virq_count;
384 virq = irq_alloc_desc_from(hint, 0);
386 virq = irq_alloc_desc_from(1, 0);
388 pr_debug("irq: -> virq allocation failed\n");
392 if (irq_setup_virq(domain, virq, hwirq)) {
393 if (domain->revmap_type != IRQ_DOMAIN_MAP_LEGACY)
398 pr_debug("irq: irq %lu on domain %s mapped to virtual irq %u\n",
399 hwirq, domain->of_node ? domain->of_node->full_name : "null", virq);
403 EXPORT_SYMBOL_GPL(irq_create_mapping);
405 unsigned int irq_create_of_mapping(struct device_node *controller,
406 const u32 *intspec, unsigned int intsize)
408 struct irq_domain *domain;
409 irq_hw_number_t hwirq;
410 unsigned int type = IRQ_TYPE_NONE;
413 domain = controller ? irq_find_host(controller) : irq_default_domain;
417 * Workaround to avoid breaking interrupt controller drivers
418 * that don't yet register an irq_domain. This is temporary
419 * code. ~~~gcl, Feb 24, 2012
421 * Scheduled for removal in Linux v3.6. That should be enough
427 printk(KERN_WARNING "irq: no irq domain found for %s !\n",
428 controller->full_name);
432 /* If domain has no translation, then we assume interrupt line */
433 if (domain->ops->xlate == NULL)
436 if (domain->ops->xlate(domain, controller, intspec, intsize,
442 virq = irq_create_mapping(domain, hwirq);
446 /* Set type if specified and different than the current one */
447 if (type != IRQ_TYPE_NONE &&
448 type != (irqd_get_trigger_type(irq_get_irq_data(virq))))
449 irq_set_irq_type(virq, type);
452 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
455 * irq_dispose_mapping() - Unmap an interrupt
456 * @virq: linux irq number of the interrupt to unmap
458 void irq_dispose_mapping(unsigned int virq)
460 struct irq_data *irq_data = irq_get_irq_data(virq);
461 struct irq_domain *domain;
462 irq_hw_number_t hwirq;
464 if (!virq || !irq_data)
467 domain = irq_data->domain;
468 if (WARN_ON(domain == NULL))
471 /* Never unmap legacy interrupts */
472 if (domain->revmap_type == IRQ_DOMAIN_MAP_LEGACY)
475 irq_set_status_flags(virq, IRQ_NOREQUEST);
477 /* remove chip and handler */
478 irq_set_chip_and_handler(virq, NULL, NULL);
480 /* Make sure it's completed */
481 synchronize_irq(virq);
483 /* Tell the PIC about it */
484 if (domain->ops->unmap)
485 domain->ops->unmap(domain, virq);
488 /* Clear reverse map */
489 hwirq = irq_data->hwirq;
490 switch(domain->revmap_type) {
491 case IRQ_DOMAIN_MAP_LINEAR:
492 if (hwirq < domain->revmap_data.linear.size)
493 domain->revmap_data.linear.revmap[hwirq] = 0;
495 case IRQ_DOMAIN_MAP_TREE:
496 mutex_lock(&revmap_trees_mutex);
497 radix_tree_delete(&domain->revmap_data.tree, hwirq);
498 mutex_unlock(&revmap_trees_mutex);
504 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
507 * irq_find_mapping() - Find a linux irq from an hw irq number.
508 * @domain: domain owning this hardware interrupt
509 * @hwirq: hardware irq number in that domain space
511 * This is a slow path, for use by generic code. It's expected that an
512 * irq controller implementation directly calls the appropriate low level
515 unsigned int irq_find_mapping(struct irq_domain *domain,
516 irq_hw_number_t hwirq)
519 unsigned int hint = hwirq % irq_virq_count;
521 /* Look for default domain if nececssary */
523 domain = irq_default_domain;
527 /* legacy -> bail early */
528 if (domain->revmap_type == IRQ_DOMAIN_MAP_LEGACY)
529 return irq_domain_legacy_revmap(domain, hwirq);
531 /* Slow path does a linear search of the map */
536 struct irq_data *data = irq_get_irq_data(i);
537 if (data && (data->domain == domain) && (data->hwirq == hwirq))
540 if (i >= irq_virq_count)
545 EXPORT_SYMBOL_GPL(irq_find_mapping);
548 * irq_radix_revmap_lookup() - Find a linux irq from a hw irq number.
549 * @domain: domain owning this hardware interrupt
550 * @hwirq: hardware irq number in that domain space
552 * This is a fast path, for use by irq controller code that uses radix tree
555 unsigned int irq_radix_revmap_lookup(struct irq_domain *domain,
556 irq_hw_number_t hwirq)
558 struct irq_data *irq_data;
560 if (WARN_ON_ONCE(domain->revmap_type != IRQ_DOMAIN_MAP_TREE))
561 return irq_find_mapping(domain, hwirq);
564 * Freeing an irq can delete nodes along the path to
565 * do the lookup via call_rcu.
568 irq_data = radix_tree_lookup(&domain->revmap_data.tree, hwirq);
572 * If found in radix tree, then fine.
573 * Else fallback to linear lookup - this should not happen in practice
574 * as it means that we failed to insert the node in the radix tree.
576 return irq_data ? irq_data->irq : irq_find_mapping(domain, hwirq);
580 * irq_radix_revmap_insert() - Insert a hw irq to linux irq number mapping.
581 * @domain: domain owning this hardware interrupt
582 * @virq: linux irq number
583 * @hwirq: hardware irq number in that domain space
585 * This is for use by irq controllers that use a radix tree reverse
586 * mapping for fast lookup.
588 void irq_radix_revmap_insert(struct irq_domain *domain, unsigned int virq,
589 irq_hw_number_t hwirq)
591 struct irq_data *irq_data = irq_get_irq_data(virq);
593 if (WARN_ON(domain->revmap_type != IRQ_DOMAIN_MAP_TREE))
597 mutex_lock(&revmap_trees_mutex);
598 radix_tree_insert(&domain->revmap_data.tree, hwirq, irq_data);
599 mutex_unlock(&revmap_trees_mutex);
604 * irq_linear_revmap() - Find a linux irq from a hw irq number.
605 * @domain: domain owning this hardware interrupt
606 * @hwirq: hardware irq number in that domain space
608 * This is a fast path, for use by irq controller code that uses linear
609 * revmaps. It does fallback to the slow path if the revmap doesn't exist
610 * yet and will create the revmap entry with appropriate locking
612 unsigned int irq_linear_revmap(struct irq_domain *domain,
613 irq_hw_number_t hwirq)
615 unsigned int *revmap;
617 if (WARN_ON_ONCE(domain->revmap_type != IRQ_DOMAIN_MAP_LINEAR))
618 return irq_find_mapping(domain, hwirq);
620 /* Check revmap bounds */
621 if (unlikely(hwirq >= domain->revmap_data.linear.size))
622 return irq_find_mapping(domain, hwirq);
624 /* Check if revmap was allocated */
625 revmap = domain->revmap_data.linear.revmap;
626 if (unlikely(revmap == NULL))
627 return irq_find_mapping(domain, hwirq);
629 /* Fill up revmap with slow path if no mapping found */
630 if (unlikely(!revmap[hwirq]))
631 revmap[hwirq] = irq_find_mapping(domain, hwirq);
633 return revmap[hwirq];
636 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
637 static int virq_debug_show(struct seq_file *m, void *private)
640 struct irq_desc *desc;
642 static const char none[] = "none";
646 seq_printf(m, "%-5s %-7s %-15s %-*s %s\n", "irq", "hwirq",
647 "chip name", 2 * sizeof(void *) + 2, "chip data", "domain name");
649 for (i = 1; i < nr_irqs; i++) {
650 desc = irq_to_desc(i);
654 raw_spin_lock_irqsave(&desc->lock, flags);
656 if (desc->action && desc->action->handler) {
657 struct irq_chip *chip;
659 seq_printf(m, "%5d ", i);
660 seq_printf(m, "0x%05lx ", desc->irq_data.hwirq);
662 chip = irq_desc_get_chip(desc);
663 if (chip && chip->name)
667 seq_printf(m, "%-15s ", p);
669 data = irq_desc_get_chip_data(desc);
670 seq_printf(m, data ? "0x%p " : " %p ", data);
672 if (desc->irq_data.domain && desc->irq_data.domain->of_node)
673 p = desc->irq_data.domain->of_node->full_name;
676 seq_printf(m, "%s\n", p);
679 raw_spin_unlock_irqrestore(&desc->lock, flags);
685 static int virq_debug_open(struct inode *inode, struct file *file)
687 return single_open(file, virq_debug_show, inode->i_private);
690 static const struct file_operations virq_debug_fops = {
691 .open = virq_debug_open,
694 .release = single_release,
697 static int __init irq_debugfs_init(void)
699 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
700 NULL, &virq_debug_fops) == NULL)
705 __initcall(irq_debugfs_init);
706 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
708 int irq_domain_simple_map(struct irq_domain *d, unsigned int irq,
709 irq_hw_number_t hwirq)
715 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
717 * Device Tree IRQ specifier translation function which works with one cell
718 * bindings where the cell value maps directly to the hwirq number.
720 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
721 const u32 *intspec, unsigned int intsize,
722 unsigned long *out_hwirq, unsigned int *out_type)
724 if (WARN_ON(intsize < 1))
726 *out_hwirq = intspec[0];
727 *out_type = IRQ_TYPE_NONE;
730 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
733 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
735 * Device Tree IRQ specifier translation function which works with two cell
736 * bindings where the cell values map directly to the hwirq number
737 * and linux irq flags.
739 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
740 const u32 *intspec, unsigned int intsize,
741 irq_hw_number_t *out_hwirq, unsigned int *out_type)
743 if (WARN_ON(intsize < 2))
745 *out_hwirq = intspec[0];
746 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
749 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
752 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
754 * Device Tree IRQ specifier translation function which works with either one
755 * or two cell bindings where the cell values map directly to the hwirq number
756 * and linux irq flags.
758 * Note: don't use this function unless your interrupt controller explicitly
759 * supports both one and two cell bindings. For the majority of controllers
760 * the _onecell() or _twocell() variants above should be used.
762 int irq_domain_xlate_onetwocell(struct irq_domain *d,
763 struct device_node *ctrlr,
764 const u32 *intspec, unsigned int intsize,
765 unsigned long *out_hwirq, unsigned int *out_type)
767 if (WARN_ON(intsize < 1))
769 *out_hwirq = intspec[0];
770 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
773 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
775 const struct irq_domain_ops irq_domain_simple_ops = {
776 .map = irq_domain_simple_map,
777 .xlate = irq_domain_xlate_onetwocell,
779 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);
782 void irq_domain_generate_simple(const struct of_device_id *match,
783 u64 phys_base, unsigned int irq_start)
785 struct device_node *node;
786 pr_debug("looking for phys_base=%llx, irq_start=%i\n",
787 (unsigned long long) phys_base, (int) irq_start);
788 node = of_find_matching_node_by_address(NULL, match, phys_base);
790 irq_domain_add_legacy(node, 32, irq_start, 0,
791 &irq_domain_simple_ops, NULL);
793 EXPORT_SYMBOL_GPL(irq_domain_generate_simple);