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