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
133 * @mapcount: The number of mapped interrupts
136 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
137 * when decoding device tree interrupt specifiers.
138 * @gc: Pointer to a list of generic chips. There is a helper function for
139 * setting up one or more generic chips for interrupt controllers
140 * drivers using the generic chip library which uses this pointer.
141 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
142 * @debugfs_file: dentry for the domain debugfs file
144 * Revmap data, used internally by irq_domain
145 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
146 * support direct mapping
147 * @revmap_size: Size of the linear map table @linear_revmap[]
148 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
149 * @linear_revmap: Linear table of hwirq->virq reverse mappings
152 struct list_head link;
154 const struct irq_domain_ops *ops;
157 unsigned int mapcount;
160 struct fwnode_handle *fwnode;
161 enum irq_domain_bus_token bus_token;
162 struct irq_domain_chip_generic *gc;
163 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
164 struct irq_domain *parent;
166 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
167 struct dentry *debugfs_file;
170 /* reverse map data. The linear map gets appended to the irq_domain */
171 irq_hw_number_t hwirq_max;
172 unsigned int revmap_direct_max_irq;
173 unsigned int revmap_size;
174 struct radix_tree_root revmap_tree;
175 unsigned int linear_revmap[];
178 /* Irq domain flags */
180 /* Irq domain is hierarchical */
181 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
183 /* Irq domain name was allocated in __irq_domain_add() */
184 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6),
186 /* Irq domain is an IPI domain with virq per cpu */
187 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
189 /* Irq domain is an IPI domain with single virq */
190 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
192 /* Irq domain implements MSIs */
193 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
195 /* Irq domain implements MSI remapping */
196 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
199 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
200 * for implementation specific purposes and ignored by the
203 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
206 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
208 return to_of_node(d->fwnode);
211 #ifdef CONFIG_IRQ_DOMAIN
212 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
213 const char *name, void *data);
217 IRQCHIP_FWNODE_NAMED,
218 IRQCHIP_FWNODE_NAMED_ID,
222 struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
224 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
228 struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
230 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
234 static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
236 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
239 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
240 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
241 irq_hw_number_t hwirq_max, int direct_max,
242 const struct irq_domain_ops *ops,
244 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
246 unsigned int first_irq,
247 const struct irq_domain_ops *ops,
249 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
251 unsigned int first_irq,
252 irq_hw_number_t first_hwirq,
253 const struct irq_domain_ops *ops,
255 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
256 enum irq_domain_bus_token bus_token);
257 extern bool irq_domain_check_msi_remap(void);
258 extern void irq_set_default_host(struct irq_domain *host);
259 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
260 irq_hw_number_t hwirq, int node,
261 const struct cpumask *affinity);
263 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
265 return node ? &node->fwnode : NULL;
268 extern const struct fwnode_operations irqchip_fwnode_ops;
270 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
272 return fwnode && fwnode->ops == &irqchip_fwnode_ops;
275 extern void irq_domain_update_bus_token(struct irq_domain *domain,
276 enum irq_domain_bus_token bus_token);
279 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
280 enum irq_domain_bus_token bus_token)
282 struct irq_fwspec fwspec = {
286 return irq_find_matching_fwspec(&fwspec, bus_token);
289 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
290 enum irq_domain_bus_token bus_token)
292 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
295 static inline struct irq_domain *irq_find_host(struct device_node *node)
297 return irq_find_matching_host(node, DOMAIN_BUS_ANY);
301 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
302 * @of_node: pointer to interrupt controller's device tree node.
303 * @size: Number of interrupts in the domain.
304 * @ops: map/unmap domain callbacks
305 * @host_data: Controller private data pointer
307 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
309 const struct irq_domain_ops *ops,
312 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
314 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
315 unsigned int max_irq,
316 const struct irq_domain_ops *ops,
319 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
321 static inline struct irq_domain *irq_domain_add_legacy_isa(
322 struct device_node *of_node,
323 const struct irq_domain_ops *ops,
326 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
329 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
330 const struct irq_domain_ops *ops,
333 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
336 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
338 const struct irq_domain_ops *ops,
341 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
344 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
345 const struct irq_domain_ops *ops,
348 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
351 extern void irq_domain_remove(struct irq_domain *host);
353 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
354 irq_hw_number_t hwirq);
355 extern void irq_domain_associate_many(struct irq_domain *domain,
356 unsigned int irq_base,
357 irq_hw_number_t hwirq_base, int count);
358 extern void irq_domain_disassociate(struct irq_domain *domain,
361 extern unsigned int irq_create_mapping(struct irq_domain *host,
362 irq_hw_number_t hwirq);
363 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
364 extern void irq_dispose_mapping(unsigned int virq);
367 * irq_linear_revmap() - Find a linux irq from a hw irq number.
368 * @domain: domain owning this hardware interrupt
369 * @hwirq: hardware irq number in that domain space
371 * This is a fast path alternative to irq_find_mapping() that can be
372 * called directly by irq controller code to save a handful of
373 * instructions. It is always safe to call, but won't find irqs mapped
374 * using the radix tree.
376 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
377 irq_hw_number_t hwirq)
379 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
381 extern unsigned int irq_find_mapping(struct irq_domain *host,
382 irq_hw_number_t hwirq);
383 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
384 extern int irq_create_strict_mappings(struct irq_domain *domain,
385 unsigned int irq_base,
386 irq_hw_number_t hwirq_base, int count);
388 static inline int irq_create_identity_mapping(struct irq_domain *host,
389 irq_hw_number_t hwirq)
391 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
394 extern const struct irq_domain_ops irq_domain_simple_ops;
396 /* stock xlate functions */
397 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
398 const u32 *intspec, unsigned int intsize,
399 irq_hw_number_t *out_hwirq, unsigned int *out_type);
400 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
401 const u32 *intspec, unsigned int intsize,
402 irq_hw_number_t *out_hwirq, unsigned int *out_type);
403 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
404 const u32 *intspec, unsigned int intsize,
405 irq_hw_number_t *out_hwirq, unsigned int *out_type);
408 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
409 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
411 /* V2 interfaces to support hierarchy IRQ domains. */
412 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
414 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
415 irq_hw_number_t hwirq, struct irq_chip *chip,
416 void *chip_data, irq_flow_handler_t handler,
417 void *handler_data, const char *handler_name);
418 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
419 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
420 unsigned int flags, unsigned int size,
421 struct fwnode_handle *fwnode,
422 const struct irq_domain_ops *ops, void *host_data);
424 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
427 struct device_node *node,
428 const struct irq_domain_ops *ops,
431 return irq_domain_create_hierarchy(parent, flags, size,
432 of_node_to_fwnode(node),
436 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
437 unsigned int nr_irqs, int node, void *arg,
438 bool realloc, const struct cpumask *affinity);
439 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
440 extern void irq_domain_activate_irq(struct irq_data *irq_data);
441 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
443 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
444 unsigned int nr_irqs, int node, void *arg)
446 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
450 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
451 unsigned int irq_base,
452 unsigned int nr_irqs, void *arg);
453 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
455 irq_hw_number_t hwirq,
456 struct irq_chip *chip,
458 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
459 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
461 unsigned int nr_irqs);
462 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
463 unsigned int virq, unsigned int nr_irqs);
465 extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
466 extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
468 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
469 unsigned int irq_base,
470 unsigned int nr_irqs, void *arg);
472 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
473 unsigned int irq_base,
474 unsigned int nr_irqs);
476 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
478 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
481 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
483 return domain->flags &
484 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
487 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
489 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
492 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
494 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
497 static inline bool irq_domain_is_msi(struct irq_domain *domain)
499 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
502 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
504 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
507 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
509 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
510 static inline void irq_domain_activate_irq(struct irq_data *data) { }
511 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
512 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
513 unsigned int nr_irqs, int node, void *arg)
518 static inline void irq_domain_free_irqs(unsigned int virq,
519 unsigned int nr_irqs) { }
521 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
526 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
531 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
536 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
541 static inline bool irq_domain_is_msi(struct irq_domain *domain)
546 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
552 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
556 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
558 #else /* CONFIG_IRQ_DOMAIN */
559 static inline void irq_dispose_mapping(unsigned int virq) { }
560 static inline void irq_domain_activate_irq(struct irq_data *data) { }
561 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
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 */