[processor-sdk/performance-audio-sr.git] / ipc_3_43_00_00_eng / docs / doxygen / html / _gate_m_p_app_common_8h_source.html
1 <!-- HTML header for doxygen 1.8.9.1-->
2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns="http://www.w3.org/1999/xhtml">
4 <head>
5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
6 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
7 <meta name="generator" content="Doxygen 1.8.9.1"/>
8 <title>IPC API: ti/ipc/tests/GateMPAppCommon.h Source File</title>
9 <link href="tabs.css" rel="stylesheet" type="text/css"/>
10 <script type="text/javascript" src="jquery.js"></script>
11 <script type="text/javascript" src="dynsections.js"></script>
12 <link href="search/search.css" rel="stylesheet" type="text/css"/>
13 <script type="text/javascript" src="search/searchdata.js"></script>
14 <script type="text/javascript" src="search/search.js"></script>
15 <script type="text/javascript">
16 $(document).ready(function() { init_search(); });
17 </script>
18 <link href="doxygen.css" rel="stylesheet" type="text/css" />
19 </head>
20 <body>
21 <table width="100%">
22 <tr>
23 <td bgcolor="black" width="1"><a href="http://www.ti.com"><img border="0" src="tilogo.gif" /></a></td>
24 <td bgcolor="red"><img src="titagline.gif" /></td>
25 </tr>
26 </table>
27 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
28 <div id="titlearea">
29 <table cellspacing="0" cellpadding="0">
30 <tbody>
31 <tr style="height: 56px;">
32 <td style="padding-left: 0.5em;">
33 <div id="projectname">IPC API
34  <span id="projectnumber">3.43.00.00_eng</span>
35 </div>
36 </td>
37 </tr>
38 </tbody>
39 </table>
40 </div>
41 <!-- end header part -->
42 <!-- Generated by Doxygen 1.8.9.1 -->
43 <script type="text/javascript">
44 var searchBox = new SearchBox("searchBox", "search",false,'Search');
45 </script>
46 <div id="navrow1" class="tabs">
47 <ul class="tablist">
48 <li><a href="index.html"><span>Main Page</span></a></li>
49 <li><a href="modules.html"><span>Modules</span></a></li>
50 <li><a href="annotated.html"><span>Data Structures</span></a></li>
51 <li class="current"><a href="files.html"><span>Files</span></a></li>
52 <li><a href="pages.html"><span>Related Pages</span></a></li>
53 <li>
54 <div id="MSearchBox" class="MSearchBoxInactive">
55 <span class="left">
56 <img id="MSearchSelect" src="search/mag_sel.png"
57 onmouseover="return searchBox.OnSearchSelectShow()"
58 onmouseout="return searchBox.OnSearchSelectHide()"
59 alt=""/>
60 <input type="text" id="MSearchField" value="Search" accesskey="S"
61 onfocus="searchBox.OnSearchFieldFocus(true)"
62 onblur="searchBox.OnSearchFieldFocus(false)"
63 onkeyup="searchBox.OnSearchFieldChange(event)"/>
64 </span><span class="right">
65 <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
66 </span>
67 </div>
68 </li>
69 </ul>
70 </div>
71 <div id="navrow2" class="tabs2">
72 <ul class="tablist">
73 <li><a href="files.html"><span>File List</span></a></li>
74 <li><a href="globals.html"><span>Globals</span></a></li>
75 </ul>
76 </div>
77 <!-- window showing the filter options -->
78 <div id="MSearchSelectWindow"
79 onmouseover="return searchBox.OnSearchSelectShow()"
80 onmouseout="return searchBox.OnSearchSelectHide()"
81 onkeydown="return searchBox.OnSearchSelectKey(event)">
82 </div>
84 <!-- iframe showing the search results (closed by default) -->
85 <div id="MSearchResultsWindow">
86 <iframe src="javascript:void(0)" frameborder="0"
87 name="MSearchResults" id="MSearchResults">
88 </iframe>
89 </div>
91 <div id="nav-path" class="navpath">
92 <ul>
93 <li class="navelem"><a class="el" href="dir_46079174fecd82ead33d8fa28082a6fc.html">ti</a></li><li class="navelem"><a class="el" href="dir_d15d182bf14778c656928067305f92ce.html">ipc</a></li><li class="navelem"><a class="el" href="dir_07c7484972aa6b4e3faecc6ab62955c0.html">tests</a></li> </ul>
94 </div>
95 </div><!-- top -->
96 <div class="header">
97 <div class="headertitle">
98 <div class="title">GateMPAppCommon.h</div> </div>
99 </div><!--header-->
100 <div class="contents">
101 <a href="_gate_m_p_app_common_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
102 <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (c) 2013, Texas Instruments Incorporated</span></div>
103 <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * All rights reserved.</span></div>
104 <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
105 <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * Redistribution and use in source and binary forms, with or without</span></div>
106 <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * modification, are permitted provided that the following conditions</span></div>
107 <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * are met:</span></div>
108 <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> *</span></div>
109 <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * * Redistributions of source code must retain the above copyright</span></div>
110 <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * notice, this list of conditions and the following disclaimer.</span></div>
111 <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
112 <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * * Redistributions in binary form must reproduce the above copyright</span></div>
113 <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * notice, this list of conditions and the following disclaimer in the</span></div>
114 <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * documentation and/or other materials provided with the distribution.</span></div>
115 <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div>
116 <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * * Neither the name of Texas Instruments Incorporated nor the names of</span></div>
117 <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * its contributors may be used to endorse or promote products derived</span></div>
118 <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * from this software without specific prior written permission.</span></div>
119 <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> *</span></div>
120 <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"</span></div>
121 <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,</span></div>
122 <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR</span></div>
123 <div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR</span></div>
124 <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,</span></div>
125 <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,</span></div>
126 <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;</span></div>
127 <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,</span></div>
128 <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR</span></div>
129 <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,</span></div>
130 <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</span></div>
131 <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> */</span></div>
132 <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div>
133 <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment">/*</span></div>
134 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> * ======== GateMPAppCommon.h ========</span></div>
135 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> *</span></div>
136 <div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"> */</span></div>
137 <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
138 <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="preprocessor">#ifndef GateMPAppCommon__include</span></div>
139 <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#define GateMPAppCommon__include</span></div>
140 <div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="preprocessor">#if defined (__cplusplus)</span></div>
141 <div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
142 <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#endif</span></div>
143 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> </div>
144 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
145 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment">/*</span></div>
146 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> * ======== Application Configuration ========</span></div>
147 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> */</span></div>
148 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div>
149 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment">/* notify commands 00 - FF */</span></div>
150 <div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a3fd94762a1e059f54a6f87f85b79b182"> 50</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_MASK 0xFF000000</span></div>
151 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
152 <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment">/* used by host and remote device to synchronize states with each other*/</span></div>
153 <div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a2185481be5c20c2a678b3915dccefd96"> 53</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_SPTR_ADDR 0x10000000</span></div>
154 <div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#ac3db8050e5b2bc295abcc22132fe3488"> 54</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_SPTR_ADDR_ACK 0x12000000</span></div>
155 <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a8d6c46290c62161603d87ad9053f07a3"> 55</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_SHUTDOWN_ACK 0x20000000</span></div>
156 <div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#ad6db1df2c8012d9d9b1defc9b136d0c8"> 56</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_SHUTDOWN 0x21000000</span></div>
157 <div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#afb5cf14d04c6eb09349650cc71b4aede"> 57</a></span> <span class="preprocessor">#define GATEMPAPP_CMD_SYNC 0x30000000</span></div>
158 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
159 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment">/* GateMP instance created on host */</span></div>
160 <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a43a955c75b187d9f0b963100c563f458"> 60</a></span> <span class="preprocessor">#define GATEMP_HOST_NAME "GATE_MP1"</span></div>
161 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment">/* GateMP instance created on slave */</span></div>
162 <div class="line"><a name="l00062"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#ae91b350694f58554ddb23b7bf44a15ee"> 62</a></span> <span class="preprocessor">#define GATEMP_SLAVE_NAME "GATE_MP2"</span></div>
163 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div>
164 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment">/* queue error message*/</span></div>
165 <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#af8eef05ae55b4664cda5507ef65d6e78"> 65</a></span> <span class="preprocessor">#define GATEMPAPP_E_FAILURE 0xF0000000</span></div>
166 <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a5b76079a5c1a27cacc75eec1a50c121f"> 66</a></span> <span class="preprocessor">#define GATEMPAPP_E_UNEXPECTEDMSG 0xF2000000</span></div>
167 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div>
168 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment">/* Number of times to lock/unlock */</span></div>
169 <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a881b50418065d33c9a0abd0996a2ac7b"> 69</a></span> <span class="preprocessor">#define LOOP_ITR 300</span></div>
170 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> </div>
171 <div class="line"><a name="l00071"></a><span class="lineno"><a class="line" href="struct_gate_m_p_app___msg.html"> 71</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
172 <div class="line"><a name="l00072"></a><span class="lineno"><a class="line" href="struct_gate_m_p_app___msg.html#a284c23e5eb597114358f0631602dc36a"> 72</a></span>  <a class="code" href="struct_message_q___msg_header.html">MessageQ_MsgHeader</a> <a class="code" href="struct_gate_m_p_app___msg.html#a284c23e5eb597114358f0631602dc36a">reserved</a>;</div>
173 <div class="line"><a name="l00073"></a><span class="lineno"><a class="line" href="struct_gate_m_p_app___msg.html#abf97c120ba376049418549b25c91677c"> 73</a></span>  UInt32 <a class="code" href="struct_gate_m_p_app___msg.html#abf97c120ba376049418549b25c91677c">cmd</a>;</div>
174 <div class="line"><a name="l00074"></a><span class="lineno"><a class="line" href="struct_gate_m_p_app___msg.html#ab24dd0fe6834c3e620dc336670b9acd7"> 74</a></span>  UInt32 <a class="code" href="struct_gate_m_p_app___msg.html#ab24dd0fe6834c3e620dc336670b9acd7">payload</a>;</div>
175 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> } <a class="code" href="struct_gate_m_p_app___msg.html">GateMPApp_Msg</a>;</div>
176 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> </div>
177 <div class="line"><a name="l00077"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#a4afde864eef6d038d2829fb1f428811d"> 77</a></span> <span class="preprocessor">#define GateMPApp_MsgHeapId 0</span></div>
178 <div class="line"><a name="l00078"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#aed1a99c370d9b1fc7f3d92fc80ff49ce"> 78</a></span> <span class="preprocessor">#define GateMPApp_HostMsgQueName "HOST:MsgQ:01"</span></div>
179 <div class="line"><a name="l00079"></a><span class="lineno"><a class="line" href="_gate_m_p_app_common_8h.html#af753067f2359392ec781da1643db8c48"> 79</a></span> <span class="preprocessor">#define GateMPApp_SlaveMsgQueName "SLAVE:MsgQ:01"</span></div>
180 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
181 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="preprocessor">#if defined (__cplusplus)</span></div>
182 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> }</div>
183 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="preprocessor">#endif </span><span class="comment">/* defined (__cplusplus) */</span><span class="preprocessor"></span></div>
184 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="preprocessor">#endif </span><span class="comment">/* GateMPAppCommon__include */</span><span class="preprocessor"></span></div>
185 <div class="ttc" id="struct_gate_m_p_app___msg_html"><div class="ttname"><a href="struct_gate_m_p_app___msg.html">GateMPApp_Msg</a></div><div class="ttdef"><b>Definition:</b> GateMPAppCommon.h:71</div></div>
186 <div class="ttc" id="struct_gate_m_p_app___msg_html_a284c23e5eb597114358f0631602dc36a"><div class="ttname"><a href="struct_gate_m_p_app___msg.html#a284c23e5eb597114358f0631602dc36a">GateMPApp_Msg::reserved</a></div><div class="ttdeci">MessageQ_MsgHeader reserved</div><div class="ttdef"><b>Definition:</b> GateMPAppCommon.h:72</div></div>
187 <div class="ttc" id="struct_message_q___msg_header_html"><div class="ttname"><a href="struct_message_q___msg_header.html">MessageQ_MsgHeader</a></div><div class="ttdoc">Required first field in every message. </div><div class="ttdef"><b>Definition:</b> MessageQ.h:601</div></div>
188 <div class="ttc" id="struct_gate_m_p_app___msg_html_abf97c120ba376049418549b25c91677c"><div class="ttname"><a href="struct_gate_m_p_app___msg.html#abf97c120ba376049418549b25c91677c">GateMPApp_Msg::cmd</a></div><div class="ttdeci">UInt32 cmd</div><div class="ttdef"><b>Definition:</b> GateMPAppCommon.h:73</div></div>
189 <div class="ttc" id="struct_gate_m_p_app___msg_html_ab24dd0fe6834c3e620dc336670b9acd7"><div class="ttname"><a href="struct_gate_m_p_app___msg.html#ab24dd0fe6834c3e620dc336670b9acd7">GateMPApp_Msg::payload</a></div><div class="ttdeci">UInt32 payload</div><div class="ttdef"><b>Definition:</b> GateMPAppCommon.h:74</div></div>
190 </div><!-- fragment --></div><!-- contents -->
191 <!-- HTML footer for doxygen 1.8.9.1-->
192 <!-- start footer part -->
193 <hr class="footer"/><small>
194 Copyright 2016, Texas Instruments Incorporated
195 </small>
196 </body>
197 </html>