[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 / interfaces / ITransportSetup.html
diff --git a/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/interfaces/ITransportSetup.html b/processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/sdo/ipc/interfaces/ITransportSetup.html
+++ /dev/null
@@ -1,200 +0,0 @@
-<html>
-<head>
-<title>interface ti.sdo.ipc.interfaces.ITransportSetup</title>
-<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">interface</span> <span class="xdoc-id">ti.sdo.ipc.interfaces.</span><span class="xdoc-id">ITransportSetup</span></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransport.html" title="interface ITransport"><img class="xdocHdrArrow" src="../../../../Arrow_left.png"/></a></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/package.html" title="package ti.sdo.ipc.interfaces"><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/interfaces/ITransportSetup.html">index URL</a></div>
-<ul class="xdocToc">
-</ul>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id">XDCspec</span></tt> summary</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynX">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">interface</span> <span class="xdoc-id">ITransportSetup</span> {<b> ...</b>
-</div>
-<div class='xdocSynSum'><tt></tt>// inherits <a class="xdoc-link" href="../../../../xdc/runtime/IModule.html" title="xdc.runtime.IModule">xdc.runtime.IModule</a></div>
-</div>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-id">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynX">
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">package</span> <a class="xdoc-link" href="../../../../ti/sdo/ipc/interfaces/package.html" title="ti.sdo.ipc.interfaces">ti.sdo.ipc.interfaces</a>;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt></tt><span class="xdoc-kw1">interface</span> <span class="xdoc-id">ITransportSetup</span> {
-</div>
-<div class='xdocSynHdr'>module-wide config parameters</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">config</span> <span class="xdoc-kw2">UInt</span> <a class="xdocSynGo" href="#priority"><span class="xdoc-id">priority</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// priority of the transport</span></span></a> = 0;
-</div>
-<div class="xdocSynSpacer"> </div>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a> <a class="xdocSynGo" href="#common$"><span class="xdoc-id">common$</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Common module configuration parameters</span></span></a>;
-</div>
-<div class='xdocSynHdr'>module-wide functions</div>
-
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Int</span> <a class="xdocSynGo" href="#attach"><span class="xdoc-id">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>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Int</span> <a class="xdocSynGo" href="#detach"><span class="xdoc-id">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>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">Bool</span> <a class="xdocSynGo" href="#is.Registered"><span class="xdoc-id">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>
-<div class="xdocSynCode">
-<tt> </tt><tt></tt><span class="xdoc-kw2">SizeT</span> <a class="xdocSynGo" href="#shared.Mem.Req"><span class="xdoc-id">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>
-<div class="xdocSynCode">
-<tt></tt>}
-</div>
-</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">ITransportSetup.</span><span class="xdoc-id">priority</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#priority">index URL</a></div>
-<p class="xdocHdrSummaryDcl">priority of the transport</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">config</span> <span class="xdoc-kw2">UInt</span> <span class="xdoc-id">priority</span> = 0;
-</div>
-</div>
-<div class="xdocSynSpacer"> </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">ITransportSetup.</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/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#common$">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Common module configuration parameters</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">config</span> <a class="xdoc-link" href="../../../../xdc/runtime/Types.html#.Common$" title="xdc.runtime.Types.Common$">Types.Common$</a> <span class="xdoc-id">common$</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="attach"></a>
-<table class="xdocHdr"><tr>
-<td class="xdocHdrTitle"><span class="xdoc-id">ITransportSetup.</span><span class="xdoc-id">attach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#attach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function that will be called in MessageQ_attach</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">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">ITransportSetup.</span><span class="xdoc-id">detach</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#detach">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Function that will be called in MessageQ_detach</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Int</span> <span class="xdoc-id">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">ITransportSetup.</span><span class="xdoc-id">isRegistered</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#is.Registered">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Determines if a transport has been registered to a remote processor</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">Bool</span> <span class="xdoc-id">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">ITransportSetup.</span><span class="xdoc-id">sharedMemReq</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
-<td class="xdocHdrArrow">
-<a class="xdocHdrLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup.html" title="interface ITransportSetup"><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/interfaces/ITransportSetup.html#shared.Mem.Req">index URL</a></div>
-<p class="xdocHdrSummaryDcl">Shared memory required</p>
-<span id='spec-synop'></span>
-<table class="xdocLabel"><tr>
-<td class="xdocLabelLeft"><tt><span class="xdoc-iddcl">XDCspec</span></tt> declarations</td>
-<td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../../ti/sdo/ipc/interfaces/ITransportSetup-src.html"><span class="xdocLabelFile">ti/sdo/ipc/interfaces/ITransportSetup.xdc</span></a></td>
-</tr></table>
-<div class="xdocSynXdcl">
-<div class="xdocSynCode">
-<tt></tt><tt></tt><span class="xdoc-kw2">SizeT</span> <span class="xdoc-id">sharedMemReq</span>(<span class="xdoc-kw2">Ptr</span> <span class="xdoc-id">sharedAddr</span>);
-</div>
-</div>
-<div class="xdocSynSpacer"> </div>
-</div>
-<div id="xdocDate">generated on Mon, 23 May 2016 14:31:12 GMT</div>
-</div></div></body>
-</html>