1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * irq_domain - IRQ translation domains
4 *
5 * Translation infrastructure between hw and linux irq numbers. This is
6 * helpful for interrupt controllers to implement mapping between hardware
7 * irq numbers and the Linux irq number space.
8 *
9 * irq_domains also have hooks for translating device tree or other
10 * firmware interrupt representations into a hardware irq number that
11 * can be mapped back to a Linux irq number without any extra platform
12 * support code.
13 *
14 * Interrupt controller "domain" data structure. This could be defined as a
15 * irq domain controller. That is, it handles the mapping between hardware
16 * and virtual interrupt numbers for a given interrupt domain. The domain
17 * structure is generally created by the PIC code for a given PIC instance
18 * (though a domain can cover more than one PIC if they have a flat number
19 * model). It's the domain callbacks that are responsible for setting the
20 * irq_chip on a given irq_desc after it's been mapped.
21 *
22 * The host code and data structures use a fwnode_handle pointer to
23 * identify the domain. In some cases, and in order to preserve source
24 * code compatibility, this fwnode pointer is "upgraded" to a DT
25 * device_node. For those firmware infrastructures that do not provide
26 * a unique identifier for an interrupt controller, the irq_domain
27 * code offers a fwnode allocator.
28 */
29
30#ifndef _LINUX_IRQDOMAIN_H
31#define _LINUX_IRQDOMAIN_H
32
33#include <linux/types.h>
34#include <linux/irqhandler.h>
35#include <linux/of.h>
36#include <linux/mutex.h>
37#include <linux/radix-tree.h>
38
39struct device_node;
40struct irq_domain;
41struct of_device_id;
42struct irq_chip;
43struct irq_data;
44struct cpumask;
45struct seq_file;
46struct irq_affinity_desc;
47
48/* Number of irqs reserved for a legacy isa controller */
49#define NUM_ISA_INTERRUPTS 16
50
51#define IRQ_DOMAIN_IRQ_SPEC_PARAMS 16
52
53/**
54 * struct irq_fwspec - generic IRQ specifier structure
55 *
56 * @fwnode: Pointer to a firmware-specific descriptor
57 * @param_count: Number of device-specific parameters
58 * @param: Device-specific parameters
59 *
60 * This structure, directly modeled after of_phandle_args, is used to
61 * pass a device-specific description of an interrupt.
62 */
63struct irq_fwspec {
64 struct fwnode_handle *fwnode;
65 int param_count;
66 u32 param[IRQ_DOMAIN_IRQ_SPEC_PARAMS];
67};
68
69/*
70 * Should several domains have the same device node, but serve
71 * different purposes (for example one domain is for PCI/MSI, and the
72 * other for wired IRQs), they can be distinguished using a
73 * bus-specific token. Most domains are expected to only carry
74 * DOMAIN_BUS_ANY.
75 */
76enum irq_domain_bus_token {
77 DOMAIN_BUS_ANY = 0,
78 DOMAIN_BUS_WIRED,
79 DOMAIN_BUS_GENERIC_MSI,
80 DOMAIN_BUS_PCI_MSI,
81 DOMAIN_BUS_PLATFORM_MSI,
82 DOMAIN_BUS_NEXUS,
83 DOMAIN_BUS_IPI,
84 DOMAIN_BUS_FSL_MC_MSI,
85};
86
87/**
88 * struct irq_domain_ops - Methods for irq_domain objects
89 * @match: Match an interrupt controller device node to a host, returns
90 * 1 on a match
91 * @map: Create or update a mapping between a virtual irq number and a hw
92 * irq number. This is called only once for a given mapping.
93 * @unmap: Dispose of such a mapping
94 * @xlate: Given a device tree node and interrupt specifier, decode
95 * the hardware irq number and linux irq type value.
96 *
97 * Functions below are provided by the driver and called whenever a new mapping
98 * is created or an old mapping is disposed. The driver can then proceed to
99 * whatever internal data structures management is required. It also needs
100 * to setup the irq_desc when returning from map().
101 */
102struct irq_domain_ops {
103 int (*match)(struct irq_domain *d, struct device_node *node,
104 enum irq_domain_bus_token bus_token);
105 int (*select)(struct irq_domain *d, struct irq_fwspec *fwspec,
106 enum irq_domain_bus_token bus_token);
107 int (*map)(struct irq_domain *d, unsigned int virq, irq_hw_number_t hw);
108 void (*unmap)(struct irq_domain *d, unsigned int virq);
109 int (*xlate)(struct irq_domain *d, struct device_node *node,
110 const u32 *intspec, unsigned int intsize,
111 unsigned long *out_hwirq, unsigned int *out_type);
112#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
113 /* extended V2 interfaces to support hierarchy irq_domains */
114 int (*alloc)(struct irq_domain *d, unsigned int virq,
115 unsigned int nr_irqs, void *arg);
116 void (*free)(struct irq_domain *d, unsigned int virq,
117 unsigned int nr_irqs);
118 int (*activate)(struct irq_domain *d, struct irq_data *irqd, bool reserve);
119 void (*deactivate)(struct irq_domain *d, struct irq_data *irq_data);
120 int (*translate)(struct irq_domain *d, struct irq_fwspec *fwspec,
121 unsigned long *out_hwirq, unsigned int *out_type);
122#endif
123#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
124 void (*debug_show)(struct seq_file *m, struct irq_domain *d,
125 struct irq_data *irqd, int ind);
126#endif
127};
128
129extern struct irq_domain_ops irq_generic_chip_ops;
130
131struct irq_domain_chip_generic;
132
133/**
134 * struct irq_domain - Hardware interrupt number translation object
135 * @link: Element in global irq_domain list.
136 * @name: Name of interrupt domain
137 * @ops: pointer to irq_domain methods
138 * @host_data: private data pointer for use by owner. Not touched by irq_domain
139 * core code.
140 * @flags: host per irq_domain flags
141 * @mapcount: The number of mapped interrupts
142 *
143 * Optional elements
144 * @fwnode: Pointer to firmware node associated with the irq_domain. Pretty easy
145 * to swap it for the of_node via the irq_domain_get_of_node accessor
146 * @gc: Pointer to a list of generic chips. There is a helper function for
147 * setting up one or more generic chips for interrupt controllers
148 * drivers using the generic chip library which uses this pointer.
149 * @parent: Pointer to parent irq_domain to support hierarchy irq_domains
150 * @debugfs_file: dentry for the domain debugfs file
151 *
152 * Revmap data, used internally by irq_domain
153 * @revmap_direct_max_irq: The largest hwirq that can be set for controllers that
154 * support direct mapping
155 * @revmap_size: Size of the linear map table @linear_revmap[]
156 * @revmap_tree: Radix map tree for hwirqs that don't fit in the linear map
157 * @linear_revmap: Linear table of hwirq->virq reverse mappings
158 */
159struct irq_domain {
160 struct list_head link;
161 const char *name;
162 const struct irq_domain_ops *ops;
163 void *host_data;
164 unsigned int flags;
165 unsigned int mapcount;
166
167 /* Optional data */
168 struct fwnode_handle *fwnode;
169 enum irq_domain_bus_token bus_token;
170 struct irq_domain_chip_generic *gc;
171#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
172 struct irq_domain *parent;
173#endif
174#ifdef CONFIG_GENERIC_IRQ_DEBUGFS
175 struct dentry *debugfs_file;
176#endif
177
178 /* reverse map data. The linear map gets appended to the irq_domain */
179 irq_hw_number_t hwirq_max;
180 unsigned int revmap_direct_max_irq;
181 unsigned int revmap_size;
182 struct radix_tree_root revmap_tree;
183 struct mutex revmap_tree_mutex;
184 unsigned int linear_revmap[];
185};
186
187/* Irq domain flags */
188enum {
189 /* Irq domain is hierarchical */
190 IRQ_DOMAIN_FLAG_HIERARCHY = (1 << 0),
191
192 /* Irq domain name was allocated in __irq_domain_add() */
193 IRQ_DOMAIN_NAME_ALLOCATED = (1 << 6),
194
195 /* Irq domain is an IPI domain with virq per cpu */
196 IRQ_DOMAIN_FLAG_IPI_PER_CPU = (1 << 2),
197
198 /* Irq domain is an IPI domain with single virq */
199 IRQ_DOMAIN_FLAG_IPI_SINGLE = (1 << 3),
200
201 /* Irq domain implements MSIs */
202 IRQ_DOMAIN_FLAG_MSI = (1 << 4),
203
204 /* Irq domain implements MSI remapping */
205 IRQ_DOMAIN_FLAG_MSI_REMAP = (1 << 5),
206
207 /*
208 * Flags starting from IRQ_DOMAIN_FLAG_NONCORE are reserved
209 * for implementation specific purposes and ignored by the
210 * core code.
211 */
212 IRQ_DOMAIN_FLAG_NONCORE = (1 << 16),
213};
214
215static inline struct device_node *irq_domain_get_of_node(struct irq_domain *d)
216{
217 return to_of_node(d->fwnode);
218}
219
220#ifdef CONFIG_IRQ_DOMAIN
221struct fwnode_handle *__irq_domain_alloc_fwnode(unsigned int type, int id,
222 const char *name, void *data);
223
224enum {
225 IRQCHIP_FWNODE_REAL,
226 IRQCHIP_FWNODE_NAMED,
227 IRQCHIP_FWNODE_NAMED_ID,
228};
229
230static inline
231struct fwnode_handle *irq_domain_alloc_named_fwnode(const char *name)
232{
233 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED, 0, name, NULL);
234}
235
236static inline
237struct fwnode_handle *irq_domain_alloc_named_id_fwnode(const char *name, int id)
238{
239 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_NAMED_ID, id, name,
240 NULL);
241}
242
243static inline struct fwnode_handle *irq_domain_alloc_fwnode(void *data)
244{
245 return __irq_domain_alloc_fwnode(IRQCHIP_FWNODE_REAL, 0, NULL, data);
246}
247
248void irq_domain_free_fwnode(struct fwnode_handle *fwnode);
249struct irq_domain *__irq_domain_add(struct fwnode_handle *fwnode, int size,
250 irq_hw_number_t hwirq_max, int direct_max,
251 const struct irq_domain_ops *ops,
252 void *host_data);
253struct irq_domain *irq_domain_add_simple(struct device_node *of_node,
254 unsigned int size,
255 unsigned int first_irq,
256 const struct irq_domain_ops *ops,
257 void *host_data);
258struct irq_domain *irq_domain_add_legacy(struct device_node *of_node,
259 unsigned int size,
260 unsigned int first_irq,
261 irq_hw_number_t first_hwirq,
262 const struct irq_domain_ops *ops,
263 void *host_data);
264extern struct irq_domain *irq_find_matching_fwspec(struct irq_fwspec *fwspec,
265 enum irq_domain_bus_token bus_token);
266extern bool irq_domain_check_msi_remap(void);
267extern void irq_set_default_host(struct irq_domain *host);
268extern struct irq_domain *irq_get_default_host(void);
269extern int irq_domain_alloc_descs(int virq, unsigned int nr_irqs,
270 irq_hw_number_t hwirq, int node,
271 const struct irq_affinity_desc *affinity);
272
273static inline struct fwnode_handle *of_node_to_fwnode(struct device_node *node)
274{
275 return node ? &node->fwnode : NULL;
276}
277
278extern const struct fwnode_operations irqchip_fwnode_ops;
279
280static inline bool is_fwnode_irqchip(struct fwnode_handle *fwnode)
281{
282 return fwnode && fwnode->ops == &irqchip_fwnode_ops;
283}
284
285extern void irq_domain_update_bus_token(struct irq_domain *domain,
286 enum irq_domain_bus_token bus_token);
287
288static inline
289struct irq_domain *irq_find_matching_fwnode(struct fwnode_handle *fwnode,
290 enum irq_domain_bus_token bus_token)
291{
292 struct irq_fwspec fwspec = {
293 .fwnode = fwnode,
294 };
295
296 return irq_find_matching_fwspec(&fwspec, bus_token);
297}
298
299static inline struct irq_domain *irq_find_matching_host(struct device_node *node,
300 enum irq_domain_bus_token bus_token)
301{
302 return irq_find_matching_fwnode(of_node_to_fwnode(node), bus_token);
303}
304
305static inline struct irq_domain *irq_find_host(struct device_node *node)
306{
307 struct irq_domain *d;
308
309 d = irq_find_matching_host(node, DOMAIN_BUS_WIRED);
310 if (!d)
311 d = irq_find_matching_host(node, DOMAIN_BUS_ANY);
312
313 return d;
314}
315
316/**
317 * irq_domain_add_linear() - Allocate and register a linear revmap irq_domain.
318 * @of_node: pointer to interrupt controller's device tree node.
319 * @size: Number of interrupts in the domain.
320 * @ops: map/unmap domain callbacks
321 * @host_data: Controller private data pointer
322 */
323static inline struct irq_domain *irq_domain_add_linear(struct device_node *of_node,
324 unsigned int size,
325 const struct irq_domain_ops *ops,
326 void *host_data)
327{
328 return __irq_domain_add(of_node_to_fwnode(of_node), size, size, 0, ops, host_data);
329}
330static inline struct irq_domain *irq_domain_add_nomap(struct device_node *of_node,
331 unsigned int max_irq,
332 const struct irq_domain_ops *ops,
333 void *host_data)
334{
335 return __irq_domain_add(of_node_to_fwnode(of_node), 0, max_irq, max_irq, ops, host_data);
336}
337static inline struct irq_domain *irq_domain_add_legacy_isa(
338 struct device_node *of_node,
339 const struct irq_domain_ops *ops,
340 void *host_data)
341{
342 return irq_domain_add_legacy(of_node, NUM_ISA_INTERRUPTS, 0, 0, ops,
343 host_data);
344}
345static inline struct irq_domain *irq_domain_add_tree(struct device_node *of_node,
346 const struct irq_domain_ops *ops,
347 void *host_data)
348{
349 return __irq_domain_add(of_node_to_fwnode(of_node), 0, ~0, 0, ops, host_data);
350}
351
352static inline struct irq_domain *irq_domain_create_linear(struct fwnode_handle *fwnode,
353 unsigned int size,
354 const struct irq_domain_ops *ops,
355 void *host_data)
356{
357 return __irq_domain_add(fwnode, size, size, 0, ops, host_data);
358}
359
360static inline struct irq_domain *irq_domain_create_tree(struct fwnode_handle *fwnode,
361 const struct irq_domain_ops *ops,
362 void *host_data)
363{
364 return __irq_domain_add(fwnode, 0, ~0, 0, ops, host_data);
365}
366
367extern void irq_domain_remove(struct irq_domain *host);
368
369extern int irq_domain_associate(struct irq_domain *domain, unsigned int irq,
370 irq_hw_number_t hwirq);
371extern void irq_domain_associate_many(struct irq_domain *domain,
372 unsigned int irq_base,
373 irq_hw_number_t hwirq_base, int count);
374extern void irq_domain_disassociate(struct irq_domain *domain,
375 unsigned int irq);
376
377extern unsigned int irq_create_mapping(struct irq_domain *host,
378 irq_hw_number_t hwirq);
379extern unsigned int irq_create_fwspec_mapping(struct irq_fwspec *fwspec);
380extern void irq_dispose_mapping(unsigned int virq);
381
382/**
383 * irq_linear_revmap() - Find a linux irq from a hw irq number.
384 * @domain: domain owning this hardware interrupt
385 * @hwirq: hardware irq number in that domain space
386 *
387 * This is a fast path alternative to irq_find_mapping() that can be
388 * called directly by irq controller code to save a handful of
389 * instructions. It is always safe to call, but won't find irqs mapped
390 * using the radix tree.
391 */
392static inline unsigned int irq_linear_revmap(struct irq_domain *domain,
393 irq_hw_number_t hwirq)
394{
395 return hwirq < domain->revmap_size ? domain->linear_revmap[hwirq] : 0;
396}
397extern unsigned int irq_find_mapping(struct irq_domain *host,
398 irq_hw_number_t hwirq);
399extern unsigned int irq_create_direct_mapping(struct irq_domain *host);
400extern int irq_create_strict_mappings(struct irq_domain *domain,
401 unsigned int irq_base,
402 irq_hw_number_t hwirq_base, int count);
403
404static inline int irq_create_identity_mapping(struct irq_domain *host,
405 irq_hw_number_t hwirq)
406{
407 return irq_create_strict_mappings(host, hwirq, hwirq, 1);
408}
409
410extern const struct irq_domain_ops irq_domain_simple_ops;
411
412/* stock xlate functions */
413int irq_domain_xlate_onecell(struct irq_domain *d, struct device_node *ctrlr,
414 const u32 *intspec, unsigned int intsize,
415 irq_hw_number_t *out_hwirq, unsigned int *out_type);
416int irq_domain_xlate_twocell(struct irq_domain *d, struct device_node *ctrlr,
417 const u32 *intspec, unsigned int intsize,
418 irq_hw_number_t *out_hwirq, unsigned int *out_type);
419int irq_domain_xlate_onetwocell(struct irq_domain *d, struct device_node *ctrlr,
420 const u32 *intspec, unsigned int intsize,
421 irq_hw_number_t *out_hwirq, unsigned int *out_type);
422
423int irq_domain_translate_twocell(struct irq_domain *d,
424 struct irq_fwspec *fwspec,
425 unsigned long *out_hwirq,
426 unsigned int *out_type);
427
428/* IPI functions */
429int irq_reserve_ipi(struct irq_domain *domain, const struct cpumask *dest);
430int irq_destroy_ipi(unsigned int irq, const struct cpumask *dest);
431
432/* V2 interfaces to support hierarchy IRQ domains. */
433extern struct irq_data *irq_domain_get_irq_data(struct irq_domain *domain,
434 unsigned int virq);
435extern void irq_domain_set_info(struct irq_domain *domain, unsigned int virq,
436 irq_hw_number_t hwirq, struct irq_chip *chip,
437 void *chip_data, irq_flow_handler_t handler,
438 void *handler_data, const char *handler_name);
439#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
440extern struct irq_domain *irq_domain_create_hierarchy(struct irq_domain *parent,
441 unsigned int flags, unsigned int size,
442 struct fwnode_handle *fwnode,
443 const struct irq_domain_ops *ops, void *host_data);
444
445static inline struct irq_domain *irq_domain_add_hierarchy(struct irq_domain *parent,
446 unsigned int flags,
447 unsigned int size,
448 struct device_node *node,
449 const struct irq_domain_ops *ops,
450 void *host_data)
451{
452 return irq_domain_create_hierarchy(parent, flags, size,
453 of_node_to_fwnode(node),
454 ops, host_data);
455}
456
457extern int __irq_domain_alloc_irqs(struct irq_domain *domain, int irq_base,
458 unsigned int nr_irqs, int node, void *arg,
459 bool realloc,
460 const struct irq_affinity_desc *affinity);
461extern void irq_domain_free_irqs(unsigned int virq, unsigned int nr_irqs);
462extern int irq_domain_activate_irq(struct irq_data *irq_data, bool early);
463extern void irq_domain_deactivate_irq(struct irq_data *irq_data);
464
465static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
466 unsigned int nr_irqs, int node, void *arg)
467{
468 return __irq_domain_alloc_irqs(domain, -1, nr_irqs, node, arg, false,
469 NULL);
470}
471
472extern int irq_domain_alloc_irqs_hierarchy(struct irq_domain *domain,
473 unsigned int irq_base,
474 unsigned int nr_irqs, void *arg);
475extern int irq_domain_set_hwirq_and_chip(struct irq_domain *domain,
476 unsigned int virq,
477 irq_hw_number_t hwirq,
478 struct irq_chip *chip,
479 void *chip_data);
480extern void irq_domain_reset_irq_data(struct irq_data *irq_data);
481extern void irq_domain_free_irqs_common(struct irq_domain *domain,
482 unsigned int virq,
483 unsigned int nr_irqs);
484extern void irq_domain_free_irqs_top(struct irq_domain *domain,
485 unsigned int virq, unsigned int nr_irqs);
486
487extern int irq_domain_push_irq(struct irq_domain *domain, int virq, void *arg);
488extern int irq_domain_pop_irq(struct irq_domain *domain, int virq);
489
490extern int irq_domain_alloc_irqs_parent(struct irq_domain *domain,
491 unsigned int irq_base,
492 unsigned int nr_irqs, void *arg);
493
494extern void irq_domain_free_irqs_parent(struct irq_domain *domain,
495 unsigned int irq_base,
496 unsigned int nr_irqs);
497
498static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
499{
500 return domain->flags & IRQ_DOMAIN_FLAG_HIERARCHY;
501}
502
503static inline bool irq_domain_is_ipi(struct irq_domain *domain)
504{
505 return domain->flags &
506 (IRQ_DOMAIN_FLAG_IPI_PER_CPU | IRQ_DOMAIN_FLAG_IPI_SINGLE);
507}
508
509static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
510{
511 return domain->flags & IRQ_DOMAIN_FLAG_IPI_PER_CPU;
512}
513
514static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
515{
516 return domain->flags & IRQ_DOMAIN_FLAG_IPI_SINGLE;
517}
518
519static inline bool irq_domain_is_msi(struct irq_domain *domain)
520{
521 return domain->flags & IRQ_DOMAIN_FLAG_MSI;
522}
523
524static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
525{
526 return domain->flags & IRQ_DOMAIN_FLAG_MSI_REMAP;
527}
528
529extern bool irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain);
530
531#else /* CONFIG_IRQ_DOMAIN_HIERARCHY */
532static inline int irq_domain_alloc_irqs(struct irq_domain *domain,
533 unsigned int nr_irqs, int node, void *arg)
534{
535 return -1;
536}
537
538static inline void irq_domain_free_irqs(unsigned int virq,
539 unsigned int nr_irqs) { }
540
541static inline bool irq_domain_is_hierarchy(struct irq_domain *domain)
542{
543 return false;
544}
545
546static inline bool irq_domain_is_ipi(struct irq_domain *domain)
547{
548 return false;
549}
550
551static inline bool irq_domain_is_ipi_per_cpu(struct irq_domain *domain)
552{
553 return false;
554}
555
556static inline bool irq_domain_is_ipi_single(struct irq_domain *domain)
557{
558 return false;
559}
560
561static inline bool irq_domain_is_msi(struct irq_domain *domain)
562{
563 return false;
564}
565
566static inline bool irq_domain_is_msi_remap(struct irq_domain *domain)
567{
568 return false;
569}
570
571static inline bool
572irq_domain_hierarchical_is_msi_remap(struct irq_domain *domain)
573{
574 return false;
575}
576#endif /* CONFIG_IRQ_DOMAIN_HIERARCHY */
577
578#else /* CONFIG_IRQ_DOMAIN */
579static inline void irq_dispose_mapping(unsigned int virq) { }
580static inline struct irq_domain *irq_find_matching_fwnode(
581 struct fwnode_handle *fwnode, enum irq_domain_bus_token bus_token)
582{
583 return NULL;
584}
585static inline bool irq_domain_check_msi_remap(void)
586{
587 return false;
588}
589#endif /* !CONFIG_IRQ_DOMAIN */
590
591#endif /* _LINUX_IRQDOMAIN_H */
592