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>
21 #include <asm/sections.h>
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.
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
40 * These flags used only by the kernel as part of the
41 * irq handling routines.
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
46 * IRQF_PERCPU - Interrupt is per cpu
47 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
48 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
49 * registered first in an shared interrupt is considered for
50 * performance reasons)
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.
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
56 * state. See Documentation/power/suspend-and-interrupts.txt
57 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
58 * IRQF_NO_THREAD - Interrupt cannot be threaded
59 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
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.
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
79 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
82 * These values can be returned by request_any_context_irq() and
83 * describe the context the interrupt will be run in.
85 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
86 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
93 typedef irqreturn_t (*irq_handler_t)(int, void *);
96 * struct irqaction - per interrupt action descriptor
97 * @handler: interrupt handler function
98 * @name: name of the device
99 * @dev_id: cookie to identify the device
100 * @percpu_dev_id: cookie to identify the device
101 * @next: pointer to the next irqaction for shared interrupts
102 * @irq: interrupt number
103 * @flags: flags (see IRQF_* above)
104 * @thread_fn: interrupt handler function for threaded interrupts
105 * @thread: thread pointer for threaded interrupts
106 * @secondary: pointer to secondary irqaction (force threading)
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;
118 struct irqaction *secondary;
121 unsigned long thread_flags;
122 unsigned long thread_mask;
124 struct proc_dir_entry *dir;
125 } ____cacheline_internodealigned_in_smp;
127 extern irqreturn_t no_action(int cpl, void *dev_id);
129 extern int __must_check
130 request_threaded_irq(unsigned int irq, irq_handler_t handler,
131 irq_handler_t thread_fn,
132 unsigned long flags, const char *name, void *dev);
134 static inline int __must_check
135 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
136 const char *name, void *dev)
138 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
141 extern int __must_check
142 request_any_context_irq(unsigned int irq, irq_handler_t handler,
143 unsigned long flags, const char *name, void *dev_id);
145 extern int __must_check
146 request_percpu_irq(unsigned int irq, irq_handler_t handler,
147 const char *devname, void __percpu *percpu_dev_id);
149 extern void free_irq(unsigned int, void *);
150 extern void free_percpu_irq(unsigned int, void __percpu *);
154 extern int __must_check
155 devm_request_threaded_irq(struct device *dev, unsigned int irq,
156 irq_handler_t handler, irq_handler_t thread_fn,
157 unsigned long irqflags, const char *devname,
160 static inline int __must_check
161 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
162 unsigned long irqflags, const char *devname, void *dev_id)
164 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
168 extern int __must_check
169 devm_request_any_context_irq(struct device *dev, unsigned int irq,
170 irq_handler_t handler, unsigned long irqflags,
171 const char *devname, void *dev_id);
173 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
176 * On lockdep we dont want to enable hardirqs in hardirq
177 * context. Use local_irq_enable_in_hardirq() to annotate
178 * kernel code that has to do this nevertheless (pretty much
179 * the only valid case is for old/broken hardware that is
182 * NOTE: in theory this might break fragile code that relies
183 * on hardirq delivery - in practice we dont seem to have such
184 * places left. So the only effect should be slightly increased
185 * irqs-off latencies.
187 #ifdef CONFIG_LOCKDEP
188 # define local_irq_enable_in_hardirq() do { } while (0)
190 # define local_irq_enable_in_hardirq() local_irq_enable()
193 extern void disable_irq_nosync(unsigned int irq);
194 extern bool disable_hardirq(unsigned int irq);
195 extern void disable_irq(unsigned int irq);
196 extern void disable_percpu_irq(unsigned int irq);
197 extern void enable_irq(unsigned int irq);
198 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
199 extern void irq_wake_thread(unsigned int irq, void *dev_id);
201 /* The following three functions are for the core kernel use only. */
202 extern void suspend_device_irqs(void);
203 extern void resume_device_irqs(void);
206 * struct irq_affinity_notify - context for notification of IRQ affinity changes
207 * @irq: Interrupt to which notification applies
208 * @kref: Reference count, for internal use
209 * @work: Work item, for internal use
210 * @notify: Function to be called on change. This will be
211 * called in process context.
212 * @release: Function to be called on release. This will be
213 * called in process context. Once registered, the
214 * structure must only be freed when this function is
217 struct irq_affinity_notify {
220 struct work_struct work;
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 extern bool force_irqthreads;
385 #define force_irqthreads (0)
388 #ifndef __ARCH_SET_SOFTIRQ_PENDING
389 #define set_softirq_pending(x) (local_softirq_pending() = (x))
390 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
393 /* Some architectures might implement lazy enabling/disabling of
394 * interrupts. In some cases, such as stop_machine, we might want
395 * to ensure that after a local_irq_disable(), interrupts have
396 * really been disabled in hardware. Such architectures need to
397 * implement the following hook.
399 #ifndef hard_irq_disable
400 #define hard_irq_disable() do { } while(0)
403 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
404 frequency threaded job scheduling. For almost all the purposes
405 tasklets are more than enough. F.e. all serial device BHs et
406 al. should be converted to tasklets, not to softirqs.
416 BLOCK_IOPOLL_SOFTIRQ,
419 HRTIMER_SOFTIRQ, /* Unused, but kept as tools rely on the
421 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
426 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
427 /* Softirq's where the handling might be long: */
428 #define LONG_SOFTIRQ_MASK ((1 << NET_TX_SOFTIRQ) | \
429 (1 << NET_RX_SOFTIRQ) | \
430 (1 << BLOCK_SOFTIRQ) | \
431 (1 << BLOCK_IOPOLL_SOFTIRQ) | \
432 (1 << TASKLET_SOFTIRQ))
434 /* map softirq index to softirq name. update 'softirq_to_name' in
435 * kernel/softirq.c when adding a new softirq.
437 extern const char * const softirq_to_name[NR_SOFTIRQS];
439 /* softirq mask and active fields moved to irq_cpustat_t in
440 * asm/hardirq.h to get better cache usage. KAO
443 struct softirq_action
445 void (*action)(struct softirq_action *);
448 asmlinkage void do_softirq(void);
449 asmlinkage void __do_softirq(void);
451 #ifdef __ARCH_HAS_DO_SOFTIRQ
452 void do_softirq_own_stack(void);
454 static inline void do_softirq_own_stack(void)
460 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
461 extern void softirq_init(void);
462 extern void __raise_softirq_irqoff(unsigned int nr);
464 extern void raise_softirq_irqoff(unsigned int nr);
465 extern void raise_softirq(unsigned int nr);
467 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
468 DECLARE_PER_CPU(__u32, active_softirqs);
470 static inline struct task_struct *this_cpu_ksoftirqd(void)
472 return this_cpu_read(ksoftirqd);
475 /* Tasklets --- multithreaded analogue of BHs.
477 Main feature differing them of generic softirqs: tasklet
478 is running only on one CPU simultaneously.
480 Main feature differing them of BHs: different tasklets
481 may be run simultaneously on different CPUs.
484 * If tasklet_schedule() is called, then tasklet is guaranteed
485 to be executed on some cpu at least once after this.
486 * If the tasklet is already scheduled, but its execution is still not
487 started, it will be executed only once.
488 * If this tasklet is already running on another CPU (or schedule is called
489 from tasklet itself), it is rescheduled for later.
490 * Tasklet is strictly serialized wrt itself, but not
491 wrt another tasklets. If client needs some intertask synchronization,
492 he makes it with spinlocks.
495 struct tasklet_struct
497 struct tasklet_struct *next;
500 void (*func)(unsigned long);
504 #define DECLARE_TASKLET(name, func, data) \
505 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
507 #define DECLARE_TASKLET_DISABLED(name, func, data) \
508 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
513 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
514 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
518 static inline int tasklet_trylock(struct tasklet_struct *t)
520 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
523 static inline void tasklet_unlock(struct tasklet_struct *t)
525 smp_mb__before_atomic();
526 clear_bit(TASKLET_STATE_RUN, &(t)->state);
529 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
531 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
534 #define tasklet_trylock(t) 1
535 #define tasklet_unlock_wait(t) do { } while (0)
536 #define tasklet_unlock(t) do { } while (0)
539 extern void __tasklet_schedule(struct tasklet_struct *t);
541 static inline void tasklet_schedule(struct tasklet_struct *t)
543 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
544 __tasklet_schedule(t);
547 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
549 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
551 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
552 __tasklet_hi_schedule(t);
555 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
558 * This version avoids touching any other tasklets. Needed for kmemcheck
559 * in order not to take any page faults while enqueueing this tasklet;
560 * consider VERY carefully whether you really need this or
561 * tasklet_hi_schedule()...
563 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
565 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
566 __tasklet_hi_schedule_first(t);
570 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
572 atomic_inc(&t->count);
573 smp_mb__after_atomic();
576 static inline void tasklet_disable(struct tasklet_struct *t)
578 tasklet_disable_nosync(t);
579 tasklet_unlock_wait(t);
583 static inline void tasklet_enable(struct tasklet_struct *t)
585 smp_mb__before_atomic();
586 atomic_dec(&t->count);
589 extern void tasklet_kill(struct tasklet_struct *t);
590 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
591 extern void tasklet_init(struct tasklet_struct *t,
592 void (*func)(unsigned long), unsigned long data);
594 struct tasklet_hrtimer {
595 struct hrtimer timer;
596 struct tasklet_struct tasklet;
597 enum hrtimer_restart (*function)(struct hrtimer *);
601 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
602 enum hrtimer_restart (*function)(struct hrtimer *),
603 clockid_t which_clock, enum hrtimer_mode mode);
606 void tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
607 const enum hrtimer_mode mode)
609 hrtimer_start(&ttimer->timer, time, mode);
613 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
615 hrtimer_cancel(&ttimer->timer);
616 tasklet_kill(&ttimer->tasklet);
620 * Autoprobing for irqs:
622 * probe_irq_on() and probe_irq_off() provide robust primitives
623 * for accurate IRQ probing during kernel initialization. They are
624 * reasonably simple to use, are not "fooled" by spurious interrupts,
625 * and, unlike other attempts at IRQ probing, they do not get hung on
626 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
628 * For reasonably foolproof probing, use them as follows:
630 * 1. clear and/or mask the device's internal interrupt.
632 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
633 * 4. enable the device and cause it to trigger an interrupt.
634 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
635 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
636 * 7. service the device to clear its pending interrupt.
637 * 8. loop again if paranoia is required.
639 * probe_irq_on() returns a mask of allocated irq's.
641 * probe_irq_off() takes the mask as a parameter,
642 * and returns the irq number which occurred,
643 * or zero if none occurred, or a negative irq number
644 * if more than one irq occurred.
647 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
648 static inline unsigned long probe_irq_on(void)
652 static inline int probe_irq_off(unsigned long val)
656 static inline unsigned int probe_irq_mask(unsigned long val)
661 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
662 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
663 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
666 #ifdef CONFIG_PROC_FS
667 /* Initialize /proc/irq/ */
668 extern void init_irq_proc(void);
670 static inline void init_irq_proc(void)
676 int show_interrupts(struct seq_file *p, void *v);
677 int arch_show_interrupts(struct seq_file *p, int prec);
679 extern int early_irq_init(void);
680 extern int arch_probe_nr_irqs(void);
681 extern int arch_early_irq_init(void);
684 * We want to know which function is an entrypoint of a hardirq or a softirq.
686 #define __irq_entry __attribute__((__section__(".irqentry.text")))
687 #define __softirq_entry \
688 __attribute__((__section__(".softirqentry.text")))