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