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/radix-tree.h>
45 /* Number of irqs reserved for a legacy isa controller */
46 #define NUM_ISA_INTERRUPTS 16
48 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
51 * struct irq_fwspec - generic IRQ specifier structure
53 * @fwnode: Pointer to a firmware-specific descriptor
54 * @param_count: Number of device-specific parameters
55 * @param: Device-specific parameters
57 * This structure, directly modeled after of_phandle_args, is used to
58 * pass a device-specific description of an interrupt.
61 struct fwnode_handle
*fwnode
;
63 u32 param
[IRQ_DOMAIN_IRQ_SPEC_PARAMS
];
67 * Should several domains have the same device node, but serve
68 * different purposes (for example one domain is for PCI/MSI, and the
69 * other for wired IRQs), they can be distinguished using a
70 * bus-specific token. Most domains are expected to only carry
73 enum irq_domain_bus_token
{
77 DOMAIN_BUS_PLATFORM_MSI
,
80 DOMAIN_BUS_FSL_MC_MSI
,
84 * struct irq_domain_ops - Methods for irq_domain objects
85 * @match: Match an interrupt controller device node to a host, returns
87 * @map: Create or update a mapping between a virtual irq number and a hw
88 * irq number. This is called only once for a given mapping.
89 * @unmap: Dispose of such a mapping
90 * @xlate: Given a device tree node and interrupt specifier, decode
91 * the hardware irq number and linux irq type value.
93 * Functions below are provided by the driver and called whenever a new mapping
94 * is created or an old mapping is disposed. The driver can then proceed to
95 * whatever internal data structures management is required. It also needs
96 * to setup the irq_desc when returning from map().
98 struct irq_domain_ops
{
99 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
100 enum irq_domain_bus_token bus_token
);
101 int (*select
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
102 enum irq_domain_bus_token bus_token
);
103 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
104 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
105 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
106 const u32
*intspec
, unsigned int intsize
,
107 unsigned long *out_hwirq
, unsigned int *out_type
);
109 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
110 /* extended V2 interfaces to support hierarchy irq_domains */
111 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
112 unsigned int nr_irqs
, void *arg
);
113 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
114 unsigned int nr_irqs
);
115 void (*activate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
116 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
117 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
118 unsigned long *out_hwirq
, unsigned int *out_type
);
122 extern struct irq_domain_ops irq_generic_chip_ops
;
124 struct irq_domain_chip_generic
;
127 * struct irq_domain - Hardware interrupt number translation object
128 * @link: Element in global irq_domain list.
129 * @name: Name of interrupt domain
130 * @ops: pointer to irq_domain methods
131 * @host_data: private data pointer for use by owner. Not touched by irq_domain
133 * @flags: host per irq_domain flags
134 * @mapcount: The number of mapped interrupts
137 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
138 * when decoding device tree interrupt specifiers.
139 * @gc: Pointer to a list of generic chips. There is a helper function for
140 * setting up one or more generic chips for interrupt controllers
141 * drivers using the generic chip library which uses this pointer.
142 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
143 * @debugfs_file: dentry for the domain debugfs file
145 * Revmap data, used internally by irq_domain
146 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
147 * support direct mapping
148 * @revmap_size: Size of the linear map table @linear_revmap[]
149 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
150 * @linear_revmap: Linear table of hwirq->virq reverse mappings
153 struct list_head link
;
155 const struct irq_domain_ops
*ops
;
158 unsigned int mapcount
;
161 struct fwnode_handle
*fwnode
;
162 enum irq_domain_bus_token bus_token
;
163 struct irq_domain_chip_generic
*gc
;
164 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
165 struct irq_domain
*parent
;
167 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
168 struct dentry
*debugfs_file
;
171 /* reverse map data. The linear map gets appended to the irq_domain */
172 irq_hw_number_t hwirq_max
;
173 unsigned int revmap_direct_max_irq
;
174 unsigned int revmap_size
;
175 struct radix_tree_root revmap_tree
;
176 unsigned int linear_revmap
[];
179 /* Irq domain flags */
181 /* Irq domain is hierarchical */
182 IRQ_DOMAIN_FLAG_HIERARCHY
= (1 << 0),
184 /* Irq domain name was allocated in __irq_domain_add() */
185 IRQ_DOMAIN_NAME_ALLOCATED
= (1 << 6),
187 /* Irq domain is an IPI domain with virq per cpu */
188 IRQ_DOMAIN_FLAG_IPI_PER_CPU
= (1 << 2),
190 /* Irq domain is an IPI domain with single virq */
191 IRQ_DOMAIN_FLAG_IPI_SINGLE
= (1 << 3),
193 /* Irq domain implements MSIs */
194 IRQ_DOMAIN_FLAG_MSI
= (1 << 4),
196 /* Irq domain implements MSI remapping */
197 IRQ_DOMAIN_FLAG_MSI_REMAP
= (1 << 5),
200 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
201 * for implementation specific purposes and ignored by the
204 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
207 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
209 return to_of_node(d
->fwnode
);
212 #ifdef CONFIG_IRQ_DOMAIN
213 struct fwnode_handle
*__irq_domain_alloc_fwnode(unsigned int type
, int id
,
214 const char *name
, void *data
);
218 IRQCHIP_FWNODE_NAMED
,
219 IRQCHIP_FWNODE_NAMED_ID
,
223 struct fwnode_handle
*irq_domain_alloc_named_fwnode(const char *name
)
225 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED
, 0, name
, NULL
);
229 struct fwnode_handle
*irq_domain_alloc_named_id_fwnode(const char *name
, int id
)
231 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID
, id
, name
,
235 static inline struct fwnode_handle
*irq_domain_alloc_fwnode(void *data
)
237 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL
, 0, NULL
, data
);
240 void irq_domain_free_fwnode(struct fwnode_handle
*fwnode
);
241 struct irq_domain
*__irq_domain_add(struct fwnode_handle
*fwnode
, int size
,
242 irq_hw_number_t hwirq_max
, int direct_max
,
243 const struct irq_domain_ops
*ops
,
245 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
247 unsigned int first_irq
,
248 const struct irq_domain_ops
*ops
,
250 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
252 unsigned int first_irq
,
253 irq_hw_number_t first_hwirq
,
254 const struct irq_domain_ops
*ops
,
256 extern struct irq_domain
*irq_find_matching_fwspec(struct irq_fwspec
*fwspec
,
257 enum irq_domain_bus_token bus_token
);
258 extern bool irq_domain_check_msi_remap(void);
259 extern void irq_set_default_host(struct irq_domain
*host
);
260 extern int irq_domain_alloc_descs(int virq
, unsigned int nr_irqs
,
261 irq_hw_number_t hwirq
, int node
,
262 const struct cpumask
*affinity
);
264 static inline struct fwnode_handle
*of_node_to_fwnode(struct device_node
*node
)
266 return node
? &node
->fwnode
: NULL
;
269 extern const struct fwnode_operations irqchip_fwnode_ops
;
271 static inline bool is_fwnode_irqchip(struct fwnode_handle
*fwnode
)
273 return fwnode
&& fwnode
->ops
== &irqchip_fwnode_ops
;
276 extern void irq_domain_update_bus_token(struct irq_domain
*domain
,
277 enum irq_domain_bus_token bus_token
);
280 struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
281 enum irq_domain_bus_token bus_token
)
283 struct irq_fwspec fwspec
= {
287 return irq_find_matching_fwspec(&fwspec
, bus_token
);
290 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
291 enum irq_domain_bus_token bus_token
)
293 return irq_find_matching_fwnode(of_node_to_fwnode(node
), bus_token
);
296 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
298 return irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
302 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
303 * @of_node: pointer to interrupt controller's device tree node.
304 * @size: Number of interrupts in the domain.
305 * @ops: map/unmap domain callbacks
306 * @host_data: Controller private data pointer
308 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
310 const struct irq_domain_ops
*ops
,
313 return __irq_domain_add(of_node_to_fwnode(of_node
), size
, size
, 0, ops
, host_data
);
315 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
316 unsigned int max_irq
,
317 const struct irq_domain_ops
*ops
,
320 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, max_irq
, max_irq
, ops
, host_data
);
322 static inline struct irq_domain
*irq_domain_add_legacy_isa(
323 struct device_node
*of_node
,
324 const struct irq_domain_ops
*ops
,
327 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
330 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
331 const struct irq_domain_ops
*ops
,
334 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, ~0, 0, ops
, host_data
);
337 static inline struct irq_domain
*irq_domain_create_linear(struct fwnode_handle
*fwnode
,
339 const struct irq_domain_ops
*ops
,
342 return __irq_domain_add(fwnode
, size
, size
, 0, ops
, host_data
);
345 static inline struct irq_domain
*irq_domain_create_tree(struct fwnode_handle
*fwnode
,
346 const struct irq_domain_ops
*ops
,
349 return __irq_domain_add(fwnode
, 0, ~0, 0, ops
, host_data
);
352 extern void irq_domain_remove(struct irq_domain
*host
);
354 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
355 irq_hw_number_t hwirq
);
356 extern void irq_domain_associate_many(struct irq_domain
*domain
,
357 unsigned int irq_base
,
358 irq_hw_number_t hwirq_base
, int count
);
359 extern void irq_domain_disassociate(struct irq_domain
*domain
,
362 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
363 irq_hw_number_t hwirq
);
364 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec
*fwspec
);
365 extern void irq_dispose_mapping(unsigned int virq
);
368 * irq_linear_revmap() - Find a linux irq from a hw irq number.
369 * @domain: domain owning this hardware interrupt
370 * @hwirq: hardware irq number in that domain space
372 * This is a fast path alternative to irq_find_mapping() that can be
373 * called directly by irq controller code to save a handful of
374 * instructions. It is always safe to call, but won't find irqs mapped
375 * using the radix tree.
377 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
378 irq_hw_number_t hwirq
)
380 return hwirq
< domain
->revmap_size
? domain
->linear_revmap
[hwirq
] : 0;
382 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
383 irq_hw_number_t hwirq
);
384 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
385 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
386 unsigned int irq_base
,
387 irq_hw_number_t hwirq_base
, int count
);
389 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
390 irq_hw_number_t hwirq
)
392 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
395 extern const struct irq_domain_ops irq_domain_simple_ops
;
397 /* stock xlate functions */
398 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
399 const u32
*intspec
, unsigned int intsize
,
400 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
401 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
402 const u32
*intspec
, unsigned int intsize
,
403 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
404 int irq_domain_xlate_onetwocell(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
);
409 int irq_reserve_ipi(struct irq_domain
*domain
, const struct cpumask
*dest
);
410 int irq_destroy_ipi(unsigned int irq
, const struct cpumask
*dest
);
412 /* V2 interfaces to support hierarchy IRQ domains. */
413 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
415 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
416 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
417 void *chip_data
, irq_flow_handler_t handler
,
418 void *handler_data
, const char *handler_name
);
419 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
420 extern struct irq_domain
*irq_domain_create_hierarchy(struct irq_domain
*parent
,
421 unsigned int flags
, unsigned int size
,
422 struct fwnode_handle
*fwnode
,
423 const struct irq_domain_ops
*ops
, void *host_data
);
425 static inline struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
428 struct device_node
*node
,
429 const struct irq_domain_ops
*ops
,
432 return irq_domain_create_hierarchy(parent
, flags
, size
,
433 of_node_to_fwnode(node
),
437 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
438 unsigned int nr_irqs
, int node
, void *arg
,
439 bool realloc
, const struct cpumask
*affinity
);
440 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
441 extern void irq_domain_activate_irq(struct irq_data
*irq_data
);
442 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
444 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
445 unsigned int nr_irqs
, int node
, void *arg
)
447 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false,
451 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain
*domain
,
452 unsigned int irq_base
,
453 unsigned int nr_irqs
, void *arg
);
454 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
456 irq_hw_number_t hwirq
,
457 struct irq_chip
*chip
,
459 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
460 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
462 unsigned int nr_irqs
);
463 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
464 unsigned int virq
, unsigned int nr_irqs
);
466 extern int irq_domain_push_irq(struct irq_domain
*domain
, int virq
, void *arg
);
467 extern int irq_domain_pop_irq(struct irq_domain
*domain
, int virq
);
469 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
470 unsigned int irq_base
,
471 unsigned int nr_irqs
, void *arg
);
473 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
474 unsigned int irq_base
,
475 unsigned int nr_irqs
);
477 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
479 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
482 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
484 return domain
->flags
&
485 (IRQ_DOMAIN_FLAG_IPI_PER_CPU
| IRQ_DOMAIN_FLAG_IPI_SINGLE
);
488 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
490 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_PER_CPU
;
493 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
495 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_SINGLE
;
498 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
500 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI
;
503 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
505 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI_REMAP
;
508 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
);
510 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
511 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
512 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
513 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
514 unsigned int nr_irqs
, int node
, void *arg
)
519 static inline void irq_domain_free_irqs(unsigned int virq
,
520 unsigned int nr_irqs
) { }
522 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
527 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
532 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
537 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
542 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
547 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
553 irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
)
557 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
559 #else /* CONFIG_IRQ_DOMAIN */
560 static inline void irq_dispose_mapping(unsigned int virq
) { }
561 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
562 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
563 static inline struct irq_domain
*irq_find_matching_fwnode(
564 struct fwnode_handle
*fwnode
, enum irq_domain_bus_token bus_token
)
568 static inline bool irq_domain_check_msi_remap(void)
572 #endif /* !CONFIG_IRQ_DOMAIN */
574 #endif /* _LINUX_IRQDOMAIN_H */