blob: b0f9d16e48f65db730c22fdc677811bc76990405 [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>
36#include <linux/radix-tree.h>
Grant Likely08a543a2011-07-26 03:19:06 -060037
Grant Likely08a543a2011-07-26 03:19:06 -060038struct device_node;
39struct irq_domain;
Grant Likely7bb69ba2012-02-14 14:06:48 -070040struct of_device_id;
41
Grant Likely1bc04f22012-02-14 14:06:55 -070042/* Number of irqs reserved for a legacy isa controller */
43#define NUM_ISA_INTERRUPTS 16
44
Grant Likely08a543a2011-07-26 03:19:06 -060045/**
46 * struct irq_domain_ops - Methods for irq_domain objects
Grant Likely7bb69ba2012-02-14 14:06:48 -070047 * @match: Match an interrupt controller device node to a host, returns
48 * 1 on a match
49 * @map: Create or update a mapping between a virtual irq number and a hw
50 * irq number. This is called only once for a given mapping.
51 * @unmap: Dispose of such a mapping
Grant Likely7bb69ba2012-02-14 14:06:48 -070052 * @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().
Grant Likely08a543a2011-07-26 03:19:06 -060059 */
60struct irq_domain_ops {
Grant Likely7bb69ba2012-02-14 14:06:48 -070061 int (*match)(struct irq_domain *d, struct device_node *node);
62 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
63 void (*unmap)(struct irq_domain *d, unsigned int virq);
Grant Likely7bb69ba2012-02-14 14:06:48 -070064 int (*xlate)(struct irq_domain *d, struct device_node *node,
65 const u32 *intspec, unsigned int intsize,
66 unsigned long *out_hwirq, unsigned int *out_type);
Grant Likely08a543a2011-07-26 03:19:06 -060067};
68
Thomas Gleixner088f40b2013-05-06 14:30:27 +000069extern struct irq_domain_ops irq_generic_chip_ops;
70
71struct irq_domain_chip_generic;
72
Grant Likely08a543a2011-07-26 03:19:06 -060073/**
74 * struct irq_domain - Hardware interrupt number translation object
Grant Likely7bb69ba2012-02-14 14:06:48 -070075 * @link: Element in global irq_domain list.
Grant Likely1aa0dd92013-06-08 12:03:59 +010076 * @name: Name of interrupt domain
Grant Likely7bb69ba2012-02-14 14:06:48 -070077 * @ops: pointer to irq_domain methods
78 * @host_data: private data pointer for use by owner. Not touched by irq_domain
79 * core code.
Grant Likely1aa0dd92013-06-08 12:03:59 +010080 *
81 * Optional elements
82 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
83 * when decoding device tree interrupt specifiers.
84 * @gc: Pointer to a list of generic chips. There is a helper function for
85 * setting up one or more generic chips for interrupt controllers
86 * drivers using the generic chip library which uses this pointer.
87 *
88 * Revmap data, used internally by irq_domain
89 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
90 * support direct mapping
91 * @revmap_size: Size of the linear map table @linear_revmap[]
92 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
93 * @linear_revmap: Linear table of hwirq->virq reverse mappings
Grant Likely08a543a2011-07-26 03:19:06 -060094 */
95struct irq_domain {
Grant Likely7bb69ba2012-02-14 14:06:48 -070096 struct list_head link;
Grant Likely0bb4afb2013-06-06 14:23:30 +010097 const char *name;
Grant Likelya18dc812012-01-26 12:12:14 -070098 const struct irq_domain_ops *ops;
Grant Likely7bb69ba2012-02-14 14:06:48 -070099 void *host_data;
Grant Likely7bb69ba2012-02-14 14:06:48 -0700100
Grant Likely1aa0dd92013-06-08 12:03:59 +0100101 /* Optional data */
Grant Likely08a543a2011-07-26 03:19:06 -0600102 struct device_node *of_node;
Thomas Gleixner088f40b2013-05-06 14:30:27 +0000103 struct irq_domain_chip_generic *gc;
Grant Likelycef50752012-07-11 17:24:31 +0100104
Grant Likely1aa0dd92013-06-08 12:03:59 +0100105 /* reverse map data. The linear map gets appended to the irq_domain */
Grant Likelyddaf1442013-06-10 01:06:02 +0100106 irq_hw_number_t hwirq_max;
Grant Likely1aa0dd92013-06-08 12:03:59 +0100107 unsigned int revmap_direct_max_irq;
108 unsigned int revmap_size;
109 struct radix_tree_root revmap_tree;
Grant Likelycef50752012-07-11 17:24:31 +0100110 unsigned int linear_revmap[];
Grant Likely08a543a2011-07-26 03:19:06 -0600111};
112
Grant Likely7bb69ba2012-02-14 14:06:48 -0700113#ifdef CONFIG_IRQ_DOMAIN
Grant Likelyddaf1442013-06-10 01:06:02 +0100114struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
115 irq_hw_number_t hwirq_max, int direct_max,
Grant Likelyfa40f372013-06-08 12:57:40 +0100116 const struct irq_domain_ops *ops,
117 void *host_data);
Mark Brown781d0f42012-07-05 12:19:19 +0100118struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
119 unsigned int size,
120 unsigned int first_irq,
121 const struct irq_domain_ops *ops,
122 void *host_data);
Grant Likelya8db8cf2012-02-14 14:06:54 -0700123struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
Grant Likely1bc04f22012-02-14 14:06:55 -0700124 unsigned int size,
125 unsigned int first_irq,
126 irq_hw_number_t first_hwirq,
Grant Likelya18dc812012-01-26 12:12:14 -0700127 const struct irq_domain_ops *ops,
Grant Likelya8db8cf2012-02-14 14:06:54 -0700128 void *host_data);
Grant Likelycc79ca62012-02-16 01:37:49 -0700129extern struct irq_domain *irq_find_host(struct device_node *node);
130extern void irq_set_default_host(struct irq_domain *host);
Grant Likelycc79ca62012-02-16 01:37:49 -0700131
Grant Likelyfa40f372013-06-08 12:57:40 +0100132/**
133 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
134 * @of_node: pointer to interrupt controller's device tree node.
135 * @size: Number of interrupts in the domain.
136 * @ops: map/unmap domain callbacks
137 * @host_data: Controller private data pointer
138 */
139static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
140 unsigned int size,
141 const struct irq_domain_ops *ops,
142 void *host_data)
143{
Grant Likelyddaf1442013-06-10 01:06:02 +0100144 return __irq_domain_add(of_node, size, size, 0, ops, host_data);
Grant Likelyfa40f372013-06-08 12:57:40 +0100145}
146static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
147 unsigned int max_irq,
148 const struct irq_domain_ops *ops,
149 void *host_data)
150{
Grant Likelyddaf1442013-06-10 01:06:02 +0100151 return __irq_domain_add(of_node, 0, max_irq, max_irq, ops, host_data);
Grant Likelyfa40f372013-06-08 12:57:40 +0100152}
Grant Likely1bc04f22012-02-14 14:06:55 -0700153static inline struct irq_domain *irq_domain_add_legacy_isa(
154 struct device_node *of_node,
Grant Likelya18dc812012-01-26 12:12:14 -0700155 const struct irq_domain_ops *ops,
Grant Likely1bc04f22012-02-14 14:06:55 -0700156 void *host_data)
157{
158 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
159 host_data);
160}
Grant Likelycef50752012-07-11 17:24:31 +0100161static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
162 const struct irq_domain_ops *ops,
163 void *host_data)
164{
Grant Likelyddaf1442013-06-10 01:06:02 +0100165 return __irq_domain_add(of_node, 0, ~0, 0, ops, host_data);
Grant Likelycef50752012-07-11 17:24:31 +0100166}
Paul Mundt58ee99a2012-05-19 15:11:41 +0900167
168extern void irq_domain_remove(struct irq_domain *host);
169
Grant Likelyddaf1442013-06-10 01:06:02 +0100170extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
171 irq_hw_number_t hwirq);
172extern void irq_domain_associate_many(struct irq_domain *domain,
173 unsigned int irq_base,
174 irq_hw_number_t hwirq_base, int count);
Jiang Liu43a77592014-06-09 16:20:05 +0800175extern void irq_domain_disassociate(struct irq_domain *domain,
176 unsigned int irq);
Grant Likely98aa4682012-06-17 16:17:04 -0600177
Grant Likelycc79ca62012-02-16 01:37:49 -0700178extern unsigned int irq_create_mapping(struct irq_domain *host,
179 irq_hw_number_t hwirq);
180extern void irq_dispose_mapping(unsigned int virq);
Grant Likelyd3dcb432013-06-10 12:19:17 +0100181
182/**
183 * irq_linear_revmap() - Find a linux irq from a hw irq number.
184 * @domain: domain owning this hardware interrupt
185 * @hwirq: hardware irq number in that domain space
186 *
187 * This is a fast path alternative to irq_find_mapping() that can be
188 * called directly by irq controller code to save a handful of
189 * instructions. It is always safe to call, but won't find irqs mapped
190 * using the radix tree.
191 */
192static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
193 irq_hw_number_t hwirq)
194{
195 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
196}
Grant Likelycc79ca62012-02-16 01:37:49 -0700197extern unsigned int irq_find_mapping(struct irq_domain *host,
198 irq_hw_number_t hwirq);
199extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
Grant Likely98aa4682012-06-17 16:17:04 -0600200extern int irq_create_strict_mappings(struct irq_domain *domain,
201 unsigned int irq_base,
202 irq_hw_number_t hwirq_base, int count);
203
204static inline int irq_create_identity_mapping(struct irq_domain *host,
205 irq_hw_number_t hwirq)
206{
207 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
208}
209
Grant Likelya18dc812012-01-26 12:12:14 -0700210extern const struct irq_domain_ops irq_domain_simple_ops;
Grant Likely16b2e6e2012-01-26 11:26:52 -0700211
212/* stock xlate functions */
213int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
214 const u32 *intspec, unsigned int intsize,
215 irq_hw_number_t *out_hwirq, unsigned int *out_type);
216int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
217 const u32 *intspec, unsigned int intsize,
218 irq_hw_number_t *out_hwirq, unsigned int *out_type);
219int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
220 const u32 *intspec, unsigned int intsize,
221 irq_hw_number_t *out_hwirq, unsigned int *out_type);
222
Grant Likelyd593f252012-02-24 08:24:17 -0700223#else /* CONFIG_IRQ_DOMAIN */
224static inline void irq_dispose_mapping(unsigned int virq) { }
225#endif /* !CONFIG_IRQ_DOMAIN */
Grant Likely7e713302011-07-26 03:19:06 -0600226
Grant Likely08a543a2011-07-26 03:19:06 -0600227#endif /* _LINUX_IRQDOMAIN_H */