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 a hook for translating device tree interrupt
9 * representation into a hardware irq number that can be mapped back to a
10 * Linux irq number without any extra platform support code.
12 * Interrupt controller "domain" data structure. This could be defined as a
13 * irq domain controller. That is, it handles the mapping between hardware
14 * and virtual interrupt numbers for a given interrupt domain. The domain
15 * structure is generally created by the PIC code for a given PIC instance
16 * (though a domain can cover more than one PIC if they have a flat number
17 * model). It's the domain callbacks that are responsible for setting the
18 * irq_chip on a given irq_desc after it's been mapped.
20 * The host code and data structures are agnostic to whether or not
21 * we use an open firmware device-tree. We do have references to struct
22 * device_node in two places: in irq_find_host() to find the host matching
23 * a given interrupt controller node, and of course as an argument to its
24 * counterpart domain->ops->match() callback. However, those are treated as
25 * generic pointers by the core and the fact that it's actually a device-node
26 * pointer is purely a convention between callers and implementation. This
27 * code could thus be used on other architectures by replacing those two
28 * by some sort of arch-specific void * "token" used to identify interrupt
32 #ifndef _LINUX_IRQDOMAIN_H
33 #define _LINUX_IRQDOMAIN_H
35 #include <linux/types.h>
36 #include <linux/irqhandler.h>
38 #include <linux/radix-tree.h>
46 /* Number of irqs reserved for a legacy isa controller */
47 #define NUM_ISA_INTERRUPTS 16
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_PLATFORM_MSI
,
82 * struct irq_domain_ops - Methods for irq_domain objects
83 * @match: Match an interrupt controller device node to a host, returns
85 * @map: Create or update a mapping between a virtual irq number and a hw
86 * irq number. This is called only once for a given mapping.
87 * @unmap: Dispose of such a mapping
88 * @xlate: Given a device tree node and interrupt specifier, decode
89 * the hardware irq number and linux irq type value.
91 * Functions below are provided by the driver and called whenever a new mapping
92 * is created or an old mapping is disposed. The driver can then proceed to
93 * whatever internal data structures management is required. It also needs
94 * to setup the irq_desc when returning from map().
96 struct irq_domain_ops
{
97 int (*match
)(struct irq_domain
*d
, struct device_node
*node
,
98 enum irq_domain_bus_token bus_token
);
99 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
100 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
101 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
102 const u32
*intspec
, unsigned int intsize
,
103 unsigned long *out_hwirq
, unsigned int *out_type
);
105 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
106 /* extended V2 interfaces to support hierarchy irq_domains */
107 int (*alloc
)(struct irq_domain
*d
, unsigned int virq
,
108 unsigned int nr_irqs
, void *arg
);
109 void (*free
)(struct irq_domain
*d
, unsigned int virq
,
110 unsigned int nr_irqs
);
111 void (*activate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
112 void (*deactivate
)(struct irq_domain
*d
, struct irq_data
*irq_data
);
113 int (*translate
)(struct irq_domain
*d
, struct irq_fwspec
*fwspec
,
114 unsigned long *out_hwirq
, unsigned int *out_type
);
118 extern struct irq_domain_ops irq_generic_chip_ops
;
120 struct irq_domain_chip_generic
;
123 * struct irq_domain - Hardware interrupt number translation object
124 * @link: Element in global irq_domain list.
125 * @name: Name of interrupt domain
126 * @ops: pointer to irq_domain methods
127 * @host_data: private data pointer for use by owner. Not touched by irq_domain
129 * @flags: host per irq_domain flags
132 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
133 * when decoding device tree interrupt specifiers.
134 * @gc: Pointer to a list of generic chips. There is a helper function for
135 * setting up one or more generic chips for interrupt controllers
136 * drivers using the generic chip library which uses this pointer.
137 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
139 * Revmap data, used internally by irq_domain
140 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
141 * support direct mapping
142 * @revmap_size: Size of the linear map table @linear_revmap[]
143 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
144 * @linear_revmap: Linear table of hwirq->virq reverse mappings
147 struct list_head link
;
149 const struct irq_domain_ops
*ops
;
154 struct fwnode_handle
*fwnode
;
155 enum irq_domain_bus_token bus_token
;
156 struct irq_domain_chip_generic
*gc
;
157 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
158 struct irq_domain
*parent
;
161 /* reverse map data. The linear map gets appended to the irq_domain */
162 irq_hw_number_t hwirq_max
;
163 unsigned int revmap_direct_max_irq
;
164 unsigned int revmap_size
;
165 struct radix_tree_root revmap_tree
;
166 unsigned int linear_revmap
[];
169 /* Irq domain flags */
171 /* Irq domain is hierarchical */
172 IRQ_DOMAIN_FLAG_HIERARCHY
= (1 << 0),
174 /* Core calls alloc/free recursive through the domain hierarchy. */
175 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE
= (1 << 1),
178 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
179 * for implementation specific purposes and ignored by the
182 IRQ_DOMAIN_FLAG_NONCORE
= (1 << 16),
185 static inline struct device_node
*irq_domain_get_of_node(struct irq_domain
*d
)
187 return to_of_node(d
->fwnode
);
190 #ifdef CONFIG_IRQ_DOMAIN
191 struct irq_domain
*__irq_domain_add(struct device_node
*of_node
, int size
,
192 irq_hw_number_t hwirq_max
, int direct_max
,
193 const struct irq_domain_ops
*ops
,
195 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
197 unsigned int first_irq
,
198 const struct irq_domain_ops
*ops
,
200 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
202 unsigned int first_irq
,
203 irq_hw_number_t first_hwirq
,
204 const struct irq_domain_ops
*ops
,
206 extern struct irq_domain
*irq_find_matching_fwnode(struct fwnode_handle
*fwnode
,
207 enum irq_domain_bus_token bus_token
);
208 extern void irq_set_default_host(struct irq_domain
*host
);
210 static inline struct irq_domain
*irq_find_matching_host(struct device_node
*node
,
211 enum irq_domain_bus_token bus_token
)
213 return irq_find_matching_fwnode(node
? &node
->fwnode
: NULL
,
217 static inline struct irq_domain
*irq_find_host(struct device_node
*node
)
219 return irq_find_matching_host(node
, DOMAIN_BUS_ANY
);
223 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
224 * @of_node: pointer to interrupt controller's device tree node.
225 * @size: Number of interrupts in the domain.
226 * @ops: map/unmap domain callbacks
227 * @host_data: Controller private data pointer
229 static inline struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
231 const struct irq_domain_ops
*ops
,
234 return __irq_domain_add(of_node
, size
, size
, 0, ops
, host_data
);
236 static inline struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
237 unsigned int max_irq
,
238 const struct irq_domain_ops
*ops
,
241 return __irq_domain_add(of_node
, 0, max_irq
, max_irq
, ops
, host_data
);
243 static inline struct irq_domain
*irq_domain_add_legacy_isa(
244 struct device_node
*of_node
,
245 const struct irq_domain_ops
*ops
,
248 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
251 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
252 const struct irq_domain_ops
*ops
,
255 return __irq_domain_add(of_node
, 0, ~0, 0, ops
, host_data
);
258 extern void irq_domain_remove(struct irq_domain
*host
);
260 extern int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
261 irq_hw_number_t hwirq
);
262 extern void irq_domain_associate_many(struct irq_domain
*domain
,
263 unsigned int irq_base
,
264 irq_hw_number_t hwirq_base
, int count
);
265 extern void irq_domain_disassociate(struct irq_domain
*domain
,
268 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
269 irq_hw_number_t hwirq
);
270 extern void irq_dispose_mapping(unsigned int virq
);
273 * irq_linear_revmap() - Find a linux irq from a hw irq number.
274 * @domain: domain owning this hardware interrupt
275 * @hwirq: hardware irq number in that domain space
277 * This is a fast path alternative to irq_find_mapping() that can be
278 * called directly by irq controller code to save a handful of
279 * instructions. It is always safe to call, but won't find irqs mapped
280 * using the radix tree.
282 static inline unsigned int irq_linear_revmap(struct irq_domain
*domain
,
283 irq_hw_number_t hwirq
)
285 return hwirq
< domain
->revmap_size
? domain
->linear_revmap
[hwirq
] : 0;
287 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
288 irq_hw_number_t hwirq
);
289 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
290 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
291 unsigned int irq_base
,
292 irq_hw_number_t hwirq_base
, int count
);
294 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
295 irq_hw_number_t hwirq
)
297 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
300 extern const struct irq_domain_ops irq_domain_simple_ops
;
302 /* stock xlate functions */
303 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
304 const u32
*intspec
, unsigned int intsize
,
305 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
306 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
307 const u32
*intspec
, unsigned int intsize
,
308 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
309 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
310 const u32
*intspec
, unsigned int intsize
,
311 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
313 /* V2 interfaces to support hierarchy IRQ domains. */
314 extern struct irq_data
*irq_domain_get_irq_data(struct irq_domain
*domain
,
316 extern void irq_domain_set_info(struct irq_domain
*domain
, unsigned int virq
,
317 irq_hw_number_t hwirq
, struct irq_chip
*chip
,
318 void *chip_data
, irq_flow_handler_t handler
,
319 void *handler_data
, const char *handler_name
);
320 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
321 extern struct irq_domain
*irq_domain_add_hierarchy(struct irq_domain
*parent
,
322 unsigned int flags
, unsigned int size
,
323 struct device_node
*node
,
324 const struct irq_domain_ops
*ops
, void *host_data
);
325 extern int __irq_domain_alloc_irqs(struct irq_domain
*domain
, int irq_base
,
326 unsigned int nr_irqs
, int node
, void *arg
,
328 extern void irq_domain_free_irqs(unsigned int virq
, unsigned int nr_irqs
);
329 extern void irq_domain_activate_irq(struct irq_data
*irq_data
);
330 extern void irq_domain_deactivate_irq(struct irq_data
*irq_data
);
332 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
333 unsigned int nr_irqs
, int node
, void *arg
)
335 return __irq_domain_alloc_irqs(domain
, -1, nr_irqs
, node
, arg
, false);
338 extern int irq_domain_set_hwirq_and_chip(struct irq_domain
*domain
,
340 irq_hw_number_t hwirq
,
341 struct irq_chip
*chip
,
343 extern void irq_domain_reset_irq_data(struct irq_data
*irq_data
);
344 extern void irq_domain_free_irqs_common(struct irq_domain
*domain
,
346 unsigned int nr_irqs
);
347 extern void irq_domain_free_irqs_top(struct irq_domain
*domain
,
348 unsigned int virq
, unsigned int nr_irqs
);
350 extern int irq_domain_alloc_irqs_parent(struct irq_domain
*domain
,
351 unsigned int irq_base
,
352 unsigned int nr_irqs
, void *arg
);
354 extern void irq_domain_free_irqs_parent(struct irq_domain
*domain
,
355 unsigned int irq_base
,
356 unsigned int nr_irqs
);
358 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
360 return domain
->flags
& IRQ_DOMAIN_FLAG_HIERARCHY
;
362 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
363 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
364 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
365 static inline int irq_domain_alloc_irqs(struct irq_domain
*domain
,
366 unsigned int nr_irqs
, int node
, void *arg
)
371 static inline bool irq_domain_is_hierarchy(struct irq_domain
*domain
)
375 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
377 #else /* CONFIG_IRQ_DOMAIN */
378 static inline void irq_dispose_mapping(unsigned int virq
) { }
379 static inline void irq_domain_activate_irq(struct irq_data
*data
) { }
380 static inline void irq_domain_deactivate_irq(struct irq_data
*data
) { }
381 #endif /* !CONFIG_IRQ_DOMAIN */
383 #endif /* _LINUX_IRQDOMAIN_H */