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