X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=bertos%2Fdrv%2Ftimer.h;h=45b8103eff137c1d3f7c07a01eac22975c2f9750;hb=ce5ddc07440aeb1357c7133beac6959b90d21885;hp=5696823a3e156ce7ef1ceebff01bbecbf2c0b44e;hpb=702bedb30a235a64f61f1d06653f8b22e39b5c5f;p=bertos.git

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index 5696823a..45b8103e 100644
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -30,16 +30,23 @@
  * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
- * \brief Hardware independent timer driver (interface)
+ * \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.
+ *
+ * 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>
  *
- * $WIZARD_MODULE = {
- * "name" : "timer",
- * "depends" : [],
- * "configuration" : "bertos/cfg/cfg_timer.h"
- * }
+ * $WIZ$ module_name = "timer"
+ * $WIZ$ module_configuration = "bertos/cfg/cfg_timer.h"
+ * $WIZ$ module_depends = "event", "sysirq"
+ * $WIZ$ module_supports = "not atmega103 and not atmega8"
  */
 
 #ifndef DRV_TIMER_H
@@ -63,6 +70,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>
@@ -113,6 +122,7 @@ extern volatile ticks_t _clock;
  * \note This function must disable interrupts on 8/16bit CPUs because the
  * clock variable is larger than the processor word size and can't
  * be copied atomically.
+ * \sa timer_delay()
  */
 INLINE ticks_t timer_clock(void)
 {
@@ -204,6 +214,12 @@ INLINE utime_t hptime_to_us(hptime_t hpticks)
 }
 
 void timer_delayTicks(ticks_t delay);
+/**
+ * Wait some time [ms].
+ *
+ * \note CPU is released while waiting so you don't have to call cpu_relax() explicitly.
+ * \param delay Time to wait [ms].
+ */
 INLINE void timer_delay(mtime_t delay)
 {
 	timer_delayTicks(ms_to_ticks(delay));
@@ -245,14 +261,23 @@ typedef struct Timer
 	DB(uint16_t magic;)
 } Timer;
 
-/** Timer is active when Timer.magic contains this value (for debugging purposes). */
+/* Timer is active when Timer.magic contains this value (for debugging purposes). */
 #define TIMER_MAGIC_ACTIVE    0xABBA
 #define TIMER_MAGIC_INACTIVE  0xBAAB
 
 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);