SAFE public projects git trees. - safe/jmp/linux-2.6/blob - 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 <linux/irqflags.h>
  14 #include <linux/bottom_half.h>
  15 #include <linux/device.h>
  16 #include <asm/atomic.h>
  17 #include <asm/ptrace.h>
  18 #include <asm/system.h>
  19
  20 /*
  21  * These correspond to the IORESOURCE_IRQ_* defines in
  22  * linux/ioport.h to select the interrupt line behaviour.  When
  23  * requesting an interrupt without specifying a IRQF_TRIGGER, the
  24  * setting should be assumed to be "as already configured", which
  25  * may be as per machine or firmware initialisation.
  26  */
  27 #define IRQF_TRIGGER_NONE       0x00000000
  28 #define IRQF_TRIGGER_RISING     0x00000001
  29 #define IRQF_TRIGGER_FALLING    0x00000002
  30 #define IRQF_TRIGGER_HIGH       0x00000004
  31 #define IRQF_TRIGGER_LOW        0x00000008
  32 #define IRQF_TRIGGER_MASK       (IRQF_TRIGGER_HIGH | IRQF_TRIGGER_LOW | \
  33                                  IRQF_TRIGGER_RISING | IRQF_TRIGGER_FALLING)
  34 #define IRQF_TRIGGER_PROBE      0x00000010
  35
  36 /*
  37  * These flags used only by the kernel as part of the
  38  * irq handling routines.
  39  *
  40  * IRQF_DISABLED - keep irqs disabled when calling the action handler
  41  * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
  42  * IRQF_SHARED - allow sharing the irq among several devices
  43  * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
  44  * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
  45  * IRQF_PERCPU - Interrupt is per cpu
  46  * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
  47  */
  48 #define IRQF_DISABLED           0x00000020
  49 #define IRQF_SAMPLE_RANDOM      0x00000040
  50 #define IRQF_SHARED             0x00000080
  51 #define IRQF_PROBE_SHARED       0x00000100
  52 #define IRQF_TIMER              0x00000200
  53 #define IRQF_PERCPU             0x00000400
  54 #define IRQF_NOBALANCING        0x00000800
  55
  56 /*
  57  * Migration helpers. Scheduled for removal in 9/2007
  58  * Do not use for new code !
  59  */
  60 static inline
  61 unsigned long __deprecated deprecated_irq_flag(unsigned long flag)
  62 {
  63         return flag;
  64 }
  65
  66 #define SA_INTERRUPT            deprecated_irq_flag(IRQF_DISABLED)
  67 #define SA_SAMPLE_RANDOM        deprecated_irq_flag(IRQF_SAMPLE_RANDOM)
  68 #define SA_SHIRQ                deprecated_irq_flag(IRQF_SHARED)
  69 #define SA_PROBEIRQ             deprecated_irq_flag(IRQF_PROBE_SHARED)
  70 #define SA_PERCPU               deprecated_irq_flag(IRQF_PERCPU)
  71
  72 #define SA_TRIGGER_LOW          deprecated_irq_flag(IRQF_TRIGGER_LOW)
  73 #define SA_TRIGGER_HIGH         deprecated_irq_flag(IRQF_TRIGGER_HIGH)
  74 #define SA_TRIGGER_FALLING      deprecated_irq_flag(IRQF_TRIGGER_FALLING)
  75 #define SA_TRIGGER_RISING       deprecated_irq_flag(IRQF_TRIGGER_RISING)
  76 #define SA_TRIGGER_MASK         deprecated_irq_flag(IRQF_TRIGGER_MASK)
  77
  78 typedef irqreturn_t (*irq_handler_t)(int, void *);
  79
  80 struct irqaction {
  81         irq_handler_t handler;
  82         unsigned long flags;
  83         cpumask_t mask;
  84         const char *name;
  85         void *dev_id;
  86         struct irqaction *next;
  87         int irq;
  88         struct proc_dir_entry *dir;
  89 };
  90
  91 extern irqreturn_t no_action(int cpl, void *dev_id);
  92 extern int __must_check request_irq(unsigned int, irq_handler_t handler,
  93                        unsigned long, const char *, void *);
  94 extern void free_irq(unsigned int, void *);
  95
  96 extern int __must_check devm_request_irq(struct device *dev, unsigned int irq,
  97                             irq_handler_t handler, unsigned long irqflags,
  98                             const char *devname, void *dev_id);
  99 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
 100
 101 /*
 102  * On lockdep we dont want to enable hardirqs in hardirq
 103  * context. Use local_irq_enable_in_hardirq() to annotate
 104  * kernel code that has to do this nevertheless (pretty much
 105  * the only valid case is for old/broken hardware that is
 106  * insanely slow).
 107  *
 108  * NOTE: in theory this might break fragile code that relies
 109  * on hardirq delivery - in practice we dont seem to have such
 110  * places left. So the only effect should be slightly increased
 111  * irqs-off latencies.
 112  */
 113 #ifdef CONFIG_LOCKDEP
 114 # define local_irq_enable_in_hardirq()  do { } while (0)
 115 #else
 116 # define local_irq_enable_in_hardirq()  local_irq_enable()
 117 #endif
 118
 119 #ifdef CONFIG_GENERIC_HARDIRQS
 120 extern void disable_irq_nosync(unsigned int irq);
 121 extern void disable_irq(unsigned int irq);
 122 extern void enable_irq(unsigned int irq);
 123
 124 /*
 125  * Special lockdep variants of irq disabling/enabling.
 126  * These should be used for locking constructs that
 127  * know that a particular irq context which is disabled,
 128  * and which is the only irq-context user of a lock,
 129  * that it's safe to take the lock in the irq-disabled
 130  * section without disabling hardirqs.
 131  *
 132  * On !CONFIG_LOCKDEP they are equivalent to the normal
 133  * irq disable/enable methods.
 134  */
 135 static inline void disable_irq_nosync_lockdep(unsigned int irq)
 136 {
 137         disable_irq_nosync(irq);
 138 #ifdef CONFIG_LOCKDEP
 139         local_irq_disable();
 140 #endif
 141 }
 142
 143 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
 144 {
 145         disable_irq_nosync(irq);
 146 #ifdef CONFIG_LOCKDEP
 147         local_irq_save(*flags);
 148 #endif
 149 }
 150
 151 static inline void disable_irq_lockdep(unsigned int irq)
 152 {
 153         disable_irq(irq);
 154 #ifdef CONFIG_LOCKDEP
 155         local_irq_disable();
 156 #endif
 157 }
 158
 159 static inline void enable_irq_lockdep(unsigned int irq)
 160 {
 161 #ifdef CONFIG_LOCKDEP
 162         local_irq_enable();
 163 #endif
 164         enable_irq(irq);
 165 }
 166
 167 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
 168 {
 169 #ifdef CONFIG_LOCKDEP
 170         local_irq_restore(*flags);
 171 #endif
 172         enable_irq(irq);
 173 }
 174
 175 /* IRQ wakeup (PM) control: */
 176 extern int set_irq_wake(unsigned int irq, unsigned int on);
 177
 178 static inline int enable_irq_wake(unsigned int irq)
 179 {
 180         return set_irq_wake(irq, 1);
 181 }
 182
 183 static inline int disable_irq_wake(unsigned int irq)
 184 {
 185         return set_irq_wake(irq, 0);
 186 }
 187
 188 #else /* !CONFIG_GENERIC_HARDIRQS */
 189 /*
 190  * NOTE: non-genirq architectures, if they want to support the lock
 191  * validator need to define the methods below in their asm/irq.h
 192  * files, under an #ifdef CONFIG_LOCKDEP section.
 193  */
 194 #ifndef CONFIG_LOCKDEP
 195 #  define disable_irq_nosync_lockdep(irq)       disable_irq_nosync(irq)
 196 #  define disable_irq_nosync_lockdep_irqsave(irq, flags) \
 197                                                 disable_irq_nosync(irq)
 198 #  define disable_irq_lockdep(irq)              disable_irq(irq)
 199 #  define enable_irq_lockdep(irq)               enable_irq(irq)
 200 #  define enable_irq_lockdep_irqrestore(irq, flags) \
 201                                                 enable_irq(irq)
 202 # endif
 203
 204 #endif /* CONFIG_GENERIC_HARDIRQS */
 205
 206 #ifndef __ARCH_SET_SOFTIRQ_PENDING
 207 #define set_softirq_pending(x) (local_softirq_pending() = (x))
 208 #define or_softirq_pending(x)  (local_softirq_pending() |= (x))
 209 #endif
 210
 211 /*
 212  * Temporary defines for UP kernels, until all code gets fixed.
 213  */
 214 #ifndef CONFIG_SMP
 215 static inline void __deprecated cli(void)
 216 {
 217         local_irq_disable();
 218 }
 219 static inline void __deprecated sti(void)
 220 {
 221         local_irq_enable();
 222 }
 223 static inline void __deprecated save_flags(unsigned long *x)
 224 {
 225         local_save_flags(*x);
 226 }
 227 #define save_flags(x) save_flags(&x)
 228 static inline void __deprecated restore_flags(unsigned long x)
 229 {
 230         local_irq_restore(x);
 231 }
 232
 233 static inline void __deprecated save_and_cli(unsigned long *x)
 234 {
 235         local_irq_save(*x);
 236 }
 237 #define save_and_cli(x) save_and_cli(&x)
 238 #endif /* CONFIG_SMP */
 239
 240 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
 241    frequency threaded job scheduling. For almost all the purposes
 242    tasklets are more than enough. F.e. all serial device BHs et
 243    al. should be converted to tasklets, not to softirqs.
 244  */
 245
 246 enum
 247 {
 248         HI_SOFTIRQ=0,
 249         TIMER_SOFTIRQ,
 250         NET_TX_SOFTIRQ,
 251         NET_RX_SOFTIRQ,
 252         BLOCK_SOFTIRQ,
 253         TASKLET_SOFTIRQ,
 254         SCHED_SOFTIRQ,
 255 #ifdef CONFIG_HIGH_RES_TIMERS
 256         HRTIMER_SOFTIRQ,
 257 #endif
 258 };
 259
 260 /* softirq mask and active fields moved to irq_cpustat_t in
 261  * asm/hardirq.h to get better cache usage.  KAO
 262  */
 263
 264 struct softirq_action
 265 {
 266         void    (*action)(struct softirq_action *);
 267         void    *data;
 268 };
 269
 270 asmlinkage void do_softirq(void);
 271 extern void open_softirq(int nr, void (*action)(struct softirq_action*), void *data);
 272 extern void softirq_init(void);
 273 #define __raise_softirq_irqoff(nr) do { or_softirq_pending(1UL << (nr)); } while (0)
 274 extern void FASTCALL(raise_softirq_irqoff(unsigned int nr));
 275 extern void FASTCALL(raise_softirq(unsigned int nr));
 276
 277
 278 /* Tasklets --- multithreaded analogue of BHs.
 279
 280    Main feature differing them of generic softirqs: tasklet
 281    is running only on one CPU simultaneously.
 282
 283    Main feature differing them of BHs: different tasklets
 284    may be run simultaneously on different CPUs.
 285
 286    Properties:
 287    * If tasklet_schedule() is called, then tasklet is guaranteed
 288      to be executed on some cpu at least once after this.
 289    * If the tasklet is already scheduled, but its excecution is still not
 290      started, it will be executed only once.
 291    * If this tasklet is already running on another CPU (or schedule is called
 292      from tasklet itself), it is rescheduled for later.
 293    * Tasklet is strictly serialized wrt itself, but not
 294      wrt another tasklets. If client needs some intertask synchronization,
 295      he makes it with spinlocks.
 296  */
 297
 298 struct tasklet_struct
 299 {
 300         struct tasklet_struct *next;
 301         unsigned long state;
 302         atomic_t count;
 303         void (*func)(unsigned long);
 304         unsigned long data;
 305 };
 306
 307 #define DECLARE_TASKLET(name, func, data) \
 308 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
 309
 310 #define DECLARE_TASKLET_DISABLED(name, func, data) \
 311 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
 312
 313
 314 enum
 315 {
 316         TASKLET_STATE_SCHED,    /* Tasklet is scheduled for execution */
 317         TASKLET_STATE_RUN       /* Tasklet is running (SMP only) */
 318 };
 319
 320 #ifdef CONFIG_SMP
 321 static inline int tasklet_trylock(struct tasklet_struct *t)
 322 {
 323         return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
 324 }
 325
 326 static inline void tasklet_unlock(struct tasklet_struct *t)
 327 {
 328         smp_mb__before_clear_bit();
 329         clear_bit(TASKLET_STATE_RUN, &(t)->state);
 330 }
 331
 332 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
 333 {
 334         while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
 335 }
 336 #else
 337 #define tasklet_trylock(t) 1
 338 #define tasklet_unlock_wait(t) do { } while (0)
 339 #define tasklet_unlock(t) do { } while (0)
 340 #endif
 341
 342 extern void FASTCALL(__tasklet_schedule(struct tasklet_struct *t));
 343
 344 static inline void tasklet_schedule(struct tasklet_struct *t)
 345 {
 346         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
 347                 __tasklet_schedule(t);
 348 }
 349
 350 extern void FASTCALL(__tasklet_hi_schedule(struct tasklet_struct *t));
 351
 352 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
 353 {
 354         if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
 355                 __tasklet_hi_schedule(t);
 356 }
 357
 358
 359 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
 360 {
 361         atomic_inc(&t->count);
 362         smp_mb__after_atomic_inc();
 363 }
 364
 365 static inline void tasklet_disable(struct tasklet_struct *t)
 366 {
 367         tasklet_disable_nosync(t);
 368         tasklet_unlock_wait(t);
 369         smp_mb();
 370 }
 371
 372 static inline void tasklet_enable(struct tasklet_struct *t)
 373 {
 374         smp_mb__before_atomic_dec();
 375         atomic_dec(&t->count);
 376 }
 377
 378 static inline void tasklet_hi_enable(struct tasklet_struct *t)
 379 {
 380         smp_mb__before_atomic_dec();
 381         atomic_dec(&t->count);
 382 }
 383
 384 extern void tasklet_kill(struct tasklet_struct *t);
 385 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
 386 extern void tasklet_init(struct tasklet_struct *t,
 387                          void (*func)(unsigned long), unsigned long data);
 388
 389 /*
 390  * Autoprobing for irqs:
 391  *
 392  * probe_irq_on() and probe_irq_off() provide robust primitives
 393  * for accurate IRQ probing during kernel initialization.  They are
 394  * reasonably simple to use, are not "fooled" by spurious interrupts,
 395  * and, unlike other attempts at IRQ probing, they do not get hung on
 396  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
 397  *
 398  * For reasonably foolproof probing, use them as follows:
 399  *
 400  * 1. clear and/or mask the device's internal interrupt.
 401  * 2. sti();
 402  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
 403  * 4. enable the device and cause it to trigger an interrupt.
 404  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
 405  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
 406  * 7. service the device to clear its pending interrupt.
 407  * 8. loop again if paranoia is required.
 408  *
 409  * probe_irq_on() returns a mask of allocated irq's.
 410  *
 411  * probe_irq_off() takes the mask as a parameter,
 412  * and returns the irq number which occurred,
 413  * or zero if none occurred, or a negative irq number
 414  * if more than one irq occurred.
 415  */
 416
 417 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
 418 static inline unsigned long probe_irq_on(void)
 419 {
 420         return 0;
 421 }
 422 static inline int probe_irq_off(unsigned long val)
 423 {
 424         return 0;
 425 }
 426 static inline unsigned int probe_irq_mask(unsigned long val)
 427 {
 428         return 0;
 429 }
 430 #else
 431 extern unsigned long probe_irq_on(void);        /* returns 0 on failure */
 432 extern int probe_irq_off(unsigned long);        /* returns 0 or negative on failure */
 433 extern unsigned int probe_irq_mask(unsigned long);      /* returns mask of ISA interrupts */
 434 #endif
 435
 436 #ifdef CONFIG_PROC_FS
 437 /* Initialize /proc/irq/ */
 438 extern void init_irq_proc(void);
 439 #else
 440 static inline void init_irq_proc(void)
 441 {
 442 }
 443 #endif
 444
 445 #endif