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/mutex.h>
37 #include <linux/radix-tree.h>
46 struct irq_affinity_desc;
48 /* Number of irqs reserved for a legacy isa controller */
49 #define NUM_ISA_INTERRUPTS 16
51 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
54 * struct irq_fwspec - generic IRQ specifier structure
56 * @fwnode: Pointer to a firmware-specific descriptor
57 * @param_count: Number of device-specific parameters
58 * @param: Device-specific parameters
60 * This structure, directly modeled after of_phandle_args, is used to
61 * pass a device-specific description of an interrupt.
64 struct fwnode_handle *fwnode;
66 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
70 * Should several domains have the same device node, but serve
71 * different purposes (for example one domain is for PCI/MSI, and the
72 * other for wired IRQs), they can be distinguished using a
73 * bus-specific token. Most domains are expected to only carry
76 enum irq_domain_bus_token {
79 DOMAIN_BUS_GENERIC_MSI,
81 DOMAIN_BUS_PLATFORM_MSI,
84 DOMAIN_BUS_FSL_MC_MSI,
88 * struct irq_domain_ops - Methods for irq_domain objects
89 * @match: Match an interrupt controller device node to a host, returns
91 * @map: Create or update a mapping between a virtual irq number and a hw
92 * irq number. This is called only once for a given mapping.
93 * @unmap: Dispose of such a mapping
94 * @xlate: Given a device tree node and interrupt specifier, decode
95 * the hardware irq number and linux irq type value.
97 * Functions below are provided by the driver and called whenever a new mapping
98 * is created or an old mapping is disposed. The driver can then proceed to
99 * whatever internal data structures management is required. It also needs
100 * to setup the irq_desc when returning from map().
102 struct irq_domain_ops {
103 int (*match)(struct irq_domain *d, struct device_node *node,
104 enum irq_domain_bus_token bus_token);
105 int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
106 enum irq_domain_bus_token bus_token);
107 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
108 void (*unmap)(struct irq_domain *d, unsigned int virq);
109 int (*xlate)(struct irq_domain *d, struct device_node *node,
110 const u32 *intspec, unsigned int intsize,
111 unsigned long *out_hwirq, unsigned int *out_type);
112 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
113 /* extended V2 interfaces to support hierarchy irq_domains */
114 int (*alloc)(struct irq_domain *d, unsigned int virq,
115 unsigned int nr_irqs, void *arg);
116 void (*free)(struct irq_domain *d, unsigned int virq,
117 unsigned int nr_irqs);
118 int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool reserve);
119 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
120 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
121 unsigned long *out_hwirq, unsigned int *out_type);
123 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
124 void (*debug_show)(struct seq_file *m, struct irq_domain *d,
125 struct irq_data *irqd, int ind);
129 extern struct irq_domain_ops irq_generic_chip_ops;
131 struct irq_domain_chip_generic;
134 * struct irq_domain - Hardware interrupt number translation object
135 * @link: Element in global irq_domain list.
136 * @name: Name of interrupt domain
137 * @ops: pointer to irq_domain methods
138 * @host_data: private data pointer for use by owner. Not touched by irq_domain
140 * @flags: host per irq_domain flags
141 * @mapcount: The number of mapped interrupts
144 * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
145 * to swap it for the of_node via the irq_domain_get_of_node accessor
146 * @gc: Pointer to a list of generic chips. There is a helper function for
147 * setting up one or more generic chips for interrupt controllers
148 * drivers using the generic chip library which uses this pointer.
149 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
150 * @debugfs_file: dentry for the domain debugfs file
152 * Revmap data, used internally by irq_domain
153 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
154 * support direct mapping
155 * @revmap_size: Size of the linear map table @linear_revmap[]
156 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
157 * @linear_revmap: Linear table of hwirq->virq reverse mappings
160 struct list_head link;
162 const struct irq_domain_ops *ops;
165 unsigned int mapcount;
168 struct fwnode_handle *fwnode;
169 enum irq_domain_bus_token bus_token;
170 struct irq_domain_chip_generic *gc;
171 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
172 struct irq_domain *parent;
174 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
175 struct dentry *debugfs_file;
178 /* reverse map data. The linear map gets appended to the irq_domain */
179 irq_hw_number_t hwirq_max;
180 unsigned int revmap_direct_max_irq;
181 unsigned int revmap_size;
182 struct radix_tree_root revmap_tree;
183 struct mutex revmap_tree_mutex;
184 unsigned int linear_revmap[];
187 /* Irq domain flags */
189 /* Irq domain is hierarchical */
190 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
192 /* Irq domain name was allocated in __irq_domain_add() */
193 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6),
195 /* Irq domain is an IPI domain with virq per cpu */
196 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
198 /* Irq domain is an IPI domain with single virq */
199 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
201 /* Irq domain implements MSIs */
202 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
204 /* Irq domain implements MSI remapping */
205 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
208 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
209 * for implementation specific purposes and ignored by the
212 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
215 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
217 return to_of_node(d->fwnode);
220 #ifdef CONFIG_IRQ_DOMAIN
221 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
222 const char *name, void *data);
226 IRQCHIP_FWNODE_NAMED,
227 IRQCHIP_FWNODE_NAMED_ID,
231 struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
233 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
237 struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
239 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
243 static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
245 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
248 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
249 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
250 irq_hw_number_t hwirq_max, int direct_max,
251 const struct irq_domain_ops *ops,
253 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
255 unsigned int first_irq,
256 const struct irq_domain_ops *ops,
258 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
260 unsigned int first_irq,
261 irq_hw_number_t first_hwirq,
262 const struct irq_domain_ops *ops,
264 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
265 enum irq_domain_bus_token bus_token);
266 extern bool irq_domain_check_msi_remap(void);
267 extern void irq_set_default_host(struct irq_domain *host);
268 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
269 irq_hw_number_t hwirq, int node,
270 const struct irq_affinity_desc *affinity);
272 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
274 return node ? &node->fwnode : NULL;
277 extern const struct fwnode_operations irqchip_fwnode_ops;
279 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
281 return fwnode && fwnode->ops == &irqchip_fwnode_ops;
284 extern void irq_domain_update_bus_token(struct irq_domain *domain,
285 enum irq_domain_bus_token bus_token);
288 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
289 enum irq_domain_bus_token bus_token)
291 struct irq_fwspec fwspec = {
295 return irq_find_matching_fwspec(&fwspec, bus_token);
298 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
299 enum irq_domain_bus_token bus_token)
301 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
304 static inline struct irq_domain *irq_find_host(struct device_node *node)
306 struct irq_domain *d;
308 d = irq_find_matching_host(node, DOMAIN_BUS_WIRED);
310 d = irq_find_matching_host(node, DOMAIN_BUS_ANY);
316 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
317 * @of_node: pointer to interrupt controller's device tree node.
318 * @size: Number of interrupts in the domain.
319 * @ops: map/unmap domain callbacks
320 * @host_data: Controller private data pointer
322 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
324 const struct irq_domain_ops *ops,
327 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
329 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
330 unsigned int max_irq,
331 const struct irq_domain_ops *ops,
334 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
336 static inline struct irq_domain *irq_domain_add_legacy_isa(
337 struct device_node *of_node,
338 const struct irq_domain_ops *ops,
341 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
344 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
345 const struct irq_domain_ops *ops,
348 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
351 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
353 const struct irq_domain_ops *ops,
356 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
359 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
360 const struct irq_domain_ops *ops,
363 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
366 extern void irq_domain_remove(struct irq_domain *host);
368 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
369 irq_hw_number_t hwirq);
370 extern void irq_domain_associate_many(struct irq_domain *domain,
371 unsigned int irq_base,
372 irq_hw_number_t hwirq_base, int count);
373 extern void irq_domain_disassociate(struct irq_domain *domain,
376 extern unsigned int irq_create_mapping(struct irq_domain *host,
377 irq_hw_number_t hwirq);
378 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
379 extern void irq_dispose_mapping(unsigned int virq);
382 * irq_linear_revmap() - Find a linux irq from a hw irq number.
383 * @domain: domain owning this hardware interrupt
384 * @hwirq: hardware irq number in that domain space
386 * This is a fast path alternative to irq_find_mapping() that can be
387 * called directly by irq controller code to save a handful of
388 * instructions. It is always safe to call, but won't find irqs mapped
389 * using the radix tree.
391 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
392 irq_hw_number_t hwirq)
394 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
396 extern unsigned int irq_find_mapping(struct irq_domain *host,
397 irq_hw_number_t hwirq);
398 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
399 extern int irq_create_strict_mappings(struct irq_domain *domain,
400 unsigned int irq_base,
401 irq_hw_number_t hwirq_base, int count);
403 static inline int irq_create_identity_mapping(struct irq_domain *host,
404 irq_hw_number_t hwirq)
406 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
409 extern const struct irq_domain_ops irq_domain_simple_ops;
411 /* stock xlate functions */
412 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
413 const u32 *intspec, unsigned int intsize,
414 irq_hw_number_t *out_hwirq, unsigned int *out_type);
415 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
416 const u32 *intspec, unsigned int intsize,
417 irq_hw_number_t *out_hwirq, unsigned int *out_type);
418 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
419 const u32 *intspec, unsigned int intsize,
420 irq_hw_number_t *out_hwirq, unsigned int *out_type);
423 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
424 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
426 /* V2 interfaces to support hierarchy IRQ domains. */
427 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
429 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
430 irq_hw_number_t hwirq, struct irq_chip *chip,
431 void *chip_data, irq_flow_handler_t handler,
432 void *handler_data, const char *handler_name);
433 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
434 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
435 unsigned int flags, unsigned int size,
436 struct fwnode_handle *fwnode,
437 const struct irq_domain_ops *ops, void *host_data);
439 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
442 struct device_node *node,
443 const struct irq_domain_ops *ops,
446 return irq_domain_create_hierarchy(parent, flags, size,
447 of_node_to_fwnode(node),
451 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
452 unsigned int nr_irqs, int node, void *arg,
454 const struct irq_affinity_desc *affinity);
455 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
456 extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
457 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
459 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
460 unsigned int nr_irqs, int node, void *arg)
462 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
466 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
467 unsigned int irq_base,
468 unsigned int nr_irqs, void *arg);
469 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
471 irq_hw_number_t hwirq,
472 struct irq_chip *chip,
474 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
475 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
477 unsigned int nr_irqs);
478 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
479 unsigned int virq, unsigned int nr_irqs);
481 extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
482 extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
484 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
485 unsigned int irq_base,
486 unsigned int nr_irqs, void *arg);
488 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
489 unsigned int irq_base,
490 unsigned int nr_irqs);
492 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
494 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
497 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
499 return domain->flags &
500 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
503 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
505 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
508 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
510 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
513 static inline bool irq_domain_is_msi(struct irq_domain *domain)
515 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
518 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
520 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
523 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
525 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
526 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
527 unsigned int nr_irqs, int node, void *arg)
532 static inline void irq_domain_free_irqs(unsigned int virq,
533 unsigned int nr_irqs) { }
535 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
540 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
545 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
550 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
555 static inline bool irq_domain_is_msi(struct irq_domain *domain)
560 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
566 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
570 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
572 #else /* CONFIG_IRQ_DOMAIN */
573 static inline void irq_dispose_mapping(unsigned int virq) { }
574 static inline struct irq_domain *irq_find_matching_fwnode(
575 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
579 static inline bool irq_domain_check_msi_remap(void)
583 #endif /* !CONFIG_IRQ_DOMAIN */
585 #endif /* _LINUX_IRQDOMAIN_H */