X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=a81b96f3dc0e609cfee5ede75c7be6d4776a516f;hb=0af829fd672d0b52f89183042fe535413d046e8d;hp=3d03c78112a2f078b470559f3ca1da109add1786;hpb=c22fe24a0da896a52dbc3882390ec18a440ef56a;p=bertos.git diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h index 3d03c781..a81b96f3 100644 --- a/bertos/drv/timer.h +++ b/bertos/drv/timer.h @@ -27,16 +27,26 @@ * the GNU General Public License. * * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/) - * Copyright 2000 Bernardo Innocenti - * + * Copyright 2000, 2008 Bernie Innocenti * --> * - * \brief Hardware independent timer driver (interface) + * \brief Hardware independent timer driver. * - * \version $Id$ + * 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. + * + * 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 Bernardo Innocenti + * \version $Id$ + * \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,7 +64,8 @@ * 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 @@ -63,8 +74,23 @@ #include #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; @@ -77,17 +103,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) { @@ -178,15 +211,26 @@ INLINE utime_t hptime_to_us(hptime_t hpticks) #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) @@ -195,7 +239,7 @@ INLINE void timer_udelay(utime_t delay) } #endif -#ifndef CONFIG_TIMER_DISABLE_EVENTS +#if CONFIG_TIMER_EVENTS #include @@ -209,23 +253,23 @@ 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 -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) +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) */ @@ -234,17 +278,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 */