/*
* $Log$
+ * Revision 1.8 2004/07/18 21:57:32 bernie
+ * timer_gettick(): Rename to timer_tick() and document better.
+ *
+ * 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'.
*
#include "cpu.h"
#include "compiler.h"
#include <mware/list.h>
-#include <kern/event.h>
+
+#ifdef CONFIG_KERNEL
+ #include <kern/event.h>
+#else
+ #include <mware/event.h>
+#endif
/*! Number of timer ticks per second. */
#define TICKS_PER_SEC 1000
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);
-INLINE time_t timer_gettick(void);
-INLINE time_t timer_gettick_irq(void);
+INLINE time_t timer_tick(void);
+INLINE time_t timer_tick_unlocked(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) */
}
+extern volatile time_t _clock;
+
/*!
- * Return the system tick counter (expressed in ms)
- * This function must disable interrupts on 8/16bit CPUs because the
+ * \brief Return the system tick counter (expressed in ms)
+ *
+ * The result is guaranteed to increment monotonically,
+ * but client code must be tolerant with respect to overflows.
+ *
+ * The following code is safe:
+ *
+ * \example
+ * time_t tea_start_time = get_tick();
+ *
+ * boil_water();
+ *
+ * if (get_tick() - tea_start_time > TEAPOT_DELAY)
+ * printf("Your tea, Sir.\n");
+ * \endexample
+ *
+ * When the tick counter increments every millisecond and time_t
+ * is 32bit wide, the tick count will overflow every 49.7 days.
+ *
+ * \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.
*/
-INLINE time_t timer_gettick(void)
+INLINE time_t timer_tick(void)
{
- extern volatile time_t _clock;
-
time_t result;
cpuflags_t flags;
return result;
}
+/* OBSOLETE */
+#define timer_gettick timer_tick
+
/*!
- * Like \c timer_gettick, faster version to be called
+ * Like \c timer_tick, faster version to be called
* from interrupt context only.
+ *
+ * \sa timer_tick
*/
-INLINE time_t timer_gettick_irq(void)
+INLINE time_t timer_tick_unlocked(void)
{
- extern volatile time_t _clock;
-
return _clock;
}
+/* OBSOLETE */
+#define timer_gettick_irq timer_tick_unlocked
+
#endif /* DRV_TIMER_H */