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