X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Ftimer.h;h=1c361fffe580d20778bff2277ab9708912c67bd3;hb=f52e46baa21748f30f30a9e725edbf90b420ed24;hp=a75adfd26e1ec8dc8e5077cdeb38a7981b18d339;hpb=f5c3dd208e34a35779cb1ec315998e0eb4582578;p=bertos.git diff --git a/drv/timer.h b/drv/timer.h index a75adfd2..1c361fff 100755 --- a/drv/timer.h +++ b/drv/timer.h @@ -1,9 +1,9 @@ -/*! +/** * \file * * * \version $Id$ @@ -15,6 +15,36 @@ /*#* *#* $Log$ + *#* 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. + *#* + *#* Revision 1.24 2005/04/11 19:10:28 bernie + *#* Include top-level headers from cfg/ subdir. + *#* + *#* Revision 1.23 2005/03/01 23:25:46 bernie + *#* Move event.h to mware/. + *#* + *#* Revision 1.22 2004/12/13 12:07:06 bernie + *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE. + *#* *#* Revision 1.21 2004/12/09 08:35:21 bernie *#* Replace IPTR with iptr_t. *#* @@ -77,32 +107,159 @@ #ifndef DRV_TIMER_H #define DRV_TIMER_H +#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 -#include -#include -#include +#include +#include +#include + + +extern volatile ticks_t _clock; + +/** + * \brief Return the system tick counter (expressed in ticks) + * + * The result is guaranteed to increment monotonically, + * but client code must be tolerant with respect to overflows. + * + * The following code is safe: + * + * \code + * ticks_t tea_start_time = timer_clock(); + * + * boil_water(); + * + * if (timer_clock() - tea_start_time > TEAPOT_DELAY) + * printf("Your tea, Sir.\n"); + * \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. + */ +INLINE ticks_t timer_clock(void) +{ + ticks_t result; + + ATOMIC(result = _clock); -/*! Number of timer ticks per second. */ -#define TICKS_PER_SEC ((mtime_t)1000) + return result; +} -/* Function protos */ -extern void timer_init(void); -extern void timer_delay(mtime_t time); +/** + * 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. + * + * \sa timer_ticks + */ +INLINE ticks_t timer_clock_unlocked(void) +{ + return _clock; +} -#ifndef CONFIG_TIMER_DISABLE_UDELAY -extern void timer_udelay(utime_t utime); +/** Convert \a ms [ms] to ticks. */ +INLINE ticks_t ms_to_ticks(mtime_t ms) +{ +#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. */ +INLINE ticks_t us_to_ticks(utime_t us) +{ +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return ((us / 1000) * TIMER_TICKS_PER_SEC) / 1000; +#else + /* Fast timer: don't overflow ticks_t. */ + return (us * ((TIMER_TICKS_PER_SEC + 500) / 1000)) / 1000; +#endif +} -#ifndef CONFIG_TIMER_DISABLE_EVENTS +/** Convert \a ticks [ticks] to ms. */ +INLINE mtime_t ticks_to_ms(ticks_t ticks) +{ +#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. */ +INLINE utime_t ticks_to_us(ticks_t ticks) +{ +#if TIMER_TICKS_PER_SEC < 1000 + /* Slow timer: avoid rounding down too much. */ + return ((ticks * 1000) / TIMER_TICKS_PER_SEC) * 1000; +#else + /* Fast timer: avoid overflowing ticks_t. */ + return (ticks / (TIMER_TICKS_PER_SEC / 1000)) * 1000; +#endif +} + +/** 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 +} -#if CONFIG_KERNEL - #include +/** 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 - #include + return((hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC); +#endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */ +} + + +void timer_init(void); +void timer_delayTicks(ticks_t delay); +INLINE void timer_delay(mtime_t delay) +{ + timer_delayTicks(ms_to_ticks(delay)); +} + +#if !defined(CONFIG_TIMER_DISABLE_UDELAY) +void timer_busyWait(hptime_t delay); +void timer_delayHp(hptime_t delay); +INLINE void timer_udelay(utime_t delay) +{ + timer_delayHp(us_to_hptime(delay)); +} #endif -/*! +#ifndef CONFIG_TIMER_DISABLE_EVENTS + +#include + +/** * The timer driver supports multiple synchronous timers * that can trigger an event when they expire. * @@ -111,88 +268,43 @@ extern void timer_udelay(utime_t utime); */ typedef struct Timer { - Node link; /*!< Link into timers queue */ - mtime_t delay; /*!< Timer delay in ms */ - mtime_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). */ +#define TIMER_MAGIC_ACTIVE 0xABBA +#define TIMER_MAGIC_INACTIVE 0xBAAB + extern void timer_add(Timer *timer); extern Timer *timer_abort(Timer *timer); -#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) -{ - event_initSignal(&timer->expire, proc, sigs); -} - -#endif /* CONFIG_KERN_SIGNALS */ - -/*! 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) */ -INLINE void timer_set_delay(Timer *timer, mtime_t delay) +/** Set the timer delay (the time before the event will be triggered) */ +INLINE void timer_setDelay(Timer *timer, ticks_t delay) { - timer->delay = delay; + timer->_delay = delay; } #endif /* CONFIG_TIMER_DISABLE_EVENTS */ -extern volatile mtime_t _clock; +#if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS -/*! - * \brief Return the system tick counter (expressed in ms) - * - * The result is guaranteed to increment monotonically, - * but client code must be tolerant with respect to overflows. - * - * The following code is safe: - * - * \code - * mtime_t tea_start_time = get_tick(); - * - * boil_water(); - * - * if (get_tick() - tea_start_time > TEAPOT_DELAY) - * printf("Your tea, Sir.\n"); - * \endcode - * - * When the tick counter increments every millisecond and mtime_t - * is 32bit wide, the tick count will overflow every 49.7 days. - * - * \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. - */ -INLINE mtime_t timer_ticks(void) +/** 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) { - mtime_t result; - cpuflags_t flags; - - DISABLE_IRQSAVE(flags); - result = _clock; - ENABLE_IRQRESTORE(flags); - - return result; + event_initSignal(&timer->expire, proc, sigs); } +#endif /* CONFIG_KERN_SIGNALS */ -/*! - * 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_ticks - */ -INLINE mtime_t timer_ticks_unlocked(void) -{ - return _clock; -} #endif /* DRV_TIMER_H */