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