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