Updated copiright notice.
[bertos.git] / 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 Bernardo Innocenti <bernie@develer.com>
31  * This file is part of DevLib - See README.devlib for information.
32  * -->
33  *
34  * \brief Signal module (public interface).
35  *
36  * \version $Id$
37  *
38  * \author Bernardo Innocenti <bernie@develer.com>
39  */
40
41 /*#*
42  *#* $Log$
43  *#* Revision 1.8  2006/07/19 12:56:27  bernie
44  *#* Convert to new Doxygen style.
45  *#*
46  *#* Revision 1.7  2005/11/04 16:20:02  bernie
47  *#* Fix reference to README.devlib in header.
48  *#*
49  *#* Revision 1.6  2005/04/11 19:10:28  bernie
50  *#* Include top-level headers from cfg/ subdir.
51  *#*
52  *#* Revision 1.5  2004/12/08 08:57:35  bernie
53  *#* Rename sigset_t to sigmask_t.
54  *#*
55  *#* Revision 1.4  2004/08/25 14:12:09  rasky
56  *#* Aggiornato il comment block dei log RCS
57  *#*
58  *#* Revision 1.3  2004/07/30 14:30:27  rasky
59  *#* Resa la sig_signal interrupt safe (con il nuovo scheduler IRQ-safe)
60  *#* Rimossa event_doIntr (ora inutile) e semplificata la logica delle macro con funzioni inline
61  *#*
62  *#* Revision 1.2  2004/06/03 11:27:09  bernie
63  *#* Add dual-license information.
64  *#*
65  *#* Revision 1.1  2004/05/23 17:27:00  bernie
66  *#* Import kern/ subdirectory.
67  *#*/
68
69 #ifndef KERN_SIGNAL_H
70 #define KERN_SIGNAL_H
71
72 #include <cfg/compiler.h>
73
74
75 /* Fwd decl */
76 struct Process;
77
78 /* Inter-process Communication services */
79 sigmask_t sig_check(sigmask_t sigs);
80 void sig_signal(struct Process *proc, sigmask_t sig);
81 sigmask_t sig_wait(sigmask_t sigs);
82
83
84 /**
85  * \name Signal definitions
86  * \{
87  */
88 #define SIG_USER0    BV(0)  /**< Free for user usage */
89 #define SIG_USER1    BV(1)  /**< Free for user usage */
90 #define SIG_USER2    BV(2)  /**< Free for user usage */
91 #define SIG_USER3    BV(3)  /**< Free for user usage */
92 #define SIG_SYSTEM4  BV(4)  /**< Reserved for system use */
93 #define SIG_SYSTEM5  BV(5)  /**< Reserved for system use */
94 #define SIG_SYSTEM6  BV(6)  /**< Reserved for system use */
95 #define SIG_SINGLE   BV(7)  /**< Used to wait for a single event */
96 /*\}*/
97
98 #endif /* KERN_SIGNAL_H */