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