git.gag.com Git - fw/stlink/blob - exampleF4/CMSIS/Documentation/DSP_Lib/html/index.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: CMSIS DSP Software Library</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 class="current"><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><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>
  43 <div class="header">
  44   <div class="headertitle">
  45 <h1>CMSIS DSP Software Library </h1>  </div>
  46 </div>
  47 <div class="contents">
  48 <h3 class="version">Version1.0.10 </h3><p><b>Introduction</b></p>
  49 <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>
  50 <p>The library is divided into a number of modules each covering a specific category:</p>
  51 <ul>
  52 <li>Basic math functions</li>
  53 <li>Fast math functions</li>
  54 <li>Complex math functions</li>
  55 <li>Filters</li>
  56 <li>Matrix functions</li>
  57 <li>Transforms</li>
  58 <li>Motor control functions</li>
  59 <li>Statistical functions</li>
  60 <li>Support functions</li>
  61 <li>Interpolation functions</li>
  62 </ul>
  63 <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>
  64 <p><b>Processor Support</b></p>
  65 <p>The library is completely written in C and is fully CMSIS compliant. High performance is achieved through maximum use of Cortex-M4 intrinsics.</p>
  66 <p>The supplied library source code also builds and runs on the Cortex-M3 and Cortex-M0 processor, with the DSP intrinsics being emulated through software.</p>
  67 <p><b>Toolchain Support</b></p>
  68 <p>The library has been developed and tested with MDK-ARM version 4.21. The library is being tested in GCC and IAR toolchains and updates on this activity will be made available shortly.</p>
  69 <p><b>Using the Library</b></p>
  70 <p>The library installer contains prebuilt versions of the libraries in the <code>Lib</code> folder.</p>
  71 <ul>
  72 <li>arm_cortexM4lf_math.lib (Little endian and Floating Point Unit on Cortex-M4)</li>
  73 <li>arm_cortexM4bf_math.lib (Big endian and Floating Point Unit on Cortex-M4)</li>
  74 <li>arm_cortexM4l_math.lib (Little endian on Cortex-M4)</li>
  75 <li>arm_cortexM4b_math.lib (Big endian on Cortex-M4)</li>
  76 <li>arm_cortexM3l_math.lib (Little endian on Cortex-M3)</li>
  77 <li>arm_cortexM3b_math.lib (Big endian on Cortex-M3)</li>
  78 <li>arm_cortexM0l_math.lib (Little endian on Cortex-M0)</li>
  79 <li>arm_cortexM0b_math.lib (Big endian on Cortex-M3)</li>
  80 </ul>
  81 <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 depending on the target processor in the application.</p>
  82 <p><b>Examples</b></p>
  83 <p>The library ships with a number of examples which demonstrate how to use the library functions.</p>
  84 <p><b>Building the Library</b></p>
  85 <p>The library installer contains project files to re build libraries on MDK Tool chain in the <code>CMSIS</code> folder.</p>
  86 <ul>
  87 <li>arm_cortexM0b_math.uvproj</li>
  88 <li>arm_cortexM0l_math.uvproj</li>
  89 <li>arm_cortexM3b_math.uvproj</li>
  90 <li>arm_cortexM3l_math.uvproj</li>
  91 <li>arm_cortexM4b_math.uvproj</li>
  92 <li>arm_cortexM4l_math.uvproj</li>
  93 <li>arm_cortexM4bf_math.uvproj</li>
  94 <li>arm_cortexM4lf_math.uvproj</li>
  95 </ul>
  96 <p>Each library project have differant pre-processor macros.</p>
  97 <p><b>ARM_MATH_CMx:</b> 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.</p>
  98 <p><b>ARM_MATH_BIG_ENDIAN:</b> Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets.</p>
  99 <p><b>ARM_MATH_MATRIX_CHECK:</b> Define macro for checking on the input and output sizes of matrices</p>
 100 <p><b>ARM_MATH_ROUNDING:</b> Define macro for rounding on support functions</p>
 101 <p><b>__FPU_PRESENT:</b> Initialize macro __FPU_PRESENT = 1 when building on FPU supported Targets. Enable this macro for M4bf and M4lf libraries</p>
 102 <p>The project can be built by opening the appropriate project in MDK-ARM 4.21 chain and defining the optional pre processor MACROs detailed above.</p>
 103 <p><b>Copyright Notice</b></p>
 104 <p>Copyright (C) 2010 ARM Limited. All rights reserved. </p>
 105 </div>
 106 <!--- window showing the filter options -->
 107 <div id="MSearchSelectWindow"
 108      onmouseover="return searchBox.OnSearchSelectShow()"
 109      onmouseout="return searchBox.OnSearchSelectHide()"
 110      onkeydown="return searchBox.OnSearchSelectKey(event)">
 111 <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>
 112
 113 <!-- iframe showing the search results (closed by default) -->
 114 <div id="MSearchResultsWindow">
 115 <iframe src="" frameborder="0"
 116         name="MSearchResults" id="MSearchResults">
 117 </iframe>
 118 </div>
 119
 120 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:15 for CMSIS DSP Software Library by&#160;
 121 <a href="http://www.doxygen.org/index.html">
 122 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 123 </body>
 124 </html>