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>
18 #include <asm/atomic.h>
19 #include <asm/ptrace.h>
20 #include <asm/system.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_DISABLED - keep irqs disabled when calling the action handler
43 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
44 * IRQF_SHARED - allow sharing the irq among several devices
45 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
46 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
47 * IRQF_PERCPU - Interrupt is per cpu
48 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
49 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
50 * registered first in an shared interrupt is considered for
51 * performance reasons)
52 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
53 * Used by threaded interrupts which need to keep the
54 * irq line disabled until the threaded handler has been run.
55 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
56 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
58 #define IRQF_DISABLED 0x00000020
59 #define IRQF_SAMPLE_RANDOM 0x00000040
60 #define IRQF_SHARED 0x00000080
61 #define IRQF_PROBE_SHARED 0x00000100
62 #define __IRQF_TIMER 0x00000200
63 #define IRQF_PERCPU 0x00000400
64 #define IRQF_NOBALANCING 0x00000800
65 #define IRQF_IRQPOLL 0x00001000
66 #define IRQF_ONESHOT 0x00002000
67 #define IRQF_NO_SUSPEND 0x00004000
68 #define IRQF_FORCE_RESUME 0x00008000
70 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND)
73 * Bits used by threaded handlers:
74 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
75 * IRQTF_DIED - handler thread died
76 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
77 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
86 typedef irqreturn_t (*irq_handler_t)(int, void *);
89 * struct irqaction - per interrupt action descriptor
90 * @handler: interrupt handler function
91 * @flags: flags (see IRQF_* above)
92 * @name: name of the device
93 * @dev_id: cookie to identify the device
94 * @next: pointer to the next irqaction for shared interrupts
95 * @irq: interrupt number
96 * @dir: pointer to the proc/irq/NN/name entry
97 * @thread_fn: interupt handler function for threaded interrupts
98 * @thread: thread pointer for threaded interrupts
99 * @thread_flags: flags related to @thread
102 irq_handler_t handler;
106 struct irqaction *next;
108 struct proc_dir_entry *dir;
109 irq_handler_t thread_fn;
110 struct task_struct *thread;
111 unsigned long thread_flags;
114 extern irqreturn_t no_action(int cpl, void *dev_id);
116 #ifdef CONFIG_GENERIC_HARDIRQS
117 extern int __must_check
118 request_threaded_irq(unsigned int irq, irq_handler_t handler,
119 irq_handler_t thread_fn,
120 unsigned long flags, const char *name, void *dev);
122 static inline int __must_check
123 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
124 const char *name, void *dev)
126 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
129 extern void exit_irq_thread(void);
132 extern int __must_check
133 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
134 const char *name, void *dev);
137 * Special function to avoid ifdeffery in kernel/irq/devres.c which
138 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
139 * m68k). I really love these $@%#!* obvious Makefile references:
140 * ../../../kernel/irq/devres.o
142 static inline int __must_check
143 request_threaded_irq(unsigned int irq, irq_handler_t handler,
144 irq_handler_t thread_fn,
145 unsigned long flags, const char *name, void *dev)
147 return request_irq(irq, handler, flags, name, dev);
150 static inline void exit_irq_thread(void) { }
153 extern void free_irq(unsigned int, void *);
157 extern int __must_check
158 devm_request_threaded_irq(struct device *dev, unsigned int irq,
159 irq_handler_t handler, irq_handler_t thread_fn,
160 unsigned long irqflags, const char *devname,
163 static inline int __must_check
164 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
165 unsigned long irqflags, const char *devname, void *dev_id)
167 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
171 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
174 * On lockdep we dont want to enable hardirqs in hardirq
175 * context. Use local_irq_enable_in_hardirq() to annotate
176 * kernel code that has to do this nevertheless (pretty much
177 * the only valid case is for old/broken hardware that is
180 * NOTE: in theory this might break fragile code that relies
181 * on hardirq delivery - in practice we dont seem to have such
182 * places left. So the only effect should be slightly increased
183 * irqs-off latencies.
185 #ifdef CONFIG_LOCKDEP
186 # define local_irq_enable_in_hardirq() do { } while (0)
188 # define local_irq_enable_in_hardirq() local_irq_enable()
191 extern void disable_irq_nosync(unsigned int irq);
192 extern void disable_irq(unsigned int irq);
193 extern void enable_irq(unsigned int irq);
195 /* The following three functions are for the core kernel use only. */
196 #ifdef CONFIG_GENERIC_HARDIRQS
197 extern void suspend_device_irqs(void);
198 extern void resume_device_irqs(void);
199 #ifdef CONFIG_PM_SLEEP
200 extern int check_wakeup_irqs(void);
202 static inline int check_wakeup_irqs(void) { return 0; }
205 static inline void suspend_device_irqs(void) { };
206 static inline void resume_device_irqs(void) { };
207 static inline int check_wakeup_irqs(void) { return 0; }
210 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
212 extern cpumask_var_t irq_default_affinity;
214 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
215 extern int irq_can_set_affinity(unsigned int irq);
216 extern int irq_select_affinity(unsigned int irq);
218 #else /* CONFIG_SMP */
220 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
225 static inline int irq_can_set_affinity(unsigned int irq)
230 static inline int irq_select_affinity(unsigned int irq) { return 0; }
232 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
234 #ifdef CONFIG_GENERIC_HARDIRQS
236 * Special lockdep variants of irq disabling/enabling.
237 * These should be used for locking constructs that
238 * know that a particular irq context which is disabled,
239 * and which is the only irq-context user of a lock,
240 * that it's safe to take the lock in the irq-disabled
241 * section without disabling hardirqs.
243 * On !CONFIG_LOCKDEP they are equivalent to the normal
244 * irq disable/enable methods.
246 static inline void disable_irq_nosync_lockdep(unsigned int irq)
248 disable_irq_nosync(irq);
249 #ifdef CONFIG_LOCKDEP
254 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
256 disable_irq_nosync(irq);
257 #ifdef CONFIG_LOCKDEP
258 local_irq_save(*flags);
262 static inline void disable_irq_lockdep(unsigned int irq)
265 #ifdef CONFIG_LOCKDEP
270 static inline void enable_irq_lockdep(unsigned int irq)
272 #ifdef CONFIG_LOCKDEP
278 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
280 #ifdef CONFIG_LOCKDEP
281 local_irq_restore(*flags);
286 /* IRQ wakeup (PM) control: */
287 extern int set_irq_wake(unsigned int irq, unsigned int on);
289 static inline int enable_irq_wake(unsigned int irq)
291 return set_irq_wake(irq, 1);
294 static inline int disable_irq_wake(unsigned int irq)
296 return set_irq_wake(irq, 0);
299 #else /* !CONFIG_GENERIC_HARDIRQS */
301 * NOTE: non-genirq architectures, if they want to support the lock
302 * validator need to define the methods below in their asm/irq.h
303 * files, under an #ifdef CONFIG_LOCKDEP section.
305 #ifndef CONFIG_LOCKDEP
306 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
307 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
308 disable_irq_nosync(irq)
309 # define disable_irq_lockdep(irq) disable_irq(irq)
310 # define enable_irq_lockdep(irq) enable_irq(irq)
311 # define enable_irq_lockdep_irqrestore(irq, flags) \
315 static inline int enable_irq_wake(unsigned int irq)
320 static inline int disable_irq_wake(unsigned int irq)
324 #endif /* CONFIG_GENERIC_HARDIRQS */
326 #ifndef __ARCH_SET_SOFTIRQ_PENDING
327 #define set_softirq_pending(x) (local_softirq_pending() = (x))
328 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
331 /* Some architectures might implement lazy enabling/disabling of
332 * interrupts. In some cases, such as stop_machine, we might want
333 * to ensure that after a local_irq_disable(), interrupts have
334 * really been disabled in hardware. Such architectures need to
335 * implement the following hook.
337 #ifndef hard_irq_disable
338 #define hard_irq_disable() do { } while(0)
341 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
342 frequency threaded job scheduling. For almost all the purposes
343 tasklets are more than enough. F.e. all serial device BHs et
344 al. should be converted to tasklets, not to softirqs.
354 BLOCK_IOPOLL_SOFTIRQ,
358 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
363 /* map softirq index to softirq name. update 'softirq_to_name' in
364 * kernel/softirq.c when adding a new softirq.
366 extern char *softirq_to_name[NR_SOFTIRQS];
368 /* softirq mask and active fields moved to irq_cpustat_t in
369 * asm/hardirq.h to get better cache usage. KAO
372 struct softirq_action
374 void (*action)(struct softirq_action *);
377 asmlinkage void do_softirq(void);
378 asmlinkage void __do_softirq(void);
379 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
380 extern void softirq_init(void);
381 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
382 extern void raise_softirq_irqoff(unsigned int nr);
383 extern void raise_softirq(unsigned int nr);
384 extern void wakeup_softirqd(void);
386 /* This is the worklist that queues up per-cpu softirq work.
388 * send_remote_sendirq() adds work to these lists, and
389 * the softirq handler itself dequeues from them. The queues
390 * are protected by disabling local cpu interrupts and they must
391 * only be accessed by the local cpu that they are for.
393 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
395 /* Try to send a softirq to a remote cpu. If this cannot be done, the
396 * work will be queued to the local cpu.
398 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
400 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
401 * and compute the current cpu, passed in as 'this_cpu'.
403 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
404 int this_cpu, int softirq);
406 /* Tasklets --- multithreaded analogue of BHs.
408 Main feature differing them of generic softirqs: tasklet
409 is running only on one CPU simultaneously.
411 Main feature differing them of BHs: different tasklets
412 may be run simultaneously on different CPUs.
415 * If tasklet_schedule() is called, then tasklet is guaranteed
416 to be executed on some cpu at least once after this.
417 * If the tasklet is already scheduled, but its excecution is still not
418 started, it will be executed only once.
419 * If this tasklet is already running on another CPU (or schedule is called
420 from tasklet itself), it is rescheduled for later.
421 * Tasklet is strictly serialized wrt itself, but not
422 wrt another tasklets. If client needs some intertask synchronization,
423 he makes it with spinlocks.
426 struct tasklet_struct
428 struct tasklet_struct *next;
431 void (*func)(unsigned long);
435 #define DECLARE_TASKLET(name, func, data) \
436 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
438 #define DECLARE_TASKLET_DISABLED(name, func, data) \
439 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
444 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
445 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
449 static inline int tasklet_trylock(struct tasklet_struct *t)
451 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
454 static inline void tasklet_unlock(struct tasklet_struct *t)
456 smp_mb__before_clear_bit();
457 clear_bit(TASKLET_STATE_RUN, &(t)->state);
460 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
462 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
465 #define tasklet_trylock(t) 1
466 #define tasklet_unlock_wait(t) do { } while (0)
467 #define tasklet_unlock(t) do { } while (0)
470 extern void __tasklet_schedule(struct tasklet_struct *t);
472 static inline void tasklet_schedule(struct tasklet_struct *t)
474 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
475 __tasklet_schedule(t);
478 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
480 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
482 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
483 __tasklet_hi_schedule(t);
486 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
489 * This version avoids touching any other tasklets. Needed for kmemcheck
490 * in order not to take any page faults while enqueueing this tasklet;
491 * consider VERY carefully whether you really need this or
492 * tasklet_hi_schedule()...
494 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
496 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
497 __tasklet_hi_schedule_first(t);
501 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
503 atomic_inc(&t->count);
504 smp_mb__after_atomic_inc();
507 static inline void tasklet_disable(struct tasklet_struct *t)
509 tasklet_disable_nosync(t);
510 tasklet_unlock_wait(t);
514 static inline void tasklet_enable(struct tasklet_struct *t)
516 smp_mb__before_atomic_dec();
517 atomic_dec(&t->count);
520 static inline void tasklet_hi_enable(struct tasklet_struct *t)
522 smp_mb__before_atomic_dec();
523 atomic_dec(&t->count);
526 extern void tasklet_kill(struct tasklet_struct *t);
527 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
528 extern void tasklet_init(struct tasklet_struct *t,
529 void (*func)(unsigned long), unsigned long data);
531 struct tasklet_hrtimer {
532 struct hrtimer timer;
533 struct tasklet_struct tasklet;
534 enum hrtimer_restart (*function)(struct hrtimer *);
538 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
539 enum hrtimer_restart (*function)(struct hrtimer *),
540 clockid_t which_clock, enum hrtimer_mode mode);
543 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
544 const enum hrtimer_mode mode)
546 return hrtimer_start(&ttimer->timer, time, mode);
550 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
552 hrtimer_cancel(&ttimer->timer);
553 tasklet_kill(&ttimer->tasklet);
557 * Autoprobing for irqs:
559 * probe_irq_on() and probe_irq_off() provide robust primitives
560 * for accurate IRQ probing during kernel initialization. They are
561 * reasonably simple to use, are not "fooled" by spurious interrupts,
562 * and, unlike other attempts at IRQ probing, they do not get hung on
563 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
565 * For reasonably foolproof probing, use them as follows:
567 * 1. clear and/or mask the device's internal interrupt.
569 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
570 * 4. enable the device and cause it to trigger an interrupt.
571 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
572 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
573 * 7. service the device to clear its pending interrupt.
574 * 8. loop again if paranoia is required.
576 * probe_irq_on() returns a mask of allocated irq's.
578 * probe_irq_off() takes the mask as a parameter,
579 * and returns the irq number which occurred,
580 * or zero if none occurred, or a negative irq number
581 * if more than one irq occurred.
584 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
585 static inline unsigned long probe_irq_on(void)
589 static inline int probe_irq_off(unsigned long val)
593 static inline unsigned int probe_irq_mask(unsigned long val)
598 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
599 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
600 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
603 #ifdef CONFIG_PROC_FS
604 /* Initialize /proc/irq/ */
605 extern void init_irq_proc(void);
607 static inline void init_irq_proc(void)
612 #if defined(CONFIG_GENERIC_HARDIRQS) && defined(CONFIG_DEBUG_SHIRQ)
613 extern void debug_poll_all_shared_irqs(void);
615 static inline void debug_poll_all_shared_irqs(void) { }
619 int show_interrupts(struct seq_file *p, void *v);
623 extern int early_irq_init(void);
624 extern int arch_probe_nr_irqs(void);
625 extern int arch_early_irq_init(void);
626 extern int arch_init_chip_data(struct irq_desc *desc, int node);