xref: /freebsd/sys/compat/linuxkpi/common/include/linux/irq_work.h (revision 2e3f49888ec8851bafb22011533217487764fdb0)
1 /*-
2  * Copyright (c) 2020 The FreeBSD Foundation
3  *
4  * This software was developed by Emmanuel Vadot under sponsorship
5  * from the FreeBSD Foundation.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 #ifndef _LINUXKPI_LINUX_IRQ_WORK_H_
30 #define	_LINUXKPI_LINUX_IRQ_WORK_H_
31 
32 #include <sys/param.h>
33 #include <sys/taskqueue.h>
34 
35 #include <linux/llist.h>
36 #include <linux/workqueue.h>
37 
38 #define	LKPI_IRQ_WORK_STD_TQ	system_wq->taskqueue
39 #define	LKPI_IRQ_WORK_FAST_TQ	linux_irq_work_tq
40 
41 #ifdef LKPI_IRQ_WORK_USE_FAST_TQ
42 #define	LKPI_IRQ_WORK_TQ	LKPI_IRQ_WORK_FAST_TQ
43 #else
44 #define	LKPI_IRQ_WORK_TQ	LKPI_IRQ_WORK_STD_TQ
45 #endif
46 
47 struct irq_work;
48 typedef void (*irq_work_func_t)(struct irq_work *);
49 
50 struct irq_work {
51 	struct task irq_task;
52 	union {
53 		struct llist_node llnode;
54 		struct {
55 			struct llist_node llist;
56 		} node;
57 	};
58 	irq_work_func_t func;
59 };
60 
61 extern struct taskqueue *linux_irq_work_tq;
62 
63 #define	DEFINE_IRQ_WORK(name, _func)	struct irq_work name = {	\
64 	.irq_task = TASK_INITIALIZER(0, linux_irq_work_fn, &(name)),	\
65 	.func  = (_func),						\
66 }
67 
68 void	linux_irq_work_fn(void *, int);
69 
70 static inline void
71 init_irq_work(struct irq_work *irqw, irq_work_func_t func)
72 {
73 	TASK_INIT(&irqw->irq_task, 0, linux_irq_work_fn, irqw);
74 	irqw->func = func;
75 }
76 
77 static inline bool
78 irq_work_queue(struct irq_work *irqw)
79 {
80 	return (taskqueue_enqueue_flags(LKPI_IRQ_WORK_TQ, &irqw->irq_task,
81 	    TASKQUEUE_FAIL_IF_PENDING) == 0);
82 }
83 
84 static inline void
85 irq_work_sync(struct irq_work *irqw)
86 {
87 	taskqueue_drain(LKPI_IRQ_WORK_TQ, &irqw->irq_task);
88 }
89 
90 #endif /* _LINUXKPI_LINUX_IRQ_WORK_H_ */
91