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