[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / sdo / ipc / heaps / HeapMemMP.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/heaps/HeapMemMP.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/heaps/HeapMemMP.html
+++ /dev/null
@@ -1,1451 +0,0 @@
-<html>
-<head>
-<title>module ti.sdo.ipc.heaps.HeapMemMP</title>
-<meta name="description" content="Multi-processor variable size buffer heap implementation">
-<link rel="stylesheet" type="text/css" href="../../../../xdoc.css" />
-</head>
-<body><div id="xdocWrapper"><div id="xdocContent">
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.sdo.ipc.heaps.</span><span class="xdoc-id">HeapMemMP</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapBufMP.html" title="module HeapBufMP"><img class="xdocHdrArrow" src="../../../../Arrow_left.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/package.html" title="package ti.sdo.ipc.heaps"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMultiBufMP.html" title="module HeapMultiBufMP"><img class="xdocHdrArrow" src="../../../../Arrow_right.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html">index URL</a></div>
-<p class="xdocHdrSummary">Multi-processor variable size buffer heap implementation</p>
-<ul class="xdocToc">
-<li class="xdocToc"><a class="xdocToc" href="#targ-synop">C synopsis</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocElems">Individual elements</a></li>
-<li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
-<li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
-</ul>
-<div class="xdocBrief">
-This module has a common header that can be found in the <a class="xdoc-link" href="../../../../ti/ipc/package.html" title="ti.ipc">ti.ipc</a>
- package. Application code should include the common header file (not the
- RTSC-generated one):
-
- <PRE>#include <ti/ipc/HeapMemMP.h></PRE>
-
- The RTSC module must be used in the application's RTSC configuration file
- (.cfg) if runtime APIs will be used in the application:
-
- <PRE>HeapMemMP = xdc.useModule('ti.sdo.ipc.heaps.HeapMemMP');</PRE>
-
- Documentation for all runtime APIs, instance configuration parameters,
- error codes macros and type definitions available to the application
- integrator can be found in the
- <A HREF="../../../../../doxygen/html/files.html">Doxygen documenation</A>
- for the IPC product. However, the documentation presented on this page
- should be referred to for information specific to the RTSC module, such as
- module configuration, Errors, and Asserts.
-</div>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2">C</span></tt> synopsis</td>
-<td class="xdocLabelCenter">target-domain</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP-src.html"><span class="xdocLabelFile">ti/sdo/ipc/heaps/HeapMemMP.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynT">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw3">#include</span> <span class="xdoc-id"><ti/sdo/ipc/heaps/HeapMemMP.h></span>
-</div>
-<table cellspacing="0" cellpadding="0" border="0">
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Functions</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">HeapMemMP_construct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize a new instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *structP, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_creation"><span class="xdoc-id">HeapMemMP_create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Allocate and initialize a new instance object and return its handle</span></span></a>(<span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_deletion"><span class="xdoc-id">HeapMemMP_delete</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> *handleP);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_deletion"><span class="xdoc-id">HeapMemMP_destruct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Finalize the instance object inside the provided structure</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *structP);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">HeapMemMP_Params_init</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Initialize this config-params structure with supplier-specified defaults before instance creation</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params);</div></td></tr>
-<tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all IHeap modules</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Ptr</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#alloc"><span class="xdoc-id">HeapMemMP_alloc</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Allocates a block of memory from the heap</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">size</span>, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">align</span>, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *<span class="xdoc-id">eb</span>);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#free"><span class="xdoc-id">HeapMemMP_free</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Free a block of memory back to the heap</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">block</span>, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">size</span>);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Void</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#get.Stats"><span class="xdoc-id">HeapMemMP_getStats</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Retrieve the statistics from the heap</span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#.Stats" title="xdc.runtime.Memory.Stats">Memory_Stats</a> *<span class="xdoc-id">stats</span>);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Bool</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#is.Blocking"><span class="xdoc-id">HeapMemMP_isBlocking</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns whether the heap may block during an <tt><span class="xdoc-link" href="HeapMemMP.html#alloc" title="alloc">alloc()</span></tt> or
- <tt><span class="xdoc-link" href="HeapMemMP.html#free" title="free">free()</span></tt></span></span></a>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);</div></td></tr>
-<tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target instances</div></td></tr>
-
-<tr>
-<td></td>
-<td>
-<div class="xdocSynTblPack">
-<a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">HeapMemMP_handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance structure pointer into an instance handle</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">HeapMemMP_Handle_downCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// conditionally move one level down the inheritance hierarchy; NULL upon failure</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Handle_label</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The label associated with this instance object</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Handle_name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The name of this instance object</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_convertors"><span class="xdoc-id">HeapMemMP_Handle_upCast</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// unconditionally move one level up the inheritance hierarchy</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Object_count</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The number of statically-created instance objects</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Object_first</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the first dynamically-created instance object, or NULL</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Object_get</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the i-th statically-created instance object (array == NULL)</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Object_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap used to allocate dynamically-created instance objects</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_built-ins"><span class="xdoc-id">HeapMemMP_Object_next</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The handle of the next dynamically-created instance object, or NULL</span></span></a>,
-<a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">HeapMemMP_struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Convert this instance handle into an instance structure pointer</span></span></a>
-</div>
-</td>
-</tr>
-<tr><td class="xdocSynFxnCat" colspan="2"><div class="xdocSynFxnCat">Functions common to all target modules</div></td></tr>
-
-<tr>
-<td></td>
-<td>
-<div class="xdocSynTblPack">
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_getMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Returns the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_hasMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test whether this module has a diagnostics mask</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_heap</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// The heap from which this module allocates memory</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_id</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get this module's unique id</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_setMask</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Set the diagnostics mask for this module</span></span></a>,
-<a class="xdocSynGo" href="#module-wide_built-ins"><span class="xdoc-id">HeapMemMP_Module_startupDone</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Test if this module has completed startup</span></span></a>
-</div>
-</td>
-</tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Typedefs</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.Extended.Stats"><span class="xdoc-id">HeapMemMP_ExtendedStats</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Stats structure for the getExtendedStats API</span></span></a> ...</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Object">HeapMemMP_Object</a> *</div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">HeapMemMP_Handle</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Client reference to an instance object</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">HeapMemMP_Object</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque internal representation of an instance object</span></span></a> <span class="xdoc-id">HeapMemMP_Object</span>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_config_parameters"><span class="xdoc-id">HeapMemMP_Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params structure</span></span></a> ...</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#per-instance_object_types"><span class="xdoc-id">HeapMemMP_Struct</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Opaque client structure large enough to hold an instance object</span></span></a> <span class="xdoc-id">HeapMemMP_Struct</span>;</div></td></tr>
-<tr><td colspan='2'><div class='xdocSynTblHdr'>Constants</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_align"><span class="xdoc-id">HeapMemMP_A_align</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the requested alignment is not a power of 2</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_heap.Size"><span class="xdoc-id">HeapMemMP_A_heapSize</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the requested heap size is too small</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_invalid.Free"><span class="xdoc-id">HeapMemMP_A_invalidFree</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the free detects that an invalid addr or size</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.A_zero.Block"><span class="xdoc-id">HeapMemMP_A_zeroBlock</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when a block of size 0 is requested</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Id" title="xdc.runtime.Error.Id">Error_Id</a> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#.E_memory"><span class="xdoc-id">HeapMemMP_E_memory</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Raised when requested size exceeds largest free block</span></span></a>;</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#max.Name.Len"><span class="xdoc-id">HeapMemMP_maxNameLen</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum length for heap names</span></span></a>;</div></td></tr>
-</table>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".Extended.Stats"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">ExtendedStats</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.Extended.Stats">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Stats structure for the getExtendedStats API</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP_ExtendedStats</span> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id"><span class="xdoc-id">buf</span></span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id"><span class="xdoc-id">size</span></span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>} <span class="xdoc-id">HeapMemMP_ExtendedStats</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">FIELDS</div>
-<div class="xdocChild"><span class="xdocChildId">buf</span>
-<span class="xdocChildSum">— Local address of the shared buffer
- This may be different from the original buf
- parameter due to alignment requirements.</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">size</span>
-<span class="xdocChildSum">— Size of the shared buffer.
- This may be different from the original size
- parameter due to alignment requirements.</span>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_align"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">A_align</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_align">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the requested alignment is not a power of 2</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">HeapMemMP_A_align</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_heap.Size"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">A_heapSize</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_heap.Size">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the requested heap size is too small</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">HeapMemMP_A_heapSize</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_invalid.Free"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">A_invalidFree</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_invalid.Free">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the free detects that an invalid addr or size</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">HeapMemMP_A_invalidFree</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This could arise when multiple frees are done on the same buffer or
- if corruption occurred.</div>
-<div class="xdocText">This also could occur when an alloc is made with size N and the
- free for this buffer specifies size M where M > N. Note: not every
- case is detectable.</div>
-<div class="xdocText">This assert can also be caused when passing an invalid addr to free
- or if the size is causing the end of the buffer to be
- out of the expected range.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".A_zero.Block"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">A_zeroBlock</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_zero.Block">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when a block of size 0 is requested</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Id" title="xdc.runtime.Assert.Id">Assert_Id</a> <span class="xdoc-id">HeapMemMP_A_zeroBlock</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id=".E_memory"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">E_memory</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.E_memory">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Raised when requested size exceeds largest free block</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Id" title="xdc.runtime.Error.Id">Error_Id</a> <span class="xdoc-id">HeapMemMP_E_memory</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="max.Name.Len"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">maxNameLen</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#max.Name.Len">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Maximum length for heap names</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">extern const</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">HeapMemMP_maxNameLen</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="module-wide_built-ins"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Module-Wide Built-Ins</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#module-wide_built-ins">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Module.Id" title="xdc.runtime.Types.ModuleId">Types_ModuleId</a> <span class="xdoc-id">HeapMemMP_Module_id</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Get this module's unique id</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">HeapMemMP_Module_startupDone</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test if this module has completed startup</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">HeapMemMP_Module_heap</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The heap from which this module allocates memory</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">HeapMemMP_Module_hasMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Test whether this module has a diagnostics mask</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">HeapMemMP_Module_getMask</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Returns the diagnostics mask for this module</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_Module_setMask</span>(<span class="xdoc-kw2">Bits16</span> <span class="xdoc-id">mask</span>);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Set the diagnostics mask for this module</div>
-</div>
-<a class="xdocAnchor" id="per-instance_object_types"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Object Types</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP_Object</span> <span class="xdoc-id">HeapMemMP_Object</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Opaque internal representation of an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Object">HeapMemMP_Object</a> *<span class="xdoc-id">HeapMemMP_Handle</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Client reference to an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP_Struct</span> <span class="xdoc-id">HeapMemMP_Struct</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Opaque client structure large enough to hold an instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_handle</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *structP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance structure pointer into an instance handle</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *<span class="xdoc-id">HeapMemMP_struct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Convert this instance handle into an instance structure pointer</div>
-</div>
-<a class="xdocAnchor" id="per-instance_config_parameters"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">typedef</span> <span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP_Params</span> {
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params structure</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><a class="xdoc-link" href="../../../../xdc/runtime/IInstance.html#per-instance_config_parameters" title="xdc.runtime.IInstance.Params">IInstance_Params</a> *instance;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Common per-instance configs</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP_Handle</a> <span class="xdoc-id">gate</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// GateMP used for critical region management of the shared memory</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Name of this instance</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">regionId</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Shared region ID</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">sharedBufSize</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Size of <a class="xdoc-link" href="HeapMemMP.html#shared.Buf" title="sharedBuf">sharedBuf</a></div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>} <span class="xdoc-id">HeapMemMP_Params</span>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_Params_init</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Initialize this config-params structure with supplier-specified defaults before instance creation</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="gate"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_Params.</span><span class="xdoc-id">gate</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#gate">index URL</a></div>
-<p class="xdocHdrSummaryDcl">GateMP used for critical region management of the shared memory</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP_Handle</a> <span class="xdoc-id">gate</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">Using the default value of NULL will result in use of the GateMP
- system gate for context protection.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="name"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_Params.</span><span class="xdoc-id">name</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#name">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Name of this instance</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">name</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The name (if not NULL) must be unique among all HeapMemMP
- instances in the entire system. When creating a new
- heap, it is necessary to supply an instance name.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="region.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_Params.</span><span class="xdoc-id">regionId</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#region.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Shared region ID</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">regionId</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The index corresponding to the shared region from which shared memory
- will be allocated.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="shared.Buf.Size"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP_Params.</span><span class="xdoc-id">sharedBufSize</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#shared.Buf.Size">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Size of <a class="xdoc-link" href="HeapMemMP.html#shared.Buf" title="sharedBuf">sharedBuf</a></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">struct</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">sharedBufSize</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This is the size of the buffer to be used in the HeapMemMP instance.
- The actual buffer size in the created instance might actually be less
- than the value supplied in 'sharedBufSize' because of alignment
- constraints.</div>
-<div class="xdocText">It is important to note that the total amount of shared memory required
- for a HeapMemMP instance will be greater than the size supplied here.
- Additional space will be consumed by shared instance attributes and
- alignment-related padding. Use the <a class="xdoc-link" href="HeapMemMP.html#shared.Mem.Req" title="sharedMemReq">sharedMemReq</a> or the
- <a class="xdoc-link" href="HeapMemMP.html#shared.Mem.Req.Meta" title="sharedMemReqMeta">sharedMemReqMeta</a> call to determine the exact amount of shared
- memory required for an instance for a given sharedBufSize and cache
- settings.</div>
-<a class="xdocAnchor" id="per-instance_creation"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Runtime Instance Creation</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_creation">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_create</span>(<span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Allocate and initialize a new instance object and return its handle</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_construct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *structP, <span class="xdoc-kw1">const</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">HeapMemMP_Params</a> *params, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *eb);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Initialize a new instance object inside the provided structure</div>
-</div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">params</span>
-<span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">eb</span>
-<span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">See specific <tt>IHeap</tt> implementation for parameters used.</div>
-<a class="xdocAnchor" id="per-instance_deletion"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Deletion</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_deletion">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_delete</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> *handleP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Finalize and free this previously allocated instance object, setting the referenced handle to NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_destruct</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Struct">HeapMemMP_Struct</a> *structP);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Finalize the instance object inside the provided structure</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="alloc"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">alloc</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#alloc">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Allocates a block of memory from the heap</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">HeapMemMP_alloc</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">size</span>, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">align</span>, <a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Block" title="xdc.runtime.Error.Block">Error_Block</a> *<span class="xdoc-id">eb</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">handle</span>
-<span class="xdocChildSum">— handle of a previously-created <tt>HeapMemMP</tt> instance object</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">size</span>
-<span class="xdocChildSum">— size (in MADUs) of the block</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">align</span>
-<span class="xdocChildSum">— alignment (in MADUs) of the block</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">eb</span>
-<span class="xdocChildSum">— pointer to error block</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This method returns a block of memory from the heap.
- It is called by the <tt><a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#alloc" title="xdc.runtime.Memory.alloc">xdc.runtime.Memory.alloc()</a></tt> function.</div>
-<span id="xdoc-sect-3"></span>
-<div class="xdocSect">RETURNS</div>
-<div class="xdocText">Returns the address of the allocated memory.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="free"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">free</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#free">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Free a block of memory back to the heap</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_free</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">block</span>, <span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">size</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">handle</span>
-<span class="xdocChildSum">— handle of a previously-created <tt>HeapMemMP</tt> instance object</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">block</span>
-<span class="xdocChildSum">— non-<tt>NULL</tt> address of allocated block to free</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">size</span>
-<span class="xdocChildSum">— size (in MADUs) of the block of memory to free</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This method gives back a block of memory to a heap.
- It is called by the <tt><a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#free" title="xdc.runtime.Memory.free">xdc.runtime.Memory.free()</a></tt> function.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="get.Stats"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">getStats</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#get.Stats">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Retrieve the statistics from the heap</p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Void</span> <span class="xdoc-id">HeapMemMP_getStats</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#.Stats" title="xdc.runtime.Memory.Stats">Memory_Stats</a> *<span class="xdoc-id">stats</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">handle</span>
-<span class="xdocChildSum">— handle of a previously-created <tt>HeapMemMP</tt> instance object</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">stats</span>
-<span class="xdocChildSum">— non-<tt>NULL</tt> pointer to an output buffer</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The caller passes in a pointer to a <tt><a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#.Stats" title="xdc.runtime.Memory.Stats">xdc.runtime.Memory.Stats</a></tt>
- structure and <tt>getStats</tt> fills in this structure.</div>
-<div class="xdocText">This function is called by the <tt><a class="xdoc-link" href="../../../../xdc/runtime/Memory.html#get.Stats" title="xdc.runtime.Memory.getStats">xdc.runtime.Memory.getStats()</a></tt>
- function.</div>
-<div class="xdocText">The returned totalSize reflects the usable size of the buffer, not
- necessarily the size specified during create.</div>
-<span id="xdoc-sect-3"></span>
-<div class="xdocSect">HEAPMEMMP</div>
-<div class="xdocText">getStats() will lock the heap using the HeapMemMP Gate while it retrieves
- the HeapMemMP's statistics.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="is.Blocking"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">HeapMemMP_</span><span class="xdoc-id">isBlocking</span>() <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#is.Blocking">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Returns whether the heap may block during an <tt><a class="xdoc-link" href="HeapMemMP.html#alloc" title="alloc">alloc()</a></tt> or
- <tt><a class="xdoc-link" href="HeapMemMP.html#free" title="free">free()</a></tt></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">HeapMemMP_isBlocking</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">handle</span>
-<span class="xdocChildSum">— handle of a previously-created <tt>HeapMemMP</tt> instance object</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">RETURNS</div>
-<div class="xdocText">If the heap might block, <tt>TRUE</tt> is returned.
- If the heap does not block, <tt>FALSE</tt> is returned.</div>
-<a class="xdocAnchor" id="per-instance_convertors"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Convertors</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_convertors">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">HeapMemMP_Handle_upCast</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// unconditionally move one level up the inheritance hierarchy</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_Handle_downCast</span>(<a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// conditionally move one level down the inheritance hierarchy; NULL upon failure</div>
-</div>
-<a class="xdocAnchor" id="per-instance_built-ins"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Built-Ins</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_built-ins">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='targ-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-targ2dcl">C</span></tt> synopsis</td>
-<td class="xdocLabelRight">target-domain</td>
-</tr></table>
-<div class="xdocSynTdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">HeapMemMP_Object_count</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The number of statically-created instance objects</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_Object_get</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Object">HeapMemMP_Object</a> *array, <span class="xdoc-kw2">Int</span> i);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the i-th statically-created instance object (array == NULL)</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_Object_first</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the first dynamically-created instance object, or NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> <span class="xdoc-id">HeapMemMP_Object_next</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The handle of the next dynamically-created instance object, or NULL</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/IHeap.html#per-instance_object_types" title="xdc.runtime.IHeap.Handle">IHeap_Handle</a> <span class="xdoc-id">HeapMemMP_Object_heap</span>();
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The heap used to allocate dynamically-created instance objects</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *<span class="xdoc-id">HeapMemMP_Handle_label</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle, <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Label" title="xdc.runtime.Types.Label">Types_Label</a> *buf);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The label associated with this instance object</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">String</span> <span class="xdoc-id">HeapMemMP_Handle_name</span>(<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_object_types" title="ti.sdo.ipc.heaps.HeapMemMP.Handle">HeapMemMP_Handle</a> handle);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// The name of this instance object</div>
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP-src.html"><span class="xdocLabelFile">ti/sdo/ipc/heaps/HeapMemMP.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynM">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">var</span> HeapMemMP = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.sdo.ipc.heaps.HeapMemMP'</span>);
-</div>
-<div class='xdocSynHdr'>module-wide constants & types</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> <a class="xdocSynGo" href="#meta.Extended.Stats">HeapMemMP.<span class="xdoc-id">ExtendedStats</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Stats structure for the getExtendedStats API</span></span></a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Extended.Stats" title="ti.sdo.ipc.heaps.HeapMemMP.ExtendedStats"><span class="xdoc-id">buf</span></a> = <i><span class="xdoc-kw2">Ptr</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt><i>obj</i>.<a class="xdocSynGo" href="#meta.Extended.Stats" title="ti.sdo.ipc.heaps.HeapMemMP.ExtendedStats"><span class="xdoc-id">size</span></a> = <i><span class="xdoc-kw2">SizeT</span></i><b> ...</b>
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_align">HeapMemMP.<span class="xdoc-id">A_align</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the requested alignment is not a power of 2</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "A_align: Requested align is not a power of 2"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_heap.Size">HeapMemMP.<span class="xdoc-id">A_heapSize</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the requested heap size is too small</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "A_heapSize: Requested heap size is too small"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_invalid.Free">HeapMemMP.<span class="xdoc-id">A_invalidFree</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when the free detects that an invalid addr or size</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "A_invalidFree: Invalid free"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.A_zero.Block">HeapMemMP.<span class="xdoc-id">A_zeroBlock</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Assert raised when a block of size 0 is requested</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "A_zeroBlock: Cannot allocate size 0"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#meta.E_memory">HeapMemMP.<span class="xdoc-id">E_memory</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Raised when requested size exceeds largest free block</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Desc" title="xdc.runtime.Error.Desc">Error.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>msg: "E_memory: Out of memory: handle=0x%x, size=%u"
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt>};
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#metamax.Name.Len">HeapMemMP.<span class="xdoc-id">maxNameLen</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum length for heap names</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 32;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">HeapMemMP.<span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#max.Runtime.Entries">HeapMemMP.<span class="xdoc-id">maxRuntimeEntries</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Maximum runtime entries</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../../ti/sdo/utils/NameServer.html#.A.L.L.O.W.G.R.O.W.T.H" title="ti.sdo.utils.NameServer.ALLOWGROWTH">NameServer.ALLOWGROWTH</a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#table.Section">HeapMemMP.<span class="xdoc-id">tableSection</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Section name is used to place the names table</span></span></a> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
-</div>
-<div class='xdocSynHdr'>per-instance config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<a class="xdocSynGo" href="#metaper-instance_config_parameters"><span class="xdoc-id">Params</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Instance config-params object</span></span></a>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metagate"><span class="xdoc-id">gate</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// GateMP used for critical region management of the shared memory</span></span></a> = <i><a class="xdoc-link" href="../../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaname"><span class="xdoc-id">name</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Name of this instance</span></span></a> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metaregion.Id"><span class="xdoc-id">regionId</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Shared region ID</span></span></a> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
-</div>
-<div class="xdocSynCode">
-<tt> </tt><tt> </tt>params.<a class="xdocSynGo" href="#metashared.Buf.Size"><span class="xdoc-id">sharedBufSize</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Size of <span class="xdoc-link" href="HeapMemMP.html#shared.Buf" title="sharedBuf">sharedBuf</span></span></span></a> = <i><span class="xdoc-kw2">SizeT</span></i> 0;
-</div>
-<div class='xdocSynHdr'>per-instance creation</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">var</span> inst = HeapMemMP.<a class="xdocSynGo" href="#metaper-instance_creation"><span class="xdoc-id">create</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Create an instance-object</span></span></a>(params);
-</div>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocMetaElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.Extended.Stats"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">struct</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">ExtendedStats</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.Extended.Stats">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Stats structure for the getExtendedStats API</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> <i>obj</i> = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">ExtendedStats</span>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">buf</span> = <i><span class="xdoc-kw2">Ptr</span></i><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt><i>obj</i>.<span class="xdoc-id">size</span> = <i><span class="xdoc-kw2">SizeT</span></i><b> ...</b>
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">FIELDS</div>
-<div class="xdocChild"><span class="xdocChildId">buf</span>
-<span class="xdocChildSum">— Local address of the shared buffer
- This may be different from the original buf
- parameter due to alignment requirements.</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">size</span>
-<span class="xdocChildSum">— Size of the shared buffer.
- This may be different from the original size
- parameter due to alignment requirements.</span>
-</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.Extended.Stats" title="HeapMemMP_ExtendedStats">HeapMemMP_ExtendedStats</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_align"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">A_align</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_align">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the requested alignment is not a power of 2</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">A_align</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "A_align: Requested align is not a power of 2"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_align" title="HeapMemMP_A_align">HeapMemMP_A_align</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_heap.Size"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">A_heapSize</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_heap.Size">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the requested heap size is too small</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">A_heapSize</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "A_heapSize: Requested heap size is too small"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_heap.Size" title="HeapMemMP_A_heapSize">HeapMemMP_A_heapSize</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_invalid.Free"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">A_invalidFree</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_invalid.Free">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when the free detects that an invalid addr or size</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">A_invalidFree</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "A_invalidFree: Invalid free"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This could arise when multiple frees are done on the same buffer or
- if corruption occurred.</div>
-<div class="xdocText">This also could occur when an alloc is made with size N and the
- free for this buffer specifies size M where M > N. Note: not every
- case is detectable.</div>
-<div class="xdocText">This assert can also be caused when passing an invalid addr to free
- or if the size is causing the end of the buffer to be
- out of the expected range.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_invalid.Free" title="HeapMemMP_A_invalidFree">HeapMemMP_A_invalidFree</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.A_zero.Block"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">A_zeroBlock</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.A_zero.Block">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Assert raised when a block of size 0 is requested</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">A_zeroBlock</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Assert.html#.Desc" title="xdc.runtime.Assert.Desc">Assert.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "A_zeroBlock: Cannot allocate size 0"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.A_zero.Block" title="HeapMemMP_A_zeroBlock">HeapMemMP_A_zeroBlock</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="meta.E_memory"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">E_memory</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#.E_memory">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Raised when requested size exceeds largest free block</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">E_memory</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Error.html#.Desc" title="xdc.runtime.Error.Desc">Error.Desc</a></i> {
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>msg: "E_memory: Out of memory: handle=0x%x, size=%u"
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>};
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#.E_memory" title="HeapMemMP_E_memory">HeapMemMP_E_memory</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metamax.Name.Len"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">maxNameLen</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#max.Name.Len">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Maximum length for heap names</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">maxNameLen</span> = <i><span class="xdoc-kw2">UInt</span></i> 32;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#max.Name.Len" title="HeapMemMP_maxNameLen">HeapMemMP_maxNameLen</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="common$"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#common$">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">common$</span> = <i><a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a></i> <span class="xdoc-kw2">undefined</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">All modules have this configuration parameter. Its name
- contains the '$' character to ensure it does not conflict with
- configuration parameters declared by the module. This allows
- new configuration parameters to be added in the future without
- any chance of breaking existing modules.</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="max.Runtime.Entries"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">maxRuntimeEntries</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#max.Runtime.Entries">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Maximum runtime entries</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">maxRuntimeEntries</span> = <i><span class="xdoc-kw2">UInt</span></i> <a class="xdoc-link" href="../../../../ti/sdo/utils/NameServer.html#.A.L.L.O.W.G.R.O.W.T.H" title="ti.sdo.utils.NameServer.ALLOWGROWTH">NameServer.ALLOWGROWTH</a>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">Maximum number of HeapMemMP's that can be dynamically created and
- added to the NameServer.</div>
-<div class="xdocText">To minimize the amount of runtime allocation, this parameter allows
- the pre-allocation of memory for the HeapMemMP's NameServer table.
- The default is to allow growth (i.e. memory allocation when
- creating a new instance).</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="table.Section"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.</span><span class="xdoc-id">tableSection</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#table.Section">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Section name is used to place the names table</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt>HeapMemMP.<span class="xdoc-id">tableSection</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The default value of NULL implies that no explicit placement is
- performed.</div>
-<a class="xdocAnchor" id="metaper-instance_config_parameters"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Instance Config Parameters</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_config_parameters">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">Params</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Instance config-params object</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>params.<span class="xdoc-id">gate</span> = <i><a class="xdoc-link" href="../../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// GateMP used for critical region management of the shared memory</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>params.<span class="xdoc-id">name</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Name of this instance</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>params.<span class="xdoc-id">regionId</span> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Shared region ID</div>
-<div class="xdocSynCode">
-<tt></tt><tt> </tt>params.<span class="xdoc-id">sharedBufSize</span> = <i><span class="xdoc-kw2">SizeT</span></i> 0;
-</div>
-<div class='xdocSynSum'><tt></tt><tt> </tt>// Size of <a class="xdoc-link" href="HeapMemMP.html#shared.Buf" title="sharedBuf">sharedBuf</a></div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metagate"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.Params.</span><span class="xdoc-id">gate</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#gate">index URL</a></div>
-<p class="xdocHdrSummaryDcl">GateMP used for critical region management of the shared memory</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">Params</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<span class="xdoc-id">gate</span> = <i><a class="xdoc-link" href="../../../../ti/sdo/ipc/GateMP.html#per-instance_object_types" title="ti.sdo.ipc.GateMP.Handle">GateMP.Handle</a></i> <span class="xdoc-kw2">null</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">Using the default value of NULL will result in use of the GateMP
- system gate for context protection.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#gate" title="HeapMemMP_Params.gate">HeapMemMP_Params.gate</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metaname"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.Params.</span><span class="xdoc-id">name</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#name">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Name of this instance</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">Params</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<span class="xdoc-id">name</span> = <i><span class="xdoc-kw2">String</span></i> <span class="xdoc-kw2">null</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The name (if not NULL) must be unique among all HeapMemMP
- instances in the entire system. When creating a new
- heap, it is necessary to supply an instance name.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#name" title="HeapMemMP_Params.name">HeapMemMP_Params.name</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metaregion.Id"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.Params.</span><span class="xdoc-id">regionId</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#region.Id">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Shared region ID</p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">Params</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<span class="xdoc-id">regionId</span> = <i><span class="xdoc-kw2">UInt16</span></i> 0;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">The index corresponding to the shared region from which shared memory
- will be allocated.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#region.Id" title="HeapMemMP_Params.regionId">HeapMemMP_Params.regionId</a></div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metashared.Buf.Size"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">HeapMemMP.Params.</span><span class="xdoc-id">sharedBufSize</span> <small><span class="xdocSynSum">// instance</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#shared.Buf.Size">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Size of <a class="xdoc-link" href="HeapMemMP.html#shared.Buf" title="sharedBuf">sharedBuf</a></p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<span class="xdoc-id">Params</span>;
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><b> ...</b>
-</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<span class="xdoc-id">sharedBufSize</span> = <i><span class="xdoc-kw2">SizeT</span></i> 0;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">This is the size of the buffer to be used in the HeapMemMP instance.
- The actual buffer size in the created instance might actually be less
- than the value supplied in 'sharedBufSize' because of alignment
- constraints.</div>
-<div class="xdocText">It is important to note that the total amount of shared memory required
- for a HeapMemMP instance will be greater than the size supplied here.
- Additional space will be consumed by shared instance attributes and
- alignment-related padding. Use the <a class="xdoc-link" href="HeapMemMP.html#shared.Mem.Req" title="sharedMemReq">sharedMemReq</a> or the
- <a class="xdoc-link" href="HeapMemMP.html#shared.Mem.Req.Meta" title="sharedMemReqMeta">sharedMemReqMeta</a> call to determine the exact amount of shared
- memory required for an instance for a given sharedBufSize and cache
- settings.</div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#shared.Buf.Size" title="HeapMemMP_Params.sharedBufSize">HeapMemMP_Params.sharedBufSize</a></div>
-<a class="xdocAnchor" id="metaper-instance_creation"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdocSynSum">Static Instance Creation</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html" title="module HeapMemMP"><img class="xdocHdrArrow" src="../../../../Arrow_up.png"/></a></td>
-</table>
-<div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../../index.html#ti/sdo/ipc/heaps/HeapMemMP.html#per-instance_creation">index URL</a></div>
-<p class="xdocHdrSummary"></p>
-<span id='meta-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
-<td class="xdocLabelRight"></td>
-</tr></table>
-<div class="xdocSynMdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> params = <span class="xdoc-kw1">new</span> HeapMemMP.<a class="xdoc-link" href="../../../../ti/sdo/ipc/heaps/HeapMemMP.html#metaper-instance_config_parameters" title="ti.sdo.ipc.heaps.HeapMemMP.Params">Params</a>;
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Allocate instance config-params</div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt>params.<i>config</i> = <b> ...</b>
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Assign individual configs</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">var</span> inst = HeapMemMP.<span class="xdoc-id">create</span>(params);
-</div>
-<div class='xdocSynSum'><tt></tt><tt></tt>// Create an instance-object</div>
-</div>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">ARGUMENTS</div>
-<div class="xdocChild"><span class="xdocChildId">params</span>
-<span class="xdocChildSum">— per-instance config params, or <tt>NULL</tt> to select default values (target-domain only)</span>
-</div>
-<div class="xdocChild"><span class="xdocChildId">eb</span>
-<span class="xdocChildSum">— active error-handling block, or <tt>NULL</tt> to select default policy (target-domain only)</span>
-</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">See specific <tt>IHeap</tt> implementation for parameters used.</div>
-</div>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:19 GMT</div>
-</div></div></body>
-</html>