irqdomain: Let irq_find_host default to DOMAIN_BUS_WIRED
[muen/linux.git] / include / linux / irqdomain.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3  * irq_domain - IRQ translation domains
4  *
5  * Translation infrastructure between hw and linux irq numbers.  This is
6  * helpful for interrupt controllers to implement mapping between hardware
7  * irq numbers and the Linux irq number space.
8  *
9  * irq_domains also have hooks for translating device tree or other
10  * firmware interrupt representations into a hardware irq number that
11  * can be mapped back to a Linux irq number without any extra platform
12  * support code.
13  *
14  * Interrupt controller "domain" data structure. This could be defined as a
15  * irq domain controller. That is, it handles the mapping between hardware
16  * and virtual interrupt numbers for a given interrupt domain. The domain
17  * structure is generally created by the PIC code for a given PIC instance
18  * (though a domain can cover more than one PIC if they have a flat number
19  * model). It's the domain callbacks that are responsible for setting the
20  * irq_chip on a given irq_desc after it's been mapped.
21  *
22  * The host code and data structures use a fwnode_handle pointer to
23  * identify the domain. In some cases, and in order to preserve source
24  * code compatibility, this fwnode pointer is "upgraded" to a DT
25  * device_node. For those firmware infrastructures that do not provide
26  * a unique identifier for an interrupt controller, the irq_domain
27  * code offers a fwnode allocator.
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
39 struct device_node;
40 struct irq_domain;
41 struct of_device_id;
42 struct irq_chip;
43 struct irq_data;
44 struct cpumask;
45 struct seq_file;
46
47 /* Number of irqs reserved for a legacy isa controller */
48 #define NUM_ISA_INTERRUPTS      16
49
50 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
51
52 /**
53  * struct irq_fwspec - generic IRQ specifier structure
54  *
55  * @fwnode:             Pointer to a firmware-specific descriptor
56  * @param_count:        Number of device-specific parameters
57  * @param:              Device-specific parameters
58  *
59  * This structure, directly modeled after of_phandle_args, is used to
60  * pass a device-specific description of an interrupt.
61  */
62 struct irq_fwspec {
63         struct fwnode_handle *fwnode;
64         int param_count;
65         u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
66 };
67
68 /*
69  * Should several domains have the same device node, but serve
70  * different purposes (for example one domain is for PCI/MSI, and the
71  * other for wired IRQs), they can be distinguished using a
72  * bus-specific token. Most domains are expected to only carry
73  * DOMAIN_BUS_ANY.
74  */
75 enum irq_domain_bus_token {
76         DOMAIN_BUS_ANY          = 0,
77         DOMAIN_BUS_WIRED,
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 };
84
85 /**
86  * struct irq_domain_ops - Methods for irq_domain objects
87  * @match: Match an interrupt controller device node to a host, returns
88  *         1 on a match
89  * @map: Create or update a mapping between a virtual irq number and a hw
90  *       irq number. This is called only once for a given mapping.
91  * @unmap: Dispose of such a mapping
92  * @xlate: Given a device tree node and interrupt specifier, decode
93  *         the hardware irq number and linux irq type value.
94  *
95  * Functions below are provided by the driver and called whenever a new mapping
96  * is created or an old mapping is disposed. The driver can then proceed to
97  * whatever internal data structures management is required. It also needs
98  * to setup the irq_desc when returning from map().
99  */
100 struct irq_domain_ops {
101         int (*match)(struct irq_domain *d, struct device_node *node,
102                      enum irq_domain_bus_token bus_token);
103         int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
104                       enum irq_domain_bus_token bus_token);
105         int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
106         void (*unmap)(struct irq_domain *d, unsigned int virq);
107         int (*xlate)(struct irq_domain *d, struct device_node *node,
108                      const u32 *intspec, unsigned int intsize,
109                      unsigned long *out_hwirq, unsigned int *out_type);
110 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
111         /* extended V2 interfaces to support hierarchy irq_domains */
112         int (*alloc)(struct irq_domain *d, unsigned int virq,
113                      unsigned int nr_irqs, void *arg);
114         void (*free)(struct irq_domain *d, unsigned int virq,
115                      unsigned int nr_irqs);
116         int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool reserve);
117         void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
118         int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
119                          unsigned long *out_hwirq, unsigned int *out_type);
120 #endif
121 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
122         void (*debug_show)(struct seq_file *m, struct irq_domain *d,
123                            struct irq_data *irqd, int ind);
124 #endif
125 };
126
127 extern struct irq_domain_ops irq_generic_chip_ops;
128
129 struct irq_domain_chip_generic;
130
131 /**
132  * struct irq_domain - Hardware interrupt number translation object
133  * @link: Element in global irq_domain list.
134  * @name: Name of interrupt domain
135  * @ops: pointer to irq_domain methods
136  * @host_data: private data pointer for use by owner.  Not touched by irq_domain
137  *             core code.
138  * @flags: host per irq_domain flags
139  * @mapcount: The number of mapped interrupts
140  *
141  * Optional elements
142  * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
143  *          to swap it for the of_node via the irq_domain_get_of_node accessor
144  * @gc: Pointer to a list of generic chips. There is a helper function for
145  *      setting up one or more generic chips for interrupt controllers
146  *      drivers using the generic chip library which uses this pointer.
147  * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
148  * @debugfs_file: dentry for the domain debugfs file
149  *
150  * Revmap data, used internally by irq_domain
151  * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
152  *                         support direct mapping
153  * @revmap_size: Size of the linear map table @linear_revmap[]
154  * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
155  * @linear_revmap: Linear table of hwirq->virq reverse mappings
156  */
157 struct irq_domain {
158         struct list_head link;
159         const char *name;
160         const struct irq_domain_ops *ops;
161         void *host_data;
162         unsigned int flags;
163         unsigned int mapcount;
164
165         /* Optional data */
166         struct fwnode_handle *fwnode;
167         enum irq_domain_bus_token bus_token;
168         struct irq_domain_chip_generic *gc;
169 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
170         struct irq_domain *parent;
171 #endif
172 #ifdef CONFIG_GENERIC_IRQ_DEBUGFS
173         struct dentry           *debugfs_file;
174 #endif
175
176         /* reverse map data. The linear map gets appended to the irq_domain */
177         irq_hw_number_t hwirq_max;
178         unsigned int revmap_direct_max_irq;
179         unsigned int revmap_size;
180         struct radix_tree_root revmap_tree;
181         struct mutex revmap_tree_mutex;
182         unsigned int linear_revmap[];
183 };
184
185 /* Irq domain flags */
186 enum {
187         /* Irq domain is hierarchical */
188         IRQ_DOMAIN_FLAG_HIERARCHY       = (1 << 0),
189
190         /* Irq domain name was allocated in __irq_domain_add() */
191         IRQ_DOMAIN_NAME_ALLOCATED       = (1 << 6),
192
193         /* Irq domain is an IPI domain with virq per cpu */
194         IRQ_DOMAIN_FLAG_IPI_PER_CPU     = (1 << 2),
195
196         /* Irq domain is an IPI domain with single virq */
197         IRQ_DOMAIN_FLAG_IPI_SINGLE      = (1 << 3),
198
199         /* Irq domain implements MSIs */
200         IRQ_DOMAIN_FLAG_MSI             = (1 << 4),
201
202         /* Irq domain implements MSI remapping */
203         IRQ_DOMAIN_FLAG_MSI_REMAP       = (1 << 5),
204
205         /*
206          * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
207          * for implementation specific purposes and ignored by the
208          * core code.
209          */
210         IRQ_DOMAIN_FLAG_NONCORE         = (1 << 16),
211 };
212
213 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
214 {
215         return to_of_node(d->fwnode);
216 }
217
218 #ifdef CONFIG_IRQ_DOMAIN
219 struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
220                                                 const char *name, void *data);
221
222 enum {
223         IRQCHIP_FWNODE_REAL,
224         IRQCHIP_FWNODE_NAMED,
225         IRQCHIP_FWNODE_NAMED_ID,
226 };
227
228 static inline
229 struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
230 {
231         return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
232 }
233
234 static inline
235 struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
236 {
237         return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
238                                          NULL);
239 }
240
241 static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
242 {
243         return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
244 }
245
246 void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
247 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
248                                     irq_hw_number_t hwirq_max, int direct_max,
249                                     const struct irq_domain_ops *ops,
250                                     void *host_data);
251 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
252                                          unsigned int size,
253                                          unsigned int first_irq,
254                                          const struct irq_domain_ops *ops,
255                                          void *host_data);
256 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
257                                          unsigned int size,
258                                          unsigned int first_irq,
259                                          irq_hw_number_t first_hwirq,
260                                          const struct irq_domain_ops *ops,
261                                          void *host_data);
262 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
263                                                    enum irq_domain_bus_token bus_token);
264 extern bool irq_domain_check_msi_remap(void);
265 extern void irq_set_default_host(struct irq_domain *host);
266 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
267                                   irq_hw_number_t hwirq, int node,
268                                   const struct cpumask *affinity);
269
270 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
271 {
272         return node ? &node->fwnode : NULL;
273 }
274
275 extern const struct fwnode_operations irqchip_fwnode_ops;
276
277 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
278 {
279         return fwnode && fwnode->ops == &irqchip_fwnode_ops;
280 }
281
282 extern void irq_domain_update_bus_token(struct irq_domain *domain,
283                                         enum irq_domain_bus_token bus_token);
284
285 static inline
286 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
287                                             enum irq_domain_bus_token bus_token)
288 {
289         struct irq_fwspec fwspec = {
290                 .fwnode = fwnode,
291         };
292
293         return irq_find_matching_fwspec(&fwspec, bus_token);
294 }
295
296 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
297                                                         enum irq_domain_bus_token bus_token)
298 {
299         return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
300 }
301
302 static inline struct irq_domain *irq_find_host(struct device_node *node)
303 {
304         struct irq_domain *d;
305
306         d = irq_find_matching_host(node, DOMAIN_BUS_WIRED);
307         if (!d)
308                 d = irq_find_matching_host(node, DOMAIN_BUS_ANY);
309
310         return d;
311 }
312
313 /**
314  * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
315  * @of_node: pointer to interrupt controller's device tree node.
316  * @size: Number of interrupts in the domain.
317  * @ops: map/unmap domain callbacks
318  * @host_data: Controller private data pointer
319  */
320 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
321                                          unsigned int size,
322                                          const struct irq_domain_ops *ops,
323                                          void *host_data)
324 {
325         return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
326 }
327 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
328                                          unsigned int max_irq,
329                                          const struct irq_domain_ops *ops,
330                                          void *host_data)
331 {
332         return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
333 }
334 static inline struct irq_domain *irq_domain_add_legacy_isa(
335                                 struct device_node *of_node,
336                                 const struct irq_domain_ops *ops,
337                                 void *host_data)
338 {
339         return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
340                                      host_data);
341 }
342 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
343                                          const struct irq_domain_ops *ops,
344                                          void *host_data)
345 {
346         return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
347 }
348
349 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
350                                          unsigned int size,
351                                          const struct irq_domain_ops *ops,
352                                          void *host_data)
353 {
354         return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
355 }
356
357 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
358                                          const struct irq_domain_ops *ops,
359                                          void *host_data)
360 {
361         return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
362 }
363
364 extern void irq_domain_remove(struct irq_domain *host);
365
366 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
367                                         irq_hw_number_t hwirq);
368 extern void irq_domain_associate_many(struct irq_domain *domain,
369                                       unsigned int irq_base,
370                                       irq_hw_number_t hwirq_base, int count);
371 extern void irq_domain_disassociate(struct irq_domain *domain,
372                                     unsigned int irq);
373
374 extern unsigned int irq_create_mapping(struct irq_domain *host,
375                                        irq_hw_number_t hwirq);
376 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
377 extern void irq_dispose_mapping(unsigned int virq);
378
379 /**
380  * irq_linear_revmap() - Find a linux irq from a hw irq number.
381  * @domain: domain owning this hardware interrupt
382  * @hwirq: hardware irq number in that domain space
383  *
384  * This is a fast path alternative to irq_find_mapping() that can be
385  * called directly by irq controller code to save a handful of
386  * instructions. It is always safe to call, but won't find irqs mapped
387  * using the radix tree.
388  */
389 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
390                                              irq_hw_number_t hwirq)
391 {
392         return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
393 }
394 extern unsigned int irq_find_mapping(struct irq_domain *host,
395                                      irq_hw_number_t hwirq);
396 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
397 extern int irq_create_strict_mappings(struct irq_domain *domain,
398                                       unsigned int irq_base,
399                                       irq_hw_number_t hwirq_base, int count);
400
401 static inline int irq_create_identity_mapping(struct irq_domain *host,
402                                               irq_hw_number_t hwirq)
403 {
404         return irq_create_strict_mappings(host, hwirq, hwirq, 1);
405 }
406
407 extern const struct irq_domain_ops irq_domain_simple_ops;
408
409 /* stock xlate functions */
410 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
411                         const u32 *intspec, unsigned int intsize,
412                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
413 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
414                         const u32 *intspec, unsigned int intsize,
415                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
416 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
417                         const u32 *intspec, unsigned int intsize,
418                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
419
420 /* IPI functions */
421 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
422 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
423
424 /* V2 interfaces to support hierarchy IRQ domains. */
425 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
426                                                 unsigned int virq);
427 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
428                                 irq_hw_number_t hwirq, struct irq_chip *chip,
429                                 void *chip_data, irq_flow_handler_t handler,
430                                 void *handler_data, const char *handler_name);
431 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
432 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
433                         unsigned int flags, unsigned int size,
434                         struct fwnode_handle *fwnode,
435                         const struct irq_domain_ops *ops, void *host_data);
436
437 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
438                                             unsigned int flags,
439                                             unsigned int size,
440                                             struct device_node *node,
441                                             const struct irq_domain_ops *ops,
442                                             void *host_data)
443 {
444         return irq_domain_create_hierarchy(parent, flags, size,
445                                            of_node_to_fwnode(node),
446                                            ops, host_data);
447 }
448
449 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
450                                    unsigned int nr_irqs, int node, void *arg,
451                                    bool realloc, const struct cpumask *affinity);
452 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
453 extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
454 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
455
456 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
457                         unsigned int nr_irqs, int node, void *arg)
458 {
459         return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
460                                        NULL);
461 }
462
463 extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
464                                            unsigned int irq_base,
465                                            unsigned int nr_irqs, void *arg);
466 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
467                                          unsigned int virq,
468                                          irq_hw_number_t hwirq,
469                                          struct irq_chip *chip,
470                                          void *chip_data);
471 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
472 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
473                                         unsigned int virq,
474                                         unsigned int nr_irqs);
475 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
476                                      unsigned int virq, unsigned int nr_irqs);
477
478 extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
479 extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
480
481 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
482                                         unsigned int irq_base,
483                                         unsigned int nr_irqs, void *arg);
484
485 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
486                                         unsigned int irq_base,
487                                         unsigned int nr_irqs);
488
489 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
490 {
491         return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
492 }
493
494 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
495 {
496         return domain->flags &
497                 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
498 }
499
500 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
501 {
502         return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
503 }
504
505 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
506 {
507         return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
508 }
509
510 static inline bool irq_domain_is_msi(struct irq_domain *domain)
511 {
512         return domain->flags & IRQ_DOMAIN_FLAG_MSI;
513 }
514
515 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
516 {
517         return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
518 }
519
520 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
521
522 #else   /* CONFIG_IRQ_DOMAIN_HIERARCHY */
523 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
524                         unsigned int nr_irqs, int node, void *arg)
525 {
526         return -1;
527 }
528
529 static inline void irq_domain_free_irqs(unsigned int virq,
530                                         unsigned int nr_irqs) { }
531
532 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
533 {
534         return false;
535 }
536
537 static inline bool irq_domain_is_ipi(struct irq_domain *domain)
538 {
539         return false;
540 }
541
542 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
543 {
544         return false;
545 }
546
547 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
548 {
549         return false;
550 }
551
552 static inline bool irq_domain_is_msi(struct irq_domain *domain)
553 {
554         return false;
555 }
556
557 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
558 {
559         return false;
560 }
561
562 static inline bool
563 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
564 {
565         return false;
566 }
567 #endif  /* CONFIG_IRQ_DOMAIN_HIERARCHY */
568
569 #else /* CONFIG_IRQ_DOMAIN */
570 static inline void irq_dispose_mapping(unsigned int virq) { }
571 static inline struct irq_domain *irq_find_matching_fwnode(
572         struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
573 {
574         return NULL;
575 }
576 static inline bool irq_domain_check_msi_remap(void)
577 {
578         return false;
579 }
580 #endif /* !CONFIG_IRQ_DOMAIN */
581
582 #endif /* _LINUX_IRQDOMAIN_H */