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