Fix timer test
[bertos.git] / bertos / drv / timer.c
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, 2006 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
31  * -->
32  *
33  * \brief Hardware independent timer driver (implementation)
34  *
35  * \version $Id$
36  * \author Bernie Innocenti <bernie@codewiz.org>
37  */
38
39 #include "timer.h"
40
41 #include "cfg/cfg_timer.h"
42 #include "cfg/cfg_wdt.h"
43 #include "cfg/cfg_kern.h"
44 #include <cfg/os.h>
45 #include <cfg/debug.h>
46 #include <cfg/module.h>
47
48 #include <cpu/attr.h>
49 #include <cpu/types.h>
50 #include <cpu/irq.h>
51
52 /*
53  * Include platform-specific binding code if we're hosted.
54  * Try the CPU specific one for bare-metal environments.
55  */
56 #if OS_HOSTED
57         #include OS_CSOURCE(timer)
58 #else
59         #include CPU_CSOURCE(timer)
60 #endif
61
62 /*
63  * Sanity check for config parameters required by this module.
64  */
65 #if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
66         #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
67 #endif
68 #if !defined(CONFIG_WATCHDOG) || ((CONFIG_WATCHDOG != 0) && CONFIG_WATCHDOG != 1)
69         #error CONFIG_WATCHDOG must be set to either 0 or 1 in config.h
70 #endif
71
72 #if CONFIG_WATCHDOG
73         #include <drv/wdt.h>
74 #endif
75
76 #if CONFIG_KERNEL
77         #if CONFIG_KERN_PREEMPTIVE
78                 #include <hw/switch.h>
79         #endif
80         #if CONFIG_KERN_SIGNALS
81                 #include <kern/signal.h> /* sig_wait(), sig_check() */
82                 #include <kern/proc.h>   /* proc_current() */
83                 #include <cfg/macros.h>  /* BV() */
84         #endif
85 #endif
86
87
88 /**
89  * \def CONFIG_TIMER_STROBE
90  *
91  * This is a debug facility that can be used to
92  * monitor timer interrupt activity on an external pin.
93  *
94  * To use strobes, redefine the macros TIMER_STROBE_ON,
95  * TIMER_STROBE_OFF and TIMER_STROBE_INIT and set
96  * CONFIG_TIMER_STROBE to 1.
97  */
98 #if !defined(CONFIG_TIMER_STROBE) || !CONFIG_TIMER_STROBE
99         #define TIMER_STROBE_ON    do {/*nop*/} while(0)
100         #define TIMER_STROBE_OFF   do {/*nop*/} while(0)
101         #define TIMER_STROBE_INIT  do {/*nop*/} while(0)
102 #endif
103
104
105 /// Master system clock (1 tick accuracy)
106 volatile ticks_t _clock;
107
108
109 #ifndef CONFIG_TIMER_DISABLE_EVENTS
110
111 /**
112  * List of active asynchronous timers.
113  */
114 REGISTER static List timers_queue;
115
116
117 /**
118  * Add the specified timer to the software timer service queue.
119  * When the delay indicated by the timer expires, the timer
120  * device will execute the event associated with it.
121  *
122  * \note Interrupt safe
123  */
124 void timer_add(Timer *timer)
125 {
126         Timer *node;
127         cpuflags_t flags;
128
129
130         /* Inserting timers twice causes mayhem. */
131         ASSERT(timer->magic != TIMER_MAGIC_ACTIVE);
132         DB(timer->magic = TIMER_MAGIC_ACTIVE;)
133
134         IRQ_SAVE_DISABLE(flags);
135
136         /* Calculate expiration time for this timer */
137         timer->tick = _clock + timer->_delay;
138
139         /*
140          * Search for the first node whose expiration time is
141          * greater than the timer we want to add.
142          */
143         node = (Timer *)LIST_HEAD(&timers_queue);
144         while (node->link.succ)
145         {
146                 /*
147                  * Stop just after the insertion point.
148                  * (this fancy compare takes care of wrap-arounds).
149                  */
150                 if (node->tick - timer->tick > 0)
151                         break;
152
153                 /* Go to next node */
154                 node = (Timer *)node->link.succ;
155         }
156
157         /* Enqueue timer request into the list */
158         INSERT_BEFORE(&timer->link, &node->link);
159
160         IRQ_RESTORE(flags);
161 }
162
163
164 /**
165  * Remove a timer from the timers queue before it has expired.
166  *
167  * \note Attempting to remove a timer already expired cause
168  *       undefined behaviour.
169  */
170 Timer *timer_abort(Timer *timer)
171 {
172         ATOMIC(REMOVE(&timer->link));
173         DB(timer->magic = TIMER_MAGIC_INACTIVE;)
174
175         return timer;
176 }
177
178 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
179
180
181 /**
182  * Wait for the specified amount of timer ticks.
183  */
184 void timer_delayTicks(ticks_t delay)
185 {
186         /* We shouldn't sleep with interrupts disabled */
187         ASSERT_IRQ_ENABLED();
188
189 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
190         Timer t;
191
192         ASSERT(!sig_check(SIG_SINGLE));
193         timer_set_event_signal(&t, proc_current(), SIG_SINGLE);
194         timer_setDelay(&t, delay);
195         timer_add(&t);
196         sig_wait(SIG_SINGLE);
197
198 #else /* !CONFIG_KERN_SIGNALS */
199
200         ticks_t start = timer_clock();
201
202         /* Busy wait */
203         while (timer_clock() - start < delay)
204         {
205 #if CONFIG_WATCHDOG
206                 wdt_reset();
207 #endif
208         }
209
210 #endif /* !CONFIG_KERN_SIGNALS */
211 }
212
213
214 #ifndef CONFIG_TIMER_DISABLE_UDELAY
215
216 /**
217  * Busy wait until the specified amount of high-precision ticks have elapsed.
218  *
219  * \note This function is interrupt safe, the only
220  *       requirement is a running hardware timer.
221  */
222 void timer_busyWait(hptime_t delay)
223 {
224         hptime_t now, prev = timer_hw_hpread();
225         hptime_t delta;
226
227         for(;;)
228         {
229                 now = timer_hw_hpread();
230                 /*
231                  * We rely on hptime_t being unsigned here to
232                  * reduce the modulo to an AND in the common
233                  * case of TIMER_HW_CNT.
234                  */
235                 delta = (now - prev) % TIMER_HW_CNT;
236                 if (delta >= delay)
237                         break;
238                 delay -= delta;
239                 prev = now;
240         }
241 }
242
243 /**
244  * Wait for the specified amount of time (expressed in microseconds).
245  *
246  * \bug In AVR arch the maximum amount of time that can be used as
247  *      delay could be very limited, depending on the hardware timer
248  *      used. Check timer_avr.h, and what register is used as hptime_t.
249  */
250 void timer_delayHp(hptime_t delay)
251 {
252         if (UNLIKELY(delay > us_to_hptime(1000)))
253         {
254                 timer_delayTicks(delay / (TIMER_HW_HPTICKS_PER_SEC / TIMER_TICKS_PER_SEC));
255                 delay %= (TIMER_HW_HPTICKS_PER_SEC / TIMER_TICKS_PER_SEC);
256         }
257
258         timer_busyWait(delay);
259 }
260 #endif /* CONFIG_TIMER_DISABLE_UDELAY */
261
262
263 /**
264  * Timer interrupt handler. Find soft timers expired and
265  * trigger corresponding events.
266  */
267 DEFINE_TIMER_ISR
268 {
269         /*
270          * With the Metrowerks compiler, the only way to force the compiler generate
271          * an interrupt service routine is to put a pragma directive within the function
272          * body.
273          */
274         #ifdef __MWERKS__
275         #pragma interrupt saveall
276         #endif
277
278 #ifndef CONFIG_TIMER_DISABLE_EVENTS
279         Timer *timer;
280 #endif
281         /*
282          * On systems sharing IRQ line and vector, this check is needed
283          * to ensure that IRQ is generated by timer source.
284          */
285         if (!timer_hw_triggered())
286                 return;
287
288         TIMER_STROBE_ON;
289
290         /* Perform hw IRQ handling */
291         timer_hw_irq();
292
293         /* Update the master ms counter */
294         ++_clock;
295
296 #ifndef CONFIG_TIMER_DISABLE_EVENTS
297         /*
298          * Check the first timer request in the list and process
299          * it when it has expired. Repeat this check until the
300          * first node has not yet expired. Since the list is sorted
301          * by expiry time, all the following requests are guaranteed
302          * to expire later.
303          */
304         while ((timer = (Timer *)LIST_HEAD(&timers_queue))->link.succ)
305         {
306                 /* This request in list has not yet expired? */
307                 if (_clock - timer->tick < 0)
308                         break;
309
310                 /* Retreat the expired timer */
311                 REMOVE(&timer->link);
312                 DB(timer->magic = TIMER_MAGIC_INACTIVE;)
313
314                 /* Execute the associated event */
315                 event_do(&timer->expire);
316         }
317 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
318
319         TIMER_STROBE_OFF;
320 }
321
322 MOD_DEFINE(timer)
323
324 /**
325  * Initialize timer
326  */
327 void timer_init(void)
328 {
329         TIMER_STROBE_INIT;
330
331 #ifndef CONFIG_TIMER_DISABLE_EVENTS
332         LIST_INIT(&timers_queue);
333 #endif
334
335         _clock = 0;
336
337         timer_hw_init();
338
339         MOD_INIT(timer);
340 }
341
342
343 #if (ARCH & ARCH_EMUL)
344 /**
345  * Stop timer (only used by emulator)
346  */
347 void timer_cleanup(void)
348 {
349         MOD_CLEANUP(timer);
350
351         timer_hw_cleanup();
352
353         // Hmmm... apparently, the demo app does not cleanup properly
354         //ASSERT(LIST_EMPTY(&timers_queue));
355 }
356 #endif /* ARCH_EMUL */