[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / transports / TransportRpmsgSetup.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/ipc/transports/TransportRpmsgSetup.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/ipc/transports/TransportRpmsgSetup.html
+++ /dev/null
@@ -1,300 +0,0 @@
-<html>
-<head>
-<title>module ti.ipc.transports.TransportRpmsgSetup</title>
-<meta name="description" content="Manages the setup of TransportRpmsg instances">
-<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.ipc.transports.</span><span class="xdoc-id">TransportRpmsgSetup</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsg.html" title="module TransportRpmsg"><img class="xdocHdrArrow" src="../../../Arrow_left.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/package.html" title="package ti.ipc.transports"><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/ipc/transports/TransportRpmsgSetup.html">index URL</a></div>
-<p class="xdocHdrSummary">Manages the setup of TransportRpmsg instances</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="#xdoc-sect-1">DETAILS</a></li>
-<li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-2">NOTE</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">
-Create or open the TransportRpmsg for each pair of devices.
-[ <a class="xdocBrief" href="#xdoc-desc">more</a> ... ]
-</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/ipc/transports/TransportRpmsgSetup-src.html"><span class="xdocLabelFile">ti/ipc/transports/TransportRpmsgSetup.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/ipc/transports/TransportRpmsgSetup.h></span>
-</div>
-<table cellspacing="0" cellpadding="0" border="0">
-<tr><td colspan="2"><div class="xdocSynFxnCat">Functions common to all ITransportSetup modules</div></td></tr>
-
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#attach"><span class="xdoc-id">TransportRpmsgSetup_attach</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function that will be called in MessageQ_attach</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">Int</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#detach"><span class="xdoc-id">TransportRpmsgSetup_detach</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Function that will be called in MessageQ_detach</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</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.Registered"><span class="xdoc-id">TransportRpmsgSetup_isRegistered</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Determines if a transport has been registered to a remote processor</span></span></a>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);</div></td></tr>
-<tr valign="top"><td class="xdocSynDecl" nowrap><div class="xdocSynTblType"><tt></tt><span class="xdoc-kw2">SizeT</span> </div></td><td class="xdocSynDecl"><div class="xdocSynTblDecl"><a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">TransportRpmsgSetup_sharedMemReq</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Shared memory required</span></span></a>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);</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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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'>Constants</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="#priority"><span class="xdoc-id">TransportRpmsgSetup_priority</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// priority of the transport</span></span></a>;</div></td></tr>
-</table>
-<div class="xdocSynSpacer"> </div>
-</div>
-<span id="xdoc-desc"></span>
-<span id="xdoc-sect-1"></span>
-<div class="xdocSect">DETAILS</div>
-<div class="xdocText">Create or open the TransportRpmsg for each pair of devices.</div>
-<span id="xdoc-sect-2"></span>
-<div class="xdocSect">NOTE</div>
-<div class="xdocText">This modules reflects upon the <a class="xdoc-link" href="../../../ti/sdo/utils/MultiProc.html#proc.Addr.Mode" title="ti.sdo.utils.MultiProc.procAddrMode">ti.sdo.utils.MultiProc.procAddrMode</a>
- configuration parameter. Some internal data structure allocations are
- optimized for the given processor address mode.</div>
-<div id="xdocSep">
-</div>
-<div id="xdocElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="priority"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsgSetup_</span><span class="xdoc-id">priority</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#priority">index URL</a></div>
-<p class="xdocHdrSummaryDcl">priority of the transport</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">TransportRpmsgSetup_priority</span>;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="attach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsgSetup_</span><span class="xdoc-id">attach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#attach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function that will be called in MessageQ_attach</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">TransportRpmsgSetup_attach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>, <span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="detach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsgSetup_</span><span class="xdoc-id">detach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#detach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function that will be called in MessageQ_detach</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">TransportRpmsgSetup_detach</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="is.Registered"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsgSetup_</span><span class="xdoc-id">isRegistered</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#is.Registered">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Determines if a transport has been registered to a remote processor</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">TransportRpmsgSetup_isRegistered</span>(<span class="xdoc-kw2">UInt16</span> <span class="xdoc-id">remoteProcId</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="shared.Mem.Req"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">TransportRpmsgSetup_</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#shared.Mem.Req">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Shared memory required</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">SizeT</span> <span class="xdoc-id">TransportRpmsgSetup_sharedMemReq</span>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</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/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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">TransportRpmsgSetup_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>
-</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/ipc/transports/TransportRpmsgSetup-src.html"><span class="xdocLabelFile">ti/ipc/transports/TransportRpmsgSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynM">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">var</span> TransportRpmsgSetup = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.transports.TransportRpmsgSetup'</span>);
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#metapriority">TransportRpmsgSetup.<span class="xdoc-id">priority</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// priority of the transport</span></span></a> = <i><span class="xdoc-kw2">UInt</span></i> 0;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><a class="xdocSynGo" href="#common$">TransportRpmsgSetup.<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="xdocSynSpacer"> </div>
-</div>
-<div id="xdocSep">
-</div>
-<div id="xdocMetaElems">
-<div class="xdocSynSpacer"> </div>
-<a class="xdocAnchor" id="metapriority"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">TransportRpmsgSetup.</span><span class="xdoc-id">priority</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.html#priority">index URL</a></div>
-<p class="xdocHdrSummaryDcl">priority of the transport</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>TransportRpmsgSetup.<span class="xdoc-id">priority</span> = <i><span class="xdoc-kw2">UInt</span></i> 0;
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSect">C SYNOPSIS</div>
-<div class="xdocText"><a class="xdoc-link" href="#priority" title="TransportRpmsgSetup_priority">TransportRpmsgSetup_priority</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">TransportRpmsgSetup.</span><span class="xdoc-id">common$</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../ti/ipc/transports/TransportRpmsgSetup.html" title="module TransportRpmsgSetup"><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/ipc/transports/TransportRpmsgSetup.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>TransportRpmsgSetup.<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>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:25 GMT</div>
-</div></div></body>
-</html>