Commit | Line | Data |
---|---|---|
08a543ad GL |
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 a hook for translating device tree interrupt | |
9 | * representation into a hardware irq number that can be mapped back to a | |
10 | * Linux irq number without any extra platform support code. | |
11 | * | |
7bb69bad GL |
12 | * Interrupt controller "domain" data structure. This could be defined as a |
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. | |
cc79ca69 GL |
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. | |
08a543ad | 30 | */ |
7bb69bad | 31 | |
08a543ad GL |
32 | #ifndef _LINUX_IRQDOMAIN_H |
33 | #define _LINUX_IRQDOMAIN_H | |
34 | ||
7bb69bad | 35 | #include <linux/types.h> |
1b537708 | 36 | #include <linux/irqhandler.h> |
7bb69bad | 37 | #include <linux/radix-tree.h> |
08a543ad | 38 | |
08a543ad GL |
39 | struct device_node; |
40 | struct irq_domain; | |
7bb69bad | 41 | struct of_device_id; |
f8264e34 JL |
42 | struct irq_chip; |
43 | struct irq_data; | |
7bb69bad | 44 | |
1bc04f2c GL |
45 | /* Number of irqs reserved for a legacy isa controller */ |
46 | #define NUM_ISA_INTERRUPTS 16 | |
47 | ||
08a543ad GL |
48 | /** |
49 | * struct irq_domain_ops - Methods for irq_domain objects | |
7bb69bad GL |
50 | * @match: Match an interrupt controller device node to a host, returns |
51 | * 1 on a match | |
52 | * @map: Create or update a mapping between a virtual irq number and a hw | |
53 | * irq number. This is called only once for a given mapping. | |
54 | * @unmap: Dispose of such a mapping | |
7bb69bad GL |
55 | * @xlate: Given a device tree node and interrupt specifier, decode |
56 | * the hardware irq number and linux irq type value. | |
57 | * | |
58 | * Functions below are provided by the driver and called whenever a new mapping | |
59 | * is created or an old mapping is disposed. The driver can then proceed to | |
60 | * whatever internal data structures management is required. It also needs | |
61 | * to setup the irq_desc when returning from map(). | |
08a543ad GL |
62 | */ |
63 | struct irq_domain_ops { | |
7bb69bad GL |
64 | int (*match)(struct irq_domain *d, struct device_node *node); |
65 | int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw); | |
66 | void (*unmap)(struct irq_domain *d, unsigned int virq); | |
7bb69bad GL |
67 | int (*xlate)(struct irq_domain *d, struct device_node *node, |
68 | const u32 *intspec, unsigned int intsize, | |
69 | unsigned long *out_hwirq, unsigned int *out_type); | |
f8264e34 JL |
70 | |
71 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY | |
72 | /* extended V2 interfaces to support hierarchy irq_domains */ | |
73 | int (*alloc)(struct irq_domain *d, unsigned int virq, | |
74 | unsigned int nr_irqs, void *arg); | |
75 | void (*free)(struct irq_domain *d, unsigned int virq, | |
76 | unsigned int nr_irqs); | |
77 | void (*activate)(struct irq_domain *d, struct irq_data *irq_data); | |
78 | void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data); | |
79 | #endif | |
08a543ad GL |
80 | }; |
81 | ||
088f40b7 TG |
82 | extern struct irq_domain_ops irq_generic_chip_ops; |
83 | ||
84 | struct irq_domain_chip_generic; | |
85 | ||
08a543ad GL |
86 | /** |
87 | * struct irq_domain - Hardware interrupt number translation object | |
7bb69bad | 88 | * @link: Element in global irq_domain list. |
1aa0dd94 | 89 | * @name: Name of interrupt domain |
7bb69bad GL |
90 | * @ops: pointer to irq_domain methods |
91 | * @host_data: private data pointer for use by owner. Not touched by irq_domain | |
92 | * core code. | |
f8264e34 | 93 | * @flags: host per irq_domain flags |
1aa0dd94 GL |
94 | * |
95 | * Optional elements | |
96 | * @of_node: Pointer to device tree nodes associated with the irq_domain. Used | |
97 | * when decoding device tree interrupt specifiers. | |
98 | * @gc: Pointer to a list of generic chips. There is a helper function for | |
99 | * setting up one or more generic chips for interrupt controllers | |
100 | * drivers using the generic chip library which uses this pointer. | |
f8264e34 | 101 | * @parent: Pointer to parent irq_domain to support hierarchy irq_domains |
1aa0dd94 GL |
102 | * |
103 | * Revmap data, used internally by irq_domain | |
104 | * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that | |
105 | * support direct mapping | |
106 | * @revmap_size: Size of the linear map table @linear_revmap[] | |
107 | * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map | |
108 | * @linear_revmap: Linear table of hwirq->virq reverse mappings | |
08a543ad GL |
109 | */ |
110 | struct irq_domain { | |
7bb69bad | 111 | struct list_head link; |
0bb4afb4 | 112 | const char *name; |
a18dc81b | 113 | const struct irq_domain_ops *ops; |
7bb69bad | 114 | void *host_data; |
f8264e34 | 115 | unsigned int flags; |
7bb69bad | 116 | |
1aa0dd94 | 117 | /* Optional data */ |
08a543ad | 118 | struct device_node *of_node; |
088f40b7 | 119 | struct irq_domain_chip_generic *gc; |
f8264e34 JL |
120 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY |
121 | struct irq_domain *parent; | |
122 | #endif | |
cef5075c | 123 | |
1aa0dd94 | 124 | /* reverse map data. The linear map gets appended to the irq_domain */ |
ddaf144c | 125 | irq_hw_number_t hwirq_max; |
1aa0dd94 GL |
126 | unsigned int revmap_direct_max_irq; |
127 | unsigned int revmap_size; | |
128 | struct radix_tree_root revmap_tree; | |
cef5075c | 129 | unsigned int linear_revmap[]; |
08a543ad GL |
130 | }; |
131 | ||
f8264e34 JL |
132 | /* Irq domain flags */ |
133 | enum { | |
134 | /* Irq domain is hierarchical */ | |
135 | IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), | |
136 | ||
137 | /* | |
138 | * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved | |
139 | * for implementation specific purposes and ignored by the | |
140 | * core code. | |
141 | */ | |
142 | IRQ_DOMAIN_FLAG_NONCORE = (1 << 16), | |
143 | }; | |
144 | ||
7bb69bad | 145 | #ifdef CONFIG_IRQ_DOMAIN |
ddaf144c GL |
146 | struct irq_domain *__irq_domain_add(struct device_node *of_node, int size, |
147 | irq_hw_number_t hwirq_max, int direct_max, | |
fa40f377 GL |
148 | const struct irq_domain_ops *ops, |
149 | void *host_data); | |
781d0f46 MB |
150 | struct irq_domain *irq_domain_add_simple(struct device_node *of_node, |
151 | unsigned int size, | |
152 | unsigned int first_irq, | |
153 | const struct irq_domain_ops *ops, | |
154 | void *host_data); | |
a8db8cf0 | 155 | struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, |
1bc04f2c GL |
156 | unsigned int size, |
157 | unsigned int first_irq, | |
158 | irq_hw_number_t first_hwirq, | |
a18dc81b | 159 | const struct irq_domain_ops *ops, |
a8db8cf0 | 160 | void *host_data); |
fa40f377 GL |
161 | extern struct irq_domain *irq_find_host(struct device_node *node); |
162 | extern void irq_set_default_host(struct irq_domain *host); | |
163 | ||
164 | /** | |
165 | * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain. | |
166 | * @of_node: pointer to interrupt controller's device tree node. | |
167 | * @size: Number of interrupts in the domain. | |
168 | * @ops: map/unmap domain callbacks | |
169 | * @host_data: Controller private data pointer | |
170 | */ | |
171 | static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node, | |
a8db8cf0 | 172 | unsigned int size, |
a18dc81b | 173 | const struct irq_domain_ops *ops, |
fa40f377 GL |
174 | void *host_data) |
175 | { | |
ddaf144c | 176 | return __irq_domain_add(of_node, size, size, 0, ops, host_data); |
fa40f377 GL |
177 | } |
178 | static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node, | |
6fa6c8e2 | 179 | unsigned int max_irq, |
a18dc81b | 180 | const struct irq_domain_ops *ops, |
fa40f377 GL |
181 | void *host_data) |
182 | { | |
ddaf144c | 183 | return __irq_domain_add(of_node, 0, max_irq, max_irq, ops, host_data); |
fa40f377 | 184 | } |
1bc04f2c GL |
185 | static inline struct irq_domain *irq_domain_add_legacy_isa( |
186 | struct device_node *of_node, | |
a18dc81b | 187 | const struct irq_domain_ops *ops, |
1bc04f2c GL |
188 | void *host_data) |
189 | { | |
190 | return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, | |
191 | host_data); | |
192 | } | |
cef5075c GL |
193 | static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node, |
194 | const struct irq_domain_ops *ops, | |
195 | void *host_data) | |
196 | { | |
ddaf144c | 197 | return __irq_domain_add(of_node, 0, ~0, 0, ops, host_data); |
cef5075c | 198 | } |
58ee99ad PM |
199 | |
200 | extern void irq_domain_remove(struct irq_domain *host); | |
201 | ||
ddaf144c GL |
202 | extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq, |
203 | irq_hw_number_t hwirq); | |
204 | extern void irq_domain_associate_many(struct irq_domain *domain, | |
205 | unsigned int irq_base, | |
206 | irq_hw_number_t hwirq_base, int count); | |
43a77591 JL |
207 | extern void irq_domain_disassociate(struct irq_domain *domain, |
208 | unsigned int irq); | |
98aa468e | 209 | |
cc79ca69 GL |
210 | extern unsigned int irq_create_mapping(struct irq_domain *host, |
211 | irq_hw_number_t hwirq); | |
212 | extern void irq_dispose_mapping(unsigned int virq); | |
d3dcb436 GL |
213 | |
214 | /** | |
215 | * irq_linear_revmap() - Find a linux irq from a hw irq number. | |
216 | * @domain: domain owning this hardware interrupt | |
217 | * @hwirq: hardware irq number in that domain space | |
218 | * | |
219 | * This is a fast path alternative to irq_find_mapping() that can be | |
220 | * called directly by irq controller code to save a handful of | |
221 | * instructions. It is always safe to call, but won't find irqs mapped | |
222 | * using the radix tree. | |
223 | */ | |
224 | static inline unsigned int irq_linear_revmap(struct irq_domain *domain, | |
225 | irq_hw_number_t hwirq) | |
226 | { | |
227 | return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0; | |
228 | } | |
cc79ca69 GL |
229 | extern unsigned int irq_find_mapping(struct irq_domain *host, |
230 | irq_hw_number_t hwirq); | |
231 | extern unsigned int irq_create_direct_mapping(struct irq_domain *host); | |
98aa468e GL |
232 | extern int irq_create_strict_mappings(struct irq_domain *domain, |
233 | unsigned int irq_base, | |
234 | irq_hw_number_t hwirq_base, int count); | |
235 | ||
236 | static inline int irq_create_identity_mapping(struct irq_domain *host, | |
237 | irq_hw_number_t hwirq) | |
238 | { | |
239 | return irq_create_strict_mappings(host, hwirq, hwirq, 1); | |
240 | } | |
241 | ||
a18dc81b | 242 | extern const struct irq_domain_ops irq_domain_simple_ops; |
16b2e6e2 GL |
243 | |
244 | /* stock xlate functions */ | |
245 | int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr, | |
246 | const u32 *intspec, unsigned int intsize, | |
247 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
248 | int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr, | |
249 | const u32 *intspec, unsigned int intsize, | |
250 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
251 | int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr, | |
252 | const u32 *intspec, unsigned int intsize, | |
253 | irq_hw_number_t *out_hwirq, unsigned int *out_type); | |
254 | ||
f8264e34 JL |
255 | /* V2 interfaces to support hierarchy IRQ domains. */ |
256 | extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, | |
257 | unsigned int virq); | |
258 | #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY | |
259 | extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, | |
260 | unsigned int nr_irqs, int node, void *arg, | |
261 | bool realloc); | |
262 | extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); | |
263 | extern void irq_domain_activate_irq(struct irq_data *irq_data); | |
264 | extern void irq_domain_deactivate_irq(struct irq_data *irq_data); | |
265 | ||
266 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, | |
267 | unsigned int nr_irqs, int node, void *arg) | |
268 | { | |
269 | return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false); | |
270 | } | |
271 | ||
272 | extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, | |
273 | unsigned int virq, | |
274 | irq_hw_number_t hwirq, | |
275 | struct irq_chip *chip, | |
276 | void *chip_data); | |
1b537708 JL |
277 | extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, |
278 | irq_hw_number_t hwirq, struct irq_chip *chip, | |
279 | void *chip_data, irq_flow_handler_t handler, | |
280 | void *handler_data, const char *handler_name); | |
f8264e34 JL |
281 | extern void irq_domain_reset_irq_data(struct irq_data *irq_data); |
282 | extern void irq_domain_free_irqs_common(struct irq_domain *domain, | |
283 | unsigned int virq, | |
284 | unsigned int nr_irqs); | |
285 | extern void irq_domain_free_irqs_top(struct irq_domain *domain, | |
286 | unsigned int virq, unsigned int nr_irqs); | |
287 | ||
288 | static inline int irq_domain_alloc_irqs_parent(struct irq_domain *domain, | |
289 | unsigned int irq_base, | |
290 | unsigned int nr_irqs, void *arg) | |
291 | { | |
292 | if (domain->parent && domain->parent->ops->alloc) | |
293 | return domain->parent->ops->alloc(domain->parent, irq_base, | |
294 | nr_irqs, arg); | |
295 | return -ENOSYS; | |
296 | } | |
297 | ||
298 | static inline void irq_domain_free_irqs_parent(struct irq_domain *domain, | |
299 | unsigned int irq_base, unsigned int nr_irqs) | |
300 | { | |
301 | if (domain->parent && domain->parent->ops->free) | |
302 | domain->parent->ops->free(domain->parent, irq_base, nr_irqs); | |
303 | } | |
304 | ||
305 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) | |
306 | { | |
307 | return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY; | |
308 | } | |
309 | #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */ | |
310 | static inline void irq_domain_activate_irq(struct irq_data *data) { } | |
311 | static inline void irq_domain_deactivate_irq(struct irq_data *data) { } | |
312 | static inline int irq_domain_alloc_irqs(struct irq_domain *domain, | |
313 | unsigned int nr_irqs, int node, void *arg) | |
314 | { | |
315 | return -1; | |
316 | } | |
317 | ||
318 | static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) | |
319 | { | |
320 | return false; | |
321 | } | |
322 | #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */ | |
323 | ||
d593f25f GL |
324 | #else /* CONFIG_IRQ_DOMAIN */ |
325 | static inline void irq_dispose_mapping(unsigned int virq) { } | |
f8264e34 JL |
326 | static inline void irq_domain_activate_irq(struct irq_data *data) { } |
327 | static inline void irq_domain_deactivate_irq(struct irq_data *data) { } | |
d593f25f | 328 | #endif /* !CONFIG_IRQ_DOMAIN */ |
7e713301 | 329 | |
08a543ad | 330 | #endif /* _LINUX_IRQDOMAIN_H */ |