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  * This file is part of DevLib - See devlib/README for information.
   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.3  2004/06/06 16:57:18  bernie
  19  * Mark some functions INLINE instead of 'extern inline'.
  20  *
  21  * Revision 1.2  2004/06/03 11:27:09  bernie
  22  * Add dual-license information.
  23  *
  24  * Revision 1.1  2004/05/23 18:23:30  bernie
  25  * Import drv/timer module.
  26  *
  27  */
  28 #ifndef DRV_TIMER_H
  29 #define DRV_TIMER_H
  30
  31 #include "cpu.h"
  32 #include "compiler.h"
  33 #include <mware/list.h>
  34 #include <kern/event.h>
  35
  36 /*! Number of timer ticks per second. */
  37 #define TICKS_PER_SEC       1000
  38
  39 typedef struct Timer
  40 {
  41         Node   link;      /*!< Link into timers queue */
  42         time_t delay;     /*!< Timer delay in ms */
  43         time_t tick;      /*!< Timer will expire at this tick */
  44         Event  expire;    /*!< Event to execute when the timer expires */
  45 } Timer;
  46
  47 extern void timer_init(void);
  48 extern Timer *timer_new(void);
  49 extern void timer_delete(Timer *timer);
  50 extern void timer_add(Timer *timer);
  51 extern Timer *timer_abort(Timer *timer);
  52 extern void timer_delay(time_t time);
  53 extern void timer_udelay(utime_t utime);
  54 INLINE time_t timer_gettick(void);
  55 INLINE time_t timer_gettick_irq(void);
  56
  57 #ifdef CONFIG_KERN_SIGNALS
  58 /*! Set the timer so that it sends a signal when it expires */
  59 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
  60 {
  61         INITEVENT_SIG(&timer->expire, proc, sigs);
  62 }
  63 #endif
  64
  65 /*! Set the timer so that it calls an user hook when it expires */
  66 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
  67 {
  68         INITEVENT_INT(&timer->expire, func, user_data);
  69 }
  70
  71 /*! Set the timer delay (the time before the event will be triggered) */
  72 INLINE void timer_set_delay(Timer* timer, time_t delay)
  73 {
  74         timer->delay = delay;
  75 }
  76
  77
  78 /*!
  79  * Return the system tick counter (expressed in ms)
  80  * This function must disable interrupts on 8/16bit CPUs because the
  81  * clock variable is larger than the processor word size and can't
  82  * be copied atomically.
  83  */
  84 INLINE time_t timer_gettick(void)
  85 {
  86         extern volatile time_t _clock;
  87
  88         time_t result;
  89         cpuflags_t flags;
  90
  91         DISABLE_IRQSAVE(flags);
  92         result = _clock;
  93         ENABLE_IRQRESTORE(flags);
  94
  95         return result;
  96 }
  97
  98
  99 /*!
 100  * Like \c timer_gettick, faster version to be called
 101  * from interrupt context only.
 102  */
 103 INLINE time_t timer_gettick_irq(void)
 104 {
 105         extern volatile time_t _clock;
 106
 107         return _clock;
 108 }
 109
 110 #endif /* DRV_TIMER_H */
 111