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 hooks for translating device tree or other 9 * firmware interrupt representations into a hardware irq number that 10 * can be mapped back to a Linux irq number without any extra platform 11 * support code. 12 * 13 * Interrupt controller "domain" data structure. This could be defined as a 14 * irq domain controller. That is, it handles the mapping between hardware 15 * and virtual interrupt numbers for a given interrupt domain. The domain 16 * structure is generally created by the PIC code for a given PIC instance 17 * (though a domain can cover more than one PIC if they have a flat number 18 * model). It's the domain callbacks that are responsible for setting the 19 * irq_chip on a given irq_desc after it's been mapped. 20 * 21 * The host code and data structures use a fwnode_handle pointer to 22 * identify the domain. In some cases, and in order to preserve source 23 * code compatibility, this fwnode pointer is "upgraded" to a DT 24 * device_node. For those firmware infrastructures that do not provide 25 * a unique identifier for an interrupt controller, the irq_domain 26 * code offers a fwnode allocator. 27 */ 28 29 #ifndef _LINUX_IRQDOMAIN_H 30 #define _LINUX_IRQDOMAIN_H 31 32 #include <linux/types.h> 33 #include <linux/irqhandler.h> 34 #include <linux/of.h> 35 #include <linux/radix-tree.h> 36 37 struct device_node; 38 struct irq_domain; 39 struct of_device_id; 40 struct irq_chip; 41 struct irq_data; 42 43 /* Number of irqs reserved for a legacy isa controller */ 44 #define NUM_ISA_INTERRUPTS 16 45 46 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16 47 48 /** 49 * struct irq_fwspec - generic IRQ specifier structure 50 * 51 * @fwnode: Pointer to a firmware-specific descriptor 52 * @param_count: Number of device-specific parameters 53 * @param: Device-specific parameters 54 * 55 * This structure, directly modeled after of_phandle_args, is used to 56 * pass a device-specific description of an interrupt. 57 */ 58 struct irq_fwspec { 59 struct fwnode_handle *fwnode; 60 int param_count; 61 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS]; 62 }; 63 64 /* 65 * Should several domains have the same device node, but serve 66 * different purposes (for example one domain is for PCI/MSI, and the 67 * other for wired IRQs), they can be distinguished using a 68 * bus-specific token. Most domains are expected to only carry 69 * DOMAIN_BUS_ANY. 70 */ 71 enum irq_domain_bus_token { 72 DOMAIN_BUS_ANY = 0, 73 DOMAIN_BUS_PCI_MSI, 74 DOMAIN_BUS_PLATFORM_MSI, 75 DOMAIN_BUS_NEXUS, 76 }; 77 78 /** 79 * struct irq_domain_ops - Methods for irq_domain objects 80 * @match: Match an interrupt controller device node to a host, returns 81 * 1 on a match 82 * @map: Create or update a mapping between a virtual irq number and a hw 83 * irq number. This is called only once for a given mapping. 84 * @unmap: Dispose of such a mapping 85 * @xlate: Given a device tree node and interrupt specifier, decode 86 * the hardware irq number and linux irq type value. 87 * 88 * Functions below are provided by the driver and called whenever a new mapping 89 * is created or an old mapping is disposed. The driver can then proceed to 90 * whatever internal data structures management is required. It also needs 91 * to setup the irq_desc when returning from map(). 92 */ 93 struct irq_domain_ops { 94 int (*match)(struct irq_domain *d, struct device_node *node, 95 enum irq_domain_bus_token bus_token); 96 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw); 97 void (*unmap)(struct irq_domain *d, unsigned int virq); 98 int (*xlate)(struct irq_domain *d, struct device_node *node, 99 const u32 *intspec, unsigned int intsize, 100 unsigned long *out_hwirq, unsigned int *out_type); 101 102 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 103 /* extended V2 interfaces to support hierarchy irq_domains */ 104 int (*alloc)(struct irq_domain *d, unsigned int virq, 105 unsigned int nr_irqs, void *arg); 106 void (*free)(struct irq_domain *d, unsigned int virq, 107 unsigned int nr_irqs); 108 void (*activate)(struct irq_domain *d, struct irq_data *irq_data); 109 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data); 110 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec, 111 unsigned long *out_hwirq, unsigned int *out_type); 112 #endif 113 }; 114 115 extern struct irq_domain_ops irq_generic_chip_ops; 116 117 struct irq_domain_chip_generic; 118 119 /** 120 * struct irq_domain - Hardware interrupt number translation object 121 * @link: Element in global irq_domain list. 122 * @name: Name of interrupt domain 123 * @ops: pointer to irq_domain methods 124 * @host_data: private data pointer for use by owner. Not touched by irq_domain 125 * core code. 126 * @flags: host per irq_domain flags 127 * 128 * Optional elements 129 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used 130 * when decoding device tree interrupt specifiers. 131 * @gc: Pointer to a list of generic chips. There is a helper function for 132 * setting up one or more generic chips for interrupt controllers 133 * drivers using the generic chip library which uses this pointer. 134 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains 135 * 136 * Revmap data, used internally by irq_domain 137 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that 138 * support direct mapping 139 * @revmap_size: Size of the linear map table @linear_revmap[] 140 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map 141 * @linear_revmap: Linear table of hwirq->virq reverse mappings 142 */ 143 struct irq_domain { 144 struct list_head link; 145 const char *name; 146 const struct irq_domain_ops *ops; 147 void *host_data; 148 unsigned int flags; 149 150 /* Optional data */ 151 struct fwnode_handle *fwnode; 152 enum irq_domain_bus_token bus_token; 153 struct irq_domain_chip_generic *gc; 154 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 155 struct irq_domain *parent; 156 #endif 157 158 /* reverse map data. The linear map gets appended to the irq_domain */ 159 irq_hw_number_t hwirq_max; 160 unsigned int revmap_direct_max_irq; 161 unsigned int revmap_size; 162 struct radix_tree_root revmap_tree; 163 unsigned int linear_revmap[]; 164 }; 165 166 /* Irq domain flags */ 167 enum { 168 /* Irq domain is hierarchical */ 169 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), 170 171 /* Core calls alloc/free recursive through the domain hierarchy. */ 172 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1), 173 174 /* 175 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved 176 * for implementation specific purposes and ignored by the 177 * core code. 178 */ 179 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16), 180 }; 181 182 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d) 183 { 184 return to_of_node(d->fwnode); 185 } 186 187 #ifdef CONFIG_IRQ_DOMAIN 188 struct fwnode_handle *irq_domain_alloc_fwnode(void *data); 189 void irq_domain_free_fwnode(struct fwnode_handle *fwnode); 190 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size, 191 irq_hw_number_t hwirq_max, int direct_max, 192 const struct irq_domain_ops *ops, 193 void *host_data); 194 struct irq_domain *irq_domain_add_simple(struct device_node *of_node, 195 unsigned int size, 196 unsigned int first_irq, 197 const struct irq_domain_ops *ops, 198 void *host_data); 199 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, 200 unsigned int size, 201 unsigned int first_irq, 202 irq_hw_number_t first_hwirq, 203 const struct irq_domain_ops *ops, 204 void *host_data); 205 extern struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode, 206 enum irq_domain_bus_token bus_token); 207 extern void irq_set_default_host(struct irq_domain *host); 208 209 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node) 210 { 211 return node ? &node->fwnode : NULL; 212 } 213 214 static inline struct irq_domain *irq_find_matching_host(struct device_node *node, 215 enum irq_domain_bus_token bus_token) 216 { 217 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token); 218 } 219 220 static inline struct irq_domain *irq_find_host(struct device_node *node) 221 { 222 return irq_find_matching_host(node, DOMAIN_BUS_ANY); 223 } 224 225 /** 226 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain. 227 * @of_node: pointer to interrupt controller's device tree node. 228 * @size: Number of interrupts in the domain. 229 * @ops: map/unmap domain callbacks 230 * @host_data: Controller private data pointer 231 */ 232 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node, 233 unsigned int size, 234 const struct irq_domain_ops *ops, 235 void *host_data) 236 { 237 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data); 238 } 239 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node, 240 unsigned int max_irq, 241 const struct irq_domain_ops *ops, 242 void *host_data) 243 { 244 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data); 245 } 246 static inline struct irq_domain *irq_domain_add_legacy_isa( 247 struct device_node *of_node, 248 const struct irq_domain_ops *ops, 249 void *host_data) 250 { 251 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, 252 host_data); 253 } 254 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node, 255 const struct irq_domain_ops *ops, 256 void *host_data) 257 { 258 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data); 259 } 260 261 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode, 262 unsigned int size, 263 const struct irq_domain_ops *ops, 264 void *host_data) 265 { 266 return __irq_domain_add(fwnode, size, size, 0, ops, host_data); 267 } 268 269 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode, 270 const struct irq_domain_ops *ops, 271 void *host_data) 272 { 273 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data); 274 } 275 276 extern void irq_domain_remove(struct irq_domain *host); 277 278 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq, 279 irq_hw_number_t hwirq); 280 extern void irq_domain_associate_many(struct irq_domain *domain, 281 unsigned int irq_base, 282 irq_hw_number_t hwirq_base, int count); 283 extern void irq_domain_disassociate(struct irq_domain *domain, 284 unsigned int irq); 285 286 extern unsigned int irq_create_mapping(struct irq_domain *host, 287 irq_hw_number_t hwirq); 288 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec); 289 extern void irq_dispose_mapping(unsigned int virq); 290 291 /** 292 * irq_linear_revmap() - Find a linux irq from a hw irq number. 293 * @domain: domain owning this hardware interrupt 294 * @hwirq: hardware irq number in that domain space 295 * 296 * This is a fast path alternative to irq_find_mapping() that can be 297 * called directly by irq controller code to save a handful of 298 * instructions. It is always safe to call, but won't find irqs mapped 299 * using the radix tree. 300 */ 301 static inline unsigned int irq_linear_revmap(struct irq_domain *domain, 302 irq_hw_number_t hwirq) 303 { 304 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0; 305 } 306 extern unsigned int irq_find_mapping(struct irq_domain *host, 307 irq_hw_number_t hwirq); 308 extern unsigned int irq_create_direct_mapping(struct irq_domain *host); 309 extern int irq_create_strict_mappings(struct irq_domain *domain, 310 unsigned int irq_base, 311 irq_hw_number_t hwirq_base, int count); 312 313 static inline int irq_create_identity_mapping(struct irq_domain *host, 314 irq_hw_number_t hwirq) 315 { 316 return irq_create_strict_mappings(host, hwirq, hwirq, 1); 317 } 318 319 extern const struct irq_domain_ops irq_domain_simple_ops; 320 321 /* stock xlate functions */ 322 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr, 323 const u32 *intspec, unsigned int intsize, 324 irq_hw_number_t *out_hwirq, unsigned int *out_type); 325 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr, 326 const u32 *intspec, unsigned int intsize, 327 irq_hw_number_t *out_hwirq, unsigned int *out_type); 328 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr, 329 const u32 *intspec, unsigned int intsize, 330 irq_hw_number_t *out_hwirq, unsigned int *out_type); 331 332 /* V2 interfaces to support hierarchy IRQ domains. */ 333 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, 334 unsigned int virq); 335 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, 336 irq_hw_number_t hwirq, struct irq_chip *chip, 337 void *chip_data, irq_flow_handler_t handler, 338 void *handler_data, const char *handler_name); 339 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 340 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent, 341 unsigned int flags, unsigned int size, 342 struct fwnode_handle *fwnode, 343 const struct irq_domain_ops *ops, void *host_data); 344 345 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent, 346 unsigned int flags, 347 unsigned int size, 348 struct device_node *node, 349 const struct irq_domain_ops *ops, 350 void *host_data) 351 { 352 return irq_domain_create_hierarchy(parent, flags, size, 353 of_node_to_fwnode(node), 354 ops, host_data); 355 } 356 357 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, 358 unsigned int nr_irqs, int node, void *arg, 359 bool realloc); 360 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); 361 extern void irq_domain_activate_irq(struct irq_data *irq_data); 362 extern void irq_domain_deactivate_irq(struct irq_data *irq_data); 363 364 static inline int irq_domain_alloc_irqs(struct irq_domain *domain, 365 unsigned int nr_irqs, int node, void *arg) 366 { 367 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false); 368 } 369 370 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, 371 unsigned int virq, 372 irq_hw_number_t hwirq, 373 struct irq_chip *chip, 374 void *chip_data); 375 extern void irq_domain_reset_irq_data(struct irq_data *irq_data); 376 extern void irq_domain_free_irqs_common(struct irq_domain *domain, 377 unsigned int virq, 378 unsigned int nr_irqs); 379 extern void irq_domain_free_irqs_top(struct irq_domain *domain, 380 unsigned int virq, unsigned int nr_irqs); 381 382 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain, 383 unsigned int irq_base, 384 unsigned int nr_irqs, void *arg); 385 386 extern void irq_domain_free_irqs_parent(struct irq_domain *domain, 387 unsigned int irq_base, 388 unsigned int nr_irqs); 389 390 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) 391 { 392 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY; 393 } 394 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */ 395 static inline void irq_domain_activate_irq(struct irq_data *data) { } 396 static inline void irq_domain_deactivate_irq(struct irq_data *data) { } 397 static inline int irq_domain_alloc_irqs(struct irq_domain *domain, 398 unsigned int nr_irqs, int node, void *arg) 399 { 400 return -1; 401 } 402 403 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) 404 { 405 return false; 406 } 407 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */ 408 409 #else /* CONFIG_IRQ_DOMAIN */ 410 static inline void irq_dispose_mapping(unsigned int virq) { } 411 static inline void irq_domain_activate_irq(struct irq_data *data) { } 412 static inline void irq_domain_deactivate_irq(struct irq_data *data) { } 413 #endif /* !CONFIG_IRQ_DOMAIN */ 414 415 #endif /* _LINUX_IRQDOMAIN_H */ 416