1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29#ifndef _LINUX_IRQDOMAIN_H
30#define _LINUX_IRQDOMAIN_H
31
32#include <linux/types.h>
33#include <linux/irqhandler.h>
34#include <linux/of.h>
35#include <linux/radix-tree.h>
36
37struct device_node;
38struct irq_domain;
39struct of_device_id;
40struct irq_chip;
41struct irq_data;
42struct cpumask;
43
44
45#define NUM_ISA_INTERRUPTS 16
46
47#define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
48
49
50
51
52
53
54
55
56
57
58
59struct irq_fwspec {
60 struct fwnode_handle *fwnode;
61 int param_count;
62 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
63};
64
65
66
67
68
69
70
71
72enum irq_domain_bus_token {
73 DOMAIN_BUS_ANY = 0,
74 DOMAIN_BUS_WIRED,
75 DOMAIN_BUS_PCI_MSI,
76 DOMAIN_BUS_PLATFORM_MSI,
77 DOMAIN_BUS_NEXUS,
78 DOMAIN_BUS_IPI,
79 DOMAIN_BUS_FSL_MC_MSI,
80};
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97struct irq_domain_ops {
98 int (*match)(struct irq_domain *d, struct device_node *node,
99 enum irq_domain_bus_token bus_token);
100 int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
101 enum irq_domain_bus_token bus_token);
102 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
103 void (*unmap)(struct irq_domain *d, unsigned int virq);
104 int (*xlate)(struct irq_domain *d, struct device_node *node,
105 const u32 *intspec, unsigned int intsize,
106 unsigned long *out_hwirq, unsigned int *out_type);
107
108#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
109
110 int (*alloc)(struct irq_domain *d, unsigned int virq,
111 unsigned int nr_irqs, void *arg);
112 void (*free)(struct irq_domain *d, unsigned int virq,
113 unsigned int nr_irqs);
114 void (*activate)(struct irq_domain *d, struct irq_data *irq_data);
115 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
116 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
117 unsigned long *out_hwirq, unsigned int *out_type);
118#endif
119};
120
121extern struct irq_domain_ops irq_generic_chip_ops;
122
123struct irq_domain_chip_generic;
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151struct irq_domain {
152 struct list_head link;
153 const char *name;
154 const struct irq_domain_ops *ops;
155 void *host_data;
156 unsigned int flags;
157 unsigned int mapcount;
158
159
160 struct fwnode_handle *fwnode;
161 enum irq_domain_bus_token bus_token;
162 struct irq_domain_chip_generic *gc;
163#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
164 struct irq_domain *parent;
165#endif
166#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
167 struct dentry *debugfs_file;
168#endif
169
170
171 irq_hw_number_t hwirq_max;
172 unsigned int revmap_direct_max_irq;
173 unsigned int revmap_size;
174 struct radix_tree_root revmap_tree;
175 unsigned int linear_revmap[];
176};
177
178
179enum {
180
181 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
182
183
184 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6),
185
186
187 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
188
189
190 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
191
192
193 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
194
195
196 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
197
198
199
200
201
202
203 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
204};
205
206static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
207{
208 return to_of_node(d->fwnode);
209}
210
211#ifdef CONFIG_IRQ_DOMAIN
212struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
213 const char *name, void *data);
214
215enum {
216 IRQCHIP_FWNODE_REAL,
217 IRQCHIP_FWNODE_NAMED,
218 IRQCHIP_FWNODE_NAMED_ID,
219};
220
221static inline
222struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
223{
224 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
225}
226
227static inline
228struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
229{
230 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
231 NULL);
232}
233
234static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
235{
236 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
237}
238
239void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
240struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
241 irq_hw_number_t hwirq_max, int direct_max,
242 const struct irq_domain_ops *ops,
243 void *host_data);
244struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
245 unsigned int size,
246 unsigned int first_irq,
247 const struct irq_domain_ops *ops,
248 void *host_data);
249struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
250 unsigned int size,
251 unsigned int first_irq,
252 irq_hw_number_t first_hwirq,
253 const struct irq_domain_ops *ops,
254 void *host_data);
255extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
256 enum irq_domain_bus_token bus_token);
257extern bool irq_domain_check_msi_remap(void);
258extern void irq_set_default_host(struct irq_domain *host);
259extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
260 irq_hw_number_t hwirq, int node,
261 const struct cpumask *affinity);
262
263static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
264{
265 return node ? &node->fwnode : NULL;
266}
267
268static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
269{
270 return fwnode && fwnode->type == FWNODE_IRQCHIP;
271}
272
273extern void irq_domain_update_bus_token(struct irq_domain *domain,
274 enum irq_domain_bus_token bus_token);
275
276static inline
277struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
278 enum irq_domain_bus_token bus_token)
279{
280 struct irq_fwspec fwspec = {
281 .fwnode = fwnode,
282 };
283
284 return irq_find_matching_fwspec(&fwspec, bus_token);
285}
286
287static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
288 enum irq_domain_bus_token bus_token)
289{
290 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
291}
292
293static inline struct irq_domain *irq_find_host(struct device_node *node)
294{
295 return irq_find_matching_host(node, DOMAIN_BUS_ANY);
296}
297
298
299
300
301
302
303
304
305static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
306 unsigned int size,
307 const struct irq_domain_ops *ops,
308 void *host_data)
309{
310 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
311}
312static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
313 unsigned int max_irq,
314 const struct irq_domain_ops *ops,
315 void *host_data)
316{
317 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
318}
319static inline struct irq_domain *irq_domain_add_legacy_isa(
320 struct device_node *of_node,
321 const struct irq_domain_ops *ops,
322 void *host_data)
323{
324 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
325 host_data);
326}
327static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
328 const struct irq_domain_ops *ops,
329 void *host_data)
330{
331 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
332}
333
334static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
335 unsigned int size,
336 const struct irq_domain_ops *ops,
337 void *host_data)
338{
339 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
340}
341
342static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
343 const struct irq_domain_ops *ops,
344 void *host_data)
345{
346 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
347}
348
349extern void irq_domain_remove(struct irq_domain *host);
350
351extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
352 irq_hw_number_t hwirq);
353extern void irq_domain_associate_many(struct irq_domain *domain,
354 unsigned int irq_base,
355 irq_hw_number_t hwirq_base, int count);
356extern void irq_domain_disassociate(struct irq_domain *domain,
357 unsigned int irq);
358
359extern unsigned int irq_create_mapping(struct irq_domain *host,
360 irq_hw_number_t hwirq);
361extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
362extern void irq_dispose_mapping(unsigned int virq);
363
364
365
366
367
368
369
370
371
372
373
374static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
375 irq_hw_number_t hwirq)
376{
377 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
378}
379extern unsigned int irq_find_mapping(struct irq_domain *host,
380 irq_hw_number_t hwirq);
381extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
382extern int irq_create_strict_mappings(struct irq_domain *domain,
383 unsigned int irq_base,
384 irq_hw_number_t hwirq_base, int count);
385
386static inline int irq_create_identity_mapping(struct irq_domain *host,
387 irq_hw_number_t hwirq)
388{
389 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
390}
391
392extern const struct irq_domain_ops irq_domain_simple_ops;
393
394
395int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
396 const u32 *intspec, unsigned int intsize,
397 irq_hw_number_t *out_hwirq, unsigned int *out_type);
398int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
399 const u32 *intspec, unsigned int intsize,
400 irq_hw_number_t *out_hwirq, unsigned int *out_type);
401int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
402 const u32 *intspec, unsigned int intsize,
403 irq_hw_number_t *out_hwirq, unsigned int *out_type);
404
405
406int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
407int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
408
409
410extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
411 unsigned int virq);
412extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
413 irq_hw_number_t hwirq, struct irq_chip *chip,
414 void *chip_data, irq_flow_handler_t handler,
415 void *handler_data, const char *handler_name);
416#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
417extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
418 unsigned int flags, unsigned int size,
419 struct fwnode_handle *fwnode,
420 const struct irq_domain_ops *ops, void *host_data);
421
422static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
423 unsigned int flags,
424 unsigned int size,
425 struct device_node *node,
426 const struct irq_domain_ops *ops,
427 void *host_data)
428{
429 return irq_domain_create_hierarchy(parent, flags, size,
430 of_node_to_fwnode(node),
431 ops, host_data);
432}
433
434extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
435 unsigned int nr_irqs, int node, void *arg,
436 bool realloc, const struct cpumask *affinity);
437extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
438extern void irq_domain_activate_irq(struct irq_data *irq_data);
439extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
440
441static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
442 unsigned int nr_irqs, int node, void *arg)
443{
444 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
445 NULL);
446}
447
448extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
449 unsigned int irq_base,
450 unsigned int nr_irqs, void *arg);
451extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
452 unsigned int virq,
453 irq_hw_number_t hwirq,
454 struct irq_chip *chip,
455 void *chip_data);
456extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
457extern void irq_domain_free_irqs_common(struct irq_domain *domain,
458 unsigned int virq,
459 unsigned int nr_irqs);
460extern void irq_domain_free_irqs_top(struct irq_domain *domain,
461 unsigned int virq, unsigned int nr_irqs);
462
463extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
464 unsigned int irq_base,
465 unsigned int nr_irqs, void *arg);
466
467extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
468 unsigned int irq_base,
469 unsigned int nr_irqs);
470
471static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
472{
473 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
474}
475
476static inline bool irq_domain_is_ipi(struct irq_domain *domain)
477{
478 return domain->flags &
479 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
480}
481
482static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
483{
484 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
485}
486
487static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
488{
489 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
490}
491
492static inline bool irq_domain_is_msi(struct irq_domain *domain)
493{
494 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
495}
496
497static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
498{
499 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
500}
501
502extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
503
504#else
505static inline void irq_domain_activate_irq(struct irq_data *data) { }
506static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
507static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
508 unsigned int nr_irqs, int node, void *arg)
509{
510 return -1;
511}
512
513static inline void irq_domain_free_irqs(unsigned int virq,
514 unsigned int nr_irqs) { }
515
516static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
517{
518 return false;
519}
520
521static inline bool irq_domain_is_ipi(struct irq_domain *domain)
522{
523 return false;
524}
525
526static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
527{
528 return false;
529}
530
531static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
532{
533 return false;
534}
535
536static inline bool irq_domain_is_msi(struct irq_domain *domain)
537{
538 return false;
539}
540
541static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
542{
543 return false;
544}
545
546static inline bool
547irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
548{
549 return false;
550}
551#endif
552
553#else
554static inline void irq_dispose_mapping(unsigned int virq) { }
555static inline void irq_domain_activate_irq(struct irq_data *data) { }
556static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
557static inline struct irq_domain *irq_find_matching_fwnode(
558 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
559{
560 return NULL;
561}
562static inline bool irq_domain_check_msi_remap(void)
563{
564 return false;
565}
566#endif
567
568#endif
569