]> begriffs open source - cmsis/blob - main/Core/index.html
Update main branch documentation
[cmsis] / main / Core / index.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): Overview</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, "CMSIS-Core (Cortex-M)");
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('index.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><div class="header">
130   <div class="headertitle"><div class="title">Overview </div></div>
131 </div><!--header-->
132 <div class="contents">
133 <div class="textblock"><p><a class="anchor" id="mainpage"></a> CMSIS-Core (Cortex-M) implements the basic run-time system for a Cortex-M device and gives the user access to the processor core and the device peripherals.</p>
134 <p>In detail it defines:</p>
135 <ul>
136 <li><b>Hardware Abstraction Layer (HAL)</b> for Cortex-M processor registers with standardized definitions for the SysTick, NVIC, System Control Block registers, MPU registers, FPU registers, and core access functions.</li>
137 <li><b>System exception names</b> to interface to system exceptions without having compatibility issues.</li>
138 <li><b>Methods to organize header files</b> that makes it easy to learn new Cortex-M microcontroller products and improve software portability. This includes naming conventions for device-specific interrupts.</li>
139 <li><b>Methods for system initialization</b> to be used by each MCU vendor. For example, the standardized <code><a class="el" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2" title="Function to Initialize the system.">SystemInit()</a></code> function is essential for configuring the clock system of the device.</li>
140 <li><b>Intrinsic functions</b> used to generate CPU instructions that are not supported by standard C functions.</li>
141 <li>A variable to determine the <b>system clock frequency</b> which simplifies the setup the SysTick timer.</li>
142 </ul>
143 <p>The following sections provide details about the CMSIS-Core (Cortex-M):</p>
144 <ul>
145 <li><a class="el" href="using_pg.html">Using CMSIS-Core</a> explains the project setup and shows a simple program example. </li>
146 <li><a class="el" href="using_TrustZone_pg.html">Using TrustZone&reg; for Armv8-M</a> describes how to use the security extensions available in the Armv8-M architecture. </li>
147 <li><a class="el" href="cmsis_core_files.html">CMSIS-Core Files</a> describes the files of the CMSIS-Core (Cortex-M) in detail and explains how to adapt template files provided by Arm to silicon vendor devices.</li>
148 <li><a class="el" href="coreMISRA_Exceptions_pg.html">MISRA-C Deviations</a> describes the violations to the MISRA standard.</li>
149 <li><a href="modules.html">API Reference</a> describes the features and functions of the <a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a> in detail.</li>
150 <li><a href="annotated.html">Data Structures</a> describe the data structures of the <a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a> in detail.</li>
151 </ul>
152 <h1><a class="anchor" id="autotoc_md0"></a>
153 Access to CMSIS-Core (Cortex-M)</h1>
154 <p>CMSIS-Core is actively maintained in <a href="https://github.com/ARM-software/CMSIS_6">CMSIS 6 GitHub repository</a> and released as part of the <a href="../General/cmsis_pack.html">CMSIS Software Pack</a>.</p>
155 <p>The following directories and files relevant to CMSIS-Core (Cortex-M) are present in the <b>ARM::CMSIS</b> Pack:</p>
156 <table class="markdownTable">
157 <tr class="markdownTableHead">
158 <th class="markdownTableHeadLeft">Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
159 <tr class="markdownTableRowOdd">
160 <td class="markdownTableBodyLeft">📂 CMSIS   </td><td class="markdownTableBodyLeft">CMSIS Base software components folder    </td></tr>
161 <tr class="markdownTableRowEven">
162 <td class="markdownTableBodyLeft">┣ ðŸ“‚ Documentation/html/Core   </td><td class="markdownTableBodyLeft">A local copy of this CMSIS-Core (M) documentation    </td></tr>
163 <tr class="markdownTableRowOdd">
164 <td class="markdownTableBodyLeft">â”— ðŸ“‚ Core   </td><td class="markdownTableBodyLeft">CMSIS-Core files    </td></tr>
165 <tr class="markdownTableRowEven">
166 <td class="markdownTableBodyLeft">&emsp;&#160; â”£ ðŸ“‚ Include   </td><td class="markdownTableBodyLeft"><a class="el" href="cmsis_core_files.html#cmsis_processor_files">CMSIS-Core Processor Files</a>.    </td></tr>
167 <tr class="markdownTableRowOdd">
168 <td class="markdownTableBodyLeft">&emsp;&emsp;&#160; â”— ðŸ“‚ m-profile   </td><td class="markdownTableBodyLeft">Header files specific for Arm M-Profile.<br  />
169  See <a class="el" href="cmsis_core_files.html#cmsis_compiler_files">CMSIS-Core Compiler Files</a> and <a class="el" href="cmsis_core_files.html#cmsis_feature_files">CMSIS-Core Architecture Feature Files</a>.    </td></tr>
170 <tr class="markdownTableRowEven">
171 <td class="markdownTableBodyLeft">&emsp;&#160; â”— ðŸ“‚ Template   </td><td class="markdownTableBodyLeft"><a class="el" href="cmsis_device_files.html#cmsis_template_files">Device Template Files</a>   </td></tr>
172 </table>
173 <h1><a class="anchor" id="ref_v6-v8M"></a>
174 Processor Support</h1>
175 <p>CMSIS-Core supports the complete range of <a href="https://www.arm.com/products/silicon-ip-cpu?families=cortex-m&amp;showall=true">Cortex-M processors</a>.</p>
176 <p><a class="anchor" id="ref_man_sec"></a><b>Cortex-M Generic User Guides</b></p>
177 <p>Following Cortex-M Device Generic User Guides contain the programmers model and detailed information about the core peripherals:</p><ul>
178 <li><a href="https://developer.arm.com/documentation/dui0497/latest/">Cortex-M0 Devices Generic User Guide (Armv6-M architecture)</a></li>
179 <li><a href="https://developer.arm.com/documentation/dui0662/latest/">Cortex-M0+ Devices Generic User Guide (Armv6-M architecture)</a></li>
180 <li><a href="https://developer.arm.com/documentation/dui0552/latest/">Cortex-M3 Devices Generic User Guide (Armv7-M architecture)</a></li>
181 <li><a href="https://developer.arm.com/documentation/dui0553/latest/">Cortex-M4 Devices Generic User Guide (Armv7-M architecture)</a></li>
182 <li><a href="https://developer.arm.com/documentation/dui0646/latest/">Cortex-M7 Devices Generic User Guide (Armv7-M architecture)</a></li>
183 <li><a href="https://developer.arm.com/documentation/dui1095/latest/">Cortex-M23 Devices Generic User Guide (Armv8-M architecture)</a></li>
184 <li><a href="https://developer.arm.com/documentation/100235/latest/">Cortex-M33 Devices Generic User Guide (Armv8-M architecture)</a></li>
185 <li><a href="https://developer.arm.com/documentation/101273/latest/">Cortex-M55 Devices Generic User Guide (Armv8.1-M architecture)</a></li>
186 <li><a href="https://developer.arm.com/documentation/101928/latest/">Cortex-M85 Devices Generic User Guide (Armv8.1-M architecture)</a></li>
187 </ul>
188 <p>CMSIS-Core also supports the following Cortex-M processor variants:</p><ul>
189 <li><a href="https://developer.arm.com/Processors/Cortex-M1">Cortex-M1</a> is a processor designed specifically for implementation in FPGAs (Armv6-M architecture).</li>
190 <li><a href="https://developer.arm.com/Processors/SecurCore%20SC000">SecurCore SC000</a> is designed specifically for smartcard and security applications (Armv6-M architecture).</li>
191 <li><a href="https://developer.arm.com/Processors/SecurCore%20SC300">SecurCore SC300</a> is designed specifically for smartcard and security applications (Armv7-M architecture).</li>
192 <li><a href="https://developer.arm.com/Processors/Cortex-M35P">Cortex-M35P</a> is a tamper resistant Cortex-M processor with optional software isolation using TrustZone for Armv8-M.</li>
193 <li><a href="https://www.armchina.com/mountain?infoId=160">STAR-MC1</a> is a variant of Armv8-M with TrustZone designed by Arm China.</li>
194 </ul>
195 <p><a class="anchor" id="ARMv8M"></a><b>Armv8-M and Armv8.1-M Architecture</b></p>
196 <p>Armv8-M introduces two profiles <b>baseline</b> (for power and area constrained applications) and <b>mainline</b> (full-featured with optional SIMD, floating-point, and co-processor extensions). Both Armv8-M profiles and Armv8.1-M are supported by CMSIS.</p>
197 <p>The Armv8-M architecture is described in the <a href="https://developer.arm.com/documentation/ddi0553/latest/">Armv8-M Architecture Reference Manual</a>.</p>
198 <p>The Armv8.1-M architecture further extends Armv8-M with Helium (the so called M-Profile Vector Extension (MVE)), as well as further instruction set and debug extensions.</p>
199 <p>More information about Armv8.1-M architecture is available under <a href="https://developer.arm.com/Architectures/Helium">Arm Helium technology</a>.</p>
200 <h1><a class="anchor" id="tested_tools_sec"></a>
201 Tested and Verified Toolchains</h1>
202 <p>The <a class="el" href="cmsis_core_files.html">CMSIS-Core Files</a> supplied by Arm have been tested and verified with the following toolchains:</p>
203 <ul>
204 <li>Arm: Arm Compiler 5.06 update 7 (not for Cortex-M23/33/35P/55/85, Armv8-M, Armv8.1-M)</li>
205 <li>Arm: Arm Compiler 6.16</li>
206 <li>Arm: Arm Compiler 6.6.4 (not for Cortex-M0/23/33/35P/55/85, Armv8-M, Armv8.1-M)</li>
207 <li>GNU: GNU Arm Embedded Toolchain 10-2020-q4-major (10.2.1 20201103)</li>
208 <li>IAR: IAR ANSI C/C++ Compiler for Arm 8.20.1.14183 </li>
209 </ul>
210 </div></div><!-- PageDoc -->
211 </div><!-- contents -->
212 </div><!-- doc-content -->
213 <!-- start footer part -->
214 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
215   <ul>
216     <li class="footer">
217       <script type="text/javascript">
218         <!--
219         writeFooter.call(this);
220         //-->
221       </script> 
222     </li>
223   </ul>
224 </div>
225 </body>
226 </html>