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/sched.h>
14 #include <linux/irqflags.h>
15 #include <linux/smp.h>
16 #include <linux/percpu.h>
17 #include <linux/hrtimer.h>
19 #include <asm/atomic.h>
20 #include <asm/ptrace.h>
21 #include <asm/system.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 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
45 * IRQF_SHARED - allow sharing the irq among several devices
46 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
47 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
48 * IRQF_PERCPU - Interrupt is per cpu
49 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
50 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
51 * registered first in an shared interrupt is considered for
52 * performance reasons)
53 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
54 * Used by threaded interrupts which need to keep the
55 * irq line disabled until the threaded handler has been run.
57 #define IRQF_DISABLED 0x00000020
58 #define IRQF_SAMPLE_RANDOM 0x00000040
59 #define IRQF_SHARED 0x00000080
60 #define IRQF_PROBE_SHARED 0x00000100
61 #define IRQF_TIMER 0x00000200
62 #define IRQF_PERCPU 0x00000400
63 #define IRQF_NOBALANCING 0x00000800
64 #define IRQF_IRQPOLL 0x00001000
65 #define IRQF_ONESHOT 0x00002000
68 * Bits used by threaded handlers:
69 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
70 * IRQTF_DIED - handler thread died
71 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
72 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
81 typedef irqreturn_t (*irq_handler_t)(int, void *);
84 * struct irqaction - per interrupt action descriptor
85 * @handler: interrupt handler function
86 * @flags: flags (see IRQF_* above)
87 * @mask: no comment as it is useless and about to be removed
88 * @name: name of the device
89 * @dev_id: cookie to identify the device
90 * @next: pointer to the next irqaction for shared interrupts
91 * @irq: interrupt number
92 * @dir: pointer to the proc/irq/NN/name entry
93 * @thread_fn: interupt handler function for threaded interrupts
94 * @thread: thread pointer for threaded interrupts
95 * @thread_flags: flags related to @thread
98 irq_handler_t handler;
102 struct irqaction *next;
104 struct proc_dir_entry *dir;
105 irq_handler_t thread_fn;
106 struct task_struct *thread;
107 unsigned long thread_flags;
110 extern irqreturn_t no_action(int cpl, void *dev_id);
112 #ifdef CONFIG_GENERIC_HARDIRQS
113 extern int __must_check
114 request_threaded_irq(unsigned int irq, irq_handler_t handler,
115 irq_handler_t thread_fn,
116 unsigned long flags, const char *name, void *dev);
118 static inline int __must_check
119 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
120 const char *name, void *dev)
122 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
125 extern void exit_irq_thread(void);
128 extern int __must_check
129 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
130 const char *name, void *dev);
133 * Special function to avoid ifdeffery in kernel/irq/devres.c which
134 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
135 * m68k). I really love these $@%#!* obvious Makefile references:
136 * ../../../kernel/irq/devres.o
138 static inline int __must_check
139 request_threaded_irq(unsigned int irq, irq_handler_t handler,
140 irq_handler_t thread_fn,
141 unsigned long flags, const char *name, void *dev)
143 return request_irq(irq, handler, flags, name, dev);
146 static inline void exit_irq_thread(void) { }
149 extern void free_irq(unsigned int, void *);
153 extern int __must_check
154 devm_request_threaded_irq(struct device *dev, unsigned int irq,
155 irq_handler_t handler, irq_handler_t thread_fn,
156 unsigned long irqflags, const char *devname,
159 static inline int __must_check
160 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
161 unsigned long irqflags, const char *devname, void *dev_id)
163 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
167 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
170 * On lockdep we dont want to enable hardirqs in hardirq
171 * context. Use local_irq_enable_in_hardirq() to annotate
172 * kernel code that has to do this nevertheless (pretty much
173 * the only valid case is for old/broken hardware that is
176 * NOTE: in theory this might break fragile code that relies
177 * on hardirq delivery - in practice we dont seem to have such
178 * places left. So the only effect should be slightly increased
179 * irqs-off latencies.
181 #ifdef CONFIG_LOCKDEP
182 # define local_irq_enable_in_hardirq() do { } while (0)
184 # define local_irq_enable_in_hardirq() local_irq_enable()
187 extern void disable_irq_nosync(unsigned int irq);
188 extern void disable_irq(unsigned int irq);
189 extern void enable_irq(unsigned int irq);
191 /* The following three functions are for the core kernel use only. */
192 #ifdef CONFIG_GENERIC_HARDIRQS
193 extern void suspend_device_irqs(void);
194 extern void resume_device_irqs(void);
195 #ifdef CONFIG_PM_SLEEP
196 extern int check_wakeup_irqs(void);
198 static inline int check_wakeup_irqs(void) { return 0; }
201 static inline void suspend_device_irqs(void) { };
202 static inline void resume_device_irqs(void) { };
203 static inline int check_wakeup_irqs(void) { return 0; }
206 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
208 extern cpumask_var_t irq_default_affinity;
210 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
211 extern int irq_can_set_affinity(unsigned int irq);
212 extern int irq_select_affinity(unsigned int irq);
214 #else /* CONFIG_SMP */
216 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
221 static inline int irq_can_set_affinity(unsigned int irq)
226 static inline int irq_select_affinity(unsigned int irq) { return 0; }
228 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
230 #ifdef CONFIG_GENERIC_HARDIRQS
232 * Special lockdep variants of irq disabling/enabling.
233 * These should be used for locking constructs that
234 * know that a particular irq context which is disabled,
235 * and which is the only irq-context user of a lock,
236 * that it's safe to take the lock in the irq-disabled
237 * section without disabling hardirqs.
239 * On !CONFIG_LOCKDEP they are equivalent to the normal
240 * irq disable/enable methods.
242 static inline void disable_irq_nosync_lockdep(unsigned int irq)
244 disable_irq_nosync(irq);
245 #ifdef CONFIG_LOCKDEP
250 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
252 disable_irq_nosync(irq);
253 #ifdef CONFIG_LOCKDEP
254 local_irq_save(*flags);
258 static inline void disable_irq_lockdep(unsigned int irq)
261 #ifdef CONFIG_LOCKDEP
266 static inline void enable_irq_lockdep(unsigned int irq)
268 #ifdef CONFIG_LOCKDEP
274 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
276 #ifdef CONFIG_LOCKDEP
277 local_irq_restore(*flags);
282 /* IRQ wakeup (PM) control: */
283 extern int set_irq_wake(unsigned int irq, unsigned int on);
285 static inline int enable_irq_wake(unsigned int irq)
287 return set_irq_wake(irq, 1);
290 static inline int disable_irq_wake(unsigned int irq)
292 return set_irq_wake(irq, 0);
295 #else /* !CONFIG_GENERIC_HARDIRQS */
297 * NOTE: non-genirq architectures, if they want to support the lock
298 * validator need to define the methods below in their asm/irq.h
299 * files, under an #ifdef CONFIG_LOCKDEP section.
301 #ifndef CONFIG_LOCKDEP
302 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
303 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
304 disable_irq_nosync(irq)
305 # define disable_irq_lockdep(irq) disable_irq(irq)
306 # define enable_irq_lockdep(irq) enable_irq(irq)
307 # define enable_irq_lockdep_irqrestore(irq, flags) \
311 static inline int enable_irq_wake(unsigned int irq)
316 static inline int disable_irq_wake(unsigned int irq)
320 #endif /* CONFIG_GENERIC_HARDIRQS */
322 #ifndef __ARCH_SET_SOFTIRQ_PENDING
323 #define set_softirq_pending(x) (local_softirq_pending() = (x))
324 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
327 /* Some architectures might implement lazy enabling/disabling of
328 * interrupts. In some cases, such as stop_machine, we might want
329 * to ensure that after a local_irq_disable(), interrupts have
330 * really been disabled in hardware. Such architectures need to
331 * implement the following hook.
333 #ifndef hard_irq_disable
334 #define hard_irq_disable() do { } while(0)
337 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
338 frequency threaded job scheduling. For almost all the purposes
339 tasklets are more than enough. F.e. all serial device BHs et
340 al. should be converted to tasklets, not to softirqs.
350 BLOCK_IOPOLL_SOFTIRQ,
354 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
359 /* map softirq index to softirq name. update 'softirq_to_name' in
360 * kernel/softirq.c when adding a new softirq.
362 extern char *softirq_to_name[NR_SOFTIRQS];
364 /* softirq mask and active fields moved to irq_cpustat_t in
365 * asm/hardirq.h to get better cache usage. KAO
368 struct softirq_action
370 void (*action)(struct softirq_action *);
373 asmlinkage void do_softirq(void);
374 asmlinkage void __do_softirq(void);
375 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
376 extern void softirq_init(void);
377 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
378 extern void raise_softirq_irqoff(unsigned int nr);
379 extern void raise_softirq(unsigned int nr);
380 extern void wakeup_softirqd(void);
382 /* This is the worklist that queues up per-cpu softirq work.
384 * send_remote_sendirq() adds work to these lists, and
385 * the softirq handler itself dequeues from them. The queues
386 * are protected by disabling local cpu interrupts and they must
387 * only be accessed by the local cpu that they are for.
389 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
391 /* Try to send a softirq to a remote cpu. If this cannot be done, the
392 * work will be queued to the local cpu.
394 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
396 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
397 * and compute the current cpu, passed in as 'this_cpu'.
399 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
400 int this_cpu, int softirq);
402 /* Tasklets --- multithreaded analogue of BHs.
404 Main feature differing them of generic softirqs: tasklet
405 is running only on one CPU simultaneously.
407 Main feature differing them of BHs: different tasklets
408 may be run simultaneously on different CPUs.
411 * If tasklet_schedule() is called, then tasklet is guaranteed
412 to be executed on some cpu at least once after this.
413 * If the tasklet is already scheduled, but its excecution is still not
414 started, it will be executed only once.
415 * If this tasklet is already running on another CPU (or schedule is called
416 from tasklet itself), it is rescheduled for later.
417 * Tasklet is strictly serialized wrt itself, but not
418 wrt another tasklets. If client needs some intertask synchronization,
419 he makes it with spinlocks.
422 struct tasklet_struct
424 struct tasklet_struct *next;
427 void (*func)(unsigned long);
431 #define DECLARE_TASKLET(name, func, data) \
432 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
434 #define DECLARE_TASKLET_DISABLED(name, func, data) \
435 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
440 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
441 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
445 static inline int tasklet_trylock(struct tasklet_struct *t)
447 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
450 static inline void tasklet_unlock(struct tasklet_struct *t)
452 smp_mb__before_clear_bit();
453 clear_bit(TASKLET_STATE_RUN, &(t)->state);
456 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
458 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
461 #define tasklet_trylock(t) 1
462 #define tasklet_unlock_wait(t) do { } while (0)
463 #define tasklet_unlock(t) do { } while (0)
466 extern void __tasklet_schedule(struct tasklet_struct *t);
468 static inline void tasklet_schedule(struct tasklet_struct *t)
470 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
471 __tasklet_schedule(t);
474 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
476 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
478 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
479 __tasklet_hi_schedule(t);
482 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
485 * This version avoids touching any other tasklets. Needed for kmemcheck
486 * in order not to take any page faults while enqueueing this tasklet;
487 * consider VERY carefully whether you really need this or
488 * tasklet_hi_schedule()...
490 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
492 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
493 __tasklet_hi_schedule_first(t);
497 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
499 atomic_inc(&t->count);
500 smp_mb__after_atomic_inc();
503 static inline void tasklet_disable(struct tasklet_struct *t)
505 tasklet_disable_nosync(t);
506 tasklet_unlock_wait(t);
510 static inline void tasklet_enable(struct tasklet_struct *t)
512 smp_mb__before_atomic_dec();
513 atomic_dec(&t->count);
516 static inline void tasklet_hi_enable(struct tasklet_struct *t)
518 smp_mb__before_atomic_dec();
519 atomic_dec(&t->count);
522 extern void tasklet_kill(struct tasklet_struct *t);
523 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
524 extern void tasklet_init(struct tasklet_struct *t,
525 void (*func)(unsigned long), unsigned long data);
527 struct tasklet_hrtimer {
528 struct hrtimer timer;
529 struct tasklet_struct tasklet;
530 enum hrtimer_restart (*function)(struct hrtimer *);
534 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
535 enum hrtimer_restart (*function)(struct hrtimer *),
536 clockid_t which_clock, enum hrtimer_mode mode);
539 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
540 const enum hrtimer_mode mode)
542 return hrtimer_start(&ttimer->timer, time, mode);
546 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
548 hrtimer_cancel(&ttimer->timer);
549 tasklet_kill(&ttimer->tasklet);
553 * Autoprobing for irqs:
555 * probe_irq_on() and probe_irq_off() provide robust primitives
556 * for accurate IRQ probing during kernel initialization. They are
557 * reasonably simple to use, are not "fooled" by spurious interrupts,
558 * and, unlike other attempts at IRQ probing, they do not get hung on
559 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
561 * For reasonably foolproof probing, use them as follows:
563 * 1. clear and/or mask the device's internal interrupt.
565 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
566 * 4. enable the device and cause it to trigger an interrupt.
567 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
568 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
569 * 7. service the device to clear its pending interrupt.
570 * 8. loop again if paranoia is required.
572 * probe_irq_on() returns a mask of allocated irq's.
574 * probe_irq_off() takes the mask as a parameter,
575 * and returns the irq number which occurred,
576 * or zero if none occurred, or a negative irq number
577 * if more than one irq occurred.
580 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
581 static inline unsigned long probe_irq_on(void)
585 static inline int probe_irq_off(unsigned long val)
589 static inline unsigned int probe_irq_mask(unsigned long val)
594 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
595 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
596 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
599 #ifdef CONFIG_PROC_FS
600 /* Initialize /proc/irq/ */
601 extern void init_irq_proc(void);
603 static inline void init_irq_proc(void)
608 #if defined(CONFIG_GENERIC_HARDIRQS) && defined(CONFIG_DEBUG_SHIRQ)
609 extern void debug_poll_all_shared_irqs(void);
611 static inline void debug_poll_all_shared_irqs(void) { }
614 int show_interrupts(struct seq_file *p, void *v);
618 extern int early_irq_init(void);
619 extern int arch_probe_nr_irqs(void);
620 extern int arch_early_irq_init(void);
621 extern int arch_init_chip_data(struct irq_desc *desc, int node);