begriffs open source - cmsis/blob - main/Toolbox/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-Toolbox: CMSIS-Toolbox</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-Toolbox
  44    </div>
  45    <div id="projectbrief">Command line tools for project build with packs</div>
  46   </td>
  47    <td>        <div id="MSearchBox" class="MSearchBoxInactive">
  48         <span class="left">
  49           <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
  50           <input type="text" id="MSearchField" value="" placeholder="Search" accesskey="S"
  51                onfocus="searchBox.OnSearchFieldFocus(true)"
  52                onblur="searchBox.OnSearchFieldFocus(false)"
  53                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  54           </span><span class="right">
  55             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
  56           </span>
  57         </div>
  58 </td>
  59   <!--END !PROJECT_NAME-->
  60  </tr>
  61  </tbody>
  62 </table>
  63 </div>
  64 <!-- end header part -->
  65 <div id="CMSISnav" class="tabs1">
  66   <ul class="tablist">
  67     <script type="text/javascript">
  68       writeComponentTabs.call(this);
  69     </script>
  70   </ul>
  71 </div>
  72 <script type="text/javascript">
  73   writeSubComponentTabs.call(this);
  74 </script>
  75 <!-- Generated by Doxygen 1.9.6 -->
  76 <script type="text/javascript">
  77 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  78 var searchBox = new SearchBox("searchBox", "search/",'.html');
  79 /* @license-end */
  80 </script>
  81 </div><!-- top -->
  82 <div id="side-nav" class="ui-resizable side-nav-resizable">
  83   <div id="nav-tree">
  84     <div id="nav-tree-contents">
  85       <div id="nav-sync" class="sync"></div>
  86     </div>
  87   </div>
  88   <div id="splitbar" style="-moz-user-select:none;"
  89        class="ui-resizable-handle">
  90   </div>
  91 </div>
  92 <script type="text/javascript">
  93 /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
  94 $(document).ready(function(){initNavTree('index.html',''); initResizable(); });
  95 /* @license-end */
  96 </script>
  97 <div id="doc-content">
  98 <!-- window showing the filter options -->
  99 <div id="MSearchSelectWindow"
 100      onmouseover="return searchBox.OnSearchSelectShow()"
 101      onmouseout="return searchBox.OnSearchSelectHide()"
 102      onkeydown="return searchBox.OnSearchSelectKey(event)">
 103 </div>
 104
 105 <!-- iframe showing the search results (closed by default) -->
 106 <div id="MSearchResultsWindow">
 107 <div id="MSearchResults">
 108 <div class="SRPage">
 109 <div id="SRIndex">
 110 <div id="SRResults"></div>
 111 <div class="SRStatus" id="Loading">Loading...</div>
 112 <div class="SRStatus" id="Searching">Searching...</div>
 113 <div class="SRStatus" id="NoMatches">No Matches</div>
 114 </div>
 115 </div>
 116 </div>
 117 </div>
 118
 119 <div><div class="header">
 120   <div class="headertitle"><div class="title">CMSIS-Toolbox </div></div>
 121 </div><!--header-->
 122 <div class="contents">
 123 <div class="textblock"><p><a class="anchor" id="mainpage"></a> The <b>CMSIS-Toolbox</b> provides command-line tools for:</p>
 124 <ul>
 125 <li>Project creation and build of embedded applications utilizing <a href="https://www.keil.arm.com/packs/">Software Packs</a> with support for multiple compilation tools.</li>
 126 <li>Software Pack creation, maintenance, and distribution utilizing the <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">CMSIS-Pack format</a>.</li>
 127 </ul>
 128 <h1><a class="anchor" id="autotoc_md0"></a>
 129 Access to CMSIS-Toolbox</h1>
 130 <p>CMSIS-Toolbox is actively maintained in a dedicated GitHub repository and released as a set of binary utilities.</p>
 131 <ul>
 132 <li><a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox"><b>CMSIS-Toolbox GitHub Repo</b></a> - contains the source code and releases.</li>
 133 <li><a href="https://github.com/Open-CMSIS-Pack/cmsis-toolbox/blob/main/docs/README.md"><b>CMSIS-Toolbox User Guide</b></a> - provides user documentation for the CMSIS-Toolbox.</li>
 134 </ul>
 135 <h1><a class="anchor" id="autotoc_md1"></a>
 136 Benefits</h1>
 137 <ul>
 138 <li>Flexible CLI tools that can be used stand-alone or integrated into <a href="https://marketplace.visualstudio.com/items?itemName=Arm.keil-studio-pack">VS Code</a> or DevOps systems for Continuous Integration (CI).</li>
 139 <li>Stand-alone tools that are available for all host platforms (Windows, Mac, Linux) and flexible deployable.</li>
 140 <li><a href="https://www.keil.arm.com/packs/">Software Packs</a> simplify tool setup with <code>device:</code> or <code>board:</code> selection and project creation with access to reusable software components.</li>
 141 <li>Organize solutions with projects that are independently managed simplifies a wide range of use cases including multi-processor applications or unit testing.</li>
 142 <li>Provisions for product lifecycle management (PLM) with versioned software packs that are easy to update and management for configuration files.</li>
 143 <li>Software layers enable code reuse across similar applications with a pre-configured set of source files and software components.</li>
 144 <li>Multiple hardware targets allow application deployment to different hardware (test board, production hardware, virtual hardware, etc.).</li>
 145 <li>Multiple build types support software testing and verification (debug build, test build, release build, ect.).</li>
 146 </ul>
 147 <h1><a class="anchor" id="autotoc_md2"></a>
 148 Project Creation</h1>
 149 <p>The following tools support the creation of build information for embedded applications:</p>
 150 <table class="markdownTable">
 151 <tr class="markdownTableHead">
 152 <th class="markdownTableHeadLeft">Tool   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 153 <tr class="markdownTableRowOdd">
 154 <td class="markdownTableBodyLeft"><b>cpackget</b>   </td><td class="markdownTableBodyLeft"><b>Pack Manager:</b> install and manage software packs in the development environment.    </td></tr>
 155 <tr class="markdownTableRowEven">
 156 <td class="markdownTableBodyLeft"><b>csolution</b>   </td><td class="markdownTableBodyLeft"><b>Project Manager:</b> create build information for embedded applications that consist of one or more related projects.    </td></tr>
 157 <tr class="markdownTableRowOdd">
 158 <td class="markdownTableBodyLeft"><b>cbuild</b>   </td><td class="markdownTableBodyLeft"><b>Build Invocation:</b> orchestrate the build steps utilizing CMSIS tools and a CMake compilation process.   </td></tr>
 159 </table>
 160 <p>The build information is defined with <b>User Input Files</b> in YAML format. It starts with a <code>*.csolution.yml</code> file that refers related, but independent projects defined with <code>*.cproject.yml</code> files. A <code>*.cproject.yml</code> may refer one or more <code>*.clayer.yml</code> files that define re-usable project parts that may be shared across projects.</p>
 161 <p>The build information can refer to <b>Software Packs</b> that define Device and Board information and provide access to re-usable software components such as drivers and middleware. A <code>cdefault.yml</code> file provides a common setup for various compilers and generic translation controls enable compiler agonistic projects; compiler toolchain specific controls may be used when required.</p>
 162 <p>The <b>Output Files</b> contain detailed build information and manage the configuration files for software components.</p>
 163 <p>The diagram below provides an overview of the <b>build information</b> used by the CMSIS-Toolbox.</p>
 164 <div class="image">
 165 <img src="csolution-overview.png" alt=""/>
 166 <div class="caption">
 167 Overview of Project Definition</div></div>
 168     <h1><a class="anchor" id="autotoc_md3"></a>
 169 Software Pack Creation</h1>
 170 <p>The following tools support the creation of Software Packs in <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/index.html">CMSIS-Pack format</a>:</p>
 171 <table class="markdownTable">
 172 <tr class="markdownTableHead">
 173 <th class="markdownTableHeadLeft">Tool   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 174 <tr class="markdownTableRowOdd">
 175 <td class="markdownTableBodyLeft"><b>packchk</b>   </td><td class="markdownTableBodyLeft"><b>Pack Validation:</b> installs and manages software packs in the local development environment.    </td></tr>
 176 <tr class="markdownTableRowEven">
 177 <td class="markdownTableBodyLeft"><b>svdconv</b>   </td><td class="markdownTableBodyLeft"><b>SVD Check / Convert:</b> validate and/or convert System View Description (SVD) files.   </td></tr>
 178 </table>
 179 <p>In addition several scripts are provided that simplify pack creation with desktop or cloud workflows. This is described in several hands-on tutorials:</p>
 180 <table class="markdownTable">
 181 <tr class="markdownTableHead">
 182 <th class="markdownTableHeadLeft">Hands-on Tutorial   </th><th class="markdownTableHeadLeft">Description    </th></tr>
 183 <tr class="markdownTableRowOdd">
 184 <td class="markdownTableBodyLeft"><a href="https://github.com/Open-CMSIS-Pack/SW-Pack-HandsOn"><b>SW-Pack-HandsOn</b></a>   </td><td class="markdownTableBodyLeft">Explains the steps to create a simple software pack using the Open-CMSIS-Pack technology.    </td></tr>
 185 <tr class="markdownTableRowEven">
 186 <td class="markdownTableBodyLeft"><a href="https://github.com/Open-CMSIS-Pack/DFP-Pack-HandsOn"><b>DFP-Pack-HandsOn</b></a>   </td><td class="markdownTableBodyLeft">Explains the structure and creation of a Device Family Pack (DFP).    </td></tr>
 187 <tr class="markdownTableRowOdd">
 188 <td class="markdownTableBodyLeft"><a href="https://github.com/Open-CMSIS-Pack/DFP-Pack-HandsOn"><b>BSP-Pack-HandsOn</b></a>   </td><td class="markdownTableBodyLeft">Explains the structure and creation of a Board Support Pack (BSP).   </td></tr>
 189 </table>
 190 </div></div><!-- PageDoc -->
 191 </div><!-- contents -->
 192 </div><!-- doc-content -->
 193 <!-- start footer part -->
 194 <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
 195   <ul>
 196     <li class="footer">
 197       <script type="text/javascript">
 198         <!--
 199         writeFooter.call(this);
 200         //-->
 201       </script>
 202     </li>
 203   </ul>
 204 </div>
 205 </body>
 206 </html>