drv/timer.h

   1 /**
   2  * \file
   3  * <!--
   4  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
   6  * This file is part of DevLib - See README.devlib 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.32  2007/01/09 08:57:19  bernie
  19  *#* Remove excess parentheses.
  20  *#*
  21  *#* Revision 1.31  2006/07/19 12:56:26  bernie
  22  *#* Convert to new Doxygen style.
  23  *#*
  24  *#* Revision 1.30  2006/02/24 00:26:49  bernie
  25  *#* Fixes for CONFIG_KERNEL.
  26  *#*
  27  *#* Revision 1.29  2006/02/21 21:28:02  bernie
  28  *#* New time handling based on TIMER_TICKS_PER_SEC to support slow timers with ticks longer than 1ms.
  29  *#*
  30  *#* Revision 1.28  2006/02/17 22:24:21  bernie
  31  *#* Update POSIX timer emulator.
  32  *#*
  33  *#* Revision 1.27  2005/11/27 03:04:19  bernie
  34  *#* Move test code to timer_test.c; Add OS_HOSTED support.
  35  *#*
  36  *#* Revision 1.26  2005/11/04 16:20:02  bernie
  37  *#* Fix reference to README.devlib in header.
  38  *#*
  39  *#* Revision 1.25  2005/07/19 07:26:37  bernie
  40  *#* Refactor to decouple timer ticks from milliseconds.
  41  *#*
  42  *#* Revision 1.24  2005/04/11 19:10:28  bernie
  43  *#* Include top-level headers from cfg/ subdir.
  44  *#*
  45  *#* Revision 1.23  2005/03/01 23:25:46  bernie
  46  *#* Move event.h to mware/.
  47  *#*
  48  *#* Revision 1.22  2004/12/13 12:07:06  bernie
  49  *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
  50  *#*
  51  *#* Revision 1.21  2004/12/09 08:35:21  bernie
  52  *#* Replace IPTR with iptr_t.
  53  *#*
  54  *#* Revision 1.20  2004/12/08 08:56:41  bernie
  55  *#* Rename sigset_t to sigmask_t; Reformat.
  56  *#*
  57  *#* Revision 1.19  2004/12/08 08:30:37  bernie
  58  *#* Convert to mtime_t; timer_minutes(): Remove.
  59  *#*
  60  *#* Revision 1.18  2004/11/16 23:09:52  bernie
  61  *#* Disable timer_minutes() for targets with 16bit time_t.
  62  *#*
  63  *#* Revision 1.17  2004/11/16 22:37:14  bernie
  64  *#* Replace IPTR with iptr_t.
  65  *#*
  66  *#* Revision 1.16  2004/08/25 14:12:08  rasky
  67  *#* Aggiornato il comment block dei log RCS
  68  *#*
  69  *#* Revision 1.15  2004/08/10 06:59:09  bernie
  70  *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
  71  *#*
  72  *#* Revision 1.12  2004/07/30 14:34:10  rasky
  73  *#* Vari fix per documentazione e commenti
  74  *#* Aggiunte PP_CATn e STATIC_ASSERT
  75  *#*
  76  *#* Revision 1.11  2004/07/29 22:40:12  bernie
  77  *#* Spelling fix.
  78  *#*
  79  *#* Revision 1.10  2004/07/21 00:13:57  bernie
  80  *#* Put timer driver on diet.
  81  *#*
  82  *#* Revision 1.9  2004/07/20 23:45:01  bernie
  83  *#* Finally remove redundant protos.
  84  *#*
  85  *#* Revision 1.8  2004/07/18 21:57:32  bernie
  86  *#* timer_gettick(): Rename to timer_tick() and document better.
  87  *#*
  88  *#* Revision 1.7  2004/06/27 15:26:17  aleph
  89  *#* Declaration fix for build with GCC 3.4
  90  *#*
  91  *#* Revision 1.6  2004/06/07 18:10:06  aleph
  92  *#* Remove free pool of timers; use user-provided Timer structure instead
  93  *#*
  94  *#* Revision 1.5  2004/06/07 15:57:12  aleph
  95  *#* Add function prototypes
  96  *#*
  97  *#* Revision 1.4  2004/06/06 18:25:44  bernie
  98  *#* Rename event macros to look like regular functions.
  99  *#*
 100  *#* Revision 1.3  2004/06/06 16:57:18  bernie
 101  *#* Mark some functions INLINE instead of 'extern inline'.
 102  *#*
 103  *#* Revision 1.2  2004/06/03 11:27:09  bernie
 104  *#* Add dual-license information.
 105  *#*
 106  *#* Revision 1.1  2004/05/23 18:23:30  bernie
 107  *#* Import drv/timer module.
 108  *#*
 109  *#*/
 110 #ifndef DRV_TIMER_H
 111 #define DRV_TIMER_H
 112
 113 #include <cfg/os.h>
 114 #include <cfg/cpu.h>
 115
 116 /*
 117  * Include platform-specific binding header if we're hosted.
 118  * Try the CPU specific one for bare-metal environments.
 119  */
 120 #if OS_HOSTED
 121         #include OS_HEADER(timer)
 122 #else
 123         #include CPU_HEADER(timer)
 124 #endif
 125
 126 #include <mware/list.h>
 127 #include <cfg/debug.h>
 128 #include <cfg/compiler.h>
 129 #include <appconfig.h>
 130
 131
 132 extern volatile ticks_t _clock;
 133
 134 /**
 135  * \brief Return the system tick counter (expressed in ticks)
 136  *
 137  * The result is guaranteed to increment monotonically,
 138  * but client code must be tolerant with respect to overflows.
 139  *
 140  * The following code is safe:
 141  *
 142  * \code
 143  *   ticks_t tea_start_time = timer_clock();
 144  *
 145  *   boil_water();
 146  *
 147  *   if (timer_clock() - tea_start_time > TEAPOT_DELAY)
 148  *       printf("Your tea, Sir.\n");
 149  * \endcode
 150  *
 151  * \note This function must disable interrupts on 8/16bit CPUs because the
 152  * clock variable is larger than the processor word size and can't
 153  * be copied atomically.
 154  */
 155 INLINE ticks_t timer_clock(void)
 156 {
 157         ticks_t result;
 158
 159         ATOMIC(result = _clock);
 160
 161         return result;
 162 }
 163
 164 /**
 165  * Faster version of timer_clock(), to be called only when the timer
 166  * interrupt is disabled (DISABLE_INTS) or overridden by a
 167  * higher-priority or non-nesting interrupt.
 168  *
 169  * \sa timer_ticks
 170  */
 171 INLINE ticks_t timer_clock_unlocked(void)
 172 {
 173         return _clock;
 174 }
 175
 176 /** Convert \a ms [ms] to ticks. */
 177 INLINE ticks_t ms_to_ticks(mtime_t ms)
 178 {
 179 #if TIMER_TICKS_PER_SEC < 1000
 180         /* Slow timer: avoid rounding down too much. */
 181         return (ms * TIMER_TICKS_PER_SEC) / 1000;
 182 #else
 183         /* Fast timer: don't overflow ticks_t. */
 184         return ms * ((TIMER_TICKS_PER_SEC + 500) / 1000);
 185 #endif
 186 }
 187
 188 /** Convert \a us [us] to ticks. */
 189 INLINE ticks_t us_to_ticks(utime_t us)
 190 {
 191 #if TIMER_TICKS_PER_SEC < 1000
 192         /* Slow timer: avoid rounding down too much. */
 193         return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
 194 #else
 195         /* Fast timer: don't overflow ticks_t. */
 196         return (us * ((TIMER_TICKS_PER_SEC + 500) / 1000)) / 1000;
 197 #endif
 198 }
 199
 200 /** Convert \a ticks [ticks] to ms. */
 201 INLINE mtime_t ticks_to_ms(ticks_t ticks)
 202 {
 203 #if TIMER_TICKS_PER_SEC < 1000
 204         /* Slow timer: avoid rounding down too much. */
 205         return (ticks * 1000) / TIMER_TICKS_PER_SEC;
 206 #else
 207         /* Fast timer: avoid overflowing ticks_t. */
 208         return ticks / (TIMER_TICKS_PER_SEC / 1000);
 209 #endif
 210 }
 211
 212 /** Convert \a ticks [ticks] to us. */
 213 INLINE utime_t ticks_to_us(ticks_t ticks)
 214 {
 215 #if TIMER_TICKS_PER_SEC < 1000
 216         /* Slow timer: avoid rounding down too much. */
 217         return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
 218 #else
 219         /* Fast timer: avoid overflowing ticks_t. */
 220         return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
 221 #endif
 222 }
 223
 224 /** Convert \a us [us] to hpticks */
 225 INLINE hptime_t us_to_hptime(utime_t us)
 226 {
 227 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
 228         return us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL);
 229 #else
 230         return (us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL;
 231 #endif
 232 }
 233
 234 /** Convert \a hpticks [hptime] to usec */
 235 INLINE utime_t hptime_to_us(hptime_t hpticks)
 236 {
 237 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
 238         return hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC);
 239 #else
 240         return (hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC;
 241 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
 242 }
 243
 244
 245 void timer_init(void);
 246 void timer_delayTicks(ticks_t delay);
 247 INLINE void timer_delay(mtime_t delay)
 248 {
 249         timer_delayTicks(ms_to_ticks(delay));
 250 }
 251
 252 #if !defined(CONFIG_TIMER_DISABLE_UDELAY)
 253 void timer_busyWait(hptime_t delay);
 254 void timer_delayHp(hptime_t delay);
 255 INLINE void timer_udelay(utime_t delay)
 256 {
 257         timer_delayHp(us_to_hptime(delay));
 258 }
 259 #endif
 260
 261 #ifndef CONFIG_TIMER_DISABLE_EVENTS
 262
 263 #include <mware/event.h>
 264
 265 /**
 266  * The timer driver supports multiple synchronous timers
 267  * that can trigger an event when they expire.
 268  *
 269  * \sa timer_add()
 270  * \sa timer_abort()
 271  */
 272 typedef struct Timer
 273 {
 274         Node    link;     /**< Link into timers queue */
 275         ticks_t _delay;   /**< Timer delay in ms */
 276         ticks_t tick;     /**< Timer will expire at this tick */
 277         Event   expire;   /**< Event to execute when the timer expires */
 278         DB(uint16_t magic;)
 279 } Timer;
 280
 281 /** Timer is active when Timer.magic contains this value (for debugging purposes). */
 282 #define TIMER_MAGIC_ACTIVE    0xABBA
 283 #define TIMER_MAGIC_INACTIVE  0xBAAB
 284
 285 extern void timer_add(Timer *timer);
 286 extern Timer *timer_abort(Timer *timer);
 287
 288 /** Set the timer so that it calls an user hook when it expires */
 289 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
 290 {
 291         event_initSoftInt(&timer->expire, func, user_data);
 292 }
 293
 294 /** Set the timer delay (the time before the event will be triggered) */
 295 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 296 {
 297         timer->_delay = delay;
 298 }
 299
 300 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
 301
 302 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 303
 304 /** Set the timer so that it sends a signal when it expires */
 305 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
 306 {
 307         event_initSignal(&timer->expire, proc, sigs);
 308 }
 309
 310 #endif /* CONFIG_KERN_SIGNALS */
 311
 312
 313 #endif /* DRV_TIMER_H */