code style scripts/checkpatch.pl (linux-3.9-rc1) formatting
[linux-2.6.32.60-moxart.git] / include / linux / interrupt.h
blobc739150f06a4de8565c794b14eaaece21ff03125
1 /* interrupt.h */
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>
23 * These correspond to the IORESOURCE_IRQ_* defines in
24 * linux/ioport.h to select the interrupt line behaviour. When
25 * requesting an interrupt without specifying a IRQF_TRIGGER, the
26 * setting should be assumed to be "as already configured", which
27 * may be as per machine or firmware initialisation.
29 #define IRQF_TRIGGER_NONE 0x00000000
30 #define IRQF_TRIGGER_RISING 0x00000001
31 #define IRQF_TRIGGER_FALLING 0x00000002
32 #define IRQF_TRIGGER_HIGH 0x00000004
33 #define IRQF_TRIGGER_LOW 0x00000008
34 #define IRQF_TRIGGER_MASK (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
35 IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
36 #define IRQF_TRIGGER_PROBE 0x00000010
39 * These flags used only by the kernel as part of the
40 * irq handling routines.
42 * IRQF_DISABLED - keep irqs disabled when calling the action handler
43 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
44 * IRQF_SHARED - allow sharing the irq among several devices
45 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
46 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
47 * IRQF_PERCPU - Interrupt is per cpu
48 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
49 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
50 * registered first in an shared interrupt is considered for
51 * performance reasons)
52 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
53 * Used by threaded interrupts which need to keep the
54 * irq line disabled until the threaded handler has been run.
55 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
56 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
57 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
58 * resume time.
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
71 #define IRQF_EARLY_RESUME 0x00020000
73 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND)
76 * Bits used by threaded handlers:
77 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
78 * IRQTF_DIED - handler thread died
79 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
80 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
82 enum {
83 IRQTF_RUNTHREAD,
84 IRQTF_DIED,
85 IRQTF_WARNED,
86 IRQTF_AFFINITY,
89 typedef irqreturn_t (*irq_handler_t)(int, void *);
91 /**
92 * struct irqaction - per interrupt action descriptor
93 * @handler: interrupt handler function
94 * @flags: flags (see IRQF_* above)
95 * @name: name of the device
96 * @dev_id: cookie to identify the device
97 * @next: pointer to the next irqaction for shared interrupts
98 * @irq: interrupt number
99 * @dir: pointer to the proc/irq/NN/name entry
100 * @thread_fn: interupt handler function for threaded interrupts
101 * @thread: thread pointer for threaded interrupts
102 * @thread_flags: flags related to @thread
104 struct irqaction {
105 irq_handler_t handler;
106 unsigned long flags;
107 const char *name;
108 void *dev_id;
109 struct irqaction *next;
110 int irq;
111 struct proc_dir_entry *dir;
112 irq_handler_t thread_fn;
113 struct task_struct *thread;
114 unsigned long thread_flags;
117 extern irqreturn_t no_action(int cpl, void *dev_id);
119 #ifdef CONFIG_GENERIC_HARDIRQS
120 extern int __must_check
121 request_threaded_irq(unsigned int irq, irq_handler_t handler,
122 irq_handler_t thread_fn,
123 unsigned long flags, const char *name, void *dev);
125 static inline int __must_check
126 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
127 const char *name, void *dev)
129 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
132 extern void exit_irq_thread(void);
133 #else
135 extern int __must_check
136 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
137 const char *name, void *dev);
140 * Special function to avoid ifdeffery in kernel/irq/devres.c which
141 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
142 * m68k). I really love these $@%#!* obvious Makefile references:
143 * ../../../kernel/irq/devres.o
145 static inline int __must_check
146 request_threaded_irq(unsigned int irq, irq_handler_t handler,
147 irq_handler_t thread_fn,
148 unsigned long flags, const char *name, void *dev)
150 return request_irq(irq, handler, flags, name, dev);
153 static inline void exit_irq_thread(void) { }
154 #endif
156 extern void free_irq(unsigned int, void *);
158 struct device;
160 extern int __must_check
161 devm_request_threaded_irq(struct device *dev, unsigned int irq,
162 irq_handler_t handler, irq_handler_t thread_fn,
163 unsigned long irqflags, const char *devname,
164 void *dev_id);
166 static inline int __must_check
167 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
168 unsigned long irqflags, const char *devname, void *dev_id)
170 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
171 devname, dev_id);
174 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
177 * On lockdep we dont want to enable hardirqs in hardirq
178 * context. Use local_irq_enable_in_hardirq() to annotate
179 * kernel code that has to do this nevertheless (pretty much
180 * the only valid case is for old/broken hardware that is
181 * insanely slow).
183 * NOTE: in theory this might break fragile code that relies
184 * on hardirq delivery - in practice we dont seem to have such
185 * places left. So the only effect should be slightly increased
186 * irqs-off latencies.
188 #ifdef CONFIG_LOCKDEP
189 # define local_irq_enable_in_hardirq() do { } while (0)
190 #else
191 # define local_irq_enable_in_hardirq() local_irq_enable()
192 #endif
194 extern void disable_irq_nosync(unsigned int irq);
195 extern void disable_irq(unsigned int irq);
196 extern void enable_irq(unsigned int irq);
198 /* The following three functions are for the core kernel use only. */
199 #ifdef CONFIG_GENERIC_HARDIRQS
200 extern void suspend_device_irqs(void);
201 extern void resume_device_irqs(void);
202 #ifdef CONFIG_PM_SLEEP
203 extern int check_wakeup_irqs(void);
204 extern void irq_pm_syscore_resume(void);
205 #else
206 static inline int check_wakeup_irqs(void) { return 0; }
207 static inline void irq_pm_syscore_resume(void) { };
208 #endif
209 #else
210 static inline void suspend_device_irqs(void) { };
211 static inline void resume_device_irqs(void) { };
212 static inline int check_wakeup_irqs(void) { return 0; }
213 static inline void irq_pm_syscore_resume(void) { };
214 #endif
216 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
218 extern cpumask_var_t irq_default_affinity;
220 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
221 extern int irq_can_set_affinity(unsigned int irq);
222 extern int irq_select_affinity(unsigned int irq);
224 #else /* CONFIG_SMP */
226 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
228 return -EINVAL;
231 static inline int irq_can_set_affinity(unsigned int irq)
233 return 0;
236 static inline int irq_select_affinity(unsigned int irq) { return 0; }
238 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
240 #ifdef CONFIG_GENERIC_HARDIRQS
242 * Special lockdep variants of irq disabling/enabling.
243 * These should be used for locking constructs that
244 * know that a particular irq context which is disabled,
245 * and which is the only irq-context user of a lock,
246 * that it's safe to take the lock in the irq-disabled
247 * section without disabling hardirqs.
249 * On !CONFIG_LOCKDEP they are equivalent to the normal
250 * irq disable/enable methods.
252 static inline void disable_irq_nosync_lockdep(unsigned int irq)
254 disable_irq_nosync(irq);
255 #ifdef CONFIG_LOCKDEP
256 local_irq_disable();
257 #endif
260 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
262 disable_irq_nosync(irq);
263 #ifdef CONFIG_LOCKDEP
264 local_irq_save(*flags);
265 #endif
268 static inline void disable_irq_lockdep(unsigned int irq)
270 disable_irq(irq);
271 #ifdef CONFIG_LOCKDEP
272 local_irq_disable();
273 #endif
276 static inline void enable_irq_lockdep(unsigned int irq)
278 #ifdef CONFIG_LOCKDEP
279 local_irq_enable();
280 #endif
281 enable_irq(irq);
284 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
286 #ifdef CONFIG_LOCKDEP
287 local_irq_restore(*flags);
288 #endif
289 enable_irq(irq);
292 /* IRQ wakeup (PM) control: */
293 extern int set_irq_wake(unsigned int irq, unsigned int on);
295 static inline int enable_irq_wake(unsigned int irq)
297 return set_irq_wake(irq, 1);
300 static inline int disable_irq_wake(unsigned int irq)
302 return set_irq_wake(irq, 0);
305 #else /* !CONFIG_GENERIC_HARDIRQS */
307 * NOTE: non-genirq architectures, if they want to support the lock
308 * validator need to define the methods below in their asm/irq.h
309 * files, under an #ifdef CONFIG_LOCKDEP section.
311 #ifndef CONFIG_LOCKDEP
312 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
313 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
314 disable_irq_nosync(irq)
315 # define disable_irq_lockdep(irq) disable_irq(irq)
316 # define enable_irq_lockdep(irq) enable_irq(irq)
317 # define enable_irq_lockdep_irqrestore(irq, flags) \
318 enable_irq(irq)
319 # endif
321 static inline int enable_irq_wake(unsigned int irq)
323 return 0;
326 static inline int disable_irq_wake(unsigned int irq)
328 return 0;
330 #endif /* CONFIG_GENERIC_HARDIRQS */
332 #ifndef __ARCH_SET_SOFTIRQ_PENDING
333 #define set_softirq_pending(x) (local_softirq_pending() = (x))
334 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
335 #endif
337 /* Some architectures might implement lazy enabling/disabling of
338 * interrupts. In some cases, such as stop_machine, we might want
339 * to ensure that after a local_irq_disable(), interrupts have
340 * really been disabled in hardware. Such architectures need to
341 * implement the following hook.
343 #ifndef hard_irq_disable
344 #define hard_irq_disable() do { } while(0)
345 #endif
347 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
348 frequency threaded job scheduling. For almost all the purposes
349 tasklets are more than enough. F.e. all serial device BHs et
350 al. should be converted to tasklets, not to softirqs.
353 enum
355 HI_SOFTIRQ=0,
356 TIMER_SOFTIRQ,
357 NET_TX_SOFTIRQ,
358 NET_RX_SOFTIRQ,
359 BLOCK_SOFTIRQ,
360 BLOCK_IOPOLL_SOFTIRQ,
361 TASKLET_SOFTIRQ,
362 SCHED_SOFTIRQ,
363 HRTIMER_SOFTIRQ,
364 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
366 NR_SOFTIRQS
369 /* map softirq index to softirq name. update 'softirq_to_name' in
370 * kernel/softirq.c when adding a new softirq.
372 extern char *softirq_to_name[NR_SOFTIRQS];
374 /* softirq mask and active fields moved to irq_cpustat_t in
375 * asm/hardirq.h to get better cache usage. KAO
378 struct softirq_action
380 void (*action)(struct softirq_action *);
383 asmlinkage void do_softirq(void);
384 asmlinkage void __do_softirq(void);
385 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
386 extern void softirq_init(void);
387 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
388 extern void raise_softirq_irqoff(unsigned int nr);
389 extern void raise_softirq(unsigned int nr);
390 extern void wakeup_softirqd(void);
392 /* This is the worklist that queues up per-cpu softirq work.
394 * send_remote_sendirq() adds work to these lists, and
395 * the softirq handler itself dequeues from them. The queues
396 * are protected by disabling local cpu interrupts and they must
397 * only be accessed by the local cpu that they are for.
399 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
401 /* Try to send a softirq to a remote cpu. If this cannot be done, the
402 * work will be queued to the local cpu.
404 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
406 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
407 * and compute the current cpu, passed in as 'this_cpu'.
409 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
410 int this_cpu, int softirq);
412 /* Tasklets --- multithreaded analogue of BHs.
414 Main feature differing them of generic softirqs: tasklet
415 is running only on one CPU simultaneously.
417 Main feature differing them of BHs: different tasklets
418 may be run simultaneously on different CPUs.
420 Properties:
421 * If tasklet_schedule() is called, then tasklet is guaranteed
422 to be executed on some cpu at least once after this.
423 * If the tasklet is already scheduled, but its excecution is still not
424 started, it will be executed only once.
425 * If this tasklet is already running on another CPU (or schedule is called
426 from tasklet itself), it is rescheduled for later.
427 * Tasklet is strictly serialized wrt itself, but not
428 wrt another tasklets. If client needs some intertask synchronization,
429 he makes it with spinlocks.
432 struct tasklet_struct
434 struct tasklet_struct *next;
435 unsigned long state;
436 atomic_t count;
437 void (*func)(unsigned long);
438 unsigned long data;
441 #define DECLARE_TASKLET(name, func, data) \
442 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
444 #define DECLARE_TASKLET_DISABLED(name, func, data) \
445 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
448 enum
450 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
451 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
454 #ifdef CONFIG_SMP
455 static inline int tasklet_trylock(struct tasklet_struct *t)
457 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
460 static inline void tasklet_unlock(struct tasklet_struct *t)
462 smp_mb__before_clear_bit();
463 clear_bit(TASKLET_STATE_RUN, &(t)->state);
466 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
468 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
470 #else
471 #define tasklet_trylock(t) 1
472 #define tasklet_unlock_wait(t) do { } while (0)
473 #define tasklet_unlock(t) do { } while (0)
474 #endif
476 extern void __tasklet_schedule(struct tasklet_struct *t);
478 static inline void tasklet_schedule(struct tasklet_struct *t)
480 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
481 __tasklet_schedule(t);
484 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
486 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
488 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
489 __tasklet_hi_schedule(t);
492 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
495 * This version avoids touching any other tasklets. Needed for kmemcheck
496 * in order not to take any page faults while enqueueing this tasklet;
497 * consider VERY carefully whether you really need this or
498 * tasklet_hi_schedule()...
500 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
502 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
503 __tasklet_hi_schedule_first(t);
507 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
509 atomic_inc(&t->count);
510 smp_mb__after_atomic_inc();
513 static inline void tasklet_disable(struct tasklet_struct *t)
515 tasklet_disable_nosync(t);
516 tasklet_unlock_wait(t);
517 smp_mb();
520 static inline void tasklet_enable(struct tasklet_struct *t)
522 smp_mb__before_atomic_dec();
523 atomic_dec(&t->count);
526 static inline void tasklet_hi_enable(struct tasklet_struct *t)
528 smp_mb__before_atomic_dec();
529 atomic_dec(&t->count);
532 extern void tasklet_kill(struct tasklet_struct *t);
533 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
534 extern void tasklet_init(struct tasklet_struct *t,
535 void (*func)(unsigned long), unsigned long data);
537 struct tasklet_hrtimer {
538 struct hrtimer timer;
539 struct tasklet_struct tasklet;
540 enum hrtimer_restart (*function)(struct hrtimer *);
543 extern void
544 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
545 enum hrtimer_restart (*function)(struct hrtimer *),
546 clockid_t which_clock, enum hrtimer_mode mode);
548 static inline
549 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
550 const enum hrtimer_mode mode)
552 return hrtimer_start(&ttimer->timer, time, mode);
555 static inline
556 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
558 hrtimer_cancel(&ttimer->timer);
559 tasklet_kill(&ttimer->tasklet);
563 * Autoprobing for irqs:
565 * probe_irq_on() and probe_irq_off() provide robust primitives
566 * for accurate IRQ probing during kernel initialization. They are
567 * reasonably simple to use, are not "fooled" by spurious interrupts,
568 * and, unlike other attempts at IRQ probing, they do not get hung on
569 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
571 * For reasonably foolproof probing, use them as follows:
573 * 1. clear and/or mask the device's internal interrupt.
574 * 2. sti();
575 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
576 * 4. enable the device and cause it to trigger an interrupt.
577 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
578 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
579 * 7. service the device to clear its pending interrupt.
580 * 8. loop again if paranoia is required.
582 * probe_irq_on() returns a mask of allocated irq's.
584 * probe_irq_off() takes the mask as a parameter,
585 * and returns the irq number which occurred,
586 * or zero if none occurred, or a negative irq number
587 * if more than one irq occurred.
590 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
591 static inline unsigned long probe_irq_on(void)
593 return 0;
595 static inline int probe_irq_off(unsigned long val)
597 return 0;
599 static inline unsigned int probe_irq_mask(unsigned long val)
601 return 0;
603 #else
604 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
605 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
606 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
607 #endif
609 #ifdef CONFIG_PROC_FS
610 /* Initialize /proc/irq/ */
611 extern void init_irq_proc(void);
612 #else
613 static inline void init_irq_proc(void)
616 #endif
618 #if defined(CONFIG_GENERIC_HARDIRQS) && defined(CONFIG_DEBUG_SHIRQ)
619 extern void debug_poll_all_shared_irqs(void);
620 #else
621 static inline void debug_poll_all_shared_irqs(void) { }
622 #endif
624 struct seq_file;
625 int show_interrupts(struct seq_file *p, void *v);
627 struct irq_desc;
629 extern int early_irq_init(void);
630 extern int arch_probe_nr_irqs(void);
631 extern int arch_early_irq_init(void);
632 extern int arch_init_chip_data(struct irq_desc *desc, int node);
634 #endif