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  * \author Bernie Innocenti <bernie@codewiz.org>
  36  * \author Francesco Sacchi <batt@develer.com>
  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 #include <kern/proc_p.h> // proc_decQuantun()
  56
  57 /*
  58  * Include platform-specific binding code if we're hosted.
  59  * Try the CPU specific one for bare-metal environments.
  60  */
  61 #if OS_HOSTED
  62         //#include OS_CSOURCE(timer)
  63         #include <emul/timer_posix.c>
  64 #else
  65         #ifndef WIZ_AUTOGEN
  66                 #warning Deprecated: now you should include timer_<cpu> directly in the makefile. Remove this line and the following once done.
  67                 #include CPU_CSOURCE(timer)
  68         #endif
  69 #endif
  70
  71 /*
  72  * Sanity check for config parameters required by this module.
  73  */
  74 #if !defined(CONFIG_KERN) || ((CONFIG_KERN != 0) && CONFIG_KERN != 1)
  75         #error CONFIG_KERN must be set to either 0 or 1 in config.h
  76 #endif
  77 #if !defined(CONFIG_WATCHDOG) || ((CONFIG_WATCHDOG != 0) && CONFIG_WATCHDOG != 1)
  78         #error CONFIG_WATCHDOG must be set to either 0 or 1 in config.h
  79 #endif
  80
  81 #if CONFIG_WATCHDOG
  82         #include <drv/wdt.h>
  83 #endif
  84
  85 #if defined (CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
  86         #include <kern/signal.h> /* sig_wait(), sig_check() */
  87         #include <kern/proc.h>   /* proc_current() */
  88         #include <cfg/macros.h>  /* BV() */
  89 #endif
  90
  91
  92 /**
  93  * \def CONFIG_TIMER_STROBE
  94  *
  95  * This is a debug facility that can be used to
  96  * monitor timer interrupt activity on an external pin.
  97  *
  98  * To use strobes, redefine the macros TIMER_STROBE_ON,
  99  * TIMER_STROBE_OFF and TIMER_STROBE_INIT and set
 100  * CONFIG_TIMER_STROBE to 1.
 101  */
 102 #if !defined(CONFIG_TIMER_STROBE) || !CONFIG_TIMER_STROBE
 103         #define TIMER_STROBE_ON    do {/*nop*/} while(0)
 104         #define TIMER_STROBE_OFF   do {/*nop*/} while(0)
 105         #define TIMER_STROBE_INIT  do {/*nop*/} while(0)
 106 #endif
 107
 108
 109 /// Master system clock (1 tick accuracy)
 110 volatile ticks_t _clock;
 111
 112
 113 #if CONFIG_TIMER_EVENTS
 114
 115 /**
 116  * List of active asynchronous timers.
 117  */
 118 REGISTER static List timers_queue;
 119
 120 /**
 121  * This function really does the job. It adds \a timer to \a queue.
 122  * \see timer_add for details.
 123  */
 124 INLINE void timer_addToList(Timer *timer, List *queue)
 125 {
 126         /* Inserting timers twice causes mayhem. */
 127         ASSERT(timer->magic != TIMER_MAGIC_ACTIVE);
 128         DB(timer->magic = TIMER_MAGIC_ACTIVE;)
 129
 130
 131         /* Calculate expiration time for this timer */
 132         timer->tick = _clock + timer->_delay;
 133
 134         /*
 135          * Search for the first node whose expiration time is
 136          * greater than the timer we want to add.
 137          */
 138         Timer *node = (Timer *)LIST_HEAD(queue);
 139         while (node->link.succ)
 140         {
 141                 /*
 142                  * Stop just after the insertion point.
 143                  * (this fancy compare takes care of wrap-arounds).
 144                  */
 145                 if (node->tick - timer->tick > 0)
 146                         break;
 147
 148                 /* Go to next node */
 149                 node = (Timer *)node->link.succ;
 150         }
 151
 152         /* Enqueue timer request into the list */
 153         INSERT_BEFORE(&timer->link, &node->link);
 154 }
 155
 156 /**
 157  * Add the specified timer to the software timer service queue.
 158  * When the delay indicated by the timer expires, the timer
 159  * device will execute the event associated with it.
 160  *
 161  * \note Interrupt safe
 162  */
 163 void timer_add(Timer *timer)
 164 {
 165         ATOMIC(timer_addToList(timer, &timers_queue));
 166 }
 167
 168 /**
 169  * Remove a timer from the timers queue before it has expired.
 170  *
 171  * \note Attempting to remove a timer already expired cause
 172  *       undefined behaviour.
 173  */
 174 Timer *timer_abort(Timer *timer)
 175 {
 176         ATOMIC(REMOVE(&timer->link));
 177         DB(timer->magic = TIMER_MAGIC_INACTIVE;)
 178
 179         return timer;
 180 }
 181
 182
 183 INLINE void timer_poll(List *queue)
 184 {
 185         Timer *timer;
 186
 187         /*
 188          * Check the first timer request in the list and process
 189          * it when it has expired. Repeat this check until the
 190          * first node has not yet expired. Since the list is sorted
 191          * by expiry time, all the following requests are guaranteed
 192          * to expire later.
 193          */
 194         while ((timer = (Timer *)LIST_HEAD(queue))->link.succ)
 195         {
 196                 /* This request in list has not yet expired? */
 197                 if (timer_clock() - timer->tick < 0)
 198                         break;
 199
 200                 /* Retreat the expired timer */
 201                 REMOVE(&timer->link);
 202                 DB(timer->magic = TIMER_MAGIC_INACTIVE;)
 203
 204                 /* Execute the associated event */
 205                 event_do(&timer->expire);
 206         }
 207 }
 208
 209 /**
 210  * Add \a timer to \a queue.
 211  * \see synctimer_poll() for details.
 212  */
 213 void synctimer_add(Timer *timer, List *queue)
 214 {
 215         timer_addToList(timer, queue);
 216 }
 217
 218 /**
 219  * Simple synchronous timer based scheduler polling routine.
 220  *
 221  * Sometimes you would like to have a proper scheduler,
 222  * but you can't afford it due to memory constraints.
 223  *
 224  * This is a simple replacement: you can create events and call
 225  * them periodically at specific time intervals.
 226  * All you have to do is to set up normal timers, and call synctimer_add()
 227  * instead of timer_add() to add the events to your specific queue.
 228  * Then, in the main loop or wherever you want, you can call
 229  * synctimer_poll() to process expired events. The associated callbacks will be
 230  * executed.
 231  * As this is done synchronously you don't have to worry about race conditions.
 232  * You can kill an event by simply calling synctimer_abort().
 233  *
 234  */
 235 void synctimer_poll(List *queue)
 236 {
 237         timer_poll(queue);
 238 }
 239
 240 #endif /* CONFIG_TIMER_EVENTS */
 241
 242
 243 /**
 244  * Wait for the specified amount of timer ticks.
 245  *
 246  * \note Sleeping while preemption is disabled fallbacks to a busy wait sleep.
 247  */
 248 void timer_delayTicks(ticks_t delay)
 249 {
 250         /* We shouldn't sleep with interrupts disabled */
 251         IRQ_ASSERT_ENABLED();
 252
 253 #if CONFIG_KERN_SIGNALS
 254         Timer t;
 255         DB(t.magic = TIMER_MAGIC_INACTIVE;)
 256         if (proc_preemptAllowed())
 257         {
 258                 timer_setEvent(&t);
 259                 timer_setDelay(&t, delay);
 260                 timer_add(&t);
 261                 timer_waitEvent(&t);
 262         }
 263         else
 264 #endif /* !CONFIG_KERN_SIGNALS */
 265         {
 266                 ticks_t start = timer_clock();
 267
 268                 /* Busy wait */
 269                 while (timer_clock() - start < delay)
 270                         cpu_relax();
 271         }
 272 }
 273
 274
 275 #if CONFIG_TIMER_UDELAY
 276
 277 /**
 278  * Busy wait until the specified amount of high-precision ticks have elapsed.
 279  *
 280  * \note This function is interrupt safe, the only
 281  *       requirement is a running hardware timer.
 282  */
 283 void timer_busyWait(hptime_t delay)
 284 {
 285         hptime_t now, prev = timer_hw_hpread();
 286         hptime_t delta;
 287
 288         for (;;)
 289         {
 290                 now = timer_hw_hpread();
 291                 /*
 292                  * The timer counter may wrap here and "prev" can become
 293                  * greater than "now". So, be sure to always evaluate a
 294                  * coherent timer difference:
 295                  *
 296                  * 0     prev            now   TIMER_HW_CNT
 297                  * |_____|_______________|_____|
 298                  *        ^^^^^^^^^^^^^^^
 299                  * delta = now - prev
 300                  *
 301                  * 0     now             prev  TIMER_HW_CNT
 302                  * |_____|_______________|_____|
 303                  *  ^^^^^                 ^^^^^
 304                  * delta = (TIMER_HW_CNT - prev) + now
 305                  *
 306                  * NOTE: TIMER_HW_CNT can be any value, not necessarily a power
 307                  * of 2. For this reason the "%" operator is not suitable for
 308                  * the generic case.
 309                  */
 310                 delta = (now < prev) ? ((hptime_t)TIMER_HW_CNT - prev + now) :
 311                                                 (now - prev);
 312                 if (delta >= delay)
 313                         break;
 314                 delay -= delta;
 315                 prev = now;
 316         }
 317 }
 318
 319 /**
 320  * Wait for the specified amount of time (expressed in microseconds).
 321  *
 322  * \bug In AVR arch the maximum amount of time that can be used as
 323  *      delay could be very limited, depending on the hardware timer
 324  *      used. Check timer_avr.h, and what register is used as hptime_t.
 325  */
 326 void timer_delayHp(hptime_t delay)
 327 {
 328         if (UNLIKELY(delay > us_to_hptime(1000)))
 329         {
 330                 timer_delayTicks(delay / (TIMER_HW_HPTICKS_PER_SEC / TIMER_TICKS_PER_SEC));
 331                 delay %= (TIMER_HW_HPTICKS_PER_SEC / TIMER_TICKS_PER_SEC);
 332         }
 333
 334         timer_busyWait(delay);
 335 }
 336 #endif /* CONFIG_TIMER_UDELAY */
 337
 338 /**
 339  * Timer interrupt handler. Find soft timers expired and
 340  * trigger corresponding events.
 341  */
 342 DEFINE_TIMER_ISR
 343 {
 344         /*
 345          * With the Metrowerks compiler, the only way to force the compiler generate
 346          * an interrupt service routine is to put a pragma directive within the function
 347          * body.
 348          */
 349         #ifdef __MWERKS__
 350         #pragma interrupt saveall
 351         #endif
 352
 353         /*
 354          * On systems sharing IRQ line and vector, this check is needed
 355          * to ensure that IRQ is generated by timer source.
 356          */
 357         if (!timer_hw_triggered())
 358                 return;
 359
 360         TIMER_STROBE_ON;
 361
 362         /* Update the master ms counter */
 363         ++_clock;
 364
 365         /* Update the current task's quantum (if enabled). */
 366         proc_decQuantum();
 367
 368         #if CONFIG_TIMER_EVENTS
 369                 timer_poll(&timers_queue);
 370         #endif
 371
 372         /* Perform hw IRQ handling */
 373         timer_hw_irq();
 374
 375         TIMER_STROBE_OFF;
 376 }
 377
 378 MOD_DEFINE(timer)
 379
 380 /**
 381  * Initialize timer
 382  */
 383 void timer_init(void)
 384 {
 385         #if CONFIG_KERN_IRQ
 386                 MOD_CHECK(irq);
 387         #endif
 388
 389         #if CONFIG_TIMER_EVENTS
 390                 LIST_INIT(&timers_queue);
 391         #endif
 392
 393         TIMER_STROBE_INIT;
 394
 395         _clock = 0;
 396
 397         timer_hw_init();
 398
 399         MOD_INIT(timer);
 400 }
 401
 402
 403 #if (ARCH & ARCH_EMUL)
 404 /**
 405  * Stop timer (only used by emulator)
 406  */
 407 void timer_cleanup(void)
 408 {
 409         MOD_CLEANUP(timer);
 410
 411         timer_hw_cleanup();
 412
 413         // Hmmm... apparently, the demo app does not cleanup properly
 414         //ASSERT(LIST_EMPTY(&timers_queue));
 415 }
 416 #endif /* ARCH_EMUL */