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