[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / ipc / ipcmgr / IpcMgr.html
1 <html>
2 <head>
3 <title>module ti.ipc.ipcmgr.IpcMgr</title>
4 <meta name="description" content="IPC Manager">
5 <link rel="stylesheet" type="text/css" href="../../../xdoc.css" />
6 </head>
7 <body><div id="xdocWrapper"><div id="xdocContent">
8 <table class="xdocHdr"><tr>
9 <td class="xdocHdrTitle"><span class="xdoc-kw1">metaonly </span><span class="xdoc-kw1">module</span> <span class="xdoc-id">ti.ipc.ipcmgr.</span><span class="xdoc-id">IpcMgr</span></td>
10 <td class="xdocHdrArrow">
11 <a class="xdocHdrLink" href="../../../ti/ipc/ipcmgr/package.html" title="package ti.ipc.ipcmgr"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
12 </table>
13 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/ipcmgr/IpcMgr.html">index URL</a></div>
14 <p class="xdocHdrSummary">IPC Manager</p>
15 <ul class="xdocToc">
16 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
17 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
18 </ul>
19 <span id='meta-synop'></span>
20 <table class="xdocLabel"><tr>
21 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
22 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../../ti/ipc/ipcmgr/IpcMgr-src.html"><span class="xdocLabelFile">ti/ipc/ipcmgr/IpcMgr.xdc</span></a></td>
23 </tr></table>
24 <div class="xdocSynM">
25 <div class="xdocSynCode">
26 <tt></tt><span class="xdoc-kw1">var</span> IpcMgr = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.ipc.ipcmgr.IpcMgr'</span>);
27 </div>
28 <div class='xdocSynHdr'>module-wide constants & types</div>
30 <div class="xdocSynCode">
31 <tt> </tt><tt></tt><i>values of type <a class="xdocSynGo" href="#.Trans.Combo">IpcMgr.<span class="xdoc-id">TransCombo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Transport combinations</span></span></a></i>
32 </div>
33 <div class="xdocSynCode">
34 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#.Trans.Combo">IpcMgr.<span class="xdoc-id">TransCombo_RPMSG</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// RPMessage only</span></span></a>;
35 </div>
36 <div class="xdocSynCode">
37 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#.Trans.Combo">IpcMgr.<span class="xdoc-id">TransCombo_RPMSG_MESSAGEQ</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// RPMessage over MessageQ</span></span></a>;
38 </div>
39 <div class="xdocSynCode">
40 <tt> </tt><tt> </tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#.Trans.Combo">IpcMgr.<span class="xdoc-id">TransCombo_RPMSG_IPC</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// RpMessage plus IPC between slaves</span></span></a>;
41 </div>
42 <div class='xdocSynHdr'>module-wide config parameters</div>
44 <div class="xdocSynCode">
45 <tt> </tt><tt></tt><a class="xdocSynGo" href="#transport.Combo">IpcMgr.<span class="xdoc-id">transportCombo</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Specifies which transport combination will be used</span></span></a> = <i><a class="xdoc-link" href="../../../ti/ipc/ipcmgr/IpcMgr.html#.Trans.Combo" title="ti.ipc.ipcmgr.IpcMgr.TransCombo">IpcMgr.TransCombo</a></i> <span class="xdoc-kw2">undefined</span>;
46 </div>
47 <div class='xdocSynHdr'>module-wide functions</div>
49 <div class="xdocSynCode">
50 <tt> </tt><tt></tt><a class="xdocSynGo" href="#get.Defs">IpcMgr.<span class="xdoc-id">getDefs</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">// Get the compiler -D options necessary to build</span></span></a>() <i>returns</i> <i><span class="xdoc-kw2">String</span></i>
51 </div>
52 <div class="xdocSynSpacer"> </div>
53 </div>
54 <div id="xdocSep">
55 </div>
56 <div id="xdocMetaElems">
57 <div class="xdocSynSpacer"> </div>
58 <a class="xdocAnchor" id=".Trans.Combo"></a>
59 <a class="xdocAnchor" id=".Trans.Combo_.R.P.M.S.G"></a>
60 <a class="xdocAnchor" id=".Trans.Combo_.R.P.M.S.G_.M.E.S.S.A.G.E.Q"></a>
61 <a class="xdocAnchor" id=".Trans.Combo_.R.P.M.S.G_.I.P.C"></a>
62 <table class="xdocHdr"><tr>
63 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">IpcMgr.</span><span class="xdoc-id">TransCombo</span></td>
64 <td class="xdocHdrArrow">
65 <a class="xdocHdrLink" href="../../../ti/ipc/ipcmgr/IpcMgr.html" title="module IpcMgr"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
66 </table>
67 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/ipcmgr/IpcMgr.html#.Trans.Combo">index URL</a></div>
68 <p class="xdocHdrSummaryDcl">Transport combinations</p>
69 <span id='meta-synop'></span>
70 <table class="xdocLabel"><tr>
71 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
72 <td class="xdocLabelRight"></td>
73 </tr></table>
74 <div class="xdocSynMdcl">
75 <div class="xdocSynCode">
76 <tt></tt><tt></tt><i>values of type IpcMgr.<span class="xdoc-id">TransCombo</span></i>
77 </div>
78 <div class="xdocSynCode">
79 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> IpcMgr.<span class="xdoc-id">TransCombo_RPMSG</span>;
80 </div>
81 <div class='xdocSynSum'><tt></tt><tt> </tt>// RPMessage only</div>
82 <div class="xdocSynCode">
83 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> IpcMgr.<span class="xdoc-id">TransCombo_RPMSG_MESSAGEQ</span>;
84 </div>
85 <div class='xdocSynSum'><tt></tt><tt> </tt>// RPMessage over MessageQ</div>
86 <div class="xdocSynCode">
87 <tt></tt><tt> </tt><span class="xdoc-kw1">const</span> IpcMgr.<span class="xdoc-id">TransCombo_RPMSG_IPC</span>;
88 </div>
89 <div class='xdocSynSum'><tt></tt><tt> </tt>// RpMessage plus IPC between slaves</div>
90 </div>
91 <div class="xdocSynSpacer"> </div>
92 <span id="xdoc-sect-1"></span>
93 <div class="xdocSect">DETAILS</div>
94 <div class="xdocText">IpcMgr supports the following transport combinations.</div>
95 <div class="xdocSynSpacer"> </div>
96 <a class="xdocAnchor" id="transport.Combo"></a>
97 <table class="xdocHdr"><tr>
98 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">IpcMgr.</span><span class="xdoc-id">transportCombo</span> <small><span class="xdocSynSum">// module-wide</span></small></td>
99 <td class="xdocHdrArrow">
100 <a class="xdocHdrLink" href="../../../ti/ipc/ipcmgr/IpcMgr.html" title="module IpcMgr"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
101 </table>
102 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/ipcmgr/IpcMgr.html#transport.Combo">index URL</a></div>
103 <p class="xdocHdrSummaryDcl">Specifies which transport combination will be used</p>
104 <span id='meta-synop'></span>
105 <table class="xdocLabel"><tr>
106 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
107 <td class="xdocLabelRight"></td>
108 </tr></table>
109 <div class="xdocSynMdcl">
110 <div class="xdocSynCode">
111 <tt></tt><tt></tt>IpcMgr.<span class="xdoc-id">transportCombo</span> = <i><a class="xdoc-link" href="../../../ti/ipc/ipcmgr/IpcMgr.html#.Trans.Combo" title="ti.ipc.ipcmgr.IpcMgr.TransCombo">IpcMgr.TransCombo</a></i> <span class="xdoc-kw2">undefined</span>;
112 </div>
113 </div>
114 <div class="xdocSynSpacer"> </div>
115 <span id="xdoc-sect-1"></span>
116 <div class="xdocSect">DETAILS</div>
117 <div class="xdocText">This config param must be set in the application config script.
118 It has no default value.</div>
119 <div class="xdocSynSpacer"> </div>
120 <a class="xdocAnchor" id="get.Defs"></a>
121 <table class="xdocHdr"><tr>
122 <td class="xdocHdrTitle"><span class="xdoc-id">IpcMgr.</span><span class="xdoc-id">getDefs</span>() <small><span class="xdocSynSum">// module-wide</span></small></td>
123 <td class="xdocHdrArrow">
124 <a class="xdocHdrLink" href="../../../ti/ipc/ipcmgr/IpcMgr.html" title="module IpcMgr"><img class="xdocHdrArrow" src="../../../Arrow_up.png"/></a></td>
125 </table>
126 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../../index.html#ti/ipc/ipcmgr/IpcMgr.html#get.Defs">index URL</a></div>
127 <p class="xdocHdrSummaryDcl">Get the compiler -D options necessary to build</p>
128 <span id='meta-synop'></span>
129 <table class="xdocLabel"><tr>
130 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
131 <td class="xdocLabelRight"></td>
132 </tr></table>
133 <div class="xdocSynMdcl">
134 <div class="xdocSynCode">
135 <tt></tt><tt></tt>IpcMgr.<span class="xdoc-id">getDefs</span>() <i>returns</i> <i><span class="xdoc-kw2">String</span></i>
136 </div>
137 </div>
138 <div class="xdocSynSpacer"> </div>
139 </div>
140 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:26 GMT</div>
141 </div></div></body>
142 </html>