begriffs open source - cmsis/blob - dev/v6.0.0-dev53/Core/html/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 <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);
  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('cmsis_device_files.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 Files </div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133 <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>
 134 <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>
 135 <li>Simplified device support for vendors with fast scaling for device families and variants on all Arm Cortex-M cores.</li>
 136 <li>Uniform workflows and experience for application developers.</li>
 137 </ul>
 138 <p>Following CMSIS-Core Device Files are defined:</p><ul>
 139 <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>
 140 <li><a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a></li>
 141 <li><a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a></li>
 142 <li><a class="el" href="linker_sct_pg.html">Scatter-Loading description file &lt;device&gt;_ac6.sct</a> </li>
 143 <li><a class="el" href="partition_h_pg.html">TrustZone setup: partition_&lt;Device&gt;.h</a></li>
 144 <li><a class="el" href="partition_h_pg.html#partition_gen_h_pg">Region/ISR setup: partition_gen.h</a> </li>
 145 </ul>
 146 <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>
 147 <h1><a class="anchor" id="cmsis_template_files"></a>
 148 Device Template Files</h1>
 149 <p>CMSIS-Core includes the template files that simplify the creation of CMSIS-Core Device Files for a specific device variant.</p>
 150 <p>Silicon vendors typically need to add to these template files the following information:</p><ul>
 151 <li><b>Device Peripheral Access Layer</b> that provides definitions for device-specific peripherals.</li>
 152 <li><b>Access Functions for Peripherals</b> (optional) that provides additional helper functions to access device-specific peripherals.</li>
 153 <li><b>Interrupt vectors</b> in the startup file that are device specific.</li>
 154 </ul>
 155 <table class="markdownTable">
 156 <tr class="markdownTableHead">
 157 <th class="markdownTableHeadLeft">Template File   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 158 <tr class="markdownTableRowOdd">
 159 <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>
 160 <tr class="markdownTableRowEven">
 161 <td class="markdownTableBodyLeft">┣ 📂 Config   </td><td class="markdownTableBodyLeft">Template configuration files    </td></tr>
 162 <tr class="markdownTableRowOdd">
 163 <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>
 164 <tr class="markdownTableRowEven">
 165 <td class="markdownTableBodyLeft">&emsp;&#160; ┣ 📄 Device_gcc.ld   </td><td class="markdownTableBodyLeft">Linker description file for GNU GCC Arm Embedded Compiler    </td></tr>
 166 <tr class="markdownTableRowOdd">
 167 <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>
 168 <tr class="markdownTableRowEven">
 169 <td class="markdownTableBodyLeft">┣ 📂 Include   </td><td class="markdownTableBodyLeft">Template header files    </td></tr>
 170 <tr class="markdownTableRowOdd">
 171 <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>
 172 <tr class="markdownTableRowEven">
 173 <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>
 174 <tr class="markdownTableRowOdd">
 175 <td class="markdownTableBodyLeft">┗ 📂 Source   </td><td class="markdownTableBodyLeft">Template C files    </td></tr>
 176 <tr class="markdownTableRowEven">
 177 <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>
 178 <tr class="markdownTableRowOdd">
 179 <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>
 180 </table>
 181 <p><b>Adapt Template Files to a Device</b></p>
 182 <p>Each template file contains comments that start with <b>ToDo:</b> and describe required modifications.</p>
 183 <p>The templates contain several placeholders that need to be replaced when creating CMSIS-Core device files:</p>
 184 <table class="markdownTable">
 185 <tr class="markdownTableHead">
 186 <th class="markdownTableHeadLeft">Placeholder   </th><th class="markdownTableHeadLeft">To be replaced with    </th></tr>
 187 <tr class="markdownTableRowOdd">
 188 <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>
 189 <tr class="markdownTableRowEven">
 190 <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>
 191 <tr class="markdownTableRowOdd">
 192 <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>
 193 <tr class="markdownTableRowEven">
 194 <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>
 195 </table>
 196 <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>
 197 </div></div><!-- contents -->
 198 </div><!-- PageDoc -->
 199 </div><!-- doc-content -->
 200 <!-- start footer part -->
 201 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 202   <ul>
 203     <li class="footer">
 204       <script type="text/javascript">
 205         <!--
 206         writeFooter.call(this);
 207         //-->
 208       </script>
 209     </li>
 210   </ul>
 211 </div>
 212 </body>
 213 </html>