4 * This file is part of BeRTOS.
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.
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.
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
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.
29 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
33 * \brief Hardware independent timer driver.
36 * \author Bernie Innocenti <bernie@codewiz.org>
38 * $WIZ$ module_name = "timer"
39 * $WIZ$ module_configuration = "bertos/cfg/cfg_timer.h"
46 #include <cfg/macros.h>
53 * Include platform-specific binding header if we're hosted.
54 * Try the CPU specific one for bare-metal environments.
57 //#include OS_HEADER(timer)
58 #include <emul/timer_posix.h>
60 #include CPU_HEADER(timer)
63 #include "cfg/cfg_timer.h"
64 #include <cfg/debug.h>
65 #include <cfg/compiler.h>
67 #include <struct/list.h>
70 * Sanity check for config parameters required by this module.
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
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
78 #if defined(CONFIG_TIMER_DISABLE_UDELAY)
79 #error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY. Use CONFIG_TIMER_UDELAY
81 #if defined(CONFIG_TIMER_DISABLE_EVENTS)
82 #error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS. Use CONFIG_TIMER_EVENTS
85 extern volatile ticks_t _clock;
88 * \brief Return the system tick counter (expressed in ticks)
90 * The result is guaranteed to increment monotonically,
91 * but client code must be tolerant with respect to overflows.
93 * The following code is safe:
97 * ticks_t tea_start_time = timer_clock();
101 * if (timer_clock() - tea_start_time > TEAPOT_DELAY)
103 * printf("Your tea, Sir.\n");
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.
114 INLINE ticks_t timer_clock(void)
118 ATOMIC(result = _clock);
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.
130 INLINE ticks_t timer_clock_unlocked(void)
135 /** Convert \a ms [ms] to ticks. */
136 INLINE ticks_t ms_to_ticks(mtime_t ms)
138 #if TIMER_TICKS_PER_SEC < 1000
139 /* Slow timer: avoid rounding down too much. */
140 return (ms * TIMER_TICKS_PER_SEC) / 1000;
142 /* Fast timer: don't overflow ticks_t. */
143 return ms * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
147 /** Convert \a us [us] to ticks. */
148 INLINE ticks_t us_to_ticks(utime_t us)
150 #if TIMER_TICKS_PER_SEC < 1000
151 /* Slow timer: avoid rounding down too much. */
152 return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
154 /* Fast timer: don't overflow ticks_t. */
155 return (us * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
159 /** Convert \a ticks [ticks] to ms. */
160 INLINE mtime_t ticks_to_ms(ticks_t ticks)
162 #if TIMER_TICKS_PER_SEC < 1000
163 /* Slow timer: avoid rounding down too much. */
164 return (ticks * 1000) / TIMER_TICKS_PER_SEC;
166 /* Fast timer: avoid overflowing ticks_t. */
167 return ticks / (TIMER_TICKS_PER_SEC / 1000);
171 /** Convert \a ticks [ticks] to us. */
172 INLINE utime_t ticks_to_us(ticks_t ticks)
174 #if TIMER_TICKS_PER_SEC < 1000
175 /* Slow timer: avoid rounding down too much. */
176 return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
178 /* Fast timer: avoid overflowing ticks_t. */
179 return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
183 /** Convert \a us [us] to hpticks */
184 INLINE hptime_t us_to_hptime(utime_t us)
186 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
187 return us * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
189 return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
193 /** Convert \a hpticks [hptime] to usec */
194 INLINE utime_t hptime_to_us(hptime_t hpticks)
196 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
197 return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
199 return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
200 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
203 void timer_delayTicks(ticks_t delay);
204 INLINE void timer_delay(mtime_t delay)
206 timer_delayTicks(ms_to_ticks(delay));
209 void timer_init(void);
210 void timer_cleanup(void);
212 int timer_testSetup(void);
213 int timer_testRun(void);
214 int timer_testTearDown(void);
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)
221 timer_delayHp(us_to_hptime(delay));
225 #if CONFIG_TIMER_EVENTS
227 #include <mware/event.h>
230 * The timer driver supports multiple synchronous timers
231 * that can trigger an event when they expire.
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 */
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
249 void timer_add(Timer *timer);
250 Timer *timer_abort(Timer *timer);
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)
255 event_initSoftint(&timer->expire, func, user_data);
258 /** Set the timer delay (the time before the event will be triggered) */
259 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
261 timer->_delay = delay;
264 #endif /* CONFIG_TIMER_EVENTS */
266 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
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)
271 event_initSignal(&timer->expire, proc, sigs);
274 #define timer_set_event_signal timer_setSignal
276 #endif /* CONFIG_KERN_SIGNALS */
278 #endif /* DRV_TIMER_H */