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 struct cpumask; 43 44 /* Number of irqs reserved for a legacy isa controller */ 45 #define NUM_ISA_INTERRUPTS 16 46 47 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16 48 49 /** 50 * struct irq_fwspec - generic IRQ specifier structure 51 * 52 * @fwnode: Pointer to a firmware-specific descriptor 53 * @param_count: Number of device-specific parameters 54 * @param: Device-specific parameters 55 * 56 * This structure, directly modeled after of_phandle_args, is used to 57 * pass a device-specific description of an interrupt. 58 */ 59 struct irq_fwspec { 60 struct fwnode_handle *fwnode; 61 int param_count; 62 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS]; 63 }; 64 65 /* 66 * Should several domains have the same device node, but serve 67 * different purposes (for example one domain is for PCI/MSI, and the 68 * other for wired IRQs), they can be distinguished using a 69 * bus-specific token. Most domains are expected to only carry 70 * DOMAIN_BUS_ANY. 71 */ 72 enum irq_domain_bus_token { 73 DOMAIN_BUS_ANY = 0, 74 DOMAIN_BUS_WIRED, 75 DOMAIN_BUS_PCI_MSI, 76 DOMAIN_BUS_PLATFORM_MSI, 77 DOMAIN_BUS_NEXUS, 78 DOMAIN_BUS_IPI, 79 DOMAIN_BUS_FSL_MC_MSI, 80 }; 81 82 /** 83 * struct irq_domain_ops - Methods for irq_domain objects 84 * @match: Match an interrupt controller device node to a host, returns 85 * 1 on a match 86 * @map: Create or update a mapping between a virtual irq number and a hw 87 * irq number. This is called only once for a given mapping. 88 * @unmap: Dispose of such a mapping 89 * @xlate: Given a device tree node and interrupt specifier, decode 90 * the hardware irq number and linux irq type value. 91 * 92 * Functions below are provided by the driver and called whenever a new mapping 93 * is created or an old mapping is disposed. The driver can then proceed to 94 * whatever internal data structures management is required. It also needs 95 * to setup the irq_desc when returning from map(). 96 */ 97 struct irq_domain_ops { 98 int (*match)(struct irq_domain *d, struct device_node *node, 99 enum irq_domain_bus_token bus_token); 100 int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec, 101 enum irq_domain_bus_token bus_token); 102 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw); 103 void (*unmap)(struct irq_domain *d, unsigned int virq); 104 int (*xlate)(struct irq_domain *d, struct device_node *node, 105 const u32 *intspec, unsigned int intsize, 106 unsigned long *out_hwirq, unsigned int *out_type); 107 108 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 109 /* extended V2 interfaces to support hierarchy irq_domains */ 110 int (*alloc)(struct irq_domain *d, unsigned int virq, 111 unsigned int nr_irqs, void *arg); 112 void (*free)(struct irq_domain *d, unsigned int virq, 113 unsigned int nr_irqs); 114 void (*activate)(struct irq_domain *d, struct irq_data *irq_data); 115 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data); 116 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec, 117 unsigned long *out_hwirq, unsigned int *out_type); 118 #endif 119 }; 120 121 extern struct irq_domain_ops irq_generic_chip_ops; 122 123 struct irq_domain_chip_generic; 124 125 /** 126 * struct irq_domain - Hardware interrupt number translation object 127 * @link: Element in global irq_domain list. 128 * @name: Name of interrupt domain 129 * @ops: pointer to irq_domain methods 130 * @host_data: private data pointer for use by owner. Not touched by irq_domain 131 * core code. 132 * @flags: host per irq_domain flags 133 * 134 * Optional elements 135 * @of_node: Pointer to device tree nodes associated with the irq_domain. Used 136 * when decoding device tree interrupt specifiers. 137 * @gc: Pointer to a list of generic chips. There is a helper function for 138 * setting up one or more generic chips for interrupt controllers 139 * drivers using the generic chip library which uses this pointer. 140 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains 141 * 142 * Revmap data, used internally by irq_domain 143 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that 144 * support direct mapping 145 * @revmap_size: Size of the linear map table @linear_revmap[] 146 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map 147 * @linear_revmap: Linear table of hwirq->virq reverse mappings 148 */ 149 struct irq_domain { 150 struct list_head link; 151 const char *name; 152 const struct irq_domain_ops *ops; 153 void *host_data; 154 unsigned int flags; 155 156 /* Optional data */ 157 struct fwnode_handle *fwnode; 158 enum irq_domain_bus_token bus_token; 159 struct irq_domain_chip_generic *gc; 160 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 161 struct irq_domain *parent; 162 #endif 163 164 /* reverse map data. The linear map gets appended to the irq_domain */ 165 irq_hw_number_t hwirq_max; 166 unsigned int revmap_direct_max_irq; 167 unsigned int revmap_size; 168 struct radix_tree_root revmap_tree; 169 unsigned int linear_revmap[]; 170 }; 171 172 /* Irq domain flags */ 173 enum { 174 /* Irq domain is hierarchical */ 175 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0), 176 177 /* Core calls alloc/free recursive through the domain hierarchy. */ 178 IRQ_DOMAIN_FLAG_AUTO_RECURSIVE = (1 << 1), 179 180 /* Irq domain is an IPI domain with virq per cpu */ 181 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2), 182 183 /* Irq domain is an IPI domain with single virq */ 184 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3), 185 186 /* Irq domain implements MSIs */ 187 IRQ_DOMAIN_FLAG_MSI = (1 << 4), 188 189 /* Irq domain implements MSI remapping */ 190 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5), 191 192 /* 193 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved 194 * for implementation specific purposes and ignored by the 195 * core code. 196 */ 197 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16), 198 }; 199 200 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d) 201 { 202 return to_of_node(d->fwnode); 203 } 204 205 #ifdef CONFIG_IRQ_DOMAIN 206 struct fwnode_handle *irq_domain_alloc_fwnode(void *data); 207 void irq_domain_free_fwnode(struct fwnode_handle *fwnode); 208 struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size, 209 irq_hw_number_t hwirq_max, int direct_max, 210 const struct irq_domain_ops *ops, 211 void *host_data); 212 struct irq_domain *irq_domain_add_simple(struct device_node *of_node, 213 unsigned int size, 214 unsigned int first_irq, 215 const struct irq_domain_ops *ops, 216 void *host_data); 217 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node, 218 unsigned int size, 219 unsigned int first_irq, 220 irq_hw_number_t first_hwirq, 221 const struct irq_domain_ops *ops, 222 void *host_data); 223 extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec, 224 enum irq_domain_bus_token bus_token); 225 extern bool irq_domain_check_msi_remap(void); 226 extern void irq_set_default_host(struct irq_domain *host); 227 extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs, 228 irq_hw_number_t hwirq, int node, 229 const struct cpumask *affinity); 230 231 static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node) 232 { 233 return node ? &node->fwnode : NULL; 234 } 235 236 static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode) 237 { 238 return fwnode && fwnode->type == FWNODE_IRQCHIP; 239 } 240 241 static inline 242 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode, 243 enum irq_domain_bus_token bus_token) 244 { 245 struct irq_fwspec fwspec = { 246 .fwnode = fwnode, 247 }; 248 249 return irq_find_matching_fwspec(&fwspec, bus_token); 250 } 251 252 static inline struct irq_domain *irq_find_matching_host(struct device_node *node, 253 enum irq_domain_bus_token bus_token) 254 { 255 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token); 256 } 257 258 static inline struct irq_domain *irq_find_host(struct device_node *node) 259 { 260 return irq_find_matching_host(node, DOMAIN_BUS_ANY); 261 } 262 263 /** 264 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain. 265 * @of_node: pointer to interrupt controller's device tree node. 266 * @size: Number of interrupts in the domain. 267 * @ops: map/unmap domain callbacks 268 * @host_data: Controller private data pointer 269 */ 270 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node, 271 unsigned int size, 272 const struct irq_domain_ops *ops, 273 void *host_data) 274 { 275 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data); 276 } 277 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node, 278 unsigned int max_irq, 279 const struct irq_domain_ops *ops, 280 void *host_data) 281 { 282 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data); 283 } 284 static inline struct irq_domain *irq_domain_add_legacy_isa( 285 struct device_node *of_node, 286 const struct irq_domain_ops *ops, 287 void *host_data) 288 { 289 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops, 290 host_data); 291 } 292 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node, 293 const struct irq_domain_ops *ops, 294 void *host_data) 295 { 296 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data); 297 } 298 299 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode, 300 unsigned int size, 301 const struct irq_domain_ops *ops, 302 void *host_data) 303 { 304 return __irq_domain_add(fwnode, size, size, 0, ops, host_data); 305 } 306 307 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode, 308 const struct irq_domain_ops *ops, 309 void *host_data) 310 { 311 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data); 312 } 313 314 extern void irq_domain_remove(struct irq_domain *host); 315 316 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq, 317 irq_hw_number_t hwirq); 318 extern void irq_domain_associate_many(struct irq_domain *domain, 319 unsigned int irq_base, 320 irq_hw_number_t hwirq_base, int count); 321 extern void irq_domain_disassociate(struct irq_domain *domain, 322 unsigned int irq); 323 324 extern unsigned int irq_create_mapping(struct irq_domain *host, 325 irq_hw_number_t hwirq); 326 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec); 327 extern void irq_dispose_mapping(unsigned int virq); 328 329 /** 330 * irq_linear_revmap() - Find a linux irq from a hw irq number. 331 * @domain: domain owning this hardware interrupt 332 * @hwirq: hardware irq number in that domain space 333 * 334 * This is a fast path alternative to irq_find_mapping() that can be 335 * called directly by irq controller code to save a handful of 336 * instructions. It is always safe to call, but won't find irqs mapped 337 * using the radix tree. 338 */ 339 static inline unsigned int irq_linear_revmap(struct irq_domain *domain, 340 irq_hw_number_t hwirq) 341 { 342 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0; 343 } 344 extern unsigned int irq_find_mapping(struct irq_domain *host, 345 irq_hw_number_t hwirq); 346 extern unsigned int irq_create_direct_mapping(struct irq_domain *host); 347 extern int irq_create_strict_mappings(struct irq_domain *domain, 348 unsigned int irq_base, 349 irq_hw_number_t hwirq_base, int count); 350 351 static inline int irq_create_identity_mapping(struct irq_domain *host, 352 irq_hw_number_t hwirq) 353 { 354 return irq_create_strict_mappings(host, hwirq, hwirq, 1); 355 } 356 357 extern const struct irq_domain_ops irq_domain_simple_ops; 358 359 /* stock xlate functions */ 360 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr, 361 const u32 *intspec, unsigned int intsize, 362 irq_hw_number_t *out_hwirq, unsigned int *out_type); 363 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr, 364 const u32 *intspec, unsigned int intsize, 365 irq_hw_number_t *out_hwirq, unsigned int *out_type); 366 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr, 367 const u32 *intspec, unsigned int intsize, 368 irq_hw_number_t *out_hwirq, unsigned int *out_type); 369 370 /* IPI functions */ 371 int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest); 372 int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest); 373 374 /* V2 interfaces to support hierarchy IRQ domains. */ 375 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain, 376 unsigned int virq); 377 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq, 378 irq_hw_number_t hwirq, struct irq_chip *chip, 379 void *chip_data, irq_flow_handler_t handler, 380 void *handler_data, const char *handler_name); 381 #ifdef CONFIG_IRQ_DOMAIN_HIERARCHY 382 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent, 383 unsigned int flags, unsigned int size, 384 struct fwnode_handle *fwnode, 385 const struct irq_domain_ops *ops, void *host_data); 386 387 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent, 388 unsigned int flags, 389 unsigned int size, 390 struct device_node *node, 391 const struct irq_domain_ops *ops, 392 void *host_data) 393 { 394 return irq_domain_create_hierarchy(parent, flags, size, 395 of_node_to_fwnode(node), 396 ops, host_data); 397 } 398 399 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base, 400 unsigned int nr_irqs, int node, void *arg, 401 bool realloc, const struct cpumask *affinity); 402 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs); 403 extern void irq_domain_activate_irq(struct irq_data *irq_data); 404 extern void irq_domain_deactivate_irq(struct irq_data *irq_data); 405 406 static inline int irq_domain_alloc_irqs(struct irq_domain *domain, 407 unsigned int nr_irqs, int node, void *arg) 408 { 409 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false, 410 NULL); 411 } 412 413 extern int irq_domain_alloc_irqs_recursive(struct irq_domain *domain, 414 unsigned int irq_base, 415 unsigned int nr_irqs, void *arg); 416 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain, 417 unsigned int virq, 418 irq_hw_number_t hwirq, 419 struct irq_chip *chip, 420 void *chip_data); 421 extern void irq_domain_reset_irq_data(struct irq_data *irq_data); 422 extern void irq_domain_free_irqs_common(struct irq_domain *domain, 423 unsigned int virq, 424 unsigned int nr_irqs); 425 extern void irq_domain_free_irqs_top(struct irq_domain *domain, 426 unsigned int virq, unsigned int nr_irqs); 427 428 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain, 429 unsigned int irq_base, 430 unsigned int nr_irqs, void *arg); 431 432 extern void irq_domain_free_irqs_parent(struct irq_domain *domain, 433 unsigned int irq_base, 434 unsigned int nr_irqs); 435 436 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) 437 { 438 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY; 439 } 440 441 static inline bool irq_domain_is_ipi(struct irq_domain *domain) 442 { 443 return domain->flags & 444 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE); 445 } 446 447 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain) 448 { 449 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU; 450 } 451 452 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain) 453 { 454 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE; 455 } 456 457 static inline bool irq_domain_is_msi(struct irq_domain *domain) 458 { 459 return domain->flags & IRQ_DOMAIN_FLAG_MSI; 460 } 461 462 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain) 463 { 464 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP; 465 } 466 467 extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain); 468 469 #else /* CONFIG_IRQ_DOMAIN_HIERARCHY */ 470 static inline void irq_domain_activate_irq(struct irq_data *data) { } 471 static inline void irq_domain_deactivate_irq(struct irq_data *data) { } 472 static inline int irq_domain_alloc_irqs(struct irq_domain *domain, 473 unsigned int nr_irqs, int node, void *arg) 474 { 475 return -1; 476 } 477 478 static inline void irq_domain_free_irqs(unsigned int virq, 479 unsigned int nr_irqs) { } 480 481 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain) 482 { 483 return false; 484 } 485 486 static inline bool irq_domain_is_ipi(struct irq_domain *domain) 487 { 488 return false; 489 } 490 491 static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain) 492 { 493 return false; 494 } 495 496 static inline bool irq_domain_is_ipi_single(struct irq_domain *domain) 497 { 498 return false; 499 } 500 501 static inline bool irq_domain_is_msi(struct irq_domain *domain) 502 { 503 return false; 504 } 505 506 static inline bool irq_domain_is_msi_remap(struct irq_domain *domain) 507 { 508 return false; 509 } 510 511 static inline bool 512 irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain) 513 { 514 return false; 515 } 516 #endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */ 517 518 #else /* CONFIG_IRQ_DOMAIN */ 519 static inline void irq_dispose_mapping(unsigned int virq) { } 520 static inline void irq_domain_activate_irq(struct irq_data *data) { } 521 static inline void irq_domain_deactivate_irq(struct irq_data *data) { } 522 static inline struct irq_domain *irq_find_matching_fwnode( 523 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token) 524 { 525 return NULL; 526 } 527 static inline bool irq_domain_check_msi_remap(void) 528 { 529 return false; 530 } 531 #endif /* !CONFIG_IRQ_DOMAIN */ 532 533 #endif /* _LINUX_IRQDOMAIN_H */ 534