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