hardware/arduino/sam/system/CMSIS/CMSIS/Documentation/DSP_Lib/html/index.html - platform/external/arduino-ide - Git at Google

 <!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"/>
 <title>CMSIS DSP Software Library: CMSIS DSP Software Library</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javaScript" src="search/search.js"></script>
 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
 </head>
 <body onload='searchBox.OnSelectItem(0);'>
 <!-- Generated by Doxygen 1.7.2 -->
 <script type="text/javascript"><!--
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 --></script>
 <div class="navigation" id="top">
   <div class="tabs">
     <ul class="tablist">
       <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="modules.html"><span>Modules</span></a></li>
       <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li><a href="examples.html"><span>Examples</span></a></li>
       <li id="searchli">
         <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>
 <div class="header">
   <div class="headertitle">
 <h1>CMSIS DSP Software Library </h1>  </div>
 </div>
 <div class="contents">
 <h3 class="version">Version1.0.10 </h3><p><b>Introduction</b></p>
 <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>
 <p>The library is divided into a number of modules each covering a specific category:</p>
 <ul>
 <li>Basic math functions</li>
 <li>Fast math functions</li>
 <li>Complex math functions</li>
 <li>Filters</li>
 <li>Matrix functions</li>
 <li>Transforms</li>
 <li>Motor control functions</li>
 <li>Statistical functions</li>
 <li>Support functions</li>
 <li>Interpolation functions</li>
 </ul>
 <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>
 <p><b>Processor Support</b></p>
 <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>
 <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>
 <p><b>Toolchain Support</b></p>
 <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>
 <p><b>Using the Library</b></p>
 <p>The library installer contains prebuilt versions of the libraries in the <code>Lib</code> folder.</p>
 <ul>
 <li>arm_cortexM4lf_math.lib (Little endian and Floating Point Unit on Cortex-M4)</li>
 <li>arm_cortexM4bf_math.lib (Big endian and Floating Point Unit on Cortex-M4)</li>
 <li>arm_cortexM4l_math.lib (Little endian on Cortex-M4)</li>
 <li>arm_cortexM4b_math.lib (Big endian on Cortex-M4)</li>
 <li>arm_cortexM3l_math.lib (Little endian on Cortex-M3)</li>
 <li>arm_cortexM3b_math.lib (Big endian on Cortex-M3)</li>
 <li>arm_cortexM0l_math.lib (Little endian on Cortex-M0)</li>
 <li>arm_cortexM0b_math.lib (Big endian on Cortex-M3)</li>
 </ul>
 <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>
 <p><b>Examples</b></p>
 <p>The library ships with a number of examples which demonstrate how to use the library functions.</p>
 <p><b>Building the Library</b></p>
 <p>The library installer contains project files to re build libraries on MDK Tool chain in the <code>CMSIS</code> folder.</p>
 <ul>
 <li>arm_cortexM0b_math.uvproj</li>
 <li>arm_cortexM0l_math.uvproj</li>
 <li>arm_cortexM3b_math.uvproj</li>
 <li>arm_cortexM3l_math.uvproj</li>
 <li>arm_cortexM4b_math.uvproj</li>
 <li>arm_cortexM4l_math.uvproj</li>
 <li>arm_cortexM4bf_math.uvproj</li>
 <li>arm_cortexM4lf_math.uvproj</li>
 </ul>
 <p>Each library project have differant pre-processor macros.</p>
 <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>
 <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>
 <p><b>ARM_MATH_MATRIX_CHECK:</b> Define macro for checking on the input and output sizes of matrices</p>
 <p><b>ARM_MATH_ROUNDING:</b> Define macro for rounding on support functions</p>
 <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>
 <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>
 <p><b>Copyright Notice</b></p>
 <p>Copyright (C) 2010 ARM Limited. All rights reserved. </p>
 </div>
 <!--- 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">&#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>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:15 for CMSIS DSP Software Library by&#160;
 <a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 </body>
 </html>
	<!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"/>
	<title>CMSIS DSP Software Library: CMSIS DSP Software Library</title>
	<link href="tabs.css" rel="stylesheet" type="text/css"/>
	<link href="search/search.css" rel="stylesheet" type="text/css"/>
	<script type="text/javaScript" src="search/search.js"></script>
	<link href="doxygen.css" rel="stylesheet" type="text/css"/>
	</head>
	<body onload='searchBox.OnSelectItem(0);'>
	<!-- Generated by Doxygen 1.7.2 -->
	<script type="text/javascript"><!--
	var searchBox = new SearchBox("searchBox", "search",false,'Search');
	--></script>
	<div class="navigation" id="top">
	<div class="tabs">
	<ul class="tablist">
	<li class="current"><a href="index.html"><span>Main Page</span></a></li>
	<li><a href="modules.html"><span>Modules</span></a></li>
	<li><a href="annotated.html"><span>Data Structures</span></a></li>
	<li><a href="files.html"><span>Files</span></a></li>
	<li><a href="examples.html"><span>Examples</span></a></li>
	<li id="searchli">
	<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>
	<div class="header">
	<div class="headertitle">
	<h1>CMSIS DSP Software Library </h1> </div>
	</div>
	<div class="contents">
	<h3 class="version">Version1.0.10 </h3><p><b>Introduction</b></p>
	<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>
	<p>The library is divided into a number of modules each covering a specific category:</p>
	<ul>
	<li>Basic math functions</li>
	<li>Fast math functions</li>
	<li>Complex math functions</li>
	<li>Filters</li>
	<li>Matrix functions</li>
	<li>Transforms</li>
	<li>Motor control functions</li>
	<li>Statistical functions</li>
	<li>Support functions</li>
	<li>Interpolation functions</li>
	</ul>
	<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>
	<p><b>Processor Support</b></p>
	<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>
	<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>
	<p><b>Toolchain Support</b></p>
	<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>
	<p><b>Using the Library</b></p>
	<p>The library installer contains prebuilt versions of the libraries in the <code>Lib</code> folder.</p>
	<ul>
	<li>arm_cortexM4lf_math.lib (Little endian and Floating Point Unit on Cortex-M4)</li>
	<li>arm_cortexM4bf_math.lib (Big endian and Floating Point Unit on Cortex-M4)</li>
	<li>arm_cortexM4l_math.lib (Little endian on Cortex-M4)</li>
	<li>arm_cortexM4b_math.lib (Big endian on Cortex-M4)</li>
	<li>arm_cortexM3l_math.lib (Little endian on Cortex-M3)</li>
	<li>arm_cortexM3b_math.lib (Big endian on Cortex-M3)</li>
	<li>arm_cortexM0l_math.lib (Little endian on Cortex-M0)</li>
	<li>arm_cortexM0b_math.lib (Big endian on Cortex-M3)</li>
	</ul>
	<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>
	<p><b>Examples</b></p>
	<p>The library ships with a number of examples which demonstrate how to use the library functions.</p>
	<p><b>Building the Library</b></p>
	<p>The library installer contains project files to re build libraries on MDK Tool chain in the <code>CMSIS</code> folder.</p>
	<ul>
	<li>arm_cortexM0b_math.uvproj</li>
	<li>arm_cortexM0l_math.uvproj</li>
	<li>arm_cortexM3b_math.uvproj</li>
	<li>arm_cortexM3l_math.uvproj</li>
	<li>arm_cortexM4b_math.uvproj</li>
	<li>arm_cortexM4l_math.uvproj</li>
	<li>arm_cortexM4bf_math.uvproj</li>
	<li>arm_cortexM4lf_math.uvproj</li>
	</ul>
	<p>Each library project have differant pre-processor macros.</p>
	<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>
	<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>
	<p><b>ARM_MATH_MATRIX_CHECK:</b> Define macro for checking on the input and output sizes of matrices</p>
	<p><b>ARM_MATH_ROUNDING:</b> Define macro for rounding on support functions</p>
	<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>
	<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>
	<p><b>Copyright Notice</b></p>
	<p>Copyright (C) 2010 ARM Limited. All rights reserved. </p>
	</div>
	<!--- 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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Defines</a></div>

	<!-- iframe showing the search results (closed by default) -->
	<div id="MSearchResultsWindow">
	<iframe src="" frameborder="0"
	name="MSearchResults" id="MSearchResults">
	</iframe>
	</div>

	<hr class="footer"/><address class="footer"><small>Generated on Fri Jul 15 2011 13:16:15 for CMSIS DSP Software Library by
	<a href="http://www.doxygen.org/index.html">
	<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
	</body>
	</html>