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 hooks for translating device tree or other
   9  * firmware interrupt representations into a hardware irq number that
  10  * can be mapped back to a Linux irq number without any extra platform
  11  * support code.
  12  *
  13  * Interrupt controller "domain" data structure. This could be defined as a
  14  * irq domain controller. That is, it handles the mapping between hardware
  15  * and virtual interrupt numbers for a given interrupt domain. The domain
  16  * structure is generally created by the PIC code for a given PIC instance
  17  * (though a domain can cover more than one PIC if they have a flat number
  18  * model). It's the domain callbacks that are responsible for setting the
  19  * irq_chip on a given irq_desc after it's been mapped.
  20  *
  21  * The host code and data structures use a fwnode_handle pointer to
  22  * identify the domain. In some cases, and in order to preserve source
  23  * code compatibility, this fwnode pointer is "upgraded" to a DT
  24  * device_node. For those firmware infrastructures that do not provide
  25  * a unique identifier for an interrupt controller, the irq_domain
  26  * code offers a fwnode allocator.
  27  */
  28
  29 #ifndef _LINUX_IRQDOMAIN_H
  30 #define _LINUX_IRQDOMAIN_H
  31
  32 #include <linux/types.h>
  33 #include <linux/irqhandler.h>
  34 #include <linux/of.h>
  35 #include <linux/radix-tree.h>
  36
  37 struct device_node;
  38 struct irq_domain;
  39 struct of_device_id;
  40 struct irq_chip;
  41 struct irq_data;
  42
  43 /* Number of irqs reserved for a legacy isa controller */
  44 #define NUM_ISA_INTERRUPTS      16
  45
  46 #define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
  47
  48 /**
  49  * struct irq_fwspec - generic IRQ specifier structure
  50  *
  51  * @fwnode:             Pointer to a firmware-specific descriptor
  52  * @param_count:        Number of device-specific parameters
  53  * @param:              Device-specific parameters
  54  *
  55  * This structure, directly modeled after of_phandle_args, is used to
  56  * pass a device-specific description of an interrupt.
  57  */
  58 struct irq_fwspec {
  59         struct fwnode_handle *fwnode;
  60         int param_count;
  61         u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
  62 };
  63
  64 /*
  65  * Should several domains have the same device node, but serve
  66  * different purposes (for example one domain is for PCI/MSI, and the
  67  * other for wired IRQs), they can be distinguished using a
  68  * bus-specific token. Most domains are expected to only carry
  69  * DOMAIN_BUS_ANY.
  70  */
  71 enum irq_domain_bus_token {
  72         DOMAIN_BUS_ANY          = 0,
  73         DOMAIN_BUS_WIRED,
  74         DOMAIN_BUS_PCI_MSI,
  75         DOMAIN_BUS_PLATFORM_MSI,
  76         DOMAIN_BUS_NEXUS,
  77 };
  78
  79 /**
  80  * struct irq_domain_ops - Methods for irq_domain objects
  81  * @match: Match an interrupt controller device node to a host, returns
  82  *         1 on a match
  83  * @map: Create or update a mapping between a virtual irq number and a hw
  84  *       irq number. This is called only once for a given mapping.
  85  * @unmap: Dispose of such a mapping
  86  * @xlate: Given a device tree node and interrupt specifier, decode
  87  *         the hardware irq number and linux irq type value.
  88  *
  89  * Functions below are provided by the driver and called whenever a new mapping
  90  * is created or an old mapping is disposed. The driver can then proceed to
  91  * whatever internal data structures management is required. It also needs
  92  * to setup the irq_desc when returning from map().
  93  */
  94 struct irq_domain_ops {
  95         int (*match)(struct irq_domain *d, struct device_node *node,
  96                      enum irq_domain_bus_token bus_token);
  97         int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
  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_fwspec(struct irq_fwspec *fwspec,
 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 bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
 218 {
 219         return fwnode && fwnode->type == FWNODE_IRQCHIP;
 220 }
 221
 222 static inline
 223 struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
 224                                             enum irq_domain_bus_token bus_token)
 225 {
 226         struct irq_fwspec fwspec = {
 227                 .fwnode = fwnode,
 228         };
 229
 230         return irq_find_matching_fwspec(&fwspec, bus_token);
 231 }
 232
 233 static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
 234                                                         enum irq_domain_bus_token bus_token)
 235 {
 236         return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
 237 }
 238
 239 static inline struct irq_domain *irq_find_host(struct device_node *node)
 240 {
 241         return irq_find_matching_host(node, DOMAIN_BUS_ANY);
 242 }
 243
 244 /**
 245  * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
 246  * @of_node: pointer to interrupt controller's device tree node.
 247  * @size: Number of interrupts in the domain.
 248  * @ops: map/unmap domain callbacks
 249  * @host_data: Controller private data pointer
 250  */
 251 static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
 252                                          unsigned int size,
 253                                          const struct irq_domain_ops *ops,
 254                                          void *host_data)
 255 {
 256         return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
 257 }
 258 static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
 259                                          unsigned int max_irq,
 260                                          const struct irq_domain_ops *ops,
 261                                          void *host_data)
 262 {
 263         return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
 264 }
 265 static inline struct irq_domain *irq_domain_add_legacy_isa(
 266                                 struct device_node *of_node,
 267                                 const struct irq_domain_ops *ops,
 268                                 void *host_data)
 269 {
 270         return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
 271                                      host_data);
 272 }
 273 static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
 274                                          const struct irq_domain_ops *ops,
 275                                          void *host_data)
 276 {
 277         return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
 278 }
 279
 280 static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
 281                                          unsigned int size,
 282                                          const struct irq_domain_ops *ops,
 283                                          void *host_data)
 284 {
 285         return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
 286 }
 287
 288 static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
 289                                          const struct irq_domain_ops *ops,
 290                                          void *host_data)
 291 {
 292         return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
 293 }
 294
 295 extern void irq_domain_remove(struct irq_domain *host);
 296
 297 extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
 298                                         irq_hw_number_t hwirq);
 299 extern void irq_domain_associate_many(struct irq_domain *domain,
 300                                       unsigned int irq_base,
 301                                       irq_hw_number_t hwirq_base, int count);
 302 extern void irq_domain_disassociate(struct irq_domain *domain,
 303                                     unsigned int irq);
 304
 305 extern unsigned int irq_create_mapping(struct irq_domain *host,
 306                                        irq_hw_number_t hwirq);
 307 extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
 308 extern void irq_dispose_mapping(unsigned int virq);
 309
 310 /**
 311  * irq_linear_revmap() - Find a linux irq from a hw irq number.
 312  * @domain: domain owning this hardware interrupt
 313  * @hwirq: hardware irq number in that domain space
 314  *
 315  * This is a fast path alternative to irq_find_mapping() that can be
 316  * called directly by irq controller code to save a handful of
 317  * instructions. It is always safe to call, but won't find irqs mapped
 318  * using the radix tree.
 319  */
 320 static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
 321                                              irq_hw_number_t hwirq)
 322 {
 323         return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
 324 }
 325 extern unsigned int irq_find_mapping(struct irq_domain *host,
 326                                      irq_hw_number_t hwirq);
 327 extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
 328 extern int irq_create_strict_mappings(struct irq_domain *domain,
 329                                       unsigned int irq_base,
 330                                       irq_hw_number_t hwirq_base, int count);
 331
 332 static inline int irq_create_identity_mapping(struct irq_domain *host,
 333                                               irq_hw_number_t hwirq)
 334 {
 335         return irq_create_strict_mappings(host, hwirq, hwirq, 1);
 336 }
 337
 338 extern const struct irq_domain_ops irq_domain_simple_ops;
 339
 340 /* stock xlate functions */
 341 int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
 342                         const u32 *intspec, unsigned int intsize,
 343                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 344 int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
 345                         const u32 *intspec, unsigned int intsize,
 346                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 347 int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
 348                         const u32 *intspec, unsigned int intsize,
 349                         irq_hw_number_t *out_hwirq, unsigned int *out_type);
 350
 351 /* V2 interfaces to support hierarchy IRQ domains. */
 352 extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
 353                                                 unsigned int virq);
 354 extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
 355                                 irq_hw_number_t hwirq, struct irq_chip *chip,
 356                                 void *chip_data, irq_flow_handler_t handler,
 357                                 void *handler_data, const char *handler_name);
 358 #ifdef  CONFIG_IRQ_DOMAIN_HIERARCHY
 359 extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
 360                         unsigned int flags, unsigned int size,
 361                         struct fwnode_handle *fwnode,
 362                         const struct irq_domain_ops *ops, void *host_data);
 363
 364 static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
 365                                             unsigned int flags,
 366                                             unsigned int size,
 367                                             struct device_node *node,
 368                                             const struct irq_domain_ops *ops,
 369                                             void *host_data)
 370 {
 371         return irq_domain_create_hierarchy(parent, flags, size,
 372                                            of_node_to_fwnode(node),
 373                                            ops, host_data);
 374 }
 375
 376 extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
 377                                    unsigned int nr_irqs, int node, void *arg,
 378                                    bool realloc);
 379 extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
 380 extern void irq_domain_activate_irq(struct irq_data *irq_data);
 381 extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
 382
 383 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
 384                         unsigned int nr_irqs, int node, void *arg)
 385 {
 386         return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false);
 387 }
 388
 389 extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
 390                                          unsigned int virq,
 391                                          irq_hw_number_t hwirq,
 392                                          struct irq_chip *chip,
 393                                          void *chip_data);
 394 extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
 395 extern void irq_domain_free_irqs_common(struct irq_domain *domain,
 396                                         unsigned int virq,
 397                                         unsigned int nr_irqs);
 398 extern void irq_domain_free_irqs_top(struct irq_domain *domain,
 399                                      unsigned int virq, unsigned int nr_irqs);
 400
 401 extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
 402                                         unsigned int irq_base,
 403                                         unsigned int nr_irqs, void *arg);
 404
 405 extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
 406                                         unsigned int irq_base,
 407                                         unsigned int nr_irqs);
 408
 409 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
 410 {
 411         return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
 412 }
 413 #else   /* CONFIG_IRQ_DOMAIN_HIERARCHY */
 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 static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
 417                         unsigned int nr_irqs, int node, void *arg)
 418 {
 419         return -1;
 420 }
 421
 422 static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
 423 {
 424         return false;
 425 }
 426 #endif  /* CONFIG_IRQ_DOMAIN_HIERARCHY */
 427
 428 #else /* CONFIG_IRQ_DOMAIN */
 429 static inline void irq_dispose_mapping(unsigned int virq) { }
 430 static inline void irq_domain_activate_irq(struct irq_data *data) { }
 431 static inline void irq_domain_deactivate_irq(struct irq_data *data) { }
 432 #endif /* !CONFIG_IRQ_DOMAIN */
 433
 434 #endif /* _LINUX_IRQDOMAIN_H */