xref: /freebsd/sys/compat/linuxkpi/common/include/linux/iopoll.h (revision f126890ac5386406dadf7c4cfa9566cbb56537c5)
1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2020-2021 Bjoern A. Zeeb
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  */
27 
28 #ifndef	_LINUXKPI_LINUX_IOPOLL_H
29 #define	_LINUXKPI_LINUX_IOPOLL_H
30 
31 #include <sys/types.h>
32 #include <sys/time.h>
33 #include <linux/delay.h>
34 
35 #define	read_poll_timeout(_pollfp, _var, _cond, _us, _to, _early_sleep, ...)	\
36 ({										\
37 	struct timeval __now, __end;						\
38 	if (_to) {								\
39 		__end.tv_sec = (_to) / USEC_PER_SEC;				\
40 		__end.tv_usec = (_to) % USEC_PER_SEC;				\
41 		microtime(&__now);						\
42 		timevaladd(&__end, &__now);					\
43 	}									\
44 										\
45 	if ((_early_sleep) && (_us) > 0)					\
46 		usleep_range(_us, _us);						\
47 	do {									\
48 		(_var) = _pollfp(__VA_ARGS__);					\
49 		if (_cond)							\
50 			break;							\
51 		if (_to) {							\
52 			microtime(&__now);					\
53 			if (timevalcmp(&__now, &__end, >))			\
54 				break;						\
55 		}								\
56 		if ((_us) != 0)							\
57 			usleep_range(_us, _us);					\
58 	} while (1);								\
59 	(_cond) ? 0 : (-ETIMEDOUT);						\
60 })
61 
62 #define readx_poll_timeout(_pollfp, _addr, _var, _cond, _us, _to)		\
63 	read_poll_timeout(_pollfp, _var, _cond, _us, _to, false, _addr)
64 
65 #define	read_poll_timeout_atomic(_pollfp, _var, _cond, _us, _to, _early_sleep, ...)	\
66 ({										\
67 	struct timeval __now, __end;						\
68 	if (_to) {								\
69 		__end.tv_sec = (_to) / USEC_PER_SEC;				\
70 		__end.tv_usec = (_to) % USEC_PER_SEC;				\
71 		microtime(&__now);						\
72 		timevaladd(&__end, &__now);					\
73 	}									\
74 										\
75 	if ((_early_sleep) && (_us) > 0)					\
76 		DELAY(_us);							\
77 	do {									\
78 		(_var) = _pollfp(__VA_ARGS__);					\
79 		if (_cond)							\
80 			break;							\
81 		if (_to) {							\
82 			microtime(&__now);					\
83 			if (timevalcmp(&__now, &__end, >))			\
84 				break;						\
85 		}								\
86 		if ((_us) != 0)							\
87 			DELAY(_us);						\
88 	} while (1);								\
89 	(_cond) ? 0 : (-ETIMEDOUT);						\
90 })
91 
92 #endif	/* _LINUXKPI_LINUX_IOPOLL_H */
93