[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / struct_heap_buf_m_p___params.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/struct_heap_buf_m_p___params.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/doxygen/html/struct_heap_buf_m_p___params.html
+++ /dev/null
@@ -1,260 +0,0 @@
-<!-- HTML header for doxygen 1.8.9.1-->
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.9.1"/>
-<title>IPC API: HeapBufMP_Params Struct Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/searchdata.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<script type="text/javascript">
- $(document).ready(function() { init_search(); });
-</script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<table width="100%">
-<tr>
- <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
- <td bgcolor="red"><img src="titagline.gif" /></td>
-</tr>
-</table>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
- <td style="padding-left: 0.5em;">
- <div id="projectname">IPC API
-  <span id="projectnumber">3.43.00.00_eng</span>
- </div>
- </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.9.1 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
- <div id="navrow1" class="tabs">
- <ul class="tablist">
- <li><a href="index.html"><span>Main Page</span></a></li>
- <li><a href="modules.html"><span>Modules</span></a></li>
- <li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="files.html"><span>Files</span></a></li>
- <li><a href="pages.html"><span>Related Pages</span></a></li>
- <li>
- <div id="MSearchBox" class="MSearchBoxInactive">
- <span class="left">
- <img id="MSearchSelect" src="search/mag_sel.png"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- alt=""/>
- <input type="text" id="MSearchField" value="Search" accesskey="S"
- onfocus="searchBox.OnSearchFieldFocus(true)"
- onblur="searchBox.OnSearchFieldFocus(false)"
- onkeyup="searchBox.OnSearchFieldChange(event)"/>
- </span><span class="right">
- <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
- </span>
- </div>
- </li>
- </ul>
- </div>
- <div id="navrow2" class="tabs2">
- <ul class="tablist">
- <li><a href="annotated.html"><span>Data Structures</span></a></li>
- <li><a href="classes.html"><span>Data Structure Index</span></a></li>
- <li><a href="functions.html"><span>Data Fields</span></a></li>
- </ul>
- </div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
- onmouseover="return searchBox.OnSearchSelectShow()"
- onmouseout="return searchBox.OnSearchSelectHide()"
- onkeydown="return searchBox.OnSearchSelectKey(event)">
-</div>
-
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0"
- name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-
-</div><!-- top -->
-<div class="header">
- <div class="summary">
-<a href="#pub-attribs">Data Fields</a> </div>
- <div class="headertitle">
-<div class="title">HeapBufMP_Params Struct Reference</div> </div>
-</div><!--header-->
-<div class="contents">
-
-<p>Structure defining parameters for the HeapBufMP module.
- <a href="struct_heap_buf_m_p___params.html#details">More...</a></p>
-
-<p><code>#include <<a class="el" href="_heap_buf_m_p_8h_source.html">HeapBufMP.h</a>></code></p>
-<div class="dynheader">
-Collaboration diagram for HeapBufMP_Params:</div>
-<div class="dyncontent">
-<div class="center"><img src="struct_heap_buf_m_p___params__coll__graph.png" border="0" usemap="#_heap_buf_m_p___params_coll__map" alt="Collaboration graph"/></div>
-<map name="_heap_buf_m_p___params_coll__map" id="_heap_buf_m_p___params_coll__map">
-</map>
-</div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:aaefdf87660dc3b0a57d33f10791dcc02"><td class="memItemLeft" align="right" valign="top">String </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#aaefdf87660dc3b0a57d33f10791dcc02">name</a></td></tr>
-<tr class="memdesc:aaefdf87660dc3b0a57d33f10791dcc02"><td class="mdescLeft"> </td><td class="mdescRight">Name of this instance. <a href="#aaefdf87660dc3b0a57d33f10791dcc02">More...</a><br /></td></tr>
-<tr class="separator:aaefdf87660dc3b0a57d33f10791dcc02"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a22f33c326f94898613b8d40335be4eee"><td class="memItemLeft" align="right" valign="top">UInt16 </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#a22f33c326f94898613b8d40335be4eee">regionId</a></td></tr>
-<tr class="memdesc:a22f33c326f94898613b8d40335be4eee"><td class="mdescLeft"> </td><td class="mdescRight">Shared region ID. <a href="#a22f33c326f94898613b8d40335be4eee">More...</a><br /></td></tr>
-<tr class="separator:a22f33c326f94898613b8d40335be4eee"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:afc5038de12c1e9bf75d642c1081b74ac"><td class="memItemLeft" align="right" valign="top">SizeT </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#afc5038de12c1e9bf75d642c1081b74ac">blockSize</a></td></tr>
-<tr class="memdesc:afc5038de12c1e9bf75d642c1081b74ac"><td class="mdescLeft"> </td><td class="mdescRight">Size (in MAUs) of each block. <a href="#afc5038de12c1e9bf75d642c1081b74ac">More...</a><br /></td></tr>
-<tr class="separator:afc5038de12c1e9bf75d642c1081b74ac"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a4e85da751892052ed1fddc3376f64d9d"><td class="memItemLeft" align="right" valign="top">UInt </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#a4e85da751892052ed1fddc3376f64d9d">numBlocks</a></td></tr>
-<tr class="memdesc:a4e85da751892052ed1fddc3376f64d9d"><td class="mdescLeft"> </td><td class="mdescRight">Number of fixed-size blocks. <a href="#a4e85da751892052ed1fddc3376f64d9d">More...</a><br /></td></tr>
-<tr class="separator:a4e85da751892052ed1fddc3376f64d9d"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a0b16778e64598aca34ee44c746374203"><td class="memItemLeft" align="right" valign="top">SizeT </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#a0b16778e64598aca34ee44c746374203">align</a></td></tr>
-<tr class="memdesc:a0b16778e64598aca34ee44c746374203"><td class="mdescLeft"> </td><td class="mdescRight">Alignment (in MAUs) of each block. <a href="#a0b16778e64598aca34ee44c746374203">More...</a><br /></td></tr>
-<tr class="separator:a0b16778e64598aca34ee44c746374203"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a1ebbb52b6985282c23f534da4ac27eaa"><td class="memItemLeft" align="right" valign="top">Bool </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#a1ebbb52b6985282c23f534da4ac27eaa">exact</a></td></tr>
-<tr class="memdesc:a1ebbb52b6985282c23f534da4ac27eaa"><td class="mdescLeft"> </td><td class="mdescRight">Use exact matching. <a href="#a1ebbb52b6985282c23f534da4ac27eaa">More...</a><br /></td></tr>
-<tr class="separator:a1ebbb52b6985282c23f534da4ac27eaa"><td class="memSeparator" colspan="2"> </td></tr>
-<tr class="memitem:a3b1ef95defb6c91953bd53050489644e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="_gate_m_p_8h.html#a3c46c6ae9c6feac86b8b8872ee52f587">GateMP_Handle</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_heap_buf_m_p___params.html#a3b1ef95defb6c91953bd53050489644e">gate</a></td></tr>
-<tr class="memdesc:a3b1ef95defb6c91953bd53050489644e"><td class="mdescLeft"> </td><td class="mdescRight">GateMP used for critical region management of the shared memory. <a href="#a3b1ef95defb6c91953bd53050489644e">More...</a><br /></td></tr>
-<tr class="separator:a3b1ef95defb6c91953bd53050489644e"><td class="memSeparator" colspan="2"> </td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>Structure defining parameters for the HeapBufMP module. </p>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="_heap_buf_m_p_8h.html#a3bb1b659403d9944bc4b64596b20f1f3" title="Create a HeapBufMP instance. ">HeapBufMP_create()</a> </dd></dl>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a class="anchor" id="aaefdf87660dc3b0a57d33f10791dcc02"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">String HeapBufMP_Params::name</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Name of this instance. </p>
-<p>The name (if not NULL) must be unique among all HeapBufMP instances in the entire system. When creating a new heap, it is necessary to supply an instance name.</p>
-<p>The name does not have to be persistent. The supplied string is copied into persistent memory. </p>
-
-</div>
-</div>
-<a class="anchor" id="a22f33c326f94898613b8d40335be4eee"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UInt16 HeapBufMP_Params::regionId</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Shared region ID. </p>
-<p>The index corresponding to the shared region from which shared memory will be allocated. </p>
-
-</div>
-</div>
-<a class="anchor" id="afc5038de12c1e9bf75d642c1081b74ac"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">SizeT HeapBufMP_Params::blockSize</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Size (in MAUs) of each block. </p>
-<p>HeapBufMP will round the blockSize up to the nearest multiple of the alignment, so the actual blockSize may be larger. When creating a HeapBufMP dynamically, this needs to be taken into account to determine the proper buffer size to pass in.</p>
-<p>Required parameter.</p>
-<p>The default size of the blocks is 0 MAUs. </p>
-
-</div>
-</div>
-<a class="anchor" id="a4e85da751892052ed1fddc3376f64d9d"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">UInt HeapBufMP_Params::numBlocks</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Number of fixed-size blocks. </p>
-<p>This is a required parameter for all new HeapBufMP instances. </p>
-
-</div>
-</div>
-<a class="anchor" id="a0b16778e64598aca34ee44c746374203"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">SizeT HeapBufMP_Params::align</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Alignment (in MAUs) of each block. </p>
-<p>The alignment must be a power of 2. If the value 0 is specified, the value will be changed to meet minimum structure alignment requirements and the cache alignment size of the region in which the heap will be placed. Therefore, the actual alignment may be larger.</p>
-<p>The default alignment is 0. </p>
-
-</div>
-</div>
-<a class="anchor" id="a1ebbb52b6985282c23f534da4ac27eaa"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname">Bool HeapBufMP_Params::exact</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>Use exact matching. </p>
-<p>Setting this flag will allow allocation only if the requested size is equal to (rather than less than or equal to) the buffer's block size. </p>
-
-</div>
-</div>
-<a class="anchor" id="a3b1ef95defb6c91953bd53050489644e"></a>
-<div class="memitem">
-<div class="memproto">
- <table class="memname">
- <tr>
- <td class="memname"><a class="el" href="_gate_m_p_8h.html#a3c46c6ae9c6feac86b8b8872ee52f587">GateMP_Handle</a> HeapBufMP_Params::gate</td>
- </tr>
- </table>
-</div><div class="memdoc">
-
-<p>GateMP used for critical region management of the shared memory. </p>
-<p>Using the default value of NULL will result in use of the GateMP system gate for context protection. </p>
-
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li>ti/ipc/<a class="el" href="_heap_buf_m_p_8h_source.html">HeapBufMP.h</a></li>
-</ul>
-</div><!-- contents -->
-<!-- HTML footer for doxygen 1.8.9.1-->
-<!-- start footer part -->
-<hr class="footer"/><small>
-Copyright 2016, Texas Instruments Incorporated
-</small>
-</body>
-</html>