aboutsummaryrefslogtreecommitdiffstats
path: root/include/linux/irqdomain.h
diff options
context:
space:
mode:
Diffstat (limited to 'include/linux/irqdomain.h')
-rw-r--r--include/linux/irqdomain.h187
1 files changed, 133 insertions, 54 deletions
diff --git a/include/linux/irqdomain.h b/include/linux/irqdomain.h
index bd4272b61a14..c65740d76e66 100644
--- a/include/linux/irqdomain.h
+++ b/include/linux/irqdomain.h
@@ -9,99 +9,178 @@
9 * representation into a hardware irq number that can be mapped back to a 9 * representation into a hardware irq number that can be mapped back to a
10 * Linux irq number without any extra platform support code. 10 * Linux irq number without any extra platform support code.
11 * 11 *
12 * irq_domain is expected to be embedded in an interrupt controller's private 12 * Interrupt controller "domain" data structure. This could be defined as a
13 * data structure. 13 * irq domain controller. That is, it handles the mapping between hardware
14 * and virtual interrupt numbers for a given interrupt domain. The domain
15 * structure is generally created by the PIC code for a given PIC instance
16 * (though a domain can cover more than one PIC if they have a flat number
17 * model). It's the domain callbacks that are responsible for setting the
18 * irq_chip on a given irq_desc after it's been mapped.
19 *
20 * The host code and data structures are agnostic to whether or not
21 * we use an open firmware device-tree. We do have references to struct
22 * device_node in two places: in irq_find_host() to find the host matching
23 * a given interrupt controller node, and of course as an argument to its
24 * counterpart domain->ops->match() callback. However, those are treated as
25 * generic pointers by the core and the fact that it's actually a device-node
26 * pointer is purely a convention between callers and implementation. This
27 * code could thus be used on other architectures by replacing those two
28 * by some sort of arch-specific void * "token" used to identify interrupt
29 * controllers.
14 */ 30 */
31
15#ifndef _LINUX_IRQDOMAIN_H 32#ifndef _LINUX_IRQDOMAIN_H
16#define _LINUX_IRQDOMAIN_H 33#define _LINUX_IRQDOMAIN_H
17 34
18#include <linux/irq.h> 35#include <linux/types.h>
19#include <linux/mod_devicetable.h> 36#include <linux/radix-tree.h>
20 37
21#ifdef CONFIG_IRQ_DOMAIN
22struct device_node; 38struct device_node;
23struct irq_domain; 39struct irq_domain;
40struct of_device_id;
41
42/* Number of irqs reserved for a legacy isa controller */
43#define NUM_ISA_INTERRUPTS 16
24 44
25/** 45/**
26 * struct irq_domain_ops - Methods for irq_domain objects 46 * struct irq_domain_ops - Methods for irq_domain objects
27 * @to_irq: (optional) given a local hardware irq number, return the linux 47 * @match: Match an interrupt controller device node to a host, returns
28 * irq number. If to_irq is not implemented, then the irq_domain 48 * 1 on a match
29 * will use this translation: irq = (domain->irq_base + hwirq) 49 * @map: Create or update a mapping between a virtual irq number and a hw
30 * @dt_translate: Given a device tree node and interrupt specifier, decode 50 * irq number. This is called only once for a given mapping.
31 * the hardware irq number and linux irq type value. 51 * @unmap: Dispose of such a mapping
52 * @xlate: Given a device tree node and interrupt specifier, decode
53 * the hardware irq number and linux irq type value.
54 *
55 * Functions below are provided by the driver and called whenever a new mapping
56 * is created or an old mapping is disposed. The driver can then proceed to
57 * whatever internal data structures management is required. It also needs
58 * to setup the irq_desc when returning from map().
32 */ 59 */
33struct irq_domain_ops { 60struct irq_domain_ops {
34 unsigned int (*to_irq)(struct irq_domain *d, unsigned long hwirq); 61 int (*match)(struct irq_domain *d, struct device_node *node);
35 62 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
36#ifdef CONFIG_OF 63 void (*unmap)(struct irq_domain *d, unsigned int virq);
37 int (*dt_translate)(struct irq_domain *d, struct device_node *node, 64 int (*xlate)(struct irq_domain *d, struct device_node *node,
38 const u32 *intspec, unsigned int intsize, 65 const u32 *intspec, unsigned int intsize,
39 unsigned long *out_hwirq, unsigned int *out_type); 66 unsigned long *out_hwirq, unsigned int *out_type);
40#endif /* CONFIG_OF */
41}; 67};
42 68
43/** 69/**
44 * struct irq_domain - Hardware interrupt number translation object 70 * struct irq_domain - Hardware interrupt number translation object
45 * @list: Element in global irq_domain list. 71 * @link: Element in global irq_domain list.
72 * @revmap_type: Method used for reverse mapping hwirq numbers to linux irq. This
73 * will be one of the IRQ_DOMAIN_MAP_* values.
74 * @revmap_data: Revmap method specific data.
75 * @ops: pointer to irq_domain methods
76 * @host_data: private data pointer for use by owner. Not touched by irq_domain
77 * core code.
46 * @irq_base: Start of irq_desc range assigned to the irq_domain. The creator 78 * @irq_base: Start of irq_desc range assigned to the irq_domain. The creator
47 * of the irq_domain is responsible for allocating the array of 79 * of the irq_domain is responsible for allocating the array of
48 * irq_desc structures. 80 * irq_desc structures.
49 * @nr_irq: Number of irqs managed by the irq domain 81 * @nr_irq: Number of irqs managed by the irq domain
50 * @hwirq_base: Starting number for hwirqs managed by the irq domain 82 * @hwirq_base: Starting number for hwirqs managed by the irq domain
51 * @ops: pointer to irq_domain methods
52 * @priv: private data pointer for use by owner. Not touched by irq_domain
53 * core code.
54 * @of_node: (optional) Pointer to device tree nodes associated with the 83 * @of_node: (optional) Pointer to device tree nodes associated with the
55 * irq_domain. Used when decoding device tree interrupt specifiers. 84 * irq_domain. Used when decoding device tree interrupt specifiers.
56 */ 85 */
57struct irq_domain { 86struct irq_domain {
58 struct list_head list; 87 struct list_head link;
59 unsigned int irq_base; 88
60 unsigned int nr_irq; 89 /* type of reverse mapping_technique */
61 unsigned int hwirq_base; 90 unsigned int revmap_type;
91 union {
92 struct {
93 unsigned int size;
94 unsigned int first_irq;
95 irq_hw_number_t first_hwirq;
96 } legacy;
97 struct {
98 unsigned int size;
99 unsigned int *revmap;
100 } linear;
101 struct {
102 unsigned int max_irq;
103 } nomap;
104 struct radix_tree_root tree;
105 } revmap_data;
62 const struct irq_domain_ops *ops; 106 const struct irq_domain_ops *ops;
63 void *priv; 107 void *host_data;
108 irq_hw_number_t inval_irq;
109
110 /* Optional device node pointer */
64 struct device_node *of_node; 111 struct device_node *of_node;
65}; 112};
66 113
67/** 114#ifdef CONFIG_IRQ_DOMAIN
68 * irq_domain_to_irq() - Translate from a hardware irq to a linux irq number 115struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
69 * 116 unsigned int size,
70 * Returns the linux irq number associated with a hardware irq. By default, 117 unsigned int first_irq,
71 * the mapping is irq == domain->irq_base + hwirq, but this mapping can 118 irq_hw_number_t first_hwirq,
72 * be overridden if the irq_domain implements a .to_irq() hook. 119 const struct irq_domain_ops *ops,
73 */ 120 void *host_data);
74static inline unsigned int irq_domain_to_irq(struct irq_domain *d, 121struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
75 unsigned long hwirq) 122 unsigned int size,
123 const struct irq_domain_ops *ops,
124 void *host_data);
125struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
126 unsigned int max_irq,
127 const struct irq_domain_ops *ops,
128 void *host_data);
129struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
130 const struct irq_domain_ops *ops,
131 void *host_data);
132
133extern struct irq_domain *irq_find_host(struct device_node *node);
134extern void irq_set_default_host(struct irq_domain *host);
135
136static inline struct irq_domain *irq_domain_add_legacy_isa(
137 struct device_node *of_node,
138 const struct irq_domain_ops *ops,
139 void *host_data)
76{ 140{
77 if (d->ops->to_irq) 141 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
78 return d->ops->to_irq(d, hwirq); 142 host_data);
79 if (WARN_ON(hwirq < d->hwirq_base))
80 return 0;
81 return d->irq_base + hwirq - d->hwirq_base;
82} 143}
144extern struct irq_domain *irq_find_host(struct device_node *node);
145extern void irq_set_default_host(struct irq_domain *host);
83 146
84#define irq_domain_for_each_hwirq(d, hw) \
85 for (hw = d->hwirq_base; hw < d->hwirq_base + d->nr_irq; hw++)
86 147
87#define irq_domain_for_each_irq(d, hw, irq) \ 148extern unsigned int irq_create_mapping(struct irq_domain *host,
88 for (hw = d->hwirq_base, irq = irq_domain_to_irq(d, hw); \ 149 irq_hw_number_t hwirq);
89 hw < d->hwirq_base + d->nr_irq; \ 150extern void irq_dispose_mapping(unsigned int virq);
90 hw++, irq = irq_domain_to_irq(d, hw)) 151extern unsigned int irq_find_mapping(struct irq_domain *host,
152 irq_hw_number_t hwirq);
153extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
154extern void irq_radix_revmap_insert(struct irq_domain *host, unsigned int virq,
155 irq_hw_number_t hwirq);
156extern unsigned int irq_radix_revmap_lookup(struct irq_domain *host,
157 irq_hw_number_t hwirq);
158extern unsigned int irq_linear_revmap(struct irq_domain *host,
159 irq_hw_number_t hwirq);
91 160
92extern void irq_domain_add(struct irq_domain *domain); 161extern const struct irq_domain_ops irq_domain_simple_ops;
93extern void irq_domain_del(struct irq_domain *domain);
94 162
95extern struct irq_domain_ops irq_domain_simple_ops; 163/* stock xlate functions */
96#endif /* CONFIG_IRQ_DOMAIN */ 164int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
165 const u32 *intspec, unsigned int intsize,
166 irq_hw_number_t *out_hwirq, unsigned int *out_type);
167int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
168 const u32 *intspec, unsigned int intsize,
169 irq_hw_number_t *out_hwirq, unsigned int *out_type);
170int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
171 const u32 *intspec, unsigned int intsize,
172 irq_hw_number_t *out_hwirq, unsigned int *out_type);
97 173
98#if defined(CONFIG_IRQ_DOMAIN) && defined(CONFIG_OF_IRQ) 174#if defined(CONFIG_OF_IRQ)
99extern void irq_domain_add_simple(struct device_node *controller, int irq_base);
100extern void irq_domain_generate_simple(const struct of_device_id *match, 175extern void irq_domain_generate_simple(const struct of_device_id *match,
101 u64 phys_base, unsigned int irq_start); 176 u64 phys_base, unsigned int irq_start);
102#else /* CONFIG_IRQ_DOMAIN && CONFIG_OF_IRQ */ 177#else /* CONFIG_OF_IRQ */
103static inline void irq_domain_generate_simple(const struct of_device_id *match, 178static inline void irq_domain_generate_simple(const struct of_device_id *match,
104 u64 phys_base, unsigned int irq_start) { } 179 u64 phys_base, unsigned int irq_start) { }
105#endif /* CONFIG_IRQ_DOMAIN && CONFIG_OF_IRQ */ 180#endif /* !CONFIG_OF_IRQ */
181
182#else /* CONFIG_IRQ_DOMAIN */
183static inline void irq_dispose_mapping(unsigned int virq) { }
184#endif /* !CONFIG_IRQ_DOMAIN */
106 185
107#endif /* _LINUX_IRQDOMAIN_H */ 186#endif /* _LINUX_IRQDOMAIN_H */
generated by cgit v1.2.2 (git 2.25.0) at 2024-12-21 22:17:53 -0500