doc: Move List documentation into its own section.

[bertos.git] / bertos / kern / signal.h

diff --git a/bertos/kern/signal.h b/bertos/kern/signal.h
index ffec2891b77573598f3b3ad7feb4e7cbac32364f..408e21e97538f2764b042fd7cb76fbccec8a5dd8 100644 (file)
--- a/bertos/kern/signal.h
+++ b/bertos/kern/signal.h
@@ -31,14 +31,17 @@
  *
  * -->
  *
+ * \defgroup kern_signal Kernel signals
+ * \ingroup kern
+ * \{
+ *
  * \brief Signal module for IPC.
  *
- * \version $Id$
  *
  * \author Bernie Innocenti <bernie@codewiz.org>
  *
  * $WIZ$ module_name = "signal"
- * $WIZ$ module_depends = "kernel"
+ * $WIZ$ module_depends = "kernel", "timer"
  * $WIZ$ module_configuration = "bertos/cfg/cfg_signal.h"
  */
 
@@ -46,13 +49,23 @@
 #define KERN_SIGNAL_H
 
 #include <cfg/compiler.h>
+#include <cfg/macros.h>    // BV()
 
 /* Fwd decl */
 struct Process;
 
 /* Inter-process Communication services */
 sigmask_t sig_check(sigmask_t sigs);
-void sig_signal(struct Process *proc, sigmask_t sig);
+void sig_send(struct Process *proc, sigmask_t sig);
+void sig_post(struct Process *proc, sigmask_t sig);
+/*
+ * XXX: this is provided for backword compatibility, consider to make this
+ * deprecated for the future.
+ */
+INLINE void sig_signal(struct Process *proc, sigmask_t sig)
+{
+       sig_post(proc, sig);
+}
 sigmask_t sig_wait(sigmask_t sigs);
 sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout);
 
@@ -74,4 +87,6 @@ int signal_testTearDown(void);
 #define SIG_SINGLE   BV(7)  /**< Used to wait for a single event */
 /*\}*/
 
+/* \} */ //defgroup kern_signal
+
 #endif /* KERN_SIGNAL_H */