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>
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);
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 int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool early);
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);
119 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
120 void (*debug_show)(struct seq_file *m, struct irq_domain *d,
121 struct irq_data *irqd, int ind);
125 extern struct irq_domain_ops irq_generic_chip_ops;
127 struct irq_domain_chip_generic;
130 * struct irq_domain - Hardware interrupt number translation object
131 * @link: Element in global irq_domain list.
132 * @name: Name of interrupt domain
133 * @ops: pointer to irq_domain methods
134 * @host_data: private data pointer for use by owner. Not touched by irq_domain
136 * @flags: host per irq_domain flags
137 * @mapcount: The number of mapped interrupts
140 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
141 * when decoding device tree interrupt specifiers.
142 * @gc: Pointer to a list of generic chips. There is a helper function for
143 * setting up one or more generic chips for interrupt controllers
144 * drivers using the generic chip library which uses this pointer.
145 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
146 * @debugfs_file: dentry for the domain debugfs file
148 * Revmap data, used internally by irq_domain
149 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
150 * support direct mapping
151 * @revmap_size: Size of the linear map table @linear_revmap[]
152 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
153 * @linear_revmap: Linear table of hwirq->virq reverse mappings
156 struct list_head link;
158 const struct irq_domain_ops *ops;
161 unsigned int mapcount;
164 struct fwnode_handle *fwnode;
165 enum irq_domain_bus_token bus_token;
166 struct irq_domain_chip_generic *gc;
167 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
168 struct irq_domain *parent;
170 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
171 struct dentry *debugfs_file;
174 /* reverse map data. The linear map gets appended to the irq_domain */
175 irq_hw_number_t hwirq_max;
176 unsigned int revmap_direct_max_irq;
177 unsigned int revmap_size;
178 struct radix_tree_root revmap_tree;
179 unsigned int linear_revmap[];
182 /* Irq domain flags */
184 /* Irq domain is hierarchical */
185 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
187 /* Irq domain name was allocated in __irq_domain_add() */
188 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6),
190 /* Irq domain is an IPI domain with virq per cpu */
191 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
193 /* Irq domain is an IPI domain with single virq */
194 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
196 /* Irq domain implements MSIs */
197 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
199 /* Irq domain implements MSI remapping */
200 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
203 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
204 * for implementation specific purposes and ignored by the
207 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
210 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
212 return to_of_node(d->fwnode);
215 #ifdef CONFIG_IRQ_DOMAIN
216 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
217 const char *name, void *data);
221 IRQCHIP_FWNODE_NAMED,
222 IRQCHIP_FWNODE_NAMED_ID,
226 struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
228 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
232 struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
234 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
238 static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
240 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
243 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
244 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
245 irq_hw_number_t hwirq_max, int direct_max,
246 const struct irq_domain_ops *ops,
248 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
250 unsigned int first_irq,
251 const struct irq_domain_ops *ops,
253 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
255 unsigned int first_irq,
256 irq_hw_number_t first_hwirq,
257 const struct irq_domain_ops *ops,
259 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
260 enum irq_domain_bus_token bus_token);
261 extern bool irq_domain_check_msi_remap(void);
262 extern void irq_set_default_host(struct irq_domain *host);
263 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
264 irq_hw_number_t hwirq, int node,
265 const struct cpumask *affinity);
267 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
269 return node ? &node->fwnode : NULL;
272 extern const struct fwnode_operations irqchip_fwnode_ops;
274 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
276 return fwnode && fwnode->ops == &irqchip_fwnode_ops;
279 extern void irq_domain_update_bus_token(struct irq_domain *domain,
280 enum irq_domain_bus_token bus_token);
283 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
284 enum irq_domain_bus_token bus_token)
286 struct irq_fwspec fwspec = {
290 return irq_find_matching_fwspec(&fwspec, bus_token);
293 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
294 enum irq_domain_bus_token bus_token)
296 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
299 static inline struct irq_domain *irq_find_host(struct device_node *node)
301 return irq_find_matching_host(node, DOMAIN_BUS_ANY);
305 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
306 * @of_node: pointer to interrupt controller's device tree node.
307 * @size: Number of interrupts in the domain.
308 * @ops: map/unmap domain callbacks
309 * @host_data: Controller private data pointer
311 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
313 const struct irq_domain_ops *ops,
316 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
318 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
319 unsigned int max_irq,
320 const struct irq_domain_ops *ops,
323 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
325 static inline struct irq_domain *irq_domain_add_legacy_isa(
326 struct device_node *of_node,
327 const struct irq_domain_ops *ops,
330 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
333 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
334 const struct irq_domain_ops *ops,
337 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
340 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
342 const struct irq_domain_ops *ops,
345 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
348 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
349 const struct irq_domain_ops *ops,
352 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
355 extern void irq_domain_remove(struct irq_domain *host);
357 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
358 irq_hw_number_t hwirq);
359 extern void irq_domain_associate_many(struct irq_domain *domain,
360 unsigned int irq_base,
361 irq_hw_number_t hwirq_base, int count);
362 extern void irq_domain_disassociate(struct irq_domain *domain,
365 extern unsigned int irq_create_mapping(struct irq_domain *host,
366 irq_hw_number_t hwirq);
367 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
368 extern void irq_dispose_mapping(unsigned int virq);
371 * irq_linear_revmap() - Find a linux irq from a hw irq number.
372 * @domain: domain owning this hardware interrupt
373 * @hwirq: hardware irq number in that domain space
375 * This is a fast path alternative to irq_find_mapping() that can be
376 * called directly by irq controller code to save a handful of
377 * instructions. It is always safe to call, but won't find irqs mapped
378 * using the radix tree.
380 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
381 irq_hw_number_t hwirq)
383 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
385 extern unsigned int irq_find_mapping(struct irq_domain *host,
386 irq_hw_number_t hwirq);
387 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
388 extern int irq_create_strict_mappings(struct irq_domain *domain,
389 unsigned int irq_base,
390 irq_hw_number_t hwirq_base, int count);
392 static inline int irq_create_identity_mapping(struct irq_domain *host,
393 irq_hw_number_t hwirq)
395 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
398 extern const struct irq_domain_ops irq_domain_simple_ops;
400 /* stock xlate functions */
401 int irq_domain_xlate_onecell(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_twocell(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_onetwocell(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);
412 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
413 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
415 /* V2 interfaces to support hierarchy IRQ domains. */
416 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
418 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
419 irq_hw_number_t hwirq, struct irq_chip *chip,
420 void *chip_data, irq_flow_handler_t handler,
421 void *handler_data, const char *handler_name);
422 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
423 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
424 unsigned int flags, unsigned int size,
425 struct fwnode_handle *fwnode,
426 const struct irq_domain_ops *ops, void *host_data);
428 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
431 struct device_node *node,
432 const struct irq_domain_ops *ops,
435 return irq_domain_create_hierarchy(parent, flags, size,
436 of_node_to_fwnode(node),
440 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
441 unsigned int nr_irqs, int node, void *arg,
442 bool realloc, const struct cpumask *affinity);
443 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
444 extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
445 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
447 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
448 unsigned int nr_irqs, int node, void *arg)
450 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
454 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
455 unsigned int irq_base,
456 unsigned int nr_irqs, void *arg);
457 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
459 irq_hw_number_t hwirq,
460 struct irq_chip *chip,
462 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
463 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
465 unsigned int nr_irqs);
466 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
467 unsigned int virq, unsigned int nr_irqs);
469 extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
470 extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
472 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
473 unsigned int irq_base,
474 unsigned int nr_irqs, void *arg);
476 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
477 unsigned int irq_base,
478 unsigned int nr_irqs);
480 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
482 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
485 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
487 return domain->flags &
488 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
491 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
493 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
496 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
498 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
501 static inline bool irq_domain_is_msi(struct irq_domain *domain)
503 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
506 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
508 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
511 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
513 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
514 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
515 unsigned int nr_irqs, int node, void *arg)
520 static inline void irq_domain_free_irqs(unsigned int virq,
521 unsigned int nr_irqs) { }
523 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
528 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
533 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
538 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
543 static inline bool irq_domain_is_msi(struct irq_domain *domain)
548 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
554 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
558 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
560 #else /* CONFIG_IRQ_DOMAIN */
561 static inline void irq_dispose_mapping(unsigned int virq) { }
562 static inline struct irq_domain *irq_find_matching_fwnode(
563 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
567 static inline bool irq_domain_check_msi_remap(void)
571 #endif /* !CONFIG_IRQ_DOMAIN */
573 #endif /* _LINUX_IRQDOMAIN_H */