2 #ifndef _LINUX_INTERRUPT_H
3 #define _LINUX_INTERRUPT_H
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/irqflags.h>
14 #include <linux/smp.h>
15 #include <linux/percpu.h>
16 #include <linux/hrtimer.h>
17 #include <linux/kref.h>
18 #include <linux/workqueue.h>
20 #include <asm/atomic.h>
21 #include <asm/ptrace.h>
22 #include <asm/system.h>
23 #include <trace/events/irq.h>
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.
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
42 * These flags used only by the kernel as part of the
43 * irq handling routines.
45 * IRQF_DISABLED - keep irqs disabled when calling the action handler.
46 * DEPRECATED. This flag is a NOOP and scheduled to be removed
47 * IRQF_SAMPLE_RANDOM - irq is used to feed the random generator
48 * IRQF_SHARED - allow sharing the irq among several devices
49 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
50 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
51 * IRQF_PERCPU - Interrupt is per cpu
52 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
53 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
54 * registered first in an shared interrupt is considered for
55 * performance reasons)
56 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
57 * Used by threaded interrupts which need to keep the
58 * irq line disabled until the threaded handler has been run.
59 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend
62 #define IRQF_DISABLED 0x00000020
63 #define IRQF_SAMPLE_RANDOM 0x00000040
64 #define IRQF_SHARED 0x00000080
65 #define IRQF_PROBE_SHARED 0x00000100
66 #define __IRQF_TIMER 0x00000200
67 #define IRQF_PERCPU 0x00000400
68 #define IRQF_NOBALANCING 0x00000800
69 #define IRQF_IRQPOLL 0x00001000
70 #define IRQF_ONESHOT 0x00002000
71 #define IRQF_NO_SUSPEND 0x00004000
73 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND)
76 * Bits used by threaded handlers:
77 * IRQTF_RUNTHREAD - signals that the interrupt handler thread should run
78 * IRQTF_DIED - handler thread died
79 * IRQTF_WARNED - warning "IRQ_WAKE_THREAD w/o thread_fn" has been printed
80 * IRQTF_AFFINITY - irq thread is requested to adjust affinity
90 * These values can be returned by request_any_context_irq() and
91 * describe the context the interrupt will be run in.
93 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
94 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
101 typedef irqreturn_t (*irq_handler_t)(int, void *);
104 * struct irqaction - per interrupt action descriptor
105 * @handler: interrupt handler function
106 * @flags: flags (see IRQF_* above)
107 * @name: name of the device
108 * @dev_id: cookie to identify the device
109 * @next: pointer to the next irqaction for shared interrupts
110 * @irq: interrupt number
111 * @dir: pointer to the proc/irq/NN/name entry
112 * @thread_fn: interupt handler function for threaded interrupts
113 * @thread: thread pointer for threaded interrupts
114 * @thread_flags: flags related to @thread
117 irq_handler_t handler;
120 struct irqaction *next;
122 irq_handler_t thread_fn;
123 struct task_struct *thread;
124 unsigned long thread_flags;
126 struct proc_dir_entry *dir;
127 } ____cacheline_internodealigned_in_smp;
129 extern irqreturn_t no_action(int cpl, void *dev_id);
131 #ifdef CONFIG_GENERIC_HARDIRQS
132 extern int __must_check
133 request_threaded_irq(unsigned int irq, irq_handler_t handler,
134 irq_handler_t thread_fn,
135 unsigned long flags, const char *name, void *dev);
137 static inline int __must_check
138 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
139 const char *name, void *dev)
141 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
144 extern int __must_check
145 request_any_context_irq(unsigned int irq, irq_handler_t handler,
146 unsigned long flags, const char *name, void *dev_id);
148 extern void exit_irq_thread(void);
151 extern int __must_check
152 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
153 const char *name, void *dev);
156 * Special function to avoid ifdeffery in kernel/irq/devres.c which
157 * gets magically built by GENERIC_HARDIRQS=n architectures (sparc,
158 * m68k). I really love these $@%#!* obvious Makefile references:
159 * ../../../kernel/irq/devres.o
161 static inline int __must_check
162 request_threaded_irq(unsigned int irq, irq_handler_t handler,
163 irq_handler_t thread_fn,
164 unsigned long flags, const char *name, void *dev)
166 return request_irq(irq, handler, flags, name, dev);
169 static inline int __must_check
170 request_any_context_irq(unsigned int irq, irq_handler_t handler,
171 unsigned long flags, const char *name, void *dev_id)
173 return request_irq(irq, handler, flags, name, dev_id);
176 static inline void exit_irq_thread(void) { }
179 extern void free_irq(unsigned int, void *);
183 extern int __must_check
184 devm_request_threaded_irq(struct device *dev, unsigned int irq,
185 irq_handler_t handler, irq_handler_t thread_fn,
186 unsigned long irqflags, const char *devname,
189 static inline int __must_check
190 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
191 unsigned long irqflags, const char *devname, void *dev_id)
193 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
197 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
200 * On lockdep we dont want to enable hardirqs in hardirq
201 * context. Use local_irq_enable_in_hardirq() to annotate
202 * kernel code that has to do this nevertheless (pretty much
203 * the only valid case is for old/broken hardware that is
206 * NOTE: in theory this might break fragile code that relies
207 * on hardirq delivery - in practice we dont seem to have such
208 * places left. So the only effect should be slightly increased
209 * irqs-off latencies.
211 #ifdef CONFIG_LOCKDEP
212 # define local_irq_enable_in_hardirq() do { } while (0)
214 # define local_irq_enable_in_hardirq() local_irq_enable()
217 extern void disable_irq_nosync(unsigned int irq);
218 extern void disable_irq(unsigned int irq);
219 extern void enable_irq(unsigned int irq);
221 /* The following three functions are for the core kernel use only. */
222 #ifdef CONFIG_GENERIC_HARDIRQS
223 extern void suspend_device_irqs(void);
224 extern void resume_device_irqs(void);
225 #ifdef CONFIG_PM_SLEEP
226 extern int check_wakeup_irqs(void);
228 static inline int check_wakeup_irqs(void) { return 0; }
231 static inline void suspend_device_irqs(void) { };
232 static inline void resume_device_irqs(void) { };
233 static inline int check_wakeup_irqs(void) { return 0; }
236 #if defined(CONFIG_SMP) && defined(CONFIG_GENERIC_HARDIRQS)
238 extern cpumask_var_t irq_default_affinity;
240 extern int irq_set_affinity(unsigned int irq, const struct cpumask *cpumask);
241 extern int irq_can_set_affinity(unsigned int irq);
242 extern int irq_select_affinity(unsigned int irq);
244 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
247 * struct irq_affinity_notify - context for notification of IRQ affinity changes
248 * @irq: Interrupt to which notification applies
249 * @kref: Reference count, for internal use
250 * @work: Work item, for internal use
251 * @notify: Function to be called on change. This will be
252 * called in process context.
253 * @release: Function to be called on release. This will be
254 * called in process context. Once registered, the
255 * structure must only be freed when this function is
258 struct irq_affinity_notify {
261 struct work_struct work;
262 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
263 void (*release)(struct kref *ref);
267 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
269 static inline void irq_run_affinity_notifiers(void)
271 flush_scheduled_work();
274 #else /* CONFIG_SMP */
276 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
281 static inline int irq_can_set_affinity(unsigned int irq)
286 static inline int irq_select_affinity(unsigned int irq) { return 0; }
288 static inline int irq_set_affinity_hint(unsigned int irq,
289 const struct cpumask *m)
293 #endif /* CONFIG_SMP && CONFIG_GENERIC_HARDIRQS */
295 #ifdef CONFIG_GENERIC_HARDIRQS
297 * Special lockdep variants of irq disabling/enabling.
298 * These should be used for locking constructs that
299 * know that a particular irq context which is disabled,
300 * and which is the only irq-context user of a lock,
301 * that it's safe to take the lock in the irq-disabled
302 * section without disabling hardirqs.
304 * On !CONFIG_LOCKDEP they are equivalent to the normal
305 * irq disable/enable methods.
307 static inline void disable_irq_nosync_lockdep(unsigned int irq)
309 disable_irq_nosync(irq);
310 #ifdef CONFIG_LOCKDEP
315 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
317 disable_irq_nosync(irq);
318 #ifdef CONFIG_LOCKDEP
319 local_irq_save(*flags);
323 static inline void disable_irq_lockdep(unsigned int irq)
326 #ifdef CONFIG_LOCKDEP
331 static inline void enable_irq_lockdep(unsigned int irq)
333 #ifdef CONFIG_LOCKDEP
339 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
341 #ifdef CONFIG_LOCKDEP
342 local_irq_restore(*flags);
347 /* IRQ wakeup (PM) control: */
348 extern int set_irq_wake(unsigned int irq, unsigned int on);
350 static inline int enable_irq_wake(unsigned int irq)
352 return set_irq_wake(irq, 1);
355 static inline int disable_irq_wake(unsigned int irq)
357 return set_irq_wake(irq, 0);
360 #else /* !CONFIG_GENERIC_HARDIRQS */
362 * NOTE: non-genirq architectures, if they want to support the lock
363 * validator need to define the methods below in their asm/irq.h
364 * files, under an #ifdef CONFIG_LOCKDEP section.
366 #ifndef CONFIG_LOCKDEP
367 # define disable_irq_nosync_lockdep(irq) disable_irq_nosync(irq)
368 # define disable_irq_nosync_lockdep_irqsave(irq, flags) \
369 disable_irq_nosync(irq)
370 # define disable_irq_lockdep(irq) disable_irq(irq)
371 # define enable_irq_lockdep(irq) enable_irq(irq)
372 # define enable_irq_lockdep_irqrestore(irq, flags) \
376 static inline int enable_irq_wake(unsigned int irq)
381 static inline int disable_irq_wake(unsigned int irq)
385 #endif /* CONFIG_GENERIC_HARDIRQS */
387 #ifndef __ARCH_SET_SOFTIRQ_PENDING
388 #define set_softirq_pending(x) (local_softirq_pending() = (x))
389 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
392 /* Some architectures might implement lazy enabling/disabling of
393 * interrupts. In some cases, such as stop_machine, we might want
394 * to ensure that after a local_irq_disable(), interrupts have
395 * really been disabled in hardware. Such architectures need to
396 * implement the following hook.
398 #ifndef hard_irq_disable
399 #define hard_irq_disable() do { } while(0)
402 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
403 frequency threaded job scheduling. For almost all the purposes
404 tasklets are more than enough. F.e. all serial device BHs et
405 al. should be converted to tasklets, not to softirqs.
415 BLOCK_IOPOLL_SOFTIRQ,
419 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
424 /* map softirq index to softirq name. update 'softirq_to_name' in
425 * kernel/softirq.c when adding a new softirq.
427 extern char *softirq_to_name[NR_SOFTIRQS];
429 /* softirq mask and active fields moved to irq_cpustat_t in
430 * asm/hardirq.h to get better cache usage. KAO
433 struct softirq_action
435 void (*action)(struct softirq_action *);
438 asmlinkage void do_softirq(void);
439 asmlinkage void __do_softirq(void);
440 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
441 extern void softirq_init(void);
442 static inline void __raise_softirq_irqoff(unsigned int nr)
444 trace_softirq_raise(nr);
445 or_softirq_pending(1UL << nr);
448 extern void raise_softirq_irqoff(unsigned int nr);
449 extern void raise_softirq(unsigned int nr);
451 /* This is the worklist that queues up per-cpu softirq work.
453 * send_remote_sendirq() adds work to these lists, and
454 * the softirq handler itself dequeues from them. The queues
455 * are protected by disabling local cpu interrupts and they must
456 * only be accessed by the local cpu that they are for.
458 DECLARE_PER_CPU(struct list_head [NR_SOFTIRQS], softirq_work_list);
460 /* Try to send a softirq to a remote cpu. If this cannot be done, the
461 * work will be queued to the local cpu.
463 extern void send_remote_softirq(struct call_single_data *cp, int cpu, int softirq);
465 /* Like send_remote_softirq(), but the caller must disable local cpu interrupts
466 * and compute the current cpu, passed in as 'this_cpu'.
468 extern void __send_remote_softirq(struct call_single_data *cp, int cpu,
469 int this_cpu, int softirq);
471 /* Tasklets --- multithreaded analogue of BHs.
473 Main feature differing them of generic softirqs: tasklet
474 is running only on one CPU simultaneously.
476 Main feature differing them of BHs: different tasklets
477 may be run simultaneously on different CPUs.
480 * If tasklet_schedule() is called, then tasklet is guaranteed
481 to be executed on some cpu at least once after this.
482 * If the tasklet is already scheduled, but its excecution is still not
483 started, it will be executed only once.
484 * If this tasklet is already running on another CPU (or schedule is called
485 from tasklet itself), it is rescheduled for later.
486 * Tasklet is strictly serialized wrt itself, but not
487 wrt another tasklets. If client needs some intertask synchronization,
488 he makes it with spinlocks.
491 struct tasklet_struct
493 struct tasklet_struct *next;
496 void (*func)(unsigned long);
500 #define DECLARE_TASKLET(name, func, data) \
501 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
503 #define DECLARE_TASKLET_DISABLED(name, func, data) \
504 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
509 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
510 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
514 static inline int tasklet_trylock(struct tasklet_struct *t)
516 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
519 static inline void tasklet_unlock(struct tasklet_struct *t)
521 smp_mb__before_clear_bit();
522 clear_bit(TASKLET_STATE_RUN, &(t)->state);
525 static inline void tasklet_unlock_wait(struct tasklet_struct *t)
527 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
530 #define tasklet_trylock(t) 1
531 #define tasklet_unlock_wait(t) do { } while (0)
532 #define tasklet_unlock(t) do { } while (0)
535 extern void __tasklet_schedule(struct tasklet_struct *t);
537 static inline void tasklet_schedule(struct tasklet_struct *t)
539 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
540 __tasklet_schedule(t);
543 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
545 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
547 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
548 __tasklet_hi_schedule(t);
551 extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
554 * This version avoids touching any other tasklets. Needed for kmemcheck
555 * in order not to take any page faults while enqueueing this tasklet;
556 * consider VERY carefully whether you really need this or
557 * tasklet_hi_schedule()...
559 static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
561 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
562 __tasklet_hi_schedule_first(t);
566 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
568 atomic_inc(&t->count);
569 smp_mb__after_atomic_inc();
572 static inline void tasklet_disable(struct tasklet_struct *t)
574 tasklet_disable_nosync(t);
575 tasklet_unlock_wait(t);
579 static inline void tasklet_enable(struct tasklet_struct *t)
581 smp_mb__before_atomic_dec();
582 atomic_dec(&t->count);
585 static inline void tasklet_hi_enable(struct tasklet_struct *t)
587 smp_mb__before_atomic_dec();
588 atomic_dec(&t->count);
591 extern void tasklet_kill(struct tasklet_struct *t);
592 extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
593 extern void tasklet_init(struct tasklet_struct *t,
594 void (*func)(unsigned long), unsigned long data);
596 struct tasklet_hrtimer {
597 struct hrtimer timer;
598 struct tasklet_struct tasklet;
599 enum hrtimer_restart (*function)(struct hrtimer *);
603 tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
604 enum hrtimer_restart (*function)(struct hrtimer *),
605 clockid_t which_clock, enum hrtimer_mode mode);
608 int tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
609 const enum hrtimer_mode mode)
611 return hrtimer_start(&ttimer->timer, time, mode);
615 void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
617 hrtimer_cancel(&ttimer->timer);
618 tasklet_kill(&ttimer->tasklet);
622 * Autoprobing for irqs:
624 * probe_irq_on() and probe_irq_off() provide robust primitives
625 * for accurate IRQ probing during kernel initialization. They are
626 * reasonably simple to use, are not "fooled" by spurious interrupts,
627 * and, unlike other attempts at IRQ probing, they do not get hung on
628 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
630 * For reasonably foolproof probing, use them as follows:
632 * 1. clear and/or mask the device's internal interrupt.
634 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
635 * 4. enable the device and cause it to trigger an interrupt.
636 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
637 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
638 * 7. service the device to clear its pending interrupt.
639 * 8. loop again if paranoia is required.
641 * probe_irq_on() returns a mask of allocated irq's.
643 * probe_irq_off() takes the mask as a parameter,
644 * and returns the irq number which occurred,
645 * or zero if none occurred, or a negative irq number
646 * if more than one irq occurred.
649 #if defined(CONFIG_GENERIC_HARDIRQS) && !defined(CONFIG_GENERIC_IRQ_PROBE)
650 static inline unsigned long probe_irq_on(void)
654 static inline int probe_irq_off(unsigned long val)
658 static inline unsigned int probe_irq_mask(unsigned long val)
663 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
664 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
665 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
668 #ifdef CONFIG_PROC_FS
669 /* Initialize /proc/irq/ */
670 extern void init_irq_proc(void);
672 static inline void init_irq_proc(void)
678 int show_interrupts(struct seq_file *p, void *v);
680 extern int early_irq_init(void);
681 extern int arch_probe_nr_irqs(void);
682 extern int arch_early_irq_init(void);