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