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 (interface)
36 * \author Bernie Innocenti <bernie@codewiz.org>
43 #include <cfg/macros.h>
50 * Include platform-specific binding header if we're hosted.
51 * Try the CPU specific one for bare-metal environments.
54 #include OS_HEADER(timer)
56 #include CPU_HEADER(timer)
59 #include "cfg/cfg_timer.h"
60 #include <cfg/debug.h>
61 #include <cfg/compiler.h>
63 #include <struct/list.h>
66 * Sanity check for config parameters required by this module.
68 #if !defined(CONFIG_TIMER_EVENTS) || ((CONFIG_TIMER_EVENTS != 0) && CONFIG_TIMER_EVENTS != 1)
69 #error CONFIG_TIMER_EVENTS must be set to either 0 or 1 in cfg_timer.h
71 #if !defined(CONFIG_TIMER_UDELAY) || ((CONFIG_TIMER_UDELAY != 0) && CONFIG_TIMER_EVENTS != 1)
72 #error CONFIG_TIMER_UDELAY must be set to either 0 or 1 in cfg_timer.h
74 #if defined(CONFIG_TIMER_DISABLE_UDELAY)
75 #error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY. Use CONFIG_TIMER_UDELAY
77 #if defined(CONFIG_TIMER_DISABLE_EVENTS)
78 #error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS. Use CONFIG_TIMER_EVENTS
81 extern volatile ticks_t _clock;
84 * \brief Return the system tick counter (expressed in ticks)
86 * The result is guaranteed to increment monotonically,
87 * but client code must be tolerant with respect to overflows.
89 * The following code is safe:
93 * ticks_t tea_start_time = timer_clock();
97 * if (timer_clock() - tea_start_time > TEAPOT_DELAY)
99 * printf("Your tea, Sir.\n");
106 * \note This function must disable interrupts on 8/16bit CPUs because the
107 * clock variable is larger than the processor word size and can't
108 * be copied atomically.
110 INLINE ticks_t timer_clock(void)
114 ATOMIC(result = _clock);
120 * Faster version of timer_clock(), to be called only when the timer
121 * interrupt is disabled (DISABLE_INTS) or overridden by a
122 * higher-priority or non-nesting interrupt.
126 INLINE ticks_t timer_clock_unlocked(void)
131 /** Convert \a ms [ms] to ticks. */
132 INLINE ticks_t ms_to_ticks(mtime_t ms)
134 #if TIMER_TICKS_PER_SEC < 1000
135 /* Slow timer: avoid rounding down too much. */
136 return (ms * TIMER_TICKS_PER_SEC) / 1000;
138 /* Fast timer: don't overflow ticks_t. */
139 return ms * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
143 /** Convert \a us [us] to ticks. */
144 INLINE ticks_t us_to_ticks(utime_t us)
146 #if TIMER_TICKS_PER_SEC < 1000
147 /* Slow timer: avoid rounding down too much. */
148 return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
150 /* Fast timer: don't overflow ticks_t. */
151 return (us * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
155 /** Convert \a ticks [ticks] to ms. */
156 INLINE mtime_t ticks_to_ms(ticks_t ticks)
158 #if TIMER_TICKS_PER_SEC < 1000
159 /* Slow timer: avoid rounding down too much. */
160 return (ticks * 1000) / TIMER_TICKS_PER_SEC;
162 /* Fast timer: avoid overflowing ticks_t. */
163 return ticks / (TIMER_TICKS_PER_SEC / 1000);
167 /** Convert \a ticks [ticks] to us. */
168 INLINE utime_t ticks_to_us(ticks_t ticks)
170 #if TIMER_TICKS_PER_SEC < 1000
171 /* Slow timer: avoid rounding down too much. */
172 return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
174 /* Fast timer: avoid overflowing ticks_t. */
175 return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
179 /** Convert \a us [us] to hpticks */
180 INLINE hptime_t us_to_hptime(utime_t us)
182 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
183 return us * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
185 return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
189 /** Convert \a hpticks [hptime] to usec */
190 INLINE utime_t hptime_to_us(hptime_t hpticks)
192 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
193 return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
195 return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
196 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
199 void timer_delayTicks(ticks_t delay);
200 INLINE void timer_delay(mtime_t delay)
202 timer_delayTicks(ms_to_ticks(delay));
205 void timer_init(void);
206 void timer_cleanup(void);
208 int timer_testSetup(void);
209 int timer_testRun(void);
210 int timer_testTearDown(void);
212 #if CONFIG_TIMER_UDELAY
213 void timer_busyWait(hptime_t delay);
214 void timer_delayHp(hptime_t delay);
215 INLINE void timer_udelay(utime_t delay)
217 timer_delayHp(us_to_hptime(delay));
221 #if CONFIG_TIMER_EVENTS
223 #include <mware/event.h>
226 * The timer driver supports multiple synchronous timers
227 * that can trigger an event when they expire.
234 Node link; /**< Link into timers queue */
235 ticks_t _delay; /**< [ticks] Timer delay */
236 ticks_t tick; /**< [ticks] When this timer will expire */
237 Event expire; /**< Event to execute when the timer expires */
241 /** Timer is active when Timer.magic contains this value (for debugging purposes). */
242 #define TIMER_MAGIC_ACTIVE 0xABBA
243 #define TIMER_MAGIC_INACTIVE 0xBAAB
245 void timer_add(Timer *timer);
246 Timer *timer_abort(Timer *timer);
248 /** Set the timer so that it calls an user hook when it expires */
249 INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
251 event_initSoftInt(&timer->expire, func, user_data);
255 #define timer_set_event_softint timer_setSoftint
257 /** Set the timer delay (the time before the event will be triggered) */
258 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
260 timer->_delay = delay;
263 #endif /* CONFIG_TIMER_EVENTS */
265 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
267 /** Set the timer so that it sends a signal when it expires */
268 INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
270 event_initSignal(&timer->expire, proc, sigs);
273 #define timer_set_event_signal timer_setSignal
275 #endif /* CONFIG_KERN_SIGNALS */
277 #endif /* DRV_TIMER_H */