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