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>
22 #include <asm/system.h>
23 #include <trace/events/irq.h>
26 * These correspond to the IORESOURCE_IRQ_* defines in
27 * linux/ioport.h to select the interrupt line behaviour. When
28 * requesting an interrupt without specifying a IRQF_TRIGGER, the
29 * setting should be assumed to be "as already configured", which
30 * may be as per machine or firmware initialisation.
32 #define IRQF_TRIGGER_NONE 0x00000000
33 #define IRQF_TRIGGER_RISING 0x00000001
34 #define IRQF_TRIGGER_FALLING 0x00000002
35 #define IRQF_TRIGGER_HIGH 0x00000004
36 #define IRQF_TRIGGER_LOW 0x00000008
37 #define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
38 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
39 #define IRQF_TRIGGER_PROBE 0x00000010
42 * These flags used only by the kernel as part of the
43 * irq handling routines.
45 * IRQF_DISABLED - keep irqs disabled when calling the action handler.
46 * DEPRECATED. This flag is a NOOP and scheduled to be removed
47 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
48 * IRQF_SHARED - allow sharing the irq among several devices
49 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
50 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
51 * IRQF_PERCPU - Interrupt is per cpu
52 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
53 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
54 * registered first in an shared interrupt is considered for
55 * performance reasons)
56 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
57 * Used by threaded interrupts which need to keep the
58 * irq line disabled until the threaded handler has been run.
59 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
60 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
61 * IRQF_NO_THREAD - Interrupt cannot be threaded
62 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
65 #define IRQF_DISABLED 0x00000020
66 #define IRQF_SAMPLE_RANDOM 0x00000040
67 #define IRQF_SHARED 0x00000080
68 #define IRQF_PROBE_SHARED 0x00000100
69 #define __IRQF_TIMER 0x00000200
70 #define IRQF_PERCPU 0x00000400
71 #define IRQF_NOBALANCING 0x00000800
72 #define IRQF_IRQPOLL 0x00001000
73 #define IRQF_ONESHOT 0x00002000
74 #define IRQF_NO_SUSPEND 0x00004000
75 #define IRQF_FORCE_RESUME 0x00008000
76 #define IRQF_NO_THREAD 0x00010000
77 #define IRQF_EARLY_RESUME 0x00020000
79 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
82 * These values can be returned by request_any_context_irq() and
83 * describe the context the interrupt will be run in.
85 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
86 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
93 typedef irqreturn_t (*irq_handler_t)(int, void *);
96 * struct irqaction - per interrupt action descriptor
97 * @handler: interrupt handler function
98 * @flags: flags (see IRQF_* above)
99 * @name: name of the device
100 * @dev_id: cookie to identify the device
101 * @percpu_dev_id: cookie to identify the device
102 * @next: pointer to the next irqaction for shared interrupts
103 * @irq: interrupt number
104 * @dir: pointer to the proc/irq/NN/name entry
105 * @thread_fn: interrupt handler function for threaded interrupts
106 * @thread: thread pointer for threaded interrupts
107 * @thread_flags: flags related to @thread
108 * @thread_mask: bitmask for keeping track of @thread activity
111 irq_handler_t handler;
114 void __percpu *percpu_dev_id;
115 struct irqaction *next;
117 irq_handler_t thread_fn;
118 struct task_struct *thread;
119 unsigned long thread_flags;
120 unsigned long thread_mask;
122 struct proc_dir_entry *dir;
123 } ____cacheline_internodealigned_in_smp;
125 extern irqreturn_t no_action(int cpl, void *dev_id);
127 #ifdef CONFIG_GENERIC_HARDIRQS
128 extern int __must_check
129 request_threaded_irq(unsigned int irq, irq_handler_t handler,
130 irq_handler_t thread_fn,
131 unsigned long flags, const char *name, void *dev);
133 static inline int __must_check
134 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
135 const char *name, void *dev)
137 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
140 extern int __must_check
141 request_any_context_irq(unsigned int irq, irq_handler_t handler,
142 unsigned long flags, const char *name, void *dev_id);
144 extern int __must_check
145 request_percpu_irq(unsigned int irq, irq_handler_t handler,
146 const char *devname, void __percpu *percpu_dev_id);
148 extern void exit_irq_thread(void);
151 extern int __must_check
152 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
153 const char *name, void *dev);
156 * Special function to avoid ifdeffery in kernel/irq/devres.c which
157 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
158 * m68k). I really love these $@%#!* obvious Makefile references:
159 * ../../../kernel/irq/devres.o
161 static inline int __must_check
162 request_threaded_irq(unsigned int irq, irq_handler_t handler,
163 irq_handler_t thread_fn,
164 unsigned long flags, const char *name, void *dev)
166 return request_irq(irq, handler, flags, name, dev);
169 static inline int __must_check
170 request_any_context_irq(unsigned int irq, irq_handler_t handler,
171 unsigned long flags, const char *name, void *dev_id)
173 return request_irq(irq, handler, flags, name, dev_id);
176 static inline int __must_check
177 request_percpu_irq(unsigned int irq, irq_handler_t handler,
178 const char *devname, void __percpu *percpu_dev_id)
180 return request_irq(irq, handler, 0, devname, percpu_dev_id);
183 static inline void exit_irq_thread(void) { }
186 extern void free_irq(unsigned int, void *);
187 extern void free_percpu_irq(unsigned int, void __percpu *);
191 extern int __must_check
192 devm_request_threaded_irq(struct device *dev, unsigned int irq,
193 irq_handler_t handler, irq_handler_t thread_fn,
194 unsigned long irqflags, const char *devname,
197 static inline int __must_check
198 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
199 unsigned long irqflags, const char *devname, void *dev_id)
201 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
205 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
208 * On lockdep we dont want to enable hardirqs in hardirq
209 * context. Use local_irq_enable_in_hardirq() to annotate
210 * kernel code that has to do this nevertheless (pretty much
211 * the only valid case is for old/broken hardware that is
214 * NOTE: in theory this might break fragile code that relies
215 * on hardirq delivery - in practice we dont seem to have such
216 * places left. So the only effect should be slightly increased
217 * irqs-off latencies.
219 #ifdef CONFIG_LOCKDEP
220 # define local_irq_enable_in_hardirq() do { } while (0)
222 # define local_irq_enable_in_hardirq() local_irq_enable()
225 extern void disable_irq_nosync(unsigned int irq);
226 extern void disable_irq(unsigned int irq);
227 extern void disable_percpu_irq(unsigned int irq);
228 extern void enable_irq(unsigned int irq);
229 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
231 /* The following three functions are for the core kernel use only. */
232 #ifdef CONFIG_GENERIC_HARDIRQS
233 extern void suspend_device_irqs(void);
234 extern void resume_device_irqs(void);
235 #ifdef CONFIG_PM_SLEEP
236 extern int check_wakeup_irqs(void);
238 static inline int check_wakeup_irqs(void) { return 0; }
241 static inline void suspend_device_irqs(void) { };
242 static inline void resume_device_irqs(void) { };
243 static inline int check_wakeup_irqs(void) { return 0; }
246 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
248 extern cpumask_var_t irq_default_affinity;
250 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
251 extern int irq_can_set_affinity(unsigned int irq);
252 extern int irq_select_affinity(unsigned int irq);
254 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
257 * struct irq_affinity_notify - context for notification of IRQ affinity changes
258 * @irq: Interrupt to which notification applies
259 * @kref: Reference count, for internal use
260 * @work: Work item, for internal use
261 * @notify: Function to be called on change. This will be
262 * called in process context.
263 * @release: Function to be called on release. This will be
264 * called in process context. Once registered, the
265 * structure must only be freed when this function is
268 struct irq_affinity_notify {
271 struct work_struct work;
272 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
273 void (*release)(struct kref *ref);
277 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
279 static inline void irq_run_affinity_notifiers(void)
281 flush_scheduled_work();
284 #else /* CONFIG_SMP */
286 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
291 static inline int irq_can_set_affinity(unsigned int irq)
296 static inline int irq_select_affinity(unsigned int irq) { return 0; }
298 static inline int irq_set_affinity_hint(unsigned int irq,
299 const struct cpumask *m)
303 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
305 #ifdef CONFIG_GENERIC_HARDIRQS
307 * Special lockdep variants of irq disabling/enabling.
308 * These should be used for locking constructs that
309 * know that a particular irq context which is disabled,
310 * and which is the only irq-context user of a lock,
311 * that it's safe to take the lock in the irq-disabled
312 * section without disabling hardirqs.
314 * On !CONFIG_LOCKDEP they are equivalent to the normal
315 * irq disable/enable methods.
317 static inline void disable_irq_nosync_lockdep(unsigned int irq)
319 disable_irq_nosync(irq);
320 #ifdef CONFIG_LOCKDEP
325 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
327 disable_irq_nosync(irq);
328 #ifdef CONFIG_LOCKDEP
329 local_irq_save(*flags);
333 static inline void disable_irq_lockdep(unsigned int irq)
336 #ifdef CONFIG_LOCKDEP
341 static inline void enable_irq_lockdep(unsigned int irq)
343 #ifdef CONFIG_LOCKDEP
349 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
351 #ifdef CONFIG_LOCKDEP
352 local_irq_restore(*flags);
357 /* IRQ wakeup (PM) control: */
358 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
360 static inline int enable_irq_wake(unsigned int irq)
362 return irq_set_irq_wake(irq, 1);
365 static inline int disable_irq_wake(unsigned int irq)
367 return irq_set_irq_wake(irq, 0);
370 #else /* !CONFIG_GENERIC_HARDIRQS */
372 * NOTE: non-genirq architectures, if they want to support the lock
373 * validator need to define the methods below in their asm/irq.h
374 * files, under an #ifdef CONFIG_LOCKDEP section.
376 #ifndef CONFIG_LOCKDEP
377 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
378 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
379 disable_irq_nosync(irq)
380 # define disable_irq_lockdep(irq) disable_irq(irq)
381 # define enable_irq_lockdep(irq) enable_irq(irq)
382 # define enable_irq_lockdep_irqrestore(irq, flags) \
386 static inline int enable_irq_wake(unsigned int irq)
391 static inline int disable_irq_wake(unsigned int irq)
395 #endif /* CONFIG_GENERIC_HARDIRQS */
397 #ifdef CONFIG_HAVE_IRQ_IGNORE_UNHANDLED
398 int irq_ignore_unhandled(unsigned int irq);
400 #define irq_ignore_unhandled(irq) 0
403 #ifdef CONFIG_IRQ_FORCED_THREADING
404 extern bool force_irqthreads;
406 #define force_irqthreads (0)
409 #ifndef __ARCH_SET_SOFTIRQ_PENDING
410 #define set_softirq_pending(x) (local_softirq_pending() = (x))
411 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
414 /* Some architectures might implement lazy enabling/disabling of
415 * interrupts. In some cases, such as stop_machine, we might want
416 * to ensure that after a local_irq_disable(), interrupts have
417 * really been disabled in hardware. Such architectures need to
418 * implement the following hook.
420 #ifndef hard_irq_disable
421 #define hard_irq_disable() do { } while(0)
424 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
425 frequency threaded job scheduling. For almost all the purposes
426 tasklets are more than enough. F.e. all serial device BHs et
427 al. should be converted to tasklets, not to softirqs.
437 BLOCK_IOPOLL_SOFTIRQ,
441 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
446 /* map softirq index to softirq name. update 'softirq_to_name' in
447 * kernel/softirq.c when adding a new softirq.
449 extern char *softirq_to_name[NR_SOFTIRQS];
451 /* softirq mask and active fields moved to irq_cpustat_t in
452 * asm/hardirq.h to get better cache usage. KAO
455 struct softirq_action
457 void (*action)(struct softirq_action *);
460 asmlinkage void do_softirq(void);
461 asmlinkage void __do_softirq(void);
462 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
463 extern void softirq_init(void);
464 static inline void __raise_softirq_irqoff(unsigned int nr)
466 trace_softirq_raise(nr);
467 or_softirq_pending(1UL << nr);
470 extern void raise_softirq_irqoff(unsigned int nr);
471 extern void raise_softirq(unsigned int nr);
473 /* This is the worklist that queues up per-cpu softirq work.
475 * send_remote_sendirq() adds work to these lists, and
476 * the softirq handler itself dequeues from them. The queues
477 * are protected by disabling local cpu interrupts and they must
478 * only be accessed by the local cpu that they are for.
480 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
482 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
484 static inline struct task_struct *this_cpu_ksoftirqd(void)
486 return this_cpu_read(ksoftirqd);
489 /* Try to send a softirq to a remote cpu. If this cannot be done, the
490 * work will be queued to the local cpu.
492 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
494 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
495 * and compute the current cpu, passed in as 'this_cpu'.
497 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
498 int this_cpu, int softirq);
500 /* Tasklets --- multithreaded analogue of BHs.
502 Main feature differing them of generic softirqs: tasklet
503 is running only on one CPU simultaneously.
505 Main feature differing them of BHs: different tasklets
506 may be run simultaneously on different CPUs.
509 * If tasklet_schedule() is called, then tasklet is guaranteed
510 to be executed on some cpu at least once after this.
511 * If the tasklet is already scheduled, but its execution is still not
512 started, it will be executed only once.
513 * If this tasklet is already running on another CPU (or schedule is called
514 from tasklet itself), it is rescheduled for later.
515 * Tasklet is strictly serialized wrt itself, but not
516 wrt another tasklets. If client needs some intertask synchronization,
517 he makes it with spinlocks.
520 struct tasklet_struct
522 struct tasklet_struct *next;
525 void (*func)(unsigned long);
529 #define DECLARE_TASKLET(name, func, data) \
530 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
532 #define DECLARE_TASKLET_DISABLED(name, func, data) \
533 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
538 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
539 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
543 static inline int tasklet_trylock(struct tasklet_struct *t)
545 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
548 static inline void tasklet_unlock(struct tasklet_struct *t)
550 smp_mb__before_clear_bit();
551 clear_bit(TASKLET_STATE_RUN, &(t)->state);
554 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
556 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
559 #define tasklet_trylock(t) 1
560 #define tasklet_unlock_wait(t) do { } while (0)
561 #define tasklet_unlock(t) do { } while (0)
564 extern void __tasklet_schedule(struct tasklet_struct *t);
566 static inline void tasklet_schedule(struct tasklet_struct *t)
568 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
569 __tasklet_schedule(t);
572 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
574 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
576 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
577 __tasklet_hi_schedule(t);
580 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
583 * This version avoids touching any other tasklets. Needed for kmemcheck
584 * in order not to take any page faults while enqueueing this tasklet;
585 * consider VERY carefully whether you really need this or
586 * tasklet_hi_schedule()...
588 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
590 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
591 __tasklet_hi_schedule_first(t);
595 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
597 atomic_inc(&t->count);
598 smp_mb__after_atomic_inc();
601 static inline void tasklet_disable(struct tasklet_struct *t)
603 tasklet_disable_nosync(t);
604 tasklet_unlock_wait(t);
608 static inline void tasklet_enable(struct tasklet_struct *t)
610 smp_mb__before_atomic_dec();
611 atomic_dec(&t->count);
614 static inline void tasklet_hi_enable(struct tasklet_struct *t)
616 smp_mb__before_atomic_dec();
617 atomic_dec(&t->count);
620 extern void tasklet_kill(struct tasklet_struct *t);
621 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
622 extern void tasklet_init(struct tasklet_struct *t,
623 void (*func)(unsigned long), unsigned long data);
625 struct tasklet_hrtimer {
626 struct hrtimer timer;
627 struct tasklet_struct tasklet;
628 enum hrtimer_restart (*function)(struct hrtimer *);
632 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
633 enum hrtimer_restart (*function)(struct hrtimer *),
634 clockid_t which_clock, enum hrtimer_mode mode);
637 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
638 const enum hrtimer_mode mode)
640 return hrtimer_start(&ttimer->timer, time, mode);
644 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
646 hrtimer_cancel(&ttimer->timer);
647 tasklet_kill(&ttimer->tasklet);
651 * Autoprobing for irqs:
653 * probe_irq_on() and probe_irq_off() provide robust primitives
654 * for accurate IRQ probing during kernel initialization. They are
655 * reasonably simple to use, are not "fooled" by spurious interrupts,
656 * and, unlike other attempts at IRQ probing, they do not get hung on
657 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
659 * For reasonably foolproof probing, use them as follows:
661 * 1. clear and/or mask the device's internal interrupt.
663 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
664 * 4. enable the device and cause it to trigger an interrupt.
665 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
666 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
667 * 7. service the device to clear its pending interrupt.
668 * 8. loop again if paranoia is required.
670 * probe_irq_on() returns a mask of allocated irq's.
672 * probe_irq_off() takes the mask as a parameter,
673 * and returns the irq number which occurred,
674 * or zero if none occurred, or a negative irq number
675 * if more than one irq occurred.
678 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
679 static inline unsigned long probe_irq_on(void)
683 static inline int probe_irq_off(unsigned long val)
687 static inline unsigned int probe_irq_mask(unsigned long val)
692 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
693 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
694 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
697 #ifdef CONFIG_PROC_FS
698 /* Initialize /proc/irq/ */
699 extern void init_irq_proc(void);
701 static inline void init_irq_proc(void)
707 int show_interrupts(struct seq_file *p, void *v);
708 int arch_show_interrupts(struct seq_file *p, int prec);
710 extern int early_irq_init(void);
711 extern int arch_probe_nr_irqs(void);
712 extern int arch_early_irq_init(void);