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