Commit | Line | Data |
---|---|---|
08a543ad GL |
1 | /* |
2 | * irq_domain - IRQ translation domains | |
3 | * | |
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. | |
7 | * | |
e7a46c81 MZ |
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 | |
11 | * support code. | |
08a543ad | 12 | * |
7bb69bad GL |
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. | |
cc79ca69 | 20 | * |
e7a46c81 MZ |
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. | |
08a543ad | 27 | */ |
7bb69bad | 28 | |
08a543ad GL |
29 | #ifndef _LINUX_IRQDOMAIN_H |
30 | #define _LINUX_IRQDOMAIN_H | |
31 | ||
7bb69bad | 32 | #include <linux/types.h> |
1b537708 | 33 | #include <linux/irqhandler.h> |
f110711a | 34 | #include <linux/of.h> |
7bb69bad | 35 | #include <linux/radix-tree.h> |
08a543ad | 36 | |
08a543ad GL |
37 | struct device_node; |
38 | struct irq_domain; | |
7bb69bad | 39 | struct of_device_id; |
f8264e34 JL |
40 | struct irq_chip; |
41 | struct irq_data; | |
7bb69bad | 42 | |
1bc04f2c GL |
43 | /* Number of irqs reserved for a legacy isa controller */ |
44 | #define NUM_ISA_INTERRUPTS 16 | |
45 | ||
11e4438e MZ |
46 | #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16 |
47 | ||
48 | /** | |
49 | * struct irq_fwspec - generic IRQ specifier structure | |
50 | * | |
51 | * @fwnode: Pointer to a firmware-specific descriptor | |
52 | * @param_count: Number of device-specific parameters | |
53 | * @param: Device-specific parameters | |
54 | * | |
55 | * This structure, directly modeled after of_phandle_args, is used to | |
56 | * pass a device-specific description of an interrupt. | |
57 | */ | |
58 | struct irq_fwspec { | |
59 | struct fwnode_handle *fwnode; | |
60 | int param_count; | |
61 | u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS]; | |
62 | }; | |
63 | ||
ad3aedfb MZ |
64 | /* |
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 | |
69 | * DOMAIN_BUS_ANY. | |
70 | */ | |
71 | enum irq_domain_bus_token { | |
72 | DOMAIN_BUS_ANY = 0, | |
530cbe10 | 73 | DOMAIN_BUS_WIRED, |
0380839d | 74 | DOMAIN_BUS_PCI_MSI, |
c706c239 | 75 | DOMAIN_BUS_PLATFORM_MSI, |
a5716070 | 76 | DOMAIN_BUS_NEXUS, |
ad3aedfb MZ |
77 | }; |
78 | ||
08a543ad GL |
79 | /** |
80 | * struct irq_domain_ops - Methods for irq_domain objects | |
7bb69bad GL |
81 | * @match: Match an interrupt controller device node to a host, returns |
82 | * 1 on a match | |
83 | * @map: Create or update a mapping between a virtual irq number and a hw | |
84 | * irq number. This is called only once for a given mapping. | |
85 | * @unmap: Dispose of such a mapping | |
7bb69bad GL |
86 | * @xlate: Given a device tree node and interrupt specifier, decode |
87 | * the hardware irq number and linux irq type value. | |
88 | * | |
89 | * Functions below are provided by the driver and called whenever a new mapping | |
90 | * is created or an old mapping is disposed. The driver can then proceed to | |
91 | * whatever internal data structures management is required. It also needs | |
92 | * to setup the irq_desc when returning from map(). | |
08a543ad GL |
93 | */ |
94 | struct irq_domain_ops { | |
ad3aedfb MZ |
95 | int (*match)(struct irq_domain *d, struct device_node *node, |
96 | enum irq_domain_bus_token bus_token); | |
7bb69bad GL |
97 | int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw); |
98 | void (*unmap)(struct irq_domain *d, unsigned int virq); | |
7bb69bad GL |
99 | int (*xlate)(struct irq_domain *d, struct device_node *node, |
100 | const u32 *intspec, unsigned int intsize, | |
101 | unsigned long *out_hwirq, unsigned int *out_type); | |
f8264e34 JL |
102 | |
103 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY | |
104 | /* extended V2 interfaces to support hierarchy irq_domains */ | |
105 | int (*alloc)(struct irq_domain *d, unsigned int virq, | |
106 | unsigned int nr_irqs, void *arg); | |
107 | void (*free)(struct irq_domain *d, unsigned int virq, | |
108 | unsigned int nr_irqs); | |
109 | void (*activate)(struct irq_domain *d, struct irq_data *irq_data); | |
110 | void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data); | |
11e4438e MZ |
111 | int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec, |
112 | unsigned long *out_hwirq, unsigned int *out_type); | |
f8264e34 | 113 | #endif |
08a543ad GL |
114 | }; |
115 | ||
088f40b7 TG |
116 | extern struct irq_domain_ops irq_generic_chip_ops; |
117 | ||
118 | struct irq_domain_chip_generic; | |
119 | ||
08a543ad GL |
120 | /** |
121 | * struct irq_domain - Hardware interrupt number translation object | |
7bb69bad | 122 | * @link: Element in global irq_domain list. |
1aa0dd94 | 123 | * @name: Name of interrupt domain |
7bb69bad GL |
124 | * @ops: pointer to irq_domain methods |
125 | * @host_data: private data pointer for use by owner. Not touched by irq_domain | |
126 | * core code. | |
f8264e34 | 127 | * @flags: host per irq_domain flags |
1aa0dd94 GL |
128 | * |
129 | * Optional elements | |
130 | * @of_node: Pointer to device tree nodes associated with the irq_domain. Used | |
131 | * when decoding device tree interrupt specifiers. | |
132 | * @gc: Pointer to a list of generic chips. There is a helper function for | |
133 | * setting up one or more generic chips for interrupt controllers | |
134 | * drivers using the generic chip library which uses this pointer. | |
f8264e34 | 135 | * @parent: Pointer to parent irq_domain to support hierarchy irq_domains |
1aa0dd94 GL |
136 | * |
137 | * Revmap data, used internally by irq_domain | |
138 | * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that | |
139 | * support direct mapping | |
140 | * @revmap_size: Size of the linear map table @linear_revmap[] | |
141 | * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map | |
142 | * @linear_revmap: Linear table of hwirq->virq reverse mappings | |
08a543ad GL |
143 | */ |
144 | struct irq_domain { | |
7bb69bad | 145 | struct list_head link; |
0bb4afb4 | 146 | const char *name; |
a18dc81b | 147 | const struct irq_domain_ops *ops; |
7bb69bad | 148 | void *host_data; |
f8264e34 | 149 | unsigned int flags; |
7bb69bad | 150 | |
1aa0dd94 | 151 | /* Optional data */ |
f110711a | 152 | struct fwnode_handle *fwnode; |
ad3aedfb | 153 | enum irq_domain_bus_token bus_token; |
088f40b7 | 154 | struct irq_domain_chip_generic *gc; |
f8264e34 JL |
155 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
156 | struct irq_domain *parent; | |
157 | #endif | |
cef5075c | 158 | |
1aa0dd94 | 159 | /* reverse map data. The linear map gets appended to the irq_domain */ |
ddaf144c | 160 | irq_hw_number_t hwirq_max; |
1aa0dd94 GL |
161 | unsigned int revmap_direct_max_irq; |
162 | unsigned int revmap_size; | |
163 | struct radix_tree_root revmap_tree; | |
cef5075c | 164 | unsigned int linear_revmap[]; |
08a543ad GL |
165 | }; |
166 | ||
f8264e34 JL |
167 | /* Irq domain flags */ |
168 | enum { | |
169 | /* Irq domain is hierarchical */ | |
170 | IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), | |
171 | ||
36d72731 JL |
172 | /* Core calls alloc/free recursive through the domain hierarchy. */ |
173 | IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1), | |
174 | ||
f8264e34 JL |
175 | /* |
176 | * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved | |
177 | * for implementation specific purposes and ignored by the | |
178 | * core code. | |
179 | */ | |
180 | IRQ_DOMAIN_FLAG_NONCORE = (1 << 16), | |
181 | }; | |
182 | ||
10abc7df MZ |
183 | static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d) |
184 | { | |
f110711a | 185 | return to_of_node(d->fwnode); |
10abc7df MZ |
186 | } |
187 | ||
7bb69bad | 188 | #ifdef CONFIG_IRQ_DOMAIN |
b145dcc4 MZ |
189 | struct fwnode_handle *irq_domain_alloc_fwnode(void *data); |
190 | void irq_domain_free_fwnode(struct fwnode_handle *fwnode); | |
1bf4ddc4 | 191 | struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size, |
ddaf144c | 192 | irq_hw_number_t hwirq_max, int direct_max, |
fa40f377 GL |
193 | const struct irq_domain_ops *ops, |
194 | void *host_data); | |
781d0f46 MB |
195 | struct irq_domain *irq_domain_add_simple(struct device_node *of_node, |
196 | unsigned int size, | |
197 | unsigned int first_irq, | |
198 | const struct irq_domain_ops *ops, | |
199 | void *host_data); | |
a8db8cf0 | 200 | struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, |
1bc04f2c GL |
201 | unsigned int size, |
202 | unsigned int first_irq, | |
203 | irq_hw_number_t first_hwirq, | |
a18dc81b | 204 | const struct irq_domain_ops *ops, |
a8db8cf0 | 205 | void *host_data); |
130b8c6c MZ |
206 | extern struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode, |
207 | enum irq_domain_bus_token bus_token); | |
fa40f377 GL |
208 | extern void irq_set_default_host(struct irq_domain *host); |
209 | ||
1bf4ddc4 MZ |
210 | static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node) |
211 | { | |
212 | return node ? &node->fwnode : NULL; | |
213 | } | |
214 | ||
75aba7b0 SS |
215 | static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode) |
216 | { | |
217 | return fwnode && fwnode->type == FWNODE_IRQCHIP; | |
218 | } | |
219 | ||
130b8c6c MZ |
220 | static inline struct irq_domain *irq_find_matching_host(struct device_node *node, |
221 | enum irq_domain_bus_token bus_token) | |
222 | { | |
1bf4ddc4 | 223 | return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token); |
130b8c6c MZ |
224 | } |
225 | ||
ad3aedfb MZ |
226 | static inline struct irq_domain *irq_find_host(struct device_node *node) |
227 | { | |
228 | return irq_find_matching_host(node, DOMAIN_BUS_ANY); | |
229 | } | |
230 | ||
fa40f377 GL |
231 | /** |
232 | * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain. | |
233 | * @of_node: pointer to interrupt controller's device tree node. | |
234 | * @size: Number of interrupts in the domain. | |
235 | * @ops: map/unmap domain callbacks | |
236 | * @host_data: Controller private data pointer | |
237 | */ | |
238 | static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node, | |
a8db8cf0 | 239 | unsigned int size, |
a18dc81b | 240 | const struct irq_domain_ops *ops, |
fa40f377 GL |
241 | void *host_data) |
242 | { | |
1bf4ddc4 | 243 | return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data); |
fa40f377 GL |
244 | } |
245 | static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node, | |
6fa6c8e2 | 246 | unsigned int max_irq, |
a18dc81b | 247 | const struct irq_domain_ops *ops, |
fa40f377 GL |
248 | void *host_data) |
249 | { | |
1bf4ddc4 | 250 | return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data); |
fa40f377 | 251 | } |
1bc04f2c GL |
252 | static inline struct irq_domain *irq_domain_add_legacy_isa( |
253 | struct device_node *of_node, | |
a18dc81b | 254 | const struct irq_domain_ops *ops, |
1bc04f2c GL |
255 | void *host_data) |
256 | { | |
257 | return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, | |
258 | host_data); | |
259 | } | |
cef5075c GL |
260 | static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node, |
261 | const struct irq_domain_ops *ops, | |
262 | void *host_data) | |
263 | { | |
1bf4ddc4 MZ |
264 | return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data); |
265 | } | |
266 | ||
267 | static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode, | |
268 | unsigned int size, | |
269 | const struct irq_domain_ops *ops, | |
270 | void *host_data) | |
271 | { | |
272 | return __irq_domain_add(fwnode, size, size, 0, ops, host_data); | |
273 | } | |
274 | ||
275 | static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode, | |
276 | const struct irq_domain_ops *ops, | |
277 | void *host_data) | |
278 | { | |
279 | return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data); | |
cef5075c | 280 | } |
58ee99ad PM |
281 | |
282 | extern void irq_domain_remove(struct irq_domain *host); | |
283 | ||
ddaf144c GL |
284 | extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq, |
285 | irq_hw_number_t hwirq); | |
286 | extern void irq_domain_associate_many(struct irq_domain *domain, | |
287 | unsigned int irq_base, | |
288 | irq_hw_number_t hwirq_base, int count); | |
43a77591 JL |
289 | extern void irq_domain_disassociate(struct irq_domain *domain, |
290 | unsigned int irq); | |
98aa468e | 291 | |
cc79ca69 GL |
292 | extern unsigned int irq_create_mapping(struct irq_domain *host, |
293 | irq_hw_number_t hwirq); | |
c0131f09 | 294 | extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec); |
cc79ca69 | 295 | extern void irq_dispose_mapping(unsigned int virq); |
d3dcb436 GL |
296 | |
297 | /** | |
298 | * irq_linear_revmap() - Find a linux irq from a hw irq number. | |
299 | * @domain: domain owning this hardware interrupt | |
300 | * @hwirq: hardware irq number in that domain space | |
301 | * | |
302 | * This is a fast path alternative to irq_find_mapping() that can be | |
303 | * called directly by irq controller code to save a handful of | |
304 | * instructions. It is always safe to call, but won't find irqs mapped | |
305 | * using the radix tree. | |
306 | */ | |
307 | static inline unsigned int irq_linear_revmap(struct irq_domain *domain, | |
308 | irq_hw_number_t hwirq) | |
309 | { | |
310 | return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0; | |
311 | } | |
cc79ca69 GL |
312 | extern unsigned int irq_find_mapping(struct irq_domain *host, |
313 | irq_hw_number_t hwirq); | |
314 | extern unsigned int irq_create_direct_mapping(struct irq_domain *host); | |
98aa468e GL |
315 | extern int irq_create_strict_mappings(struct irq_domain *domain, |
316 | unsigned int irq_base, | |
317 | irq_hw_number_t hwirq_base, int count); | |
318 | ||
319 | static inline int irq_create_identity_mapping(struct irq_domain *host, | |
320 | irq_hw_number_t hwirq) | |
321 | { | |
322 | return irq_create_strict_mappings(host, hwirq, hwirq, 1); | |
323 | } | |
324 | ||
a18dc81b | 325 | extern const struct irq_domain_ops irq_domain_simple_ops; |
16b2e6e2 GL |
326 | |
327 | /* stock xlate functions */ | |
328 | int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr, | |
329 | const u32 *intspec, unsigned int intsize, | |
330 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
331 | int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr, | |
332 | const u32 *intspec, unsigned int intsize, | |
333 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
334 | int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr, | |
335 | const u32 *intspec, unsigned int intsize, | |
336 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
337 | ||
f8264e34 JL |
338 | /* V2 interfaces to support hierarchy IRQ domains. */ |
339 | extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, | |
340 | unsigned int virq); | |
5f22f5c6 SA |
341 | extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, |
342 | irq_hw_number_t hwirq, struct irq_chip *chip, | |
343 | void *chip_data, irq_flow_handler_t handler, | |
344 | void *handler_data, const char *handler_name); | |
f8264e34 | 345 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
2a5e9a07 | 346 | extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent, |
afb7da83 | 347 | unsigned int flags, unsigned int size, |
2a5e9a07 | 348 | struct fwnode_handle *fwnode, |
afb7da83 | 349 | const struct irq_domain_ops *ops, void *host_data); |
2a5e9a07 MZ |
350 | |
351 | static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent, | |
352 | unsigned int flags, | |
353 | unsigned int size, | |
354 | struct device_node *node, | |
355 | const struct irq_domain_ops *ops, | |
356 | void *host_data) | |
357 | { | |
358 | return irq_domain_create_hierarchy(parent, flags, size, | |
359 | of_node_to_fwnode(node), | |
360 | ops, host_data); | |
361 | } | |
362 | ||
f8264e34 JL |
363 | extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, |
364 | unsigned int nr_irqs, int node, void *arg, | |
365 | bool realloc); | |
366 | extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); | |
367 | extern void irq_domain_activate_irq(struct irq_data *irq_data); | |
368 | extern void irq_domain_deactivate_irq(struct irq_data *irq_data); | |
369 | ||
370 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, | |
371 | unsigned int nr_irqs, int node, void *arg) | |
372 | { | |
373 | return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false); | |
374 | } | |
375 | ||
c466595c MZ |
376 | extern int irq_domain_alloc_irqs_recursive(struct irq_domain *domain, |
377 | unsigned int irq_base, | |
378 | unsigned int nr_irqs, void *arg); | |
f8264e34 JL |
379 | extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, |
380 | unsigned int virq, | |
381 | irq_hw_number_t hwirq, | |
382 | struct irq_chip *chip, | |
383 | void *chip_data); | |
384 | extern void irq_domain_reset_irq_data(struct irq_data *irq_data); | |
385 | extern void irq_domain_free_irqs_common(struct irq_domain *domain, | |
386 | unsigned int virq, | |
387 | unsigned int nr_irqs); | |
388 | extern void irq_domain_free_irqs_top(struct irq_domain *domain, | |
389 | unsigned int virq, unsigned int nr_irqs); | |
390 | ||
36d72731 JL |
391 | extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain, |
392 | unsigned int irq_base, | |
393 | unsigned int nr_irqs, void *arg); | |
f8264e34 | 394 | |
36d72731 JL |
395 | extern void irq_domain_free_irqs_parent(struct irq_domain *domain, |
396 | unsigned int irq_base, | |
397 | unsigned int nr_irqs); | |
f8264e34 JL |
398 | |
399 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) | |
400 | { | |
401 | return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY; | |
402 | } | |
403 | #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */ | |
404 | static inline void irq_domain_activate_irq(struct irq_data *data) { } | |
405 | static inline void irq_domain_deactivate_irq(struct irq_data *data) { } | |
406 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, | |
407 | unsigned int nr_irqs, int node, void *arg) | |
408 | { | |
409 | return -1; | |
410 | } | |
411 | ||
412 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) | |
413 | { | |
414 | return false; | |
415 | } | |
416 | #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */ | |
417 | ||
d593f25f GL |
418 | #else /* CONFIG_IRQ_DOMAIN */ |
419 | static inline void irq_dispose_mapping(unsigned int virq) { } | |
f8264e34 JL |
420 | static inline void irq_domain_activate_irq(struct irq_data *data) { } |
421 | static inline void irq_domain_deactivate_irq(struct irq_data *data) { } | |
471036b2 SS |
422 | static inline struct irq_domain *irq_find_matching_fwnode( |
423 | struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token) | |
424 | { | |
425 | return NULL; | |
426 | } | |
d593f25f | 427 | #endif /* !CONFIG_IRQ_DOMAIN */ |
7e713301 | 428 | |
08a543ad | 429 | #endif /* _LINUX_IRQDOMAIN_H */ |