X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;f=drv%2Ftimer.h;h=7bde5f5bb9667d2d0b2917fd89cc605afca5f3f2;hb=528790e0e4433fa1e1394cdfa23eb33dfd934185;hp=bb8c89dda02c34ce168e6cc7bbb937752528236e;hpb=5f6b4b226d25c237d9d0831785f19acd1d7fb316;p=bertos.git diff --git a/drv/timer.h b/drv/timer.h index bb8c89dd..7bde5f5b 100755 --- a/drv/timer.h +++ b/drv/timer.h @@ -1,7 +1,7 @@ /*! * \file * @@ -15,6 +15,27 @@ /*#* *#* $Log$ + *#* 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. + *#* + *#* Revision 1.20 2004/12/08 08:56:41 bernie + *#* Rename sigset_t to sigmask_t; Reformat. + *#* + *#* Revision 1.19 2004/12/08 08:30:37 bernie + *#* Convert to mtime_t; timer_minutes(): Remove. + *#* *#* Revision 1.18 2004/11/16 23:09:52 bernie *#* Disable timer_minutes() for targets with 16bit time_t. *#* @@ -68,77 +89,25 @@ #ifndef DRV_TIMER_H #define DRV_TIMER_H -#include "cpu.h" -#include "compiler.h" -#include +#include + +#include CPU_HEADER(timer) #include +#include +#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); +#define TIMER_TICKS_PER_SEC (TIMER_TICKS_PER_MSEC * 1000) -#ifndef CONFIG_TIMER_DISABLE_UDELAY -extern void timer_udelay(utime_t utime); -#endif +/*! Number of ticks per microsecond */ +#define TIMER_TICKS_PER_USEC ((TIMER_TICKS_PER_MSEC + 500) / 1000) -#ifndef CONFIG_TIMER_DISABLE_EVENTS - -#if CONFIG_KERNEL - #include -#else - #include -#endif +extern volatile ticks_t _clock; /*! - * 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 */ - time_t delay; /*!< Timer delay in ms */ - time_t tick; /*!< Timer will expire at this tick */ - Event expire; /*!< Event to execute when the timer expires */ -} Timer; - -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, sigset_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 */ -INLINE void timer_set_event_softint(Timer* timer, Hook func, void* 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, time_t delay) -{ - timer->delay = delay; -} - -#endif /* CONFIG_TIMER_DISABLE_EVENTS */ - -extern volatile time_t _clock; - -/*! - * \brief Return the system tick counter (expressed in ms) + * \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. @@ -146,66 +115,166 @@ extern volatile time_t _clock; * The following code is safe: * * \code - * time_t tea_start_time = get_tick(); + * ticks_t tea_start_time = timer_clock(); * * boil_water(); * - * if (get_tick() - tea_start_time > TEAPOT_DELAY) + * if (timer_clock() - tea_start_time > TEAPOT_DELAY) * printf("Your tea, Sir.\n"); * \endcode * - * When the tick counter increments every millisecond and time_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 time_t timer_ticks(void) +INLINE ticks_t timer_clock(void) { - time_t result; - cpuflags_t flags; + ticks_t result; - DISABLE_IRQSAVE(flags); - result = _clock; - ENABLE_IRQRESTORE(flags); + ATOMIC(result = _clock); return result; } - /*! - * Faster version of timer_ticks(), to be called only when the timer + * 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 time_t timer_ticks_unlocked(void) +INLINE ticks_t timer_clock_unlocked(void) { return _clock; } -/* - * timer_minutes() makes no sense when time_t is 16bit because - * it overflows every 65.536 seconds. - */ -#if SIZEOF_TIME_T >= 4 + +//TODO: take care of slow timers so add convertions for seconds to ticks and viceversa. + +/*! Convert \a ms [ms] to ticks */ +INLINE ticks_t ms_to_ticks(mtime_t ms) +{ + return ms * TIMER_TICKS_PER_MSEC; +} + +/*! 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; +#else + return (us * TIMER_TICKS_PER_USEC); +#endif +} + +/*! 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; +} + +/*! 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); +#else + return (ticks * 1000 + TIMER_TICKS_PER_MSEC / 2) / TIMER_TICKS_PER_MSEC; +#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 /* TIMER_HW_HPTICKS_PER_SEC > 10000000UL */ +} + +/*! 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 */ +} + + +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 + +#if CONFIG_TEST +void timer_test(void); +#endif /* CONFIG_TEST */ + +#ifndef CONFIG_TIMER_DISABLE_EVENTS + +#include /*! - * Return the minutes passed since timer start. + * The timer driver supports multiple synchronous timers + * that can trigger an event when they expire. * - * 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. + * \sa timer_add() + * \sa timer_abort() */ -INLINE time_t timer_minutes(void) +typedef struct Timer { - return timer_ticks() / (TICKS_PER_SEC * 60); + 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); + +/*! 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); } -#endif /* SIZEOF_TIME_T >= 4 */ +/*! 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 /* DRV_TIMER_H */ +#endif /* CONFIG_TIMER_DISABLE_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) +{ + event_initSignal(&timer->expire, proc, sigs); +} +#endif /* CONFIG_KERN_SIGNALS */ + + +#endif /* DRV_TIMER_H */