begriffs open source - cmsis/blob - main/Core/html/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-M): 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-M)
  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-M 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__control__gr.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 #define 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:ga85987c5fcc1e012d7ac01369ee6ca2b5"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#ga85987c5fcc1e012d7ac01369ee6ca2b5">__CM_CMSIS_VERSION_MAIN</a></td></tr>
 142 <tr class="memdesc:ga85987c5fcc1e012d7ac01369ee6ca2b5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the CMSIS major version.  <br /></td></tr>
 143 <tr class="separator:ga85987c5fcc1e012d7ac01369ee6ca2b5"><td class="memSeparator" colspan="2">&#160;</td></tr>
 144 <tr class="memitem:ga22083cbe7f0606cfd538ec12b2e41608"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#ga22083cbe7f0606cfd538ec12b2e41608">__CM_CMSIS_VERSION_SUB</a></td></tr>
 145 <tr class="memdesc:ga22083cbe7f0606cfd538ec12b2e41608"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the CMSIS minor version.  <br /></td></tr>
 146 <tr class="separator:ga22083cbe7f0606cfd538ec12b2e41608"><td class="memSeparator" colspan="2">&#160;</td></tr>
 147 <tr class="memitem:ga39f3d64ff95fb58feccc7639e537ff89"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#ga39f3d64ff95fb58feccc7639e537ff89">__CM_CMSIS_VERSION</a></td></tr>
 148 <tr class="memdesc:ga39f3d64ff95fb58feccc7639e537ff89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the CMSIS version.  <br /></td></tr>
 149 <tr class="separator:ga39f3d64ff95fb58feccc7639e537ff89"><td class="memSeparator" colspan="2">&#160;</td></tr>
 150 <tr class="memitem:ga63ea62503c88acab19fcf3d5743009e3"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#ga63ea62503c88acab19fcf3d5743009e3">__CORTEX_M</a></td></tr>
 151 <tr class="memdesc:ga63ea62503c88acab19fcf3d5743009e3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core version for a Cortex-M class controller.  <br /></td></tr>
 152 <tr class="separator:ga63ea62503c88acab19fcf3d5743009e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
 153 <tr class="memitem:gaeaaf66c86e5ae02a0e1fe542cb7f4d8c"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#gaeaaf66c86e5ae02a0e1fe542cb7f4d8c">__CORTEX_SC</a></td></tr>
 154 <tr class="memdesc:gaeaaf66c86e5ae02a0e1fe542cb7f4d8c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core version for a Cortex Secure Core controller.  <br /></td></tr>
 155 <tr class="separator:gaeaaf66c86e5ae02a0e1fe542cb7f4d8c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 156 <tr class="memitem:ga9db417c20fe833187e2f2b8aeb14e94e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__version__control__gr.html#ga9db417c20fe833187e2f2b8aeb14e94e">__STAR_MC</a></td></tr>
 157 <tr class="memdesc:ga9db417c20fe833187e2f2b8aeb14e94e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Contains the core version for a STAR-MC controller.  <br /></td></tr>
 158 <tr class="separator:ga9db417c20fe833187e2f2b8aeb14e94e"><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 #define symbols for CMSIS release specific C/C++ source code. </p>
 162 <p>The header file <b>cmsis_version.h</b> is included by each core header so that these definitions are available.</p>
 163 <p><b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if defined(__CM_CMSIS_VERSION) &amp;&amp; \</span></div>
 164 <div class="line"><span class="preprocessor">    (__CM_CMSIS_VERSION &gt;= 0x00050001)</span></div>
 165 <div class="line"><span class="preprocessor">#error Yes, we have CMSIS 5.1 or later</span></div>
 166 <div class="line"><span class="preprocessor">#else</span></div>
 167 <div class="line"><span class="preprocessor">#error We need CMSIS 5.1 or later!</span></div>
 168 <div class="line"><span class="preprocessor">#endif</span></div>
 169 </div><!-- fragment --><p><b>Deprecated</b></p>
 170 <p>The following macros are deprecated:</p><ul>
 171 <li><b>__XXX_CMSIS_VERSION_MAIN</b> which is replaced by <a class="el" href="group__version__control__gr.html#ga85987c5fcc1e012d7ac01369ee6ca2b5">__CM_CMSIS_VERSION_MAIN</a>.</li>
 172 <li><b>__XXX_CMSIS_VERSION_SUB</b> which is replaced by <a class="el" href="group__version__control__gr.html#ga22083cbe7f0606cfd538ec12b2e41608">__CM_CMSIS_VERSION_SUB</a>.</li>
 173 <li><b>__XXX_CMSIS_VERSION</b> which is replaced by <a class="el" href="group__version__control__gr.html#ga39f3d64ff95fb58feccc7639e537ff89">__CM_CMSIS_VERSION</a>. </li>
 174 </ul>
 175 <h2 class="groupheader">Macro Definition Documentation</h2>
 176 <a id="ga39f3d64ff95fb58feccc7639e537ff89" name="ga39f3d64ff95fb58feccc7639e537ff89"></a>
 177 <h2 class="memtitle"><span class="permalink"><a href="#ga39f3d64ff95fb58feccc7639e537ff89">&#9670;&#160;</a></span>__CM_CMSIS_VERSION</h2>
 178
 179 <div class="memitem">
 180 <div class="memproto">
 181       <table class="memname">
 182         <tr>
 183           <td class="memname">#define __CM_CMSIS_VERSION</td>
 184         </tr>
 185       </table>
 186 </div><div class="memdoc">
 187
 188 <p>Contains the CMSIS version. </p>
 189 <p>The CMSIS version is a combination of the <a class="el" href="group__version__control__gr.html#ga85987c5fcc1e012d7ac01369ee6ca2b5">__CM_CMSIS_VERSION_MAIN</a> (bits 31..15) and <a class="el" href="group__version__control__gr.html#ga22083cbe7f0606cfd538ec12b2e41608">__CM_CMSIS_VERSION_SUB</a> (bits 14..0). </p>
 190
 191 </div>
 192 </div>
 193 <a id="ga85987c5fcc1e012d7ac01369ee6ca2b5" name="ga85987c5fcc1e012d7ac01369ee6ca2b5"></a>
 194 <h2 class="memtitle"><span class="permalink"><a href="#ga85987c5fcc1e012d7ac01369ee6ca2b5">&#9670;&#160;</a></span>__CM_CMSIS_VERSION_MAIN</h2>
 195
 196 <div class="memitem">
 197 <div class="memproto">
 198       <table class="memname">
 199         <tr>
 200           <td class="memname">#define __CM_CMSIS_VERSION_MAIN</td>
 201         </tr>
 202       </table>
 203 </div><div class="memdoc">
 204
 205 <p>Contains the CMSIS major version. </p>
 206 <p>The CMSIS major version can be used to differentiate between CMSIS major releases. </p>
 207
 208 </div>
 209 </div>
 210 <a id="ga22083cbe7f0606cfd538ec12b2e41608" name="ga22083cbe7f0606cfd538ec12b2e41608"></a>
 211 <h2 class="memtitle"><span class="permalink"><a href="#ga22083cbe7f0606cfd538ec12b2e41608">&#9670;&#160;</a></span>__CM_CMSIS_VERSION_SUB</h2>
 212
 213 <div class="memitem">
 214 <div class="memproto">
 215       <table class="memname">
 216         <tr>
 217           <td class="memname">#define __CM_CMSIS_VERSION_SUB</td>
 218         </tr>
 219       </table>
 220 </div><div class="memdoc">
 221
 222 <p>Contains the CMSIS minor version. </p>
 223 <p>The CMSIS minor version can be used to query a CMSIS release update level. </p>
 224
 225 </div>
 226 </div>
 227 <a id="ga63ea62503c88acab19fcf3d5743009e3" name="ga63ea62503c88acab19fcf3d5743009e3"></a>
 228 <h2 class="memtitle"><span class="permalink"><a href="#ga63ea62503c88acab19fcf3d5743009e3">&#9670;&#160;</a></span>__CORTEX_M</h2>
 229
 230 <div class="memitem">
 231 <div class="memproto">
 232       <table class="memname">
 233         <tr>
 234           <td class="memname">#define __CORTEX_M</td>
 235         </tr>
 236       </table>
 237 </div><div class="memdoc">
 238
 239 <p>Contains the core version for a Cortex-M class controller. </p>
 240 <p>This define can be used to differentiate between the various available Cortex-M controllers. Possible values are:</p><ul>
 241 <li>0 for a Cortex-M0 or Cortex-M0+</li>
 242 <li>1 for a Cortex-M1</li>
 243 <li>3 for a Cortex-M3</li>
 244 <li>4 for a Cortex-M4</li>
 245 <li>7 for a Cortex-M7 </li>
 246 <li>23 for a Cortex-M23</li>
 247 <li>33 for a Cortex-M33</li>
 248 <li>35 for a Cortex-M35P</li>
 249 <li>55 for a Cortex-M55</li>
 250 <li>85 for a Cortex-M85</li>
 251 <li>2 for a Armv8-M Base Line device</li>
 252 <li>80 for a Armv8-M Main Line device</li>
 253 <li>81 for a Armv8.1-M Main Line device </li>
 254 </ul>
 255 <p>This define is only available for Cortex-M class controllers. <b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if defined(__CORTEX_M) &amp;&amp; (__CORTEX_M == 4)</span></div>
 256 <div class="line"><span class="preprocessor">#error Yes, we have an Cortex-M4 controller.</span></div>
 257 <div class="line"><span class="preprocessor">#else</span></div>
 258 <div class="line"><span class="preprocessor">#error We need a Cortex-M4 controller!</span></div>
 259 <div class="line"><span class="preprocessor">#endif</span></div>
 260 </div><!-- fragment -->
 261 </div>
 262 </div>
 263 <a id="gaeaaf66c86e5ae02a0e1fe542cb7f4d8c" name="gaeaaf66c86e5ae02a0e1fe542cb7f4d8c"></a>
 264 <h2 class="memtitle"><span class="permalink"><a href="#gaeaaf66c86e5ae02a0e1fe542cb7f4d8c">&#9670;&#160;</a></span>__CORTEX_SC</h2>
 265
 266 <div class="memitem">
 267 <div class="memproto">
 268       <table class="memname">
 269         <tr>
 270           <td class="memname">#define __CORTEX_SC</td>
 271         </tr>
 272       </table>
 273 </div><div class="memdoc">
 274
 275 <p>Contains the core version for a Cortex Secure Core controller. </p>
 276 <p>This define can be used to differentiate between the various available Cortex Secure Core controllers. Possible values are:</p><ul>
 277 <li>000 for a Cortex-SC000</li>
 278 <li>300 for a Cortex-SC300</li>
 279 </ul>
 280 <p>This define is only available for Cortex Secure Core controllers. <b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if defined(__CORTEX_SC) &amp;&amp; (__CORTEX_SC == 300U)</span></div>
 281 <div class="line"><span class="preprocessor">#error Yes, we have an Cortex SC300 controller.</span></div>
 282 <div class="line"><span class="preprocessor">#else</span></div>
 283 <div class="line"><span class="preprocessor">#error We need a Cortex SC300 controller!</span></div>
 284 <div class="line"><span class="preprocessor">#endif</span></div>
 285 </div><!-- fragment -->
 286 </div>
 287 </div>
 288 <a id="ga9db417c20fe833187e2f2b8aeb14e94e" name="ga9db417c20fe833187e2f2b8aeb14e94e"></a>
 289 <h2 class="memtitle"><span class="permalink"><a href="#ga9db417c20fe833187e2f2b8aeb14e94e">&#9670;&#160;</a></span>__STAR_MC</h2>
 290
 291 <div class="memitem">
 292 <div class="memproto">
 293       <table class="memname">
 294         <tr>
 295           <td class="memname">#define __STAR_MC</td>
 296         </tr>
 297       </table>
 298 </div><div class="memdoc">
 299
 300 <p>Contains the core version for a STAR-MC controller. </p>
 301 <p>This define can be used to differentiate between the various available STAR-MC controllers. Possible values are:</p><ul>
 302 <li>1 for a STAR-MC1</li>
 303 </ul>
 304 <p>This define is only available for STAR-MC controllers. <b>Code Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if defined(__STAR_MC) &amp;&amp; (__STAR_MC == 1U)</span></div>
 305 <div class="line"><span class="preprocessor">#error Yes, we have a STAR-MC1 controller.</span></div>
 306 <div class="line"><span class="preprocessor">#else</span></div>
 307 <div class="line"><span class="preprocessor">#error We need a STAR-MC1 controller!</span></div>
 308 <div class="line"><span class="preprocessor">#endif</span></div>
 309 </div><!-- fragment -->
 310 </div>
 311 </div>
 312 </div><!-- contents -->
 313 </div><!-- doc-content -->
 314 <!-- start footer part -->
 315 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 316   <ul>
 317     <li class="footer">
 318       <script type="text/javascript">
 319         <!--
 320         writeFooter.call(this);
 321         //-->
 322       </script>
 323     </li>
 324   </ul>
 325 </div>
 326 </body>
 327 </html>