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
46 * struct irq_domain_ops - Methods for irq_domain objects
47 * @match: Match an interrupt controller device node to a host, returns
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
52 * @xlate: Given a device tree node and interrupt specifier, decode
53 * the hardware irq number and linux irq type value.
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().
60 struct irq_domain_ops
{
61 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
);
64 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
);
69 extern struct irq_domain_ops irq_generic_chip_ops
;
71 struct irq_domain_chip_generic
;
74 * struct irq_domain - Hardware interrupt number translation object
75 * @link: Element in global irq_domain list.
76 * @name: Name of interrupt domain
77 * @ops: pointer to irq_domain methods
78 * @host_data: private data pointer for use by owner. Not touched by irq_domain
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.
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
96 struct list_head link
;
98 const struct irq_domain_ops
*ops
;
102 struct device_node
*of_node
;
103 struct irq_domain_chip_generic
*gc
;
105 /* reverse map data. The linear map gets appended to the irq_domain */
106 unsigned int revmap_direct_max_irq
;
107 unsigned int revmap_size
;
108 struct radix_tree_root revmap_tree
;
109 unsigned int linear_revmap
[];
112 #ifdef CONFIG_IRQ_DOMAIN
113 struct irq_domain
*irq_domain_add_simple(struct device_node
*of_node
,
115 unsigned int first_irq
,
116 const struct irq_domain_ops
*ops
,
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 unsigned int max_irq
,
130 const struct irq_domain_ops
*ops
,
132 extern struct irq_domain
*irq_find_host(struct device_node
*node
);
133 extern void irq_set_default_host(struct irq_domain
*host
);
135 static inline struct irq_domain
*irq_domain_add_legacy_isa(
136 struct device_node
*of_node
,
137 const struct irq_domain_ops
*ops
,
140 return irq_domain_add_legacy(of_node
, NUM_ISA_INTERRUPTS
, 0, 0, ops
,
143 static inline struct irq_domain
*irq_domain_add_tree(struct device_node
*of_node
,
144 const struct irq_domain_ops
*ops
,
147 return irq_domain_add_linear(of_node
, 0, ops
, host_data
);
150 extern void irq_domain_remove(struct irq_domain
*host
);
152 extern int irq_domain_associate_many(struct irq_domain
*domain
,
153 unsigned int irq_base
,
154 irq_hw_number_t hwirq_base
, int count
);
155 static inline int irq_domain_associate(struct irq_domain
*domain
, unsigned int irq
,
156 irq_hw_number_t hwirq
)
158 return irq_domain_associate_many(domain
, irq
, hwirq
, 1);
161 extern unsigned int irq_create_mapping(struct irq_domain
*host
,
162 irq_hw_number_t hwirq
);
163 extern void irq_dispose_mapping(unsigned int virq
);
164 extern unsigned int irq_find_mapping(struct irq_domain
*host
,
165 irq_hw_number_t hwirq
);
166 extern unsigned int irq_create_direct_mapping(struct irq_domain
*host
);
167 extern int irq_create_strict_mappings(struct irq_domain
*domain
,
168 unsigned int irq_base
,
169 irq_hw_number_t hwirq_base
, int count
);
171 static inline int irq_create_identity_mapping(struct irq_domain
*host
,
172 irq_hw_number_t hwirq
)
174 return irq_create_strict_mappings(host
, hwirq
, hwirq
, 1);
177 extern unsigned int irq_linear_revmap(struct irq_domain
*host
,
178 irq_hw_number_t hwirq
);
180 extern const struct irq_domain_ops irq_domain_simple_ops
;
182 /* stock xlate functions */
183 int irq_domain_xlate_onecell(struct irq_domain
*d
, struct device_node
*ctrlr
,
184 const u32
*intspec
, unsigned int intsize
,
185 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
186 int irq_domain_xlate_twocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
187 const u32
*intspec
, unsigned int intsize
,
188 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
189 int irq_domain_xlate_onetwocell(struct irq_domain
*d
, struct device_node
*ctrlr
,
190 const u32
*intspec
, unsigned int intsize
,
191 irq_hw_number_t
*out_hwirq
, unsigned int *out_type
);
193 #if defined(CONFIG_OF_IRQ)
194 extern void irq_domain_generate_simple(const struct of_device_id
*match
,
195 u64 phys_base
, unsigned int irq_start
);
196 #else /* CONFIG_OF_IRQ */
197 static inline void irq_domain_generate_simple(const struct of_device_id
*match
,
198 u64 phys_base
, unsigned int irq_start
) { }
199 #endif /* !CONFIG_OF_IRQ */
201 #else /* CONFIG_IRQ_DOMAIN */
202 static inline void irq_dispose_mapping(unsigned int virq
) { }
203 #endif /* !CONFIG_IRQ_DOMAIN */
205 #endif /* _LINUX_IRQDOMAIN_H */