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.17 2004/11/16 22:37:14 bernie
19 *#* Replace IPTR with iptr_t.
21 *#* Revision 1.16 2004/08/25 14:12:08 rasky
22 *#* Aggiornato il comment block dei log RCS
24 *#* Revision 1.15 2004/08/10 06:59:09 bernie
25 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
27 *#* Revision 1.12 2004/07/30 14:34:10 rasky
28 *#* Vari fix per documentazione e commenti
29 *#* Aggiunte PP_CATn e STATIC_ASSERT
31 *#* Revision 1.11 2004/07/29 22:40:12 bernie
34 *#* Revision 1.10 2004/07/21 00:13:57 bernie
35 *#* Put timer driver on diet.
37 *#* Revision 1.9 2004/07/20 23:45:01 bernie
38 *#* Finally remove redundant protos.
40 *#* Revision 1.8 2004/07/18 21:57:32 bernie
41 *#* timer_gettick(): Rename to timer_tick() and document better.
43 *#* Revision 1.7 2004/06/27 15:26:17 aleph
44 *#* Declaration fix for build with GCC 3.4
46 *#* Revision 1.6 2004/06/07 18:10:06 aleph
47 *#* Remove free pool of timers; use user-provided Timer structure instead
49 *#* Revision 1.5 2004/06/07 15:57:12 aleph
50 *#* Add function prototypes
52 *#* Revision 1.4 2004/06/06 18:25:44 bernie
53 *#* Rename event macros to look like regular functions.
55 *#* Revision 1.3 2004/06/06 16:57:18 bernie
56 *#* Mark some functions INLINE instead of 'extern inline'.
58 *#* Revision 1.2 2004/06/03 11:27:09 bernie
59 *#* Add dual-license information.
61 *#* Revision 1.1 2004/05/23 18:23:30 bernie
62 *#* Import drv/timer module.
71 #include <mware/list.h>
73 /*! Number of timer ticks per second. */
74 #define TICKS_PER_SEC ((time_t)1000)
77 extern void timer_init(void);
78 extern void timer_delay(time_t time);
80 #ifndef CONFIG_TIMER_DISABLE_UDELAY
81 extern void timer_udelay(utime_t utime);
85 #ifndef CONFIG_TIMER_DISABLE_EVENTS
88 #include <kern/event.h>
90 #include <mware/event.h>
94 * The timer driver supports multiple synchronous timers
95 * that can trigger an event when they expire.
102 Node link; /*!< Link into timers queue */
103 time_t delay; /*!< Timer delay in ms */
104 time_t tick; /*!< Timer will expire at this tick */
105 Event expire; /*!< Event to execute when the timer expires */
108 extern void timer_add(Timer *timer);
109 extern Timer *timer_abort(Timer *timer);
111 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
113 /*! Set the timer so that it sends a signal when it expires */
114 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
116 event_initSignal(&timer->expire, proc, sigs);
119 #endif /* CONFIG_KERN_SIGNALS */
121 /*! Set the timer so that it calls an user hook when it expires */
122 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
124 event_initSoftInt(&timer->expire, func, user_data);
127 /*! Set the timer delay (the time before the event will be triggered) */
128 INLINE void timer_set_delay(Timer* timer, time_t delay)
130 timer->delay = delay;
133 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
135 extern volatile time_t _clock;
138 * \brief Return the system tick counter (expressed in ms)
140 * The result is guaranteed to increment monotonically,
141 * but client code must be tolerant with respect to overflows.
143 * The following code is safe:
146 * time_t tea_start_time = get_tick();
150 * if (get_tick() - tea_start_time > TEAPOT_DELAY)
151 * printf("Your tea, Sir.\n");
154 * When the tick counter increments every millisecond and time_t
155 * is 32bit wide, the tick count will overflow every 49.7 days.
157 * \note This function must disable interrupts on 8/16bit CPUs because the
158 * clock variable is larger than the processor word size and can't
159 * be copied atomically.
161 INLINE time_t timer_ticks(void)
166 DISABLE_IRQSAVE(flags);
168 ENABLE_IRQRESTORE(flags);
175 * Faster version of timer_ticks(), to be called only when the timer
176 * interrupt is disabled (DISABLE_INTS) or overridden by a
177 * higher-priority or non-nesting interrupt.
181 INLINE time_t timer_ticks_unlocked(void)
188 * Return the minutes passed since timer start.
190 * The uptime in minutes is computed directly from system tick counter.
191 * This value wraps around every 71582 minutes with a 32bit time_t.
193 INLINE time_t timer_minutes(void)
195 return timer_ticks() / (TICKS_PER_SEC * 60);
198 #endif /* DRV_TIMER_H */