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