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 * 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. 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. 30 */ 31 32#ifndef _LINUX_IRQDOMAIN_H 33#define _LINUX_IRQDOMAIN_H 34 35#include <linux/types.h> 36#include <linux/irqhandler.h> 37#include <linux/radix-tree.h> 38 39struct device_node; 40struct irq_domain; 41struct of_device_id; 42struct irq_chip; 43struct irq_data; 44 45/* Number of irqs reserved for a legacy isa controller */ 46#define NUM_ISA_INTERRUPTS 16 47 48/** 49 * struct irq_domain_ops - Methods for irq_domain objects 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 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(). 62 */ 63struct irq_domain_ops { 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); 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); 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 80}; 81 82extern struct irq_domain_ops irq_generic_chip_ops; 83 84struct irq_domain_chip_generic; 85 86/** 87 * struct irq_domain - Hardware interrupt number translation object 88 * @link: Element in global irq_domain list. 89 * @name: Name of interrupt domain 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. 93 * @flags: host per irq_domain flags 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. 101 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains 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 109 */ 110struct irq_domain { 111 struct list_head link; 112 const char *name; 113 const struct irq_domain_ops *ops; 114 void *host_data; 115 unsigned int flags; 116 117 /* Optional data */ 118 struct device_node *of_node; 119 struct irq_domain_chip_generic *gc; 120#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 121 struct irq_domain *parent; 122#endif 123 124 /* reverse map data. The linear map gets appended to the irq_domain */ 125 irq_hw_number_t hwirq_max; 126 unsigned int revmap_direct_max_irq; 127 unsigned int revmap_size; 128 struct radix_tree_root revmap_tree; 129 unsigned int linear_revmap[]; 130}; 131 132/* Irq domain flags */ 133enum { 134 /* Irq domain is hierarchical */ 135 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), 136 137 /* Core calls alloc/free recursive through the domain hierarchy. */ 138 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1), 139 140 /* 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 148#ifdef CONFIG_IRQ_DOMAIN 149struct irq_domain *__irq_domain_add(struct device_node *of_node, int size, 150 irq_hw_number_t hwirq_max, int direct_max, 151 const struct irq_domain_ops *ops, 152 void *host_data); 153struct 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); 158struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, 159 unsigned int size, 160 unsigned int first_irq, 161 irq_hw_number_t first_hwirq, 162 const struct irq_domain_ops *ops, 163 void *host_data); 164extern struct irq_domain *irq_find_host(struct device_node *node); 165extern void irq_set_default_host(struct irq_domain *host); 166 167/** 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{ 179 return __irq_domain_add(of_node, size, size, 0, ops, host_data); 180} 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{ 186 return __irq_domain_add(of_node, 0, max_irq, max_irq, ops, host_data); 187} 188static inline struct irq_domain *irq_domain_add_legacy_isa( 189 struct device_node *of_node, 190 const struct irq_domain_ops *ops, 191 void *host_data) 192{ 193 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, 194 host_data); 195} 196static 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{ 200 return __irq_domain_add(of_node, 0, ~0, 0, ops, host_data); 201} 202 203extern void irq_domain_remove(struct irq_domain *host); 204 205extern 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); 210extern void irq_domain_disassociate(struct irq_domain *domain, 211 unsigned int irq); 212 213extern unsigned int irq_create_mapping(struct irq_domain *host, 214 irq_hw_number_t hwirq); 215extern void irq_dispose_mapping(unsigned int virq); 216 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} 232extern 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); 235extern 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 245extern const struct irq_domain_ops irq_domain_simple_ops; 246 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 258/* V2 interfaces to support hierarchy IRQ domains. */ 259extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, 260 unsigned int virq); 261#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 262extern struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent, 263 unsigned int flags, unsigned int size, 264 struct device_node *node, 265 const struct irq_domain_ops *ops, void *host_data); 266extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, 267 unsigned int nr_irqs, int node, void *arg, 268 bool realloc); 269extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); 270extern void irq_domain_activate_irq(struct irq_data *irq_data); 271extern void irq_domain_deactivate_irq(struct irq_data *irq_data); 272 273static inline int irq_domain_alloc_irqs(struct irq_domain *domain, 274 unsigned int nr_irqs, int node, void *arg) 275{ 276 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false); 277} 278 279extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, 280 unsigned int virq, 281 irq_hw_number_t hwirq, 282 struct irq_chip *chip, 283 void *chip_data); 284extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, 285 irq_hw_number_t hwirq, struct irq_chip *chip, 286 void *chip_data, irq_flow_handler_t handler, 287 void *handler_data, const char *handler_name); 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 295extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain, 296 unsigned int irq_base, 297 unsigned int nr_irqs, void *arg); 298 299extern void irq_domain_free_irqs_parent(struct irq_domain *domain, 300 unsigned int irq_base, 301 unsigned int nr_irqs); 302 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 322#else /* CONFIG_IRQ_DOMAIN */ 323static inline void irq_dispose_mapping(unsigned int virq) { } 324static inline void irq_domain_activate_irq(struct irq_data *data) { } 325static inline void irq_domain_deactivate_irq(struct irq_data *data) { } 326#endif /* !CONFIG_IRQ_DOMAIN */ 327 328#endif /* _LINUX_IRQDOMAIN_H */ 329