]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/linux/irq.h
Merge branch 'akpm' (patches from Andrew)
[mirror_ubuntu-jammy-kernel.git] / include / linux / irq.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
06fcb0c6
IM
2#ifndef _LINUX_IRQ_H
3#define _LINUX_IRQ_H
1da177e4
LT
4
5/*
6 * Please do not include this file in generic code. There is currently
7 * no requirement for any architecture to implement anything held
8 * within this file.
9 *
10 * Thanks. --rmk
11 */
12
1da177e4
LT
13#include <linux/cache.h>
14#include <linux/spinlock.h>
15#include <linux/cpumask.h>
75ffc007 16#include <linux/irqhandler.h>
908dcecd 17#include <linux/irqreturn.h>
dd3a1db9 18#include <linux/irqnr.h>
503e5763 19#include <linux/topology.h>
332fd7c4 20#include <linux/io.h>
707188f5 21#include <linux/slab.h>
1da177e4
LT
22
23#include <asm/irq.h>
24#include <asm/ptrace.h>
7d12e780 25#include <asm/irq_regs.h>
1da177e4 26
ab7798ff 27struct seq_file;
ec53cf23 28struct module;
515085ef 29struct msi_msg;
bec04037 30struct irq_affinity_desc;
1b7047ed 31enum irqchip_irq_state;
57a58a94 32
1da177e4
LT
33/*
34 * IRQ line status.
6e213616 35 *
5d4d8fc9
TG
36 * Bits 0-7 are the same as the IRQF_* bits in linux/interrupt.h
37 *
38 * IRQ_TYPE_NONE - default, unspecified type
39 * IRQ_TYPE_EDGE_RISING - rising edge triggered
40 * IRQ_TYPE_EDGE_FALLING - falling edge triggered
41 * IRQ_TYPE_EDGE_BOTH - rising and falling edge triggered
42 * IRQ_TYPE_LEVEL_HIGH - high level triggered
43 * IRQ_TYPE_LEVEL_LOW - low level triggered
44 * IRQ_TYPE_LEVEL_MASK - Mask to filter out the level bits
45 * IRQ_TYPE_SENSE_MASK - Mask for all the above bits
3fca40c7
BH
46 * IRQ_TYPE_DEFAULT - For use by some PICs to ask irq_set_type
47 * to setup the HW to a sane default (used
48 * by irqdomain map() callbacks to synchronize
49 * the HW state and SW flags for a newly
50 * allocated descriptor).
51 *
5d4d8fc9
TG
52 * IRQ_TYPE_PROBE - Special flag for probing in progress
53 *
54 * Bits which can be modified via irq_set/clear/modify_status_flags()
55 * IRQ_LEVEL - Interrupt is level type. Will be also
56 * updated in the code when the above trigger
0911f124 57 * bits are modified via irq_set_irq_type()
5d4d8fc9
TG
58 * IRQ_PER_CPU - Mark an interrupt PER_CPU. Will protect
59 * it from affinity setting
60 * IRQ_NOPROBE - Interrupt cannot be probed by autoprobing
61 * IRQ_NOREQUEST - Interrupt cannot be requested via
62 * request_irq()
7f1b1244 63 * IRQ_NOTHREAD - Interrupt cannot be threaded
5d4d8fc9
TG
64 * IRQ_NOAUTOEN - Interrupt is not automatically enabled in
65 * request/setup_irq()
66 * IRQ_NO_BALANCING - Interrupt cannot be balanced (affinity set)
67 * IRQ_MOVE_PCNTXT - Interrupt can be migrated from process context
92068d17 68 * IRQ_NESTED_THREAD - Interrupt nests into another thread
31d9d9b6 69 * IRQ_PER_CPU_DEVID - Dev_id is a per-cpu variable
b39898cd
TG
70 * IRQ_IS_POLLED - Always polled by another interrupt. Exclude
71 * it from the spurious interrupt detection
72 * mechanism and from core side polling.
e9849777 73 * IRQ_DISABLE_UNLAZY - Disable lazy irq disable
1da177e4 74 */
5d4d8fc9
TG
75enum {
76 IRQ_TYPE_NONE = 0x00000000,
77 IRQ_TYPE_EDGE_RISING = 0x00000001,
78 IRQ_TYPE_EDGE_FALLING = 0x00000002,
79 IRQ_TYPE_EDGE_BOTH = (IRQ_TYPE_EDGE_FALLING | IRQ_TYPE_EDGE_RISING),
80 IRQ_TYPE_LEVEL_HIGH = 0x00000004,
81 IRQ_TYPE_LEVEL_LOW = 0x00000008,
82 IRQ_TYPE_LEVEL_MASK = (IRQ_TYPE_LEVEL_LOW | IRQ_TYPE_LEVEL_HIGH),
83 IRQ_TYPE_SENSE_MASK = 0x0000000f,
3fca40c7 84 IRQ_TYPE_DEFAULT = IRQ_TYPE_SENSE_MASK,
5d4d8fc9
TG
85
86 IRQ_TYPE_PROBE = 0x00000010,
87
88 IRQ_LEVEL = (1 << 8),
89 IRQ_PER_CPU = (1 << 9),
90 IRQ_NOPROBE = (1 << 10),
91 IRQ_NOREQUEST = (1 << 11),
92 IRQ_NOAUTOEN = (1 << 12),
93 IRQ_NO_BALANCING = (1 << 13),
94 IRQ_MOVE_PCNTXT = (1 << 14),
95 IRQ_NESTED_THREAD = (1 << 15),
7f1b1244 96 IRQ_NOTHREAD = (1 << 16),
31d9d9b6 97 IRQ_PER_CPU_DEVID = (1 << 17),
b39898cd 98 IRQ_IS_POLLED = (1 << 18),
e9849777 99 IRQ_DISABLE_UNLAZY = (1 << 19),
5d4d8fc9 100};
950f4427 101
44247184
TG
102#define IRQF_MODIFY_MASK \
103 (IRQ_TYPE_SENSE_MASK | IRQ_NOPROBE | IRQ_NOREQUEST | \
872434d6 104 IRQ_NOAUTOEN | IRQ_MOVE_PCNTXT | IRQ_LEVEL | IRQ_NO_BALANCING | \
b39898cd 105 IRQ_PER_CPU | IRQ_NESTED_THREAD | IRQ_NOTHREAD | IRQ_PER_CPU_DEVID | \
e9849777 106 IRQ_IS_POLLED | IRQ_DISABLE_UNLAZY)
44247184 107
8f53f924
TG
108#define IRQ_NO_BALANCING_MASK (IRQ_PER_CPU | IRQ_NO_BALANCING)
109
3b8249e7
TG
110/*
111 * Return value for chip->irq_set_affinity()
112 *
9df872fa
JL
113 * IRQ_SET_MASK_OK - OK, core updates irq_common_data.affinity
114 * IRQ_SET_MASK_NOCPY - OK, chip did update irq_common_data.affinity
2cb62547
JL
115 * IRQ_SET_MASK_OK_DONE - Same as IRQ_SET_MASK_OK for core. Special code to
116 * support stacked irqchips, which indicates skipping
117 * all descendent irqchips.
3b8249e7
TG
118 */
119enum {
120 IRQ_SET_MASK_OK = 0,
121 IRQ_SET_MASK_OK_NOCOPY,
2cb62547 122 IRQ_SET_MASK_OK_DONE,
3b8249e7
TG
123};
124
5b912c10 125struct msi_desc;
08a543ad 126struct irq_domain;
6a6de9ef 127
ff7dcd44 128/**
0d0b4c86
JL
129 * struct irq_common_data - per irq data shared by all irqchips
130 * @state_use_accessors: status information for irq chip functions.
131 * Use accessor functions to deal with it
449e9cae 132 * @node: node index useful for balancing
af7080e0 133 * @handler_data: per-IRQ data for the irq_chip methods
955bfe59
QY
134 * @affinity: IRQ affinity on SMP. If this is an IPI
135 * related irq, then this is the mask of the
136 * CPUs to which an IPI can be sent.
0d3f5425
TG
137 * @effective_affinity: The effective IRQ affinity on SMP as some irq
138 * chips do not allow multi CPU destinations.
139 * A subset of @affinity.
b237721c 140 * @msi_desc: MSI descriptor
f256c9a0 141 * @ipi_offset: Offset of first IPI target cpu in @affinity. Optional.
0d0b4c86
JL
142 */
143struct irq_common_data {
b354286e 144 unsigned int __private state_use_accessors;
449e9cae
JL
145#ifdef CONFIG_NUMA
146 unsigned int node;
147#endif
af7080e0 148 void *handler_data;
b237721c 149 struct msi_desc *msi_desc;
9df872fa 150 cpumask_var_t affinity;
0d3f5425
TG
151#ifdef CONFIG_GENERIC_IRQ_EFFECTIVE_AFF_MASK
152 cpumask_var_t effective_affinity;
153#endif
f256c9a0
QY
154#ifdef CONFIG_GENERIC_IRQ_IPI
155 unsigned int ipi_offset;
156#endif
0d0b4c86
JL
157};
158
159/**
160 * struct irq_data - per irq chip data passed down to chip functions
966dc736 161 * @mask: precomputed bitmask for accessing the chip registers
ff7dcd44 162 * @irq: interrupt number
08a543ad 163 * @hwirq: hardware interrupt number, local to the interrupt domain
0d0b4c86 164 * @common: point to data shared by all irqchips
ff7dcd44 165 * @chip: low level interrupt hardware access
08a543ad
GL
166 * @domain: Interrupt translation domain; responsible for mapping
167 * between hwirq number and linux irq number.
f8264e34
JL
168 * @parent_data: pointer to parent struct irq_data to support hierarchy
169 * irq_domain
ff7dcd44
TG
170 * @chip_data: platform-specific per-chip private data for the chip
171 * methods, to allow shared chip implementations
ff7dcd44
TG
172 */
173struct irq_data {
966dc736 174 u32 mask;
ff7dcd44 175 unsigned int irq;
08a543ad 176 unsigned long hwirq;
0d0b4c86 177 struct irq_common_data *common;
ff7dcd44 178 struct irq_chip *chip;
08a543ad 179 struct irq_domain *domain;
f8264e34
JL
180#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
181 struct irq_data *parent_data;
182#endif
ff7dcd44 183 void *chip_data;
ff7dcd44
TG
184};
185
f230b6d5 186/*
0d0b4c86 187 * Bit masks for irq_common_data.state_use_accessors
f230b6d5 188 *
876dbd4c 189 * IRQD_TRIGGER_MASK - Mask for the trigger type bits
f230b6d5 190 * IRQD_SETAFFINITY_PENDING - Affinity setting is pending
08d85f3e 191 * IRQD_ACTIVATED - Interrupt has already been activated
a005677b
TG
192 * IRQD_NO_BALANCING - Balancing disabled for this IRQ
193 * IRQD_PER_CPU - Interrupt is per cpu
2bdd1055 194 * IRQD_AFFINITY_SET - Interrupt affinity was set
876dbd4c 195 * IRQD_LEVEL - Interrupt is level triggered
7f94226f
TG
196 * IRQD_WAKEUP_STATE - Interrupt is configured for wakeup
197 * from suspend
551417af 198 * IRQD_MOVE_PCNTXT - Interrupt can be moved in process
e1ef8241 199 * context
32f4125e
TG
200 * IRQD_IRQ_DISABLED - Disabled state of the interrupt
201 * IRQD_IRQ_MASKED - Masked state of the interrupt
202 * IRQD_IRQ_INPROGRESS - In progress state of the interrupt
b76f1674 203 * IRQD_WAKEUP_ARMED - Wakeup mode armed
fc569712 204 * IRQD_FORWARDED_TO_VCPU - The interrupt is forwarded to a VCPU
9c255583 205 * IRQD_AFFINITY_MANAGED - Affinity is auto-managed by the kernel
1bb04016 206 * IRQD_IRQ_STARTED - Startup state of the interrupt
54fdf6a0
TG
207 * IRQD_MANAGED_SHUTDOWN - Interrupt was shutdown due to empty affinity
208 * mask. Applies only to affinity managed irqs.
d52dd441 209 * IRQD_SINGLE_TARGET - IRQ allows only a single affinity target
4f8413a3 210 * IRQD_DEFAULT_TRIGGER_SET - Expected trigger already been set
69790ba9 211 * IRQD_CAN_RESERVE - Can use reservation mode
f230b6d5
TG
212 */
213enum {
876dbd4c 214 IRQD_TRIGGER_MASK = 0xf,
a005677b 215 IRQD_SETAFFINITY_PENDING = (1 << 8),
08d85f3e 216 IRQD_ACTIVATED = (1 << 9),
a005677b
TG
217 IRQD_NO_BALANCING = (1 << 10),
218 IRQD_PER_CPU = (1 << 11),
2bdd1055 219 IRQD_AFFINITY_SET = (1 << 12),
876dbd4c 220 IRQD_LEVEL = (1 << 13),
7f94226f 221 IRQD_WAKEUP_STATE = (1 << 14),
e1ef8241 222 IRQD_MOVE_PCNTXT = (1 << 15),
801a0e9a 223 IRQD_IRQ_DISABLED = (1 << 16),
32f4125e
TG
224 IRQD_IRQ_MASKED = (1 << 17),
225 IRQD_IRQ_INPROGRESS = (1 << 18),
b76f1674 226 IRQD_WAKEUP_ARMED = (1 << 19),
fc569712 227 IRQD_FORWARDED_TO_VCPU = (1 << 20),
9c255583 228 IRQD_AFFINITY_MANAGED = (1 << 21),
201d7f47 229 IRQD_IRQ_STARTED = (1 << 22),
54fdf6a0 230 IRQD_MANAGED_SHUTDOWN = (1 << 23),
d52dd441 231 IRQD_SINGLE_TARGET = (1 << 24),
4f8413a3 232 IRQD_DEFAULT_TRIGGER_SET = (1 << 25),
69790ba9 233 IRQD_CAN_RESERVE = (1 << 26),
f230b6d5
TG
234};
235
b354286e 236#define __irqd_to_state(d) ACCESS_PRIVATE((d)->common, state_use_accessors)
0d0b4c86 237
f230b6d5
TG
238static inline bool irqd_is_setaffinity_pending(struct irq_data *d)
239{
0d0b4c86 240 return __irqd_to_state(d) & IRQD_SETAFFINITY_PENDING;
f230b6d5
TG
241}
242
a005677b
TG
243static inline bool irqd_is_per_cpu(struct irq_data *d)
244{
0d0b4c86 245 return __irqd_to_state(d) & IRQD_PER_CPU;
a005677b
TG
246}
247
248static inline bool irqd_can_balance(struct irq_data *d)
249{
0d0b4c86 250 return !(__irqd_to_state(d) & (IRQD_PER_CPU | IRQD_NO_BALANCING));
a005677b
TG
251}
252
2bdd1055
TG
253static inline bool irqd_affinity_was_set(struct irq_data *d)
254{
0d0b4c86 255 return __irqd_to_state(d) & IRQD_AFFINITY_SET;
2bdd1055
TG
256}
257
ee38c04b
TG
258static inline void irqd_mark_affinity_was_set(struct irq_data *d)
259{
0d0b4c86 260 __irqd_to_state(d) |= IRQD_AFFINITY_SET;
ee38c04b
TG
261}
262
4f8413a3
MZ
263static inline bool irqd_trigger_type_was_set(struct irq_data *d)
264{
265 return __irqd_to_state(d) & IRQD_DEFAULT_TRIGGER_SET;
266}
267
876dbd4c
TG
268static inline u32 irqd_get_trigger_type(struct irq_data *d)
269{
0d0b4c86 270 return __irqd_to_state(d) & IRQD_TRIGGER_MASK;
876dbd4c
TG
271}
272
273/*
4f8413a3
MZ
274 * Must only be called inside irq_chip.irq_set_type() functions or
275 * from the DT/ACPI setup code.
876dbd4c
TG
276 */
277static inline void irqd_set_trigger_type(struct irq_data *d, u32 type)
278{
0d0b4c86
JL
279 __irqd_to_state(d) &= ~IRQD_TRIGGER_MASK;
280 __irqd_to_state(d) |= type & IRQD_TRIGGER_MASK;
4f8413a3 281 __irqd_to_state(d) |= IRQD_DEFAULT_TRIGGER_SET;
876dbd4c
TG
282}
283
284static inline bool irqd_is_level_type(struct irq_data *d)
285{
0d0b4c86 286 return __irqd_to_state(d) & IRQD_LEVEL;
876dbd4c
TG
287}
288
d52dd441
TG
289/*
290 * Must only be called of irqchip.irq_set_affinity() or low level
291 * hieararchy domain allocation functions.
292 */
293static inline void irqd_set_single_target(struct irq_data *d)
294{
295 __irqd_to_state(d) |= IRQD_SINGLE_TARGET;
296}
297
298static inline bool irqd_is_single_target(struct irq_data *d)
299{
300 return __irqd_to_state(d) & IRQD_SINGLE_TARGET;
301}
302
7f94226f
TG
303static inline bool irqd_is_wakeup_set(struct irq_data *d)
304{
0d0b4c86 305 return __irqd_to_state(d) & IRQD_WAKEUP_STATE;
7f94226f
TG
306}
307
e1ef8241
TG
308static inline bool irqd_can_move_in_process_context(struct irq_data *d)
309{
0d0b4c86 310 return __irqd_to_state(d) & IRQD_MOVE_PCNTXT;
e1ef8241
TG
311}
312
801a0e9a
TG
313static inline bool irqd_irq_disabled(struct irq_data *d)
314{
0d0b4c86 315 return __irqd_to_state(d) & IRQD_IRQ_DISABLED;
801a0e9a
TG
316}
317
32f4125e
TG
318static inline bool irqd_irq_masked(struct irq_data *d)
319{
0d0b4c86 320 return __irqd_to_state(d) & IRQD_IRQ_MASKED;
32f4125e
TG
321}
322
323static inline bool irqd_irq_inprogress(struct irq_data *d)
324{
0d0b4c86 325 return __irqd_to_state(d) & IRQD_IRQ_INPROGRESS;
32f4125e
TG
326}
327
b76f1674
TG
328static inline bool irqd_is_wakeup_armed(struct irq_data *d)
329{
0d0b4c86 330 return __irqd_to_state(d) & IRQD_WAKEUP_ARMED;
b76f1674
TG
331}
332
fc569712
TG
333static inline bool irqd_is_forwarded_to_vcpu(struct irq_data *d)
334{
335 return __irqd_to_state(d) & IRQD_FORWARDED_TO_VCPU;
336}
337
338static inline void irqd_set_forwarded_to_vcpu(struct irq_data *d)
339{
340 __irqd_to_state(d) |= IRQD_FORWARDED_TO_VCPU;
341}
342
343static inline void irqd_clr_forwarded_to_vcpu(struct irq_data *d)
344{
345 __irqd_to_state(d) &= ~IRQD_FORWARDED_TO_VCPU;
346}
b76f1674 347
9c255583
TG
348static inline bool irqd_affinity_is_managed(struct irq_data *d)
349{
350 return __irqd_to_state(d) & IRQD_AFFINITY_MANAGED;
351}
352
08d85f3e
MZ
353static inline bool irqd_is_activated(struct irq_data *d)
354{
355 return __irqd_to_state(d) & IRQD_ACTIVATED;
356}
357
358static inline void irqd_set_activated(struct irq_data *d)
359{
360 __irqd_to_state(d) |= IRQD_ACTIVATED;
361}
362
363static inline void irqd_clr_activated(struct irq_data *d)
364{
365 __irqd_to_state(d) &= ~IRQD_ACTIVATED;
366}
367
201d7f47
TG
368static inline bool irqd_is_started(struct irq_data *d)
369{
370 return __irqd_to_state(d) & IRQD_IRQ_STARTED;
371}
372
761ea388 373static inline bool irqd_is_managed_and_shutdown(struct irq_data *d)
54fdf6a0
TG
374{
375 return __irqd_to_state(d) & IRQD_MANAGED_SHUTDOWN;
376}
377
69790ba9
TG
378static inline void irqd_set_can_reserve(struct irq_data *d)
379{
380 __irqd_to_state(d) |= IRQD_CAN_RESERVE;
381}
382
383static inline void irqd_clr_can_reserve(struct irq_data *d)
384{
385 __irqd_to_state(d) &= ~IRQD_CAN_RESERVE;
386}
387
388static inline bool irqd_can_reserve(struct irq_data *d)
389{
390 return __irqd_to_state(d) & IRQD_CAN_RESERVE;
391}
392
b354286e
BF
393#undef __irqd_to_state
394
a699e4e4
GL
395static inline irq_hw_number_t irqd_to_hwirq(struct irq_data *d)
396{
397 return d->hwirq;
398}
399
8fee5c36 400/**
6a6de9ef 401 * struct irq_chip - hardware interrupt chip descriptor
8fee5c36 402 *
be45beb2 403 * @parent_device: pointer to parent device for irqchip
8fee5c36 404 * @name: name for /proc/interrupts
f8822657
TG
405 * @irq_startup: start up the interrupt (defaults to ->enable if NULL)
406 * @irq_shutdown: shut down the interrupt (defaults to ->disable if NULL)
407 * @irq_enable: enable the interrupt (defaults to chip->unmask if NULL)
408 * @irq_disable: disable the interrupt
409 * @irq_ack: start of a new interrupt
410 * @irq_mask: mask an interrupt source
411 * @irq_mask_ack: ack and mask an interrupt source
412 * @irq_unmask: unmask an interrupt source
413 * @irq_eoi: end of interrupt
83979133
TG
414 * @irq_set_affinity: Set the CPU affinity on SMP machines. If the force
415 * argument is true, it tells the driver to
416 * unconditionally apply the affinity setting. Sanity
417 * checks against the supplied affinity mask are not
418 * required. This is used for CPU hotplug where the
419 * target CPU is not yet set in the cpu_online_mask.
f8822657
TG
420 * @irq_retrigger: resend an IRQ to the CPU
421 * @irq_set_type: set the flow type (IRQ_TYPE_LEVEL/etc.) of an IRQ
422 * @irq_set_wake: enable/disable power-management wake-on of an IRQ
423 * @irq_bus_lock: function to lock access to slow bus (i2c) chips
424 * @irq_bus_sync_unlock:function to sync and unlock slow bus (i2c) chips
0fdb4b25
DD
425 * @irq_cpu_online: configure an interrupt source for a secondary CPU
426 * @irq_cpu_offline: un-configure an interrupt source for a secondary CPU
be9b22b6
BN
427 * @irq_suspend: function called from core code on suspend once per
428 * chip, when one or more interrupts are installed
429 * @irq_resume: function called from core code on resume once per chip,
430 * when one ore more interrupts are installed
cfefd21e 431 * @irq_pm_shutdown: function called from core code on shutdown once per chip
d0051816 432 * @irq_calc_mask: Optional function to set irq_data.mask for special cases
ab7798ff 433 * @irq_print_chip: optional to print special chip info in show_interrupts
c1bacbae
TG
434 * @irq_request_resources: optional to request resources before calling
435 * any other callback related to this irq
436 * @irq_release_resources: optional to release resources acquired with
437 * irq_request_resources
515085ef 438 * @irq_compose_msi_msg: optional to compose message content for MSI
9dde55b7 439 * @irq_write_msi_msg: optional to write message content for MSI
1b7047ed
MZ
440 * @irq_get_irqchip_state: return the internal state of an interrupt
441 * @irq_set_irqchip_state: set the internal state of a interrupt
0a4377de 442 * @irq_set_vcpu_affinity: optional to target a vCPU in a virtual machine
34dc1ae1
QY
443 * @ipi_send_single: send a single IPI to destination cpus
444 * @ipi_send_mask: send an IPI to destination cpus in cpumask
b525903c
JT
445 * @irq_nmi_setup: function called from core code before enabling an NMI
446 * @irq_nmi_teardown: function called from core code after disabling an NMI
2bff17ad 447 * @flags: chip specific flags
1da177e4 448 */
6a6de9ef 449struct irq_chip {
be45beb2 450 struct device *parent_device;
6a6de9ef 451 const char *name;
f8822657
TG
452 unsigned int (*irq_startup)(struct irq_data *data);
453 void (*irq_shutdown)(struct irq_data *data);
454 void (*irq_enable)(struct irq_data *data);
455 void (*irq_disable)(struct irq_data *data);
456
457 void (*irq_ack)(struct irq_data *data);
458 void (*irq_mask)(struct irq_data *data);
459 void (*irq_mask_ack)(struct irq_data *data);
460 void (*irq_unmask)(struct irq_data *data);
461 void (*irq_eoi)(struct irq_data *data);
462
463 int (*irq_set_affinity)(struct irq_data *data, const struct cpumask *dest, bool force);
464 int (*irq_retrigger)(struct irq_data *data);
465 int (*irq_set_type)(struct irq_data *data, unsigned int flow_type);
466 int (*irq_set_wake)(struct irq_data *data, unsigned int on);
467
468 void (*irq_bus_lock)(struct irq_data *data);
469 void (*irq_bus_sync_unlock)(struct irq_data *data);
470
0fdb4b25
DD
471 void (*irq_cpu_online)(struct irq_data *data);
472 void (*irq_cpu_offline)(struct irq_data *data);
473
cfefd21e
TG
474 void (*irq_suspend)(struct irq_data *data);
475 void (*irq_resume)(struct irq_data *data);
476 void (*irq_pm_shutdown)(struct irq_data *data);
477
d0051816
TG
478 void (*irq_calc_mask)(struct irq_data *data);
479
ab7798ff 480 void (*irq_print_chip)(struct irq_data *data, struct seq_file *p);
c1bacbae
TG
481 int (*irq_request_resources)(struct irq_data *data);
482 void (*irq_release_resources)(struct irq_data *data);
ab7798ff 483
515085ef 484 void (*irq_compose_msi_msg)(struct irq_data *data, struct msi_msg *msg);
9dde55b7 485 void (*irq_write_msi_msg)(struct irq_data *data, struct msi_msg *msg);
515085ef 486
1b7047ed
MZ
487 int (*irq_get_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool *state);
488 int (*irq_set_irqchip_state)(struct irq_data *data, enum irqchip_irq_state which, bool state);
489
0a4377de
JL
490 int (*irq_set_vcpu_affinity)(struct irq_data *data, void *vcpu_info);
491
34dc1ae1
QY
492 void (*ipi_send_single)(struct irq_data *data, unsigned int cpu);
493 void (*ipi_send_mask)(struct irq_data *data, const struct cpumask *dest);
494
b525903c
JT
495 int (*irq_nmi_setup)(struct irq_data *data);
496 void (*irq_nmi_teardown)(struct irq_data *data);
497
2bff17ad 498 unsigned long flags;
1da177e4
LT
499};
500
d4d5e089
TG
501/*
502 * irq_chip specific flags
503 *
77694b40
TG
504 * IRQCHIP_SET_TYPE_MASKED: Mask before calling chip.irq_set_type()
505 * IRQCHIP_EOI_IF_HANDLED: Only issue irq_eoi() when irq was handled
d209a699 506 * IRQCHIP_MASK_ON_SUSPEND: Mask non wake irqs in the suspend path
b3d42232
TG
507 * IRQCHIP_ONOFFLINE_ENABLED: Only call irq_on/off_line callbacks
508 * when irq enabled
60f96b41 509 * IRQCHIP_SKIP_SET_WAKE: Skip chip.irq_set_wake(), for this irq chip
4f6e4f71 510 * IRQCHIP_ONESHOT_SAFE: One shot does not require mask/unmask
328a4978 511 * IRQCHIP_EOI_THREADED: Chip requires eoi() on unmask in threaded mode
72a8edc2 512 * IRQCHIP_SUPPORTS_LEVEL_MSI Chip can provide two doorbells for Level MSIs
b525903c 513 * IRQCHIP_SUPPORTS_NMI: Chip can deliver NMIs, only for root irqchips
d4d5e089
TG
514 */
515enum {
516 IRQCHIP_SET_TYPE_MASKED = (1 << 0),
77694b40 517 IRQCHIP_EOI_IF_HANDLED = (1 << 1),
d209a699 518 IRQCHIP_MASK_ON_SUSPEND = (1 << 2),
b3d42232 519 IRQCHIP_ONOFFLINE_ENABLED = (1 << 3),
60f96b41 520 IRQCHIP_SKIP_SET_WAKE = (1 << 4),
dc9b229a 521 IRQCHIP_ONESHOT_SAFE = (1 << 5),
328a4978 522 IRQCHIP_EOI_THREADED = (1 << 6),
6988e0e0 523 IRQCHIP_SUPPORTS_LEVEL_MSI = (1 << 7),
b525903c 524 IRQCHIP_SUPPORTS_NMI = (1 << 8),
d4d5e089
TG
525};
526
e144710b 527#include <linux/irqdesc.h>
0b8f1efa 528
34ffdb72
IM
529/*
530 * Pick up the arch-dependent methods:
531 */
532#include <asm/hw_irq.h>
1da177e4 533
b683de2b
TG
534#ifndef NR_IRQS_LEGACY
535# define NR_IRQS_LEGACY 0
536#endif
537
1318a481
TG
538#ifndef ARCH_IRQ_INIT_FLAGS
539# define ARCH_IRQ_INIT_FLAGS 0
540#endif
541
c1594b77 542#define IRQ_DEFAULT_INIT_FLAGS ARCH_IRQ_INIT_FLAGS
1318a481 543
e144710b 544struct irqaction;
06fcb0c6 545extern int setup_irq(unsigned int irq, struct irqaction *new);
cbf94f06 546extern void remove_irq(unsigned int irq, struct irqaction *act);
31d9d9b6
MZ
547extern int setup_percpu_irq(unsigned int irq, struct irqaction *new);
548extern void remove_percpu_irq(unsigned int irq, struct irqaction *act);
1da177e4 549
0fdb4b25
DD
550extern void irq_cpu_online(void);
551extern void irq_cpu_offline(void);
01f8fa4f
TG
552extern int irq_set_affinity_locked(struct irq_data *data,
553 const struct cpumask *cpumask, bool force);
0a4377de 554extern int irq_set_vcpu_affinity(unsigned int irq, void *vcpu_info);
0fdb4b25 555
c5cb83bb 556#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_IRQ_MIGRATION)
f1e0bb0a 557extern void irq_migrate_all_off_this_cpu(void);
c5cb83bb
TG
558extern int irq_affinity_online_cpu(unsigned int cpu);
559#else
560# define irq_affinity_online_cpu NULL
561#endif
f1e0bb0a 562
3a3856d0 563#if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_PENDING_IRQ)
d340ebd6
TG
564void __irq_move_irq(struct irq_data *data);
565static inline void irq_move_irq(struct irq_data *data)
566{
567 if (unlikely(irqd_is_setaffinity_pending(data)))
568 __irq_move_irq(data);
569}
a439520f 570void irq_move_masked_irq(struct irq_data *data);
f0383c24 571void irq_force_complete_move(struct irq_desc *desc);
e144710b 572#else
a439520f
TG
573static inline void irq_move_irq(struct irq_data *data) { }
574static inline void irq_move_masked_irq(struct irq_data *data) { }
f0383c24 575static inline void irq_force_complete_move(struct irq_desc *desc) { }
e144710b 576#endif
54d5d424 577
1da177e4 578extern int no_irq_affinity;
1da177e4 579
293a7a0a
TG
580#ifdef CONFIG_HARDIRQS_SW_RESEND
581int irq_set_parent(int irq, int parent_irq);
582#else
583static inline int irq_set_parent(int irq, int parent_irq)
584{
585 return 0;
586}
587#endif
588
6a6de9ef
TG
589/*
590 * Built-in IRQ handlers for various IRQ types,
bebd04cc 591 * callable via desc->handle_irq()
6a6de9ef 592 */
bd0b9ac4
TG
593extern void handle_level_irq(struct irq_desc *desc);
594extern void handle_fasteoi_irq(struct irq_desc *desc);
595extern void handle_edge_irq(struct irq_desc *desc);
596extern void handle_edge_eoi_irq(struct irq_desc *desc);
597extern void handle_simple_irq(struct irq_desc *desc);
edd14cfe 598extern void handle_untracked_irq(struct irq_desc *desc);
bd0b9ac4
TG
599extern void handle_percpu_irq(struct irq_desc *desc);
600extern void handle_percpu_devid_irq(struct irq_desc *desc);
601extern void handle_bad_irq(struct irq_desc *desc);
31b47cf7 602extern void handle_nested_irq(unsigned int irq);
6a6de9ef 603
2dcf1fbc
JT
604extern void handle_fasteoi_nmi(struct irq_desc *desc);
605extern void handle_percpu_devid_fasteoi_nmi(struct irq_desc *desc);
606
515085ef 607extern int irq_chip_compose_msi_msg(struct irq_data *data, struct msi_msg *msg);
be45beb2
JH
608extern int irq_chip_pm_get(struct irq_data *data);
609extern int irq_chip_pm_put(struct irq_data *data);
85f08c17 610#ifdef CONFIG_IRQ_DOMAIN_HIERARCHY
7703b08c
DD
611extern void handle_fasteoi_ack_irq(struct irq_desc *desc);
612extern void handle_fasteoi_mask_irq(struct irq_desc *desc);
3cfeffc2
SA
613extern void irq_chip_enable_parent(struct irq_data *data);
614extern void irq_chip_disable_parent(struct irq_data *data);
85f08c17
JL
615extern void irq_chip_ack_parent(struct irq_data *data);
616extern int irq_chip_retrigger_hierarchy(struct irq_data *data);
56e8abab 617extern void irq_chip_mask_parent(struct irq_data *data);
5aa5bd56 618extern void irq_chip_mask_ack_parent(struct irq_data *data);
56e8abab
YC
619extern void irq_chip_unmask_parent(struct irq_data *data);
620extern void irq_chip_eoi_parent(struct irq_data *data);
621extern int irq_chip_set_affinity_parent(struct irq_data *data,
622 const struct cpumask *dest,
623 bool force);
08b55e2a 624extern int irq_chip_set_wake_parent(struct irq_data *data, unsigned int on);
0a4377de
JL
625extern int irq_chip_set_vcpu_affinity_parent(struct irq_data *data,
626 void *vcpu_info);
b7560de1 627extern int irq_chip_set_type_parent(struct irq_data *data, unsigned int type);
2bd1298a
LV
628extern int irq_chip_request_resources_parent(struct irq_data *data);
629extern void irq_chip_release_resources_parent(struct irq_data *data);
85f08c17
JL
630#endif
631
6a6de9ef 632/* Handling of unhandled and spurious interrupts: */
0dcdbc97 633extern void note_interrupt(struct irq_desc *desc, irqreturn_t action_ret);
1da177e4 634
a4633adc 635
6a6de9ef
TG
636/* Enable/disable irq debugging output: */
637extern int noirqdebug_setup(char *str);
638
639/* Checks whether the interrupt can be requested by request_irq(): */
640extern int can_request_irq(unsigned int irq, unsigned long irqflags);
641
f8b5473f 642/* Dummy irq-chip implementations: */
6a6de9ef 643extern struct irq_chip no_irq_chip;
f8b5473f 644extern struct irq_chip dummy_irq_chip;
6a6de9ef 645
145fc655 646extern void
3836ca08 647irq_set_chip_and_handler_name(unsigned int irq, struct irq_chip *chip,
a460e745
IM
648 irq_flow_handler_t handle, const char *name);
649
3836ca08
TG
650static inline void irq_set_chip_and_handler(unsigned int irq, struct irq_chip *chip,
651 irq_flow_handler_t handle)
652{
653 irq_set_chip_and_handler_name(irq, chip, handle, NULL);
654}
655
31d9d9b6 656extern int irq_set_percpu_devid(unsigned int irq);
222df54f
MZ
657extern int irq_set_percpu_devid_partition(unsigned int irq,
658 const struct cpumask *affinity);
659extern int irq_get_percpu_devid_partition(unsigned int irq,
660 struct cpumask *affinity);
31d9d9b6 661
6a6de9ef 662extern void
3836ca08 663__irq_set_handler(unsigned int irq, irq_flow_handler_t handle, int is_chained,
a460e745 664 const char *name);
1da177e4 665
6a6de9ef 666static inline void
3836ca08 667irq_set_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef 668{
3836ca08 669 __irq_set_handler(irq, handle, 0, NULL);
6a6de9ef
TG
670}
671
672/*
673 * Set a highlevel chained flow handler for a given IRQ.
674 * (a chained handler is automatically enabled and set to
7f1b1244 675 * IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
6a6de9ef
TG
676 */
677static inline void
3836ca08 678irq_set_chained_handler(unsigned int irq, irq_flow_handler_t handle)
6a6de9ef 679{
3836ca08 680 __irq_set_handler(irq, handle, 1, NULL);
6a6de9ef
TG
681}
682
3b0f95be
RK
683/*
684 * Set a highlevel chained flow handler and its data for a given IRQ.
685 * (a chained handler is automatically enabled and set to
686 * IRQ_NOREQUEST, IRQ_NOPROBE, and IRQ_NOTHREAD)
687 */
688void
689irq_set_chained_handler_and_data(unsigned int irq, irq_flow_handler_t handle,
690 void *data);
691
44247184
TG
692void irq_modify_status(unsigned int irq, unsigned long clr, unsigned long set);
693
694static inline void irq_set_status_flags(unsigned int irq, unsigned long set)
695{
696 irq_modify_status(irq, 0, set);
697}
698
699static inline void irq_clear_status_flags(unsigned int irq, unsigned long clr)
700{
701 irq_modify_status(irq, clr, 0);
702}
703
a0cd9ca2 704static inline void irq_set_noprobe(unsigned int irq)
44247184
TG
705{
706 irq_modify_status(irq, 0, IRQ_NOPROBE);
707}
708
a0cd9ca2 709static inline void irq_set_probe(unsigned int irq)
44247184
TG
710{
711 irq_modify_status(irq, IRQ_NOPROBE, 0);
712}
46f4f8f6 713
7f1b1244
PM
714static inline void irq_set_nothread(unsigned int irq)
715{
716 irq_modify_status(irq, 0, IRQ_NOTHREAD);
717}
718
719static inline void irq_set_thread(unsigned int irq)
720{
721 irq_modify_status(irq, IRQ_NOTHREAD, 0);
722}
723
6f91a52d
TG
724static inline void irq_set_nested_thread(unsigned int irq, bool nest)
725{
726 if (nest)
727 irq_set_status_flags(irq, IRQ_NESTED_THREAD);
728 else
729 irq_clear_status_flags(irq, IRQ_NESTED_THREAD);
730}
731
31d9d9b6
MZ
732static inline void irq_set_percpu_devid_flags(unsigned int irq)
733{
734 irq_set_status_flags(irq,
735 IRQ_NOAUTOEN | IRQ_PER_CPU | IRQ_NOTHREAD |
736 IRQ_NOPROBE | IRQ_PER_CPU_DEVID);
737}
738
3a16d713 739/* Set/get chip/data for an IRQ: */
a0cd9ca2
TG
740extern int irq_set_chip(unsigned int irq, struct irq_chip *chip);
741extern int irq_set_handler_data(unsigned int irq, void *data);
742extern int irq_set_chip_data(unsigned int irq, void *data);
743extern int irq_set_irq_type(unsigned int irq, unsigned int type);
744extern int irq_set_msi_desc(unsigned int irq, struct msi_desc *entry);
51906e77
AG
745extern int irq_set_msi_desc_off(unsigned int irq_base, unsigned int irq_offset,
746 struct msi_desc *entry);
f303a6dd 747extern struct irq_data *irq_get_irq_data(unsigned int irq);
dd87eb3a 748
a0cd9ca2 749static inline struct irq_chip *irq_get_chip(unsigned int irq)
f303a6dd
TG
750{
751 struct irq_data *d = irq_get_irq_data(irq);
752 return d ? d->chip : NULL;
753}
754
755static inline struct irq_chip *irq_data_get_irq_chip(struct irq_data *d)
756{
757 return d->chip;
758}
759
a0cd9ca2 760static inline void *irq_get_chip_data(unsigned int irq)
f303a6dd
TG
761{
762 struct irq_data *d = irq_get_irq_data(irq);
763 return d ? d->chip_data : NULL;
764}
765
766static inline void *irq_data_get_irq_chip_data(struct irq_data *d)
767{
768 return d->chip_data;
769}
770
a0cd9ca2 771static inline void *irq_get_handler_data(unsigned int irq)
f303a6dd
TG
772{
773 struct irq_data *d = irq_get_irq_data(irq);
af7080e0 774 return d ? d->common->handler_data : NULL;
f303a6dd
TG
775}
776
a0cd9ca2 777static inline void *irq_data_get_irq_handler_data(struct irq_data *d)
f303a6dd 778{
af7080e0 779 return d->common->handler_data;
f303a6dd
TG
780}
781
a0cd9ca2 782static inline struct msi_desc *irq_get_msi_desc(unsigned int irq)
f303a6dd
TG
783{
784 struct irq_data *d = irq_get_irq_data(irq);
b237721c 785 return d ? d->common->msi_desc : NULL;
f303a6dd
TG
786}
787
c391f262 788static inline struct msi_desc *irq_data_get_msi_desc(struct irq_data *d)
f303a6dd 789{
b237721c 790 return d->common->msi_desc;
f303a6dd
TG
791}
792
1f6236bf
JMC
793static inline u32 irq_get_trigger_type(unsigned int irq)
794{
795 struct irq_data *d = irq_get_irq_data(irq);
796 return d ? irqd_get_trigger_type(d) : 0;
797}
798
449e9cae 799static inline int irq_common_data_get_node(struct irq_common_data *d)
6783011b 800{
449e9cae 801#ifdef CONFIG_NUMA
6783011b 802 return d->node;
449e9cae
JL
803#else
804 return 0;
805#endif
806}
807
808static inline int irq_data_get_node(struct irq_data *d)
809{
810 return irq_common_data_get_node(d->common);
6783011b
JL
811}
812
c64301a2
JL
813static inline struct cpumask *irq_get_affinity_mask(int irq)
814{
815 struct irq_data *d = irq_get_irq_data(irq);
816
9df872fa 817 return d ? d->common->affinity : NULL;
c64301a2
JL
818}
819
820static inline struct cpumask *irq_data_get_affinity_mask(struct irq_data *d)
821{
9df872fa 822 return d->common->affinity;
c64301a2
JL
823}
824
0d3f5425
TG
825#ifdef CONFIG_GENERIC_IRQ_EFFECTIVE_AFF_MASK
826static inline
827struct cpumask *irq_data_get_effective_affinity_mask(struct irq_data *d)
828{
0551968a 829 return d->common->effective_affinity;
0d3f5425
TG
830}
831static inline void irq_data_update_effective_affinity(struct irq_data *d,
832 const struct cpumask *m)
833{
834 cpumask_copy(d->common->effective_affinity, m);
835}
836#else
837static inline void irq_data_update_effective_affinity(struct irq_data *d,
838 const struct cpumask *m)
839{
840}
841static inline
842struct cpumask *irq_data_get_effective_affinity_mask(struct irq_data *d)
843{
844 return d->common->affinity;
845}
846#endif
847
62a08ae2
TG
848unsigned int arch_dynirq_lower_bound(unsigned int from);
849
b6873807 850int __irq_alloc_descs(int irq, unsigned int from, unsigned int cnt, int node,
bec04037
DL
851 struct module *owner,
852 const struct irq_affinity_desc *affinity);
b6873807 853
2b5e7730
BG
854int __devm_irq_alloc_descs(struct device *dev, int irq, unsigned int from,
855 unsigned int cnt, int node, struct module *owner,
bec04037 856 const struct irq_affinity_desc *affinity);
2b5e7730 857
ec53cf23
PG
858/* use macros to avoid needing export.h for THIS_MODULE */
859#define irq_alloc_descs(irq, from, cnt, node) \
06ee6d57 860 __irq_alloc_descs(irq, from, cnt, node, THIS_MODULE, NULL)
b6873807 861
ec53cf23
PG
862#define irq_alloc_desc(node) \
863 irq_alloc_descs(-1, 0, 1, node)
1f5a5b87 864
ec53cf23
PG
865#define irq_alloc_desc_at(at, node) \
866 irq_alloc_descs(at, at, 1, node)
1f5a5b87 867
ec53cf23
PG
868#define irq_alloc_desc_from(from, node) \
869 irq_alloc_descs(-1, from, 1, node)
1f5a5b87 870
51906e77
AG
871#define irq_alloc_descs_from(from, cnt, node) \
872 irq_alloc_descs(-1, from, cnt, node)
873
2b5e7730
BG
874#define devm_irq_alloc_descs(dev, irq, from, cnt, node) \
875 __devm_irq_alloc_descs(dev, irq, from, cnt, node, THIS_MODULE, NULL)
876
877#define devm_irq_alloc_desc(dev, node) \
878 devm_irq_alloc_descs(dev, -1, 0, 1, node)
879
880#define devm_irq_alloc_desc_at(dev, at, node) \
881 devm_irq_alloc_descs(dev, at, at, 1, node)
882
883#define devm_irq_alloc_desc_from(dev, from, node) \
884 devm_irq_alloc_descs(dev, -1, from, 1, node)
885
886#define devm_irq_alloc_descs_from(dev, from, cnt, node) \
887 devm_irq_alloc_descs(dev, -1, from, cnt, node)
888
ec53cf23 889void irq_free_descs(unsigned int irq, unsigned int cnt);
1f5a5b87
TG
890static inline void irq_free_desc(unsigned int irq)
891{
892 irq_free_descs(irq, 1);
893}
894
7b6ef126
TG
895#ifdef CONFIG_GENERIC_IRQ_LEGACY_ALLOC_HWIRQ
896unsigned int irq_alloc_hwirqs(int cnt, int node);
897static inline unsigned int irq_alloc_hwirq(int node)
898{
899 return irq_alloc_hwirqs(1, node);
900}
901void irq_free_hwirqs(unsigned int from, int cnt);
902static inline void irq_free_hwirq(unsigned int irq)
903{
904 return irq_free_hwirqs(irq, 1);
905}
906int arch_setup_hwirq(unsigned int irq, int node);
907void arch_teardown_hwirq(unsigned int irq);
908#endif
909
c940e01c
TG
910#ifdef CONFIG_GENERIC_IRQ_LEGACY
911void irq_init_desc(unsigned int irq);
912#endif
913
7d828062
TG
914/**
915 * struct irq_chip_regs - register offsets for struct irq_gci
916 * @enable: Enable register offset to reg_base
917 * @disable: Disable register offset to reg_base
918 * @mask: Mask register offset to reg_base
919 * @ack: Ack register offset to reg_base
920 * @eoi: Eoi register offset to reg_base
921 * @type: Type configuration register offset to reg_base
922 * @polarity: Polarity configuration register offset to reg_base
923 */
924struct irq_chip_regs {
925 unsigned long enable;
926 unsigned long disable;
927 unsigned long mask;
928 unsigned long ack;
929 unsigned long eoi;
930 unsigned long type;
931 unsigned long polarity;
932};
933
934/**
935 * struct irq_chip_type - Generic interrupt chip instance for a flow type
936 * @chip: The real interrupt chip which provides the callbacks
937 * @regs: Register offsets for this chip
938 * @handler: Flow handler associated with this chip
939 * @type: Chip can handle these flow types
899f0e66
GF
940 * @mask_cache_priv: Cached mask register private to the chip type
941 * @mask_cache: Pointer to cached mask register
7d828062
TG
942 *
943 * A irq_generic_chip can have several instances of irq_chip_type when
944 * it requires different functions and register offsets for different
945 * flow types.
946 */
947struct irq_chip_type {
948 struct irq_chip chip;
949 struct irq_chip_regs regs;
950 irq_flow_handler_t handler;
951 u32 type;
899f0e66
GF
952 u32 mask_cache_priv;
953 u32 *mask_cache;
7d828062
TG
954};
955
956/**
957 * struct irq_chip_generic - Generic irq chip data structure
958 * @lock: Lock to protect register and cache data access
959 * @reg_base: Register base address (virtual)
2b280376
KC
960 * @reg_readl: Alternate I/O accessor (defaults to readl if NULL)
961 * @reg_writel: Alternate I/O accessor (defaults to writel if NULL)
be9b22b6
BN
962 * @suspend: Function called from core code on suspend once per
963 * chip; can be useful instead of irq_chip::suspend to
964 * handle chip details even when no interrupts are in use
965 * @resume: Function called from core code on resume once per chip;
966 * can be useful instead of irq_chip::suspend to handle
967 * chip details even when no interrupts are in use
7d828062
TG
968 * @irq_base: Interrupt base nr for this chip
969 * @irq_cnt: Number of interrupts handled by this chip
899f0e66 970 * @mask_cache: Cached mask register shared between all chip types
7d828062
TG
971 * @type_cache: Cached type register
972 * @polarity_cache: Cached polarity register
973 * @wake_enabled: Interrupt can wakeup from suspend
974 * @wake_active: Interrupt is marked as an wakeup from suspend source
975 * @num_ct: Number of available irq_chip_type instances (usually 1)
976 * @private: Private data for non generic chip callbacks
088f40b7 977 * @installed: bitfield to denote installed interrupts
e8bd834f 978 * @unused: bitfield to denote unused interrupts
088f40b7 979 * @domain: irq domain pointer
cfefd21e 980 * @list: List head for keeping track of instances
7d828062
TG
981 * @chip_types: Array of interrupt irq_chip_types
982 *
983 * Note, that irq_chip_generic can have multiple irq_chip_type
984 * implementations which can be associated to a particular irq line of
985 * an irq_chip_generic instance. That allows to share and protect
986 * state in an irq_chip_generic instance when we need to implement
987 * different flow mechanisms (level/edge) for it.
988 */
989struct irq_chip_generic {
990 raw_spinlock_t lock;
991 void __iomem *reg_base;
2b280376
KC
992 u32 (*reg_readl)(void __iomem *addr);
993 void (*reg_writel)(u32 val, void __iomem *addr);
be9b22b6
BN
994 void (*suspend)(struct irq_chip_generic *gc);
995 void (*resume)(struct irq_chip_generic *gc);
7d828062
TG
996 unsigned int irq_base;
997 unsigned int irq_cnt;
998 u32 mask_cache;
999 u32 type_cache;
1000 u32 polarity_cache;
1001 u32 wake_enabled;
1002 u32 wake_active;
1003 unsigned int num_ct;
1004 void *private;
088f40b7 1005 unsigned long installed;
e8bd834f 1006 unsigned long unused;
088f40b7 1007 struct irq_domain *domain;
cfefd21e 1008 struct list_head list;
7d828062
TG
1009 struct irq_chip_type chip_types[0];
1010};
1011
1012/**
1013 * enum irq_gc_flags - Initialization flags for generic irq chips
1014 * @IRQ_GC_INIT_MASK_CACHE: Initialize the mask_cache by reading mask reg
1015 * @IRQ_GC_INIT_NESTED_LOCK: Set the lock class of the irqs to nested for
1016 * irq chips which need to call irq_set_wake() on
1017 * the parent irq. Usually GPIO implementations
af80b0fe 1018 * @IRQ_GC_MASK_CACHE_PER_TYPE: Mask cache is chip type private
966dc736 1019 * @IRQ_GC_NO_MASK: Do not calculate irq_data->mask
b7905595 1020 * @IRQ_GC_BE_IO: Use big-endian register accesses (default: LE)
7d828062
TG
1021 */
1022enum irq_gc_flags {
1023 IRQ_GC_INIT_MASK_CACHE = 1 << 0,
1024 IRQ_GC_INIT_NESTED_LOCK = 1 << 1,
af80b0fe 1025 IRQ_GC_MASK_CACHE_PER_TYPE = 1 << 2,
966dc736 1026 IRQ_GC_NO_MASK = 1 << 3,
b7905595 1027 IRQ_GC_BE_IO = 1 << 4,
7d828062
TG
1028};
1029
088f40b7
TG
1030/*
1031 * struct irq_domain_chip_generic - Generic irq chip data structure for irq domains
1032 * @irqs_per_chip: Number of interrupts per chip
1033 * @num_chips: Number of chips
1034 * @irq_flags_to_set: IRQ* flags to set on irq setup
1035 * @irq_flags_to_clear: IRQ* flags to clear on irq setup
1036 * @gc_flags: Generic chip specific setup flags
1037 * @gc: Array of pointers to generic interrupt chips
1038 */
1039struct irq_domain_chip_generic {
1040 unsigned int irqs_per_chip;
1041 unsigned int num_chips;
1042 unsigned int irq_flags_to_clear;
1043 unsigned int irq_flags_to_set;
1044 enum irq_gc_flags gc_flags;
1045 struct irq_chip_generic *gc[0];
1046};
1047
7d828062
TG
1048/* Generic chip callback functions */
1049void irq_gc_noop(struct irq_data *d);
1050void irq_gc_mask_disable_reg(struct irq_data *d);
1051void irq_gc_mask_set_bit(struct irq_data *d);
1052void irq_gc_mask_clr_bit(struct irq_data *d);
1053void irq_gc_unmask_enable_reg(struct irq_data *d);
659fb32d
SG
1054void irq_gc_ack_set_bit(struct irq_data *d);
1055void irq_gc_ack_clr_bit(struct irq_data *d);
20608924 1056void irq_gc_mask_disable_and_ack_set(struct irq_data *d);
7d828062
TG
1057void irq_gc_eoi(struct irq_data *d);
1058int irq_gc_set_wake(struct irq_data *d, unsigned int on);
1059
1060/* Setup functions for irq_chip_generic */
a5152c8a
BB
1061int irq_map_generic_chip(struct irq_domain *d, unsigned int virq,
1062 irq_hw_number_t hw_irq);
7d828062
TG
1063struct irq_chip_generic *
1064irq_alloc_generic_chip(const char *name, int nr_ct, unsigned int irq_base,
1065 void __iomem *reg_base, irq_flow_handler_t handler);
1066void irq_setup_generic_chip(struct irq_chip_generic *gc, u32 msk,
1067 enum irq_gc_flags flags, unsigned int clr,
1068 unsigned int set);
1069int irq_setup_alt_chip(struct irq_data *d, unsigned int type);
cfefd21e
TG
1070void irq_remove_generic_chip(struct irq_chip_generic *gc, u32 msk,
1071 unsigned int clr, unsigned int set);
7d828062 1072
1c3e3630
BG
1073struct irq_chip_generic *
1074devm_irq_alloc_generic_chip(struct device *dev, const char *name, int num_ct,
1075 unsigned int irq_base, void __iomem *reg_base,
1076 irq_flow_handler_t handler);
30fd8fc5
BG
1077int devm_irq_setup_generic_chip(struct device *dev, struct irq_chip_generic *gc,
1078 u32 msk, enum irq_gc_flags flags,
1079 unsigned int clr, unsigned int set);
1c3e3630 1080
088f40b7 1081struct irq_chip_generic *irq_get_domain_generic_chip(struct irq_domain *d, unsigned int hw_irq);
088f40b7 1082
f88eecfe
SF
1083int __irq_alloc_domain_generic_chips(struct irq_domain *d, int irqs_per_chip,
1084 int num_ct, const char *name,
1085 irq_flow_handler_t handler,
1086 unsigned int clr, unsigned int set,
1087 enum irq_gc_flags flags);
1088
1089#define irq_alloc_domain_generic_chips(d, irqs_per_chip, num_ct, name, \
1090 handler, clr, set, flags) \
1091({ \
1092 MAYBE_BUILD_BUG_ON(irqs_per_chip > 32); \
1093 __irq_alloc_domain_generic_chips(d, irqs_per_chip, num_ct, name,\
1094 handler, clr, set, flags); \
1095})
088f40b7 1096
707188f5
BG
1097static inline void irq_free_generic_chip(struct irq_chip_generic *gc)
1098{
1099 kfree(gc);
1100}
1101
32bb6cbb
BG
1102static inline void irq_destroy_generic_chip(struct irq_chip_generic *gc,
1103 u32 msk, unsigned int clr,
1104 unsigned int set)
1105{
1106 irq_remove_generic_chip(gc, msk, clr, set);
1107 irq_free_generic_chip(gc);
1108}
1109
7d828062
TG
1110static inline struct irq_chip_type *irq_data_get_chip_type(struct irq_data *d)
1111{
1112 return container_of(d->chip, struct irq_chip_type, chip);
1113}
1114
1115#define IRQ_MSK(n) (u32)((n) < 32 ? ((1 << (n)) - 1) : UINT_MAX)
1116
1117#ifdef CONFIG_SMP
1118static inline void irq_gc_lock(struct irq_chip_generic *gc)
1119{
1120 raw_spin_lock(&gc->lock);
1121}
1122
1123static inline void irq_gc_unlock(struct irq_chip_generic *gc)
1124{
1125 raw_spin_unlock(&gc->lock);
1126}
1127#else
1128static inline void irq_gc_lock(struct irq_chip_generic *gc) { }
1129static inline void irq_gc_unlock(struct irq_chip_generic *gc) { }
1130#endif
1131
ebf9ff75
BB
1132/*
1133 * The irqsave variants are for usage in non interrupt code. Do not use
1134 * them in irq_chip callbacks. Use irq_gc_lock() instead.
1135 */
1136#define irq_gc_lock_irqsave(gc, flags) \
1137 raw_spin_lock_irqsave(&(gc)->lock, flags)
1138
1139#define irq_gc_unlock_irqrestore(gc, flags) \
1140 raw_spin_unlock_irqrestore(&(gc)->lock, flags)
1141
332fd7c4
KC
1142static inline void irq_reg_writel(struct irq_chip_generic *gc,
1143 u32 val, int reg_offset)
1144{
2b280376
KC
1145 if (gc->reg_writel)
1146 gc->reg_writel(val, gc->reg_base + reg_offset);
1147 else
1148 writel(val, gc->reg_base + reg_offset);
332fd7c4
KC
1149}
1150
1151static inline u32 irq_reg_readl(struct irq_chip_generic *gc,
1152 int reg_offset)
1153{
2b280376
KC
1154 if (gc->reg_readl)
1155 return gc->reg_readl(gc->reg_base + reg_offset);
1156 else
1157 return readl(gc->reg_base + reg_offset);
332fd7c4
KC
1158}
1159
2f75d9e1
TG
1160struct irq_matrix;
1161struct irq_matrix *irq_alloc_matrix(unsigned int matrix_bits,
1162 unsigned int alloc_start,
1163 unsigned int alloc_end);
1164void irq_matrix_online(struct irq_matrix *m);
1165void irq_matrix_offline(struct irq_matrix *m);
1166void irq_matrix_assign_system(struct irq_matrix *m, unsigned int bit, bool replace);
1167int irq_matrix_reserve_managed(struct irq_matrix *m, const struct cpumask *msk);
1168void irq_matrix_remove_managed(struct irq_matrix *m, const struct cpumask *msk);
76f99ae5
DL
1169int irq_matrix_alloc_managed(struct irq_matrix *m, const struct cpumask *msk,
1170 unsigned int *mapped_cpu);
2f75d9e1
TG
1171void irq_matrix_reserve(struct irq_matrix *m);
1172void irq_matrix_remove_reserved(struct irq_matrix *m);
1173int irq_matrix_alloc(struct irq_matrix *m, const struct cpumask *msk,
1174 bool reserved, unsigned int *mapped_cpu);
1175void irq_matrix_free(struct irq_matrix *m, unsigned int cpu,
1176 unsigned int bit, bool managed);
1177void irq_matrix_assign(struct irq_matrix *m, unsigned int bit);
1178unsigned int irq_matrix_available(struct irq_matrix *m, bool cpudown);
1179unsigned int irq_matrix_allocated(struct irq_matrix *m);
1180unsigned int irq_matrix_reserved(struct irq_matrix *m);
1181void irq_matrix_debug_show(struct seq_file *sf, struct irq_matrix *m, int ind);
1182
d17bf24e
QY
1183/* Contrary to Linux irqs, for hardware irqs the irq number 0 is valid */
1184#define INVALID_HWIRQ (~0UL)
f9bce791 1185irq_hw_number_t ipi_get_hwirq(unsigned int irq, unsigned int cpu);
3b8e29a8
QY
1186int __ipi_send_single(struct irq_desc *desc, unsigned int cpu);
1187int __ipi_send_mask(struct irq_desc *desc, const struct cpumask *dest);
1188int ipi_send_single(unsigned int virq, unsigned int cpu);
1189int ipi_send_mask(unsigned int virq, const struct cpumask *dest);
d17bf24e 1190
caacdbf4
PD
1191#ifdef CONFIG_GENERIC_IRQ_MULTI_HANDLER
1192/*
1193 * Registers a generic IRQ handling function as the top-level IRQ handler in
1194 * the system, which is generally the first C code called from an assembly
1195 * architecture-specific interrupt handler.
1196 *
1197 * Returns 0 on success, or -EBUSY if an IRQ handler has already been
1198 * registered.
1199 */
1200int __init set_handle_irq(void (*handle_irq)(struct pt_regs *));
1201
1202/*
1203 * Allows interrupt handlers to find the irqchip that's been registered as the
1204 * top-level IRQ handler.
1205 */
1206extern void (*handle_arch_irq)(struct pt_regs *) __ro_after_init;
1207#endif
1208
06fcb0c6 1209#endif /* _LINUX_IRQ_H */