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