index.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  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. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>CMSIS-DSP: CMSIS DSP Software Library</title>
  7. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  8. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15. $(document).ready(initResizable);
  16. </script>
  17. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  18. <script type="text/javascript" src="search/search.js"></script>
  19. <script type="text/javascript">
  20. $(document).ready(function() { searchBox.OnSelectItem(0); });
  21. </script>
  22. <link href="stylsheetf" rel="stylesheet" type="text/css" />
  23. </head>
  24. <body>
  25. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  26. <div id="titlearea">
  27. <table cellspacing="0" cellpadding="0">
  28. <tbody>
  29. <tr style="height: 46px;">
  30. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  31. <td style="padding-left: 0.5em;">
  32. <div id="projectname">CMSIS-DSP
  33. &#160;<span id="projectnumber">Version 1.4.4</span>
  34. </div>
  35. <div id="projectbrief">CMSIS DSP Software Library</div>
  36. </td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. <!-- end header part -->
  42. <div id="CMSISnav" class="tabs1">
  43. <ul class="tablist">
  44. <li><a href="../../General/html/index.html"><span>CMSIS</span></a></li>
  45. <li><a href="../../Core/html/index.html"><span>CORE</span></a></li>
  46. <li><a href="../../Driver/html/index.html"><span>Driver</span></a></li>
  47. <li class="current"><a href="../../DSP/html/index.html"><span>DSP</span></a></li>
  48. <li><a href="../../RTOS/html/index.html"><span>RTOS API</span></a></li>
  49. <li><a href="../../Pack/html/index.html"><span>Pack</span></a></li>
  50. <li><a href="../../SVD/html/index.html"><span>SVD</span></a></li>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.2 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li><a href="modules.html"><span>Reference</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('index.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="headertitle">
  109. <div class="title">CMSIS DSP Software Library </div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><h2>Introduction</h2>
  113. <p>This user manual describes the CMSIS DSP software library, a suite of common signal processing functions for use on Cortex-M processor based devices.</p>
  114. <p>The library is divided into a number of functions each covering a specific category:</p>
  115. <ul>
  116. <li>Basic math functions</li>
  117. <li>Fast math functions</li>
  118. <li>Complex math functions</li>
  119. <li>Filters</li>
  120. <li>Matrix functions</li>
  121. <li>Transforms</li>
  122. <li>Motor control functions</li>
  123. <li>Statistical functions</li>
  124. <li>Support functions</li>
  125. <li>Interpolation functions</li>
  126. </ul>
  127. <p>The library has separate functions for operating on 8-bit integers, 16-bit integers, 32-bit integer and 32-bit floating-point values.</p>
  128. <h2>Using the Library</h2>
  129. <p>The library installer contains prebuilt versions of the libraries in the <code>Lib</code> folder.</p>
  130. <ul>
  131. <li>arm_cortexM4lf_math.lib (Little endian and Floating Point Unit on Cortex-M4)</li>
  132. <li>arm_cortexM4bf_math.lib (Big endian and Floating Point Unit on Cortex-M4)</li>
  133. <li>arm_cortexM4l_math.lib (Little endian on Cortex-M4)</li>
  134. <li>arm_cortexM4b_math.lib (Big endian on Cortex-M4)</li>
  135. <li>arm_cortexM3l_math.lib (Little endian on Cortex-M3)</li>
  136. <li>arm_cortexM3b_math.lib (Big endian on Cortex-M3)</li>
  137. <li>arm_cortexM0l_math.lib (Little endian on Cortex-M0)</li>
  138. <li>arm_cortexM0b_math.lib (Big endian on Cortex-M3)</li>
  139. </ul>
  140. <p>The library functions are declared in the public file <code><a class="el" href="arm__math_8h.html">arm_math.h</a></code> which is placed in the <code>Include</code> folder. Simply include this file and link the appropriate library in the application and begin calling the library functions. The Library supports single public header file <code> <a class="el" href="arm__math_8h.html">arm_math.h</a></code> for Cortex-M4/M3/M0 with little endian and big endian. Same header file will be used for floating point unit(FPU) variants. Define the appropriate pre processor MACRO ARM_MATH_CM4 or ARM_MATH_CM3 or ARM_MATH_CM0 or ARM_MATH_CM0PLUS depending on the target processor in the application.</p>
  141. <h2>Examples</h2>
  142. <p>The library ships with a number of examples which demonstrate how to use the library functions.</p>
  143. <h2>Toolchain Support</h2>
  144. <p>The library has been developed and tested with MDK-ARM version 4.60. The library is being tested in GCC and IAR toolchains and updates on this activity will be made available shortly.</p>
  145. <h2>Building the Library</h2>
  146. <p>The library installer contains a project file to re build libraries on MDK-ARM Tool chain in the <code>CMSIS\DSP_Lib\Source\ARM</code> folder.</p>
  147. <ul>
  148. <li>arm_cortexM_math.uvproj</li>
  149. </ul>
  150. <p>The libraries can be built by opening the arm_cortexM_math.uvproj project in MDK-ARM, selecting a specific target, and defining the optional pre processor MACROs detailed above.</p>
  151. <h2>Pre-processor Macros</h2>
  152. <p>Each library project have differant pre-processor macros.</p>
  153. <ul>
  154. <li>UNALIGNED_SUPPORT_DISABLE:</li>
  155. </ul>
  156. <p>Define macro UNALIGNED_SUPPORT_DISABLE, If the silicon does not support unaligned memory access</p>
  157. <ul>
  158. <li>ARM_MATH_BIG_ENDIAN:</li>
  159. </ul>
  160. <p>Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets.</p>
  161. <ul>
  162. <li>ARM_MATH_MATRIX_CHECK:</li>
  163. </ul>
  164. <p>Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices</p>
  165. <ul>
  166. <li>ARM_MATH_ROUNDING:</li>
  167. </ul>
  168. <p>Define macro ARM_MATH_ROUNDING for rounding on support functions</p>
  169. <ul>
  170. <li>ARM_MATH_CMx:</li>
  171. </ul>
  172. <p>Define macro ARM_MATH_CM4 for building the library on Cortex-M4 target, ARM_MATH_CM3 for building library on Cortex-M3 target and ARM_MATH_CM0 for building library on cortex-M0 target, ARM_MATH_CM0PLUS for building library on cortex-M0+ target.</p>
  173. <ul>
  174. <li>__FPU_PRESENT:</li>
  175. </ul>
  176. <p>Initialize macro __FPU_PRESENT = 1 when building on FPU supported Targets. Enable this macro for M4bf and M4lf libraries</p>
  177. <hr/>
  178. <h2>CMSIS-DSP in ARM::CMSIS Pack</h2>
  179. <p>The following files relevant to CMSIS-DSP are present in the <b>ARM::CMSIS</b> Pack directories: </p>
  180. <table class="doxtable">
  181. <tr>
  182. <th>File/Folder </th><th>Content </th></tr>
  183. <tr>
  184. <td><b>CMSIS\Documentation\DSP</b> </td><td>This documentation </td></tr>
  185. <tr>
  186. <td><b>CMSIS\DSP_Lib</b> </td><td>Software license agreement (<a class="el" href="license_8txt.html">license.txt</a>) </td></tr>
  187. <tr>
  188. <td><b>CMSIS\DSP_Lib\Examples</b> </td><td>Example projects demonstrating the usage of the library functions </td></tr>
  189. <tr>
  190. <td><b>CMSIS\DSP_Lib\Source</b> </td><td>Source files for rebuilding the library </td></tr>
  191. </table>
  192. <hr/>
  193. <h2>Revision History of CMSIS-DSP</h2>
  194. <p>Please refer to <a class="el" href="_change_log_pg.html">Change Log</a>.</p>
  195. <h2>Copyright Notice</h2>
  196. <p>Copyright (C) 2010-2014 ARM Limited. All rights reserved. </p>
  197. </div></div><!-- contents -->
  198. </div><!-- doc-content -->
  199. <!-- start footer part -->
  200. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  201. <ul>
  202. <li class="footer">Generated on Tue Sep 23 2014 18:52:44 for CMSIS-DSP by ARM Ltd. All rights reserved.
  203. <!--
  204. <a href="http://www.doxygen.org/index.html">
  205. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.2
  206. -->
  207. </li>
  208. </ul>
  209. </div>
  210. </body>
  211. </html>