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
10enum {
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 */
21struct 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	bool			destroyed;
29};
30
31/*
32 * init rxe_task structure
33 *	arg  => parameter to pass to fcn
34 *	func => function to call until it returns != 0
35 */
36int rxe_init_task(struct rxe_task *task, void *arg, int (*func)(void *));
37
38/* cleanup task */
39void rxe_cleanup_task(struct rxe_task *task);
40
41/*
42 * raw call to func in loop without any checking
43 * can call when tasklets are disabled
44 */
45int __rxe_do_task(struct rxe_task *task);
46
47/*
48 * common function called by any of the main tasklets
49 * If there is any chance that there is additional
50 * work to do someone must reschedule the task before
51 * leaving
52 */
53void rxe_do_task(struct tasklet_struct *t);
54
55/* run a task, else schedule it to run as a tasklet, The decision
56 * to run or schedule tasklet is based on the parameter sched.
57 */
58void rxe_run_task(struct rxe_task *task, int sched);
59
60/* keep a task from scheduling */
61void rxe_disable_task(struct rxe_task *task);
62
63/* allow task to run */
64void rxe_enable_task(struct rxe_task *task);
65
66#endif /* RXE_TASK_H */
67