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