Add synchronous timer scheduler.

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

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index a81b96f3dc0e609cfee5ede75c7be6d4776a516f..de2680093243d1b47d0ec5884b3c56c94cea13db 100644 (file)
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -36,6 +36,7 @@
  * \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.
@@ -70,6 +71,8 @@
        #include CPU_HEADER(timer)
 #endif
 
+STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T);
+
 #include "cfg/cfg_timer.h"
 #include <cfg/debug.h>
 #include <cfg/compiler.h>
@@ -266,7 +269,16 @@ typedef struct Timer
 void timer_add(Timer *timer);
 Timer *timer_abort(Timer *timer);
 
-/** Set the timer so that it calls an user hook when it expires */
+/**
+ * Set the timer so that it calls an user hook when it expires
+ *
+ * Sometimes you may want to use the same callback for different events, so you must have
+ * different data to operate on. The user_data parameter is such data.
+ *
+ * \param timer Timer struct to set the callback to
+ * \param func  Function that will be called when the timer expires
+ * \param user_data Additional data you may want to pass to the callback
+ */
 INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
 {
        event_initSoftint(&timer->expire, func, user_data);
@@ -278,6 +290,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