1 /* SPDX-License-Identifier: GPL-2.0 */
3 * irq_domain - IRQ translation domains
5 * Translation infrastructure between hw and linux irq numbers. This is
6 * helpful for interrupt controllers to implement mapping between hardware
7 * irq numbers and the Linux irq number space.
9 * irq_domains also have hooks for translating device tree or other
10 * firmware interrupt representations into a hardware irq number that
11 * can be mapped back to a Linux irq number without any extra platform
14 * Interrupt controller "domain" data structure. This could be defined as a
15 * irq domain controller. That is, it handles the mapping between hardware
16 * and virtual interrupt numbers for a given interrupt domain. The domain
17 * structure is generally created by the PIC code for a given PIC instance
18 * (though a domain can cover more than one PIC if they have a flat number
19 * model). It's the domain callbacks that are responsible for setting the
20 * irq_chip on a given irq_desc after it's been mapped.
22 * The host code and data structures use a fwnode_handle pointer to
23 * identify the domain. In some cases, and in order to preserve source
24 * code compatibility, this fwnode pointer is "upgraded" to a DT
25 * device_node. For those firmware infrastructures that do not provide
26 * a unique identifier for an interrupt controller, the irq_domain
27 * code offers a fwnode allocator.
30 #ifndef _LINUX_IRQDOMAIN_H
31 #define _LINUX_IRQDOMAIN_H
33 #include <linux/types.h>
34 #include <linux/irqhandler.h>
36 #include <linux/mutex.h>
37 #include <linux/radix-tree.h>
47 /* Number of irqs reserved for a legacy isa controller */
48 #define NUM_ISA_INTERRUPTS 16
50 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
53 * struct irq_fwspec - generic IRQ specifier structure
55 * @fwnode: Pointer to a firmware-specific descriptor
56 * @param_count: Number of device-specific parameters
57 * @param: Device-specific parameters
59 * This structure, directly modeled after of_phandle_args, is used to
60 * pass a device-specific description of an interrupt.
63 struct fwnode_handle
*fwnode
;
65 u32 param
[IRQ_DOMAIN_IRQ_SPEC_PARAMS
];
69 * Should several domains have the same device node, but serve
70 * different purposes (for example one domain is for PCI/MSI, and the
71 * other for wired IRQs), they can be distinguished using a
72 * bus-specific token. Most domains are expected to only carry
75 enum irq_domain_bus_token
{
79 DOMAIN_BUS_PLATFORM_MSI
,
82 DOMAIN_BUS_FSL_MC_MSI
,
86 * struct irq_domain_ops - Methods for irq_domain objects
87 * @match: Match an interrupt controller device node to a host, returns
89 * @map: Create or update a mapping between a virtual irq number and a hw
90 * irq number. This is called only once for a given mapping.
91 * @unmap: Dispose of such a mapping
92 * @xlate: Given a device tree node and interrupt specifier, decode
93 * the hardware irq number and linux irq type value.
95 * Functions below are provided by the driver and called whenever a new mapping
96 * is created or an old mapping is disposed. The driver can then proceed to
97 * whatever internal data structures management is required. It also needs
98 * to setup the irq_desc when returning from map().
100 struct irq_domain_ops
{
101 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
102 enum irq_domain_bus_token bus_token
);
103 int (*select
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
104 enum irq_domain_bus_token bus_token
);
105 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
106 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
107 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
108 const u32
*intspec
, unsigned int intsize
,
109 unsigned long *out_hwirq
, unsigned int *out_type
);
110 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
111 /* extended V2 interfaces to support hierarchy irq_domains */
112 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
113 unsigned int nr_irqs
, void *arg
);
114 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
115 unsigned int nr_irqs
);
116 int (*activate
)(struct irq_domain
*d
, struct irq_data
*irqd
, bool reserve
);
117 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
118 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
119 unsigned long *out_hwirq
, unsigned int *out_type
);
121 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
122 void (*debug_show
)(struct seq_file
*m
, struct irq_domain
*d
,
123 struct irq_data
*irqd
, int ind
);
127 extern struct irq_domain_ops irq_generic_chip_ops
;
129 struct irq_domain_chip_generic
;
132 * struct irq_domain - Hardware interrupt number translation object
133 * @link: Element in global irq_domain list.
134 * @name: Name of interrupt domain
135 * @ops: pointer to irq_domain methods
136 * @host_data: private data pointer for use by owner. Not touched by irq_domain
138 * @flags: host per irq_domain flags
139 * @mapcount: The number of mapped interrupts
142 * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
143 * to swap it for the of_node via the irq_domain_get_of_node accessor
144 * @gc: Pointer to a list of generic chips. There is a helper function for
145 * setting up one or more generic chips for interrupt controllers
146 * drivers using the generic chip library which uses this pointer.
147 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
148 * @debugfs_file: dentry for the domain debugfs file
150 * Revmap data, used internally by irq_domain
151 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
152 * support direct mapping
153 * @revmap_size: Size of the linear map table @linear_revmap[]
154 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
155 * @linear_revmap: Linear table of hwirq->virq reverse mappings
158 struct list_head link
;
160 const struct irq_domain_ops
*ops
;
163 unsigned int mapcount
;
166 struct fwnode_handle
*fwnode
;
167 enum irq_domain_bus_token bus_token
;
168 struct irq_domain_chip_generic
*gc
;
169 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
170 struct irq_domain
*parent
;
172 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
173 struct dentry
*debugfs_file
;
176 /* reverse map data. The linear map gets appended to the irq_domain */
177 irq_hw_number_t hwirq_max
;
178 unsigned int revmap_direct_max_irq
;
179 unsigned int revmap_size
;
180 struct radix_tree_root revmap_tree
;
181 struct mutex revmap_tree_mutex
;
182 unsigned int linear_revmap
[];
185 /* Irq domain flags */
187 /* Irq domain is hierarchical */
188 IRQ_DOMAIN_FLAG_HIERARCHY
= (1 << 0),
190 /* Irq domain name was allocated in __irq_domain_add() */
191 IRQ_DOMAIN_NAME_ALLOCATED
= (1 << 6),
193 /* Irq domain is an IPI domain with virq per cpu */
194 IRQ_DOMAIN_FLAG_IPI_PER_CPU
= (1 << 2),
196 /* Irq domain is an IPI domain with single virq */
197 IRQ_DOMAIN_FLAG_IPI_SINGLE
= (1 << 3),
199 /* Irq domain implements MSIs */
200 IRQ_DOMAIN_FLAG_MSI
= (1 << 4),
202 /* Irq domain implements MSI remapping */
203 IRQ_DOMAIN_FLAG_MSI_REMAP
= (1 << 5),
206 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
207 * for implementation specific purposes and ignored by the
210 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
213 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
215 return to_of_node(d
->fwnode
);
218 #ifdef CONFIG_IRQ_DOMAIN
219 struct fwnode_handle
*__irq_domain_alloc_fwnode(unsigned int type
, int id
,
220 const char *name
, void *data
);
224 IRQCHIP_FWNODE_NAMED
,
225 IRQCHIP_FWNODE_NAMED_ID
,
229 struct fwnode_handle
*irq_domain_alloc_named_fwnode(const char *name
)
231 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED
, 0, name
, NULL
);
235 struct fwnode_handle
*irq_domain_alloc_named_id_fwnode(const char *name
, int id
)
237 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID
, id
, name
,
241 static inline struct fwnode_handle
*irq_domain_alloc_fwnode(void *data
)
243 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL
, 0, NULL
, data
);
246 void irq_domain_free_fwnode(struct fwnode_handle
*fwnode
);
247 struct irq_domain
*__irq_domain_add(struct fwnode_handle
*fwnode
, int size
,
248 irq_hw_number_t hwirq_max
, int direct_max
,
249 const struct irq_domain_ops
*ops
,
251 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
253 unsigned int first_irq
,
254 const struct irq_domain_ops
*ops
,
256 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
258 unsigned int first_irq
,
259 irq_hw_number_t first_hwirq
,
260 const struct irq_domain_ops
*ops
,
262 extern struct irq_domain
*irq_find_matching_fwspec(struct irq_fwspec
*fwspec
,
263 enum irq_domain_bus_token bus_token
);
264 extern bool irq_domain_check_msi_remap(void);
265 extern void irq_set_default_host(struct irq_domain
*host
);
266 extern int irq_domain_alloc_descs(int virq
, unsigned int nr_irqs
,
267 irq_hw_number_t hwirq
, int node
,
268 const struct cpumask
*affinity
);
270 static inline struct fwnode_handle
*of_node_to_fwnode(struct device_node
*node
)
272 return node
? &node
->fwnode
: NULL
;
275 extern const struct fwnode_operations irqchip_fwnode_ops
;
277 static inline bool is_fwnode_irqchip(struct fwnode_handle
*fwnode
)
279 return fwnode
&& fwnode
->ops
== &irqchip_fwnode_ops
;
282 extern void irq_domain_update_bus_token(struct irq_domain
*domain
,
283 enum irq_domain_bus_token bus_token
);
286 struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
287 enum irq_domain_bus_token bus_token
)
289 struct irq_fwspec fwspec
= {
293 return irq_find_matching_fwspec(&fwspec
, bus_token
);
296 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
297 enum irq_domain_bus_token bus_token
)
299 return irq_find_matching_fwnode(of_node_to_fwnode(node
), bus_token
);
302 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
304 return irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
308 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
309 * @of_node: pointer to interrupt controller's device tree node.
310 * @size: Number of interrupts in the domain.
311 * @ops: map/unmap domain callbacks
312 * @host_data: Controller private data pointer
314 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
316 const struct irq_domain_ops
*ops
,
319 return __irq_domain_add(of_node_to_fwnode(of_node
), size
, size
, 0, ops
, host_data
);
321 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
322 unsigned int max_irq
,
323 const struct irq_domain_ops
*ops
,
326 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, max_irq
, max_irq
, ops
, host_data
);
328 static inline struct irq_domain
*irq_domain_add_legacy_isa(
329 struct device_node
*of_node
,
330 const struct irq_domain_ops
*ops
,
333 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
336 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
337 const struct irq_domain_ops
*ops
,
340 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, ~0, 0, ops
, host_data
);
343 static inline struct irq_domain
*irq_domain_create_linear(struct fwnode_handle
*fwnode
,
345 const struct irq_domain_ops
*ops
,
348 return __irq_domain_add(fwnode
, size
, size
, 0, ops
, host_data
);
351 static inline struct irq_domain
*irq_domain_create_tree(struct fwnode_handle
*fwnode
,
352 const struct irq_domain_ops
*ops
,
355 return __irq_domain_add(fwnode
, 0, ~0, 0, ops
, host_data
);
358 extern void irq_domain_remove(struct irq_domain
*host
);
360 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
361 irq_hw_number_t hwirq
);
362 extern void irq_domain_associate_many(struct irq_domain
*domain
,
363 unsigned int irq_base
,
364 irq_hw_number_t hwirq_base
, int count
);
365 extern void irq_domain_disassociate(struct irq_domain
*domain
,
368 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
369 irq_hw_number_t hwirq
);
370 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec
*fwspec
);
371 extern void irq_dispose_mapping(unsigned int virq
);
374 * irq_linear_revmap() - Find a linux irq from a hw irq number.
375 * @domain: domain owning this hardware interrupt
376 * @hwirq: hardware irq number in that domain space
378 * This is a fast path alternative to irq_find_mapping() that can be
379 * called directly by irq controller code to save a handful of
380 * instructions. It is always safe to call, but won't find irqs mapped
381 * using the radix tree.
383 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
384 irq_hw_number_t hwirq
)
386 return hwirq
< domain
->revmap_size
? domain
->linear_revmap
[hwirq
] : 0;
388 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
389 irq_hw_number_t hwirq
);
390 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
391 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
392 unsigned int irq_base
,
393 irq_hw_number_t hwirq_base
, int count
);
395 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
396 irq_hw_number_t hwirq
)
398 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
401 extern const struct irq_domain_ops irq_domain_simple_ops
;
403 /* stock xlate functions */
404 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
405 const u32
*intspec
, unsigned int intsize
,
406 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
407 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
408 const u32
*intspec
, unsigned int intsize
,
409 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
410 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
411 const u32
*intspec
, unsigned int intsize
,
412 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
415 int irq_reserve_ipi(struct irq_domain
*domain
, const struct cpumask
*dest
);
416 int irq_destroy_ipi(unsigned int irq
, const struct cpumask
*dest
);
418 /* V2 interfaces to support hierarchy IRQ domains. */
419 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
421 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
422 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
423 void *chip_data
, irq_flow_handler_t handler
,
424 void *handler_data
, const char *handler_name
);
425 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
426 extern struct irq_domain
*irq_domain_create_hierarchy(struct irq_domain
*parent
,
427 unsigned int flags
, unsigned int size
,
428 struct fwnode_handle
*fwnode
,
429 const struct irq_domain_ops
*ops
, void *host_data
);
431 static inline struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
434 struct device_node
*node
,
435 const struct irq_domain_ops
*ops
,
438 return irq_domain_create_hierarchy(parent
, flags
, size
,
439 of_node_to_fwnode(node
),
443 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
444 unsigned int nr_irqs
, int node
, void *arg
,
445 bool realloc
, const struct cpumask
*affinity
);
446 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
447 extern int irq_domain_activate_irq(struct irq_data
*irq_data
, bool early
);
448 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
450 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
451 unsigned int nr_irqs
, int node
, void *arg
)
453 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false,
457 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain
*domain
,
458 unsigned int irq_base
,
459 unsigned int nr_irqs
, void *arg
);
460 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
462 irq_hw_number_t hwirq
,
463 struct irq_chip
*chip
,
465 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
466 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
468 unsigned int nr_irqs
);
469 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
470 unsigned int virq
, unsigned int nr_irqs
);
472 extern int irq_domain_push_irq(struct irq_domain
*domain
, int virq
, void *arg
);
473 extern int irq_domain_pop_irq(struct irq_domain
*domain
, int virq
);
475 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
476 unsigned int irq_base
,
477 unsigned int nr_irqs
, void *arg
);
479 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
480 unsigned int irq_base
,
481 unsigned int nr_irqs
);
483 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
485 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
488 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
490 return domain
->flags
&
491 (IRQ_DOMAIN_FLAG_IPI_PER_CPU
| IRQ_DOMAIN_FLAG_IPI_SINGLE
);
494 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
496 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_PER_CPU
;
499 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
501 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_SINGLE
;
504 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
506 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI
;
509 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
511 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI_REMAP
;
514 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
);
516 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
517 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
518 unsigned int nr_irqs
, int node
, void *arg
)
523 static inline void irq_domain_free_irqs(unsigned int virq
,
524 unsigned int nr_irqs
) { }
526 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
531 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
536 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
541 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
546 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
551 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
557 irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
)
561 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
563 #else /* CONFIG_IRQ_DOMAIN */
564 static inline void irq_dispose_mapping(unsigned int virq
) { }
565 static inline struct irq_domain
*irq_find_matching_fwnode(
566 struct fwnode_handle
*fwnode
, enum irq_domain_bus_token bus_token
)
570 static inline bool irq_domain_check_msi_remap(void)
574 #endif /* !CONFIG_IRQ_DOMAIN */
576 #endif /* _LINUX_IRQDOMAIN_H */