1 /* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
2 /*
3  * Copyright (c) 2016 Mellanox Technologies Ltd. All rights reserved.
4  * Copyright (c) 2015 System Fabric Works, Inc. All rights reserved.
5  */
6 
7 #ifndef RXE_TASK_H
8 #define RXE_TASK_H
9 
10 enum {
11 	TASK_STATE_START	= 0,
12 	TASK_STATE_BUSY		= 1,
13 	TASK_STATE_ARMED	= 2,
14 };
15 
16 /*
17  * data structure to describe a 'task' which is a short
18  * function that returns 0 as long as it needs to be
19  * called again.
20  */
21 struct rxe_task {
22 	struct tasklet_struct	tasklet;
23 	int			state;
24 	spinlock_t		state_lock; /* spinlock for task state */
25 	void			*arg;
26 	int			(*func)(void *arg);
27 	int			ret;
28 	char			name[16];
29 	bool			destroyed;
30 };
31 
32 /*
33  * init rxe_task structure
34  *	arg  => parameter to pass to fcn
35  *	func => function to call until it returns != 0
36  */
37 int rxe_init_task(struct rxe_task *task,
38 		  void *arg, int (*func)(void *), char *name);
39 
40 /* cleanup task */
41 void rxe_cleanup_task(struct rxe_task *task);
42 
43 /*
44  * raw call to func in loop without any checking
45  * can call when tasklets are disabled
46  */
47 int __rxe_do_task(struct rxe_task *task);
48 
49 /*
50  * common function called by any of the main tasklets
51  * If there is any chance that there is additional
52  * work to do someone must reschedule the task before
53  * leaving
54  */
55 void rxe_do_task(struct tasklet_struct *t);
56 
57 /* run a task, else schedule it to run as a tasklet, The decision
58  * to run or schedule tasklet is based on the parameter sched.
59  */
60 void rxe_run_task(struct rxe_task *task, int sched);
61 
62 /* keep a task from scheduling */
63 void rxe_disable_task(struct rxe_task *task);
64 
65 /* allow task to run */
66 void rxe_enable_task(struct rxe_task *task);
67 
68 #endif /* RXE_TASK_H */
69