X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=b006c5f4a3037b753a2b5bb3005983a1cbf4e053;hb=0088022a7741d4636b054f47c67be353d9242af2;hp=50d118a9f8845824f9483ab81ceef7cc0640dd54;hpb=24362270bbdf61ceedf3cecaf63fb1d36571e554;p=bertos.git

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index 50d118a9..b006c5f4 100644
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -30,6 +30,10 @@
  * 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:
@@ -96,6 +100,9 @@ STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T);
 
 extern volatile ticks_t _clock;
 
+#define TIMER_AFTER(x, y) ((long)(y) - (long)(x) < 0)
+#define TIMER_BEFORE(x, y) TIMER_AFTER(y, x)
+
 /**
  * \brief Return the system tick counter (expressed in ticks)
  *
@@ -284,7 +291,12 @@ INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
 	event_initSoftint(&timer->expire, func, user_data);
 }
 
-/** Set the timer delay (the time before the event will be triggered) */
+/**
+ * Set the timer delay (the time before the event will be triggered)
+ *
+ * \note It's illegal to change the delay of the timer when it's
+ * still running.
+ */
 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 {
 	timer->_delay = delay;
@@ -303,6 +315,18 @@ void synctimer_poll(List* q);
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 
+/** Set the timer so that it sends a event notification when it expires */
+INLINE void timer_setEvent(Timer *timer)
+{
+	event_initGeneric(&timer->expire);
+}
+
+/** Wait until the timer expires */
+INLINE void timer_waitEvent(Timer *timer)
+{
+	event_wait(&timer->expire);
+}
+
 /** Set the timer so that it sends a signal when it expires */
 INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 {
@@ -313,4 +337,6 @@ INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 
 #endif /* CONFIG_KERN_SIGNALS */
 
+/** \} */ //defgroup drv_timers
+
 #endif /* DRV_TIMER_H */