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