gnuk/ChibiOS_2.0.6/docs/html/chlists_8h_source.html
2010-11-22 14:53:37 +09:00

170 lines
17 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: chlists.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&nbsp;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;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&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div class="header">
<div class="headertitle">
<h1>chlists.h</h1> </div>
</div>
<div class="contents">
<a href="chlists_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 &lt;http://www.gnu.org/licenses/&gt;.</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 chlists.h</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Thread queues/lists macros and structures.</span>
<a name="l00030"></a>00030 <span class="comment"> * @note All the macros present in this module, while public, are not</span>
<a name="l00031"></a>00031 <span class="comment"> * an OS API and should not be directly used in the user applications</span>
<a name="l00032"></a>00032 <span class="comment"> * code.</span>
<a name="l00033"></a>00033 <span class="comment"> *</span>
<a name="l00034"></a>00034 <span class="comment"> * @addtogroup internals</span>
<a name="l00035"></a>00035 <span class="comment"> * @{</span>
<a name="l00036"></a>00036 <span class="comment"> */</span>
<a name="l00037"></a>00037
<a name="l00038"></a>00038 <span class="preprocessor">#ifndef _CHLISTS_H_</span>
<a name="l00039"></a>00039 <span class="preprocessor"></span><span class="preprocessor">#define _CHLISTS_H_</span>
<a name="l00040"></a>00040 <span class="preprocessor"></span>
<a name="l00041"></a>00041 <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a>;
<a name="l00042"></a>00042 <span class="comment"></span>
<a name="l00043"></a>00043 <span class="comment">/**</span>
<a name="l00044"></a>00044 <span class="comment"> * @brief Threads queue initialization.</span>
<a name="l00045"></a>00045 <span class="comment"> */</span>
<a name="l00046"></a><a class="code" href="group__internals.html#ga6d19d0f3ff1fa599b6d9783dec180451">00046</a> <span class="preprocessor">#define queue_init(tqp) ((tqp)-&gt;p_next = (tqp)-&gt;p_prev = (Thread *)(tqp));</span>
<a name="l00047"></a>00047 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00048"></a>00048 <span class="comment">/**</span>
<a name="l00049"></a>00049 <span class="comment"> * @brief Threads list initialization.</span>
<a name="l00050"></a>00050 <span class="comment"> */</span>
<a name="l00051"></a><a class="code" href="group__internals.html#gaaef72a9005ecd65e7b5c22e95ad82388">00051</a> <span class="preprocessor">#define list_init(tlp) ((tlp)-&gt;p_next = (Thread *)(tlp))</span>
<a name="l00052"></a>00052 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00053"></a>00053 <span class="comment">/**</span>
<a name="l00054"></a>00054 <span class="comment"> * @brief Evaluates to @p TRUE if the specified threads queue or list is</span>
<a name="l00055"></a>00055 <span class="comment"> * empty.</span>
<a name="l00056"></a>00056 <span class="comment"> */</span>
<a name="l00057"></a><a class="code" href="group__internals.html#gadf402c10356566d82a6631c102b7f656">00057</a> <span class="preprocessor">#define isempty(p) ((p)-&gt;p_next == (Thread *)(p))</span>
<a name="l00058"></a>00058 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00059"></a>00059 <span class="comment">/**</span>
<a name="l00060"></a>00060 <span class="comment"> * @brief Evaluates to @p TRUE if the specified threads queue or list is</span>
<a name="l00061"></a>00061 <span class="comment"> * not empty.</span>
<a name="l00062"></a>00062 <span class="comment"> */</span>
<a name="l00063"></a><a class="code" href="group__internals.html#ga8f6bea56a53acc44758fe61c98d68a4e">00063</a> <span class="preprocessor">#define notempty(p) ((p)-&gt;p_next != (Thread *)(p))</span>
<a name="l00064"></a>00064 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00065"></a>00065 <span class="comment">/**</span>
<a name="l00066"></a>00066 <span class="comment"> * @brief Data part of a static threads queue initializer.</span>
<a name="l00067"></a>00067 <span class="comment"> * @details This macro should be used when statically initializing a threads</span>
<a name="l00068"></a>00068 <span class="comment"> * queue that is part of a bigger structure.</span>
<a name="l00069"></a>00069 <span class="comment"> *</span>
<a name="l00070"></a>00070 <span class="comment"> * @param[in] name the name of the threads queue variable</span>
<a name="l00071"></a>00071 <span class="comment"> */</span>
<a name="l00072"></a><a class="code" href="group__internals.html#ga9ac5ac4cb62a9baa48d2004876852112">00072</a> <span class="preprocessor">#define _THREADSQUEUE_DATA(name) {(Thread *)&amp;name, (Thread *)&amp;name}</span>
<a name="l00073"></a>00073 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00074"></a>00074 <span class="comment">/**</span>
<a name="l00075"></a>00075 <span class="comment"> * @brief Static threads queue initializer.</span>
<a name="l00076"></a>00076 <span class="comment"> * @details Statically initialized threads queues require no explicit</span>
<a name="l00077"></a>00077 <span class="comment"> * initialization using @p queue_init().</span>
<a name="l00078"></a>00078 <span class="comment"> *</span>
<a name="l00079"></a>00079 <span class="comment"> * @param[in] name the name of the threads queue variable</span>
<a name="l00080"></a>00080 <span class="comment"> */</span>
<a name="l00081"></a><a class="code" href="group__internals.html#ga08959a4e3dd5e492734970618a56078c">00081</a> <span class="preprocessor">#define THREADSQUEUE_DECL(name) ThreadsQueue name = _THREADSQUEUE_DATA(name)</span>
<a name="l00082"></a>00082 <span class="preprocessor"></span><span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">/**</span>
<a name="l00084"></a>00084 <span class="comment"> * @extends ThreadsList</span>
<a name="l00085"></a>00085 <span class="comment"> *</span>
<a name="l00086"></a>00086 <span class="comment"> * @brief Generic threads bidirectional linked list header and element.</span>
<a name="l00087"></a>00087 <span class="comment"> */</span>
<a name="l00088"></a><a class="code" href="struct_threads_queue.html">00088</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00089"></a><a class="code" href="struct_threads_queue.html#af4a099c245d7ceecdf2f9755d05d0ed0">00089</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="struct_thread.html#a49d3270919a6e423a47de20bc57beaa1" title="Next in the list/queue.">p_next</a>; <span class="comment">/**&lt; First @p Thread in the queue, or</span>
<a name="l00090"></a>00090 <span class="comment"> @p ThreadQueue when empty. */</span>
<a name="l00091"></a><a class="code" href="struct_threads_queue.html#aefc0a5e3ba3ed03da122337bc13be8fa">00091</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="struct_thread.html#a7661cf39bbb29453ce0c48a94708fb69" title="Previous in the queue.">p_prev</a>; <span class="comment">/**&lt; Last @p Thread in the queue, or</span>
<a name="l00092"></a>00092 <span class="comment"> @p ThreadQueue when empty. */</span>
<a name="l00093"></a>00093 } <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a>;
<a name="l00094"></a>00094 <span class="comment"></span>
<a name="l00095"></a>00095 <span class="comment">/**</span>
<a name="l00096"></a>00096 <span class="comment"> * @brief Generic threads single link list, it works like a stack.</span>
<a name="l00097"></a>00097 <span class="comment"> */</span>
<a name="l00098"></a><a class="code" href="struct_threads_list.html">00098</a> <span class="keyword">typedef</span> <span class="keyword">struct </span>{
<a name="l00099"></a>00099
<a name="l00100"></a><a class="code" href="struct_threads_list.html#a9076f9b8ac5d59067adc11faa8998371">00100</a> <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *p_next; <span class="comment">/**&lt; Last pushed @p Thread on the stack</span>
<a name="l00101"></a>00101 <span class="comment"> list, or pointer to itself if</span>
<a name="l00102"></a>00102 <span class="comment"> empty. */</span>
<a name="l00103"></a>00103 } <a class="code" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack.">ThreadsList</a>;
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="preprocessor">#if !CH_OPTIMIZE_SPEED</span>
<a name="l00106"></a>00106 <span class="preprocessor"></span>
<a name="l00107"></a>00107 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00108"></a>00108 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">&quot;C&quot;</span> {
<a name="l00109"></a>00109 <span class="preprocessor">#endif</span>
<a name="l00110"></a>00110 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__internals.html#ga02226b866ae704435baf2ffe259ba0b2" title="Inserts a thread into a priority ordered queue.">prio_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp);
<a name="l00111"></a>00111 <span class="keywordtype">void</span> <a class="code" href="group__internals.html#gaf7072f75fdab9dcc5f7b8dcad212965c" title="Inserts a Thread into a queue.">queue_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp);
<a name="l00112"></a>00112 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#ga042479f09357fc59befebf4dfe0e9f4a" title="Removes the first-out Thread from a queue and returns it.">fifo_remove</a>(<a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp);
<a name="l00113"></a>00113 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gacacfe77140cab62948e63d898bf4dfba" title="Removes the last-out Thread from a queue and returns it.">lifo_remove</a>(<a class="code" href="struct_threads_queue.html" title="Generic threads bidirectional linked list header and element.">ThreadsQueue</a> *tqp);
<a name="l00114"></a>00114 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gafff11bcd31d7dc3d1a0a6c66f3fc6ec9" title="Removes a Thread from a queue and returns it.">dequeue</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp);
<a name="l00115"></a>00115 <span class="keywordtype">void</span> <a class="code" href="group__internals.html#ga5818ce2d363d36402baece614b06e41b" title="Pushes a Thread on top of a stack list.">list_insert</a>(<a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *tp, <a class="code" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack.">ThreadsList</a> *tlp);
<a name="l00116"></a>00116 <a class="code" href="struct_thread.html" title="Structure representing a thread.">Thread</a> *<a class="code" href="group__internals.html#gad9aa523aebdaeefa3cc4a311bc210e8a" title="Pops a Thread from the top of a stack list and returns it.">list_remove</a>(<a class="code" href="struct_threads_list.html" title="Generic threads single link list, it works like a stack.">ThreadsList</a> *tlp);
<a name="l00117"></a>00117 <span class="preprocessor">#ifdef __cplusplus</span>
<a name="l00118"></a>00118 <span class="preprocessor"></span>}
<a name="l00119"></a>00119 <span class="preprocessor">#endif</span>
<a name="l00120"></a>00120 <span class="preprocessor"></span>
<a name="l00121"></a>00121 <span class="preprocessor">#endif </span><span class="comment">/* !CH_OPTIMIZE_SPEED */</span>
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="preprocessor">#endif </span><span class="comment">/* _CHLISTS_H_ */</span>
<a name="l00124"></a>00124 <span class="comment"></span>
<a name="l00125"></a>00125 <span class="comment">/** @} */</span>
</pre></div></div>
</div>
<hr size="1"><address style="text-align: right;"><small>
Generated on Sun Oct 24 2010 09:40:37 for ChibiOS/RT by&nbsp;<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>