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/radix-tree.h>
  37
  38 struct device_node;
  39 struct irq_domain;
  40 struct of_device_id;
  41
  42 /* Number of irqs reserved for a legacy isa controller */
  43 #define NUM_ISA_INTERRUPTS      16
  44
  45 /* This type is the placeholder for a hardware interrupt number. It has to
  46  * be big enough to enclose whatever representation is used by a given
  47  * platform.
  48  */
  49 typedef unsigned long irq_hw_number_t;
  50
  51 /**
  52  * struct irq_domain_ops - Methods for irq_domain objects
  53  * @match: Match an interrupt controller device node to a host, returns
  54  *         1 on a match
  55  * @map: Create or update a mapping between a virtual irq number and a hw
  56  *       irq number. This is called only once for a given mapping.
  57  * @unmap: Dispose of such a mapping
  58  * @to_irq: (optional) given a local hardware irq number, return the linux
  59  *          irq number.  If to_irq is not implemented, then the irq_domain
  60  *          will use this translation: irq = (domain->irq_base + hwirq)
  61  * @xlate: Given a device tree node and interrupt specifier, decode
  62  *         the hardware irq number and linux irq type value.
  63  *
  64  * Functions below are provided by the driver and called whenever a new mapping
  65  * is created or an old mapping is disposed. The driver can then proceed to
  66  * whatever internal data structures management is required. It also needs
  67  * to setup the irq_desc when returning from map().
  68  */
  69 struct irq_domain_ops {
  70         int (*match)(struct irq_domain *d, struct device_node *node);
  71         int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
  72         void (*unmap)(struct irq_domain *d, unsigned int virq);
  73         unsigned int (*to_irq)(struct irq_domain *d, unsigned long hwirq);
  74         int (*xlate)(struct irq_domain *d, struct device_node *node,
  75                      const u32 *intspec, unsigned int intsize,
  76                      unsigned long *out_hwirq, unsigned int *out_type);
  77 };
  78
  79 /**
  80  * struct irq_domain - Hardware interrupt number translation object
  81  * @link: Element in global irq_domain list.
  82  * @revmap_type: Method used for reverse mapping hwirq numbers to linux irq. This
  83  *               will be one of the IRQ_DOMAIN_MAP_* values.
  84  * @revmap_data: Revmap method specific data.
  85  * @ops: pointer to irq_domain methods
  86  * @host_data: private data pointer for use by owner.  Not touched by irq_domain
  87  *             core code.
  88  * @irq_base: Start of irq_desc range assigned to the irq_domain.  The creator
  89  *            of the irq_domain is responsible for allocating the array of
  90  *            irq_desc structures.
  91  * @nr_irq: Number of irqs managed by the irq domain
  92  * @hwirq_base: Starting number for hwirqs managed by the irq domain
  93  * @of_node: (optional) Pointer to device tree nodes associated with the
  94  *           irq_domain.  Used when decoding device tree interrupt specifiers.
  95  */
  96 struct irq_domain {
  97         struct list_head link;
  98
  99         /* type of reverse mapping_technique */
 100         unsigned int revmap_type;
 101         union {
 102                 struct {
 103                         unsigned int size;
 104                         unsigned int first_irq;
 105                         irq_hw_number_t first_hwirq;
 106                 } legacy;
 107                 struct {
 108                         unsigned int size;
 109                         unsigned int *revmap;
 110                 } linear;
 111                 struct radix_tree_root tree;
 112         } revmap_data;
 113         struct irq_domain_ops *ops;
 114         void *host_data;
 115         irq_hw_number_t inval_irq;
 116
 117         unsigned int irq_base;
 118         unsigned int nr_irq;
 119         unsigned int hwirq_base;
 120
 121         /* Optional device node pointer */
 122         struct device_node *of_node;
 123 };
 124
 125 #ifdef CONFIG_IRQ_DOMAIN
 126 #ifdef CONFIG_PPC
 127 struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
 128                                          unsigned int size,
 129                                          unsigned int first_irq,
 130                                          irq_hw_number_t first_hwirq,
 131                                          struct irq_domain_ops *ops,
 132                                          void *host_data);
 133 struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
 134                                          unsigned int size,
 135                                          struct irq_domain_ops *ops,
 136                                          void *host_data);
 137 struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
 138                                          struct irq_domain_ops *ops,
 139                                          void *host_data);
 140 struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
 141                                          struct irq_domain_ops *ops,
 142                                          void *host_data);
 143
 144 extern struct irq_domain *irq_find_host(struct device_node *node);
 145 extern void irq_set_default_host(struct irq_domain *host);
 146 extern void irq_set_virq_count(unsigned int count);
 147
 148 static inline struct irq_domain *irq_domain_add_legacy_isa(
 149                                 struct device_node *of_node,
 150                                 struct irq_domain_ops *ops,
 151                                 void *host_data)
 152 {
 153         return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
 154                                      host_data);
 155 }
 156
 157 extern unsigned int irq_create_mapping(struct irq_domain *host,
 158                                        irq_hw_number_t hwirq);
 159 extern void irq_dispose_mapping(unsigned int virq);
 160 extern unsigned int irq_find_mapping(struct irq_domain *host,
 161                                      irq_hw_number_t hwirq);
 162 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
 163 extern void irq_radix_revmap_insert(struct irq_domain *host, unsigned int virq,
 164                                     irq_hw_number_t hwirq);
 165 extern unsigned int irq_radix_revmap_lookup(struct irq_domain *host,
 166                                             irq_hw_number_t hwirq);
 167 extern unsigned int irq_linear_revmap(struct irq_domain *host,
 168                                       irq_hw_number_t hwirq);
 169
 170 #else /* CONFIG_PPC */
 171
 172 /**
 173  * irq_domain_to_irq() - Translate from a hardware irq to a linux irq number
 174  *
 175  * Returns the linux irq number associated with a hardware irq.  By default,
 176  * the mapping is irq == domain->irq_base + hwirq, but this mapping can
 177  * be overridden if the irq_domain implements a .to_irq() hook.
 178  */
 179 static inline unsigned int irq_domain_to_irq(struct irq_domain *d,
 180                                              unsigned long hwirq)
 181 {
 182         if (d->ops->to_irq)
 183                 return d->ops->to_irq(d, hwirq);
 184         if (WARN_ON(hwirq < d->hwirq_base))
 185                 return 0;
 186         return d->irq_base + hwirq - d->hwirq_base;
 187 }
 188
 189 #define irq_domain_for_each_hwirq(d, hw) \
 190         for (hw = d->hwirq_base; hw < d->hwirq_base + d->nr_irq; hw++)
 191
 192 #define irq_domain_for_each_irq(d, hw, irq) \
 193         for (hw = d->hwirq_base, irq = irq_domain_to_irq(d, hw); \
 194              hw < d->hwirq_base + d->nr_irq; \
 195              hw++, irq = irq_domain_to_irq(d, hw))
 196
 197 extern void irq_domain_add(struct irq_domain *domain);
 198 extern void irq_domain_del(struct irq_domain *domain);
 199
 200 extern struct irq_domain_ops irq_domain_simple_ops;
 201
 202 #if defined(CONFIG_OF_IRQ)
 203 extern void irq_domain_add_simple(struct device_node *controller, int irq_base);
 204 extern void irq_domain_generate_simple(const struct of_device_id *match,
 205                                         u64 phys_base, unsigned int irq_start);
 206 #else /* CONFIG_OF_IRQ */
 207 static inline void irq_domain_generate_simple(const struct of_device_id *match,
 208                                         u64 phys_base, unsigned int irq_start) { }
 209 #endif /* !CONFIG_OF_IRQ */
 210 #endif /* !CONFIG_PPC */
 211 #endif /* CONFIG_IRQ_DOMAIN */
 212
 213 #endif /* _LINUX_IRQDOMAIN_H */