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.24 2005/04/11 19:10:28 bernie
19 *#* Include top-level headers from cfg/ subdir.
21 *#* Revision 1.23 2005/03/01 23:25:46 bernie
22 *#* Move event.h to mware/.
24 *#* Revision 1.22 2004/12/13 12:07:06 bernie
25 *#* DISABLE_IRQSAVE/ENABLE_IRQRESTORE: Convert to IRQ_SAVE_DISABLE/IRQ_RESTORE.
27 *#* Revision 1.21 2004/12/09 08:35:21 bernie
28 *#* Replace IPTR with iptr_t.
30 *#* Revision 1.20 2004/12/08 08:56:41 bernie
31 *#* Rename sigset_t to sigmask_t; Reformat.
33 *#* Revision 1.19 2004/12/08 08:30:37 bernie
34 *#* Convert to mtime_t; timer_minutes(): Remove.
36 *#* Revision 1.18 2004/11/16 23:09:52 bernie
37 *#* Disable timer_minutes() for targets with 16bit time_t.
39 *#* Revision 1.17 2004/11/16 22:37:14 bernie
40 *#* Replace IPTR with iptr_t.
42 *#* Revision 1.16 2004/08/25 14:12:08 rasky
43 *#* Aggiornato il comment block dei log RCS
45 *#* Revision 1.15 2004/08/10 06:59:09 bernie
46 *#* timer_gettick(): Rename to timer_ticks() and add backwards compatibility inline.
48 *#* Revision 1.12 2004/07/30 14:34:10 rasky
49 *#* Vari fix per documentazione e commenti
50 *#* Aggiunte PP_CATn e STATIC_ASSERT
52 *#* Revision 1.11 2004/07/29 22:40:12 bernie
55 *#* Revision 1.10 2004/07/21 00:13:57 bernie
56 *#* Put timer driver on diet.
58 *#* Revision 1.9 2004/07/20 23:45:01 bernie
59 *#* Finally remove redundant protos.
61 *#* Revision 1.8 2004/07/18 21:57:32 bernie
62 *#* timer_gettick(): Rename to timer_tick() and document better.
64 *#* Revision 1.7 2004/06/27 15:26:17 aleph
65 *#* Declaration fix for build with GCC 3.4
67 *#* Revision 1.6 2004/06/07 18:10:06 aleph
68 *#* Remove free pool of timers; use user-provided Timer structure instead
70 *#* Revision 1.5 2004/06/07 15:57:12 aleph
71 *#* Add function prototypes
73 *#* Revision 1.4 2004/06/06 18:25:44 bernie
74 *#* Rename event macros to look like regular functions.
76 *#* Revision 1.3 2004/06/06 16:57:18 bernie
77 *#* Mark some functions INLINE instead of 'extern inline'.
79 *#* Revision 1.2 2004/06/03 11:27:09 bernie
80 *#* Add dual-license information.
82 *#* Revision 1.1 2004/05/23 18:23:30 bernie
83 *#* Import drv/timer module.
89 #include <mware/list.h>
91 #include <cfg/compiler.h>
92 #include <cfg/config.h>
94 /*! Number of timer ticks per second. */
95 #define TICKS_PER_SEC ((mtime_t)1000)
98 extern void timer_init(void);
99 extern void timer_delay(mtime_t time);
101 #ifndef CONFIG_TIMER_DISABLE_UDELAY
102 extern void timer_udelay(utime_t utime);
106 #ifndef CONFIG_TIMER_DISABLE_EVENTS
108 #include <mware/event.h>
111 * The timer driver supports multiple synchronous timers
112 * that can trigger an event when they expire.
119 Node link; /*!< Link into timers queue */
120 mtime_t delay; /*!< Timer delay in ms */
121 mtime_t tick; /*!< Timer will expire at this tick */
122 Event expire; /*!< Event to execute when the timer expires */
125 extern void timer_add(Timer *timer);
126 extern Timer *timer_abort(Timer *timer);
128 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
130 /*! Set the timer so that it sends a signal when it expires */
131 INLINE void timer_set_event_signal(Timer *timer, struct Process *proc, sigmask_t sigs)
133 event_initSignal(&timer->expire, proc, sigs);
136 #endif /* CONFIG_KERN_SIGNALS */
138 /*! Set the timer so that it calls an user hook when it expires */
139 INLINE void timer_set_event_softint(Timer *timer, Hook func, iptr_t user_data)
141 event_initSoftInt(&timer->expire, func, user_data);
144 /*! Set the timer delay (the time before the event will be triggered) */
145 INLINE void timer_set_delay(Timer *timer, mtime_t delay)
147 timer->delay = delay;
150 #endif /* CONFIG_TIMER_DISABLE_EVENTS */
152 extern volatile mtime_t _clock;
155 * \brief Return the system tick counter (expressed in ms)
157 * The result is guaranteed to increment monotonically,
158 * but client code must be tolerant with respect to overflows.
160 * The following code is safe:
163 * mtime_t tea_start_time = get_tick();
167 * if (get_tick() - tea_start_time > TEAPOT_DELAY)
168 * printf("Your tea, Sir.\n");
171 * When the tick counter increments every millisecond and mtime_t
172 * is 32bit wide, the tick count will overflow every 49.7 days.
174 * \note This function must disable interrupts on 8/16bit CPUs because the
175 * clock variable is larger than the processor word size and can't
176 * be copied atomically.
178 INLINE mtime_t timer_ticks(void)
182 ATOMIC(result = _clock);
189 * Faster version of timer_ticks(), to be called only when the timer
190 * interrupt is disabled (DISABLE_INTS) or overridden by a
191 * higher-priority or non-nesting interrupt.
195 INLINE mtime_t timer_ticks_unlocked(void)
200 #endif /* DRV_TIMER_H */