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