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
58 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
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
70 #define IRQF_FORCE_RESUME 0x00008000
72 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND)
75 * Bits used by threaded handlers:
76 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
77 * IRQTF_DIED - handler thread died
78 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
79 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
89 * These values can be returned by request_any_context_irq() and
90 * describe the context the interrupt will be run in.
92 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
93 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
100 typedef irqreturn_t (*irq_handler_t)(int, void *);
103 * struct irqaction - per interrupt action descriptor
104 * @handler: interrupt handler function
105 * @flags: flags (see IRQF_* above)
106 * @name: name of the device
107 * @dev_id: cookie to identify the device
108 * @next: pointer to the next irqaction for shared interrupts
109 * @irq: interrupt number
110 * @dir: pointer to the proc/irq/NN/name entry
111 * @thread_fn: interupt handler function for threaded interrupts
112 * @thread: thread pointer for threaded interrupts
113 * @thread_flags: flags related to @thread
116 irq_handler_t handler;
119 struct irqaction *next;
121 irq_handler_t thread_fn;
122 struct task_struct *thread;
123 unsigned long thread_flags;
125 struct proc_dir_entry *dir;
126 } ____cacheline_internodealigned_in_smp;
128 extern irqreturn_t no_action(int cpl, void *dev_id);
130 #ifdef CONFIG_GENERIC_HARDIRQS
131 extern int __must_check
132 request_threaded_irq(unsigned int irq, irq_handler_t handler,
133 irq_handler_t thread_fn,
134 unsigned long flags, const char *name, void *dev);
136 static inline int __must_check
137 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
138 const char *name, void *dev)
140 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
143 extern int __must_check
144 request_any_context_irq(unsigned int irq, irq_handler_t handler,
145 unsigned long flags, const char *name, void *dev_id);
147 extern void exit_irq_thread(void);
150 extern int __must_check
151 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
152 const char *name, void *dev);
155 * Special function to avoid ifdeffery in kernel/irq/devres.c which
156 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
157 * m68k). I really love these $@%#!* obvious Makefile references:
158 * ../../../kernel/irq/devres.o
160 static inline int __must_check
161 request_threaded_irq(unsigned int irq, irq_handler_t handler,
162 irq_handler_t thread_fn,
163 unsigned long flags, const char *name, void *dev)
165 return request_irq(irq, handler, flags, name, dev);
168 static inline int __must_check
169 request_any_context_irq(unsigned int irq, irq_handler_t handler,
170 unsigned long flags, const char *name, void *dev_id)
172 return request_irq(irq, handler, flags, name, dev_id);
175 static inline void exit_irq_thread(void) { }
178 extern void free_irq(unsigned int, void *);
182 extern int __must_check
183 devm_request_threaded_irq(struct device *dev, unsigned int irq,
184 irq_handler_t handler, irq_handler_t thread_fn,
185 unsigned long irqflags, const char *devname,
188 static inline int __must_check
189 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
190 unsigned long irqflags, const char *devname, void *dev_id)
192 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
196 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
199 * On lockdep we dont want to enable hardirqs in hardirq
200 * context. Use local_irq_enable_in_hardirq() to annotate
201 * kernel code that has to do this nevertheless (pretty much
202 * the only valid case is for old/broken hardware that is
205 * NOTE: in theory this might break fragile code that relies
206 * on hardirq delivery - in practice we dont seem to have such
207 * places left. So the only effect should be slightly increased
208 * irqs-off latencies.
210 #ifdef CONFIG_LOCKDEP
211 # define local_irq_enable_in_hardirq() do { } while (0)
213 # define local_irq_enable_in_hardirq() local_irq_enable()
216 extern void disable_irq_nosync(unsigned int irq);
217 extern void disable_irq(unsigned int irq);
218 extern void enable_irq(unsigned int irq);
220 /* The following three functions are for the core kernel use only. */
221 #ifdef CONFIG_GENERIC_HARDIRQS
222 extern void suspend_device_irqs(void);
223 extern void resume_device_irqs(void);
224 #ifdef CONFIG_PM_SLEEP
225 extern int check_wakeup_irqs(void);
227 static inline int check_wakeup_irqs(void) { return 0; }
230 static inline void suspend_device_irqs(void) { };
231 static inline void resume_device_irqs(void) { };
232 static inline int check_wakeup_irqs(void) { return 0; }
235 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
237 extern cpumask_var_t irq_default_affinity;
239 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
240 extern int irq_can_set_affinity(unsigned int irq);
241 extern int irq_select_affinity(unsigned int irq);
243 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
244 #else /* CONFIG_SMP */
246 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
251 static inline int irq_can_set_affinity(unsigned int irq)
256 static inline int irq_select_affinity(unsigned int irq) { return 0; }
258 static inline int irq_set_affinity_hint(unsigned int irq,
259 const struct cpumask *m)
263 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
265 #ifdef CONFIG_GENERIC_HARDIRQS
267 * Special lockdep variants of irq disabling/enabling.
268 * These should be used for locking constructs that
269 * know that a particular irq context which is disabled,
270 * and which is the only irq-context user of a lock,
271 * that it's safe to take the lock in the irq-disabled
272 * section without disabling hardirqs.
274 * On !CONFIG_LOCKDEP they are equivalent to the normal
275 * irq disable/enable methods.
277 static inline void disable_irq_nosync_lockdep(unsigned int irq)
279 disable_irq_nosync(irq);
280 #ifdef CONFIG_LOCKDEP
285 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
287 disable_irq_nosync(irq);
288 #ifdef CONFIG_LOCKDEP
289 local_irq_save(*flags);
293 static inline void disable_irq_lockdep(unsigned int irq)
296 #ifdef CONFIG_LOCKDEP
301 static inline void enable_irq_lockdep(unsigned int irq)
303 #ifdef CONFIG_LOCKDEP
309 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
311 #ifdef CONFIG_LOCKDEP
312 local_irq_restore(*flags);
317 /* IRQ wakeup (PM) control: */
318 extern int set_irq_wake(unsigned int irq, unsigned int on);
320 static inline int enable_irq_wake(unsigned int irq)
322 return set_irq_wake(irq, 1);
325 static inline int disable_irq_wake(unsigned int irq)
327 return set_irq_wake(irq, 0);
330 #else /* !CONFIG_GENERIC_HARDIRQS */
332 * NOTE: non-genirq architectures, if they want to support the lock
333 * validator need to define the methods below in their asm/irq.h
334 * files, under an #ifdef CONFIG_LOCKDEP section.
336 #ifndef CONFIG_LOCKDEP
337 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
338 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
339 disable_irq_nosync(irq)
340 # define disable_irq_lockdep(irq) disable_irq(irq)
341 # define enable_irq_lockdep(irq) enable_irq(irq)
342 # define enable_irq_lockdep_irqrestore(irq, flags) \
346 static inline int enable_irq_wake(unsigned int irq)
351 static inline int disable_irq_wake(unsigned int irq)
355 #endif /* CONFIG_GENERIC_HARDIRQS */
357 #ifndef __ARCH_SET_SOFTIRQ_PENDING
358 #define set_softirq_pending(x) (local_softirq_pending() = (x))
359 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
362 /* Some architectures might implement lazy enabling/disabling of
363 * interrupts. In some cases, such as stop_machine, we might want
364 * to ensure that after a local_irq_disable(), interrupts have
365 * really been disabled in hardware. Such architectures need to
366 * implement the following hook.
368 #ifndef hard_irq_disable
369 #define hard_irq_disable() do { } while(0)
372 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
373 frequency threaded job scheduling. For almost all the purposes
374 tasklets are more than enough. F.e. all serial device BHs et
375 al. should be converted to tasklets, not to softirqs.
385 BLOCK_IOPOLL_SOFTIRQ,
389 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
394 /* map softirq index to softirq name. update 'softirq_to_name' in
395 * kernel/softirq.c when adding a new softirq.
397 extern char *softirq_to_name[NR_SOFTIRQS];
399 /* softirq mask and active fields moved to irq_cpustat_t in
400 * asm/hardirq.h to get better cache usage. KAO
403 struct softirq_action
405 void (*action)(struct softirq_action *);
408 asmlinkage void do_softirq(void);
409 asmlinkage void __do_softirq(void);
410 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
411 extern void softirq_init(void);
412 static inline void __raise_softirq_irqoff(unsigned int nr)
414 trace_softirq_raise(nr);
415 or_softirq_pending(1UL << nr);
418 extern void raise_softirq_irqoff(unsigned int nr);
419 extern void raise_softirq(unsigned int nr);
421 /* This is the worklist that queues up per-cpu softirq work.
423 * send_remote_sendirq() adds work to these lists, and
424 * the softirq handler itself dequeues from them. The queues
425 * are protected by disabling local cpu interrupts and they must
426 * only be accessed by the local cpu that they are for.
428 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
430 /* Try to send a softirq to a remote cpu. If this cannot be done, the
431 * work will be queued to the local cpu.
433 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
435 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
436 * and compute the current cpu, passed in as 'this_cpu'.
438 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
439 int this_cpu, int softirq);
441 /* Tasklets --- multithreaded analogue of BHs.
443 Main feature differing them of generic softirqs: tasklet
444 is running only on one CPU simultaneously.
446 Main feature differing them of BHs: different tasklets
447 may be run simultaneously on different CPUs.
450 * If tasklet_schedule() is called, then tasklet is guaranteed
451 to be executed on some cpu at least once after this.
452 * If the tasklet is already scheduled, but its excecution is still not
453 started, it will be executed only once.
454 * If this tasklet is already running on another CPU (or schedule is called
455 from tasklet itself), it is rescheduled for later.
456 * Tasklet is strictly serialized wrt itself, but not
457 wrt another tasklets. If client needs some intertask synchronization,
458 he makes it with spinlocks.
461 struct tasklet_struct
463 struct tasklet_struct *next;
466 void (*func)(unsigned long);
470 #define DECLARE_TASKLET(name, func, data) \
471 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
473 #define DECLARE_TASKLET_DISABLED(name, func, data) \
474 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
479 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
480 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
484 static inline int tasklet_trylock(struct tasklet_struct *t)
486 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
489 static inline void tasklet_unlock(struct tasklet_struct *t)
491 smp_mb__before_clear_bit();
492 clear_bit(TASKLET_STATE_RUN, &(t)->state);
495 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
497 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
500 #define tasklet_trylock(t) 1
501 #define tasklet_unlock_wait(t) do { } while (0)
502 #define tasklet_unlock(t) do { } while (0)
505 extern void __tasklet_schedule(struct tasklet_struct *t);
507 static inline void tasklet_schedule(struct tasklet_struct *t)
509 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
510 __tasklet_schedule(t);
513 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
515 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
517 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
518 __tasklet_hi_schedule(t);
521 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
524 * This version avoids touching any other tasklets. Needed for kmemcheck
525 * in order not to take any page faults while enqueueing this tasklet;
526 * consider VERY carefully whether you really need this or
527 * tasklet_hi_schedule()...
529 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
531 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
532 __tasklet_hi_schedule_first(t);
536 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
538 atomic_inc(&t->count);
539 smp_mb__after_atomic_inc();
542 static inline void tasklet_disable(struct tasklet_struct *t)
544 tasklet_disable_nosync(t);
545 tasklet_unlock_wait(t);
549 static inline void tasklet_enable(struct tasklet_struct *t)
551 smp_mb__before_atomic_dec();
552 atomic_dec(&t->count);
555 static inline void tasklet_hi_enable(struct tasklet_struct *t)
557 smp_mb__before_atomic_dec();
558 atomic_dec(&t->count);
561 extern void tasklet_kill(struct tasklet_struct *t);
562 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
563 extern void tasklet_init(struct tasklet_struct *t,
564 void (*func)(unsigned long), unsigned long data);
566 struct tasklet_hrtimer {
567 struct hrtimer timer;
568 struct tasklet_struct tasklet;
569 enum hrtimer_restart (*function)(struct hrtimer *);
573 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
574 enum hrtimer_restart (*function)(struct hrtimer *),
575 clockid_t which_clock, enum hrtimer_mode mode);
578 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
579 const enum hrtimer_mode mode)
581 return hrtimer_start(&ttimer->timer, time, mode);
585 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
587 hrtimer_cancel(&ttimer->timer);
588 tasklet_kill(&ttimer->tasklet);
592 * Autoprobing for irqs:
594 * probe_irq_on() and probe_irq_off() provide robust primitives
595 * for accurate IRQ probing during kernel initialization. They are
596 * reasonably simple to use, are not "fooled" by spurious interrupts,
597 * and, unlike other attempts at IRQ probing, they do not get hung on
598 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
600 * For reasonably foolproof probing, use them as follows:
602 * 1. clear and/or mask the device's internal interrupt.
604 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
605 * 4. enable the device and cause it to trigger an interrupt.
606 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
607 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
608 * 7. service the device to clear its pending interrupt.
609 * 8. loop again if paranoia is required.
611 * probe_irq_on() returns a mask of allocated irq's.
613 * probe_irq_off() takes the mask as a parameter,
614 * and returns the irq number which occurred,
615 * or zero if none occurred, or a negative irq number
616 * if more than one irq occurred.
619 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
620 static inline unsigned long probe_irq_on(void)
624 static inline int probe_irq_off(unsigned long val)
628 static inline unsigned int probe_irq_mask(unsigned long val)
633 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
634 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
635 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
638 #ifdef CONFIG_PROC_FS
639 /* Initialize /proc/irq/ */
640 extern void init_irq_proc(void);
642 static inline void init_irq_proc(void)
648 int show_interrupts(struct seq_file *p, void *v);
650 extern int early_irq_init(void);
651 extern int arch_probe_nr_irqs(void);
652 extern int arch_early_irq_init(void);