blob: 9fcabeb07787b75cef51e3c9118754b29ff41e03 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* interrupt.h */
2#ifndef _LINUX_INTERRUPT_H
3#define _LINUX_INTERRUPT_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/kernel.h>
6#include <linux/linkage.h>
7#include <linux/bitops.h>
8#include <linux/preempt.h>
9#include <linux/cpumask.h>
Jan Beulich908dcec2006-06-23 02:06:00 -070010#include <linux/irqreturn.h>
Thomas Gleixnerdd3a1db2008-10-16 18:20:58 +020011#include <linux/irqnr.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/hardirq.h>
Ingo Molnarde30a2b2006-07-03 00:24:42 -070013#include <linux/irqflags.h>
Peter Zijlstra9ba5f002009-07-22 14:18:35 +020014#include <linux/hrtimer.h>
Ben Hutchingscd7eab42011-01-19 21:01:44 +000015#include <linux/kref.h>
16#include <linux/workqueue.h>
Ingo Molnar0ebb26e2008-12-12 11:26:39 +010017
Arun Sharma600634972011-07-26 16:09:06 -070018#include <linux/atomic.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <asm/ptrace.h>
Frederic Weisbecker7d65f4a2013-09-05 15:49:45 +020020#include <asm/irq.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070021
Thomas Gleixner6e213612006-07-01 19:29:03 -070022/*
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 *
Thomas Gleixner6e213612006-07-01 19:29:03 -070042 * IRQF_SHARED - allow sharing the irq among several devices
43 * IRQF_PROBE_SHARED - set by callers when they expect sharing mismatches to occur
44 * IRQF_TIMER - Flag to mark this interrupt as timer interrupt
Thomas Gleixner950f4422007-02-16 01:27:24 -080045 * IRQF_PERCPU - Interrupt is per cpu
46 * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
Bernhard Walled85a60d2007-05-08 00:35:24 -070047 * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
48 * registered first in an shared interrupt is considered for
49 * performance reasons)
Thomas Gleixnerb25c3402009-08-13 12:17:22 +020050 * IRQF_ONESHOT - Interrupt is not reenabled after the hardirq handler finished.
51 * Used by threaded interrupts which need to keep the
52 * irq line disabled until the threaded handler has been run.
Mark Rutland737eb032015-02-20 14:53:46 +000053 * IRQF_NO_SUSPEND - Do not disable this IRQ during suspend. Does not guarantee
54 * that this interrupt will wake the system from a suspended
55 * state. See Documentation/power/suspend-and-interrupts.txt
Thomas Gleixnerdc5f2192011-02-04 13:19:20 +010056 * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
Thomas Gleixner0c4602f2011-02-23 23:52:18 +000057 * IRQF_NO_THREAD - Interrupt cannot be threaded
Ian Campbell9bab0b72011-10-03 15:37:00 +010058 * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
59 * resume time.
Rafael J. Wysocki17f48032015-02-27 00:07:55 +010060 * IRQF_COND_SUSPEND - If the IRQ is shared with a NO_SUSPEND user, execute this
61 * interrupt handler after suspending interrupts. For system
62 * wakeup devices users need to implement wakeup detection in
63 * their interrupt handlers.
Thomas Gleixner6e213612006-07-01 19:29:03 -070064 */
Thomas Gleixner6e213612006-07-01 19:29:03 -070065#define IRQF_SHARED 0x00000080
66#define IRQF_PROBE_SHARED 0x00000100
Ian Campbell685fd0b2010-07-29 11:16:32 +010067#define __IRQF_TIMER 0x00000200
Thomas Gleixner284c6682006-07-03 02:20:32 +020068#define IRQF_PERCPU 0x00000400
Thomas Gleixner950f4422007-02-16 01:27:24 -080069#define IRQF_NOBALANCING 0x00000800
Bernhard Walled85a60d2007-05-08 00:35:24 -070070#define IRQF_IRQPOLL 0x00001000
Thomas Gleixnerb25c3402009-08-13 12:17:22 +020071#define IRQF_ONESHOT 0x00002000
Ian Campbell685fd0b2010-07-29 11:16:32 +010072#define IRQF_NO_SUSPEND 0x00004000
Thomas Gleixnerdc5f2192011-02-04 13:19:20 +010073#define IRQF_FORCE_RESUME 0x00008000
Thomas Gleixner0c4602f2011-02-23 23:52:18 +000074#define IRQF_NO_THREAD 0x00010000
Ian Campbell9bab0b72011-10-03 15:37:00 +010075#define IRQF_EARLY_RESUME 0x00020000
Rafael J. Wysocki17f48032015-02-27 00:07:55 +010076#define IRQF_COND_SUSPEND 0x00040000
Ian Campbell685fd0b2010-07-29 11:16:32 +010077
Thomas Gleixner0c4602f2011-02-23 23:52:18 +000078#define IRQF_TIMER (__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
Thomas Gleixner3aa551c2009-03-23 18:28:15 +010079
Randy Dunlapb4e6b092010-05-21 09:03:01 -070080/*
Marc Zyngierae731f82010-03-15 22:56:33 +000081 * These values can be returned by request_any_context_irq() and
82 * describe the context the interrupt will be run in.
83 *
84 * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
85 * IRQC_IS_NESTED - interrupt runs in a nested threaded context
86 */
87enum {
88 IRQC_IS_HARDIRQ = 0,
89 IRQC_IS_NESTED,
90};
91
David Howells7d12e782006-10-05 14:55:46 +010092typedef irqreturn_t (*irq_handler_t)(int, void *);
David Howellsda482792006-10-05 13:06:34 +010093
Thomas Gleixnera9d0a1a2009-03-03 16:58:16 +010094/**
95 * struct irqaction - per interrupt action descriptor
96 * @handler: interrupt handler function
Thomas Gleixnera9d0a1a2009-03-03 16:58:16 +010097 * @name: name of the device
98 * @dev_id: cookie to identify the device
Marc Zyngier31d9d9b2011-09-23 17:03:06 +010099 * @percpu_dev_id: cookie to identify the device
Thomas Gleixnera9d0a1a2009-03-03 16:58:16 +0100100 * @next: pointer to the next irqaction for shared interrupts
101 * @irq: interrupt number
Thomas Gleixnerc0ecaa02012-04-19 11:53:25 +0200102 * @flags: flags (see IRQF_* above)
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300103 * @thread_fn: interrupt handler function for threaded interrupts
Thomas Gleixner3aa551c2009-03-23 18:28:15 +0100104 * @thread: thread pointer for threaded interrupts
Thomas Gleixner2a1d3ab2015-09-21 11:01:10 +0200105 * @secondary: pointer to secondary irqaction (force threading)
Thomas Gleixner3aa551c2009-03-23 18:28:15 +0100106 * @thread_flags: flags related to @thread
Thomas Gleixnerb5faba22011-02-23 23:52:13 +0000107 * @thread_mask: bitmask for keeping track of @thread activity
Thomas Gleixnerc0ecaa02012-04-19 11:53:25 +0200108 * @dir: pointer to the proc/irq/NN/name entry
Thomas Gleixnera9d0a1a2009-03-03 16:58:16 +0100109 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110struct irqaction {
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100111 irq_handler_t handler;
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100112 void *dev_id;
113 void __percpu *percpu_dev_id;
114 struct irqaction *next;
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100115 irq_handler_t thread_fn;
116 struct task_struct *thread;
Thomas Gleixner2a1d3ab2015-09-21 11:01:10 +0200117 struct irqaction *secondary;
Thomas Gleixnerc0ecaa02012-04-19 11:53:25 +0200118 unsigned int irq;
119 unsigned int flags;
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100120 unsigned long thread_flags;
121 unsigned long thread_mask;
122 const char *name;
123 struct proc_dir_entry *dir;
Eric Dumazetf6cd2472010-11-04 11:13:48 +0100124} ____cacheline_internodealigned_in_smp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
David Howells7d12e782006-10-05 14:55:46 +0100126extern irqreturn_t no_action(int cpl, void *dev_id);
Thomas Gleixner3aa551c2009-03-23 18:28:15 +0100127
Chen Fane237a552016-02-15 12:52:01 +0800128/*
129 * If a (PCI) device interrupt is not connected we set dev->irq to
130 * IRQ_NOTCONNECTED. This causes request_irq() to fail with -ENOTCONN, so we
131 * can distingiush that case from other error returns.
132 *
133 * 0x80000000 is guaranteed to be outside the available range of interrupts
134 * and easy to distinguish from other possible incorrect values.
135 */
136#define IRQ_NOTCONNECTED (1U << 31)
137
Thomas Gleixner3aa551c2009-03-23 18:28:15 +0100138extern int __must_check
139request_threaded_irq(unsigned int irq, irq_handler_t handler,
140 irq_handler_t thread_fn,
141 unsigned long flags, const char *name, void *dev);
142
143static inline int __must_check
144request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
145 const char *name, void *dev)
146{
147 return request_threaded_irq(irq, handler, NULL, flags, name, dev);
148}
149
Marc Zyngierae731f82010-03-15 22:56:33 +0000150extern int __must_check
151request_any_context_irq(unsigned int irq, irq_handler_t handler,
152 unsigned long flags, const char *name, void *dev_id);
153
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100154extern int __must_check
155request_percpu_irq(unsigned int irq, irq_handler_t handler,
156 const char *devname, void __percpu *percpu_dev_id);
Thomas Gleixner3aa551c2009-03-23 18:28:15 +0100157
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158extern void free_irq(unsigned int, void *);
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100159extern void free_percpu_irq(unsigned int, void __percpu *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160
Al Viro0af36782007-07-27 14:24:33 +0100161struct device;
162
Arjan van de Ven935bd5b2009-03-23 18:28:16 +0100163extern int __must_check
164devm_request_threaded_irq(struct device *dev, unsigned int irq,
165 irq_handler_t handler, irq_handler_t thread_fn,
166 unsigned long irqflags, const char *devname,
167 void *dev_id);
168
169static inline int __must_check
170devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
171 unsigned long irqflags, const char *devname, void *dev_id)
172{
173 return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
174 devname, dev_id);
175}
176
Stephen Boyd0668d302014-01-02 16:37:32 -0800177extern int __must_check
178devm_request_any_context_irq(struct device *dev, unsigned int irq,
179 irq_handler_t handler, unsigned long irqflags,
180 const char *devname, void *dev_id);
181
Tejun Heo9ac78492007-01-20 16:00:26 +0900182extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
183
Ingo Molnard7e96292006-07-03 00:24:27 -0700184/*
185 * On lockdep we dont want to enable hardirqs in hardirq
186 * context. Use local_irq_enable_in_hardirq() to annotate
187 * kernel code that has to do this nevertheless (pretty much
188 * the only valid case is for old/broken hardware that is
189 * insanely slow).
190 *
191 * NOTE: in theory this might break fragile code that relies
192 * on hardirq delivery - in practice we dont seem to have such
193 * places left. So the only effect should be slightly increased
194 * irqs-off latencies.
195 */
196#ifdef CONFIG_LOCKDEP
197# define local_irq_enable_in_hardirq() do { } while (0)
198#else
199# define local_irq_enable_in_hardirq() local_irq_enable()
200#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202extern void disable_irq_nosync(unsigned int irq);
Peter Zijlstra02cea392015-02-05 14:06:23 +0100203extern bool disable_hardirq(unsigned int irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204extern void disable_irq(unsigned int irq);
Marc Zyngier31d9d9b2011-09-23 17:03:06 +0100205extern void disable_percpu_irq(unsigned int irq);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206extern void enable_irq(unsigned int irq);
Marc Zyngier1e7c5fd2011-09-30 10:48:47 +0100207extern void enable_percpu_irq(unsigned int irq, unsigned int type);
Thomas Petazzonif0cb3222015-10-20 15:23:51 +0200208extern bool irq_percpu_is_enabled(unsigned int irq);
Thomas Gleixnera92444c2014-02-15 00:55:19 +0000209extern void irq_wake_thread(unsigned int irq, void *dev_id);
Thomas Gleixnerba9a2332006-06-29 02:24:55 -0700210
Rafael J. Wysocki0a0c5162009-03-16 22:33:49 +0100211/* The following three functions are for the core kernel use only. */
212extern void suspend_device_irqs(void);
213extern void resume_device_irqs(void);
Rafael J. Wysocki0a0c5162009-03-16 22:33:49 +0100214
Eyal Perryf0ba3d02014-05-20 17:57:00 +0300215/**
216 * struct irq_affinity_notify - context for notification of IRQ affinity changes
217 * @irq: Interrupt to which notification applies
218 * @kref: Reference count, for internal use
219 * @work: Work item, for internal use
220 * @notify: Function to be called on change. This will be
221 * called in process context.
222 * @release: Function to be called on release. This will be
223 * called in process context. Once registered, the
224 * structure must only be freed when this function is
225 * called or later.
226 */
227struct irq_affinity_notify {
228 unsigned int irq;
229 struct kref kref;
230 struct work_struct work;
231 void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
232 void (*release)(struct kref *ref);
233};
234
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200235#if defined(CONFIG_SMP)
Russell Kingd7b90682008-04-17 07:46:24 +0200236
Rusty Russelld036e672009-01-01 10:12:26 +1030237extern cpumask_var_t irq_default_affinity;
Max Krasnyansky18404752008-05-29 11:02:52 -0700238
Thomas Gleixner01f8fa42014-04-16 14:36:44 +0000239/* Internal implementation. Use the helpers below */
240extern int __irq_set_affinity(unsigned int irq, const struct cpumask *cpumask,
241 bool force);
242
243/**
244 * irq_set_affinity - Set the irq affinity of a given irq
245 * @irq: Interrupt to set affinity
Randy Dunlapdef5f122014-04-27 21:03:09 -0700246 * @cpumask: cpumask
Thomas Gleixner01f8fa42014-04-16 14:36:44 +0000247 *
248 * Fails if cpumask does not contain an online CPU
249 */
250static inline int
251irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
252{
253 return __irq_set_affinity(irq, cpumask, false);
254}
255
256/**
257 * irq_force_affinity - Force the irq affinity of a given irq
258 * @irq: Interrupt to set affinity
Randy Dunlapdef5f122014-04-27 21:03:09 -0700259 * @cpumask: cpumask
Thomas Gleixner01f8fa42014-04-16 14:36:44 +0000260 *
261 * Same as irq_set_affinity, but without checking the mask against
262 * online cpus.
263 *
264 * Solely for low level cpu hotplug code, where we need to make per
265 * cpu interrupts affine before the cpu becomes online.
266 */
267static inline int
268irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
269{
270 return __irq_set_affinity(irq, cpumask, true);
271}
272
Russell Kingd7b90682008-04-17 07:46:24 +0200273extern int irq_can_set_affinity(unsigned int irq);
Max Krasnyansky18404752008-05-29 11:02:52 -0700274extern int irq_select_affinity(unsigned int irq);
Russell Kingd7b90682008-04-17 07:46:24 +0200275
Peter P Waskiewicz Jre7a297b2010-04-30 14:44:50 -0700276extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
Ben Hutchingscd7eab42011-01-19 21:01:44 +0000277
Ben Hutchingscd7eab42011-01-19 21:01:44 +0000278extern int
279irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
280
Russell Kingd7b90682008-04-17 07:46:24 +0200281#else /* CONFIG_SMP */
282
Rusty Russell0de26522008-12-13 21:20:26 +1030283static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
Russell Kingd7b90682008-04-17 07:46:24 +0200284{
285 return -EINVAL;
286}
287
Arnd Bergmann4c88d7f2014-04-23 14:49:17 +0200288static inline int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
289{
290 return 0;
291}
292
Russell Kingd7b90682008-04-17 07:46:24 +0200293static inline int irq_can_set_affinity(unsigned int irq)
294{
295 return 0;
296}
297
Max Krasnyansky18404752008-05-29 11:02:52 -0700298static inline int irq_select_affinity(unsigned int irq) { return 0; }
299
Peter P Waskiewicz Jre7a297b2010-04-30 14:44:50 -0700300static inline int irq_set_affinity_hint(unsigned int irq,
Ben Hutchingscd7eab42011-01-19 21:01:44 +0000301 const struct cpumask *m)
Peter P Waskiewicz Jre7a297b2010-04-30 14:44:50 -0700302{
303 return -EINVAL;
304}
Eyal Perryf0ba3d02014-05-20 17:57:00 +0300305
306static inline int
307irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
308{
309 return 0;
310}
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200311#endif /* CONFIG_SMP */
Russell Kingd7b90682008-04-17 07:46:24 +0200312
Ingo Molnarc01d4032006-07-03 00:24:27 -0700313/*
314 * Special lockdep variants of irq disabling/enabling.
315 * These should be used for locking constructs that
316 * know that a particular irq context which is disabled,
317 * and which is the only irq-context user of a lock,
318 * that it's safe to take the lock in the irq-disabled
319 * section without disabling hardirqs.
320 *
321 * On !CONFIG_LOCKDEP they are equivalent to the normal
322 * irq disable/enable methods.
323 */
324static inline void disable_irq_nosync_lockdep(unsigned int irq)
325{
326 disable_irq_nosync(irq);
327#ifdef CONFIG_LOCKDEP
328 local_irq_disable();
329#endif
330}
331
Arjan van de Vene8106b92006-09-29 02:01:08 -0700332static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
333{
334 disable_irq_nosync(irq);
335#ifdef CONFIG_LOCKDEP
336 local_irq_save(*flags);
337#endif
338}
339
Ingo Molnarc01d4032006-07-03 00:24:27 -0700340static inline void disable_irq_lockdep(unsigned int irq)
341{
342 disable_irq(irq);
343#ifdef CONFIG_LOCKDEP
344 local_irq_disable();
345#endif
346}
347
348static inline void enable_irq_lockdep(unsigned int irq)
349{
350#ifdef CONFIG_LOCKDEP
351 local_irq_enable();
352#endif
353 enable_irq(irq);
354}
355
Arjan van de Vene8106b92006-09-29 02:01:08 -0700356static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
357{
358#ifdef CONFIG_LOCKDEP
359 local_irq_restore(*flags);
360#endif
361 enable_irq(irq);
362}
363
Thomas Gleixnerba9a2332006-06-29 02:24:55 -0700364/* IRQ wakeup (PM) control: */
Thomas Gleixnera0cd9ca2011-02-10 11:36:33 +0100365extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
366
Thomas Gleixnerba9a2332006-06-29 02:24:55 -0700367static inline int enable_irq_wake(unsigned int irq)
368{
Thomas Gleixnera0cd9ca2011-02-10 11:36:33 +0100369 return irq_set_irq_wake(irq, 1);
Thomas Gleixnerba9a2332006-06-29 02:24:55 -0700370}
371
372static inline int disable_irq_wake(unsigned int irq)
373{
Thomas Gleixnera0cd9ca2011-02-10 11:36:33 +0100374 return irq_set_irq_wake(irq, 0);
Thomas Gleixnerba9a2332006-06-29 02:24:55 -0700375}
376
Marc Zyngier1b7047e2015-03-18 11:01:22 +0000377/*
378 * irq_get_irqchip_state/irq_set_irqchip_state specific flags
379 */
380enum irqchip_irq_state {
381 IRQCHIP_STATE_PENDING, /* Is interrupt pending? */
382 IRQCHIP_STATE_ACTIVE, /* Is interrupt in progress? */
383 IRQCHIP_STATE_MASKED, /* Is interrupt masked? */
384 IRQCHIP_STATE_LINE_LEVEL, /* Is IRQ line high? */
385};
386
387extern int irq_get_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
388 bool *state);
389extern int irq_set_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
390 bool state);
Thomas Gleixner8d32a302011-02-23 23:52:23 +0000391
392#ifdef CONFIG_IRQ_FORCED_THREADING
393extern bool force_irqthreads;
394#else
395#define force_irqthreads (0)
396#endif
397
Andi Kleen3f744782005-09-12 18:49:24 +0200398#ifndef __ARCH_SET_SOFTIRQ_PENDING
399#define set_softirq_pending(x) (local_softirq_pending() = (x))
400#define or_softirq_pending(x) (local_softirq_pending() |= (x))
401#endif
402
Benjamin Herrenschmidt2d3fbbb2007-05-10 22:22:46 -0700403/* Some architectures might implement lazy enabling/disabling of
404 * interrupts. In some cases, such as stop_machine, we might want
405 * to ensure that after a local_irq_disable(), interrupts have
406 * really been disabled in hardware. Such architectures need to
407 * implement the following hook.
408 */
409#ifndef hard_irq_disable
410#define hard_irq_disable() do { } while(0)
411#endif
412
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413/* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
414 frequency threaded job scheduling. For almost all the purposes
415 tasklets are more than enough. F.e. all serial device BHs et
416 al. should be converted to tasklets, not to softirqs.
417 */
418
419enum
420{
421 HI_SOFTIRQ=0,
422 TIMER_SOFTIRQ,
423 NET_TX_SOFTIRQ,
424 NET_RX_SOFTIRQ,
Jens Axboeff856ba2006-01-09 16:02:34 +0100425 BLOCK_SOFTIRQ,
Christoph Hellwig511cbce2015-11-10 14:56:14 +0100426 IRQ_POLL_SOFTIRQ,
Christoph Lameterc9819f42006-12-10 02:20:25 -0800427 TASKLET_SOFTIRQ,
428 SCHED_SOFTIRQ,
Thomas Gleixnerc6eb3f72015-04-14 21:08:51 +0000429 HRTIMER_SOFTIRQ, /* Unused, but kept as tools rely on the
430 numbering. Sigh! */
Shaohua Li09223372011-06-14 13:26:25 +0800431 RCU_SOFTIRQ, /* Preferable RCU should always be the last softirq */
Alexey Dobriyan978b0112008-09-06 20:04:36 +0200432
433 NR_SOFTIRQS
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434};
435
Paul E. McKenney803b0eb2012-08-23 08:34:07 -0700436#define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
437
Jason Baron5d592b42009-03-12 14:33:36 -0400438/* map softirq index to softirq name. update 'softirq_to_name' in
439 * kernel/softirq.c when adding a new softirq.
440 */
Joe Perchesce85b4f2014-01-27 17:07:16 -0800441extern const char * const softirq_to_name[NR_SOFTIRQS];
Jason Baron5d592b42009-03-12 14:33:36 -0400442
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443/* softirq mask and active fields moved to irq_cpustat_t in
444 * asm/hardirq.h to get better cache usage. KAO
445 */
446
447struct softirq_action
448{
449 void (*action)(struct softirq_action *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450};
451
452asmlinkage void do_softirq(void);
Adrian Bunkeb0f1c42008-04-29 00:59:12 -0700453asmlinkage void __do_softirq(void);
Frederic Weisbecker7d65f4a2013-09-05 15:49:45 +0200454
455#ifdef __ARCH_HAS_DO_SOFTIRQ
456void do_softirq_own_stack(void);
457#else
458static inline void do_softirq_own_stack(void)
459{
460 __do_softirq();
461}
462#endif
463
Carlos R. Mafra962cf362008-05-15 11:15:37 -0300464extern void open_softirq(int nr, void (*action)(struct softirq_action *));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465extern void softirq_init(void);
Steven Rostedtf0696862012-01-25 20:18:55 -0500466extern void __raise_softirq_irqoff(unsigned int nr);
Lai Jiangshan2bf21602010-08-23 18:42:48 +0900467
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800468extern void raise_softirq_irqoff(unsigned int nr);
469extern void raise_softirq(unsigned int nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470
Venkatesh Pallipadi4dd53d82010-12-21 17:09:00 -0800471DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
472
473static inline struct task_struct *this_cpu_ksoftirqd(void)
474{
475 return this_cpu_read(ksoftirqd);
476}
477
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478/* Tasklets --- multithreaded analogue of BHs.
479
480 Main feature differing them of generic softirqs: tasklet
481 is running only on one CPU simultaneously.
482
483 Main feature differing them of BHs: different tasklets
484 may be run simultaneously on different CPUs.
485
486 Properties:
487 * If tasklet_schedule() is called, then tasklet is guaranteed
488 to be executed on some cpu at least once after this.
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300489 * If the tasklet is already scheduled, but its execution is still not
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 started, it will be executed only once.
491 * If this tasklet is already running on another CPU (or schedule is called
492 from tasklet itself), it is rescheduled for later.
493 * Tasklet is strictly serialized wrt itself, but not
494 wrt another tasklets. If client needs some intertask synchronization,
495 he makes it with spinlocks.
496 */
497
498struct tasklet_struct
499{
500 struct tasklet_struct *next;
501 unsigned long state;
502 atomic_t count;
503 void (*func)(unsigned long);
504 unsigned long data;
505};
506
507#define DECLARE_TASKLET(name, func, data) \
508struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(0), func, data }
509
510#define DECLARE_TASKLET_DISABLED(name, func, data) \
511struct tasklet_struct name = { NULL, 0, ATOMIC_INIT(1), func, data }
512
513
514enum
515{
516 TASKLET_STATE_SCHED, /* Tasklet is scheduled for execution */
517 TASKLET_STATE_RUN /* Tasklet is running (SMP only) */
518};
519
520#ifdef CONFIG_SMP
521static inline int tasklet_trylock(struct tasklet_struct *t)
522{
523 return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
524}
525
526static inline void tasklet_unlock(struct tasklet_struct *t)
527{
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100528 smp_mb__before_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529 clear_bit(TASKLET_STATE_RUN, &(t)->state);
530}
531
532static inline void tasklet_unlock_wait(struct tasklet_struct *t)
533{
534 while (test_bit(TASKLET_STATE_RUN, &(t)->state)) { barrier(); }
535}
536#else
537#define tasklet_trylock(t) 1
538#define tasklet_unlock_wait(t) do { } while (0)
539#define tasklet_unlock(t) do { } while (0)
540#endif
541
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800542extern void __tasklet_schedule(struct tasklet_struct *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544static inline void tasklet_schedule(struct tasklet_struct *t)
545{
546 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
547 __tasklet_schedule(t);
548}
549
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800550extern void __tasklet_hi_schedule(struct tasklet_struct *t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552static inline void tasklet_hi_schedule(struct tasklet_struct *t)
553{
554 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
555 __tasklet_hi_schedule(t);
556}
557
Vegard Nossum7c692cb2008-05-21 22:53:13 +0200558extern void __tasklet_hi_schedule_first(struct tasklet_struct *t);
559
560/*
561 * This version avoids touching any other tasklets. Needed for kmemcheck
562 * in order not to take any page faults while enqueueing this tasklet;
563 * consider VERY carefully whether you really need this or
564 * tasklet_hi_schedule()...
565 */
566static inline void tasklet_hi_schedule_first(struct tasklet_struct *t)
567{
568 if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
569 __tasklet_hi_schedule_first(t);
570}
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
573static inline void tasklet_disable_nosync(struct tasklet_struct *t)
574{
575 atomic_inc(&t->count);
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100576 smp_mb__after_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700577}
578
579static inline void tasklet_disable(struct tasklet_struct *t)
580{
581 tasklet_disable_nosync(t);
582 tasklet_unlock_wait(t);
583 smp_mb();
584}
585
586static inline void tasklet_enable(struct tasklet_struct *t)
587{
Peter Zijlstra4e857c52014-03-17 18:06:10 +0100588 smp_mb__before_atomic();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 atomic_dec(&t->count);
590}
591
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592extern void tasklet_kill(struct tasklet_struct *t);
593extern void tasklet_kill_immediate(struct tasklet_struct *t, unsigned int cpu);
594extern void tasklet_init(struct tasklet_struct *t,
595 void (*func)(unsigned long), unsigned long data);
596
Peter Zijlstra9ba5f002009-07-22 14:18:35 +0200597struct tasklet_hrtimer {
598 struct hrtimer timer;
599 struct tasklet_struct tasklet;
600 enum hrtimer_restart (*function)(struct hrtimer *);
601};
602
603extern void
604tasklet_hrtimer_init(struct tasklet_hrtimer *ttimer,
605 enum hrtimer_restart (*function)(struct hrtimer *),
606 clockid_t which_clock, enum hrtimer_mode mode);
607
608static inline
Thomas Gleixner61699e132015-04-14 21:09:23 +0000609void tasklet_hrtimer_start(struct tasklet_hrtimer *ttimer, ktime_t time,
610 const enum hrtimer_mode mode)
Peter Zijlstra9ba5f002009-07-22 14:18:35 +0200611{
Thomas Gleixner61699e132015-04-14 21:09:23 +0000612 hrtimer_start(&ttimer->timer, time, mode);
Peter Zijlstra9ba5f002009-07-22 14:18:35 +0200613}
614
615static inline
616void tasklet_hrtimer_cancel(struct tasklet_hrtimer *ttimer)
617{
618 hrtimer_cancel(&ttimer->timer);
619 tasklet_kill(&ttimer->tasklet);
620}
621
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622/*
623 * Autoprobing for irqs:
624 *
625 * probe_irq_on() and probe_irq_off() provide robust primitives
626 * for accurate IRQ probing during kernel initialization. They are
627 * reasonably simple to use, are not "fooled" by spurious interrupts,
628 * and, unlike other attempts at IRQ probing, they do not get hung on
629 * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
630 *
631 * For reasonably foolproof probing, use them as follows:
632 *
633 * 1. clear and/or mask the device's internal interrupt.
634 * 2. sti();
635 * 3. irqs = probe_irq_on(); // "take over" all unassigned idle IRQs
636 * 4. enable the device and cause it to trigger an interrupt.
637 * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
638 * 6. irq = probe_irq_off(irqs); // get IRQ number, 0=none, negative=multiple
639 * 7. service the device to clear its pending interrupt.
640 * 8. loop again if paranoia is required.
641 *
642 * probe_irq_on() returns a mask of allocated irq's.
643 *
644 * probe_irq_off() takes the mask as a parameter,
645 * and returns the irq number which occurred,
646 * or zero if none occurred, or a negative irq number
647 * if more than one irq occurred.
648 */
649
Martin Schwidefsky0244ad02013-08-30 09:39:53 +0200650#if !defined(CONFIG_GENERIC_IRQ_PROBE)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651static inline unsigned long probe_irq_on(void)
652{
653 return 0;
654}
655static inline int probe_irq_off(unsigned long val)
656{
657 return 0;
658}
659static inline unsigned int probe_irq_mask(unsigned long val)
660{
661 return 0;
662}
663#else
664extern unsigned long probe_irq_on(void); /* returns 0 on failure */
665extern int probe_irq_off(unsigned long); /* returns 0 or negative on failure */
666extern unsigned int probe_irq_mask(unsigned long); /* returns mask of ISA interrupts */
667#endif
668
Andrew Morton6168a702007-02-17 21:22:39 -0800669#ifdef CONFIG_PROC_FS
670/* Initialize /proc/irq/ */
671extern void init_irq_proc(void);
672#else
673static inline void init_irq_proc(void)
674{
675}
676#endif
677
Alexey Dobriyand43c36d2009-10-07 17:09:06 +0400678struct seq_file;
Adrian Bunkf74596d2008-02-06 01:36:35 -0800679int show_interrupts(struct seq_file *p, void *v);
Thomas Gleixnerc78b9b62010-12-16 17:21:47 +0100680int arch_show_interrupts(struct seq_file *p, int prec);
Adrian Bunkf74596d2008-02-06 01:36:35 -0800681
Yinghai Lu43a25632008-12-28 16:01:13 -0800682extern int early_irq_init(void);
Yinghai Lu4a046d12009-01-12 17:39:24 -0800683extern int arch_probe_nr_irqs(void);
Yinghai Lu43a25632008-12-28 16:01:13 -0800684extern int arch_early_irq_init(void);
Yinghai Lu43a25632008-12-28 16:01:13 -0800685
Alexander Potapenkobe7635e2016-03-25 14:22:05 -0700686#if defined(CONFIG_FUNCTION_GRAPH_TRACER) || defined(CONFIG_KASAN)
687/*
688 * We want to know which function is an entrypoint of a hardirq or a softirq.
689 */
690#define __irq_entry __attribute__((__section__(".irqentry.text")))
691#define __softirq_entry \
692 __attribute__((__section__(".softirqentry.text")))
693
694/* Limits of hardirq entrypoints */
695extern char __irqentry_text_start[];
696extern char __irqentry_text_end[];
697/* Limits of softirq entrypoints */
698extern char __softirqentry_text_start[];
699extern char __softirqentry_text_end[];
700
701#else
702#define __irq_entry
703#define __softirq_entry
704#endif
705
Linus Torvalds1da177e2005-04-16 15:20:36 -0700706#endif