begriffs open source - cmsis/blob - main/Core/cmsis_device_files.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): CMSIS-Core Device Files</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-M)
  44    &#160;<span id="projectnumber"><script type="text/javascript">
  45      <!--
  46      writeHeader.call(this);
  47      writeVersionDropdown.call(this, "CMSIS-Core (Cortex-M)");
  48      //-->
  49     </script>
  50    </span>
  51    </div>
  52    <div id="projectbrief">CMSIS-Core support for Cortex-M 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('cmsis_device_files.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">CMSIS-Core Device Files </div></div>
 128 </div><!--header-->
 129 <div class="contents">
 130 <div class="textblock"><p><a class="anchor" id="md_src_core_device_files"></a> The <b>CMSIS-Core Device Files</b> implement CMSIS-Core support for a specific microcontroller device or family of devices. These files are typically provided by the device vendor and use <a class="el" href="cmsis_core_files.html#cmsis_standard_files">CMSIS-Core Standard Files</a> via #include directives.</p>
 131 <p>CMSIS-Core specifies the organization of CMSIS-Core Device Files, defines their functionalities, and provides unified naming conventions. This brings following benefits:</p><ul>
 132 <li>Simplified device support for vendors with fast scaling for device families and variants on all Arm Cortex-M cores.</li>
 133 <li>Uniform workflows and experience for application developers.</li>
 134 </ul>
 135 <p>Following CMSIS-Core Device Files are defined:</p><ul>
 136 <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>
 137 <li><a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a></li>
 138 <li><a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a></li>
 139 <li><a class="el" href="linker_sct_pg.html">Scatter-Loading description file &lt;device&gt;_ac6.sct</a> </li>
 140 <li><a class="el" href="partition_h_pg.html">TrustZone setup: partition_&lt;Device&gt;.h</a></li>
 141 <li><a class="el" href="partition_h_pg.html#partition_gen_h_pg">Region/ISR setup: partition_gen.h</a> </li>
 142 </ul>
 143 <p><a class="el" href="cmsis_files_dfps.html">Delivery in CMSIS-Packs</a> explains how to distribute <a class="el" href="cmsis_device_files.html">CMSIS-Core Device Files</a> in CMSIS-Pack format.</p>
 144 <h1><a class="anchor" id="cmsis_template_files"></a>
 145 Device Template Files</h1>
 146 <p>CMSIS-Core includes the template files that simplify the creation of CMSIS-Core Device Files for a specific device variant.</p>
 147 <p>Silicon vendors typically need to add to these template files the following information:</p><ul>
 148 <li><b>Device Peripheral Access Layer</b> that provides definitions for device-specific peripherals.</li>
 149 <li><b>Access Functions for Peripherals</b> (optional) that provides additional helper functions to access device-specific peripherals.</li>
 150 <li><b>Interrupt vectors</b> in the startup file that are device specific.</li>
 151 </ul>
 152 <table class="markdownTable">
 153 <tr class="markdownTableHead">
 154 <th class="markdownTableHeadLeft">Template File   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 155 <tr class="markdownTableRowOdd">
 156 <td class="markdownTableBodyLeft">📂 CMSIS/Core/Template/Device_M   </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_M/">See on GitHub</a>)    </td></tr>
 157 <tr class="markdownTableRowEven">
 158 <td class="markdownTableBodyLeft">┣ 📂 Config   </td><td class="markdownTableBodyLeft">Template configuration files    </td></tr>
 159 <tr class="markdownTableRowOdd">
 160 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 Device_ac6.sct   </td><td class="markdownTableBodyLeft"><a class="el" href="linker_sct_pg.html">Scatter-Loading description file &lt;device&gt;_ac6.sct</a> template    </td></tr>
 161 <tr class="markdownTableRowEven">
 162 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 Device_gcc.ld   </td><td class="markdownTableBodyLeft">Linker description file for GNU GCC Arm Embedded Compiler    </td></tr>
 163 <tr class="markdownTableRowOdd">
 164 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📄 partition_Device.h   </td><td class="markdownTableBodyLeft"><a class="el" href="partition_h_pg.html">TrustZone setup: partition_&lt;Device&gt;.h</a> template    </td></tr>
 165 <tr class="markdownTableRowEven">
 166 <td class="markdownTableBodyLeft">┣ 📂 Include   </td><td class="markdownTableBodyLeft">Template header files    </td></tr>
 167 <tr class="markdownTableRowOdd">
 168 <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>
 169 <tr class="markdownTableRowEven">
 170 <td class="markdownTableBodyLeft">&emsp;&#160; ┗ 📄 system_Device.h   </td><td class="markdownTableBodyLeft"><a class="el" href="system_c_pg.html#system_Device_sec">system_Device Template Files</a>    </td></tr>
 171 <tr class="markdownTableRowOdd">
 172 <td class="markdownTableBodyLeft">┗ 📂 Source   </td><td class="markdownTableBodyLeft">Template C files    </td></tr>
 173 <tr class="markdownTableRowEven">
 174 <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>
 175 <tr class="markdownTableRowOdd">
 176 <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 Template Files</a>   </td></tr>
 177 </table>
 178 <p><b>Adapt Template Files to a Device</b></p>
 179 <p>Each template file contains comments that start with <b>ToDo:</b> and describe required modifications.</p>
 180 <p>The templates contain several placeholders that need to be replaced when creating CMSIS-Core device files:</p>
 181 <table class="markdownTable">
 182 <tr class="markdownTableHead">
 183 <th class="markdownTableHeadLeft">Placeholder   </th><th class="markdownTableHeadLeft">To be replaced with    </th></tr>
 184 <tr class="markdownTableRowOdd">
 185 <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>
 186 <tr class="markdownTableRowEven">
 187 <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>
 188 <tr class="markdownTableRowOdd">
 189 <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>
 190 <tr class="markdownTableRowEven">
 191 <td class="markdownTableBodyLeft"><code>Cortex-M#</code>   </td><td class="markdownTableBodyLeft">The specific Cortex-M processor name, for example <code>Cortex-M3</code>   </td></tr>
 192 </table>
 193 <p>Device files for the <a class="el" href="cmsis_files_dfps.html#device_examples">Device Examples</a> can be also a good reference point for implementing CMSIS-Core support for specific devices. </p>
 194 </div></div><!-- contents -->
 195 </div><!-- PageDoc -->
 196 </div><!-- doc-content -->
 197 <!-- start footer part -->
 198 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 199   <ul>
 200     <li class="footer">
 201       <script type="text/javascript">
 202         <!--
 203         writeFooter.call(this);
 204         //-->
 205       </script>
 206     </li>
 207   </ul>
 208 </div>
 209 </body>
 210 </html>