2 #ifndef _LINUX_INTERRUPT_H
3 #define _LINUX_INTERRUPT_H
5 #include <linux/kernel.h>
6 #include <linux/linkage.h>
7 #include <linux/bitops.h>
8 #include <linux/preempt.h>
9 #include <linux/cpumask.h>
10 #include <linux/irqreturn.h>
11 #include <linux/irqnr.h>
12 #include <linux/hardirq.h>
13 #include <linux/irqflags.h>
14 #include <linux/hrtimer.h>
15 #include <linux/kref.h>
16 #include <linux/workqueue.h>
18 #include <linux/atomic.h>
19 #include <asm/ptrace.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 an 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.
64 * IRQF_NO_SOFTIRQ_CALL - Do not process softirqs in the irq thread context (RT)
66 #define IRQF_SHARED 0x00000080
67 #define IRQF_PROBE_SHARED 0x00000100
68 #define __IRQF_TIMER 0x00000200
69 #define IRQF_PERCPU 0x00000400
70 #define IRQF_NOBALANCING 0x00000800
71 #define IRQF_IRQPOLL 0x00001000
72 #define IRQF_ONESHOT 0x00002000
73 #define IRQF_NO_SUSPEND 0x00004000
74 #define IRQF_FORCE_RESUME 0x00008000
75 #define IRQF_NO_THREAD 0x00010000
76 #define IRQF_EARLY_RESUME 0x00020000
77 #define IRQF_COND_SUSPEND 0x00040000
78 #define IRQF_NO_SOFTIRQ_CALL 0x00080000
80 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
83 * These values can be returned by request_any_context_irq() and
84 * describe the context the interrupt will be run in.
86 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
87 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
94 typedef irqreturn_t (*irq_handler_t)(int, void *);
97 * struct irqaction - per interrupt action descriptor
98 * @handler: interrupt handler function
99 * @name: name of the device
100 * @dev_id: cookie to identify the device
101 * @percpu_dev_id: cookie to identify the device
102 * @next: pointer to the next irqaction for shared interrupts
103 * @irq: interrupt number
104 * @flags: flags (see IRQF_* above)
105 * @thread_fn: interrupt handler function for threaded interrupts
106 * @thread: thread pointer for threaded interrupts
107 * @thread_flags: flags related to @thread
108 * @thread_mask: bitmask for keeping track of @thread activity
109 * @dir: pointer to the proc/irq/NN/name entry
112 irq_handler_t handler;
114 void __percpu *percpu_dev_id;
115 struct irqaction *next;
116 irq_handler_t thread_fn;
117 struct task_struct *thread;
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);
128 extern int __must_check
129 request_threaded_irq(unsigned int irq, irq_handler_t handler,
130 irq_handler_t thread_fn,
131 unsigned long flags, const char *name, void *dev);
133 static inline int __must_check
134 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
135 const char *name, void *dev)
137 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
140 extern int __must_check
141 request_any_context_irq(unsigned int irq, irq_handler_t handler,
142 unsigned long flags, const char *name, void *dev_id);
144 extern int __must_check
145 request_percpu_irq(unsigned int irq, irq_handler_t handler,
146 const char *devname, void __percpu *percpu_dev_id);
148 extern void free_irq(unsigned int, void *);
149 extern void free_percpu_irq(unsigned int, void __percpu *);
153 extern int __must_check
154 devm_request_threaded_irq(struct device *dev, unsigned int irq,
155 irq_handler_t handler, irq_handler_t thread_fn,
156 unsigned long irqflags, const char *devname,
159 static inline int __must_check
160 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
161 unsigned long irqflags, const char *devname, void *dev_id)
163 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
167 extern int __must_check
168 devm_request_any_context_irq(struct device *dev, unsigned int irq,
169 irq_handler_t handler, unsigned long irqflags,
170 const char *devname, void *dev_id);
172 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
175 * On lockdep we dont want to enable hardirqs in hardirq
176 * context. Use local_irq_enable_in_hardirq() to annotate
177 * kernel code that has to do this nevertheless (pretty much
178 * the only valid case is for old/broken hardware that is
181 * NOTE: in theory this might break fragile code that relies
182 * on hardirq delivery - in practice we dont seem to have such
183 * places left. So the only effect should be slightly increased
184 * irqs-off latencies.
186 #ifdef CONFIG_LOCKDEP
187 # define local_irq_enable_in_hardirq() do { } while (0)
189 # define local_irq_enable_in_hardirq() local_irq_enable_nort()
192 extern void disable_irq_nosync(unsigned int irq);
193 extern bool disable_hardirq(unsigned int irq);
194 extern void disable_irq(unsigned int irq);
195 extern void disable_percpu_irq(unsigned int irq);
196 extern void enable_irq(unsigned int irq);
197 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
198 extern void irq_wake_thread(unsigned int irq, void *dev_id);
200 /* The following three functions are for the core kernel use only. */
201 extern void suspend_device_irqs(void);
202 extern void resume_device_irqs(void);
205 * struct irq_affinity_notify - context for notification of IRQ affinity changes
206 * @irq: Interrupt to which notification applies
207 * @kref: Reference count, for internal use
208 * @work: Work item, for internal use
209 * @notify: Function to be called on change. This will be
210 * called in process context.
211 * @release: Function to be called on release. This will be
212 * called in process context. Once registered, the
213 * structure must only be freed when this function is
216 struct irq_affinity_notify {
219 struct work_struct work;
220 struct list_head list;
221 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
222 void (*release)(struct kref *ref);
225 #if defined(CONFIG_SMP)
227 extern cpumask_var_t irq_default_affinity;
229 /* Internal implementation. Use the helpers below */
230 extern int __irq_set_affinity(unsigned int irq, const struct cpumask *cpumask,
234 * irq_set_affinity - Set the irq affinity of a given irq
235 * @irq: Interrupt to set affinity
238 * Fails if cpumask does not contain an online CPU
241 irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
243 return __irq_set_affinity(irq, cpumask, false);
247 * irq_force_affinity - Force the irq affinity of a given irq
248 * @irq: Interrupt to set affinity
251 * Same as irq_set_affinity, but without checking the mask against
254 * Solely for low level cpu hotplug code, where we need to make per
255 * cpu interrupts affine before the cpu becomes online.
258 irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
260 return __irq_set_affinity(irq, cpumask, true);
263 extern int irq_can_set_affinity(unsigned int irq);
264 extern int irq_select_affinity(unsigned int irq);
266 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
269 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
271 #else /* CONFIG_SMP */
273 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
278 static inline int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
283 static inline int irq_can_set_affinity(unsigned int irq)
288 static inline int irq_select_affinity(unsigned int irq) { return 0; }
290 static inline int irq_set_affinity_hint(unsigned int irq,
291 const struct cpumask *m)
297 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
301 #endif /* CONFIG_SMP */
304 * Special lockdep variants of irq disabling/enabling.
305 * These should be used for locking constructs that
306 * know that a particular irq context which is disabled,
307 * and which is the only irq-context user of a lock,
308 * that it's safe to take the lock in the irq-disabled
309 * section without disabling hardirqs.
311 * On !CONFIG_LOCKDEP they are equivalent to the normal
312 * irq disable/enable methods.
314 static inline void disable_irq_nosync_lockdep(unsigned int irq)
316 disable_irq_nosync(irq);
317 #ifdef CONFIG_LOCKDEP
322 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
324 disable_irq_nosync(irq);
325 #ifdef CONFIG_LOCKDEP
326 local_irq_save(*flags);
330 static inline void disable_irq_lockdep(unsigned int irq)
333 #ifdef CONFIG_LOCKDEP
338 static inline void enable_irq_lockdep(unsigned int irq)
340 #ifdef CONFIG_LOCKDEP
346 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
348 #ifdef CONFIG_LOCKDEP
349 local_irq_restore(*flags);
354 /* IRQ wakeup (PM) control: */
355 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
357 static inline int enable_irq_wake(unsigned int irq)
359 return irq_set_irq_wake(irq, 1);
362 static inline int disable_irq_wake(unsigned int irq)
364 return irq_set_irq_wake(irq, 0);
368 * irq_get_irqchip_state/irq_set_irqchip_state specific flags
370 enum irqchip_irq_state {
371 IRQCHIP_STATE_PENDING, /* Is interrupt pending? */
372 IRQCHIP_STATE_ACTIVE, /* Is interrupt in progress? */
373 IRQCHIP_STATE_MASKED, /* Is interrupt masked? */
374 IRQCHIP_STATE_LINE_LEVEL, /* Is IRQ line high? */
377 extern int irq_get_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
379 extern int irq_set_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
382 #ifdef CONFIG_IRQ_FORCED_THREADING
383 # ifndef CONFIG_PREEMPT_RT_BASE
384 extern bool force_irqthreads;
386 # define force_irqthreads (true)
389 #define force_irqthreads (false)
392 #ifndef __ARCH_SET_SOFTIRQ_PENDING
393 #define set_softirq_pending(x) (local_softirq_pending() = (x))
394 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
397 /* Some architectures might implement lazy enabling/disabling of
398 * interrupts. In some cases, such as stop_machine, we might want
399 * to ensure that after a local_irq_disable(), interrupts have
400 * really been disabled in hardware. Such architectures need to
401 * implement the following hook.
403 #ifndef hard_irq_disable
404 #define hard_irq_disable() do { } while(0)
407 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
408 frequency threaded job scheduling. For almost all the purposes
409 tasklets are more than enough. F.e. all serial device BHs et
410 al. should be converted to tasklets, not to softirqs.
420 BLOCK_IOPOLL_SOFTIRQ,
424 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
429 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
431 /* map softirq index to softirq name. update 'softirq_to_name' in
432 * kernel/softirq.c when adding a new softirq.
434 extern const char * const softirq_to_name[NR_SOFTIRQS];
436 /* softirq mask and active fields moved to irq_cpustat_t in
437 * asm/hardirq.h to get better cache usage. KAO
440 struct softirq_action
442 void (*action)(struct softirq_action *);
445 #ifndef CONFIG_PREEMPT_RT_FULL
446 asmlinkage void do_softirq(void);
447 asmlinkage void __do_softirq(void);
448 static inline void thread_do_softirq(void) { do_softirq(); }
449 #ifdef __ARCH_HAS_DO_SOFTIRQ
450 void do_softirq_own_stack(void);
452 static inline void do_softirq_own_stack(void)
458 extern void thread_do_softirq(void);
461 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
462 extern void softirq_init(void);
463 extern void __raise_softirq_irqoff(unsigned int nr);
465 extern void raise_softirq_irqoff(unsigned int nr);
466 extern void raise_softirq(unsigned int nr);
467 extern void softirq_check_pending_idle(void);
469 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
471 static inline struct task_struct *this_cpu_ksoftirqd(void)
473 return this_cpu_read(ksoftirqd);
476 /* Tasklets --- multithreaded analogue of BHs.
478 Main feature differing them of generic softirqs: tasklet
479 is running only on one CPU simultaneously.
481 Main feature differing them of BHs: different tasklets
482 may be run simultaneously on different CPUs.
485 * If tasklet_schedule() is called, then tasklet is guaranteed
486 to be executed on some cpu at least once after this.
487 * If the tasklet is already scheduled, but its execution is still not
488 started, it will be executed only once.
489 * If this tasklet is already running on another CPU, it is rescheduled
491 * Schedule must not be called from the tasklet itself (a lockup occurs)
492 * Tasklet is strictly serialized wrt itself, but not
493 wrt another tasklets. If client needs some intertask synchronization,
494 he makes it with spinlocks.
497 struct tasklet_struct
499 struct tasklet_struct *next;
502 void (*func)(unsigned long);
506 #define DECLARE_TASKLET(name, func, data) \
507 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
509 #define DECLARE_TASKLET_DISABLED(name, func, data) \
510 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
515 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
516 TASKLET_STATE_RUN, /* Tasklet is running (SMP only) */
517 TASKLET_STATE_PENDING /* Tasklet is pending */
520 #define TASKLET_STATEF_SCHED (1 << TASKLET_STATE_SCHED)
521 #define TASKLET_STATEF_RUN (1 << TASKLET_STATE_RUN)
522 #define TASKLET_STATEF_PENDING (1 << TASKLET_STATE_PENDING)
524 #if defined(CONFIG_SMP) || defined(CONFIG_PREEMPT_RT_FULL)
525 static inline int tasklet_trylock(struct tasklet_struct *t)
527 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
530 static inline int tasklet_tryunlock(struct tasklet_struct *t)
532 return cmpxchg(&t->state, TASKLET_STATEF_RUN, 0) == TASKLET_STATEF_RUN;
535 static inline void tasklet_unlock(struct tasklet_struct *t)
537 smp_mb__before_atomic();
538 clear_bit(TASKLET_STATE_RUN, &(t)->state);
541 extern void tasklet_unlock_wait(struct tasklet_struct *t);
544 #define tasklet_trylock(t) 1
545 #define tasklet_tryunlock(t) 1
546 #define tasklet_unlock_wait(t) do { } while (0)
547 #define tasklet_unlock(t) do { } while (0)
550 extern void __tasklet_schedule(struct tasklet_struct *t);
552 static inline void tasklet_schedule(struct tasklet_struct *t)
554 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
555 __tasklet_schedule(t);
558 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
560 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
562 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
563 __tasklet_hi_schedule(t);
566 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
569 * This version avoids touching any other tasklets. Needed for kmemcheck
570 * in order not to take any page faults while enqueueing this tasklet;
571 * consider VERY carefully whether you really need this or
572 * tasklet_hi_schedule()...
574 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
576 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
577 __tasklet_hi_schedule_first(t);
581 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
583 atomic_inc(&t->count);
584 smp_mb__after_atomic();
587 static inline void tasklet_disable(struct tasklet_struct *t)
589 tasklet_disable_nosync(t);
590 tasklet_unlock_wait(t);
594 extern void tasklet_enable(struct tasklet_struct *t);
595 extern void tasklet_kill(struct tasklet_struct *t);
596 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
597 extern void tasklet_init(struct tasklet_struct *t,
598 void (*func)(unsigned long), unsigned long data);
600 struct tasklet_hrtimer {
601 struct hrtimer timer;
602 struct tasklet_struct tasklet;
603 enum hrtimer_restart (*function)(struct hrtimer *);
607 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
608 enum hrtimer_restart (*function)(struct hrtimer *),
609 clockid_t which_clock, enum hrtimer_mode mode);
612 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
613 const enum hrtimer_mode mode)
615 return hrtimer_start(&ttimer->timer, time, mode);
619 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
621 hrtimer_cancel(&ttimer->timer);
622 tasklet_kill(&ttimer->tasklet);
625 #ifdef CONFIG_PREEMPT_RT_FULL
626 extern void softirq_early_init(void);
628 static inline void softirq_early_init(void) { }
632 * Autoprobing for irqs:
634 * probe_irq_on() and probe_irq_off() provide robust primitives
635 * for accurate IRQ probing during kernel initialization. They are
636 * reasonably simple to use, are not "fooled" by spurious interrupts,
637 * and, unlike other attempts at IRQ probing, they do not get hung on
638 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
640 * For reasonably foolproof probing, use them as follows:
642 * 1. clear and/or mask the device's internal interrupt.
644 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
645 * 4. enable the device and cause it to trigger an interrupt.
646 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
647 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
648 * 7. service the device to clear its pending interrupt.
649 * 8. loop again if paranoia is required.
651 * probe_irq_on() returns a mask of allocated irq's.
653 * probe_irq_off() takes the mask as a parameter,
654 * and returns the irq number which occurred,
655 * or zero if none occurred, or a negative irq number
656 * if more than one irq occurred.
659 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
660 static inline unsigned long probe_irq_on(void)
664 static inline int probe_irq_off(unsigned long val)
668 static inline unsigned int probe_irq_mask(unsigned long val)
673 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
674 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
675 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
678 #ifdef CONFIG_PROC_FS
679 /* Initialize /proc/irq/ */
680 extern void init_irq_proc(void);
682 static inline void init_irq_proc(void)
688 int show_interrupts(struct seq_file *p, void *v);
689 int arch_show_interrupts(struct seq_file *p, int prec);
691 extern int early_irq_init(void);
692 extern int arch_probe_nr_irqs(void);
693 extern int arch_early_irq_init(void);