X-Git-Url: https://codewiz.org/gitweb?a=blobdiff_plain;ds=sidebyside;f=bertos%2Fmware%2Fevent.h;h=b797b7eb25a35add0bef5fa02b9509e9149d40e9;hb=63dca689018786e2dedba8683dc230b8abd82c98;hp=e640105669490d7d7c25d8c5f731202ac5098f83;hpb=1e5e45887029f15c8a3ea43edf162ed93d3f25b1;p=bertos.git

diff --git a/bertos/mware/event.h b/bertos/mware/event.h
index e6401056..b797b7eb 100644
--- a/bertos/mware/event.h
+++ b/bertos/mware/event.h
@@ -30,12 +30,13 @@
  * Copyright 1999, 2001, 2003 Bernie Innocenti <bernie@codewiz.org>
  * -->
  *
+ * \addtogroup event_handling
+ *
  * \brief Events handling
  *
  * This module implements a common system for executing
  * a user defined action calling a hook function.
  *
- *  NOTE: Generic completion events
  *
  *  Device drivers often need to wait the completion of some event, usually to
  *  allow the hardware to accomplish some asynchronous task.
@@ -64,7 +65,7 @@
  *  behaviour with or without the kernel.
  *
  *  Example usage (wait for a generic device driver initialization):
- *  \verbatim
+ *  \code
  *  static Event e;
  *
  *  static void irq_handler(void)
@@ -82,7 +83,7 @@
  *      // Wait for the completion of the event
  *      event_wait(&e);
  *  }
- *  \endverbatim
+ *  \endcode
  *
  * \author Bernie Innocenti <bernie@codewiz.org>
  */
@@ -106,6 +107,11 @@
 	struct Process;
 #endif
 
+/**
+ * \defgroup event_handling Events handling module
+ * \{
+ */
+
 
 /// User defined callback type
 typedef void (*Hook)(void *);
@@ -218,6 +224,10 @@ INLINE Event event_createGeneric(void)
 
 /**
  * Wait the completion of event \a e.
+ *
+ * This function releases the CPU the application is configured to use
+ * the kernel, otherwise it's just a busy wait.
+ * \note It's forbidden to use this function inside irq handling functions.
  */
 INLINE void event_wait(Event *e)
 {
@@ -241,33 +251,44 @@ INLINE void event_wait(Event *e)
 
 /**
  * Wait the completion of event \a e or \a timeout elapses.
+ *
+ * \note It's forbidden to use this function inside irq handling functions.
  */
 INLINE bool event_waitTimeout(Event *e, ticks_t timeout)
 {
+	bool ret;
+
 #if defined(CONFIG_KERN_SIGNALS) && CONFIG_KERN_SIGNALS
 	e->Ev.Sig.sig_proc = proc_current();
-	return (sig_waitTimeout(e->Ev.Sig.sig_bit, timeout) & SIG_TIMEOUT) ?
+	ret = (sig_waitTimeout(e->Ev.Sig.sig_bit, timeout) & SIG_TIMEOUT) ?
 				false : true;
 #else
 	ticks_t end = timer_clock() + timeout;
-	bool ret;
 
 	while ((ACCESS_SAFE(e->Ev.Gen.completed) == false) ||
 			TIMER_AFTER(timer_clock(), end))
 		cpu_relax();
 	ret = e->Ev.Gen.completed;
 	e->Ev.Gen.completed = false;
+#endif
 	MEMORY_BARRIER;
-
 	return ret;
-#endif
 }
 #endif /* CONFIG_TIMER_EVENTS */
 
-/** Trigger an event */
+/**
+ * Trigger an event.
+ *
+ * Execute the callback function associated with event \a e.
+ *
+ * This function can be used also in interrupt routines, but only if the
+ * event was created as a signal or generic event.
+ */
 INLINE void event_do(struct Event *e)
 {
 	e->action(e);
 }
 
+/** \} */
+
 #endif /* KERN_EVENT_H */