summaryrefslogtreecommitdiff
path: root/docs/Zone/html/zTUI.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/Zone/html/zTUI.html')
-rw-r--r--docs/Zone/html/zTUI.html201
1 files changed, 201 insertions, 0 deletions
diff --git a/docs/Zone/html/zTUI.html b/docs/Zone/html/zTUI.html
new file mode 100644
index 0000000..1fa455c
--- /dev/null
+++ b/docs/Zone/html/zTUI.html
@@ -0,0 +1,201 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=9"/>
+<title>User Interface</title>
+<title>CMSIS-Zone (Preview): User Interface</title>
+<link href="tabs.css" rel="stylesheet" type="text/css"/>
+<link href="cmsis.css" rel="stylesheet" type="text/css" />
+<script type="text/javascript" src="jquery.js"></script>
+<script type="text/javascript" src="dynsections.js"></script>
+<script type="text/javascript" src="printComponentTabs.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<script type="text/javascript">
+ $(document).ready(initResizable);
+ $(window).load(resizeHeight);
+</script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+ $(document).ready(function() { searchBox.OnSelectItem(0); });
+</script>
+</head>
+<body>
+<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
+<div id="titlearea">
+<table cellspacing="0" cellpadding="0">
+ <tbody>
+ <tr style="height: 46px;">
+ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
+ <td style="padding-left: 0.5em;">
+ <div id="projectname">CMSIS-Zone (Preview)
+ &#160;<span id="projectnumber">Version 0.9.2</span>
+ </div>
+ <div id="projectbrief">System Resource Management</div>
+ </td>
+ </tr>
+ </tbody>
+</table>
+</div>
+<!-- end header part -->
+<div id="CMSISnav" class="tabs1">
+ <ul class="tablist">
+ <script type="text/javascript">
+ <!--
+ writeComponentTabs.call(this);
+ //-->
+ </script>
+ </ul>
+</div>
+<!-- Generated by Doxygen 1.8.6 -->
+<script type="text/javascript">
+var searchBox = new SearchBox("searchBox", "search",false,'Search');
+</script>
+ <div id="navrow1" class="tabs">
+ <ul class="tablist">
+ <li><a href="index.html"><span>Main&#160;Page</span></a></li>
+ <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
+ <li>
+ <div id="MSearchBox" class="MSearchBoxInactive">
+ <span class="left">
+ <img id="MSearchSelect" src="search/mag_sel.png"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ alt=""/>
+ <input type="text" id="MSearchField" value="Search" accesskey="S"
+ onfocus="searchBox.OnSearchFieldFocus(true)"
+ onblur="searchBox.OnSearchFieldFocus(false)"
+ onkeyup="searchBox.OnSearchFieldChange(event)"/>
+ </span><span class="right">
+ <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
+ </span>
+ </div>
+ </li>
+ </ul>
+ </div>
+</div><!-- top -->
+<div id="side-nav" class="ui-resizable side-nav-resizable">
+ <div id="nav-tree">
+ <div id="nav-tree-contents">
+ <div id="nav-sync" class="sync"></div>
+ </div>
+ </div>
+ <div id="splitbar" style="-moz-user-select:none;"
+ class="ui-resizable-handle">
+ </div>
+</div>
+<script type="text/javascript">
+$(document).ready(function(){initNavTree('zTUI.html','');});
+</script>
+<div id="doc-content">
+<!-- window showing the filter options -->
+<div id="MSearchSelectWindow"
+ onmouseover="return searchBox.OnSearchSelectShow()"
+ onmouseout="return searchBox.OnSearchSelectHide()"
+ onkeydown="return searchBox.OnSearchSelectKey(event)">
+<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>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<iframe src="javascript:void(0)" frameborder="0"
+ name="MSearchResults" id="MSearchResults">
+</iframe>
+</div>
+
+<div class="header">
+ <div class="headertitle">
+<div class="title">User Interface </div> </div>
+</div><!--header-->
+<div class="contents">
+<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>
+<h1><a class="anchor" id="zTGUI"></a>
+CMSIS-Zone GUI</h1>
+<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>
+<div class="image">
+<img src="GUI.png" alt="GUI.png"/>
+</div>
+<h1><a class="anchor" id="zTProjEx"></a>
+Project Explorer</h1>
+<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>
+<div class="image">
+<img src="ProjectExplorerWindow.png" alt="ProjectExplorerWindow.png"/>
+<div class="caption">
+Project Explorer window showing a complex project</div></div>
+<p> In the <b>Project Explorer</b> window, you manage the project files. The following files are shown:</p>
+<table class="doxtable">
+<tr>
+<th>File name </th><th>Description </th></tr>
+<tr>
+<td><code>project.azone</code> </td><td>Project-level <a class="el" href="zoneFormat.html#azone">.azone</a> file </td></tr>
+<tr>
+<td><code>project.rzone</code> </td><td>Project-level <a class="el" href="zoneFormat.html#rzone">.rzone</a> file </td></tr>
+<tr>
+<td><code>zone.azone</code> </td><td>Zone-level <a class="el" href="zoneFormat.html#azone">.azone</a> file </td></tr>
+<tr>
+<td><code>zone.rzone</code> </td><td>Zone-level <a class="el" href="zoneFormat.html#rzone">.rzone</a> file </td></tr>
+<tr>
+<td><code>*.ftl</code> </td><td>Freemarker template file used to <a class="el" href="GenDataModel.html">generate</a> output </td></tr>
+<tr>
+<td><code>helper.ftlinc</code> </td><td>Helper file to generate Freemarker output </td></tr>
+<tr>
+<td><code>*.sct,</code> <code>partition_*</code>.h </td><td>Generated output files </td></tr>
+</table>
+<h1><a class="anchor" id="zTGUIZoneEditor"></a>
+Zone Editor</h1>
+<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>
+<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>
+<div class="image">
+<img src="resource_map.png" alt="resource_map.png"/>
+</div>
+<p>The <b>Zone</b> <b>map</b> shows the same resources, but mapped to zones that have been created for the device:</p>
+<div class="image">
+<img src="zone_map.png" alt="zone_map.png"/>
+</div>
+<p>Resources assigned to a zone are marked with colors: </p>
+<table class="doxtable">
+<tr>
+<th>Color </th><th>Meaning </th></tr>
+<tr>
+<td>Green </td><td>Resource is assigned to one zone </td></tr>
+<tr>
+<td>Amber </td><td>Resource is assigned to multiple zones </td></tr>
+</table>
+<h2><a class="anchor" id="zTGUIButtons"></a>
+Toolbar Buttons</h2>
+<p>The <b>Zone Editor</b> window contains toolbar buttons that offer direct access to functionality of the utility:</p>
+<div class="image">
+<img src="Buttons.png" alt="Buttons.png"/>
+</div>
+<table class="doxtable">
+<tr>
+<th>Button </th><th>Description </th></tr>
+<tr>
+<td>Tree View </td><td>Shows the resources as a tree </td></tr>
+<tr>
+<td>List View </td><td>Shows the resources as a simple list </td></tr>
+<tr>
+<td>Arrange memory regions </td><td>Arranges memory regions according to their sizes </td></tr>
+<tr>
+<td><a class="el" href="zTUIZonePart.html#zTUICreate">Add new zone</a> </td><td>Adds a new zone to the zone map </td></tr>
+<tr>
+<td><a class="el" href="zTUIGenerate.html">Generate</a> </td><td>Generates CMSIS-Zone output files </td></tr>
+</table>
+</div></div><!-- contents -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+ <ul>
+ <li class="navelem"><a class="el" href="zoneToolUsage.html">CMSIS-Zone Utility</a></li>
+ <li class="footer">Generated on Wed Jul 10 2019 15:21:06 for CMSIS-Zone (Preview) Version 0.9.2 by Arm Ltd. All rights reserved.
+ <!--
+ <a href="http://www.doxygen.org/index.html">
+ <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
+ -->
+ </li>
+ </ul>
+</div>
+</body>
+</html>