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 #include <kern/proc.h>
  55
  56 #if CONFIG_KERN_SIGNALS
  57
  58 /* Inter-process Communication services */
  59 sigmask_t sig_checkSignal(Signal *s, sigmask_t sigs);
  60
  61 INLINE sigmask_t sig_check(sigmask_t sigs)
  62 {
  63         Process *proc = proc_current();
  64         return sig_checkSignal(&proc->sig, sigs);
  65 }
  66
  67 void sig_sendSignal(Signal *s, Process *proc, sigmask_t sig);
  68
  69 INLINE void sig_send(Process *proc, sigmask_t sig)
  70 {
  71         sig_sendSignal(&proc->sig, proc, sig);
  72 }
  73
  74 void sig_postSignal(Signal *s, Process *proc, sigmask_t sig);
  75
  76 INLINE void sig_post(Process *proc, sigmask_t sig)
  77 {
  78         sig_postSignal(&proc->sig, proc, sig);
  79 }
  80
  81 /*
  82  * XXX: this is provided for backword compatibility, consider to make this
  83  * deprecated for the future.
  84  */
  85 INLINE void sig_signal(Process *proc, sigmask_t sig)
  86 {
  87         sig_postSignal(&proc->sig, proc, sig);
  88 }
  89
  90 sigmask_t sig_waitSignal(Signal *s, sigmask_t sigs);
  91
  92 INLINE sigmask_t sig_wait(sigmask_t sigs)
  93 {
  94         Process *proc = proc_current();
  95         return sig_waitSignal(&proc->sig, sigs);
  96 }
  97
  98 sigmask_t sig_waitTimeoutSignal(Signal *s, sigmask_t sigs, ticks_t timeout);
  99
 100 INLINE sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout)
 101 {
 102         Process *proc = proc_current();
 103         return sig_waitTimeoutSignal(&proc->sig, sigs, timeout);
 104 }
 105
 106 #endif /* CONFIG_KERN_SIGNALS */
 107
 108 int signal_testRun(void);
 109 int signal_testSetup(void);
 110 int signal_testTearDown(void);
 111
 112 /**
 113  * \name Signal definitions
 114  * \{
 115  */
 116 #define SIG_USER0    BV(0)  /**< Free for user usage */
 117 #define SIG_USER1    BV(1)  /**< Free for user usage */
 118 #define SIG_USER2    BV(2)  /**< Free for user usage */
 119 #define SIG_USER3    BV(3)  /**< Free for user usage */
 120 #define SIG_SINGLE   BV(4)  /**< Used to wait for a single event */
 121 #define SIG_SYSTEM5  BV(5)  /**< Reserved for internal system use */
 122 #define SIG_SYSTEM6  BV(6)  /**< Reserved for internal system use */
 123 #define SIG_TIMEOUT  BV(7)  /**< Reserved for timeout use */
 124
 125 /**
 126  * Max number of signals that can be used by drivers or user applications.
 127  */
 128 #define SIG_USER_MAX SIG_SINGLE
 129 /*\}*/
 130
 131 /* \} */ //defgroup kern_signal
 132
 133 #endif /* KERN_SIGNAL_H */