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