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