[processor-sdk/performance-audio-sr.git] / processor_audio_sdk_1_00_00_00 / psdk_cust / ipc_3_43_00_00_eng / docs / doxygen / html / _mx_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/Mx.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">Mx.h</div> </div>
99 </div><!--header-->
100 <div class="contents">
101 <a href="_mx_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) 2012-2015, 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="l00042"></a><span class="lineno"> 42</span> <span class="preprocessor">#ifndef Mx__include</span></div>
134 <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#define Mx__include</span></div>
135 <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> </div>
136 <div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="preprocessor">#include <stddef.h></span></div>
137 <div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#include <stdint.h></span></div>
138 <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> </div>
139 <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="preprocessor">#if defined(__cplusplus)</span></div>
140 <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div>
141 <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="preprocessor">#endif</span></div>
142 <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> </div>
143 <div class="line"><a name="l00055"></a><span class="lineno"><a class="line" href="_mx_8h.html#ac7e1e82ff976b74bd796ca16b8674ffd"> 55</a></span> <span class="preprocessor">#define Mx_S_SUCCESS (0)</span></div>
144 <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div>
145 <div class="line"><a name="l00060"></a><span class="lineno"><a class="line" href="_mx_8h.html#a8ce38b60222338436de4e7d0ee038cae"> 60</a></span> <span class="preprocessor">#define Mx_E_FAIL (-1)</span></div>
146 <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> </div>
147 <div class="line"><a name="l00065"></a><span class="lineno"><a class="line" href="struct_mx___compute.html"> 65</a></span> <span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
148 <div class="line"><a name="l00066"></a><span class="lineno"><a class="line" href="struct_mx___compute.html#a34c9118798bba2d4d4a5814dc1c68fa3"> 66</a></span>  uint32_t <a class="code" href="struct_mx___compute.html#a34c9118798bba2d4d4a5814dc1c68fa3">coef</a>;</div>
149 <div class="line"><a name="l00067"></a><span class="lineno"><a class="line" href="struct_mx___compute.html#acb0bdd3c87fc093b3c74ece02be80dae"> 67</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct_mx___compute.html#acb0bdd3c87fc093b3c74ece02be80dae">key</a>;</div>
150 <div class="line"><a name="l00068"></a><span class="lineno"><a class="line" href="struct_mx___compute.html#ac4672491d59c46e5ef6496559e3e900e"> 68</a></span>  <span class="keywordtype">int</span> <a class="code" href="struct_mx___compute.html#ac4672491d59c46e5ef6496559e3e900e">size</a>;</div>
151 <div class="line"><a name="l00069"></a><span class="lineno"><a class="line" href="struct_mx___compute.html#ab3a29f25cae2d40816cb1522b5568afe"> 69</a></span>  uint32_t * <a class="code" href="struct_mx___compute.html#ab3a29f25cae2d40816cb1522b5568afe">inBuf</a>;</div>
152 <div class="line"><a name="l00070"></a><span class="lineno"><a class="line" href="struct_mx___compute.html#adc0f516fc19bebc8ea8158b3c0736370"> 70</a></span>  uint32_t * <a class="code" href="struct_mx___compute.html#adc0f516fc19bebc8ea8158b3c0736370">outBuf</a>;</div>
153 <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> } <a class="code" href="struct_mx___compute.html">Mx_Compute</a>;</div>
154 <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> </div>
155 <div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="keywordtype">int</span> <a class="code" href="_mx_8h.html#affea8e4781a718740da9ca3f9b591af5">Mx_initialize</a>(UInt16 procId);</div>
156 <div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
157 <div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="keywordtype">void</span> <a class="code" href="_mx_8h.html#a1327ad38d1fa462a51676e807dbdf3e3">Mx_finalize</a>(<span class="keywordtype">void</span>);</div>
158 <div class="line"><a name="l00082"></a><span class="lineno"> 82</span> </div>
159 <div class="line"><a name="l00086"></a><span class="lineno"> 86</span> int32_t <a class="code" href="_mx_8h.html#a699b4953029c9e5f10511a31e0736d00">Mx_triple</a>(uint32_t a);</div>
160 <div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
161 <div class="line"><a name="l00091"></a><span class="lineno"> 91</span> int32_t <a class="code" href="_mx_8h.html#a5a56547e7361187f54da4d5b4a9a42db">Mx_add</a>(int32_t a, int32_t b);</div>
162 <div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
163 <div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="preprocessor">#if defined(IPC_BUILDOS_QNX)</span></div>
164 <div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div>
165 <div class="line"><a name="l00099"></a><span class="lineno"> 99</span> int32_t Mx_compute_QnX(<a class="code" href="struct_mx___compute.html">Mx_Compute</a> *compute);</div>
166 <div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div>
167 <div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#else </span><span class="comment">/* Linux */</span><span class="preprocessor"></span></div>
168 <div class="line"><a name="l00102"></a><span class="lineno"> 102</span> </div>
169 <div class="line"><a name="l00108"></a><span class="lineno"> 108</span> int32_t <a class="code" href="_mx_8h.html#a346c1c8f022bde521c15a31470c628f9">Mx_compute_Linux</a>(<a class="code" href="struct_mx___compute.html">Mx_Compute</a> *compute, <span class="keywordtype">int</span> fd, <span class="keywordtype">int</span> fdIn, <span class="keywordtype">int</span> fdOut);</div>
170 <div class="line"><a name="l00109"></a><span class="lineno"> 109</span> </div>
171 <div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="preprocessor">#endif</span></div>
172 <div class="line"><a name="l00111"></a><span class="lineno"> 111</span> </div>
173 <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="preprocessor">#if defined(__cplusplus)</span></div>
174 <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> }</div>
175 <div class="line"><a name="l00114"></a><span class="lineno"> 114</span> <span class="preprocessor">#endif</span></div>
176 <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="preprocessor">#endif </span><span class="comment">/* Mx__include */</span><span class="preprocessor"></span></div>
177 <div class="ttc" id="struct_mx___compute_html_a34c9118798bba2d4d4a5814dc1c68fa3"><div class="ttname"><a href="struct_mx___compute.html#a34c9118798bba2d4d4a5814dc1c68fa3">Mx_Compute::coef</a></div><div class="ttdeci">uint32_t coef</div><div class="ttdef"><b>Definition:</b> Mx.h:66</div></div>
178 <div class="ttc" id="struct_mx___compute_html_adc0f516fc19bebc8ea8158b3c0736370"><div class="ttname"><a href="struct_mx___compute.html#adc0f516fc19bebc8ea8158b3c0736370">Mx_Compute::outBuf</a></div><div class="ttdeci">uint32_t * outBuf</div><div class="ttdef"><b>Definition:</b> Mx.h:70</div></div>
179 <div class="ttc" id="struct_mx___compute_html"><div class="ttname"><a href="struct_mx___compute.html">Mx_Compute</a></div><div class="ttdoc">Compute structure. </div><div class="ttdef"><b>Definition:</b> Mx.h:65</div></div>
180 <div class="ttc" id="_mx_8h_html_a346c1c8f022bde521c15a31470c628f9"><div class="ttname"><a href="_mx_8h.html#a346c1c8f022bde521c15a31470c628f9">Mx_compute_Linux</a></div><div class="ttdeci">int32_t Mx_compute_Linux(Mx_Compute *compute, int fd, int fdIn, int fdOut)</div><div class="ttdoc">Sample function which has pointer parameter (DMA_BUF) to a structure with two embedded pointers...</div></div>
181 <div class="ttc" id="_mx_8h_html_a1327ad38d1fa462a51676e807dbdf3e3"><div class="ttname"><a href="_mx_8h.html#a1327ad38d1fa462a51676e807dbdf3e3">Mx_finalize</a></div><div class="ttdeci">void Mx_finalize(void)</div><div class="ttdoc">Finalize the module, must be called last. </div></div>
182 <div class="ttc" id="struct_mx___compute_html_acb0bdd3c87fc093b3c74ece02be80dae"><div class="ttname"><a href="struct_mx___compute.html#acb0bdd3c87fc093b3c74ece02be80dae">Mx_Compute::key</a></div><div class="ttdeci">int key</div><div class="ttdef"><b>Definition:</b> Mx.h:67</div></div>
183 <div class="ttc" id="_mx_8h_html_affea8e4781a718740da9ca3f9b591af5"><div class="ttname"><a href="_mx_8h.html#affea8e4781a718740da9ca3f9b591af5">Mx_initialize</a></div><div class="ttdeci">int Mx_initialize(UInt16 procId)</div><div class="ttdoc">Initialize the module, must be called first. </div></div>
184 <div class="ttc" id="_mx_8h_html_a699b4953029c9e5f10511a31e0736d00"><div class="ttname"><a href="_mx_8h.html#a699b4953029c9e5f10511a31e0736d00">Mx_triple</a></div><div class="ttdeci">int32_t Mx_triple(uint32_t a)</div><div class="ttdoc">Sample function which multiplies argument by three. </div></div>
185 <div class="ttc" id="_mx_8h_html_a5a56547e7361187f54da4d5b4a9a42db"><div class="ttname"><a href="_mx_8h.html#a5a56547e7361187f54da4d5b4a9a42db">Mx_add</a></div><div class="ttdeci">int32_t Mx_add(int32_t a, int32_t b)</div><div class="ttdoc">Sample function which addes two arguments. </div></div>
186 <div class="ttc" id="struct_mx___compute_html_ab3a29f25cae2d40816cb1522b5568afe"><div class="ttname"><a href="struct_mx___compute.html#ab3a29f25cae2d40816cb1522b5568afe">Mx_Compute::inBuf</a></div><div class="ttdeci">uint32_t * inBuf</div><div class="ttdef"><b>Definition:</b> Mx.h:69</div></div>
187 <div class="ttc" id="struct_mx___compute_html_ac4672491d59c46e5ef6496559e3e900e"><div class="ttname"><a href="struct_mx___compute.html#ac4672491d59c46e5ef6496559e3e900e">Mx_Compute::size</a></div><div class="ttdeci">int size</div><div class="ttdef"><b>Definition:</b> Mx.h:68</div></div>
188 </div><!-- fragment --></div><!-- contents -->
189 <!-- HTML footer for doxygen 1.8.9.1-->
190 <!-- start footer part -->
191 <hr class="footer"/><small>
192 Copyright 2016, Texas Instruments Incorporated
193 </small>
194 </body>
195 </html>