bertos/kern/signal.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   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.
  10  *
  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.
  15  *
  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
  19  *
  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.
  28  *
  29  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 1999,2000,2001 Bernie Innocenti <bernie@codewiz.org>
  31  *
  32  * -->
  33  *
  34  * \defgroup kern_signal Kernel signals
  35  * \ingroup kern
  36  * \{
  37  *
  38  * \brief Signal module for IPC.
  39  *
  40  *
  41  * \author Bernie Innocenti <bernie@codewiz.org>
  42  *
  43  * $WIZ$ module_name = "signal"
  44  * $WIZ$ module_depends = "kernel", "timer"
  45  * $WIZ$ module_configuration = "bertos/cfg/cfg_signal.h"
  46  */
  47
  48 #ifndef KERN_SIGNAL_H
  49 #define KERN_SIGNAL_H
  50
  51 #include <cfg/compiler.h>
  52 #include <cfg/macros.h>    // BV()
  53
  54 /* Fwd decl */
  55 struct Process;
  56
  57 /**
  58  * Signal structure
  59  */
  60 typedef struct Signal
  61 {
  62         sigmask_t    wait;    /**< Signals the process is waiting for */
  63         sigmask_t    recv;    /**< Received signals */
  64 } Signal;
  65
  66 /* Inter-process Communication services */
  67 sigmask_t sig_check(sigmask_t sigs);
  68 void sig_send(struct Process *proc, sigmask_t sig);
  69 void sig_post(struct Process *proc, sigmask_t sig);
  70 /*
  71  * XXX: this is provided for backword compatibility, consider to make this
  72  * deprecated for the future.
  73  */
  74 INLINE void sig_signal(struct Process *proc, sigmask_t sig)
  75 {
  76         sig_post(proc, sig);
  77 }
  78 sigmask_t sig_wait(sigmask_t sigs);
  79 sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout);
  80
  81 int signal_testRun(void);
  82 int signal_testSetup(void);
  83 int signal_testTearDown(void);
  84
  85 /**
  86  * \name Signal definitions
  87  * \{
  88  */
  89 #define SIG_USER0    BV(0)  /**< Free for user usage */
  90 #define SIG_USER1    BV(1)  /**< Free for user usage */
  91 #define SIG_USER2    BV(2)  /**< Free for user usage */
  92 #define SIG_USER3    BV(3)  /**< Free for user usage */
  93 #define SIG_TIMEOUT  BV(4)  /**< Reserved for timeout use */
  94 #define SIG_SYSTEM5  BV(5)  /**< Reserved for system use */
  95 #define SIG_SYSTEM6  BV(6)  /**< Reserved for system use */
  96 #define SIG_SINGLE   BV(7)  /**< Used to wait for a single event */
  97 /*\}*/
  98
  99 /* \} */ //defgroup kern_signal
 100
 101 #endif /* KERN_SIGNAL_H */