processor_audio_sdk_1_00_00_00/psdk_cust/ipc_3_43_00_00_eng/docs/cdoc/ti/grcm/Settings.html

   1 <html>
   2 <head>
   3 <title>module ti.grcm.Settings</title>
   4 <meta name="description" content="Global configuration settings for the ti.grcm package">
   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.grcm.</span><span class="xdoc-id">Settings</span></td>
  10 <td class="xdocHdrArrow">
  11 <a class="xdocHdrLink" href="../../ti/grcm/RcmServer.html" title="module RcmServer"><img class="xdocHdrArrow" src="../../Arrow_left.png"/></a></td>
  12 <td class="xdocHdrArrow">
  13 <a class="xdocHdrLink" href="../../ti/grcm/package.html" title="package ti.grcm"><img class="xdocHdrArrow" src="../../Arrow_up.png"/></a></td>
  14 </table>
  15 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../index.html#ti/grcm/Settings.html">index URL</a></div>
  16 <p class="xdocHdrSummary">Global configuration settings for the ti.grcm package</p>
  17 <ul class="xdocToc">
  18 <li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-1">DETAILS</a></li>
  19 <li class="xdocToc"><a class="xdocToc" href="#xdoc-sect-2">SEE ALSO</a></li>
  20 <li class="xdocToc"><a class="xdocToc" href="#meta-synop">Configuration settings</a></li>
  21 <li class="xdocToc2"><a class="xdocToc" href="#xdocMetaElems">Individual elements</a></li>
  22 </ul>
  23 <div class="xdocBrief">
  24 This is a RTSC meta-only module. When building your executable with
  25   XDCtools, use this module to configure this package.
  26 [&nbsp;<a class="xdocBrief" href="#xdoc-desc">more</a>&nbsp;...&nbsp;]
  27 </div>
  28 <span id='meta-synop'></span>
  29 <table class="xdocLabel"><tr>
  30 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2"></span></tt>Configuration settings</td>
  31 <td class="xdocLabelRight">sourced in <a class="xdocLink" href="../../ti/grcm/Settings-src.html"><span class="xdocLabelFile">ti/grcm/Settings.xdc</span></a></td>
  32 </tr></table>
  33 <div class="xdocSynM">
  34 <div class="xdocSynCode">
  35 <tt></tt><span class="xdoc-kw1">var</span> Settings = <span class="xdoc-kw3">xdc.useModule</span>(<span class="xdoc-id">'ti.grcm.Settings'</span>);
  36 </div>
  37 <div class='xdocSynHdr'>module-wide constants & types</div>
  38
  39 <div class="xdocSynCode">
  40 <tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><tt></tt><i>values of type <a class="xdocSynGo" href="#.Ipc.Support">Settings.<span class="xdoc-id">IpcSupport</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">//&nbsp;IPC Support enumeration type</span></span></a></i>
  41 </div>
  42 <div class="xdocSynCode">
  43 <tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#.Ipc.Support">Settings.<span class="xdoc-id">IpcSupport_ti_sdo_ipc</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">//&nbsp;DSP/BIOS IPC Support</span></span></a>;
  44 </div>
  45 <div class="xdocSynCode">
  46 <tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><span class="xdoc-kw1">const</span> <a class="xdocSynGo" href="#.Ipc.Support">Settings.<span class="xdoc-id">IpcSupport_ti_syslink_ipc</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">//&nbsp;SysLink IPC Support</span></span></a>;
  47 </div>
  48 <div class='xdocSynHdr'>module-wide config parameters</div>
  49
  50 <div class="xdocSynCode">
  51 <tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><tt></tt><a class="xdocSynGo" href="#ipc">Settings.<span class="xdoc-id">ipc</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">//&nbsp;Specifies which IPC support to link into the executable</span></span></a> = <i><a class="xdoc-link" href="../../ti/grcm/Settings.html#.Ipc.Support" title="ti.grcm.Settings.IpcSupport">Settings.IpcSupport</a></i> <a class="xdoc-link" href="../../ti/grcm/Settings.html#.Ipc.Support_ti_sdo_ipc" title="ti.grcm.Settings.IpcSupport_ti_sdo_ipc">Settings.IpcSupport_ti_sdo_ipc</a>;
  52 </div>
  53 <div class="xdocSynCode">
  54 <tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><tt></tt><a class="xdocSynGo" href="#load.Strings">Settings.<span class="xdoc-id">loadStrings</span><span class="xdocSynHoverShadow"><span class="xdocSynHover">//&nbsp;Controls the loading of string constants to the target</span></span></a> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
  55 </div>
  56 <div class="xdocSynSpacer">&nbsp;</div>
  57 </div>
  58 <span id="xdoc-desc"></span>
  59 <span id="xdoc-sect-1"></span>
  60 <div class="xdocSect">DETAILS</div>
  61 <div class="xdocText">This is a RTSC meta-only module. When building your executable with
  62   XDCtools, use this module to configure this package.</div>
  63 <span id="xdoc-sect-2"></span>
  64 <div class="xdocSect">SEE ALSO</div>
  65 <div class="xdocText"></div>
  66 <div class="xdocText"><DL><DT> <a class="xdoc-linkDoxygen" href="ti_grcm">RCM Overview</a></DT><DD>
  67 </DD><DT> <a class="xdoc-linkDoxygen" href="RcmClient.h">RcmClient File Reference</a></DT><DD>
  68 </DD><DT> <a class="xdoc-linkDoxygen" href="RcmServer.h">RcmServer File Reference</a></DT><DD>
  69 </DD></DL></div>
  70 <div id="xdocSep">
  71 </div>
  72 <div id="xdocMetaElems">
  73 <div class="xdocSynSpacer">&nbsp;</div>
  74 <a class="xdocAnchor" id=".Ipc.Support"></a>
  75 <a class="xdocAnchor" id=".Ipc.Support_ti_sdo_ipc"></a>
  76 <a class="xdocAnchor" id=".Ipc.Support_ti_syslink_ipc"></a>
  77 <table class="xdocHdr"><tr>
  78 <td class="xdocHdrTitle"><span class="xdoc-kw1">enum</span> <span class="xdoc-id">Settings.</span><span class="xdoc-id">IpcSupport</span></td>
  79 <td class="xdocHdrArrow">
  80 <a class="xdocHdrLink" href="../../ti/grcm/Settings.html" title="module Settings"><img class="xdocHdrArrow" src="../../Arrow_up.png"/></a></td>
  81 </table>
  82 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../index.html#ti/grcm/Settings.html#.Ipc.Support">index URL</a></div>
  83 <p class="xdocHdrSummaryDcl">IPC Support enumeration type</p>
  84 <span id='meta-synop'></span>
  85 <table class="xdocLabel"><tr>
  86 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
  87 <td class="xdocLabelRight"></td>
  88 </tr></table>
  89 <div class="xdocSynMdcl">
  90 <div class="xdocSynCode">
  91 <tt></tt><tt></tt><i>values of type Settings.<span class="xdoc-id">IpcSupport</span></i>
  92 </div>
  93 <div class="xdocSynCode">
  94 <tt></tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><span class="xdoc-kw1">const</span> Settings.<span class="xdoc-id">IpcSupport_ti_sdo_ipc</span>;
  95 </div>
  96 <div class='xdocSynSum'><tt></tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt>//&nbsp;DSP/BIOS IPC Support</div>
  97 <div class="xdocSynCode">
  98 <tt></tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt><span class="xdoc-kw1">const</span> Settings.<span class="xdoc-id">IpcSupport_ti_syslink_ipc</span>;
  99 </div>
 100 <div class='xdocSynSum'><tt></tt><tt>&nbsp;&nbsp;&nbsp;&nbsp;</tt>//&nbsp;SysLink IPC Support</div>
 101 </div>
 102 <div class="xdocSynSpacer">&nbsp;</div>
 103 <span id="xdoc-sect-1"></span>
 104 <div class="xdocSect">DETAILS</div>
 105 <div class="xdocText">The IPC support is provided by one of the following types.</div>
 106 <div class="xdocSynSpacer">&nbsp;</div>
 107 <a class="xdocAnchor" id="ipc"></a>
 108 <table class="xdocHdr"><tr>
 109 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Settings.</span><span class="xdoc-id">ipc</span>&nbsp;&nbsp;<small><span class="xdocSynSum">//&nbsp;module-wide</span></small></td>
 110 <td class="xdocHdrArrow">
 111 <a class="xdocHdrLink" href="../../ti/grcm/Settings.html" title="module Settings"><img class="xdocHdrArrow" src="../../Arrow_up.png"/></a></td>
 112 </table>
 113 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../index.html#ti/grcm/Settings.html#ipc">index URL</a></div>
 114 <p class="xdocHdrSummaryDcl">Specifies which IPC support to link into the executable</p>
 115 <span id='meta-synop'></span>
 116 <table class="xdocLabel"><tr>
 117 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
 118 <td class="xdocLabelRight"></td>
 119 </tr></table>
 120 <div class="xdocSynMdcl">
 121 <div class="xdocSynCode">
 122 <tt></tt><tt></tt>Settings.<span class="xdoc-id">ipc</span> = <i><a class="xdoc-link" href="../../ti/grcm/Settings.html#.Ipc.Support" title="ti.grcm.Settings.IpcSupport">Settings.IpcSupport</a></i> <a class="xdoc-link" href="../../ti/grcm/Settings.html#.Ipc.Support_ti_sdo_ipc" title="ti.grcm.Settings.IpcSupport_ti_sdo_ipc">Settings.IpcSupport_ti_sdo_ipc</a>;
 123 </div>
 124 </div>
 125 <div class="xdocSynSpacer">&nbsp;</div>
 126 <span id="xdoc-sect-1"></span>
 127 <div class="xdocSect">DETAILS</div>
 128 <div class="xdocText">This config param must be set in the application config script.
 129   It has no default value.</div>
 130 <div class="xdocSynSpacer">&nbsp;</div>
 131 <a class="xdocAnchor" id="load.Strings"></a>
 132 <table class="xdocHdr"><tr>
 133 <td class="xdocHdrTitle"><span class="xdoc-kw1">config</span> <span class="xdoc-id">Settings.</span><span class="xdoc-id">loadStrings</span>&nbsp;&nbsp;<small><span class="xdocSynSum">//&nbsp;module-wide</span></small></td>
 134 <td class="xdocHdrArrow">
 135 <a class="xdocHdrLink" href="../../ti/grcm/Settings.html" title="module Settings"><img class="xdocHdrArrow" src="../../Arrow_up.png"/></a></td>
 136 </table>
 137 <div class=xdocHdrIndex><a class=xdocHdrIndex title="right-click to capture" href="../../index.html#ti/grcm/Settings.html#load.Strings">index URL</a></div>
 138 <p class="xdocHdrSummaryDcl">Controls the loading of string constants to the target</p>
 139 <span id='meta-synop'></span>
 140 <table class="xdocLabel"><tr>
 141 <td class="xdocLabelLeft"><tt><span class="xdoc-id-meta2dcl"></span></tt>Configuration settings</td>
 142 <td class="xdocLabelRight"></td>
 143 </tr></table>
 144 <div class="xdocSynMdcl">
 145 <div class="xdocSynCode">
 146 <tt></tt><tt></tt>Settings.<span class="xdoc-id">loadStrings</span> = <i><span class="xdoc-kw2">Bool</span></i> <span class="xdoc-kw2">true</span>;
 147 </div>
 148 </div>
 149 <div class="xdocSynSpacer">&nbsp;</div>
 150 <span id="xdoc-sect-1"></span>
 151 <div class="xdocSect">DETAILS</div>
 152 <div class="xdocText">By default, all string constants are loaded to the target. If the
 153   program is using a logger which does not process the strings, then
 154   setting this config param to false will reduce the program's data
 155   footprint because the string constants will not be loaded.</div>
 156 </div>
 157 <div id="xdocDate">generated on Mon, 23 May 2016 14:31:07 GMT</div>
 158 </div></div></body>
 159 </html>