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