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