]> begriffs open source - cmsis/blob - main/Core_A/html/group__version__ctrl.html
Initial contribution
[cmsis] / main / Core_A / html / 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, "CMSIS-Core (Cortex-A)");
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 <!-- 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__ctrl.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 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: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>
139 <tr class="memdesc:ga519092cc80304900838f3d79a1a04e36"><td class="mdescLeft">&#160;</td><td class="mdescRight">[31:16] CMSIS-Core(A) main version <br  />
140   <br /></td></tr>
141 <tr class="separator:ga519092cc80304900838f3d79a1a04e36"><td class="memSeparator" colspan="2">&#160;</td></tr>
142 <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>
143 <tr class="memdesc:gaca4690227a53e24645758cdab9a00cdf"><td class="mdescLeft">&#160;</td><td class="mdescRight">[15:0] CMSIS-Core(A) sub version <br  />
144   <br /></td></tr>
145 <tr class="separator:gaca4690227a53e24645758cdab9a00cdf"><td class="memSeparator" colspan="2">&#160;</td></tr>
146 <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>
147 <tr class="memdesc:ga60199f17babba1ac0cf233e59043b23b"><td class="mdescLeft">&#160;</td><td class="mdescRight">CMSIS-Core(A) version number <br  />
148   <br /></td></tr>
149 <tr class="separator:ga60199f17babba1ac0cf233e59043b23b"><td class="memSeparator" colspan="2">&#160;</td></tr>
150 </table>
151 <a name="details" id="details"></a><h2 class="groupheader">Description</h2>
152 <h2 class="groupheader">Macro Definition Documentation</h2>
153 <a id="ga60199f17babba1ac0cf233e59043b23b" name="ga60199f17babba1ac0cf233e59043b23b"></a>
154 <h2 class="memtitle"><span class="permalink"><a href="#ga60199f17babba1ac0cf233e59043b23b">&#9670;&#160;</a></span>__CA_CMSIS_VERSION</h2>
155
156 <div class="memitem">
157 <div class="memproto">
158       <table class="memname">
159         <tr>
160           <td class="memname">#define __CA_CMSIS_VERSION</td>
161         </tr>
162       </table>
163 </div><div class="memdoc">
164 <p>Use this define to query the full version of CMSIS-Core(A) component.</p>
165 <table class="markdownTable">
166 <tr class="markdownTableHead">
167 <th class="markdownTableHeadLeft">Bits   </th><th class="markdownTableHeadLeft">Name   </th><th class="markdownTableHeadLeft">Function    </th></tr>
168 <tr class="markdownTableRowOdd">
169 <td class="markdownTableBodyLeft">[31:16]   </td><td class="markdownTableBodyLeft">MAIN   </td><td class="markdownTableBodyLeft">__CA_CMSIS_VERSION_MAIN    </td></tr>
170 <tr class="markdownTableRowEven">
171 <td class="markdownTableBodyLeft">[15:0]   </td><td class="markdownTableBodyLeft">SUB   </td><td class="markdownTableBodyLeft">__CA_CMSIS_VERSION_SUB   </td></tr>
172 </table>
173 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION &lt; 0x00050001</span></div>
174 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5.1!</span></div>
175 <div class="line"><span class="preprocessor">#endif</span></div>
176 </div><!-- fragment --> 
177 </div>
178 </div>
179 <a id="ga519092cc80304900838f3d79a1a04e36" name="ga519092cc80304900838f3d79a1a04e36"></a>
180 <h2 class="memtitle"><span class="permalink"><a href="#ga519092cc80304900838f3d79a1a04e36">&#9670;&#160;</a></span>__CA_CMSIS_VERSION_MAIN</h2>
181
182 <div class="memitem">
183 <div class="memproto">
184       <table class="memname">
185         <tr>
186           <td class="memname">#define __CA_CMSIS_VERSION_MAIN&#160;&#160;&#160;(1U)</td>
187         </tr>
188       </table>
189 </div><div class="memdoc">
190 <p>Use this define to query the major version of CMSIS-Core(A) component.</p>
191 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
192 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
193 <div class="line"><span class="preprocessor">#endif</span></div>
194 </div><!-- fragment --> 
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&#160;&#160;&#160;(1U)</td>
205         </tr>
206       </table>
207 </div><div class="memdoc">
208 <p>Use this define to query the minor version of CMSIS-Core(A) component.</p>
209 <p><b>Example:</b> </p><div class="fragment"><div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_MAIN &lt; 5</span></div>
210 <div class="line"><span class="preprocessor">#error This code needs at least CMSIS-Core(A) version 5!</span></div>
211 <div class="line"><span class="preprocessor">#else</span></div>
212 <div class="line"><span class="preprocessor">#if __CA_CMSIS_VERSION_SUB &lt; 1</span></div>
213 <div class="line"><span class="preprocessor">#warning Using CMSIS-Core(A) version 5.0 compatibility functions.</span></div>
214 <div class="line"><span class="preprocessor">#endif</span></div>
215 <div class="line"><span class="preprocessor">#endif</span></div>
216 </div><!-- fragment --> 
217 </div>
218 </div>
219 </div><!-- contents -->
220 </div><!-- doc-content -->
221 <!-- start footer part -->
222 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
223   <ul>
224     <li class="footer">
225       <script type="text/javascript">
226         <!--
227         writeFooter.call(this);
228         //-->
229       </script> 
230     </li>
231   </ul>
232 </div>
233 </body>
234 </html>