Updated with Doxygen 1.3.8.

[bertos.git] / drv / timer.h

diff --git a/drv/timer.h b/drv/timer.h
index 5a9c93e2b3f2a633bfe715e761046930eae9857e..09d97c1307a7b78a10a2e0e934482d79dbb6f2f9 100755 (executable)
--- a/drv/timer.h
+++ b/drv/timer.h
@@ -15,6 +15,22 @@
 
 /*
  * $Log$
+ * Revision 1.14  2004/08/03 15:50:03  aleph
+ * Rename timer_tick() to timer_ticks()
+ *
+ * Revision 1.13  2004/08/02 20:20:29  aleph
+ * Merge from project_ks
+ *
+ * Revision 1.12  2004/07/30 14:34:10  rasky
+ * Vari fix per documentazione e commenti
+ * Aggiunte PP_CATn e STATIC_ASSERT
+ *
+ * Revision 1.11  2004/07/29 22:40:12  bernie
+ * Spelling fix.
+ *
+ * Revision 1.10  2004/07/21 00:13:57  bernie
+ * Put timer driver on diet.
+ *
  * Revision 1.9  2004/07/20 23:45:01  bernie
  * Finally remove redundant protos.
  *
@@ -48,17 +64,36 @@
 
 #include "cpu.h"
 #include "compiler.h"
+#include <config.h>
 #include <mware/list.h>
 
+/*! Number of timer ticks per second. */
+#define TICKS_PER_SEC  ((time_t)1000)
+
+/* Function protos */
+extern void timer_init(void);
+extern void timer_delay(time_t time);
+
+#ifndef CONFIG_TIMER_DISABLE_UDELAY
+extern void timer_udelay(utime_t utime);
+#endif
+
+
+#ifndef CONFIG_TIMER_DISABLE_EVENTS
+
 #ifdef CONFIG_KERNEL
        #include <kern/event.h>
 #else
        #include <mware/event.h>
 #endif
 
-/*! Number of timer ticks per second. */
-#define TICKS_PER_SEC       1000
-
+/*!
+ * The timer driver supports multiple synchronous timers
+ * that can trigger an event when they expire.
+ *
+ * \sa timer_add()
+ * \sa timer_abort()
+ */
 typedef struct Timer
 {
        Node   link;      /*!< Link into timers queue */
@@ -67,12 +102,8 @@ typedef struct Timer
        Event  expire;    /*!< Event to execute when the timer expires */
 } Timer;
 
-/* Function protos */
-extern void timer_init(void);
 extern void timer_add(Timer *timer);
 extern Timer *timer_abort(Timer *timer);
-extern void timer_delay(time_t time);
-extern void timer_udelay(utime_t utime);
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 
@@ -96,6 +127,7 @@ INLINE void timer_set_delay(Timer* timer, time_t delay)
        timer->delay = delay;
 }
 
+#endif /* CONFIG_TIMER_DISABLE_EVENTS */
 
 extern volatile time_t _clock;
 
@@ -107,14 +139,14 @@ extern volatile time_t _clock;
  *
  * The following code is safe:
  *
- * \example
+ * \code
  *   time_t tea_start_time = get_tick();
  *
  *   boil_water();
  *
  *   if (get_tick() - tea_start_time > TEAPOT_DELAY)
  *       printf("Your tea, Sir.\n");
- * \endexample
+ * \endcode
  *
  * When the tick counter increments every millisecond and time_t
  * is 32bit wide, the tick count will overflow every 49.7 days.
@@ -123,7 +155,7 @@ extern volatile time_t _clock;
  * clock variable is larger than the processor word size and can't
  * be copied atomically.
  */
-INLINE time_t timer_tick(void)
+INLINE time_t timer_ticks(void)
 {
        time_t result;
        cpuflags_t flags;
@@ -136,22 +168,36 @@ INLINE time_t timer_tick(void)
 }
 
 /* OBSOLETE */
-#define timer_gettick timer_tick
+#define timer_gettick timer_ticks
 
 
 /*!
- * Like \c timer_tick, faster version to be called
- * from interrupt context only.
+ * Faster version of timer_ticks(), to be called only when the timer
+ * interrupt is disabled (DISABLE_INTS) or overridden by a
+ * higher-priority or non-nesting interrupt.
  *
- * \sa timer_tick
+ * \sa timer_ticks
  */
-INLINE time_t timer_tick_unlocked(void)
+INLINE time_t timer_ticks_unlocked(void)
 {
        return _clock;
 }
 
 /* OBSOLETE */
-#define timer_gettick_irq timer_tick_unlocked
+#define timer_gettick_irq timer_ticks_unlocked
+
+
+/*!
+ * Return the minutes passed since timer start.
+ *
+ * The minutes uptime is computed directly from system tick counter:
+ * in case of a 4 bytes time_t after 71582 minutes the value will
+ * wrap around.
+ */
+INLINE time_t timer_minutes(void)
+{
+       return timer_ticks() / (TICKS_PER_SEC * 60);
+}
 
 #endif /* DRV_TIMER_H */