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 #define IRQF_PERCPU             0x00000400
  49
  50 /*
  51  * Migration helpers. Scheduled for removal in 1/2007
  52  * Do not use for new code !
  53  */
  54 #define SA_INTERRUPT            IRQF_DISABLED
  55 #define SA_SAMPLE_RANDOM        IRQF_SAMPLE_RANDOM
  56 #define SA_SHIRQ                IRQF_SHARED
  57 #define SA_PROBEIRQ             IRQF_PROBE_SHARED
  58 #define SA_PERCPU               IRQF_PERCPU
  59
  60 #define SA_TRIGGER_LOW          IRQF_TRIGGER_LOW
  61 #define SA_TRIGGER_HIGH         IRQF_TRIGGER_HIGH
  62 #define SA_TRIGGER_FALLING      IRQF_TRIGGER_FALLING
  63 #define SA_TRIGGER_RISING       IRQF_TRIGGER_RISING
  64 #define SA_TRIGGER_MASK         IRQF_TRIGGER_MASK
  65
  66 struct irqaction {
  67         irqreturn_t (*handler)(int, void *, struct pt_regs *);
  68         unsigned long flags;
  69         cpumask_t mask;
  70         const char *name;
  71         void *dev_id;
  72         struct irqaction *next;
  73         int irq;
  74         struct proc_dir_entry *dir;
  75 };
  76
  77 extern irqreturn_t no_action(int cpl, void *dev_id, struct pt_regs *regs);
  78 extern int request_irq(unsigned int,
  79                        irqreturn_t (*handler)(int, void *, struct pt_regs *),
  80                        unsigned long, const char *, void *);
  81 extern void free_irq(unsigned int, void *);
  82
  83
  84 #ifdef CONFIG_GENERIC_HARDIRQS
  85 extern void disable_irq_nosync(unsigned int irq);
  86 extern void disable_irq(unsigned int irq);
  87 extern void enable_irq(unsigned int irq);
  88
  89 /*
  90  * Special lockdep variants of irq disabling/enabling.
  91  * These should be used for locking constructs that
  92  * know that a particular irq context which is disabled,
  93  * and which is the only irq-context user of a lock,
  94  * that it's safe to take the lock in the irq-disabled
  95  * section without disabling hardirqs.
  96  *
  97  * On !CONFIG_LOCKDEP they are equivalent to the normal
  98  * irq disable/enable methods.
  99  */
 100 static inline void disable_irq_nosync_lockdep(unsigned int irq)
 101 {
 102         disable_irq_nosync(irq);
 103 #ifdef CONFIG_LOCKDEP
 104         local_irq_disable();
 105 #endif
 106 }
 107
 108 static inline void disable_irq_lockdep(unsigned int irq)
 109 {
 110         disable_irq(irq);
 111 #ifdef CONFIG_LOCKDEP
 112         local_irq_disable();
 113 #endif
 114 }
 115
 116 static inline void enable_irq_lockdep(unsigned int irq)
 117 {
 118 #ifdef CONFIG_LOCKDEP
 119         local_irq_enable();
 120 #endif
 121         enable_irq(irq);
 122 }
 123
 124 /* IRQ wakeup (PM) control: */
 125 extern int set_irq_wake(unsigned int irq, unsigned int on);
 126
 127 static inline int enable_irq_wake(unsigned int irq)
 128 {
 129         return set_irq_wake(irq, 1);
 130 }
 131
 132 static inline int disable_irq_wake(unsigned int irq)
 133 {
 134         return set_irq_wake(irq, 0);
 135 }
 136
 137 #else /* !CONFIG_GENERIC_HARDIRQS */
 138 /*
 139  * NOTE: non-genirq architectures, if they want to support the lock
 140  * validator need to define the methods below in their asm/irq.h
 141  * files, under an #ifdef CONFIG_LOCKDEP section.
 142  */
 143 # ifndef CONFIG_LOCKDEP
 144 #  define disable_irq_nosync_lockdep(irq)       disable_irq_nosync(irq)
 145 #  define disable_irq_lockdep(irq)              disable_irq(irq)
 146 #  define enable_irq_lockdep(irq)               enable_irq(irq)
 147 # endif
 148
 149 #endif /* CONFIG_GENERIC_HARDIRQS */
 150
 151 #ifndef __ARCH_SET_SOFTIRQ_PENDING
 152 #define set_softirq_pending(x) (local_softirq_pending() = (x))
 153 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
 154 #endif
 155
 156 /*
 157  * Temporary defines for UP kernels, until all code gets fixed.
 158  */
 159 #ifndef CONFIG_SMP
 160 static inline void __deprecated cli(void)
 161 {
 162         local_irq_disable();
 163 }
 164 static inline void __deprecated sti(void)
 165 {
 166         local_irq_enable();
 167 }
 168 static inline void __deprecated save_flags(unsigned long *x)
 169 {
 170         local_save_flags(*x);
 171 }
 172 #define save_flags(x) save_flags(&x)
 173 static inline void __deprecated restore_flags(unsigned long x)
 174 {
 175         local_irq_restore(x);
 176 }
 177
 178 static inline void __deprecated save_and_cli(unsigned long *x)
 179 {
 180         local_irq_save(*x);
 181 }
 182 #define save_and_cli(x) save_and_cli(&x)
 183 #endif /* CONFIG_SMP */
 184
 185 /* SoftIRQ primitives.  */
 186 #define local_bh_disable() \
 187                 do { add_preempt_count(SOFTIRQ_OFFSET); barrier(); } while (0)
 188 #define __local_bh_enable() \
 189                 do { barrier(); sub_preempt_count(SOFTIRQ_OFFSET); } while (0)
 190
 191 extern void local_bh_enable(void);
 192
 193 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
 194    frequency threaded job scheduling. For almost all the purposes
 195    tasklets are more than enough. F.e. all serial device BHs et
 196    al. should be converted to tasklets, not to softirqs.
 197  */
 198
 199 enum
 200 {
 201         HI_SOFTIRQ=0,
 202         TIMER_SOFTIRQ,
 203         NET_TX_SOFTIRQ,
 204         NET_RX_SOFTIRQ,
 205         BLOCK_SOFTIRQ,
 206         TASKLET_SOFTIRQ
 207 };
 208
 209 /* softirq mask and active fields moved to irq_cpustat_t in
 210  * asm/hardirq.h to get better cache usage.  KAO
 211  */
 212
 213 struct softirq_action
 214 {
 215         void    (*action)(struct softirq_action *);
 216         void    *data;
 217 };
 218
 219 asmlinkage void do_softirq(void);
 220 extern void open_softirq(int nr, void (*action)(struct softirq_action*), void *data);
 221 extern void softirq_init(void);
 222 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
 223 extern void FASTCALL(raise_softirq_irqoff(unsigned int nr));
 224 extern void FASTCALL(raise_softirq(unsigned int nr));
 225
 226
 227 /* Tasklets --- multithreaded analogue of BHs.
 228
 229    Main feature differing them of generic softirqs: tasklet
 230    is running only on one CPU simultaneously.
 231
 232    Main feature differing them of BHs: different tasklets
 233    may be run simultaneously on different CPUs.
 234
 235    Properties:
 236    * If tasklet_schedule() is called, then tasklet is guaranteed
 237      to be executed on some cpu at least once after this.
 238    * If the tasklet is already scheduled, but its excecution is still not
 239      started, it will be executed only once.
 240    * If this tasklet is already running on another CPU (or schedule is called
 241      from tasklet itself), it is rescheduled for later.
 242    * Tasklet is strictly serialized wrt itself, but not
 243      wrt another tasklets. If client needs some intertask synchronization,
 244      he makes it with spinlocks.
 245  */
 246
 247 struct tasklet_struct
 248 {
 249         struct tasklet_struct *next;
 250         unsigned long state;
 251         atomic_t count;
 252         void (*func)(unsigned long);
 253         unsigned long data;
 254 };
 255
 256 #define DECLARE_TASKLET(name, func, data) \
 257 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
 258
 259 #define DECLARE_TASKLET_DISABLED(name, func, data) \
 260 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
 261
 262
 263 enum
 264 {
 265         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
 266         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
 267 };
 268
 269 #ifdef CONFIG_SMP
 270 static inline int tasklet_trylock(struct tasklet_struct *t)
 271 {
 272         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
 273 }
 274
 275 static inline void tasklet_unlock(struct tasklet_struct *t)
 276 {
 277         smp_mb__before_clear_bit();
 278         clear_bit(TASKLET_STATE_RUN, &(t)->state);
 279 }
 280
 281 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
 282 {
 283         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
 284 }
 285 #else
 286 #define tasklet_trylock(t) 1
 287 #define tasklet_unlock_wait(t) do { } while (0)
 288 #define tasklet_unlock(t) do { } while (0)
 289 #endif
 290
 291 extern void FASTCALL(__tasklet_schedule(struct tasklet_struct *t));
 292
 293 static inline void tasklet_schedule(struct tasklet_struct *t)
 294 {
 295         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
 296                 __tasklet_schedule(t);
 297 }
 298
 299 extern void FASTCALL(__tasklet_hi_schedule(struct tasklet_struct *t));
 300
 301 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
 302 {
 303         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
 304                 __tasklet_hi_schedule(t);
 305 }
 306
 307
 308 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
 309 {
 310         atomic_inc(&t->count);
 311         smp_mb__after_atomic_inc();
 312 }
 313
 314 static inline void tasklet_disable(struct tasklet_struct *t)
 315 {
 316         tasklet_disable_nosync(t);
 317         tasklet_unlock_wait(t);
 318         smp_mb();
 319 }
 320
 321 static inline void tasklet_enable(struct tasklet_struct *t)
 322 {
 323         smp_mb__before_atomic_dec();
 324         atomic_dec(&t->count);
 325 }
 326
 327 static inline void tasklet_hi_enable(struct tasklet_struct *t)
 328 {
 329         smp_mb__before_atomic_dec();
 330         atomic_dec(&t->count);
 331 }
 332
 333 extern void tasklet_kill(struct tasklet_struct *t);
 334 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
 335 extern void tasklet_init(struct tasklet_struct *t,
 336                          void (*func)(unsigned long), unsigned long data);
 337
 338 /*
 339  * Autoprobing for irqs:
 340  *
 341  * probe_irq_on() and probe_irq_off() provide robust primitives
 342  * for accurate IRQ probing during kernel initialization.  They are
 343  * reasonably simple to use, are not "fooled" by spurious interrupts,
 344  * and, unlike other attempts at IRQ probing, they do not get hung on
 345  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
 346  *
 347  * For reasonably foolproof probing, use them as follows:
 348  *
 349  * 1. clear and/or mask the device's internal interrupt.
 350  * 2. sti();
 351  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
 352  * 4. enable the device and cause it to trigger an interrupt.
 353  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
 354  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
 355  * 7. service the device to clear its pending interrupt.
 356  * 8. loop again if paranoia is required.
 357  *
 358  * probe_irq_on() returns a mask of allocated irq's.
 359  *
 360  * probe_irq_off() takes the mask as a parameter,
 361  * and returns the irq number which occurred,
 362  * or zero if none occurred, or a negative irq number
 363  * if more than one irq occurred.
 364  */
 365
 366 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
 367 static inline unsigned long probe_irq_on(void)
 368 {
 369         return 0;
 370 }
 371 static inline int probe_irq_off(unsigned long val)
 372 {
 373         return 0;
 374 }
 375 static inline unsigned int probe_irq_mask(unsigned long val)
 376 {
 377         return 0;
 378 }
 379 #else
 380 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
 381 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
 382 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
 383 #endif
 384
 385 #endif