blob: ddd5bbe1fc8e935524f2f769c286fa282b5b8b81 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef _LINUX_TIMER_H
2#define _LINUX_TIMER_H
3
4#include <linux/config.h>
5#include <linux/list.h>
6#include <linux/spinlock.h>
7#include <linux/stddef.h>
8
Oleg Nesterov55c888d2005-06-23 00:08:56 -07009struct timer_base_s;
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
11struct timer_list {
12 struct list_head entry;
13 unsigned long expires;
14
Linus Torvalds1da177e2005-04-16 15:20:36 -070015 unsigned long magic;
16
17 void (*function)(unsigned long);
18 unsigned long data;
19
Oleg Nesterov55c888d2005-06-23 00:08:56 -070020 struct timer_base_s *base;
Linus Torvalds1da177e2005-04-16 15:20:36 -070021};
22
23#define TIMER_MAGIC 0x4b87ad6e
24
Oleg Nesterov55c888d2005-06-23 00:08:56 -070025extern struct timer_base_s __init_timer_base;
26
Linus Torvalds1da177e2005-04-16 15:20:36 -070027#define TIMER_INITIALIZER(_function, _expires, _data) { \
28 .function = (_function), \
29 .expires = (_expires), \
30 .data = (_data), \
Oleg Nesterov55c888d2005-06-23 00:08:56 -070031 .base = &__init_timer_base, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 .magic = TIMER_MAGIC, \
Linus Torvalds1da177e2005-04-16 15:20:36 -070033 }
34
Ingo Molnar8d06afa2005-09-09 13:10:40 -070035#define DEFINE_TIMER(_name, _function, _expires, _data) \
36 struct timer_list _name = \
37 TIMER_INITIALIZER(_function, _expires, _data)
38
Oleg Nesterov55c888d2005-06-23 00:08:56 -070039void fastcall init_timer(struct timer_list * timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070040
Oleg Nesterova8db2db2005-10-30 15:01:38 -080041static inline void setup_timer(struct timer_list * timer,
42 void (*function)(unsigned long),
43 unsigned long data)
44{
45 timer->function = function;
46 timer->data = data;
47 init_timer(timer);
48}
49
Linus Torvalds1da177e2005-04-16 15:20:36 -070050/***
51 * timer_pending - is a timer pending?
52 * @timer: the timer in question
53 *
54 * timer_pending will tell whether a given timer is currently pending,
55 * or not. Callers must ensure serialization wrt. other operations done
56 * to this timer, eg. interrupt contexts, or other CPUs on SMP.
57 *
58 * return value: 1 if the timer is pending, 0 if not.
59 */
60static inline int timer_pending(const struct timer_list * timer)
61{
Oleg Nesterov55c888d2005-06-23 00:08:56 -070062 return timer->entry.next != NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -070063}
64
65extern void add_timer_on(struct timer_list *timer, int cpu);
66extern int del_timer(struct timer_list * timer);
67extern int __mod_timer(struct timer_list *timer, unsigned long expires);
68extern int mod_timer(struct timer_list *timer, unsigned long expires);
69
70extern unsigned long next_timer_interrupt(void);
71
72/***
73 * add_timer - start a timer
74 * @timer: the timer to be added
75 *
76 * The kernel will do a ->function(->data) callback from the
77 * timer interrupt at the ->expired point in the future. The
78 * current time is 'jiffies'.
79 *
80 * The timer's ->expired, ->function (and if the handler uses it, ->data)
81 * fields must be set prior calling this function.
82 *
83 * Timers with an ->expired field in the past will be executed in the next
84 * timer tick.
85 */
86static inline void add_timer(struct timer_list * timer)
87{
88 __mod_timer(timer, timer->expires);
89}
90
91#ifdef CONFIG_SMP
Oleg Nesterovfd450b72005-06-23 00:08:59 -070092 extern int try_to_del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070093 extern int del_timer_sync(struct timer_list *timer);
Linus Torvalds1da177e2005-04-16 15:20:36 -070094#else
Oleg Nesterovfd450b72005-06-23 00:08:59 -070095# define try_to_del_timer_sync(t) del_timer(t)
96# define del_timer_sync(t) del_timer(t)
Linus Torvalds1da177e2005-04-16 15:20:36 -070097#endif
98
Oleg Nesterov55c888d2005-06-23 00:08:56 -070099#define del_singleshot_timer_sync(t) del_timer_sync(t)
100
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101extern void init_timers(void);
102extern void run_local_timers(void);
103extern void it_real_fn(unsigned long);
104
105#endif