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.12 2004/07/30 14:34:10 rasky
19 * Vari fix per documentazione e commenti
20 * Aggiunte PP_CATn e STATIC_ASSERT
22 * Revision 1.11 2004/07/29 22:40:12 bernie
25 * Revision 1.10 2004/07/21 00:13:57 bernie
26 * Put timer driver on diet.
28 * Revision 1.9 2004/07/20 23:45:01 bernie
29 * Finally remove redundant protos.
31 * Revision 1.8 2004/07/18 21:57:32 bernie
32 * timer_gettick(): Rename to timer_tick() and document better.
34 * Revision 1.7 2004/06/27 15:26:17 aleph
35 * Declaration fix for build with GCC 3.4
37 * Revision 1.6 2004/06/07 18:10:06 aleph
38 * Remove free pool of timers; use user-provided Timer structure instead
40 * Revision 1.5 2004/06/07 15:57:12 aleph
41 * Add function prototypes
43 * Revision 1.4 2004/06/06 18:25:44 bernie
44 * Rename event macros to look like regular functions.
46 * Revision 1.3 2004/06/06 16:57:18 bernie
47 * Mark some functions INLINE instead of 'extern inline'.
49 * Revision 1.2 2004/06/03 11:27:09 bernie
50 * Add dual-license information.
52 * Revision 1.1 2004/05/23 18:23:30 bernie
53 * Import drv/timer module.
62 #include <mware/list.h>
64 /*! Number of timer ticks per second. */
65 #define TICKS_PER_SEC 1000
68 extern void timer_init(void);
69 extern void timer_delay(time_t time);
71 #ifndef CONFIG_TIMER_DISABLE_UDELAY
72 extern void timer_udelay(utime_t utime);
76 #ifndef CONFIG_TIMER_DISABLE_EVENTS
79 #include <kern/event.h>
81 #include <mware/event.h>
85 * The timer driver supports multiple synchronous timers
86 * that can trigger an event when they expire.
93 Node link; /*!< Link into timers queue */
94 time_t delay; /*!< Timer delay in ms */
95 time_t tick; /*!< Timer will expire at this tick */
96 Event expire; /*!< Event to execute when the timer expires */
99 extern void timer_add(Timer *timer);
100 extern Timer *timer_abort(Timer *timer);
102 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
104 /*! Set the timer so that it sends a signal when it expires */
105 INLINE void timer_set_event_signal(Timer* timer, struct Process* proc, sigset_t sigs)
107 event_initSignal(&timer->expire, proc, sigs);
110 #endif /* CONFIG_KERN_SIGNALS */
112 /*! Set the timer so that it calls an user hook when it expires */
113 INLINE void timer_set_event_softint(Timer* timer, Hook func, void* user_data)
115 event_initSoftInt(&timer->expire, func, user_data);
118 /*! Set the timer delay (the time before the event will be triggered) */
119 INLINE void timer_set_delay(Timer* timer, time_t delay)
121 timer->delay = delay;
124 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
126 extern volatile time_t _clock;
129 * \brief Return the system tick counter (expressed in ms)
131 * The result is guaranteed to increment monotonically,
132 * but client code must be tolerant with respect to overflows.
134 * The following code is safe:
137 * time_t tea_start_time = get_tick();
141 * if (get_tick() - tea_start_time > TEAPOT_DELAY)
142 * printf("Your tea, Sir.\n");
145 * When the tick counter increments every millisecond and time_t
146 * is 32bit wide, the tick count will overflow every 49.7 days.
148 * \note This function must disable interrupts on 8/16bit CPUs because the
149 * clock variable is larger than the processor word size and can't
150 * be copied atomically.
152 INLINE time_t timer_tick(void)
157 DISABLE_IRQSAVE(flags);
159 ENABLE_IRQRESTORE(flags);
165 #define timer_gettick timer_tick
169 * Faster version of timer_tick(), to be called only when the timer
170 * interrupt is disabled (DISABLE_INTS) or overridden by a
171 * higher-priority or non-nesting interrupt.
175 INLINE time_t timer_tick_unlocked(void)
181 #define timer_gettick_irq timer_tick_unlocked
183 #endif /* DRV_TIMER_H */