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
63 #define IRQF_DISABLED 0x00000020
64 #define IRQF_SAMPLE_RANDOM 0x00000040
65 #define IRQF_SHARED 0x00000080
66 #define IRQF_PROBE_SHARED 0x00000100
67 #define __IRQF_TIMER 0x00000200
68 #define IRQF_PERCPU 0x00000400
69 #define IRQF_NOBALANCING 0x00000800
70 #define IRQF_IRQPOLL 0x00001000
71 #define IRQF_ONESHOT 0x00002000
72 #define IRQF_NO_SUSPEND 0x00004000
73 #define IRQF_FORCE_RESUME 0x00008000
74 #define IRQF_NO_THREAD 0x00010000
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 * @flags: flags (see IRQF_* above)
96 * @name: name of the device
97 * @dev_id: cookie to identify the device
98 * @percpu_dev_id: cookie to identify the device
99 * @next: pointer to the next irqaction for shared interrupts
100 * @irq: interrupt number
101 * @dir: pointer to the proc/irq/NN/name entry
102 * @thread_fn: interrupt handler function for threaded interrupts
103 * @thread: thread pointer for threaded interrupts
104 * @thread_flags: flags related to @thread
105 * @thread_mask: bitmask for keeping track of @thread activity
108 irq_handler_t handler;
111 void __percpu *percpu_dev_id;
112 struct irqaction *next;
114 irq_handler_t thread_fn;
115 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 #ifdef CONFIG_GENERIC_HARDIRQS
125 extern int __must_check
126 request_threaded_irq(unsigned int irq, irq_handler_t handler,
127 irq_handler_t thread_fn,
128 unsigned long flags, const char *name, void *dev);
130 static inline int __must_check
131 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
132 const char *name, void *dev)
134 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
137 extern int __must_check
138 request_any_context_irq(unsigned int irq, irq_handler_t handler,
139 unsigned long flags, const char *name, void *dev_id);
141 extern int __must_check
142 request_percpu_irq(unsigned int irq, irq_handler_t handler,
143 const char *devname, void __percpu *percpu_dev_id);
145 extern void exit_irq_thread(void);
148 extern int __must_check
149 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
150 const char *name, void *dev);
153 * Special function to avoid ifdeffery in kernel/irq/devres.c which
154 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
155 * m68k). I really love these $@%#!* obvious Makefile references:
156 * ../../../kernel/irq/devres.o
158 static inline int __must_check
159 request_threaded_irq(unsigned int irq, irq_handler_t handler,
160 irq_handler_t thread_fn,
161 unsigned long flags, const char *name, void *dev)
163 return request_irq(irq, handler, flags, name, dev);
166 static inline int __must_check
167 request_any_context_irq(unsigned int irq, irq_handler_t handler,
168 unsigned long flags, const char *name, void *dev_id)
170 return request_irq(irq, handler, flags, name, dev_id);
173 static inline int __must_check
174 request_percpu_irq(unsigned int irq, irq_handler_t handler,
175 const char *devname, void __percpu *percpu_dev_id)
177 return request_irq(irq, handler, 0, devname, percpu_dev_id);
180 static inline void exit_irq_thread(void) { }
183 extern void free_irq(unsigned int, void *);
184 extern void free_percpu_irq(unsigned int, void __percpu *);
188 extern int __must_check
189 devm_request_threaded_irq(struct device *dev, unsigned int irq,
190 irq_handler_t handler, irq_handler_t thread_fn,
191 unsigned long irqflags, const char *devname,
194 static inline int __must_check
195 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
196 unsigned long irqflags, const char *devname, void *dev_id)
198 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
202 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
205 * On lockdep we dont want to enable hardirqs in hardirq
206 * context. Use local_irq_enable_in_hardirq() to annotate
207 * kernel code that has to do this nevertheless (pretty much
208 * the only valid case is for old/broken hardware that is
211 * NOTE: in theory this might break fragile code that relies
212 * on hardirq delivery - in practice we dont seem to have such
213 * places left. So the only effect should be slightly increased
214 * irqs-off latencies.
216 #ifdef CONFIG_LOCKDEP
217 # define local_irq_enable_in_hardirq() do { } while (0)
219 # define local_irq_enable_in_hardirq() local_irq_enable()
222 extern void disable_irq_nosync(unsigned int irq);
223 extern void disable_irq(unsigned int irq);
224 extern void disable_percpu_irq(unsigned int irq);
225 extern void enable_irq(unsigned int irq);
226 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
228 /* The following three functions are for the core kernel use only. */
229 #ifdef CONFIG_GENERIC_HARDIRQS
230 extern void suspend_device_irqs(void);
231 extern void resume_device_irqs(void);
232 #ifdef CONFIG_PM_SLEEP
233 extern int check_wakeup_irqs(void);
235 static inline int check_wakeup_irqs(void) { return 0; }
238 static inline void suspend_device_irqs(void) { };
239 static inline void resume_device_irqs(void) { };
240 static inline int check_wakeup_irqs(void) { return 0; }
243 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
245 extern cpumask_var_t irq_default_affinity;
247 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
248 extern int irq_can_set_affinity(unsigned int irq);
249 extern int irq_select_affinity(unsigned int irq);
251 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
254 * struct irq_affinity_notify - context for notification of IRQ affinity changes
255 * @irq: Interrupt to which notification applies
256 * @kref: Reference count, for internal use
257 * @work: Work item, for internal use
258 * @notify: Function to be called on change. This will be
259 * called in process context.
260 * @release: Function to be called on release. This will be
261 * called in process context. Once registered, the
262 * structure must only be freed when this function is
265 struct irq_affinity_notify {
268 struct work_struct work;
269 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
270 void (*release)(struct kref *ref);
274 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
276 static inline void irq_run_affinity_notifiers(void)
278 flush_scheduled_work();
281 #else /* CONFIG_SMP */
283 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
288 static inline int irq_can_set_affinity(unsigned int irq)
293 static inline int irq_select_affinity(unsigned int irq) { return 0; }
295 static inline int irq_set_affinity_hint(unsigned int irq,
296 const struct cpumask *m)
300 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
302 #ifdef CONFIG_GENERIC_HARDIRQS
304 * Special lockdep variants of irq disabling/enabling.
305 * These should be used for locking constructs that
306 * know that a particular irq context which is disabled,
307 * and which is the only irq-context user of a lock,
308 * that it's safe to take the lock in the irq-disabled
309 * section without disabling hardirqs.
311 * On !CONFIG_LOCKDEP they are equivalent to the normal
312 * irq disable/enable methods.
314 static inline void disable_irq_nosync_lockdep(unsigned int irq)
316 disable_irq_nosync(irq);
317 #ifdef CONFIG_LOCKDEP
322 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
324 disable_irq_nosync(irq);
325 #ifdef CONFIG_LOCKDEP
326 local_irq_save(*flags);
330 static inline void disable_irq_lockdep(unsigned int irq)
333 #ifdef CONFIG_LOCKDEP
338 static inline void enable_irq_lockdep(unsigned int irq)
340 #ifdef CONFIG_LOCKDEP
346 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
348 #ifdef CONFIG_LOCKDEP
349 local_irq_restore(*flags);
354 /* IRQ wakeup (PM) control: */
355 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
357 static inline int enable_irq_wake(unsigned int irq)
359 return irq_set_irq_wake(irq, 1);
362 static inline int disable_irq_wake(unsigned int irq)
364 return irq_set_irq_wake(irq, 0);
367 #else /* !CONFIG_GENERIC_HARDIRQS */
369 * NOTE: non-genirq architectures, if they want to support the lock
370 * validator need to define the methods below in their asm/irq.h
371 * files, under an #ifdef CONFIG_LOCKDEP section.
373 #ifndef CONFIG_LOCKDEP
374 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
375 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
376 disable_irq_nosync(irq)
377 # define disable_irq_lockdep(irq) disable_irq(irq)
378 # define enable_irq_lockdep(irq) enable_irq(irq)
379 # define enable_irq_lockdep_irqrestore(irq, flags) \
383 static inline int enable_irq_wake(unsigned int irq)
388 static inline int disable_irq_wake(unsigned int irq)
392 #endif /* CONFIG_GENERIC_HARDIRQS */
395 #ifdef CONFIG_IRQ_FORCED_THREADING
396 extern bool force_irqthreads;
398 #define force_irqthreads (0)
401 #ifndef __ARCH_SET_SOFTIRQ_PENDING
402 #define set_softirq_pending(x) (local_softirq_pending() = (x))
403 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
406 /* Some architectures might implement lazy enabling/disabling of
407 * interrupts. In some cases, such as stop_machine, we might want
408 * to ensure that after a local_irq_disable(), interrupts have
409 * really been disabled in hardware. Such architectures need to
410 * implement the following hook.
412 #ifndef hard_irq_disable
413 #define hard_irq_disable() do { } while(0)
416 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
417 frequency threaded job scheduling. For almost all the purposes
418 tasklets are more than enough. F.e. all serial device BHs et
419 al. should be converted to tasklets, not to softirqs.
429 BLOCK_IOPOLL_SOFTIRQ,
433 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
438 /* map softirq index to softirq name. update 'softirq_to_name' in
439 * kernel/softirq.c when adding a new softirq.
441 extern char *softirq_to_name[NR_SOFTIRQS];
443 /* softirq mask and active fields moved to irq_cpustat_t in
444 * asm/hardirq.h to get better cache usage. KAO
447 struct softirq_action
449 void (*action)(struct softirq_action *);
452 asmlinkage void do_softirq(void);
453 asmlinkage void __do_softirq(void);
454 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
455 extern void softirq_init(void);
456 static inline void __raise_softirq_irqoff(unsigned int nr)
458 trace_softirq_raise(nr);
459 or_softirq_pending(1UL << nr);
462 extern void raise_softirq_irqoff(unsigned int nr);
463 extern void raise_softirq(unsigned int nr);
465 /* This is the worklist that queues up per-cpu softirq work.
467 * send_remote_sendirq() adds work to these lists, and
468 * the softirq handler itself dequeues from them. The queues
469 * are protected by disabling local cpu interrupts and they must
470 * only be accessed by the local cpu that they are for.
472 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
474 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
476 static inline struct task_struct *this_cpu_ksoftirqd(void)
478 return this_cpu_read(ksoftirqd);
481 /* Try to send a softirq to a remote cpu. If this cannot be done, the
482 * work will be queued to the local cpu.
484 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
486 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
487 * and compute the current cpu, passed in as 'this_cpu'.
489 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
490 int this_cpu, int softirq);
492 /* Tasklets --- multithreaded analogue of BHs.
494 Main feature differing them of generic softirqs: tasklet
495 is running only on one CPU simultaneously.
497 Main feature differing them of BHs: different tasklets
498 may be run simultaneously on different CPUs.
501 * If tasklet_schedule() is called, then tasklet is guaranteed
502 to be executed on some cpu at least once after this.
503 * If the tasklet is already scheduled, but its execution is still not
504 started, it will be executed only once.
505 * If this tasklet is already running on another CPU (or schedule is called
506 from tasklet itself), it is rescheduled for later.
507 * Tasklet is strictly serialized wrt itself, but not
508 wrt another tasklets. If client needs some intertask synchronization,
509 he makes it with spinlocks.
512 struct tasklet_struct
514 struct tasklet_struct *next;
517 void (*func)(unsigned long);
521 #define DECLARE_TASKLET(name, func, data) \
522 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
524 #define DECLARE_TASKLET_DISABLED(name, func, data) \
525 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
530 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
531 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
535 static inline int tasklet_trylock(struct tasklet_struct *t)
537 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
540 static inline void tasklet_unlock(struct tasklet_struct *t)
542 smp_mb__before_clear_bit();
543 clear_bit(TASKLET_STATE_RUN, &(t)->state);
546 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
548 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
551 #define tasklet_trylock(t) 1
552 #define tasklet_unlock_wait(t) do { } while (0)
553 #define tasklet_unlock(t) do { } while (0)
556 extern void __tasklet_schedule(struct tasklet_struct *t);
558 static inline void tasklet_schedule(struct tasklet_struct *t)
560 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
561 __tasklet_schedule(t);
564 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
566 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
568 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
569 __tasklet_hi_schedule(t);
572 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
575 * This version avoids touching any other tasklets. Needed for kmemcheck
576 * in order not to take any page faults while enqueueing this tasklet;
577 * consider VERY carefully whether you really need this or
578 * tasklet_hi_schedule()...
580 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
582 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
583 __tasklet_hi_schedule_first(t);
587 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
589 atomic_inc(&t->count);
590 smp_mb__after_atomic_inc();
593 static inline void tasklet_disable(struct tasklet_struct *t)
595 tasklet_disable_nosync(t);
596 tasklet_unlock_wait(t);
600 static inline void tasklet_enable(struct tasklet_struct *t)
602 smp_mb__before_atomic_dec();
603 atomic_dec(&t->count);
606 static inline void tasklet_hi_enable(struct tasklet_struct *t)
608 smp_mb__before_atomic_dec();
609 atomic_dec(&t->count);
612 extern void tasklet_kill(struct tasklet_struct *t);
613 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
614 extern void tasklet_init(struct tasklet_struct *t,
615 void (*func)(unsigned long), unsigned long data);
617 struct tasklet_hrtimer {
618 struct hrtimer timer;
619 struct tasklet_struct tasklet;
620 enum hrtimer_restart (*function)(struct hrtimer *);
624 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
625 enum hrtimer_restart (*function)(struct hrtimer *),
626 clockid_t which_clock, enum hrtimer_mode mode);
629 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
630 const enum hrtimer_mode mode)
632 return hrtimer_start(&ttimer->timer, time, mode);
636 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
638 hrtimer_cancel(&ttimer->timer);
639 tasklet_kill(&ttimer->tasklet);
643 * Autoprobing for irqs:
645 * probe_irq_on() and probe_irq_off() provide robust primitives
646 * for accurate IRQ probing during kernel initialization. They are
647 * reasonably simple to use, are not "fooled" by spurious interrupts,
648 * and, unlike other attempts at IRQ probing, they do not get hung on
649 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
651 * For reasonably foolproof probing, use them as follows:
653 * 1. clear and/or mask the device's internal interrupt.
655 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
656 * 4. enable the device and cause it to trigger an interrupt.
657 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
658 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
659 * 7. service the device to clear its pending interrupt.
660 * 8. loop again if paranoia is required.
662 * probe_irq_on() returns a mask of allocated irq's.
664 * probe_irq_off() takes the mask as a parameter,
665 * and returns the irq number which occurred,
666 * or zero if none occurred, or a negative irq number
667 * if more than one irq occurred.
670 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
671 static inline unsigned long probe_irq_on(void)
675 static inline int probe_irq_off(unsigned long val)
679 static inline unsigned int probe_irq_mask(unsigned long val)
684 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
685 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
686 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
689 #ifdef CONFIG_PROC_FS
690 /* Initialize /proc/irq/ */
691 extern void init_irq_proc(void);
693 static inline void init_irq_proc(void)
699 int show_interrupts(struct seq_file *p, void *v);
700 int arch_show_interrupts(struct seq_file *p, int prec);
702 extern int early_irq_init(void);
703 extern int arch_probe_nr_irqs(void);
704 extern int arch_early_irq_init(void);