Add and cleanup comments

[bertos.git] / drv / timer.h

diff --git a/drv/timer.h b/drv/timer.h
index e1a37860bbedf55e5ecacd8b5becb00e80f3f717..88d9f2496fd061359adbc347b688f11eb16101af 100755 (executable)
--- a/drv/timer.h
+++ b/drv/timer.h
@@ -3,7 +3,7 @@
  * <!--
  * Copyright 2003,2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
- * All Rights Reserved.
+ * This file is part of DevLib - See devlib/README for information.
  * -->
  *
  * \version $Id$
@@ -15,6 +15,24 @@
 
 /*
  * $Log$
+ * Revision 1.7  2004/06/27 15:26:17  aleph
+ * Declaration fix for build with GCC 3.4
+ *
+ * Revision 1.6  2004/06/07 18:10:06  aleph
+ * Remove free pool of timers; use user-provided Timer structure instead
+ *
+ * Revision 1.5  2004/06/07 15:57:12  aleph
+ * Add function prototypes
+ *
+ * Revision 1.4  2004/06/06 18:25:44  bernie
+ * Rename event macros to look like regular functions.
+ *
+ * Revision 1.3  2004/06/06 16:57:18  bernie
+ * Mark some functions INLINE instead of 'extern inline'.
+ *
+ * Revision 1.2  2004/06/03 11:27:09  bernie
+ * Add dual-license information.
+ *
  * Revision 1.1  2004/05/23 18:23:30  bernie
  * Import drv/timer module.
  *
@@ -38,28 +56,32 @@ typedef struct Timer
        Event  expire;    /*!< Event to execute when the timer expires */
 } Timer;
 
+/* Function protos */
 extern void timer_init(void);
-extern Timer *timer_new(void);
-extern void timer_delete(Timer *timer);
 extern void timer_add(Timer *timer);
 extern Timer *timer_abort(Timer *timer);
 extern void timer_delay(time_t time);
 extern void timer_udelay(utime_t utime);
-extern inline time_t timer_gettick(void);
-extern inline time_t timer_gettick_irq(void);
+INLINE time_t timer_gettick(void);
+INLINE time_t timer_gettick_irq(void);
+INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data);
+INLINE void timer_set_delay(Timer* timer, time_t delay);
+
+#if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 
-#ifdef 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, sigset_t sigs);
 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
 {
-       INITEVENT_SIG(&timer->expire, proc, sigs);
+       event_initSignal(&timer->expire, proc, sigs);
 }
-#endif
+
+#endif /* CONFIG_KERN_SIGNALS */
 
 /*! Set the timer so that it calls an user hook when it expires */
 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
 {
-       INITEVENT_INT(&timer->expire, func, user_data);
+       event_initSoftInt(&timer->expire, func, user_data);
 }
 
 /*! Set the timer delay (the time before the event will be triggered) */
@@ -69,16 +91,16 @@ INLINE void timer_set_delay(Timer* timer, time_t delay)
 }
 
 
+extern volatile time_t _clock;
+
 /*!
  * Return the system tick counter (expressed in ms)
  * 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.
  */
-extern inline time_t timer_gettick(void)
+INLINE time_t timer_gettick(void)
 {
-       extern volatile time_t _clock;
-
        time_t result;
        cpuflags_t flags;
 
@@ -94,10 +116,8 @@ extern inline time_t timer_gettick(void)
  * Like \c timer_gettick, faster version to be called
  * from interrupt context only.
  */
-extern inline time_t timer_gettick_irq(void)
+INLINE time_t timer_gettick_irq(void)
 {
-       extern volatile time_t _clock;
-
        return _clock;
 }