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