* the GNU General Public License.
*
* Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
- * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
- *
+ * Copyright 2000, 2008 Bernie Innocenti <bernie@codewiz.org>
* -->
*
- * \version $Id$
+ * \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.
+ * \li simple synchronous timer based scheduler: use synctimer_add() to schedule an event in a user provided queue.
*
- * \author Bernardo Innocenti <bernie@develer.com>
+ * 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>
*
- * \brief Hardware independent timer driver (interface)
+ * $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
#include <cfg/os.h>
#include <cfg/macros.h>
+
#include <cpu/attr.h>
#include <cpu/irq.h>
* Try the CPU specific one for bare-metal environments.
*/
#if OS_HOSTED
- #include OS_HEADER(timer)
+ //#include OS_HEADER(timer)
+ #include <emul/timer_posix.h>
#else
#include CPU_HEADER(timer)
#endif
-#include <mware/list.h>
+STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T);
+
+#include "cfg/cfg_timer.h"
#include <cfg/debug.h>
#include <cfg/compiler.h>
-#include <appconfig.h>
+#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;
* 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
* clock variable is larger than the processor word size and can't
* be copied atomically.
+ * \sa timer_delay()
*/
INLINE ticks_t timer_clock(void)
{
#endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
}
-
-void timer_init(void);
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));
}
-#if !defined(CONFIG_TIMER_DISABLE_UDELAY)
+void timer_init(void);
+void timer_cleanup(void);
+
+int timer_testSetup(void);
+int timer_testRun(void);
+int timer_testTearDown(void);
+
+#if CONFIG_TIMER_UDELAY
void timer_busyWait(hptime_t delay);
void timer_delayHp(hptime_t delay);
INLINE void timer_udelay(utime_t delay)
}
#endif
-#ifndef CONFIG_TIMER_DISABLE_EVENTS
+#if CONFIG_TIMER_EVENTS
#include <mware/event.h>
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;
-/** 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
-extern void timer_add(Timer *timer);
-extern Timer *timer_abort(Timer *timer);
+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_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
+/**
+ * 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);
+ event_initSoftint(&timer->expire, func, user_data);
}
/** Set the timer delay (the time before the event will be triggered) */
timer->_delay = delay;
}
-#endif /* CONFIG_TIMER_DISABLE_EVENTS */
+
+void synctimer_add(Timer *timer, List* q);
+
+/** \sa timer_abort */
+#define synctimer_abort(t) timer_abort(t)
+
+void synctimer_poll(List* q);
+
+
+#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 */
projects / bertos.git / blobdiff