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>
25 * These correspond to the IORESOURCE_IRQ_* defines in
26 * linux/ioport.h to select the interrupt line behaviour. When
27 * requesting an interrupt without specifying a IRQF_TRIGGER, the
28 * setting should be assumed to be "as already configured", which
29 * may be as per machine or firmware initialisation.
31 #define IRQF_TRIGGER_NONE 0x00000000
32 #define IRQF_TRIGGER_RISING 0x00000001
33 #define IRQF_TRIGGER_FALLING 0x00000002
34 #define IRQF_TRIGGER_HIGH 0x00000004
35 #define IRQF_TRIGGER_LOW 0x00000008
36 #define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
37 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
38 #define IRQF_TRIGGER_PROBE 0x00000010
41 * These flags used only by the kernel as part of the
42 * irq handling routines.
44 * IRQF_DISABLED - keep irqs disabled when calling the action handler.
45 * DEPRECATED. This flag is a NOOP and scheduled to be removed
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_SHARED 0x00000080
65 #define IRQF_PROBE_SHARED 0x00000100
66 #define __IRQF_TIMER 0x00000200
67 #define IRQF_PERCPU 0x00000400
68 #define IRQF_NOBALANCING 0x00000800
69 #define IRQF_IRQPOLL 0x00001000
70 #define IRQF_ONESHOT 0x00002000
71 #define IRQF_NO_SUSPEND 0x00004000
72 #define IRQF_FORCE_RESUME 0x00008000
73 #define IRQF_NO_THREAD 0x00010000
74 #define IRQF_EARLY_RESUME 0x00020000
76 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
79 * These values can be returned by request_any_context_irq() and
80 * describe the context the interrupt will be run in.
82 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
83 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
90 typedef irqreturn_t (*irq_handler_t)(int, void *);
93 * struct irqaction - per interrupt action descriptor
94 * @handler: interrupt handler function
95 * @name: name of the device
96 * @dev_id: cookie to identify the device
97 * @percpu_dev_id: cookie to identify the device
98 * @next: pointer to the next irqaction for shared interrupts
99 * @irq: interrupt number
100 * @flags: flags (see IRQF_* above)
101 * @thread_fn: interrupt handler function for threaded interrupts
102 * @thread: thread pointer for threaded interrupts
103 * @thread_flags: flags related to @thread
104 * @thread_mask: bitmask for keeping track of @thread activity
105 * @dir: pointer to the proc/irq/NN/name entry
108 irq_handler_t handler;
110 void __percpu *percpu_dev_id;
111 struct irqaction *next;
112 irq_handler_t thread_fn;
113 struct task_struct *thread;
116 unsigned long thread_flags;
117 unsigned long thread_mask;
119 struct proc_dir_entry *dir;
120 } ____cacheline_internodealigned_in_smp;
122 extern irqreturn_t no_action(int cpl, void *dev_id);
124 extern int __must_check
125 request_threaded_irq(unsigned int irq, irq_handler_t handler,
126 irq_handler_t thread_fn,
127 unsigned long flags, const char *name, void *dev);
129 static inline int __must_check
130 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
131 const char *name, void *dev)
133 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
136 extern int __must_check
137 request_any_context_irq(unsigned int irq, irq_handler_t handler,
138 unsigned long flags, const char *name, void *dev_id);
140 extern int __must_check
141 request_percpu_irq(unsigned int irq, irq_handler_t handler,
142 const char *devname, void __percpu *percpu_dev_id);
144 extern void free_irq(unsigned int, void *);
145 extern void free_percpu_irq(unsigned int, void __percpu *);
149 extern int __must_check
150 devm_request_threaded_irq(struct device *dev, unsigned int irq,
151 irq_handler_t handler, irq_handler_t thread_fn,
152 unsigned long irqflags, const char *devname,
155 static inline int __must_check
156 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
157 unsigned long irqflags, const char *devname, void *dev_id)
159 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
163 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
166 * On lockdep we dont want to enable hardirqs in hardirq
167 * context. Use local_irq_enable_in_hardirq() to annotate
168 * kernel code that has to do this nevertheless (pretty much
169 * the only valid case is for old/broken hardware that is
172 * NOTE: in theory this might break fragile code that relies
173 * on hardirq delivery - in practice we dont seem to have such
174 * places left. So the only effect should be slightly increased
175 * irqs-off latencies.
177 #ifdef CONFIG_LOCKDEP
178 # define local_irq_enable_in_hardirq() do { } while (0)
180 # define local_irq_enable_in_hardirq() local_irq_enable()
183 extern void disable_irq_nosync(unsigned int irq);
184 extern void disable_irq(unsigned int irq);
185 extern void disable_percpu_irq(unsigned int irq);
186 extern void enable_irq(unsigned int irq);
187 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
189 /* The following three functions are for the core kernel use only. */
190 extern void suspend_device_irqs(void);
191 extern void resume_device_irqs(void);
192 #ifdef CONFIG_PM_SLEEP
193 extern int check_wakeup_irqs(void);
195 static inline int check_wakeup_irqs(void) { return 0; }
198 #if defined(CONFIG_SMP)
200 extern cpumask_var_t irq_default_affinity;
202 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
203 extern int irq_can_set_affinity(unsigned int irq);
204 extern int irq_select_affinity(unsigned int irq);
206 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
209 * struct irq_affinity_notify - context for notification of IRQ affinity changes
210 * @irq: Interrupt to which notification applies
211 * @kref: Reference count, for internal use
212 * @work: Work item, for internal use
213 * @notify: Function to be called on change. This will be
214 * called in process context.
215 * @release: Function to be called on release. This will be
216 * called in process context. Once registered, the
217 * structure must only be freed when this function is
220 struct irq_affinity_notify {
223 struct work_struct work;
224 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
225 void (*release)(struct kref *ref);
229 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
231 #else /* CONFIG_SMP */
233 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
238 static inline int irq_can_set_affinity(unsigned int irq)
243 static inline int irq_select_affinity(unsigned int irq) { return 0; }
245 static inline int irq_set_affinity_hint(unsigned int irq,
246 const struct cpumask *m)
250 #endif /* CONFIG_SMP */
253 * Special lockdep variants of irq disabling/enabling.
254 * These should be used for locking constructs that
255 * know that a particular irq context which is disabled,
256 * and which is the only irq-context user of a lock,
257 * that it's safe to take the lock in the irq-disabled
258 * section without disabling hardirqs.
260 * On !CONFIG_LOCKDEP they are equivalent to the normal
261 * irq disable/enable methods.
263 static inline void disable_irq_nosync_lockdep(unsigned int irq)
265 disable_irq_nosync(irq);
266 #ifdef CONFIG_LOCKDEP
271 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
273 disable_irq_nosync(irq);
274 #ifdef CONFIG_LOCKDEP
275 local_irq_save(*flags);
279 static inline void disable_irq_lockdep(unsigned int irq)
282 #ifdef CONFIG_LOCKDEP
287 static inline void enable_irq_lockdep(unsigned int irq)
289 #ifdef CONFIG_LOCKDEP
295 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
297 #ifdef CONFIG_LOCKDEP
298 local_irq_restore(*flags);
303 /* IRQ wakeup (PM) control: */
304 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
306 static inline int enable_irq_wake(unsigned int irq)
308 return irq_set_irq_wake(irq, 1);
311 static inline int disable_irq_wake(unsigned int irq)
313 return irq_set_irq_wake(irq, 0);
317 #ifdef CONFIG_IRQ_FORCED_THREADING
318 extern bool force_irqthreads;
320 #define force_irqthreads (0)
323 #ifndef __ARCH_SET_SOFTIRQ_PENDING
324 #define set_softirq_pending(x) (local_softirq_pending() = (x))
325 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
328 /* Some architectures might implement lazy enabling/disabling of
329 * interrupts. In some cases, such as stop_machine, we might want
330 * to ensure that after a local_irq_disable(), interrupts have
331 * really been disabled in hardware. Such architectures need to
332 * implement the following hook.
334 #ifndef hard_irq_disable
335 #define hard_irq_disable() do { } while(0)
338 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
339 frequency threaded job scheduling. For almost all the purposes
340 tasklets are more than enough. F.e. all serial device BHs et
341 al. should be converted to tasklets, not to softirqs.
351 BLOCK_IOPOLL_SOFTIRQ,
355 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
360 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
362 /* map softirq index to softirq name. update 'softirq_to_name' in
363 * kernel/softirq.c when adding a new softirq.
365 extern char *softirq_to_name[NR_SOFTIRQS];
367 /* softirq mask and active fields moved to irq_cpustat_t in
368 * asm/hardirq.h to get better cache usage. KAO
371 struct softirq_action
373 void (*action)(struct softirq_action *);
376 asmlinkage void do_softirq(void);
377 asmlinkage void __do_softirq(void);
379 #ifdef __ARCH_HAS_DO_SOFTIRQ
380 void do_softirq_own_stack(void);
382 static inline void do_softirq_own_stack(void)
388 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
389 extern void softirq_init(void);
390 extern void __raise_softirq_irqoff(unsigned int nr);
392 extern void raise_softirq_irqoff(unsigned int nr);
393 extern void raise_softirq(unsigned int nr);
395 /* This is the worklist that queues up per-cpu softirq work.
397 * send_remote_sendirq() adds work to these lists, and
398 * the softirq handler itself dequeues from them. The queues
399 * are protected by disabling local cpu interrupts and they must
400 * only be accessed by the local cpu that they are for.
402 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
404 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
406 static inline struct task_struct *this_cpu_ksoftirqd(void)
408 return this_cpu_read(ksoftirqd);
411 /* Try to send a softirq to a remote cpu. If this cannot be done, the
412 * work will be queued to the local cpu.
414 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
416 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
417 * and compute the current cpu, passed in as 'this_cpu'.
419 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
420 int this_cpu, int softirq);
422 /* Tasklets --- multithreaded analogue of BHs.
424 Main feature differing them of generic softirqs: tasklet
425 is running only on one CPU simultaneously.
427 Main feature differing them of BHs: different tasklets
428 may be run simultaneously on different CPUs.
431 * If tasklet_schedule() is called, then tasklet is guaranteed
432 to be executed on some cpu at least once after this.
433 * If the tasklet is already scheduled, but its execution is still not
434 started, it will be executed only once.
435 * If this tasklet is already running on another CPU (or schedule is called
436 from tasklet itself), it is rescheduled for later.
437 * Tasklet is strictly serialized wrt itself, but not
438 wrt another tasklets. If client needs some intertask synchronization,
439 he makes it with spinlocks.
442 struct tasklet_struct
444 struct tasklet_struct *next;
447 void (*func)(unsigned long);
451 #define DECLARE_TASKLET(name, func, data) \
452 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
454 #define DECLARE_TASKLET_DISABLED(name, func, data) \
455 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
460 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
461 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
465 static inline int tasklet_trylock(struct tasklet_struct *t)
467 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
470 static inline void tasklet_unlock(struct tasklet_struct *t)
472 smp_mb__before_clear_bit();
473 clear_bit(TASKLET_STATE_RUN, &(t)->state);
476 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
478 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
481 #define tasklet_trylock(t) 1
482 #define tasklet_unlock_wait(t) do { } while (0)
483 #define tasklet_unlock(t) do { } while (0)
486 extern void __tasklet_schedule(struct tasklet_struct *t);
488 static inline void tasklet_schedule(struct tasklet_struct *t)
490 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
491 __tasklet_schedule(t);
494 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
496 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
498 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
499 __tasklet_hi_schedule(t);
502 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
505 * This version avoids touching any other tasklets. Needed for kmemcheck
506 * in order not to take any page faults while enqueueing this tasklet;
507 * consider VERY carefully whether you really need this or
508 * tasklet_hi_schedule()...
510 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
512 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
513 __tasklet_hi_schedule_first(t);
517 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
519 atomic_inc(&t->count);
520 smp_mb__after_atomic_inc();
523 static inline void tasklet_disable(struct tasklet_struct *t)
525 tasklet_disable_nosync(t);
526 tasklet_unlock_wait(t);
530 static inline void tasklet_enable(struct tasklet_struct *t)
532 smp_mb__before_atomic_dec();
533 atomic_dec(&t->count);
536 static inline void tasklet_hi_enable(struct tasklet_struct *t)
538 smp_mb__before_atomic_dec();
539 atomic_dec(&t->count);
542 extern void tasklet_kill(struct tasklet_struct *t);
543 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
544 extern void tasklet_init(struct tasklet_struct *t,
545 void (*func)(unsigned long), unsigned long data);
547 struct tasklet_hrtimer {
548 struct hrtimer timer;
549 struct tasklet_struct tasklet;
550 enum hrtimer_restart (*function)(struct hrtimer *);
554 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
555 enum hrtimer_restart (*function)(struct hrtimer *),
556 clockid_t which_clock, enum hrtimer_mode mode);
559 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
560 const enum hrtimer_mode mode)
562 return hrtimer_start(&ttimer->timer, time, mode);
566 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
568 hrtimer_cancel(&ttimer->timer);
569 tasklet_kill(&ttimer->tasklet);
573 * Autoprobing for irqs:
575 * probe_irq_on() and probe_irq_off() provide robust primitives
576 * for accurate IRQ probing during kernel initialization. They are
577 * reasonably simple to use, are not "fooled" by spurious interrupts,
578 * and, unlike other attempts at IRQ probing, they do not get hung on
579 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
581 * For reasonably foolproof probing, use them as follows:
583 * 1. clear and/or mask the device's internal interrupt.
585 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
586 * 4. enable the device and cause it to trigger an interrupt.
587 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
588 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
589 * 7. service the device to clear its pending interrupt.
590 * 8. loop again if paranoia is required.
592 * probe_irq_on() returns a mask of allocated irq's.
594 * probe_irq_off() takes the mask as a parameter,
595 * and returns the irq number which occurred,
596 * or zero if none occurred, or a negative irq number
597 * if more than one irq occurred.
600 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
601 static inline unsigned long probe_irq_on(void)
605 static inline int probe_irq_off(unsigned long val)
609 static inline unsigned int probe_irq_mask(unsigned long val)
614 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
615 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
616 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
619 #ifdef CONFIG_PROC_FS
620 /* Initialize /proc/irq/ */
621 extern void init_irq_proc(void);
623 static inline void init_irq_proc(void)
629 int show_interrupts(struct seq_file *p, void *v);
630 int arch_show_interrupts(struct seq_file *p, int prec);
632 extern int early_irq_init(void);
633 extern int arch_probe_nr_irqs(void);
634 extern int arch_early_irq_init(void);