You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
280 lines
13 KiB
HTML
280 lines
13 KiB
HTML
<!-- HTML header for doxygen 1.9.2-->
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>CMSIS-DSP: CMSIS DSP Software Library</title>
|
|
<link href="tabs.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="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="navtreedata.js"></script>
|
|
<script type="text/javascript" src="navtree.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_search(); });
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/x-mathjax-config">
|
|
MathJax.Hub.Config({
|
|
extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
|
|
jax: ["input/TeX","output/HTML-CSS"],
|
|
});
|
|
</script>
|
|
<script type="text/javascript" async="async" src="https://cdn.jsdelivr.net/npm/mathjax@2/MathJax.js"></script>
|
|
<link href="$extra_stylesheet" rel="stylesheet" type="text/css" />
|
|
<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
|
|
<link href="version.css" rel="stylesheet" type="text/css" />
|
|
<script type="text/javascript" src="../version.js"></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: 55px;">
|
|
<td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
|
|
<td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
|
|
<div id="projectname">CMSIS-DSP
|
|
 <span id="projectnumber"><script type="text/javascript">
|
|
<!--
|
|
writeHeader.call(this);
|
|
writeVersionDropdown(this);
|
|
//-->
|
|
</script>
|
|
</span>
|
|
</div>
|
|
<div id="projectbrief">CMSIS DSP Software Library</div>
|
|
</td>
|
|
<!--END !PROJECT_NAME-->
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.2 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
|
|
/* @license-end */
|
|
</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> API Reference</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.svg"
|
|
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.svg" 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">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('index.html',''); initResizable(); });
|
|
/* @license-end */
|
|
</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)">
|
|
</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><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><a class="el" href="group__groupMath.html">Basic math functions</a></li>
|
|
<li><a class="el" href="group__groupFastMath.html">Fast math functions</a></li>
|
|
<li><a class="el" href="group__groupCmplxMath.html">Complex math functions</a></li>
|
|
<li><a class="el" href="group__groupFilters.html">Filtering functions</a></li>
|
|
<li><a class="el" href="group__groupMatrix.html">Matrix functions</a></li>
|
|
<li><a class="el" href="group__groupTransforms.html">Transform functions</a></li>
|
|
<li><a class="el" href="group__groupController.html">Motor control functions</a></li>
|
|
<li><a class="el" href="group__groupStats.html">Statistical functions</a></li>
|
|
<li><a class="el" href="group__groupSupport.html">Support functions</a></li>
|
|
<li><a class="el" href="group__groupInterpolation.html">Interpolation functions</a></li>
|
|
<li><a class="el" href="group__groupSVM.html">Support Vector Machine functions (SVM)</a></li>
|
|
<li><a class="el" href="group__groupBayes.html">Bayes classifier functions</a></li>
|
|
<li><a class="el" href="group__groupDistance.html">Distance functions</a></li>
|
|
<li><a class="el" href="group__groupQuaternionMath.html">Quaternion functions</a></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 <code>Include/dsp</code> 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. Please refer to <a class="el" href="group__groupExamples.html">Examples</a>.</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 has different preprocessor macros.</p>
|
|
<ul>
|
|
<li><code>ARM_MATH_BIG_ENDIAN</code>:<ul>
|
|
<li>Define macro ARM_MATH_BIG_ENDIAN to build the library for big endian targets. By default library builds for little endian targets.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_MATRIX_CHECK</code>:<ul>
|
|
<li>Define macro ARM_MATH_MATRIX_CHECK for checking on the input and output sizes of matrices</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_ROUNDING</code>:<ul>
|
|
<li>Define macro ARM_MATH_ROUNDING for rounding on support functions</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_LOOPUNROLL</code>:<ul>
|
|
<li>Define macro ARM_MATH_LOOPUNROLL to enable manual loop unrolling in DSP functions</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_NEON</code>:<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_NEON_EXPERIMENTAL</code>:<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_HELIUM</code>:<ul>
|
|
<li>It implies the flags ARM_MATH_MVEF and ARM_MATH_MVEI and ARM_MATH_MVE_FLOAT16.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_HELIUM_EXPERIMENTAL</code>:<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_MVEF</code>:<ul>
|
|
<li>Select Helium versions of the f32 algorithms. It implies ARM_MATH_FLOAT16 and ARM_MATH_MVEI.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_MVEI</code>:<ul>
|
|
<li>Select Helium versions of the int and fixed point algorithms.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_MVE_FLOAT16</code>:<ul>
|
|
<li>MVE Float16 implementations of some algorithms (Requires MVE extension).</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>DISABLEFLOAT16</code>:<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<ul>
|
|
<li><code>ARM_MATH_AUTOVECTORIZE</code>:<ul>
|
|
<li>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.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<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="markdownTable">
|
|
<tr class="markdownTableHead">
|
|
<th class="markdownTableHeadNone">File/Folder </th><th class="markdownTableHeadNone">Content </th></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\Documentation\DSP</b> </td><td class="markdownTableBodyNone">This documentation </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Examples</b> </td><td class="markdownTableBodyNone">Example projects demonstrating the usage of the library functions </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\DSP\ComputeLibrary</b> </td><td class="markdownTableBodyNone">Small Neon kernels when building on Cortex-A </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Include</b> </td><td class="markdownTableBodyNone">include files for using and building the lib </td></tr>
|
|
<tr class="markdownTableRowOdd">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\DSP\PrivateInclude</b> </td><td class="markdownTableBodyNone">private include files for building the lib </td></tr>
|
|
<tr class="markdownTableRowEven">
|
|
<td class="markdownTableBodyNone"><b>CMSIS\DSP\Source</b> </td><td class="markdownTableBodyNone">source files </td></tr>
|
|
</table>
|
|
<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>
|
|
<h1><a class="anchor" id="license"></a>
|
|
License</h1>
|
|
<p >The CMSIS-DSP is provided free of charge under the <a href="LICENSE.txt">Apache 2.0 License</a>. </p>
|
|
</div></div><!-- PageDoc -->
|
|
</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>
|