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/topology.h>
14 #include <linux/seq_file.h>
15 #include <linux/slab.h>
16 #include <linux/smp.h>
19 static LIST_HEAD(irq_domain_list);
20 static DEFINE_MUTEX(irq_domain_mutex);
22 static DEFINE_MUTEX(revmap_trees_mutex);
23 static struct irq_domain *irq_default_domain;
26 * __irq_domain_add() - Allocate a new irq_domain data structure
27 * @of_node: optional device-tree node of the interrupt controller
28 * @size: Size of linear map; 0 for radix mapping only
29 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
31 * @ops: map/unmap domain callbacks
32 * @host_data: Controller private data pointer
34 * Allocates and initialize and irq_domain structure. Caller is expected to
35 * register allocated irq_domain with irq_domain_register(). Returns pointer
36 * to IRQ domain, or NULL on failure.
38 struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
39 irq_hw_number_t hwirq_max, int direct_max,
40 const struct irq_domain_ops *ops,
43 struct irq_domain *domain;
45 domain = kzalloc_node(sizeof(*domain) + (sizeof(unsigned int) * size),
46 GFP_KERNEL, of_node_to_nid(of_node));
51 INIT_RADIX_TREE(&domain->revmap_tree, GFP_KERNEL);
53 domain->host_data = host_data;
54 domain->of_node = of_node_get(of_node);
55 domain->hwirq_max = hwirq_max;
56 domain->revmap_size = size;
57 domain->revmap_direct_max_irq = direct_max;
59 mutex_lock(&irq_domain_mutex);
60 list_add(&domain->link, &irq_domain_list);
61 mutex_unlock(&irq_domain_mutex);
63 pr_debug("Added domain %s\n", domain->name);
66 EXPORT_SYMBOL_GPL(__irq_domain_add);
69 * irq_domain_remove() - Remove an irq domain.
70 * @domain: domain to remove
72 * This routine is used to remove an irq domain. The caller must ensure
73 * that all mappings within the domain have been disposed of prior to
74 * use, depending on the revmap type.
76 void irq_domain_remove(struct irq_domain *domain)
78 mutex_lock(&irq_domain_mutex);
81 * radix_tree_delete() takes care of destroying the root
82 * node when all entries are removed. Shout if there are
85 WARN_ON(domain->revmap_tree.height);
87 list_del(&domain->link);
90 * If the going away domain is the default one, reset it.
92 if (unlikely(irq_default_domain == domain))
93 irq_set_default_host(NULL);
95 mutex_unlock(&irq_domain_mutex);
97 pr_debug("Removed domain %s\n", domain->name);
99 of_node_put(domain->of_node);
102 EXPORT_SYMBOL_GPL(irq_domain_remove);
105 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
106 * @of_node: pointer to interrupt controller's device tree node.
107 * @size: total number of irqs in mapping
108 * @first_irq: first number of irq block assigned to the domain,
109 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
110 * pre-map all of the irqs in the domain to virqs starting at first_irq.
111 * @ops: map/unmap domain callbacks
112 * @host_data: Controller private data pointer
114 * Allocates an irq_domain, and optionally if first_irq is positive then also
115 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
117 * This is intended to implement the expected behaviour for most
118 * interrupt controllers. If device tree is used, then first_irq will be 0 and
119 * irqs get mapped dynamically on the fly. However, if the controller requires
120 * static virq assignments (non-DT boot) then it will set that up correctly.
122 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
124 unsigned int first_irq,
125 const struct irq_domain_ops *ops,
128 struct irq_domain *domain;
130 domain = __irq_domain_add(of_node, size, size, 0, ops, host_data);
135 if (IS_ENABLED(CONFIG_SPARSE_IRQ)) {
136 /* attempt to allocated irq_descs */
137 int rc = irq_alloc_descs(first_irq, first_irq, size,
138 of_node_to_nid(of_node));
140 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
143 irq_domain_associate_many(domain, first_irq, 0, size);
148 EXPORT_SYMBOL_GPL(irq_domain_add_simple);
151 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
152 * @of_node: pointer to interrupt controller's device tree node.
153 * @size: total number of irqs in legacy mapping
154 * @first_irq: first number of irq block assigned to the domain
155 * @first_hwirq: first hwirq number to use for the translation. Should normally
156 * be '0', but a positive integer can be used if the effective
157 * hwirqs numbering does not begin at zero.
158 * @ops: map/unmap domain callbacks
159 * @host_data: Controller private data pointer
161 * Note: the map() callback will be called before this function returns
162 * for all legacy interrupts except 0 (which is always the invalid irq for
163 * a legacy controller).
165 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
167 unsigned int first_irq,
168 irq_hw_number_t first_hwirq,
169 const struct irq_domain_ops *ops,
172 struct irq_domain *domain;
174 domain = __irq_domain_add(of_node, first_hwirq + size,
175 first_hwirq + size, 0, ops, host_data);
179 irq_domain_associate_many(domain, first_irq, first_hwirq, size);
183 EXPORT_SYMBOL_GPL(irq_domain_add_legacy);
186 * irq_find_host() - Locates a domain for a given device node
187 * @node: device-tree node of the interrupt controller
189 struct irq_domain *irq_find_host(struct device_node *node)
191 struct irq_domain *h, *found = NULL;
194 /* We might want to match the legacy controller last since
195 * it might potentially be set to match all interrupts in
196 * the absence of a device node. This isn't a problem so far
199 mutex_lock(&irq_domain_mutex);
200 list_for_each_entry(h, &irq_domain_list, link) {
202 rc = h->ops->match(h, node);
204 rc = (h->of_node != NULL) && (h->of_node == node);
211 mutex_unlock(&irq_domain_mutex);
214 EXPORT_SYMBOL_GPL(irq_find_host);
217 * irq_set_default_host() - Set a "default" irq domain
218 * @domain: default domain pointer
220 * For convenience, it's possible to set a "default" domain that will be used
221 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
222 * platforms that want to manipulate a few hard coded interrupt numbers that
223 * aren't properly represented in the device-tree.
225 void irq_set_default_host(struct irq_domain *domain)
227 pr_debug("Default domain set to @0x%p\n", domain);
229 irq_default_domain = domain;
231 EXPORT_SYMBOL_GPL(irq_set_default_host);
233 static void irq_domain_disassociate(struct irq_domain *domain, unsigned int irq)
235 struct irq_data *irq_data = irq_get_irq_data(irq);
236 irq_hw_number_t hwirq;
238 if (WARN(!irq_data || irq_data->domain != domain,
239 "virq%i doesn't exist; cannot disassociate\n", irq))
242 hwirq = irq_data->hwirq;
243 irq_set_status_flags(irq, IRQ_NOREQUEST);
245 /* remove chip and handler */
246 irq_set_chip_and_handler(irq, NULL, NULL);
248 /* Make sure it's completed */
249 synchronize_irq(irq);
251 /* Tell the PIC about it */
252 if (domain->ops->unmap)
253 domain->ops->unmap(domain, irq);
256 irq_data->domain = NULL;
259 /* Clear reverse map for this hwirq */
260 if (hwirq < domain->revmap_size) {
261 domain->linear_revmap[hwirq] = 0;
263 mutex_lock(&revmap_trees_mutex);
264 radix_tree_delete(&domain->revmap_tree, hwirq);
265 mutex_unlock(&revmap_trees_mutex);
269 int irq_domain_associate(struct irq_domain *domain, unsigned int virq,
270 irq_hw_number_t hwirq)
272 struct irq_data *irq_data = irq_get_irq_data(virq);
275 if (WARN(hwirq >= domain->hwirq_max,
276 "error: hwirq 0x%x is too large for %s\n", (int)hwirq, domain->name))
278 if (WARN(!irq_data, "error: virq%i is not allocated", virq))
280 if (WARN(irq_data->domain, "error: virq%i is already associated", virq))
283 mutex_lock(&irq_domain_mutex);
284 irq_data->hwirq = hwirq;
285 irq_data->domain = domain;
286 if (domain->ops->map) {
287 ret = domain->ops->map(domain, virq, hwirq);
290 * If map() returns -EPERM, this interrupt is protected
291 * by the firmware or some other service and shall not
292 * be mapped. Don't bother telling the user about it.
295 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
296 domain->name, hwirq, virq, ret);
298 irq_data->domain = NULL;
300 mutex_unlock(&irq_domain_mutex);
304 /* If not already assigned, give the domain the chip's name */
305 if (!domain->name && irq_data->chip)
306 domain->name = irq_data->chip->name;
309 if (hwirq < domain->revmap_size) {
310 domain->linear_revmap[hwirq] = virq;
312 mutex_lock(&revmap_trees_mutex);
313 radix_tree_insert(&domain->revmap_tree, hwirq, irq_data);
314 mutex_unlock(&revmap_trees_mutex);
316 mutex_unlock(&irq_domain_mutex);
318 irq_clear_status_flags(virq, IRQ_NOREQUEST);
322 EXPORT_SYMBOL_GPL(irq_domain_associate);
324 void irq_domain_associate_many(struct irq_domain *domain, unsigned int irq_base,
325 irq_hw_number_t hwirq_base, int count)
329 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__,
330 of_node_full_name(domain->of_node), irq_base, (int)hwirq_base, count);
332 for (i = 0; i < count; i++) {
333 irq_domain_associate(domain, irq_base + i, hwirq_base + i);
336 EXPORT_SYMBOL_GPL(irq_domain_associate_many);
339 * irq_create_direct_mapping() - Allocate an irq for direct mapping
340 * @domain: domain to allocate the irq for or NULL for default domain
342 * This routine is used for irq controllers which can choose the hardware
343 * interrupt numbers they generate. In such a case it's simplest to use
344 * the linux irq as the hardware interrupt number. It still uses the linear
345 * or radix tree to store the mapping, but the irq controller can optimize
346 * the revmap path by using the hwirq directly.
348 unsigned int irq_create_direct_mapping(struct irq_domain *domain)
353 domain = irq_default_domain;
355 virq = irq_alloc_desc_from(1, of_node_to_nid(domain->of_node));
357 pr_debug("create_direct virq allocation failed\n");
360 if (virq >= domain->revmap_direct_max_irq) {
361 pr_err("ERROR: no free irqs available below %i maximum\n",
362 domain->revmap_direct_max_irq);
366 pr_debug("create_direct obtained virq %d\n", virq);
368 if (irq_domain_associate(domain, virq, virq)) {
375 EXPORT_SYMBOL_GPL(irq_create_direct_mapping);
378 * irq_create_mapping() - Map a hardware interrupt into linux irq space
379 * @domain: domain owning this hardware interrupt or NULL for default domain
380 * @hwirq: hardware irq number in that domain space
382 * Only one mapping per hardware interrupt is permitted. Returns a linux
384 * If the sense/trigger is to be specified, set_irq_type() should be called
385 * on the number returned from that call.
387 unsigned int irq_create_mapping(struct irq_domain *domain,
388 irq_hw_number_t hwirq)
393 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain, hwirq);
395 /* Look for default domain if nececssary */
397 domain = irq_default_domain;
398 if (domain == NULL) {
399 WARN(1, "%s(, %lx) called with NULL domain\n", __func__, hwirq);
402 pr_debug("-> using domain @%p\n", domain);
404 /* Check if mapping already exists */
405 virq = irq_find_mapping(domain, hwirq);
407 pr_debug("-> existing mapping on virq %d\n", virq);
411 /* Allocate a virtual interrupt number */
412 hint = hwirq % nr_irqs;
415 virq = irq_alloc_desc_from(hint, of_node_to_nid(domain->of_node));
417 virq = irq_alloc_desc_from(1, of_node_to_nid(domain->of_node));
419 pr_debug("-> virq allocation failed\n");
423 if (irq_domain_associate(domain, virq, hwirq)) {
428 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
429 hwirq, of_node_full_name(domain->of_node), virq);
433 EXPORT_SYMBOL_GPL(irq_create_mapping);
436 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
437 * @domain: domain owning the interrupt range
438 * @irq_base: beginning of linux IRQ range
439 * @hwirq_base: beginning of hardware IRQ range
440 * @count: Number of interrupts to map
442 * This routine is used for allocating and mapping a range of hardware
443 * irqs to linux irqs where the linux irq numbers are at pre-defined
444 * locations. For use by controllers that already have static mappings
445 * to insert in to the domain.
447 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
450 * 0 is returned upon success, while any failure to establish a static
451 * mapping is treated as an error.
453 int irq_create_strict_mappings(struct irq_domain *domain, unsigned int irq_base,
454 irq_hw_number_t hwirq_base, int count)
458 ret = irq_alloc_descs(irq_base, irq_base, count,
459 of_node_to_nid(domain->of_node));
460 if (unlikely(ret < 0))
463 irq_domain_associate_many(domain, irq_base, hwirq_base, count);
466 EXPORT_SYMBOL_GPL(irq_create_strict_mappings);
468 unsigned int irq_create_of_mapping(struct device_node *controller,
469 const u32 *intspec, unsigned int intsize)
471 struct irq_domain *domain;
472 irq_hw_number_t hwirq;
473 unsigned int type = IRQ_TYPE_NONE;
476 domain = controller ? irq_find_host(controller) : irq_default_domain;
478 pr_warn("no irq domain found for %s !\n",
479 of_node_full_name(controller));
483 /* If domain has no translation, then we assume interrupt line */
484 if (domain->ops->xlate == NULL)
487 if (domain->ops->xlate(domain, controller, intspec, intsize,
493 virq = irq_create_mapping(domain, hwirq);
497 /* Set type if specified and different than the current one */
498 if (type != IRQ_TYPE_NONE &&
499 type != irq_get_trigger_type(virq))
500 irq_set_irq_type(virq, type);
503 EXPORT_SYMBOL_GPL(irq_create_of_mapping);
506 * irq_dispose_mapping() - Unmap an interrupt
507 * @virq: linux irq number of the interrupt to unmap
509 void irq_dispose_mapping(unsigned int virq)
511 struct irq_data *irq_data = irq_get_irq_data(virq);
512 struct irq_domain *domain;
514 if (!virq || !irq_data)
517 domain = irq_data->domain;
518 if (WARN_ON(domain == NULL))
521 irq_domain_disassociate(domain, virq);
524 EXPORT_SYMBOL_GPL(irq_dispose_mapping);
527 * irq_find_mapping() - Find a linux irq from an hw irq number.
528 * @domain: domain owning this hardware interrupt
529 * @hwirq: hardware irq number in that domain space
531 unsigned int irq_find_mapping(struct irq_domain *domain,
532 irq_hw_number_t hwirq)
534 struct irq_data *data;
536 /* Look for default domain if nececssary */
538 domain = irq_default_domain;
542 if (hwirq < domain->revmap_direct_max_irq) {
543 data = irq_get_irq_data(hwirq);
544 if (data && (data->domain == domain) && (data->hwirq == hwirq))
548 /* Check if the hwirq is in the linear revmap. */
549 if (hwirq < domain->revmap_size)
550 return domain->linear_revmap[hwirq];
553 data = radix_tree_lookup(&domain->revmap_tree, hwirq);
555 return data ? data->irq : 0;
557 EXPORT_SYMBOL_GPL(irq_find_mapping);
559 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
560 static int virq_debug_show(struct seq_file *m, void *private)
563 struct irq_desc *desc;
564 struct irq_domain *domain;
565 struct radix_tree_iter iter;
569 seq_printf(m, " %-16s %-6s %-10s %-10s %s\n",
570 "name", "mapped", "linear-max", "direct-max", "devtree-node");
571 mutex_lock(&irq_domain_mutex);
572 list_for_each_entry(domain, &irq_domain_list, link) {
574 radix_tree_for_each_slot(slot, &domain->revmap_tree, &iter, 0)
576 seq_printf(m, "%c%-16s %6u %10u %10u %s\n",
577 domain == irq_default_domain ? '*' : ' ', domain->name,
578 domain->revmap_size + count, domain->revmap_size,
579 domain->revmap_direct_max_irq,
580 domain->of_node ? of_node_full_name(domain->of_node) : "");
582 mutex_unlock(&irq_domain_mutex);
584 seq_printf(m, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
585 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
586 "active", "type", "domain");
588 for (i = 1; i < nr_irqs; i++) {
589 desc = irq_to_desc(i);
593 raw_spin_lock_irqsave(&desc->lock, flags);
594 domain = desc->irq_data.domain;
597 struct irq_chip *chip;
598 int hwirq = desc->irq_data.hwirq;
601 seq_printf(m, "%5d ", i);
602 seq_printf(m, "0x%05x ", hwirq);
604 chip = irq_desc_get_chip(desc);
605 seq_printf(m, "%-15s ", (chip && chip->name) ? chip->name : "none");
607 data = irq_desc_get_chip_data(desc);
608 seq_printf(m, data ? "0x%p " : " %p ", data);
610 seq_printf(m, " %c ", (desc->action && desc->action->handler) ? '*' : ' ');
611 direct = (i == hwirq) && (i < domain->revmap_direct_max_irq);
612 seq_printf(m, "%6s%-8s ",
613 (hwirq < domain->revmap_size) ? "LINEAR" : "RADIX",
614 direct ? "(DIRECT)" : "");
615 seq_printf(m, "%s\n", desc->irq_data.domain->name);
618 raw_spin_unlock_irqrestore(&desc->lock, flags);
624 static int virq_debug_open(struct inode *inode, struct file *file)
626 return single_open(file, virq_debug_show, inode->i_private);
629 static const struct file_operations virq_debug_fops = {
630 .open = virq_debug_open,
633 .release = single_release,
636 static int __init irq_debugfs_init(void)
638 if (debugfs_create_file("irq_domain_mapping", S_IRUGO, NULL,
639 NULL, &virq_debug_fops) == NULL)
644 __initcall(irq_debugfs_init);
645 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
648 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
650 * Device Tree IRQ specifier translation function which works with one cell
651 * bindings where the cell value maps directly to the hwirq number.
653 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
654 const u32 *intspec, unsigned int intsize,
655 unsigned long *out_hwirq, unsigned int *out_type)
657 if (WARN_ON(intsize < 1))
659 *out_hwirq = intspec[0];
660 *out_type = IRQ_TYPE_NONE;
663 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell);
666 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
668 * Device Tree IRQ specifier translation function which works with two cell
669 * bindings where the cell values map directly to the hwirq number
670 * and linux irq flags.
672 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
673 const u32 *intspec, unsigned int intsize,
674 irq_hw_number_t *out_hwirq, unsigned int *out_type)
676 if (WARN_ON(intsize < 2))
678 *out_hwirq = intspec[0];
679 *out_type = intspec[1] & IRQ_TYPE_SENSE_MASK;
682 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell);
685 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
687 * Device Tree IRQ specifier translation function which works with either one
688 * or two cell bindings where the cell values map directly to the hwirq number
689 * and linux irq flags.
691 * Note: don't use this function unless your interrupt controller explicitly
692 * supports both one and two cell bindings. For the majority of controllers
693 * the _onecell() or _twocell() variants above should be used.
695 int irq_domain_xlate_onetwocell(struct irq_domain *d,
696 struct device_node *ctrlr,
697 const u32 *intspec, unsigned int intsize,
698 unsigned long *out_hwirq, unsigned int *out_type)
700 if (WARN_ON(intsize < 1))
702 *out_hwirq = intspec[0];
703 *out_type = (intsize > 1) ? intspec[1] : IRQ_TYPE_NONE;
706 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell);
708 const struct irq_domain_ops irq_domain_simple_ops = {
709 .xlate = irq_domain_xlate_onetwocell,
711 EXPORT_SYMBOL_GPL(irq_domain_simple_ops);