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 /**
  88  * Check if any of the signals in \a sigs has occurred and clear them.
  89  *
  90  * \return the signals that have occurred.
  91  */
  92 INLINE sigmask_t sig_check(sigmask_t sigs)
  93 {
  94         Process *proc = proc_current();
  95         return sig_checkSignal(&proc->sig, sigs);
  96 }
  97
  98 void sig_sendSignal(Signal *s, Process *proc, sigmask_t sig);
  99
 100 /**
 101  * Send the signals \a sigs to the process \a proc and immeditaly dispatch it
 102  * for execution.
 103  *
 104  * The process will be awoken if it was waiting for any of them and immediately
 105  * dispatched for execution.
 106  *
 107  * \note This function can't be called from IRQ context, use sig_post()
 108  * instead.
 109  */
 110 INLINE void sig_send(Process *proc, sigmask_t sig)
 111 {
 112         sig_sendSignal(&proc->sig, proc, sig);
 113 }
 114
 115 void sig_postSignal(Signal *s, Process *proc, sigmask_t sig);
 116
 117 /**
 118  * Send the signals \a sigs to the process \a proc.
 119  * The process will be awoken if it was waiting for any of them.
 120  *
 121  * \note This call is interrupt safe.
 122  */
 123 INLINE void sig_post(Process *proc, sigmask_t sig)
 124 {
 125         sig_postSignal(&proc->sig, proc, sig);
 126 }
 127
 128 /*
 129  * XXX: this is provided for backword compatibility, consider to make this
 130  * deprecated for the future.
 131  */
 132 INLINE void sig_signal(Process *proc, sigmask_t sig)
 133 {
 134         sig_postSignal(&proc->sig, proc, sig);
 135 }
 136
 137 sigmask_t sig_waitSignal(Signal *s, sigmask_t sigs);
 138
 139 /**
 140  * Sleep until any of the signals in \a sigs occurs.
 141  *
 142  * \return the signal(s) that have awoken the process.
 143  */
 144 INLINE sigmask_t sig_wait(sigmask_t sigs)
 145 {
 146         Process *proc = proc_current();
 147         return sig_waitSignal(&proc->sig, sigs);
 148 }
 149
 150 sigmask_t sig_waitTimeoutSignal(Signal *s, sigmask_t sigs, ticks_t timeout,
 151                                 Hook func, iptr_t data);
 152
 153 /**
 154  * Sleep until any of the signals in \a sigs or \a timeout ticks elapse.
 155  * If the timeout elapse a SIG_TIMEOUT is added to the received signal(s).
 156  * \return the signal(s) that have awoken the process.
 157  * \note Caller must check return value to check which signal awoke the process.
 158  */
 159 INLINE sigmask_t sig_waitTimeout(sigmask_t sigs, ticks_t timeout)
 160 {
 161         Process *proc = proc_current();
 162         return sig_waitTimeoutSignal(&proc->sig, sigs, timeout,
 163                         NULL, NULL);
 164 }
 165
 166 #endif /* CONFIG_KERN_SIGNALS */
 167
 168 int signal_testRun(void);
 169 int signal_testSetup(void);
 170 int signal_testTearDown(void);
 171
 172 /**
 173  * \name Signal definitions
 174  * \{
 175  */
 176 #define SIG_USER0    BV(0)  /**< Free for user usage */
 177 #define SIG_USER1    BV(1)  /**< Free for user usage */
 178 #define SIG_USER2    BV(2)  /**< Free for user usage */
 179 #define SIG_USER3    BV(3)  /**< Free for user usage */
 180 #define SIG_SINGLE   BV(4)  /**< Used to wait for a single event */
 181 #define SIG_SYSTEM5  BV(5)  /**< Reserved for internal system use */
 182 #define SIG_SYSTEM6  BV(6)  /**< Reserved for internal system use */
 183 #define SIG_TIMEOUT  BV(7)  /**< Reserved for timeout use */
 184
 185 /**
 186  * Max number of signals that can be used by drivers or user applications.
 187  */
 188 #define SIG_USER_MAX SIG_SINGLE
 189 /*\}*/
 190
 191 /* \} */ //defgroup kern_signal
 192
 193 #endif /* KERN_SIGNAL_H */