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>
43 /* Number of irqs reserved for a legacy isa controller */
44 #define NUM_ISA_INTERRUPTS 16
46 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
49 * struct irq_fwspec - generic IRQ specifier structure
51 * @fwnode: Pointer to a firmware-specific descriptor
52 * @param_count: Number of device-specific parameters
53 * @param: Device-specific parameters
55 * This structure, directly modeled after of_phandle_args, is used to
56 * pass a device-specific description of an interrupt.
59 struct fwnode_handle *fwnode;
61 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
65 * Should several domains have the same device node, but serve
66 * different purposes (for example one domain is for PCI/MSI, and the
67 * other for wired IRQs), they can be distinguished using a
68 * bus-specific token. Most domains are expected to only carry
71 enum irq_domain_bus_token {
75 DOMAIN_BUS_PLATFORM_MSI,
78 DOMAIN_BUS_FSL_MC_MSI,
82 * struct irq_domain_ops - Methods for irq_domain objects
83 * @match: Match an interrupt controller device node to a host, returns
85 * @map: Create or update a mapping between a virtual irq number and a hw
86 * irq number. This is called only once for a given mapping.
87 * @unmap: Dispose of such a mapping
88 * @xlate: Given a device tree node and interrupt specifier, decode
89 * the hardware irq number and linux irq type value.
91 * Functions below are provided by the driver and called whenever a new mapping
92 * is created or an old mapping is disposed. The driver can then proceed to
93 * whatever internal data structures management is required. It also needs
94 * to setup the irq_desc when returning from map().
96 struct irq_domain_ops {
97 int (*match)(struct irq_domain *d, struct device_node *node,
98 enum irq_domain_bus_token bus_token);
99 int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
100 enum irq_domain_bus_token bus_token);
101 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
102 void (*unmap)(struct irq_domain *d, unsigned int virq);
103 int (*xlate)(struct irq_domain *d, struct device_node *node,
104 const u32 *intspec, unsigned int intsize,
105 unsigned long *out_hwirq, unsigned int *out_type);
107 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
108 /* extended V2 interfaces to support hierarchy irq_domains */
109 int (*alloc)(struct irq_domain *d, unsigned int virq,
110 unsigned int nr_irqs, void *arg);
111 void (*free)(struct irq_domain *d, unsigned int virq,
112 unsigned int nr_irqs);
113 void (*activate)(struct irq_domain *d, struct irq_data *irq_data);
114 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
115 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
116 unsigned long *out_hwirq, unsigned int *out_type);
120 extern struct irq_domain_ops irq_generic_chip_ops;
122 struct irq_domain_chip_generic;
125 * struct irq_domain - Hardware interrupt number translation object
126 * @link: Element in global irq_domain list.
127 * @name: Name of interrupt domain
128 * @ops: pointer to irq_domain methods
129 * @host_data: private data pointer for use by owner. Not touched by irq_domain
131 * @flags: host per irq_domain flags
134 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
135 * when decoding device tree interrupt specifiers.
136 * @gc: Pointer to a list of generic chips. There is a helper function for
137 * setting up one or more generic chips for interrupt controllers
138 * drivers using the generic chip library which uses this pointer.
139 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
141 * Revmap data, used internally by irq_domain
142 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
143 * support direct mapping
144 * @revmap_size: Size of the linear map table @linear_revmap[]
145 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
146 * @linear_revmap: Linear table of hwirq->virq reverse mappings
149 struct list_head link;
151 const struct irq_domain_ops *ops;
156 struct fwnode_handle *fwnode;
157 enum irq_domain_bus_token bus_token;
158 struct irq_domain_chip_generic *gc;
159 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
160 struct irq_domain *parent;
163 /* reverse map data. The linear map gets appended to the irq_domain */
164 irq_hw_number_t hwirq_max;
165 unsigned int revmap_direct_max_irq;
166 unsigned int revmap_size;
167 struct radix_tree_root revmap_tree;
168 unsigned int linear_revmap[];
171 /* Irq domain flags */
173 /* Irq domain is hierarchical */
174 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
176 /* Core calls alloc/free recursive through the domain hierarchy. */
177 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1),
179 /* Irq domain is an IPI domain with virq per cpu */
180 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
182 /* Irq domain is an IPI domain with single virq */
183 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
186 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
187 * for implementation specific purposes and ignored by the
190 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
193 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
195 return to_of_node(d->fwnode);
198 #ifdef CONFIG_IRQ_DOMAIN
199 struct fwnode_handle *irq_domain_alloc_fwnode(void *data);
200 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
201 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
202 irq_hw_number_t hwirq_max, int direct_max,
203 const struct irq_domain_ops *ops,
205 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
207 unsigned int first_irq,
208 const struct irq_domain_ops *ops,
210 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
212 unsigned int first_irq,
213 irq_hw_number_t first_hwirq,
214 const struct irq_domain_ops *ops,
216 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
217 enum irq_domain_bus_token bus_token);
218 extern void irq_set_default_host(struct irq_domain *host);
219 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
220 irq_hw_number_t hwirq, int node);
222 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
224 return node ? &node->fwnode : NULL;
227 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
229 return fwnode && fwnode->type == FWNODE_IRQCHIP;
233 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
234 enum irq_domain_bus_token bus_token)
236 struct irq_fwspec fwspec = {
240 return irq_find_matching_fwspec(&fwspec, bus_token);
243 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
244 enum irq_domain_bus_token bus_token)
246 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
249 static inline struct irq_domain *irq_find_host(struct device_node *node)
251 return irq_find_matching_host(node, DOMAIN_BUS_ANY);
255 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
256 * @of_node: pointer to interrupt controller's device tree node.
257 * @size: Number of interrupts in the domain.
258 * @ops: map/unmap domain callbacks
259 * @host_data: Controller private data pointer
261 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
263 const struct irq_domain_ops *ops,
266 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
268 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
269 unsigned int max_irq,
270 const struct irq_domain_ops *ops,
273 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
275 static inline struct irq_domain *irq_domain_add_legacy_isa(
276 struct device_node *of_node,
277 const struct irq_domain_ops *ops,
280 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
283 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
284 const struct irq_domain_ops *ops,
287 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
290 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
292 const struct irq_domain_ops *ops,
295 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
298 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
299 const struct irq_domain_ops *ops,
302 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
305 extern void irq_domain_remove(struct irq_domain *host);
307 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
308 irq_hw_number_t hwirq);
309 extern void irq_domain_associate_many(struct irq_domain *domain,
310 unsigned int irq_base,
311 irq_hw_number_t hwirq_base, int count);
312 extern void irq_domain_disassociate(struct irq_domain *domain,
315 extern unsigned int irq_create_mapping(struct irq_domain *host,
316 irq_hw_number_t hwirq);
317 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
318 extern void irq_dispose_mapping(unsigned int virq);
321 * irq_linear_revmap() - Find a linux irq from a hw irq number.
322 * @domain: domain owning this hardware interrupt
323 * @hwirq: hardware irq number in that domain space
325 * This is a fast path alternative to irq_find_mapping() that can be
326 * called directly by irq controller code to save a handful of
327 * instructions. It is always safe to call, but won't find irqs mapped
328 * using the radix tree.
330 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
331 irq_hw_number_t hwirq)
333 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
335 extern unsigned int irq_find_mapping(struct irq_domain *host,
336 irq_hw_number_t hwirq);
337 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
338 extern int irq_create_strict_mappings(struct irq_domain *domain,
339 unsigned int irq_base,
340 irq_hw_number_t hwirq_base, int count);
342 static inline int irq_create_identity_mapping(struct irq_domain *host,
343 irq_hw_number_t hwirq)
345 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
348 extern const struct irq_domain_ops irq_domain_simple_ops;
350 /* stock xlate functions */
351 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
352 const u32 *intspec, unsigned int intsize,
353 irq_hw_number_t *out_hwirq, unsigned int *out_type);
354 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
355 const u32 *intspec, unsigned int intsize,
356 irq_hw_number_t *out_hwirq, unsigned int *out_type);
357 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
358 const u32 *intspec, unsigned int intsize,
359 irq_hw_number_t *out_hwirq, unsigned int *out_type);
362 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
363 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
365 /* V2 interfaces to support hierarchy IRQ domains. */
366 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
368 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
369 irq_hw_number_t hwirq, struct irq_chip *chip,
370 void *chip_data, irq_flow_handler_t handler,
371 void *handler_data, const char *handler_name);
372 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
373 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
374 unsigned int flags, unsigned int size,
375 struct fwnode_handle *fwnode,
376 const struct irq_domain_ops *ops, void *host_data);
378 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
381 struct device_node *node,
382 const struct irq_domain_ops *ops,
385 return irq_domain_create_hierarchy(parent, flags, size,
386 of_node_to_fwnode(node),
390 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
391 unsigned int nr_irqs, int node, void *arg,
393 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
394 extern void irq_domain_activate_irq(struct irq_data *irq_data);
395 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
397 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
398 unsigned int nr_irqs, int node, void *arg)
400 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false);
403 extern int irq_domain_alloc_irqs_recursive(struct irq_domain *domain,
404 unsigned int irq_base,
405 unsigned int nr_irqs, void *arg);
406 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
408 irq_hw_number_t hwirq,
409 struct irq_chip *chip,
411 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
412 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
414 unsigned int nr_irqs);
415 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
416 unsigned int virq, unsigned int nr_irqs);
418 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
419 unsigned int irq_base,
420 unsigned int nr_irqs, void *arg);
422 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
423 unsigned int irq_base,
424 unsigned int nr_irqs);
426 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
428 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
431 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
433 return domain->flags &
434 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
437 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
439 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
442 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
444 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
446 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
447 static inline void irq_domain_activate_irq(struct irq_data *data) { }
448 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
449 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
450 unsigned int nr_irqs, int node, void *arg)
455 static inline void irq_domain_free_irqs(unsigned int virq,
456 unsigned int nr_irqs) { }
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 */