1 /* SPDX-License-Identifier: GPL-2.0 */
3 #ifndef _LINUX_INTERRUPT_H
4 #define _LINUX_INTERRUPT_H
6 #include <linux/kernel.h>
7 #include <linux/bitops.h>
8 #include <linux/cpumask.h>
9 #include <linux/irqreturn.h>
10 #include <linux/irqnr.h>
11 #include <linux/hardirq.h>
12 #include <linux/irqflags.h>
13 #include <linux/hrtimer.h>
14 #include <linux/kref.h>
15 #include <linux/workqueue.h>
17 #include <linux/atomic.h>
18 #include <asm/ptrace.h>
20 #include <asm/sections.h>
23 * These correspond to the IORESOURCE_IRQ_* defines in
24 * linux/ioport.h to select the interrupt line behaviour. When
25 * requesting an interrupt without specifying a IRQF_TRIGGER, the
26 * setting should be assumed to be "as already configured", which
27 * may be as per machine or firmware initialisation.
29 #define IRQF_TRIGGER_NONE 0x00000000
30 #define IRQF_TRIGGER_RISING 0x00000001
31 #define IRQF_TRIGGER_FALLING 0x00000002
32 #define IRQF_TRIGGER_HIGH 0x00000004
33 #define IRQF_TRIGGER_LOW 0x00000008
34 #define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
35 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
36 #define IRQF_TRIGGER_PROBE 0x00000010
39 * These flags used only by the kernel as part of the
40 * irq handling routines.
42 * IRQF_SHARED - allow sharing the irq among several devices
43 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
44 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
45 * IRQF_PERCPU - Interrupt is per cpu
46 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
47 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
48 * registered first in a shared interrupt is considered for
49 * performance reasons)
50 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
51 * Used by threaded interrupts which need to keep the
52 * irq line disabled until the threaded handler has been run.
53 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend. Does not guarantee
54 * that this interrupt will wake the system from a suspended
55 * state. See Documentation/power/suspend-and-interrupts.txt
56 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
57 * IRQF_NO_THREAD - Interrupt cannot be threaded
58 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
60 * IRQF_COND_SUSPEND - If the IRQ is shared with a NO_SUSPEND user, execute this
61 * interrupt handler after suspending interrupts. For system
62 * wakeup devices users need to implement wakeup detection in
63 * their interrupt handlers.
65 #define IRQF_SHARED 0x00000080
66 #define IRQF_PROBE_SHARED 0x00000100
67 #define __IRQF_TIMER 0x00000200
68 #define IRQF_PERCPU 0x00000400
69 #define IRQF_NOBALANCING 0x00000800
70 #define IRQF_IRQPOLL 0x00001000
71 #define IRQF_ONESHOT 0x00002000
72 #define IRQF_NO_SUSPEND 0x00004000
73 #define IRQF_FORCE_RESUME 0x00008000
74 #define IRQF_NO_THREAD 0x00010000
75 #define IRQF_EARLY_RESUME 0x00020000
76 #define IRQF_COND_SUSPEND 0x00040000
78 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
81 * These values can be returned by request_any_context_irq() and
82 * describe the context the interrupt will be run in.
84 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
85 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
92 typedef irqreturn_t (*irq_handler_t)(int, void *);
95 * struct irqaction - per interrupt action descriptor
96 * @handler: interrupt handler function
97 * @name: name of the device
98 * @dev_id: cookie to identify the device
99 * @percpu_dev_id: cookie to identify the device
100 * @next: pointer to the next irqaction for shared interrupts
101 * @irq: interrupt number
102 * @flags: flags (see IRQF_* above)
103 * @thread_fn: interrupt handler function for threaded interrupts
104 * @thread: thread pointer for threaded interrupts
105 * @secondary: pointer to secondary irqaction (force threading)
106 * @thread_flags: flags related to @thread
107 * @thread_mask: bitmask for keeping track of @thread activity
108 * @dir: pointer to the proc/irq/NN/name entry
111 irq_handler_t handler;
113 void __percpu *percpu_dev_id;
114 struct irqaction *next;
115 irq_handler_t thread_fn;
116 struct task_struct *thread;
117 struct irqaction *secondary;
120 unsigned long thread_flags;
121 unsigned long thread_mask;
123 struct proc_dir_entry *dir;
124 } ____cacheline_internodealigned_in_smp;
126 extern irqreturn_t no_action(int cpl, void *dev_id);
129 * If a (PCI) device interrupt is not connected we set dev->irq to
130 * IRQ_NOTCONNECTED. This causes request_irq() to fail with -ENOTCONN, so we
131 * can distingiush that case from other error returns.
133 * 0x80000000 is guaranteed to be outside the available range of interrupts
134 * and easy to distinguish from other possible incorrect values.
136 #define IRQ_NOTCONNECTED (1U << 31)
138 extern int __must_check
139 request_threaded_irq(unsigned int irq, irq_handler_t handler,
140 irq_handler_t thread_fn,
141 unsigned long flags, const char *name, void *dev);
143 static inline int __must_check
144 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
145 const char *name, void *dev)
147 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
150 extern int __must_check
151 request_any_context_irq(unsigned int irq, irq_handler_t handler,
152 unsigned long flags, const char *name, void *dev_id);
154 extern int __must_check
155 __request_percpu_irq(unsigned int irq, irq_handler_t handler,
156 unsigned long flags, const char *devname,
157 void __percpu *percpu_dev_id);
159 static inline int __must_check
160 request_percpu_irq(unsigned int irq, irq_handler_t handler,
161 const char *devname, void __percpu *percpu_dev_id)
163 return __request_percpu_irq(irq, handler, 0,
164 devname, percpu_dev_id);
167 extern const void *free_irq(unsigned int, void *);
168 extern void free_percpu_irq(unsigned int, void __percpu *);
172 extern int __must_check
173 devm_request_threaded_irq(struct device *dev, unsigned int irq,
174 irq_handler_t handler, irq_handler_t thread_fn,
175 unsigned long irqflags, const char *devname,
178 static inline int __must_check
179 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
180 unsigned long irqflags, const char *devname, void *dev_id)
182 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
186 extern int __must_check
187 devm_request_any_context_irq(struct device *dev, unsigned int irq,
188 irq_handler_t handler, unsigned long irqflags,
189 const char *devname, void *dev_id);
191 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
194 * On lockdep we dont want to enable hardirqs in hardirq
195 * context. Use local_irq_enable_in_hardirq() to annotate
196 * kernel code that has to do this nevertheless (pretty much
197 * the only valid case is for old/broken hardware that is
200 * NOTE: in theory this might break fragile code that relies
201 * on hardirq delivery - in practice we dont seem to have such
202 * places left. So the only effect should be slightly increased
203 * irqs-off latencies.
205 #ifdef CONFIG_LOCKDEP
206 # define local_irq_enable_in_hardirq() do { } while (0)
208 # define local_irq_enable_in_hardirq() local_irq_enable()
211 extern void disable_irq_nosync(unsigned int irq);
212 extern bool disable_hardirq(unsigned int irq);
213 extern void disable_irq(unsigned int irq);
214 extern void disable_percpu_irq(unsigned int irq);
215 extern void enable_irq(unsigned int irq);
216 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
217 extern bool irq_percpu_is_enabled(unsigned int irq);
218 extern void irq_wake_thread(unsigned int irq, void *dev_id);
220 /* The following three functions are for the core kernel use only. */
221 extern void suspend_device_irqs(void);
222 extern void resume_device_irqs(void);
225 * struct irq_affinity_notify - context for notification of IRQ affinity changes
226 * @irq: Interrupt to which notification applies
227 * @kref: Reference count, for internal use
228 * @work: Work item, for internal use
229 * @notify: Function to be called on change. This will be
230 * called in process context.
231 * @release: Function to be called on release. This will be
232 * called in process context. Once registered, the
233 * structure must only be freed when this function is
236 struct irq_affinity_notify {
239 struct work_struct work;
240 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
241 void (*release)(struct kref *ref);
245 * struct irq_affinity - Description for automatic irq affinity assignements
246 * @pre_vectors: Don't apply affinity to @pre_vectors at beginning of
247 * the MSI(-X) vector space
248 * @post_vectors: Don't apply affinity to @post_vectors at end of
249 * the MSI(-X) vector space
250 * @nr_sets: Length of passed in *sets array
251 * @sets: Number of affinitized sets
253 struct irq_affinity {
254 unsigned int pre_vectors;
255 unsigned int post_vectors;
256 unsigned int nr_sets;
261 * struct irq_affinity_desc - Interrupt affinity descriptor
262 * @mask: cpumask to hold the affinity assignment
263 * @is_managed: 1 if the interrupt is managed internally
265 struct irq_affinity_desc {
267 unsigned int is_managed : 1;
270 #if defined(CONFIG_SMP)
272 extern cpumask_var_t irq_default_affinity;
274 /* Internal implementation. Use the helpers below */
275 extern int __irq_set_affinity(unsigned int irq, const struct cpumask *cpumask,
279 * irq_set_affinity - Set the irq affinity of a given irq
280 * @irq: Interrupt to set affinity
283 * Fails if cpumask does not contain an online CPU
286 irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
288 return __irq_set_affinity(irq, cpumask, false);
292 * irq_force_affinity - Force the irq affinity of a given irq
293 * @irq: Interrupt to set affinity
296 * Same as irq_set_affinity, but without checking the mask against
299 * Solely for low level cpu hotplug code, where we need to make per
300 * cpu interrupts affine before the cpu becomes online.
303 irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
305 return __irq_set_affinity(irq, cpumask, true);
308 extern int irq_can_set_affinity(unsigned int irq);
309 extern int irq_select_affinity(unsigned int irq);
311 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
314 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
316 struct irq_affinity_desc *
317 irq_create_affinity_masks(unsigned int nvec, const struct irq_affinity *affd);
319 unsigned int irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
320 const struct irq_affinity *affd);
322 #else /* CONFIG_SMP */
324 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
329 static inline int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
334 static inline int irq_can_set_affinity(unsigned int irq)
339 static inline int irq_select_affinity(unsigned int irq) { return 0; }
341 static inline int irq_set_affinity_hint(unsigned int irq,
342 const struct cpumask *m)
348 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
353 static inline struct irq_affinity_desc *
354 irq_create_affinity_masks(unsigned int nvec, const struct irq_affinity *affd)
359 static inline unsigned int
360 irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
361 const struct irq_affinity *affd)
366 #endif /* CONFIG_SMP */
369 * Special lockdep variants of irq disabling/enabling.
370 * These should be used for locking constructs that
371 * know that a particular irq context which is disabled,
372 * and which is the only irq-context user of a lock,
373 * that it's safe to take the lock in the irq-disabled
374 * section without disabling hardirqs.
376 * On !CONFIG_LOCKDEP they are equivalent to the normal
377 * irq disable/enable methods.
379 static inline void disable_irq_nosync_lockdep(unsigned int irq)
381 disable_irq_nosync(irq);
382 #ifdef CONFIG_LOCKDEP
387 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
389 disable_irq_nosync(irq);
390 #ifdef CONFIG_LOCKDEP
391 local_irq_save(*flags);
395 static inline void disable_irq_lockdep(unsigned int irq)
398 #ifdef CONFIG_LOCKDEP
403 static inline void enable_irq_lockdep(unsigned int irq)
405 #ifdef CONFIG_LOCKDEP
411 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
413 #ifdef CONFIG_LOCKDEP
414 local_irq_restore(*flags);
419 /* IRQ wakeup (PM) control: */
420 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
422 static inline int enable_irq_wake(unsigned int irq)
424 return irq_set_irq_wake(irq, 1);
427 static inline int disable_irq_wake(unsigned int irq)
429 return irq_set_irq_wake(irq, 0);
433 * irq_get_irqchip_state/irq_set_irqchip_state specific flags
435 enum irqchip_irq_state {
436 IRQCHIP_STATE_PENDING, /* Is interrupt pending? */
437 IRQCHIP_STATE_ACTIVE, /* Is interrupt in progress? */
438 IRQCHIP_STATE_MASKED, /* Is interrupt masked? */
439 IRQCHIP_STATE_LINE_LEVEL, /* Is IRQ line high? */
442 extern int irq_get_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
444 extern int irq_set_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
447 #ifdef CONFIG_IRQ_FORCED_THREADING
448 extern bool force_irqthreads;
450 #define force_irqthreads (0)
453 #ifndef local_softirq_pending
455 #ifndef local_softirq_pending_ref
456 #define local_softirq_pending_ref irq_stat.__softirq_pending
459 #define local_softirq_pending() (__this_cpu_read(local_softirq_pending_ref))
460 #define set_softirq_pending(x) (__this_cpu_write(local_softirq_pending_ref, (x)))
461 #define or_softirq_pending(x) (__this_cpu_or(local_softirq_pending_ref, (x)))
463 #endif /* local_softirq_pending */
465 /* Some architectures might implement lazy enabling/disabling of
466 * interrupts. In some cases, such as stop_machine, we might want
467 * to ensure that after a local_irq_disable(), interrupts have
468 * really been disabled in hardware. Such architectures need to
469 * implement the following hook.
471 #ifndef hard_irq_disable
472 #define hard_irq_disable() do { } while(0)
475 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
476 frequency threaded job scheduling. For almost all the purposes
477 tasklets are more than enough. F.e. all serial device BHs et
478 al. should be converted to tasklets, not to softirqs.
491 HRTIMER_SOFTIRQ, /* Unused, but kept as tools rely on the
493 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
498 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
500 /* map softirq index to softirq name. update 'softirq_to_name' in
501 * kernel/softirq.c when adding a new softirq.
503 extern const char * const softirq_to_name[NR_SOFTIRQS];
505 /* softirq mask and active fields moved to irq_cpustat_t in
506 * asm/hardirq.h to get better cache usage. KAO
509 struct softirq_action
511 void (*action)(struct softirq_action *);
514 asmlinkage void do_softirq(void);
515 asmlinkage void __do_softirq(void);
517 #ifdef __ARCH_HAS_DO_SOFTIRQ
518 void do_softirq_own_stack(void);
520 static inline void do_softirq_own_stack(void)
526 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
527 extern void softirq_init(void);
528 extern void __raise_softirq_irqoff(unsigned int nr);
530 extern void raise_softirq_irqoff(unsigned int nr);
531 extern void raise_softirq(unsigned int nr);
533 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
535 static inline struct task_struct *this_cpu_ksoftirqd(void)
537 return this_cpu_read(ksoftirqd);
540 /* Tasklets --- multithreaded analogue of BHs.
542 Main feature differing them of generic softirqs: tasklet
543 is running only on one CPU simultaneously.
545 Main feature differing them of BHs: different tasklets
546 may be run simultaneously on different CPUs.
549 * If tasklet_schedule() is called, then tasklet is guaranteed
550 to be executed on some cpu at least once after this.
551 * If the tasklet is already scheduled, but its execution is still not
552 started, it will be executed only once.
553 * If this tasklet is already running on another CPU (or schedule is called
554 from tasklet itself), it is rescheduled for later.
555 * Tasklet is strictly serialized wrt itself, but not
556 wrt another tasklets. If client needs some intertask synchronization,
557 he makes it with spinlocks.
560 struct tasklet_struct
562 struct tasklet_struct *next;
565 void (*func)(unsigned long);
569 #define DECLARE_TASKLET(name, func, data) \
570 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
572 #define DECLARE_TASKLET_DISABLED(name, func, data) \
573 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
578 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
579 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
583 static inline int tasklet_trylock(struct tasklet_struct *t)
585 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
588 static inline void tasklet_unlock(struct tasklet_struct *t)
590 smp_mb__before_atomic();
591 clear_bit(TASKLET_STATE_RUN, &(t)->state);
594 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
596 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
599 #define tasklet_trylock(t) 1
600 #define tasklet_unlock_wait(t) do { } while (0)
601 #define tasklet_unlock(t) do { } while (0)
604 extern void __tasklet_schedule(struct tasklet_struct *t);
606 static inline void tasklet_schedule(struct tasklet_struct *t)
608 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
609 __tasklet_schedule(t);
612 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
614 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
616 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
617 __tasklet_hi_schedule(t);
620 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
622 atomic_inc(&t->count);
623 smp_mb__after_atomic();
626 static inline void tasklet_disable(struct tasklet_struct *t)
628 tasklet_disable_nosync(t);
629 tasklet_unlock_wait(t);
633 static inline void tasklet_enable(struct tasklet_struct *t)
635 smp_mb__before_atomic();
636 atomic_dec(&t->count);
639 extern void tasklet_kill(struct tasklet_struct *t);
640 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
641 extern void tasklet_init(struct tasklet_struct *t,
642 void (*func)(unsigned long), unsigned long data);
644 struct tasklet_hrtimer {
645 struct hrtimer timer;
646 struct tasklet_struct tasklet;
647 enum hrtimer_restart (*function)(struct hrtimer *);
651 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
652 enum hrtimer_restart (*function)(struct hrtimer *),
653 clockid_t which_clock, enum hrtimer_mode mode);
656 void tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
657 const enum hrtimer_mode mode)
659 hrtimer_start(&ttimer->timer, time, mode);
663 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
665 hrtimer_cancel(&ttimer->timer);
666 tasklet_kill(&ttimer->tasklet);
670 * Autoprobing for irqs:
672 * probe_irq_on() and probe_irq_off() provide robust primitives
673 * for accurate IRQ probing during kernel initialization. They are
674 * reasonably simple to use, are not "fooled" by spurious interrupts,
675 * and, unlike other attempts at IRQ probing, they do not get hung on
676 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
678 * For reasonably foolproof probing, use them as follows:
680 * 1. clear and/or mask the device's internal interrupt.
682 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
683 * 4. enable the device and cause it to trigger an interrupt.
684 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
685 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
686 * 7. service the device to clear its pending interrupt.
687 * 8. loop again if paranoia is required.
689 * probe_irq_on() returns a mask of allocated irq's.
691 * probe_irq_off() takes the mask as a parameter,
692 * and returns the irq number which occurred,
693 * or zero if none occurred, or a negative irq number
694 * if more than one irq occurred.
697 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
698 static inline unsigned long probe_irq_on(void)
702 static inline int probe_irq_off(unsigned long val)
706 static inline unsigned int probe_irq_mask(unsigned long val)
711 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
712 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
713 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
716 #ifdef CONFIG_PROC_FS
717 /* Initialize /proc/irq/ */
718 extern void init_irq_proc(void);
720 static inline void init_irq_proc(void)
725 #ifdef CONFIG_IRQ_TIMINGS
726 void irq_timings_enable(void);
727 void irq_timings_disable(void);
728 u64 irq_timings_next_event(u64 now);
732 int show_interrupts(struct seq_file *p, void *v);
733 int arch_show_interrupts(struct seq_file *p, int prec);
735 extern int early_irq_init(void);
736 extern int arch_probe_nr_irqs(void);
737 extern int arch_early_irq_init(void);
740 * We want to know which function is an entrypoint of a hardirq or a softirq.
742 #define __irq_entry __attribute__((__section__(".irqentry.text")))
743 #define __softirq_entry \
744 __attribute__((__section__(".softirqentry.text")))