Remove obsolete INITLIST macro.
[bertos.git] / drv / timer.c
index 385ef9c3f811b9c95441207c7329e00f1a42cf68..60261e1f80328f928623947cdebfb53ed3502c45 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.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.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 <cpu.h>
+#include <hw.h>
+#include CPU_HEADER(timer)
+#include <debug.h>
+#include <config.h>
 
-#ifdef CONFIG_KERN_SIGNALS
-#include <kern/proc.h>
+/*
+ * 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 (ARCH & ARCH_EMUL)
-       #error To be recoded
-#elif defined(__AVR__)
-       #include "timer_avr.h"
-#elif defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__) /* 80C196 */
-       #include "timer_i196.h"
-#elif defined (__m56800__)
-       #include "timer_dsp56k.h"
-#else
-       #error Unknown system
+#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
 
-/*! Number of available timers */
-#define MAX_TIMERS 4
-
-
-//! Master system clock (1ms accuracy)
-volatile time_t _clock;
-
-static Timer soft_timers[MAX_TIMERS];   /*!< Pool of Timer structures */
-static List timers_pool;                /*!< Pool of free timers */
-REGISTER static List timers_queue;      /*!< Active timers */
+#if CONFIG_KERNEL && CONFIG_KERN_SIGNALS
+       #include <kern/proc.h>
+#endif
 
 
 /*!
- * Return a new timer picking and removing it from the available
- * timers pool. Return NULL if no more timers are available.
+ * \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.
  */
-Timer *timer_new(void)
-{
-       Timer *timer;
-       cpuflags_t flags;
-
-       DISABLE_IRQSAVE(flags);
-
-       /* Should never happen */
-       if (ISLISTEMPTY(&timers_pool))
-       {
-               ENABLE_IRQRESTORE(flags);
-               DB(kprintf("Tmrspool empty\n");)
-               return NULL;
-       }
+#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
 
-       /* Get a timer from the free pool */
-       timer = (Timer *)timers_pool.head;
-       REMOVE((Node *)timer);
 
-       ENABLE_IRQRESTORE(flags);
+//! Master system clock (1ms accuracy)
+volatile time_t _clock;
 
-       return timer;
-}
 
+#ifndef CONFIG_TIMER_DISABLE_EVENTS
 
 /*!
- * Delete a timer, putting it in the available timers queue.
+ * List of active asynchronous timers.
  */
-void timer_delete(Timer *timer)
-{
-       cpuflags_t flags;
-       DISABLE_IRQSAVE(flags);
-       ADDHEAD(&timers_pool, &timer->link);
-       ENABLE_IRQRESTORE(flags);
-}
+REGISTER static List timers_queue;
 
 
 /*!
@@ -123,14 +148,18 @@ void timer_add(Timer *timer)
        /* 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 insert 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 */
@@ -138,7 +167,7 @@ void timer_add(Timer *timer)
        }
 
        /* Enqueue timer request into the list */
-       INSERTBEFORE((Node *)timer, (Node *)node);
+       INSERTBEFORE(&timer->link, &node->link);
 
        ENABLE_IRQRESTORE(flags);
 }
@@ -151,18 +180,25 @@ Timer *timer_abort(Timer *timer)
 {
        cpuflags_t flags;
        DISABLE_IRQSAVE(flags);
-       REMOVE((Node *)timer);
+       REMOVE(&timer->link);
        ENABLE_IRQRESTORE(flags);
 
        return timer;
 }
 
+#endif /* CONFIG_TIMER_DISABLE_EVENTS */
+
 
 /*!
  * Wait for the specified amount of time (expressed in ms)
  */
 void timer_delay(time_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;
 
@@ -174,15 +210,21 @@ void timer_delay(time_t time)
 
 #else /* !CONFIG_KERN_SIGNALS */
 
-       time_t start = timer_gettick();
+       time_t start = timer_ticks();
 
        /* Busy wait */
-       while (timer_gettick() - start < time) { /* nop */ }
+       while (timer_ticks() - start < time)
+       {
+#if CONFIG_WATCHDOG
+               wdt_reset();
+#endif
+       }
 
 #endif /* !CONFIG_KERN_SIGNALS */
 }
 
 
+#ifndef CONFIG_TIMER_DISABLE_UDELAY
 /*!
  * Wait for the specified amount of time (expressed in microseconds)
  *
@@ -192,7 +234,7 @@ void timer_delay(time_t time)
  */
 void timer_udelay(utime_t usec_delay)
 {
-       if (usec_delay > 1000)
+       if (UNLIKELY(usec_delay > 1000))
        {
                timer_delay(usec_delay / 1000);
                usec_delay %= 1000;
@@ -207,6 +249,7 @@ void timer_udelay(utime_t usec_delay)
        while (timer_hw_hpread() - start < delay)
        {}
 }
+#endif /* CONFIG_TIMER_DISABLE_UDELAY */
 
 
 /*!
@@ -215,14 +258,18 @@ void timer_udelay(utime_t usec_delay)
  */
 DEFINE_TIMER_ISR
 {
-       /* With the Metrowerks compiler, the only way to force the compiler generate
-          an interrupt service routine is to put a pragma directive within the function
-          body. */
+       /*
+        * With the Metrowerks compiler, the only way to force the compiler generate
+        * an interrupt service routine is to put a pragma directive within the function
+        * body.
+        */
        #ifdef __MWERKS__
        #pragma interrupt saveall
        #endif
 
+#ifndef CONFIG_TIMER_DISABLE_EVENTS
        Timer *timer;
+#endif
 
        TIMER_STROBE_ON;
 
@@ -231,6 +278,7 @@ DEFINE_TIMER_ISR
        /* Update the master ms counter */
        ++_clock;
 
+#ifndef CONFIG_TIMER_DISABLE_EVENTS
        /*
         * Check the first timer request in the list and process
         * it when it has expired. Repeat this check until the
@@ -245,11 +293,12 @@ DEFINE_TIMER_ISR
                        break;
 
                /* Retreat the expired timer */
-               REMOVE((Node *)timer);
+               REMOVE(&timer->link);
 
                /* Execute the associated event */
-               event_doIntr(&timer->expire);
+               event_do(&timer->expire);
        }
+#endif /* CONFIG_TIMER_DISABLE_EVENTS */
 
        TIMER_STROBE_OFF;
 }
@@ -260,19 +309,13 @@ DEFINE_TIMER_ISR
  */
 void timer_init(void)
 {
-       int i;
-
        TIMER_STROBE_INIT;
 
-       INITLIST(&timers_queue);
-       INITLIST(&timers_pool);
-
-       /* Init all software timers in the free pool */
-       for (i = 0; i < MAX_TIMERS; i++)
-               ADDTAIL(&timers_pool, (Node *)&soft_timers[i]);
+#ifndef CONFIG_TIMER_DISABLE_EVENTS
+       LIST_INIT(&timers_queue);
+#endif
 
        _clock = 0;
 
        timer_hw_init();
 }
-