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.19  2004/12/08 08:30:37  bernie
  19  *#* Convert to mtime_t; timer_minutes(): Remove.
  20  *#*
  21  *#* Revision 1.18  2004/11/16 23:09:52  bernie
  22  *#* Disable timer_minutes() for targets with 16bit time_t.
  23  *#*
  24  *#* Revision 1.17  2004/11/16 22:37:14  bernie
  25  *#* Replace IPTR with iptr_t.
  26  *#*
  27  *#* Revision 1.16  2004/08/25 14:12:08  rasky
  28  *#* Aggiornato il comment block dei log RCS
  29  *#*
  30  *#* Revision 1.15  2004/08/10 06:59:09  bernie
  31  *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
  32  *#*
  33  *#* Revision 1.12  2004/07/30 14:34:10  rasky
  34  *#* Vari fix per documentazione e commenti
  35  *#* Aggiunte PP_CATn e STATIC_ASSERT
  36  *#*
  37  *#* Revision 1.11  2004/07/29 22:40:12  bernie
  38  *#* Spelling fix.
  39  *#*
  40  *#* Revision 1.10  2004/07/21 00:13:57  bernie
  41  *#* Put timer driver on diet.
  42  *#*
  43  *#* Revision 1.9  2004/07/20 23:45:01  bernie
  44  *#* Finally remove redundant protos.
  45  *#*
  46  *#* Revision 1.8  2004/07/18 21:57:32  bernie
  47  *#* timer_gettick(): Rename to timer_tick() and document better.
  48  *#*
  49  *#* Revision 1.7  2004/06/27 15:26:17  aleph
  50  *#* Declaration fix for build with GCC 3.4
  51  *#*
  52  *#* Revision 1.6  2004/06/07 18:10:06  aleph
  53  *#* Remove free pool of timers; use user-provided Timer structure instead
  54  *#*
  55  *#* Revision 1.5  2004/06/07 15:57:12  aleph
  56  *#* Add function prototypes
  57  *#*
  58  *#* Revision 1.4  2004/06/06 18:25:44  bernie
  59  *#* Rename event macros to look like regular functions.
  60  *#*
  61  *#* Revision 1.3  2004/06/06 16:57:18  bernie
  62  *#* Mark some functions INLINE instead of 'extern inline'.
  63  *#*
  64  *#* Revision 1.2  2004/06/03 11:27:09  bernie
  65  *#* Add dual-license information.
  66  *#*
  67  *#* Revision 1.1  2004/05/23 18:23:30  bernie
  68  *#* Import drv/timer module.
  69  *#*
  70  *#*/
  71 #ifndef DRV_TIMER_H
  72 #define DRV_TIMER_H
  73
  74 #include <mware/list.h>
  75 #include <cpu.h>
  76 #include <compiler.h>
  77 #include <config.h>
  78
  79 /*! Number of timer ticks per second. */
  80 #define TICKS_PER_SEC  ((mtime_t)1000)
  81
  82 /* Function protos */
  83 extern void timer_init(void);
  84 extern void timer_delay(mtime_t time);
  85
  86 #ifndef CONFIG_TIMER_DISABLE_UDELAY
  87 extern void timer_udelay(utime_t utime);
  88 #endif
  89
  90
  91 #ifndef CONFIG_TIMER_DISABLE_EVENTS
  92
  93 #if CONFIG_KERNEL
  94         #include <kern/event.h>
  95 #else
  96         #include <mware/event.h>
  97 #endif
  98
  99 /*!
 100  * The timer driver supports multiple synchronous timers
 101  * that can trigger an event when they expire.
 102  *
 103  * \sa timer_add()
 104  * \sa timer_abort()
 105  */
 106 typedef struct Timer
 107 {
 108         Node    link;     /*!< Link into timers queue */
 109         mtime_t delay;    /*!< Timer delay in ms */
 110         mtime_t tick;     /*!< Timer will expire at this tick */
 111         Event   expire;   /*!< Event to execute when the timer expires */
 112 } Timer;
 113
 114 extern void timer_add(Timer *timer);
 115 extern Timer *timer_abort(Timer *timer);
 116
 117 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 118
 119 /*! Set the timer so that it sends a signal when it expires */
 120 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
 121 {
 122         event_initSignal(&timer->expire, proc, sigs);
 123 }
 124
 125 #endif /* CONFIG_KERN_SIGNALS */
 126
 127 /*! Set the timer so that it calls an user hook when it expires */
 128 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
 129 {
 130         event_initSoftInt(&timer->expire, func, user_data);
 131 }
 132
 133 /*! Set the timer delay (the time before the event will be triggered) */
 134 INLINE void timer_set_delay(Timer* timer, mtime_t delay)
 135 {
 136         timer->delay = delay;
 137 }
 138
 139 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
 140
 141 extern volatile mtime_t _clock;
 142
 143 /*!
 144  * \brief Return the system tick counter (expressed in ms)
 145  *
 146  * The result is guaranteed to increment monotonically,
 147  * but client code must be tolerant with respect to overflows.
 148  *
 149  * The following code is safe:
 150  *
 151  * \code
 152  *   mtime_t tea_start_time = get_tick();
 153  *
 154  *   boil_water();
 155  *
 156  *   if (get_tick() - tea_start_time > TEAPOT_DELAY)
 157  *       printf("Your tea, Sir.\n");
 158  * \endcode
 159  *
 160  * When the tick counter increments every millisecond and mtime_t
 161  * is 32bit wide, the tick count will overflow every 49.7 days.
 162  *
 163  * \note This function must disable interrupts on 8/16bit CPUs because the
 164  * clock variable is larger than the processor word size and can't
 165  * be copied atomically.
 166  */
 167 INLINE mtime_t timer_ticks(void)
 168 {
 169         mtime_t result;
 170         cpuflags_t flags;
 171
 172         DISABLE_IRQSAVE(flags);
 173         result = _clock;
 174         ENABLE_IRQRESTORE(flags);
 175
 176         return result;
 177 }
 178
 179
 180 /*!
 181  * Faster version of timer_ticks(), to be called only when the timer
 182  * interrupt is disabled (DISABLE_INTS) or overridden by a
 183  * higher-priority or non-nesting interrupt.
 184  *
 185  * \sa timer_ticks
 186  */
 187 INLINE mtime_t timer_ticks_unlocked(void)
 188 {
 189         return _clock;
 190 }
 191
 192 #endif /* DRV_TIMER_H */