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/hrtimer.h>
15 #include <linux/kref.h>
16 #include <linux/workqueue.h>
18 #include <linux/atomic.h>
19 #include <asm/ptrace.h>
21 #include <asm/sections.h>
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.
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
40 * These flags used only by the kernel as part of the
41 * irq handling routines.
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 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
52 * Used by threaded interrupts which need to keep the
53 * irq line disabled until the threaded handler has been run.
54 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend. Does not guarantee
55 * that this interrupt will wake the system from a suspended
56 * state. See Documentation/power/suspend-and-interrupts.txt
57 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
58 * IRQF_NO_THREAD - Interrupt cannot be threaded
59 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
61 * IRQF_COND_SUSPEND - If the IRQ is shared with a NO_SUSPEND user, execute this
62 * interrupt handler after suspending interrupts. For system
63 * wakeup devices users need to implement wakeup detection in
64 * their interrupt handlers.
66 #define IRQF_SHARED 0x00000080
67 #define IRQF_PROBE_SHARED 0x00000100
68 #define __IRQF_TIMER 0x00000200
69 #define IRQF_PERCPU 0x00000400
70 #define IRQF_NOBALANCING 0x00000800
71 #define IRQF_IRQPOLL 0x00001000
72 #define IRQF_ONESHOT 0x00002000
73 #define IRQF_NO_SUSPEND 0x00004000
74 #define IRQF_FORCE_RESUME 0x00008000
75 #define IRQF_NO_THREAD 0x00010000
76 #define IRQF_EARLY_RESUME 0x00020000
77 #define IRQF_COND_SUSPEND 0x00040000
79 #define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
82 * These values can be returned by request_any_context_irq() and
83 * describe the context the interrupt will be run in.
85 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
86 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
93 typedef irqreturn_t (*irq_handler_t
)(int, void *);
96 * struct irqaction - per interrupt action descriptor
97 * @handler: interrupt handler function
98 * @name: name of the device
99 * @dev_id: cookie to identify the device
100 * @percpu_dev_id: cookie to identify the device
101 * @next: pointer to the next irqaction for shared interrupts
102 * @irq: interrupt number
103 * @flags: flags (see IRQF_* above)
104 * @thread_fn: interrupt handler function for threaded interrupts
105 * @thread: thread pointer for threaded interrupts
106 * @secondary: pointer to secondary irqaction (force threading)
107 * @thread_flags: flags related to @thread
108 * @thread_mask: bitmask for keeping track of @thread activity
109 * @dir: pointer to the proc/irq/NN/name entry
112 irq_handler_t handler
;
114 void __percpu
*percpu_dev_id
;
115 struct irqaction
*next
;
116 irq_handler_t thread_fn
;
117 struct task_struct
*thread
;
118 struct irqaction
*secondary
;
121 unsigned long thread_flags
;
122 unsigned long thread_mask
;
124 struct proc_dir_entry
*dir
;
125 } ____cacheline_internodealigned_in_smp
;
127 extern irqreturn_t
no_action(int cpl
, void *dev_id
);
130 * If a (PCI) device interrupt is not connected we set dev->irq to
131 * IRQ_NOTCONNECTED. This causes request_irq() to fail with -ENOTCONN, so we
132 * can distingiush that case from other error returns.
134 * 0x80000000 is guaranteed to be outside the available range of interrupts
135 * and easy to distinguish from other possible incorrect values.
137 #define IRQ_NOTCONNECTED (1U << 31)
139 extern int __must_check
140 request_threaded_irq(unsigned int irq
, irq_handler_t handler
,
141 irq_handler_t thread_fn
,
142 unsigned long flags
, const char *name
, void *dev
);
144 static inline int __must_check
145 request_irq(unsigned int irq
, irq_handler_t handler
, unsigned long flags
,
146 const char *name
, void *dev
)
148 return request_threaded_irq(irq
, handler
, NULL
, flags
, name
, dev
);
151 extern int __must_check
152 request_any_context_irq(unsigned int irq
, irq_handler_t handler
,
153 unsigned long flags
, const char *name
, void *dev_id
);
155 extern int __must_check
156 __request_percpu_irq(unsigned int irq
, irq_handler_t handler
,
157 unsigned long flags
, const char *devname
,
158 void __percpu
*percpu_dev_id
);
160 static inline int __must_check
161 request_percpu_irq(unsigned int irq
, irq_handler_t handler
,
162 const char *devname
, void __percpu
*percpu_dev_id
)
164 return __request_percpu_irq(irq
, handler
, 0,
165 devname
, percpu_dev_id
);
168 extern const void *free_irq(unsigned int, void *);
169 extern void free_percpu_irq(unsigned int, void __percpu
*);
173 extern int __must_check
174 devm_request_threaded_irq(struct device
*dev
, unsigned int irq
,
175 irq_handler_t handler
, irq_handler_t thread_fn
,
176 unsigned long irqflags
, const char *devname
,
179 static inline int __must_check
180 devm_request_irq(struct device
*dev
, unsigned int irq
, irq_handler_t handler
,
181 unsigned long irqflags
, const char *devname
, void *dev_id
)
183 return devm_request_threaded_irq(dev
, irq
, handler
, NULL
, irqflags
,
187 extern int __must_check
188 devm_request_any_context_irq(struct device
*dev
, unsigned int irq
,
189 irq_handler_t handler
, unsigned long irqflags
,
190 const char *devname
, void *dev_id
);
192 extern void devm_free_irq(struct device
*dev
, unsigned int irq
, void *dev_id
);
195 * On lockdep we dont want to enable hardirqs in hardirq
196 * context. Use local_irq_enable_in_hardirq() to annotate
197 * kernel code that has to do this nevertheless (pretty much
198 * the only valid case is for old/broken hardware that is
201 * NOTE: in theory this might break fragile code that relies
202 * on hardirq delivery - in practice we dont seem to have such
203 * places left. So the only effect should be slightly increased
204 * irqs-off latencies.
206 #ifdef CONFIG_LOCKDEP
207 # define local_irq_enable_in_hardirq() do { } while (0)
209 # define local_irq_enable_in_hardirq() local_irq_enable()
212 extern void disable_irq_nosync(unsigned int irq
);
213 extern bool disable_hardirq(unsigned int irq
);
214 extern void disable_irq(unsigned int irq
);
215 extern void disable_percpu_irq(unsigned int irq
);
216 extern void enable_irq(unsigned int irq
);
217 extern void enable_percpu_irq(unsigned int irq
, unsigned int type
);
218 extern bool irq_percpu_is_enabled(unsigned int irq
);
219 extern void irq_wake_thread(unsigned int irq
, void *dev_id
);
221 /* The following three functions are for the core kernel use only. */
222 extern void suspend_device_irqs(void);
223 extern void resume_device_irqs(void);
226 * struct irq_affinity_notify - context for notification of IRQ affinity changes
227 * @irq: Interrupt to which notification applies
228 * @kref: Reference count, for internal use
229 * @work: Work item, for internal use
230 * @notify: Function to be called on change. This will be
231 * called in process context.
232 * @release: Function to be called on release. This will be
233 * called in process context. Once registered, the
234 * structure must only be freed when this function is
237 struct irq_affinity_notify
{
240 struct work_struct work
;
241 void (*notify
)(struct irq_affinity_notify
*, const cpumask_t
*mask
);
242 void (*release
)(struct kref
*ref
);
246 * struct irq_affinity - Description for automatic irq affinity assignements
247 * @pre_vectors: Don't apply affinity to @pre_vectors at beginning of
248 * the MSI(-X) vector space
249 * @post_vectors: Don't apply affinity to @post_vectors at end of
250 * the MSI(-X) vector space
252 struct irq_affinity
{
257 #if defined(CONFIG_SMP)
259 extern cpumask_var_t irq_default_affinity
;
261 /* Internal implementation. Use the helpers below */
262 extern int __irq_set_affinity(unsigned int irq
, const struct cpumask
*cpumask
,
266 * irq_set_affinity - Set the irq affinity of a given irq
267 * @irq: Interrupt to set affinity
270 * Fails if cpumask does not contain an online CPU
273 irq_set_affinity(unsigned int irq
, const struct cpumask
*cpumask
)
275 return __irq_set_affinity(irq
, cpumask
, false);
279 * irq_force_affinity - Force the irq affinity of a given irq
280 * @irq: Interrupt to set affinity
283 * Same as irq_set_affinity, but without checking the mask against
286 * Solely for low level cpu hotplug code, where we need to make per
287 * cpu interrupts affine before the cpu becomes online.
290 irq_force_affinity(unsigned int irq
, const struct cpumask
*cpumask
)
292 return __irq_set_affinity(irq
, cpumask
, true);
295 extern int irq_can_set_affinity(unsigned int irq
);
296 extern int irq_select_affinity(unsigned int irq
);
298 extern int irq_set_affinity_hint(unsigned int irq
, const struct cpumask
*m
);
301 irq_set_affinity_notifier(unsigned int irq
, struct irq_affinity_notify
*notify
);
303 struct cpumask
*irq_create_affinity_masks(int nvec
, const struct irq_affinity
*affd
);
304 int irq_calc_affinity_vectors(int minvec
, int maxvec
, const struct irq_affinity
*affd
);
306 #else /* CONFIG_SMP */
308 static inline int irq_set_affinity(unsigned int irq
, const struct cpumask
*m
)
313 static inline int irq_force_affinity(unsigned int irq
, const struct cpumask
*cpumask
)
318 static inline int irq_can_set_affinity(unsigned int irq
)
323 static inline int irq_select_affinity(unsigned int irq
) { return 0; }
325 static inline int irq_set_affinity_hint(unsigned int irq
,
326 const struct cpumask
*m
)
332 irq_set_affinity_notifier(unsigned int irq
, struct irq_affinity_notify
*notify
)
337 static inline struct cpumask
*
338 irq_create_affinity_masks(int nvec
, const struct irq_affinity
*affd
)
344 irq_calc_affinity_vectors(int minvec
, int maxvec
, const struct irq_affinity
*affd
)
349 #endif /* CONFIG_SMP */
352 * Special lockdep variants of irq disabling/enabling.
353 * These should be used for locking constructs that
354 * know that a particular irq context which is disabled,
355 * and which is the only irq-context user of a lock,
356 * that it's safe to take the lock in the irq-disabled
357 * section without disabling hardirqs.
359 * On !CONFIG_LOCKDEP they are equivalent to the normal
360 * irq disable/enable methods.
362 static inline void disable_irq_nosync_lockdep(unsigned int irq
)
364 disable_irq_nosync(irq
);
365 #ifdef CONFIG_LOCKDEP
370 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq
, unsigned long *flags
)
372 disable_irq_nosync(irq
);
373 #ifdef CONFIG_LOCKDEP
374 local_irq_save(*flags
);
378 static inline void disable_irq_lockdep(unsigned int irq
)
381 #ifdef CONFIG_LOCKDEP
386 static inline void enable_irq_lockdep(unsigned int irq
)
388 #ifdef CONFIG_LOCKDEP
394 static inline void enable_irq_lockdep_irqrestore(unsigned int irq
, unsigned long *flags
)
396 #ifdef CONFIG_LOCKDEP
397 local_irq_restore(*flags
);
402 /* IRQ wakeup (PM) control: */
403 extern int irq_set_irq_wake(unsigned int irq
, unsigned int on
);
405 static inline int enable_irq_wake(unsigned int irq
)
407 return irq_set_irq_wake(irq
, 1);
410 static inline int disable_irq_wake(unsigned int irq
)
412 return irq_set_irq_wake(irq
, 0);
416 * irq_get_irqchip_state/irq_set_irqchip_state specific flags
418 enum irqchip_irq_state
{
419 IRQCHIP_STATE_PENDING
, /* Is interrupt pending? */
420 IRQCHIP_STATE_ACTIVE
, /* Is interrupt in progress? */
421 IRQCHIP_STATE_MASKED
, /* Is interrupt masked? */
422 IRQCHIP_STATE_LINE_LEVEL
, /* Is IRQ line high? */
425 extern int irq_get_irqchip_state(unsigned int irq
, enum irqchip_irq_state which
,
427 extern int irq_set_irqchip_state(unsigned int irq
, enum irqchip_irq_state which
,
430 #ifdef CONFIG_IRQ_FORCED_THREADING
431 extern bool force_irqthreads
;
433 #define force_irqthreads (0)
436 #ifndef __ARCH_SET_SOFTIRQ_PENDING
437 #define set_softirq_pending(x) (local_softirq_pending() = (x))
438 #define or_softirq_pending(x) (local_softirq_pending() |= (x))
441 /* Some architectures might implement lazy enabling/disabling of
442 * interrupts. In some cases, such as stop_machine, we might want
443 * to ensure that after a local_irq_disable(), interrupts have
444 * really been disabled in hardware. Such architectures need to
445 * implement the following hook.
447 #ifndef hard_irq_disable
448 #define hard_irq_disable() do { } while(0)
451 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
452 frequency threaded job scheduling. For almost all the purposes
453 tasklets are more than enough. F.e. all serial device BHs et
454 al. should be converted to tasklets, not to softirqs.
467 HRTIMER_SOFTIRQ
, /* Unused, but kept as tools rely on the
469 RCU_SOFTIRQ
, /* Preferable RCU should always be the last softirq */
474 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
476 /* map softirq index to softirq name. update 'softirq_to_name' in
477 * kernel/softirq.c when adding a new softirq.
479 extern const char * const softirq_to_name
[NR_SOFTIRQS
];
481 /* softirq mask and active fields moved to irq_cpustat_t in
482 * asm/hardirq.h to get better cache usage. KAO
485 struct softirq_action
487 void (*action
)(struct softirq_action
*);
490 asmlinkage
void do_softirq(void);
491 asmlinkage
void __do_softirq(void);
493 #ifdef __ARCH_HAS_DO_SOFTIRQ
494 void do_softirq_own_stack(void);
496 static inline void do_softirq_own_stack(void)
502 extern void open_softirq(int nr
, void (*action
)(struct softirq_action
*));
503 extern void softirq_init(void);
504 extern void __raise_softirq_irqoff(unsigned int nr
);
506 extern void raise_softirq_irqoff(unsigned int nr
);
507 extern void raise_softirq(unsigned int nr
);
509 DECLARE_PER_CPU(struct task_struct
*, ksoftirqd
);
511 static inline struct task_struct
*this_cpu_ksoftirqd(void)
513 return this_cpu_read(ksoftirqd
);
516 /* Tasklets --- multithreaded analogue of BHs.
518 Main feature differing them of generic softirqs: tasklet
519 is running only on one CPU simultaneously.
521 Main feature differing them of BHs: different tasklets
522 may be run simultaneously on different CPUs.
525 * If tasklet_schedule() is called, then tasklet is guaranteed
526 to be executed on some cpu at least once after this.
527 * If the tasklet is already scheduled, but its execution is still not
528 started, it will be executed only once.
529 * If this tasklet is already running on another CPU (or schedule is called
530 from tasklet itself), it is rescheduled for later.
531 * Tasklet is strictly serialized wrt itself, but not
532 wrt another tasklets. If client needs some intertask synchronization,
533 he makes it with spinlocks.
536 struct tasklet_struct
538 struct tasklet_struct
*next
;
541 void (*func
)(unsigned long);
545 #define DECLARE_TASKLET(name, func, data) \
546 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
548 #define DECLARE_TASKLET_DISABLED(name, func, data) \
549 struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
554 TASKLET_STATE_SCHED
, /* Tasklet is scheduled for execution */
555 TASKLET_STATE_RUN
/* Tasklet is running (SMP only) */
559 static inline int tasklet_trylock(struct tasklet_struct
*t
)
561 return !test_and_set_bit(TASKLET_STATE_RUN
, &(t
)->state
);
564 static inline void tasklet_unlock(struct tasklet_struct
*t
)
566 smp_mb__before_atomic();
567 clear_bit(TASKLET_STATE_RUN
, &(t
)->state
);
570 static inline void tasklet_unlock_wait(struct tasklet_struct
*t
)
572 while (test_bit(TASKLET_STATE_RUN
, &(t
)->state
)) { barrier(); }
575 #define tasklet_trylock(t) 1
576 #define tasklet_unlock_wait(t) do { } while (0)
577 #define tasklet_unlock(t) do { } while (0)
580 extern void __tasklet_schedule(struct tasklet_struct
*t
);
582 static inline void tasklet_schedule(struct tasklet_struct
*t
)
584 if (!test_and_set_bit(TASKLET_STATE_SCHED
, &t
->state
))
585 __tasklet_schedule(t
);
588 extern void __tasklet_hi_schedule(struct tasklet_struct
*t
);
590 static inline void tasklet_hi_schedule(struct tasklet_struct
*t
)
592 if (!test_and_set_bit(TASKLET_STATE_SCHED
, &t
->state
))
593 __tasklet_hi_schedule(t
);
596 extern void __tasklet_hi_schedule_first(struct tasklet_struct
*t
);
599 * This version avoids touching any other tasklets. Needed for kmemcheck
600 * in order not to take any page faults while enqueueing this tasklet;
601 * consider VERY carefully whether you really need this or
602 * tasklet_hi_schedule()...
604 static inline void tasklet_hi_schedule_first(struct tasklet_struct
*t
)
606 if (!test_and_set_bit(TASKLET_STATE_SCHED
, &t
->state
))
607 __tasklet_hi_schedule_first(t
);
611 static inline void tasklet_disable_nosync(struct tasklet_struct
*t
)
613 atomic_inc(&t
->count
);
614 smp_mb__after_atomic();
617 static inline void tasklet_disable(struct tasklet_struct
*t
)
619 tasklet_disable_nosync(t
);
620 tasklet_unlock_wait(t
);
624 static inline void tasklet_enable(struct tasklet_struct
*t
)
626 smp_mb__before_atomic();
627 atomic_dec(&t
->count
);
630 extern void tasklet_kill(struct tasklet_struct
*t
);
631 extern void tasklet_kill_immediate(struct tasklet_struct
*t
, unsigned int cpu
);
632 extern void tasklet_init(struct tasklet_struct
*t
,
633 void (*func
)(unsigned long), unsigned long data
);
635 struct tasklet_hrtimer
{
636 struct hrtimer timer
;
637 struct tasklet_struct tasklet
;
638 enum hrtimer_restart (*function
)(struct hrtimer
*);
642 tasklet_hrtimer_init(struct tasklet_hrtimer
*ttimer
,
643 enum hrtimer_restart (*function
)(struct hrtimer
*),
644 clockid_t which_clock
, enum hrtimer_mode mode
);
647 void tasklet_hrtimer_start(struct tasklet_hrtimer
*ttimer
, ktime_t time
,
648 const enum hrtimer_mode mode
)
650 hrtimer_start(&ttimer
->timer
, time
, mode
);
654 void tasklet_hrtimer_cancel(struct tasklet_hrtimer
*ttimer
)
656 hrtimer_cancel(&ttimer
->timer
);
657 tasklet_kill(&ttimer
->tasklet
);
661 * Autoprobing for irqs:
663 * probe_irq_on() and probe_irq_off() provide robust primitives
664 * for accurate IRQ probing during kernel initialization. They are
665 * reasonably simple to use, are not "fooled" by spurious interrupts,
666 * and, unlike other attempts at IRQ probing, they do not get hung on
667 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
669 * For reasonably foolproof probing, use them as follows:
671 * 1. clear and/or mask the device's internal interrupt.
673 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
674 * 4. enable the device and cause it to trigger an interrupt.
675 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
676 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
677 * 7. service the device to clear its pending interrupt.
678 * 8. loop again if paranoia is required.
680 * probe_irq_on() returns a mask of allocated irq's.
682 * probe_irq_off() takes the mask as a parameter,
683 * and returns the irq number which occurred,
684 * or zero if none occurred, or a negative irq number
685 * if more than one irq occurred.
688 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
689 static inline unsigned long probe_irq_on(void)
693 static inline int probe_irq_off(unsigned long val
)
697 static inline unsigned int probe_irq_mask(unsigned long val
)
702 extern unsigned long probe_irq_on(void); /* returns 0 on failure */
703 extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
704 extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
707 #ifdef CONFIG_PROC_FS
708 /* Initialize /proc/irq/ */
709 extern void init_irq_proc(void);
711 static inline void init_irq_proc(void)
716 #ifdef CONFIG_IRQ_TIMINGS
717 void irq_timings_enable(void);
718 void irq_timings_disable(void);
719 u64
irq_timings_next_event(u64 now
);
723 int show_interrupts(struct seq_file
*p
, void *v
);
724 int arch_show_interrupts(struct seq_file
*p
, int prec
);
726 extern int early_irq_init(void);
727 extern int arch_probe_nr_irqs(void);
728 extern int arch_early_irq_init(void);
731 * We want to know which function is an entrypoint of a hardirq or a softirq.
733 #define __irq_entry __attribute__((__section__(".irqentry.text")))
734 #define __softirq_entry \
735 __attribute__((__section__(".softirqentry.text")))