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 #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 {
76 DOMAIN_BUS_GENERIC_MSI,
78 DOMAIN_BUS_PLATFORM_MSI,
81 DOMAIN_BUS_FSL_MC_MSI,
82 DOMAIN_BUS_TI_SCI_INTA_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
151 * Revmap data, used internally by irq_domain
152 * @revmap_size: Size of the linear map table @revmap[]
153 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
154 * @revmap_mutex: Lock for the revmap
155 * @revmap: Linear table of irq_data pointers
158 struct list_head link;
160 const struct irq_domain_ops *ops;
163 unsigned int mapcount;
166 struct fwnode_handle *fwnode;
167 enum irq_domain_bus_token bus_token;
168 struct irq_domain_chip_generic *gc;
169 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
170 struct irq_domain *parent;
173 /* reverse map data. The linear map gets appended to the irq_domain */
174 irq_hw_number_t hwirq_max;
175 unsigned int revmap_size;
176 struct radix_tree_root revmap_tree;
177 struct mutex revmap_mutex;
178 struct irq_data __rcu *revmap[];
181 /* Irq domain flags */
183 /* Irq domain is hierarchical */
184 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
186 /* Irq domain name was allocated in __irq_domain_add() */
187 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 1),
189 /* Irq domain is an IPI domain with virq per cpu */
190 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
192 /* Irq domain is an IPI domain with single virq */
193 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
195 /* Irq domain implements MSIs */
196 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
198 /* Irq domain implements MSI remapping */
199 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
202 * Quirk to handle MSI implementations which do not provide
203 * masking. Currently known to affect x86, but partially
204 * handled in core code.
206 IRQ_DOMAIN_MSI_NOMASK_QUIRK = (1 << 6),
208 /* Irq domain doesn't translate anything */
209 IRQ_DOMAIN_FLAG_NO_MAP = (1 << 7),
212 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
213 * for implementation specific purposes and ignored by the
216 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
219 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
221 return to_of_node(d->fwnode);
224 #ifdef CONFIG_IRQ_DOMAIN
225 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
226 const char *name, phys_addr_t *pa);
230 IRQCHIP_FWNODE_NAMED,
231 IRQCHIP_FWNODE_NAMED_ID,
235 struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
237 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
241 struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
243 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
247 static inline struct fwnode_handle *irq_domain_alloc_fwnode(phys_addr_t *pa)
249 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, pa);
252 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
253 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
254 irq_hw_number_t hwirq_max, int direct_max,
255 const struct irq_domain_ops *ops,
257 struct irq_domain *irq_domain_create_simple(struct fwnode_handle *fwnode,
259 unsigned int first_irq,
260 const struct irq_domain_ops *ops,
262 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
264 unsigned int first_irq,
265 irq_hw_number_t first_hwirq,
266 const struct irq_domain_ops *ops,
268 struct irq_domain *irq_domain_create_legacy(struct fwnode_handle *fwnode,
270 unsigned int first_irq,
271 irq_hw_number_t first_hwirq,
272 const struct irq_domain_ops *ops,
274 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
275 enum irq_domain_bus_token bus_token);
276 extern bool irq_domain_check_msi_remap(void);
277 extern void irq_set_default_host(struct irq_domain *host);
278 extern struct irq_domain *irq_get_default_host(void);
279 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
280 irq_hw_number_t hwirq, int node,
281 const struct irq_affinity_desc *affinity);
283 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
285 return node ? &node->fwnode : NULL;
288 extern const struct fwnode_operations irqchip_fwnode_ops;
290 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
292 return fwnode && fwnode->ops == &irqchip_fwnode_ops;
295 extern void irq_domain_update_bus_token(struct irq_domain *domain,
296 enum irq_domain_bus_token bus_token);
299 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
300 enum irq_domain_bus_token bus_token)
302 struct irq_fwspec fwspec = {
306 return irq_find_matching_fwspec(&fwspec, bus_token);
309 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
310 enum irq_domain_bus_token bus_token)
312 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
315 static inline struct irq_domain *irq_find_host(struct device_node *node)
317 struct irq_domain *d;
319 d = irq_find_matching_host(node, DOMAIN_BUS_WIRED);
321 d = irq_find_matching_host(node, DOMAIN_BUS_ANY);
326 static inline struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
328 unsigned int first_irq,
329 const struct irq_domain_ops *ops,
332 return irq_domain_create_simple(of_node_to_fwnode(of_node), size, first_irq, ops, host_data);
336 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
337 * @of_node: pointer to interrupt controller's device tree node.
338 * @size: Number of interrupts in the domain.
339 * @ops: map/unmap domain callbacks
340 * @host_data: Controller private data pointer
342 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
344 const struct irq_domain_ops *ops,
347 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
350 #ifdef CONFIG_IRQ_DOMAIN_NOMAP
351 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
352 unsigned int max_irq,
353 const struct irq_domain_ops *ops,
356 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
359 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
362 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
363 const struct irq_domain_ops *ops,
366 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
369 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
371 const struct irq_domain_ops *ops,
374 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
377 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
378 const struct irq_domain_ops *ops,
381 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
384 extern void irq_domain_remove(struct irq_domain *host);
386 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
387 irq_hw_number_t hwirq);
388 extern void irq_domain_associate_many(struct irq_domain *domain,
389 unsigned int irq_base,
390 irq_hw_number_t hwirq_base, int count);
392 extern unsigned int irq_create_mapping_affinity(struct irq_domain *host,
393 irq_hw_number_t hwirq,
394 const struct irq_affinity_desc *affinity);
395 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
396 extern void irq_dispose_mapping(unsigned int virq);
398 static inline unsigned int irq_create_mapping(struct irq_domain *host,
399 irq_hw_number_t hwirq)
401 return irq_create_mapping_affinity(host, hwirq, NULL);
405 * irq_find_mapping() - Find a linux irq from a hw irq number.
406 * @domain: domain owning this hardware interrupt
407 * @hwirq: hardware irq number in that domain space
409 extern unsigned int irq_find_mapping(struct irq_domain *host,
410 irq_hw_number_t hwirq);
412 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
413 irq_hw_number_t hwirq)
415 return irq_find_mapping(domain, hwirq);
418 extern const struct irq_domain_ops irq_domain_simple_ops;
420 /* stock xlate functions */
421 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
422 const u32 *intspec, unsigned int intsize,
423 irq_hw_number_t *out_hwirq, unsigned int *out_type);
424 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
425 const u32 *intspec, unsigned int intsize,
426 irq_hw_number_t *out_hwirq, unsigned int *out_type);
427 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
428 const u32 *intspec, unsigned int intsize,
429 irq_hw_number_t *out_hwirq, unsigned int *out_type);
431 int irq_domain_translate_twocell(struct irq_domain *d,
432 struct irq_fwspec *fwspec,
433 unsigned long *out_hwirq,
434 unsigned int *out_type);
436 int irq_domain_translate_onecell(struct irq_domain *d,
437 struct irq_fwspec *fwspec,
438 unsigned long *out_hwirq,
439 unsigned int *out_type);
442 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
443 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
445 /* V2 interfaces to support hierarchy IRQ domains. */
446 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
448 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
449 irq_hw_number_t hwirq, struct irq_chip *chip,
450 void *chip_data, irq_flow_handler_t handler,
451 void *handler_data, const char *handler_name);
452 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
453 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
454 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
455 unsigned int flags, unsigned int size,
456 struct fwnode_handle *fwnode,
457 const struct irq_domain_ops *ops, void *host_data);
459 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
462 struct device_node *node,
463 const struct irq_domain_ops *ops,
466 return irq_domain_create_hierarchy(parent, flags, size,
467 of_node_to_fwnode(node),
471 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
472 unsigned int nr_irqs, int node, void *arg,
474 const struct irq_affinity_desc *affinity);
475 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
476 extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
477 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
479 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
480 unsigned int nr_irqs, int node, void *arg)
482 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
486 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
487 unsigned int irq_base,
488 unsigned int nr_irqs, void *arg);
489 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
491 irq_hw_number_t hwirq,
492 struct irq_chip *chip,
494 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
496 unsigned int nr_irqs);
497 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
498 unsigned int virq, unsigned int nr_irqs);
500 extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
501 extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
503 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
504 unsigned int irq_base,
505 unsigned int nr_irqs, void *arg);
507 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
508 unsigned int irq_base,
509 unsigned int nr_irqs);
511 extern int irq_domain_disconnect_hierarchy(struct irq_domain *domain,
514 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
516 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
519 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
521 return domain->flags &
522 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
525 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
527 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
530 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
532 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
535 static inline bool irq_domain_is_msi(struct irq_domain *domain)
537 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
540 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
542 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
545 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
547 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
548 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
549 unsigned int nr_irqs, int node, void *arg)
554 static inline void irq_domain_free_irqs(unsigned int virq,
555 unsigned int nr_irqs) { }
557 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
562 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
567 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
572 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
577 static inline bool irq_domain_is_msi(struct irq_domain *domain)
582 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
588 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
592 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
594 #else /* CONFIG_IRQ_DOMAIN */
595 static inline void irq_dispose_mapping(unsigned int virq) { }
596 static inline struct irq_domain *irq_find_matching_fwnode(
597 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
601 static inline bool irq_domain_check_msi_remap(void)
605 #endif /* !CONFIG_IRQ_DOMAIN */
607 #endif /* _LINUX_IRQDOMAIN_H */