drv/timer.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
   6  * All Rights Reserved.
   7  * -->
   8  *
   9  * \version $Id$
  10  *
  11  * \author Bernardo Innocenti <bernie@develer.com>
  12  *
  13  * \brief Hardware independent timer driver (interface)
  14  */
  15
  16 /*
  17  * $Log$
  18  * Revision 1.1  2004/05/23 18:23:30  bernie
  19  * Import drv/timer module.
  20  *
  21  */
  22 #ifndef DRV_TIMER_H
  23 #define DRV_TIMER_H
  24
  25 #include "cpu.h"
  26 #include "compiler.h"
  27 #include <mware/list.h>
  28 #include <kern/event.h>
  29
  30 /*! Number of timer ticks per second. */
  31 #define TICKS_PER_SEC       1000
  32
  33 typedef struct Timer
  34 {
  35         Node   link;      /*!< Link into timers queue */
  36         time_t delay;     /*!< Timer delay in ms */
  37         time_t tick;      /*!< Timer will expire at this tick */
  38         Event  expire;    /*!< Event to execute when the timer expires */
  39 } Timer;
  40
  41 extern void timer_init(void);
  42 extern Timer *timer_new(void);
  43 extern void timer_delete(Timer *timer);
  44 extern void timer_add(Timer *timer);
  45 extern Timer *timer_abort(Timer *timer);
  46 extern void timer_delay(time_t time);
  47 extern void timer_udelay(utime_t utime);
  48 extern inline time_t timer_gettick(void);
  49 extern inline time_t timer_gettick_irq(void);
  50
  51 #ifdef CONFIG_KERN_SIGNALS
  52 /*! Set the timer so that it sends a signal when it expires */
  53 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
  54 {
  55         INITEVENT_SIG(&timer->expire, proc, sigs);
  56 }
  57 #endif
  58
  59 /*! Set the timer so that it calls an user hook when it expires */
  60 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
  61 {
  62         INITEVENT_INT(&timer->expire, func, user_data);
  63 }
  64
  65 /*! Set the timer delay (the time before the event will be triggered) */
  66 INLINE void timer_set_delay(Timer* timer, time_t delay)
  67 {
  68         timer->delay = delay;
  69 }
  70
  71
  72 /*!
  73  * Return the system tick counter (expressed in ms)
  74  * This function must disable interrupts on 8/16bit CPUs because the
  75  * clock variable is larger than the processor word size and can't
  76  * be copied atomically.
  77  */
  78 extern inline time_t timer_gettick(void)
  79 {
  80         extern volatile time_t _clock;
  81
  82         time_t result;
  83         cpuflags_t flags;
  84
  85         DISABLE_IRQSAVE(flags);
  86         result = _clock;
  87         ENABLE_IRQRESTORE(flags);
  88
  89         return result;
  90 }
  91
  92
  93 /*!
  94  * Like \c timer_gettick, faster version to be called
  95  * from interrupt context only.
  96  */
  97 extern inline time_t timer_gettick_irq(void)
  98 {
  99         extern volatile time_t _clock;
 100
 101         return _clock;
 102 }
 103
 104 #endif /* DRV_TIMER_H */
 105