4 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See README.devlib for information.
11 * \author Bernardo Innocenti <bernie@develer.com>
13 * \brief Hardware independent timer driver (interface)
18 *#* Revision 1.31 2006/07/19 12:56:26 bernie
19 *#* Convert to new Doxygen style.
21 *#* Revision 1.30 2006/02/24 00:26:49 bernie
22 *#* Fixes for CONFIG_KERNEL.
24 *#* Revision 1.29 2006/02/21 21:28:02 bernie
25 *#* New time handling based on TIMER_TICKS_PER_SEC to support slow timers with ticks longer than 1ms.
27 *#* Revision 1.28 2006/02/17 22:24:21 bernie
28 *#* Update POSIX timer emulator.
30 *#* Revision 1.27 2005/11/27 03:04:19 bernie
31 *#* Move test code to timer_test.c; Add OS_HOSTED support.
33 *#* Revision 1.26 2005/11/04 16:20:02 bernie
34 *#* Fix reference to README.devlib in header.
36 *#* Revision 1.25 2005/07/19 07:26:37 bernie
37 *#* Refactor to decouple timer ticks from milliseconds.
39 *#* Revision 1.24 2005/04/11 19:10:28 bernie
40 *#* Include top-level headers from cfg/ subdir.
42 *#* Revision 1.23 2005/03/01 23:25:46 bernie
43 *#* Move event.h to mware/.
45 *#* Revision 1.22 2004/12/13 12:07:06 bernie
46 *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
48 *#* Revision 1.21 2004/12/09 08:35:21 bernie
49 *#* Replace IPTR with iptr_t.
51 *#* Revision 1.20 2004/12/08 08:56:41 bernie
52 *#* Rename sigset_t to sigmask_t; Reformat.
54 *#* Revision 1.19 2004/12/08 08:30:37 bernie
55 *#* Convert to mtime_t; timer_minutes(): Remove.
57 *#* Revision 1.18 2004/11/16 23:09:52 bernie
58 *#* Disable timer_minutes() for targets with 16bit time_t.
60 *#* Revision 1.17 2004/11/16 22:37:14 bernie
61 *#* Replace IPTR with iptr_t.
63 *#* Revision 1.16 2004/08/25 14:12:08 rasky
64 *#* Aggiornato il comment block dei log RCS
66 *#* Revision 1.15 2004/08/10 06:59:09 bernie
67 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
69 *#* Revision 1.12 2004/07/30 14:34:10 rasky
70 *#* Vari fix per documentazione e commenti
71 *#* Aggiunte PP_CATn e STATIC_ASSERT
73 *#* Revision 1.11 2004/07/29 22:40:12 bernie
76 *#* Revision 1.10 2004/07/21 00:13:57 bernie
77 *#* Put timer driver on diet.
79 *#* Revision 1.9 2004/07/20 23:45:01 bernie
80 *#* Finally remove redundant protos.
82 *#* Revision 1.8 2004/07/18 21:57:32 bernie
83 *#* timer_gettick(): Rename to timer_tick() and document better.
85 *#* Revision 1.7 2004/06/27 15:26:17 aleph
86 *#* Declaration fix for build with GCC 3.4
88 *#* Revision 1.6 2004/06/07 18:10:06 aleph
89 *#* Remove free pool of timers; use user-provided Timer structure instead
91 *#* Revision 1.5 2004/06/07 15:57:12 aleph
92 *#* Add function prototypes
94 *#* Revision 1.4 2004/06/06 18:25:44 bernie
95 *#* Rename event macros to look like regular functions.
97 *#* Revision 1.3 2004/06/06 16:57:18 bernie
98 *#* Mark some functions INLINE instead of 'extern inline'.
100 *#* Revision 1.2 2004/06/03 11:27:09 bernie
101 *#* Add dual-license information.
103 *#* Revision 1.1 2004/05/23 18:23:30 bernie
104 *#* Import drv/timer module.
114 * Include platform-specific binding header if we're hosted.
115 * Try the CPU specific one for bare-metal environments.
118 #include OS_HEADER(timer)
120 #include CPU_HEADER(timer)
123 #include <mware/list.h>
124 #include <cfg/debug.h>
125 #include <cfg/compiler.h>
126 #include <appconfig.h>
129 extern volatile ticks_t _clock;
132 * \brief Return the system tick counter (expressed in ticks)
134 * The result is guaranteed to increment monotonically,
135 * but client code must be tolerant with respect to overflows.
137 * The following code is safe:
140 * ticks_t tea_start_time = timer_clock();
144 * if (timer_clock() - tea_start_time > TEAPOT_DELAY)
145 * printf("Your tea, Sir.\n");
148 * \note This function must disable interrupts on 8/16bit CPUs because the
149 * clock variable is larger than the processor word size and can't
150 * be copied atomically.
152 INLINE ticks_t timer_clock(void)
156 ATOMIC(result = _clock);
162 * Faster version of timer_clock(), to be called only when the timer
163 * interrupt is disabled (DISABLE_INTS) or overridden by a
164 * higher-priority or non-nesting interrupt.
168 INLINE ticks_t timer_clock_unlocked(void)
173 /** Convert \a ms [ms] to ticks. */
174 INLINE ticks_t ms_to_ticks(mtime_t ms)
176 #if TIMER_TICKS_PER_SEC < 1000
177 /* Slow timer: avoid rounding down too much. */
178 return (ms * TIMER_TICKS_PER_SEC) / 1000;
180 /* Fast timer: don't overflow ticks_t. */
181 return ms * ((TIMER_TICKS_PER_SEC + 500) / 1000);
185 /** Convert \a us [us] to ticks. */
186 INLINE ticks_t us_to_ticks(utime_t us)
188 #if TIMER_TICKS_PER_SEC < 1000
189 /* Slow timer: avoid rounding down too much. */
190 return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
192 /* Fast timer: don't overflow ticks_t. */
193 return (us * ((TIMER_TICKS_PER_SEC + 500) / 1000)) / 1000;
197 /** Convert \a ticks [ticks] to ms. */
198 INLINE mtime_t ticks_to_ms(ticks_t ticks)
200 #if TIMER_TICKS_PER_SEC < 1000
201 /* Slow timer: avoid rounding down too much. */
202 return (ticks * 1000) / TIMER_TICKS_PER_SEC;
204 /* Fast timer: avoid overflowing ticks_t. */
205 return ticks / (TIMER_TICKS_PER_SEC / 1000);
209 /** Convert \a ticks [ticks] to us. */
210 INLINE utime_t ticks_to_us(ticks_t ticks)
212 #if TIMER_TICKS_PER_SEC < 1000
213 /* Slow timer: avoid rounding down too much. */
214 return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
216 /* Fast timer: avoid overflowing ticks_t. */
217 return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
221 /** Convert \a us [us] to hpticks */
222 INLINE hptime_t us_to_hptime(utime_t us)
224 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
225 return(us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL));
227 return((us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL);
231 /** Convert \a hpticks [hptime] to usec */
232 INLINE utime_t hptime_to_us(hptime_t hpticks)
234 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
235 return(hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC));
237 return((hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC);
238 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
242 void timer_init(void);
243 void timer_delayTicks(ticks_t delay);
244 INLINE void timer_delay(mtime_t delay)
246 timer_delayTicks(ms_to_ticks(delay));
249 #if !defined(CONFIG_TIMER_DISABLE_UDELAY)
250 void timer_busyWait(hptime_t delay);
251 void timer_delayHp(hptime_t delay);
252 INLINE void timer_udelay(utime_t delay)
254 timer_delayHp(us_to_hptime(delay));
258 #ifndef CONFIG_TIMER_DISABLE_EVENTS
260 #include <mware/event.h>
263 * The timer driver supports multiple synchronous timers
264 * that can trigger an event when they expire.
271 Node link; /**< Link into timers queue */
272 ticks_t _delay; /**< Timer delay in ms */
273 ticks_t tick; /**< Timer will expire at this tick */
274 Event expire; /**< Event to execute when the timer expires */
278 /** Timer is active when Timer.magic contains this value (for debugging purposes). */
279 #define TIMER_MAGIC_ACTIVE 0xABBA
280 #define TIMER_MAGIC_INACTIVE 0xBAAB
282 extern void timer_add(Timer *timer);
283 extern Timer *timer_abort(Timer *timer);
285 /** Set the timer so that it calls an user hook when it expires */
286 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
288 event_initSoftInt(&timer->expire, func, user_data);
291 /** Set the timer delay (the time before the event will be triggered) */
292 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
294 timer->_delay = delay;
297 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
299 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
301 /** Set the timer so that it sends a signal when it expires */
302 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
304 event_initSignal(&timer->expire, proc, sigs);
307 #endif /* CONFIG_KERN_SIGNALS */
310 #endif /* DRV_TIMER_H */