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/smp.h>
15 #include <linux/percpu.h>
16 #include <linux/hrtimer.h>
17 #include <linux/kref.h>
18 #include <linux/workqueue.h>
20 #include <linux/atomic.h>
21 #include <asm/ptrace.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_DISABLED - keep irqs disabled when calling the action handler.
44 * DEPRECATED. This flag is a NOOP and scheduled to be removed
45 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
46 * IRQF_SHARED - allow sharing the irq among several devices
47 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
48 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
49 * IRQF_PERCPU - Interrupt is per cpu
50 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
51 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
52 * registered first in an shared interrupt is considered for
53 * performance reasons)
54 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
55 * Used by threaded interrupts which need to keep the
56 * irq line disabled until the threaded handler has been run.
57 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
58 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
59 * IRQF_NO_THREAD - Interrupt cannot be threaded
60 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
63 #define IRQF_DISABLED 0x00000020
64 #define IRQF_SAMPLE_RANDOM 0x00000040
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
77 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
80 * These values can be returned by request_any_context_irq() and
81 * describe the context the interrupt will be run in.
83 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
84 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
91 typedef irqreturn_t (*irq_handler_t)(int, void *);
94 * struct irqaction - per interrupt action descriptor
95 * @handler: interrupt handler function
96 * @flags: flags (see IRQF_* above)
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 * @dir: pointer to the proc/irq/NN/name entry
103 * @thread_fn: interrupt handler function for threaded interrupts
104 * @thread: thread pointer for threaded interrupts
105 * @thread_flags: flags related to @thread
106 * @thread_mask: bitmask for keeping track of @thread activity
109 irq_handler_t handler;
112 void __percpu *percpu_dev_id;
113 struct irqaction *next;
115 irq_handler_t thread_fn;
116 struct task_struct *thread;
117 unsigned long thread_flags;
118 unsigned long thread_mask;
120 struct proc_dir_entry *dir;
121 } ____cacheline_internodealigned_in_smp;
123 extern irqreturn_t no_action(int cpl, void *dev_id);
125 #ifdef CONFIG_GENERIC_HARDIRQS
126 extern int __must_check
127 request_threaded_irq(unsigned int irq, irq_handler_t handler,
128 irq_handler_t thread_fn,
129 unsigned long flags, const char *name, void *dev);
131 static inline int __must_check
132 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
133 const char *name, void *dev)
135 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
138 extern int __must_check
139 request_any_context_irq(unsigned int irq, irq_handler_t handler,
140 unsigned long flags, const char *name, void *dev_id);
142 extern int __must_check
143 request_percpu_irq(unsigned int irq, irq_handler_t handler,
144 const char *devname, void __percpu *percpu_dev_id);
146 extern void exit_irq_thread(void);
149 extern int __must_check
150 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
151 const char *name, void *dev);
154 * Special function to avoid ifdeffery in kernel/irq/devres.c which
155 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
156 * m68k). I really love these $@%#!* obvious Makefile references:
157 * ../../../kernel/irq/devres.o
159 static inline int __must_check
160 request_threaded_irq(unsigned int irq, irq_handler_t handler,
161 irq_handler_t thread_fn,
162 unsigned long flags, const char *name, void *dev)
164 return request_irq(irq, handler, flags, name, dev);
167 static inline int __must_check
168 request_any_context_irq(unsigned int irq, irq_handler_t handler,
169 unsigned long flags, const char *name, void *dev_id)
171 return request_irq(irq, handler, flags, name, dev_id);
174 static inline int __must_check
175 request_percpu_irq(unsigned int irq, irq_handler_t handler,
176 const char *devname, void __percpu *percpu_dev_id)
178 return request_irq(irq, handler, 0, devname, percpu_dev_id);
181 static inline void exit_irq_thread(void) { }
184 extern void free_irq(unsigned int, void *);
185 extern void free_percpu_irq(unsigned int, void __percpu *);
189 extern int __must_check
190 devm_request_threaded_irq(struct device *dev, unsigned int irq,
191 irq_handler_t handler, irq_handler_t thread_fn,
192 unsigned long irqflags, const char *devname,
195 static inline int __must_check
196 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
197 unsigned long irqflags, const char *devname, void *dev_id)
199 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
203 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
206 * On lockdep we dont want to enable hardirqs in hardirq
207 * context. Use local_irq_enable_in_hardirq() to annotate
208 * kernel code that has to do this nevertheless (pretty much
209 * the only valid case is for old/broken hardware that is
212 * NOTE: in theory this might break fragile code that relies
213 * on hardirq delivery - in practice we dont seem to have such
214 * places left. So the only effect should be slightly increased
215 * irqs-off latencies.
217 #ifdef CONFIG_LOCKDEP
218 # define local_irq_enable_in_hardirq() do { } while (0)
220 # define local_irq_enable_in_hardirq() local_irq_enable()
223 extern void disable_irq_nosync(unsigned int irq);
224 extern void disable_irq(unsigned int irq);
225 extern void disable_percpu_irq(unsigned int irq);
226 extern void enable_irq(unsigned int irq);
227 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
229 /* The following three functions are for the core kernel use only. */
230 #ifdef CONFIG_GENERIC_HARDIRQS
231 extern void suspend_device_irqs(void);
232 extern void resume_device_irqs(void);
233 #ifdef CONFIG_PM_SLEEP
234 extern int check_wakeup_irqs(void);
236 static inline int check_wakeup_irqs(void) { return 0; }
239 static inline void suspend_device_irqs(void) { };
240 static inline void resume_device_irqs(void) { };
241 static inline int check_wakeup_irqs(void) { return 0; }
244 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
246 extern cpumask_var_t irq_default_affinity;
248 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
249 extern int irq_can_set_affinity(unsigned int irq);
250 extern int irq_select_affinity(unsigned int irq);
252 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
255 * struct irq_affinity_notify - context for notification of IRQ affinity changes
256 * @irq: Interrupt to which notification applies
257 * @kref: Reference count, for internal use
258 * @work: Work item, for internal use
259 * @notify: Function to be called on change. This will be
260 * called in process context.
261 * @release: Function to be called on release. This will be
262 * called in process context. Once registered, the
263 * structure must only be freed when this function is
266 struct irq_affinity_notify {
269 struct work_struct work;
270 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
271 void (*release)(struct kref *ref);
275 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
277 static inline void irq_run_affinity_notifiers(void)
279 flush_scheduled_work();
282 #else /* CONFIG_SMP */
284 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
289 static inline int irq_can_set_affinity(unsigned int irq)
294 static inline int irq_select_affinity(unsigned int irq) { return 0; }
296 static inline int irq_set_affinity_hint(unsigned int irq,
297 const struct cpumask *m)
301 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
303 #ifdef CONFIG_GENERIC_HARDIRQS
305 * Special lockdep variants of irq disabling/enabling.
306 * These should be used for locking constructs that
307 * know that a particular irq context which is disabled,
308 * and which is the only irq-context user of a lock,
309 * that it's safe to take the lock in the irq-disabled
310 * section without disabling hardirqs.
312 * On !CONFIG_LOCKDEP they are equivalent to the normal
313 * irq disable/enable methods.
315 static inline void disable_irq_nosync_lockdep(unsigned int irq)
317 disable_irq_nosync(irq);
318 #ifdef CONFIG_LOCKDEP
323 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
325 disable_irq_nosync(irq);
326 #ifdef CONFIG_LOCKDEP
327 local_irq_save(*flags);
331 static inline void disable_irq_lockdep(unsigned int irq)
334 #ifdef CONFIG_LOCKDEP
339 static inline void enable_irq_lockdep(unsigned int irq)
341 #ifdef CONFIG_LOCKDEP
347 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
349 #ifdef CONFIG_LOCKDEP
350 local_irq_restore(*flags);
355 /* IRQ wakeup (PM) control: */
356 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
358 static inline int enable_irq_wake(unsigned int irq)
360 return irq_set_irq_wake(irq, 1);
363 static inline int disable_irq_wake(unsigned int irq)
365 return irq_set_irq_wake(irq, 0);
368 #else /* !CONFIG_GENERIC_HARDIRQS */
370 * NOTE: non-genirq architectures, if they want to support the lock
371 * validator need to define the methods below in their asm/irq.h
372 * files, under an #ifdef CONFIG_LOCKDEP section.
374 #ifndef CONFIG_LOCKDEP
375 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
376 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
377 disable_irq_nosync(irq)
378 # define disable_irq_lockdep(irq) disable_irq(irq)
379 # define enable_irq_lockdep(irq) enable_irq(irq)
380 # define enable_irq_lockdep_irqrestore(irq, flags) \
384 static inline int enable_irq_wake(unsigned int irq)
389 static inline int disable_irq_wake(unsigned int irq)
393 #endif /* CONFIG_GENERIC_HARDIRQS */
395 #ifdef CONFIG_HAVE_IRQ_IGNORE_UNHANDLED
396 int irq_ignore_unhandled(unsigned int irq);
398 #define irq_ignore_unhandled(irq) 0
401 #ifdef CONFIG_IRQ_FORCED_THREADING
402 extern bool force_irqthreads;
404 #define force_irqthreads (0)
407 #ifndef __ARCH_SET_SOFTIRQ_PENDING
408 #define set_softirq_pending(x) (local_softirq_pending() = (x))
409 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
412 /* Some architectures might implement lazy enabling/disabling of
413 * interrupts. In some cases, such as stop_machine, we might want
414 * to ensure that after a local_irq_disable(), interrupts have
415 * really been disabled in hardware. Such architectures need to
416 * implement the following hook.
418 #ifndef hard_irq_disable
419 #define hard_irq_disable() do { } while(0)
422 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
423 frequency threaded job scheduling. For almost all the purposes
424 tasklets are more than enough. F.e. all serial device BHs et
425 al. should be converted to tasklets, not to softirqs.
435 BLOCK_IOPOLL_SOFTIRQ,
439 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
444 /* map softirq index to softirq name. update 'softirq_to_name' in
445 * kernel/softirq.c when adding a new softirq.
447 extern char *softirq_to_name[NR_SOFTIRQS];
449 /* softirq mask and active fields moved to irq_cpustat_t in
450 * asm/hardirq.h to get better cache usage. KAO
453 struct softirq_action
455 void (*action)(struct softirq_action *);
458 asmlinkage void do_softirq(void);
459 asmlinkage void __do_softirq(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 /* This is the worklist that queues up per-cpu softirq work.
469 * send_remote_sendirq() adds work to these lists, and
470 * the softirq handler itself dequeues from them. The queues
471 * are protected by disabling local cpu interrupts and they must
472 * only be accessed by the local cpu that they are for.
474 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
476 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
478 static inline struct task_struct *this_cpu_ksoftirqd(void)
480 return this_cpu_read(ksoftirqd);
483 /* Try to send a softirq to a remote cpu. If this cannot be done, the
484 * work will be queued to the local cpu.
486 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
488 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
489 * and compute the current cpu, passed in as 'this_cpu'.
491 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
492 int this_cpu, int softirq);
494 /* Tasklets --- multithreaded analogue of BHs.
496 Main feature differing them of generic softirqs: tasklet
497 is running only on one CPU simultaneously.
499 Main feature differing them of BHs: different tasklets
500 may be run simultaneously on different CPUs.
503 * If tasklet_schedule() is called, then tasklet is guaranteed
504 to be executed on some cpu at least once after this.
505 * If the tasklet is already scheduled, but its execution is still not
506 started, it will be executed only once.
507 * If this tasklet is already running on another CPU (or schedule is called
508 from tasklet itself), it is rescheduled for later.
509 * Tasklet is strictly serialized wrt itself, but not
510 wrt another tasklets. If client needs some intertask synchronization,
511 he makes it with spinlocks.
514 struct tasklet_struct
516 struct tasklet_struct *next;
519 void (*func)(unsigned long);
523 #define DECLARE_TASKLET(name, func, data) \
524 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
526 #define DECLARE_TASKLET_DISABLED(name, func, data) \
527 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
532 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
533 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
537 static inline int tasklet_trylock(struct tasklet_struct *t)
539 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
542 static inline void tasklet_unlock(struct tasklet_struct *t)
544 smp_mb__before_clear_bit();
545 clear_bit(TASKLET_STATE_RUN, &(t)->state);
548 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
550 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
553 #define tasklet_trylock(t) 1
554 #define tasklet_unlock_wait(t) do { } while (0)
555 #define tasklet_unlock(t) do { } while (0)
558 extern void __tasklet_schedule(struct tasklet_struct *t);
560 static inline void tasklet_schedule(struct tasklet_struct *t)
562 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
563 __tasklet_schedule(t);
566 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
568 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
570 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
571 __tasklet_hi_schedule(t);
574 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
577 * This version avoids touching any other tasklets. Needed for kmemcheck
578 * in order not to take any page faults while enqueueing this tasklet;
579 * consider VERY carefully whether you really need this or
580 * tasklet_hi_schedule()...
582 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
584 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
585 __tasklet_hi_schedule_first(t);
589 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
591 atomic_inc(&t->count);
592 smp_mb__after_atomic_inc();
595 static inline void tasklet_disable(struct tasklet_struct *t)
597 tasklet_disable_nosync(t);
598 tasklet_unlock_wait(t);
602 static inline void tasklet_enable(struct tasklet_struct *t)
604 smp_mb__before_atomic_dec();
605 atomic_dec(&t->count);
608 static inline void tasklet_hi_enable(struct tasklet_struct *t)
610 smp_mb__before_atomic_dec();
611 atomic_dec(&t->count);
614 extern void tasklet_kill(struct tasklet_struct *t);
615 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
616 extern void tasklet_init(struct tasklet_struct *t,
617 void (*func)(unsigned long), unsigned long data);
619 struct tasklet_hrtimer {
620 struct hrtimer timer;
621 struct tasklet_struct tasklet;
622 enum hrtimer_restart (*function)(struct hrtimer *);
626 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
627 enum hrtimer_restart (*function)(struct hrtimer *),
628 clockid_t which_clock, enum hrtimer_mode mode);
631 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
632 const enum hrtimer_mode mode)
634 return hrtimer_start(&ttimer->timer, time, mode);
638 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
640 hrtimer_cancel(&ttimer->timer);
641 tasklet_kill(&ttimer->tasklet);
645 * Autoprobing for irqs:
647 * probe_irq_on() and probe_irq_off() provide robust primitives
648 * for accurate IRQ probing during kernel initialization. They are
649 * reasonably simple to use, are not "fooled" by spurious interrupts,
650 * and, unlike other attempts at IRQ probing, they do not get hung on
651 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
653 * For reasonably foolproof probing, use them as follows:
655 * 1. clear and/or mask the device's internal interrupt.
657 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
658 * 4. enable the device and cause it to trigger an interrupt.
659 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
660 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
661 * 7. service the device to clear its pending interrupt.
662 * 8. loop again if paranoia is required.
664 * probe_irq_on() returns a mask of allocated irq's.
666 * probe_irq_off() takes the mask as a parameter,
667 * and returns the irq number which occurred,
668 * or zero if none occurred, or a negative irq number
669 * if more than one irq occurred.
672 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
673 static inline unsigned long probe_irq_on(void)
677 static inline int probe_irq_off(unsigned long val)
681 static inline unsigned int probe_irq_mask(unsigned long val)
686 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
687 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
688 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
691 #ifdef CONFIG_PROC_FS
692 /* Initialize /proc/irq/ */
693 extern void init_irq_proc(void);
695 static inline void init_irq_proc(void)
701 int show_interrupts(struct seq_file *p, void *v);
702 int arch_show_interrupts(struct seq_file *p, int prec);
704 extern int early_irq_init(void);
705 extern int arch_probe_nr_irqs(void);
706 extern int arch_early_irq_init(void);