doc: Added group definitions for most common modules.

[bertos.git] / bertos / drv / timer.h

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index 45b8103eff137c1d3f7c07a01eac22975c2f9750..83483b9975c4f5a9bc26693a723be828ac2271ae 100644 (file)
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -30,17 +30,21 @@
  * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
+ * \defgroup drv_timers Timer module
+ * \ingroup core
+ * \{
+ *
  * \brief Hardware independent timer driver.
  *
  * All timer related functions are implemented in this module. You have several options to use timers:
  * \li simple delay: just use timer_delay() if you want to wait for a few milliseconds;
  * \li delay with callback: create a timer structure and use timer_setDelay() and timer_setSoftint() to set the callback;
  * \li delay with signal: same as above but use timer_setSignal() to set specify which signal to send.
+ * \li simple synchronous timer based scheduler: use synctimer_add() to schedule an event in a user provided queue.
  *
  * Whenever a timer expires you need to explicitly arm it again with timer_add(). If you want to abort a timer, use timer_abort().
  * You can use conversion macros when using msecs to specify the delay.
  *
- * \version $Id$
  * \author Bernie Innocenti <bernie@codewiz.org>
  *
  * $WIZ$ module_name = "timer"
@@ -145,6 +149,7 @@ INLINE ticks_t timer_clock_unlocked(void)
        return _clock;
 }
 
+
 /** Convert \a ms [ms] to ticks. */
 INLINE ticks_t ms_to_ticks(mtime_t ms)
 {
@@ -289,6 +294,15 @@ INLINE void timer_setDelay(Timer *timer, ticks_t delay)
        timer->_delay = delay;
 }
 
+
+void synctimer_add(Timer *timer, List* q);
+
+/** \sa timer_abort */
+#define synctimer_abort(t) timer_abort(t)
+
+void synctimer_poll(List* q);
+
+
 #endif /* CONFIG_TIMER_EVENTS */
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
@@ -303,4 +317,6 @@ INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 
 #endif /* CONFIG_KERN_SIGNALS */
 
+/** \} */ //defgroup drv_timers
+
 #endif /* DRV_TIMER_H */