X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=41f43f655d5cc191201fd0c7c8fa1736d334c965;hb=9d38debd0d2b2eaeeeec7f82d7c39e749ac729e5;hp=2e1dcdbecd292e28529336988b2977052f0c3c23;hpb=46b32fefc02b4b8fc3a9ee1e7225f3053b514a02;p=bertos.git

diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h
index 2e1dcdbe..41f43f65 100644
--- a/bertos/drv/timer.h
+++ b/bertos/drv/timer.h
@@ -27,16 +27,13 @@
  * the GNU General Public License.
  *
  * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2000 Bernie Innocenti <bernie@codewiz.org>
- *
+ * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
  * \brief Hardware independent timer driver (interface)
  *
  * \version $Id$
- *
  * \author Bernie Innocenti <bernie@codewiz.org>
- *
  */
 
 #ifndef DRV_TIMER_H
@@ -65,6 +62,21 @@
 
 #include <struct/list.h>
 
+/*
+ * Sanity check for config parameters required by this module.
+ */
+#if !defined(CONFIG_TIMER_EVENTS) || ((CONFIG_TIMER_EVENTS != 0) && CONFIG_TIMER_EVENTS != 1)
+	#error CONFIG_TIMER_EVENTS must be set to either 0 or 1 in cfg_timer.h
+#endif
+#if !defined(CONFIG_TIMER_UDELAY) || ((CONFIG_TIMER_UDELAY != 0) && CONFIG_TIMER_EVENTS != 1)
+	#error CONFIG_TIMER_UDELAY must be set to either 0 or 1 in cfg_timer.h
+#endif
+#if defined(CONFIG_TIMER_DISABLE_UDELAY)
+	#error Obosolete config option CONFIG_TIMER_DISABLE_UDELAY.  Use CONFIG_TIMER_UDELAY
+#endif
+#if defined(CONFIG_TIMER_DISABLE_EVENTS)
+	#error Obosolete config option CONFIG_TIMER_DISABLE_EVENTS.  Use CONFIG_TIMER_EVENTS
+#endif
 
 extern volatile ticks_t _clock;
 
@@ -77,12 +89,18 @@ extern volatile ticks_t _clock;
  * The following code is safe:
  *
  * \code
+ *   drop_teabag();
  *   ticks_t tea_start_time = timer_clock();
  *
- *   boil_water();
- *
- *   if (timer_clock() - tea_start_time > TEAPOT_DELAY)
- *       printf("Your tea, Sir.\n");
+ *   for (;;)
+ *   {
+ *       if (timer_clock() - tea_start_time > TEAPOT_DELAY)
+ *       {
+ *           printf("Your tea, Sir.\n");
+ *           break;
+ *       }
+ *       patience();
+ *   }
  * \endcode
  *
  * \note This function must disable interrupts on 8/16bit CPUs because the
@@ -191,7 +209,7 @@ int timer_testSetup(void);
 int timer_testRun(void);
 int timer_testTearDown(void);
 
-#if !defined(CONFIG_TIMER_DISABLE_UDELAY)
+#if CONFIG_TIMER_UDELAY
 void timer_busyWait(hptime_t delay);
 void timer_delayHp(hptime_t delay);
 INLINE void timer_udelay(utime_t delay)
@@ -200,7 +218,7 @@ INLINE void timer_udelay(utime_t delay)
 }
 #endif
 
-#ifndef CONFIG_TIMER_DISABLE_EVENTS
+#if CONFIG_TIMER_EVENTS
 
 #include <mware/event.h>
 
@@ -214,8 +232,8 @@ INLINE void timer_udelay(utime_t delay)
 typedef struct Timer
 {
 	Node    link;     /**< Link into timers queue */
-	ticks_t _delay;   /**< Timer delay in ms */
-	ticks_t tick;     /**< Timer will expire at this tick */
+	ticks_t _delay;   /**< [ticks] Timer delay */
+	ticks_t tick;     /**< [ticks] When this timer will expire */
 	Event   expire;   /**< Event to execute when the timer expires */
 	DB(uint16_t magic;)
 } Timer;
@@ -228,13 +246,13 @@ void timer_add(Timer *timer);
 Timer *timer_abort(Timer *timer);
 
 /** Set the timer so that it calls an user hook when it expires */
-INLINE void timer_setSoftInt(Timer *timer, Hook func, iptr_t user_data)
+INLINE void timer_setSoftint(Timer *timer, Hook func, iptr_t user_data)
 {
 	event_initSoftInt(&timer->expire, func, user_data);
 }
 
 // OBSOLETE
-#define  timer_set_event_softint timer_setSoftInt
+#define  timer_set_event_softint timer_setSoftint
 
 /** Set the timer delay (the time before the event will be triggered) */
 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
@@ -242,17 +260,18 @@ INLINE void timer_setDelay(Timer *timer, ticks_t delay)
 	timer->_delay = delay;
 }
 
-#endif /* CONFIG_TIMER_DISABLE_EVENTS */
+#endif /* CONFIG_TIMER_EVENTS */
 
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 
 /** Set the timer so that it sends a signal when it expires */
-INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
+INLINE void timer_setSignal(Timer *timer, struct Process *proc, sigmask_t sigs)
 {
 	event_initSignal(&timer->expire, proc, sigs);
 }
 
-#endif /* CONFIG_KERN_SIGNALS */
+#define timer_set_event_signal timer_setSignal
 
+#endif /* CONFIG_KERN_SIGNALS */
 
 #endif /* DRV_TIMER_H */