Include top-level headers from cfg/ subdir.
[bertos.git] / drv / timer.c
index b2caf90d9706526aed8ba8f065c40a2a7e5c4ee6..c1f161454f7deea37dc1d429f487c7b7408eabc7 100755 (executable)
 /*!
  * \file
  * <!--
- * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
+ * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
  * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \version $Id$
+ * \brief Hardware independent timer driver (implementation)
  *
+ * \version $Id$
  * \author Bernardo Innocenti <bernie@develer.com>
- *
- * \brief Hardware independent timer driver (implementation)
  */
 
-/*
- * $Log$
- * Revision 1.13  2004/08/10 06:59:09  bernie
- * timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
- *
- * Revision 1.12  2004/08/08 05:59:37  bernie
- * Remove a few useless casts.
- *
- * Revision 1.11  2004/08/02 20:20:29  aleph
- * Merge from project_ks
- *
- * Revision 1.10  2004/07/30 14:15:53  rasky
- * Nuovo supporto unificato per detect della CPU
- *
- * Revision 1.9  2004/07/21 00:15:13  bernie
- * Put timer driver on diet.
- *
- * Revision 1.8  2004/07/18 21:57:07  bernie
- * Fix preprocessor warning with potentially undefined symbol.
- *
- * Revision 1.6  2004/06/07 18:10:06  aleph
- * Remove free pool of timers; use user-provided Timer structure instead
- *
- * Revision 1.5  2004/06/07 15:56:55  aleph
- * Some tabs cleanup and add timer strobe macros
- *
- * Revision 1.4  2004/06/06 18:25:44  bernie
- * Rename event macros to look like regular functions.
- *
- * Revision 1.3  2004/06/06 17:18:42  bernie
- * Fix \!CONFIG_KERN_SIGNALS code paths.
- *
- * Revision 1.2  2004/06/03 11:27:09  bernie
- * Add dual-license information.
- *
- * Revision 1.1  2004/05/23 18:23:30  bernie
- * Import drv/timer module.
- *
- */
+/*#*
+ *#* $Log$
+ *#* Revision 1.24  2005/04/11 19:10:28  bernie
+ *#* Include top-level headers from cfg/ subdir.
+ *#*
+ *#* Revision 1.23  2004/12/13 12:07:06  bernie
+ *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
+ *#*
+ *#* Revision 1.22  2004/12/08 09:12:09  bernie
+ *#* Rename time_t to mtime_t.
+ *#*
+ *#* Revision 1.21  2004/11/28 23:20:25  bernie
+ *#* Remove obsolete INITLIST macro.
+ *#*
+ *#* Revision 1.20  2004/11/16 20:59:06  bernie
+ *#* Add watchdog timer support.
+ *#*
+ *#* Revision 1.19  2004/10/19 08:56:49  bernie
+ *#* TIMER_STROBE_ON, TIMER_STROBE_OFF, TIMER_STROBE_INIT: Move from timer_avr.h to timer.h, where they really belong.
+ *#*
+ *#* Revision 1.18  2004/10/14 23:14:05  bernie
+ *#* Fix longstanding problem with wrap-arounds.
+ *#*
+ *#* Revision 1.17  2004/10/03 18:52:08  bernie
+ *#* Move \brief on top in header to please Doxygen.
+ *#*
+ *#* Revision 1.16  2004/10/03 18:48:01  bernie
+ *#* timer_delay(): Add a sanity check to avoid sleeping forever.
+ *#*
+ *#* Revision 1.15  2004/09/14 21:07:18  bernie
+ *#* Use debug.h instead of kdebug.h.
+ *#*
+ *#* Revision 1.14  2004/08/25 14:12:08  rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* Revision 1.13  2004/08/10 06:59:09  bernie
+ *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
+ *#*
+ *#* Revision 1.12  2004/08/08 05:59:37  bernie
+ *#* Remove a few useless casts.
+ *#*
+ *#* Revision 1.11  2004/08/02 20:20:29  aleph
+ *#* Merge from project_ks
+ *#*
+ *#* Revision 1.10  2004/07/30 14:15:53  rasky
+ *#* Nuovo supporto unificato per detect della CPU
+ *#*
+ *#* Revision 1.9  2004/07/21 00:15:13  bernie
+ *#* Put timer driver on diet.
+ *#*
+ *#* Revision 1.8  2004/07/18 21:57:07  bernie
+ *#* Fix preprocessor warning with potentially undefined symbol.
+ *#*
+ *#* Revision 1.6  2004/06/07 18:10:06  aleph
+ *#* Remove free pool of timers; use user-provided Timer structure instead
+ *#*
+ *#* Revision 1.5  2004/06/07 15:56:55  aleph
+ *#* Some tabs cleanup and add timer strobe macros
+ *#*
+ *#* Revision 1.4  2004/06/06 18:25:44  bernie
+ *#* Rename event macros to look like regular functions.
+ *#*
+ *#* Revision 1.3  2004/06/06 17:18:42  bernie
+ *#* Fix \!CONFIG_KERN_SIGNALS code paths.
+ *#*
+ *#* Revision 1.2  2004/06/03 11:27:09  bernie
+ *#* Add dual-license information.
+ *#*
+ *#* Revision 1.1  2004/05/23 18:23:30  bernie
+ *#* Import drv/timer module.
+ *#*
+ *#*/
 
