bertos/drv/timer.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
  31  * -->
  32  *
  33  * \brief Hardware independent timer driver.
  34  *
  35  * All timer related functions are implemented in this module. You have several options to use timers:
  36  * \li simple delay: just use timer_delay() if you want to wait for a few milliseconds;
  37  * \li delay with callback: create a timer structure and use timer_setDelay() and timer_setSoftint() to set the callback;
  38  * \li delay with signal: same as above but use timer_setSignal() to set specify which signal to send.
  39  *
  40  * Whenever a timer expires you need to explicitly arm it again with timer_add(). If you want to abort a timer, use timer_abort().
  41  * You can use conversion macros when using msecs to specify the delay.
  42  *
  43  * \version $Id$
  44  * \author Bernie Innocenti <bernie@codewiz.org>
  45  *
  46  * $WIZ$ module_name = "timer"
  47  * $WIZ$ module_configuration = "bertos/cfg/cfg_timer.h"
  48  * $WIZ$ module_depends = "event", "sysirq"
  49  * $WIZ$ module_supports = "not atmega103 and not atmega8"
  50  */
  51
  52 #ifndef DRV_TIMER_H
  53 #define DRV_TIMER_H
  54
  55 #include <cfg/os.h>
  56 #include <cfg/macros.h>
  57
  58 #include <cpu/attr.h>
  59 #include <cpu/irq.h>
  60
  61
  62 /*
  63  * Include platform-specific binding header if we're hosted.
  64  * Try the CPU specific one for bare-metal environments.
  65  */
  66 #if OS_HOSTED
  67         //#include OS_HEADER(timer)
  68         #include <emul/timer_posix.h>
  69 #else
  70         #include CPU_HEADER(timer)
  71 #endif
  72
  73 STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T);
  74
  75 #include "cfg/cfg_timer.h"
  76 #include <cfg/debug.h>
  77 #include <cfg/compiler.h>
  78
  79 #include <struct/list.h>
  80
  81 /*
  82  * Sanity check for config parameters required by this module.
  83  */
  84 #if !defined(CONFIG_TIMER_EVENTS) || ((CONFIG_TIMER_EVENTS != 0) && CONFIG_TIMER_EVENTS != 1)
  85         #error CONFIG_TIMER_EVENTS must be set to either 0 or 1 in cfg_timer.h
  86 #endif
  87 #if !defined(CONFIG_TIMER_UDELAY) || ((CONFIG_TIMER_UDELAY != 0) && CONFIG_TIMER_EVENTS != 1)
  88         #error CONFIG_TIMER_UDELAY must be set to either 0 or 1 in cfg_timer.h
  89 #endif
  90 #if defined(CONFIG_TIMER_DISABLE_UDELAY)
  91         #error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY.  Use CONFIG_TIMER_UDELAY
  92 #endif
  93 #if defined(CONFIG_TIMER_DISABLE_EVENTS)
  94         #error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS.  Use CONFIG_TIMER_EVENTS
  95 #endif
  96
  97 extern volatile ticks_t _clock;
  98
  99 /**
 100  * \brief Return the system tick counter (expressed in ticks)
 101  *
 102  * The result is guaranteed to increment monotonically,
 103  * but client code must be tolerant with respect to overflows.
 104  *
 105  * The following code is safe:
 106  *
 107  * \code
 108  *   drop_teabag();
 109  *   ticks_t tea_start_time = timer_clock();
 110  *
 111  *   for (;;)
 112  *   {
 113  *       if (timer_clock() - tea_start_time > TEAPOT_DELAY)
 114  *       {
 115  *           printf("Your tea, Sir.\n");
 116  *           break;
 117  *       }
 118  *       patience();
 119  *   }
 120  * \endcode
 121  *
 122  * \note This function must disable interrupts on 8/16bit CPUs because the
 123  * clock variable is larger than the processor word size and can't
 124  * be copied atomically.
 125  * \sa timer_delay()
 126  */
 127 INLINE ticks_t timer_clock(void)
 128 {
 129         ticks_t result;
 130
 131         ATOMIC(result = _clock);
 132
 133         return result;
 134 }
 135
 136 /**
 137  * Faster version of timer_clock(), to be called only when the timer
 138  * interrupt is disabled (DISABLE_INTS) or overridden by a
 139  * higher-priority or non-nesting interrupt.
 140  *
 141  * \sa timer_clock
 142  */
 143 INLINE ticks_t timer_clock_unlocked(void)
 144 {
 145         return _clock;
 146 }
 147
 148 /** Convert \a ms [ms] to ticks. */
 149 INLINE ticks_t ms_to_ticks(mtime_t ms)
 150 {
 151 #if TIMER_TICKS_PER_SEC < 1000
 152         /* Slow timer: avoid rounding down too much. */
 153         return (ms * TIMER_TICKS_PER_SEC) / 1000;
 154 #else
 155         /* Fast timer: don't overflow ticks_t. */
 156         return ms * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
 157 #endif
 158 }
 159
 160 /** Convert \a us [us] to ticks. */
 161 INLINE ticks_t us_to_ticks(utime_t us)
 162 {
 163 #if TIMER_TICKS_PER_SEC < 1000
 164         /* Slow timer: avoid rounding down too much. */
 165         return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
 166 #else
 167         /* Fast timer: don't overflow ticks_t. */
 168         return (us * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
 169 #endif
 170 }
 171
 172 /** Convert \a ticks [ticks] to ms. */
 173 INLINE mtime_t ticks_to_ms(ticks_t ticks)
 174 {
 175 #if TIMER_TICKS_PER_SEC < 1000
 176         /* Slow timer: avoid rounding down too much. */
 177         return (ticks * 1000) / TIMER_TICKS_PER_SEC;
 178 #else
 179         /* Fast timer: avoid overflowing ticks_t. */
 180         return ticks / (TIMER_TICKS_PER_SEC / 1000);
 181 #endif
 182 }
 183
 184 /** Convert \a ticks [ticks] to us. */
 185 INLINE utime_t ticks_to_us(ticks_t ticks)
 186 {
 187 #if TIMER_TICKS_PER_SEC < 1000
 188         /* Slow timer: avoid rounding down too much. */
 189         return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
 190 #else
 191         /* Fast timer: avoid overflowing ticks_t. */
 192         return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
 193 #endif
 194 }
 195
 196 /** Convert \a us [us] to hpticks */
 197 INLINE hptime_t us_to_hptime(utime_t us)
 198 {
 199 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
 200         return us * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
 201 #else
 202         return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
 203 #endif
 204 }
 205
 206 /** Convert \a hpticks [hptime] to usec */
 207 INLINE utime_t hptime_to_us(hptime_t hpticks)
 208 {
 209 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
 210         return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
 211 #else
 212         return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
 213 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
 214 }
 215
 216 void timer_delayTicks(ticks_t delay);
 217 /**
 218  * Wait some time [ms].
 219  *
 220  * \note CPU is released while waiting so you don't have to call cpu_relax() explicitly.
 221  * \param delay Time to wait [ms].
 222  */
 223 INLINE void timer_delay(mtime_t delay)
 224 {
 225         timer_delayTicks(ms_to_ticks(delay));
 226 }
 227
 228 void timer_init(void);
 229 void timer_cleanup(void);
 230
 231 int timer_testSetup(void);
 232 int timer_testRun(void);
 233 int timer_testTearDown(void);
 234
 235 #if CONFIG_TIMER_UDELAY
 236 void timer_busyWait(hptime_t delay);
 237 void timer_delayHp(hptime_t delay);
 238 INLINE void timer_udelay(utime_t delay)
 239 {
 240         timer_delayHp(us_to_hptime(delay));
 241 }
 242 #endif
 243
 244 #if CONFIG_TIMER_EVENTS
 245
 246 #include <mware/event.h>
 247
 248 /**
 249  * The timer driver supports multiple synchronous timers
 250  * that can trigger an event when they expire.
 251  *
 252  * \sa timer_add()
 253  * \sa timer_abort()
 254  */
 255 typedef struct Timer
 256 {
 257         Node    link;     /**< Link into timers queue */
 258         ticks_t _delay;   /**< [ticks] Timer delay */
 259         ticks_t tick;     /**< [ticks] When this timer will expire */
 260         Event   expire;   /**< Event to execute when the timer expires */
 261         DB(uint16_t magic;)
 262 } Timer;
 263
 264 /* Timer is active when Timer.magic contains this value (for debugging purposes). */
 265 #define TIMER_MAGIC_ACTIVE    0xABBA
 266 #define TIMER_MAGIC_INACTIVE  0xBAAB
 267
 268 void timer_add(Timer *timer);
 269 Timer *timer_abort(Timer *timer);
 270
 271 /**
 272  * Set the timer so that it calls an user hook when it expires
 273  *
 274  * Sometimes you may want to use the same callback for different events, so you must have
 275  * different data to operate on. The user_data parameter is such data.
 276  *
 277  * \param timer Timer struct to set the callback to
 278  * \param func  Function that will be called when the timer expires
 279  * \param user_data Additional data you may want to pass to the callback
 280  */
 281 INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
 282 {
 283         event_initSoftint(&timer->expire, func, user_data);
 284 }
 285
 286 /** Set the timer delay (the time before the event will be triggered) */
 287 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 288 {
 289         timer->_delay = delay;
 290 }
 291
 292 #endif /* CONFIG_TIMER_EVENTS */
 293
 294 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 295
 296 /** Set the timer so that it sends a signal when it expires */
 297 INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 298 {
 299         event_initSignal(&timer->expire, proc, sigs);
 300 }
 301
 302 #define timer_set_event_signal timer_setSignal
 303
 304 #endif /* CONFIG_KERN_SIGNALS */
 305
 306 #endif /* DRV_TIMER_H */