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>
47 struct irq_affinity_desc
;
49 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
52 * struct irq_fwspec - generic IRQ specifier structure
54 * @fwnode: Pointer to a firmware-specific descriptor
55 * @param_count: Number of device-specific parameters
56 * @param: Device-specific parameters
58 * This structure, directly modeled after of_phandle_args, is used to
59 * pass a device-specific description of an interrupt.
62 struct fwnode_handle
*fwnode
;
64 u32 param
[IRQ_DOMAIN_IRQ_SPEC_PARAMS
];
68 * Should several domains have the same device node, but serve
69 * different purposes (for example one domain is for PCI/MSI, and the
70 * other for wired IRQs), they can be distinguished using a
71 * bus-specific token. Most domains are expected to only carry
74 enum irq_domain_bus_token
{
77 DOMAIN_BUS_GENERIC_MSI
,
79 DOMAIN_BUS_PLATFORM_MSI
,
82 DOMAIN_BUS_FSL_MC_MSI
,
83 DOMAIN_BUS_TI_SCI_INTA_MSI
,
89 * struct irq_domain_ops - Methods for irq_domain objects
90 * @match: Match an interrupt controller device node to a host, returns
92 * @map: Create or update a mapping between a virtual irq number and a hw
93 * irq number. This is called only once for a given mapping.
94 * @unmap: Dispose of such a mapping
95 * @xlate: Given a device tree node and interrupt specifier, decode
96 * the hardware irq number and linux irq type value.
98 * Functions below are provided by the driver and called whenever a new mapping
99 * is created or an old mapping is disposed. The driver can then proceed to
100 * whatever internal data structures management is required. It also needs
101 * to setup the irq_desc when returning from map().
103 struct irq_domain_ops
{
104 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
105 enum irq_domain_bus_token bus_token
);
106 int (*select
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
107 enum irq_domain_bus_token bus_token
);
108 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
109 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
110 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
111 const u32
*intspec
, unsigned int intsize
,
112 unsigned long *out_hwirq
, unsigned int *out_type
);
113 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
114 /* extended V2 interfaces to support hierarchy irq_domains */
115 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
116 unsigned int nr_irqs
, void *arg
);
117 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
118 unsigned int nr_irqs
);
119 int (*activate
)(struct irq_domain
*d
, struct irq_data
*irqd
, bool reserve
);
120 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
121 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
122 unsigned long *out_hwirq
, unsigned int *out_type
);
124 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
125 void (*debug_show
)(struct seq_file
*m
, struct irq_domain
*d
,
126 struct irq_data
*irqd
, int ind
);
130 extern struct irq_domain_ops irq_generic_chip_ops
;
132 struct irq_domain_chip_generic
;
135 * struct irq_domain - Hardware interrupt number translation object
136 * @link: Element in global irq_domain list.
137 * @name: Name of interrupt domain
138 * @ops: pointer to irq_domain methods
139 * @host_data: private data pointer for use by owner. Not touched by irq_domain
141 * @flags: host per irq_domain flags
142 * @mapcount: The number of mapped interrupts
145 * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
146 * to swap it for the of_node via the irq_domain_get_of_node accessor
147 * @gc: Pointer to a list of generic chips. There is a helper function for
148 * setting up one or more generic chips for interrupt controllers
149 * drivers using the generic chip library which uses this pointer.
150 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
152 * Revmap data, used internally by irq_domain
153 * @revmap_size: Size of the linear map table @revmap[]
154 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
155 * @revmap_mutex: Lock for the revmap
156 * @revmap: Linear table of irq_data pointers
159 struct list_head link
;
161 const struct irq_domain_ops
*ops
;
164 unsigned int mapcount
;
167 struct fwnode_handle
*fwnode
;
168 enum irq_domain_bus_token bus_token
;
169 struct irq_domain_chip_generic
*gc
;
170 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
171 struct irq_domain
*parent
;
174 /* reverse map data. The linear map gets appended to the irq_domain */
175 irq_hw_number_t hwirq_max
;
176 unsigned int revmap_size
;
177 struct radix_tree_root revmap_tree
;
178 struct mutex revmap_mutex
;
179 struct irq_data __rcu
*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 << 1),
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 * Quirk to handle MSI implementations which do not provide
204 * masking. Currently known to affect x86, but partially
205 * handled in core code.
207 IRQ_DOMAIN_MSI_NOMASK_QUIRK
= (1 << 6),
209 /* Irq domain doesn't translate anything */
210 IRQ_DOMAIN_FLAG_NO_MAP
= (1 << 7),
213 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
214 * for implementation specific purposes and ignored by the
217 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
220 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
222 return to_of_node(d
->fwnode
);
225 #ifdef CONFIG_IRQ_DOMAIN
226 struct fwnode_handle
*__irq_domain_alloc_fwnode(unsigned int type
, int id
,
227 const char *name
, phys_addr_t
*pa
);
231 IRQCHIP_FWNODE_NAMED
,
232 IRQCHIP_FWNODE_NAMED_ID
,
236 struct fwnode_handle
*irq_domain_alloc_named_fwnode(const char *name
)
238 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED
, 0, name
, NULL
);
242 struct fwnode_handle
*irq_domain_alloc_named_id_fwnode(const char *name
, int id
)
244 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID
, id
, name
,
248 static inline struct fwnode_handle
*irq_domain_alloc_fwnode(phys_addr_t
*pa
)
250 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL
, 0, NULL
, pa
);
253 void irq_domain_free_fwnode(struct fwnode_handle
*fwnode
);
254 struct irq_domain
*__irq_domain_add(struct fwnode_handle
*fwnode
, int size
,
255 irq_hw_number_t hwirq_max
, int direct_max
,
256 const struct irq_domain_ops
*ops
,
258 struct irq_domain
*irq_domain_create_simple(struct fwnode_handle
*fwnode
,
260 unsigned int first_irq
,
261 const struct irq_domain_ops
*ops
,
263 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
265 unsigned int first_irq
,
266 irq_hw_number_t first_hwirq
,
267 const struct irq_domain_ops
*ops
,
269 struct irq_domain
*irq_domain_create_legacy(struct fwnode_handle
*fwnode
,
271 unsigned int first_irq
,
272 irq_hw_number_t first_hwirq
,
273 const struct irq_domain_ops
*ops
,
275 extern struct irq_domain
*irq_find_matching_fwspec(struct irq_fwspec
*fwspec
,
276 enum irq_domain_bus_token bus_token
);
277 extern bool irq_domain_check_msi_remap(void);
278 extern void irq_set_default_host(struct irq_domain
*host
);
279 extern struct irq_domain
*irq_get_default_host(void);
280 extern int irq_domain_alloc_descs(int virq
, unsigned int nr_irqs
,
281 irq_hw_number_t hwirq
, int node
,
282 const struct irq_affinity_desc
*affinity
);
284 static inline struct fwnode_handle
*of_node_to_fwnode(struct device_node
*node
)
286 return node
? &node
->fwnode
: NULL
;
289 extern const struct fwnode_operations irqchip_fwnode_ops
;
291 static inline bool is_fwnode_irqchip(struct fwnode_handle
*fwnode
)
293 return fwnode
&& fwnode
->ops
== &irqchip_fwnode_ops
;
296 extern void irq_domain_update_bus_token(struct irq_domain
*domain
,
297 enum irq_domain_bus_token bus_token
);
300 struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
301 enum irq_domain_bus_token bus_token
)
303 struct irq_fwspec fwspec
= {
307 return irq_find_matching_fwspec(&fwspec
, bus_token
);
310 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
311 enum irq_domain_bus_token bus_token
)
313 return irq_find_matching_fwnode(of_node_to_fwnode(node
), bus_token
);
316 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
318 struct irq_domain
*d
;
320 d
= irq_find_matching_host(node
, DOMAIN_BUS_WIRED
);
322 d
= irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
327 static inline struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
329 unsigned int first_irq
,
330 const struct irq_domain_ops
*ops
,
333 return irq_domain_create_simple(of_node_to_fwnode(of_node
), size
, first_irq
, ops
, host_data
);
337 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
338 * @of_node: pointer to interrupt controller's device tree node.
339 * @size: Number of interrupts in the domain.
340 * @ops: map/unmap domain callbacks
341 * @host_data: Controller private data pointer
343 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
345 const struct irq_domain_ops
*ops
,
348 return __irq_domain_add(of_node_to_fwnode(of_node
), size
, size
, 0, ops
, host_data
);
351 #ifdef CONFIG_IRQ_DOMAIN_NOMAP
352 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
353 unsigned int max_irq
,
354 const struct irq_domain_ops
*ops
,
357 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, max_irq
, max_irq
, ops
, host_data
);
360 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
363 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
364 const struct irq_domain_ops
*ops
,
367 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, ~0, 0, ops
, host_data
);
370 static inline struct irq_domain
*irq_domain_create_linear(struct fwnode_handle
*fwnode
,
372 const struct irq_domain_ops
*ops
,
375 return __irq_domain_add(fwnode
, size
, size
, 0, ops
, host_data
);
378 static inline struct irq_domain
*irq_domain_create_tree(struct fwnode_handle
*fwnode
,
379 const struct irq_domain_ops
*ops
,
382 return __irq_domain_add(fwnode
, 0, ~0, 0, ops
, host_data
);
385 extern void irq_domain_remove(struct irq_domain
*host
);
387 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
388 irq_hw_number_t hwirq
);
389 extern void irq_domain_associate_many(struct irq_domain
*domain
,
390 unsigned int irq_base
,
391 irq_hw_number_t hwirq_base
, int count
);
393 extern unsigned int irq_create_mapping_affinity(struct irq_domain
*host
,
394 irq_hw_number_t hwirq
,
395 const struct irq_affinity_desc
*affinity
);
396 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec
*fwspec
);
397 extern void irq_dispose_mapping(unsigned int virq
);
399 static inline unsigned int irq_create_mapping(struct irq_domain
*host
,
400 irq_hw_number_t hwirq
)
402 return irq_create_mapping_affinity(host
, hwirq
, NULL
);
405 extern struct irq_desc
*__irq_resolve_mapping(struct irq_domain
*domain
,
406 irq_hw_number_t hwirq
,
409 static inline struct irq_desc
*irq_resolve_mapping(struct irq_domain
*domain
,
410 irq_hw_number_t hwirq
)
412 return __irq_resolve_mapping(domain
, hwirq
, NULL
);
416 * irq_find_mapping() - Find a linux irq from a hw irq number.
417 * @domain: domain owning this hardware interrupt
418 * @hwirq: hardware irq number in that domain space
420 static inline unsigned int irq_find_mapping(struct irq_domain
*domain
,
421 irq_hw_number_t hwirq
)
425 if (__irq_resolve_mapping(domain
, hwirq
, &irq
))
431 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
432 irq_hw_number_t hwirq
)
434 return irq_find_mapping(domain
, hwirq
);
437 extern const struct irq_domain_ops irq_domain_simple_ops
;
439 /* stock xlate functions */
440 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
441 const u32
*intspec
, unsigned int intsize
,
442 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
443 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
444 const u32
*intspec
, unsigned int intsize
,
445 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
446 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
447 const u32
*intspec
, unsigned int intsize
,
448 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
450 int irq_domain_translate_twocell(struct irq_domain
*d
,
451 struct irq_fwspec
*fwspec
,
452 unsigned long *out_hwirq
,
453 unsigned int *out_type
);
455 int irq_domain_translate_onecell(struct irq_domain
*d
,
456 struct irq_fwspec
*fwspec
,
457 unsigned long *out_hwirq
,
458 unsigned int *out_type
);
461 int irq_reserve_ipi(struct irq_domain
*domain
, const struct cpumask
*dest
);
462 int irq_destroy_ipi(unsigned int irq
, const struct cpumask
*dest
);
464 /* V2 interfaces to support hierarchy IRQ domains. */
465 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
467 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
468 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
469 void *chip_data
, irq_flow_handler_t handler
,
470 void *handler_data
, const char *handler_name
);
471 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
472 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
473 extern struct irq_domain
*irq_domain_create_hierarchy(struct irq_domain
*parent
,
474 unsigned int flags
, unsigned int size
,
475 struct fwnode_handle
*fwnode
,
476 const struct irq_domain_ops
*ops
, void *host_data
);
478 static inline struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
481 struct device_node
*node
,
482 const struct irq_domain_ops
*ops
,
485 return irq_domain_create_hierarchy(parent
, flags
, size
,
486 of_node_to_fwnode(node
),
490 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
491 unsigned int nr_irqs
, int node
, void *arg
,
493 const struct irq_affinity_desc
*affinity
);
494 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
495 extern int irq_domain_activate_irq(struct irq_data
*irq_data
, bool early
);
496 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
498 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
499 unsigned int nr_irqs
, int node
, void *arg
)
501 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false,
505 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain
*domain
,
506 unsigned int irq_base
,
507 unsigned int nr_irqs
, void *arg
);
508 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
510 irq_hw_number_t hwirq
,
511 struct irq_chip
*chip
,
513 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
515 unsigned int nr_irqs
);
516 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
517 unsigned int virq
, unsigned int nr_irqs
);
519 extern int irq_domain_push_irq(struct irq_domain
*domain
, int virq
, void *arg
);
520 extern int irq_domain_pop_irq(struct irq_domain
*domain
, int virq
);
522 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
523 unsigned int irq_base
,
524 unsigned int nr_irqs
, void *arg
);
526 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
527 unsigned int irq_base
,
528 unsigned int nr_irqs
);
530 extern int irq_domain_disconnect_hierarchy(struct irq_domain
*domain
,
533 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
535 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
538 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
540 return domain
->flags
&
541 (IRQ_DOMAIN_FLAG_IPI_PER_CPU
| IRQ_DOMAIN_FLAG_IPI_SINGLE
);
544 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
546 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_PER_CPU
;
549 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
551 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_SINGLE
;
554 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
556 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI
;
559 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
561 return domain
->flags
& IRQ_DOMAIN_FLAG_MSI_REMAP
;
564 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
);
566 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
567 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
568 unsigned int nr_irqs
, int node
, void *arg
)
573 static inline void irq_domain_free_irqs(unsigned int virq
,
574 unsigned int nr_irqs
) { }
576 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
581 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
586 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
591 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
596 static inline bool irq_domain_is_msi(struct irq_domain
*domain
)
601 static inline bool irq_domain_is_msi_remap(struct irq_domain
*domain
)
607 irq_domain_hierarchical_is_msi_remap(struct irq_domain
*domain
)
611 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
613 #else /* CONFIG_IRQ_DOMAIN */
614 static inline void irq_dispose_mapping(unsigned int virq
) { }
615 static inline struct irq_domain
*irq_find_matching_fwnode(
616 struct fwnode_handle
*fwnode
, enum irq_domain_bus_token bus_token
)
620 static inline bool irq_domain_check_msi_remap(void)
624 #endif /* !CONFIG_IRQ_DOMAIN */
626 #endif /* _LINUX_IRQDOMAIN_H */