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