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