include/linux/timer.h

   1 #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
   9 struct timer_base_s;
  10
  11 struct timer_list {
  12         struct list_head entry;
  13         unsigned long expires;
  14
  15         unsigned long magic;
  16
  17         void (*function)(unsigned long);
  18         unsigned long data;
  19
  20         struct timer_base_s *base;
  21 };
  22
  23 #define TIMER_MAGIC     0x4b87ad6e
  24
  25 extern struct timer_base_s __init_timer_base;
  26
  27 #define TIMER_INITIALIZER(_function, _expires, _data) {         \
  28                 .function = (_function),                        \
  29                 .expires = (_expires),                          \
  30                 .data = (_data),                                \
  31                 .base = &__init_timer_base,                     \
  32                 .magic = TIMER_MAGIC,                           \
  33         }
  34
  35 #define DEFINE_TIMER(_name, _function, _expires, _data)         \
  36         struct timer_list _name =                               \
  37                 TIMER_INITIALIZER(_function, _expires, _data)
  38
  39 void fastcall init_timer(struct timer_list * timer);
  40
  41 static 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
  50 /***
  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  */
  60 static inline int timer_pending(const struct timer_list * timer)
  61 {
  62         return timer->entry.next != NULL;
  63 }
  64
  65 extern void add_timer_on(struct timer_list *timer, int cpu);
  66 extern int del_timer(struct timer_list * timer);
  67 extern int __mod_timer(struct timer_list *timer, unsigned long expires);
  68 extern int mod_timer(struct timer_list *timer, unsigned long expires);
  69
  70 extern 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  */
  86 static inline void add_timer(struct timer_list * timer)
  87 {
  88         __mod_timer(timer, timer->expires);
  89 }
  90
  91 #ifdef CONFIG_SMP
  92   extern int try_to_del_timer_sync(struct timer_list *timer);
  93   extern int del_timer_sync(struct timer_list *timer);
  94 #else
  95 # define try_to_del_timer_sync(t)       del_timer(t)
  96 # define del_timer_sync(t)              del_timer(t)
  97 #endif
  98
  99 #define del_singleshot_timer_sync(t) del_timer_sync(t)
 100
 101 extern void init_timers(void);
 102 extern void run_local_timers(void);
 103 extern void it_real_fn(unsigned long);
 104
 105 #endif