| <!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>Memory Pool Functions</title> |
| <title>CMSIS-RTOS2: Memory Pool 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__memory__pool.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">Memory Pool 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 memory pool 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:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga7e1a37b0c5dd0a97507c025ab1a62ec8">EvrRtxMemoryPoolError</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, int32_t status)</td></tr> |
| <tr class="memdesc:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool error (Error) <a href="#ga7e1a37b0c5dd0a97507c025ab1a62ec8">More...</a><br/></td></tr> |
| <tr class="separator:ga7e1a37b0c5dd0a97507c025ab1a62ec8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf2fd4c91acf1379e93cd9886c515b9c5">EvrRtxMemoryPoolNew</a> (uint32_t block_count, uint32_t block_size, const <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t">osMemoryPoolAttr_t</a> *attr)</td></tr> |
| <tr class="memdesc:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool create and initialize (API) <a href="#gaf2fd4c91acf1379e93cd9886c515b9c5">More...</a><br/></td></tr> |
| <tr class="separator:gaf2fd4c91acf1379e93cd9886c515b9c5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gadad71c7b04493c03647ca0929ea087b1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gadad71c7b04493c03647ca0929ea087b1">EvrRtxMemoryPoolCreated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, const char *name)</td></tr> |
| <tr class="memdesc:gadad71c7b04493c03647ca0929ea087b1"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful memory pool create (Op) <a href="#gadad71c7b04493c03647ca0929ea087b1">More...</a><br/></td></tr> |
| <tr class="separator:gadad71c7b04493c03647ca0929ea087b1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaeface1ee4957cdb59292e13c38a672d7"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaeface1ee4957cdb59292e13c38a672d7">EvrRtxMemoryPoolGetName</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, const char *name)</td></tr> |
| <tr class="memdesc:gaeface1ee4957cdb59292e13c38a672d7"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool name retrieve (API) <a href="#gaeface1ee4957cdb59292e13c38a672d7">More...</a><br/></td></tr> |
| <tr class="separator:gaeface1ee4957cdb59292e13c38a672d7"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga425c8a0e13c6fb13262d99a4dcabd507">EvrRtxMemoryPoolAlloc</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t timeout)</td></tr> |
| <tr class="memdesc:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool allocation (API) <a href="#ga425c8a0e13c6fb13262d99a4dcabd507">More...</a><br/></td></tr> |
| <tr class="separator:ga425c8a0e13c6fb13262d99a4dcabd507"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga2fbd33e3d84b4f37e9f9b80576b26907">EvrRtxMemoryPoolAllocPending</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t timeout)</td></tr> |
| <tr class="memdesc:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="mdescLeft"> </td><td class="mdescRight">Event on pending memory pool allocation (Op) <a href="#ga2fbd33e3d84b4f37e9f9b80576b26907">More...</a><br/></td></tr> |
| <tr class="separator:ga2fbd33e3d84b4f37e9f9b80576b26907"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga0e144530d45959126018ad74bae7a6ed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga0e144530d45959126018ad74bae7a6ed">EvrRtxMemoryPoolAllocTimeout</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr> |
| <tr class="memdesc:ga0e144530d45959126018ad74bae7a6ed"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool allocation timeout (Op) <a href="#ga0e144530d45959126018ad74bae7a6ed">More...</a><br/></td></tr> |
| <tr class="separator:ga0e144530d45959126018ad74bae7a6ed"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad05246ee7e1f95e7f9496716515daeed"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gad05246ee7e1f95e7f9496716515daeed">EvrRtxMemoryPoolAllocated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr> |
| <tr class="memdesc:gad05246ee7e1f95e7f9496716515daeed"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful memory pool allocation (Op) <a href="#gad05246ee7e1f95e7f9496716515daeed">More...</a><br/></td></tr> |
| <tr class="separator:gad05246ee7e1f95e7f9496716515daeed"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf511fce5389dde6fd3277e3469c72fd9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf511fce5389dde6fd3277e3469c72fd9">EvrRtxMemoryPoolAllocFailed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr> |
| <tr class="memdesc:gaf511fce5389dde6fd3277e3469c72fd9"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful memory pool allocation (Op) <a href="#gaf511fce5389dde6fd3277e3469c72fd9">More...</a><br/></td></tr> |
| <tr class="separator:gaf511fce5389dde6fd3277e3469c72fd9"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga46bc3ef3b1ca2e4cfb914f58d0efe92e">EvrRtxMemoryPoolFree</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr> |
| <tr class="memdesc:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool free (API) <a href="#ga46bc3ef3b1ca2e4cfb914f58d0efe92e">More...</a><br/></td></tr> |
| <tr class="separator:ga46bc3ef3b1ca2e4cfb914f58d0efe92e"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga3e8e700baea20b88c3d13678fe7a7fb4">EvrRtxMemoryPoolDeallocated</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr> |
| <tr class="memdesc:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful memory pool free (Op) <a href="#ga3e8e700baea20b88c3d13678fe7a7fb4">More...</a><br/></td></tr> |
| <tr class="separator:ga3e8e700baea20b88c3d13678fe7a7fb4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gad75c377c00ae23caf7b4c3b77a0b46d1">EvrRtxMemoryPoolFreeFailed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, void *block)</td></tr> |
| <tr class="memdesc:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="mdescLeft"> </td><td class="mdescRight">Event on unsuccessful memory pool free (Op) <a href="#gad75c377c00ae23caf7b4c3b77a0b46d1">More...</a><br/></td></tr> |
| <tr class="separator:gad75c377c00ae23caf7b4c3b77a0b46d1"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaed36f26a548d40e2a3d5b81c8695f287"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaed36f26a548d40e2a3d5b81c8695f287">EvrRtxMemoryPoolGetCapacity</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t capacity)</td></tr> |
| <tr class="memdesc:gaed36f26a548d40e2a3d5b81c8695f287"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool capacity retrieve (API) <a href="#gaed36f26a548d40e2a3d5b81c8695f287">More...</a><br/></td></tr> |
| <tr class="separator:gaed36f26a548d40e2a3d5b81c8695f287"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#gaf79f0e1eb41d42566ba9023be7e442c5">EvrRtxMemoryPoolGetBlockSize</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t block_size)</td></tr> |
| <tr class="memdesc:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool block size retrieve (API) <a href="#gaf79f0e1eb41d42566ba9023be7e442c5">More...</a><br/></td></tr> |
| <tr class="separator:gaf79f0e1eb41d42566ba9023be7e442c5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga668bc3e627d9b74b6e8259a667e05846"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga668bc3e627d9b74b6e8259a667e05846">EvrRtxMemoryPoolGetCount</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t count)</td></tr> |
| <tr class="memdesc:ga668bc3e627d9b74b6e8259a667e05846"><td class="mdescLeft"> </td><td class="mdescRight">Event on used memory pool blocks retrieve (API) <a href="#ga668bc3e627d9b74b6e8259a667e05846">More...</a><br/></td></tr> |
| <tr class="separator:ga668bc3e627d9b74b6e8259a667e05846"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga4bee4e3e41bdef94046dc059f16ca7ce">EvrRtxMemoryPoolGetSpace</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id, uint32_t space)</td></tr> |
| <tr class="memdesc:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="mdescLeft"> </td><td class="mdescRight">Event on available memory pool blocks retrieve (API) <a href="#ga4bee4e3e41bdef94046dc059f16ca7ce">More...</a><br/></td></tr> |
| <tr class="separator:ga4bee4e3e41bdef94046dc059f16ca7ce"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga64ae703ad556f25b105e3eae85b582b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga64ae703ad556f25b105e3eae85b582b8">EvrRtxMemoryPoolDelete</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr> |
| <tr class="memdesc:ga64ae703ad556f25b105e3eae85b582b8"><td class="mdescLeft"> </td><td class="mdescRight">Event on memory pool delete (API) <a href="#ga64ae703ad556f25b105e3eae85b582b8">More...</a><br/></td></tr> |
| <tr class="separator:ga64ae703ad556f25b105e3eae85b582b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ga853e1867a4b65aff3f12f7be1aee5ce4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory__pool.html#ga853e1867a4b65aff3f12f7be1aee5ce4">EvrRtxMemoryPoolDestroyed</a> (<a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> mp_id)</td></tr> |
| <tr class="memdesc:ga853e1867a4b65aff3f12f7be1aee5ce4"><td class="mdescLeft"> </td><td class="mdescRight">Event on successful memory pool delete (Op) <a href="#ga853e1867a4b65aff3f12f7be1aee5ce4">More...</a><br/></td></tr> |
| <tr class="separator:ga853e1867a4b65aff3f12f7be1aee5ce4"><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="ga7e1a37b0c5dd0a97507c025ab1a62ec8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolError </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</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>MemoryPoolError</b> is generated when <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html">Memory Pool</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>mp_id</b> : memory pool ID.</li> |
| <li><b>status</b> : execution status code. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaf2fd4c91acf1379e93cd9886c515b9c5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolNew </td> |
| <td>(</td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>block_count</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>block_size</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t">osMemoryPoolAttr_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">block_count</td><td>maximum number of memory blocks in memory pool. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>memory block size in bytes. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">attr</td><td>memory pool attributes; NULL: default values.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolNew</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a> is called.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>block_count</b> : maximum number of memory blocks in memory pool.</li> |
| <li><b>block_size</b> : memory block size in bytes.</li> |
| <li><b>attr</b> : memory address of Memory Pool attributes or 0 when they are not specified.</li> |
| </ul> |
| <p>In case when <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#structosMemoryPoolAttr__t">memory pool attributes</a> are provided in the API call they are also detailed in the Event Recorder. </p> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gadad71c7b04493c03647ca0929ea087b1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolCreated </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to memory pool object name.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolCreated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a> successfully creates a memory pool object.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaeface1ee4957cdb59292e13c38a672d7"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolGetName </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">name</td><td>pointer to memory pool object name.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolGetName</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab414a1e138205a55820acfa277c8f386">osMemoryPoolGetName</a> is called and its execution result is known.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool 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="ga425c8a0e13c6fb13262d99a4dcabd507"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolAlloc </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </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>MemoryPoolAlloc</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> is called.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</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="ga2fbd33e3d84b4f37e9f9b80576b26907"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolAllocPending </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </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>MemoryPoolAllocPending</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> blocks current running thread and waits for memory block to become available.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</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="ga0e144530d45959126018ad74bae7a6ed"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolAllocTimeout </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolAllocTimeout</b> is generated when wait for memory pool to become available is aborted due to expired wait timeout.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gad05246ee7e1f95e7f9496716515daeed"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolAllocated </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>block</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolAllocated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> successfully allocates the memory block.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>block</b> : memory address of the allocated memory block. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaf511fce5389dde6fd3277e3469c72fd9"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolAllocFailed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolAllocFailed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8ead54e99ccb8f112356c88f99d38fbe">osMemoryPoolAlloc</a> fails to allocate the memory block due to out of available memory.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga46bc3ef3b1ca2e4cfb914f58d0efe92e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolFree </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>block</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block to be returned to the memory pool.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolFree</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> is called.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>block</b> : memory address of the memory block to be returned to the memory pool. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga3e8e700baea20b88c3d13678fe7a7fb4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolDeallocated </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>block</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block to be returned to the memory pool.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolDeallocated</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> successfully deallocates the memory block.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>block</b> : memory address of the memory block returned to the memory pool. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gad75c377c00ae23caf7b4c3b77a0b46d1"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolFreeFailed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">void * </td> |
| <td class="paramname"><em>block</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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block to be returned to the memory pool.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolFreeFailed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gabb4f4560daa6d1f8c8789082ee186d16">osMemoryPoolFree</a> fails to deallocate the memory block.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>block</b> : memory address of the memory block to be returned to the memory pool. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaed36f26a548d40e2a3d5b81c8695f287"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolGetCapacity </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">capacity</td><td>maximum number of memory blocks.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolGetCapacity</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gad696e94bfbe28f0b6613f9303fdf6a37">osMemoryPoolGetCapacity</a> is called and its execution result is known.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>capacity</b> : retrieved maximum number of memory blocks (0 in case of a failure). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="gaf79f0e1eb41d42566ba9023be7e442c5"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolGetBlockSize </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_id</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">uint32_t </td> |
| <td class="paramname"><em>block_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">block_size</td><td>memory block size in bytes.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolGetBlockSize</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#gab2bf059b7fa7679c3cccdaeec60b6c0e">osMemoryPoolGetBlockSize</a> is called and its execution result is known.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>block_size</b> : retrieved memory block size in bytes (0 in case of a failure). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga668bc3e627d9b74b6e8259a667e05846"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolGetCount </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">count</td><td>number of memory blocks used.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolGetCount</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga958a9449bff8c95ce213de98eef5739d">osMemoryPoolGetCount</a> is called and its execution result is known.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>count</b> : retrieved number of memory block used (0 in case of a failure). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga4bee4e3e41bdef94046dc059f16ca7ce"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolGetSpace </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>. </td></tr> |
| <tr><td class="paramdir">[in]</td><td class="paramname">space</td><td>number of memory blocks available.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolGetSpace</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga0394cffa9479a7994e3b03c79c1cb909">osMemoryPoolGetSpace</a> is called and its execution result is known.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID.</li> |
| <li><b>space</b> : retrieved number of memory blocks available (0 in case of a failure). </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga64ae703ad556f25b105e3eae85b582b8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolDelete </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolDelete</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8c39e7e5cd2b9eda907466808e59d62e">osMemoryPoolDelete</a> is called.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool ID. </li> |
| </ul> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ga853e1867a4b65aff3f12f7be1aee5ce4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void EvrRtxMemoryPoolDestroyed </td> |
| <td>(</td> |
| <td class="paramtype"><a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga2e44473caf338266f56800960294f960">osMemoryPoolId_t</a> </td> |
| <td class="paramname"><em>mp_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">mp_id</td><td>memory pool ID obtained by <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga497ced5d72dc5cd405c4c418516220dc">osMemoryPoolNew</a>.</td></tr> |
| </table> |
| </dd> |
| </dl> |
| <p>The event <b>MemoryPoolDestroyed</b> is generated when the function <a class="el" href="group__CMSIS__RTOS__PoolMgmt.html#ga8c39e7e5cd2b9eda907466808e59d62e">osMemoryPoolDelete</a> successfully deletes the memory pool object.</p> |
| <p><b>Value</b> in the Event Recorder shows:</p> |
| <ul> |
| <li><b>mp_id</b> : memory pool 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> |