git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/arm__fir__decimate__init__q15_8c_source.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2 <html xmlns="http://www.w3.org/1999/xhtml">
   3 <head>
   4 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   5 <title>CMSIS DSP Software Library: arm_fir_decimate_init_q15.c Source File</title>
   6 <link href="tabs.css" rel="stylesheet" type="text/css"/>
   7 <link href="search/search.css" rel="stylesheet" type="text/css"/>
   8 <script type="text/javaScript" src="search/search.js"></script>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 </head>
  11 <body onload='searchBox.OnSelectItem(0);'>
  12 <!-- Generated by Doxygen 1.7.2 -->
  13 <script type="text/javascript"><!--
  14 var searchBox = new SearchBox("searchBox", "search",false,'Search');
  15 --></script>
  16 <div class="navigation" id="top">
  17   <div class="tabs">
  18     <ul class="tablist">
  19       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  20       <li><a href="modules.html"><span>Modules</span></a></li>
  21       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
  22       <li class="current"><a href="files.html"><span>Files</span></a></li>
  23       <li><a href="examples.html"><span>Examples</span></a></li>
  24       <li id="searchli">
  25         <div id="MSearchBox" class="MSearchBoxInactive">
  26         <span class="left">
  27           <img id="MSearchSelect" src="search/mag_sel.png"
  28                onmouseover="return searchBox.OnSearchSelectShow()"
  29                onmouseout="return searchBox.OnSearchSelectHide()"
  30                alt=""/>
  31           <input type="text" id="MSearchField" value="Search" accesskey="S"
  32                onfocus="searchBox.OnSearchFieldFocus(true)"
  33                onblur="searchBox.OnSearchFieldFocus(false)"
  34                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  35           </span><span class="right">
  36             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  37           </span>
  38         </div>
  39       </li>
  40     </ul>
  41   </div>
  42   <div class="tabs2">
  43     <ul class="tablist">
  44       <li><a href="files.html"><span>File&#160;List</span></a></li>
  45       <li><a href="globals.html"><span>Globals</span></a></li>
  46     </ul>
  47   </div>
  48 <div class="header">
  49   <div class="headertitle">
  50 <h1>arm_fir_decimate_init_q15.c</h1>  </div>
  51 </div>
  52 <div class="contents">
  53 <a href="arm__fir__decimate__init__q15_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/* ----------------------------------------------------------------------   </span>
  54 <a name="l00002"></a>00002 <span class="comment">* Copyright (C) 2010 ARM Limited. All rights reserved.   </span>
  55 <a name="l00003"></a>00003 <span class="comment">*   </span>
  56 <a name="l00004"></a>00004 <span class="comment">* $Date:        15. July 2011  </span>
  57 <a name="l00005"></a>00005 <span class="comment">* $Revision:    V1.0.10  </span>
  58 <a name="l00006"></a>00006 <span class="comment">*   </span>
  59 <a name="l00007"></a>00007 <span class="comment">* Project:      CMSIS DSP Library   </span>
  60 <a name="l00008"></a>00008 <span class="comment">* Title:        arm_fir_decimate_init_q15.c   </span>
  61 <a name="l00009"></a>00009 <span class="comment">*   </span>
  62 <a name="l00010"></a>00010 <span class="comment">* Description:  Initialization function for the Q15 FIR Decimator.   </span>
  63 <a name="l00011"></a>00011 <span class="comment">*   </span>
  64 <a name="l00012"></a>00012 <span class="comment">* Target Processor: Cortex-M4/Cortex-M3/Cortex-M0</span>
  65 <a name="l00013"></a>00013 <span class="comment">*  </span>
  66 <a name="l00014"></a>00014 <span class="comment">* Version 1.0.10 2011/7/15 </span>
  67 <a name="l00015"></a>00015 <span class="comment">*    Big Endian support added and Merged M0 and M3/M4 Source code.  </span>
  68 <a name="l00016"></a>00016 <span class="comment">*   </span>
  69 <a name="l00017"></a>00017 <span class="comment">* Version 1.0.3 2010/11/29  </span>
  70 <a name="l00018"></a>00018 <span class="comment">*    Re-organized the CMSIS folders and updated documentation.   </span>
  71 <a name="l00019"></a>00019 <span class="comment">*    </span>
  72 <a name="l00020"></a>00020 <span class="comment">* Version 1.0.2 2010/11/11   </span>
  73 <a name="l00021"></a>00021 <span class="comment">*    Documentation updated.    </span>
  74 <a name="l00022"></a>00022 <span class="comment">*   </span>
  75 <a name="l00023"></a>00023 <span class="comment">* Version 1.0.1 2010/10/05    </span>
  76 <a name="l00024"></a>00024 <span class="comment">*    Production release and review comments incorporated.   </span>
  77 <a name="l00025"></a>00025 <span class="comment">*   </span>
  78 <a name="l00026"></a>00026 <span class="comment">* Version 1.0.0 2010/09/20    </span>
  79 <a name="l00027"></a>00027 <span class="comment">*    Production release and review comments incorporated   </span>
  80 <a name="l00028"></a>00028 <span class="comment">*   </span>
  81 <a name="l00029"></a>00029 <span class="comment">* Version 0.0.7  2010/06/10    </span>
  82 <a name="l00030"></a>00030 <span class="comment">*    Misra-C changes done   </span>
  83 <a name="l00031"></a>00031 <span class="comment">* ------------------------------------------------------------------- */</span>
  84 <a name="l00032"></a>00032
  85 <a name="l00033"></a>00033 <span class="preprocessor">#include &quot;<a class="code" href="arm__math_8h.html">arm_math.h</a>&quot;</span>
  86 <a name="l00034"></a>00034
  87 <a name="l00068"></a><a class="code" href="group___f_i_r__decimate.html#gada660e54b93d5d32178c6f5e1c6f368d">00068</a> <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> <a class="code" href="group___f_i_r__decimate.html#gada660e54b93d5d32178c6f5e1c6f368d" title="Initialization function for the Q15 FIR decimator.">arm_fir_decimate_init_q15</a>(
  88 <a name="l00069"></a>00069   <a class="code" href="structarm__fir__decimate__instance__q15.html" title="Instance structure for the Q15 FIR decimator.">arm_fir_decimate_instance_q15</a> * S,
  89 <a name="l00070"></a>00070   uint16_t numTaps,
  90 <a name="l00071"></a>00071   uint8_t M,
  91 <a name="l00072"></a>00072   <a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a> * pCoeffs,
  92 <a name="l00073"></a>00073   <a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a> * pState,
  93 <a name="l00074"></a>00074   uint32_t <a class="code" href="arm__fir__example__f32_8c.html#ab6558f40a619c2502fbc24c880fd4fb0">blockSize</a>)
  94 <a name="l00075"></a>00075 {
  95 <a name="l00076"></a>00076
  96 <a name="l00077"></a>00077   <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6" title="Error status returned by some functions in the library.">arm_status</a> <a class="code" href="arm__dotproduct__example__f32_8c.html#a88ccb294236ab22b00310c47164c53c3">status</a>;
  97 <a name="l00078"></a>00078
  98 <a name="l00079"></a>00079   <span class="comment">/* The size of the input block must be a multiple of the decimation factor */</span>
  99 <a name="l00080"></a>00080   <span class="keywordflow">if</span>((blockSize % M) != 0u)
 100 <a name="l00081"></a>00081   {
 101 <a name="l00082"></a>00082     <span class="comment">/* Set status as ARM_MATH_LENGTH_ERROR */</span>
 102 <a name="l00083"></a>00083     status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9ae74d7f8a53aec0512ae8f0a421e0e1">ARM_MATH_LENGTH_ERROR</a>;
 103 <a name="l00084"></a>00084   }
 104 <a name="l00085"></a>00085   <span class="keywordflow">else</span>
 105 <a name="l00086"></a>00086   {
 106 <a name="l00087"></a>00087     <span class="comment">/* Assign filter taps */</span>
 107 <a name="l00088"></a>00088     S-&gt;<a class="code" href="structarm__fir__decimate__instance__q15.html#ac1e9844488ec717da334fbd4c4f41990">numTaps</a> = numTaps;
 108 <a name="l00089"></a>00089
 109 <a name="l00090"></a>00090     <span class="comment">/* Assign coefficient pointer */</span>
 110 <a name="l00091"></a>00091     S-&gt;<a class="code" href="structarm__fir__decimate__instance__q15.html#a01cacab67e73945e8289075598ede14d">pCoeffs</a> = pCoeffs;
 111 <a name="l00092"></a>00092
 112 <a name="l00093"></a>00093     <span class="comment">/* Clear the state buffer.  The size of buffer is always (blockSize + numTaps - 1) */</span>
 113 <a name="l00094"></a>00094     memset(pState, 0, (numTaps + (blockSize - 1u)) * <span class="keyword">sizeof</span>(<a class="code" href="arm__math_8h.html#ab5a8fb21a5b3b983d5f54f31614052ea" title="16-bit fractional data type in 1.15 format.">q15_t</a>));
 114 <a name="l00095"></a>00095
 115 <a name="l00096"></a>00096     <span class="comment">/* Assign state pointer */</span>
 116 <a name="l00097"></a>00097     S-&gt;<a class="code" href="structarm__fir__decimate__instance__q15.html#a3f7b5184bb28853ef401b001df121047">pState</a> = pState;
 117 <a name="l00098"></a>00098
 118 <a name="l00099"></a>00099     <span class="comment">/* Assign Decimation factor */</span>
 119 <a name="l00100"></a>00100     S-&gt;<a class="code" href="structarm__fir__decimate__instance__q15.html#aad9320284218b3aa378527ea518cf093">M</a> = M;
 120 <a name="l00101"></a>00101
 121 <a name="l00102"></a>00102     status = <a class="code" href="arm__math_8h.html#a5e459c6409dfcd2927bb8a57491d7cf6a9f8b2a10bd827fb4600e77d455902eb0">ARM_MATH_SUCCESS</a>;
 122 <a name="l00103"></a>00103   }
 123 <a name="l00104"></a>00104
 124 <a name="l00105"></a>00105   <span class="keywordflow">return</span> (status);
 125 <a name="l00106"></a>00106
 126 <a name="l00107"></a>00107 }
 127 <a name="l00108"></a>00108
 128 </pre></div></div>
 129 </div>
 130 <!--- window showing the filter options -->
 131 <div id="MSearchSelectWindow"
 132      onmouseover="return searchBox.OnSearchSelectShow()"
 133      onmouseout="return searchBox.OnSearchSelectHide()"
 134      onkeydown="return searchBox.OnSearchSelectKey(event)">
 135 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Defines</a></div>
 136
 137 <!-- iframe showing the search results (closed by default) -->
 138 <div id="MSearchResultsWindow">
 139 <iframe src="" frameborder="0"
 140         name="MSearchResults" id="MSearchResults">
 141 </iframe>
 142 </div>
 143
 144 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:16 for CMSIS DSP Software Library by&#160;
 145 <a href="http://www.doxygen.org/index.html">
 146 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 147 </body>
 148 </html>