xref: /freebsd/sys/dev/mana/gdma_util.c (revision af23369a6deaaeb612ab266eb88b8bb8d560c322)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2021 Microsoft Corp.
5  * All rights reserved.
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  *
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  *
14  * 2. Redistributions in binary form must reproduce the above copyright
15  *    notice, this list of conditions and the following disclaimer in the
16  *    documentation and/or other materials provided with the distribution.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
32 
33 #include <sys/types.h>
34 #include <sys/mutex.h>
35 #include <sys/systm.h>
36 
37 #include "gdma_util.h"
38 
39 
40 void
41 init_completion(struct completion *c)
42 {
43 	memset(c, 0, sizeof(*c));
44 	mtx_init(&c->lock, "gdma_completion", NULL, MTX_DEF);
45 	c->done = 0;
46 }
47 
48 void
49 free_completion(struct completion *c)
50 {
51 	mtx_destroy(&c->lock);
52 }
53 
54 void
55 complete(struct completion *c)
56 {
57 	mtx_lock(&c->lock);
58 	c->done++;
59 	mtx_unlock(&c->lock);
60 	wakeup(c);
61 }
62 
63 void
64 wait_for_completion(struct completion *c)
65 {
66 	mtx_lock(&c->lock);
67 	while (c->done == 0)
68 		mtx_sleep(c, &c->lock, 0, "gdma_wfc", 0);
69 	c->done--;
70 	mtx_unlock(&c->lock);
71 }
72 
73 /*
74  * Return: 0 if completed, a non-zero value if timed out.
75  */
76 int
77 wait_for_completion_timeout(struct completion *c, int timeout)
78 {
79 	int ret;
80 
81 	mtx_lock(&c->lock);
82 
83 	if (c->done == 0)
84 		mtx_sleep(c, &c->lock, 0, "gdma_wfc", timeout);
85 
86 	if (c->done > 0) {
87 		c->done--;
88 		ret = 0;
89 	} else {
90 		ret = 1;
91 	}
92 
93 	mtx_unlock(&c->lock);
94 
95 	return (ret);
96 }
97