2012-12-30 11:25:17 +01:00
<!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" / >
2013-05-18 20:29:06 +02:00
< meta http-equiv = "X-UA-Compatible" content = "IE=9" / >
< title > CMSIS-DSP: CMSIS DSP Software Library< / title >
2012-12-30 11:25:17 +01:00
< link href = "tabs.css" rel = "stylesheet" type = "text/css" / >
2013-05-17 22:41:34 +02:00
< link href = "cmsis.css" rel = "stylesheet" type = "text/css" / >
< script type = "text/javascript" src = "jquery.js" > < / script >
2013-05-18 20:29:06 +02:00
< script type = "text/javascript" src = "dynsections.js" > < / script >
< link href = "navtree.css" rel = "stylesheet" type = "text/css" / >
2013-05-17 22:41:34 +02:00
< script type = "text/javascript" src = "resize.js" > < / script >
< script type = "text/javascript" src = "navtree.js" > < / script >
< script type = "text/javascript" >
$(document).ready(initResizable);
2013-05-18 20:29:06 +02:00
$(window).load(resizeHeight);
2013-05-17 22:41:34 +02:00
< / script >
2012-12-30 11:25:17 +01:00
< link href = "search/search.css" rel = "stylesheet" type = "text/css" / >
2013-05-17 22:41:34 +02:00
< script type = "text/javascript" src = "search/search.js" > < / script >
< script type = "text/javascript" >
$(document).ready(function() { searchBox.OnSelectItem(0); });
< / script >
2013-05-18 20:29:06 +02:00
< link href = "stylsheetf" rel = "stylesheet" type = "text/css" / >
2012-12-30 11:25:17 +01:00
< / head >
2013-05-17 22:41:34 +02:00
< body >
2013-05-18 20:29:06 +02:00
< div id = "top" > <!-- do not remove this div, it is closed by doxygen! -->
2013-05-17 22:41:34 +02:00
< div id = "titlearea" >
< table cellspacing = "0" cellpadding = "0" >
< tbody >
< tr style = "height: 46px;" >
2013-05-18 20:29:06 +02:00
< td id = "projectlogo" > < img alt = "Logo" src = "CMSIS_Logo_Final.png" / > < / td >
2013-05-17 22:41:34 +02:00
< td style = "padding-left: 0.5em;" >
< div id = "projectname" > CMSIS-DSP
2013-05-18 20:29:06 +02:00
  < span id = "projectnumber" > Verison 1.4.1< / span >
