X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=b006c5f4a3037b753a2b5bb3005983a1cbf4e053;hb=0088022a7741d4636b054f47c67be353d9242af2;hp=380b8c34c1df69df680f516ff223e536af333a8f;hpb=6eb6ebb5ae5953a27977f0ef66a36344462b949a;p=bertos.git diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h index 380b8c34..b006c5f4 100644 --- a/bertos/drv/timer.h +++ b/bertos/drv/timer.h @@ -27,16 +27,30 @@ * the GNU General Public License. * * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/) - * Copyright 2000 Bernie Innocenti - * + * Copyright 2000, 2008 Bernie Innocenti * --> * - * \brief Hardware independent timer driver (interface) + * \defgroup drv_timers Timer module + * \ingroup core + * \{ + * + * \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. * - * \version $Id$ + * 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. * * \author Bernie Innocenti * + * $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 @@ -54,20 +68,41 @@ * Try the CPU specific one for bare-metal environments. */ #if OS_HOSTED - #include OS_HEADER(timer) + //#include OS_HEADER(timer) + #include #else #include CPU_HEADER(timer) #endif +STATIC_ASSERT(sizeof(hptime_t) == SIZEOF_HPTIME_T); + #include "cfg/cfg_timer.h" #include #include #include +/* + * 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; +#define TIMER_AFTER(x, y) ((long)(y) - (long)(x) < 0) +#define TIMER_BEFORE(x, y) TIMER_AFTER(y, x) + /** * \brief Return the system tick counter (expressed in ticks) * @@ -77,17 +112,24 @@ 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) { @@ -110,6 +152,7 @@ INLINE ticks_t timer_clock_unlocked(void) return _clock; } + /** Convert \a ms [ms] to ticks. */ INLINE ticks_t ms_to_ticks(mtime_t ms) { @@ -179,6 +222,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)); @@ -191,7 +240,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 +249,7 @@ INLINE void timer_udelay(utime_t delay) } #endif -#ifndef CONFIG_TIMER_DISABLE_EVENTS +#if CONFIG_TIMER_EVENTS #include @@ -214,42 +263,80 @@ 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; -/** 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 */ -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) */ +/** + * Set the timer delay (the time before the event will be triggered) + * + * \note It's illegal to change the delay of the timer when it's + * still running. + */ INLINE void timer_setDelay(Timer *timer, ticks_t delay) { 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 event notification when it expires */ +INLINE void timer_setEvent(Timer *timer) +{ + event_initGeneric(&timer->expire); +} + +/** Wait until the timer expires */ +INLINE void timer_waitEvent(Timer *timer) +{ + event_wait(&timer->expire); +} + /** 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); } +#define timer_set_event_signal timer_setSignal + #endif /* CONFIG_KERN_SIGNALS */ +/** \} */ //defgroup drv_timers #endif /* DRV_TIMER_H */