cf682a73a6f97c67baf4bfa1346df00caa605f38
[linux-2.6.git] / include / linux / interrupt.h
1 /* interrupt.h */
2 #ifndef _LINUX_INTERRUPT_H
3 #define _LINUX_INTERRUPT_H
4
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/hardirq.h>
12 #include <linux/sched.h>
13 #include <asm/atomic.h>
14 #include <asm/ptrace.h>
15 #include <asm/system.h>
16
17 /*
18  * These correspond to the IORESOURCE_IRQ_* defines in
19  * linux/ioport.h to select the interrupt line behaviour.  When
20  * requesting an interrupt without specifying a IRQF_TRIGGER, the
21  * setting should be assumed to be "as already configured", which
22  * may be as per machine or firmware initialisation.
23  */
24 #define IRQF_TRIGGER_NONE       0x00000000
25 #define IRQF_TRIGGER_RISING     0x00000001
26 #define IRQF_TRIGGER_FALLING    0x00000002
27 #define IRQF_TRIGGER_HIGH       0x00000004
28 #define IRQF_TRIGGER_LOW        0x00000008
29 #define IRQF_TRIGGER_MASK       (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
30                                  IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
31 #define IRQF_TRIGGER_PROBE      0x00000010
32
33 /*
34  * These flags used only by the kernel as part of the
35  * irq handling routines.
36  *
37  * IRQF_DISABLED - keep irqs disabled when calling the action handler
38  * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
39  * IRQF_SHARED - allow sharing the irq among several devices
40  * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
41  * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
42  */
43 #define IRQF_DISABLED           0x00000020
44 #define IRQF_SAMPLE_RANDOM      0x00000040
45 #define IRQF_SHARED             0x00000080
46 #define IRQF_PROBE_SHARED       0x00000100
47 #define IRQF_TIMER              0x00000200
48
49 /*
50  * Migration helpers. Scheduled for removal in 1/2007
51  * Do not use for new code !
52  */
53 #define SA_INTERRUPT            IRQF_DISABLED
54 #define SA_SAMPLE_RANDOM        IRQF_SAMPLE_RANDOM
55 #define SA_SHIRQ                IRQF_SHARED
56 #define SA_PROBEIRQ             IRQF_PROBE_SHARED
57
58 #define SA_TRIGGER_LOW          IRQF_TRIGGER_LOW
59 #define SA_TRIGGER_HIGH         IRQF_TRIGGER_HIGH
60 #define SA_TRIGGER_FALLING      IRQF_TRIGGER_FALLING
61 #define SA_TRIGGER_RISING       IRQF_TRIGGER_RISING
62 #define SA_TRIGGER_MASK         IRQF_TRIGGER_MASK
63
64 struct irqaction {
65         irqreturn_t (*handler)(int, void *, struct pt_regs *);
66         unsigned long flags;
67         cpumask_t mask;
68         const char *name;
69         void *dev_id;
70         struct irqaction *next;
71         int irq;
72         struct proc_dir_entry *dir;
73 };
74
75 extern irqreturn_t no_action(int cpl, void *dev_id, struct pt_regs *regs);
76 extern int request_irq(unsigned int,
77                        irqreturn_t (*handler)(int, void *, struct pt_regs *),
78                        unsigned long, const char *, void *);
79 extern void free_irq(unsigned int, void *);
80
81
82 #ifdef CONFIG_GENERIC_HARDIRQS
83 extern void disable_irq_nosync(unsigned int irq);
84 extern void disable_irq(unsigned int irq);
85 extern void enable_irq(unsigned int irq);
86
87 /* IRQ wakeup (PM) control: */
88 extern int set_irq_wake(unsigned int irq, unsigned int on);
89
90 static inline int enable_irq_wake(unsigned int irq)
91 {
92         return set_irq_wake(irq, 1);
93 }
94
95 static inline int disable_irq_wake(unsigned int irq)
96 {
97         return set_irq_wake(irq, 0);
98 }
99
100 #endif
101
102 #ifndef __ARCH_SET_SOFTIRQ_PENDING
103 #define set_softirq_pending(x) (local_softirq_pending() = (x))
104 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
105 #endif
106
107 /*
108  * Temporary defines for UP kernels, until all code gets fixed.
109  */
110 #ifndef CONFIG_SMP
111 static inline void __deprecated cli(void)
112 {
113         local_irq_disable();
114 }
115 static inline void __deprecated sti(void)
116 {
117         local_irq_enable();
118 }
119 static inline void __deprecated save_flags(unsigned long *x)
120 {
121         local_save_flags(*x);
122 }
123 #define save_flags(x) save_flags(&x)
124 static inline void __deprecated restore_flags(unsigned long x)
125 {
126         local_irq_restore(x);
127 }
128
129 static inline void __deprecated save_and_cli(unsigned long *x)
130 {
131         local_irq_save(*x);
132 }
133 #define save_and_cli(x) save_and_cli(&x)
134 #endif /* CONFIG_SMP */
135
136 /* SoftIRQ primitives.  */
137 #define local_bh_disable() \
138                 do { add_preempt_count(SOFTIRQ_OFFSET); barrier(); } while (0)
139 #define __local_bh_enable() \
140                 do { barrier(); sub_preempt_count(SOFTIRQ_OFFSET); } while (0)
141
142 extern void local_bh_enable(void);
143
144 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
145    frequency threaded job scheduling. For almost all the purposes
146    tasklets are more than enough. F.e. all serial device BHs et
147    al. should be converted to tasklets, not to softirqs.
148  */
149
150 enum
151 {
152         HI_SOFTIRQ=0,
153         TIMER_SOFTIRQ,
154         NET_TX_SOFTIRQ,
155         NET_RX_SOFTIRQ,
156         BLOCK_SOFTIRQ,
157         TASKLET_SOFTIRQ
158 };
159
160 /* softirq mask and active fields moved to irq_cpustat_t in
161  * asm/hardirq.h to get better cache usage.  KAO
162  */
163
164 struct softirq_action
165 {
166         void    (*action)(struct softirq_action *);
167         void    *data;
168 };
169
170 asmlinkage void do_softirq(void);
171 extern void open_softirq(int nr, void (*action)(struct softirq_action*), void *data);
172 extern void softirq_init(void);
173 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
174 extern void FASTCALL(raise_softirq_irqoff(unsigned int nr));
175 extern void FASTCALL(raise_softirq(unsigned int nr));
176
177
178 /* Tasklets --- multithreaded analogue of BHs.
179
180    Main feature differing them of generic softirqs: tasklet
181    is running only on one CPU simultaneously.
182
183    Main feature differing them of BHs: different tasklets
184    may be run simultaneously on different CPUs.
185
186    Properties:
187    * If tasklet_schedule() is called, then tasklet is guaranteed
188      to be executed on some cpu at least once after this.
189    * If the tasklet is already scheduled, but its excecution is still not
190      started, it will be executed only once.
191    * If this tasklet is already running on another CPU (or schedule is called
192      from tasklet itself), it is rescheduled for later.
193    * Tasklet is strictly serialized wrt itself, but not
194      wrt another tasklets. If client needs some intertask synchronization,
195      he makes it with spinlocks.
196  */
197
198 struct tasklet_struct
199 {
200         struct tasklet_struct *next;
201         unsigned long state;
202         atomic_t count;
203         void (*func)(unsigned long);
204         unsigned long data;
205 };
206
207 #define DECLARE_TASKLET(name, func, data) \
208 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
209
210 #define DECLARE_TASKLET_DISABLED(name, func, data) \
211 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
212
213
214 enum
215 {
216         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
217         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
218 };
219
220 #ifdef CONFIG_SMP
221 static inline int tasklet_trylock(struct tasklet_struct *t)
222 {
223         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
224 }
225
226 static inline void tasklet_unlock(struct tasklet_struct *t)
227 {
228         smp_mb__before_clear_bit(); 
229         clear_bit(TASKLET_STATE_RUN, &(t)->state);
230 }
231
232 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
233 {
234         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
235 }
236 #else
237 #define tasklet_trylock(t) 1
238 #define tasklet_unlock_wait(t) do { } while (0)
239 #define tasklet_unlock(t) do { } while (0)
240 #endif
241
242 extern void FASTCALL(__tasklet_schedule(struct tasklet_struct *t));
243
244 static inline void tasklet_schedule(struct tasklet_struct *t)
245 {
246         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
247                 __tasklet_schedule(t);
248 }
249
250 extern void FASTCALL(__tasklet_hi_schedule(struct tasklet_struct *t));
251
252 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
253 {
254         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
255                 __tasklet_hi_schedule(t);
256 }
257
258
259 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
260 {
261         atomic_inc(&t->count);
262         smp_mb__after_atomic_inc();
263 }
264
265 static inline void tasklet_disable(struct tasklet_struct *t)
266 {
267         tasklet_disable_nosync(t);
268         tasklet_unlock_wait(t);
269         smp_mb();
270 }
271
272 static inline void tasklet_enable(struct tasklet_struct *t)
273 {
274         smp_mb__before_atomic_dec();
275         atomic_dec(&t->count);
276 }
277
278 static inline void tasklet_hi_enable(struct tasklet_struct *t)
279 {
280         smp_mb__before_atomic_dec();
281         atomic_dec(&t->count);
282 }
283
284 extern void tasklet_kill(struct tasklet_struct *t);
285 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
286 extern void tasklet_init(struct tasklet_struct *t,
287                          void (*func)(unsigned long), unsigned long data);
288
289 /*
290  * Autoprobing for irqs:
291  *
292  * probe_irq_on() and probe_irq_off() provide robust primitives
293  * for accurate IRQ probing during kernel initialization.  They are
294  * reasonably simple to use, are not "fooled" by spurious interrupts,
295  * and, unlike other attempts at IRQ probing, they do not get hung on
296  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
297  *
298  * For reasonably foolproof probing, use them as follows:
299  *
300  * 1. clear and/or mask the device's internal interrupt.
301  * 2. sti();
302  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
303  * 4. enable the device and cause it to trigger an interrupt.
304  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
305  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
306  * 7. service the device to clear its pending interrupt.
307  * 8. loop again if paranoia is required.
308  *
309  * probe_irq_on() returns a mask of allocated irq's.
310  *
311  * probe_irq_off() takes the mask as a parameter,
312  * and returns the irq number which occurred,
313  * or zero if none occurred, or a negative irq number
314  * if more than one irq occurred.
315  */
316
317 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE) 
318 static inline unsigned long probe_irq_on(void)
319 {
320         return 0;
321 }
322 static inline int probe_irq_off(unsigned long val)
323 {
324         return 0;
325 }
326 static inline unsigned int probe_irq_mask(unsigned long val)
327 {
328         return 0;
329 }
330 #else
331 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
332 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
333 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
334 #endif
335
336 #endif