xref: /freebsd/sys/compat/linuxkpi/common/include/linux/timer.h (revision 95ee2897e98f5d444f26ed2334cc7c439f9c16c6)
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 	int expires;
46 };
47 
48 extern unsigned long linux_timer_hz_mask;
49 
50 #define	TIMER_IRQSAFE	0x0001
51 
52 #define	from_timer(var, arg, field)					\
53         container_of(arg, typeof(*(var)), field)
54 
55 #define	timer_setup(timer, func, flags) do {				\
56 	CTASSERT(((flags) & ~TIMER_IRQSAFE) == 0);			\
57 	(timer)->function_415 = (func);					\
58 	(timer)->data = (unsigned long)(timer);				\
59 	callout_init(&(timer)->callout, 1);				\
60 } while (0)
61 
62 #define	setup_timer(timer, func, dat) do {				\
63 	(timer)->function = (func);					\
64 	(timer)->data = (dat);						\
65 	callout_init(&(timer)->callout, 1);			\
66 } while (0)
67 
68 #define	__setup_timer(timer, func, dat, flags) do {			\
69 	CTASSERT(((flags) & ~TIMER_IRQSAFE) == 0);			\
70 	setup_timer(timer, func, dat);					\
71 } while (0)
72 
73 #define	init_timer(timer) do {						\
74 	(timer)->function = NULL;					\
75 	(timer)->data = 0;						\
76 	callout_init(&(timer)->callout, 1);			\
77 } while (0)
78 
79 extern int mod_timer(struct timer_list *, int);
80 extern void add_timer(struct timer_list *);
81 extern void add_timer_on(struct timer_list *, int cpu);
82 extern int del_timer(struct timer_list *);
83 extern int del_timer_sync(struct timer_list *);
84 extern int timer_delete_sync(struct timer_list *);
85 extern int timer_shutdown_sync(struct timer_list *);
86 
87 #define	timer_pending(timer)	callout_pending(&(timer)->callout)
88 #define	round_jiffies(j)	\
89 	((int)(((j) + linux_timer_hz_mask) & ~linux_timer_hz_mask))
90 #define	round_jiffies_relative(j) round_jiffies(j)
91 #define	round_jiffies_up(j)	round_jiffies(j)
92 #define	round_jiffies_up_relative(j) round_jiffies_up(j)
93 
94 #endif					/* _LINUXKPI_LINUX_TIMER_H_ */
95