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