xref: /freebsd/sys/dev/mana/gdma_util.c (revision d0b2dbfa0ecf2bbc9709efc5e20baf8e4b44bbbf)
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 #include <sys/types.h>
32 #include <sys/mutex.h>
33 #include <sys/systm.h>
34 
35 #include "gdma_util.h"
36 
37 
38 void
39 init_completion(struct completion *c)
40 {
41 	memset(c, 0, sizeof(*c));
42 	mtx_init(&c->lock, "gdma_completion", NULL, MTX_DEF);
43 	c->done = 0;
44 }
45 
46 void
47 free_completion(struct completion *c)
48 {
49 	mtx_destroy(&c->lock);
50 }
51 
52 void
53 complete(struct completion *c)
54 {
55 	mtx_lock(&c->lock);
56 	c->done++;
57 	mtx_unlock(&c->lock);
58 	wakeup(c);
59 }
60 
61 void
62 wait_for_completion(struct completion *c)
63 {
64 	mtx_lock(&c->lock);
65 	while (c->done == 0)
66 		mtx_sleep(c, &c->lock, 0, "gdma_wfc", 0);
67 	c->done--;
68 	mtx_unlock(&c->lock);
69 }
70 
71 /*
72  * Return: 0 if completed, a non-zero value if timed out.
73  */
74 int
75 wait_for_completion_timeout(struct completion *c, int timeout)
76 {
77 	int ret;
78 
79 	mtx_lock(&c->lock);
80 
81 	if (c->done == 0)
82 		mtx_sleep(c, &c->lock, 0, "gdma_wfc", timeout);
83 
84 	if (c->done > 0) {
85 		c->done--;
86 		ret = 0;
87 	} else {
88 		ret = 1;
89 	}
90 
91 	mtx_unlock(&c->lock);
92 
93 	return (ret);
94 }
95