coelner/gnuk
1
0
Fork 0
mirror of https://salsa.debian.org/gnuk-team/gnuk/gnuk.git synced 2024-09-21 11:20:08 +00:00
Code Issues Packages Projects Releases Wiki Activity
27543cfeca
gnuk/ChibiOS_2.0.6/docs/html/chmboxes_8c_source.html

321 lines
35 KiB
HTML
Raw Normal View History

Initial import
2010-08-10 03:11:02 +00:00
<!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.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">
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
Initial import
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
<ul class="tablist">
Initial import
2010-08-10 03:11:02 +00:00
<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>
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
Initial import
2010-08-10 03:11:02 +00:00
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="headertitle">
<h1>chmboxes.c</h1> </div>
</div>
<div class="contents">
<a href="chmboxes_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>
Initial import
2010-08-10 03:11:02 +00:00
<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 chmboxes.c</span>
<a name="l00029"></a>00029 <span class="comment"> * @brief Mailboxes code.</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"> * @details Asynchronous messages.</span>
<a name="l00033"></a>00033 <span class="comment"> * &lt;h2&gt;Operation mode&lt;/h2&gt;</span>
<a name="l00034"></a>00034 <span class="comment"> * A mailbox is an asynchronous communication mechanism.&lt;br&gt;</span>
<a name="l00035"></a>00035 <span class="comment"> * Operations defined for mailboxes:</span>
<a name="l00036"></a>00036 <span class="comment"> * - &lt;b&gt;Post&lt;/b&gt;: Posts a message on the mailbox in FIFO order.</span>
<a name="l00037"></a>00037 <span class="comment"> * - &lt;b&gt;Post Ahead&lt;/b&gt;: Posts a message on the mailbox with urgent</span>
<a name="l00038"></a>00038 <span class="comment"> * priority.</span>
<a name="l00039"></a>00039 <span class="comment"> * - &lt;b&gt;Fetch&lt;/b&gt;: A message is fetched from the mailbox and removed</span>
<a name="l00040"></a>00040 <span class="comment"> * from the queue.</span>
<a name="l00041"></a>00041 <span class="comment"> * - &lt;b&gt;Reset&lt;/b&gt;: The mailbox is emptied and all the stored messages</span>
<a name="l00042"></a>00042 <span class="comment"> * are lost.</span>
<a name="l00043"></a>00043 <span class="comment"> * .</span>
<a name="l00044"></a>00044 <span class="comment"> * A message is a variable of type msg_t that is guaranteed to have</span>
<a name="l00045"></a>00045 <span class="comment"> * the same size of and be compatible with (data) pointers (anyway an</span>
<a name="l00046"></a>00046 <span class="comment"> * explicit cast is needed).</span>
<a name="l00047"></a>00047 <span class="comment"> * If larger messages need to be exchanged then a pointer to a</span>
<a name="l00048"></a>00048 <span class="comment"> * structure can be posted in the mailbox but the posting side has</span>
<a name="l00049"></a>00049 <span class="comment"> * no predefined way to know when the message has been processed. A</span>
<a name="l00050"></a>00050 <span class="comment"> * possible approach is to allocate memory (from a memory pool as</span>
<a name="l00051"></a>00051 <span class="comment"> * example) from the posting side and free it on the fetching side.</span>
<a name="l00052"></a>00052 <span class="comment"> * Another approach is to set a &quot;done&quot; flag into the structure pointed</span>
<a name="l00053"></a>00053 <span class="comment"> * by the message.&lt;br&gt;</span>
<a name="l00054"></a>00054 <span class="comment"> * In order to use the mailboxes APIs the @p CH_USE_MAILBOXES option</span>
<a name="l00055"></a>00055 <span class="comment"> * must be enabled in @p chconf.h.</span>
<a name="l00056"></a>00056 <span class="comment"> * @{</span>
<a name="l00057"></a>00057 <span class="comment"> */</span>
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="preprocessor">#include &quot;<a class="code" href="ch_8h.html" title="ChibiOS/RT main include file.">ch.h</a>&quot;</span>
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="preprocessor">#if CH_USE_MAILBOXES</span>
<a name="l00062"></a>00062 <span class="preprocessor"></span><span class="comment">/**</span>
<a name="l00063"></a>00063 <span class="comment"> * @brief Initializes a Mailbox object.</span>
<a name="l00064"></a>00064 <span class="comment"> *</span>
<a name="l00065"></a>00065 <span class="comment"> * @param[out] mbp the pointer to the Mailbox structure to be initialized</span>
<a name="l00066"></a>00066 <span class="comment"> * @param[in] buf the circular messages buffer</span>
<a name="l00067"></a>00067 <span class="comment"> * @param[in] n the buffer size as number of @p msg_t</span>
<a name="l00068"></a>00068 <span class="comment"> */</span>
<a name="l00069"></a><a class="code" href="group__mailboxes.html#gaff65b97bfdbf9144e9727a100a9be93a">00069</a> <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="l00070"></a>00070
<a name="l00071"></a>00071 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((mbp != NULL) &amp;&amp; (buf != NULL) &amp;&amp; (n &gt; 0), <span class="stringliteral">&quot;chMBInit&quot;</span>);
<a name="l00072"></a>00072
<a name="l00073"></a>00073 mbp-&gt;mb_buffer = mbp-&gt;mb_wrptr = mbp-&gt;mb_rdptr = buf;
<a name="l00074"></a>00074 mbp-&gt;mb_top = &amp;buf[n];
<a name="l00075"></a>00075 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&amp;mbp-&gt;mb_emptysem, n);
<a name="l00076"></a>00076 <a class="code" href="group__semaphores.html#gafe8fc6155a871074e8017efd908b2c58" title="Initializes a semaphore with the specified counter value.">chSemInit</a>(&amp;mbp-&gt;mb_fullsem, 0);
<a name="l00077"></a>00077 }
<a name="l00078"></a>00078 <span class="comment"></span>
<a name="l00079"></a>00079 <span class="comment">/**</span>
<a name="l00080"></a>00080 <span class="comment"> * @brief Resets a Mailbox object.</span>
<a name="l00081"></a>00081 <span class="comment"> * @details All the waiting threads are resumed with status @p RDY_RESET and</span>
<a name="l00082"></a>00082 <span class="comment"> * the queued messages are lost.</span>
<a name="l00083"></a>00083 <span class="comment"> *</span>
<a name="l00084"></a>00084 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00085"></a>00085 <span class="comment"> */</span>
<a name="l00086"></a><a class="code" href="group__mailboxes.html#ga4199e224456395c3dbc74dbc889dff94">00086</a> <span class="keywordtype">void</span> <a class="code" href="group__mailboxes.html#ga4199e224456395c3dbc74dbc889dff94" title="Resets a Mailbox object.">chMBReset</a>(Mailbox *mbp) {
<a name="l00087"></a>00087
<a name="l00088"></a>00088 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(mbp != NULL, <span class="stringliteral">&quot;chMBReset&quot;</span>);
<a name="l00089"></a>00089
<a name="l00090"></a>00090 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00091"></a>00091 mbp-&gt;mb_wrptr = mbp-&gt;mb_rdptr = mbp-&gt;mb_buffer;
<a name="l00092"></a>00092 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&amp;mbp-&gt;mb_emptysem, mbp-&gt;mb_top - mbp-&gt;mb_buffer);
<a name="l00093"></a>00093 <a class="code" href="group__semaphores.html#gae7972b6b22b80ac09bac5a186277ab81" title="Performs a reset operation on the semaphore.">chSemResetI</a>(&amp;mbp-&gt;mb_fullsem, 0);
<a name="l00094"></a>00094 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00095"></a>00095 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00096"></a>00096 }
<a name="l00097"></a>00097 <span class="comment"></span>
<a name="l00098"></a>00098 <span class="comment">/**</span>
<a name="l00099"></a>00099 <span class="comment"> * @brief Posts a message into a mailbox.</span>
<a name="l00100"></a>00100 <span class="comment"> * @details The invoking thread waits until a empty slot in the mailbox becomes</span>
<a name="l00101"></a>00101 <span class="comment"> * available or the specified time runs out.</span>
<a name="l00102"></a>00102 <span class="comment"> *</span>
<a name="l00103"></a>00103 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00104"></a>00104 <span class="comment"> * @param[in] msg the message to be posted on the mailbox</span>
<a name="l00105"></a>00105 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00106"></a>00106 <span class="comment"> * the following special values are allowed:</span>
<a name="l00107"></a>00107 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00108"></a>00108 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00109"></a>00109 <span class="comment"> * .</span>
<a name="l00110"></a>00110 <span class="comment"> * @return The operation status.</span>
<a name="l00111"></a>00111 <span class="comment"> * @retval RDY_OK if the message was correctly posted.</span>
<a name="l00112"></a>00112 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00113"></a>00113 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00114"></a>00114 <span class="comment"> */</span>
<a name="l00115"></a><a class="code" href="group__mailboxes.html#ga9bafcc634765886f59cf68c0e35d070d">00115</a> <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> time) {
<a name="l00116"></a>00116 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00117"></a>00117
<a name="l00118"></a>00118 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00119"></a>00119 rdymsg = <a class="code" href="group__mailboxes.html#gac6514c185ae87c2633132478ea48d689" title="Posts a message into a mailbox.">chMBPostS</a>(mbp, msg, time);
<a name="l00120"></a>00120 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00121"></a>00121 <span class="keywordflow">return</span> rdymsg;
<a name="l00122"></a>00122 }
<a name="l00123"></a>00123 <span class="comment"></span>
<a name="l00124"></a>00124 <span class="comment">/**</span>
<a name="l00125"></a>00125 <span class="comment"> * @brief Posts a message into a mailbox.</span>
<a name="l00126"></a>00126 <span class="comment"> * @details The invoking thread waits until a empty slot in the mailbox becomes</span>
<a name="l00127"></a>00127 <span class="comment"> * available or the specified time runs out.</span>
<a name="l00128"></a>00128 <span class="comment"> *</span>
<a name="l00129"></a>00129 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00130"></a>00130 <span class="comment"> * @param[in] msg the message to be posted on the mailbox</span>
<a name="l00131"></a>00131 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00132"></a>00132 <span class="comment"> * the following special values are allowed:</span>
<a name="l00133"></a>00133 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00134"></a>00134 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00135"></a>00135 <span class="comment"> * .</span>
<a name="l00136"></a>00136 <span class="comment"> * @return The operation status.</span>
<a name="l00137"></a>00137 <span class="comment"> * @retval RDY_OK if the message was correctly posted.</span>
<a name="l00138"></a>00138 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00139"></a>00139 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00140"></a>00140 <span class="comment"> */</span>
<a name="l00141"></a><a class="code" href="group__mailboxes.html#gac6514c185ae87c2633132478ea48d689">00141</a> <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> time) {
<a name="l00142"></a>00142 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00143"></a>00143
<a name="l00144"></a>00144 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(mbp != NULL, <span class="stringliteral">&quot;chMBPostS&quot;</span>);
<a name="l00145"></a>00145
<a name="l00146"></a>00146 rdymsg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&amp;mbp-&gt;mb_emptysem, time);
<a name="l00147"></a>00147 <span class="keywordflow">if</span> (rdymsg == <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
<a name="l00148"></a>00148 *mbp-&gt;mb_wrptr++ = msg;
<a name="l00149"></a>00149 <span class="keywordflow">if</span> (mbp-&gt;mb_wrptr &gt;= mbp-&gt;mb_top)
<a name="l00150"></a>00150 mbp-&gt;mb_wrptr = mbp-&gt;mb_buffer;
<a name="l00151"></a>00151 <a class="code" href="group__semaphores.html#gaca0b70cf495a9cb7569e1cf5b07e2b3d" title="Performs a signal operation on a semaphore.">chSemSignalI</a>(&amp;mbp-&gt;mb_fullsem);
<a name="l00152"></a>00152 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00153"></a>00153 }
<a name="l00154"></a>00154 <span class="keywordflow">return</span> rdymsg;
<a name="l00155"></a>00155 }
<a name="l00156"></a>00156 <span class="comment"></span>
<a name="l00157"></a>00157 <span class="comment">/**</span>
<a name="l00158"></a>00158 <span class="comment"> * @brief Posts an high priority message into a mailbox.</span>
<a name="l00159"></a>00159 <span class="comment"> * @details The invoking thread waits until a empty slot in the mailbox becomes</span>
<a name="l00160"></a>00160 <span class="comment"> * available or the specified time runs out.</span>
<a name="l00161"></a>00161 <span class="comment"> *</span>
<a name="l00162"></a>00162 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00163"></a>00163 <span class="comment"> * @param[in] msg the message to be posted on the mailbox</span>
<a name="l00164"></a>00164 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00165"></a>00165 <span class="comment"> * the following special values are allowed:</span>
<a name="l00166"></a>00166 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00167"></a>00167 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00168"></a>00168 <span class="comment"> * .</span>
<a name="l00169"></a>00169 <span class="comment"> * @return The operation status.</span>
<a name="l00170"></a>00170 <span class="comment"> * @retval RDY_OK if the message was correctly posted.</span>
<a name="l00171"></a>00171 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00172"></a>00172 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00173"></a>00173 <span class="comment"> */</span>
<a name="l00174"></a><a class="code" href="group__mailboxes.html#ga55c5b8890b78127bc1fa5a324252d5e6">00174</a> <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> time) {
<a name="l00175"></a>00175 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00176"></a>00176
<a name="l00177"></a>00177 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00178"></a>00178 rdymsg = <a class="code" href="group__mailboxes.html#gaa9c91c0b781bec0df3540407d75b1bb3" title="Posts an high priority message into a mailbox.">chMBPostAheadS</a>(mbp, msg, time);
<a name="l00179"></a>00179 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00180"></a>00180 <span class="keywordflow">return</span> rdymsg;
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182 <span class="comment"></span>
<a name="l00183"></a>00183 <span class="comment">/**</span>
<a name="l00184"></a>00184 <span class="comment"> * @brief Posts an high priority message into a mailbox.</span>
<a name="l00185"></a>00185 <span class="comment"> * @details The invoking thread waits until a empty slot in the mailbox becomes</span>
<a name="l00186"></a>00186 <span class="comment"> * available or the specified time runs out.</span>
<a name="l00187"></a>00187 <span class="comment"> *</span>
<a name="l00188"></a>00188 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00189"></a>00189 <span class="comment"> * @param[in] msg the message to be posted on the mailbox</span>
<a name="l00190"></a>00190 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00191"></a>00191 <span class="comment"> * the following special values are allowed:</span>
<a name="l00192"></a>00192 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00193"></a>00193 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00194"></a>00194 <span class="comment"> * .</span>
<a name="l00195"></a>00195 <span class="comment"> * @return The operation status.</span>
<a name="l00196"></a>00196 <span class="comment"> * @retval RDY_OK if the message was correctly posted.</span>
<a name="l00197"></a>00197 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00198"></a>00198 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00199"></a>00199 <span class="comment"> */</span>
<a name="l00200"></a><a class="code" href="group__mailboxes.html#gaa9c91c0b781bec0df3540407d75b1bb3">00200</a> <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> time) {
<a name="l00201"></a>00201 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00202"></a>00202
<a name="l00203"></a>00203 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>(mbp != NULL, <span class="stringliteral">&quot;chMBPostAheadS&quot;</span>);
<a name="l00204"></a>00204
<a name="l00205"></a>00205 rdymsg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&amp;mbp-&gt;mb_emptysem, time);
<a name="l00206"></a>00206 <span class="keywordflow">if</span> (rdymsg == <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
<a name="l00207"></a>00207 <span class="keywordflow">if</span> (--mbp-&gt;mb_rdptr &lt; mbp-&gt;mb_buffer)
<a name="l00208"></a>00208 mbp-&gt;mb_rdptr = mbp-&gt;mb_top - 1;
<a name="l00209"></a>00209 *mbp-&gt;mb_rdptr = msg;
<a name="l00210"></a>00210 <a class="code" href="group__semaphores.html#gaca0b70cf495a9cb7569e1cf5b07e2b3d" title="Performs a signal operation on a semaphore.">chSemSignalI</a>(&amp;mbp-&gt;mb_fullsem);
<a name="l00211"></a>00211 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213 <span class="keywordflow">return</span> rdymsg;
<a name="l00214"></a>00214 }
<a name="l00215"></a>00215 <span class="comment"></span>
<a name="l00216"></a>00216 <span class="comment">/**</span>
<a name="l00217"></a>00217 <span class="comment"> * @brief Retrieves a message from a mailbox.</span>
<a name="l00218"></a>00218 <span class="comment"> * @details The invoking thread waits until a message is posted in the mailbox</span>
<a name="l00219"></a>00219 <span class="comment"> * or the specified time runs out.</span>
<a name="l00220"></a>00220 <span class="comment"> *</span>
<a name="l00221"></a>00221 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00222"></a>00222 <span class="comment"> * @param[out] msgp pointer to a message variable for the received message</span>
<a name="l00223"></a>00223 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00224"></a>00224 <span class="comment"> * the following special values are allowed:</span>
<a name="l00225"></a>00225 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00226"></a>00226 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00227"></a>00227 <span class="comment"> * .</span>
<a name="l00228"></a>00228 <span class="comment"> * @return The operation status.</span>
<a name="l00229"></a>00229 <span class="comment"> * @retval RDY_OK if a message was correctly fetched.</span>
<a name="l00230"></a>00230 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00231"></a>00231 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00232"></a>00232 <span class="comment"> */</span>
<a name="l00233"></a><a class="code" href="group__mailboxes.html#ga61543bf11d0caa737f5818c67548c055">00233</a> <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> time) {
<a name="l00234"></a>00234 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00235"></a>00235
<a name="l00236"></a>00236 <a class="code" href="group__system.html#ga9f6573c0763d1e4e97c63c62edad6e42" title="Enters the kernel lock mode.">chSysLock</a>();
<a name="l00237"></a>00237 rdymsg = <a class="code" href="group__mailboxes.html#gadc562242a8854497a1f9539cb9ffea09" title="Retrieves a message from a mailbox.">chMBFetchS</a>(mbp, msgp, time);
<a name="l00238"></a>00238 <a class="code" href="group__system.html#ga5a257fa58a09815eb64a45e2dfbdc22e" title="Leaves the kernel lock mode.">chSysUnlock</a>();
<a name="l00239"></a>00239 <span class="keywordflow">return</span> rdymsg;
<a name="l00240"></a>00240 }
<a name="l00241"></a>00241 <span class="comment"></span>
<a name="l00242"></a>00242 <span class="comment">/**</span>
<a name="l00243"></a>00243 <span class="comment"> * @brief Retrieves a message from a mailbox.</span>
<a name="l00244"></a>00244 <span class="comment"> * @details The invoking thread waits until a message is posted in the mailbox</span>
<a name="l00245"></a>00245 <span class="comment"> * or the specified time runs out.</span>
<a name="l00246"></a>00246 <span class="comment"> *</span>
<a name="l00247"></a>00247 <span class="comment"> * @param[in] mbp the pointer to an initialized Mailbox object</span>
<a name="l00248"></a>00248 <span class="comment"> * @param[out] msgp pointer to a message variable for the received message</span>
<a name="l00249"></a>00249 <span class="comment"> * @param[in] time the number of ticks before the operation timeouts,</span>
<a name="l00250"></a>00250 <span class="comment"> * the following special values are allowed:</span>
<a name="l00251"></a>00251 <span class="comment"> * - @a TIME_IMMEDIATE immediate timeout.</span>
<a name="l00252"></a>00252 <span class="comment"> * - @a TIME_INFINITE no timeout.</span>
<a name="l00253"></a>00253 <span class="comment"> * .</span>
<a name="l00254"></a>00254 <span class="comment"> * @return The operation status.</span>
<a name="l00255"></a>00255 <span class="comment"> * @retval RDY_OK if a message was correctly fetched.</span>
<a name="l00256"></a>00256 <span class="comment"> * @retval RDY_RESET if the mailbox was reset while waiting.</span>
<a name="l00257"></a>00257 <span class="comment"> * @retval RDY_TIMEOUT if the operation timed out.</span>
<a name="l00258"></a>00258 <span class="comment"> */</span>
<a name="l00259"></a><a class="code" href="group__mailboxes.html#gadc562242a8854497a1f9539cb9ffea09">00259</a> <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> time) {
<a name="l00260"></a>00260 <a class="code" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3" title="Message, use signed pointer equivalent.">msg_t</a> rdymsg;
<a name="l00261"></a>00261
<a name="l00262"></a>00262 <a class="code" href="group__debug.html#ga6bb6c0f97caab3a66332c8bfbf7a3844" title="Function parameter check.">chDbgCheck</a>((mbp != NULL) &amp;&amp; (msgp != NULL), <span class="stringliteral">&quot;chMBFetchS&quot;</span>);
<a name="l00263"></a>00263
<a name="l00264"></a>00264 rdymsg = <a class="code" href="group__semaphores.html#ga924ec5d191bb8debe8727ae4dd5d6d03" title="Performs a wait operation on a semaphore with timeout specification.">chSemWaitTimeoutS</a>(&amp;mbp-&gt;mb_fullsem, time);
<a name="l00265"></a>00265 <span class="keywordflow">if</span> (rdymsg == <a class="code" href="group__scheduler.html#gae1c86078318e11c2fa57ee3c2ec69f61" title="Default thread wakeup low level message.">RDY_OK</a>) {
<a name="l00266"></a>00266 *msgp = *mbp-&gt;mb_rdptr++;
<a name="l00267"></a>00267 <span class="keywordflow">if</span> (mbp-&gt;mb_rdptr &gt;= mbp-&gt;mb_top)
<a name="l00268"></a>00268 mbp-&gt;mb_rdptr = mbp-&gt;mb_buffer;
<a name="l00269"></a>00269 <a class="code" href="group__semaphores.html#gaca0b70cf495a9cb7569e1cf5b07e2b3d" title="Performs a signal operation on a semaphore.">chSemSignalI</a>(&amp;mbp-&gt;mb_emptysem);
<a name="l00270"></a>00270 <a class="code" href="group__scheduler.html#ga4e38b4bee3d2330f6a0f1cdb7660af20" title="Performs a reschedule if a higher priority thread is runnable.">chSchRescheduleS</a>();
<a name="l00271"></a>00271 }
<a name="l00272"></a>00272 <span class="keywordflow">return</span> rdymsg;
<a name="l00273"></a>00273 }
<a name="l00274"></a>00274 <span class="preprocessor">#endif </span><span class="comment">/* CH_USE_MAILBOXES */</span>
<a name="l00275"></a>00275 <span class="comment"></span>
<a name="l00276"></a>00276 <span class="comment">/** @} */</span>
</pre></div></div>
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
</div>
Initial import
2010-08-10 03:11:02 +00:00
<hr size="1"><address style="text-align: right;"><small>
Imported ChibiOS/RT 2.0.6.
2010-11-22 05:53:37 +00:00
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>
Initial import
2010-08-10 03:11:02 +00:00
</body>
</html>
Reference in New Issue Copy Permalink