mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
137 lines
14 KiB
HTML
137 lines
14 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
|
|
<title>ChibiOS/RT: chcond.h Source File</title>
|
|
<link href="custom.css" rel="stylesheet" type="text/css">
|
|
<link href="tabs.css" rel="stylesheet" type="text/css">
|
|
</head><body>
|
|
<table style="text-align: center; width: 100%;" border="0"
|
|
cellpadding="2" cellspacing="2">
|
|
<tbody>
|
|
<tr>
|
|
<td style="width: 80px;"><img alt="ChibiOS/RT Logo" src="logo_small.png"></td>
|
|
<td><big><big>ChibiOS/RT</big></big><br><br>Architecture - Reference Manual - Guides</td>
|
|
<td style="width: 80px;"></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<hr size="1">
|
|
<!-- Generated by Doxygen 1.6.3 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="main.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li class="current"><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="tabs">
|
|
<ul>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<h1>chcond.h</h1><a href="chcond_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
|
|
<a name="l00002"></a>00002 <span class="comment"> ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010 Giovanni Di Sirio.</span>
|
|
<a name="l00003"></a>00003 <span class="comment"></span>
|
|
<a name="l00004"></a>00004 <span class="comment"> This file is part of ChibiOS/RT.</span>
|
|
<a name="l00005"></a>00005 <span class="comment"></span>
|
|
<a name="l00006"></a>00006 <span class="comment"> ChibiOS/RT is free software; you can redistribute it and/or modify</span>
|
|
<a name="l00007"></a>00007 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
|
|
<a name="l00008"></a>00008 <span class="comment"> the Free Software Foundation; either version 3 of the License, or</span>
|
|
<a name="l00009"></a>00009 <span class="comment"> (at your option) any later version.</span>
|
|
<a name="l00010"></a>00010 <span class="comment"></span>
|
|
<a name="l00011"></a>00011 <span class="comment"> ChibiOS/RT is distributed in the hope that it will be useful,</span>
|
|
<a name="l00012"></a>00012 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
|
|
<a name="l00013"></a>00013 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
|
|
<a name="l00014"></a>00014 <span class="comment"> GNU General Public License for more details.</span>
|
|
<a name="l00015"></a>00015 <span class="comment"></span>
|
|
<a name="l00016"></a>00016 <span class="comment"> You should have received a copy of the GNU General Public License</span>
|
|
<a name="l00017"></a>00017 <span class="comment"> along with this program. If not, see <http://www.gnu.org/licenses/>.</span>
|
|
<a name="l00018"></a>00018 <span class="comment"></span>
|
|
<a name="l00019"></a>00019 <span class="comment"> ---</span>
|
|
<a name="l00020"></a>00020 <span class="comment"></span>
|
|
<a name="l00021"></a>00021 <span class="comment"> A special exception to the GPL can be applied should you wish to distribute</span>
|
|
<a name="l00022"></a>00022 <span class="comment"> a combined work that includes ChibiOS/RT, without being obliged to provide</span>
|
|
<a name="l00023"></a>00023 <span class="comment"> the source code for any proprietary components. See the file exception.txt</span>
|
|
<a name="l00024"></a>00024 <span class="comment"> for full details of how and when the exception can be applied.</span>
|
|
<a name="l00025"></a>00025 <span class="comment">*/</span>
|
|
<a name="l00026"></a>00026 <span class="comment">/*</span>
|
|
<a name="l00027"></a>00027 <span class="comment"> Concepts and parts of this file are contributed by and Copyright (C) 2008</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> of Leon Woestenberg.</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> */</span>
|
|
<a name="l00030"></a>00030 <span class="comment"></span>
|
|
<a name="l00031"></a>00031 <span class="comment">/**</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @file chcond.h</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> * @brief Condition Variables macros and structures.</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> *</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * @addtogroup condvars</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * @{</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> */</span>
|
|
<a name="l00038"></a>00038
|
|
<a name="l00039"></a>00039 <span class="preprocessor">#ifndef _CHCOND_H_</span>
|
|
<a name="l00040"></a>00040 <span class="preprocessor"></span><span class="preprocessor">#define _CHCOND_H_</span>
|
|
<a name="l00041"></a>00041 <span class="preprocessor"></span>
|
|
<a name="l00042"></a>00042 <span class="preprocessor">#if CH_USE_CONDVARS</span>
|
|
<a name="l00043"></a>00043 <span class="preprocessor"></span>
|
|
<a name="l00044"></a>00044 <span class="comment">/*</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> * Module dependencies check.</span>
|
|
<a name="l00046"></a>00046 <span class="comment"> */</span>
|
|
<a name="l00047"></a>00047 <span class="preprocessor">#if !CH_USE_MUTEXES</span>
|
|
<a name="l00048"></a>00048 <span class="preprocessor"></span><span class="preprocessor">#error "CH_USE_CONDVARS requires CH_USE_MUTEXES"</span>
|
|
<a name="l00049"></a>00049 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00050"></a>00050 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00051"></a>00051 <span class="comment">/**</span>
|
|
<a name="l00052"></a>00052 <span class="comment"> * @brief CondVar structure.</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> */</span>
|
|
<a name="l00054"></a><a class="code" href="struct_cond_var.html">00054</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> {
|
|
<a name="l00055"></a><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666">00055</a> <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> <a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>; <span class="comment">/**< @brief CondVar threads queue.*/</span>
|
|
<a name="l00056"></a>00056 } <a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a>;
|
|
<a name="l00057"></a>00057
|
|
<a name="l00058"></a>00058 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00059"></a>00059 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00060"></a>00060 <span class="preprocessor">#endif</span>
|
|
<a name="l00061"></a>00061 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__condvars.html#ga4c698ba6ce06089c08f989e126af9873" title="Initializes s CondVar structure.">chCondInit</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="group__condvars.html#gadddadb68e2a2ce061c7df0d647da9996" title="Signals one thread that is waiting on the condition variable.">chCondSignal</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00063"></a>00063 <span class="keywordtype">void</span> <a class="code" href="group__condvars.html#ga7b9d882c348124fed46a1afc3db6c02c" title="Signals one thread that is waiting on the condition variable.">chCondSignalI</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="group__condvars.html#ga60c24a8060a884313efe82b8404e77f6" title="Signals all threads that are waiting on the condition variable.">chCondBroadcast</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00065"></a>00065 <span class="keywordtype">void</span> <a class="code" href="group__condvars.html#ga5cf1f4697985d81ee089b042391df6fc" title="Signals all threads that are waiting on the condition variable.">chCondBroadcastI</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00066"></a>00066 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__condvars.html#ga466f912bc9b09b133fae862993004ffe" title="Waits on the condition variable releasing the mutex lock.">chCondWait</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00067"></a>00067 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__condvars.html#gab6357d80b01ed8d225ef1e30a66248f9" title="Waits on the condition variable releasing the mutex lock.">chCondWaitS</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp);
|
|
<a name="l00068"></a>00068 <span class="preprocessor">#if CH_USE_CONDVARS_TIMEOUT</span>
|
|
<a name="l00069"></a>00069 <span class="preprocessor"></span> <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__condvars.html#ga07a0c55ac1002a64e8c7f9b7e3ca1caf" title="Waits on the condition variable releasing the mutex lock.">chCondWaitTimeout</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time);
|
|
<a name="l00070"></a>00070 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__condvars.html#ga9cf6ebe4c9f28cb206fab14984a18d29" title="Waits on the condition variable releasing the mutex lock.">chCondWaitTimeoutS</a>(<a class="code" href="struct_cond_var.html" title="CondVar structure.">CondVar</a> *cp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> time);
|
|
<a name="l00071"></a>00071 <span class="preprocessor">#endif</span>
|
|
<a name="l00072"></a>00072 <span class="preprocessor"></span><span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00073"></a>00073 <span class="preprocessor"></span>}
|
|
<a name="l00074"></a>00074 <span class="preprocessor">#endif</span>
|
|
<a name="l00075"></a>00075 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00076"></a>00076 <span class="comment">/**</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> * @brief Data part of a static condition variable initializer.</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * @details This macro should be used when statically initializing a condition</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> * variable that is part of a bigger structure.</span>
|
|
<a name="l00080"></a>00080 <span class="comment"> *</span>
|
|
<a name="l00081"></a>00081 <span class="comment"> * @param[in] name the name of the condition variable</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> */</span>
|
|
<a name="l00083"></a><a class="code" href="group__condvars.html#ga5d435ff663d0d9f3d54427cba4faf00f">00083</a> <span class="preprocessor">#define _CONDVAR_DATA(name) {_THREADSQUEUE_DATA(name.c_queue)}</span>
|
|
<a name="l00084"></a>00084 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00085"></a>00085 <span class="comment">/**</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> * @brief Static condition variable initializer.</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @details Statically initialized condition variables require no explicit</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * initialization using @p chCondInit().</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> *</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> * @param[in] name the name of the condition variable</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> */</span>
|
|
<a name="l00092"></a><a class="code" href="group__condvars.html#ga3ea56c50eb9ddff1cf665e8fb60ba6ac">00092</a> <span class="preprocessor">#define CONDVAR_DECL(name) CondVar name = _CONDVAR_DATA(name)</span>
|
|
<a name="l00093"></a>00093 <span class="preprocessor"></span>
|
|
<a name="l00094"></a>00094 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_CONDVARS */</span>
|
|
<a name="l00095"></a>00095
|
|
<a name="l00096"></a>00096 <span class="preprocessor">#endif </span><span class="comment">/* _CHCOND_H_ */</span>
|
|
<a name="l00097"></a>00097 <span class="comment"></span>
|
|
<a name="l00098"></a>00098 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Jul 11 13:13:00 2010 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.6.3</small></address>
|
|
</body>
|
|
</html>
|