-#include "hw.h"
-#include "kdebug.h"
 #include "timer.h"
+#include <cfg/cpu.h>
+#include <hw.h>
 #include CPU_HEADER(timer)
+#include <cfg/debug.h>
+#include <cfg/config.h>
 
-#if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
+/*
+ * Sanity check for config parameters required by this module.
+ */
+#if !defined(CONFIG_KERNEL) || ((CONFIG_KERNEL != 0) && CONFIG_KERNEL != 1)
+       #error CONFIG_KERNEL must be set to either 0 or 1 in config.h
+#endif
+#if !defined(CONFIG_WATCHDOG) || ((CONFIG_WATCHDOG != 0) && CONFIG_WATCHDOG != 1)
+       #error CONFIG_WATCHDOG must be set to either 0 or 1 in config.h
+#endif
+
+#if CONFIG_WATCHDOG
+       #include <drv/wdt.h>
+#endif
+
+#if CONFIG_KERNEL && CONFIG_KERN_SIGNALS
        #include <kern/proc.h>
 #endif
 
+
+/*!
+ * \def CONFIG_TIMER_STROBE
+ *
+ * This is a debug facility that can be used to
+ * monitor timer interrupt activity on an external pin.
+ *
+ * To use strobes, redefine the macros TIMER_STROBE_ON,
+ * TIMER_STROBE_OFF and TIMER_STROBE_INIT and set
+ * CONFIG_TIMER_STROBE to 1.
+ */
+#if !defined(CONFIG_TIMER_STROBE) || !CONFIG_TIMER_STROBE
+       #define TIMER_STROBE_ON    do {/*nop*/} while(0)
+       #define TIMER_STROBE_OFF   do {/*nop*/} while(0)
+       #define TIMER_STROBE_INIT  do {/*nop*/} while(0)
+#endif
+
+
 //! Master system clock (1ms accuracy)
-volatile time_t _clock;
+volatile mtime_t _clock;
 
 
 #ifndef CONFIG_TIMER_DISABLE_EVENTS
@@ -86,19 +152,23 @@ void timer_add(Timer *timer)
        Timer *node;
        cpuflags_t flags;
 
-       DISABLE_IRQSAVE(flags);
+       IRQ_SAVE_DISABLE(flags);
 
        /* Calculate expiration time for this timer */
        timer->tick = _clock + timer->delay;
 
-       /* Search for the first node whose expiration time is
+       /*
+        * Search for the first node whose expiration time is
         * greater than the timer we want to add.
         */
        node = (Timer *)timers_queue.head;
        while (node->link.succ)
        {
-               /* Stop just after the insertion point */
-               if (node->tick > timer->tick)
+               /*
+                * Stop just after the insertion point.
+                * (this fancy compare takes care of wrap-arounds).
+                */
+               if (node->tick - timer->tick > 0)
                        break;
 
                /* Go to next node */
@@ -108,19 +178,16 @@ void timer_add(Timer *timer)
        /* Enqueue timer request into the list */
        INSERTBEFORE(&timer->link, &node->link);
 
-       ENABLE_IRQRESTORE(flags);
+       IRQ_RESTORE(flags);
 }
 
 
 /*!
- * Remove a timer from the timer queue before it has expired
+ * Remove a timer from the timer queue before it has expired.
  */
 Timer *timer_abort(Timer *timer)
 {
-       cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
-       REMOVE(&timer->link);
-       ENABLE_IRQRESTORE(flags);
+       ATOMIC(REMOVE(&timer->link));
 
        return timer;
 }
@@ -129,10 +196,15 @@ Timer *timer_abort(Timer *timer)
 
 
 /*!
- * Wait for the specified amount of time (expressed in ms)
+ * Wait for the specified amount of time (expressed in ms).
  */
-void timer_delay(time_t time)
+void timer_delay(mtime_t time)
 {
+#if defined(IRQ_GETSTATE)
+       /* We shouldn't sleep with interrupts disabled */
+       ASSERT(IRQ_GETSTATE());
+#endif
+
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
        Timer t;
 
@@ -144,10 +216,15 @@ void timer_delay(time_t time)
 
 #else /* !CONFIG_KERN_SIGNALS */
 
-       time_t start = timer_ticks();
+       mtime_t start = timer_ticks();
 
        /* Busy wait */
-       while (timer_ticks() - start < time) { /* nop */ }
+       while (timer_ticks() - start < time)
+       {
+#if CONFIG_WATCHDOG
+               wdt_reset();
+#endif
+       }
 
 #endif /* !CONFIG_KERN_SIGNALS */
 }
@@ -155,7 +232,7 @@ void timer_delay(time_t time)
 
 #ifndef CONFIG_TIMER_DISABLE_UDELAY
 /*!
- * Wait for the specified amount of time (expressed in microseconds)
+ * Wait for the specified amount of time (expressed in microseconds).
  *
  * \bug In AVR arch the maximum amount of time that can be used as
  *      delay could be very limited, depending on the hardware timer
@@ -241,7 +318,7 @@ void timer_init(void)
        TIMER_STROBE_INIT;
 
 #ifndef CONFIG_TIMER_DISABLE_EVENTS
-       INITLIST(&timers_queue);
+       LIST_INIT(&timers_queue);
 #endif
 
        _clock = 0;