[processor-sdk/performance-audio-sr.git] / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / _rcm_types_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/grcm/RcmTypes.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_69da2738e79cd78673c2b69538fc568b.html">grcm</a></li> </ul>
94 </div>
95 </div><!-- top -->
96 <div class="header">
97 <div class="headertitle">
98 <div class="title">RcmTypes.h</div> </div>
99 </div><!--header-->
100 <div class="contents">
101 <a href="_rcm_types_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) 2011-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> </div>
134 <div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">/*</span></div>
135 <div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> * ======== RcmTypes.h ========</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> <span class="comment"> */</span></div>
138 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#ifndef ti_grcm_RcmTypes_h</span></div>
139 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#define ti_grcm_RcmTypes_h</span></div>
140 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> </div>
141 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment">/*</span></div>
142 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> * Force use of the RPMessage instead of MessageQ API for SysLink 3 IPC.</span></div>
143 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> * This is temporary to get a protoype working.</span></div>
144 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * Ideally, RPMessage should not be needed.</span></div>
145 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
146 <div class="line"><a name="l00052"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a3b61a9497ceac9a87af917af9e175a72"> 52</a></span> <span class="preprocessor">#define USE_RPMESSAGE 1</span></div>
147 <div class="line"><a name="l00053"></a><span class="lineno"> 53</span> </div>
148 <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#if USE_RPMESSAGE</span></div>
149 <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#include <ti/ipc/rpmsg/RPMessage.h></span></div>
150 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="preprocessor">#else</span></div>
151 <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#include <<a class="code" href="_message_q_8h.html">ti/ipc/MessageQ.h</a>></span></div>
152 <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#endif</span></div>
153 <div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div>
154 <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="preprocessor">#include <<a class="code" href="_rcm_client_8h.html">ti/grcm/RcmClient.h</a>></span></div>
155 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
156 <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
157 <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment">/*</span></div>
158 <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> * ======== RcmClient_Packet ========</span></div>
159 <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> *</span></div>
160 <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * RcmClient_Packet.desc: the package descriptor field. Note that the</span></div>
161 <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * format is different for out-bound and in-bound messages.</span></div>
162 <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> *</span></div>
163 <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> * out-bound message descriptor</span></div>
164 <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> *</span></div>
165 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> * Bits Description</span></div>
166 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> * --------------------------------------------------------------------</span></div>
167 <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> * [15:12] reserved</span></div>
168 <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> * [11:8] message type</span></div>
169 <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> * [7:0] client protocol version</span></div>
170 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"> *</span></div>
171 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> *</span></div>
172 <div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * in-bound message descriptor</span></div>
173 <div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> *</span></div>
174 <div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="comment"> * Bits Description</span></div>
175 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"> * --------------------------------------------------------------------</span></div>
176 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> * [15:12] reserved</span></div>
177 <div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * [11:8] server status code</span></div>
178 <div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> * [7:0] server protocol version</span></div>
179 <div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="comment"> */</span></div>
180 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
181 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> <span class="comment">/* message type values */</span></div>
182 <div class="line"><a name="l00088"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#ae693b370275e6c606706db25dca73223"> 88</a></span> <span class="preprocessor">#define RcmClient_Desc_RCM_MSG 0x1 </span><span class="comment">/* client exec message*/</span><span class="preprocessor"></span></div>
183 <div class="line"><a name="l00089"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a125a23fd088e1eb074ac8c3f6d11a839"> 89</a></span> <span class="preprocessor">#define RcmClient_Desc_DPC 0x2 </span><span class="comment">/* deferred procedure call*/</span><span class="preprocessor"></span></div>
184 <div class="line"><a name="l00090"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#aaafd88cf09e2450678b1a976398b5511"> 90</a></span> <span class="preprocessor">#define RcmClient_Desc_SYM_ADD 0x3 </span><span class="comment">/* symbol add message*/</span><span class="preprocessor"></span></div>
185 <div class="line"><a name="l00091"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#aabb5541f14d54d22b63a8c602ed5f346"> 91</a></span> <span class="preprocessor">#define RcmClient_Desc_SYM_IDX 0x4 </span><span class="comment">/* query symbox index*/</span><span class="preprocessor"></span></div>
186 <div class="line"><a name="l00092"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a5e30fa308815e510161409525744f6bb"> 92</a></span> <span class="preprocessor">#define RcmClient_Desc_CMD 0x5 </span><span class="comment">/* cmd message (one-way)*/</span><span class="preprocessor"></span></div>
187 <div class="line"><a name="l00093"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a160703512ce8f8718532c0209a6c662a"> 93</a></span> <span class="preprocessor">#define RcmClient_Desc_JOB_ACQ 0x6 </span><span class="comment">/* acquire a job id*/</span><span class="preprocessor"></span></div>
188 <div class="line"><a name="l00094"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#adb6543ad86406608e160e5f5dc6f31ba"> 94</a></span> <span class="preprocessor">#define RcmClient_Desc_JOB_REL 0x7 </span><span class="comment">/* release a job id*/</span><span class="preprocessor"></span></div>
189 <div class="line"><a name="l00095"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a96235d76aa079930ae704c24056a668a"> 95</a></span> <span class="preprocessor">#define RcmClient_Desc_TYPE_MASK 0x0F00 </span><span class="comment">/* field mask*/</span><span class="preprocessor"></span></div>
190 <div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a8645d0673744f2aaf1a2b0f92bf2f1c1"> 96</a></span> <span class="preprocessor">#define RcmClient_Desc_TYPE_SHIFT 8 </span><span class="comment">/* field shift width*/</span><span class="preprocessor"></span></div>
191 <div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
192 <div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="comment">/* server status codes must be 0 - 15, it has to fit in a 4-bit field */</span></div>
193 <div class="line"><a name="l00099"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a3af4c70805ff0634acab80525c907379"> 99</a></span> <span class="preprocessor">#define RcmServer_Status_SUCCESS ((UInt16)0) </span><span class="comment">/* success*/</span><span class="preprocessor"></span></div>
194 <div class="line"><a name="l00100"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a034c1af17ef7b0315c7933862f8efc0c"> 100</a></span> <span class="preprocessor">#define RcmServer_Status_INVALID_FXN ((UInt16)1) </span><span class="comment">/* invalid fxn index*/</span><span class="preprocessor"></span></div>
195 <div class="line"><a name="l00101"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#ae8a4449b6f80f6d6c382b32e037a60af"> 101</a></span> <span class="preprocessor">#define RcmServer_Status_SYMBOL_NOT_FOUND ((UInt16)2) </span><span class="comment">/* symbol not found*/</span><span class="preprocessor"></span></div>
196 <div class="line"><a name="l00102"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a719dba566e532b367769ecda8bb5b47e"> 102</a></span> <span class="preprocessor">#define RcmServer_Status_INVALID_MSG_TYPE ((UInt16)3) </span><span class="comment">/* invalid msg type*/</span><span class="preprocessor"></span></div>
197 <div class="line"><a name="l00103"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#ae936443729b13db3c82307b4dfef63f8"> 103</a></span> <span class="preprocessor">#define RcmServer_Status_MSG_FXN_ERR ((UInt16)4) </span><span class="comment">/* msg function error*/</span><span class="preprocessor"></span></div>
198 <div class="line"><a name="l00104"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a07a25b0dcb8551830c58ed11055377fc"> 104</a></span> <span class="preprocessor">#define RcmServer_Status_Error ((UInt16)5) </span><span class="comment">/* general failure*/</span><span class="preprocessor"></span></div>
199 <div class="line"><a name="l00105"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#aa4f772bfd092a6fce8011d5e22fbcaef"> 105</a></span> <span class="preprocessor">#define RcmServer_Status_Unprocessed ((UInt16)6) </span><span class="comment">/* unprocessed message*/</span><span class="preprocessor"></span></div>
200 <div class="line"><a name="l00106"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#aaee26bff874da341322ef0f868766830"> 106</a></span> <span class="preprocessor">#define RcmServer_Status_JobNotFound ((UInt16)7) </span><span class="comment">/* job id not found*/</span><span class="preprocessor"></span></div>
201 <div class="line"><a name="l00107"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a73ddaf749f1234eb7c517dcc8846b9b6"> 107</a></span> <span class="preprocessor">#define RcmServer_Status_PoolNotFound ((UInt16)8) </span><span class="comment">/* pool id not found*/</span><span class="preprocessor"></span></div>
202 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> </div>
203 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> <span class="comment">/* the packet structure (actual message send to server) */</span></div>
204 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> </div>
205 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> <span class="preprocessor">#if USE_RPMESSAGE</span></div>
206 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment">/* Need to deal with this structure, as Linux side rpmsg_omx driver needs it: */</span></div>
207 <div class="line"><a name="l00113"></a><span class="lineno"><a class="line" href="structrpmsg__omx__hdr.html"> 113</a></span> <span class="keyword">struct </span><a class="code" href="structrpmsg__omx__hdr.html">rpmsg_omx_hdr</a> {</div>
208 <div class="line"><a name="l00114"></a><span class="lineno"><a class="line" href="structrpmsg__omx__hdr.html#a11192f8bf26ec33bbfb76bcb2dd56eef"> 114</a></span>  UInt32 <a class="code" href="structrpmsg__omx__hdr.html#a11192f8bf26ec33bbfb76bcb2dd56eef">type</a>;</div>
209 <div class="line"><a name="l00115"></a><span class="lineno"><a class="line" href="structrpmsg__omx__hdr.html#a1ad7b59eed5e90900509fc72ce516b96"> 115</a></span>  UInt32 <a class="code" href="structrpmsg__omx__hdr.html#a1ad7b59eed5e90900509fc72ce516b96">len</a>;</div>
210 <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> };</div>
211 <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> </div>
212 <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment">/*</span></div>
213 <div class="line"><a name="l00119"></a><span class="lineno"> 119</span> <span class="comment"> * Warning: This packet cannot be placed on RCMServer job queues, so can't use</span></div>
214 <div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="comment"> * that capability for now.</span></div>
215 <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> */</span></div>
216 <div class="line"><a name="l00122"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html"> 122</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
217 <div class="line"><a name="l00123"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#a8c904ef1675a8a1684eebbd24d34db7f"> 123</a></span>  Bits32 <a class="code" href="struct_rcm_client___packet.html#a8c904ef1675a8a1684eebbd24d34db7f">reserved0</a>; <span class="comment">/* reserved for List.elem->next */</span></div>
218 <div class="line"><a name="l00124"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#a7be15cc650ede871cb42803390a039ce"> 124</a></span>  Bits32 <a class="code" href="struct_rcm_client___packet.html#a7be15cc650ede871cb42803390a039ce">reserved1</a>; <span class="comment">/* reserved for List.elem->prev */</span></div>
219 <div class="line"><a name="l00125"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#ab7288eeb04aff732a464ec673e571e38"> 125</a></span>  <span class="keyword">struct </span><a class="code" href="structrpmsg__omx__hdr.html">rpmsg_omx_hdr</a> hdr;</div>
220 <div class="line"><a name="l00126"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#afe581d89b117e6a4bd0b2442b7ebf112"> 126</a></span>  UInt16 <a class="code" href="struct_rcm_client___packet.html#afe581d89b117e6a4bd0b2442b7ebf112">desc</a>; <span class="comment">/* protocol, descriptor, status */</span></div>
221 <div class="line"><a name="l00127"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#a2af45b569ae11b1f50f9190c4e1f08db"> 127</a></span>  UInt16 <a class="code" href="struct_rcm_client___packet.html#a2af45b569ae11b1f50f9190c4e1f08db">msgId</a>; <span class="comment">/* message id */</span></div>
222 <div class="line"><a name="l00128"></a><span class="lineno"><a class="line" href="struct_rcm_client___packet.html#a3524e80eb61fdf42a721a9957186f7be"> 128</a></span>  <a class="code" href="struct_rcm_client___message.html">RcmClient_Message</a> <a class="code" href="struct_rcm_client___packet.html#a3524e80eb61fdf42a721a9957186f7be">message</a>; <span class="comment">/* client message body (5 words + payload) */</span></div>
223 <div class="line"><a name="l00129"></a><span class="lineno"> 129</span> } <a class="code" href="struct_rcm_client___packet.html">RcmClient_Packet</a>;</div>
224 <div class="line"><a name="l00130"></a><span class="lineno"> 130</span> </div>
225 <div class="line"><a name="l00131"></a><span class="lineno"> 131</span> <span class="comment">/*</span></div>
226 <div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="comment"> * Defined to equal packed structure size received on the host.</span></div>
227 <div class="line"><a name="l00133"></a><span class="lineno"> 133</span> <span class="comment"> * Strips off the first two ListElem fields and the .data[1] field in .message</span></div>
228 <div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="comment"> */</span></div>
229 <div class="line"><a name="l00135"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a29d0b08845ef4b9a331e0038ea7390d4"> 135</a></span> <span class="preprocessor">#define PACKET_HDR_SIZE (sizeof(RcmClient_Packet) - 3 * sizeof(UInt32))</span></div>
230 <div class="line"><a name="l00136"></a><span class="lineno"><a class="line" href="_rcm_types_8h.html#a515f46a87f301d94d9f3b06a6bb2540a"> 136</a></span> <span class="preprocessor">#define PACKET_DATA_SIZE (PACKET_HDR_SIZE - sizeof(struct rpmsg_omx_hdr))</span></div>
231 <div class="line"><a name="l00137"></a><span class="lineno"> 137</span> </div>
232 <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment">/* To test on BIOS side only, uncomment and rebuild anything that</span></div>
233 <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> * calls RPMessage()</span></div>
234 <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> */</span></div>
235 <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment">/* #define BIOS_ONLY_TEST */</span></div>
236 <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> </div>
237 <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="preprocessor">#else</span></div>
238 <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
239 <div class="line"><a name="l00145"></a><span class="lineno"> 145</span>  <a class="code" href="struct_message_q___msg_header.html">MessageQ_MsgHeader</a> msgqHeader; <span class="comment">/* MessageQ header (8 words)*/</span></div>
240 <div class="line"><a name="l00146"></a><span class="lineno"> 146</span>  UInt16 desc; <span class="comment">/* protocol, descriptor, status*/</span></div>
241 <div class="line"><a name="l00147"></a><span class="lineno"> 147</span>  UInt16 msgId; <span class="comment">/* message id*/</span></div>
242 <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  <a class="code" href="struct_rcm_client___message.html">RcmClient_Message</a> message; <span class="comment">/* client message body (5 words + payload)*/</span></div>
243 <div class="line"><a name="l00149"></a><span class="lineno"> 149</span> } <a class="code" href="struct_rcm_client___packet.html">RcmClient_Packet</a>;</div>
244 <div class="line"><a name="l00150"></a><span class="lineno"> 150</span> </div>
245 <div class="line"><a name="l00151"></a><span class="lineno"> 151</span> <span class="preprocessor">#endif</span></div>
246 <div class="line"><a name="l00152"></a><span class="lineno"> 152</span> </div>
247 <div class="line"><a name="l00153"></a><span class="lineno"> 153</span> <span class="comment">/* string functions */</span></div>
248 <div class="line"><a name="l00154"></a><span class="lineno"> 154</span> Void *<a class="code" href="_rcm_types_8h.html#a5e94e936b9e327789d8d9c413720c748">_memset</a>(Void *s, Int c, Int n);</div>
249 <div class="line"><a name="l00155"></a><span class="lineno"> 155</span> Int <a class="code" href="_rcm_types_8h.html#a53da5392d14ed23fdc1ec00a83d9feab">_strcmp</a>(Char *s, Char *t);</div>
250 <div class="line"><a name="l00156"></a><span class="lineno"> 156</span> Void <a class="code" href="_rcm_types_8h.html#ac3900954b5e1043375e28c180c0f5cb9">_strcpy</a>(Char *s, Char *t);</div>
251 <div class="line"><a name="l00157"></a><span class="lineno"> 157</span> Int <a class="code" href="_rcm_types_8h.html#a94f1820099c1a6117a9421caaceadc75">_strlen</a>(<span class="keyword">const</span> Char *s);</div>
252 <div class="line"><a name="l00158"></a><span class="lineno"> 158</span> </div>
253 <div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif </span><span class="comment">/* ti_grcm_RcmTypes_h */</span><span class="preprocessor"></span></div>
254 <div class="ttc" id="struct_rcm_client___packet_html_a2af45b569ae11b1f50f9190c4e1f08db"><div class="ttname"><a href="struct_rcm_client___packet.html#a2af45b569ae11b1f50f9190c4e1f08db">RcmClient_Packet::msgId</a></div><div class="ttdeci">UInt16 msgId</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:127</div></div>
255 <div class="ttc" id="_message_q_8h_html"><div class="ttname"><a href="_message_q_8h.html">MessageQ.h</a></div><div class="ttdoc">MessageQ Manager. </div></div>
256 <div class="ttc" id="struct_rcm_client___packet_html_a7be15cc650ede871cb42803390a039ce"><div class="ttname"><a href="struct_rcm_client___packet.html#a7be15cc650ede871cb42803390a039ce">RcmClient_Packet::reserved1</a></div><div class="ttdeci">Bits32 reserved1</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:124</div></div>
257 <div class="ttc" id="structrpmsg__omx__hdr_html"><div class="ttname"><a href="structrpmsg__omx__hdr.html">rpmsg_omx_hdr</a></div><div class="ttdef"><b>Definition:</b> RcmTypes.h:113</div></div>
258 <div class="ttc" id="struct_rcm_client___packet_html_a8c904ef1675a8a1684eebbd24d34db7f"><div class="ttname"><a href="struct_rcm_client___packet.html#a8c904ef1675a8a1684eebbd24d34db7f">RcmClient_Packet::reserved0</a></div><div class="ttdeci">Bits32 reserved0</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:123</div></div>
259 <div class="ttc" id="struct_rcm_client___packet_html"><div class="ttname"><a href="struct_rcm_client___packet.html">RcmClient_Packet</a></div><div class="ttdef"><b>Definition:</b> RcmTypes.h:122</div></div>
260 <div class="ttc" id="structrpmsg__omx__hdr_html_a11192f8bf26ec33bbfb76bcb2dd56eef"><div class="ttname"><a href="structrpmsg__omx__hdr.html#a11192f8bf26ec33bbfb76bcb2dd56eef">rpmsg_omx_hdr::type</a></div><div class="ttdeci">UInt32 type</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:114</div></div>
261 <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>
262 <div class="ttc" id="_rcm_client_8h_html"><div class="ttname"><a href="_rcm_client_8h.html">RcmClient.h</a></div><div class="ttdoc">Remote Command Message Client Module. An RcmClient is used for sending messages to an RcmServer for p...</div></div>
263 <div class="ttc" id="struct_rcm_client___message_html"><div class="ttname"><a href="struct_rcm_client___message.html">RcmClient_Message</a></div><div class="ttdoc">Remote Command Message structure. </div><div class="ttdef"><b>Definition:</b> RcmClient.h:441</div></div>
264 <div class="ttc" id="_rcm_types_8h_html_a53da5392d14ed23fdc1ec00a83d9feab"><div class="ttname"><a href="_rcm_types_8h.html#a53da5392d14ed23fdc1ec00a83d9feab">_strcmp</a></div><div class="ttdeci">Int _strcmp(Char *s, Char *t)</div></div>
265 <div class="ttc" id="structrpmsg__omx__hdr_html_a1ad7b59eed5e90900509fc72ce516b96"><div class="ttname"><a href="structrpmsg__omx__hdr.html#a1ad7b59eed5e90900509fc72ce516b96">rpmsg_omx_hdr::len</a></div><div class="ttdeci">UInt32 len</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:115</div></div>
266 <div class="ttc" id="_rcm_types_8h_html_a5e94e936b9e327789d8d9c413720c748"><div class="ttname"><a href="_rcm_types_8h.html#a5e94e936b9e327789d8d9c413720c748">_memset</a></div><div class="ttdeci">Void * _memset(Void *s, Int c, Int n)</div></div>
267 <div class="ttc" id="struct_rcm_client___packet_html_a3524e80eb61fdf42a721a9957186f7be"><div class="ttname"><a href="struct_rcm_client___packet.html#a3524e80eb61fdf42a721a9957186f7be">RcmClient_Packet::message</a></div><div class="ttdeci">RcmClient_Message message</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:128</div></div>
268 <div class="ttc" id="_rcm_types_8h_html_ac3900954b5e1043375e28c180c0f5cb9"><div class="ttname"><a href="_rcm_types_8h.html#ac3900954b5e1043375e28c180c0f5cb9">_strcpy</a></div><div class="ttdeci">Void _strcpy(Char *s, Char *t)</div></div>
269 <div class="ttc" id="_rcm_types_8h_html_a94f1820099c1a6117a9421caaceadc75"><div class="ttname"><a href="_rcm_types_8h.html#a94f1820099c1a6117a9421caaceadc75">_strlen</a></div><div class="ttdeci">Int _strlen(const Char *s)</div></div>
270 <div class="ttc" id="struct_rcm_client___packet_html_afe581d89b117e6a4bd0b2442b7ebf112"><div class="ttname"><a href="struct_rcm_client___packet.html#afe581d89b117e6a4bd0b2442b7ebf112">RcmClient_Packet::desc</a></div><div class="ttdeci">UInt16 desc</div><div class="ttdef"><b>Definition:</b> RcmTypes.h:126</div></div>
271 </div><!-- fragment --></div><!-- contents -->
272 <!-- HTML footer for doxygen 1.8.9.1-->
273 <!-- start footer part -->
274 <hr class="footer"/><small>
275 Copyright 2016, Texas Instruments Incorporated
276 </small>
277 </body>
278 </html>