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