mirror of
https://salsa.debian.org/gnuk-team/gnuk/gnuk.git
synced 2024-09-21 19:30:08 +00:00
195 lines
21 KiB
HTML
195 lines
21 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: chmboxes.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>chmboxes.h</h1> </div>
|
|
</div>
|
|
<div class="contents">
|
|
<a href="chmboxes_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 chmboxes.h</span>
|
|
<a name="l00029"></a>00029 <span class="comment"> * @brief Mailboxes macros and structures.</span>
|
|
<a name="l00030"></a>00030 <span class="comment"> *</span>
|
|
<a name="l00031"></a>00031 <span class="comment"> * @addtogroup mailboxes</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 _CHMBOXES_H_</span>
|
|
<a name="l00036"></a>00036 <span class="preprocessor"></span><span class="preprocessor">#define _CHMBOXES_H_</span>
|
|
<a name="l00037"></a>00037 <span class="preprocessor"></span>
|
|
<a name="l00038"></a>00038 <span class="preprocessor">#if CH_USE_MAILBOXES</span>
|
|
<a name="l00039"></a>00039 <span class="preprocessor"></span>
|
|
<a name="l00040"></a>00040 <span class="comment">/*</span>
|
|
<a name="l00041"></a>00041 <span class="comment"> * Module dependencies check.</span>
|
|
<a name="l00042"></a>00042 <span class="comment"> */</span>
|
|
<a name="l00043"></a>00043 <span class="preprocessor">#if !CH_USE_SEMAPHORES</span>
|
|
<a name="l00044"></a>00044 <span class="preprocessor"></span><span class="preprocessor">#error "CH_USE_MAILBOXES requires CH_USE_SEMAPHORES"</span>
|
|
<a name="l00045"></a>00045 <span class="preprocessor"></span><span class="preprocessor">#endif</span>
|
|
<a name="l00046"></a>00046 <span class="preprocessor"></span>
|
|
<a name="l00047"></a>00047 <span class="keyword">typedef</span> <span class="keyword">struct </span>{
|
|
<a name="l00048"></a>00048 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *mb_buffer; <span class="comment">/**< @brief Pointer to the mailbox</span>
|
|
<a name="l00049"></a>00049 <span class="comment"> buffer. */</span>
|
|
<a name="l00050"></a>00050 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *mb_top; <span class="comment">/**< @brief Pointer to the location</span>
|
|
<a name="l00051"></a>00051 <span class="comment"> after the buffer. */</span>
|
|
<a name="l00052"></a>00052 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *mb_wrptr; <span class="comment">/**< @brief Write pointer. */</span>
|
|
<a name="l00053"></a>00053 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *mb_rdptr; <span class="comment">/**< @brief Read pointer. */</span>
|
|
<a name="l00054"></a>00054 <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> mb_fullsem; <span class="comment">/**< @brief Full counter</span>
|
|
<a name="l00055"></a>00055 <span class="comment"> @p Semaphore. */</span>
|
|
<a name="l00056"></a>00056 <a class="code" href="struct_semaphore.html" title="Semaphore structure.">Semaphore</a> mb_emptysem; <span class="comment">/**< @brief Empty counter</span>
|
|
<a name="l00057"></a>00057 <span class="comment"> @p Semaphore. */</span>
|
|
<a name="l00058"></a>00058 } Mailbox;
|
|
<a name="l00059"></a>00059
|
|
<a name="l00060"></a>00060 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00061"></a>00061 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
|
|
<a name="l00062"></a>00062 <span class="preprocessor">#endif</span>
|
|
<a name="l00063"></a>00063 <span class="preprocessor"></span> <span class="keywordtype">void</span> <a class="code" href="group__mailboxes.html#gaff65b97bfdbf9144e9727a100a9be93a" title="Initializes a Mailbox object.">chMBInit</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *buf, <a class="code" href="group__types.html#ga090b3bab5602157ebf706a44041dc05e" title="Counter, recommended fastest signed.">cnt_t</a> n);
|
|
<a name="l00064"></a>00064 <span class="keywordtype">void</span> <a class="code" href="group__mailboxes.html#ga4199e224456395c3dbc74dbc889dff94" title="Resets a Mailbox object.">chMBReset</a>(Mailbox *mbp);
|
|
<a name="l00065"></a>00065 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__mailboxes.html#ga9bafcc634765886f59cf68c0e35d070d" title="Posts a message into a mailbox.">chMBPost</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<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__mailboxes.html#gac6514c185ae87c2633132478ea48d689" title="Posts a message into a mailbox.">chMBPostS</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<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__mailboxes.html#ga55c5b8890b78127bc1fa5a324252d5e6" title="Posts an high priority message into a mailbox.">chMBPostAhead</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<a name="l00068"></a>00068 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__mailboxes.html#gaa9c91c0b781bec0df3540407d75b1bb3" title="Posts an high priority message into a mailbox.">chMBPostAheadS</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> msg, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<a name="l00069"></a>00069 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> <a class="code" href="group__mailboxes.html#ga61543bf11d0caa737f5818c67548c055" title="Retrieves a message from a mailbox.">chMBFetch</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *msgp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<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__mailboxes.html#gadc562242a8854497a1f9539cb9ffea09" title="Retrieves a message from a mailbox.">chMBFetchS</a>(Mailbox *mbp, <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> *msgp, <a class="code" href="group__types.html#gae3e32a98d431a02106616da3071832dd" title="System Time, recommended fastest unsigned.">systime_t</a> timeout);
|
|
<a name="l00071"></a>00071 <span class="preprocessor">#ifdef __cplusplus</span>
|
|
<a name="l00072"></a>00072 <span class="preprocessor"></span>}
|
|
<a name="l00073"></a>00073 <span class="preprocessor">#endif</span>
|
|
<a name="l00074"></a>00074 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00075"></a>00075 <span class="comment">/**</span>
|
|
<a name="l00076"></a>00076 <span class="comment"> * @brief Returns the mailbox buffer size.</span>
|
|
<a name="l00077"></a>00077 <span class="comment"> *</span>
|
|
<a name="l00078"></a>00078 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
|
|
<a name="l00079"></a>00079 <span class="comment"> */</span>
|
|
<a name="l00080"></a><a class="code" href="group__mailboxes.html#gad9707fcb206d677fe9437d1f196d135f">00080</a> <span class="preprocessor">#define chMBSize(mbp) \</span>
|
|
<a name="l00081"></a>00081 <span class="preprocessor"> ((mbp)->mb_top - (mbp)->mb_buffer)</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"> * @brief Returns the free space into the mailbox.</span>
|
|
<a name="l00085"></a>00085 <span class="comment"> * @note Can be invoked in any system state but if invoked out of a locked</span>
|
|
<a name="l00086"></a>00086 <span class="comment"> * state then the returned value may change after reading.</span>
|
|
<a name="l00087"></a>00087 <span class="comment"> * @note The returned value can be less than zero when there are waiting</span>
|
|
<a name="l00088"></a>00088 <span class="comment"> * threads on the internal semaphore.</span>
|
|
<a name="l00089"></a>00089 <span class="comment"> *</span>
|
|
<a name="l00090"></a>00090 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
|
|
<a name="l00091"></a>00091 <span class="comment"> * @return The number of empty message slots.</span>
|
|
<a name="l00092"></a>00092 <span class="comment"> */</span>
|
|
<a name="l00093"></a><a class="code" href="group__mailboxes.html#ga883666d096d855c8c372c0241fc47142">00093</a> <span class="preprocessor">#define chMBGetEmpty(mbp) chSemGetCounterI(&(mbp)->mb_emptysem)</span>
|
|
<a name="l00094"></a>00094 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00095"></a>00095 <span class="comment">/**</span>
|
|
<a name="l00096"></a>00096 <span class="comment"> * @brief Returns the number of messages into the mailbox.</span>
|
|
<a name="l00097"></a>00097 <span class="comment"> * @note Can be invoked in any system state but if invoked out of a locked</span>
|
|
<a name="l00098"></a>00098 <span class="comment"> * state then the returned value may change after reading.</span>
|
|
<a name="l00099"></a>00099 <span class="comment"> * @note The returned value can be less than zero when there are waiting</span>
|
|
<a name="l00100"></a>00100 <span class="comment"> * threads on the internal semaphore.</span>
|
|
<a name="l00101"></a>00101 <span class="comment"> *</span>
|
|
<a name="l00102"></a>00102 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
|
|
<a name="l00103"></a>00103 <span class="comment"> * @return The number of queued messages.</span>
|
|
<a name="l00104"></a>00104 <span class="comment"> */</span>
|
|
<a name="l00105"></a><a class="code" href="group__mailboxes.html#gad41c9e058c4a35cceeecbf21038f4c03">00105</a> <span class="preprocessor">#define chMBGetFull(mbp) chSemGetCounterI(&(mbp)->mb_fullsem)</span>
|
|
<a name="l00106"></a>00106 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00107"></a>00107 <span class="comment">/**</span>
|
|
<a name="l00108"></a>00108 <span class="comment"> * @brief Returns the next message in the queue without removing it.</span>
|
|
<a name="l00109"></a>00109 <span class="comment"> * @note A message must be waiting in the queue for this function to work or</span>
|
|
<a name="l00110"></a>00110 <span class="comment"> * it would return garbage. The correct way to use this macro is to</span>
|
|
<a name="l00111"></a>00111 <span class="comment"> * use @p chMBGetFull() and then use this macro, all within a lock</span>
|
|
<a name="l00112"></a>00112 <span class="comment"> * state.</span>
|
|
<a name="l00113"></a>00113 <span class="comment"> */</span>
|
|
<a name="l00114"></a><a class="code" href="group__mailboxes.html#ga620fdbcfe9e4f631f6ea87bed82aa581">00114</a> <span class="preprocessor">#define chMBPeek(mbp) (*(mbp)->mb_rdptr)</span>
|
|
<a name="l00115"></a>00115 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00116"></a>00116 <span class="comment">/**</span>
|
|
<a name="l00117"></a>00117 <span class="comment"> * @brief Data part of a static mailbox initializer.</span>
|
|
<a name="l00118"></a>00118 <span class="comment"> * @details This macro should be used when statically initializing a</span>
|
|
<a name="l00119"></a>00119 <span class="comment"> * mailbox that is part of a bigger structure.</span>
|
|
<a name="l00120"></a>00120 <span class="comment"> *</span>
|
|
<a name="l00121"></a>00121 <span class="comment"> * @param[in] name the name of the mailbox variable</span>
|
|
<a name="l00122"></a>00122 <span class="comment"> * @param[in] buffer pointer to the mailbox buffer area</span>
|
|
<a name="l00123"></a>00123 <span class="comment"> * @param[in] size size of the mailbox buffer area</span>
|
|
<a name="l00124"></a>00124 <span class="comment"> */</span>
|
|
<a name="l00125"></a><a class="code" href="group__mailboxes.html#ga258b7bab4fa19d63854e7f7f2e3641e6">00125</a> <span class="preprocessor">#define _MAILBOX_DATA(name, buffer, size) { \</span>
|
|
<a name="l00126"></a>00126 <span class="preprocessor"> (msg_t *)(buffer), \</span>
|
|
<a name="l00127"></a>00127 <span class="preprocessor"> (msg_t *)(buffer) + size, \</span>
|
|
<a name="l00128"></a>00128 <span class="preprocessor"> (msg_t *)(buffer), \</span>
|
|
<a name="l00129"></a>00129 <span class="preprocessor"> (msg_t *)(buffer), \</span>
|
|
<a name="l00130"></a>00130 <span class="preprocessor"> _SEMAPHORE_DATA(name.mb_fullsem, 0), \</span>
|
|
<a name="l00131"></a>00131 <span class="preprocessor"> _SEMAPHORE_DATA(name.mb_emptysem, size), \</span>
|
|
<a name="l00132"></a>00132 <span class="preprocessor">}</span>
|
|
<a name="l00133"></a>00133 <span class="preprocessor"></span><span class="comment"></span>
|
|
<a name="l00134"></a>00134 <span class="comment">/**</span>
|
|
<a name="l00135"></a>00135 <span class="comment"> * @brief Static mailbox initializer.</span>
|
|
<a name="l00136"></a>00136 <span class="comment"> * @details Statically initialized mailboxes require no explicit</span>
|
|
<a name="l00137"></a>00137 <span class="comment"> * initialization using @p chMBInit().</span>
|
|
<a name="l00138"></a>00138 <span class="comment"> *</span>
|
|
<a name="l00139"></a>00139 <span class="comment"> * @param[in] name the name of the mailbox variable</span>
|
|
<a name="l00140"></a>00140 <span class="comment"> * @param[in] buffer pointer to the mailbox buffer area</span>
|
|
<a name="l00141"></a>00141 <span class="comment"> * @param[in] size size of the mailbox buffer area</span>
|
|
<a name="l00142"></a>00142 <span class="comment"> */</span>
|
|
<a name="l00143"></a><a class="code" href="group__mailboxes.html#gafb06e097629b88a09b1f29146a86bf20">00143</a> <span class="preprocessor">#define MAILBOX_DECL(name, buffer, size) \</span>
|
|
<a name="l00144"></a>00144 <span class="preprocessor"> Mailbox name = _MAILBOX_DATA(name, buffer, size)</span>
|
|
<a name="l00145"></a>00145 <span class="preprocessor"></span>
|
|
<a name="l00146"></a>00146 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_MAILBOXES */</span>
|
|
<a name="l00147"></a>00147
|
|
<a name="l00148"></a>00148 <span class="preprocessor">#endif </span><span class="comment">/* _CHMBOXES_H_ */</span>
|
|
<a name="l00149"></a>00149 <span class="comment"></span>
|
|
<a name="l00150"></a>00150 <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 <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>
|