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_matching_host() - Locates a domain for a given device node
191 * @node: device-tree node of the interrupt controller
192 * @bus_token: domain-specific data
194 struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
195 enum irq_domain_bus_token bus_token
)
197 struct irq_domain
*h
, *found
= NULL
;
200 /* We might want to match the legacy controller last since
201 * it might potentially be set to match all interrupts in
202 * the absence of a device node. This isn't a problem so far
205 * bus_token == DOMAIN_BUS_ANY matches any domain, any other
206 * values must generate an exact match for the domain to be
209 mutex_lock(&irq_domain_mutex
);
210 list_for_each_entry(h
, &irq_domain_list
, link
) {
212 rc
= h
->ops
->match(h
, node
, bus_token
);
214 rc
= ((h
->of_node
!= NULL
) && (h
->of_node
== node
) &&
215 ((bus_token
== DOMAIN_BUS_ANY
) ||
216 (h
->bus_token
== bus_token
)));
223 mutex_unlock(&irq_domain_mutex
);
226 EXPORT_SYMBOL_GPL(irq_find_matching_host
);
229 * irq_set_default_host() - Set a "default" irq domain
230 * @domain: default domain pointer
232 * For convenience, it's possible to set a "default" domain that will be used
233 * whenever NULL is passed to irq_create_mapping(). It makes life easier for
234 * platforms that want to manipulate a few hard coded interrupt numbers that
235 * aren't properly represented in the device-tree.
237 void irq_set_default_host(struct irq_domain
*domain
)
239 pr_debug("Default domain set to @0x%p\n", domain
);
241 irq_default_domain
= domain
;
243 EXPORT_SYMBOL_GPL(irq_set_default_host
);
245 void irq_domain_disassociate(struct irq_domain
*domain
, unsigned int irq
)
247 struct irq_data
*irq_data
= irq_get_irq_data(irq
);
248 irq_hw_number_t hwirq
;
250 if (WARN(!irq_data
|| irq_data
->domain
!= domain
,
251 "virq%i doesn't exist; cannot disassociate\n", irq
))
254 hwirq
= irq_data
->hwirq
;
255 irq_set_status_flags(irq
, IRQ_NOREQUEST
);
257 /* remove chip and handler */
258 irq_set_chip_and_handler(irq
, NULL
, NULL
);
260 /* Make sure it's completed */
261 synchronize_irq(irq
);
263 /* Tell the PIC about it */
264 if (domain
->ops
->unmap
)
265 domain
->ops
->unmap(domain
, irq
);
268 irq_data
->domain
= NULL
;
271 /* Clear reverse map for this hwirq */
272 if (hwirq
< domain
->revmap_size
) {
273 domain
->linear_revmap
[hwirq
] = 0;
275 mutex_lock(&revmap_trees_mutex
);
276 radix_tree_delete(&domain
->revmap_tree
, hwirq
);
277 mutex_unlock(&revmap_trees_mutex
);
281 int irq_domain_associate(struct irq_domain
*domain
, unsigned int virq
,
282 irq_hw_number_t hwirq
)
284 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
287 if (WARN(hwirq
>= domain
->hwirq_max
,
288 "error: hwirq 0x%x is too large for %s\n", (int)hwirq
, domain
->name
))
290 if (WARN(!irq_data
, "error: virq%i is not allocated", virq
))
292 if (WARN(irq_data
->domain
, "error: virq%i is already associated", virq
))
295 mutex_lock(&irq_domain_mutex
);
296 irq_data
->hwirq
= hwirq
;
297 irq_data
->domain
= domain
;
298 if (domain
->ops
->map
) {
299 ret
= domain
->ops
->map(domain
, virq
, hwirq
);
302 * If map() returns -EPERM, this interrupt is protected
303 * by the firmware or some other service and shall not
304 * be mapped. Don't bother telling the user about it.
307 pr_info("%s didn't like hwirq-0x%lx to VIRQ%i mapping (rc=%d)\n",
308 domain
->name
, hwirq
, virq
, ret
);
310 irq_data
->domain
= NULL
;
312 mutex_unlock(&irq_domain_mutex
);
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
);
328 mutex_unlock(&irq_domain_mutex
);
330 irq_clear_status_flags(virq
, IRQ_NOREQUEST
);
334 EXPORT_SYMBOL_GPL(irq_domain_associate
);
336 void irq_domain_associate_many(struct irq_domain
*domain
, unsigned int irq_base
,
337 irq_hw_number_t hwirq_base
, int count
)
341 pr_debug("%s(%s, irqbase=%i, hwbase=%i, count=%i)\n", __func__
,
342 of_node_full_name(domain
->of_node
), irq_base
, (int)hwirq_base
, count
);
344 for (i
= 0; i
< count
; i
++) {
345 irq_domain_associate(domain
, irq_base
+ i
, hwirq_base
+ i
);
348 EXPORT_SYMBOL_GPL(irq_domain_associate_many
);
351 * irq_create_direct_mapping() - Allocate an irq for direct mapping
352 * @domain: domain to allocate the irq for or NULL for default domain
354 * This routine is used for irq controllers which can choose the hardware
355 * interrupt numbers they generate. In such a case it's simplest to use
356 * the linux irq as the hardware interrupt number. It still uses the linear
357 * or radix tree to store the mapping, but the irq controller can optimize
358 * the revmap path by using the hwirq directly.
360 unsigned int irq_create_direct_mapping(struct irq_domain
*domain
)
365 domain
= irq_default_domain
;
367 virq
= irq_alloc_desc_from(1, of_node_to_nid(domain
->of_node
));
369 pr_debug("create_direct virq allocation failed\n");
372 if (virq
>= domain
->revmap_direct_max_irq
) {
373 pr_err("ERROR: no free irqs available below %i maximum\n",
374 domain
->revmap_direct_max_irq
);
378 pr_debug("create_direct obtained virq %d\n", virq
);
380 if (irq_domain_associate(domain
, virq
, virq
)) {
387 EXPORT_SYMBOL_GPL(irq_create_direct_mapping
);
390 * irq_create_mapping() - Map a hardware interrupt into linux irq space
391 * @domain: domain owning this hardware interrupt or NULL for default domain
392 * @hwirq: hardware irq number in that domain space
394 * Only one mapping per hardware interrupt is permitted. Returns a linux
396 * If the sense/trigger is to be specified, set_irq_type() should be called
397 * on the number returned from that call.
399 unsigned int irq_create_mapping(struct irq_domain
*domain
,
400 irq_hw_number_t hwirq
)
404 pr_debug("irq_create_mapping(0x%p, 0x%lx)\n", domain
, hwirq
);
406 /* Look for default domain if nececssary */
408 domain
= irq_default_domain
;
409 if (domain
== NULL
) {
410 WARN(1, "%s(, %lx) called with NULL domain\n", __func__
, hwirq
);
413 pr_debug("-> using domain @%p\n", domain
);
415 /* Check if mapping already exists */
416 virq
= irq_find_mapping(domain
, hwirq
);
418 pr_debug("-> existing mapping on virq %d\n", virq
);
422 /* Allocate a virtual interrupt number */
423 virq
= irq_domain_alloc_descs(-1, 1, hwirq
,
424 of_node_to_nid(domain
->of_node
));
426 pr_debug("-> virq allocation failed\n");
430 if (irq_domain_associate(domain
, virq
, hwirq
)) {
435 pr_debug("irq %lu on domain %s mapped to virtual irq %u\n",
436 hwirq
, of_node_full_name(domain
->of_node
), virq
);
440 EXPORT_SYMBOL_GPL(irq_create_mapping
);
443 * irq_create_strict_mappings() - Map a range of hw irqs to fixed linux irqs
444 * @domain: domain owning the interrupt range
445 * @irq_base: beginning of linux IRQ range
446 * @hwirq_base: beginning of hardware IRQ range
447 * @count: Number of interrupts to map
449 * This routine is used for allocating and mapping a range of hardware
450 * irqs to linux irqs where the linux irq numbers are at pre-defined
451 * locations. For use by controllers that already have static mappings
452 * to insert in to the domain.
454 * Non-linear users can use irq_create_identity_mapping() for IRQ-at-a-time
457 * 0 is returned upon success, while any failure to establish a static
458 * mapping is treated as an error.
460 int irq_create_strict_mappings(struct irq_domain
*domain
, unsigned int irq_base
,
461 irq_hw_number_t hwirq_base
, int count
)
465 ret
= irq_alloc_descs(irq_base
, irq_base
, count
,
466 of_node_to_nid(domain
->of_node
));
467 if (unlikely(ret
< 0))
470 irq_domain_associate_many(domain
, irq_base
, hwirq_base
, count
);
473 EXPORT_SYMBOL_GPL(irq_create_strict_mappings
);
475 unsigned int irq_create_of_mapping(struct of_phandle_args
*irq_data
)
477 struct irq_domain
*domain
;
478 irq_hw_number_t hwirq
;
479 unsigned int type
= IRQ_TYPE_NONE
;
482 domain
= irq_data
->np
? irq_find_host(irq_data
->np
) : irq_default_domain
;
484 pr_warn("no irq domain found for %s !\n",
485 of_node_full_name(irq_data
->np
));
489 /* If domain has no translation, then we assume interrupt line */
490 if (domain
->ops
->xlate
== NULL
)
491 hwirq
= irq_data
->args
[0];
493 if (domain
->ops
->xlate(domain
, irq_data
->np
, irq_data
->args
,
494 irq_data
->args_count
, &hwirq
, &type
))
498 if (irq_domain_is_hierarchy(domain
)) {
500 * If we've already configured this interrupt,
501 * don't do it again, or hell will break loose.
503 virq
= irq_find_mapping(domain
, hwirq
);
507 virq
= irq_domain_alloc_irqs(domain
, 1, NUMA_NO_NODE
, irq_data
);
512 virq
= irq_create_mapping(domain
, hwirq
);
517 /* Set type if specified and different than the current one */
518 if (type
!= IRQ_TYPE_NONE
&&
519 type
!= irq_get_trigger_type(virq
))
520 irq_set_irq_type(virq
, type
);
523 EXPORT_SYMBOL_GPL(irq_create_of_mapping
);
526 * irq_dispose_mapping() - Unmap an interrupt
527 * @virq: linux irq number of the interrupt to unmap
529 void irq_dispose_mapping(unsigned int virq
)
531 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
532 struct irq_domain
*domain
;
534 if (!virq
|| !irq_data
)
537 domain
= irq_data
->domain
;
538 if (WARN_ON(domain
== NULL
))
541 irq_domain_disassociate(domain
, virq
);
544 EXPORT_SYMBOL_GPL(irq_dispose_mapping
);
547 * irq_find_mapping() - Find a linux irq from an hw irq number.
548 * @domain: domain owning this hardware interrupt
549 * @hwirq: hardware irq number in that domain space
551 unsigned int irq_find_mapping(struct irq_domain
*domain
,
552 irq_hw_number_t hwirq
)
554 struct irq_data
*data
;
556 /* Look for default domain if nececssary */
558 domain
= irq_default_domain
;
562 if (hwirq
< domain
->revmap_direct_max_irq
) {
563 data
= irq_domain_get_irq_data(domain
, hwirq
);
564 if (data
&& data
->hwirq
== hwirq
)
568 /* Check if the hwirq is in the linear revmap. */
569 if (hwirq
< domain
->revmap_size
)
570 return domain
->linear_revmap
[hwirq
];
573 data
= radix_tree_lookup(&domain
->revmap_tree
, hwirq
);
575 return data
? data
->irq
: 0;
577 EXPORT_SYMBOL_GPL(irq_find_mapping
);
579 #ifdef CONFIG_IRQ_DOMAIN_DEBUG
580 static int virq_debug_show(struct seq_file
*m
, void *private)
583 struct irq_desc
*desc
;
584 struct irq_domain
*domain
;
585 struct radix_tree_iter iter
;
589 seq_printf(m
, " %-16s %-6s %-10s %-10s %s\n",
590 "name", "mapped", "linear-max", "direct-max", "devtree-node");
591 mutex_lock(&irq_domain_mutex
);
592 list_for_each_entry(domain
, &irq_domain_list
, link
) {
594 radix_tree_for_each_slot(slot
, &domain
->revmap_tree
, &iter
, 0)
596 seq_printf(m
, "%c%-16s %6u %10u %10u %s\n",
597 domain
== irq_default_domain
? '*' : ' ', domain
->name
,
598 domain
->revmap_size
+ count
, domain
->revmap_size
,
599 domain
->revmap_direct_max_irq
,
600 domain
->of_node
? of_node_full_name(domain
->of_node
) : "");
602 mutex_unlock(&irq_domain_mutex
);
604 seq_printf(m
, "%-5s %-7s %-15s %-*s %6s %-14s %s\n", "irq", "hwirq",
605 "chip name", (int)(2 * sizeof(void *) + 2), "chip data",
606 "active", "type", "domain");
608 for (i
= 1; i
< nr_irqs
; i
++) {
609 desc
= irq_to_desc(i
);
613 raw_spin_lock_irqsave(&desc
->lock
, flags
);
614 domain
= desc
->irq_data
.domain
;
617 struct irq_chip
*chip
;
618 int hwirq
= desc
->irq_data
.hwirq
;
621 seq_printf(m
, "%5d ", i
);
622 seq_printf(m
, "0x%05x ", hwirq
);
624 chip
= irq_desc_get_chip(desc
);
625 seq_printf(m
, "%-15s ", (chip
&& chip
->name
) ? chip
->name
: "none");
627 data
= irq_desc_get_chip_data(desc
);
628 seq_printf(m
, data
? "0x%p " : " %p ", data
);
630 seq_printf(m
, " %c ", (desc
->action
&& desc
->action
->handler
) ? '*' : ' ');
631 direct
= (i
== hwirq
) && (i
< domain
->revmap_direct_max_irq
);
632 seq_printf(m
, "%6s%-8s ",
633 (hwirq
< domain
->revmap_size
) ? "LINEAR" : "RADIX",
634 direct
? "(DIRECT)" : "");
635 seq_printf(m
, "%s\n", desc
->irq_data
.domain
->name
);
638 raw_spin_unlock_irqrestore(&desc
->lock
, flags
);
644 static int virq_debug_open(struct inode
*inode
, struct file
*file
)
646 return single_open(file
, virq_debug_show
, inode
->i_private
);
649 static const struct file_operations virq_debug_fops
= {
650 .open
= virq_debug_open
,
653 .release
= single_release
,
656 static int __init
irq_debugfs_init(void)
658 if (debugfs_create_file("irq_domain_mapping", S_IRUGO
, NULL
,
659 NULL
, &virq_debug_fops
) == NULL
)
664 __initcall(irq_debugfs_init
);
665 #endif /* CONFIG_IRQ_DOMAIN_DEBUG */
668 * irq_domain_xlate_onecell() - Generic xlate for direct one cell bindings
670 * Device Tree IRQ specifier translation function which works with one cell
671 * bindings where the cell value maps directly to the hwirq number.
673 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
674 const u32
*intspec
, unsigned int intsize
,
675 unsigned long *out_hwirq
, unsigned int *out_type
)
677 if (WARN_ON(intsize
< 1))
679 *out_hwirq
= intspec
[0];
680 *out_type
= IRQ_TYPE_NONE
;
683 EXPORT_SYMBOL_GPL(irq_domain_xlate_onecell
);
686 * irq_domain_xlate_twocell() - Generic xlate for direct two cell bindings
688 * Device Tree IRQ specifier translation function which works with two cell
689 * bindings where the cell values map directly to the hwirq number
690 * and linux irq flags.
692 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
693 const u32
*intspec
, unsigned int intsize
,
694 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
)
696 if (WARN_ON(intsize
< 2))
698 *out_hwirq
= intspec
[0];
699 *out_type
= intspec
[1] & IRQ_TYPE_SENSE_MASK
;
702 EXPORT_SYMBOL_GPL(irq_domain_xlate_twocell
);
705 * irq_domain_xlate_onetwocell() - Generic xlate for one or two cell bindings
707 * Device Tree IRQ specifier translation function which works with either one
708 * or two cell bindings where the cell values map directly to the hwirq number
709 * and linux irq flags.
711 * Note: don't use this function unless your interrupt controller explicitly
712 * supports both one and two cell bindings. For the majority of controllers
713 * the _onecell() or _twocell() variants above should be used.
715 int irq_domain_xlate_onetwocell(struct irq_domain
*d
,
716 struct device_node
*ctrlr
,
717 const u32
*intspec
, unsigned int intsize
,
718 unsigned long *out_hwirq
, unsigned int *out_type
)
720 if (WARN_ON(intsize
< 1))
722 *out_hwirq
= intspec
[0];
723 *out_type
= (intsize
> 1) ? intspec
[1] : IRQ_TYPE_NONE
;
726 EXPORT_SYMBOL_GPL(irq_domain_xlate_onetwocell
);
728 const struct irq_domain_ops irq_domain_simple_ops
= {
729 .xlate
= irq_domain_xlate_onetwocell
,
731 EXPORT_SYMBOL_GPL(irq_domain_simple_ops
);
733 static int irq_domain_alloc_descs(int virq
, unsigned int cnt
,
734 irq_hw_number_t hwirq
, int node
)
739 virq
= irq_alloc_descs(virq
, virq
, cnt
, node
);
741 hint
= hwirq
% nr_irqs
;
744 virq
= irq_alloc_descs_from(hint
, cnt
, node
);
745 if (virq
<= 0 && hint
> 1)
746 virq
= irq_alloc_descs_from(1, cnt
, node
);
752 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
754 * irq_domain_add_hierarchy - Add a irqdomain into the hierarchy
755 * @parent: Parent irq domain to associate with the new domain
756 * @flags: Irq domain flags associated to the domain
757 * @size: Size of the domain. See below
758 * @node: Optional device-tree node of the interrupt controller
759 * @ops: Pointer to the interrupt domain callbacks
760 * @host_data: Controller private data pointer
762 * If @size is 0 a tree domain is created, otherwise a linear domain.
764 * If successful the parent is associated to the new domain and the
765 * domain flags are set.
766 * Returns pointer to IRQ domain, or NULL on failure.
768 struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
771 struct device_node
*node
,
772 const struct irq_domain_ops
*ops
,
775 struct irq_domain
*domain
;
778 domain
= irq_domain_add_linear(node
, size
, ops
, host_data
);
780 domain
= irq_domain_add_tree(node
, ops
, host_data
);
782 domain
->parent
= parent
;
783 domain
->flags
|= flags
;
789 static void irq_domain_insert_irq(int virq
)
791 struct irq_data
*data
;
793 for (data
= irq_get_irq_data(virq
); data
; data
= data
->parent_data
) {
794 struct irq_domain
*domain
= data
->domain
;
795 irq_hw_number_t hwirq
= data
->hwirq
;
797 if (hwirq
< domain
->revmap_size
) {
798 domain
->linear_revmap
[hwirq
] = virq
;
800 mutex_lock(&revmap_trees_mutex
);
801 radix_tree_insert(&domain
->revmap_tree
, hwirq
, data
);
802 mutex_unlock(&revmap_trees_mutex
);
805 /* If not already assigned, give the domain the chip's name */
806 if (!domain
->name
&& data
->chip
)
807 domain
->name
= data
->chip
->name
;
810 irq_clear_status_flags(virq
, IRQ_NOREQUEST
);
813 static void irq_domain_remove_irq(int virq
)
815 struct irq_data
*data
;
817 irq_set_status_flags(virq
, IRQ_NOREQUEST
);
818 irq_set_chip_and_handler(virq
, NULL
, NULL
);
819 synchronize_irq(virq
);
822 for (data
= irq_get_irq_data(virq
); data
; data
= data
->parent_data
) {
823 struct irq_domain
*domain
= data
->domain
;
824 irq_hw_number_t hwirq
= data
->hwirq
;
826 if (hwirq
< domain
->revmap_size
) {
827 domain
->linear_revmap
[hwirq
] = 0;
829 mutex_lock(&revmap_trees_mutex
);
830 radix_tree_delete(&domain
->revmap_tree
, hwirq
);
831 mutex_unlock(&revmap_trees_mutex
);
836 static struct irq_data
*irq_domain_insert_irq_data(struct irq_domain
*domain
,
837 struct irq_data
*child
)
839 struct irq_data
*irq_data
;
841 irq_data
= kzalloc_node(sizeof(*irq_data
), GFP_KERNEL
,
842 irq_data_get_node(child
));
844 child
->parent_data
= irq_data
;
845 irq_data
->irq
= child
->irq
;
846 irq_data
->common
= child
->common
;
847 irq_data
->node
= child
->node
;
848 irq_data
->domain
= domain
;
854 static void irq_domain_free_irq_data(unsigned int virq
, unsigned int nr_irqs
)
856 struct irq_data
*irq_data
, *tmp
;
859 for (i
= 0; i
< nr_irqs
; i
++) {
860 irq_data
= irq_get_irq_data(virq
+ i
);
861 tmp
= irq_data
->parent_data
;
862 irq_data
->parent_data
= NULL
;
863 irq_data
->domain
= NULL
;
867 tmp
= tmp
->parent_data
;
873 static int irq_domain_alloc_irq_data(struct irq_domain
*domain
,
874 unsigned int virq
, unsigned int nr_irqs
)
876 struct irq_data
*irq_data
;
877 struct irq_domain
*parent
;
880 /* The outermost irq_data is embedded in struct irq_desc */
881 for (i
= 0; i
< nr_irqs
; i
++) {
882 irq_data
= irq_get_irq_data(virq
+ i
);
883 irq_data
->domain
= domain
;
885 for (parent
= domain
->parent
; parent
; parent
= parent
->parent
) {
886 irq_data
= irq_domain_insert_irq_data(parent
, irq_data
);
888 irq_domain_free_irq_data(virq
, i
+ 1);
898 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
899 * @domain: domain to match
900 * @virq: IRQ number to get irq_data
902 struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
905 struct irq_data
*irq_data
;
907 for (irq_data
= irq_get_irq_data(virq
); irq_data
;
908 irq_data
= irq_data
->parent_data
)
909 if (irq_data
->domain
== domain
)
916 * irq_domain_set_hwirq_and_chip - Set hwirq and irqchip of @virq at @domain
917 * @domain: Interrupt domain to match
919 * @hwirq: The hwirq number
920 * @chip: The associated interrupt chip
921 * @chip_data: The associated chip data
923 int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
, unsigned int virq
,
924 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
927 struct irq_data
*irq_data
= irq_domain_get_irq_data(domain
, virq
);
932 irq_data
->hwirq
= hwirq
;
933 irq_data
->chip
= chip
? chip
: &no_irq_chip
;
934 irq_data
->chip_data
= chip_data
;
940 * irq_domain_set_info - Set the complete data for a @virq in @domain
941 * @domain: Interrupt domain to match
943 * @hwirq: The hardware interrupt number
944 * @chip: The associated interrupt chip
945 * @chip_data: The associated interrupt chip data
946 * @handler: The interrupt flow handler
947 * @handler_data: The interrupt flow handler data
948 * @handler_name: The interrupt handler name
950 void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
951 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
952 void *chip_data
, irq_flow_handler_t handler
,
953 void *handler_data
, const char *handler_name
)
955 irq_domain_set_hwirq_and_chip(domain
, virq
, hwirq
, chip
, chip_data
);
956 __irq_set_handler(virq
, handler
, 0, handler_name
);
957 irq_set_handler_data(virq
, handler_data
);
961 * irq_domain_reset_irq_data - Clear hwirq, chip and chip_data in @irq_data
962 * @irq_data: The pointer to irq_data
964 void irq_domain_reset_irq_data(struct irq_data
*irq_data
)
967 irq_data
->chip
= &no_irq_chip
;
968 irq_data
->chip_data
= NULL
;
972 * irq_domain_free_irqs_common - Clear irq_data and free the parent
973 * @domain: Interrupt domain to match
974 * @virq: IRQ number to start with
975 * @nr_irqs: The number of irqs to free
977 void irq_domain_free_irqs_common(struct irq_domain
*domain
, unsigned int virq
,
978 unsigned int nr_irqs
)
980 struct irq_data
*irq_data
;
983 for (i
= 0; i
< nr_irqs
; i
++) {
984 irq_data
= irq_domain_get_irq_data(domain
, virq
+ i
);
986 irq_domain_reset_irq_data(irq_data
);
988 irq_domain_free_irqs_parent(domain
, virq
, nr_irqs
);
992 * irq_domain_free_irqs_top - Clear handler and handler data, clear irqdata and free parent
993 * @domain: Interrupt domain to match
994 * @virq: IRQ number to start with
995 * @nr_irqs: The number of irqs to free
997 void irq_domain_free_irqs_top(struct irq_domain
*domain
, unsigned int virq
,
998 unsigned int nr_irqs
)
1002 for (i
= 0; i
< nr_irqs
; i
++) {
1003 irq_set_handler_data(virq
+ i
, NULL
);
1004 irq_set_handler(virq
+ i
, NULL
);
1006 irq_domain_free_irqs_common(domain
, virq
, nr_irqs
);
1009 static bool irq_domain_is_auto_recursive(struct irq_domain
*domain
)
1011 return domain
->flags
& IRQ_DOMAIN_FLAG_AUTO_RECURSIVE
;
1014 static void irq_domain_free_irqs_recursive(struct irq_domain
*domain
,
1015 unsigned int irq_base
,
1016 unsigned int nr_irqs
)
1018 domain
->ops
->free(domain
, irq_base
, nr_irqs
);
1019 if (irq_domain_is_auto_recursive(domain
)) {
1020 BUG_ON(!domain
->parent
);
1021 irq_domain_free_irqs_recursive(domain
->parent
, irq_base
,
1026 static int irq_domain_alloc_irqs_recursive(struct irq_domain
*domain
,
1027 unsigned int irq_base
,
1028 unsigned int nr_irqs
, void *arg
)
1031 struct irq_domain
*parent
= domain
->parent
;
1032 bool recursive
= irq_domain_is_auto_recursive(domain
);
1034 BUG_ON(recursive
&& !parent
);
1036 ret
= irq_domain_alloc_irqs_recursive(parent
, irq_base
,
1039 ret
= domain
->ops
->alloc(domain
, irq_base
, nr_irqs
, arg
);
1040 if (ret
< 0 && recursive
)
1041 irq_domain_free_irqs_recursive(parent
, irq_base
, nr_irqs
);
1047 * __irq_domain_alloc_irqs - Allocate IRQs from domain
1048 * @domain: domain to allocate from
1049 * @irq_base: allocate specified IRQ nubmer if irq_base >= 0
1050 * @nr_irqs: number of IRQs to allocate
1051 * @node: NUMA node id for memory allocation
1052 * @arg: domain specific argument
1053 * @realloc: IRQ descriptors have already been allocated if true
1055 * Allocate IRQ numbers and initialized all data structures to support
1056 * hierarchy IRQ domains.
1057 * Parameter @realloc is mainly to support legacy IRQs.
1058 * Returns error code or allocated IRQ number
1060 * The whole process to setup an IRQ has been split into two steps.
1061 * The first step, __irq_domain_alloc_irqs(), is to allocate IRQ
1062 * descriptor and required hardware resources. The second step,
1063 * irq_domain_activate_irq(), is to program hardwares with preallocated
1064 * resources. In this way, it's easier to rollback when failing to
1065 * allocate resources.
1067 int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
1068 unsigned int nr_irqs
, int node
, void *arg
,
1073 if (domain
== NULL
) {
1074 domain
= irq_default_domain
;
1075 if (WARN(!domain
, "domain is NULL; cannot allocate IRQ\n"))
1079 if (!domain
->ops
->alloc
) {
1080 pr_debug("domain->ops->alloc() is NULL\n");
1084 if (realloc
&& irq_base
>= 0) {
1087 virq
= irq_domain_alloc_descs(irq_base
, nr_irqs
, 0, node
);
1089 pr_debug("cannot allocate IRQ(base %d, count %d)\n",
1095 if (irq_domain_alloc_irq_data(domain
, virq
, nr_irqs
)) {
1096 pr_debug("cannot allocate memory for IRQ%d\n", virq
);
1101 mutex_lock(&irq_domain_mutex
);
1102 ret
= irq_domain_alloc_irqs_recursive(domain
, virq
, nr_irqs
, arg
);
1104 mutex_unlock(&irq_domain_mutex
);
1105 goto out_free_irq_data
;
1107 for (i
= 0; i
< nr_irqs
; i
++)
1108 irq_domain_insert_irq(virq
+ i
);
1109 mutex_unlock(&irq_domain_mutex
);
1114 irq_domain_free_irq_data(virq
, nr_irqs
);
1116 irq_free_descs(virq
, nr_irqs
);
1121 * irq_domain_free_irqs - Free IRQ number and associated data structures
1122 * @virq: base IRQ number
1123 * @nr_irqs: number of IRQs to free
1125 void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
)
1127 struct irq_data
*data
= irq_get_irq_data(virq
);
1130 if (WARN(!data
|| !data
->domain
|| !data
->domain
->ops
->free
,
1131 "NULL pointer, cannot free irq\n"))
1134 mutex_lock(&irq_domain_mutex
);
1135 for (i
= 0; i
< nr_irqs
; i
++)
1136 irq_domain_remove_irq(virq
+ i
);
1137 irq_domain_free_irqs_recursive(data
->domain
, virq
, nr_irqs
);
1138 mutex_unlock(&irq_domain_mutex
);
1140 irq_domain_free_irq_data(virq
, nr_irqs
);
1141 irq_free_descs(virq
, nr_irqs
);
1145 * irq_domain_alloc_irqs_parent - Allocate interrupts from parent domain
1146 * @irq_base: Base IRQ number
1147 * @nr_irqs: Number of IRQs to allocate
1148 * @arg: Allocation data (arch/domain specific)
1150 * Check whether the domain has been setup recursive. If not allocate
1151 * through the parent domain.
1153 int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
1154 unsigned int irq_base
, unsigned int nr_irqs
,
1157 /* irq_domain_alloc_irqs_recursive() has called parent's alloc() */
1158 if (irq_domain_is_auto_recursive(domain
))
1161 domain
= domain
->parent
;
1163 return irq_domain_alloc_irqs_recursive(domain
, irq_base
,
1169 * irq_domain_free_irqs_parent - Free interrupts from parent domain
1170 * @irq_base: Base IRQ number
1171 * @nr_irqs: Number of IRQs to free
1173 * Check whether the domain has been setup recursive. If not free
1174 * through the parent domain.
1176 void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
1177 unsigned int irq_base
, unsigned int nr_irqs
)
1179 /* irq_domain_free_irqs_recursive() will call parent's free */
1180 if (!irq_domain_is_auto_recursive(domain
) && domain
->parent
)
1181 irq_domain_free_irqs_recursive(domain
->parent
, irq_base
,
1186 * irq_domain_activate_irq - Call domain_ops->activate recursively to activate
1188 * @irq_data: outermost irq_data associated with interrupt
1190 * This is the second step to call domain_ops->activate to program interrupt
1191 * controllers, so the interrupt could actually get delivered.
1193 void irq_domain_activate_irq(struct irq_data
*irq_data
)
1195 if (irq_data
&& irq_data
->domain
) {
1196 struct irq_domain
*domain
= irq_data
->domain
;
1198 if (irq_data
->parent_data
)
1199 irq_domain_activate_irq(irq_data
->parent_data
);
1200 if (domain
->ops
->activate
)
1201 domain
->ops
->activate(domain
, irq_data
);
1206 * irq_domain_deactivate_irq - Call domain_ops->deactivate recursively to
1207 * deactivate interrupt
1208 * @irq_data: outermost irq_data associated with interrupt
1210 * It calls domain_ops->deactivate to program interrupt controllers to disable
1211 * interrupt delivery.
1213 void irq_domain_deactivate_irq(struct irq_data
*irq_data
)
1215 if (irq_data
&& irq_data
->domain
) {
1216 struct irq_domain
*domain
= irq_data
->domain
;
1218 if (domain
->ops
->deactivate
)
1219 domain
->ops
->deactivate(domain
, irq_data
);
1220 if (irq_data
->parent_data
)
1221 irq_domain_deactivate_irq(irq_data
->parent_data
);
1225 static void irq_domain_check_hierarchy(struct irq_domain
*domain
)
1227 /* Hierarchy irq_domains must implement callback alloc() */
1228 if (domain
->ops
->alloc
)
1229 domain
->flags
|= IRQ_DOMAIN_FLAG_HIERARCHY
;
1231 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
1233 * irq_domain_get_irq_data - Get irq_data associated with @virq and @domain
1234 * @domain: domain to match
1235 * @virq: IRQ number to get irq_data
1237 struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
1240 struct irq_data
*irq_data
= irq_get_irq_data(virq
);
1242 return (irq_data
&& irq_data
->domain
== domain
) ? irq_data
: NULL
;
1246 * irq_domain_set_info - Set the complete data for a @virq in @domain
1247 * @domain: Interrupt domain to match
1249 * @hwirq: The hardware interrupt number
1250 * @chip: The associated interrupt chip
1251 * @chip_data: The associated interrupt chip data
1252 * @handler: The interrupt flow handler
1253 * @handler_data: The interrupt flow handler data
1254 * @handler_name: The interrupt handler name
1256 void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
1257 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
1258 void *chip_data
, irq_flow_handler_t handler
,
1259 void *handler_data
, const char *handler_name
)
1261 irq_set_chip_and_handler_name(virq
, chip
, handler
, handler_name
);
1262 irq_set_chip_data(virq
, chip_data
);
1263 irq_set_handler_data(virq
, handler_data
);
1266 static void irq_domain_check_hierarchy(struct irq_domain
*domain
)
1269 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */