]> begriffs open source - cmsis/blob - v6.0.0/Core_A/index.html
Update documentation for branch main
[cmsis] / v6.0.0 / Core_A / 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-A): Overview</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('index.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><div class="header">
127   <div class="headertitle"><div class="title">Overview </div></div>
128 </div><!--header-->
129 <div class="contents">
130 <div class="textblock"><p><a class="anchor" id="mainpage"></a> The <b>CMSIS-Core (Cortex-A)</b> component implements the basic run-time system for a Cortex-A device and gives the user access to the processor core and the device peripherals. In detail it defines:</p>
131 <ul>
132 <li><b>Hardware Abstraction Layer (HAL)</b> for Cortex-A processor registers with standardized definitions for the GIC, FPU, MMU, Cache, and core access functions.</li>
133 <li><b>System exception names</b> to interface to system exceptions without having compatibility issues.</li>
134 <li><b>Methods to organize header files</b> that makes it easy to learn new Cortex-A microcontroller products and improve software portability. This includes naming conventions for device-specific interrupts.</li>
135 <li><b>Methods for system initialization</b> to be used by each MCU vendor. For example, the standardized <a class="el" href="group__system__init__gr.html#ga93f514700ccf00d08dbdcff7f1224eb2" title="Function to Initialize the system.">SystemInit()</a> function is essential for configuring the clock system of the device.</li>
136 <li><b>Intrinsic functions</b> used to generate CPU instructions that are not supported by standard C functions.</li>
137 <li>A variable to determine the <b>system clock frequency</b> which simplifies the setup of the system timers.</li>
138 </ul>
139 <p>The following sections provide details about the CMSIS-Core (Cortex-A):</p>
140 <ul>
141 <li><a class="el" href="using_pg.html">Using CMSIS in Embedded Applications</a> describes the project setup and shows a simple program example.</li>
142 <li><a class="el" href="templates_pg.html">CMSIS-Core Device Templates</a> describes the files of the CMSIS-Core (Cortex-A) in detail and explains how to adapt template files provided by Arm to silicon vendor devices.</li>
143 <li><a class="el" href="coreMISRA_Exceptions_pg.html">MISRA-C Deviations</a> describes the violations to the MISRA standard.</li>
144 <li><a href="modules.html"><b>API Reference</b></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>
145 <li><a href="annotated.html"><b>Data Structures</b></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>
146 </ul>
147 <h1><a class="anchor" id="autotoc_md0"></a>
148 Access to CMSIS-Core (Cortex-A)</h1>
149 <p>CMSIS-Core is actively maintained in the <a href="https://github.com/ARM-software/CMSIS_6"><b>CMSIS 6 GitHub repository</b></a> and released as part of the <a href="../General/cmsis_pack.html"><b>CMSIS Software Pack</b></a>.</p>
150 <p>The following directories and files relevant to CMSIS-Core (Cortex-A) are present in the <b>ARM::CMSIS</b> Pack:</p>
151 <table class="markdownTable">
152 <tr class="markdownTableHead">
153 <th class="markdownTableHeadLeft">Directory   </th><th class="markdownTableHeadLeft">Content    </th></tr>
154 <tr class="markdownTableRowOdd">
155 <td class="markdownTableBodyLeft">📂 CMSIS   </td><td class="markdownTableBodyLeft">CMSIS Base software components folder    </td></tr>
156 <tr class="markdownTableRowEven">
157 <td class="markdownTableBodyLeft">┣ ðŸ“‚ Documentation/html/Core_A   </td><td class="markdownTableBodyLeft">A local copy of this CMSIS-Core (A) documentation    </td></tr>
158 <tr class="markdownTableRowOdd">
159 <td class="markdownTableBodyLeft">â”— ðŸ“‚ Core   </td><td class="markdownTableBodyLeft">CMSIS-Core files    </td></tr>
160 <tr class="markdownTableRowEven">
161 <td class="markdownTableBodyLeft">&emsp;&#160; â”£ ðŸ“‚ Include   </td><td class="markdownTableBodyLeft"><a class="el" href="templates_pg.html#CMSIS_Processor_files">CMSIS-Core Processor Files</a>.    </td></tr>
162 <tr class="markdownTableRowOdd">
163 <td class="markdownTableBodyLeft">&emsp;&emsp;&#160; â”— ðŸ“‚ a-profile   </td><td class="markdownTableBodyLeft">Header files specific for Arm A-Profile.    </td></tr>
164 <tr class="markdownTableRowEven">
165 <td class="markdownTableBodyLeft">&emsp;&#160; â”— ðŸ“‚ Template   </td><td class="markdownTableBodyLeft"><a class="el" href="templates_pg.html#template_files_sec">Template Files</a>   </td></tr>
166 </table>
167 <h1><a class="anchor" id="ref_v7A"></a>
168 Processor Support</h1>
169 <p>CMSIS supports a selected subset of <a href="https://www.arm.com/products/silicon-ip-cpu?families=cortex-m&amp;showall=true">Cortex-A processors</a>.</p>
170 <p><a class="anchor" id="ref_man_ca_sec"></a><b>Cortex-A Technical Reference Manuals</b></p>
171 <p>The following Technical Reference Manuals describe the various Arm Cortex-A processors:</p>
172 <ul>
173 <li><a href="https://developer.arm.com/documentation/ddi0433">Cortex-A5</a> (Armv7-A architecture)</li>
174 <li><a href="https://developer.arm.com/documentation/ddi0464">Cortex-A7</a> (Armv7-A architecture)</li>
175 <li><a href="https://developer.arm.com/documentation/100511">Cortex-A9</a> (Armv7-A architecture)</li>
176 </ul>
177 <h1><a class="anchor" id="tested_tools_sec"></a>
178 Tested and Verified Toolchains</h1>
179 <p>The <a class="el" href="templates_pg.html">CMSIS-Core Device Templates</a> delivered with this CMSIS-Core release have been tested and verified with the following toolchains:</p>
180 <ul>
181 <li>Arm Compiler for Embedded 6.20</li>
182 <li>IAR C/C++ Compiler for Arm 9.40</li>
183 <li>GNU Arm Embedded Toolchain 13.2.1</li>
184 <li>LLVM/Clang 17.0.1 </li>
185 </ul>
186 </div></div><!-- PageDoc -->
187 </div><!-- contents -->
188 </div><!-- doc-content -->
189 <!-- start footer part -->
190 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
191   <ul>
192     <li class="footer">
193       <script type="text/javascript">
194         <!--
195         writeFooter.call(this);
196         //-->
197       </script> 
198     </li>
199   </ul>
200 </div>
201 </body>
202 </html>