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