xref: /dragonfly/sys/dev/drm/include/linux/hrtimer.h (revision ffe53622)
1 /*
2  * Copyright (c) 2017 François Tigeot
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 #ifndef _LINUX_HRTIMER_H_
27 #define _LINUX_HRTIMER_H_
28 
29 #include <linux/ktime.h>
30 #include <linux/list.h>
31 #include <linux/wait.h>
32 #include <linux/timer.h>
33 
34 enum hrtimer_mode {
35 	HRTIMER_MODE_ABS = 0x0,
36 	HRTIMER_MODE_REL = 0x1,
37 };
38 
39 enum hrtimer_restart {
40 	HRTIMER_NORESTART,	/* Timer is not restarted */
41 	HRTIMER_RESTART,	/* Timer must be restarted */
42 };
43 
44 struct hrtimer {
45 	struct callout timer_callout;
46 	clockid_t 		clock_id;
47 	enum hrtimer_mode	ht_mode;
48 	bool active;
49 	enum hrtimer_restart	(*function)(struct hrtimer *);
50 	struct lwkt_token timer_token;
51 };
52 
53 extern void hrtimer_init(struct hrtimer *timer, clockid_t which_clock,
54 			 enum hrtimer_mode mode);
55 
56 extern void hrtimer_start_range_ns(struct hrtimer *timer, ktime_t tim,
57 				   u64 range_ns, const enum hrtimer_mode mode);
58 
59 extern int hrtimer_cancel(struct hrtimer *timer);
60 
61 extern bool hrtimer_active(const struct hrtimer *timer);
62 
63 #endif /* _LINUX_HRTIMER_H_ */
64