Restore wrong committ.
[bertos.git] / kern / signal.c
old mode 100755 (executable)
new mode 100644 (file)
index e64272b..0e97709
@@ -1,9 +1,34 @@
-/*!
+/**
  * \file
  * <!--
+ * This file is part of BeRTOS.
+ *
+ * Bertos is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ *
+ * As a special exception, you may use this file as part of a free software
+ * library without restriction.  Specifically, if other files instantiate
+ * templates or use macros or inline functions from this file, or you compile
+ * this file and link it with other files to produce an executable, this
+ * file does not by itself cause the resulting executable to be covered by
+ * the GNU General Public License.  This exception does not however
+ * invalidate any other reasons why the executable file might be covered by
+ * the GNU General Public License.
+ *
  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  * Copyright 1999, 2000, 2001 Bernardo Innocenti <bernie@develer.com>
- * This file is part of DevLib - See devlib/README for information.
+ *
  * -->
  *
  * \brief IPC signals implementation.
 
 /*#*
  *#* $Log$
+ *#* Revision 1.14  2006/07/19 12:56:27  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.13  2006/02/24 01:17:05  bernie
+ *#* Update for new emulator.
+ *#*
+ *#* Revision 1.12  2005/11/04 16:20:02  bernie
+ *#* Fix reference to README.devlib in header.
+ *#*
  *#* Revision 1.11  2005/04/11 19:10:28  bernie
  *#* Include top-level headers from cfg/ subdir.
  *#*
  *#*/
 
 #include "signal.h"
-#include "proc.h"
-#include "proc_p.h"
-#include "hw.h"
+
 #include <cfg/debug.h>
+#include <drv/timer.h>
+#include <kern/proc.h>
+#include <kern/proc_p.h>
 
 #if CONFIG_KERN_SIGNALS
 
-/*!
+/**
  * Check if any of the signals in \a sigs has occurred and clear them.
- * Return the signals that have occurred.
+ * \return the signals that have occurred.
  */
 sigmask_t sig_check(sigmask_t sigs)
 {
@@ -129,9 +165,9 @@ sigmask_t sig_check(sigmask_t sigs)
 }
 
 
-/*!
+/**
  * Sleep until any of the signals in \a sigs occurs.
- * Return the signal(s) that have awaked the process.
+ * \return the signal(s) that have awaked the process.
  */
 sigmask_t sig_wait(sigmask_t sigs)
 {
@@ -159,8 +195,26 @@ sigmask_t sig_wait(sigmask_t sigs)
        return result;
 }
 
+/**
+ * Sleep until any of the signals in \a sigs or \a timeout ticks elapse.
+ * If the timeout elapse a SIG_TIMEOUT is added to the received signal(s).
+ * \return the signal(s) that have awaked the process.
+ * \note Caller must check return value to check which signal has awaked the process.
+ */
+sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout)
+{
+       Timer t;
+
+       ASSERT(!sig_check(SIG_TIMEOUT));
+       ASSERT(!(sigs & SIG_TIMEOUT));
+       timer_set_event_signal(&t, proc_current(), SIG_TIMEOUT);
+       timer_setDelay(&t, timeout);
+       timer_add(&t);
+       return sig_wait(SIG_TIMEOUT | sigs);
+}
+
 
-/*!
+/**
  * Send the signals \a sigs to the process \a proc.
  * The process will be awaken if it was waiting for any of them.
  *