xref: /freebsd/sys/compat/linuxkpi/common/include/linux/hrtimer.h (revision 4b330699f819a81d8e34d471225143ffeb321855)
1 /*-
2  * Copyright (c) 2017 Mark Johnston <markj@FreeBSD.org>
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice unmodified, this list of conditions, and the following
10  *    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 ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  *
26  * $FreeBSD$
27  */
28 
29 #ifndef _LINUX_HRTIMER_H_
30 #define	_LINUX_HRTIMER_H_
31 
32 #include <sys/_callout.h>
33 #include <sys/_mutex.h>
34 
35 #include <linux/ktime.h>
36 #include <linux/timer.h>
37 
38 enum hrtimer_mode {
39 	HRTIMER_MODE_REL,
40 };
41 
42 enum hrtimer_restart {
43 	HRTIMER_RESTART,
44 	HRTIMER_NORESTART,
45 };
46 
47 struct hrtimer {
48 	enum hrtimer_restart (*function)(struct hrtimer *);
49 	struct mtx mtx;
50 	struct callout callout;
51 	uint32_t flags;
52 };
53 
54 #define	hrtimer_active(hrtimer)	linux_hrtimer_active(hrtimer)
55 #define	hrtimer_cancel(hrtimer)	linux_hrtimer_cancel(hrtimer)
56 #define	hrtimer_init(hrtimer, clock, mode) do {			\
57 	CTASSERT((clock) == CLOCK_MONOTONIC);			\
58 	CTASSERT((mode) == HRTIMER_MODE_REL);			\
59 	linux_hrtimer_init(hrtimer);				\
60 } while (0)
61 #define	hrtimer_set_expires(hrtimer, time)			\
62 	linux_hrtimer_set_expires(hrtimer, time)
63 #define	hrtimer_start(hrtimer, time, mode) do {			\
64 	CTASSERT((mode) == HRTIMER_MODE_REL);			\
65 	linux_hrtimer_start(hrtimer, time);			\
66 } while (0)
67 #define	hrtimer_start_range_ns(hrtimer, time, prec, mode) do {	\
68 	CTASSERT((mode) == HRTIMER_MODE_REL);			\
69 	linux_hrtimer_start_range_ns(hrtimer, time, prec);	\
70 } while (0)
71 
72 bool	linux_hrtimer_active(struct hrtimer *);
73 int	linux_hrtimer_cancel(struct hrtimer *);
74 void	linux_hrtimer_init(struct hrtimer *);
75 void	linux_hrtimer_set_expires(struct hrtimer *, ktime_t);
76 void	linux_hrtimer_start(struct hrtimer *, ktime_t);
77 void	linux_hrtimer_start_range_ns(struct hrtimer *, ktime_t, int64_t);
78 
79 #endif /* _LINUX_HRTIMER_H_ */
80