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