include/linux/irqdomain.h

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