2013-05-17 22:41:34 +02:00
< / div >
< div id = "projectbrief" > CMSIS DSP Software Library< / div >
< / td >
< / tr >
< / tbody >
< / table >
< / div >
2013-05-18 20:29:06 +02:00
<!-- end header part -->
2013-05-17 22:41:34 +02:00
< div id = "CMSISnav" class = "tabs1" >
< ul class = "tablist" >
< li > < a href = "../../General/html/index.html" > < span > CMSIS< / span > < / a > < / li >
< li > < a href = "../../Core/html/index.html" > < span > CORE< / span > < / a > < / li >
< li class = "current" > < a href = "../../DSP/html/index.html" > < span > DSP< / span > < / a > < / li >
< li > < a href = "../../RTOS/html/index.html" > < span > RTOS API< / span > < / a > < / li >
< li > < a href = "../../SVD/html/index.html" > < span > SVD< / span > < / a > < / li >
< / ul >
< / div >
2013-05-18 20:29:06 +02:00
<!-- Generated by Doxygen 1.8.3.1 -->
2013-05-17 22:41:34 +02:00
< script type = "text/javascript" >
2012-12-30 11:25:17 +01:00
var searchBox = new SearchBox("searchBox", "search",false,'Search');
2013-05-17 22:41:34 +02:00
< / script >
< div id = "navrow1" class = "tabs" >
2012-12-30 11:25:17 +01:00
< ul class = "tablist" >
< li class = "current" > < a href = "index.html" > < span > Main  Page< / span > < / a > < / li >
2013-05-18 20:29:06 +02:00
< li > < a href = "pages.html" > < span > Usage  and  Description< / span > < / a > < / li >
2013-05-17 22:41:34 +02:00
< li > < a href = "modules.html" > < span > Reference< / span > < / a > < / li >
< li >
2012-12-30 11:25:17 +01:00
< 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 >
2013-05-18 20:29:06 +02:00
< / div > <!-- top -->
2013-05-17 22:41:34 +02:00
< div id = "side-nav" class = "ui-resizable side-nav-resizable" >
< div id = "nav-tree" >
< div id = "nav-tree-contents" >
2013-05-18 20:29:06 +02:00
< div id = "nav-sync" class = "sync" > < / div >
2013-05-17 22:41:34 +02:00
< / div >
< / div >
< div id = "splitbar" style = "-moz-user-select:none;"
class="ui-resizable-handle">
< / div >
< / div >
< script type = "text/javascript" >
2013-05-18 20:29:06 +02:00
$(document).ready(function(){initNavTree('index.html','');});
2013-05-17 22:41:34 +02:00
< / script >
< div id = "doc-content" >
2013-05-18 20:29:06 +02:00
<!-- 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 > Macros< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(9)" > < span class = "SelectionMark" >   < / span > Groups< / a > < a class = "SelectItem" href = "javascript:void(0)" onclick = "searchBox.OnSelectItem(10)" > < 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 >
2012-12-30 11:25:17 +01:00
< div class = "header" >
< div class = "headertitle" >
2013-05-17 22:41:34 +02:00
< div class = "title" > CMSIS DSP Software Library < / div > < / div >
2013-05-18 20:29:06 +02:00
< / div > <!-- header -->
2012-12-30 11:25:17 +01:00
< div class = "contents" >
2013-05-17 22:41:34 +02:00
< div class = "textblock" > < p > < b > Introduction< / b > < / p >
2012-12-30 11:25:17 +01:00
< 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 >
2013-05-17 22:41:34 +02:00
< p > The library is divided into a number of functions each covering a specific category:< / p >
2012-12-30 11:25:17 +01:00
< 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 > 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 >
2013-05-18 20:29:06 +02:00
< 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 >
2012-12-30 11:25:17 +01:00
< p > < b > Examples< / b > < / p >
< p > The library ships with a number of examples which demonstrate how to use the library functions.< / p >
2013-05-18 20:29:06 +02:00
< p > < b > Toolchain Support< / b > < / p >
< 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 >
2012-12-30 11:25:17 +01:00
< p > < b > Building the Library< / b > < / p >
2013-05-17 22:41:34 +02:00
< p > The library installer contains project files to re build libraries on MDK Tool chain in the < code > CMSIS\DSP_Lib\Source\ARM< / code > folder.< / p >
2012-12-30 11:25:17 +01:00
< 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 >
2013-05-18 20:29:06 +02:00
< p > The project can be built by opening the appropriate project in MDK-ARM 4.60 chain and defining the optional pre processor MACROs detailed above.< / p >
< p > < b > Pre-processor Macros< / b > < / p >
< p > Each library project have differant pre-processor macros.< / p >
< ul >
< li > UNALIGNED_SUPPORT_DISABLE:< / li >
< / ul >
< p > Define macro UNALIGNED_SUPPORT_DISABLE, If the silicon does not support unaligned memory access< / 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_CMx:< / li >
< / ul >
< 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 >
< ul >
< li > __FPU_PRESENT:< / li >
< / ul >
< p > Initialize macro __FPU_PRESENT = 1 when building on FPU supported Targets. Enable this macro for M4bf and M4lf libraries< / p >
2012-12-30 11:25:17 +01:00
< p > < b > Copyright Notice< / b > < / p >
2013-05-18 20:29:06 +02:00
< p > Copyright (C) 2010-2013 ARM Limited. All rights reserved. < / 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" > Generated on Mon Mar 18 2013 13:37:58 for CMSIS-DSP by ARM Ltd. All rights reserved.
<!--
2013-05-17 22:41:34 +02:00
< a href = "http://www.doxygen.org/index.html" >
2013-05-18 20:29:06 +02:00
< img class = "footer" src = "doxygen.png" alt = "doxygen" / > < / a > 1.8.3.1
-->
< / li >
< / ul >
< / div >
2012-12-30 11:25:17 +01:00
< / body >
< / html >
