gnuk/ChibiOS_2.0.8/docs/html/chmboxes_8h.html

91 lines
10 KiB
HTML
Raw Normal View History

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.h File Reference</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">
2010-11-22 05:53:37 +00:00
<!-- Generated by Doxygen 1.7.1 -->
2010-08-10 03:11:02 +00:00
<div class="navigation" id="top">
<div class="tabs">
2010-11-22 05:53:37 +00:00
<ul class="tablist">
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>
2010-11-22 05:53:37 +00:00
<div class="tabs2">
<ul class="tablist">
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>
</div>
2010-11-22 05:53:37 +00:00
<div class="header">
<div class="summary">
<a href="#define-members">Defines</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<h1>chmboxes.h File Reference</h1> </div>
</div>
2010-08-10 03:11:02 +00:00
<div class="contents">
2010-11-22 05:53:37 +00:00
2010-08-10 03:11:02 +00:00
<p>Mailboxes macros and structures.
<a href="#_details">More...</a></p>
<p><a href="chmboxes_8h_source.html">Go to the source code of this file.</a></p>
2010-11-22 05:53:37 +00:00
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="define-members"></a>
Defines</h2></td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gad9707fcb206d677fe9437d1f196d135f">chMBSize</a>(mbp)&nbsp;&nbsp;&nbsp;((mbp)-&gt;mb_top - (mbp)-&gt;mb_buffer)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the mailbox buffer size. <a href="group__mailboxes.html#gad9707fcb206d677fe9437d1f196d135f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga883666d096d855c8c372c0241fc47142">chMBGetEmpty</a>(mbp)&nbsp;&nbsp;&nbsp;chSemGetCounterI(&amp;(mbp)-&gt;mb_emptysem)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the free space into the mailbox. <a href="group__mailboxes.html#ga883666d096d855c8c372c0241fc47142"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gad41c9e058c4a35cceeecbf21038f4c03">chMBGetFull</a>(mbp)&nbsp;&nbsp;&nbsp;chSemGetCounterI(&amp;(mbp)-&gt;mb_fullsem)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the number of messages into the mailbox. <a href="group__mailboxes.html#gad41c9e058c4a35cceeecbf21038f4c03"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga620fdbcfe9e4f631f6ea87bed82aa581">chMBPeek</a>(mbp)&nbsp;&nbsp;&nbsp;(*(mbp)-&gt;mb_rdptr)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the next message in the queue without removing it. <a href="group__mailboxes.html#ga620fdbcfe9e4f631f6ea87bed82aa581"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga258b7bab4fa19d63854e7f7f2e3641e6">_MAILBOX_DATA</a>(name, buffer, size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Data part of a static mailbox initializer. <a href="group__mailboxes.html#ga258b7bab4fa19d63854e7f7f2e3641e6"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gafb06e097629b88a09b1f29146a86bf20">MAILBOX_DECL</a>(name, buffer, size)&nbsp;&nbsp;&nbsp;Mailbox name = _MAILBOX_DATA(name, buffer, size)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Static mailbox initializer. <a href="group__mailboxes.html#gafb06e097629b88a09b1f29146a86bf20"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gaff65b97bfdbf9144e9727a100a9be93a">chMBInit</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> *buf, <a class="el" href="group__types.html#ga090b3bab5602157ebf706a44041dc05e">cnt_t</a> n)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Initializes a Mailbox object. <a href="group__mailboxes.html#gaff65b97bfdbf9144e9727a100a9be93a"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga4199e224456395c3dbc74dbc889dff94">chMBReset</a> (Mailbox *mbp)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Resets a Mailbox object. <a href="group__mailboxes.html#ga4199e224456395c3dbc74dbc889dff94"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga9bafcc634765886f59cf68c0e35d070d">chMBPost</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> msg, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Posts a message into a mailbox. <a href="group__mailboxes.html#ga9bafcc634765886f59cf68c0e35d070d"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gac6514c185ae87c2633132478ea48d689">chMBPostS</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> msg, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Posts a message into a mailbox. <a href="group__mailboxes.html#gac6514c185ae87c2633132478ea48d689"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga55c5b8890b78127bc1fa5a324252d5e6">chMBPostAhead</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> msg, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Posts an high priority message into a mailbox. <a href="group__mailboxes.html#ga55c5b8890b78127bc1fa5a324252d5e6"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gaa9c91c0b781bec0df3540407d75b1bb3">chMBPostAheadS</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> msg, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Posts an high priority message into a mailbox. <a href="group__mailboxes.html#gaa9c91c0b781bec0df3540407d75b1bb3"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#ga61543bf11d0caa737f5818c67548c055">chMBFetch</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> *msgp, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a message from a mailbox. <a href="group__mailboxes.html#ga61543bf11d0caa737f5818c67548c055"></a><br/></td></tr>
2010-11-22 05:53:37 +00:00
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__mailboxes.html#gadc562242a8854497a1f9539cb9ffea09">chMBFetchS</a> (Mailbox *mbp, <a class="el" href="group__types.html#ga35bcb0c321cd7bc45bf1a11fa17ebdd3">msg_t</a> *msgp, <a class="el" href="group__types.html#gae3e32a98d431a02106616da3071832dd">systime_t</a> time)</td></tr>
2010-08-10 03:11:02 +00:00
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Retrieves a message from a mailbox. <a href="group__mailboxes.html#gadc562242a8854497a1f9539cb9ffea09"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Mailboxes macros and structures. </p>
<p>Definition in file <a class="el" href="chmboxes_8h_source.html">chmboxes.h</a>.</p>
</div>
<hr size="1"><address style="text-align: right;"><small>
2010-11-30 04:54:43 +00:00
Generated on Sun Nov 28 2010 14:09:49 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>
2010-08-10 03:11:02 +00:00
</body>
</html>