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 #include "hw/hw_timer.h"
  41
  42 #include "cfg/cfg_timer.h"
  43 #include "cfg/cfg_wdt.h"
  44 #include "cfg/cfg_proc.h"
  45 #include "cfg/cfg_signal.h"
  46 #include <cfg/os.h>
  47 #include <cfg/debug.h>
  48 #include <cfg/module.h>
  49
  50 #include <cpu/attr.h>
  51 #include <cpu/types.h>
  52 #include <cpu/irq.h>
  53 #include <cpu/power.h> // cpu_relax()
  54
  55 /*
  56  * Include platform-specific binding code if we're hosted.
  57  * Try the CPU specific one for bare-metal environments.
  58  */
  59 #if OS_HOSTED
  60         //#include OS_CSOURCE(timer)
  61         #include <emul/timer_posix.c>
  62 #else
  63         #ifndef WIZ_AUTOGEN
  64                 #warning Deprecated: now you should include timer_<cpu> directly in the makefile. Remove this line and the following once done.
  65                 #include CPU_CSOURCE(timer)
  66         #endif
  67 #endif
  68
  69 /*
  70  * Sanity check for config parameters required by this module.
  71  */
  72 #if !defined(CONFIG_KERN) || ((CONFIG_KERN != 0) && CONFIG_KERN != 1)
  73         #error CONFIG_KERN must be set to either 0 or 1 in config.h
  74 #endif
  75 #if !defined(CONFIG_WATCHDOG) || ((CONFIG_WATCHDOG != 0) && CONFIG_WATCHDOG != 1)
  76         #error CONFIG_WATCHDOG must be set to either 0 or 1 in config.h
  77 #endif
  78
  79 #if CONFIG_WATCHDOG
  80         #include <drv/wdt.h>
  81 #endif
  82
  83 #if defined (CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
  84         #include <kern/signal.h> /* sig_wait(), sig_check() */
  85         #include <kern/proc.h>   /* proc_current() */
  86         #include <cfg/macros.h>  /* BV() */
  87 #endif
  88
  89
  90 /**
  91  * \def CONFIG_TIMER_STROBE
  92  *
  93  * This is a debug facility that can be used to
  94  * monitor timer interrupt activity on an external pin.
  95  *
  96  * To use strobes, redefine the macros TIMER_STROBE_ON,
  97  * TIMER_STROBE_OFF and TIMER_STROBE_INIT and set
  98  * CONFIG_TIMER_STROBE to 1.
  99  */
 100 #if !defined(CONFIG_TIMER_STROBE) || !CONFIG_TIMER_STROBE
 101         #define TIMER_STROBE_ON    do {/*nop*/} while(0)
 102         #define TIMER_STROBE_OFF   do {/*nop*/} while(0)
 103         #define TIMER_STROBE_INIT  do {/*nop*/} while(0)
 104 #endif
 105
 106
 107 /// Master system clock (1 tick accuracy)
 108 volatile ticks_t _clock;
 109
 110
 111 #if CONFIG_TIMER_EVENTS
 112
 113 /**
 114  * List of active asynchronous timers.
 115  */
 116 REGISTER static List timers_queue;
 117
 118
 119 /**
 120  * Add the specified timer to the software timer service queue.
 121  * When the delay indicated by the timer expires, the timer
 122  * device will execute the event associated with it.
 123  *
 124  * \note Interrupt safe
 125  */
 126 void timer_add(Timer *timer)
 127 {
 128         Timer *node;
 129         cpu_flags_t flags;
 130
 131
 132         /* Inserting timers twice causes mayhem. */
 133         ASSERT(timer->magic != TIMER_MAGIC_ACTIVE);
 134         DB(timer->magic = TIMER_MAGIC_ACTIVE;)
 135
 136         IRQ_SAVE_DISABLE(flags);
 137
 138         /* Calculate expiration time for this timer */
 139         timer->tick = _clock + timer->_delay;
 140
 141         /*
 142          * Search for the first node whose expiration time is
 143          * greater than the timer we want to add.
 144          */
 145         node = (Timer *)LIST_HEAD(&timers_queue);
 146         while (node->link.succ)
 147         {
 148                 /*
 149                  * Stop just after the insertion point.
 150                  * (this fancy compare takes care of wrap-arounds).
 151                  */
 152                 if (node->tick - timer->tick > 0)
 153                         break;
 154
 155                 /* Go to next node */
 156                 node = (Timer *)node->link.succ;
 157         }
 158
 159         /* Enqueue timer request into the list */
 160         INSERT_BEFORE(&timer->link, &node->link);
 161
 162         IRQ_RESTORE(flags);
 163 }
 164
 165
 166 /**
 167  * Remove a timer from the timers queue before it has expired.
 168  *
 169  * \note Attempting to remove a timer already expired cause
 170  *       undefined behaviour.
 171  */
 172 Timer *timer_abort(Timer *timer)
 173 {
 174         ATOMIC(REMOVE(&timer->link));
 175         DB(timer->magic = TIMER_MAGIC_INACTIVE;)
 176
 177         return timer;
 178 }
 179
 180 #endif /* CONFIG_TIMER_EVENTS */
 181
 182
 183 /**
 184  * Wait for the specified amount of timer ticks.
 185  */
 186 void timer_delayTicks(ticks_t delay)
 187 {
 188         /* We shouldn't sleep with interrupts disabled */
 189         IRQ_ASSERT_ENABLED();
 190
 191 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 192         Timer t;
 193
 194         ASSERT(!sig_check(SIG_SINGLE));
 195         timer_setSignal(&t, proc_current(), SIG_SINGLE);
 196         timer_setDelay(&t, delay);
 197         timer_add(&t);
 198         sig_wait(SIG_SINGLE);
 199
 200 #else /* !CONFIG_KERN_SIGNALS */
 201
 202         ticks_t start = timer_clock();
 203
 204         /* Busy wait */
 205         while (timer_clock() - start < delay)
 206                 cpu_relax();
 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         #if CONFIG_KERN_IRQ
 329                 MOD_CHECK(irq);
 330         #endif
 331
 332         #if CONFIG_TIMER_EVENTS
 333                 LIST_INIT(&timers_queue);
 334         #endif
 335
 336         TIMER_STROBE_INIT;
 337
 338         _clock = 0;
 339
 340         timer_hw_init();
 341
 342         MOD_INIT(timer);
 343 }
 344
 345
 346 #if (ARCH & ARCH_EMUL)
 347 /**
 348  * Stop timer (only used by emulator)
 349  */
 350 void timer_cleanup(void)
 351 {
 352         MOD_CLEANUP(timer);
 353
 354         timer_hw_cleanup();
 355
 356         // Hmmm... apparently, the demo app does not cleanup properly
 357         //ASSERT(LIST_EMPTY(&timers_queue));
 358 }
 359 #endif /* ARCH_EMUL */