4 * Copyright 2003, 2004 Develer S.r.l. (http://www.develer.com/)
5 * Copyright 2000 Bernardo Innocenti <bernie@develer.com>
6 * This file is part of DevLib - See devlib/README for information.
11 * \author Bernardo Innocenti <bernie@develer.com>
13 * \brief Hardware independent timer driver (interface)
18 *#* Revision 1.22 2004/12/13 12:07:06 bernie
19 *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
21 *#* Revision 1.21 2004/12/09 08:35:21 bernie
22 *#* Replace IPTR with iptr_t.
24 *#* Revision 1.20 2004/12/08 08:56:41 bernie
25 *#* Rename sigset_t to sigmask_t; Reformat.
27 *#* Revision 1.19 2004/12/08 08:30:37 bernie
28 *#* Convert to mtime_t; timer_minutes(): Remove.
30 *#* Revision 1.18 2004/11/16 23:09:52 bernie
31 *#* Disable timer_minutes() for targets with 16bit time_t.
33 *#* Revision 1.17 2004/11/16 22:37:14 bernie
34 *#* Replace IPTR with iptr_t.
36 *#* Revision 1.16 2004/08/25 14:12:08 rasky
37 *#* Aggiornato il comment block dei log RCS
39 *#* Revision 1.15 2004/08/10 06:59:09 bernie
40 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
42 *#* Revision 1.12 2004/07/30 14:34:10 rasky
43 *#* Vari fix per documentazione e commenti
44 *#* Aggiunte PP_CATn e STATIC_ASSERT
46 *#* Revision 1.11 2004/07/29 22:40:12 bernie
49 *#* Revision 1.10 2004/07/21 00:13:57 bernie
50 *#* Put timer driver on diet.
52 *#* Revision 1.9 2004/07/20 23:45:01 bernie
53 *#* Finally remove redundant protos.
55 *#* Revision 1.8 2004/07/18 21:57:32 bernie
56 *#* timer_gettick(): Rename to timer_tick() and document better.
58 *#* Revision 1.7 2004/06/27 15:26:17 aleph
59 *#* Declaration fix for build with GCC 3.4
61 *#* Revision 1.6 2004/06/07 18:10:06 aleph
62 *#* Remove free pool of timers; use user-provided Timer structure instead
64 *#* Revision 1.5 2004/06/07 15:57:12 aleph
65 *#* Add function prototypes
67 *#* Revision 1.4 2004/06/06 18:25:44 bernie
68 *#* Rename event macros to look like regular functions.
70 *#* Revision 1.3 2004/06/06 16:57:18 bernie
71 *#* Mark some functions INLINE instead of 'extern inline'.
73 *#* Revision 1.2 2004/06/03 11:27:09 bernie
74 *#* Add dual-license information.
76 *#* Revision 1.1 2004/05/23 18:23:30 bernie
77 *#* Import drv/timer module.
83 #include <mware/list.h>
88 /*! Number of timer ticks per second. */
89 #define TICKS_PER_SEC ((mtime_t)1000)
92 extern void timer_init(void);
93 extern void timer_delay(mtime_t time);
95 #ifndef CONFIG_TIMER_DISABLE_UDELAY
96 extern void timer_udelay(utime_t utime);
100 #ifndef CONFIG_TIMER_DISABLE_EVENTS
103 #include <kern/event.h>
105 #include <mware/event.h>
109 * The timer driver supports multiple synchronous timers
110 * that can trigger an event when they expire.
117 Node link; /*!< Link into timers queue */
118 mtime_t delay; /*!< Timer delay in ms */
119 mtime_t tick; /*!< Timer will expire at this tick */
120 Event expire; /*!< Event to execute when the timer expires */
123 extern void timer_add(Timer *timer);
124 extern Timer *timer_abort(Timer *timer);
126 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
128 /*! Set the timer so that it sends a signal when it expires */
129 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
131 event_initSignal(&timer->expire, proc, sigs);
134 #endif /* CONFIG_KERN_SIGNALS */
136 /*! Set the timer so that it calls an user hook when it expires */
137 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
139 event_initSoftInt(&timer->expire, func, user_data);
142 /*! Set the timer delay (the time before the event will be triggered) */
143 INLINE void timer_set_delay(Timer *timer, mtime_t delay)
145 timer->delay = delay;
148 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
150 extern volatile mtime_t _clock;
153 * \brief Return the system tick counter (expressed in ms)
155 * The result is guaranteed to increment monotonically,
156 * but client code must be tolerant with respect to overflows.
158 * The following code is safe:
161 * mtime_t tea_start_time = get_tick();
165 * if (get_tick() - tea_start_time > TEAPOT_DELAY)
166 * printf("Your tea, Sir.\n");
169 * When the tick counter increments every millisecond and mtime_t
170 * is 32bit wide, the tick count will overflow every 49.7 days.
172 * \note This function must disable interrupts on 8/16bit CPUs because the
173 * clock variable is larger than the processor word size and can't
174 * be copied atomically.
176 INLINE mtime_t timer_ticks(void)
180 ATOMIC(result = _clock);
187 * Faster version of timer_ticks(), to be called only when the timer
188 * interrupt is disabled (DISABLE_INTS) or overridden by a
189 * higher-priority or non-nesting interrupt.
193 INLINE mtime_t timer_ticks_unlocked(void)
198 #endif /* DRV_TIMER_H */