X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=bertos%2Fdrv%2Ftimer.h;h=6ae1907e6863ca5b2e182b694811e5a1eaab25c0;hb=cfa8814ca45e8bae9b36713bc534ecb581834016;hp=a71dfb68a852e5dd2eaabec288347299472b2849;hpb=42e61240ce8a55e92fe0942fecbee3abe371c507;p=bertos.git diff --git a/bertos/drv/timer.h b/bertos/drv/timer.h index a71dfb68..6ae1907e 100644 --- a/bertos/drv/timer.h +++ b/bertos/drv/timer.h @@ -27,16 +27,13 @@ * 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) * * \version $Id$ - * * \author Bernie Innocenti - * */ #ifndef DRV_TIMER_H @@ -54,7 +51,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 +61,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,12 +90,18 @@ 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 @@ -191,7 +210,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 +219,7 @@ INLINE void timer_udelay(utime_t delay) } #endif -#ifndef CONFIG_TIMER_DISABLE_EVENTS +#if CONFIG_TIMER_EVENTS #include @@ -214,8 +233,8 @@ 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; @@ -228,28 +247,32 @@ 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); } +// OBSOLETE +#define timer_set_event_softint timer_setSoftint + /** Set the timer delay (the time before the event will be triggered) */ 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 */