4 * This file is part of BeRTOS.
6 * Bertos is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * As a special exception, you may use this file as part of a free software
21 * library without restriction. Specifically, if other files instantiate
22 * templates or use macros or inline functions from this file, or you compile
23 * this file and link it with other files to produce an executable, this
24 * file does not by itself cause the resulting executable to be covered by
25 * the GNU General Public License. This exception does not however
26 * invalidate any other reasons why the executable file might be covered by
27 * the GNU General Public License.
29 * Copyright 2003, 2004, 2005 Develer S.r.l. (http://www.develer.com/)
30 * Copyright 1999, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
33 * \defgroup event_handling Event handling module
37 * \brief Events handling
39 * This module implements a common system for executing
40 * a user defined action calling a hook function.
43 * Device drivers often need to wait the completion of some event, usually to
44 * allow the hardware to accomplish some asynchronous task.
46 * A common approach is to place a busy wait with a cpu_relax() loop that invokes
47 * the architecture-specific instructions to say that we're not doing much with
50 * Although technically correct, the busy loop degrades the overall system
51 * performance in presence of multiple processes and power consumption.
53 * With the kernel the natural way to implement such wait/complete mechanism is to
54 * use signals via sig_wait() and sig_post()/sig_send().
56 * However, signals in BeRTOS are only available in presence of the kernel (that
57 * is just a compile-time option). This means that each device driver must provide
58 * two different interfaces to implement the wait/complete semantic: one with the
59 * kernel and another without the kernel.
61 * The purpose of the completion events is to provide a generic interface to
62 * implement a synchronization mechanism to block the execution of code until a
63 * specific event happens.
65 * This interface does not depend on the presence of the kernel and it
66 * automatically uses the appropriate event backend to provide the same
67 * behaviour with or without the kernel.
69 * Example usage (wait for a generic device driver initialization):
73 * static void irq_handler(void)
75 * // Completion event has happened, resume the execution of init()
79 * static void init(void)
81 * // Declare the generic completion event
82 * event_initGeneric(&e);
83 * // Submit the hardware initialization request
85 * // Wait for the completion of the event
90 * \author Bernie Innocenti <bernie@codewiz.org>
96 #include <cfg/compiler.h>
97 #include "cfg/cfg_proc.h"
98 #include "cfg/cfg_signal.h"
99 #include "cfg/cfg_timer.h"
101 #include <cpu/power.h> /* cpu_relax() */
104 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
105 #include <kern/signal.h>
112 /// User defined callback type
113 typedef void (*Hook)(void *);
117 void (*action)(struct Event *);
120 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
123 struct Process *sig_proc; /* Process to be signalled */
124 sigbit_t sig_bit; /* Signal to send */
129 struct Process *sig_proc; /* Process to be signalled */
130 Signal sig; /* Signal structure */
135 Hook func; /* Pointer to softint hook */
136 void *user_data; /* Data to be passed back to user hook */
141 bool completed; /* Generic event completion */
146 void event_hook_ignore(Event *event);
147 void event_hook_signal(Event *event);
148 void event_hook_softint(Event *event);
149 void event_hook_generic(Event *event);
150 void event_hook_generic_signal(Event *event);
151 void event_hook_generic_timeout(Event *event);
153 /** Initialize the event \a e as a no-op */
154 #define event_initNone(e) \
155 ((e)->action = event_hook_ignore)
157 /** Same as event_initNone(), but returns the initialized event */
158 INLINE Event event_createNone(void);
159 INLINE Event event_createNone(void)
162 e.action = event_hook_ignore;
166 /** Initialize the event \a e with a software interrupt (call function \a f, with parameter \a u) */
167 #define event_initSoftint(e,f,u) \
168 ((e)->action = event_hook_softint,(e)->Ev.Int.func = (f), (e)->Ev.Int.user_data = (u))
170 /** Same as event_initSoftint(), but returns the initialized event */
171 INLINE Event event_createSoftint(Hook func, void *user_data)
174 e.action = event_hook_softint;
175 e.Ev.Int.func = func;
176 e.Ev.Int.user_data = user_data;
180 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
182 /** Initialize the event \a e with a signal (send signal \a s to process \a p) */
183 #define event_initSignal(e,p,s) \
184 ((e)->action = event_hook_signal,(e)->Ev.Sig.sig_proc = (p), (e)->Ev.Sig.sig_bit = (s))
186 /** Same as event_initSignal(), but returns the initialized event */
187 INLINE Event event_createSignal(struct Process *proc, sigbit_t bit)
190 e.action = event_hook_signal;
191 e.Ev.Sig.sig_proc = proc;
192 e.Ev.Sig.sig_bit = bit;
198 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
199 /** Initialize the generic sleepable event \a e */
200 #define event_initGeneric(e) \
201 ((e)->action = event_hook_generic_signal, \
202 (e)->Ev.SigGen.sig_proc = proc_current(), \
203 (e)->Ev.SigGen.sig.wait = 0, (e)->Ev.SigGen.sig.recv = 0)
205 #define event_initGeneric(e) \
206 ((e)->action = event_hook_generic, (e)->Ev.Gen.completed = false)
210 * Signal used to implement generic events.
212 #define EVENT_GENERIC_SIGNAL SIG_SYSTEM5
215 * Create a generic sleepable event.
217 * \return the properly initialized generic event structure.
219 INLINE Event event_createGeneric(void)
222 event_initGeneric(&e);
227 * Wait the completion of event \a e.
229 * This function releases the CPU the application is configured to use
230 * the kernel, otherwise it's just a busy wait.
231 * \note It's forbidden to use this function inside irq handling functions.
233 INLINE void event_wait(Event *e)
235 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
236 e->Ev.Sig.sig_proc = proc_current();
237 sig_waitSignal(&e->Ev.SigGen.sig, EVENT_GENERIC_SIGNAL);
239 while (ACCESS_SAFE(e->Ev.Gen.completed) == false)
241 e->Ev.Gen.completed = false;
246 #if CONFIG_TIMER_EVENTS
247 #include <drv/timer.h> /* timer_clock() */
250 * Wait the completion of event \a e or \a timeout elapses.
252 * \note It's forbidden to use this function inside irq handling functions.
254 INLINE bool event_waitTimeout(Event *e, ticks_t timeout)
258 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
259 e->Ev.Sig.sig_proc = proc_current();
260 ret = (sig_waitTimeoutSignal(&e->Ev.SigGen.sig,
261 EVENT_GENERIC_SIGNAL, timeout) & SIG_TIMEOUT) ?
264 ticks_t end = timer_clock() + timeout;
266 while ((ACCESS_SAFE(e->Ev.Gen.completed) == false) ||
267 TIMER_AFTER(timer_clock(), end))
269 ret = e->Ev.Gen.completed;
270 e->Ev.Gen.completed = false;
275 #endif /* CONFIG_TIMER_EVENTS */
280 * Execute the callback function associated with event \a e.
282 * This function can be used also in interrupt routines, but only if the
283 * event was created as a signal or generic event.
285 INLINE void event_do(struct Event *e)
292 #endif /* KERN_EVENT_H */