Merge tag 'mm-hotfixes-stable-2024-06-26-17-28' of git://git.kernel.org/pub/scm/linux...
[linux-2.6-block.git] / include / linux / interrupt.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
1da177e4
LT
2/* interrupt.h */
3#ifndef _LINUX_INTERRUPT_H
4#define _LINUX_INTERRUPT_H
5
1da177e4 6#include <linux/kernel.h>
1da177e4 7#include <linux/bitops.h>
1da177e4 8#include <linux/cpumask.h>
908dcecd 9#include <linux/irqreturn.h>
dd3a1db9 10#include <linux/irqnr.h>
1da177e4 11#include <linux/hardirq.h>
de30a2b3 12#include <linux/irqflags.h>
9ba5f005 13#include <linux/hrtimer.h>
cd7eab44
BH
14#include <linux/kref.h>
15#include <linux/workqueue.h>
91cc470e 16#include <linux/jump_label.h>
0ebb26e7 17
60063497 18#include <linux/atomic.h>
1da177e4 19#include <asm/ptrace.h>
7d65f4a6 20#include <asm/irq.h>
229a7186 21#include <asm/sections.h>
1da177e4 22
6e213616
TG
23/*
24 * These correspond to the IORESOURCE_IRQ_* defines in
25 * linux/ioport.h to select the interrupt line behaviour. When
26 * requesting an interrupt without specifying a IRQF_TRIGGER, the
27 * setting should be assumed to be "as already configured", which
28 * may be as per machine or firmware initialisation.
29 */
30#define IRQF_TRIGGER_NONE 0x00000000
31#define IRQF_TRIGGER_RISING 0x00000001
32#define IRQF_TRIGGER_FALLING 0x00000002
33#define IRQF_TRIGGER_HIGH 0x00000004
34#define IRQF_TRIGGER_LOW 0x00000008
35#define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
36 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
37#define IRQF_TRIGGER_PROBE 0x00000010
38
39/*
40 * These flags used only by the kernel as part of the
41 * irq handling routines.
42 *
6e213616
TG
43 * IRQF_SHARED - allow sharing the irq among several devices
44 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
45 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
950f4427
TG
46 * IRQF_PERCPU - Interrupt is per cpu
47 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
d85a60d8 48 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
b8d62f33 49 * registered first in a shared interrupt is considered for
d85a60d8 50 * performance reasons)
b25c340c
TG
51 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
52 * Used by threaded interrupts which need to keep the
53 * irq line disabled until the threaded handler has been run.
737eb030
MR
54 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend. Does not guarantee
55 * that this interrupt will wake the system from a suspended
151f4e2b 56 * state. See Documentation/power/suspend-and-interrupts.rst
dc5f219e 57 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
0c4602ff 58 * IRQF_NO_THREAD - Interrupt cannot be threaded
9bab0b7f
IC
59 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
60 * resume time.
17f48034
RW
61 * IRQF_COND_SUSPEND - If the IRQ is shared with a NO_SUSPEND user, execute this
62 * interrupt handler after suspending interrupts. For system
63 * wakeup devices users need to implement wakeup detection in
64 * their interrupt handlers.
cbe16f35
BS
65 * IRQF_NO_AUTOEN - Don't enable IRQ or NMI automatically when users request it.
66 * Users will enable it explicitly by enable_irq() or enable_nmi()
67 * later.
c2b1063e
TG
68 * IRQF_NO_DEBUG - Exclude from runnaway detection for IPI and similar handlers,
69 * depends on IRQF_PERCPU.
c2ddeb29
RW
70 * IRQF_COND_ONESHOT - Agree to do IRQF_ONESHOT if already set for a shared
71 * interrupt.
6e213616 72 */
6e213616
TG
73#define IRQF_SHARED 0x00000080
74#define IRQF_PROBE_SHARED 0x00000100
685fd0b4 75#define __IRQF_TIMER 0x00000200
284c6680 76#define IRQF_PERCPU 0x00000400
950f4427 77#define IRQF_NOBALANCING 0x00000800
d85a60d8 78#define IRQF_IRQPOLL 0x00001000
b25c340c 79#define IRQF_ONESHOT 0x00002000
685fd0b4 80#define IRQF_NO_SUSPEND 0x00004000
dc5f219e 81#define IRQF_FORCE_RESUME 0x00008000
0c4602ff 82#define IRQF_NO_THREAD 0x00010000
9bab0b7f 83#define IRQF_EARLY_RESUME 0x00020000
17f48034 84#define IRQF_COND_SUSPEND 0x00040000
cbe16f35 85#define IRQF_NO_AUTOEN 0x00080000
c2b1063e 86#define IRQF_NO_DEBUG 0x00100000
c2ddeb29 87#define IRQF_COND_ONESHOT 0x00200000
685fd0b4 88
0c4602ff 89#define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
3aa551c9 90
b4e6b097 91/*
ae731f8d
MZ
92 * These values can be returned by request_any_context_irq() and
93 * describe the context the interrupt will be run in.
94 *
95 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
96 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
97 */
98enum {
99 IRQC_IS_HARDIRQ = 0,
100 IRQC_IS_NESTED,
101};
102
7d12e780 103typedef irqreturn_t (*irq_handler_t)(int, void *);
da482792 104
a9d0a1a3
TG
105/**
106 * struct irqaction - per interrupt action descriptor
107 * @handler: interrupt handler function
a9d0a1a3
TG
108 * @name: name of the device
109 * @dev_id: cookie to identify the device
31d9d9b6 110 * @percpu_dev_id: cookie to identify the device
a9d0a1a3
TG
111 * @next: pointer to the next irqaction for shared interrupts
112 * @irq: interrupt number
c0ecaa06 113 * @flags: flags (see IRQF_* above)
25985edc 114 * @thread_fn: interrupt handler function for threaded interrupts
3aa551c9 115 * @thread: thread pointer for threaded interrupts
2a1d3ab8 116 * @secondary: pointer to secondary irqaction (force threading)
3aa551c9 117 * @thread_flags: flags related to @thread
b5faba21 118 * @thread_mask: bitmask for keeping track of @thread activity
c0ecaa06 119 * @dir: pointer to the proc/irq/NN/name entry
a9d0a1a3 120 */
1da177e4 121struct irqaction {
31d9d9b6 122 irq_handler_t handler;
31d9d9b6
MZ
123 void *dev_id;
124 void __percpu *percpu_dev_id;
125 struct irqaction *next;
31d9d9b6
MZ
126 irq_handler_t thread_fn;
127 struct task_struct *thread;
2a1d3ab8 128 struct irqaction *secondary;
c0ecaa06
TG
129 unsigned int irq;
130 unsigned int flags;
31d9d9b6
MZ
131 unsigned long thread_flags;
132 unsigned long thread_mask;
133 const char *name;
134 struct proc_dir_entry *dir;
f6cd2477 135} ____cacheline_internodealigned_in_smp;
1da177e4 136
7d12e780 137extern irqreturn_t no_action(int cpl, void *dev_id);
3aa551c9 138
e237a551
CF
139/*
140 * If a (PCI) device interrupt is not connected we set dev->irq to
141 * IRQ_NOTCONNECTED. This causes request_irq() to fail with -ENOTCONN, so we
142 * can distingiush that case from other error returns.
143 *
144 * 0x80000000 is guaranteed to be outside the available range of interrupts
145 * and easy to distinguish from other possible incorrect values.
146 */
147#define IRQ_NOTCONNECTED (1U << 31)
148
3aa551c9
TG
149extern int __must_check
150request_threaded_irq(unsigned int irq, irq_handler_t handler,
151 irq_handler_t thread_fn,
152 unsigned long flags, const char *name, void *dev);
153
5ca470a0
JC
154/**
155 * request_irq - Add a handler for an interrupt line
156 * @irq: The interrupt line to allocate
157 * @handler: Function to be called when the IRQ occurs.
158 * Primary handler for threaded interrupts
159 * If NULL, the default primary handler is installed
160 * @flags: Handling flags
161 * @name: Name of the device generating this interrupt
162 * @dev: A cookie passed to the handler function
163 *
164 * This call allocates an interrupt and establishes a handler; see
165 * the documentation for request_threaded_irq() for details.
166 */
3aa551c9
TG
167static inline int __must_check
168request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
169 const char *name, void *dev)
170{
171 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
172}
173
ae731f8d
MZ
174extern int __must_check
175request_any_context_irq(unsigned int irq, irq_handler_t handler,
176 unsigned long flags, const char *name, void *dev_id);
177
31d9d9b6 178extern int __must_check
c80081b9
DL
179__request_percpu_irq(unsigned int irq, irq_handler_t handler,
180 unsigned long flags, const char *devname,
181 void __percpu *percpu_dev_id);
182
b525903c
JT
183extern int __must_check
184request_nmi(unsigned int irq, irq_handler_t handler, unsigned long flags,
185 const char *name, void *dev);
186
c80081b9 187static inline int __must_check
31d9d9b6 188request_percpu_irq(unsigned int irq, irq_handler_t handler,
c80081b9
DL
189 const char *devname, void __percpu *percpu_dev_id)
190{
191 return __request_percpu_irq(irq, handler, 0,
192 devname, percpu_dev_id);
193}
3aa551c9 194
4b078c3f
JT
195extern int __must_check
196request_percpu_nmi(unsigned int irq, irq_handler_t handler,
197 const char *devname, void __percpu *dev);
198
25ce4be7 199extern const void *free_irq(unsigned int, void *);
31d9d9b6 200extern void free_percpu_irq(unsigned int, void __percpu *);
1da177e4 201
b525903c 202extern const void *free_nmi(unsigned int irq, void *dev_id);
4b078c3f 203extern void free_percpu_nmi(unsigned int irq, void __percpu *percpu_dev_id);
b525903c 204
0af3678f
AV
205struct device;
206
935bd5b9
AV
207extern int __must_check
208devm_request_threaded_irq(struct device *dev, unsigned int irq,
209 irq_handler_t handler, irq_handler_t thread_fn,
210 unsigned long irqflags, const char *devname,
211 void *dev_id);
212
213static inline int __must_check
214devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
215 unsigned long irqflags, const char *devname, void *dev_id)
216{
217 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
218 devname, dev_id);
219}
220
0668d306
SB
221extern int __must_check
222devm_request_any_context_irq(struct device *dev, unsigned int irq,
223 irq_handler_t handler, unsigned long irqflags,
224 const char *devname, void *dev_id);
225
9ac7849e
TH
226extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
227
a313357e 228bool irq_has_action(unsigned int irq);
1da177e4 229extern void disable_irq_nosync(unsigned int irq);
02cea395 230extern bool disable_hardirq(unsigned int irq);
1da177e4 231extern void disable_irq(unsigned int irq);
31d9d9b6 232extern void disable_percpu_irq(unsigned int irq);
1da177e4 233extern void enable_irq(unsigned int irq);
1e7c5fd2 234extern void enable_percpu_irq(unsigned int irq, unsigned int type);
f0cb3220 235extern bool irq_percpu_is_enabled(unsigned int irq);
a92444c6 236extern void irq_wake_thread(unsigned int irq, void *dev_id);
ba9a2331 237
b525903c 238extern void disable_nmi_nosync(unsigned int irq);
4b078c3f 239extern void disable_percpu_nmi(unsigned int irq);
b525903c 240extern void enable_nmi(unsigned int irq);
4b078c3f
JT
241extern void enable_percpu_nmi(unsigned int irq, unsigned int type);
242extern int prepare_percpu_nmi(unsigned int irq);
243extern void teardown_percpu_nmi(unsigned int irq);
b525903c 244
acd26bcf
TG
245extern int irq_inject_interrupt(unsigned int irq);
246
0a0c5168
RW
247/* The following three functions are for the core kernel use only. */
248extern void suspend_device_irqs(void);
249extern void resume_device_irqs(void);
3a79bc63 250extern void rearm_wake_irq(unsigned int irq);
0a0c5168 251
f0ba3d05
EP
252/**
253 * struct irq_affinity_notify - context for notification of IRQ affinity changes
254 * @irq: Interrupt to which notification applies
255 * @kref: Reference count, for internal use
256 * @work: Work item, for internal use
257 * @notify: Function to be called on change. This will be
258 * called in process context.
259 * @release: Function to be called on release. This will be
260 * called in process context. Once registered, the
261 * structure must only be freed when this function is
262 * called or later.
263 */
264struct irq_affinity_notify {
265 unsigned int irq;
266 struct kref kref;
267 struct work_struct work;
268 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
269 void (*release)(struct kref *ref);
270};
271
9cfef55b
ML
272#define IRQ_AFFINITY_MAX_SETS 4
273
20e407e1
CH
274/**
275 * struct irq_affinity - Description for automatic irq affinity assignements
276 * @pre_vectors: Don't apply affinity to @pre_vectors at beginning of
277 * the MSI(-X) vector space
278 * @post_vectors: Don't apply affinity to @post_vectors at end of
279 * the MSI(-X) vector space
9cfef55b
ML
280 * @nr_sets: The number of interrupt sets for which affinity
281 * spreading is required
282 * @set_size: Array holding the size of each interrupt set
c66d4bd1
ML
283 * @calc_sets: Callback for calculating the number and size
284 * of interrupt sets
285 * @priv: Private data for usage by @calc_sets, usually a
286 * pointer to driver/device specific data.
20e407e1
CH
287 */
288struct irq_affinity {
0145c30e
TG
289 unsigned int pre_vectors;
290 unsigned int post_vectors;
291 unsigned int nr_sets;
9cfef55b 292 unsigned int set_size[IRQ_AFFINITY_MAX_SETS];
c66d4bd1
ML
293 void (*calc_sets)(struct irq_affinity *, unsigned int nvecs);
294 void *priv;
20e407e1
CH
295};
296
bec04037
DL
297/**
298 * struct irq_affinity_desc - Interrupt affinity descriptor
299 * @mask: cpumask to hold the affinity assignment
70921ae2 300 * @is_managed: 1 if the interrupt is managed internally
bec04037
DL
301 */
302struct irq_affinity_desc {
303 struct cpumask mask;
c410abbb 304 unsigned int is_managed : 1;
bec04037
DL
305};
306
0244ad00 307#if defined(CONFIG_SMP)
d7b90689 308
d036e67b 309extern cpumask_var_t irq_default_affinity;
18404756 310
4d80d6ca
TG
311extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
312extern int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask);
01f8fa4f 313
d7b90689 314extern int irq_can_set_affinity(unsigned int irq);
18404756 315extern int irq_select_affinity(unsigned int irq);
d7b90689 316
65c7cded
TG
317extern int __irq_apply_affinity_hint(unsigned int irq, const struct cpumask *m,
318 bool setaffinity);
319
320/**
321 * irq_update_affinity_hint - Update the affinity hint
322 * @irq: Interrupt to update
323 * @m: cpumask pointer (NULL to clear the hint)
324 *
325 * Updates the affinity hint, but does not change the affinity of the interrupt.
326 */
327static inline int
328irq_update_affinity_hint(unsigned int irq, const struct cpumask *m)
329{
330 return __irq_apply_affinity_hint(irq, m, false);
331}
332
333/**
334 * irq_set_affinity_and_hint - Update the affinity hint and apply the provided
335 * cpumask to the interrupt
336 * @irq: Interrupt to update
337 * @m: cpumask pointer (NULL to clear the hint)
338 *
339 * Updates the affinity hint and if @m is not NULL it applies it as the
340 * affinity of that interrupt.
341 */
342static inline int
343irq_set_affinity_and_hint(unsigned int irq, const struct cpumask *m)
344{
345 return __irq_apply_affinity_hint(irq, m, true);
346}
347
348/*
349 * Deprecated. Use irq_update_affinity_hint() or irq_set_affinity_and_hint()
350 * instead.
351 */
352static inline int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m)
353{
354 return irq_set_affinity_and_hint(irq, m);
355}
356
1d3aec89
JG
357extern int irq_update_affinity_desc(unsigned int irq,
358 struct irq_affinity_desc *affinity);
cd7eab44 359
cd7eab44
BH
360extern int
361irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
362
bec04037 363struct irq_affinity_desc *
c66d4bd1 364irq_create_affinity_masks(unsigned int nvec, struct irq_affinity *affd);
bec04037 365
0145c30e
TG
366unsigned int irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
367 const struct irq_affinity *affd);
5e385a6e 368
d7b90689
RK
369#else /* CONFIG_SMP */
370
0de26520 371static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
d7b90689
RK
372{
373 return -EINVAL;
374}
375
4c88d7f9
AB
376static inline int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
377{
378 return 0;
379}
380
d7b90689
RK
381static inline int irq_can_set_affinity(unsigned int irq)
382{
383 return 0;
384}
385
18404756
MK
386static inline int irq_select_affinity(unsigned int irq) { return 0; }
387
65c7cded
TG
388static inline int irq_update_affinity_hint(unsigned int irq,
389 const struct cpumask *m)
390{
391 return -EINVAL;
392}
393
394static inline int irq_set_affinity_and_hint(unsigned int irq,
395 const struct cpumask *m)
396{
397 return -EINVAL;
398}
399
e7a297b0 400static inline int irq_set_affinity_hint(unsigned int irq,
cd7eab44 401 const struct cpumask *m)
e7a297b0
PWJ
402{
403 return -EINVAL;
404}
f0ba3d05 405
1d3aec89
JG
406static inline int irq_update_affinity_desc(unsigned int irq,
407 struct irq_affinity_desc *affinity)
408{
409 return -EINVAL;
410}
411
f0ba3d05
EP
412static inline int
413irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
414{
415 return 0;
416}
5e385a6e 417
bec04037 418static inline struct irq_affinity_desc *
c66d4bd1 419irq_create_affinity_masks(unsigned int nvec, struct irq_affinity *affd)
34c3d981
TG
420{
421 return NULL;
422}
423
0145c30e
TG
424static inline unsigned int
425irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
426 const struct irq_affinity *affd)
34c3d981
TG
427{
428 return maxvec;
429}
430
0244ad00 431#endif /* CONFIG_SMP */
d7b90689 432
c01d403b
IM
433/*
434 * Special lockdep variants of irq disabling/enabling.
435 * These should be used for locking constructs that
436 * know that a particular irq context which is disabled,
437 * and which is the only irq-context user of a lock,
438 * that it's safe to take the lock in the irq-disabled
439 * section without disabling hardirqs.
440 *
441 * On !CONFIG_LOCKDEP they are equivalent to the normal
442 * irq disable/enable methods.
443 */
444static inline void disable_irq_nosync_lockdep(unsigned int irq)
445{
446 disable_irq_nosync(irq);
447#ifdef CONFIG_LOCKDEP
448 local_irq_disable();
449#endif
450}
451
e8106b94
AV
452static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
453{
454 disable_irq_nosync(irq);
455#ifdef CONFIG_LOCKDEP
456 local_irq_save(*flags);
457#endif
458}
459
c01d403b
IM
460static inline void disable_irq_lockdep(unsigned int irq)
461{
462 disable_irq(irq);
463#ifdef CONFIG_LOCKDEP
464 local_irq_disable();
465#endif
466}
467
468static inline void enable_irq_lockdep(unsigned int irq)
469{
470#ifdef CONFIG_LOCKDEP
471 local_irq_enable();
472#endif
473 enable_irq(irq);
474}
475
e8106b94
AV
476static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
477{
478#ifdef CONFIG_LOCKDEP
479 local_irq_restore(*flags);
480#endif
481 enable_irq(irq);
482}
483
ba9a2331 484/* IRQ wakeup (PM) control: */
a0cd9ca2
TG
485extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
486
ba9a2331
TG
487static inline int enable_irq_wake(unsigned int irq)
488{
a0cd9ca2 489 return irq_set_irq_wake(irq, 1);
ba9a2331
TG
490}
491
492static inline int disable_irq_wake(unsigned int irq)
493{
a0cd9ca2 494 return irq_set_irq_wake(irq, 0);
ba9a2331
TG
495}
496
1b7047ed
MZ
497/*
498 * irq_get_irqchip_state/irq_set_irqchip_state specific flags
499 */
500enum irqchip_irq_state {
501 IRQCHIP_STATE_PENDING, /* Is interrupt pending? */
502 IRQCHIP_STATE_ACTIVE, /* Is interrupt in progress? */
503 IRQCHIP_STATE_MASKED, /* Is interrupt masked? */
504 IRQCHIP_STATE_LINE_LEVEL, /* Is IRQ line high? */
505};
506
507extern int irq_get_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
508 bool *state);
509extern int irq_set_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
510 bool state);
8d32a307
TG
511
512#ifdef CONFIG_IRQ_FORCED_THREADING
b6a32bbd 513# ifdef CONFIG_PREEMPT_RT
91cc470e 514# define force_irqthreads() (true)
b6a32bbd 515# else
91cc470e
TL
516DECLARE_STATIC_KEY_FALSE(force_irqthreads_key);
517# define force_irqthreads() (static_branch_unlikely(&force_irqthreads_key))
b6a32bbd 518# endif
8d32a307 519#else
91cc470e 520#define force_irqthreads() (false)
8d32a307
TG
521#endif
522
0fd7d862
FW
523#ifndef local_softirq_pending
524
525#ifndef local_softirq_pending_ref
526#define local_softirq_pending_ref irq_stat.__softirq_pending
527#endif
528
529#define local_softirq_pending() (__this_cpu_read(local_softirq_pending_ref))
530#define set_softirq_pending(x) (__this_cpu_write(local_softirq_pending_ref, (x)))
531#define or_softirq_pending(x) (__this_cpu_or(local_softirq_pending_ref, (x)))
532
0fd7d862
FW
533#endif /* local_softirq_pending */
534
2d3fbbb3
BH
535/* Some architectures might implement lazy enabling/disabling of
536 * interrupts. In some cases, such as stop_machine, we might want
537 * to ensure that after a local_irq_disable(), interrupts have
538 * really been disabled in hardware. Such architectures need to
539 * implement the following hook.
540 */
541#ifndef hard_irq_disable
542#define hard_irq_disable() do { } while(0)
543#endif
544
1da177e4
LT
545/* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
546 frequency threaded job scheduling. For almost all the purposes
547 tasklets are more than enough. F.e. all serial device BHs et
548 al. should be converted to tasklets, not to softirqs.
549 */
550
551enum
552{
553 HI_SOFTIRQ=0,
554 TIMER_SOFTIRQ,
555 NET_TX_SOFTIRQ,
556 NET_RX_SOFTIRQ,
ff856bad 557 BLOCK_SOFTIRQ,
511cbce2 558 IRQ_POLL_SOFTIRQ,
c9819f45
CL
559 TASKLET_SOFTIRQ,
560 SCHED_SOFTIRQ,
3bbc53f4 561 HRTIMER_SOFTIRQ,
09223371 562 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
978b0116
AD
563
564 NR_SOFTIRQS
1da177e4
LT
565};
566
0345691b 567/*
f96272a9
FW
568 * The following vectors can be safely ignored after ksoftirqd is parked:
569 *
570 * _ RCU:
571 * 1) rcutree_migrate_callbacks() migrates the queue.
448e9f34 572 * 2) rcutree_report_cpu_dead() reports the final quiescent states.
f96272a9
FW
573 *
574 * _ IRQ_POLL: irq_poll_cpu_dead() migrates the queue
1a6a4647
FW
575 *
576 * _ (HR)TIMER_SOFTIRQ: (hr)timers_dead_cpu() migrates the queue
0345691b 577 */
1a6a4647
FW
578#define SOFTIRQ_HOTPLUG_SAFE_MASK (BIT(TIMER_SOFTIRQ) | BIT(IRQ_POLL_SOFTIRQ) |\
579 BIT(HRTIMER_SOFTIRQ) | BIT(RCU_SOFTIRQ))
580
803b0eba 581
5d592b44
JB
582/* map softirq index to softirq name. update 'softirq_to_name' in
583 * kernel/softirq.c when adding a new softirq.
584 */
ce85b4f2 585extern const char * const softirq_to_name[NR_SOFTIRQS];
5d592b44 586
1da177e4
LT
587/* softirq mask and active fields moved to irq_cpustat_t in
588 * asm/hardirq.h to get better cache usage. KAO
589 */
590
591struct softirq_action
592{
593 void (*action)(struct softirq_action *);
1da177e4
LT
594};
595
596asmlinkage void do_softirq(void);
eb0f1c44 597asmlinkage void __do_softirq(void);
7d65f4a6 598
1a90bfd2
SAS
599#ifdef CONFIG_PREEMPT_RT
600extern void do_softirq_post_smp_call_flush(unsigned int was_pending);
601#else
602static inline void do_softirq_post_smp_call_flush(unsigned int unused)
603{
604 do_softirq();
605}
606#endif
607
962cf36c 608extern void open_softirq(int nr, void (*action)(struct softirq_action *));
1da177e4 609extern void softirq_init(void);
f069686e 610extern void __raise_softirq_irqoff(unsigned int nr);
2bf2160d 611
b3c97528
HH
612extern void raise_softirq_irqoff(unsigned int nr);
613extern void raise_softirq(unsigned int nr);
1da177e4 614
4dd53d89
VP
615DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
616
617static inline struct task_struct *this_cpu_ksoftirqd(void)
618{
619 return this_cpu_read(ksoftirqd);
620}
621
1da177e4
LT
622/* Tasklets --- multithreaded analogue of BHs.
623
12cc923f
RP
624 This API is deprecated. Please consider using threaded IRQs instead:
625 https://lore.kernel.org/lkml/20200716081538.2sivhkj4hcyrusem@linutronix.de
626
1da177e4
LT
627 Main feature differing them of generic softirqs: tasklet
628 is running only on one CPU simultaneously.
629
630 Main feature differing them of BHs: different tasklets
631 may be run simultaneously on different CPUs.
632
633 Properties:
634 * If tasklet_schedule() is called, then tasklet is guaranteed
635 to be executed on some cpu at least once after this.
25985edc 636 * If the tasklet is already scheduled, but its execution is still not
1da177e4
LT
637 started, it will be executed only once.
638 * If this tasklet is already running on another CPU (or schedule is called
639 from tasklet itself), it is rescheduled for later.
640 * Tasklet is strictly serialized wrt itself, but not
641 wrt another tasklets. If client needs some intertask synchronization,
642 he makes it with spinlocks.
643 */
644
645struct tasklet_struct
646{
647 struct tasklet_struct *next;
648 unsigned long state;
649 atomic_t count;
12cc923f
RP
650 bool use_callback;
651 union {
652 void (*func)(unsigned long data);
653 void (*callback)(struct tasklet_struct *t);
654 };
1da177e4
LT
655 unsigned long data;
656};
657
12cc923f
RP
658#define DECLARE_TASKLET(name, _callback) \
659struct tasklet_struct name = { \
660 .count = ATOMIC_INIT(0), \
661 .callback = _callback, \
662 .use_callback = true, \
663}
664
665#define DECLARE_TASKLET_DISABLED(name, _callback) \
666struct tasklet_struct name = { \
667 .count = ATOMIC_INIT(1), \
668 .callback = _callback, \
669 .use_callback = true, \
670}
671
672#define from_tasklet(var, callback_tasklet, tasklet_fieldname) \
673 container_of(callback_tasklet, typeof(*var), tasklet_fieldname)
674
b13fecb1
KC
675#define DECLARE_TASKLET_OLD(name, _func) \
676struct tasklet_struct name = { \
677 .count = ATOMIC_INIT(0), \
678 .func = _func, \
679}
1da177e4 680
b13fecb1
KC
681#define DECLARE_TASKLET_DISABLED_OLD(name, _func) \
682struct tasklet_struct name = { \
683 .count = ATOMIC_INIT(1), \
684 .func = _func, \
685}
1da177e4
LT
686
687enum
688{
689 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
690 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
691};
692
eb2dafbb 693#if defined(CONFIG_SMP) || defined(CONFIG_PREEMPT_RT)
1da177e4
LT
694static inline int tasklet_trylock(struct tasklet_struct *t)
695{
696 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
697}
698
da044747
PZ
699void tasklet_unlock(struct tasklet_struct *t);
700void tasklet_unlock_wait(struct tasklet_struct *t);
eb2dafbb 701void tasklet_unlock_spin_wait(struct tasklet_struct *t);
ca5f6251 702
1da177e4 703#else
6951547a
TG
704static inline int tasklet_trylock(struct tasklet_struct *t) { return 1; }
705static inline void tasklet_unlock(struct tasklet_struct *t) { }
706static inline void tasklet_unlock_wait(struct tasklet_struct *t) { }
ca5f6251 707static inline void tasklet_unlock_spin_wait(struct tasklet_struct *t) { }
1da177e4
LT
708#endif
709
b3c97528 710extern void __tasklet_schedule(struct tasklet_struct *t);
1da177e4
LT
711
712static inline void tasklet_schedule(struct tasklet_struct *t)
713{
714 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
715 __tasklet_schedule(t);
716}
717
b3c97528 718extern void __tasklet_hi_schedule(struct tasklet_struct *t);
1da177e4
LT
719
720static inline void tasklet_hi_schedule(struct tasklet_struct *t)
721{
722 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
723 __tasklet_hi_schedule(t);
724}
725
1da177e4
LT
726static inline void tasklet_disable_nosync(struct tasklet_struct *t)
727{
728 atomic_inc(&t->count);
4e857c58 729 smp_mb__after_atomic();
1da177e4
LT
730}
731
ca5f6251
TG
732/*
733 * Do not use in new code. Disabling tasklets from atomic contexts is
734 * error prone and should be avoided.
735 */
736static inline void tasklet_disable_in_atomic(struct tasklet_struct *t)
737{
738 tasklet_disable_nosync(t);
739 tasklet_unlock_spin_wait(t);
740 smp_mb();
741}
742
1da177e4
LT
743static inline void tasklet_disable(struct tasklet_struct *t)
744{
745 tasklet_disable_nosync(t);
6fd4e861 746 tasklet_unlock_wait(t);
1da177e4
LT
747 smp_mb();
748}
749
750static inline void tasklet_enable(struct tasklet_struct *t)
751{
4e857c58 752 smp_mb__before_atomic();
1da177e4
LT
753 atomic_dec(&t->count);
754}
755
1da177e4 756extern void tasklet_kill(struct tasklet_struct *t);
1da177e4
LT
757extern void tasklet_init(struct tasklet_struct *t,
758 void (*func)(unsigned long), unsigned long data);
12cc923f
RP
759extern void tasklet_setup(struct tasklet_struct *t,
760 void (*callback)(struct tasklet_struct *));
1da177e4
LT
761
762/*
763 * Autoprobing for irqs:
764 *
765 * probe_irq_on() and probe_irq_off() provide robust primitives
766 * for accurate IRQ probing during kernel initialization. They are
767 * reasonably simple to use, are not "fooled" by spurious interrupts,
768 * and, unlike other attempts at IRQ probing, they do not get hung on
769 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
770 *
771 * For reasonably foolproof probing, use them as follows:
772 *
773 * 1. clear and/or mask the device's internal interrupt.
774 * 2. sti();
775 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
776 * 4. enable the device and cause it to trigger an interrupt.
777 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
778 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
779 * 7. service the device to clear its pending interrupt.
780 * 8. loop again if paranoia is required.
781 *
782 * probe_irq_on() returns a mask of allocated irq's.
783 *
784 * probe_irq_off() takes the mask as a parameter,
785 * and returns the irq number which occurred,
786 * or zero if none occurred, or a negative irq number
787 * if more than one irq occurred.
788 */
789
0244ad00 790#if !defined(CONFIG_GENERIC_IRQ_PROBE)
1da177e4
LT
791static inline unsigned long probe_irq_on(void)
792{
793 return 0;
794}
795static inline int probe_irq_off(unsigned long val)
796{
797 return 0;
798}
799static inline unsigned int probe_irq_mask(unsigned long val)
800{
801 return 0;
802}
803#else
804extern unsigned long probe_irq_on(void); /* returns 0 on failure */
805extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
806extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
807#endif
808
6168a702
AM
809#ifdef CONFIG_PROC_FS
810/* Initialize /proc/irq/ */
811extern void init_irq_proc(void);
812#else
813static inline void init_irq_proc(void)
814{
815}
816#endif
817
b2d3d61a
DL
818#ifdef CONFIG_IRQ_TIMINGS
819void irq_timings_enable(void);
820void irq_timings_disable(void);
e1c92149 821u64 irq_timings_next_event(u64 now);
b2d3d61a
DL
822#endif
823
d43c36dc 824struct seq_file;
f74596d0 825int show_interrupts(struct seq_file *p, void *v);
c78b9b65 826int arch_show_interrupts(struct seq_file *p, int prec);
f74596d0 827
43a25632 828extern int early_irq_init(void);
4a046d17 829extern int arch_probe_nr_irqs(void);
43a25632 830extern int arch_early_irq_init(void);
43a25632 831
be7635e7
AP
832/*
833 * We want to know which function is an entrypoint of a hardirq or a softirq.
834 */
f0178fc0 835#ifndef __irq_entry
33def849 836# define __irq_entry __section(".irqentry.text")
f0178fc0
TG
837#endif
838
33def849 839#define __softirq_entry __section(".softirqentry.text")
be7635e7 840
1da177e4 841#endif