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