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 * __irq_domain_add() - Allocate a new irq_domain data structure
32 * @of_node: optional device-tree node of the interrupt controller
33 * @size: Size of linear map; 0 for radix mapping only
34 * @hwirq_max: Maximum number of interrupts supported by controller
35 * @direct_max: Maximum value of direct maps; Use ~0 for no limit; 0 for no
37 * @ops: domain callbacks
38 * @host_data: Controller private data pointer
40 * Allocates and initialize and irq_domain structure.
41 * Returns pointer to IRQ domain, or NULL on failure.
43 struct irq_domain
*__irq_domain_add(struct device_node
*of_node
, int size
,
44 irq_hw_number_t hwirq_max
, int direct_max
,
45 const struct irq_domain_ops
*ops
,
48 struct irq_domain
*domain
;
50 domain
= kzalloc_node(sizeof(*domain
) + (sizeof(unsigned int) * size
),
51 GFP_KERNEL
, of_node_to_nid(of_node
));
56 INIT_RADIX_TREE(&domain
->revmap_tree
, GFP_KERNEL
);
58 domain
->host_data
= host_data
;
59 domain
->of_node
= of_node_get(of_node
);
60 domain
->hwirq_max
= hwirq_max
;
61 domain
->revmap_size
= size
;
62 domain
->revmap_direct_max_irq
= direct_max
;
63 irq_domain_check_hierarchy(domain
);
65 mutex_lock(&irq_domain_mutex
);
66 list_add(&domain
->link
, &irq_domain_list
);
67 mutex_unlock(&irq_domain_mutex
);
69 pr_debug("Added domain %s\n", domain
->name
);
72 EXPORT_SYMBOL_GPL(__irq_domain_add
);
75 * irq_domain_remove() - Remove an irq domain.
76 * @domain: domain to remove
78 * This routine is used to remove an irq domain. The caller must ensure
79 * that all mappings within the domain have been disposed of prior to
80 * use, depending on the revmap type.
82 void irq_domain_remove(struct irq_domain
*domain
)
84 mutex_lock(&irq_domain_mutex
);
87 * radix_tree_delete() takes care of destroying the root
88 * node when all entries are removed. Shout if there are
91 WARN_ON(domain
->revmap_tree
.height
);
93 list_del(&domain
->link
);
96 * If the going away domain is the default one, reset it.
98 if (unlikely(irq_default_domain
== domain
))
99 irq_set_default_host(NULL
);
101 mutex_unlock(&irq_domain_mutex
);
103 pr_debug("Removed domain %s\n", domain
->name
);
105 of_node_put(domain
->of_node
);
108 EXPORT_SYMBOL_GPL(irq_domain_remove
);
111 * irq_domain_add_simple() - Register an irq_domain and optionally map a range of irqs
112 * @of_node: pointer to interrupt controller's device tree node.
113 * @size: total number of irqs in mapping
114 * @first_irq: first number of irq block assigned to the domain,
115 * pass zero to assign irqs on-the-fly. If first_irq is non-zero, then
116 * pre-map all of the irqs in the domain to virqs starting at first_irq.
117 * @ops: domain callbacks
118 * @host_data: Controller private data pointer
120 * Allocates an irq_domain, and optionally if first_irq is positive then also
121 * allocate irq_descs and map all of the hwirqs to virqs starting at first_irq.
123 * This is intended to implement the expected behaviour for most
124 * interrupt controllers. If device tree is used, then first_irq will be 0 and
125 * irqs get mapped dynamically on the fly. However, if the controller requires
126 * static virq assignments (non-DT boot) then it will set that up correctly.
128 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
130 unsigned int first_irq
,
131 const struct irq_domain_ops
*ops
,
134 struct irq_domain
*domain
;
136 domain
= __irq_domain_add(of_node
, size
, size
, 0, ops
, host_data
);
141 if (IS_ENABLED(CONFIG_SPARSE_IRQ
)) {
142 /* attempt to allocated irq_descs */
143 int rc
= irq_alloc_descs(first_irq
, first_irq
, size
,
144 of_node_to_nid(of_node
));
146 pr_info("Cannot allocate irq_descs @ IRQ%d, assuming pre-allocated\n",
149 irq_domain_associate_many(domain
, first_irq
, 0, size
);
154 EXPORT_SYMBOL_GPL(irq_domain_add_simple
);
157 * irq_domain_add_legacy() - Allocate and register a legacy revmap irq_domain.
158 * @of_node: pointer to interrupt controller's device tree node.
159 * @size: total number of irqs in legacy mapping
160 * @first_irq: first number of irq block assigned to the domain
161 * @first_hwirq: first hwirq number to use for the translation. Should normally
162 * be '0', but a positive integer can be used if the effective
163 * hwirqs numbering does not begin at zero.
164 * @ops: map/unmap domain callbacks
165 * @host_data: Controller private data pointer
167 * Note: the map() callback will be called before this function returns
168 * for all legacy interrupts except 0 (which is always the invalid irq for
169 * a legacy controller).
171 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
173 unsigned int first_irq
,
174 irq_hw_number_t first_hwirq
,
175 const struct irq_domain_ops
*ops
,
178 struct irq_domain
*domain
;
180 domain
= __irq_domain_add(of_node
, first_hwirq
+ size
,
181 first_hwirq
+ size
, 0, ops
, host_data
);
183 irq_domain_associate_many(domain
, first_irq
, first_hwirq
, size
);
187 EXPORT_SYMBOL_GPL(irq_domain_add_legacy
);
190 * irq_find_host() - Locates a domain for a given device node
191 * @node: device-tree node of the interrupt controller
193 struct irq_domain
*irq_find_host(struct device_node
*node
)
195 struct irq_domain
*h
, *found
= NULL
;
198 /* We might want to match the legacy controller last since
199 * it might potentially be set to match all interrupts in
200 * the absence of a device node. This isn't a problem so far
203 mutex_lock(&irq_domain_mutex
);
204 list_for_each_entry(h
, &irq_domain_list
, link
) {
206 rc
= h
->ops
->match(h
, node
);
208 rc
= (h
->of_node
!= NULL
) && (h
->of_node
== node
);
215 mutex_unlock(&irq_domain_mutex
);
218 EXPORT_SYMBOL_GPL(irq_find_host
);
221 * irq_set_default_host() - Set a "default" irq domain
222 * @domain: default domain pointer
224 * For convenience, it's possible to set a "default" domain that will be used
225 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
226 * platforms that want to manipulate a few hard coded interrupt numbers that
227 * aren't properly represented in the device-tree.
229 void irq_set_default_host(struct irq_domain
*domain
)
231 pr_debug("Default domain set to @0x%p\n", domain
);
233 irq_default_domain
= domain
;
235 EXPORT_SYMBOL_GPL(irq_set_default_host
);
237 void irq_domain_disassociate(struct irq_domain
*domain
, unsigned int irq
)
239 struct irq_data
*irq_data
= irq_get_irq_data(irq
);
240 irq_hw_number_t hwirq
;
242 if (WARN(!irq_data
|| irq_data
->domain
!= domain
,
243 "virq%i doesn't exist; cannot disassociate\n", irq
))
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
);
273 int irq_domain_associate(struct irq_domain
*domain
, unsigned int virq
,
274 irq_hw_number_t hwirq
)
276 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
279 if (WARN(hwirq
>= domain
->hwirq_max
,
280 "error: hwirq 0x%x is too large for %s\n", (int)hwirq
, domain
->name
))
282 if (WARN(!irq_data
, "error: virq%i is not allocated", virq
))
284 if (WARN(irq_data
->domain
, "error: virq%i is already associated", virq
))
287 mutex_lock(&irq_domain_mutex
);
288 irq_data
->hwirq
= hwirq
;
289 irq_data
->domain
= domain
;
290 if (domain
->ops
->map
) {
291 ret
= domain
->ops
->map(domain
, virq
, hwirq
);
294 * If map() returns -EPERM, this interrupt is protected
295 * by the firmware or some other service and shall not
296 * be mapped. Don't bother telling the user about it.
299 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
300 domain
->name
, hwirq
, virq
, ret
);
302 irq_data
->domain
= NULL
;
304 mutex_unlock(&irq_domain_mutex
);
308 /* If not already assigned, give the domain the chip's name */
309 if (!domain
->name
&& irq_data
->chip
)
310 domain
->name
= irq_data
->chip
->name
;
313 if (hwirq
< domain
->revmap_size
) {
314 domain
->linear_revmap
[hwirq
] = virq
;
316 mutex_lock(&revmap_trees_mutex
);
317 radix_tree_insert(&domain
->revmap_tree
, hwirq
, irq_data
);
318 mutex_unlock(&revmap_trees_mutex
);
320 mutex_unlock(&irq_domain_mutex
);
322 irq_clear_status_flags(virq
, IRQ_NOREQUEST
);
326 EXPORT_SYMBOL_GPL(irq_domain_associate
);
328 void irq_domain_associate_many(struct irq_domain
*domain
, unsigned int irq_base
,
329 irq_hw_number_t hwirq_base
, int count
)
333 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__
,
334 of_node_full_name(domain
->of_node
), irq_base
, (int)hwirq_base
, count
);
336 for (i
= 0; i
< count
; i
++) {
337 irq_domain_associate(domain
, irq_base
+ i
, hwirq_base
+ i
);
340 EXPORT_SYMBOL_GPL(irq_domain_associate_many
);
343 * irq_create_direct_mapping() - Allocate an irq for direct mapping
344 * @domain: domain to allocate the irq for or NULL for default domain
346 * This routine is used for irq controllers which can choose the hardware
347 * interrupt numbers they generate. In such a case it's simplest to use
348 * the linux irq as the hardware interrupt number. It still uses the linear
349 * or radix tree to store the mapping, but the irq controller can optimize
350 * the revmap path by using the hwirq directly.
352 unsigned int irq_create_direct_mapping(struct irq_domain
*domain
)
357 domain
= irq_default_domain
;
359 virq
= irq_alloc_desc_from(1, of_node_to_nid(domain
->of_node
));
361 pr_debug("create_direct virq allocation failed\n");
364 if (virq
>= domain
->revmap_direct_max_irq
) {
365 pr_err("ERROR: no free irqs available below %i maximum\n",
366 domain
->revmap_direct_max_irq
);
370 pr_debug("create_direct obtained virq %d\n", virq
);
372 if (irq_domain_associate(domain
, virq
, virq
)) {
379 EXPORT_SYMBOL_GPL(irq_create_direct_mapping
);
382 * irq_create_mapping() - Map a hardware interrupt into linux irq space
383 * @domain: domain owning this hardware interrupt or NULL for default domain
384 * @hwirq: hardware irq number in that domain space
386 * Only one mapping per hardware interrupt is permitted. Returns a linux
388 * If the sense/trigger is to be specified, set_irq_type() should be called
389 * on the number returned from that call.
391 unsigned int irq_create_mapping(struct irq_domain
*domain
,
392 irq_hw_number_t hwirq
)
396 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain
, hwirq
);
398 /* Look for default domain if nececssary */
400 domain
= irq_default_domain
;
401 if (domain
== NULL
) {
402 WARN(1, "%s(, %lx) called with NULL domain\n", __func__
, hwirq
);
405 pr_debug("-> using domain @%p\n", domain
);
407 /* Check if mapping already exists */
408 virq
= irq_find_mapping(domain
, hwirq
);
410 pr_debug("-> existing mapping on virq %d\n", virq
);
414 /* Allocate a virtual interrupt number */
415 virq
= irq_domain_alloc_descs(-1, 1, hwirq
,
416 of_node_to_nid(domain
->of_node
));
418 pr_debug("-> virq allocation failed\n");
422 if (irq_domain_associate(domain
, virq
, hwirq
)) {
427 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
428 hwirq
, of_node_full_name(domain
->of_node
), virq
);
432 EXPORT_SYMBOL_GPL(irq_create_mapping
);
435 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
436 * @domain: domain owning the interrupt range
437 * @irq_base: beginning of linux IRQ range
438 * @hwirq_base: beginning of hardware IRQ range
439 * @count: Number of interrupts to map
441 * This routine is used for allocating and mapping a range of hardware
442 * irqs to linux irqs where the linux irq numbers are at pre-defined
443 * locations. For use by controllers that already have static mappings
444 * to insert in to the domain.
446 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
449 * 0 is returned upon success, while any failure to establish a static
450 * mapping is treated as an error.
452 int irq_create_strict_mappings(struct irq_domain
*domain
, unsigned int irq_base
,
453 irq_hw_number_t hwirq_base
, int count
)
457 ret
= irq_alloc_descs(irq_base
, irq_base
, count
,
458 of_node_to_nid(domain
->of_node
));
459 if (unlikely(ret
< 0))
462 irq_domain_associate_many(domain
, irq_base
, hwirq_base
, count
);
465 EXPORT_SYMBOL_GPL(irq_create_strict_mappings
);
467 unsigned int irq_create_of_mapping(struct of_phandle_args
*irq_data
)
469 struct irq_domain
*domain
;
470 irq_hw_number_t hwirq
;
471 unsigned int type
= IRQ_TYPE_NONE
;
474 domain
= irq_data
->np
? irq_find_host(irq_data
->np
) : irq_default_domain
;
476 pr_warn("no irq domain found for %s !\n",
477 of_node_full_name(irq_data
->np
));
481 /* If domain has no translation, then we assume interrupt line */
482 if (domain
->ops
->xlate
== NULL
)
483 hwirq
= irq_data
->args
[0];
485 if (domain
->ops
->xlate(domain
, irq_data
->np
, irq_data
->args
,
486 irq_data
->args_count
, &hwirq
, &type
))
490 if (irq_domain_is_hierarchy(domain
)) {
492 * If we've already configured this interrupt,
493 * don't do it again, or hell will break loose.
495 virq
= irq_find_mapping(domain
, hwirq
);
499 virq
= irq_domain_alloc_irqs(domain
, 1, NUMA_NO_NODE
, irq_data
);
504 virq
= irq_create_mapping(domain
, hwirq
);
509 /* Set type if specified and different than the current one */
510 if (type
!= IRQ_TYPE_NONE
&&
511 type
!= irq_get_trigger_type(virq
))
512 irq_set_irq_type(virq
, type
);
515 EXPORT_SYMBOL_GPL(irq_create_of_mapping
);
518 * irq_dispose_mapping() - Unmap an interrupt
519 * @virq: linux irq number of the interrupt to unmap
521 void irq_dispose_mapping(unsigned int virq
)
523 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
524 struct irq_domain
*domain
;
526 if (!virq
|| !irq_data
)
529 domain
= irq_data
->domain
;
530 if (WARN_ON(domain
== NULL
))
533 irq_domain_disassociate(domain
, virq
);
536 EXPORT_SYMBOL_GPL(irq_dispose_mapping
);
539 * irq_find_mapping() - Find a linux irq from an hw irq number.
540 * @domain: domain owning this hardware interrupt
541 * @hwirq: hardware irq number in that domain space
543 unsigned int irq_find_mapping(struct irq_domain
*domain
,
544 irq_hw_number_t hwirq
)
546 struct irq_data
*data
;
548 /* Look for default domain if nececssary */
550 domain
= irq_default_domain
;
554 if (hwirq
< domain
->revmap_direct_max_irq
) {
555 data
= irq_domain_get_irq_data(domain
, hwirq
);
556 if (data
&& data
->hwirq
== hwirq
)
560 /* Check if the hwirq is in the linear revmap. */
561 if (hwirq
< domain
->revmap_size
)
562 return domain
->linear_revmap
[hwirq
];
565 data
= radix_tree_lookup(&domain
->revmap_tree
, hwirq
);
567 return data
? data
->irq
: 0;
569 EXPORT_SYMBOL_GPL(irq_find_mapping
);
571 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
572 static int virq_debug_show(struct seq_file
*m
, void *private)
575 struct irq_desc
*desc
;
576 struct irq_domain
*domain
;
577 struct radix_tree_iter iter
;
581 seq_printf(m
, " %-16s %-6s %-10s %-10s %s\n",
582 "name", "mapped", "linear-max", "direct-max", "devtree-node");
583 mutex_lock(&irq_domain_mutex
);
584 list_for_each_entry(domain
, &irq_domain_list
, link
) {
586 radix_tree_for_each_slot(slot
, &domain
->revmap_tree
, &iter
, 0)
588 seq_printf(m
, "%c%-16s %6u %10u %10u %s\n",
589 domain
== irq_default_domain
? '*' : ' ', domain
->name
,
590 domain
->revmap_size
+ count
, domain
->revmap_size
,
591 domain
->revmap_direct_max_irq
,
592 domain
->of_node
? of_node_full_name(domain
->of_node
) : "");
594 mutex_unlock(&irq_domain_mutex
);
596 seq_printf(m
, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
597 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
598 "active", "type", "domain");
600 for (i
= 1; i
< nr_irqs
; i
++) {
601 desc
= irq_to_desc(i
);
605 raw_spin_lock_irqsave(&desc
->lock
, flags
);
606 domain
= desc
->irq_data
.domain
;
609 struct irq_chip
*chip
;
610 int hwirq
= desc
->irq_data
.hwirq
;
613 seq_printf(m
, "%5d ", i
);
614 seq_printf(m
, "0x%05x ", hwirq
);
616 chip
= irq_desc_get_chip(desc
);
617 seq_printf(m
, "%-15s ", (chip
&& chip
->name
) ? chip
->name
: "none");
619 data
= irq_desc_get_chip_data(desc
);
620 seq_printf(m
, data
? "0x%p " : " %p ", data
);
622 seq_printf(m
, " %c ", (desc
->action
&& desc
->action
->handler
) ? '*' : ' ');
623 direct
= (i
== hwirq
) && (i
< domain
->revmap_direct_max_irq
);
624 seq_printf(m
, "%6s%-8s ",
625 (hwirq
< domain
->revmap_size
) ? "LINEAR" : "RADIX",
626 direct
? "(DIRECT)" : "");
627 seq_printf(m
, "%s\n", desc
->irq_data
.domain
->name
);
630 raw_spin_unlock_irqrestore(&desc
->lock
, flags
);
636 static int virq_debug_open(struct inode
*inode
, struct file
*file
)
638 return single_open(file
, virq_debug_show
, inode
->i_private
);
641 static const struct file_operations virq_debug_fops
= {
642 .open
= virq_debug_open
,
645 .release
= single_release
,
648 static int __init
irq_debugfs_init(void)
650 if (debugfs_create_file("irq_domain_mapping", S_IRUGO
, NULL
,
651 NULL
, &virq_debug_fops
) == NULL
)
656 __initcall(irq_debugfs_init
);
657 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
660 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
662 * Device Tree IRQ specifier translation function which works with one cell
663 * bindings where the cell value maps directly to the hwirq number.
665 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
666 const u32
*intspec
, unsigned int intsize
,
667 unsigned long *out_hwirq
, unsigned int *out_type
)
669 if (WARN_ON(intsize
< 1))
671 *out_hwirq
= intspec
[0];
672 *out_type
= IRQ_TYPE_NONE
;
675 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell
);
678 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
680 * Device Tree IRQ specifier translation function which works with two cell
681 * bindings where the cell values map directly to the hwirq number
682 * and linux irq flags.
684 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
685 const u32
*intspec
, unsigned int intsize
,
686 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
)
688 if (WARN_ON(intsize
< 2))
690 *out_hwirq
= intspec
[0];
691 *out_type
= intspec
[1] & IRQ_TYPE_SENSE_MASK
;
694 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell
);
697 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
699 * Device Tree IRQ specifier translation function which works with either one
700 * or two cell bindings where the cell values map directly to the hwirq number
701 * and linux irq flags.
703 * Note: don't use this function unless your interrupt controller explicitly
704 * supports both one and two cell bindings. For the majority of controllers
705 * the _onecell() or _twocell() variants above should be used.
707 int irq_domain_xlate_onetwocell(struct irq_domain
*d
,
708 struct device_node
*ctrlr
,
709 const u32
*intspec
, unsigned int intsize
,
710 unsigned long *out_hwirq
, unsigned int *out_type
)
712 if (WARN_ON(intsize
< 1))
714 *out_hwirq
= intspec
[0];
715 *out_type
= (intsize
> 1) ? intspec
[1] : IRQ_TYPE_NONE
;
718 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell
);
720 const struct irq_domain_ops irq_domain_simple_ops
= {
721 .xlate
= irq_domain_xlate_onetwocell
,
723 EXPORT_SYMBOL_GPL(irq_domain_simple_ops
);
725 static int irq_domain_alloc_descs(int virq
, unsigned int cnt
,
726 irq_hw_number_t hwirq
, int node
)
731 virq
= irq_alloc_descs(virq
, virq
, cnt
, node
);
733 hint
= hwirq
% nr_irqs
;
736 virq
= irq_alloc_descs_from(hint
, cnt
, node
);
737 if (virq
<= 0 && hint
> 1)
738 virq
= irq_alloc_descs_from(1, cnt
, node
);
744 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
746 * irq_domain_add_hierarchy - Add a irqdomain into the hierarchy
747 * @parent: Parent irq domain to associate with the new domain
748 * @flags: Irq domain flags associated to the domain
749 * @size: Size of the domain. See below
750 * @node: Optional device-tree node of the interrupt controller
751 * @ops: Pointer to the interrupt domain callbacks
752 * @host_data: Controller private data pointer
754 * If @size is 0 a tree domain is created, otherwise a linear domain.
756 * If successful the parent is associated to the new domain and the
757 * domain flags are set.
758 * Returns pointer to IRQ domain, or NULL on failure.
760 struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
763 struct device_node
*node
,
764 const struct irq_domain_ops
*ops
,
767 struct irq_domain
*domain
;
770 domain
= irq_domain_add_linear(node
, size
, ops
, host_data
);
772 domain
= irq_domain_add_tree(node
, ops
, host_data
);
774 domain
->parent
= parent
;
775 domain
->flags
|= flags
;
781 static void irq_domain_insert_irq(int virq
)
783 struct irq_data
*data
;
785 for (data
= irq_get_irq_data(virq
); data
; data
= data
->parent_data
) {
786 struct irq_domain
*domain
= data
->domain
;
787 irq_hw_number_t hwirq
= data
->hwirq
;
789 if (hwirq
< domain
->revmap_size
) {
790 domain
->linear_revmap
[hwirq
] = virq
;
792 mutex_lock(&revmap_trees_mutex
);
793 radix_tree_insert(&domain
->revmap_tree
, hwirq
, data
);
794 mutex_unlock(&revmap_trees_mutex
);
797 /* If not already assigned, give the domain the chip's name */
798 if (!domain
->name
&& data
->chip
)
799 domain
->name
= data
->chip
->name
;
802 irq_clear_status_flags(virq
, IRQ_NOREQUEST
);
805 static void irq_domain_remove_irq(int virq
)
807 struct irq_data
*data
;
809 irq_set_status_flags(virq
, IRQ_NOREQUEST
);
810 irq_set_chip_and_handler(virq
, NULL
, NULL
);
811 synchronize_irq(virq
);
814 for (data
= irq_get_irq_data(virq
); data
; data
= data
->parent_data
) {
815 struct irq_domain
*domain
= data
->domain
;
816 irq_hw_number_t hwirq
= data
->hwirq
;
818 if (hwirq
< domain
->revmap_size
) {
819 domain
->linear_revmap
[hwirq
] = 0;
821 mutex_lock(&revmap_trees_mutex
);
822 radix_tree_delete(&domain
->revmap_tree
, hwirq
);
823 mutex_unlock(&revmap_trees_mutex
);
828 static struct irq_data
*irq_domain_insert_irq_data(struct irq_domain
*domain
,
829 struct irq_data
*child
)
831 struct irq_data
*irq_data
;
833 irq_data
= kzalloc_node(sizeof(*irq_data
), GFP_KERNEL
,
834 irq_data_get_node(child
));
836 child
->parent_data
= irq_data
;
837 irq_data
->irq
= child
->irq
;
838 irq_data
->common
= child
->common
;
839 irq_data
->node
= child
->node
;
840 irq_data
->domain
= domain
;
846 static void irq_domain_free_irq_data(unsigned int virq
, unsigned int nr_irqs
)
848 struct irq_data
*irq_data
, *tmp
;
851 for (i
= 0; i
< nr_irqs
; i
++) {
852 irq_data
= irq_get_irq_data(virq
+ i
);
853 tmp
= irq_data
->parent_data
;
854 irq_data
->parent_data
= NULL
;
855 irq_data
->domain
= NULL
;
859 tmp
= tmp
->parent_data
;
865 static int irq_domain_alloc_irq_data(struct irq_domain
*domain
,
866 unsigned int virq
, unsigned int nr_irqs
)
868 struct irq_data
*irq_data
;
869 struct irq_domain
*parent
;
872 /* The outermost irq_data is embedded in struct irq_desc */
873 for (i
= 0; i
< nr_irqs
; i
++) {
874 irq_data
= irq_get_irq_data(virq
+ i
);
875 irq_data
->domain
= domain
;
877 for (parent
= domain
->parent
; parent
; parent
= parent
->parent
) {
878 irq_data
= irq_domain_insert_irq_data(parent
, irq_data
);
880 irq_domain_free_irq_data(virq
, i
+ 1);
890 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
891 * @domain: domain to match
892 * @virq: IRQ number to get irq_data
894 struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
897 struct irq_data
*irq_data
;
899 for (irq_data
= irq_get_irq_data(virq
); irq_data
;
900 irq_data
= irq_data
->parent_data
)
901 if (irq_data
->domain
== domain
)
908 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
909 * @domain: Interrupt domain to match
911 * @hwirq: The hwirq number
912 * @chip: The associated interrupt chip
913 * @chip_data: The associated chip data
915 int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
, unsigned int virq
,
916 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
919 struct irq_data
*irq_data
= irq_domain_get_irq_data(domain
, virq
);
924 irq_data
->hwirq
= hwirq
;
925 irq_data
->chip
= chip
? chip
: &no_irq_chip
;
926 irq_data
->chip_data
= chip_data
;
932 * irq_domain_set_info - Set the complete data for a @virq in @domain
933 * @domain: Interrupt domain to match
935 * @hwirq: The hardware interrupt number
936 * @chip: The associated interrupt chip
937 * @chip_data: The associated interrupt chip data
938 * @handler: The interrupt flow handler
939 * @handler_data: The interrupt flow handler data
940 * @handler_name: The interrupt handler name
942 void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
943 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
944 void *chip_data
, irq_flow_handler_t handler
,
945 void *handler_data
, const char *handler_name
)
947 irq_domain_set_hwirq_and_chip(domain
, virq
, hwirq
, chip
, chip_data
);
948 __irq_set_handler(virq
, handler
, 0, handler_name
);
949 irq_set_handler_data(virq
, handler_data
);
953 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
954 * @irq_data: The pointer to irq_data
956 void irq_domain_reset_irq_data(struct irq_data
*irq_data
)
959 irq_data
->chip
= &no_irq_chip
;
960 irq_data
->chip_data
= NULL
;
964 * irq_domain_free_irqs_common - Clear irq_data and free the parent
965 * @domain: Interrupt domain to match
966 * @virq: IRQ number to start with
967 * @nr_irqs: The number of irqs to free
969 void irq_domain_free_irqs_common(struct irq_domain
*domain
, unsigned int virq
,
970 unsigned int nr_irqs
)
972 struct irq_data
*irq_data
;
975 for (i
= 0; i
< nr_irqs
; i
++) {
976 irq_data
= irq_domain_get_irq_data(domain
, virq
+ i
);
978 irq_domain_reset_irq_data(irq_data
);
980 irq_domain_free_irqs_parent(domain
, virq
, nr_irqs
);
984 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
985 * @domain: Interrupt domain to match
986 * @virq: IRQ number to start with
987 * @nr_irqs: The number of irqs to free
989 void irq_domain_free_irqs_top(struct irq_domain
*domain
, unsigned int virq
,
990 unsigned int nr_irqs
)
994 for (i
= 0; i
< nr_irqs
; i
++) {
995 irq_set_handler_data(virq
+ i
, NULL
);
996 irq_set_handler(virq
+ i
, NULL
);
998 irq_domain_free_irqs_common(domain
, virq
, nr_irqs
);
1001 static bool irq_domain_is_auto_recursive(struct irq_domain
*domain
)
1003 return domain
->flags
& IRQ_DOMAIN_FLAG_AUTO_RECURSIVE
;
1006 static void irq_domain_free_irqs_recursive(struct irq_domain
*domain
,
1007 unsigned int irq_base
,
1008 unsigned int nr_irqs
)
1010 domain
->ops
->free(domain
, irq_base
, nr_irqs
);
1011 if (irq_domain_is_auto_recursive(domain
)) {
1012 BUG_ON(!domain
->parent
);
1013 irq_domain_free_irqs_recursive(domain
->parent
, irq_base
,
1018 static int irq_domain_alloc_irqs_recursive(struct irq_domain
*domain
,
1019 unsigned int irq_base
,
1020 unsigned int nr_irqs
, void *arg
)
1023 struct irq_domain
*parent
= domain
->parent
;
1024 bool recursive
= irq_domain_is_auto_recursive(domain
);
1026 BUG_ON(recursive
&& !parent
);
1028 ret
= irq_domain_alloc_irqs_recursive(parent
, irq_base
,
1031 ret
= domain
->ops
->alloc(domain
, irq_base
, nr_irqs
, arg
);
1032 if (ret
< 0 && recursive
)
1033 irq_domain_free_irqs_recursive(parent
, irq_base
, nr_irqs
);
1039 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1040 * @domain: domain to allocate from
1041 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1042 * @nr_irqs: number of IRQs to allocate
1043 * @node: NUMA node id for memory allocation
1044 * @arg: domain specific argument
1045 * @realloc: IRQ descriptors have already been allocated if true
1047 * Allocate IRQ numbers and initialized all data structures to support
1048 * hierarchy IRQ domains.
1049 * Parameter @realloc is mainly to support legacy IRQs.
1050 * Returns error code or allocated IRQ number
1052 * The whole process to setup an IRQ has been split into two steps.
1053 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1054 * descriptor and required hardware resources. The second step,
1055 * irq_domain_activate_irq(), is to program hardwares with preallocated
1056 * resources. In this way, it's easier to rollback when failing to
1057 * allocate resources.
1059 int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
1060 unsigned int nr_irqs
, int node
, void *arg
,
1065 if (domain
== NULL
) {
1066 domain
= irq_default_domain
;
1067 if (WARN(!domain
, "domain is NULL; cannot allocate IRQ\n"))
1071 if (!domain
->ops
->alloc
) {
1072 pr_debug("domain->ops->alloc() is NULL\n");
1076 if (realloc
&& irq_base
>= 0) {
1079 virq
= irq_domain_alloc_descs(irq_base
, nr_irqs
, 0, node
);
1081 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1087 if (irq_domain_alloc_irq_data(domain
, virq
, nr_irqs
)) {
1088 pr_debug("cannot allocate memory for IRQ%d\n", virq
);
1093 mutex_lock(&irq_domain_mutex
);
1094 ret
= irq_domain_alloc_irqs_recursive(domain
, virq
, nr_irqs
, arg
);
1096 mutex_unlock(&irq_domain_mutex
);
1097 goto out_free_irq_data
;
1099 for (i
= 0; i
< nr_irqs
; i
++)
1100 irq_domain_insert_irq(virq
+ i
);
1101 mutex_unlock(&irq_domain_mutex
);
1106 irq_domain_free_irq_data(virq
, nr_irqs
);
1108 irq_free_descs(virq
, nr_irqs
);
1113 * irq_domain_free_irqs - Free IRQ number and associated data structures
1114 * @virq: base IRQ number
1115 * @nr_irqs: number of IRQs to free
1117 void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
)
1119 struct irq_data
*data
= irq_get_irq_data(virq
);
1122 if (WARN(!data
|| !data
->domain
|| !data
->domain
->ops
->free
,
1123 "NULL pointer, cannot free irq\n"))
1126 mutex_lock(&irq_domain_mutex
);
1127 for (i
= 0; i
< nr_irqs
; i
++)
1128 irq_domain_remove_irq(virq
+ i
);
1129 irq_domain_free_irqs_recursive(data
->domain
, virq
, nr_irqs
);
1130 mutex_unlock(&irq_domain_mutex
);
1132 irq_domain_free_irq_data(virq
, nr_irqs
);
1133 irq_free_descs(virq
, nr_irqs
);
1137 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1138 * @irq_base: Base IRQ number
1139 * @nr_irqs: Number of IRQs to allocate
1140 * @arg: Allocation data (arch/domain specific)
1142 * Check whether the domain has been setup recursive. If not allocate
1143 * through the parent domain.
1145 int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
1146 unsigned int irq_base
, unsigned int nr_irqs
,
1149 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1150 if (irq_domain_is_auto_recursive(domain
))
1153 domain
= domain
->parent
;
1155 return irq_domain_alloc_irqs_recursive(domain
, irq_base
,
1161 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1162 * @irq_base: Base IRQ number
1163 * @nr_irqs: Number of IRQs to free
1165 * Check whether the domain has been setup recursive. If not free
1166 * through the parent domain.
1168 void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
1169 unsigned int irq_base
, unsigned int nr_irqs
)
1171 /* irq_domain_free_irqs_recursive() will call parent's free */
1172 if (!irq_domain_is_auto_recursive(domain
) && domain
->parent
)
1173 irq_domain_free_irqs_recursive(domain
->parent
, irq_base
,
1178 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1180 * @irq_data: outermost irq_data associated with interrupt
1182 * This is the second step to call domain_ops->activate to program interrupt
1183 * controllers, so the interrupt could actually get delivered.
1185 void irq_domain_activate_irq(struct irq_data
*irq_data
)
1187 if (irq_data
&& irq_data
->domain
) {
1188 struct irq_domain
*domain
= irq_data
->domain
;
1190 if (irq_data
->parent_data
)
1191 irq_domain_activate_irq(irq_data
->parent_data
);
1192 if (domain
->ops
->activate
)
1193 domain
->ops
->activate(domain
, irq_data
);
1198 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1199 * deactivate interrupt
1200 * @irq_data: outermost irq_data associated with interrupt
1202 * It calls domain_ops->deactivate to program interrupt controllers to disable
1203 * interrupt delivery.
1205 void irq_domain_deactivate_irq(struct irq_data
*irq_data
)
1207 if (irq_data
&& irq_data
->domain
) {
1208 struct irq_domain
*domain
= irq_data
->domain
;
1210 if (domain
->ops
->deactivate
)
1211 domain
->ops
->deactivate(domain
, irq_data
);
1212 if (irq_data
->parent_data
)
1213 irq_domain_deactivate_irq(irq_data
->parent_data
);
1217 static void irq_domain_check_hierarchy(struct irq_domain
*domain
)
1219 /* Hierarchy irq_domains must implement callback alloc() */
1220 if (domain
->ops
->alloc
)
1221 domain
->flags
|= IRQ_DOMAIN_FLAG_HIERARCHY
;
1223 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1225 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1226 * @domain: domain to match
1227 * @virq: IRQ number to get irq_data
1229 struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
1232 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
1234 return (irq_data
&& irq_data
->domain
== domain
) ? irq_data
: NULL
;
1238 * irq_domain_set_info - Set the complete data for a @virq in @domain
1239 * @domain: Interrupt domain to match
1241 * @hwirq: The hardware interrupt number
1242 * @chip: The associated interrupt chip
1243 * @chip_data: The associated interrupt chip data
1244 * @handler: The interrupt flow handler
1245 * @handler_data: The interrupt flow handler data
1246 * @handler_name: The interrupt handler name
1248 void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
1249 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
1250 void *chip_data
, irq_flow_handler_t handler
,
1251 void *handler_data
, const char *handler_name
)
1253 irq_set_chip_and_handler_name(virq
, chip
, handler
, handler_name
);
1254 irq_set_chip_data(virq
, chip_data
);
1255 irq_set_handler_data(virq
, handler_data
);
1258 static void irq_domain_check_hierarchy(struct irq_domain
*domain
)
1261 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */