blob: 744ac0ec98eb2c9e094f8ebdcfd71aebcdd32026 [file] [log] [blame]
Grant Likely08a543a2011-07-26 03:19:06 -06001/*
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 *
Grant Likely7bb69ba2012-02-14 14:06:48 -070012 * 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.
Grant Likelycc79ca62012-02-16 01:37:49 -070019 *
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.
Grant Likely08a543a2011-07-26 03:19:06 -060030 */
Grant Likely7bb69ba2012-02-14 14:06:48 -070031
Grant Likely08a543a2011-07-26 03:19:06 -060032#ifndef _LINUX_IRQDOMAIN_H
33#define _LINUX_IRQDOMAIN_H
34
Grant Likely7bb69ba2012-02-14 14:06:48 -070035#include <linux/types.h>
Jiang Liu1b537702014-11-09 23:10:24 +080036#include <linux/irqhandler.h>
Grant Likely7bb69ba2012-02-14 14:06:48 -070037#include <linux/radix-tree.h>
Grant Likely08a543a2011-07-26 03:19:06 -060038
Grant Likely08a543a2011-07-26 03:19:06 -060039struct device_node;
40struct irq_domain;
Grant Likely7bb69ba2012-02-14 14:06:48 -070041struct of_device_id;
Jiang Liuf8264e32014-11-06 22:20:14 +080042struct irq_chip;
43struct irq_data;
Grant Likely7bb69ba2012-02-14 14:06:48 -070044
Grant Likely1bc04f22012-02-14 14:06:55 -070045/* Number of irqs reserved for a legacy isa controller */
46#define NUM_ISA_INTERRUPTS 16
47
Grant Likely08a543a2011-07-26 03:19:06 -060048/**
49 * struct irq_domain_ops - Methods for irq_domain objects
Grant Likely7bb69ba2012-02-14 14:06:48 -070050 * @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
Grant Likely7bb69ba2012-02-14 14:06:48 -070055 * @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().
Grant Likely08a543a2011-07-26 03:19:06 -060062 */
63struct irq_domain_ops {
Grant Likely7bb69ba2012-02-14 14:06:48 -070064 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);
Grant Likely7bb69ba2012-02-14 14:06:48 -070067 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);
Jiang Liuf8264e32014-11-06 22:20:14 +080070
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
Grant Likely08a543a2011-07-26 03:19:06 -060080};
81
Thomas Gleixner088f40b2013-05-06 14:30:27 +000082extern struct irq_domain_ops irq_generic_chip_ops;
83
84struct irq_domain_chip_generic;
85
Grant Likely08a543a2011-07-26 03:19:06 -060086/**
87 * struct irq_domain - Hardware interrupt number translation object
Grant Likely7bb69ba2012-02-14 14:06:48 -070088 * @link: Element in global irq_domain list.
Grant Likely1aa0dd92013-06-08 12:03:59 +010089 * @name: Name of interrupt domain
Grant Likely7bb69ba2012-02-14 14:06:48 -070090 * @ops: pointer to irq_domain methods
91 * @host_data: private data pointer for use by owner. Not touched by irq_domain
92 * core code.
Jiang Liuf8264e32014-11-06 22:20:14 +080093 * @flags: host per irq_domain flags
Grant Likely1aa0dd92013-06-08 12:03:59 +010094 *
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.
Jiang Liuf8264e32014-11-06 22:20:14 +0800101 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
Grant Likely1aa0dd92013-06-08 12:03:59 +0100102 *
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
Grant Likely08a543a2011-07-26 03:19:06 -0600109 */
110struct irq_domain {
Grant Likely7bb69ba2012-02-14 14:06:48 -0700111 struct list_head link;
Grant Likely0bb4afb2013-06-06 14:23:30 +0100112 const char *name;
Grant Likelya18dc812012-01-26 12:12:14 -0700113 const struct irq_domain_ops *ops;
Grant Likely7bb69ba2012-02-14 14:06:48 -0700114 void *host_data;
Jiang Liuf8264e32014-11-06 22:20:14 +0800115 unsigned int flags;
Grant Likely7bb69ba2012-02-14 14:06:48 -0700116
Grant Likely1aa0dd92013-06-08 12:03:59 +0100117 /* Optional data */
Grant Likely08a543a2011-07-26 03:19:06 -0600118 struct device_node *of_node;
Thomas Gleixner088f40b2013-05-06 14:30:27 +0000119 struct irq_domain_chip_generic *gc;
Jiang Liuf8264e32014-11-06 22:20:14 +0800120#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
121 struct irq_domain *parent;
122#endif
Grant Likelycef50752012-07-11 17:24:31 +0100123
Grant Likely1aa0dd92013-06-08 12:03:59 +0100124 /* reverse map data. The linear map gets appended to the irq_domain */
Grant Likelyddaf1442013-06-10 01:06:02 +0100125 irq_hw_number_t hwirq_max;
Grant Likely1aa0dd92013-06-08 12:03:59 +0100126 unsigned int revmap_direct_max_irq;
127 unsigned int revmap_size;
128 struct radix_tree_root revmap_tree;
Grant Likelycef50752012-07-11 17:24:31 +0100129 unsigned int linear_revmap[];
Grant Likely08a543a2011-07-26 03:19:06 -0600130};
131
Jiang Liuf8264e32014-11-06 22:20:14 +0800132/* Irq domain flags */
133enum {
134 /* Irq domain is hierarchical */
135 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
136
Jiang Liu36d72732014-11-15 22:24:01 +0800137 /* Core calls alloc/free recursive through the domain hierarchy. */
138 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1),
139
Jiang Liuf8264e32014-11-06 22:20:14 +0800140 /*
141 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
142 * for implementation specific purposes and ignored by the
143 * core code.
144 */
145 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
146};
147
Grant Likely7bb69ba2012-02-14 14:06:48 -0700148#ifdef CONFIG_IRQ_DOMAIN
Grant Likelyddaf1442013-06-10 01:06:02 +0100149struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
150 irq_hw_number_t hwirq_max, int direct_max,
Grant Likelyfa40f372013-06-08 12:57:40 +0100151 const struct irq_domain_ops *ops,
152 void *host_data);
Mark Brown781d0f42012-07-05 12:19:19 +0100153struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
154 unsigned int size,
155 unsigned int first_irq,
156 const struct irq_domain_ops *ops,
157 void *host_data);
Grant Likelya8db8cf2012-02-14 14:06:54 -0700158struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
Grant Likely1bc04f22012-02-14 14:06:55 -0700159 unsigned int size,
160 unsigned int first_irq,
161 irq_hw_number_t first_hwirq,
Grant Likelya18dc812012-01-26 12:12:14 -0700162 const struct irq_domain_ops *ops,
Grant Likelya8db8cf2012-02-14 14:06:54 -0700163 void *host_data);
Grant Likelycc79ca62012-02-16 01:37:49 -0700164extern struct irq_domain *irq_find_host(struct device_node *node);
165extern void irq_set_default_host(struct irq_domain *host);
Grant Likelycc79ca62012-02-16 01:37:49 -0700166
Grant Likelyfa40f372013-06-08 12:57:40 +0100167/**
168 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
169 * @of_node: pointer to interrupt controller's device tree node.
170 * @size: Number of interrupts in the domain.
171 * @ops: map/unmap domain callbacks
172 * @host_data: Controller private data pointer
173 */
174static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
175 unsigned int size,
176 const struct irq_domain_ops *ops,
177 void *host_data)
178{
Grant Likelyddaf1442013-06-10 01:06:02 +0100179 return __irq_domain_add(of_node, size, size, 0, ops, host_data);
Grant Likelyfa40f372013-06-08 12:57:40 +0100180}
181static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
182 unsigned int max_irq,
183 const struct irq_domain_ops *ops,
184 void *host_data)
185{
Grant Likelyddaf1442013-06-10 01:06:02 +0100186 return __irq_domain_add(of_node, 0, max_irq, max_irq, ops, host_data);
Grant Likelyfa40f372013-06-08 12:57:40 +0100187}
Grant Likely1bc04f22012-02-14 14:06:55 -0700188static inline struct irq_domain *irq_domain_add_legacy_isa(
189 struct device_node *of_node,
Grant Likelya18dc812012-01-26 12:12:14 -0700190 const struct irq_domain_ops *ops,
Grant Likely1bc04f22012-02-14 14:06:55 -0700191 void *host_data)
192{
193 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
194 host_data);
195}
Grant Likelycef50752012-07-11 17:24:31 +0100196static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
197 const struct irq_domain_ops *ops,
198 void *host_data)
199{
Grant Likelyddaf1442013-06-10 01:06:02 +0100200 return __irq_domain_add(of_node, 0, ~0, 0, ops, host_data);
Grant Likelycef50752012-07-11 17:24:31 +0100201}
Paul Mundt58ee99a2012-05-19 15:11:41 +0900202
203extern void irq_domain_remove(struct irq_domain *host);
204
Grant Likelyddaf1442013-06-10 01:06:02 +0100205extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
206 irq_hw_number_t hwirq);
207extern void irq_domain_associate_many(struct irq_domain *domain,
208 unsigned int irq_base,
209 irq_hw_number_t hwirq_base, int count);
Jiang Liu43a77592014-06-09 16:20:05 +0800210extern void irq_domain_disassociate(struct irq_domain *domain,
211 unsigned int irq);
Grant Likely98aa4682012-06-17 16:17:04 -0600212
Grant Likelycc79ca62012-02-16 01:37:49 -0700213extern unsigned int irq_create_mapping(struct irq_domain *host,
214 irq_hw_number_t hwirq);
215extern void irq_dispose_mapping(unsigned int virq);
Grant Likelyd3dcb432013-06-10 12:19:17 +0100216
217/**
218 * irq_linear_revmap() - Find a linux irq from a hw irq number.
219 * @domain: domain owning this hardware interrupt
220 * @hwirq: hardware irq number in that domain space
221 *
222 * This is a fast path alternative to irq_find_mapping() that can be
223 * called directly by irq controller code to save a handful of
224 * instructions. It is always safe to call, but won't find irqs mapped
225 * using the radix tree.
226 */
227static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
228 irq_hw_number_t hwirq)
229{
230 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
231}
Grant Likelycc79ca62012-02-16 01:37:49 -0700232extern unsigned int irq_find_mapping(struct irq_domain *host,
233 irq_hw_number_t hwirq);
234extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
Grant Likely98aa4682012-06-17 16:17:04 -0600235extern int irq_create_strict_mappings(struct irq_domain *domain,
236 unsigned int irq_base,
237 irq_hw_number_t hwirq_base, int count);
238
239static inline int irq_create_identity_mapping(struct irq_domain *host,
240 irq_hw_number_t hwirq)
241{
242 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
243}
244
Grant Likelya18dc812012-01-26 12:12:14 -0700245extern const struct irq_domain_ops irq_domain_simple_ops;
Grant Likely16b2e6e2012-01-26 11:26:52 -0700246
247/* stock xlate functions */
248int irq_domain_xlate_onecell(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);
251int irq_domain_xlate_twocell(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);
254int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
255 const u32 *intspec, unsigned int intsize,
256 irq_hw_number_t *out_hwirq, unsigned int *out_type);
257
Jiang Liuf8264e32014-11-06 22:20:14 +0800258/* V2 interfaces to support hierarchy IRQ domains. */
259extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
260 unsigned int virq);
Stefan Agner5f22f5c2015-05-16 11:44:13 +0200261extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
262 irq_hw_number_t hwirq, struct irq_chip *chip,
263 void *chip_data, irq_flow_handler_t handler,
264 void *handler_data, const char *handler_name);
Jiang Liuf8264e32014-11-06 22:20:14 +0800265#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
Jiang Liuafb7da82014-11-15 22:24:02 +0800266extern struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
267 unsigned int flags, unsigned int size,
268 struct device_node *node,
269 const struct irq_domain_ops *ops, void *host_data);
Jiang Liuf8264e32014-11-06 22:20:14 +0800270extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
271 unsigned int nr_irqs, int node, void *arg,
272 bool realloc);
273extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
274extern void irq_domain_activate_irq(struct irq_data *irq_data);
275extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
276
277static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
278 unsigned int nr_irqs, int node, void *arg)
279{
280 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false);
281}
282
283extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
284 unsigned int virq,
285 irq_hw_number_t hwirq,
286 struct irq_chip *chip,
287 void *chip_data);
288extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
289extern void irq_domain_free_irqs_common(struct irq_domain *domain,
290 unsigned int virq,
291 unsigned int nr_irqs);
292extern void irq_domain_free_irqs_top(struct irq_domain *domain,
293 unsigned int virq, unsigned int nr_irqs);
294
Jiang Liu36d72732014-11-15 22:24:01 +0800295extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
296 unsigned int irq_base,
297 unsigned int nr_irqs, void *arg);
Jiang Liuf8264e32014-11-06 22:20:14 +0800298
Jiang Liu36d72732014-11-15 22:24:01 +0800299extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
300 unsigned int irq_base,
301 unsigned int nr_irqs);
Jiang Liuf8264e32014-11-06 22:20:14 +0800302
303static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
304{
305 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
306}
307#else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
308static inline void irq_domain_activate_irq(struct irq_data *data) { }
309static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
310static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
311 unsigned int nr_irqs, int node, void *arg)
312{
313 return -1;
314}
315
316static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
317{
318 return false;
319}
320#endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
321
Grant Likelyd593f252012-02-24 08:24:17 -0700322#else /* CONFIG_IRQ_DOMAIN */
323static inline void irq_dispose_mapping(unsigned int virq) { }
Jiang Liuf8264e32014-11-06 22:20:14 +0800324static inline void irq_domain_activate_irq(struct irq_data *data) { }
325static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
Grant Likelyd593f252012-02-24 08:24:17 -0700326#endif /* !CONFIG_IRQ_DOMAIN */
Grant Likely7e713302011-07-26 03:19:06 -0600327
Grant Likely08a543a2011-07-26 03:19:06 -0600328#endif /* _LINUX_IRQDOMAIN_H */