index.html 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>Overview</title>
  7. <title>CMSIS-Build: Overview</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.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="printComponentTabs.js"></script>
  13. <script type="text/javascript" src="cmsis_footer.js"></script>
  14. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  15. <script type="text/javascript" src="resize.js"></script>
  16. <script type="text/javascript" src="navtree.js"></script>
  17. <script type="text/javascript">
  18. $(document).ready(initResizable);
  19. $(window).load(resizeHeight);
  20. </script>
  21. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  22. <script type="text/javascript" src="search/search.js"></script>
  23. <script type="text/javascript">
  24. $(document).ready(function() { searchBox.OnSelectItem(0); });
  25. </script>
  26. </head>
  27. <body>
  28. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  29. <div id="titlearea">
  30. <table cellspacing="0" cellpadding="0">
  31. <tbody>
  32. <tr style="height: 46px;">
  33. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  34. <td style="padding-left: 0.5em;">
  35. <div id="projectname">CMSIS-Build
  36. &#160;<span id="projectnumber">Version 0.10.0 (beta)</span>
  37. </div>
  38. <div id="projectbrief">Tools, software frameworks, and work flows for productivity with CMSIS based projects</div>
  39. </td>
  40. </tr>
  41. </tbody>
  42. </table>
  43. </div>
  44. <!-- end header part -->
  45. <div id="CMSISnav" class="tabs1">
  46. <ul class="tablist">
  47. <script type="text/javascript">
  48. <!--
  49. writeComponentTabs.call(this);
  50. //-->
  51. </script>
  52. </ul>
  53. </div>
  54. <!-- Generated by Doxygen 1.8.6 -->
  55. <script type="text/javascript">
  56. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  57. </script>
  58. <div id="navrow1" class="tabs">
  59. <ul class="tablist">
  60. <li class="current"><a href="index.html"><span>Main&#160;Page</span></a></li>
  61. <li><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  62. <li>
  63. <div id="MSearchBox" class="MSearchBoxInactive">
  64. <span class="left">
  65. <img id="MSearchSelect" src="search/mag_sel.png"
  66. onmouseover="return searchBox.OnSearchSelectShow()"
  67. onmouseout="return searchBox.OnSearchSelectHide()"
  68. alt=""/>
  69. <input type="text" id="MSearchField" value="Search" accesskey="S"
  70. onfocus="searchBox.OnSearchFieldFocus(true)"
  71. onblur="searchBox.OnSearchFieldFocus(false)"
  72. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  73. </span><span class="right">
  74. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  75. </span>
  76. </div>
  77. </li>
  78. </ul>
  79. </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82. <div id="nav-tree">
  83. <div id="nav-tree-contents">
  84. <div id="nav-sync" class="sync"></div>
  85. </div>
  86. </div>
  87. <div id="splitbar" style="-moz-user-select:none;"
  88. class="ui-resizable-handle">
  89. </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('index.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97. onmouseover="return searchBox.OnSearchSelectShow()"
  98. onmouseout="return searchBox.OnSearchSelectHide()"
  99. onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="headertitle">
  109. <div class="title">Overview </div> </div>
  110. </div><!--header-->
  111. <div class="contents">
  112. <div class="textblock"><p>CMSIS-Build is now replaced with the <a href="https://github.com/Open-CMSIS-Pack/devtools/tree/main/tools" target="_blank"><b>CMSIS-Toolbox</b></a> that is a set of tools for creating and building projects that are based on software packs.</p>
  113. Content of this documentation is now <a href="https://open-cmsis-pack.github.io/devtools/buildmgr/latest/index.html" target="_blank"><b>provided here</b></a> and individual pages are redirected to the corresponding pages in CMSIS-Toolbox documents.
  114. <h1><a class="anchor" id="Components_of_CMSIS_Toolbox"></a>
  115. Components of CMSIS-Toolbox</h1>
  116. <p>The <a href="https://github.com/Open-CMSIS-Pack/devtools/tree/main/tools" target="_blank"><b>CMSIS-Toolbox</b></a> is developed under the <a href="https://www.open-cmsis-pack.org" target="_blank">Linaro Open-CMSIS-Pack</a> project and contains these tools:</p>
  117. <ul>
  118. <li><b>cpackget</b> download, add and remove software packs.</li>
  119. <li><b>csolution</b> to create and manage complex applications with user source files and content from software packs</li>
  120. <li><b>cbuild</b> controls the build process that translates a project to a executable binary image.</li>
  121. <li><b>packgen</b> to create a software pack from a CMake based software repository.</li>
  122. <li><b>packchk</b> to validate a software pack</li>
  123. </ul>
  124. <p>The <a href="https://github.com/Open-CMSIS-Pack/devtools/tree/main/tools" target="_blank"><b>CMSIS-Toolbox</b></a> can be used as stand-alone tools with command line interface (CLI) but will be integrated into several other Arm tool solutions such as:</p>
  125. <ul>
  126. <li><a href="https://www.arm.com/virtual-hardware" target="_blank"><b>Arm Virtual Hardware</b></a> to manage the build process in CI workflows.</li>
  127. <li><a href="https://www.keil.arm.com" target="_blank"><b>Keil Studio</b></a> as integral part of the project management.</li>
  128. <li><a href="https://www.keil.com/mdk5/" target="_blank"><b>Keil MDK</b></a> to provide CLI tools for project generation.</li>
  129. </ul>
  130. <h1><a class="anchor" id="Development_Workflow"></a>
  131. Development Workflow</h1>
  132. <p>The following diagram shows the development workflow using the CMSIS-Toolbox.</p>
  133. <div class="image">
  134. <img src="CMSIS-Toolbox.png" alt="CMSIS-Toolbox.png"/>
  135. <div class="caption">
  136. Diagram: CMSIS-Toolbox Development Workflow</div></div>
  137. <p> A solution that manages several related projects and projects can be composed using an intuitive <code>*.yml</code> format. This solution and project files are then translated using <b>csolution</b> CLI tool to the <code>*.CPRJ</code> project file format.</p>
  138. <p>The individual <code>*.CPRJ</code> project files can be imported to an IDE or by using <b>cbuild</b> translated into executable binary images.</p>
  139. <p>The <a class="el" href="cprjFormat_pg.html" target="_blank">*.CPRJ Project Format</a> describes the input file format that is used by <b>cbuild</b>.</p>
  140. <h1><a class="anchor" id="Revision_History"></a>
  141. Revision History</h1>
  142. <table class="doxtable">
  143. <tr>
  144. <th align="left">Version </th><th align="left">Description </th></tr>
  145. <tr>
  146. <td align="left">replaced by </td><td align="left"><a href="https://github.com/Open-CMSIS-Pack/devtools/tree/main/tools" target="_blank"><b>CMSIS-Toolbox</b></a> now contains the <b>cbuild</b> (aka CMSIS-Build) CLI tool. </td></tr>
  147. <tr>
  148. <td align="left">0.10.0 (beta) </td><td align="left">CMake back-end and support for more Cortex-M processors including ArmV8.1M architecture. </td></tr>
  149. <tr>
  150. <td align="left">0.9.0 (beta) </td><td align="left">Support for multiple compilers and commands for layer management </td></tr>
  151. <tr>
  152. <td align="left">0.1.0 (alpha) </td><td align="left">Release for alpha review </td></tr>
  153. </table>
  154. </div></div><!-- contents -->
  155. </div><!-- doc-content -->
  156. <!-- start footer part -->
  157. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  158. <ul>
  159. <li class="footer">
  160. <script type="text/javascript">
  161. <!--
  162. writeFooter.call(this);
  163. //-->
  164. </script>
  165. </li>
  166. </ul>
  167. </div>
  168. </body>
  169. </html>