xref: /freebsd/sys/compat/linuxkpi/common/include/linux/timer.h (revision 5cb64a1d3fe75526fb879ef4dce5860bbb4e4aea)
1 /*-
2  * Copyright (c) 2010 Isilon Systems, Inc.
3  * Copyright (c) 2010 iX Systems, Inc.
4  * Copyright (c) 2010 Panasas, Inc.
5  * Copyright (c) 2013, 2014 Mellanox Technologies, Ltd.
6  * All rights reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice unmodified, this list of conditions, and the following
13  *    disclaimer.
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 AUTHOR ``AS IS'' AND ANY EXPRESS OR
19  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
20  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
21  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
22  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
23  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 #ifndef _LINUXKPI_LINUX_TIMER_H_
30 #define	_LINUXKPI_LINUX_TIMER_H_
31 
32 #include <linux/types.h>
33 
34 #include <sys/param.h>
35 #include <sys/kernel.h>
36 #include <sys/callout.h>
37 
38 struct timer_list {
39 	struct callout callout;
40 	union {
41 		void (*function) (unsigned long);	/* < v4.15 */
42 		void (*function_415) (struct timer_list *);
43 	};
44 	unsigned long data;
45 	unsigned long expires;
46 };
47 
48 extern unsigned long linux_timer_hz_mask;
49 
50 #define	TIMER_IRQSAFE	0x0001
51 
52 #if defined(LINUXKPI_VERSION) && (LINUXKPI_VERSION < 61600)
53 #define	from_timer(var, arg, field)					\
54         container_of(arg, typeof(*(var)), field)
55 #else
56 #define	timer_container_of(var, arg, field)				\
57     container_of(arg, typeof(*(var)), field)
58 #endif
59 
60 #define	timer_setup(timer, func, flags) do {				\
61 	CTASSERT(((flags) & ~TIMER_IRQSAFE) == 0);			\
62 	(timer)->function_415 = (func);					\
63 	(timer)->data = (unsigned long)(timer);				\
64 	callout_init(&(timer)->callout, 1);				\
65 } while (0)
66 
67 #define	setup_timer(timer, func, dat) do {				\
68 	(timer)->function = (func);					\
69 	(timer)->data = (dat);						\
70 	callout_init(&(timer)->callout, 1);			\
71 } while (0)
72 
73 #define	__setup_timer(timer, func, dat, flags) do {			\
74 	CTASSERT(((flags) & ~TIMER_IRQSAFE) == 0);			\
75 	setup_timer(timer, func, dat);					\
76 } while (0)
77 
78 #define	init_timer(timer) do {						\
79 	(timer)->function = NULL;					\
80 	(timer)->data = 0;						\
81 	callout_init(&(timer)->callout, 1);			\
82 } while (0)
83 
84 extern int mod_timer(struct timer_list *, unsigned long);
85 extern void add_timer(struct timer_list *);
86 extern void add_timer_on(struct timer_list *, int cpu);
87 
88 extern int timer_delete(struct timer_list *);
89 extern int timer_delete_sync(struct timer_list *);
90 extern int timer_shutdown_sync(struct timer_list *);
91 
92 static inline int
del_timer(struct timer_list * tl)93 del_timer(struct timer_list *tl)
94 {
95 	return (timer_delete(tl));
96 }
97 
98 static inline int
del_timer_sync(struct timer_list * tl)99 del_timer_sync(struct timer_list *tl)
100 {
101 	return (timer_delete_sync(tl));
102 }
103 
104 #define	timer_pending(timer)	callout_pending(&(timer)->callout)
105 #define	round_jiffies(j)	\
106 	((unsigned long)(((j) + linux_timer_hz_mask) & ~linux_timer_hz_mask))
107 #define	round_jiffies_relative(j) round_jiffies(j)
108 #define	round_jiffies_up(j)	round_jiffies(j)
109 #define	round_jiffies_up_relative(j) round_jiffies_up(j)
110 
111 #endif					/* _LINUXKPI_LINUX_TIMER_H_ */
112