2 * irq_domain - IRQ translation domains
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.
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.
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.
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
32 #ifndef _LINUX_IRQDOMAIN_H
33 #define _LINUX_IRQDOMAIN_H
35 #include <linux/types.h>
36 #include <linux/radix-tree.h>
42 /* Number of irqs reserved for a legacy isa controller */
43 #define NUM_ISA_INTERRUPTS 16
45 /* This type is the placeholder for a hardware interrupt number. It has to
46 * be big enough to enclose whatever representation is used by a given
49 typedef unsigned long irq_hw_number_t
;
52 * struct irq_domain_ops - Methods for irq_domain objects
53 * @match: Match an interrupt controller device node to a host, returns
55 * @map: Create or update a mapping between a virtual irq number and a hw
56 * irq number. This is called only once for a given mapping.
57 * @unmap: Dispose of such a mapping
58 * @xlate: Given a device tree node and interrupt specifier, decode
59 * the hardware irq number and linux irq type value.
61 * Functions below are provided by the driver and called whenever a new mapping
62 * is created or an old mapping is disposed. The driver can then proceed to
63 * whatever internal data structures management is required. It also needs
64 * to setup the irq_desc when returning from map().
66 struct irq_domain_ops
{
67 int (*match
)(struct irq_domain
*d
, struct device_node
*node
);
68 int (*map
)(struct irq_domain
*d
, unsigned int virq
, irq_hw_number_t hw
);
69 void (*unmap
)(struct irq_domain
*d
, unsigned int virq
);
70 int (*xlate
)(struct irq_domain
*d
, struct device_node
*node
,
71 const u32
*intspec
, unsigned int intsize
,
72 unsigned long *out_hwirq
, unsigned int *out_type
);
76 * struct irq_domain - Hardware interrupt number translation object
77 * @link: Element in global irq_domain list.
78 * @revmap_type: Method used for reverse mapping hwirq numbers to linux irq. This
79 * will be one of the IRQ_DOMAIN_MAP_* values.
80 * @revmap_data: Revmap method specific data.
81 * @ops: pointer to irq_domain methods
82 * @host_data: private data pointer for use by owner. Not touched by irq_domain
84 * @irq_base: Start of irq_desc range assigned to the irq_domain. The creator
85 * of the irq_domain is responsible for allocating the array of
86 * irq_desc structures.
87 * @nr_irq: Number of irqs managed by the irq domain
88 * @hwirq_base: Starting number for hwirqs managed by the irq domain
89 * @of_node: (optional) Pointer to device tree nodes associated with the
90 * irq_domain. Used when decoding device tree interrupt specifiers.
93 struct list_head link
;
95 /* type of reverse mapping_technique */
96 unsigned int revmap_type
;
100 unsigned int first_irq
;
101 irq_hw_number_t first_hwirq
;
105 unsigned int *revmap
;
107 struct radix_tree_root tree
;
109 const struct irq_domain_ops
*ops
;
111 irq_hw_number_t inval_irq
;
113 /* Optional device node pointer */
114 struct device_node
*of_node
;
117 #ifdef CONFIG_IRQ_DOMAIN
118 struct irq_domain
*irq_domain_add_legacy(struct device_node
*of_node
,
120 unsigned int first_irq
,
121 irq_hw_number_t first_hwirq
,
122 const struct irq_domain_ops
*ops
,
124 struct irq_domain
*irq_domain_add_linear(struct device_node
*of_node
,
126 const struct irq_domain_ops
*ops
,
128 struct irq_domain
*irq_domain_add_nomap(struct device_node
*of_node
,
129 const struct irq_domain_ops
*ops
,
131 struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
132 const struct irq_domain_ops
*ops
,
135 extern struct irq_domain
*irq_find_host(struct device_node
*node
);
136 extern void irq_set_default_host(struct irq_domain
*host
);
137 extern void irq_set_virq_count(unsigned int count
);
139 static inline struct irq_domain
*irq_domain_add_legacy_isa(
140 struct device_node
*of_node
,
141 const struct irq_domain_ops
*ops
,
144 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
147 extern struct irq_domain
*irq_find_host(struct device_node
*node
);
148 extern void irq_set_default_host(struct irq_domain
*host
);
149 extern void irq_set_virq_count(unsigned int count
);
152 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
153 irq_hw_number_t hwirq
);
154 extern void irq_dispose_mapping(unsigned int virq
);
155 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
156 irq_hw_number_t hwirq
);
157 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
158 extern void irq_radix_revmap_insert(struct irq_domain
*host
, unsigned int virq
,
159 irq_hw_number_t hwirq
);
160 extern unsigned int irq_radix_revmap_lookup(struct irq_domain
*host
,
161 irq_hw_number_t hwirq
);
162 extern unsigned int irq_linear_revmap(struct irq_domain
*host
,
163 irq_hw_number_t hwirq
);
165 extern const struct irq_domain_ops irq_domain_simple_ops
;
167 /* stock xlate functions */
168 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
169 const u32
*intspec
, unsigned int intsize
,
170 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
171 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
172 const u32
*intspec
, unsigned int intsize
,
173 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
174 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
175 const u32
*intspec
, unsigned int intsize
,
176 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
178 #if defined(CONFIG_OF_IRQ)
179 extern void irq_domain_generate_simple(const struct of_device_id
*match
,
180 u64 phys_base
, unsigned int irq_start
);
181 #else /* CONFIG_OF_IRQ */
182 static inline void irq_domain_generate_simple(const struct of_device_id
*match
,
183 u64 phys_base
, unsigned int irq_start
) { }
184 #endif /* !CONFIG_OF_IRQ */
186 #else /* CONFIG_IRQ_DOMAIN */
187 static inline void irq_dispose_mapping(unsigned int virq
) { }
188 #endif /* !CONFIG_IRQ_DOMAIN */
190 #endif /* _LINUX_IRQDOMAIN_H */