begriffs open source - cmsis/blob - main/Core_A/group__version__ctrl.html

   1 <!-- HTML header for doxygen 1.9.6-->
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
   4 <head>
   5 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
   6 <meta http-equiv="X-UA-Compatible" content="IE=11"/>
   7 <meta name="viewport" content="width=device-width, initial-scale=1"/>
   8 <title>CMSIS-Core (Cortex-A): Version Control</title>
   9 <link href="doxygen.css" rel="stylesheet" type="text/css"/>
  10 <link href="tabs.css" rel="stylesheet" type="text/css"/>
  11 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  12 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  13 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  14 <script type="text/javascript" src="jquery.js"></script>
  15 <script type="text/javascript" src="dynsections.js"></script>
  16 <script type="text/javascript" src="printComponentTabs.js"></script>
  17 <script type="text/javascript" src="footer.js"></script>
  18 <script type="text/javascript" src="navtree.js"></script>
  19 <link href="navtree.css" rel="stylesheet" type="text/css"/>
  20 <script type="text/javascript" src="resize.js"></script>
  21 <script type="text/javascript" src="navtreedata.js"></script>
  22 <script type="text/javascript" src="navtree.js"></script>
  23 <link href="search/search.css" rel="stylesheet" type="text/css"/>
  24 <script type="text/javascript" src="search/searchdata.js"></script>
  25 <script type="text/javascript" src="search/search.js"></script>
  26 <script type="text/javascript">
  27 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  28   $(document).ready(function() { init_search(); });
  29 /* @license-end */
  30 </script>
  31 <script type="text/javascript" src="darkmode_toggle.js"></script>
  32 <link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
  33 <link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
  34 <link href="extra_search.css" rel="stylesheet" type="text/css"/>
  35 <link href="version.css" rel="stylesheet" type="text/css" />
  36 <script type="text/javascript" src="../../../version.js"></script>
  37 </head>
  38 <body>
  39 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  40 <div id="titlearea">
  41 <table cellspacing="0" cellpadding="0">
  42  <tbody>
  43  <tr style="height: 55px;">
  44   <td id="projectlogo" style="padding: 1.5em;"><img alt="Logo" src="cmsis_logo_white_small.png"/></td>
  45   <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
  46    <div id="projectname">CMSIS-Core (Cortex-A)
  47    &#160;<span id="projectnumber"><script type="text/javascript">
  48      <!--
  49      writeHeader.call(this);
  50      writeVersionDropdown.call(this);
  51      //-->
  52     </script>
  53    </span>
  54    </div>
  55    <div id="projectbrief">CMSIS-Core support for Cortex-A processor-based devices</div>
  56   </td>
  57    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  58         <span class="left">
  59           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  60           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  61                onfocus="searchBox.OnSearchFieldFocus(true)"
  62                onblur="searchBox.OnSearchFieldFocus(false)"
  63                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  64           </span><span class="right">
  65             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  66           </span>
  67         </div>
  68 </td>
  69   <!--END !PROJECT_NAME-->
  70  </tr>
  71  </tbody>
  72 </table>
  73 </div>
  74 <!-- end header part -->
  75 <div id="CMSISnav" class="tabs1">
  76   <ul class="tablist">
  77     <script type="text/javascript">
  78       writeComponentTabs.call(this);
  79     </script>
  80   </ul>
  81 </div>
  82 <script type="text/javascript">
  83   writeSubComponentTabs.call(this);
  84 </script>
  85 <!-- Generated by Doxygen 1.9.6 -->
  86 <script type="text/javascript">
  87 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  88 var searchBox = new SearchBox("searchBox", "search/",'.html');
  89 /* @license-end */
  90 </script>
  91 </div><!-- top -->
  92 <div id="side-nav" class="ui-resizable side-nav-resizable">
  93   <div id="nav-tree">
  94     <div id="nav-tree-contents">
  95       <div id="nav-sync" class="sync"></div>
  96     </div>
  97   </div>
  98   <div id="splitbar" style="-moz-user-select:none;"
  99        class="ui-resizable-handle">
 100   </div>
 101 </div>
 102 <script type="text/javascript">
 103 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
 104 $(document).ready(function(){initNavTree('group__version__ctrl.html',''); initResizable(); });
 105 /* @license-end */
 106 </script>
 107 <div id="doc-content">
 108 <!-- window showing the filter options -->
 109 <div id="MSearchSelectWindow"
 110      onmouseover="return searchBox.OnSearchSelectShow()"
 111      onmouseout="return searchBox.OnSearchSelectHide()"
 112      onkeydown="return searchBox.OnSearchSelectKey(event)">
 113 </div>
 114
 115 <!-- iframe showing the search results (closed by default) -->
 116 <div id="MSearchResultsWindow">
 117 <div id="MSearchResults">
 118 <div class="SRPage">
 119 <div id="SRIndex">
 120 <div id="SRResults"></div>
 121 <div class="SRStatus" id="Loading">Loading...</div>
 122 <div class="SRStatus" id="Searching">Searching...</div>
 123 <div class="SRStatus" id="NoMatches">No Matches</div>
 124 </div>
 125 </div>
 126 </div>
 127 </div>
 128
 129 <div class="header">
 130   <div class="summary">
 131 <a href="#define-members">Macros</a>  </div>
 132   <div class="headertitle"><div class="title">Version Control</div></div>
 133 </div><!--header-->
 134 <div class="contents">
 135
 136 <p>Version symbols for CMSIS release specific C/C++ source code.
 137 <a href="#details">More...</a></p>
 138 <table class="memberdecls">
 139 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a>
 140 Macros</h2></td></tr>
 141 <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>
 142 <tr class="memdesc:ga519092cc80304900838f3d79a1a04e36"><td class="mdescLeft">&#160;</td><td class="mdescRight">[31:16] CMSIS-Core(A) main version <br  />
 143   <br /></td></tr>
 144 <tr class="separator:ga519092cc80304900838f3d79a1a04e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
 145 <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>
 146 <tr class="memdesc:gaca4690227a53e24645758cdab9a00cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">[15:0] CMSIS-Core(A) sub version <br  />
 147   <br /></td></tr>
 148 <tr class="separator:gaca4690227a53e24645758cdab9a00cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
 149 <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>
 150 <tr class="memdesc:ga60199f17babba1ac0cf233e59043b23b"><td class="mdescLeft">&#160;</td><td class="mdescRight">CMSIS-Core(A) version number <br  />
 151   <br /></td></tr>
 152 <tr class="separator:ga60199f17babba1ac0cf233e59043b23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <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;0x0000</td></tr>
 154 <tr class="memdesc:ga8ebf37d3e9141ccae33bb6b1edf539bd"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core revision for a Cortex-A class device.  <br /></td></tr>
 155 <tr class="separator:ga8ebf37d3e9141ccae33bb6b1edf539bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <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;0x0000</td></tr>
 157 <tr class="memdesc:ga74d176c89aefe783e9ce0712c4360537"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core family for a Cortex-A class device.  <br /></td></tr>
 158 <tr class="separator:ga74d176c89aefe783e9ce0712c4360537"><td class="memSeparator" colspan="2">&#160;</td></tr>
 159 </table>
 160 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
 161 <p>Version symbols for CMSIS release specific C/C++ source code. </p>
 162 <h2 class="groupheader">Macro Definition Documentation</h2>
 163 <a id="ga60199f17babba1ac0cf233e59043b23b" name="ga60199f17babba1ac0cf233e59043b23b"></a>
 164 <h2 class="memtitle"><span class="permalink"><a href="#ga60199f17babba1ac0cf233e59043b23b">&#9670;&#160;</a></span>__CA_CMSIS_VERSION</h2>
 165
 166 <div class="memitem">
 167 <div class="memproto">
 168       <table class="memname">
 169         <tr>
 170           <td class="memname">#define __CA_CMSIS_VERSION</td>
 171         </tr>
 172       </table>
 173 </div><div class="memdoc">
 174
 175 <p>CMSIS-Core(A) version number <br  />
 176  </p>
 177 <p>Use this define to query the full version of CMSIS-Core(A) component.</p>
 178 <table class="markdownTable">
 179 <tr class="markdownTableHead">
 180 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
 181 <tr class="markdownTableRowOdd">
 182 <td class="markdownTableBodyLeft">[31:16]   </td><td class="markdownTableBodyLeft">MAIN   </td><td class="markdownTableBodyLeft">__CA_CMSIS_VERSION_MAIN    </td></tr>
 183 <tr class="markdownTableRowEven">
 184 <td class="markdownTableBodyLeft">[15:0]   </td><td class="markdownTableBodyLeft">SUB   </td><td class="markdownTableBodyLeft">__CA_CMSIS_VERSION_SUB   </td></tr>
 185 </table>
 186 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION &lt; 0x00050001</span></div>
 187 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5.1!</span></div>
 188 <div class="line"><span class="preprocessor">#endif</span></div>
 189 </div><!-- fragment -->
 190 </div>
 191 </div>
 192 <a id="ga519092cc80304900838f3d79a1a04e36" name="ga519092cc80304900838f3d79a1a04e36"></a>
 193 <h2 class="memtitle"><span class="permalink"><a href="#ga519092cc80304900838f3d79a1a04e36">&#9670;&#160;</a></span>__CA_CMSIS_VERSION_MAIN</h2>
 194
 195 <div class="memitem">
 196 <div class="memproto">
 197       <table class="memname">
 198         <tr>
 199           <td class="memname">#define __CA_CMSIS_VERSION_MAIN&#160;&#160;&#160;(1U)</td>
 200         </tr>
 201       </table>
 202 </div><div class="memdoc">
 203
 204 <p>[31:16] CMSIS-Core(A) main version <br  />
 205  </p>
 206 <p>Use this define to query the major version of CMSIS-Core(A) component.</p>
 207 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
 208 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
 209 <div class="line"><span class="preprocessor">#endif</span></div>
 210 </div><!-- fragment -->
 211 </div>
 212 </div>
 213 <a id="gaca4690227a53e24645758cdab9a00cdf" name="gaca4690227a53e24645758cdab9a00cdf"></a>
 214 <h2 class="memtitle"><span class="permalink"><a href="#gaca4690227a53e24645758cdab9a00cdf">&#9670;&#160;</a></span>__CA_CMSIS_VERSION_SUB</h2>
 215
 216 <div class="memitem">
 217 <div class="memproto">
 218       <table class="memname">
 219         <tr>
 220           <td class="memname">#define __CA_CMSIS_VERSION_SUB&#160;&#160;&#160;(1U)</td>
 221         </tr>
 222       </table>
 223 </div><div class="memdoc">
 224
 225 <p>[15:0] CMSIS-Core(A) sub version <br  />
 226  </p>
 227 <p>Use this define to query the minor version of CMSIS-Core(A) component.</p>
 228 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
 229 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
 230 <div class="line"><span class="preprocessor">#else</span></div>
 231 <div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_SUB &lt; 1</span></div>
 232 <div class="line"><span class="preprocessor">#warning Using CMSIS-Core(A) version 5.0 compatibility functions.</span></div>
 233 <div class="line"><span class="preprocessor">#endif</span></div>
 234 <div class="line"><span class="preprocessor">#endif</span></div>
 235 </div><!-- fragment -->
 236 </div>
 237 </div>
 238 <a id="ga8ebf37d3e9141ccae33bb6b1edf539bd" name="ga8ebf37d3e9141ccae33bb6b1edf539bd"></a>
 239 <h2 class="memtitle"><span class="permalink"><a href="#ga8ebf37d3e9141ccae33bb6b1edf539bd">&#9670;&#160;</a></span>__CA_REV</h2>
 240
 241 <div class="memitem">
 242 <div class="memproto">
 243       <table class="memname">
 244         <tr>
 245           <td class="memname">#define __CA_REV&#160;&#160;&#160;0x0000</td>
 246         </tr>
 247       </table>
 248 </div><div class="memdoc">
 249
 250 <p>Contains the core revision for a Cortex-A class device. </p>
 251 <p>Use this define to query the core design revision number implemented in the selected device.</p>
 252 <table class="markdownTable">
 253 <tr class="markdownTableHead">
 254 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
 255 <tr class="markdownTableRowOdd">
 256 <td class="markdownTableBodyLeft">[15:8]   </td><td class="markdownTableBodyLeft">REV   </td><td class="markdownTableBodyLeft">Revision number    </td></tr>
 257 <tr class="markdownTableRowEven">
 258 <td class="markdownTableBodyLeft">[7:0]   </td><td class="markdownTableBodyLeft">PATCH   </td><td class="markdownTableBodyLeft">Patch number   </td></tr>
 259 </table>
 260 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_REV &lt; 0x0201</span></div>
 261 <div class="line"><span class="preprocessor">#error This code needs at least a core revision r2p1.</span></div>
 262 <div class="line"><span class="preprocessor">#endif</span></div>
 263 </div><!-- fragment -->
 264 </div>
 265 </div>
 266 <a id="ga74d176c89aefe783e9ce0712c4360537" name="ga74d176c89aefe783e9ce0712c4360537"></a>
 267 <h2 class="memtitle"><span class="permalink"><a href="#ga74d176c89aefe783e9ce0712c4360537">&#9670;&#160;</a></span>__CORTEX_A</h2>
 268
 269 <div class="memitem">
 270 <div class="memproto">
 271       <table class="memname">
 272         <tr>
 273           <td class="memname">#define __CORTEX_A&#160;&#160;&#160;0x0000</td>
 274         </tr>
 275       </table>
 276 </div><div class="memdoc">
 277
 278 <p>Contains the core family for a Cortex-A class device. </p>
 279 <p>Use this define to query the actual Cortex-A class device number implemented in the selected device.</p>
 280 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CORTEX_A == 5</span></div>
 281 <div class="line"><span class="preprocessor">#warning Running on Cortex-A5.</span></div>
 282 <div class="line"><span class="preprocessor">#elif __CORTEX_A == 7</span></div>
 283 <div class="line"><span class="preprocessor">#warning Running on Cortex-A7.</span></div>
 284 <div class="line"><span class="preprocessor">#elif __CORTEX_A == 9</span></div>
 285 <div class="line"><span class="preprocessor">#warning Running on Cortex-A9.</span></div>
 286 <div class="line"><span class="preprocessor">#endif</span></div>
 287 </div><!-- fragment -->
 288 </div>
 289 </div>
 290 </div><!-- contents -->
 291 </div><!-- doc-content -->
 292 <!-- start footer part -->
 293 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 294   <ul>
 295     <li class="footer">
 296       <script type="text/javascript">
 297         <!--
 298         writeFooter.call(this);
 299         //-->
 300       </script>
 301     </li>
 302   </ul>
 303 </div>
 304 </body>
 305 </html>