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 <cpu/irq.h>
  55
  56 #include <kern/proc.h>
  57
  58 #if CONFIG_KERN_SIGNALS
  59
  60 INLINE sigmask_t __sig_checkSignal(Signal *s, sigmask_t sigs)
  61 {
  62         sigmask_t result;
  63
  64         result = s->recv & sigs;
  65         s->recv &= ~sigs;
  66
  67         return result;
  68 }
  69
  70 /**
  71  * Check if any of the signals in \a sigs has occurred and clear them.
  72  *
  73  * \return the signals that have occurred.
  74  */
  75 INLINE sigmask_t sig_checkSignal(Signal *s, sigmask_t sigs)
  76 {
  77         cpu_flags_t flags;
  78         sigmask_t result;
  79
  80         IRQ_SAVE_DISABLE(flags);
  81         result = __sig_checkSignal(s, sigs);
  82         IRQ_RESTORE(flags);
  83
  84         return result;
  85 }
  86
  87 INLINE sigmask_t sig_check(sigmask_t sigs)
  88 {
  89         Process *proc = proc_current();
  90         return sig_checkSignal(&proc->sig, sigs);
  91 }
  92
  93 void sig_sendSignal(Signal *s, Process *proc, sigmask_t sig);
  94
  95 INLINE void sig_send(Process *proc, sigmask_t sig)
  96 {
  97         sig_sendSignal(&proc->sig, proc, sig);
  98 }
  99
 100 void sig_postSignal(Signal *s, Process *proc, sigmask_t sig);
 101
 102 INLINE void sig_post(Process *proc, sigmask_t sig)
 103 {
 104         sig_postSignal(&proc->sig, proc, sig);
 105 }
 106
 107 /*
 108  * XXX: this is provided for backword compatibility, consider to make this
 109  * deprecated for the future.
 110  */
 111 INLINE void sig_signal(Process *proc, sigmask_t sig)
 112 {
 113         sig_postSignal(&proc->sig, proc, sig);
 114 }
 115
 116 sigmask_t sig_waitSignal(Signal *s, sigmask_t sigs);
 117
 118 INLINE sigmask_t sig_wait(sigmask_t sigs)
 119 {
 120         Process *proc = proc_current();
 121         return sig_waitSignal(&proc->sig, sigs);
 122 }
 123
 124 sigmask_t sig_waitTimeoutSignal(Signal *s, sigmask_t sigs, ticks_t timeout);
 125
 126 INLINE sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout)
 127 {
 128         Process *proc = proc_current();
 129         return sig_waitTimeoutSignal(&proc->sig, sigs, timeout);
 130 }
 131
 132 #endif /* CONFIG_KERN_SIGNALS */
 133
 134 int signal_testRun(void);
 135 int signal_testSetup(void);
 136 int signal_testTearDown(void);
 137
 138 /**
 139  * \name Signal definitions
 140  * \{
 141  */
 142 #define SIG_USER0    BV(0)  /**< Free for user usage */
 143 #define SIG_USER1    BV(1)  /**< Free for user usage */
 144 #define SIG_USER2    BV(2)  /**< Free for user usage */
 145 #define SIG_USER3    BV(3)  /**< Free for user usage */
 146 #define SIG_SINGLE   BV(4)  /**< Used to wait for a single event */
 147 #define SIG_SYSTEM5  BV(5)  /**< Reserved for internal system use */
 148 #define SIG_SYSTEM6  BV(6)  /**< Reserved for internal system use */
 149 #define SIG_TIMEOUT  BV(7)  /**< Reserved for timeout use */
 150
 151 /**
 152  * Max number of signals that can be used by drivers or user applications.
 153  */
 154 #define SIG_USER_MAX SIG_SINGLE
 155 /*\}*/
 156
 157 /* \} */ //defgroup kern_signal
 158
 159 #endif /* KERN_SIGNAL_H */