diff options
Diffstat (limited to 'docs/RTOS2/html/group__rtx__evr__message__queue.html')
-rw-r--r-- | docs/RTOS2/html/group__rtx__evr__message__queue.html | 1126 |
1 files changed, 1126 insertions, 0 deletions
diff --git a/docs/RTOS2/html/group__rtx__evr__message__queue.html b/docs/RTOS2/html/group__rtx__evr__message__queue.html new file mode 100644 index 0000000..e3edde3 --- /dev/null +++ b/docs/RTOS2/html/group__rtx__evr__message__queue.html @@ -0,0 +1,1126 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<title>Message Queue Functions</title> +<title>CMSIS-RTOS2: Message Queue Functions</title> +<link href="tabs.css" rel="stylesheet" type="text/css"/> +<link href="cmsis.css" rel="stylesheet" type="text/css" /> +<script type="text/javascript" src="jquery.js"></script> +<script type="text/javascript" src="dynsections.js"></script> +<script type="text/javascript" src="printComponentTabs.js"></script> +<link href="navtree.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="resize.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); + $(window).load(resizeHeight); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/search.js"></script> +<script type="text/javascript"> + $(document).ready(function() { searchBox.OnSelectItem(0); }); +</script> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> +<div id="titlearea"> +<table cellspacing="0" cellpadding="0"> + <tbody> + <tr style="height: 46px;"> + <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> + <td style="padding-left: 0.5em;"> + <div id="projectname">CMSIS-RTOS2 +  <span id="projectnumber">Version 2.1.3</span> + </div> + <div id="projectbrief">Real-Time Operating System: API and RTX Reference Implementation</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<div id="CMSISnav" class="tabs1"> + <ul class="tablist"> + <script type="text/javascript"> + <!-- + writeComponentTabs.call(this); + //--> + </script> + </ul> +</div> +<!-- Generated by Doxygen 1.8.6 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> + <div id="navrow1" class="tabs"> + <ul class="tablist"> + <li><a href="index.html"><span>Main Page</span></a></li> + <li><a href="pages.html"><span>Usage and Description</span></a></li> + <li><a href="modules.html"><span>Reference</span></a></li> + <li> + <div id="MSearchBox" class="MSearchBoxInactive"> + <span class="left"> + <img id="MSearchSelect" src="search/mag_sel.png" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + alt=""/> + <input type="text" id="MSearchField" value="Search" accesskey="S" + onfocus="searchBox.OnSearchFieldFocus(true)" + onblur="searchBox.OnSearchFieldFocus(false)" + onkeyup="searchBox.OnSearchFieldChange(event)"/> + </span><span class="right"> + <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> + </span> + </div> + </li> + </ul> + </div> +</div><!-- top --> +<div id="side-nav" class="ui-resizable side-nav-resizable"> + <div id="nav-tree"> + <div id="nav-tree-contents"> + <div id="nav-sync" class="sync"></div> + </div> + </div> + <div id="splitbar" style="-moz-user-select:none;" + class="ui-resizable-handle"> + </div> +</div> +<script type="text/javascript"> +$(document).ready(function(){initNavTree('group__rtx__evr__message__queue.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Pages</a></div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#func-members">Functions</a> </div> + <div class="headertitle"> +<div class="title">Message Queue Functions<div class="ingroups"><a class="el" href="group__rtx__evr.html">Event functions</a></div></div> </div> +</div><!--header--> +<div class="contents"> + +<p>Events generated by message queue functions. +<a href="#details">More...</a></p> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> +Functions</h2></td></tr> +<tr class="memitem:ga8ded1d43703e0885a81e65251c6df405"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga8ded1d43703e0885a81e65251c6df405">EvrRtxMessageQueueError</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, int32_t status)</td></tr> +<tr class="memdesc:ga8ded1d43703e0885a81e65251c6df405"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue error (Error) <a href="#ga8ded1d43703e0885a81e65251c6df405">More...</a><br/></td></tr> +<tr class="separator:ga8ded1d43703e0885a81e65251c6df405"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gaa7b18f18f3f53d6afb39ac1abe257000">EvrRtxMessageQueueNew</a> (uint32_t msg_count, uint32_t msg_size, const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a> *attr)</td></tr> +<tr class="memdesc:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue create and initialization (API) <a href="#gaa7b18f18f3f53d6afb39ac1abe257000">More...</a><br/></td></tr> +<tr class="separator:gaa7b18f18f3f53d6afb39ac1abe257000"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga36d6982377c1f54a227ba6fbb9458b79"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga36d6982377c1f54a227ba6fbb9458b79">EvrRtxMessageQueueCreated</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const char *name)</td></tr> +<tr class="memdesc:ga36d6982377c1f54a227ba6fbb9458b79"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful message queue create (Op) <a href="#ga36d6982377c1f54a227ba6fbb9458b79">More...</a><br/></td></tr> +<tr class="separator:ga36d6982377c1f54a227ba6fbb9458b79"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad0ef8ee59d2ec189351c5884f5f8e945">EvrRtxMessageQueueGetName</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const char *name)</td></tr> +<tr class="memdesc:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue name retrieve(API) <a href="#gad0ef8ee59d2ec189351c5884f5f8e945">More...</a><br/></td></tr> +<tr class="separator:gad0ef8ee59d2ec189351c5884f5f8e945"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga401536a603e5a805cc6089b4de11d3d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga401536a603e5a805cc6089b4de11d3d3">EvrRtxMessageQueuePut</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr, uint8_t msg_prio, uint32_t timeout)</td></tr> +<tr class="memdesc:ga401536a603e5a805cc6089b4de11d3d3"><td class="mdescLeft"> </td><td class="mdescRight">Event on message put (API) <a href="#ga401536a603e5a805cc6089b4de11d3d3">More...</a><br/></td></tr> +<tr class="separator:ga401536a603e5a805cc6089b4de11d3d3"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga4b1b6191c6ca87dff4714e25b5845828"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga4b1b6191c6ca87dff4714e25b5845828">EvrRtxMessageQueuePutPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr, uint32_t timeout)</td></tr> +<tr class="memdesc:ga4b1b6191c6ca87dff4714e25b5845828"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending message put (Op) <a href="#ga4b1b6191c6ca87dff4714e25b5845828">More...</a><br/></td></tr> +<tr class="separator:ga4b1b6191c6ca87dff4714e25b5845828"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga7394ca2d88255470f7ba0bb2bff12e99">EvrRtxMessageQueuePutTimeout</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="mdescLeft"> </td><td class="mdescRight">Event on message put timeout (Op) <a href="#ga7394ca2d88255470f7ba0bb2bff12e99">More...</a><br/></td></tr> +<tr class="separator:ga7394ca2d88255470f7ba0bb2bff12e99"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga8440223b9d48145df5505489e7c6f7d9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga8440223b9d48145df5505489e7c6f7d9">EvrRtxMessageQueueInsertPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr> +<tr class="memdesc:ga8440223b9d48145df5505489e7c6f7d9"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending message insert (Op) <a href="#ga8440223b9d48145df5505489e7c6f7d9">More...</a><br/></td></tr> +<tr class="separator:ga8440223b9d48145df5505489e7c6f7d9"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gaa30c5b375d4050ad7d99ba094821bf52"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gaa30c5b375d4050ad7d99ba094821bf52">EvrRtxMessageQueueInserted</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr> +<tr class="memdesc:gaa30c5b375d4050ad7d99ba094821bf52"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful message insert (Op) <a href="#gaa30c5b375d4050ad7d99ba094821bf52">More...</a><br/></td></tr> +<tr class="separator:gaa30c5b375d4050ad7d99ba094821bf52"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga2922125d8ac63fd800dc3b7888fd3f3c">EvrRtxMessageQueueNotInserted</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, const void *msg_ptr)</td></tr> +<tr class="memdesc:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful message insert (Op) <a href="#ga2922125d8ac63fd800dc3b7888fd3f3c">More...</a><br/></td></tr> +<tr class="separator:ga2922125d8ac63fd800dc3b7888fd3f3c"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga0826c1d05d3a99afb8682f0ca3f7fd62">EvrRtxMessageQueueGet</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr, uint8_t *msg_prio, uint32_t timeout)</td></tr> +<tr class="memdesc:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="mdescLeft"> </td><td class="mdescRight">Event on message get (API) <a href="#ga0826c1d05d3a99afb8682f0ca3f7fd62">More...</a><br/></td></tr> +<tr class="separator:ga0826c1d05d3a99afb8682f0ca3f7fd62"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga11e3df32a66d5240b277375cbb5d3c83"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga11e3df32a66d5240b277375cbb5d3c83">EvrRtxMessageQueueGetPending</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr, uint32_t timeout)</td></tr> +<tr class="memdesc:ga11e3df32a66d5240b277375cbb5d3c83"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending message get (Op) <a href="#ga11e3df32a66d5240b277375cbb5d3c83">More...</a><br/></td></tr> +<tr class="separator:ga11e3df32a66d5240b277375cbb5d3c83"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga5e699de7401c46fd0e8bc19e398dc5a8">EvrRtxMessageQueueGetTimeout</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="mdescLeft"> </td><td class="mdescRight">Event on message get timeout (Op) <a href="#ga5e699de7401c46fd0e8bc19e398dc5a8">More...</a><br/></td></tr> +<tr class="separator:ga5e699de7401c46fd0e8bc19e398dc5a8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gab340b38df5d8bf2a1182fd18f2d3a6c4">EvrRtxMessageQueueRetrieved</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr)</td></tr> +<tr class="memdesc:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful message get (Op) <a href="#gab340b38df5d8bf2a1182fd18f2d3a6c4">More...</a><br/></td></tr> +<tr class="separator:gab340b38df5d8bf2a1182fd18f2d3a6c4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga22bfb7d1c2f6e3e9fea9d3267b2d6988">EvrRtxMessageQueueNotRetrieved</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, void *msg_ptr)</td></tr> +<tr class="memdesc:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful message get (Op) <a href="#ga22bfb7d1c2f6e3e9fea9d3267b2d6988">More...</a><br/></td></tr> +<tr class="separator:ga22bfb7d1c2f6e3e9fea9d3267b2d6988"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad423a0be13d65e98d9ae08de9c399615"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad423a0be13d65e98d9ae08de9c399615">EvrRtxMessageQueueGetCapacity</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t capacity)</td></tr> +<tr class="memdesc:gad423a0be13d65e98d9ae08de9c399615"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue capacity retrieve (API) <a href="#gad423a0be13d65e98d9ae08de9c399615">More...</a><br/></td></tr> +<tr class="separator:gad423a0be13d65e98d9ae08de9c399615"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3d6348bed3937de29765ed4d7d07fac8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3d6348bed3937de29765ed4d7d07fac8">EvrRtxMessageQueueGetMsgSize</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t msg_size)</td></tr> +<tr class="memdesc:ga3d6348bed3937de29765ed4d7d07fac8"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue message size retrieve (API) <a href="#ga3d6348bed3937de29765ed4d7d07fac8">More...</a><br/></td></tr> +<tr class="separator:ga3d6348bed3937de29765ed4d7d07fac8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga145f0c464382dc71ff3b1c624b8bd570"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga145f0c464382dc71ff3b1c624b8bd570">EvrRtxMessageQueueGetCount</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t count)</td></tr> +<tr class="memdesc:ga145f0c464382dc71ff3b1c624b8bd570"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue message count retrieve (API) <a href="#ga145f0c464382dc71ff3b1c624b8bd570">More...</a><br/></td></tr> +<tr class="separator:ga145f0c464382dc71ff3b1c624b8bd570"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga6cfce7336f58505a2379a8a71f477d2f"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga6cfce7336f58505a2379a8a71f477d2f">EvrRtxMessageQueueGetSpace</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id, uint32_t space)</td></tr> +<tr class="memdesc:ga6cfce7336f58505a2379a8a71f477d2f"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue message slots retrieve (API) <a href="#ga6cfce7336f58505a2379a8a71f477d2f">More...</a><br/></td></tr> +<tr class="separator:ga6cfce7336f58505a2379a8a71f477d2f"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga91b8c8630c7d89b6b6dbb74d4fc81ba4">EvrRtxMessageQueueReset</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue reset (API) <a href="#ga91b8c8630c7d89b6b6dbb74d4fc81ba4">More...</a><br/></td></tr> +<tr class="separator:ga91b8c8630c7d89b6b6dbb74d4fc81ba4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3947d4a7ac86ee7a50052c9eb4cd5432">EvrRtxMessageQueueResetDone</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful message queue reset (Op) <a href="#ga3947d4a7ac86ee7a50052c9eb4cd5432">More...</a><br/></td></tr> +<tr class="separator:ga3947d4a7ac86ee7a50052c9eb4cd5432"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:gad11606ef82f5b82f291bf64adfc805e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#gad11606ef82f5b82f291bf64adfc805e4">EvrRtxMessageQueueDelete</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:gad11606ef82f5b82f291bf64adfc805e4"><td class="mdescLeft"> </td><td class="mdescRight">Event on message queue delete (API) <a href="#gad11606ef82f5b82f291bf64adfc805e4">More...</a><br/></td></tr> +<tr class="separator:gad11606ef82f5b82f291bf64adfc805e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__message__queue.html#ga3bbf02128c31e5cc7ef4c78cdbec508c">EvrRtxMessageQueueDestroyed</a> (<a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> mq_id)</td></tr> +<tr class="memdesc:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful message queue delete (Op) <a href="#ga3bbf02128c31e5cc7ef4c78cdbec508c">More...</a><br/></td></tr> +<tr class="separator:ga3bbf02128c31e5cc7ef4c78cdbec508c"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Description</h2> +<h2 class="groupheader">Function Documentation</h2> +<a class="anchor" id="ga8ded1d43703e0885a81e65251c6df405"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueError </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">int32_t </td> + <td class="paramname"><em>status</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> or NULL when ID is unknown. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueError</b> is generated when <a class="el" href="group__CMSIS__RTOS__Message.html">Message Queue</a> routines complete their execution due to an error.</p> +<p>The status parameter indicates the execution status and can be one of the <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t codes</a> or one of the extended execution status codes which are summarized in the table below.</p> +<table class="doxtable"> +<tr> +<th align="left">Extended Status Code </th><th align="left">Description </th></tr> +<tr> +<td align="left">osRtxErrorKernelNotReady </td><td align="left">Kernel scheduler is not in Ready state. </td></tr> +<tr> +<td align="left">osRtxErrorKernelNotRunning </td><td align="left">Kernel scheduler is not executing - there is no running thread. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidControlBlock </td><td align="left">Object control block with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidDataMemory </td><td align="left">Object data memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidThreadStack </td><td align="left">Thread stack memory with invalid alignment or size was specified. </td></tr> +<tr> +<td align="left">osRtxErrorInvalidPriority </td><td align="left">Invalid thread priority was specified. </td></tr> +<tr> +<td align="left">osRtxErrorThreadNotJoinable </td><td align="left">Specified thread is not joinable. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotOwned </td><td align="left">Specified mutex is not owned by the current running thread. </td></tr> +<tr> +<td align="left">osRtxErrorMutexNotLocked </td><td align="left">Specified mutex is not locked. </td></tr> +<tr> +<td align="left">osRtxErrorMutexLockLimit </td><td align="left">Maximum number of recursive mutex locks reached. </td></tr> +<tr> +<td align="left">osRtxErrorSemaphoreCountLimit </td><td align="left">Semaphore count limit reached. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_InitContext_S </td><td align="left">Secure context memory system initialization failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_AllocContext_S </td><td align="left">Secure context memory allocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_FreeContext_S </td><td align="left">Secure context memory deallocation failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_LoadContext_S </td><td align="left">Secure context load failed. </td></tr> +<tr> +<td align="left">osRtxErrorTZ_SaveContext_S </td><td align="left">Secure context save failed. </td></tr> +</table> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>status</b> : execution status code. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaa7b18f18f3f53d6afb39ac1abe257000"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueNew </td> + <td>(</td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>msg_count</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>msg_size</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">osMessageQueueAttr_t</a> * </td> + <td class="paramname"><em>attr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_count</td><td>maximum number of messages in queue. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>message queue attributes; NULL: default values.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>msg_count</b> : maximum number of messages in queue.</li> +<li><b>msg_size</b> : maximum message size in bytes.</li> +<li><b>attr</b> : memory address of Message Queue attributes or 0 when they are not specified.</li> +</ul> +<p>In case when <a class="el" href="group__CMSIS__RTOS__Message.html#structosMessageQueueAttr__t">message queue attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p> + +</div> +</div> +<a class="anchor" id="ga36d6982377c1f54a227ba6fbb9458b79"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueCreated </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a> successfully creates a message queue object.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gad0ef8ee59d2ec189351c5884f5f8e945"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetName </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const char * </td> + <td class="paramname"><em>name</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to message queue object name.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gae7cf7bf2b97a5ae481fb60fcce99247a">osMessageQueueGetName</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>name</b> : retrieved memory address of name string (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga401536a603e5a805cc6089b4de11d3d3"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueuePut </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>msg_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint8_t </td> + <td class="paramname"><em>msg_prio</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueuePut</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of message buffer.</li> +<li><b>msg_prio</b> : message priority.</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga4b1b6191c6ca87dff4714e25b5845828"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueuePutPending </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>msg_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueuePutPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> starts waiting to put message into the queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of message buffer.</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga7394ca2d88255470f7ba0bb2bff12e99"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueuePutTimeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueuePutTimeout</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> fails to insert a message into the queue until timeout expires.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga8440223b9d48145df5505489e7c6f7d9"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueInsertPending </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>msg_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueInsertPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> is called from ISR and message is registered to be put into the queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of message buffer. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gaa30c5b375d4050ad7d99ba094821bf52"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueInserted </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>msg_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueInserted</b> is generated when a message is successfully inserted into the queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of message buffer. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga2922125d8ac63fd800dc3b7888fd3f3c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueNotInserted </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const void * </td> + <td class="paramname"><em>msg_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer with message to put into a queue.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueNotInserted</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaa515fc8b956f721a8f72b2c505813bfc">osMessageQueuePut</a> fails to insert a message into the queue. Usually this happens when queue is out of memory.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of message buffer. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga0826c1d05d3a99afb8682f0ca3f7fd62"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGet </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>msg_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint8_t * </td> + <td class="paramname"><em>msg_prio</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_prio</td><td>message priority. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGet</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of buffer for message.</li> +<li><b>msg_prio</b> : memory address of buffer for message priority.</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga11e3df32a66d5240b277375cbb5d3c83"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetPending </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>msg_ptr</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>timeout</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">timeout</td><td><a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a> or 0 in case of no time-out.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> starts waiting for message to be retrieved from the queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of buffer for message.</li> +<li><b>timeout</b> : <a class="el" href="theory_of_operation.html#CMSIS_RTOS_TimeOutValue">Timeout Value</a>. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga5e699de7401c46fd0e8bc19e398dc5a8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetTimeout </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetTimeout</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called and there is no message available in queue until timeout expires.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gab340b38df5d8bf2a1182fd18f2d3a6c4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueRetrieved </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>msg_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueRetrieved</b> is generated when message is retrieved from the message queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of buffer for message. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga22bfb7d1c2f6e3e9fea9d3267b2d6988"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueNotRetrieved </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">void * </td> + <td class="paramname"><em>msg_ptr</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_ptr</td><td>pointer to buffer for message to get from a queue.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueNotRetrieved</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gad90d4959466a7a65105061da8256ab9e">osMessageQueueGet</a> is called without the wait timeout and there is no message available in queue.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_ptr</b> : memory address of buffer for message. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gad423a0be13d65e98d9ae08de9c399615"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetCapacity </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>capacity</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>maximum number of messages.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetCapacity</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac24f87d4f395e9e9c900c320e45ade8a">osMessageQueueGetCapacity</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>capacity</b> : retrieved maximum number of messages (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga3d6348bed3937de29765ed4d7d07fac8"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetMsgSize </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>msg_size</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">msg_size</td><td>maximum message size in bytes.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetMsgSize</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga96d3d84069b20359de48109e28a1a89e">osMessageQueueGetMsgSize</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>msg_size</b> : retrieved maximum message size in bytes (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga145f0c464382dc71ff3b1c624b8bd570"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetCount </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>count</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>number of queued messages.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#ga6a32ac394fcff568b251c160cc3014b2">osMessageQueueGetCount</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>count</b> : retrieved number of queued messages (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga6cfce7336f58505a2379a8a71f477d2f"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueGetSpace </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">uint32_t </td> + <td class="paramname"><em>space</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>. </td></tr> + <tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>number of available slots for messages.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueGetSpace</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaddf0904427436dd3880d46263c2dc9fa">osMessageQueueGetSpace</a> is called and its execution result is known.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID.</li> +<li><b>space</b> : retrieved number of available slots for messages (0 in case of a failure). </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga91b8c8630c7d89b6b6dbb74d4fc81ba4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueReset </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueReset</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4">osMessageQueueReset</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga3947d4a7ac86ee7a50052c9eb4cd5432"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueResetDone </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueResetDone</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gac6dce7f9ad132d266292c2e979d861b4">osMessageQueueReset</a> successfully completes message queue reset.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="gad11606ef82f5b82f291bf64adfc805e4"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueDelete </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe">osMessageQueueDelete</a> is called.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +<a class="anchor" id="ga3bbf02128c31e5cc7ef4c78cdbec508c"></a> +<div class="memitem"> +<div class="memproto"> + <table class="memname"> + <tr> + <td class="memname">void EvrRtxMessageQueueDestroyed </td> + <td>(</td> + <td class="paramtype"><a class="el" href="cmsis__os2_8h.html#a206dbc05367e03c39fc6d4d1ebcff317">osMessageQueueId_t</a> </td> + <td class="paramname"><em>mq_id</em></td><td>)</td> + <td></td> + </tr> + </table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramdir">[in]</td><td class="paramname">mq_id</td><td>message queue ID obtained by <a class="el" href="group__CMSIS__RTOS__Message.html#ga24e895a00f9d484db33aaf784c57bfed">osMessageQueueNew</a>.</td></tr> + </table> + </dd> +</dl> +<p>The event <b>MessageQueueDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__Message.html#gaba987f665444e0d83fa6a3a68bc72abe">osMessageQueueDelete</a> successfully deletes the message queue object.</p> +<p><b>Value</b> in the Event Recorder shows:</p> +<ul> +<li><b>mq_id</b> : message queue ID. </li> +</ul> + +</div> +</div> +</div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <li class="footer">Generated on Wed Aug 1 2018 17:12:45 for CMSIS-RTOS2 by Arm Ltd. All rights reserved. + <!-- + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6 + --> + </li> + </ul> +</div> +</body> +</html> |