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