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>
43 /* Number of irqs reserved for a legacy isa controller */
44 #define NUM_ISA_INTERRUPTS 16
46 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
49 * struct irq_fwspec - generic IRQ specifier structure
51 * @fwnode: Pointer to a firmware-specific descriptor
52 * @param_count: Number of device-specific parameters
53 * @param: Device-specific parameters
55 * This structure, directly modeled after of_phandle_args, is used to
56 * pass a device-specific description of an interrupt.
59 struct fwnode_handle
*fwnode
;
61 u32 param
[IRQ_DOMAIN_IRQ_SPEC_PARAMS
];
65 * Should several domains have the same device node, but serve
66 * different purposes (for example one domain is for PCI/MSI, and the
67 * other for wired IRQs), they can be distinguished using a
68 * bus-specific token. Most domains are expected to only carry
71 enum irq_domain_bus_token
{
75 DOMAIN_BUS_PLATFORM_MSI
,
81 * struct irq_domain_ops - Methods for irq_domain objects
82 * @match: Match an interrupt controller device node to a host, returns
84 * @map: Create or update a mapping between a virtual irq number and a hw
85 * irq number. This is called only once for a given mapping.
86 * @unmap: Dispose of such a mapping
87 * @xlate: Given a device tree node and interrupt specifier, decode
88 * the hardware irq number and linux irq type value.
90 * Functions below are provided by the driver and called whenever a new mapping
91 * is created or an old mapping is disposed. The driver can then proceed to
92 * whatever internal data structures management is required. It also needs
93 * to setup the irq_desc when returning from map().
95 struct irq_domain_ops
{
96 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
97 enum irq_domain_bus_token bus_token
);
98 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
99 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
100 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
101 const u32
*intspec
, unsigned int intsize
,
102 unsigned long *out_hwirq
, unsigned int *out_type
);
104 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
105 /* extended V2 interfaces to support hierarchy irq_domains */
106 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
107 unsigned int nr_irqs
, void *arg
);
108 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
109 unsigned int nr_irqs
);
110 void (*activate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
111 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
112 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
113 unsigned long *out_hwirq
, unsigned int *out_type
);
117 extern struct irq_domain_ops irq_generic_chip_ops
;
119 struct irq_domain_chip_generic
;
122 * struct irq_domain - Hardware interrupt number translation object
123 * @link: Element in global irq_domain list.
124 * @name: Name of interrupt domain
125 * @ops: pointer to irq_domain methods
126 * @host_data: private data pointer for use by owner. Not touched by irq_domain
128 * @flags: host per irq_domain flags
131 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
132 * when decoding device tree interrupt specifiers.
133 * @gc: Pointer to a list of generic chips. There is a helper function for
134 * setting up one or more generic chips for interrupt controllers
135 * drivers using the generic chip library which uses this pointer.
136 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
138 * Revmap data, used internally by irq_domain
139 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
140 * support direct mapping
141 * @revmap_size: Size of the linear map table @linear_revmap[]
142 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
143 * @linear_revmap: Linear table of hwirq->virq reverse mappings
146 struct list_head link
;
148 const struct irq_domain_ops
*ops
;
153 struct fwnode_handle
*fwnode
;
154 enum irq_domain_bus_token bus_token
;
155 struct irq_domain_chip_generic
*gc
;
156 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
157 struct irq_domain
*parent
;
160 /* reverse map data. The linear map gets appended to the irq_domain */
161 irq_hw_number_t hwirq_max
;
162 unsigned int revmap_direct_max_irq
;
163 unsigned int revmap_size
;
164 struct radix_tree_root revmap_tree
;
165 unsigned int linear_revmap
[];
168 /* Irq domain flags */
170 /* Irq domain is hierarchical */
171 IRQ_DOMAIN_FLAG_HIERARCHY
= (1 << 0),
173 /* Core calls alloc/free recursive through the domain hierarchy. */
174 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE
= (1 << 1),
176 /* Irq domain is an IPI domain with virq per cpu */
177 IRQ_DOMAIN_FLAG_IPI_PER_CPU
= (1 << 2),
179 /* Irq domain is an IPI domain with single virq */
180 IRQ_DOMAIN_FLAG_IPI_SINGLE
= (1 << 3),
183 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
184 * for implementation specific purposes and ignored by the
187 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
190 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
192 return to_of_node(d
->fwnode
);
195 #ifdef CONFIG_IRQ_DOMAIN
196 struct fwnode_handle
*irq_domain_alloc_fwnode(void *data
);
197 void irq_domain_free_fwnode(struct fwnode_handle
*fwnode
);
198 struct irq_domain
*__irq_domain_add(struct fwnode_handle
*fwnode
, int size
,
199 irq_hw_number_t hwirq_max
, int direct_max
,
200 const struct irq_domain_ops
*ops
,
202 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
204 unsigned int first_irq
,
205 const struct irq_domain_ops
*ops
,
207 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
209 unsigned int first_irq
,
210 irq_hw_number_t first_hwirq
,
211 const struct irq_domain_ops
*ops
,
213 extern struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
214 enum irq_domain_bus_token bus_token
);
215 extern void irq_set_default_host(struct irq_domain
*host
);
216 extern int irq_domain_alloc_descs(int virq
, unsigned int nr_irqs
,
217 irq_hw_number_t hwirq
, int node
);
219 static inline struct fwnode_handle
*of_node_to_fwnode(struct device_node
*node
)
221 return node
? &node
->fwnode
: NULL
;
224 static inline bool is_fwnode_irqchip(struct fwnode_handle
*fwnode
)
226 return fwnode
&& fwnode
->type
== FWNODE_IRQCHIP
;
229 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
230 enum irq_domain_bus_token bus_token
)
232 return irq_find_matching_fwnode(of_node_to_fwnode(node
), bus_token
);
235 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
237 return irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
241 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
242 * @of_node: pointer to interrupt controller's device tree node.
243 * @size: Number of interrupts in the domain.
244 * @ops: map/unmap domain callbacks
245 * @host_data: Controller private data pointer
247 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
249 const struct irq_domain_ops
*ops
,
252 return __irq_domain_add(of_node_to_fwnode(of_node
), size
, size
, 0, ops
, host_data
);
254 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
255 unsigned int max_irq
,
256 const struct irq_domain_ops
*ops
,
259 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, max_irq
, max_irq
, ops
, host_data
);
261 static inline struct irq_domain
*irq_domain_add_legacy_isa(
262 struct device_node
*of_node
,
263 const struct irq_domain_ops
*ops
,
266 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
269 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
270 const struct irq_domain_ops
*ops
,
273 return __irq_domain_add(of_node_to_fwnode(of_node
), 0, ~0, 0, ops
, host_data
);
276 static inline struct irq_domain
*irq_domain_create_linear(struct fwnode_handle
*fwnode
,
278 const struct irq_domain_ops
*ops
,
281 return __irq_domain_add(fwnode
, size
, size
, 0, ops
, host_data
);
284 static inline struct irq_domain
*irq_domain_create_tree(struct fwnode_handle
*fwnode
,
285 const struct irq_domain_ops
*ops
,
288 return __irq_domain_add(fwnode
, 0, ~0, 0, ops
, host_data
);
291 extern void irq_domain_remove(struct irq_domain
*host
);
293 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
294 irq_hw_number_t hwirq
);
295 extern void irq_domain_associate_many(struct irq_domain
*domain
,
296 unsigned int irq_base
,
297 irq_hw_number_t hwirq_base
, int count
);
298 extern void irq_domain_disassociate(struct irq_domain
*domain
,
301 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
302 irq_hw_number_t hwirq
);
303 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec
*fwspec
);
304 extern void irq_dispose_mapping(unsigned int virq
);
307 * irq_linear_revmap() - Find a linux irq from a hw irq number.
308 * @domain: domain owning this hardware interrupt
309 * @hwirq: hardware irq number in that domain space
311 * This is a fast path alternative to irq_find_mapping() that can be
312 * called directly by irq controller code to save a handful of
313 * instructions. It is always safe to call, but won't find irqs mapped
314 * using the radix tree.
316 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
317 irq_hw_number_t hwirq
)
319 return hwirq
< domain
->revmap_size
? domain
->linear_revmap
[hwirq
] : 0;
321 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
322 irq_hw_number_t hwirq
);
323 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
324 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
325 unsigned int irq_base
,
326 irq_hw_number_t hwirq_base
, int count
);
328 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
329 irq_hw_number_t hwirq
)
331 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
334 extern const struct irq_domain_ops irq_domain_simple_ops
;
336 /* stock xlate functions */
337 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
338 const u32
*intspec
, unsigned int intsize
,
339 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
340 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
341 const u32
*intspec
, unsigned int intsize
,
342 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
343 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
344 const u32
*intspec
, unsigned int intsize
,
345 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
348 unsigned int irq_reserve_ipi(struct irq_domain
*domain
,
349 const struct cpumask
*dest
);
350 void irq_destroy_ipi(unsigned int irq
);
352 /* V2 interfaces to support hierarchy IRQ domains. */
353 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
355 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
356 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
357 void *chip_data
, irq_flow_handler_t handler
,
358 void *handler_data
, const char *handler_name
);
359 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
360 extern struct irq_domain
*irq_domain_create_hierarchy(struct irq_domain
*parent
,
361 unsigned int flags
, unsigned int size
,
362 struct fwnode_handle
*fwnode
,
363 const struct irq_domain_ops
*ops
, void *host_data
);
365 static inline struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
368 struct device_node
*node
,
369 const struct irq_domain_ops
*ops
,
372 return irq_domain_create_hierarchy(parent
, flags
, size
,
373 of_node_to_fwnode(node
),
377 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
378 unsigned int nr_irqs
, int node
, void *arg
,
380 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
381 extern void irq_domain_activate_irq(struct irq_data
*irq_data
);
382 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
384 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
385 unsigned int nr_irqs
, int node
, void *arg
)
387 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false);
390 extern int irq_domain_alloc_irqs_recursive(struct irq_domain
*domain
,
391 unsigned int irq_base
,
392 unsigned int nr_irqs
, void *arg
);
393 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
395 irq_hw_number_t hwirq
,
396 struct irq_chip
*chip
,
398 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
399 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
401 unsigned int nr_irqs
);
402 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
403 unsigned int virq
, unsigned int nr_irqs
);
405 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
406 unsigned int irq_base
,
407 unsigned int nr_irqs
, void *arg
);
409 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
410 unsigned int irq_base
,
411 unsigned int nr_irqs
);
413 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
415 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
418 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
420 return domain
->flags
&
421 (IRQ_DOMAIN_FLAG_IPI_PER_CPU
| IRQ_DOMAIN_FLAG_IPI_SINGLE
);
424 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
426 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_PER_CPU
;
429 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
431 return domain
->flags
& IRQ_DOMAIN_FLAG_IPI_SINGLE
;
433 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
434 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
435 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
436 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
437 unsigned int nr_irqs
, int node
, void *arg
)
442 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
447 static inline bool irq_domain_is_ipi(struct irq_domain
*domain
)
452 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain
*domain
)
457 static inline bool irq_domain_is_ipi_single(struct irq_domain
*domain
)
461 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
463 #else /* CONFIG_IRQ_DOMAIN */
464 static inline void irq_dispose_mapping(unsigned int virq
) { }
465 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
466 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
467 static inline struct irq_domain
*irq_find_matching_fwnode(
468 struct fwnode_handle
*fwnode
, enum irq_domain_bus_token bus_token
)
472 #endif /* !CONFIG_IRQ_DOMAIN */
474 #endif /* _LINUX_IRQDOMAIN_H */