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>
25 * These correspond to the IORESOURCE_IRQ_* defines in
26 * linux/ioport.h to select the interrupt line behaviour. When
27 * requesting an interrupt without specifying a IRQF_TRIGGER, the
28 * setting should be assumed to be "as already configured", which
29 * may be as per machine or firmware initialisation.
31 #define IRQF_TRIGGER_NONE 0x00000000
32 #define IRQF_TRIGGER_RISING 0x00000001
33 #define IRQF_TRIGGER_FALLING 0x00000002
34 #define IRQF_TRIGGER_HIGH 0x00000004
35 #define IRQF_TRIGGER_LOW 0x00000008
36 #define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
37 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
38 #define IRQF_TRIGGER_PROBE 0x00000010
41 * These flags used only by the kernel as part of the
42 * irq handling routines.
44 * IRQF_DISABLED - keep irqs disabled when calling the action handler.
45 * DEPRECATED. This flag is a NOOP and scheduled to be removed
46 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
47 * IRQF_SHARED - allow sharing the irq among several devices
48 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
49 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
50 * IRQF_PERCPU - Interrupt is per cpu
51 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
52 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
53 * registered first in an shared interrupt is considered for
54 * performance reasons)
55 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
56 * Used by threaded interrupts which need to keep the
57 * irq line disabled until the threaded handler has been run.
58 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
59 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
60 * IRQF_NO_THREAD - Interrupt cannot be threaded
61 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
64 #define IRQF_DISABLED 0x00000020
65 #define IRQF_SAMPLE_RANDOM 0x00000040
66 #define IRQF_SHARED 0x00000080
67 #define IRQF_PROBE_SHARED 0x00000100
68 #define __IRQF_TIMER 0x00000200
69 #define IRQF_PERCPU 0x00000400
70 #define IRQF_NOBALANCING 0x00000800
71 #define IRQF_IRQPOLL 0x00001000
72 #define IRQF_ONESHOT 0x00002000
73 #define IRQF_NO_SUSPEND 0x00004000
74 #define IRQF_FORCE_RESUME 0x00008000
75 #define IRQF_NO_THREAD 0x00010000
76 #define IRQF_EARLY_RESUME 0x00020000
78 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
81 * These values can be returned by request_any_context_irq() and
82 * describe the context the interrupt will be run in.
84 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
85 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
92 typedef irqreturn_t (*irq_handler_t)(int, void *);
95 * struct irqaction - per interrupt action descriptor
96 * @handler: interrupt handler function
97 * @flags: flags (see IRQF_* above)
98 * @name: name of the device
99 * @dev_id: cookie to identify the device
100 * @percpu_dev_id: cookie to identify the device
101 * @next: pointer to the next irqaction for shared interrupts
102 * @irq: interrupt number
103 * @dir: pointer to the proc/irq/NN/name entry
104 * @thread_fn: interrupt handler function for threaded interrupts
105 * @thread: thread pointer for threaded interrupts
106 * @thread_flags: flags related to @thread
107 * @thread_mask: bitmask for keeping track of @thread activity
110 irq_handler_t handler;
113 void __percpu *percpu_dev_id;
114 struct irqaction *next;
116 irq_handler_t thread_fn;
117 struct task_struct *thread;
118 unsigned long thread_flags;
119 unsigned long thread_mask;
121 struct proc_dir_entry *dir;
122 } ____cacheline_internodealigned_in_smp;
124 extern irqreturn_t no_action(int cpl, void *dev_id);
126 #ifdef CONFIG_GENERIC_HARDIRQS
127 extern int __must_check
128 request_threaded_irq(unsigned int irq, irq_handler_t handler,
129 irq_handler_t thread_fn,
130 unsigned long flags, const char *name, void *dev);
132 static inline int __must_check
133 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
134 const char *name, void *dev)
136 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
139 extern int __must_check
140 request_any_context_irq(unsigned int irq, irq_handler_t handler,
141 unsigned long flags, const char *name, void *dev_id);
143 extern int __must_check
144 request_percpu_irq(unsigned int irq, irq_handler_t handler,
145 const char *devname, void __percpu *percpu_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 int __must_check
176 request_percpu_irq(unsigned int irq, irq_handler_t handler,
177 const char *devname, void __percpu *percpu_dev_id)
179 return request_irq(irq, handler, 0, devname, percpu_dev_id);
182 static inline void exit_irq_thread(void) { }
185 extern void free_irq(unsigned int, void *);
186 extern void free_percpu_irq(unsigned int, void __percpu *);
190 extern int __must_check
191 devm_request_threaded_irq(struct device *dev, unsigned int irq,
192 irq_handler_t handler, irq_handler_t thread_fn,
193 unsigned long irqflags, const char *devname,
196 static inline int __must_check
197 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
198 unsigned long irqflags, const char *devname, void *dev_id)
200 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
204 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
207 * On lockdep we dont want to enable hardirqs in hardirq
208 * context. Use local_irq_enable_in_hardirq() to annotate
209 * kernel code that has to do this nevertheless (pretty much
210 * the only valid case is for old/broken hardware that is
213 * NOTE: in theory this might break fragile code that relies
214 * on hardirq delivery - in practice we dont seem to have such
215 * places left. So the only effect should be slightly increased
216 * irqs-off latencies.
218 #ifdef CONFIG_LOCKDEP
219 # define local_irq_enable_in_hardirq() do { } while (0)
221 # define local_irq_enable_in_hardirq() local_irq_enable()
224 extern void disable_irq_nosync(unsigned int irq);
225 extern void disable_irq(unsigned int irq);
226 extern void disable_percpu_irq(unsigned int irq);
227 extern void enable_irq(unsigned int irq);
228 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
230 /* The following three functions are for the core kernel use only. */
231 #ifdef CONFIG_GENERIC_HARDIRQS
232 extern void suspend_device_irqs(void);
233 extern void resume_device_irqs(void);
234 #ifdef CONFIG_PM_SLEEP
235 extern int check_wakeup_irqs(void);
237 static inline int check_wakeup_irqs(void) { return 0; }
240 static inline void suspend_device_irqs(void) { };
241 static inline void resume_device_irqs(void) { };
242 static inline int check_wakeup_irqs(void) { return 0; }
245 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
247 extern cpumask_var_t irq_default_affinity;
249 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
250 extern int irq_can_set_affinity(unsigned int irq);
251 extern int irq_select_affinity(unsigned int irq);
253 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
256 * struct irq_affinity_notify - context for notification of IRQ affinity changes
257 * @irq: Interrupt to which notification applies
258 * @kref: Reference count, for internal use
259 * @work: Work item, for internal use
260 * @notify: Function to be called on change. This will be
261 * called in process context.
262 * @release: Function to be called on release. This will be
263 * called in process context. Once registered, the
264 * structure must only be freed when this function is
267 struct irq_affinity_notify {
270 struct work_struct work;
271 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
272 void (*release)(struct kref *ref);
276 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
278 static inline void irq_run_affinity_notifiers(void)
280 flush_scheduled_work();
283 #else /* CONFIG_SMP */
285 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
290 static inline int irq_can_set_affinity(unsigned int irq)
295 static inline int irq_select_affinity(unsigned int irq) { return 0; }
297 static inline int irq_set_affinity_hint(unsigned int irq,
298 const struct cpumask *m)
302 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
304 #ifdef CONFIG_GENERIC_HARDIRQS
306 * Special lockdep variants of irq disabling/enabling.
307 * These should be used for locking constructs that
308 * know that a particular irq context which is disabled,
309 * and which is the only irq-context user of a lock,
310 * that it's safe to take the lock in the irq-disabled
311 * section without disabling hardirqs.
313 * On !CONFIG_LOCKDEP they are equivalent to the normal
314 * irq disable/enable methods.
316 static inline void disable_irq_nosync_lockdep(unsigned int irq)
318 disable_irq_nosync(irq);
319 #ifdef CONFIG_LOCKDEP
324 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
326 disable_irq_nosync(irq);
327 #ifdef CONFIG_LOCKDEP
328 local_irq_save(*flags);
332 static inline void disable_irq_lockdep(unsigned int irq)
335 #ifdef CONFIG_LOCKDEP
340 static inline void enable_irq_lockdep(unsigned int irq)
342 #ifdef CONFIG_LOCKDEP
348 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
350 #ifdef CONFIG_LOCKDEP
351 local_irq_restore(*flags);
356 /* IRQ wakeup (PM) control: */
357 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
359 static inline int enable_irq_wake(unsigned int irq)
361 return irq_set_irq_wake(irq, 1);
364 static inline int disable_irq_wake(unsigned int irq)
366 return irq_set_irq_wake(irq, 0);
369 #else /* !CONFIG_GENERIC_HARDIRQS */
371 * NOTE: non-genirq architectures, if they want to support the lock
372 * validator need to define the methods below in their asm/irq.h
373 * files, under an #ifdef CONFIG_LOCKDEP section.
375 #ifndef CONFIG_LOCKDEP
376 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
377 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
378 disable_irq_nosync(irq)
379 # define disable_irq_lockdep(irq) disable_irq(irq)
380 # define enable_irq_lockdep(irq) enable_irq(irq)
381 # define enable_irq_lockdep_irqrestore(irq, flags) \
385 static inline int enable_irq_wake(unsigned int irq)
390 static inline int disable_irq_wake(unsigned int irq)
394 #endif /* CONFIG_GENERIC_HARDIRQS */
397 #ifdef CONFIG_IRQ_FORCED_THREADING
398 extern bool force_irqthreads;
400 #define force_irqthreads (0)
403 #ifndef __ARCH_SET_SOFTIRQ_PENDING
404 #define set_softirq_pending(x) (local_softirq_pending() = (x))
405 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
408 /* Some architectures might implement lazy enabling/disabling of
409 * interrupts. In some cases, such as stop_machine, we might want
410 * to ensure that after a local_irq_disable(), interrupts have
411 * really been disabled in hardware. Such architectures need to
412 * implement the following hook.
414 #ifndef hard_irq_disable
415 #define hard_irq_disable() do { } while(0)
418 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
419 frequency threaded job scheduling. For almost all the purposes
420 tasklets are more than enough. F.e. all serial device BHs et
421 al. should be converted to tasklets, not to softirqs.
431 BLOCK_IOPOLL_SOFTIRQ,
435 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
440 /* map softirq index to softirq name. update 'softirq_to_name' in
441 * kernel/softirq.c when adding a new softirq.
443 extern char *softirq_to_name[NR_SOFTIRQS];
445 /* softirq mask and active fields moved to irq_cpustat_t in
446 * asm/hardirq.h to get better cache usage. KAO
449 struct softirq_action
451 void (*action)(struct softirq_action *);
454 asmlinkage void do_softirq(void);
455 asmlinkage void __do_softirq(void);
456 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
457 extern void softirq_init(void);
458 extern void __raise_softirq_irqoff(unsigned int nr);
460 extern void raise_softirq_irqoff(unsigned int nr);
461 extern void raise_softirq(unsigned int nr);
463 /* This is the worklist that queues up per-cpu softirq work.
465 * send_remote_sendirq() adds work to these lists, and
466 * the softirq handler itself dequeues from them. The queues
467 * are protected by disabling local cpu interrupts and they must
468 * only be accessed by the local cpu that they are for.
470 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
472 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
474 static inline struct task_struct *this_cpu_ksoftirqd(void)
476 return this_cpu_read(ksoftirqd);
479 /* Try to send a softirq to a remote cpu. If this cannot be done, the
480 * work will be queued to the local cpu.
482 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
484 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
485 * and compute the current cpu, passed in as 'this_cpu'.
487 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
488 int this_cpu, int softirq);
490 /* Tasklets --- multithreaded analogue of BHs.
492 Main feature differing them of generic softirqs: tasklet
493 is running only on one CPU simultaneously.
495 Main feature differing them of BHs: different tasklets
496 may be run simultaneously on different CPUs.
499 * If tasklet_schedule() is called, then tasklet is guaranteed
500 to be executed on some cpu at least once after this.
501 * If the tasklet is already scheduled, but its execution is still not
502 started, it will be executed only once.
503 * If this tasklet is already running on another CPU (or schedule is called
504 from tasklet itself), it is rescheduled for later.
505 * Tasklet is strictly serialized wrt itself, but not
506 wrt another tasklets. If client needs some intertask synchronization,
507 he makes it with spinlocks.
510 struct tasklet_struct
512 struct tasklet_struct *next;
515 void (*func)(unsigned long);
519 #define DECLARE_TASKLET(name, func, data) \
520 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
522 #define DECLARE_TASKLET_DISABLED(name, func, data) \
523 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
528 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
529 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
533 static inline int tasklet_trylock(struct tasklet_struct *t)
535 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
538 static inline void tasklet_unlock(struct tasklet_struct *t)
540 smp_mb__before_clear_bit();
541 clear_bit(TASKLET_STATE_RUN, &(t)->state);
544 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
546 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
549 #define tasklet_trylock(t) 1
550 #define tasklet_unlock_wait(t) do { } while (0)
551 #define tasklet_unlock(t) do { } while (0)
554 extern void __tasklet_schedule(struct tasklet_struct *t);
556 static inline void tasklet_schedule(struct tasklet_struct *t)
558 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
559 __tasklet_schedule(t);
562 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
564 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
566 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
567 __tasklet_hi_schedule(t);
570 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
573 * This version avoids touching any other tasklets. Needed for kmemcheck
574 * in order not to take any page faults while enqueueing this tasklet;
575 * consider VERY carefully whether you really need this or
576 * tasklet_hi_schedule()...
578 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
580 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
581 __tasklet_hi_schedule_first(t);
585 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
587 atomic_inc(&t->count);
588 smp_mb__after_atomic_inc();
591 static inline void tasklet_disable(struct tasklet_struct *t)
593 tasklet_disable_nosync(t);
594 tasklet_unlock_wait(t);
598 static inline void tasklet_enable(struct tasklet_struct *t)
600 smp_mb__before_atomic_dec();
601 atomic_dec(&t->count);
604 static inline void tasklet_hi_enable(struct tasklet_struct *t)
606 smp_mb__before_atomic_dec();
607 atomic_dec(&t->count);
610 extern void tasklet_kill(struct tasklet_struct *t);
611 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
612 extern void tasklet_init(struct tasklet_struct *t,
613 void (*func)(unsigned long), unsigned long data);
615 struct tasklet_hrtimer {
616 struct hrtimer timer;
617 struct tasklet_struct tasklet;
618 enum hrtimer_restart (*function)(struct hrtimer *);
622 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
623 enum hrtimer_restart (*function)(struct hrtimer *),
624 clockid_t which_clock, enum hrtimer_mode mode);
627 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
628 const enum hrtimer_mode mode)
630 return hrtimer_start(&ttimer->timer, time, mode);
634 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
636 hrtimer_cancel(&ttimer->timer);
637 tasklet_kill(&ttimer->tasklet);
641 * Autoprobing for irqs:
643 * probe_irq_on() and probe_irq_off() provide robust primitives
644 * for accurate IRQ probing during kernel initialization. They are
645 * reasonably simple to use, are not "fooled" by spurious interrupts,
646 * and, unlike other attempts at IRQ probing, they do not get hung on
647 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
649 * For reasonably foolproof probing, use them as follows:
651 * 1. clear and/or mask the device's internal interrupt.
653 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
654 * 4. enable the device and cause it to trigger an interrupt.
655 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
656 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
657 * 7. service the device to clear its pending interrupt.
658 * 8. loop again if paranoia is required.
660 * probe_irq_on() returns a mask of allocated irq's.
662 * probe_irq_off() takes the mask as a parameter,
663 * and returns the irq number which occurred,
664 * or zero if none occurred, or a negative irq number
665 * if more than one irq occurred.
668 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
669 static inline unsigned long probe_irq_on(void)
673 static inline int probe_irq_off(unsigned long val)
677 static inline unsigned int probe_irq_mask(unsigned long val)
682 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
683 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
684 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
687 #ifdef CONFIG_PROC_FS
688 /* Initialize /proc/irq/ */
689 extern void init_irq_proc(void);
691 static inline void init_irq_proc(void)
697 int show_interrupts(struct seq_file *p, void *v);
698 int arch_show_interrupts(struct seq_file *p, int prec);
700 extern int early_irq_init(void);
701 extern int arch_probe_nr_irqs(void);
702 extern int arch_early_irq_init(void);