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>
21 #include <trace/events/irq.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
60 #define IRQF_DISABLED 0x00000020
61 #define IRQF_SAMPLE_RANDOM 0x00000040
62 #define IRQF_SHARED 0x00000080
63 #define IRQF_PROBE_SHARED 0x00000100
64 #define __IRQF_TIMER 0x00000200
65 #define IRQF_PERCPU 0x00000400
66 #define IRQF_NOBALANCING 0x00000800
67 #define IRQF_IRQPOLL 0x00001000
68 #define IRQF_ONESHOT 0x00002000
69 #define IRQF_NO_SUSPEND 0x00004000
71 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND)
74 * Bits used by threaded handlers:
75 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
76 * IRQTF_DIED - handler thread died
77 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
78 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
88 * These values can be returned by request_any_context_irq() and
89 * describe the context the interrupt will be run in.
91 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
92 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
99 typedef irqreturn_t (*irq_handler_t)(int, void *);
102 * struct irqaction - per interrupt action descriptor
103 * @handler: interrupt handler function
104 * @flags: flags (see IRQF_* above)
105 * @name: name of the device
106 * @dev_id: cookie to identify the device
107 * @next: pointer to the next irqaction for shared interrupts
108 * @irq: interrupt number
109 * @dir: pointer to the proc/irq/NN/name entry
110 * @thread_fn: interupt handler function for threaded interrupts
111 * @thread: thread pointer for threaded interrupts
112 * @thread_flags: flags related to @thread
115 irq_handler_t handler;
118 struct irqaction *next;
120 irq_handler_t thread_fn;
121 struct task_struct *thread;
122 unsigned long thread_flags;
124 struct proc_dir_entry *dir;
125 } ____cacheline_internodealigned_in_smp;
127 extern irqreturn_t no_action(int cpl, void *dev_id);
129 #ifdef CONFIG_GENERIC_HARDIRQS
130 extern int __must_check
131 request_threaded_irq(unsigned int irq, irq_handler_t handler,
132 irq_handler_t thread_fn,
133 unsigned long flags, const char *name, void *dev);
135 static inline int __must_check
136 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
137 const char *name, void *dev)
139 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
142 extern int __must_check
143 request_any_context_irq(unsigned int irq, irq_handler_t handler,
144 unsigned long flags, const char *name, void *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 void exit_irq_thread(void) { }
177 extern void free_irq(unsigned int, void *);
181 extern int __must_check
182 devm_request_threaded_irq(struct device *dev, unsigned int irq,
183 irq_handler_t handler, irq_handler_t thread_fn,
184 unsigned long irqflags, const char *devname,
187 static inline int __must_check
188 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
189 unsigned long irqflags, const char *devname, void *dev_id)
191 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
195 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
198 * On lockdep we dont want to enable hardirqs in hardirq
199 * context. Use local_irq_enable_in_hardirq() to annotate
200 * kernel code that has to do this nevertheless (pretty much
201 * the only valid case is for old/broken hardware that is
204 * NOTE: in theory this might break fragile code that relies
205 * on hardirq delivery - in practice we dont seem to have such
206 * places left. So the only effect should be slightly increased
207 * irqs-off latencies.
209 #ifdef CONFIG_LOCKDEP
210 # define local_irq_enable_in_hardirq() do { } while (0)
212 # define local_irq_enable_in_hardirq() local_irq_enable()
215 extern void disable_irq_nosync(unsigned int irq);
216 extern void disable_irq(unsigned int irq);
217 extern void enable_irq(unsigned int irq);
219 /* The following three functions are for the core kernel use only. */
220 #ifdef CONFIG_GENERIC_HARDIRQS
221 extern void suspend_device_irqs(void);
222 extern void resume_device_irqs(void);
223 #ifdef CONFIG_PM_SLEEP
224 extern int check_wakeup_irqs(void);
226 static inline int check_wakeup_irqs(void) { return 0; }
229 static inline void suspend_device_irqs(void) { };
230 static inline void resume_device_irqs(void) { };
231 static inline int check_wakeup_irqs(void) { return 0; }
234 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
236 extern cpumask_var_t irq_default_affinity;
238 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
239 extern int irq_can_set_affinity(unsigned int irq);
240 extern int irq_select_affinity(unsigned int irq);
242 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
243 #else /* CONFIG_SMP */
245 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
250 static inline int irq_can_set_affinity(unsigned int irq)
255 static inline int irq_select_affinity(unsigned int irq) { return 0; }
257 static inline int irq_set_affinity_hint(unsigned int irq,
258 const struct cpumask *m)
262 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
264 #ifdef CONFIG_GENERIC_HARDIRQS
266 * Special lockdep variants of irq disabling/enabling.
267 * These should be used for locking constructs that
268 * know that a particular irq context which is disabled,
269 * and which is the only irq-context user of a lock,
270 * that it's safe to take the lock in the irq-disabled
271 * section without disabling hardirqs.
273 * On !CONFIG_LOCKDEP they are equivalent to the normal
274 * irq disable/enable methods.
276 static inline void disable_irq_nosync_lockdep(unsigned int irq)
278 disable_irq_nosync(irq);
279 #ifdef CONFIG_LOCKDEP
284 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
286 disable_irq_nosync(irq);
287 #ifdef CONFIG_LOCKDEP
288 local_irq_save(*flags);
292 static inline void disable_irq_lockdep(unsigned int irq)
295 #ifdef CONFIG_LOCKDEP
300 static inline void enable_irq_lockdep(unsigned int irq)
302 #ifdef CONFIG_LOCKDEP
308 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
310 #ifdef CONFIG_LOCKDEP
311 local_irq_restore(*flags);
316 /* IRQ wakeup (PM) control: */
317 extern int set_irq_wake(unsigned int irq, unsigned int on);
319 static inline int enable_irq_wake(unsigned int irq)
321 return set_irq_wake(irq, 1);
324 static inline int disable_irq_wake(unsigned int irq)
326 return set_irq_wake(irq, 0);
329 #else /* !CONFIG_GENERIC_HARDIRQS */
331 * NOTE: non-genirq architectures, if they want to support the lock
332 * validator need to define the methods below in their asm/irq.h
333 * files, under an #ifdef CONFIG_LOCKDEP section.
335 #ifndef CONFIG_LOCKDEP
336 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
337 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
338 disable_irq_nosync(irq)
339 # define disable_irq_lockdep(irq) disable_irq(irq)
340 # define enable_irq_lockdep(irq) enable_irq(irq)
341 # define enable_irq_lockdep_irqrestore(irq, flags) \
345 static inline int enable_irq_wake(unsigned int irq)
350 static inline int disable_irq_wake(unsigned int irq)
354 #endif /* CONFIG_GENERIC_HARDIRQS */
356 #ifndef __ARCH_SET_SOFTIRQ_PENDING
357 #define set_softirq_pending(x) (local_softirq_pending() = (x))
358 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
361 /* Some architectures might implement lazy enabling/disabling of
362 * interrupts. In some cases, such as stop_machine, we might want
363 * to ensure that after a local_irq_disable(), interrupts have
364 * really been disabled in hardware. Such architectures need to
365 * implement the following hook.
367 #ifndef hard_irq_disable
368 #define hard_irq_disable() do { } while(0)
371 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
372 frequency threaded job scheduling. For almost all the purposes
373 tasklets are more than enough. F.e. all serial device BHs et
374 al. should be converted to tasklets, not to softirqs.
384 BLOCK_IOPOLL_SOFTIRQ,
388 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
393 /* map softirq index to softirq name. update 'softirq_to_name' in
394 * kernel/softirq.c when adding a new softirq.
396 extern char *softirq_to_name[NR_SOFTIRQS];
398 /* softirq mask and active fields moved to irq_cpustat_t in
399 * asm/hardirq.h to get better cache usage. KAO
402 struct softirq_action
404 void (*action)(struct softirq_action *);
407 asmlinkage void do_softirq(void);
408 asmlinkage void __do_softirq(void);
409 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
410 extern void softirq_init(void);
411 static inline void __raise_softirq_irqoff(unsigned int nr)
413 trace_softirq_raise(nr);
414 or_softirq_pending(1UL << nr);
417 extern void raise_softirq_irqoff(unsigned int nr);
418 extern void raise_softirq(unsigned int nr);
420 /* This is the worklist that queues up per-cpu softirq work.
422 * send_remote_sendirq() adds work to these lists, and
423 * the softirq handler itself dequeues from them. The queues
424 * are protected by disabling local cpu interrupts and they must
425 * only be accessed by the local cpu that they are for.
427 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
429 /* Try to send a softirq to a remote cpu. If this cannot be done, the
430 * work will be queued to the local cpu.
432 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
434 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
435 * and compute the current cpu, passed in as 'this_cpu'.
437 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
438 int this_cpu, int softirq);
440 /* Tasklets --- multithreaded analogue of BHs.
442 Main feature differing them of generic softirqs: tasklet
443 is running only on one CPU simultaneously.
445 Main feature differing them of BHs: different tasklets
446 may be run simultaneously on different CPUs.
449 * If tasklet_schedule() is called, then tasklet is guaranteed
450 to be executed on some cpu at least once after this.
451 * If the tasklet is already scheduled, but its excecution is still not
452 started, it will be executed only once.
453 * If this tasklet is already running on another CPU (or schedule is called
454 from tasklet itself), it is rescheduled for later.
455 * Tasklet is strictly serialized wrt itself, but not
456 wrt another tasklets. If client needs some intertask synchronization,
457 he makes it with spinlocks.
460 struct tasklet_struct
462 struct tasklet_struct *next;
465 void (*func)(unsigned long);
469 #define DECLARE_TASKLET(name, func, data) \
470 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
472 #define DECLARE_TASKLET_DISABLED(name, func, data) \
473 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
478 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
479 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
483 static inline int tasklet_trylock(struct tasklet_struct *t)
485 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
488 static inline void tasklet_unlock(struct tasklet_struct *t)
490 smp_mb__before_clear_bit();
491 clear_bit(TASKLET_STATE_RUN, &(t)->state);
494 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
496 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
499 #define tasklet_trylock(t) 1
500 #define tasklet_unlock_wait(t) do { } while (0)
501 #define tasklet_unlock(t) do { } while (0)
504 extern void __tasklet_schedule(struct tasklet_struct *t);
506 static inline void tasklet_schedule(struct tasklet_struct *t)
508 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
509 __tasklet_schedule(t);
512 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
514 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
516 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
517 __tasklet_hi_schedule(t);
520 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
523 * This version avoids touching any other tasklets. Needed for kmemcheck
524 * in order not to take any page faults while enqueueing this tasklet;
525 * consider VERY carefully whether you really need this or
526 * tasklet_hi_schedule()...
528 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
530 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
531 __tasklet_hi_schedule_first(t);
535 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
537 atomic_inc(&t->count);
538 smp_mb__after_atomic_inc();
541 static inline void tasklet_disable(struct tasklet_struct *t)
543 tasklet_disable_nosync(t);
544 tasklet_unlock_wait(t);
548 static inline void tasklet_enable(struct tasklet_struct *t)
550 smp_mb__before_atomic_dec();
551 atomic_dec(&t->count);
554 static inline void tasklet_hi_enable(struct tasklet_struct *t)
556 smp_mb__before_atomic_dec();
557 atomic_dec(&t->count);
560 extern void tasklet_kill(struct tasklet_struct *t);
561 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
562 extern void tasklet_init(struct tasklet_struct *t,
563 void (*func)(unsigned long), unsigned long data);
565 struct tasklet_hrtimer {
566 struct hrtimer timer;
567 struct tasklet_struct tasklet;
568 enum hrtimer_restart (*function)(struct hrtimer *);
572 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
573 enum hrtimer_restart (*function)(struct hrtimer *),
574 clockid_t which_clock, enum hrtimer_mode mode);
577 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
578 const enum hrtimer_mode mode)
580 return hrtimer_start(&ttimer->timer, time, mode);
584 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
586 hrtimer_cancel(&ttimer->timer);
587 tasklet_kill(&ttimer->tasklet);
591 * Autoprobing for irqs:
593 * probe_irq_on() and probe_irq_off() provide robust primitives
594 * for accurate IRQ probing during kernel initialization. They are
595 * reasonably simple to use, are not "fooled" by spurious interrupts,
596 * and, unlike other attempts at IRQ probing, they do not get hung on
597 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
599 * For reasonably foolproof probing, use them as follows:
601 * 1. clear and/or mask the device's internal interrupt.
603 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
604 * 4. enable the device and cause it to trigger an interrupt.
605 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
606 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
607 * 7. service the device to clear its pending interrupt.
608 * 8. loop again if paranoia is required.
610 * probe_irq_on() returns a mask of allocated irq's.
612 * probe_irq_off() takes the mask as a parameter,
613 * and returns the irq number which occurred,
614 * or zero if none occurred, or a negative irq number
615 * if more than one irq occurred.
618 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
619 static inline unsigned long probe_irq_on(void)
623 static inline int probe_irq_off(unsigned long val)
627 static inline unsigned int probe_irq_mask(unsigned long val)
632 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
633 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
634 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
637 #ifdef CONFIG_PROC_FS
638 /* Initialize /proc/irq/ */
639 extern void init_irq_proc(void);
641 static inline void init_irq_proc(void)
647 int show_interrupts(struct seq_file *p, void *v);
649 extern int early_irq_init(void);
650 extern int arch_probe_nr_irqs(void);
651 extern int arch_early_irq_init(void);