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