[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / cdoc / ti / grcm / Settings-src.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2 <html><head><title>module ti.grcm.Settings</title>
3 <meta name="googlebot" content="noindex,nofollow">
4 <link rel="stylesheet" type="text/css" href="../../src.css"/>
5 </head>
6 <body>
7 <pre class=src>
8 1 <span class="comment">/*
9 </span> 2 <span class="comment"> * Copyright (c) 2011-2013, Texas Instruments Incorporated
10 </span> 3 <span class="comment"> * All rights reserved.
11 </span> 4 <span class="comment"> *
12 </span> 5 <span class="comment"> * Redistribution and use in source and binary forms, with or without
13 </span> 6 <span class="comment"> * modification, are permitted provided that the following conditions
14 </span> 7 <span class="comment"> * are met:
15 </span> 8 <span class="comment"> *
16 </span> 9 <span class="comment"> * * Redistributions of source code must retain the above copyright
17 </span> 10 <span class="comment"> * notice, this list of conditions and the following disclaimer.
18 </span> 11 <span class="comment"> *
19 </span> 12 <span class="comment"> * * Redistributions in binary form must reproduce the above copyright
20 </span> 13 <span class="comment"> * notice, this list of conditions and the following disclaimer in the
21 </span> 14 <span class="comment"> * documentation and/or other materials provided with the distribution.
22 </span> 15 <span class="comment"> *
23 </span> 16 <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of
24 </span> 17 <span class="comment"> * its contributors may be used to endorse or promote products derived
25 </span> 18 <span class="comment"> * from this software without specific prior written permission.
26 </span> 19 <span class="comment"> *
27 </span> 20 <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
28 </span> 21 <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
29 </span> 22 <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
30 </span> 23 <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
31 </span> 24 <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
32 </span> 25 <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
33 </span> 26 <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
34 </span> 27 <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
35 </span> 28 <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
36 </span> 29 <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
37 </span> 30 <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
38 </span> 31 <span class="comment"> */</span>
39 32
40 33
41 34 <span class="comment">/*
42 </span> 35 <span class="comment"> * ======== Settings.xdc ========
43 </span> 36 <span class="comment"> *
44 </span> 37 <span class="comment"> */</span>
45 38
46 39
47 40 <span class=key>package</span> ti.grcm;
48 41
49 42
50 43 <span class="xdoc">/*!
51 </span> 44 <span class="xdoc"> * ======== Settings ========
52 </span> 45 <span class="xdoc"> * Global configuration settings for the ti.grcm package
53 </span> 46 <span class="xdoc"> *
54 </span> 47 <span class="xdoc"> * This is a RTSC meta-only module. When building your executable with
55 </span> 48 <span class="xdoc"> * XDCtools, use this module to configure this package.
56 </span> 49 <span class="xdoc"> *
57 </span> 50 <span class="xdoc"> * <b>@a(See Also)</b>
58 </span> 51 <span class="xdoc"> * <b>@p(dlist)</b>
59 </span> 52 <span class="xdoc"> * - {<b>@link</b> doxy(ti_grcm) RCM Overview}
60 </span> 53 <span class="xdoc"> * - {<b>@link</b> doxy(RcmClient.h) RcmClient File Reference}
61 </span> 54 <span class="xdoc"> * - {<b>@link</b> doxy(RcmServer.h) RcmServer File Reference}
62 </span> 55 <span class="xdoc"> * <b>@p</b>
63 </span> 56 <span class="xdoc"> */</span>
64 57
65 58 <span class=key>metaonly</span> <span class=key>module</span> Settings
66 59 {
67 60
68 61 <span class=comment>// -------- Module Constants --------</span>
69 62
70 63 <span class=comment>// -------- Module Types --------</span>
71 64
72 65 <span class="xdoc">/*!
73 </span> 66 <span class="xdoc"> * IPC Support enumeration type
74 </span> 67 <span class="xdoc"> *
75 </span> 68 <span class="xdoc"> * The IPC support is provided by one of the following types.
76 </span> 69 <span class="xdoc"> */</span>
77 70 <span class=key>enum</span> IpcSupport {
78 71 IpcSupport_ti_sdo_ipc, <span class=xdoc>//! DSP/BIOS IPC Support</span>
79 72 IpcSupport_ti_syslink_ipc <span class=xdoc>//! SysLink IPC Support</span>
80 73 };
81 74
82 75
83 76 <span class=comment>// -------- Module Parameters --------</span>
84 77
85 78 <span class="xdoc">/*!
86 </span> 79 <span class="xdoc"> * Specifies which IPC support to link into the executable
87 </span> 80 <span class="xdoc"> *
88 </span> 81 <span class="xdoc"> * This config param must be set in the application config script.
89 </span> 82 <span class="xdoc"> * It has no default value.
90 </span> 83 <span class="xdoc"> */</span>
91 84 <span class=key>config</span> IpcSupport ipc = IpcSupport_ti_sdo_ipc;
92 85
93 86 <span class="xdoc">/*!
94 </span> 87 <span class="xdoc"> * Controls the loading of string constants to the target
95 </span> 88 <span class="xdoc"> *
96 </span> 89 <span class="xdoc"> * By default, all string constants are loaded to the target. If the
97 </span> 90 <span class="xdoc"> * program is using a logger which does not process the strings, then
98 </span> 91 <span class="xdoc"> * setting this config param to false will reduce the program's data
99 </span> 92 <span class="xdoc"> * footprint because the string constants will not be loaded.
100 </span> 93 <span class="xdoc"> */</span>
101 94 <span class=key>config</span> Bool loadStrings = <span class=key>true</span>;
102 95 }
103 </pre>
104 </body></html>