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
,
39 int size
, 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
->revmap_size
= size
;
56 domain
->revmap_direct_max_irq
= direct_max
;
58 mutex_lock(&irq_domain_mutex
);
59 list_add(&domain
->link
, &irq_domain_list
);
60 mutex_unlock(&irq_domain_mutex
);
62 pr_debug("Added domain %s\n", domain
->name
);
65 EXPORT_SYMBOL_GPL(__irq_domain_add
);
68 * irq_domain_remove() - Remove an irq domain.
69 * @domain: domain to remove
71 * This routine is used to remove an irq domain. The caller must ensure
72 * that all mappings within the domain have been disposed of prior to
73 * use, depending on the revmap type.
75 void irq_domain_remove(struct irq_domain
*domain
)
77 mutex_lock(&irq_domain_mutex
);
80 * radix_tree_delete() takes care of destroying the root
81 * node when all entries are removed. Shout if there are
84 WARN_ON(domain
->revmap_tree
.height
);
86 list_del(&domain
->link
);
89 * If the going away domain is the default one, reset it.
91 if (unlikely(irq_default_domain
== domain
))
92 irq_set_default_host(NULL
);
94 mutex_unlock(&irq_domain_mutex
);
96 pr_debug("Removed domain %s\n", domain
->name
);
98 of_node_put(domain
->of_node
);
101 EXPORT_SYMBOL_GPL(irq_domain_remove
);
104 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
105 * @of_node: pointer to interrupt controller's device tree node.
106 * @size: total number of irqs in mapping
107 * @first_irq: first number of irq block assigned to the domain,
108 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
109 * pre-map all of the irqs in the domain to virqs starting at first_irq.
110 * @ops: map/unmap domain callbacks
111 * @host_data: Controller private data pointer
113 * Allocates an irq_domain, and optionally if first_irq is positive then also
114 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
116 * This is intended to implement the expected behaviour for most
117 * interrupt controllers. If device tree is used, then first_irq will be 0 and
118 * irqs get mapped dynamically on the fly. However, if the controller requires
119 * static virq assignments (non-DT boot) then it will set that up correctly.
121 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
123 unsigned int first_irq
,
124 const struct irq_domain_ops
*ops
,
127 struct irq_domain
*domain
;
129 domain
= __irq_domain_add(of_node
, size
, 0, ops
, host_data
);
134 if (IS_ENABLED(CONFIG_SPARSE_IRQ
)) {
135 /* attempt to allocated irq_descs */
136 int rc
= irq_alloc_descs(first_irq
, first_irq
, size
,
137 of_node_to_nid(of_node
));
139 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
142 WARN_ON(irq_domain_associate_many(domain
, first_irq
, 0, size
));
147 EXPORT_SYMBOL_GPL(irq_domain_add_simple
);
150 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
151 * @of_node: pointer to interrupt controller's device tree node.
152 * @size: total number of irqs in legacy mapping
153 * @first_irq: first number of irq block assigned to the domain
154 * @first_hwirq: first hwirq number to use for the translation. Should normally
155 * be '0', but a positive integer can be used if the effective
156 * hwirqs numbering does not begin at zero.
157 * @ops: map/unmap domain callbacks
158 * @host_data: Controller private data pointer
160 * Note: the map() callback will be called before this function returns
161 * for all legacy interrupts except 0 (which is always the invalid irq for
162 * a legacy controller).
164 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
166 unsigned int first_irq
,
167 irq_hw_number_t first_hwirq
,
168 const struct irq_domain_ops
*ops
,
171 struct irq_domain
*domain
;
173 domain
= __irq_domain_add(of_node
, first_hwirq
+ size
, 0, ops
, host_data
);
177 WARN_ON(irq_domain_associate_many(domain
, first_irq
, first_hwirq
, size
));
181 EXPORT_SYMBOL_GPL(irq_domain_add_legacy
);
184 * irq_find_host() - Locates a domain for a given device node
185 * @node: device-tree node of the interrupt controller
187 struct irq_domain
*irq_find_host(struct device_node
*node
)
189 struct irq_domain
*h
, *found
= NULL
;
192 /* We might want to match the legacy controller last since
193 * it might potentially be set to match all interrupts in
194 * the absence of a device node. This isn't a problem so far
197 mutex_lock(&irq_domain_mutex
);
198 list_for_each_entry(h
, &irq_domain_list
, link
) {
200 rc
= h
->ops
->match(h
, node
);
202 rc
= (h
->of_node
!= NULL
) && (h
->of_node
== node
);
209 mutex_unlock(&irq_domain_mutex
);
212 EXPORT_SYMBOL_GPL(irq_find_host
);
215 * irq_set_default_host() - Set a "default" irq domain
216 * @domain: default domain pointer
218 * For convenience, it's possible to set a "default" domain that will be used
219 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
220 * platforms that want to manipulate a few hard coded interrupt numbers that
221 * aren't properly represented in the device-tree.
223 void irq_set_default_host(struct irq_domain
*domain
)
225 pr_debug("Default domain set to @0x%p\n", domain
);
227 irq_default_domain
= domain
;
229 EXPORT_SYMBOL_GPL(irq_set_default_host
);
231 static void irq_domain_disassociate_many(struct irq_domain
*domain
,
232 unsigned int irq_base
, int count
)
235 * disassociate in reverse order;
236 * not strictly necessary, but nice for unwinding
239 int irq
= irq_base
+ count
;
240 struct irq_data
*irq_data
= irq_get_irq_data(irq
);
241 irq_hw_number_t hwirq
;
243 if (WARN_ON(!irq_data
|| irq_data
->domain
!= domain
))
246 hwirq
= irq_data
->hwirq
;
247 irq_set_status_flags(irq
, IRQ_NOREQUEST
);
249 /* remove chip and handler */
250 irq_set_chip_and_handler(irq
, NULL
, NULL
);
252 /* Make sure it's completed */
253 synchronize_irq(irq
);
255 /* Tell the PIC about it */
256 if (domain
->ops
->unmap
)
257 domain
->ops
->unmap(domain
, irq
);
260 irq_data
->domain
= NULL
;
263 /* Clear reverse map for this hwirq */
264 if (hwirq
< domain
->revmap_size
) {
265 domain
->linear_revmap
[hwirq
] = 0;
267 mutex_lock(&revmap_trees_mutex
);
268 radix_tree_delete(&domain
->revmap_tree
, hwirq
);
269 mutex_unlock(&revmap_trees_mutex
);
274 int irq_domain_associate_many(struct irq_domain
*domain
, unsigned int irq_base
,
275 irq_hw_number_t hwirq_base
, int count
)
277 unsigned int virq
= irq_base
;
278 irq_hw_number_t hwirq
= hwirq_base
;
281 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__
,
282 of_node_full_name(domain
->of_node
), irq_base
, (int)hwirq_base
, count
);
284 for (i
= 0; i
< count
; i
++) {
285 struct irq_data
*irq_data
= irq_get_irq_data(virq
+ i
);
287 if (WARN(!irq_data
, "error: irq_desc not allocated; "
288 "irq=%i hwirq=0x%x\n", virq
+ i
, (int)hwirq
+ i
))
290 if (WARN(irq_data
->domain
, "error: irq_desc already associated; "
291 "irq=%i hwirq=0x%x\n", virq
+ i
, (int)hwirq
+ i
))
295 for (i
= 0; i
< count
; i
++, virq
++, hwirq
++) {
296 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
298 irq_data
->hwirq
= hwirq
;
299 irq_data
->domain
= domain
;
300 if (domain
->ops
->map
) {
301 ret
= domain
->ops
->map(domain
, virq
, hwirq
);
304 * If map() returns -EPERM, this interrupt is protected
305 * by the firmware or some other service and shall not
306 * be mapped. Don't bother telling the user about it.
309 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
310 domain
->name
, hwirq
, virq
, ret
);
312 irq_data
->domain
= NULL
;
316 /* If not already assigned, give the domain the chip's name */
317 if (!domain
->name
&& irq_data
->chip
)
318 domain
->name
= irq_data
->chip
->name
;
321 if (hwirq
< domain
->revmap_size
) {
322 domain
->linear_revmap
[hwirq
] = virq
;
324 mutex_lock(&revmap_trees_mutex
);
325 radix_tree_insert(&domain
->revmap_tree
, hwirq
, irq_data
);
326 mutex_unlock(&revmap_trees_mutex
);
329 irq_clear_status_flags(virq
, IRQ_NOREQUEST
);
334 EXPORT_SYMBOL_GPL(irq_domain_associate_many
);
337 * irq_create_direct_mapping() - Allocate an irq for direct mapping
338 * @domain: domain to allocate the irq for or NULL for default domain
340 * This routine is used for irq controllers which can choose the hardware
341 * interrupt numbers they generate. In such a case it's simplest to use
342 * the linux irq as the hardware interrupt number. It still uses the linear
343 * or radix tree to store the mapping, but the irq controller can optimize
344 * the revmap path by using the hwirq directly.
346 unsigned int irq_create_direct_mapping(struct irq_domain
*domain
)
351 domain
= irq_default_domain
;
353 virq
= irq_alloc_desc_from(1, of_node_to_nid(domain
->of_node
));
355 pr_debug("create_direct virq allocation failed\n");
358 if (virq
>= domain
->revmap_direct_max_irq
) {
359 pr_err("ERROR: no free irqs available below %i maximum\n",
360 domain
->revmap_direct_max_irq
);
364 pr_debug("create_direct obtained virq %d\n", virq
);
366 if (irq_domain_associate(domain
, virq
, virq
)) {
373 EXPORT_SYMBOL_GPL(irq_create_direct_mapping
);
376 * irq_create_mapping() - Map a hardware interrupt into linux irq space
377 * @domain: domain owning this hardware interrupt or NULL for default domain
378 * @hwirq: hardware irq number in that domain space
380 * Only one mapping per hardware interrupt is permitted. Returns a linux
382 * If the sense/trigger is to be specified, set_irq_type() should be called
383 * on the number returned from that call.
385 unsigned int irq_create_mapping(struct irq_domain
*domain
,
386 irq_hw_number_t hwirq
)
391 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain
, hwirq
);
393 /* Look for default domain if nececssary */
395 domain
= irq_default_domain
;
396 if (domain
== NULL
) {
397 pr_warning("irq_create_mapping called for"
398 " NULL domain, hwirq=%lx\n", 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 ret
= irq_domain_associate_many(domain
, irq_base
, hwirq_base
, count
);
464 if (unlikely(ret
< 0)) {
465 irq_free_descs(irq_base
, count
);
471 EXPORT_SYMBOL_GPL(irq_create_strict_mappings
);
473 unsigned int irq_create_of_mapping(struct device_node
*controller
,
474 const u32
*intspec
, unsigned int intsize
)
476 struct irq_domain
*domain
;
477 irq_hw_number_t hwirq
;
478 unsigned int type
= IRQ_TYPE_NONE
;
481 domain
= controller
? irq_find_host(controller
) : irq_default_domain
;
485 * Workaround to avoid breaking interrupt controller drivers
486 * that don't yet register an irq_domain. This is temporary
487 * code. ~~~gcl, Feb 24, 2012
489 * Scheduled for removal in Linux v3.6. That should be enough
495 pr_warning("no irq domain found for %s !\n",
496 of_node_full_name(controller
));
500 /* If domain has no translation, then we assume interrupt line */
501 if (domain
->ops
->xlate
== NULL
)
504 if (domain
->ops
->xlate(domain
, controller
, intspec
, intsize
,
510 virq
= irq_create_mapping(domain
, hwirq
);
514 /* Set type if specified and different than the current one */
515 if (type
!= IRQ_TYPE_NONE
&&
516 type
!= (irqd_get_trigger_type(irq_get_irq_data(virq
))))
517 irq_set_irq_type(virq
, type
);
520 EXPORT_SYMBOL_GPL(irq_create_of_mapping
);
523 * irq_dispose_mapping() - Unmap an interrupt
524 * @virq: linux irq number of the interrupt to unmap
526 void irq_dispose_mapping(unsigned int virq
)
528 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
529 struct irq_domain
*domain
;
531 if (!virq
|| !irq_data
)
534 domain
= irq_data
->domain
;
535 if (WARN_ON(domain
== NULL
))
538 irq_domain_disassociate_many(domain
, virq
, 1);
541 EXPORT_SYMBOL_GPL(irq_dispose_mapping
);
544 * irq_find_mapping() - Find a linux irq from an hw irq number.
545 * @domain: domain owning this hardware interrupt
546 * @hwirq: hardware irq number in that domain space
548 unsigned int irq_find_mapping(struct irq_domain
*domain
,
549 irq_hw_number_t hwirq
)
551 struct irq_data
*data
;
553 /* Look for default domain if nececssary */
555 domain
= irq_default_domain
;
559 if (hwirq
< domain
->revmap_direct_max_irq
) {
560 data
= irq_get_irq_data(hwirq
);
561 if (data
&& (data
->domain
== domain
) && (data
->hwirq
== hwirq
))
565 return irq_linear_revmap(domain
, hwirq
);
567 EXPORT_SYMBOL_GPL(irq_find_mapping
);
570 * irq_linear_revmap() - Find a linux irq from a hw irq number.
571 * @domain: domain owning this hardware interrupt
572 * @hwirq: hardware irq number in that domain space
574 * This is a fast path that can be called directly by irq controller code to
575 * save a handful of instructions.
577 unsigned int irq_linear_revmap(struct irq_domain
*domain
,
578 irq_hw_number_t hwirq
)
580 struct irq_data
*data
;
582 /* Check revmap bounds; complain if exceeded */
583 if (hwirq
>= domain
->revmap_size
) {
585 data
= radix_tree_lookup(&domain
->revmap_tree
, hwirq
);
587 return data
? data
->irq
: 0;
590 return domain
->linear_revmap
[hwirq
];
592 EXPORT_SYMBOL_GPL(irq_linear_revmap
);
594 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
595 static int virq_debug_show(struct seq_file
*m
, void *private)
598 struct irq_desc
*desc
;
599 struct irq_domain
*domain
;
600 struct radix_tree_iter iter
;
604 seq_printf(m
, " %-16s %-6s %-10s %-10s %s\n",
605 "name", "mapped", "linear-max", "direct-max", "devtree-node");
606 mutex_lock(&irq_domain_mutex
);
607 list_for_each_entry(domain
, &irq_domain_list
, link
) {
609 radix_tree_for_each_slot(slot
, &domain
->revmap_tree
, &iter
, 0)
611 seq_printf(m
, "%c%-16s %6u %10u %10u %s\n",
612 domain
== irq_default_domain
? '*' : ' ', domain
->name
,
613 domain
->revmap_size
+ count
, domain
->revmap_size
,
614 domain
->revmap_direct_max_irq
,
615 domain
->of_node
? of_node_full_name(domain
->of_node
) : "");
617 mutex_unlock(&irq_domain_mutex
);
619 seq_printf(m
, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
620 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
621 "active", "type", "domain");
623 for (i
= 1; i
< nr_irqs
; i
++) {
624 desc
= irq_to_desc(i
);
628 raw_spin_lock_irqsave(&desc
->lock
, flags
);
629 domain
= desc
->irq_data
.domain
;
632 struct irq_chip
*chip
;
633 int hwirq
= desc
->irq_data
.hwirq
;
636 seq_printf(m
, "%5d ", i
);
637 seq_printf(m
, "0x%05x ", hwirq
);
639 chip
= irq_desc_get_chip(desc
);
640 seq_printf(m
, "%-15s ", (chip
&& chip
->name
) ? chip
->name
: "none");
642 data
= irq_desc_get_chip_data(desc
);
643 seq_printf(m
, data
? "0x%p " : " %p ", data
);
645 seq_printf(m
, " %c ", (desc
->action
&& desc
->action
->handler
) ? '*' : ' ');
646 direct
= (i
== hwirq
) && (i
< domain
->revmap_direct_max_irq
);
647 seq_printf(m
, "%6s%-8s ",
648 (hwirq
< domain
->revmap_size
) ? "LINEAR" : "RADIX",
649 direct
? "(DIRECT)" : "");
650 seq_printf(m
, "%s\n", desc
->irq_data
.domain
->name
);
653 raw_spin_unlock_irqrestore(&desc
->lock
, flags
);
659 static int virq_debug_open(struct inode
*inode
, struct file
*file
)
661 return single_open(file
, virq_debug_show
, inode
->i_private
);
664 static const struct file_operations virq_debug_fops
= {
665 .open
= virq_debug_open
,
668 .release
= single_release
,
671 static int __init
irq_debugfs_init(void)
673 if (debugfs_create_file("irq_domain_mapping", S_IRUGO
, NULL
,
674 NULL
, &virq_debug_fops
) == NULL
)
679 __initcall(irq_debugfs_init
);
680 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
683 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
685 * Device Tree IRQ specifier translation function which works with one cell
686 * bindings where the cell value maps directly to the hwirq number.
688 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
689 const u32
*intspec
, unsigned int intsize
,
690 unsigned long *out_hwirq
, unsigned int *out_type
)
692 if (WARN_ON(intsize
< 1))
694 *out_hwirq
= intspec
[0];
695 *out_type
= IRQ_TYPE_NONE
;
698 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell
);
701 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
703 * Device Tree IRQ specifier translation function which works with two cell
704 * bindings where the cell values map directly to the hwirq number
705 * and linux irq flags.
707 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
708 const u32
*intspec
, unsigned int intsize
,
709 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
)
711 if (WARN_ON(intsize
< 2))
713 *out_hwirq
= intspec
[0];
714 *out_type
= intspec
[1] & IRQ_TYPE_SENSE_MASK
;
717 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell
);
720 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
722 * Device Tree IRQ specifier translation function which works with either one
723 * or two cell bindings where the cell values map directly to the hwirq number
724 * and linux irq flags.
726 * Note: don't use this function unless your interrupt controller explicitly
727 * supports both one and two cell bindings. For the majority of controllers
728 * the _onecell() or _twocell() variants above should be used.
730 int irq_domain_xlate_onetwocell(struct irq_domain
*d
,
731 struct device_node
*ctrlr
,
732 const u32
*intspec
, unsigned int intsize
,
733 unsigned long *out_hwirq
, unsigned int *out_type
)
735 if (WARN_ON(intsize
< 1))
737 *out_hwirq
= intspec
[0];
738 *out_type
= (intsize
> 1) ? intspec
[1] : IRQ_TYPE_NONE
;
741 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell
);
743 const struct irq_domain_ops irq_domain_simple_ops
= {
744 .xlate
= irq_domain_xlate_onetwocell
,
746 EXPORT_SYMBOL_GPL(irq_domain_simple_ops
);
749 void irq_domain_generate_simple(const struct of_device_id
*match
,
750 u64 phys_base
, unsigned int irq_start
)
752 struct device_node
*node
;
753 pr_debug("looking for phys_base=%llx, irq_start=%i\n",
754 (unsigned long long) phys_base
, (int) irq_start
);
755 node
= of_find_matching_node_by_address(NULL
, match
, phys_base
);
757 irq_domain_add_legacy(node
, 32, irq_start
, 0,
758 &irq_domain_simple_ops
, NULL
);
760 EXPORT_SYMBOL_GPL(irq_domain_generate_simple
);