Add demo application.
[bertos.git] / drv / timer.h
1 /*!
2  * \file
3  * <!--
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.
7  * -->
8  *
9  * \version $Id$
10  *
11  * \author Bernardo Innocenti <bernie@develer.com>
12  *
13  * \brief Hardware independent timer driver (interface)
14  */
15
16 /*#*
17  *#* $Log$
18  *#* Revision 1.30  2006/02/24 00:26:49  bernie
19  *#* Fixes for CONFIG_KERNEL.
20  *#*
21  *#* Revision 1.29  2006/02/21 21:28:02  bernie
22  *#* New time handling based on TIMER_TICKS_PER_SEC to support slow timers with ticks longer than 1ms.
23  *#*
24  *#* Revision 1.28  2006/02/17 22:24:21  bernie
25  *#* Update POSIX timer emulator.
26  *#*
27  *#* Revision 1.27  2005/11/27 03:04:19  bernie
28  *#* Move test code to timer_test.c; Add OS_HOSTED support.
29  *#*
30  *#* Revision 1.26  2005/11/04 16:20:02  bernie
31  *#* Fix reference to README.devlib in header.
32  *#*
33  *#* Revision 1.25  2005/07/19 07:26:37  bernie
34  *#* Refactor to decouple timer ticks from milliseconds.
35  *#*
36  *#* Revision 1.24  2005/04/11 19:10:28  bernie
37  *#* Include top-level headers from cfg/ subdir.
38  *#*
39  *#* Revision 1.23  2005/03/01 23:25:46  bernie
40  *#* Move event.h to mware/.
41  *#*
42  *#* Revision 1.22  2004/12/13 12:07:06  bernie
43  *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
44  *#*
45  *#* Revision 1.21  2004/12/09 08:35:21  bernie
46  *#* Replace IPTR with iptr_t.
47  *#*
48  *#* Revision 1.20  2004/12/08 08:56:41  bernie
49  *#* Rename sigset_t to sigmask_t; Reformat.
50  *#*
51  *#* Revision 1.19  2004/12/08 08:30:37  bernie
52  *#* Convert to mtime_t; timer_minutes(): Remove.
53  *#*
54  *#* Revision 1.18  2004/11/16 23:09:52  bernie
55  *#* Disable timer_minutes() for targets with 16bit time_t.
56  *#*
57  *#* Revision 1.17  2004/11/16 22:37:14  bernie
58  *#* Replace IPTR with iptr_t.
59  *#*
60  *#* Revision 1.16  2004/08/25 14:12:08  rasky
61  *#* Aggiornato il comment block dei log RCS
62  *#*
63  *#* Revision 1.15  2004/08/10 06:59:09  bernie
64  *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
65  *#*
66  *#* Revision 1.12  2004/07/30 14:34:10  rasky
67  *#* Vari fix per documentazione e commenti
68  *#* Aggiunte PP_CATn e STATIC_ASSERT
69  *#*
70  *#* Revision 1.11  2004/07/29 22:40:12  bernie
71  *#* Spelling fix.
72  *#*
73  *#* Revision 1.10  2004/07/21 00:13:57  bernie
74  *#* Put timer driver on diet.
75  *#*
76  *#* Revision 1.9  2004/07/20 23:45:01  bernie
77  *#* Finally remove redundant protos.
78  *#*
79  *#* Revision 1.8  2004/07/18 21:57:32  bernie
80  *#* timer_gettick(): Rename to timer_tick() and document better.
81  *#*
82  *#* Revision 1.7  2004/06/27 15:26:17  aleph
83  *#* Declaration fix for build with GCC 3.4
84  *#*
85  *#* Revision 1.6  2004/06/07 18:10:06  aleph
86  *#* Remove free pool of timers; use user-provided Timer structure instead
87  *#*
88  *#* Revision 1.5  2004/06/07 15:57:12  aleph
89  *#* Add function prototypes
90  *#*
91  *#* Revision 1.4  2004/06/06 18:25:44  bernie
92  *#* Rename event macros to look like regular functions.
93  *#*
94  *#* Revision 1.3  2004/06/06 16:57:18  bernie
95  *#* Mark some functions INLINE instead of 'extern inline'.
96  *#*
97  *#* Revision 1.2  2004/06/03 11:27:09  bernie
98  *#* Add dual-license information.
99  *#*
100  *#* Revision 1.1  2004/05/23 18:23:30  bernie
101  *#* Import drv/timer module.
102  *#*
103  *#*/
104 #ifndef DRV_TIMER_H
105 #define DRV_TIMER_H
106
107 #include <cfg/os.h>
108 #include <cfg/cpu.h>
109
110 /*
111  * Include platform-specific binding header if we're hosted.
112  * Try the CPU specific one for bare-metal environments.
113  */
114 #if OS_HOSTED
115         #include OS_HEADER(timer)
116 #else
117         #include CPU_HEADER(timer)
118 #endif
119
120 #include <mware/list.h>
121 #include <cfg/debug.h>
122 #include <cfg/compiler.h>
123 #include <appconfig.h>
124
125
126 extern volatile ticks_t _clock;
127
128 /*!
129  * \brief Return the system tick counter (expressed in ticks)
130  *
131  * The result is guaranteed to increment monotonically,
132  * but client code must be tolerant with respect to overflows.
133  *
134  * The following code is safe:
135  *
136  * \code
137  *   ticks_t tea_start_time = timer_clock();
138  *
139  *   boil_water();
140  *
141  *   if (timer_clock() - tea_start_time > TEAPOT_DELAY)
142  *       printf("Your tea, Sir.\n");
143  * \endcode
144  *
145  * \note This function must disable interrupts on 8/16bit CPUs because the
146  * clock variable is larger than the processor word size and can't
147  * be copied atomically.
148  */
149 INLINE ticks_t timer_clock(void)
150 {
151         ticks_t result;
152
153         ATOMIC(result = _clock);
154
155         return result;
156 }
157
158 /*!
159  * Faster version of timer_clock(), to be called only when the timer
160  * interrupt is disabled (DISABLE_INTS) or overridden by a
161  * higher-priority or non-nesting interrupt.
162  *
163  * \sa timer_ticks
164  */
165 INLINE ticks_t timer_clock_unlocked(void)
166 {
167         return _clock;
168 }
169
170 /*! Convert \a ms [ms] to ticks. */
171 INLINE ticks_t ms_to_ticks(mtime_t ms)
172 {
173 #if TIMER_TICKS_PER_SEC < 1000
174         /* Slow timer: avoid rounding down too much. */
175         return (ms * TIMER_TICKS_PER_SEC) / 1000;
176 #else
177         /* Fast timer: don't overflow ticks_t. */
178         return ms * ((TIMER_TICKS_PER_SEC + 500) / 1000);
179 #endif
180 }
181
182 /*! Convert \a us [us] to ticks. */
183 INLINE ticks_t us_to_ticks(utime_t us)
184 {
185 #if TIMER_TICKS_PER_SEC < 1000
186         /* Slow timer: avoid rounding down too much. */
187         return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000;
188 #else
189         /* Fast timer: don't overflow ticks_t. */
190         return (us * ((TIMER_TICKS_PER_SEC + 500) / 1000)) / 1000;
191 #endif
192 }
193
194 /*! Convert \a ticks [ticks] to ms. */
195 INLINE mtime_t ticks_to_ms(ticks_t ticks)
196 {
197 #if TIMER_TICKS_PER_SEC < 1000
198         /* Slow timer: avoid rounding down too much. */
199         return (ticks * 1000) / TIMER_TICKS_PER_SEC;
200 #else
201         /* Fast timer: avoid overflowing ticks_t. */
202         return ticks / (TIMER_TICKS_PER_SEC / 1000);
203 #endif
204 }
205
206 /*! Convert \a ticks [ticks] to us. */
207 INLINE utime_t ticks_to_us(ticks_t ticks)
208 {
209 #if TIMER_TICKS_PER_SEC < 1000
210         /* Slow timer: avoid rounding down too much. */
211         return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000;
212 #else
213         /* Fast timer: avoid overflowing ticks_t. */
214         return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000;
215 #endif
216 }
217
218 /*! Convert \a us [us] to hpticks */
219 INLINE hptime_t us_to_hptime(utime_t us)
220 {
221 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
222         return(us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL));
223 #else
224         return((us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL);
225 #endif
226 }
227
228 /*! Convert \a hpticks [hptime] to usec */
229 INLINE utime_t hptime_to_us(hptime_t hpticks)
230 {
231 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
232         return(hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC));
233 #else
234         return((hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC);
235 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
236 }
237
238
239 void timer_init(void);
240 void timer_delayTicks(ticks_t delay);
241 INLINE void timer_delay(mtime_t delay)
242 {
243         timer_delayTicks(ms_to_ticks(delay));
244 }
245
246 #if !defined(CONFIG_TIMER_DISABLE_UDELAY)
247 void timer_busyWait(hptime_t delay);
248 void timer_delayHp(hptime_t delay);
249 INLINE void timer_udelay(utime_t delay)
250 {
251         timer_delayHp(us_to_hptime(delay));
252 }
253 #endif
254
255 #ifndef CONFIG_TIMER_DISABLE_EVENTS
256
257 #include <mware/event.h>
258
259 /*!
260  * The timer driver supports multiple synchronous timers
261  * that can trigger an event when they expire.
262  *
263  * \sa timer_add()
264  * \sa timer_abort()
265  */
266 typedef struct Timer
267 {
268         Node    link;     /*!< Link into timers queue */
269         ticks_t _delay;   /*!< Timer delay in ms */
270         ticks_t tick;     /*!< Timer will expire at this tick */
271         Event   expire;   /*!< Event to execute when the timer expires */
272         DB(uint16_t magic;)
273 } Timer;
274
275 /*! Timer is active when Timer.magic contains this value (for debugging purposes). */
276 #define TIMER_MAGIC_ACTIVE    0xABBA
277 #define TIMER_MAGIC_INACTIVE  0xBAAB
278
279 extern void timer_add(Timer *timer);
280 extern Timer *timer_abort(Timer *timer);
281
282 /*! Set the timer so that it calls an user hook when it expires */
283 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
284 {
285         event_initSoftInt(&timer->expire, func, user_data);
286 }
287
288 /*! Set the timer delay (the time before the event will be triggered) */
289 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
290 {
291         timer->_delay = delay;
292 }
293
294 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
295
296 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
297
298 /*! Set the timer so that it sends a signal when it expires */
299 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
300 {
301         event_initSignal(&timer->expire, proc, sigs);
302 }
303
304 #endif /* CONFIG_KERN_SIGNALS */
305
306
307 #endif /* DRV_TIMER_H */