2 * irq_domain - IRQ translation domains
4 * Translation infrastructure between hw and linux irq numbers. This is
5 * helpful for interrupt controllers to implement mapping between hardware
6 * irq numbers and the Linux irq number space.
8 * irq_domains also have hooks for translating device tree or other
9 * firmware interrupt representations into a hardware irq number that
10 * can be mapped back to a Linux irq number without any extra platform
13 * Interrupt controller "domain" data structure. This could be defined as a
14 * irq domain controller. That is, it handles the mapping between hardware
15 * and virtual interrupt numbers for a given interrupt domain. The domain
16 * structure is generally created by the PIC code for a given PIC instance
17 * (though a domain can cover more than one PIC if they have a flat number
18 * model). It's the domain callbacks that are responsible for setting the
19 * irq_chip on a given irq_desc after it's been mapped.
21 * The host code and data structures use a fwnode_handle pointer to
22 * identify the domain. In some cases, and in order to preserve source
23 * code compatibility, this fwnode pointer is "upgraded" to a DT
24 * device_node. For those firmware infrastructures that do not provide
25 * a unique identifier for an interrupt controller, the irq_domain
26 * code offers a fwnode allocator.
29 #ifndef _LINUX_IRQDOMAIN_H
30 #define _LINUX_IRQDOMAIN_H
32 #include <linux/types.h>
33 #include <linux/irqhandler.h>
35 #include <linux/radix-tree.h>
44 /* Number of irqs reserved for a legacy isa controller */
45 #define NUM_ISA_INTERRUPTS 16
47 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
50 * struct irq_fwspec - generic IRQ specifier structure
52 * @fwnode: Pointer to a firmware-specific descriptor
53 * @param_count: Number of device-specific parameters
54 * @param: Device-specific parameters
56 * This structure, directly modeled after of_phandle_args, is used to
57 * pass a device-specific description of an interrupt.
60 struct fwnode_handle
*fwnode
;
62 u32 param
[IRQ_DOMAIN_IRQ_SPEC_PARAMS
];
66 * Should several domains have the same device node, but serve
67 * different purposes (for example one domain is for PCI/MSI, and the
68 * other for wired IRQs), they can be distinguished using a
69 * bus-specific token. Most domains are expected to only carry
72 enum irq_domain_bus_token
{
76 DOMAIN_BUS_PLATFORM_MSI
,
79 DOMAIN_BUS_FSL_MC_MSI
,
83 * struct irq_domain_ops - Methods for irq_domain objects
84 * @match: Match an interrupt controller device node to a host, returns
86 * @map: Create or update a mapping between a virtual irq number and a hw
87 * irq number. This is called only once for a given mapping.
88 * @unmap: Dispose of such a mapping
89 * @xlate: Given a device tree node and interrupt specifier, decode
90 * the hardware irq number and linux irq type value.
92 * Functions below are provided by the driver and called whenever a new mapping
93 * is created or an old mapping is disposed. The driver can then proceed to
94 * whatever internal data structures management is required. It also needs
95 * to setup the irq_desc when returning from map().
97 struct irq_domain_ops
{
98 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
99 enum irq_domain_bus_token bus_token
);
100 int (*select
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
101 enum irq_domain_bus_token bus_token
);
102 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
103 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
104 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
105 const u32
*intspec
, unsigned int intsize
,
106 unsigned long *out_hwirq
, unsigned int *out_type
);
108 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
109 /* extended V2 interfaces to support hierarchy irq_domains */
110 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
111 unsigned int nr_irqs
, void *arg
);
112 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
113 unsigned int nr_irqs
);
114 void (*activate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
115 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
116 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
117 unsigned long *out_hwirq
, unsigned int *out_type
);
121 extern struct irq_domain_ops irq_generic_chip_ops
;
123 struct irq_domain_chip_generic
;
126 * struct irq_domain - Hardware interrupt number translation object
127 * @link: Element in global irq_domain list.
128 * @name: Name of interrupt domain
129 * @ops: pointer to irq_domain methods
130 * @host_data: private data pointer for use by owner. Not touched by irq_domain
132 * @flags: host per irq_domain flags
135 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
136 * when decoding device tree interrupt specifiers.
137 * @gc: Pointer to a list of generic chips. There is a helper function for
138 * setting up one or more generic chips for interrupt controllers
139 * drivers using the generic chip library which uses this pointer.
140 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
142 * Revmap data, used internally by irq_domain
143 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
144 * support direct mapping
145 * @revmap_size: Size of the linear map table @linear_revmap[]
146 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
147 * @linear_revmap: Linear table of hwirq->virq reverse mappings
150 struct list_head link
;
152 const struct irq_domain_ops
*ops
;
157 struct fwnode_handle
*fwnode
;
158 enum irq_domain_bus_token bus_token
;
159 struct irq_domain_chip_generic
*gc
;
160 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
161 struct irq_domain
*parent
;
164 /* reverse map data. The linear map gets appended to the irq_domain */
165 irq_hw_number_t hwirq_max
;
166 unsigned int revmap_direct_max_irq
;
167 unsigned int revmap_size
;
168 struct radix_tree_root revmap_tree
;
169 unsigned int linear_revmap
[];
172 /* Irq domain flags */
174 /* Irq domain is hierarchical */
175 IRQ_DOMAIN_FLAG_HIERARCHY
= (1 << 0),
177 /* Core calls alloc/free recursive through the domain hierarchy. */
178 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE
= (1 << 1),
180 /* Irq domain is an IPI domain with virq per cpu */
181 IRQ_DOMAIN_FLAG_IPI_PER_CPU
= (1 << 2),
183 /* Irq domain is an IPI domain with single virq */
184 IRQ_DOMAIN_FLAG_IPI_SINGLE
= (1 << 3),
186 /* Irq domain implements MSIs */
187 IRQ_DOMAIN_FLAG_MSI
= (1 << 4),
189 /* Irq domain implements MSI remapping */
190 IRQ_DOMAIN_FLAG_MSI_REMAP
= (1 << 5),
193 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
194 * for implementation specific purposes and ignored by the
197 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
200 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
202 return to_of_node(d
->fwnode
);
205 #ifdef CONFIG_IRQ_DOMAIN
206 struct fwnode_handle
*irq_domain_alloc_fwnode(void *data
);
207 void irq_domain_free_fwnode(struct fwnode_handle
*fwnode
);
208 struct irq_domain
*__irq_domain_add(struct fwnode_handle
*fwnode
, int size
,
209 irq_hw_number_t hwirq_max
, int direct_max
,
210 const struct irq_domain_ops
*ops
,
212 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
214 unsigned int first_irq
,
215 const struct irq_domain_ops
*ops
,
217 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
219 unsigned int first_irq
,
220 irq_hw_number_t first_hwirq
,
221 const struct irq_domain_ops
*ops
,
223 extern struct irq_domain
*irq_find_matching_fwspec(struct irq_fwspec
*fwspec
,
224 enum irq_domain_bus_token bus_token
);
225 extern bool irq_domain_check_msi_remap(void);
226 extern void irq_set_default_host(struct irq_domain
*host
);
227 extern int irq_domain_alloc_descs(int virq
, unsigned int nr_irqs
,
228 irq_hw_number_t hwirq
, int node
,
229 const struct cpumask
*affinity
);
231 static inline struct fwnode_handle
*of_node_to_fwnode(struct device_node
*node
)
233 return node
? &node
->fwnode
: NULL
;
236 static inline bool is_fwnode_irqchip(struct fwnode_handle
*fwnode
)
238 return fwnode
&& fwnode
->type
== FWNODE_IRQCHIP
;
242 struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
243 enum irq_domain_bus_token bus_token
)
245 struct irq_fwspec fwspec
= {
249 return irq_find_matching_fwspec(&fwspec
, bus_token
);
252 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
253 enum irq_domain_bus_token bus_token
)
255 return irq_find_matching_fwnode(of_node_to_fwnode(node
), bus_token
);
258 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
260 return irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
264 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
265 * @of_node: pointer to interrupt controller's device tree node.
266 * @size: Number of interrupts in the domain.
267 * @ops: map/unmap domain callbacks
268 * @host_data: Controller private data pointer
270 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
272 const struct irq_domain_ops
*ops
,
275 return __irq_domain_add(of_node_to_fwnode(of_node
), size
, size
, 0, ops
, host_data
);
277 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
278 unsigned int max_irq
,
279 const struct irq_domain_ops
*ops
,
282 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, max_irq
, max_irq
, ops
, host_data
);
284 static inline struct irq_domain
*irq_domain_add_legacy_isa(
285 struct device_node
*of_node
,
286 const struct irq_domain_ops
*ops
,
289 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
292 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
293 const struct irq_domain_ops
*ops
,
296 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, ~0, 0, ops
, host_data
);
299 static inline struct irq_domain
*irq_domain_create_linear(struct fwnode_handle
*fwnode
,
301 const struct irq_domain_ops
*ops
,
304 return __irq_domain_add(fwnode
, size
, size
, 0, ops
, host_data
);
307 static inline struct irq_domain
*irq_domain_create_tree(struct fwnode_handle
*fwnode
,
308 const struct irq_domain_ops
*ops
,
311 return __irq_domain_add(fwnode
, 0, ~0, 0, ops
, host_data
);
314 extern void irq_domain_remove(struct irq_domain
*host
);
316 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
317 irq_hw_number_t hwirq
);
318 extern void irq_domain_associate_many(struct irq_domain
*domain
,
319 unsigned int irq_base
,
320 irq_hw_number_t hwirq_base
, int count
);
321 extern void irq_domain_disassociate(struct irq_domain
*domain
,
324 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
325 irq_hw_number_t hwirq
);
326 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec
*fwspec
);
327 extern void irq_dispose_mapping(unsigned int virq
);
330 * irq_linear_revmap() - Find a linux irq from a hw irq number.
331 * @domain: domain owning this hardware interrupt
332 * @hwirq: hardware irq number in that domain space
334 * This is a fast path alternative to irq_find_mapping() that can be
335 * called directly by irq controller code to save a handful of
336 * instructions. It is always safe to call, but won't find irqs mapped
337 * using the radix tree.
339 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
340 irq_hw_number_t hwirq
)
342 return hwirq
< domain
->revmap_size
? domain
->linear_revmap
[hwirq
] : 0;
344 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
345 irq_hw_number_t hwirq
);
346 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
347 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
348 unsigned int irq_base
,
349 irq_hw_number_t hwirq_base
, int count
);
351 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
352 irq_hw_number_t hwirq
)
354 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
357 extern const struct irq_domain_ops irq_domain_simple_ops
;
359 /* stock xlate functions */
360 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
361 const u32
*intspec
, unsigned int intsize
,
362 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
363 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
364 const u32
*intspec
, unsigned int intsize
,
365 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
366 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
367 const u32
*intspec
, unsigned int intsize
,
368 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
371 int irq_reserve_ipi(struct irq_domain
*domain
, const struct cpumask
*dest
);
372 int irq_destroy_ipi(unsigned int irq
, const struct cpumask
*dest
);
374 /* V2 interfaces to support hierarchy IRQ domains. */
375 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
377 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
378 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
379 void *chip_data
, irq_flow_handler_t handler
,
380 void *handler_data
, const char *handler_name
);
381 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
382 extern struct irq_domain
*irq_domain_create_hierarchy(struct irq_domain
*parent
,
383 unsigned int flags
, unsigned int size
,
384 struct fwnode_handle
*fwnode
,
385 const struct irq_domain_ops
*ops
, void *host_data
);
387 static inline struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
390 struct device_node
*node
,
391 const struct irq_domain_ops
*ops
,
394 return irq_domain_create_hierarchy(parent
, flags
, size
,
395 of_node_to_fwnode(node
),
399 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
400 unsigned int nr_irqs
, int node
, void *arg
,
401 bool realloc
, const struct cpumask
*affinity
);
402 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
403 extern void irq_domain_activate_irq(struct irq_data
*irq_data
);
404 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
406 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
407 unsigned int nr_irqs
, int node
, void *arg
)
409 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false,
413 extern int irq_domain_alloc_irqs_recursive(struct irq_domain
*domain
,
414 unsigned int irq_base
,
415 unsigned int nr_irqs
, void *arg
);
416 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
418 irq_hw_number_t hwirq
,
419 struct irq_chip
*chip
,
421 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
422 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
424 unsigned int nr_irqs
);
425 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
426 unsigned int virq
, unsigned int nr_irqs
);
428 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
429 unsigned int irq_base
,
430 unsigned int nr_irqs
, void *arg
);
432 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
433 unsigned int irq_base
,
434 unsigned int nr_irqs
);
436 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
438 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
441 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
443 return domain
->flags
&
444 (IRQ_DOMAIN_FLAG_IPI_PER_CPU
| IRQ_DOMAIN_FLAG_IPI_SINGLE
);
447 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
449 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_PER_CPU
;
452 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
454 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_SINGLE
;
457 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
459 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI
;
462 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
464 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI_REMAP
;
467 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
);
469 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
470 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
471 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
472 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
473 unsigned int nr_irqs
, int node
, void *arg
)
478 static inline void irq_domain_free_irqs(unsigned int virq
,
479 unsigned int nr_irqs
) { }
481 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
486 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
491 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
496 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
501 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
506 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
512 irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
)
516 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
518 #else /* CONFIG_IRQ_DOMAIN */
519 static inline void irq_dispose_mapping(unsigned int virq
) { }
520 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
521 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
522 static inline struct irq_domain
*irq_find_matching_fwnode(
523 struct fwnode_handle
*fwnode
, enum irq_domain_bus_token bus_token
)
527 static inline bool irq_domain_check_msi_remap(void)
531 #endif /* !CONFIG_IRQ_DOMAIN */
533 #endif /* _LINUX_IRQDOMAIN_H */