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