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