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  * \version $Id$
  36  * \author Bernie Innocenti <bernie@codewiz.org>
  37  *
  38  * $WIZ$ module_name = "timer"
  39  * $WIZ$ module_configuration = "bertos/cfg/cfg_timer.h"
  40  */
  41
  42 #ifndef DRV_TIMER_H
  43 #define DRV_TIMER_H
  44
  45 #include <cfg/os.h>
  46 #include <cfg/macros.h>
  47
  48 #include <cpu/attr.h>
  49 #include <cpu/irq.h>
  50
  51
  52 /*
  53  * Include platform-specific binding header if we're hosted.
  54  * Try the CPU specific one for bare-metal environments.
  55  */
  56 #if OS_HOSTED
  57         //#include OS_HEADER(timer)
  58         #include <emul/timer_posix.h>
  59 #else
  60         #include CPU_HEADER(timer)
  61 #endif
  62
  63 #include "cfg/cfg_timer.h"
  64 #include <cfg/debug.h>
  65 #include <cfg/compiler.h>
  66
  67 #include <struct/list.h>
  68
  69 /*
  70  * Sanity check for config parameters required by this module.
  71  */
  72 #if !defined(CONFIG_TIMER_EVENTS) || ((CONFIG_TIMER_EVENTS != 0) && CONFIG_TIMER_EVENTS != 1)
  73         #error CONFIG_TIMER_EVENTS must be set to either 0 or 1 in cfg_timer.h
  74 #endif
  75 #if !defined(CONFIG_TIMER_UDELAY) || ((CONFIG_TIMER_UDELAY != 0) && CONFIG_TIMER_EVENTS != 1)
  76         #error CONFIG_TIMER_UDELAY must be set to either 0 or 1 in cfg_timer.h
  77 #endif
  78 #if defined(CONFIG_TIMER_DISABLE_UDELAY)
  79         #error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY.  Use CONFIG_TIMER_UDELAY
  80 #endif
  81 #if defined(CONFIG_TIMER_DISABLE_EVENTS)
  82         #error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS.  Use CONFIG_TIMER_EVENTS
  83 #endif
  84
  85 extern volatile ticks_t _clock;
  86
  87 /**
  88  * \brief Return the system tick counter (expressed in ticks)
  89  *
  90  * The result is guaranteed to increment monotonically,
  91  * but client code must be tolerant with respect to overflows.
  92  *
  93  * The following code is safe:
  94  *
  95  * \code
  96  *   drop_teabag();
  97  *   ticks_t tea_start_time = timer_clock();
  98  *
  99  *   for (;;)
 100  *   {
 101  *       if (timer_clock() - tea_start_time > TEAPOT_DELAY)
 102  *       {
 103  *           printf("Your tea, Sir.\n");
 104  *           break;
 105  *       }
 106  *       patience();
 107  *   }
 108  * \endcode
 109  *
 110  * \note This function must disable interrupts on 8/16bit CPUs because the
 111  * clock variable is larger than the processor word size and can't
 112  * be copied atomically.
 113  */
 114 INLINE ticks_t timer_clock(void)
 115 {
 116         ticks_t result;
 117
 118         ATOMIC(result = _clock);
 119
 120         return result;
 121 }
 122
 123 /**
 124  * Faster version of timer_clock(), to be called only when the timer
 125  * interrupt is disabled (DISABLE_INTS) or overridden by a
 126  * higher-priority or non-nesting interrupt.
 127  *
 128  * \sa timer_clock
 129  */
 130 INLINE ticks_t timer_clock_unlocked(void)
 131 {
 132         return _clock;
 133 }
 134
 135 /** Convert \a ms [ms] to ticks. */
 136 INLINE ticks_t ms_to_ticks(mtime_t ms)
 137 {
 138 #if TIMER_TICKS_PER_SEC < 1000
 139         /* Slow timer: avoid rounding down too much. */
 140         return (ms * TIMER_TICKS_PER_SEC) / 1000;
 141 #else
 142         /* Fast timer: don't overflow ticks_t. */
 143         return ms * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
 144 #endif
 145 }
 146
 147 /** Convert \a us [us] to ticks. */
 148 INLINE ticks_t us_to_ticks(utime_t us)
 149 {
 150 #if TIMER_TICKS_PER_SEC < 1000
 151         /* Slow timer: avoid rounding down too much. */
 152         return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
 153 #else
 154         /* Fast timer: don't overflow ticks_t. */
 155         return (us * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
 156 #endif
 157 }
 158
 159 /** Convert \a ticks [ticks] to ms. */
 160 INLINE mtime_t ticks_to_ms(ticks_t ticks)
 161 {
 162 #if TIMER_TICKS_PER_SEC < 1000
 163         /* Slow timer: avoid rounding down too much. */
 164         return (ticks * 1000) / TIMER_TICKS_PER_SEC;
 165 #else
 166         /* Fast timer: avoid overflowing ticks_t. */
 167         return ticks / (TIMER_TICKS_PER_SEC / 1000);
 168 #endif
 169 }
 170
 171 /** Convert \a ticks [ticks] to us. */
 172 INLINE utime_t ticks_to_us(ticks_t ticks)
 173 {
 174 #if TIMER_TICKS_PER_SEC < 1000
 175         /* Slow timer: avoid rounding down too much. */
 176         return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
 177 #else
 178         /* Fast timer: avoid overflowing ticks_t. */
 179         return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
 180 #endif
 181 }
 182
 183 /** Convert \a us [us] to hpticks */
 184 INLINE hptime_t us_to_hptime(utime_t us)
 185 {
 186 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
 187         return us * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
 188 #else
 189         return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
 190 #endif
 191 }
 192
 193 /** Convert \a hpticks [hptime] to usec */
 194 INLINE utime_t hptime_to_us(hptime_t hpticks)
 195 {
 196 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
 197         return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
 198 #else
 199         return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
 200 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
 201 }
 202
 203 void timer_delayTicks(ticks_t delay);
 204 INLINE void timer_delay(mtime_t delay)
 205 {
 206         timer_delayTicks(ms_to_ticks(delay));
 207 }
 208
 209 void timer_init(void);
 210 void timer_cleanup(void);
 211
 212 int timer_testSetup(void);
 213 int timer_testRun(void);
 214 int timer_testTearDown(void);
 215
 216 #if CONFIG_TIMER_UDELAY
 217 void timer_busyWait(hptime_t delay);
 218 void timer_delayHp(hptime_t delay);
 219 INLINE void timer_udelay(utime_t delay)
 220 {
 221         timer_delayHp(us_to_hptime(delay));
 222 }
 223 #endif
 224
 225 #if CONFIG_TIMER_EVENTS
 226
 227 #include <mware/event.h>
 228
 229 /**
 230  * The timer driver supports multiple synchronous timers
 231  * that can trigger an event when they expire.
 232  *
 233  * \sa timer_add()
 234  * \sa timer_abort()
 235  */
 236 typedef struct Timer
 237 {
 238         Node    link;     /**< Link into timers queue */
 239         ticks_t _delay;   /**< [ticks] Timer delay */
 240         ticks_t tick;     /**< [ticks] When this timer will expire */
 241         Event   expire;   /**< Event to execute when the timer expires */
 242         DB(uint16_t magic;)
 243 } Timer;
 244
 245 /** Timer is active when Timer.magic contains this value (for debugging purposes). */
 246 #define TIMER_MAGIC_ACTIVE    0xABBA
 247 #define TIMER_MAGIC_INACTIVE  0xBAAB
 248
 249 void timer_add(Timer *timer);
 250 Timer *timer_abort(Timer *timer);
 251
 252 /** Set the timer so that it calls an user hook when it expires */
 253 INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
 254 {
 255         event_initSoftint(&timer->expire, func, user_data);
 256 }
 257
 258 /** Set the timer delay (the time before the event will be triggered) */
 259 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 260 {
 261         timer->_delay = delay;
 262 }
 263
 264 #endif /* CONFIG_TIMER_EVENTS */
 265
 266 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 267
 268 /** Set the timer so that it sends a signal when it expires */
 269 INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 270 {
 271         event_initSignal(&timer->expire, proc, sigs);
 272 }
 273
 274 #define timer_set_event_signal timer_setSignal
 275
 276 #endif /* CONFIG_KERN_SIGNALS */
 277
 278 #endif /* DRV_TIMER_H */