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 a hook for translating device tree interrupt
   9  * representation into a hardware irq number that can be mapped back to a
  10  * Linux irq number without any extra platform support code.
  11  *
  12  * Interrupt controller "domain" data structure. This could be defined as a
  13  * irq domain controller. That is, it handles the mapping between hardware
  14  * and virtual interrupt numbers for a given interrupt domain. The domain
  15  * structure is generally created by the PIC code for a given PIC instance
  16  * (though a domain can cover more than one PIC if they have a flat number
  17  * model). It's the domain callbacks that are responsible for setting the
  18  * irq_chip on a given irq_desc after it's been mapped.
  19  *
  20  * The host code and data structures are agnostic to whether or not
  21  * we use an open firmware device-tree. We do have references to struct
  22  * device_node in two places: in irq_find_host() to find the host matching
  23  * a given interrupt controller node, and of course as an argument to its
  24  * counterpart domain->ops->match() callback. However, those are treated as
  25  * generic pointers by the core and the fact that it's actually a device-node
  26  * pointer is purely a convention between callers and implementation. This
  27  * code could thus be used on other architectures by replacing those two
  28  * by some sort of arch-specific void * "token" used to identify interrupt
  29  * controllers.
  30  */
  31
  32 #ifndef _LINUX_IRQDOMAIN_H
  33 #define _LINUX_IRQDOMAIN_H
  34
  35 #include <linux/types.h>
  36 #include <linux/irqhandler.h>
  37 #include <linux/of.h>
  38 #include <linux/radix-tree.h>
  39
  40 struct device_node;
  41 struct irq_domain;
  42 struct of_device_id;
  43 struct irq_chip;
  44 struct irq_data;
  45
  46 /* Number of irqs reserved for a legacy isa controller */
  47 #define NUM_ISA_INTERRUPTS      16
  48
  49 /*
  50  * Should several domains have the same device node, but serve
  51  * different purposes (for example one domain is for PCI/MSI, and the
  52  * other for wired IRQs), they can be distinguished using a
  53  * bus-specific token. Most domains are expected to only carry
  54  * DOMAIN_BUS_ANY.
  55  */
  56 enum irq_domain_bus_token {
  57         DOMAIN_BUS_ANY          = 0,
  58         DOMAIN_BUS_PCI_MSI,
  59         DOMAIN_BUS_PLATFORM_MSI,
  60         DOMAIN_BUS_NEXUS,
  61 };
  62
  63 /**
  64  * struct irq_domain_ops - Methods for irq_domain objects
  65  * @match: Match an interrupt controller device node to a host, returns
  66  *         1 on a match
  67  * @map: Create or update a mapping between a virtual irq number and a hw
  68  *       irq number. This is called only once for a given mapping.
  69  * @unmap: Dispose of such a mapping
  70  * @xlate: Given a device tree node and interrupt specifier, decode
  71  *         the hardware irq number and linux irq type value.
  72  *
  73  * Functions below are provided by the driver and called whenever a new mapping
  74  * is created or an old mapping is disposed. The driver can then proceed to
  75  * whatever internal data structures management is required. It also needs
  76  * to setup the irq_desc when returning from map().
  77  */
  78 struct irq_domain_ops {
  79         int (*match)(struct irq_domain *d, struct device_node *node,
  80                      enum irq_domain_bus_token bus_token);
  81         int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
  82         void (*unmap)(struct irq_domain *d, unsigned int virq);
  83         int (*xlate)(struct irq_domain *d, struct device_node *node,
  84                      const u32 *intspec, unsigned int intsize,
  85                      unsigned long *out_hwirq, unsigned int *out_type);
  86
  87 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
  88         /* extended V2 interfaces to support hierarchy irq_domains */
  89         int (*alloc)(struct irq_domain *d, unsigned int virq,
  90                      unsigned int nr_irqs, void *arg);
  91         void (*free)(struct irq_domain *d, unsigned int virq,
  92                      unsigned int nr_irqs);
  93         void (*activate)(struct irq_domain *d, struct irq_data *irq_data);
  94         void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
  95 #endif
  96 };
  97
  98 extern struct irq_domain_ops irq_generic_chip_ops;
  99
 100 struct irq_domain_chip_generic;
 101
 102 /**
 103  * struct irq_domain - Hardware interrupt number translation object
 104  * @link: Element in global irq_domain list.
 105  * @name: Name of interrupt domain
 106  * @ops: pointer to irq_domain methods
 107  * @host_data: private data pointer for use by owner.  Not touched by irq_domain
 108  *             core code.
 109  * @flags: host per irq_domain flags
 110  *
 111  * Optional elements
 112  * @of_node: Pointer to device tree nodes associated with the irq_domain. Used
 113  *           when decoding device tree interrupt specifiers.
 114  * @gc: Pointer to a list of generic chips. There is a helper function for
 115  *      setting up one or more generic chips for interrupt controllers
 116  *      drivers using the generic chip library which uses this pointer.
 117  * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
 118  *
 119  * Revmap data, used internally by irq_domain
 120  * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
 121  *                         support direct mapping
 122  * @revmap_size: Size of the linear map table @linear_revmap[]
 123  * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
 124  * @linear_revmap: Linear table of hwirq->virq reverse mappings
 125  */
 126 struct irq_domain {
 127         struct list_head link;
 128         const char *name;
 129         const struct irq_domain_ops *ops;
 130         void *host_data;
 131         unsigned int flags;
 132
 133         /* Optional data */
 134         struct fwnode_handle *fwnode;
 135         enum irq_domain_bus_token bus_token;
 136         struct irq_domain_chip_generic *gc;
 137 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 138         struct irq_domain *parent;
 139 #endif
 140
 141         /* reverse map data. The linear map gets appended to the irq_domain */
 142         irq_hw_number_t hwirq_max;
 143         unsigned int revmap_direct_max_irq;
 144         unsigned int revmap_size;
 145         struct radix_tree_root revmap_tree;
 146         unsigned int linear_revmap[];
 147 };
 148
 149 /* Irq domain flags */
 150 enum {
 151         /* Irq domain is hierarchical */
 152         IRQ_DOMAIN_FLAG_HIERARCHY       = (1 << 0),
 153
 154         /* Core calls alloc/free recursive through the domain hierarchy. */
 155         IRQ_DOMAIN_FLAG_AUTO_RECURSIVE  = (1 << 1),
 156
 157         /*
 158          * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
 159          * for implementation specific purposes and ignored by the
 160          * core code.
 161          */
 162         IRQ_DOMAIN_FLAG_NONCORE         = (1 << 16),
 163 };
 164
 165 static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
 166 {
 167         return to_of_node(d->fwnode);
 168 }
 169
 170 #ifdef CONFIG_IRQ_DOMAIN
 171 struct irq_domain *__irq_domain_add(struct device_node *of_node, int size,
 172                                     irq_hw_number_t hwirq_max, int direct_max,
 173                                     const struct irq_domain_ops *ops,
 174                                     void *host_data);
 175 struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
 176                                          unsigned int size,
 177                                          unsigned int first_irq,
 178                                          const struct irq_domain_ops *ops,
 179                                          void *host_data);
 180 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
 181                                          unsigned int size,
 182                                          unsigned int first_irq,
 183                                          irq_hw_number_t first_hwirq,
 184                                          const struct irq_domain_ops *ops,
 185                                          void *host_data);
 186 extern struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
 187                                                    enum irq_domain_bus_token bus_token);
 188 extern void irq_set_default_host(struct irq_domain *host);
 189
 190 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
 191                                                         enum irq_domain_bus_token bus_token)
 192 {
 193         return irq_find_matching_fwnode(node ? &node->fwnode : NULL,
 194                                         bus_token);
 195 }
 196
 197 static inline struct irq_domain *irq_find_host(struct device_node *node)
 198 {
 199         return irq_find_matching_host(node, DOMAIN_BUS_ANY);
 200 }
 201
 202 /**
 203  * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
 204  * @of_node: pointer to interrupt controller's device tree node.
 205  * @size: Number of interrupts in the domain.
 206  * @ops: map/unmap domain callbacks
 207  * @host_data: Controller private data pointer
 208  */
 209 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
 210                                          unsigned int size,
 211                                          const struct irq_domain_ops *ops,
 212                                          void *host_data)
 213 {
 214         return __irq_domain_add(of_node, size, size, 0, ops, host_data);
 215 }
 216 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
 217                                          unsigned int max_irq,
 218                                          const struct irq_domain_ops *ops,
 219                                          void *host_data)
 220 {
 221         return __irq_domain_add(of_node, 0, max_irq, max_irq, ops, host_data);
 222 }
 223 static inline struct irq_domain *irq_domain_add_legacy_isa(
 224                                 struct device_node *of_node,
 225                                 const struct irq_domain_ops *ops,
 226                                 void *host_data)
 227 {
 228         return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
 229                                      host_data);
 230 }
 231 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
 232                                          const struct irq_domain_ops *ops,
 233                                          void *host_data)
 234 {
 235         return __irq_domain_add(of_node, 0, ~0, 0, ops, host_data);
 236 }
 237
 238 extern void irq_domain_remove(struct irq_domain *host);
 239
 240 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
 241                                         irq_hw_number_t hwirq);
 242 extern void irq_domain_associate_many(struct irq_domain *domain,
 243                                       unsigned int irq_base,
 244                                       irq_hw_number_t hwirq_base, int count);
 245 extern void irq_domain_disassociate(struct irq_domain *domain,
 246                                     unsigned int irq);
 247
 248 extern unsigned int irq_create_mapping(struct irq_domain *host,
 249                                        irq_hw_number_t hwirq);
 250 extern void irq_dispose_mapping(unsigned int virq);
 251
 252 /**
 253  * irq_linear_revmap() - Find a linux irq from a hw irq number.
 254  * @domain: domain owning this hardware interrupt
 255  * @hwirq: hardware irq number in that domain space
 256  *
 257  * This is a fast path alternative to irq_find_mapping() that can be
 258  * called directly by irq controller code to save a handful of
 259  * instructions. It is always safe to call, but won't find irqs mapped
 260  * using the radix tree.
 261  */
 262 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
 263                                              irq_hw_number_t hwirq)
 264 {
 265         return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
 266 }
 267 extern unsigned int irq_find_mapping(struct irq_domain *host,
 268                                      irq_hw_number_t hwirq);
 269 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
 270 extern int irq_create_strict_mappings(struct irq_domain *domain,
 271                                       unsigned int irq_base,
 272                                       irq_hw_number_t hwirq_base, int count);
 273
 274 static inline int irq_create_identity_mapping(struct irq_domain *host,
 275                                               irq_hw_number_t hwirq)
 276 {
 277         return irq_create_strict_mappings(host, hwirq, hwirq, 1);
 278 }
 279
 280 extern const struct irq_domain_ops irq_domain_simple_ops;
 281
 282 /* stock xlate functions */
 283 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
 284                         const u32 *intspec, unsigned int intsize,
 285                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 286 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
 287                         const u32 *intspec, unsigned int intsize,
 288                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 289 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
 290                         const u32 *intspec, unsigned int intsize,
 291                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 292
 293 /* V2 interfaces to support hierarchy IRQ domains. */
 294 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
 295                                                 unsigned int virq);
 296 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
 297                                 irq_hw_number_t hwirq, struct irq_chip *chip,
 298                                 void *chip_data, irq_flow_handler_t handler,
 299                                 void *handler_data, const char *handler_name);
 300 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 301 extern struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
 302                         unsigned int flags, unsigned int size,
 303                         struct device_node *node,
 304                         const struct irq_domain_ops *ops, void *host_data);
 305 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
 306                                    unsigned int nr_irqs, int node, void *arg,
 307                                    bool realloc);
 308 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
 309 extern void irq_domain_activate_irq(struct irq_data *irq_data);
 310 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
 311
 312 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
 313                         unsigned int nr_irqs, int node, void *arg)
 314 {
 315         return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false);
 316 }
 317
 318 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
 319                                          unsigned int virq,
 320                                          irq_hw_number_t hwirq,
 321                                          struct irq_chip *chip,
 322                                          void *chip_data);
 323 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
 324 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
 325                                         unsigned int virq,
 326                                         unsigned int nr_irqs);
 327 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
 328                                      unsigned int virq, unsigned int nr_irqs);
 329
 330 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
 331                                         unsigned int irq_base,
 332                                         unsigned int nr_irqs, void *arg);
 333
 334 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
 335                                         unsigned int irq_base,
 336                                         unsigned int nr_irqs);
 337
 338 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
 339 {
 340         return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
 341 }
 342 #else   /* CONFIG_IRQ_DOMAIN_HIERARCHY */
 343 static inline void irq_domain_activate_irq(struct irq_data *data) { }
 344 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
 345 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
 346                         unsigned int nr_irqs, int node, void *arg)
 347 {
 348         return -1;
 349 }
 350
 351 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
 352 {
 353         return false;
 354 }
 355 #endif  /* CONFIG_IRQ_DOMAIN_HIERARCHY */
 356
 357 #else /* CONFIG_IRQ_DOMAIN */
 358 static inline void irq_dispose_mapping(unsigned int virq) { }
 359 static inline void irq_domain_activate_irq(struct irq_data *data) { }
 360 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
 361 #endif /* !CONFIG_IRQ_DOMAIN */
 362
 363 #endif /* _LINUX_IRQDOMAIN_H */