X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Ftimer.h;h=5c1d9001402c60353d4a3358972efe0cb2b7a911;hb=46ac2c9347e738ee3c23109b83d522023ac4e7c9;hp=7bde5f5bb9667d2d0b2917fd89cc605afca5f3f2;hpb=528790e0e4433fa1e1394cdfa23eb33dfd934185;p=bertos.git diff --git a/drv/timer.h b/drv/timer.h index 7bde5f5b..5c1d9001 100755 --- a/drv/timer.h +++ b/drv/timer.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \version $Id$ @@ -15,6 +15,27 @@ /*#* *#* $Log$ + *#* Revision 1.32 2007/01/09 08:57:19 bernie + *#* Remove excess parentheses. + *#* + *#* Revision 1.31 2006/07/19 12:56:26 bernie + *#* Convert to new Doxygen style. + *#* + *#* Revision 1.30 2006/02/24 00:26:49 bernie + *#* Fixes for CONFIG_KERNEL. + *#* + *#* Revision 1.29 2006/02/21 21:28:02 bernie + *#* New time handling based on TIMER_TICKS_PER_SEC to support slow timers with ticks longer than 1ms. + *#* + *#* Revision 1.28 2006/02/17 22:24:21 bernie + *#* Update POSIX timer emulator. + *#* + *#* Revision 1.27 2005/11/27 03:04:19 bernie + *#* Move test code to timer_test.c; Add OS_HOSTED support. + *#* + *#* Revision 1.26 2005/11/04 16:20:02 bernie + *#* Fix reference to README.devlib in header. + *#* *#* Revision 1.25 2005/07/19 07:26:37 bernie *#* Refactor to decouple timer ticks from milliseconds. *#* @@ -89,24 +110,28 @@ #ifndef DRV_TIMER_H #define DRV_TIMER_H -#include +#include +#include + +/* + * Include platform-specific binding header if we're hosted. + * Try the CPU specific one for bare-metal environments. + */ +#if OS_HOSTED + #include OS_HEADER(timer) +#else + #include CPU_HEADER(timer) +#endif -#include CPU_HEADER(timer) #include -#include +#include #include #include -/*! Number of timer ticks per second. */ -#define TIMER_TICKS_PER_SEC (TIMER_TICKS_PER_MSEC * 1000) - -/*! Number of ticks per microsecond */ -#define TIMER_TICKS_PER_USEC ((TIMER_TICKS_PER_MSEC + 500) / 1000) - extern volatile ticks_t _clock; -/*! +/** * \brief Return the system tick counter (expressed in ticks) * * The result is guaranteed to increment monotonically, @@ -136,7 +161,7 @@ INLINE ticks_t timer_clock(void) return result; } -/*! +/** * Faster version of timer_clock(), to be called only when the timer * interrupt is disabled (DISABLE_INTS) or overridden by a * higher-priority or non-nesting interrupt. @@ -148,60 +173,72 @@ INLINE ticks_t timer_clock_unlocked(void) return _clock; } - - -//TODO: take care of slow timers so add convertions for seconds to ticks and viceversa. - -/*! Convert \a ms [ms] to ticks */ +/** Convert \a ms [ms] to ticks. */ INLINE ticks_t ms_to_ticks(mtime_t ms) { - return ms * TIMER_TICKS_PER_MSEC; +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return (ms * TIMER_TICKS_PER_SEC) / 1000; +#else + /* Fast timer: don't overflow ticks_t. */ + return ms * ((TIMER_TICKS_PER_SEC + 500) / 1000); +#endif } -/*! Convert \a us [us] to ticks */ +/** Convert \a us [us] to ticks. */ INLINE ticks_t us_to_ticks(utime_t us) { -#if TIMER_TICKS_PER_MSEC < 10000 - return (us * TIMER_TICKS_PER_MSEC + 500) / 1000; +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000; #else - return (us * TIMER_TICKS_PER_USEC); + /* Fast timer: don't overflow ticks_t. */ + return (us * ((TIMER_TICKS_PER_SEC + 500) / 1000)) / 1000; #endif } -/*! Convert \a ticks [ticks] to ms */ +/** Convert \a ticks [ticks] to ms. */ INLINE mtime_t ticks_to_ms(ticks_t ticks) { - return (ticks + TIMER_TICKS_PER_MSEC / 2) / TIMER_TICKS_PER_MSEC; +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return (ticks * 1000) / TIMER_TICKS_PER_SEC; +#else + /* Fast timer: avoid overflowing ticks_t. */ + return ticks / (TIMER_TICKS_PER_SEC / 1000); +#endif } -/*! Convert \a ticks [ticks] to us */ +/** Convert \a ticks [ticks] to us. */ INLINE utime_t ticks_to_us(ticks_t ticks) { -#if TIMER_TICKS_PER_USEC > 10 - return (ticks / TIMER_TICKS_PER_USEC); +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000; #else - return (ticks * 1000 + TIMER_TICKS_PER_MSEC / 2) / TIMER_TICKS_PER_MSEC; + /* Fast timer: avoid overflowing ticks_t. */ + return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000; #endif } -/*! Convert \a us [us] to hpticks */ +/** Convert \a us [us] to hpticks */ INLINE hptime_t us_to_hptime(utime_t us) { - #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL - return(us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL)); - #else - return((us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL)); - #endif /* TIMER_HW_HPTICKS_PER_SEC > 10000000UL */ +#if TIMER_HW_HPTICKS_PER_SEC > 10000000UL + return us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL); +#else + return (us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL; +#endif } -/*! Convert \a hpticks [hptime] to usec */ +/** Convert \a hpticks [hptime] to usec */ INLINE utime_t hptime_to_us(hptime_t hpticks) { - #if TIMER_HW_HPTICKS_PER_SEC < 100000UL - return(hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC)); - #else - return((hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC); - #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */ +#if TIMER_HW_HPTICKS_PER_SEC < 100000UL + return hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC); +#else + return (hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC; +#endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */ } @@ -221,15 +258,11 @@ INLINE void timer_udelay(utime_t delay) } #endif -#if CONFIG_TEST -void timer_test(void); -#endif /* CONFIG_TEST */ - #ifndef CONFIG_TIMER_DISABLE_EVENTS #include -/*! +/** * The timer driver supports multiple synchronous timers * that can trigger an event when they expire. * @@ -238,27 +271,27 @@ void timer_test(void); */ 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 */ - Event expire; /*!< Event to execute when the timer expires */ + Node link; /**< Link into timers queue */ + ticks_t _delay; /**< Timer delay in ms */ + ticks_t tick; /**< Timer will expire at this tick */ + 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); -/*! Set the timer so that it calls an user hook when it expires */ +/** 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) { 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) */ INLINE void timer_setDelay(Timer *timer, ticks_t delay) { timer->_delay = delay; @@ -268,7 +301,7 @@ INLINE void timer_setDelay(Timer *timer, ticks_t delay) #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS -/*! Set the timer so that it sends a signal when it expires */ +/** 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) { event_initSignal(&timer->expire, proc, sigs);