4 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See README.devlib for information.
11 * \author Bernardo Innocenti <bernie@develer.com>
13 * \brief Hardware independent timer driver (interface)
18 *#* Revision 1.26 2005/11/04 16:20:02 bernie
19 *#* Fix reference to README.devlib in header.
21 *#* Revision 1.25 2005/07/19 07:26:37 bernie
22 *#* Refactor to decouple timer ticks from milliseconds.
24 *#* Revision 1.24 2005/04/11 19:10:28 bernie
25 *#* Include top-level headers from cfg/ subdir.
27 *#* Revision 1.23 2005/03/01 23:25:46 bernie
28 *#* Move event.h to mware/.
30 *#* Revision 1.22 2004/12/13 12:07:06 bernie
31 *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
33 *#* Revision 1.21 2004/12/09 08:35:21 bernie
34 *#* Replace IPTR with iptr_t.
36 *#* Revision 1.20 2004/12/08 08:56:41 bernie
37 *#* Rename sigset_t to sigmask_t; Reformat.
39 *#* Revision 1.19 2004/12/08 08:30:37 bernie
40 *#* Convert to mtime_t; timer_minutes(): Remove.
42 *#* Revision 1.18 2004/11/16 23:09:52 bernie
43 *#* Disable timer_minutes() for targets with 16bit time_t.
45 *#* Revision 1.17 2004/11/16 22:37:14 bernie
46 *#* Replace IPTR with iptr_t.
48 *#* Revision 1.16 2004/08/25 14:12:08 rasky
49 *#* Aggiornato il comment block dei log RCS
51 *#* Revision 1.15 2004/08/10 06:59:09 bernie
52 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
54 *#* Revision 1.12 2004/07/30 14:34:10 rasky
55 *#* Vari fix per documentazione e commenti
56 *#* Aggiunte PP_CATn e STATIC_ASSERT
58 *#* Revision 1.11 2004/07/29 22:40:12 bernie
61 *#* Revision 1.10 2004/07/21 00:13:57 bernie
62 *#* Put timer driver on diet.
64 *#* Revision 1.9 2004/07/20 23:45:01 bernie
65 *#* Finally remove redundant protos.
67 *#* Revision 1.8 2004/07/18 21:57:32 bernie
68 *#* timer_gettick(): Rename to timer_tick() and document better.
70 *#* Revision 1.7 2004/06/27 15:26:17 aleph
71 *#* Declaration fix for build with GCC 3.4
73 *#* Revision 1.6 2004/06/07 18:10:06 aleph
74 *#* Remove free pool of timers; use user-provided Timer structure instead
76 *#* Revision 1.5 2004/06/07 15:57:12 aleph
77 *#* Add function prototypes
79 *#* Revision 1.4 2004/06/06 18:25:44 bernie
80 *#* Rename event macros to look like regular functions.
82 *#* Revision 1.3 2004/06/06 16:57:18 bernie
83 *#* Mark some functions INLINE instead of 'extern inline'.
85 *#* Revision 1.2 2004/06/03 11:27:09 bernie
86 *#* Add dual-license information.
88 *#* Revision 1.1 2004/05/23 18:23:30 bernie
89 *#* Import drv/timer module.
95 #include <cfg/debug.h>
97 #include CPU_HEADER(timer)
98 #include <mware/list.h>
100 #include <cfg/compiler.h>
101 #include <appconfig.h>
103 /*! Number of timer ticks per second. */
104 #define TIMER_TICKS_PER_SEC (TIMER_TICKS_PER_MSEC * 1000)
106 /*! Number of ticks per microsecond */
107 #define TIMER_TICKS_PER_USEC ((TIMER_TICKS_PER_MSEC + 500) / 1000)
110 extern volatile ticks_t _clock;
113 * \brief Return the system tick counter (expressed in ticks)
115 * The result is guaranteed to increment monotonically,
116 * but client code must be tolerant with respect to overflows.
118 * The following code is safe:
121 * ticks_t tea_start_time = timer_clock();
125 * if (timer_clock() - tea_start_time > TEAPOT_DELAY)
126 * printf("Your tea, Sir.\n");
129 * \note This function must disable interrupts on 8/16bit CPUs because the
130 * clock variable is larger than the processor word size and can't
131 * be copied atomically.
133 INLINE ticks_t timer_clock(void)
137 ATOMIC(result = _clock);
143 * Faster version of timer_clock(), to be called only when the timer
144 * interrupt is disabled (DISABLE_INTS) or overridden by a
145 * higher-priority or non-nesting interrupt.
149 INLINE ticks_t timer_clock_unlocked(void)
156 //TODO: take care of slow timers so add convertions for seconds to ticks and viceversa.
158 /*! Convert \a ms [ms] to ticks */
159 INLINE ticks_t ms_to_ticks(mtime_t ms)
161 return ms * TIMER_TICKS_PER_MSEC;
164 /*! Convert \a us [us] to ticks */
165 INLINE ticks_t us_to_ticks(utime_t us)
167 #if TIMER_TICKS_PER_MSEC < 10000
168 return (us * TIMER_TICKS_PER_MSEC + 500) / 1000;
170 return (us * TIMER_TICKS_PER_USEC);
174 /*! Convert \a ticks [ticks] to ms */
175 INLINE mtime_t ticks_to_ms(ticks_t ticks)
177 return (ticks + TIMER_TICKS_PER_MSEC / 2) / TIMER_TICKS_PER_MSEC;
180 /*! Convert \a ticks [ticks] to us */
181 INLINE utime_t ticks_to_us(ticks_t ticks)
183 #if TIMER_TICKS_PER_USEC > 10
184 return (ticks / TIMER_TICKS_PER_USEC);
186 return (ticks * 1000 + TIMER_TICKS_PER_MSEC / 2) / TIMER_TICKS_PER_MSEC;
190 /*! Convert \a us [us] to hpticks */
191 INLINE hptime_t us_to_hptime(utime_t us)
193 #if TIMER_HW_HPTICKS_PER_SEC > 10000000UL
194 return(us * ((TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL));
196 return((us * TIMER_HW_HPTICKS_PER_SEC + 500000UL) / 1000000UL));
197 #endif /* TIMER_HW_HPTICKS_PER_SEC > 10000000UL */
200 /*! Convert \a hpticks [hptime] to usec */
201 INLINE utime_t hptime_to_us(hptime_t hpticks)
203 #if TIMER_HW_HPTICKS_PER_SEC < 100000UL
204 return(hpticks * (1000000UL / TIMER_HW_HPTICKS_PER_SEC));
206 return((hpticks * 1000000UL) / TIMER_HW_HPTICKS_PER_SEC);
207 #endif /* TIMER_HW_HPTICKS_PER_SEC < 100000UL */
211 void timer_init(void);
212 void timer_delayTicks(ticks_t delay);
213 INLINE void timer_delay(mtime_t delay)
215 timer_delayTicks(ms_to_ticks(delay));
218 #if !defined(CONFIG_TIMER_DISABLE_UDELAY)
219 void timer_busyWait(hptime_t delay);
220 void timer_delayHp(hptime_t delay);
221 INLINE void timer_udelay(utime_t delay)
223 timer_delayHp(us_to_hptime(delay));
228 void timer_test(void);
229 #endif /* CONFIG_TEST */
231 #ifndef CONFIG_TIMER_DISABLE_EVENTS
233 #include <mware/event.h>
236 * The timer driver supports multiple synchronous timers
237 * that can trigger an event when they expire.
244 Node link; /*!< Link into timers queue */
245 ticks_t _delay; /*!< Timer delay in ms */
246 ticks_t tick; /*!< Timer will expire at this tick */
247 Event expire; /*!< Event to execute when the timer expires */
251 /*! Timer is active when Timer.magic contains this value (for debugging purposes). */
252 #define TIMER_MAGIC_ACTIVE 0xABBA
253 #define TIMER_MAGIC_INACTIVE 0xBAAB
255 extern void timer_add(Timer *timer);
256 extern Timer *timer_abort(Timer *timer);
258 /*! Set the timer so that it calls an user hook when it expires */
259 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
261 event_initSoftInt(&timer->expire, func, user_data);
264 /*! Set the timer delay (the time before the event will be triggered) */
265 INLINE void timer_setDelay(Timer *timer, ticks_t delay)
267 timer->_delay = delay;
270 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
272 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
274 /*! Set the timer so that it sends a signal when it expires */
275 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
277 event_initSignal(&timer->expire, proc, sigs);
280 #endif /* CONFIG_KERN_SIGNALS */
283 #endif /* DRV_TIMER_H */