xref: /openbmc/linux/include/linux/irq_work.h (revision aa6159ab)
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_IRQ_WORK_H
3 #define _LINUX_IRQ_WORK_H
4 
5 #include <linux/smp_types.h>
6 
7 /*
8  * An entry can be in one of four states:
9  *
10  * free	     NULL, 0 -> {claimed}       : free to be used
11  * claimed   NULL, 3 -> {pending}       : claimed to be enqueued
12  * pending   next, 3 -> {busy}          : queued, pending callback
13  * busy      NULL, 2 -> {free, claimed} : callback in progress, can be claimed
14  */
15 
16 struct irq_work {
17 	struct __call_single_node node;
18 	void (*func)(struct irq_work *);
19 };
20 
21 #define __IRQ_WORK_INIT(_func, _flags) (struct irq_work){	\
22 	.node = { .u_flags = (_flags), },			\
23 	.func = (_func),					\
24 }
25 
26 #define IRQ_WORK_INIT(_func) __IRQ_WORK_INIT(_func, 0)
27 #define IRQ_WORK_INIT_LAZY(_func) __IRQ_WORK_INIT(_func, IRQ_WORK_LAZY)
28 #define IRQ_WORK_INIT_HARD(_func) __IRQ_WORK_INIT(_func, IRQ_WORK_HARD_IRQ)
29 
30 #define DEFINE_IRQ_WORK(name, _f)				\
31 	struct irq_work name = IRQ_WORK_INIT(_f)
32 
33 static inline
34 void init_irq_work(struct irq_work *work, void (*func)(struct irq_work *))
35 {
36 	*work = IRQ_WORK_INIT(func);
37 }
38 
39 static inline bool irq_work_is_pending(struct irq_work *work)
40 {
41 	return atomic_read(&work->node.a_flags) & IRQ_WORK_PENDING;
42 }
43 
44 static inline bool irq_work_is_busy(struct irq_work *work)
45 {
46 	return atomic_read(&work->node.a_flags) & IRQ_WORK_BUSY;
47 }
48 
49 bool irq_work_queue(struct irq_work *work);
50 bool irq_work_queue_on(struct irq_work *work, int cpu);
51 
52 void irq_work_tick(void);
53 void irq_work_sync(struct irq_work *work);
54 
55 #ifdef CONFIG_IRQ_WORK
56 #include <asm/irq_work.h>
57 
58 void irq_work_run(void);
59 bool irq_work_needs_cpu(void);
60 void irq_work_single(void *arg);
61 #else
62 static inline bool irq_work_needs_cpu(void) { return false; }
63 static inline void irq_work_run(void) { }
64 static inline void irq_work_single(void *arg) { }
65 #endif
66 
67 #endif /* _LINUX_IRQ_WORK_H */
68