begriffs open source - cmsis/blob - main/Core_A/templates_pg.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): CMSIS-Core Device Templates</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 <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('templates_pg.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">CMSIS-Core Device Templates </div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133 <div class="textblock"><p><a class="anchor" id="md_src_template"></a> Arm supplies CMSIS-Core device template files for the all supported Cortex-A processors and various compiler vendors. Refer to the list of <a class="el" href="index.html#tested_tools_sec">Tested and Verified Toolchains</a> for compliance.</p>
 134 <p>These CMSIS-Core device template files include the following:</p><ul>
 135 <li>Register names of the Core Peripherals and names of the Core Exception Vectors.</li>
 136 <li>Functions to access core peripherals, cache, MMU and special CPU instructions</li>
 137 <li>Generic startup code and system configuration code.</li>
 138 </ul>
 139 <h1><a class="anchor" id="CMSIS_Processor_files"></a>
 140 CMSIS-Core Processor Files</h1>
 141 <p>The CMSIS-Core processor files provided by Arm are in the directory .\CMSIS\Core\Include. These header files define all processor specific attributes do not need any modifications.</p>
 142 <p>The <code>core_&lt;cpu&gt;.h</code> defines the core peripherals and provides helper functions that access the core registers.</p>
 143 <table class="markdownTable">
 144 <tr class="markdownTableHead">
 145 <th class="markdownTableHeadLeft">Header File   </th><th class="markdownTableHeadLeft">Target Processor Core    </th></tr>
 146 <tr class="markdownTableRowOdd">
 147 <td class="markdownTableBodyLeft">📂 CMSIS/Core/Include   </td><td class="markdownTableBodyLeft">CMSIS-Core include folder (<a href="https://github.com/ARM-software/CMSIS_6/tree/main/CMSIS/Core/Include/">See on GitHub</a>)    </td></tr>
 148 <tr class="markdownTableRowEven">
 149 <td class="markdownTableBodyLeft">┗ 📄 <a class="el" href="core__ca_8h.html">core_ca.h</a>   </td><td class="markdownTableBodyLeft">Generics for all supported Cortex-A processors   </td></tr>
 150 </table>
 151 <h1><a class="anchor" id="device_examples"></a>
 152 Device Examples</h1>
 153 <p>The <a href="https://github.com/ARM-software/Cortex_DFP">Cortex_DFP pack</a> provides generic device definitions for supported Arm Cortex-A cores and contains corresponding CMSIS-Core device files.</p>
 154 <h1><a class="anchor" id="template_files_sec"></a>
 155 Template Files</h1>
 156 <p>To simplify the creation of CMSIS-Core device files, the following template files are provided that should be extended by the silicon vendor to reflect the actual device and device peripherals. Silicon vendors add to these template files the following information:</p><ul>
 157 <li><b>Device Peripheral Access Layer</b> that provides definitions for device-specific peripherals.</li>
 158 <li><b>Access Functions for Peripherals</b> (optional) that provides additional helper functions to access device-specific peripherals.</li>
 159 <li><b>Interrupt vectors</b> in the startup file that are device specific.</li>
 160 </ul>
 161 <table class="markdownTable">
 162 <tr class="markdownTableHead">
 163 <th class="markdownTableHeadLeft">Template File   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 164 <tr class="markdownTableRowOdd">
 165 <td class="markdownTableBodyLeft">📂 CMSIS/Core/Template/Device_A   </td><td class="markdownTableBodyLeft">Folder with CMSIS-Core device file templates (<a href="https://github.com/ARM-software/CMSIS_6/tree/main/CMSIS/Core/Template/Device_A/">See on GitHub</a>)    </td></tr>
 166 <tr class="markdownTableRowEven">
 167 <td class="markdownTableBodyLeft">┣ 📂 Config   </td><td class="markdownTableBodyLeft">Template configuration files    </td></tr>
 168 <tr class="markdownTableRowOdd">
 169 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 Device_ac6.sct   </td><td class="markdownTableBodyLeft">Linker scatter file template for Arm C/C++ Compiler    </td></tr>
 170 <tr class="markdownTableRowEven">
 171 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📄 mem_Device.h   </td><td class="markdownTableBodyLeft"><a class="el" href="mem_h_pg.html">Memory Configuration Files mem_&lt;device&gt;.h</a> template    </td></tr>
 172 <tr class="markdownTableRowOdd">
 173 <td class="markdownTableBodyLeft">┣ 📂 Include   </td><td class="markdownTableBodyLeft">Template header files    </td></tr>
 174 <tr class="markdownTableRowEven">
 175 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 Device.h   </td><td class="markdownTableBodyLeft"><a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a> template    </td></tr>
 176 <tr class="markdownTableRowOdd">
 177 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📄 system_Device.h   </td><td class="markdownTableBodyLeft"><a class="el" href="system_c_pg.html#system_Device_h_sec">system_Device.h Template File</a>    </td></tr>
 178 <tr class="markdownTableRowEven">
 179 <td class="markdownTableBodyLeft">┗ 📂 Source   </td><td class="markdownTableBodyLeft">Template C files    </td></tr>
 180 <tr class="markdownTableRowOdd">
 181 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 mmu_Device.c   </td><td class="markdownTableBodyLeft"><a class="el" href="mmu_c_pg.html">Memory Management Unit Files mmu_&lt;device&gt;.c</a> template    </td></tr>
 182 <tr class="markdownTableRowEven">
 183 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 startup_Device.c   </td><td class="markdownTableBodyLeft"><a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a> template    </td></tr>
 184 <tr class="markdownTableRowOdd">
 185 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📄 system_Device.c   </td><td class="markdownTableBodyLeft"><a class="el" href="system_c_pg.html#system_Device_sec">system_Device.c Template File</a>   </td></tr>
 186 </table>
 187 <p><b>Adapt Template Files to a Device</b></p>
 188 <p>The following steps describe how to adopt the template files to a specific device or device family. Copy the complete all files in the template directory and replace:</p><ul>
 189 <li>directory name 'Vendor' with the abbreviation for the device vendor e.g.: NXP.</li>
 190 <li>directory name 'Device' with the specific device name e.g.: LPC17xx.</li>
 191 <li>in the file names 'Device' with the specific device name e.g.: LPC17xx.</li>
 192 </ul>
 193 <p>Each template file contains comments that start with <b>ToDo:</b> that describe a required modification. The template files contain place holders:</p>
 194 <table class="markdownTable">
 195 <tr class="markdownTableHead">
 196 <th class="markdownTableHeadLeft">Placeholder   </th><th class="markdownTableHeadLeft">To be replaced with    </th></tr>
 197 <tr class="markdownTableRowOdd">
 198 <td class="markdownTableBodyLeft"><code>&lt;Device&gt;</code>   </td><td class="markdownTableBodyLeft">The specific device name or device family name, for example <code>LPC17xx</code>    </td></tr>
 199 <tr class="markdownTableRowEven">
 200 <td class="markdownTableBodyLeft"><code>&lt;DeviceInterrupt&gt;</code>   </td><td class="markdownTableBodyLeft">The specific interrupt name of the device, for example <code>TIM1</code> for Timer 1 interrupt    </td></tr>
 201 <tr class="markdownTableRowOdd">
 202 <td class="markdownTableBodyLeft"><code>&lt;DeviceAbbreviation&gt;</code>   </td><td class="markdownTableBodyLeft">Short name or abbreviation of the device family, for example <code>LPC</code>    </td></tr>
 203 <tr class="markdownTableRowEven">
 204 <td class="markdownTableBodyLeft"><code>Cortex-A#</code>   </td><td class="markdownTableBodyLeft">The specific Cortex-A processor name, for example <code>Cortex-A9</code>   </td></tr>
 205 </table>
 206 <p>The device configuration of the template files is described in detail on the following pages:</p><ul>
 207 <li><a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a></li>
 208 <li><a class="el" href="system_c_pg.html">System Configuration Files system_&lt;Device&gt;.c and system_&lt;Device&gt;.h</a></li>
 209 <li><a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a></li>
 210 <li><a class="el" href="mem_h_pg.html">Memory Configuration Files mem_&lt;device&gt;.h</a></li>
 211 <li><a class="el" href="mmu_c_pg.html">Memory Management Unit Files mmu_&lt;device&gt;.c</a> </li>
 212 </ul>
 213 </div></div><!-- contents -->
 214 </div><!-- PageDoc -->
 215 </div><!-- doc-content -->
 216 <!-- start footer part -->
 217 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 218   <ul>
 219     <li class="footer">
 220       <script type="text/javascript">
 221         <!--
 222         writeFooter.call(this);
 223         //-->
 224       </script>
 225     </li>
 226   </ul>
 227 </div>
 228 </body>
 229 </html>