xref: /freebsd/sys/compat/linuxkpi/common/include/linux/irq_work.h (revision bec4576e4c194a3b3bc8fb8cce613d7088dbfb2c)
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  * $FreeBSD$
29  */
30 
31 #ifndef _LINUXKPI_LINUX_IRQ_WORK_H_
32 #define	_LINUXKPI_LINUX_IRQ_WORK_H_
33 
34 #include <sys/param.h>
35 #include <sys/taskqueue.h>
36 
37 #include <linux/llist.h>
38 
39 struct irq_work;
40 typedef void (*irq_work_func_t)(struct irq_work *);
41 
42 struct irq_work {
43 	struct task irq_task;
44 	struct llist_node llnode;
45 	irq_work_func_t func;
46 };
47 
48 extern struct taskqueue *linux_irq_work_tq;
49 
50 #define	DEFINE_IRQ_WORK(name, _func)	struct irq_work name = {	\
51 	.irq_task = TASK_INITIALIZER(0, linux_irq_work_fn, &(name)),	\
52 	.func  = (_func),						\
53 }
54 
55 void	linux_irq_work_fn(void *, int);
56 
57 static inline void
58 init_irq_work(struct irq_work *irqw, irq_work_func_t func)
59 {
60 	TASK_INIT(&irqw->irq_task, 0, linux_irq_work_fn, irqw);
61 	irqw->func = func;
62 }
63 
64 static inline bool
65 irq_work_queue(struct irq_work *irqw)
66 {
67 	return (taskqueue_enqueue_flags(linux_irq_work_tq, &irqw->irq_task,
68 	    TASKQUEUE_FAIL_IF_PENDING) == 0);
69 }
70 
71 static inline void
72 irq_work_sync(struct irq_work *irqw)
73 {
74 	taskqueue_drain(linux_irq_work_tq, &irqw->irq_task);
75 }
76 
77 #endif /* _LINUXKPI_LINUX_IRQ_WORK_H_ */
78