<!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 Functions</title>
<title>CMSIS-RTOS2: Memory 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
   &#160;<span id="projectnumber">Version 2.1.0</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&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Usage&#160;and&#160;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.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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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 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 memory 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:ga15078f1251744140d90761e05c0fe1f2"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga15078f1251744140d90761e05c0fe1f2">EvrRtxMemoryInit</a> (void *mem, uint32_t size, uint32_t result)</td></tr>
<tr class="memdesc:ga15078f1251744140d90761e05c0fe1f2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory initialization (Op)  <a href="#ga15078f1251744140d90761e05c0fe1f2">More...</a><br/></td></tr>
<tr class="separator:ga15078f1251744140d90761e05c0fe1f2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae1818917a5e085f92a03039ffaf2bad4"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#gae1818917a5e085f92a03039ffaf2bad4">EvrRtxMemoryAlloc</a> (void *mem, uint32_t size, uint32_t type, void *block)</td></tr>
<tr class="memdesc:gae1818917a5e085f92a03039ffaf2bad4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory allocate (Op)  <a href="#gae1818917a5e085f92a03039ffaf2bad4">More...</a><br/></td></tr>
<tr class="separator:gae1818917a5e085f92a03039ffaf2bad4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga9227b18f5ea44d7caa8fadd4d539af9c">EvrRtxMemoryFree</a> (void *mem, void *block, uint32_t result)</td></tr>
<tr class="memdesc:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory free (Op)  <a href="#ga9227b18f5ea44d7caa8fadd4d539af9c">More...</a><br/></td></tr>
<tr class="separator:ga9227b18f5ea44d7caa8fadd4d539af9c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#gac71421bbf537f2f8c9255f9f51cf7d54">EvrRtxMemoryBlockInit</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, uint32_t block_count, uint32_t block_size, void *block_mem)</td></tr>
<tr class="memdesc:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block initialization (Op)  <a href="#gac71421bbf537f2f8c9255f9f51cf7d54">More...</a><br/></td></tr>
<tr class="separator:gac71421bbf537f2f8c9255f9f51cf7d54"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga71c0df6f932436b54d7d641a440586db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga71c0df6f932436b54d7d641a440586db">EvrRtxMemoryBlockAlloc</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, void *block)</td></tr>
<tr class="memdesc:ga71c0df6f932436b54d7d641a440586db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block alloc (Op)  <a href="#ga71c0df6f932436b54d7d641a440586db">More...</a><br/></td></tr>
<tr class="separator:ga71c0df6f932436b54d7d641a440586db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga69c2139620def7c5e59f6b1249857949"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__rtx__evr__memory.html#ga69c2139620def7c5e59f6b1249857949">EvrRtxMemoryBlockFree</a> (<a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *mp_info, void *block, int32_t status)</td></tr>
<tr class="memdesc:ga69c2139620def7c5e59f6b1249857949"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event on memory block free (Op)  <a href="#ga69c2139620def7c5e59f6b1249857949">More...</a><br/></td></tr>
<tr class="separator:ga69c2139620def7c5e59f6b1249857949"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga15078f1251744140d90761e05c0fe1f2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryInit </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>mem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>result</em>&#160;</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">mem</td><td>pointer to memory pool. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>size of a memory pool in bytes. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>execution status: 1 - success, 0 - failure.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryInit</b> is generated when initialization of a variable size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mem</b> : memory address of memory pool.</li>
<li><b>size</b> : size of a memory pool in bytes.</li>
<li><b>result</b> : execution status: 1 - success, 0 - failure. </li>
</ul>

</div>
</div>
<a class="anchor" id="gae1818917a5e085f92a03039ffaf2bad4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryAlloc </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>mem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>type</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>block</em>&#160;</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">mem</td><td>pointer to memory pool. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">size</td><td>size of a memory block in bytes. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>memory block type: 0 - generic, 1 - control block </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>pointer to allocated memory block or NULL in case of no memory is available.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryAlloc</b> is generated when allocation of a variable size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mem</b> : memory address of memory pool.</li>
<li><b>size</b> : size of a memory block in bytes.</li>
<li><b>type</b> : memory block type: 0 - generic, 1 - control block</li>
<li><b>block</b> : memory address of allocated memory block or 0 in case of no memory is available. </li>
</ul>

</div>
</div>
<a class="anchor" id="ga9227b18f5ea44d7caa8fadd4d539af9c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryFree </td>
          <td>(</td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>mem</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>block</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>result</em>&#160;</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">mem</td><td>pointer to memory pool. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>memory block to be returned to the memory pool. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">result</td><td>execution status: 1 - success, 0 - failure.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryFree</b> is generated when deallocation of a variable size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mem</b> : memory address of memory pool.</li>
<li><b>block</b> : memory address of block to be returned to the memory pool.</li>
<li><b>result</b> : execution status: 1 - success, 0 - failure. </li>
</ul>

</div>
</div>
<a class="anchor" id="gac71421bbf537f2f8c9255f9f51cf7d54"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryBlockInit </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
          <td class="paramname"><em>mp_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>block_count</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">uint32_t&#160;</td>
          <td class="paramname"><em>block_size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>block_mem</em>&#160;</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_info</td><td>memory pool info. </td></tr>
    <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>size of a memory block in bytes. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">block_mem</td><td>pointer to memory for block storage.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryBlockInit</b> is generated when initialization of a fixed size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mp_info</b> : memory address of memory pool info.</li>
<li><b>block_count</b> : maximum number of memory blocks in memory pool.</li>
<li><b>block_size</b> : size of a memory block in bytes.</li>
<li><b>block_mem</b> : memory address of memory for block storage. </li>
</ul>

</div>
</div>
<a class="anchor" id="ga71c0df6f932436b54d7d641a440586db"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryBlockAlloc </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
          <td class="paramname"><em>mp_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>block</em>&#160;</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_info</td><td>memory pool info. </td></tr>
    <tr><td class="paramdir">[in]</td><td class="paramname">block</td><td>address of the allocated memory block or NULL in case of no memory is available.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryBlockAlloc</b> is generated when allocation of a fixed size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mp_info</b> : memory address of memory pool info.</li>
<li><b>block</b> : memory address of the allocated memory block or 0 in case of no memory is available. </li>
</ul>

</div>
</div>
<a class="anchor" id="ga69c2139620def7c5e59f6b1249857949"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void EvrRtxMemoryBlockFree </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="rtx__os_8h.html#structosRtxMpInfo__t">osRtxMpInfo_t</a> *&#160;</td>
          <td class="paramname"><em>mp_info</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">void *&#160;</td>
          <td class="paramname"><em>block</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int32_t&#160;</td>
          <td class="paramname"><em>status</em>&#160;</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_info</td><td>memory pool info. </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>
    <tr><td class="paramdir">[in]</td><td class="paramname">status</td><td>extended execution status.</td></tr>
  </table>
  </dd>
</dl>
<p>The event <b>MemoryBlockFree</b> is generated when deallocation of a fixed size memory block completes.</p>
<p><b>Value</b> in the Event Recorder shows:</p>
<ul>
<li><b>mp_info</b> : memory address of memory pool info.</li>
<li><b>block</b> : memory address of the allocated memory block to be returned to the memory pool.</li>
<li><b>status</b> : execution status <a class="el" href="group__CMSIS__RTOS__Definitions.html#ga6c0dbe6069e4e7f47bb4cd32ae2b813e">osStatus_t</a> </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 Feb 8 2017 10:21:04 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>