First version
[3rdparty/ote_partner/tlk.git] / kernel / timer.c
1 /*
2  * Copyright (c) 2008-2009 Travis Geiselbrecht
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining
5  * a copy of this software and associated documentation files
6  * (the "Software"), to deal in the Software without restriction,
7  * including without limitation the rights to use, copy, modify, merge,
8  * publish, distribute, sublicense, and/or sell copies of the Software,
9  * and to permit persons to whom the Software is furnished to do so,
10  * subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be
13  * included in all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22  */
23
24 /**
25  * @file
26  * @brief  Kernel timer subsystem
27  * @defgroup timer Timers
28  *
29  * The timer subsystem allows functions to be scheduled for later
30  * execution.  Each timer object is used to cause one function to
31  * be executed at a later time.
32  *
33  * Timer callback functions are called in interrupt context.
34  *
35  * @{
36  */
37 #include <debug.h>
38 #include <assert.h>
39 #include <list.h>
40 #include <kernel/thread.h>
41 #include <kernel/timer.h>
42 #include <platform/timer.h>
43 #include <platform.h>
44
45 #define LOCAL_TRACE 0
46
47 static struct list_node timer_queue;
48
49 static enum handler_return timer_tick(void *arg, lk_time_t now);
50
51 /**
52  * @brief  Initialize a timer object
53  */
54 void timer_initialize(timer_t *timer)
55 {
56         timer->magic = TIMER_MAGIC;
57         list_clear_node(&timer->node);
58         timer->scheduled_time = 0;
59         timer->periodic_time = 0;
60         timer->callback = 0;
61         timer->arg = 0;
62 }
63
64 static void insert_timer_in_queue(timer_t *timer)
65 {
66         timer_t *entry;
67
68         LTRACEF("timer %p, scheduled %lu, periodic %lu\n", timer, timer->scheduled_time, timer->periodic_time);
69
70         list_for_every_entry(&timer_queue, entry, timer_t, node) {
71                 if (TIME_GT(entry->scheduled_time, timer->scheduled_time)) {
72                         list_add_before(&entry->node, &timer->node);
73                         return;
74                 }
75         }
76
77         /* walked off the end of the list */
78         list_add_tail(&timer_queue, &timer->node);
79 }
80
81 static void timer_set(timer_t *timer, lk_time_t delay, lk_time_t period, timer_callback callback, void *arg)
82 {
83         lk_time_t now;
84
85         LTRACEF("timer %p, delay %lu, period %lu, callback %p, arg %p, now %lu\n", timer, delay, period, callback, arg, now);
86
87         DEBUG_ASSERT(timer->magic == TIMER_MAGIC);      
88
89         if (list_in_list(&timer->node)) {
90                 panic("timer %p already in list\n", timer);
91         }
92
93         now = current_time();
94         timer->scheduled_time = now + delay;
95         timer->periodic_time = period;
96         timer->callback = callback;
97         timer->arg = arg;
98
99         LTRACEF("scheduled time %lu\n", timer->scheduled_time);
100
101         enter_critical_section();
102
103         insert_timer_in_queue(timer);
104
105 #if PLATFORM_HAS_DYNAMIC_TIMER
106         if (list_peek_head_type(&timer_queue, timer_t, node) == timer) {
107                 /* we just modified the head of the timer queue */
108                 LTRACEF("setting new timer for %u msecs\n", (uint)delay);
109                 platform_set_oneshot_timer(timer_tick, NULL, delay);
110         }
111 #endif
112
113         exit_critical_section();
114 }
115
116 /**
117  * @brief  Set up a timer that executes once
118  *
119  * This function specifies a callback function to be called after a specified
120  * delay.  The function will be called one time.
121  *
122  * @param  timer The timer to use
123  * @param  delay The delay, in ms, before the timer is executed
124  * @param  callback  The function to call when the timer expires
125  * @param  arg  The argument to pass to the callback
126  *
127  * The timer function is declared as:
128  *   enum handler_return callback(struct timer *, lk_time_t now, void *arg) { ... }
129  */
130 void timer_set_oneshot(timer_t *timer, lk_time_t delay, timer_callback callback, void *arg)
131 {
132         if (delay == 0)
133                 delay = 1;
134         timer_set(timer, delay, 0, callback, arg);
135 }
136
137 /**
138  * @brief  Set up a timer that executes repeatedly
139  *
140  * This function specifies a callback function to be called after a specified
141  * delay.  The function will be called repeatedly.
142  *
143  * @param  timer The timer to use
144  * @param  delay The delay, in ms, before the timer is executed
145  * @param  callback  The function to call when the timer expires
146  * @param  arg  The argument to pass to the callback
147  *
148  * The timer function is declared as:
149  *   enum handler_return callback(struct timer *, lk_time_t now, void *arg) { ... }
150  */
151 void timer_set_periodic(timer_t *timer, lk_time_t period, timer_callback callback, void *arg)
152 {
153         if (period == 0)
154                 period = 1;
155         timer_set(timer, period, period, callback, arg);
156 }
157
158 /**
159  * @brief  Cancel a pending timer
160  */
161 void timer_cancel(timer_t *timer)
162 {
163         DEBUG_ASSERT(timer->magic == TIMER_MAGIC);
164
165         enter_critical_section();
166
167 #if PLATFORM_HAS_DYNAMIC_TIMER
168         timer_t *oldhead = list_peek_head_type(&timer_queue, timer_t, node);
169 #endif
170
171         if (list_in_list(&timer->node))
172                 list_delete(&timer->node);
173
174         /* to keep it from being reinserted into the queue if called from 
175          * periodic timer callback.
176          */
177         timer->periodic_time = 0;
178         timer->callback = NULL;
179         timer->arg = NULL;
180
181 #if PLATFORM_HAS_DYNAMIC_TIMER
182         /* see if we've just modified the head of the timer queue */
183         timer_t *newhead = list_peek_head_type(&timer_queue, timer_t, node);
184         if (newhead == NULL) {
185                 LTRACEF("clearing old hw timer, nothing in the queue\n");
186                 platform_stop_timer();
187         } else if (newhead != oldhead) {
188                 lk_time_t delay;
189                 lk_time_t now = current_time();
190
191                 if (TIME_LT(newhead->scheduled_time, now))
192                         delay = 0;
193                 else
194                         delay = newhead->scheduled_time - now;
195
196                 LTRACEF("setting new timer to %d\n", delay);
197                 platform_set_oneshot_timer(timer_tick, NULL, delay);
198         }
199 #endif
200
201         exit_critical_section();
202 }
203
204 /* called at interrupt time to process any pending timers */
205 static enum handler_return timer_tick(void *arg, lk_time_t now)
206 {
207         timer_t *timer;
208         enum handler_return ret = INT_NO_RESCHEDULE;
209
210         THREAD_STATS_INC(timer_ints);
211
212         LTRACEF("now %lu, sp %p\n", now, __GET_FRAME());
213
214         for (;;) {
215                 /* see if there's an event to process */
216                 timer = list_peek_head_type(&timer_queue, timer_t, node);
217                 if (likely(timer == 0))
218                         break;
219                 LTRACEF("next item on timer queue %p at %lu now %lu (%p, arg %p)\n", timer, timer->scheduled_time, now, timer->callback, timer->arg);
220                 if (likely(TIME_LT(now, timer->scheduled_time)))
221                         break;
222
223                 /* process it */
224                 LTRACEF("timer %p\n", timer);
225                 DEBUG_ASSERT(timer && timer->magic == TIMER_MAGIC);
226                 list_delete(&timer->node);
227
228                 LTRACEF("dequeued timer %p, scheduled %lu periodic %lu\n", timer, timer->scheduled_time, timer->periodic_time);
229
230                 THREAD_STATS_INC(timers);
231
232                 bool periodic = timer->periodic_time > 0;
233
234                 LTRACEF("timer %p firing callback %p, arg %p\n", timer, timer->callback, timer->arg);
235                 if (timer->callback(timer, now, timer->arg) == INT_RESCHEDULE)
236                         ret = INT_RESCHEDULE;
237
238                 /* if it was a periodic timer and it hasn't been requeued
239                  * by the callback put it back in the list
240                  */
241                 if (periodic && !list_in_list(&timer->node) && timer->periodic_time > 0) {
242                         LTRACEF("periodic timer, period %u\n", (uint)timer->periodic_time);
243                         timer->scheduled_time = now + timer->periodic_time;
244                         insert_timer_in_queue(timer);
245                 }
246         }
247
248 #if PLATFORM_HAS_DYNAMIC_TIMER
249         /* reset the timer to the next event */
250         timer = list_peek_head_type(&timer_queue, timer_t, node);
251         if (timer) {
252                 /* has to be the case or it would have fired already */
253                 ASSERT(TIME_GT(timer->scheduled_time, now));
254
255                 lk_time_t delay = timer->scheduled_time - now;
256
257                 LTRACEF("setting new timer for %u msecs for event %p\n", (uint)delay, timer);
258                 platform_set_oneshot_timer(timer_tick, NULL, delay);
259         }
260 #else
261         /* let the scheduler have a shot to do quantum expiration, etc */
262         /* in case of dynamic timer, the scheduler will set up a periodic timer */
263         if (thread_timer_tick() == INT_RESCHEDULE)
264                 ret = INT_RESCHEDULE;
265 #endif
266
267         ASSERT(in_critical_section());
268         return ret;
269 }
270
271 void timer_init(void)
272 {
273         list_initialize(&timer_queue);
274
275         /* register for a periodic timer tick */
276         platform_set_periodic_timer(timer_tick, NULL, 10); /* 10ms */
277 }
278
279