mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
297 lines
35 KiB
HTML
297 lines
35 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.c 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.7.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul class="tablist">
|
|
<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="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
<li><a href="globals.html"><span>Globals</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<h1>chcond.c</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chcond_8c.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 have been contributed by Leon Woestenberg.</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> */</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"> * @file chcond.c</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @brief Condition Variables code.</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> *</span>
|
|
<a name="l00034"></a>00034 <span class="comment"> * @addtogroup condvars Condition Variables</span>
|
|
<a name="l00035"></a>00035 <span class="comment"> * @details This module implements the Condition Variables mechanism. Condition</span>
|
|
<a name="l00036"></a>00036 <span class="comment"> * variables are an extensions to the Mutex subsystem and cannot</span>
|
|
<a name="l00037"></a>00037 <span class="comment"> * work alone.</span>
|
|
<a name="l00038"></a>00038 <span class="comment"> * <h2>Operation mode</h2></span>
|
|
<a name="l00039"></a>00039 <span class="comment"> * The condition variable is a synchronization object meant to be</span>
|
|
<a name="l00040"></a>00040 <span class="comment"> * used inside a zone protected by a @p Mutex. Mutexes and CondVars</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * together can implement a Monitor construct.<br></span>
|
|
<a name="l00042"></a>00042 <span class="comment"> * In order to use the Condition Variables APIs the @p CH_USE_CONDVARS</span>
|
|
<a name="l00043"></a>00043 <span class="comment"> * option must be enabled in @p chconf.h.</span>
|
|
<a name="l00044"></a>00044 <span class="comment"> * @{</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> */</span>
|
|
<a name="l00046"></a>00046
|
|
<a name="l00047"></a>00047 <span class="preprocessor">#include "<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>"</span>
|
|
<a name="l00048"></a>00048
|
|
<a name="l00049"></a>00049 <span class="preprocessor">#if CH_USE_CONDVARS && CH_USE_MUTEXES</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 Initializes s @p CondVar structure.</span>
|
|
<a name="l00053"></a>00053 <span class="comment"> * @note This function can be invoked from within an interrupt handler even</span>
|
|
<a name="l00054"></a>00054 <span class="comment"> * if it is not an I-Class API because it does not touch any critical</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> * kernel data structure.</span>
|
|
<a name="l00056"></a>00056 <span class="comment"> *</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> * @param[out] cp pointer to a @p CondVar structure</span>
|
|
<a name="l00058"></a>00058 <span class="comment"> */</span>
|
|
<a name="l00059"></a><a class="code" href="group__condvars.html#ga4c698ba6ce06089c08f989e126af9873">00059</a> <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="l00060"></a>00060
|
|
<a name="l00061"></a>00061 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondInit"</span>);
|
|
<a name="l00062"></a>00062
|
|
<a name="l00063"></a>00063 <a class="code" href="group__internals.html#ga6d19d0f3ff1fa599b6d9783dec180451" title="Threads queue initialization.">queue_init</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>);
|
|
<a name="l00064"></a>00064 }
|
|
<a name="l00065"></a>00065 <span class="comment"></span>
|
|
<a name="l00066"></a>00066 <span class="comment">/**</span>
|
|
<a name="l00067"></a>00067 <span class="comment"> * @brief Signals one thread that is waiting on the condition variable.</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> *</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> */</span>
|
|
<a name="l00071"></a><a class="code" href="group__condvars.html#gadddadb68e2a2ce061c7df0d647da9996">00071</a> <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="l00072"></a>00072
|
|
<a name="l00073"></a>00073 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondSignal"</span>);
|
|
<a name="l00074"></a>00074
|
|
<a name="l00075"></a>00075 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00076"></a>00076 <span class="keywordflow">if</span> (<a class="code" href="group__internals.html#ga8f6bea56a53acc44758fe61c98d68a4e" title="Evaluates to TRUE if the specified threads queue or list is not empty.">notempty</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>))
|
|
<a name="l00077"></a>00077 <a class="code" href="group__scheduler.html#gae47a8819a21ef2d521124e76bfb37c95" title="Wakes up a thread.">chSchWakeupS</a>(<a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a" title="Removes the first-out Thread from a queue and returns it.">fifo_remove</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>), <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>);
|
|
<a name="l00078"></a>00078 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00079"></a>00079 }
|
|
<a name="l00080"></a>00080 <span class="comment"></span>
|
|
<a name="l00081"></a>00081 <span class="comment">/**</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> * @brief Signals one thread that is waiting on the condition variable.</span>
|
|
<a name="l00083"></a>00083 <span class="comment"> *</span>
|
|
<a name="l00084"></a>00084 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> */</span>
|
|
<a name="l00086"></a><a class="code" href="group__condvars.html#ga7b9d882c348124fed46a1afc3db6c02c">00086</a> <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="l00087"></a>00087
|
|
<a name="l00088"></a>00088 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondSignalI"</span>);
|
|
<a name="l00089"></a>00089
|
|
<a name="l00090"></a>00090 <span class="keywordflow">if</span> (<a class="code" href="group__internals.html#ga8f6bea56a53acc44758fe61c98d68a4e" title="Evaluates to TRUE if the specified threads queue or list is not empty.">notempty</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>))
|
|
<a name="l00091"></a>00091 <a class="code" href="group__scheduler.html#ga535d58cfb3436c8d4e4586c31c062298" title="Inserts a thread in the Ready List.">chSchReadyI</a>(<a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a" title="Removes the first-out Thread from a queue and returns it.">fifo_remove</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>))-><a class="code" href="struct_thread.html#a72cd0424b6098ca241fac1f74d21b56a" title="State-specific fields.">p_u</a>.<a class="code" href="struct_thread.html#ad5792c30fbd60df0de223b0f398fc6d7" title="Thread wakeup code.">rdymsg</a> = RDY_OK;
|
|
<a name="l00092"></a>00092 }
|
|
<a name="l00093"></a>00093 <span class="comment"></span>
|
|
<a name="l00094"></a>00094 <span class="comment">/**</span>
|
|
<a name="l00095"></a>00095 <span class="comment"> * @brief Signals all threads that are waiting on the condition variable.</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> *</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> */</span>
|
|
<a name="l00099"></a><a class="code" href="group__condvars.html#ga60c24a8060a884313efe82b8404e77f6">00099</a> <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="l00100"></a>00100
|
|
<a name="l00101"></a>00101 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00102"></a>00102 <a class="code" href="group__condvars.html#ga5cf1f4697985d81ee089b042391df6fc" title="Signals all threads that are waiting on the condition variable.">chCondBroadcastI</a>(cp);
|
|
<a name="l00103"></a>00103 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
|
|
<a name="l00104"></a>00104 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00105"></a>00105 }
|
|
<a name="l00106"></a>00106 <span class="comment"></span>
|
|
<a name="l00107"></a>00107 <span class="comment">/**</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> * @brief Signals all threads that are waiting on the condition variable.</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> *</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> */</span>
|
|
<a name="l00112"></a><a class="code" href="group__condvars.html#ga5cf1f4697985d81ee089b042391df6fc">00112</a> <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="l00113"></a>00113
|
|
<a name="l00114"></a>00114 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondBroadcastI"</span>);
|
|
<a name="l00115"></a>00115
|
|
<a name="l00116"></a>00116 <span class="comment">/* Empties the condition variable queue and inserts all the Threads into the</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> ready list in FIFO order. The wakeup message is set to @p RDY_RESET in</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> order to make a chCondBroadcast() detectable from a chCondSignal().*/</span>
|
|
<a name="l00119"></a>00119 <span class="keywordflow">while</span> (cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>.<a class="code" href="struct_threads_queue.html#af4a099c245d7ceecdf2f9755d05d0ed0">p_next</a> != (<span class="keywordtype">void</span> *)&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>)
|
|
<a name="l00120"></a>00120 <a class="code" href="group__scheduler.html#ga535d58cfb3436c8d4e4586c31c062298" title="Inserts a thread in the Ready List.">chSchReadyI</a>(<a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a" title="Removes the first-out Thread from a queue and returns it.">fifo_remove</a>(&cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>))-><a class="code" href="struct_thread.html#a72cd0424b6098ca241fac1f74d21b56a" title="State-specific fields.">p_u</a>.<a class="code" href="struct_thread.html#ad5792c30fbd60df0de223b0f398fc6d7" title="Thread wakeup code.">rdymsg</a> = RDY_RESET;
|
|
<a name="l00121"></a>00121 }
|
|
<a name="l00122"></a>00122 <span class="comment"></span>
|
|
<a name="l00123"></a>00123 <span class="comment">/**</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> * @brief Waits on the condition variable releasing the mutex lock.</span>
|
|
<a name="l00125"></a>00125 <span class="comment"> * @details Releases the currently owned mutex, waits on the condition</span>
|
|
<a name="l00126"></a>00126 <span class="comment"> * variable, and finally acquires the mutex again. All the sequence</span>
|
|
<a name="l00127"></a>00127 <span class="comment"> * is performed atomically.</span>
|
|
<a name="l00128"></a>00128 <span class="comment"> * @note The invoking thread <b>must</b> have at least one owned mutex on</span>
|
|
<a name="l00129"></a>00129 <span class="comment"> * entry.</span>
|
|
<a name="l00130"></a>00130 <span class="comment"> *</span>
|
|
<a name="l00131"></a>00131 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00132"></a>00132 <span class="comment"> * @return The wakep mode.</span>
|
|
<a name="l00133"></a>00133 <span class="comment"> * @retval RDY_OK if the condvar was signaled using @p chCondSignal().</span>
|
|
<a name="l00134"></a>00134 <span class="comment"> * @retval RDY_RESET if the condvar was signaled using @p chCondBroadcast().</span>
|
|
<a name="l00135"></a>00135 <span class="comment"> */</span>
|
|
<a name="l00136"></a><a class="code" href="group__condvars.html#ga466f912bc9b09b133fae862993004ffe">00136</a> <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="l00137"></a>00137 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
|
<a name="l00138"></a>00138
|
|
<a name="l00139"></a>00139 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00140"></a>00140 msg = <a class="code" href="group__condvars.html#gab6357d80b01ed8d225ef1e30a66248f9" title="Waits on the condition variable releasing the mutex lock.">chCondWaitS</a>(cp);
|
|
<a name="l00141"></a>00141 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00142"></a>00142 <span class="keywordflow">return</span> msg;
|
|
<a name="l00143"></a>00143 }
|
|
<a name="l00144"></a>00144 <span class="comment"></span>
|
|
<a name="l00145"></a>00145 <span class="comment">/**</span>
|
|
<a name="l00146"></a>00146 <span class="comment"> * @brief Waits on the condition variable releasing the mutex lock.</span>
|
|
<a name="l00147"></a>00147 <span class="comment"> * @details Releases the currently owned mutex, waits on the condition</span>
|
|
<a name="l00148"></a>00148 <span class="comment"> * variable, and finally acquires the mutex again. All the sequence</span>
|
|
<a name="l00149"></a>00149 <span class="comment"> * is performed atomically.</span>
|
|
<a name="l00150"></a>00150 <span class="comment"> * @note The invoking thread <b>must</b> have at least one owned mutex on</span>
|
|
<a name="l00151"></a>00151 <span class="comment"> * entry.</span>
|
|
<a name="l00152"></a>00152 <span class="comment"> *</span>
|
|
<a name="l00153"></a>00153 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00154"></a>00154 <span class="comment"> * @return The wakep mode.</span>
|
|
<a name="l00155"></a>00155 <span class="comment"> * @retval RDY_OK if the condvar was signaled using @p chCondSignal().</span>
|
|
<a name="l00156"></a>00156 <span class="comment"> * @retval RDY_RESET if the condvar was signaled using @p chCondBroadcast().</span>
|
|
<a name="l00157"></a>00157 <span class="comment"> */</span>
|
|
<a name="l00158"></a><a class="code" href="group__condvars.html#gab6357d80b01ed8d225ef1e30a66248f9">00158</a> <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="l00159"></a>00159 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *ctp = currp;
|
|
<a name="l00160"></a>00160 <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp;
|
|
<a name="l00161"></a>00161 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
|
<a name="l00162"></a>00162
|
|
<a name="l00163"></a>00163 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondWaitS"</span>);
|
|
<a name="l00164"></a>00164 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>(ctp-><a class="code" href="struct_thread.html#a3ae80b4b3de4c7a23c542ca251e1f017" title="List of the mutexes owned by this thread.">p_mtxlist</a> != NULL,
|
|
<a name="l00165"></a>00165 <span class="stringliteral">"chCondWaitS(), #1"</span>,
|
|
<a name="l00166"></a>00166 <span class="stringliteral">"not owning a mutex"</span>);
|
|
<a name="l00167"></a>00167
|
|
<a name="l00168"></a>00168 mp = <a class="code" href="group__mutexes.html#ga705fa60fb8aa28a6632f693e83f78c96" title="Unlocks the next owned mutex in reverse lock order.">chMtxUnlockS</a>();
|
|
<a name="l00169"></a>00169 ctp-><a class="code" href="struct_thread.html#a72cd0424b6098ca241fac1f74d21b56a" title="State-specific fields.">p_u</a>.<a class="code" href="struct_thread.html#a4f016b01444741e6f9b420436b748862" title="Pointer to a generic &quot;wait&quot; object.">wtobjp</a> = cp;
|
|
<a name="l00170"></a>00170 <a class="code" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2" title="Inserts a thread into a priority ordered queue.">prio_insert</a>(ctp, &cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>);
|
|
<a name="l00171"></a>00171 <a class="code" href="group__scheduler.html#ga97c1c514b755a1e71caf2f19c1ccf986" title="Puts the current thread to sleep into the specified state.">chSchGoSleepS</a>(<a class="code" href="group__threads.html#ga286c5b1a6459d654d5794fc17e93c939" title="Thread state: Waiting in chCondWait().">THD_STATE_WTCOND</a>);
|
|
<a name="l00172"></a>00172 msg = ctp-><a class="code" href="struct_thread.html#a72cd0424b6098ca241fac1f74d21b56a" title="State-specific fields.">p_u</a>.<a class="code" href="struct_thread.html#ad5792c30fbd60df0de223b0f398fc6d7" title="Thread wakeup code.">rdymsg</a>;
|
|
<a name="l00173"></a>00173 <a class="code" href="group__mutexes.html#ga2d6350c2d147d1165c359f30798205f5" title="Locks the specified mutex.">chMtxLockS</a>(mp);
|
|
<a name="l00174"></a>00174 <span class="keywordflow">return</span> msg;
|
|
<a name="l00175"></a>00175 }
|
|
<a name="l00176"></a>00176
|
|
<a name="l00177"></a>00177 <span class="preprocessor">#if CH_USE_CONDVARS_TIMEOUT</span>
|
|
<a name="l00178"></a>00178 <span class="preprocessor"></span><span class="comment">/**</span>
|
|
<a name="l00179"></a>00179 <span class="comment"> * @brief Waits on the condition variable releasing the mutex lock.</span>
|
|
<a name="l00180"></a>00180 <span class="comment"> * @details Releases the currently owned mutex, waits on the condition</span>
|
|
<a name="l00181"></a>00181 <span class="comment"> * variable, and finally acquires the mutex again. All the sequence</span>
|
|
<a name="l00182"></a>00182 <span class="comment"> * is performed atomically.</span>
|
|
<a name="l00183"></a>00183 <span class="comment"> * @note The invoking thread <b>must</b> have at least one owned mutex on</span>
|
|
<a name="l00184"></a>00184 <span class="comment"> * entry.</span>
|
|
<a name="l00185"></a>00185 <span class="comment"> * @note Exiting the function because a timeout does not re-acquire the</span>
|
|
<a name="l00186"></a>00186 <span class="comment"> * mutex, the mutex ownership is lost.</span>
|
|
<a name="l00187"></a>00187 <span class="comment"> *</span>
|
|
<a name="l00188"></a>00188 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00189"></a>00189 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00190"></a>00190 <span class="comment"> * the special value @p TIME_INFINITE is allowed.</span>
|
|
<a name="l00191"></a>00191 <span class="comment"> * It is not possible to specify zero @p TIME_IMMEDIATE</span>
|
|
<a name="l00192"></a>00192 <span class="comment"> * as timeout specification because it would make no sense</span>
|
|
<a name="l00193"></a>00193 <span class="comment"> * in this function.</span>
|
|
<a name="l00194"></a>00194 <span class="comment"> * @return The wakep mode.</span>
|
|
<a name="l00195"></a>00195 <span class="comment"> * @retval RDY_OK if the condvar was signaled using @p chCondSignal().</span>
|
|
<a name="l00196"></a>00196 <span class="comment"> * @retval RDY_RESET if the condvar was signaled using @p chCondBroadcast().</span>
|
|
<a name="l00197"></a>00197 <span class="comment"> * @retval RDY_TIMEOUT if the condvar was not signaled @p within the specified</span>
|
|
<a name="l00198"></a>00198 <span class="comment"> * timeout.</span>
|
|
<a name="l00199"></a>00199 <span class="comment"> */</span>
|
|
<a name="l00200"></a><a class="code" href="group__condvars.html#ga07a0c55ac1002a64e8c7f9b7e3ca1caf">00200</a> <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="l00201"></a>00201 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
|
<a name="l00202"></a>00202
|
|
<a name="l00203"></a>00203 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
|
|
<a name="l00204"></a>00204 msg = <a class="code" href="group__condvars.html#ga9cf6ebe4c9f28cb206fab14984a18d29" title="Waits on the condition variable releasing the mutex lock.">chCondWaitTimeoutS</a>(cp, time);
|
|
<a name="l00205"></a>00205 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
|
|
<a name="l00206"></a>00206 <span class="keywordflow">return</span> msg;
|
|
<a name="l00207"></a>00207 }
|
|
<a name="l00208"></a>00208 <span class="comment"></span>
|
|
<a name="l00209"></a>00209 <span class="comment">/**</span>
|
|
<a name="l00210"></a>00210 <span class="comment"> * @brief Waits on the condition variable releasing the mutex lock.</span>
|
|
<a name="l00211"></a>00211 <span class="comment"> * @details Releases the currently owned mutex, waits on the condition</span>
|
|
<a name="l00212"></a>00212 <span class="comment"> * variable, and finally acquires the mutex again. All the sequence</span>
|
|
<a name="l00213"></a>00213 <span class="comment"> * is performed atomically.</span>
|
|
<a name="l00214"></a>00214 <span class="comment"> * @note The invoking thread <b>must</b> have at least one owned mutex on</span>
|
|
<a name="l00215"></a>00215 <span class="comment"> * entry.</span>
|
|
<a name="l00216"></a>00216 <span class="comment"> * @note Exiting the function because a timeout does not re-acquire the</span>
|
|
<a name="l00217"></a>00217 <span class="comment"> * mutex, the mutex ownership is lost.</span>
|
|
<a name="l00218"></a>00218 <span class="comment"> *</span>
|
|
<a name="l00219"></a>00219 <span class="comment"> * @param[in] cp pointer to the @p CondVar structure</span>
|
|
<a name="l00220"></a>00220 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
|
|
<a name="l00221"></a>00221 <span class="comment"> * the special value @p TIME_INFINITE is allowed.</span>
|
|
<a name="l00222"></a>00222 <span class="comment"> * It is not possible to specify zero @p TIME_IMMEDIATE</span>
|
|
<a name="l00223"></a>00223 <span class="comment"> * as timeout specification because it would make no sense</span>
|
|
<a name="l00224"></a>00224 <span class="comment"> * in this function.</span>
|
|
<a name="l00225"></a>00225 <span class="comment"> * @return The wakep mode.</span>
|
|
<a name="l00226"></a>00226 <span class="comment"> * @retval RDY_OK if the condvar was signaled using @p chCondSignal().</span>
|
|
<a name="l00227"></a>00227 <span class="comment"> * @retval RDY_RESET if the condvar was signaled using @p chCondBroadcast().</span>
|
|
<a name="l00228"></a>00228 <span class="comment"> * @retval RDY_TIMEOUT if the condvar was not signaled within the specified</span>
|
|
<a name="l00229"></a>00229 <span class="comment"> * timeout.</span>
|
|
<a name="l00230"></a>00230 <span class="comment"> */</span>
|
|
<a name="l00231"></a><a class="code" href="group__condvars.html#ga9cf6ebe4c9f28cb206fab14984a18d29">00231</a> <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="l00232"></a>00232 <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp;
|
|
<a name="l00233"></a>00233 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg;
|
|
<a name="l00234"></a>00234
|
|
<a name="l00235"></a>00235 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(cp != NULL, <span class="stringliteral">"chCondWaitTimeoutS"</span>);
|
|
<a name="l00236"></a>00236 <a class="code" href="group__debug.html#ga43d50c69eb730d0f024eb832d61f30c9" title="Condition assertion.">chDbgAssert</a>(<a class="code" href="group__scheduler.html#ga1a5fddde56420e8accd0c09c1abb32a7" title="Current thread pointer access macro.">currp</a>->p_mtxlist != NULL,
|
|
<a name="l00237"></a>00237 <span class="stringliteral">"chCondWaitTimeoutS(), #1"</span>,
|
|
<a name="l00238"></a>00238 <span class="stringliteral">"not owning a mutex"</span>);
|
|
<a name="l00239"></a>00239
|
|
<a name="l00240"></a>00240 mp = <a class="code" href="group__mutexes.html#ga705fa60fb8aa28a6632f693e83f78c96" title="Unlocks the next owned mutex in reverse lock order.">chMtxUnlockS</a>();
|
|
<a name="l00241"></a>00241 <a class="code" href="group__scheduler.html#ga1a5fddde56420e8accd0c09c1abb32a7" title="Current thread pointer access macro.">currp</a>->p_u.wtobjp = cp;
|
|
<a name="l00242"></a>00242 <a class="code" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2" title="Inserts a thread into a priority ordered queue.">prio_insert</a>(<a class="code" href="group__scheduler.html#ga1a5fddde56420e8accd0c09c1abb32a7" title="Current thread pointer access macro.">currp</a>, &cp-><a class="code" href="struct_cond_var.html#a0d320ca091de542fccfebabc7716f666" title="CondVar threads queue.">c_queue</a>);
|
|
<a name="l00243"></a>00243 msg = <a class="code" href="group__scheduler.html#ga306e564f678c1a39139639490c77e78b" title="Puts the current thread to sleep into the specified state with timeout specification.">chSchGoSleepTimeoutS</a>(<a class="code" href="group__threads.html#ga286c5b1a6459d654d5794fc17e93c939" title="Thread state: Waiting in chCondWait().">THD_STATE_WTCOND</a>, time);
|
|
<a name="l00244"></a>00244 <span class="keywordflow">if</span> (msg != <a class="code" href="group__scheduler.html#gaf28d5427eeeb8f737cc7db495157780c" title="Low level message sent to a thread awakened by a timeout.">RDY_TIMEOUT</a>)
|
|
<a name="l00245"></a>00245 <a class="code" href="group__mutexes.html#ga2d6350c2d147d1165c359f30798205f5" title="Locks the specified mutex.">chMtxLockS</a>(mp);
|
|
<a name="l00246"></a>00246 <span class="keywordflow">return</span> msg;
|
|
<a name="l00247"></a>00247 }
|
|
<a name="l00248"></a>00248 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_CONDVARS_TIMEOUT */</span>
|
|
<a name="l00249"></a>00249
|
|
<a name="l00250"></a>00250 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_CONDVARS && CH_USE_MUTEXES */</span>
|
|
<a name="l00251"></a>00251 <span class="comment"></span>
|
|
<a name="l00252"></a>00252 <span class="comment">/** @} */</span>
|
|
</pre></div></div>
|
|
</div>
|
|
<hr size="1"><address style="text-align: right;"><small>
|
|
Generated on Sun Nov 28 2010 14:09:48 for ChibiOS/RT by <a href="http://www.doxygen.org/index.html"><img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.7.1</small></address>
|
|
</body>
|
|
</html>
|