blob: c335a3d47bede8f8575a75a42be26d9b4f077cd7 [file] [log] [blame]
<!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>Version Control</title>
<title>CMSIS-Core (Cortex-A): Version Control</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>
<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-Core (Cortex-A)
&#160;<span id="projectnumber">Version 1.1.4</span>
</div>
<div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- 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><a href="index.html"><span>Main&#160;Page</span></a></li>
<li><a href="pages.html"><span>Usage&#160;and&#160;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('group__version__ctrl.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">&#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>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</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="summary">
<a href="#define-members">Macros</a> </div>
<div class="headertitle">
<div class="title">Version Control</div> </div>
</div><!--header-->
<div class="contents">
<p>Version symbols for CMSIS release specific C/C++ source code.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga519092cc80304900838f3d79a1a04e36"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__ctrl.html#ga519092cc80304900838f3d79a1a04e36">__CA_CMSIS_VERSION_MAIN</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:ga519092cc80304900838f3d79a1a04e36"><td class="mdescLeft">&#160;</td><td class="mdescRight">[31:16] CMSIS-Core(A) main version <a href="#ga519092cc80304900838f3d79a1a04e36">More...</a><br/></td></tr>
<tr class="separator:ga519092cc80304900838f3d79a1a04e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaca4690227a53e24645758cdab9a00cdf"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__ctrl.html#gaca4690227a53e24645758cdab9a00cdf">__CA_CMSIS_VERSION_SUB</a>&#160;&#160;&#160;(1U)</td></tr>
<tr class="memdesc:gaca4690227a53e24645758cdab9a00cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">[15:0] CMSIS-Core(A) sub version <a href="#gaca4690227a53e24645758cdab9a00cdf">More...</a><br/></td></tr>
<tr class="separator:gaca4690227a53e24645758cdab9a00cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60199f17babba1ac0cf233e59043b23b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__ctrl.html#ga60199f17babba1ac0cf233e59043b23b">__CA_CMSIS_VERSION</a></td></tr>
<tr class="memdesc:ga60199f17babba1ac0cf233e59043b23b"><td class="mdescLeft">&#160;</td><td class="mdescRight">CMSIS-Core(A) version number. <a href="#ga60199f17babba1ac0cf233e59043b23b">More...</a><br/></td></tr>
<tr class="separator:ga60199f17babba1ac0cf233e59043b23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga8ebf37d3e9141ccae33bb6b1edf539bd"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__ctrl.html#ga8ebf37d3e9141ccae33bb6b1edf539bd">__CA_REV</a>&#160;&#160;&#160;0x0000U</td></tr>
<tr class="memdesc:ga8ebf37d3e9141ccae33bb6b1edf539bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core revision for a Cortex-A class device. <a href="#ga8ebf37d3e9141ccae33bb6b1edf539bd">More...</a><br/></td></tr>
<tr class="separator:ga8ebf37d3e9141ccae33bb6b1edf539bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga74d176c89aefe783e9ce0712c4360537"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__ctrl.html#ga74d176c89aefe783e9ce0712c4360537">__CORTEX_A</a>&#160;&#160;&#160;9U</td></tr>
<tr class="memdesc:ga74d176c89aefe783e9ce0712c4360537"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core family for a Cortex-A class device. <a href="#ga74d176c89aefe783e9ce0712c4360537">More...</a><br/></td></tr>
<tr class="separator:ga74d176c89aefe783e9ce0712c4360537"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga60199f17babba1ac0cf233e59043b23b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __CA_CMSIS_VERSION</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this define to query the full version of CMSIS-Core(A) component.</p>
<table class="doxtable">
<tr>
<th align="left">Bits </th><th align="left">Name </th><th align="left">Function </th></tr>
<tr>
<td align="left">[31:16] </td><td align="left">MAIN </td><td align="left">__CA_CMSIS_VERSION_MAIN </td></tr>
<tr>
<td align="left">[15:0] </td><td align="left">SUB </td><td align="left">__CA_CMSIS_VERSION_SUB </td></tr>
</table>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION &lt; 0x00050001</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5.1!</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga519092cc80304900838f3d79a1a04e36"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __CA_CMSIS_VERSION_MAIN&#160;&#160;&#160;(1U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this define to query the major version of CMSIS-Core(A) component.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="gaca4690227a53e24645758cdab9a00cdf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __CA_CMSIS_VERSION_SUB&#160;&#160;&#160;(1U)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this define to query the minor version of CMSIS-Core(A) component.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#else</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#if __CA_CMSIS_VERSION_SUB &lt; 1</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#warning Using CMSIS-Core(A) version 5.0 compatibility functions.</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#endif</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment -->
</div>
</div>
<a class="anchor" id="ga8ebf37d3e9141ccae33bb6b1edf539bd"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __CA_REV&#160;&#160;&#160;0x0000U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this define to query the core design revision number implemented in the selected device.</p>
<table class="doxtable">
<tr>
<th align="left">Bits </th><th align="left">Name </th><th align="left">Function </th></tr>
<tr>
<td align="left">[15:8] </td><td align="left">REV </td><td align="left">Revision number </td></tr>
<tr>
<td align="left">[7:0] </td><td align="left">PATCH </td><td align="left">Patch number </td></tr>
</table>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if __CA_REV &lt; 0x0201</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#error This code needs at least a core revision r2p1.</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment --><p>Core revision r0p0 </p>
</div>
</div>
<a class="anchor" id="ga74d176c89aefe783e9ce0712c4360537"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define __CORTEX_A&#160;&#160;&#160;9U</td>
</tr>
</table>
</div><div class="memdoc">
<p>Use this define to query the actual Cortex-A class device number implemented in the selected device.</p>
<p><b>Example:</b> </p>
<div class="fragment"><div class="line"><span class="preprocessor">#if __CORTEX_A == 5</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#warning Running on Cortex-A5.</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#elif __CORTEX_A == 7</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#warning Running on Cortex-A7.</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#elif __CORTEX_A == 9</span></div>
<div class="line"><span class="preprocessor"></span><span class="preprocessor">#warning Running on Cortex-A9.</span></div>
<div class="line"><span class="preprocessor">#endif</span></div>
</div><!-- fragment --><p>Cortex-A9 Core </p>
</div>
</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 Wed Jul 10 2019 15:20:27 for CMSIS-Core (Cortex-A) Version 1.1.4 by Arm Ltd. All rights reserved.
<!--
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
-->
</li>
</ul>
</div>
</body>
</html>