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