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.21 2004/12/09 08:35:21 bernie
19 *#* Replace IPTR with iptr_t.
21 *#* Revision 1.20 2004/12/08 08:56:41 bernie
22 *#* Rename sigset_t to sigmask_t; Reformat.
24 *#* Revision 1.19 2004/12/08 08:30:37 bernie
25 *#* Convert to mtime_t; timer_minutes(): Remove.
27 *#* Revision 1.18 2004/11/16 23:09:52 bernie
28 *#* Disable timer_minutes() for targets with 16bit time_t.
30 *#* Revision 1.17 2004/11/16 22:37:14 bernie
31 *#* Replace IPTR with iptr_t.
33 *#* Revision 1.16 2004/08/25 14:12:08 rasky
34 *#* Aggiornato il comment block dei log RCS
36 *#* Revision 1.15 2004/08/10 06:59:09 bernie
37 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
39 *#* Revision 1.12 2004/07/30 14:34:10 rasky
40 *#* Vari fix per documentazione e commenti
41 *#* Aggiunte PP_CATn e STATIC_ASSERT
43 *#* Revision 1.11 2004/07/29 22:40:12 bernie
46 *#* Revision 1.10 2004/07/21 00:13:57 bernie
47 *#* Put timer driver on diet.
49 *#* Revision 1.9 2004/07/20 23:45:01 bernie
50 *#* Finally remove redundant protos.
52 *#* Revision 1.8 2004/07/18 21:57:32 bernie
53 *#* timer_gettick(): Rename to timer_tick() and document better.
55 *#* Revision 1.7 2004/06/27 15:26:17 aleph
56 *#* Declaration fix for build with GCC 3.4
58 *#* Revision 1.6 2004/06/07 18:10:06 aleph
59 *#* Remove free pool of timers; use user-provided Timer structure instead
61 *#* Revision 1.5 2004/06/07 15:57:12 aleph
62 *#* Add function prototypes
64 *#* Revision 1.4 2004/06/06 18:25:44 bernie
65 *#* Rename event macros to look like regular functions.
67 *#* Revision 1.3 2004/06/06 16:57:18 bernie
68 *#* Mark some functions INLINE instead of 'extern inline'.
70 *#* Revision 1.2 2004/06/03 11:27:09 bernie
71 *#* Add dual-license information.
73 *#* Revision 1.1 2004/05/23 18:23:30 bernie
74 *#* Import drv/timer module.
80 #include <mware/list.h>
85 /*! Number of timer ticks per second. */
86 #define TICKS_PER_SEC ((mtime_t)1000)
89 extern void timer_init(void);
90 extern void timer_delay(mtime_t time);
92 #ifndef CONFIG_TIMER_DISABLE_UDELAY
93 extern void timer_udelay(utime_t utime);
97 #ifndef CONFIG_TIMER_DISABLE_EVENTS
100 #include <kern/event.h>
102 #include <mware/event.h>
106 * The timer driver supports multiple synchronous timers
107 * that can trigger an event when they expire.
114 Node link; /*!< Link into timers queue */
115 mtime_t delay; /*!< Timer delay in ms */
116 mtime_t tick; /*!< Timer will expire at this tick */
117 Event expire; /*!< Event to execute when the timer expires */
120 extern void timer_add(Timer *timer);
121 extern Timer *timer_abort(Timer *timer);
123 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
125 /*! Set the timer so that it sends a signal when it expires */
126 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
128 event_initSignal(&timer->expire, proc, sigs);
131 #endif /* CONFIG_KERN_SIGNALS */
133 /*! Set the timer so that it calls an user hook when it expires */
134 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
136 event_initSoftInt(&timer->expire, func, user_data);
139 /*! Set the timer delay (the time before the event will be triggered) */
140 INLINE void timer_set_delay(Timer *timer, mtime_t delay)
142 timer->delay = delay;
145 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
147 extern volatile mtime_t _clock;
150 * \brief Return the system tick counter (expressed in ms)
152 * The result is guaranteed to increment monotonically,
153 * but client code must be tolerant with respect to overflows.
155 * The following code is safe:
158 * mtime_t tea_start_time = get_tick();
162 * if (get_tick() - tea_start_time > TEAPOT_DELAY)
163 * printf("Your tea, Sir.\n");
166 * When the tick counter increments every millisecond and mtime_t
167 * is 32bit wide, the tick count will overflow every 49.7 days.
169 * \note This function must disable interrupts on 8/16bit CPUs because the
170 * clock variable is larger than the processor word size and can't
171 * be copied atomically.
173 INLINE mtime_t timer_ticks(void)
178 DISABLE_IRQSAVE(flags);
180 ENABLE_IRQRESTORE(flags);
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 */