-/*!
+/**
* \file
* <!--
- * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction. Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License. This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
+ * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
* Copyright 2000 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ *
* -->
*
* \version $Id$
* \brief Hardware independent timer driver (interface)
*/
-/*#*
- *#* $Log$
- *#* Revision 1.18 2004/11/16 23:09:52 bernie
- *#* Disable timer_minutes() for targets with 16bit time_t.
- *#*
- *#* Revision 1.17 2004/11/16 22:37:14 bernie
- *#* Replace IPTR with iptr_t.
- *#*
- *#* 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 <config.h>
-#include <mware/list.h>
-
-/*! Number of timer ticks per second. */
-#define TICKS_PER_SEC ((time_t)1000)
+#include <cfg/os.h>
+#include <cfg/macros.h>
+#include <cpu/attr.h>
+#include <cpu/irq.h>
-/* 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
-
-#if CONFIG_KERNEL
- #include <kern/event.h>
+/*
+ * 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 <mware/event.h>
+ #include CPU_HEADER(timer)
#endif
-/*!
- * 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;
-}
+#include <mware/list.h>
+#include <cfg/debug.h>
+#include <cfg/compiler.h>
+#include <appconfig.h>
-#endif /* CONFIG_TIMER_DISABLE_EVENTS */
-extern volatile time_t _clock;
+extern volatile ticks_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.
* 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
+ * \sa timer_clock
*/
-INLINE time_t timer_ticks_unlocked(void)
+INLINE ticks_t timer_clock_unlocked(void)
{
return _clock;
}
+/** 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 * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000);
+#endif
+}
-/*
- * timer_minutes() makes no sense when time_t is 16bit because
- * it overflows every 65.536 seconds.
- */
-#if SIZEOF_TIME_T >= 4
+/** 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 * DIV_ROUND(TIMER_TICKS_PER_SEC, 1000)) / 1000;
+#endif
+}
-/*!
- * Return the minutes passed since timer start.
+/** 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 * DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000000UL);
+#else
+ return (us * ((TIMER_HW_HPTICKS_PER_SEC + 500) / 1000UL) + 500) / 1000UL;
+#endif
+}
+
+/** Convert \a hpticks [hptime] to usec */
+INLINE utime_t hptime_to_us(hptime_t hpticks)
+{
+#if TIMER_HW_HPTICKS_PER_SEC < 100000UL
+ return hpticks * DIV_ROUND(1000000UL, TIMER_HW_HPTICKS_PER_SEC);
+#else
+ return (hpticks * 1000UL) / DIV_ROUND(TIMER_HW_HPTICKS_PER_SEC, 1000UL);
+#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 <mware/event.h>
+
+/**
+ * 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
+{
+ 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);
+}
+
+/** Set the timer delay (the time before the event will be triggered) */
+INLINE void timer_setDelay(Timer *timer, ticks_t delay)
{
- return timer_ticks() / (TICKS_PER_SEC * 60);
+ timer->_delay = delay;
}
-#endif /* SIZEOF_TIME_T >= 4 */
+#endif /* CONFIG_TIMER_DISABLE_EVENTS */
-#endif /* DRV_TIMER_H */
+#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 */