zTUI.html 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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>User Interface</title>
  7. <title>CMSIS-Zone: User Interface</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. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Zone
  35. &#160;<span id="projectnumber">Version 1.0.0</span>
  36. </div>
  37. <div id="projectbrief">System Resource Management</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li>
  62. <div id="MSearchBox" class="MSearchBoxInactive">
  63. <span class="left">
  64. <img id="MSearchSelect" src="search/mag_sel.png"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. alt=""/>
  68. <input type="text" id="MSearchField" value="Search" accesskey="S"
  69. onfocus="searchBox.OnSearchFieldFocus(true)"
  70. onblur="searchBox.OnSearchFieldFocus(false)"
  71. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72. </span><span class="right">
  73. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74. </span>
  75. </div>
  76. </li>
  77. </ul>
  78. </div>
  79. </div><!-- top -->
  80. <div id="side-nav" class="ui-resizable side-nav-resizable">
  81. <div id="nav-tree">
  82. <div id="nav-tree-contents">
  83. <div id="nav-sync" class="sync"></div>
  84. </div>
  85. </div>
  86. <div id="splitbar" style="-moz-user-select:none;"
  87. class="ui-resizable-handle">
  88. </div>
  89. </div>
  90. <script type="text/javascript">
  91. $(document).ready(function(){initNavTree('zTUI.html','');});
  92. </script>
  93. <div id="doc-content">
  94. <!-- window showing the filter options -->
  95. <div id="MSearchSelectWindow"
  96. onmouseover="return searchBox.OnSearchSelectShow()"
  97. onmouseout="return searchBox.OnSearchSelectHide()"
  98. onkeydown="return searchBox.OnSearchSelectKey(event)">
  99. <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>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  100. <!-- iframe showing the search results (closed by default) -->
  101. <div id="MSearchResultsWindow">
  102. <iframe src="javascript:void(0)" frameborder="0"
  103. name="MSearchResults" id="MSearchResults">
  104. </iframe>
  105. </div>
  106. <div class="header">
  107. <div class="headertitle">
  108. <div class="title">User Interface </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p>The CMSIS-Zone Utility user interface offers menus, toolbars, dialog boxes, and windows to manage the various aspects of your project.</p>
  112. <h1><a class="anchor" id="zTGUI"></a>
  113. CMSIS-Zone GUI</h1>
  114. <p>The utility's GUI provides menus for selecting commands and toolbar buttons in the <a class="el" href="zTUI.html#zTGUIZoneEditor">Zone Editor</a> window:</p>
  115. <div class="image">
  116. <img src="GUI.png" alt="GUI.png"/>
  117. </div>
  118. <h1><a class="anchor" id="zTProjEx"></a>
  119. Project Explorer</h1>
  120. <p>Projects that are currently available in the Eclipse workspace are shown in the <b>Project Explorer</b>. When creating a new project, you will first find the <a class="el" href="zoneFormat.html#rzone">.rzone</a> and the <a class="el" href="zoneFormat.html#azone">.azone</a> files here. Later, generator files and generated files are shown as well:</p>
  121. <div class="image">
  122. <img src="ProjectExplorerWindow.png" alt="ProjectExplorerWindow.png"/>
  123. <div class="caption">
  124. Project Explorer window showing a complex project</div></div>
  125. <p> In the <b>Project Explorer</b> window, you manage the project files. The following files are shown:</p>
  126. <table class="doxtable">
  127. <tr>
  128. <th>File name </th><th>Description </th></tr>
  129. <tr>
  130. <td><code>project.azone</code> </td><td>Project-level <a class="el" href="zoneFormat.html#azone">.azone</a> file </td></tr>
  131. <tr>
  132. <td><code>project.rzone</code> </td><td>Project-level <a class="el" href="zoneFormat.html#rzone">.rzone</a> file </td></tr>
  133. <tr>
  134. <td><code>zone.azone</code> </td><td>Zone-level <a class="el" href="zoneFormat.html#azone">.azone</a> file </td></tr>
  135. <tr>
  136. <td><code>zone.rzone</code> </td><td>Zone-level <a class="el" href="zoneFormat.html#rzone">.rzone</a> file </td></tr>
  137. <tr>
  138. <td><code>*.ftl</code> </td><td>Freemarker template file used to <a class="el" href="GenDataModel.html">generate</a> output </td></tr>
  139. <tr>
  140. <td><code>helper.ftlinc</code> </td><td>Helper file to generate Freemarker output </td></tr>
  141. <tr>
  142. <td><code>*.sct,</code> <code>partition_*</code>.h </td><td>Generated output files </td></tr>
  143. </table>
  144. <h1><a class="anchor" id="zTGUIZoneEditor"></a>
  145. Zone Editor</h1>
  146. <p>The <b>Zone Editor</b> shows <a class="el" href="zoneFormat.html#azone">.azone</a> files in two different views: <b>Resource</b> <b>map</b> and <b>Zone</b> <b>map</b>.</p>
  147. <p>The <b>Resource</b> <b>map</b> shows all resources available to that system or sub-system. By default, it shows the selected device, as well as lists of memories and peripherals:</p>
  148. <div class="image">
  149. <img src="resource_map.png" alt="resource_map.png"/>
  150. </div>
  151. <p>The <b>Zone</b> <b>map</b> shows the same resources, but mapped to zones that have been created for the device:</p>
  152. <div class="image">
  153. <img src="zone_map.png" alt="zone_map.png"/>
  154. </div>
  155. <p>Resources assigned to a zone are marked with colors: </p>
  156. <table class="doxtable">
  157. <tr>
  158. <th>Color </th><th>Meaning </th></tr>
  159. <tr>
  160. <td>Green </td><td>Resource is assigned to one zone </td></tr>
  161. <tr>
  162. <td>Amber </td><td>Resource is assigned to multiple zones </td></tr>
  163. </table>
  164. <h2><a class="anchor" id="zTGUIButtons"></a>
  165. Toolbar Buttons</h2>
  166. <p>The <b>Zone Editor</b> window contains toolbar buttons that offer direct access to functionality of the utility:</p>
  167. <div class="image">
  168. <img src="Buttons.png" alt="Buttons.png"/>
  169. </div>
  170. <table class="doxtable">
  171. <tr>
  172. <th>Button </th><th>Description </th></tr>
  173. <tr>
  174. <td>Tree View </td><td>Shows the resources as a tree </td></tr>
  175. <tr>
  176. <td>List View </td><td>Shows the resources as a simple list </td></tr>
  177. <tr>
  178. <td>Arrange memory regions </td><td>Arranges memory regions according to their sizes </td></tr>
  179. <tr>
  180. <td><a class="el" href="zTUIZonePart.html#zTUICreate">Add new zone</a> </td><td>Adds a new zone to the zone map </td></tr>
  181. <tr>
  182. <td><a class="el" href="zTUIGenerate.html">Generate</a> </td><td>Generates CMSIS-Zone output files </td></tr>
  183. </table>
  184. </div></div><!-- contents -->
  185. </div><!-- doc-content -->
  186. <!-- start footer part -->
  187. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  188. <ul>
  189. <li class="navelem"><a class="el" href="zoneToolUsage.html">CMSIS-Zone Utility</a></li>
  190. <li class="footer">Generated on Thu Apr 9 2020 15:50:03 for CMSIS-Zone Version 1.0.0 by Arm Ltd. All rights reserved.
  191. <!--
  192. <a href="http://www.doxygen.org/index.html">
  193. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  194. -->
  195. </li>
  196. </ul>
  197. </div>
  198. </body>
  199. </html>