X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Ftimer.h;h=924ee26c415a833343a26937add0e81cab920ec0;hb=8ff088ff4cf0ddbff09c6630e36370bf25f33535;hp=5a9c93e2b3f2a633bfe715e761046930eae9857e;hpb=2708af4ade1a189c58adb4a6e543ea80be781730;p=bertos.git diff --git a/drv/timer.h b/drv/timer.h index 5a9c93e2..924ee26c 100755 --- a/drv/timer.h +++ b/drv/timer.h @@ -13,52 +13,87 @@ * \brief Hardware independent timer driver (interface) */ -/* - * $Log$ - * Revision 1.9 2004/07/20 23:45:01 bernie - * Finally remove redundant protos. - * - * 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'. - * - * Revision 1.2 2004/06/03 11:27:09 bernie - * Add dual-license information. - * - * Revision 1.1 2004/05/23 18:23:30 bernie - * Import drv/timer module. - * - */ +/*#* + *#* $Log$ + *#* Revision 1.16 2004/08/25 14:12:08 rasky + *#* Aggiornato il comment block dei log RCS + *#* + *#* Revision 1.15 2004/08/10 06:59:09 bernie + *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline. + *#* + *#* Revision 1.12 2004/07/30 14:34:10 rasky + *#* Vari fix per documentazione e commenti + *#* Aggiunte PP_CATn e STATIC_ASSERT + *#* + *#* Revision 1.11 2004/07/29 22:40:12 bernie + *#* Spelling fix. + *#* + *#* Revision 1.10 2004/07/21 00:13:57 bernie + *#* Put timer driver on diet. + *#* + *#* Revision 1.9 2004/07/20 23:45:01 bernie + *#* Finally remove redundant protos. + *#* + *#* 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'. + *#* + *#* Revision 1.2 2004/06/03 11:27:09 bernie + *#* Add dual-license information. + *#* + *#* Revision 1.1 2004/05/23 18:23:30 bernie + *#* Import drv/timer module. + *#* + *#*/ #ifndef DRV_TIMER_H #define DRV_TIMER_H #include "cpu.h" #include "compiler.h" +#include #include +/*! Number of timer ticks per second. */ +#define TICKS_PER_SEC ((time_t)1000) + +/* Function protos */ +extern void timer_init(void); +extern void timer_delay(time_t time); + +#ifndef CONFIG_TIMER_DISABLE_UDELAY +extern void timer_udelay(utime_t utime); +#endif + + +#ifndef CONFIG_TIMER_DISABLE_EVENTS + #ifdef CONFIG_KERNEL #include #else #include #endif -/*! Number of timer ticks per second. */ -#define TICKS_PER_SEC 1000 - +/*! + * The timer driver supports multiple synchronous timers + * that can trigger an event when they expire. + * + * \sa timer_add() + * \sa timer_abort() + */ typedef struct Timer { Node link; /*!< Link into timers queue */ @@ -67,12 +102,8 @@ typedef struct Timer Event expire; /*!< Event to execute when the timer expires */ } Timer; -/* Function protos */ -extern void timer_init(void); 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); #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS @@ -96,6 +127,7 @@ INLINE void timer_set_delay(Timer* timer, time_t delay) timer->delay = delay; } +#endif /* CONFIG_TIMER_DISABLE_EVENTS */ extern volatile time_t _clock; @@ -107,14 +139,14 @@ extern volatile time_t _clock; * * The following code is safe: * - * \example + * \code * time_t tea_start_time = get_tick(); * * boil_water(); * * if (get_tick() - tea_start_time > TEAPOT_DELAY) * printf("Your tea, Sir.\n"); - * \endexample + * \endcode * * When the tick counter increments every millisecond and time_t * is 32bit wide, the tick count will overflow every 49.7 days. @@ -123,7 +155,7 @@ extern volatile time_t _clock; * clock variable is larger than the processor word size and can't * be copied atomically. */ -INLINE time_t timer_tick(void) +INLINE time_t timer_ticks(void) { time_t result; cpuflags_t flags; @@ -135,23 +167,41 @@ INLINE time_t timer_tick(void) return result; } -/* OBSOLETE */ -#define timer_gettick timer_tick +DEPRECATED INLINE time_t timer_gettick(void) +{ + return timer_ticks(); +} /*! - * Like \c timer_tick, faster version to be called - * from interrupt context only. + * Faster version of timer_ticks(), to be called only when the timer + * interrupt is disabled (DISABLE_INTS) or overridden by a + * higher-priority or non-nesting interrupt. * - * \sa timer_tick + * \sa timer_ticks */ -INLINE time_t timer_tick_unlocked(void) +INLINE time_t timer_ticks_unlocked(void) { return _clock; } -/* OBSOLETE */ -#define timer_gettick_irq timer_tick_unlocked +DEPRECATED INLINE time_t timer_gettick_irq(void) +{ + return timer_ticks_unlocked(); +} + + +/*! + * Return the minutes passed since timer start. + * + * The minutes uptime is computed directly from system tick counter: + * in case of a 4 bytes time_t after 71582 minutes the value will + * wrap around. + */ +INLINE time_t timer_minutes(void) +{ + return timer_ticks() / (TICKS_PER_SEC * 60); +} #endif /* DRV_TIMER_H */