<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <title>CMSIS DSP Software Library</title> <title>CMSIS-DSP: CMSIS DSP Software Library</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="cmsis.css" rel="stylesheet" type="text/css" /> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <script type="text/javascript" src="printComponentTabs.js"></script> <script type="text/javascript" src="footer.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/search.js"></script> <script type="text/javascript"> $(document).ready(function() { searchBox.OnSelectItem(0); }); </script> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 46px;"> <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-DSP  <span id="projectnumber"><script type="text/javascript"> <!-- writeHeader.call(this); //--> </script> </span> </div> <div id="projectbrief">CMSIS DSP Software Library</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.6 --> <script type="text/javascript"> var searchBox = new SearchBox("searchBox", "search",false,'Search'); </script> <div id="navrow1" class="tabs"> <ul class="tablist"> <li class="current"><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Usage and Description</span></a></li> <li><a href="modules.html"><span>Reference</span></a></li> <li> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('index.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> <div class="header"> <div class="headertitle"> <div class="title">CMSIS DSP Software Library </div> </div> </div><!--header--> <div class="contents"> <div class="textblock"><h1><a class="anchor" id="intro"></a> Introduction</h1> <p>This user manual describes the CMSIS DSP software library, a suite of common signal processing functions for use on Cortex-M and Cortex-A processor based devices.</p> <p>The library is divided into a number of functions each covering a specific category:</p> <ul> <li>Basic math functions</li> <li>Fast math functions</li> <li>Complex math functions</li> <li>Filtering functions</li> <li>Matrix functions</li> <li>Transform functions</li> <li>Motor control functions</li> <li>Statistical functions</li> <li>Support functions</li> <li>Interpolation functions</li> <li>Support Vector Machine functions (SVM)</li> <li>Bayes classifier functions</li> <li>Distance functions</li> <li>Quaternion functions</li> </ul> <p>The library has generally separate functions for operating on 8-bit integers, 16-bit integers, 32-bit integer and 32-bit floating-point values.</p> <p>The library is providing vectorized versions of most algorthms for Helium and of most f32 algorithms for Neon.</p> <p>When using a vectorized version, provide a little bit of padding after the end of a buffer (3 words) because the vectorized code may read a little bit after the end of a buffer. You don't have to modify your buffers but just ensure that the end of buffer + padding is not outside of a memory region.</p> <h1><a class="anchor" id="using"></a> Using the Library</h1> <p>The library is released in source form. It is strongly advised to compile the library using -Ofast to have the best performances.</p> <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. If you don't want to include everything, you can also rely on headers in Include/dsp folder and use only what you need.</p> <h1><a class="anchor" id="example"></a> Examples</h1> <p>The library ships with a number of examples which demonstrate how to use the library functions.</p> <h1><a class="anchor" id="toolchain"></a> Toolchain Support</h1> <p>The library is now tested on Fast Models building with cmake. Core M0, M4, M7, M33, M55, A32 are tested.</p> <h1><a class="anchor" id="preprocessor"></a> Preprocessor Macros</h1> <p>Each library project have different preprocessor macros.</p> <ul> <li>ARM_MATH_BIG_ENDIAN:</li> </ul> <p>Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets.</p> <ul> <li>ARM_MATH_MATRIX_CHECK:</li> </ul> <p>Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices</p> <ul> <li>ARM_MATH_ROUNDING:</li> </ul> <p>Define macro ARM_MATH_ROUNDING for rounding on support functions</p> <ul> <li>ARM_MATH_LOOPUNROLL:</li> </ul> <p>Define macro ARM_MATH_LOOPUNROLL to enable manual loop unrolling in DSP functions</p> <ul> <li>ARM_MATH_NEON:</li> </ul> <p>Define macro ARM_MATH_NEON to enable Neon versions of the DSP functions. It is not enabled by default when Neon is available because performances are dependent on the compiler and target architecture.</p> <ul> <li>ARM_MATH_NEON_EXPERIMENTAL:</li> </ul> <p>Define macro ARM_MATH_NEON_EXPERIMENTAL to enable experimental Neon versions of of some DSP functions. Experimental Neon versions currently do not have better performances than the scalar versions.</p> <ul> <li>ARM_MATH_HELIUM:</li> </ul> <p>It implies the flags ARM_MATH_MVEF and ARM_MATH_MVEI and ARM_MATH_MVE_FLOAT16.</p> <ul> <li>ARM_MATH_HELIUM_EXPERIMENTAL:</li> </ul> <p>Only taken into account when ARM_MATH_MVEF, ARM_MATH_MVEI or ARM_MATH_MVE_FLOAT16 are defined. Enable some vector versions which may have worse performance than scalar depending on the core / compiler configuration.</p> <ul> <li>ARM_MATH_MVEF:</li> </ul> <p>Select Helium versions of the f32 algorithms. It implies ARM_MATH_FLOAT16 and ARM_MATH_MVEI.</p> <ul> <li>ARM_MATH_MVEI:</li> </ul> <p>Select Helium versions of the int and fixed point algorithms.</p> <ul> <li>ARM_MATH_MVE_FLOAT16:</li> </ul> <p>MVE Float16 implementations of some algorithms (Requires MVE extension).</p> <ul> <li>DISABLEFLOAT16:</li> </ul> <p>Disable float16 algorithms when __fp16 is not supported for a specific compiler / core configuration. This is only valid for scalar. When vector architecture is supporting f16 then it can't be disabled.</p> <ul> <li>ARM_MATH_AUTOVECTORIZE:</li> </ul> <p>With Helium or Neon, disable the use of vectorized code with C intrinsics and use pure C instead. The vectorization is then done by the compiler.</p> <hr/> <h1><a class="anchor" id="pack"></a> CMSIS-DSP in ARM::CMSIS Pack</h1> <p>The following files relevant to CMSIS-DSP are present in the <b>ARM::CMSIS</b> Pack directories: </p> <table class="doxtable"> <tr> <th>File/Folder </th><th>Content </th></tr> <tr> <td><b>CMSIS\Documentation\DSP</b> </td><td>This documentation </td></tr> <tr> <td><b>CMSIS\DSP\Examples</b> </td><td>Example projects demonstrating the usage of the library functions </td></tr> <tr> <td><b>CMSIS\DSP\ComputeLibrary</b> </td><td>Small Neon kernels when building on Cortex-A </td></tr> <tr> <td><b>CMSIS\DSP\Include</b> </td><td>include files for using and building the lib </td></tr> <tr> <td><b>CMSIS\DSP\PrivateInclude</b> </td><td>private include files for building the lib </td></tr> <tr> <td><b>CMSIS\DSP\Source</b> </td><td>source files </td></tr> </table> <hr/> <h1><a class="anchor" id="rev"></a> Revision History of CMSIS-DSP</h1> <p>Please refer to <a class="el" href="ChangeLog_pg.html">Revision History</a>. </p> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer"> <script type="text/javascript"> <!-- writeFooter.call(this); //--> </script> </li> </ul> </div> </body> </html>