mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 11:20:08 +00:00
140 lines
13 KiB
HTML
140 lines
13 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: chmtx.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.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>chmtx.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chmtx_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">/**</span>
|
|
<a name="l00028"></a>00028 <span class="comment"> * @file chmtx.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Mutexes macros and structures.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup mutexes</span>
|
|
<a name="l00032"></a>00032 <span class="comment"> * @{</span>
|
|
<a name="l00033"></a>00033 <span class="comment"> */</span>
|
|
<a name="l00034"></a>00034
|
|
<a name="l00035"></a>00035 <span class="preprocessor">#ifndef _CHMTX_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHMTX_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_USE_MUTEXES</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00040"></a>00040 <span class="comment">/**</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * @brief Mutex structure.</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> */</span>
|
|
<a name="l00043"></a><a class="code" href="struct_mutex.html">00043</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> {
|
|
<a name="l00044"></a><a class="code" href="struct_mutex.html#ad3efd6941b40b1415b5fe40e804d4b6f">00044</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_mutex.html#ad3efd6941b40b1415b5fe40e804d4b6f" title="Queue of the threads sleeping on this Mutex.">m_queue</a>; <span class="comment">/**< @brief Queue of the threads sleeping</span>
|
|
<a name="l00045"></a>00045 <span class="comment"> on this Mutex. */</span>
|
|
<a name="l00046"></a><a class="code" href="struct_mutex.html#ad83ff6b7d8b483f91a080ae8c53a4941">00046</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="struct_mutex.html#ad83ff6b7d8b483f91a080ae8c53a4941" title="Owner Thread pointer or NULL.">m_owner</a>; <span class="comment">/**< @brief Owner @p Thread pointer or</span>
|
|
<a name="l00047"></a>00047 <span class="comment"> @p NULL. */</span>
|
|
<a name="l00048"></a><a class="code" href="struct_mutex.html#aa2113b554e5f0deefbc20dbadfd3d1dd">00048</a> <span class="keyword">struct </span><a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *<a class="code" href="struct_mutex.html#aa2113b554e5f0deefbc20dbadfd3d1dd" title="Next Mutex into an owner-list or NULL.">m_next</a>; <span class="comment">/**< @brief Next @p Mutex into an</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> owner-list or @p NULL. */</span>
|
|
<a name="l00050"></a>00050 } <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a>;
|
|
<a name="l00051"></a>00051
|
|
<a name="l00052"></a>00052 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00053"></a>00053 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00054"></a>00054 <span class="preprocessor">#endif</span>
|
|
<a name="l00055"></a>00055 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__mutexes.html#gac55fe4d05aa6bbeb31594193d2e4d2b6" title="Initializes s Mutex structure.">chMtxInit</a>(<a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp);
|
|
<a name="l00056"></a>00056 <span class="keywordtype">void</span> <a class="code" href="group__mutexes.html#gafa06b82e3496c44eb7bf31d9f1b655ba" title="Locks the specified mutex.">chMtxLock</a>(<a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp);
|
|
<a name="l00057"></a>00057 <span class="keywordtype">void</span> <a class="code" href="group__mutexes.html#ga2d6350c2d147d1165c359f30798205f5" title="Locks the specified mutex.">chMtxLockS</a>(<a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp);
|
|
<a name="l00058"></a>00058 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> <a class="code" href="group__mutexes.html#gaada14e216460dc55e1816234168cf95c" title="Tries to lock a mutex.">chMtxTryLock</a>(<a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp);
|
|
<a name="l00059"></a>00059 <a class="code" href="group__types.html#ga7556af1cb61728b53228fa3af1c851de" title="Boolean, recommended the fastest signed.">bool_t</a> <a class="code" href="group__mutexes.html#gadbf0bd4a36b1f7e33ee41939df32ab78" title="Tries to lock a mutex.">chMtxTryLockS</a>(<a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *mp);
|
|
<a name="l00060"></a>00060 <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *<a class="code" href="group__mutexes.html#gae9ae07165126c9f6c0ce0b17bdb53669" title="Unlocks the next owned mutex in reverse lock order.">chMtxUnlock</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00061"></a>00061 <a class="code" href="struct_mutex.html" title="Mutex structure.">Mutex</a> *<a class="code" href="group__mutexes.html#ga705fa60fb8aa28a6632f693e83f78c96" title="Unlocks the next owned mutex in reverse lock order.">chMtxUnlockS</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00062"></a>00062 <span class="keywordtype">void</span> <a class="code" href="group__mutexes.html#ga853b4ced43d22fb5d82678dd2f0aba75" title="Unlocks all the mutexes owned by the invoking thread.">chMtxUnlockAll</a>(<span class="keywordtype">void</span>);
|
|
<a name="l00063"></a>00063 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00064"></a>00064 <span class="preprocessor"></span>}
|
|
<a name="l00065"></a>00065 <span class="preprocessor">#endif</span>
|
|
<a name="l00066"></a>00066 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00067"></a>00067 <span class="comment">/**</span>
|
|
<a name="l00068"></a>00068 <span class="comment"> * @brief Data part of a static mutex initializer.</span>
|
|
<a name="l00069"></a>00069 <span class="comment"> * @details This macro should be used when statically initializing a mutex</span>
|
|
<a name="l00070"></a>00070 <span class="comment"> * that is part of a bigger structure.</span>
|
|
<a name="l00071"></a>00071 <span class="comment"> *</span>
|
|
<a name="l00072"></a>00072 <span class="comment"> * @param[in] name the name of the mutex variable</span>
|
|
<a name="l00073"></a>00073 <span class="comment"> */</span>
|
|
<a name="l00074"></a><a class="code" href="group__mutexes.html#ga01a9ed719f222e64589413d6eda7396e">00074</a> <span class="preprocessor">#define _MUTEX_DATA(name) {_THREADSQUEUE_DATA(name.m_queue), NULL, NULL}</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 Static mutex initializer.</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * @details Statically initialized mutexes require no explicit initialization</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> * using @p chMtxInit().</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 mutex variable</span>
|
|
<a name="l00082"></a>00082 <span class="comment"> */</span>
|
|
<a name="l00083"></a><a class="code" href="group__mutexes.html#ga0461d963db5d730f1829eb783f6fdf94">00083</a> <span class="preprocessor">#define MUTEX_DECL(name) Mutex name = _MUTEX_DATA(name)</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 Returns @p TRUE if the mutex queue contains at least a waiting</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * thread.</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> */</span>
|
|
<a name="l00089"></a><a class="code" href="group__mutexes.html#ga322ebcfba68cf5b66b9c315638e3ae63">00089</a> <span class="preprocessor">#define chMtxQueueNotEmptyS(mp) notempty(&(mp)->m_queue)</span>
|
|
<a name="l00090"></a>00090 <span class="preprocessor"></span>
|
|
<a name="l00091"></a>00091 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_MUTEXES */</span>
|
|
<a name="l00092"></a>00092
|
|
<a name="l00093"></a>00093 <span class="preprocessor">#endif </span><span class="comment">/* _CHMTX_H_ */</span>
|
|
<a name="l00094"></a>00094 <span class="comment"></span>
|
|
<a name="l00095"></a>00095 <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>
|