begriffs open source - cmsis/blob - main/Core/html/cmsis_files_dfps.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): Delivery in CMSIS-Packs</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_files_dfps.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">Delivery in CMSIS-Packs </div></div>
 131 </div><!--header-->
 132 <div class="contents">
 133 <div class="textblock"><p><a class="anchor" id="md_src_core_files_in_packs"></a> In simple individual cases the <a class="el" href="cmsis_core_files.html">CMSIS-Core Files</a> can be delivered to developers as part of example projects and SDKs. But the most scalable approach with improved usability is to provide them packaged in <a href="https://www.open-cmsis-pack.org">Open-CMSIS-Pack format</a>, and this page explains how to do this.</p>
 134 <p>The <a class="el" href="cmsis_core_files.html#cmsis_standard_files">CMSIS-Core Standard Files</a> are provided as part of <a href="../../General/html/cmsis_pack.html">CMSIS Software pack</a> under <b>CMSIS</b> class of components and compose there the <b>CORE</b> group.</p>
 135 <p>The <a class="el" href="cmsis_device_files.html">CMSIS-Core Device Files</a> are delivered in <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/cp_PackTutorial.html#createPack_DFP">CMSIS Device Family Packs (DFPs)</a> that provide necessary mechanisms for device support in embedded software. The DFPs are typically maintained by device vendors.</p>
 136 <p>Since <a class="el" href="device_h_pg.html">Device Header File &lt;Device.h&gt;</a> does not need to be modified in the project, it can be made accessible with its include path.</p>
 137 <p>For uniform experience, the files <a class="el" href="startup_c_pg.html">Startup File startup_&lt;Device&gt;.c</a> and <a class="el" href="system_c_pg.html">System Configuration Files system_&lt;Device&gt;.c and system_&lt;Device&gt;.h</a> should be provided in the DFP as part of <b>Device</b> class in the <b>Startup</b> group and defined as configuration files, meaning they are copied from the pack into a project folder and can be modifed there if necessary.</p>
 138 <p>Below is an example of how CMSIS-Core device files can be defined in a .pdsc file of DFP pack, based on the implementation for a generic Cortex-M55 device.</p>
 139 <div class="fragment"><div class="line">&lt;<span class="keywordtype">components</span>&gt;</div>
 140 <div class="line">  <span class="comment">&lt;!-- CMSIS-Startup components --&gt;</span></div>
 141 <div class="line">  </div>
 142 <div class="line">  <span class="comment">&lt;!-- Cortex-M55 --&gt;</span></div>
 143 <div class="line">  &lt;<span class="keywordtype">component</span> <span class="keyword">Cclass</span>=<span class="stringliteral">&quot;Device&quot;</span> <span class="keyword">Cgroup</span>=<span class="stringliteral">&quot;Startup&quot;</span> <span class="keyword">Cvariant</span>=<span class="stringliteral">&quot;C Startup&quot;</span> <span class="keyword">Cversion</span>=<span class="stringliteral">&quot;2.2.0&quot;</span> <span class="keyword">condition</span>=<span class="stringliteral">&quot;ARMCM55 CMSIS&quot;</span> <span class="keyword">isDefaultVariant</span>=<span class="stringliteral">&quot;true&quot;</span>&gt;</div>
 144 <div class="line">    &lt;<span class="keywordtype">description</span>&gt;<span class="keyword">System</span> <span class="keyword">and</span> <span class="keyword">Startup</span> <span class="keyword">for</span> <span class="keyword">Generic</span> <span class="keyword">Cortex-M55</span> <span class="keyword">device</span>&lt;/<span class="keywordtype">description</span>&gt;</div>
 145 <div class="line">    &lt;<span class="keywordtype">files</span>&gt;</div>
 146 <div class="line">      <span class="comment">&lt;!-- include folder / device header file --&gt;</span></div>
 147 <div class="line">      &lt;<span class="keywordtype">file</span> <span class="keyword">category</span>=<span class="stringliteral">&quot;include&quot;</span> <span class="keyword">name</span>=<span class="stringliteral">&quot;Device/ARMCM55/Include/&quot;</span>/&gt;</div>
 148 <div class="line">      <span class="comment">&lt;!-- startup / system file --&gt;</span></div>
 149 <div class="line">      &lt;<span class="keywordtype">file</span> <span class="keyword">category</span>=<span class="stringliteral">&quot;sourceC&quot;</span> <span class="keyword">name</span>=<span class="stringliteral">&quot;Device/ARMCM55/Source/startup_ARMCM55.c&quot;</span>   <span class="keyword">version</span>=<span class="stringliteral">&quot;1.1.0&quot;</span> <span class="keyword">attr</span>=<span class="stringliteral">&quot;config&quot;</span>/&gt;</div>
 150 <div class="line">      &lt;<span class="keywordtype">file</span> <span class="keyword">category</span>=<span class="stringliteral">&quot;sourceC&quot;</span> <span class="keyword">name</span>=<span class="stringliteral">&quot;Device/ARMCM55/Source/system_ARMCM55.c&quot;</span>    <span class="keyword">version</span>=<span class="stringliteral">&quot;1.1.0&quot;</span> <span class="keyword">attr</span>=<span class="stringliteral">&quot;config&quot;</span>/&gt;</div>
 151 <div class="line">      <span class="comment">&lt;!-- SAU configuration --&gt;</span></div>
 152 <div class="line">      &lt;<span class="keywordtype">file</span> <span class="keyword">category</span>=<span class="stringliteral">&quot;header&quot;</span>  <span class="keyword">name</span>=<span class="stringliteral">&quot;Device/ARMCM55/Config/partition_ARMCM55.h&quot;</span> <span class="keyword">version</span>=<span class="stringliteral">&quot;1.0.0&quot;</span> <span class="keyword">attr</span>=<span class="stringliteral">&quot;config&quot;</span> <span class="keyword">condition</span>=<span class="stringliteral">&quot;TZ Secure&quot;</span>/&gt;</div>
 153 <div class="line">    &lt;/<span class="keywordtype">files</span>&gt;</div>
 154 <div class="line">  &lt;/<span class="keywordtype">component</span>&gt;</div>
 155 <div class="line">  </div>
 156 <div class="line">&lt;/<span class="keywordtype">components</span>&gt;</div>
 157 </div><!-- fragment --><p>Since the <a class="el" href="cmsis_device_files.html">CMSIS-Core Device Files</a> require access to implementations from <a class="el" href="cmsis_core_files.html#cmsis_standard_files">CMSIS-Core Standard Files</a>, the Device Family Packs need to specify the dependency on <b>CMSIS:CORE</b> component. In the code above this is done with the <code>condition="ARMCM55 CMSIS"</code> that is defined in the same .psdc file as:</p>
 158 <div class="fragment"><div class="line">&lt;<span class="keywordtype">conditions</span>&gt;</div>
 159 <div class="line">  </div>
 160 <div class="line">  &lt;<span class="keywordtype">condition</span> <span class="keyword">id</span>=<span class="stringliteral">&quot;ARMCM55 CMSIS&quot;</span>&gt;</div>
 161 <div class="line">    &lt;<span class="keywordtype">description</span>&gt;<span class="keyword">Generic</span> <span class="keyword">Arm</span> <span class="keyword">Cortex-M55</span> <span class="keyword">device</span> <span class="keyword">startup</span> <span class="keyword">and</span> <span class="keyword">depends</span> <span class="keyword">on</span> <span class="keyword">CMSIS</span> <span class="keyword">Core</span>&lt;/<span class="keywordtype">description</span>&gt;</div>
 162 <div class="line">    &lt;<span class="keywordtype">require</span> <span class="keyword">Dvendor</span>=<span class="stringliteral">&quot;ARM:82&quot;</span> <span class="keyword">Dname</span>=<span class="stringliteral">&quot;ARMCM55*&quot;</span>/&gt;</div>
 163 <div class="line">    &lt;<span class="keywordtype">require</span> <span class="keyword">Cclass</span>=<span class="stringliteral">&quot;CMSIS&quot;</span> <span class="keyword">Cgroup</span>=<span class="stringliteral">&quot;CORE&quot;</span>/&gt;</div>
 164 <div class="line">  &lt;/<span class="keywordtype">condition</span>&gt;</div>
 165 <div class="line">  </div>
 166 <div class="line">&lt;/<span class="keywordtype">conditions</span>&gt;</div>
 167 </div><!-- fragment --><h1><a class="anchor" id="device_examples"></a>
 168 Device Examples</h1>
 169 <p>The <a href="https://github.com/ARM-software/CMSIS-DFP">CMSIS-DFP pack</a> provides generic device definitions for standard Arm Cortex-M cores and contains corresponding <a class="el" href="cmsis_device_files.html">CMSIS-Core Device Files</a>.</p>
 170 <p>These files can be used as a reference for device support in a DFP pack, but can also be used in projects that require standard Arm processors functionality. See <a class="el" href="using_pg.html#using_arm">Use generic Arm Devices</a>.</p>
 171 <p>Looking at other Device Family Packs can be also helpful to understand the CMSIS-Core support with DFPs. The list of public CMSIS packs (including DFPs) can be found at <a href="https://www.keil.arm.com/packs/">keil.arm.com/packs</a>. </p>
 172 </div></div><!-- contents -->
 173 </div><!-- PageDoc -->
 174 </div><!-- doc-content -->
 175 <!-- start footer part -->
 176 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 177   <ul>
 178     <li class="footer">
 179       <script type="text/javascript">
 180         <!--
 181         writeFooter.call(this);
 182         //-->
 183       </script>
 184     </li>
 185   </ul>
 186 </div>
 187 </body>
 188 </html>