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),
187 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
188 * for implementation specific purposes and ignored by the
191 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
194 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
196 return to_of_node(d->fwnode);
199 #ifdef CONFIG_IRQ_DOMAIN
200 struct fwnode_handle *irq_domain_alloc_fwnode(void *data);
201 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
202 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
203 irq_hw_number_t hwirq_max, int direct_max,
204 const struct irq_domain_ops *ops,
206 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
208 unsigned int first_irq,
209 const struct irq_domain_ops *ops,
211 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
213 unsigned int first_irq,
214 irq_hw_number_t first_hwirq,
215 const struct irq_domain_ops *ops,
217 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
218 enum irq_domain_bus_token bus_token);
219 extern void irq_set_default_host(struct irq_domain *host);
220 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
221 irq_hw_number_t hwirq, int node,
222 const struct cpumask *affinity);
224 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
226 return node ? &node->fwnode : NULL;
229 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
231 return fwnode && fwnode->type == FWNODE_IRQCHIP;
235 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
236 enum irq_domain_bus_token bus_token)
238 struct irq_fwspec fwspec = {
242 return irq_find_matching_fwspec(&fwspec, bus_token);
245 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
246 enum irq_domain_bus_token bus_token)
248 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
251 static inline struct irq_domain *irq_find_host(struct device_node *node)
253 return irq_find_matching_host(node, DOMAIN_BUS_ANY);
257 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
258 * @of_node: pointer to interrupt controller's device tree node.
259 * @size: Number of interrupts in the domain.
260 * @ops: map/unmap domain callbacks
261 * @host_data: Controller private data pointer
263 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
265 const struct irq_domain_ops *ops,
268 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
270 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
271 unsigned int max_irq,
272 const struct irq_domain_ops *ops,
275 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
277 static inline struct irq_domain *irq_domain_add_legacy_isa(
278 struct device_node *of_node,
279 const struct irq_domain_ops *ops,
282 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
285 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
286 const struct irq_domain_ops *ops,
289 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
292 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
294 const struct irq_domain_ops *ops,
297 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
300 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
301 const struct irq_domain_ops *ops,
304 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
307 extern void irq_domain_remove(struct irq_domain *host);
309 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
310 irq_hw_number_t hwirq);
311 extern void irq_domain_associate_many(struct irq_domain *domain,
312 unsigned int irq_base,
313 irq_hw_number_t hwirq_base, int count);
314 extern void irq_domain_disassociate(struct irq_domain *domain,
317 extern unsigned int irq_create_mapping(struct irq_domain *host,
318 irq_hw_number_t hwirq);
319 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
320 extern void irq_dispose_mapping(unsigned int virq);
323 * irq_linear_revmap() - Find a linux irq from a hw irq number.
324 * @domain: domain owning this hardware interrupt
325 * @hwirq: hardware irq number in that domain space
327 * This is a fast path alternative to irq_find_mapping() that can be
328 * called directly by irq controller code to save a handful of
329 * instructions. It is always safe to call, but won't find irqs mapped
330 * using the radix tree.
332 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
333 irq_hw_number_t hwirq)
335 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
337 extern unsigned int irq_find_mapping(struct irq_domain *host,
338 irq_hw_number_t hwirq);
339 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
340 extern int irq_create_strict_mappings(struct irq_domain *domain,
341 unsigned int irq_base,
342 irq_hw_number_t hwirq_base, int count);
344 static inline int irq_create_identity_mapping(struct irq_domain *host,
345 irq_hw_number_t hwirq)
347 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
350 extern const struct irq_domain_ops irq_domain_simple_ops;
352 /* stock xlate functions */
353 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
354 const u32 *intspec, unsigned int intsize,
355 irq_hw_number_t *out_hwirq, unsigned int *out_type);
356 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
357 const u32 *intspec, unsigned int intsize,
358 irq_hw_number_t *out_hwirq, unsigned int *out_type);
359 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
360 const u32 *intspec, unsigned int intsize,
361 irq_hw_number_t *out_hwirq, unsigned int *out_type);
364 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
365 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
367 /* V2 interfaces to support hierarchy IRQ domains. */
368 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
370 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
371 irq_hw_number_t hwirq, struct irq_chip *chip,
372 void *chip_data, irq_flow_handler_t handler,
373 void *handler_data, const char *handler_name);
374 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
375 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
376 unsigned int flags, unsigned int size,
377 struct fwnode_handle *fwnode,
378 const struct irq_domain_ops *ops, void *host_data);
380 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
383 struct device_node *node,
384 const struct irq_domain_ops *ops,
387 return irq_domain_create_hierarchy(parent, flags, size,
388 of_node_to_fwnode(node),
392 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
393 unsigned int nr_irqs, int node, void *arg,
394 bool realloc, const struct cpumask *affinity);
395 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
396 extern void irq_domain_activate_irq(struct irq_data *irq_data);
397 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
399 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
400 unsigned int nr_irqs, int node, void *arg)
402 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
406 extern int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
407 unsigned int irq_base,
408 unsigned int nr_irqs, void *arg);
409 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
411 irq_hw_number_t hwirq,
412 struct irq_chip *chip,
414 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
415 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
417 unsigned int nr_irqs);
418 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
419 unsigned int virq, unsigned int nr_irqs);
421 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
422 unsigned int irq_base,
423 unsigned int nr_irqs, void *arg);
425 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
426 unsigned int irq_base,
427 unsigned int nr_irqs);
429 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
431 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
434 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
436 return domain->flags &
437 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
440 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
442 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
445 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
447 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
449 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
450 static inline void irq_domain_activate_irq(struct irq_data *data) { }
451 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
452 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
453 unsigned int nr_irqs, int node, void *arg)
458 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
463 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
468 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
473 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
477 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
479 #else /* CONFIG_IRQ_DOMAIN */
480 static inline void irq_dispose_mapping(unsigned int virq) { }
481 static inline void irq_domain_activate_irq(struct irq_data *data) { }
482 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
483 static inline struct irq_domain *irq_find_matching_fwnode(
484 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
488 #endif /* !CONFIG_IRQ_DOMAIN */
490 #endif /* _LINUX_IRQDOMAIN_H */