genirq: fix devres.o build for GENERIC_HARDIRQS=n
[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/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
18 #include <asm/atomic.h>
19 #include <asm/ptrace.h>
20 #include <asm/system.h>
21
22 /*
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.
28  */
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
37
38 /*
39  * These flags used only by the kernel as part of the
40  * irq handling routines.
41  *
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  */
53 #define IRQF_DISABLED           0x00000020
54 #define IRQF_SAMPLE_RANDOM      0x00000040
55 #define IRQF_SHARED             0x00000080
56 #define IRQF_PROBE_SHARED       0x00000100
57 #define IRQF_TIMER              0x00000200
58 #define IRQF_PERCPU             0x00000400
59 #define IRQF_NOBALANCING        0x00000800
60 #define IRQF_IRQPOLL            0x00001000
61
62 /*
63  * Bits used by threaded handlers:
64  * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
65  * IRQTF_DIED      - handler thread died
66  * IRQTF_WARNED    - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
67  */
68 enum {
69         IRQTF_RUNTHREAD,
70         IRQTF_DIED,
71         IRQTF_WARNED,
72 };
73
74 typedef irqreturn_t (*irq_handler_t)(int, void *);
75
76 /**
77  * struct irqaction - per interrupt action descriptor
78  * @handler:    interrupt handler function
79  * @flags:      flags (see IRQF_* above)
80  * @mask:       no comment as it is useless and about to be removed
81  * @name:       name of the device
82  * @dev_id:     cookie to identify the device
83  * @next:       pointer to the next irqaction for shared interrupts
84  * @irq:        interrupt number
85  * @dir:        pointer to the proc/irq/NN/name entry
86  * @thread_fn:  interupt handler function for threaded interrupts
87  * @thread:     thread pointer for threaded interrupts
88  * @thread_flags:       flags related to @thread
89  */
90 struct irqaction {
91         irq_handler_t handler;
92         unsigned long flags;
93         cpumask_t mask;
94         const char *name;
95         void *dev_id;
96         struct irqaction *next;
97         int irq;
98         struct proc_dir_entry *dir;
99         irq_handler_t thread_fn;
100         struct task_struct *thread;
101         unsigned long thread_flags;
102 };
103
104 extern irqreturn_t no_action(int cpl, void *dev_id);
105
106 #ifdef CONFIG_GENERIC_HARDIRQS
107 extern int __must_check
108 request_threaded_irq(unsigned int irq, irq_handler_t handler,
109                      irq_handler_t thread_fn,
110                      unsigned long flags, const char *name, void *dev);
111
112 static inline int __must_check
113 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
114             const char *name, void *dev)
115 {
116         return request_threaded_irq(irq, handler, NULL, flags, name, dev);
117 }
118
119 extern void exit_irq_thread(void);
120 #else
121
122 extern int __must_check
123 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
124             const char *name, void *dev);
125
126 /*
127  * Special function to avoid ifdeffery in kernel/irq/devres.c which
128  * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
129  * m68k). I really love these $@%#!* obvious Makefile references:
130  * ../../../kernel/irq/devres.o
131  */
132 static inline int __must_check
133 request_threaded_irq(unsigned int irq, irq_handler_t handler,
134                      irq_handler_t thread_fn,
135                      unsigned long flags, const char *name, void *dev)
136 {
137         return request_irq(irq, handler, flags, name, dev);
138 }
139
140 static inline void exit_irq_thread(void) { }
141 #endif
142
143 extern void free_irq(unsigned int, void *);
144
145 struct device;
146
147 extern int __must_check
148 devm_request_threaded_irq(struct device *dev, unsigned int irq,
149                           irq_handler_t handler, irq_handler_t thread_fn,
150                           unsigned long irqflags, const char *devname,
151                           void *dev_id);
152
153 static inline int __must_check
154 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
155                  unsigned long irqflags, const char *devname, void *dev_id)
156 {
157         return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
158                                          devname, dev_id);
159 }
160
161 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
162
163 /*
164  * On lockdep we dont want to enable hardirqs in hardirq
165  * context. Use local_irq_enable_in_hardirq() to annotate
166  * kernel code that has to do this nevertheless (pretty much
167  * the only valid case is for old/broken hardware that is
168  * insanely slow).
169  *
170  * NOTE: in theory this might break fragile code that relies
171  * on hardirq delivery - in practice we dont seem to have such
172  * places left. So the only effect should be slightly increased
173  * irqs-off latencies.
174  */
175 #ifdef CONFIG_LOCKDEP
176 # define local_irq_enable_in_hardirq()  do { } while (0)
177 #else
178 # define local_irq_enable_in_hardirq()  local_irq_enable()
179 #endif
180
181 extern void disable_irq_nosync(unsigned int irq);
182 extern void disable_irq(unsigned int irq);
183 extern void enable_irq(unsigned int irq);
184
185 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
186
187 extern cpumask_var_t irq_default_affinity;
188
189 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
190 extern int irq_can_set_affinity(unsigned int irq);
191 extern int irq_select_affinity(unsigned int irq);
192
193 #else /* CONFIG_SMP */
194
195 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
196 {
197         return -EINVAL;
198 }
199
200 static inline int irq_can_set_affinity(unsigned int irq)
201 {
202         return 0;
203 }
204
205 static inline int irq_select_affinity(unsigned int irq)  { return 0; }
206
207 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
208
209 #ifdef CONFIG_GENERIC_HARDIRQS
210 /*
211  * Special lockdep variants of irq disabling/enabling.
212  * These should be used for locking constructs that
213  * know that a particular irq context which is disabled,
214  * and which is the only irq-context user of a lock,
215  * that it's safe to take the lock in the irq-disabled
216  * section without disabling hardirqs.
217  *
218  * On !CONFIG_LOCKDEP they are equivalent to the normal
219  * irq disable/enable methods.
220  */
221 static inline void disable_irq_nosync_lockdep(unsigned int irq)
222 {
223         disable_irq_nosync(irq);
224 #ifdef CONFIG_LOCKDEP
225         local_irq_disable();
226 #endif
227 }
228
229 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
230 {
231         disable_irq_nosync(irq);
232 #ifdef CONFIG_LOCKDEP
233         local_irq_save(*flags);
234 #endif
235 }
236
237 static inline void disable_irq_lockdep(unsigned int irq)
238 {
239         disable_irq(irq);
240 #ifdef CONFIG_LOCKDEP
241         local_irq_disable();
242 #endif
243 }
244
245 static inline void enable_irq_lockdep(unsigned int irq)
246 {
247 #ifdef CONFIG_LOCKDEP
248         local_irq_enable();
249 #endif
250         enable_irq(irq);
251 }
252
253 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
254 {
255 #ifdef CONFIG_LOCKDEP
256         local_irq_restore(*flags);
257 #endif
258         enable_irq(irq);
259 }
260
261 /* IRQ wakeup (PM) control: */
262 extern int set_irq_wake(unsigned int irq, unsigned int on);
263
264 static inline int enable_irq_wake(unsigned int irq)
265 {
266         return set_irq_wake(irq, 1);
267 }
268
269 static inline int disable_irq_wake(unsigned int irq)
270 {
271         return set_irq_wake(irq, 0);
272 }
273
274 #else /* !CONFIG_GENERIC_HARDIRQS */
275 /*
276  * NOTE: non-genirq architectures, if they want to support the lock
277  * validator need to define the methods below in their asm/irq.h
278  * files, under an #ifdef CONFIG_LOCKDEP section.
279  */
280 #ifndef CONFIG_LOCKDEP
281 #  define disable_irq_nosync_lockdep(irq)       disable_irq_nosync(irq)
282 #  define disable_irq_nosync_lockdep_irqsave(irq, flags) \
283                                                 disable_irq_nosync(irq)
284 #  define disable_irq_lockdep(irq)              disable_irq(irq)
285 #  define enable_irq_lockdep(irq)               enable_irq(irq)
286 #  define enable_irq_lockdep_irqrestore(irq, flags) \
287                                                 enable_irq(irq)
288 # endif
289
290 static inline int enable_irq_wake(unsigned int irq)
291 {
292         return 0;
293 }
294
295 static inline int disable_irq_wake(unsigned int irq)
296 {
297         return 0;
298 }
299 #endif /* CONFIG_GENERIC_HARDIRQS */
300
301 #ifndef __ARCH_SET_SOFTIRQ_PENDING
302 #define set_softirq_pending(x) (local_softirq_pending() = (x))
303 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
304 #endif
305
306 /* Some architectures might implement lazy enabling/disabling of
307  * interrupts. In some cases, such as stop_machine, we might want
308  * to ensure that after a local_irq_disable(), interrupts have
309  * really been disabled in hardware. Such architectures need to
310  * implement the following hook.
311  */
312 #ifndef hard_irq_disable
313 #define hard_irq_disable()      do { } while(0)
314 #endif
315
316 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
317    frequency threaded job scheduling. For almost all the purposes
318    tasklets are more than enough. F.e. all serial device BHs et
319    al. should be converted to tasklets, not to softirqs.
320  */
321
322 enum
323 {
324         HI_SOFTIRQ=0,
325         TIMER_SOFTIRQ,
326         NET_TX_SOFTIRQ,
327         NET_RX_SOFTIRQ,
328         BLOCK_SOFTIRQ,
329         TASKLET_SOFTIRQ,
330         SCHED_SOFTIRQ,
331         HRTIMER_SOFTIRQ,
332         RCU_SOFTIRQ,    /* Preferable RCU should always be the last softirq */
333
334         NR_SOFTIRQS
335 };
336
337 /* softirq mask and active fields moved to irq_cpustat_t in
338  * asm/hardirq.h to get better cache usage.  KAO
339  */
340
341 struct softirq_action
342 {
343         void    (*action)(struct softirq_action *);
344 };
345
346 asmlinkage void do_softirq(void);
347 asmlinkage void __do_softirq(void);
348 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
349 extern void softirq_init(void);
350 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
351 extern void raise_softirq_irqoff(unsigned int nr);
352 extern void raise_softirq(unsigned int nr);
353
354 /* This is the worklist that queues up per-cpu softirq work.
355  *
356  * send_remote_sendirq() adds work to these lists, and
357  * the softirq handler itself dequeues from them.  The queues
358  * are protected by disabling local cpu interrupts and they must
359  * only be accessed by the local cpu that they are for.
360  */
361 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
362
363 /* Try to send a softirq to a remote cpu.  If this cannot be done, the
364  * work will be queued to the local cpu.
365  */
366 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
367
368 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
369  * and compute the current cpu, passed in as 'this_cpu'.
370  */
371 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
372                                   int this_cpu, int softirq);
373
374 /* Tasklets --- multithreaded analogue of BHs.
375
376    Main feature differing them of generic softirqs: tasklet
377    is running only on one CPU simultaneously.
378
379    Main feature differing them of BHs: different tasklets
380    may be run simultaneously on different CPUs.
381
382    Properties:
383    * If tasklet_schedule() is called, then tasklet is guaranteed
384      to be executed on some cpu at least once after this.
385    * If the tasklet is already scheduled, but its excecution is still not
386      started, it will be executed only once.
387    * If this tasklet is already running on another CPU (or schedule is called
388      from tasklet itself), it is rescheduled for later.
389    * Tasklet is strictly serialized wrt itself, but not
390      wrt another tasklets. If client needs some intertask synchronization,
391      he makes it with spinlocks.
392  */
393
394 struct tasklet_struct
395 {
396         struct tasklet_struct *next;
397         unsigned long state;
398         atomic_t count;
399         void (*func)(unsigned long);
400         unsigned long data;
401 };
402
403 #define DECLARE_TASKLET(name, func, data) \
404 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
405
406 #define DECLARE_TASKLET_DISABLED(name, func, data) \
407 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
408
409
410 enum
411 {
412         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
413         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
414 };
415
416 #ifdef CONFIG_SMP
417 static inline int tasklet_trylock(struct tasklet_struct *t)
418 {
419         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
420 }
421
422 static inline void tasklet_unlock(struct tasklet_struct *t)
423 {
424         smp_mb__before_clear_bit(); 
425         clear_bit(TASKLET_STATE_RUN, &(t)->state);
426 }
427
428 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
429 {
430         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
431 }
432 #else
433 #define tasklet_trylock(t) 1
434 #define tasklet_unlock_wait(t) do { } while (0)
435 #define tasklet_unlock(t) do { } while (0)
436 #endif
437
438 extern void __tasklet_schedule(struct tasklet_struct *t);
439
440 static inline void tasklet_schedule(struct tasklet_struct *t)
441 {
442         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
443                 __tasklet_schedule(t);
444 }
445
446 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
447
448 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
449 {
450         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
451                 __tasklet_hi_schedule(t);
452 }
453
454
455 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
456 {
457         atomic_inc(&t->count);
458         smp_mb__after_atomic_inc();
459 }
460
461 static inline void tasklet_disable(struct tasklet_struct *t)
462 {
463         tasklet_disable_nosync(t);
464         tasklet_unlock_wait(t);
465         smp_mb();
466 }
467
468 static inline void tasklet_enable(struct tasklet_struct *t)
469 {
470         smp_mb__before_atomic_dec();
471         atomic_dec(&t->count);
472 }
473
474 static inline void tasklet_hi_enable(struct tasklet_struct *t)
475 {
476         smp_mb__before_atomic_dec();
477         atomic_dec(&t->count);
478 }
479
480 extern void tasklet_kill(struct tasklet_struct *t);
481 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
482 extern void tasklet_init(struct tasklet_struct *t,
483                          void (*func)(unsigned long), unsigned long data);
484
485 /*
486  * Autoprobing for irqs:
487  *
488  * probe_irq_on() and probe_irq_off() provide robust primitives
489  * for accurate IRQ probing during kernel initialization.  They are
490  * reasonably simple to use, are not "fooled" by spurious interrupts,
491  * and, unlike other attempts at IRQ probing, they do not get hung on
492  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
493  *
494  * For reasonably foolproof probing, use them as follows:
495  *
496  * 1. clear and/or mask the device's internal interrupt.
497  * 2. sti();
498  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
499  * 4. enable the device and cause it to trigger an interrupt.
500  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
501  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
502  * 7. service the device to clear its pending interrupt.
503  * 8. loop again if paranoia is required.
504  *
505  * probe_irq_on() returns a mask of allocated irq's.
506  *
507  * probe_irq_off() takes the mask as a parameter,
508  * and returns the irq number which occurred,
509  * or zero if none occurred, or a negative irq number
510  * if more than one irq occurred.
511  */
512
513 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE) 
514 static inline unsigned long probe_irq_on(void)
515 {
516         return 0;
517 }
518 static inline int probe_irq_off(unsigned long val)
519 {
520         return 0;
521 }
522 static inline unsigned int probe_irq_mask(unsigned long val)
523 {
524         return 0;
525 }
526 #else
527 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
528 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
529 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
530 #endif
531
532 #ifdef CONFIG_PROC_FS
533 /* Initialize /proc/irq/ */
534 extern void init_irq_proc(void);
535 #else
536 static inline void init_irq_proc(void)
537 {
538 }
539 #endif
540
541 #if defined(CONFIG_GENERIC_HARDIRQS) && defined(CONFIG_DEBUG_SHIRQ)
542 extern void debug_poll_all_shared_irqs(void);
543 #else
544 static inline void debug_poll_all_shared_irqs(void) { }
545 #endif
546
547 int show_interrupts(struct seq_file *p, void *v);
548
549 struct irq_desc;
550
551 extern int early_irq_init(void);
552 extern int arch_probe_nr_irqs(void);
553 extern int arch_early_irq_init(void);
554 extern int arch_init_chip_data(struct irq_desc *desc, int cpu);
555
556 #endif