xref: /linux-6.15/include/linux/interrupt.h (revision c2b1063e)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 /* interrupt.h */
3 #ifndef _LINUX_INTERRUPT_H
4 #define _LINUX_INTERRUPT_H
5 
6 #include <linux/kernel.h>
7 #include <linux/bitops.h>
8 #include <linux/cpumask.h>
9 #include <linux/irqreturn.h>
10 #include <linux/irqnr.h>
11 #include <linux/hardirq.h>
12 #include <linux/irqflags.h>
13 #include <linux/hrtimer.h>
14 #include <linux/kref.h>
15 #include <linux/workqueue.h>
16 
17 #include <linux/atomic.h>
18 #include <asm/ptrace.h>
19 #include <asm/irq.h>
20 #include <asm/sections.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_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
45  * IRQF_PERCPU - Interrupt is per cpu
46  * IRQF_NOBALANCING - Flag to exclude this interrupt from irq balancing
47  * IRQF_IRQPOLL - Interrupt is used for polling (only the interrupt that is
48  *                registered first in a shared interrupt is considered for
49  *                performance reasons)
50  * 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.
53  * 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.rst
56  * IRQF_FORCE_RESUME - Force enable it on resume even if IRQF_NO_SUSPEND is set
57  * IRQF_NO_THREAD - Interrupt cannot be threaded
58  * IRQF_EARLY_RESUME - Resume IRQ early during syscore instead of at device
59  *                resume time.
60  * 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.
64  * IRQF_NO_AUTOEN - Don't enable IRQ or NMI automatically when users request it.
65  *                Users will enable it explicitly by enable_irq() or enable_nmi()
66  *                later.
67  * IRQF_NO_DEBUG - Exclude from runnaway detection for IPI and similar handlers,
68  *		   depends on IRQF_PERCPU.
69  */
70 #define IRQF_SHARED		0x00000080
71 #define IRQF_PROBE_SHARED	0x00000100
72 #define __IRQF_TIMER		0x00000200
73 #define IRQF_PERCPU		0x00000400
74 #define IRQF_NOBALANCING	0x00000800
75 #define IRQF_IRQPOLL		0x00001000
76 #define IRQF_ONESHOT		0x00002000
77 #define IRQF_NO_SUSPEND		0x00004000
78 #define IRQF_FORCE_RESUME	0x00008000
79 #define IRQF_NO_THREAD		0x00010000
80 #define IRQF_EARLY_RESUME	0x00020000
81 #define IRQF_COND_SUSPEND	0x00040000
82 #define IRQF_NO_AUTOEN		0x00080000
83 #define IRQF_NO_DEBUG		0x00100000
84 
85 #define IRQF_TIMER		(__IRQF_TIMER | IRQF_NO_SUSPEND | IRQF_NO_THREAD)
86 
87 /*
88  * These values can be returned by request_any_context_irq() and
89  * describe the context the interrupt will be run in.
90  *
91  * IRQC_IS_HARDIRQ - interrupt runs in hardirq context
92  * IRQC_IS_NESTED - interrupt runs in a nested threaded context
93  */
94 enum {
95 	IRQC_IS_HARDIRQ	= 0,
96 	IRQC_IS_NESTED,
97 };
98 
99 typedef irqreturn_t (*irq_handler_t)(int, void *);
100 
101 /**
102  * struct irqaction - per interrupt action descriptor
103  * @handler:	interrupt handler function
104  * @name:	name of the device
105  * @dev_id:	cookie to identify the device
106  * @percpu_dev_id:	cookie to identify the device
107  * @next:	pointer to the next irqaction for shared interrupts
108  * @irq:	interrupt number
109  * @flags:	flags (see IRQF_* above)
110  * @thread_fn:	interrupt handler function for threaded interrupts
111  * @thread:	thread pointer for threaded interrupts
112  * @secondary:	pointer to secondary irqaction (force threading)
113  * @thread_flags:	flags related to @thread
114  * @thread_mask:	bitmask for keeping track of @thread activity
115  * @dir:	pointer to the proc/irq/NN/name entry
116  */
117 struct irqaction {
118 	irq_handler_t		handler;
119 	void			*dev_id;
120 	void __percpu		*percpu_dev_id;
121 	struct irqaction	*next;
122 	irq_handler_t		thread_fn;
123 	struct task_struct	*thread;
124 	struct irqaction	*secondary;
125 	unsigned int		irq;
126 	unsigned int		flags;
127 	unsigned long		thread_flags;
128 	unsigned long		thread_mask;
129 	const char		*name;
130 	struct proc_dir_entry	*dir;
131 } ____cacheline_internodealigned_in_smp;
132 
133 extern irqreturn_t no_action(int cpl, void *dev_id);
134 
135 /*
136  * If a (PCI) device interrupt is not connected we set dev->irq to
137  * IRQ_NOTCONNECTED. This causes request_irq() to fail with -ENOTCONN, so we
138  * can distingiush that case from other error returns.
139  *
140  * 0x80000000 is guaranteed to be outside the available range of interrupts
141  * and easy to distinguish from other possible incorrect values.
142  */
143 #define IRQ_NOTCONNECTED	(1U << 31)
144 
145 extern int __must_check
146 request_threaded_irq(unsigned int irq, irq_handler_t handler,
147 		     irq_handler_t thread_fn,
148 		     unsigned long flags, const char *name, void *dev);
149 
150 /**
151  * request_irq - Add a handler for an interrupt line
152  * @irq:	The interrupt line to allocate
153  * @handler:	Function to be called when the IRQ occurs.
154  *		Primary handler for threaded interrupts
155  *		If NULL, the default primary handler is installed
156  * @flags:	Handling flags
157  * @name:	Name of the device generating this interrupt
158  * @dev:	A cookie passed to the handler function
159  *
160  * This call allocates an interrupt and establishes a handler; see
161  * the documentation for request_threaded_irq() for details.
162  */
163 static inline int __must_check
164 request_irq(unsigned int irq, irq_handler_t handler, unsigned long flags,
165 	    const char *name, void *dev)
166 {
167 	return request_threaded_irq(irq, handler, NULL, flags, name, dev);
168 }
169 
170 extern int __must_check
171 request_any_context_irq(unsigned int irq, irq_handler_t handler,
172 			unsigned long flags, const char *name, void *dev_id);
173 
174 extern int __must_check
175 __request_percpu_irq(unsigned int irq, irq_handler_t handler,
176 		     unsigned long flags, const char *devname,
177 		     void __percpu *percpu_dev_id);
178 
179 extern int __must_check
180 request_nmi(unsigned int irq, irq_handler_t handler, unsigned long flags,
181 	    const char *name, void *dev);
182 
183 static inline int __must_check
184 request_percpu_irq(unsigned int irq, irq_handler_t handler,
185 		   const char *devname, void __percpu *percpu_dev_id)
186 {
187 	return __request_percpu_irq(irq, handler, 0,
188 				    devname, percpu_dev_id);
189 }
190 
191 extern int __must_check
192 request_percpu_nmi(unsigned int irq, irq_handler_t handler,
193 		   const char *devname, void __percpu *dev);
194 
195 extern const void *free_irq(unsigned int, void *);
196 extern void free_percpu_irq(unsigned int, void __percpu *);
197 
198 extern const void *free_nmi(unsigned int irq, void *dev_id);
199 extern void free_percpu_nmi(unsigned int irq, void __percpu *percpu_dev_id);
200 
201 struct device;
202 
203 extern int __must_check
204 devm_request_threaded_irq(struct device *dev, unsigned int irq,
205 			  irq_handler_t handler, irq_handler_t thread_fn,
206 			  unsigned long irqflags, const char *devname,
207 			  void *dev_id);
208 
209 static inline int __must_check
210 devm_request_irq(struct device *dev, unsigned int irq, irq_handler_t handler,
211 		 unsigned long irqflags, const char *devname, void *dev_id)
212 {
213 	return devm_request_threaded_irq(dev, irq, handler, NULL, irqflags,
214 					 devname, dev_id);
215 }
216 
217 extern int __must_check
218 devm_request_any_context_irq(struct device *dev, unsigned int irq,
219 		 irq_handler_t handler, unsigned long irqflags,
220 		 const char *devname, void *dev_id);
221 
222 extern void devm_free_irq(struct device *dev, unsigned int irq, void *dev_id);
223 
224 /*
225  * On lockdep we dont want to enable hardirqs in hardirq
226  * context. Use local_irq_enable_in_hardirq() to annotate
227  * kernel code that has to do this nevertheless (pretty much
228  * the only valid case is for old/broken hardware that is
229  * insanely slow).
230  *
231  * NOTE: in theory this might break fragile code that relies
232  * on hardirq delivery - in practice we dont seem to have such
233  * places left. So the only effect should be slightly increased
234  * irqs-off latencies.
235  */
236 #ifdef CONFIG_LOCKDEP
237 # define local_irq_enable_in_hardirq()	do { } while (0)
238 #else
239 # define local_irq_enable_in_hardirq()	local_irq_enable()
240 #endif
241 
242 bool irq_has_action(unsigned int irq);
243 extern void disable_irq_nosync(unsigned int irq);
244 extern bool disable_hardirq(unsigned int irq);
245 extern void disable_irq(unsigned int irq);
246 extern void disable_percpu_irq(unsigned int irq);
247 extern void enable_irq(unsigned int irq);
248 extern void enable_percpu_irq(unsigned int irq, unsigned int type);
249 extern bool irq_percpu_is_enabled(unsigned int irq);
250 extern void irq_wake_thread(unsigned int irq, void *dev_id);
251 
252 extern void disable_nmi_nosync(unsigned int irq);
253 extern void disable_percpu_nmi(unsigned int irq);
254 extern void enable_nmi(unsigned int irq);
255 extern void enable_percpu_nmi(unsigned int irq, unsigned int type);
256 extern int prepare_percpu_nmi(unsigned int irq);
257 extern void teardown_percpu_nmi(unsigned int irq);
258 
259 extern int irq_inject_interrupt(unsigned int irq);
260 
261 /* The following three functions are for the core kernel use only. */
262 extern void suspend_device_irqs(void);
263 extern void resume_device_irqs(void);
264 extern void rearm_wake_irq(unsigned int irq);
265 
266 /**
267  * struct irq_affinity_notify - context for notification of IRQ affinity changes
268  * @irq:		Interrupt to which notification applies
269  * @kref:		Reference count, for internal use
270  * @work:		Work item, for internal use
271  * @notify:		Function to be called on change.  This will be
272  *			called in process context.
273  * @release:		Function to be called on release.  This will be
274  *			called in process context.  Once registered, the
275  *			structure must only be freed when this function is
276  *			called or later.
277  */
278 struct irq_affinity_notify {
279 	unsigned int irq;
280 	struct kref kref;
281 	struct work_struct work;
282 	void (*notify)(struct irq_affinity_notify *, const cpumask_t *mask);
283 	void (*release)(struct kref *ref);
284 };
285 
286 #define	IRQ_AFFINITY_MAX_SETS  4
287 
288 /**
289  * struct irq_affinity - Description for automatic irq affinity assignements
290  * @pre_vectors:	Don't apply affinity to @pre_vectors at beginning of
291  *			the MSI(-X) vector space
292  * @post_vectors:	Don't apply affinity to @post_vectors at end of
293  *			the MSI(-X) vector space
294  * @nr_sets:		The number of interrupt sets for which affinity
295  *			spreading is required
296  * @set_size:		Array holding the size of each interrupt set
297  * @calc_sets:		Callback for calculating the number and size
298  *			of interrupt sets
299  * @priv:		Private data for usage by @calc_sets, usually a
300  *			pointer to driver/device specific data.
301  */
302 struct irq_affinity {
303 	unsigned int	pre_vectors;
304 	unsigned int	post_vectors;
305 	unsigned int	nr_sets;
306 	unsigned int	set_size[IRQ_AFFINITY_MAX_SETS];
307 	void		(*calc_sets)(struct irq_affinity *, unsigned int nvecs);
308 	void		*priv;
309 };
310 
311 /**
312  * struct irq_affinity_desc - Interrupt affinity descriptor
313  * @mask:	cpumask to hold the affinity assignment
314  * @is_managed: 1 if the interrupt is managed internally
315  */
316 struct irq_affinity_desc {
317 	struct cpumask	mask;
318 	unsigned int	is_managed : 1;
319 };
320 
321 #if defined(CONFIG_SMP)
322 
323 extern cpumask_var_t irq_default_affinity;
324 
325 /* Internal implementation. Use the helpers below */
326 extern int __irq_set_affinity(unsigned int irq, const struct cpumask *cpumask,
327 			      bool force);
328 
329 /**
330  * irq_set_affinity - Set the irq affinity of a given irq
331  * @irq:	Interrupt to set affinity
332  * @cpumask:	cpumask
333  *
334  * Fails if cpumask does not contain an online CPU
335  */
336 static inline int
337 irq_set_affinity(unsigned int irq, const struct cpumask *cpumask)
338 {
339 	return __irq_set_affinity(irq, cpumask, false);
340 }
341 
342 /**
343  * irq_force_affinity - Force the irq affinity of a given irq
344  * @irq:	Interrupt to set affinity
345  * @cpumask:	cpumask
346  *
347  * Same as irq_set_affinity, but without checking the mask against
348  * online cpus.
349  *
350  * Solely for low level cpu hotplug code, where we need to make per
351  * cpu interrupts affine before the cpu becomes online.
352  */
353 static inline int
354 irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
355 {
356 	return __irq_set_affinity(irq, cpumask, true);
357 }
358 
359 extern int irq_can_set_affinity(unsigned int irq);
360 extern int irq_select_affinity(unsigned int irq);
361 
362 extern int irq_set_affinity_hint(unsigned int irq, const struct cpumask *m);
363 extern int irq_update_affinity_desc(unsigned int irq,
364 				    struct irq_affinity_desc *affinity);
365 
366 extern int
367 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify);
368 
369 struct irq_affinity_desc *
370 irq_create_affinity_masks(unsigned int nvec, struct irq_affinity *affd);
371 
372 unsigned int irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
373 				       const struct irq_affinity *affd);
374 
375 #else /* CONFIG_SMP */
376 
377 static inline int irq_set_affinity(unsigned int irq, const struct cpumask *m)
378 {
379 	return -EINVAL;
380 }
381 
382 static inline int irq_force_affinity(unsigned int irq, const struct cpumask *cpumask)
383 {
384 	return 0;
385 }
386 
387 static inline int irq_can_set_affinity(unsigned int irq)
388 {
389 	return 0;
390 }
391 
392 static inline int irq_select_affinity(unsigned int irq)  { return 0; }
393 
394 static inline int irq_set_affinity_hint(unsigned int irq,
395 					const struct cpumask *m)
396 {
397 	return -EINVAL;
398 }
399 
400 static inline int irq_update_affinity_desc(unsigned int irq,
401 					   struct irq_affinity_desc *affinity)
402 {
403 	return -EINVAL;
404 }
405 
406 static inline int
407 irq_set_affinity_notifier(unsigned int irq, struct irq_affinity_notify *notify)
408 {
409 	return 0;
410 }
411 
412 static inline struct irq_affinity_desc *
413 irq_create_affinity_masks(unsigned int nvec, struct irq_affinity *affd)
414 {
415 	return NULL;
416 }
417 
418 static inline unsigned int
419 irq_calc_affinity_vectors(unsigned int minvec, unsigned int maxvec,
420 			  const struct irq_affinity *affd)
421 {
422 	return maxvec;
423 }
424 
425 #endif /* CONFIG_SMP */
426 
427 /*
428  * Special lockdep variants of irq disabling/enabling.
429  * These should be used for locking constructs that
430  * know that a particular irq context which is disabled,
431  * and which is the only irq-context user of a lock,
432  * that it's safe to take the lock in the irq-disabled
433  * section without disabling hardirqs.
434  *
435  * On !CONFIG_LOCKDEP they are equivalent to the normal
436  * irq disable/enable methods.
437  */
438 static inline void disable_irq_nosync_lockdep(unsigned int irq)
439 {
440 	disable_irq_nosync(irq);
441 #ifdef CONFIG_LOCKDEP
442 	local_irq_disable();
443 #endif
444 }
445 
446 static inline void disable_irq_nosync_lockdep_irqsave(unsigned int irq, unsigned long *flags)
447 {
448 	disable_irq_nosync(irq);
449 #ifdef CONFIG_LOCKDEP
450 	local_irq_save(*flags);
451 #endif
452 }
453 
454 static inline void disable_irq_lockdep(unsigned int irq)
455 {
456 	disable_irq(irq);
457 #ifdef CONFIG_LOCKDEP
458 	local_irq_disable();
459 #endif
460 }
461 
462 static inline void enable_irq_lockdep(unsigned int irq)
463 {
464 #ifdef CONFIG_LOCKDEP
465 	local_irq_enable();
466 #endif
467 	enable_irq(irq);
468 }
469 
470 static inline void enable_irq_lockdep_irqrestore(unsigned int irq, unsigned long *flags)
471 {
472 #ifdef CONFIG_LOCKDEP
473 	local_irq_restore(*flags);
474 #endif
475 	enable_irq(irq);
476 }
477 
478 /* IRQ wakeup (PM) control: */
479 extern int irq_set_irq_wake(unsigned int irq, unsigned int on);
480 
481 static inline int enable_irq_wake(unsigned int irq)
482 {
483 	return irq_set_irq_wake(irq, 1);
484 }
485 
486 static inline int disable_irq_wake(unsigned int irq)
487 {
488 	return irq_set_irq_wake(irq, 0);
489 }
490 
491 /*
492  * irq_get_irqchip_state/irq_set_irqchip_state specific flags
493  */
494 enum irqchip_irq_state {
495 	IRQCHIP_STATE_PENDING,		/* Is interrupt pending? */
496 	IRQCHIP_STATE_ACTIVE,		/* Is interrupt in progress? */
497 	IRQCHIP_STATE_MASKED,		/* Is interrupt masked? */
498 	IRQCHIP_STATE_LINE_LEVEL,	/* Is IRQ line high? */
499 };
500 
501 extern int irq_get_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
502 				 bool *state);
503 extern int irq_set_irqchip_state(unsigned int irq, enum irqchip_irq_state which,
504 				 bool state);
505 
506 #ifdef CONFIG_IRQ_FORCED_THREADING
507 # ifdef CONFIG_PREEMPT_RT
508 #  define force_irqthreads	(true)
509 # else
510 extern bool force_irqthreads;
511 # endif
512 #else
513 #define force_irqthreads	(0)
514 #endif
515 
516 #ifndef local_softirq_pending
517 
518 #ifndef local_softirq_pending_ref
519 #define local_softirq_pending_ref irq_stat.__softirq_pending
520 #endif
521 
522 #define local_softirq_pending()	(__this_cpu_read(local_softirq_pending_ref))
523 #define set_softirq_pending(x)	(__this_cpu_write(local_softirq_pending_ref, (x)))
524 #define or_softirq_pending(x)	(__this_cpu_or(local_softirq_pending_ref, (x)))
525 
526 #endif /* local_softirq_pending */
527 
528 /* Some architectures might implement lazy enabling/disabling of
529  * interrupts. In some cases, such as stop_machine, we might want
530  * to ensure that after a local_irq_disable(), interrupts have
531  * really been disabled in hardware. Such architectures need to
532  * implement the following hook.
533  */
534 #ifndef hard_irq_disable
535 #define hard_irq_disable()	do { } while(0)
536 #endif
537 
538 /* PLEASE, avoid to allocate new softirqs, if you need not _really_ high
539    frequency threaded job scheduling. For almost all the purposes
540    tasklets are more than enough. F.e. all serial device BHs et
541    al. should be converted to tasklets, not to softirqs.
542  */
543 
544 enum
545 {
546 	HI_SOFTIRQ=0,
547 	TIMER_SOFTIRQ,
548 	NET_TX_SOFTIRQ,
549 	NET_RX_SOFTIRQ,
550 	BLOCK_SOFTIRQ,
551 	IRQ_POLL_SOFTIRQ,
552 	TASKLET_SOFTIRQ,
553 	SCHED_SOFTIRQ,
554 	HRTIMER_SOFTIRQ,
555 	RCU_SOFTIRQ,    /* Preferable RCU should always be the last softirq */
556 
557 	NR_SOFTIRQS
558 };
559 
560 #define SOFTIRQ_STOP_IDLE_MASK (~(1 << RCU_SOFTIRQ))
561 
562 /* map softirq index to softirq name. update 'softirq_to_name' in
563  * kernel/softirq.c when adding a new softirq.
564  */
565 extern const char * const softirq_to_name[NR_SOFTIRQS];
566 
567 /* softirq mask and active fields moved to irq_cpustat_t in
568  * asm/hardirq.h to get better cache usage.  KAO
569  */
570 
571 struct softirq_action
572 {
573 	void	(*action)(struct softirq_action *);
574 };
575 
576 asmlinkage void do_softirq(void);
577 asmlinkage void __do_softirq(void);
578 
579 extern void open_softirq(int nr, void (*action)(struct softirq_action *));
580 extern void softirq_init(void);
581 extern void __raise_softirq_irqoff(unsigned int nr);
582 
583 extern void raise_softirq_irqoff(unsigned int nr);
584 extern void raise_softirq(unsigned int nr);
585 
586 DECLARE_PER_CPU(struct task_struct *, ksoftirqd);
587 
588 static inline struct task_struct *this_cpu_ksoftirqd(void)
589 {
590 	return this_cpu_read(ksoftirqd);
591 }
592 
593 /* Tasklets --- multithreaded analogue of BHs.
594 
595    This API is deprecated. Please consider using threaded IRQs instead:
596    https://lore.kernel.org/lkml/[email protected]
597 
598    Main feature differing them of generic softirqs: tasklet
599    is running only on one CPU simultaneously.
600 
601    Main feature differing them of BHs: different tasklets
602    may be run simultaneously on different CPUs.
603 
604    Properties:
605    * If tasklet_schedule() is called, then tasklet is guaranteed
606      to be executed on some cpu at least once after this.
607    * If the tasklet is already scheduled, but its execution is still not
608      started, it will be executed only once.
609    * If this tasklet is already running on another CPU (or schedule is called
610      from tasklet itself), it is rescheduled for later.
611    * Tasklet is strictly serialized wrt itself, but not
612      wrt another tasklets. If client needs some intertask synchronization,
613      he makes it with spinlocks.
614  */
615 
616 struct tasklet_struct
617 {
618 	struct tasklet_struct *next;
619 	unsigned long state;
620 	atomic_t count;
621 	bool use_callback;
622 	union {
623 		void (*func)(unsigned long data);
624 		void (*callback)(struct tasklet_struct *t);
625 	};
626 	unsigned long data;
627 };
628 
629 #define DECLARE_TASKLET(name, _callback)		\
630 struct tasklet_struct name = {				\
631 	.count = ATOMIC_INIT(0),			\
632 	.callback = _callback,				\
633 	.use_callback = true,				\
634 }
635 
636 #define DECLARE_TASKLET_DISABLED(name, _callback)	\
637 struct tasklet_struct name = {				\
638 	.count = ATOMIC_INIT(1),			\
639 	.callback = _callback,				\
640 	.use_callback = true,				\
641 }
642 
643 #define from_tasklet(var, callback_tasklet, tasklet_fieldname)	\
644 	container_of(callback_tasklet, typeof(*var), tasklet_fieldname)
645 
646 #define DECLARE_TASKLET_OLD(name, _func)		\
647 struct tasklet_struct name = {				\
648 	.count = ATOMIC_INIT(0),			\
649 	.func = _func,					\
650 }
651 
652 #define DECLARE_TASKLET_DISABLED_OLD(name, _func)	\
653 struct tasklet_struct name = {				\
654 	.count = ATOMIC_INIT(1),			\
655 	.func = _func,					\
656 }
657 
658 enum
659 {
660 	TASKLET_STATE_SCHED,	/* Tasklet is scheduled for execution */
661 	TASKLET_STATE_RUN	/* Tasklet is running (SMP only) */
662 };
663 
664 #if defined(CONFIG_SMP) || defined(CONFIG_PREEMPT_RT)
665 static inline int tasklet_trylock(struct tasklet_struct *t)
666 {
667 	return !test_and_set_bit(TASKLET_STATE_RUN, &(t)->state);
668 }
669 
670 void tasklet_unlock(struct tasklet_struct *t);
671 void tasklet_unlock_wait(struct tasklet_struct *t);
672 void tasklet_unlock_spin_wait(struct tasklet_struct *t);
673 
674 #else
675 static inline int tasklet_trylock(struct tasklet_struct *t) { return 1; }
676 static inline void tasklet_unlock(struct tasklet_struct *t) { }
677 static inline void tasklet_unlock_wait(struct tasklet_struct *t) { }
678 static inline void tasklet_unlock_spin_wait(struct tasklet_struct *t) { }
679 #endif
680 
681 extern void __tasklet_schedule(struct tasklet_struct *t);
682 
683 static inline void tasklet_schedule(struct tasklet_struct *t)
684 {
685 	if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
686 		__tasklet_schedule(t);
687 }
688 
689 extern void __tasklet_hi_schedule(struct tasklet_struct *t);
690 
691 static inline void tasklet_hi_schedule(struct tasklet_struct *t)
692 {
693 	if (!test_and_set_bit(TASKLET_STATE_SCHED, &t->state))
694 		__tasklet_hi_schedule(t);
695 }
696 
697 static inline void tasklet_disable_nosync(struct tasklet_struct *t)
698 {
699 	atomic_inc(&t->count);
700 	smp_mb__after_atomic();
701 }
702 
703 /*
704  * Do not use in new code. Disabling tasklets from atomic contexts is
705  * error prone and should be avoided.
706  */
707 static inline void tasklet_disable_in_atomic(struct tasklet_struct *t)
708 {
709 	tasklet_disable_nosync(t);
710 	tasklet_unlock_spin_wait(t);
711 	smp_mb();
712 }
713 
714 static inline void tasklet_disable(struct tasklet_struct *t)
715 {
716 	tasklet_disable_nosync(t);
717 	tasklet_unlock_wait(t);
718 	smp_mb();
719 }
720 
721 static inline void tasklet_enable(struct tasklet_struct *t)
722 {
723 	smp_mb__before_atomic();
724 	atomic_dec(&t->count);
725 }
726 
727 extern void tasklet_kill(struct tasklet_struct *t);
728 extern void tasklet_init(struct tasklet_struct *t,
729 			 void (*func)(unsigned long), unsigned long data);
730 extern void tasklet_setup(struct tasklet_struct *t,
731 			  void (*callback)(struct tasklet_struct *));
732 
733 /*
734  * Autoprobing for irqs:
735  *
736  * probe_irq_on() and probe_irq_off() provide robust primitives
737  * for accurate IRQ probing during kernel initialization.  They are
738  * reasonably simple to use, are not "fooled" by spurious interrupts,
739  * and, unlike other attempts at IRQ probing, they do not get hung on
740  * stuck interrupts (such as unused PS2 mouse interfaces on ASUS boards).
741  *
742  * For reasonably foolproof probing, use them as follows:
743  *
744  * 1. clear and/or mask the device's internal interrupt.
745  * 2. sti();
746  * 3. irqs = probe_irq_on();      // "take over" all unassigned idle IRQs
747  * 4. enable the device and cause it to trigger an interrupt.
748  * 5. wait for the device to interrupt, using non-intrusive polling or a delay.
749  * 6. irq = probe_irq_off(irqs);  // get IRQ number, 0=none, negative=multiple
750  * 7. service the device to clear its pending interrupt.
751  * 8. loop again if paranoia is required.
752  *
753  * probe_irq_on() returns a mask of allocated irq's.
754  *
755  * probe_irq_off() takes the mask as a parameter,
756  * and returns the irq number which occurred,
757  * or zero if none occurred, or a negative irq number
758  * if more than one irq occurred.
759  */
760 
761 #if !defined(CONFIG_GENERIC_IRQ_PROBE)
762 static inline unsigned long probe_irq_on(void)
763 {
764 	return 0;
765 }
766 static inline int probe_irq_off(unsigned long val)
767 {
768 	return 0;
769 }
770 static inline unsigned int probe_irq_mask(unsigned long val)
771 {
772 	return 0;
773 }
774 #else
775 extern unsigned long probe_irq_on(void);	/* returns 0 on failure */
776 extern int probe_irq_off(unsigned long);	/* returns 0 or negative on failure */
777 extern unsigned int probe_irq_mask(unsigned long);	/* returns mask of ISA interrupts */
778 #endif
779 
780 #ifdef CONFIG_PROC_FS
781 /* Initialize /proc/irq/ */
782 extern void init_irq_proc(void);
783 #else
784 static inline void init_irq_proc(void)
785 {
786 }
787 #endif
788 
789 #ifdef CONFIG_IRQ_TIMINGS
790 void irq_timings_enable(void);
791 void irq_timings_disable(void);
792 u64 irq_timings_next_event(u64 now);
793 #endif
794 
795 struct seq_file;
796 int show_interrupts(struct seq_file *p, void *v);
797 int arch_show_interrupts(struct seq_file *p, int prec);
798 
799 extern int early_irq_init(void);
800 extern int arch_probe_nr_irqs(void);
801 extern int arch_early_irq_init(void);
802 
803 /*
804  * We want to know which function is an entrypoint of a hardirq or a softirq.
805  */
806 #ifndef __irq_entry
807 # define __irq_entry	 __section(".irqentry.text")
808 #endif
809 
810 #define __softirq_entry  __section(".softirqentry.text")
811 
812 #endif
813