diff options
Diffstat (limited to 'docs/Zone/html')
168 files changed, 6084 insertions, 2133 deletions
diff --git a/docs/Zone/html/AddMemoryBlock.png b/docs/Zone/html/AddMemoryBlock.png Binary files differnew file mode 100644 index 0000000..f632f92 --- /dev/null +++ b/docs/Zone/html/AddMemoryBlock.png diff --git a/docs/Zone/html/AddNewZoneButton.png b/docs/Zone/html/AddNewZoneButton.png Binary files differnew file mode 100644 index 0000000..4e117d0 --- /dev/null +++ b/docs/Zone/html/AddNewZoneButton.png diff --git a/docs/Zone/html/Buttons.png b/docs/Zone/html/Buttons.png Binary files differnew file mode 100644 index 0000000..62449de --- /dev/null +++ b/docs/Zone/html/Buttons.png diff --git a/docs/Zone/html/CMSISPacksPreferences.png b/docs/Zone/html/CMSISPacksPreferences.png Binary files differnew file mode 100644 index 0000000..cb8cae9 --- /dev/null +++ b/docs/Zone/html/CMSISPacksPreferences.png diff --git a/docs/Zone/html/DelMemoryRegion.png b/docs/Zone/html/DelMemoryRegion.png Binary files differnew file mode 100644 index 0000000..b00d6da --- /dev/null +++ b/docs/Zone/html/DelMemoryRegion.png diff --git a/docs/Zone/html/DevelopmentFlow.png b/docs/Zone/html/DevelopmentFlow.png Binary files differdeleted file mode 100644 index ccf2462..0000000 --- a/docs/Zone/html/DevelopmentFlow.png +++ /dev/null diff --git a/docs/Zone/html/GUI.png b/docs/Zone/html/GUI.png Binary files differnew file mode 100644 index 0000000..7bfd7dd --- /dev/null +++ b/docs/Zone/html/GUI.png diff --git a/docs/Zone/html/GenCodeButton.png b/docs/Zone/html/GenCodeButton.png Binary files differnew file mode 100644 index 0000000..8554ec9 --- /dev/null +++ b/docs/Zone/html/GenCodeButton.png diff --git a/docs/Zone/html/GenDataModel.html b/docs/Zone/html/GenDataModel.html index 3e2c40f..5cff952 100644 --- a/docs/Zone/html/GenDataModel.html +++ b/docs/Zone/html/GenDataModel.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -110,61 +110,45 @@ $(document).ready(function(){initNavTree('GenDataModel.html','');}); <div class="title">Generator Data Model </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>Generator Data Model</b> defines the view on the <b>Zone Description</b> for code generators. By defining a common data model code generators can be developed independendly from actual CMSIS Zone Projects and vendor tools.</p> -<p>The CMSIS-Zone data (structured according to the Generator Data Model) is combined with file templates using the FreeMarker template engine to generate arbitrary project files, see picture below..</p> +<div class="textblock"><p>The <b>Generator Data Model</b> defines the resource and partition data structure for code generators. This data structure is connected to a FreeMarker template engine and file templates allow to generate various files that can be used to configure development tools or hardware components.</p> <div class="image"> <img src="generator.png" alt="generator.png"/> <div class="caption"> FreeMarker Template Engine</div></div> - <h1><a class="anchor" id="GenDataModel_Structure"></a> -Data Model Structure</h1> -<p>The class diagram below visualizes the overall structure of the <b>Generator Data Model</b>. The root element visible to the templates is FmZone.</p> -<div class="image"> -<img src="genmodel.png" alt="genmodel.png"/> -<div class="caption"> -Generator Data Model Class Diagram</div></div> -<p> According to <a href="http://freemarker.org/docs/index.html" target="_blank">FreeMarker Documentation</a> one can access the named attributes like <a href="http://freemarker.org/docs/dgui_template_exp.html#dgui_template_exp_var_hash" target="_blank">retrieving data from a hash</a>. The reference implementation documented in detail below make use of the default FreeMarker <a href="http://freemarker.org/docs/pgui_misc_beanwrapper.html" target="_blank">Bean wrapper</a>. This leads to all Java methods named like <em>get<Attribute></em> or <em>is<Attribute></em> to be visible just as <em><Attribute></em> to the template.</p> -<p>Please take note about the multiplicities stated in the diagram:</p> -<ul> -<li>0..1 indicates an optional value which might be unavailable, consider using <a href="http://freemarker.org/docs/dgui_template_exp.html#dgui_template_exp_missing" target="_blank">missing value handler operators</a>.</li> -<li>1 indicates a mandatory value which is guaranteed to be valid.</li> -<li>0..* indicates a collection or hash of values which might be empty.</li> -<li>1..* indicates a collection or hash of values which is guaranteed to contain at least one element.</li> -</ul> -<p>For detailed descriptions of the data model elements please refere to the <a href="../genmodel/index.html" target="_blank">JavaDoc</a> documentation for</p> + <h1><a class="anchor" id="fp_toplevel"></a> +FreeMarker top-level format</h1> +<p><a class="el" href="fm_system.html">system element</a> provides memory layout and TrustZone configuration of the complete system. <a class="el" href="fm_zone.html">zone element</a> setup information of a zone (or system partition) along with related peripherals.</p> +<h1><a class="anchor" id="fm_basics"></a> +FreeMarker basics</h1> +<p>The variable types relevant for CMSIS-Zone are:</p> +<p><b>scalar:</b> variable that stores a single value of a scalar type scalar-types:</p> <ul> -<li><a href="../genmodel/com/arm/cmsis/zone/gen/data/FmZone.html" target="_blank">FmZone</a></li> -<li><a href="../genmodel/com/arm/cmsis/zone/gen/data/FmProcess.html" target="_blank">FmProcess</a></li> -<li><a href="../genmodel/com/arm/cmsis/zone/gen/data/FmDevice.html" target="_blank">FmDevice</a></li> -<li><a href="../genmodel/com/arm/cmsis/zone/gen/data/FmProcessor.html" target="_blank">FmProcesor</a></li> -<li><a href="../genmodel/com/arm/cmsis/zone/gen/data/FmBlock.html" target="_blank">FmBlock</a></li> +<li>string</li> +<li>int</li> +<li>bool</li> </ul> -<h1><a class="anchor" id="GenDataModel_Examples"></a> -Template Examples</h1> -<p>To get an impression of how template files might look like please refere to the simplyfied examples in this section.</p> -<h2><a class="anchor" id="GenDataModel_Examples_AssignedBlocks"></a> -HTML table of all assigned memory blocks</h2> -<p>This examples demonstrates how to iterate over the collection of memory blocks assigned to the project zone currently evaluated. The result of the template below is a HTML table with three columns listing block name, start address and size, respectively.</p> -<div class="fragment"><div class="line"><table></div> -<div class="line"> <th></div> -<div class="line"> <td>Name</td></div> -<div class="line"> <td>Start</td></div> -<div class="line"> <td>Size</td></div> -<div class="line"> </th></div> -<div class="line"><#list blocks as block></div> -<div class="line"> <tr></div> -<div class="line"> <td>${block.name}</td></div> -<div class="line"> <td>${block.start}</td></div> -<div class="line"> <td>${block.size}</td></div> -<div class="line"> </tr></div> +<p><b>hash:</b> variable that that stores one or more variables with a unique lookup name</p> +<p><b>sequence:</b> variable that stores sub-variables without names but instead are selected via index (myVariable[index])</p> +<p>A variable is accessed using the dollar character followed by a variable or expression in brackets: </p> +<div class="fragment"><div class="line">${...}</div> +</div><!-- fragment --><p> Output the name of the zone: </p> +<div class="fragment"><div class="line">${zone.name}</div> +</div><!-- fragment --><p>A sequence gets iterated: </p> +<div class="fragment"><div class="line"><#list zone.memory as mem></div> +<div class="line"> Memory region name $mem.name</div> +<div class="line"></#list</div> +<div class="line"></div> +<div class="line">Printing a sorted list of all available memory entries by start address</div> +<div class="line">\code</div> +<div class="line"><#list zone.memory?sort_by(<span class="stringliteral">"start"</span>) as mem></div> +<div class="line"> ${mem.start} ${mem.name}</div> <div class="line"></#list></div> -<div class="line"></table></div> </div><!-- fragment --> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <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 diff --git a/docs/Zone/html/GenDataModel.js b/docs/Zone/html/GenDataModel.js new file mode 100644 index 0000000..8eadf5c --- /dev/null +++ b/docs/Zone/html/GenDataModel.js @@ -0,0 +1,7 @@ +var GenDataModel = +[ + [ "FreeMarker top-level format", "GenDataModel.html#fp_toplevel", null ], + [ "FreeMarker basics", "GenDataModel.html#fm_basics", null ], + [ "system element", "fm_system.html", "fm_system" ], + [ "zone element", "fm_zone.html", "fm_zone" ] +];
\ No newline at end of file diff --git a/docs/Zone/html/IRAM1_1Display.png b/docs/Zone/html/IRAM1_1Display.png Binary files differnew file mode 100644 index 0000000..f51c417 --- /dev/null +++ b/docs/Zone/html/IRAM1_1Display.png diff --git a/docs/Zone/html/NewMemoryBlockWiz.png b/docs/Zone/html/NewMemoryBlockWiz.png Binary files differnew file mode 100644 index 0000000..841a33e --- /dev/null +++ b/docs/Zone/html/NewMemoryBlockWiz.png diff --git a/docs/Zone/html/NewZoneCM33_0.png b/docs/Zone/html/NewZoneCM33_0.png Binary files differnew file mode 100644 index 0000000..f321009 --- /dev/null +++ b/docs/Zone/html/NewZoneCM33_0.png diff --git a/docs/Zone/html/Partitioning_Hardware.png b/docs/Zone/html/Partitioning_Hardware.png Binary files differnew file mode 100644 index 0000000..4aa2119 --- /dev/null +++ b/docs/Zone/html/Partitioning_Hardware.png diff --git a/docs/Zone/html/Partitioning_Workflow.png b/docs/Zone/html/Partitioning_Workflow.png Binary files differnew file mode 100644 index 0000000..7690833 --- /dev/null +++ b/docs/Zone/html/Partitioning_Workflow.png diff --git a/docs/Zone/html/ProjectExplorerWindow.png b/docs/Zone/html/ProjectExplorerWindow.png Binary files differnew file mode 100644 index 0000000..51a65fb --- /dev/null +++ b/docs/Zone/html/ProjectExplorerWindow.png diff --git a/docs/Zone/html/STM32L5_zones.png b/docs/Zone/html/STM32L5_zones.png Binary files differnew file mode 100644 index 0000000..48d81cc --- /dev/null +++ b/docs/Zone/html/STM32L5_zones.png diff --git a/docs/Zone/html/SaveButton.png b/docs/Zone/html/SaveButton.png Binary files differnew file mode 100644 index 0000000..321d66b --- /dev/null +++ b/docs/Zone/html/SaveButton.png diff --git a/docs/Zone/html/SetProjectName.png b/docs/Zone/html/SetProjectName.png Binary files differnew file mode 100644 index 0000000..780e2bc --- /dev/null +++ b/docs/Zone/html/SetProjectName.png diff --git a/docs/Zone/html/SpecifyRzoneFile.png b/docs/Zone/html/SpecifyRzoneFile.png Binary files differnew file mode 100644 index 0000000..7a9cd6e --- /dev/null +++ b/docs/Zone/html/SpecifyRzoneFile.png diff --git a/docs/Zone/html/UseCases.html b/docs/Zone/html/UseCases.html new file mode 100644 index 0000000..cc1c5b3 --- /dev/null +++ b/docs/Zone/html/UseCases.html @@ -0,0 +1,150 @@ +<!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>CMSIS-Zone Use Cases</title> +<title>CMSIS-Zone (Preview): CMSIS-Zone Use Cases</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('UseCases.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">CMSIS-Zone Use Cases </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p><b>CMSIS-Zone</b> simplifies to manage the complexity and the configuration of modern embedded systems that frequently include multiple processors and/or memory protection hardware. It helps to split the embedded application various projects which creates the need to partition system resources. And it simplifies the consistent configuration of access rights across the system, for example when using an MPU (memory protection unit).</p> +<p>The following section describes several uses cases that benefit from <b>CMSIS-Zone</b>.</p> +<h1><a class="anchor" id="UseCase_MPU"></a> +MPU Protection</h1> +<p>Focused on a single core microcontroller one might want to utilize the memory protection unit (MPU) capabilities to segregate parts of an application. Thus the need to partition the system resources accordingly arises.</p> +<div class="image"> +<img src="mpu.png" alt="mpu.png"/> +<div class="caption"> +MPU Protection</div></div> +<h1><a class="anchor" id="UseCase_TrustZone"></a> +TrustZone Partitioning</h1> +<p>TrustZone extensions add another degree of segregation which must be handled consistently. In this case one has to handle MPU settings per security context and SAU configuration.</p> +<div class="image"> +<img src="trustzone.png" alt="trustzone.png"/> +<div class="caption"> +TrustZone Partitioning and MPU Protection</div></div> +<h1><a class="anchor" id="UseCase_MultiCore"></a> +Multi-Core Partitioning</h1> +<p>Beside traditional single cores asymmetric and hybrid multi-core devices contribute to increasing development complexity for embedded systems. Having multiple cores running different parts of an application concurrently needs a well defined resource assignment to prevent undesired misbehavior.</p> +<div class="image"> +<img src="multicore.png" alt="multicore.png"/> +<div class="caption"> +Multi-Core Partitioning</div></div> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> diff --git a/docs/Zone/html/XML_Format.html b/docs/Zone/html/XML_Format.html deleted file mode 100644 index a66eded..0000000 --- a/docs/Zone/html/XML_Format.html +++ /dev/null @@ -1,252 +0,0 @@ -<!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>Zone Description Format</title> -<title>CMSIS-Zone (Preview): Zone Description Format</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('XML_Format.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Zone Description Format </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>Zone Description Format</b> uses standard XML annotations and is defined in the schema file <b>ZONE.xsd</b>. It is intended to provide a tool vendor agnostic storage format for</p> -<ul> -<li>describing embedded system resource capabilities<ul> -<li>specific <a class="el" href="format_device.html">device</a> and <a class="el" href="format_processor.html">processor</a> properties</li> -<li>available <a class="el" href="format_memory.html">memory</a> and <a class="el" href="format_peripheral.html">peripheral</a> resources</li> -</ul> -</li> -<li>specifying resource partitioning across<ul> -<li><a class="el" href="format_pzone.html">project zones</a>, e.g. for secure and non-secure firmware parts</li> -<li><a class="el" href="format_xzone.html">execution zones</a>, e.g. for functional segregation</li> -</ul> -</li> -</ul> -<h1><a class="anchor" id="XML_Format_Model"></a> -Storage Data Model</h1> -<p>In the following diagram the overall structure of the <b>Storage Data Model</b> is depicted. The <a class="el" href="XML_Format.html#XML_Format_Schema">storage format</a> is derived from the model.</p> -<div class="image"> -<img src="storagemodel.png" alt="storagemodel.png"/> -<div class="caption"> -Storage Data Model Class Diagram</div></div> -<p> The storage model is developed based on the domain and can be seen as the domain model as well. Its main purpose is to capture all information about presumable embedded systems and microcontroller devices.</p> -<h2><a class="anchor" id="XML_Format_Model_Decomp"></a> -Embedded Microcontroller System Decomposition</h2> -<p>Todays available system-on-modules (SoM) and system-on-chips (SoC) already physically outlines the overall composition. It seems to be viable to stick with todays system structures. It's not likely that this structure will change drastically.</p> -<p>A detailed view on the decomposition of an arbitrary SoM is given in the diagram below.</p> -<div class="image"> -<img src="som-decomposition.png" alt="som-decomposition.png"/> -<div class="caption"> -System-on-Module Decomposition</div></div> -<p> The SoM itself (System) can be seen as a composition of one or more SoCs (Device) combined with an arbitrary amount of board-level resources, i.e. off-chip memory (Memory) and peripheral (Peripheral). In turn each SoC is a composition of one or more processor elements (Processor, PE) with chip-level resources, i.e. on-chip memory and peripheral.</p> -<p>Private memory and peripheral resources local to a dedicated PE has been simplified. These can also be seen as chip-level resources.</p> -<p>The grouping (ResourceGroup) is intended to allow structural grouping of resources elements, i.e. by type or bus structure.</p> -<dl class="section note"><dt>Note</dt><dd>The names (i.e. <code>name</code> attributes) are typically used as references and hence must be unique per class. Duplicate names are allowed if object hierarchies do not overlap. I.e. resources contained on two separate SoCs may have the same name but the name of a SoM level resource must not be reused on SoC level.</dd></dl> -<h2><a class="anchor" id="XML_Format_Model_MemMap"></a> -Microcontroller Memory Map Specification</h2> -<p>Most of the Multi-Core-SoCs available today show uniform memory maps. But in principle the logical memory address used to address a certain resource may vary between multiple PEs on the same SoC. Taking this into account leads to memory map specification on both SoC and PE level, see diagram below.</p> -<div class="image"> -<img src="soc-memorymap.png" alt="soc-memorymap.png"/> -<div class="caption"> -System-on-Chip Memory Map Specification</div></div> -<p> The memory maps specified on SoC and PE level are additive, i.e. the PEs actual memory map is the combination of both. This split allow the specification of uniform memory maps without duplication. Only the non-uniform parts need to be specified on PE level.</p> -<p>Each resource can be mapped as often as needed, i.e. to reflect multiple memory aliases. By default the <code>name</code> attribute is used to identify the resource to be mapped. In order to map the same resource multiple times into a PEs memory space the <code>alias</code> attribute must be given to identify the resource instead. The mapping names must be unique per PE because they are used as references later.</p> -<p>The attributes of the mapping are merged with those of the resource mapped. This allows the mapping of an individual PE to enhance the basic attributes of a resource. For example a memory resource that is basically readable/writeable/executable might be mapped to a PE as readonly memory.</p> -<h2><a class="anchor" id="XML_Format_Model_Assign"></a> -Zone Resource Assignments</h2> -<p>A system can be split into an arbitrary amount of project zones (PZone). And each PZone can be further split into execution zones (XZone). Resources used by an individual zone are represented using assignments (Assignment). Refer to the diagram below.</p> -<div class="image"> -<img src="zone-assignment.png" alt="zone-assignment.png"/> -<div class="caption"> -Zone Resource Assignments</div></div> -<p> Each PZone is assigned to a dedicated PE which is selected to execute the resulting software part. The PE is referenced by the unique combination of <code>Dname</code> and <code>Pname</code> attributes. The XZones are contained in the PZone they belong to.</p> -<p>Both PZones and XZones can have arbitrary assignments to available resources visible to the assigned PE. Assignments to SoC level resources not part of the SoC the PE is located on are illegal. Such assignments cannot be represented because the unique reference is built from <code>PZone::Dname</code> and <code>Assignment::name</code>.</p> -<p>As a resource may be visible to the enclosing PE using multiple mappings the <code>as</code> attribute can be used to distinguish which alias is used for access. Selecting the correct alias is significant because of the effective access attributes resulting from merging <code>Resource.access</code>, <code>MemoryMapping.access</code>/<code>PeripheralMapping.access</code> and <code>Assignment.access</code>.</p> -<p>Whilst peripheral resources can be assigned directly memory resources need to be split into blocks (MemoryBlock). A block can be seen as an arbitrary part of the physical memory. Individual blocks can be defined using modified access attributes, e.g. for having dedicated executable or readonly regions in RAM.</p> -<h1><a class="anchor" id="XML_Format_Schema"></a> -Zone Schema</h1> -<p>The XML schema is defined hierarchically with the following top-level elements:</p> -<p><a class="el" href="format_system.html">/system element</a></p> -<ul> -<li><a class="el" href="format_device.html">/device element</a></li> -<li><a class="el" href="format_resources.html">/resources element</a></li> -<li><a class="el" href="format_zones.html">/zones element</a></li> -</ul> -<div class="fragment"><div class="line"><system></div> -<div class="line"> </div> -<div class="line"> <device></div> -<div class="line"> </div> -<div class="line"> <processor></div> -<div class="line"> <memory_map></div> -<div class="line"> <memory/></div> -<div class="line"> <peripheral/></div> -<div class="line"> </memory_map></div> -<div class="line"> </processor></div> -<div class="line"> </div> -<div class="line"> <memory_map></div> -<div class="line"> <memory/></div> -<div class="line"> <peripheral/></div> -<div class="line"> </memory_map></div> -<div class="line"> </div> -<div class="line"> <resources></div> -<div class="line"> </div> -<div class="line"> <memory></div> -<div class="line"> <region></div> -<div class="line"> <block/></div> -<div class="line"> </region></div> -<div class="line"> </memory></div> -<div class="line"> </div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral/></div> -<div class="line"> </peripherals></div> -<div class="line"> </div> -<div class="line"> </resources></div> -<div class="line"> </div> -<div class="line"> </device></div> -<div class="line"> </div> -<div class="line"> <resources></div> -<div class="line"> </div> -<div class="line"> <memory></div> -<div class="line"> <region></div> -<div class="line"> <block/></div> -<div class="line"> </region></div> -<div class="line"> </memory></div> -<div class="line"> </div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral/></div> -<div class="line"> </peripherals></div> -<div class="line"> </div> -<div class="line"> </resources></div> -<div class="line"> </div> -<div class="line"> <zones></div> -<div class="line"> <pzone></div> -<div class="line"> <assign></div> -<div class="line"> <capture/></div> -<div class="line"> </assign></div> -<div class="line"> </div> -<div class="line"> <xzone></div> -<div class="line"> <assign/></div> -<div class="line"> </xzone></div> -<div class="line"> </div> -<div class="line"> </pzone></div> -<div class="line"> </zones></div> -<div class="line"> </div> -<div class="line"></system></div> -</div><!-- fragment --><h1><a class="anchor" id="Example"></a> -Example</h1> -</div></div><!-- contents --> -</div><!-- doc-content --> -<!-- start footer part --> -<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> - <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/XML_Format.js b/docs/Zone/html/XML_Format.js deleted file mode 100644 index 8cc381b..0000000 --- a/docs/Zone/html/XML_Format.js +++ /dev/null @@ -1,11 +0,0 @@ -var XML_Format = -[ - [ "Storage Data Model", "XML_Format.html#XML_Format_Model", [ - [ "Embedded Microcontroller System Decomposition", "XML_Format.html#XML_Format_Model_Decomp", null ], - [ "Microcontroller Memory Map Specification", "XML_Format.html#XML_Format_Model_MemMap", null ], - [ "Zone Resource Assignments", "XML_Format.html#XML_Format_Model_Assign", null ] - ] ], - [ "Zone Schema", "XML_Format.html#XML_Format_Schema", null ], - [ "Example", "XML_Format.html#Example", null ], - [ "/system element", "format_system.html", "format_system" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/blinky_window.png b/docs/Zone/html/blinky_window.png Binary files differnew file mode 100644 index 0000000..716015d --- /dev/null +++ b/docs/Zone/html/blinky_window.png diff --git a/docs/Zone/html/cmsis.css b/docs/Zone/html/cmsis.css index bba1010..586d4d2 100644 --- a/docs/Zone/html/cmsis.css +++ b/docs/Zone/html/cmsis.css @@ -1148,7 +1148,7 @@ dl.section dd { .image { - text-align: center; + text-align: left; } .dotgraph diff --git a/docs/Zone/html/dma_channel_config.png b/docs/Zone/html/dma_channel_config.png Binary files differnew file mode 100644 index 0000000..864dc13 --- /dev/null +++ b/docs/Zone/html/dma_channel_config.png diff --git a/docs/Zone/html/dma_gpio_config.png b/docs/Zone/html/dma_gpio_config.png Binary files differnew file mode 100644 index 0000000..f3ad4d8 --- /dev/null +++ b/docs/Zone/html/dma_gpio_config.png diff --git a/docs/Zone/html/format_memory_map.html b/docs/Zone/html/fm_interrupt.html index 1c1514f..e4dc967 100644 --- a/docs/Zone/html/format_memory_map.html +++ b/docs/Zone/html/fm_interrupt.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/memory_map element</title> -<title>CMSIS-Zone (Preview): /memory_map element</title> +<title>interrupt[n] sequence element</title> +<title>CMSIS-Zone (Preview): interrupt[n] sequence element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_memory_map.html','');}); +$(document).ready(function(){initNavTree('fm_interrupt.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,41 +107,37 @@ $(document).ready(function(){initNavTree('format_memory_map.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/memory_map element </div> </div> +<div class="title">interrupt[n] sequence element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>memory_map</b> element is used to to define the logical address mappings (i.e. the <em>"memory map"</em>).</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><memory_map></div> -<div class="line"> <!-- Logical address to access integrated SRAM --></div> -<div class="line"> <memory name=<span class="stringliteral">"SRAM"</span> start=<span class="stringliteral">"0x10000000"</span>/></div> -<div class="line"> :</div> -<div class="line"> <!-- Logical address to access peripheral ADC0 registers --> </div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> start=<span class="stringliteral">"0x40010000"</span>/></div> -<div class="line"> :</div> -<div class="line"></memory_map></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Memory_Map"> +<div class="textblock"><p>The <a class="el" href="fm_interrupt.html">interrupt[n] sequence element</a> lists all interrupt sources available in the system.</p> +<table class="cmtable" summary="Element: interrupt[n]"> <tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> <tr> -<td><a class="el" href="format_device.html">device</a> </td><td colspan="3"><a class="el" href="format_device.html">/device element</a> </td></tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> s </td></tr> <tr> -<td><a class="el" href="format_processor.html">processor</a> </td><td colspan="3"><a class="el" href="format_processor.html">/processor element</a> </td></tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>.interrupt[<em>n</em>].name </td><td>The name of this interrupt. </td><td>xs:string </td></tr> <tr> -<td><a class="el" href="format_map_memory.html">memory</a> </td><td>One memory entry per memory region mapped into the logical address space. </td><td>complexType </td><td>0..* </td></tr> +<td>.interrupt[<em>n</em>].irqn </td><td>The interrupt number. </td><td>NonNegativeInteger </td></tr> <tr> -<td><a class="el" href="format_map_peripheral.html">peripheral</a> </td><td>One peripheral entry per peripheral mapped into the logical address space. </td><td>complexType </td><td>0..* </td></tr> +<td>.interrupt[<em>n</em>].security </td><td>The <a class="el" href="zoneFormat.html#security">security</a> setting for this interrupt. </td><td>SecurityTypeEnum/xs:string </td></tr> +<tr> +<td>.interrupt[<em>n</em>].security.s </td><td>Peripheral with related interrupt is assigned to <em>"secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.interrupt[<em>n</em>].security.n </td><td>Peripheral with related interrupt is assigned to <em>"non-secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.interrupt[<em>n</em>].info </td><td>Brief description of the interrupt source. </td><td>xs:string </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_processor.html">/processor element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_system.html">system element</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 diff --git a/docs/Zone/html/format_peripheral.html b/docs/Zone/html/fm_memory.html index a5572f5..e3ef3ed 100644 --- a/docs/Zone/html/format_peripheral.html +++ b/docs/Zone/html/fm_memory.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/peripheral element</title> -<title>CMSIS-Zone (Preview): /peripheral element</title> +<title>../memory[n] sequence element</title> +<title>CMSIS-Zone (Preview): ../memory[n] sequence element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_peripheral.html','');}); +$(document).ready(function(){initNavTree('fm_memory.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,53 +107,71 @@ $(document).ready(function(){initNavTree('format_peripheral.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/peripheral element </div> </div> +<div class="title">../memory[n] sequence element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>peripheral</b> element is used to define physical peripheral resources.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> :</div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Analog/Digital Converter 0 (12-bit)"</span>/></div> -<div class="line"> :</div> -<div class="line"> <group name=<span class="stringliteral">"USART"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter"</span>></div> -<div class="line"> <peripheral name=<span class="stringliteral">"UART0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal asynchronous receiver/transmitter 0"</span>/></div> -<div class="line"> <peripheral name=<span class="stringliteral">"USART1"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter 1"</span>/></div> -<div class="line"> :</div> -<div class="line"> </group></div> -<div class="line"> </peripherals></div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Peripheral"> +<div class="textblock"><p>The <a class="el" href="fm_memory.html">../memory[n] sequence element</a> provides a sequence of memory information.</p> +<table class="cmtable" summary="Element: memory[n]"> <tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> <tr> -<td><a class="el" href="format_peripherals.html">peripherals</a> </td><td colspan="3"><a class="el" href="format_peripherals.html">/peripherals element</a> </td></tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> </td></tr> <tr> -<td><a class="el" href="format_group.html">group</a> </td><td colspan="3"><a class="el" href="format_group.html">/group element</a> </td></tr> +<td><a class="el" href="fm_zone.html">zone</a> </td><td colspan="3"><a class="el" href="fm_zone.html">zone element</a> </td></tr> <tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> <tr> -<td>name </td><td>The name for this peripheral. Must be unique within a single device. </td><td>xs:string </td><td>required </td></tr> +<td>.memory[<em>n</em>] </td><td>Sequence of memory region information. </td><td>sequence </td></tr> <tr> -<td>size </td><td>The memory size the peripheral registers occupy. </td><td>xs:string </td><td>required </td></tr> +<td>.memory[<em>n</em>].name </td><td>The name of this memory region. </td><td>xs:string </td></tr> <tr> -<td>access </td><td>The access attributes for this peripheral. </td><td>xs:string </td><td>required </td></tr> +<td>.memory[<em>n</em>].type </td><td>The type of memory in this region ("RAM" or "ROM"). </td><td>MemoryTypeEnum </td></tr> <tr> -<td>info </td><td>Brief description of the peripheral resource. </td><td>xs:string </td><td>optional </td></tr> +<td>.memory[<em>n</em>].start </td><td>The logical start address of the memory region in the address map. </td><td>NonNegativeInteger </td></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>.memory[<em>n</em>].size </td><td>The size (in bytes) of the memory region. </td><td>NonNegativeInteger </td></tr> <tr> -<td></td><td></td><td>complexType </td><td>0..* </td></tr> +<td>.memory[<em>n</em>].security </td><td>The <a class="el" href="zoneFormat.html#security">security</a> setting for this memory region. </td><td>SecurityType </td></tr> +<tr> +<td>.memory[<em>n</em>].security.c </td><td>Memory has non-secure callable attribute set. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].security.s </td><td>Memory is access from <em>"secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].security.n </td><td>Memory is access from <em>"non-secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].access </td><td>The <a class="el" href="zoneFormat.html#access">access</a> permissions for this memory region in the following separate fields. </td><td>AccessType </td></tr> +<tr> +<td>.memory[<em>n</em>].access.r </td><td>The <em>read</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].access.w </td><td>The <em>write</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].access.x </td><td>The <em>execution</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].access.p </td><td>The <em>peripheral</em> <a class="el" href="zoneFormat.html#access">access</a> information. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].privilege </td><td>The <a class="el" href="zoneFormat.html#privilege">privilege type</a> settings for this memory region in the following separate fields. </td><td>PrivilegeType </td></tr> +<tr> +<td>.memory[<em>n</em>].privilege.p </td><td>The <em>privileged</em> <em>level</em> setting of <a class="el" href="zoneFormat.html#privilege">privilege type</a>. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].privilege.u </td><td>The <em>unprivileged</em> <em>level</em> setting of <a class="el" href="zoneFormat.html#privilege">privilege type</a>. </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].startup </td><td>"1" specifies that this region is used for the startup code of the application. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].uninit </td><td>"1" specifies that this region is not zero initialized during startup. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].shared </td><td>"1" specifies that this region is used by multiple zones. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].dma </td><td>"1" specifies that this region is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.memory[<em>n</em>].info </td><td>Brief description of the memory region. </td><td>xs:string </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li><li class="navelem"><a class="el" href="format_peripherals.html">/peripherals element</a></li><li class="navelem"><a class="el" href="format_group.html">/group element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_zone.html">zone element</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 diff --git a/docs/Zone/html/fm_mpc_setup.html b/docs/Zone/html/fm_mpc_setup.html new file mode 100644 index 0000000..1a306e1 --- /dev/null +++ b/docs/Zone/html/fm_mpc_setup.html @@ -0,0 +1,149 @@ +<!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>mpc_setup[n] element</title> +<title>CMSIS-Zone (Preview): mpc_setup[n] element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_mpc_setup.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">mpc_setup[n] element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_mpc_setup.html">mpc_setup[n] element</a> contains a sequence of device specific configuration for the setup of the Memory Protection Controller (MPC).</p> +<table class="cmtable" summary="Element: mpc_setup[n]"> +<tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> +<tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>.mpc_setup[<em>n</em>].name </td><td>The name of the base register that controls the MPC. </td><td>xs:string </td></tr> +<tr> +<td>.mpc_setup[<em>n</em>].memory </td><td>The name of the physical memory region that is connected via the MPC. </td><td>xs:string </td></tr> +<tr> +<td>.mpc_setup[<em>n</em>].blk_size </td><td>The block size information that CMSIS-Zone used for LUT generation. </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.mpc_setup[<em>n</em>].S_bit[<em>m</em>] </td><td>A list of bit values for Secure attribute that are used to compose the LUT. </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.mpc_setup[<em>n</em>].P_bit[<em>m</em>] </td><td>A list of bit values for Privileged attribute that are used to compose the LUT. </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.mpc_setup[<em>n</em>].bits_comment[<em>m</em>] </td><td>The memory region information for source code comments that relate to S_bits or P_bits. </td><td>xs:string </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="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_system.html">system element</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> diff --git a/docs/Zone/html/fm_mpu_setup.html b/docs/Zone/html/fm_mpu_setup.html new file mode 100644 index 0000000..42f9e10 --- /dev/null +++ b/docs/Zone/html/fm_mpu_setup.html @@ -0,0 +1,147 @@ +<!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>mpu_setup element</title> +<title>CMSIS-Zone (Preview): mpu_setup element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_mpu_setup.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">mpu_setup element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_mpu_setup.html">mpu_setup element</a> contains the configuration information for the Memory Protection Unit (MPU).</p> +<table class="cmtable" summary="Element: mpu_setup"> +<tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> +<tr> +<td><a class="el" href="fm_system.html">zone</a> </td><td colspan="3"><a class="el" href="fm_zone.html">zone element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>mpu_setup.type </td><td>Implementation of the MPU ("v7M" or "v8M"). </td><td>xs:string </td></tr> +<tr> +<td>mpu_setup.region[<em>n</em>] </td><td>Sequence of MPU region settings. </td><td>sequence </td></tr> +<tr> +<td>mpu_setup.region[<em>n</em>].no </td><td>Number of the region. </td><td>xs:string </td></tr> +<tr> +<td>mpu_setup.region[<em>n</em>].BaseAddress </td><td>The base address of the region. </td><td>xs:string </td></tr> +<tr> +<td>mpu_setup.region[<em>n</em>].RASR </td><td>The MPU region attribute and size register value. </td><td>xs:string </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="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_zone.html">zone element</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> diff --git a/docs/Zone/html/format_pzone.html b/docs/Zone/html/fm_peripheral.html index 049388d..4cd513e 100644 --- a/docs/Zone/html/format_pzone.html +++ b/docs/Zone/html/fm_peripheral.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/pzone element</title> -<title>CMSIS-Zone (Preview): /pzone element</title> +<title>../peripheral[n] element</title> +<title>CMSIS-Zone (Preview): ../peripheral[n] element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_pzone.html','');}); +$(document).ready(function(){initNavTree('fm_peripheral.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,54 +107,63 @@ $(document).ready(function(){initNavTree('format_pzone.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/pzone element </div> </div> +<div class="title">../peripheral[n] element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>pzone</b> element defines a single project zone.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><zones></div> -<div class="line"> <pzone name=<span class="stringliteral">"App"</span> Dname=<span class="stringliteral">"ARM32CM4128x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"SHARED"</span> as=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwu"</span>></div> -<div class="line"> <capture symbol=<span class="stringliteral">".bss.shared"</span>/></div> -<div class="line"> :</div> -<div class="line"> </assign></div> -<div class="line"> <assign name=<span class="stringliteral">"ADC0"</span> access=<span class="stringliteral">"rw"</span> /></div> -<div class="line"> :</div> -<div class="line"> <xzone name=<span class="stringliteral">"process"</span>/></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"></zones></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: PZone"> +<div class="textblock"><p>The <a class="el" href="fm_peripheral.html">../peripheral[n] element</a> contains a sequence of all peripherals that are accessible in the zone (or system partition).</p> +<table class="cmtable" summary="Element: peripheral[n]"> <tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> <tr> -<td><a class="el" href="format_zones.html">zones</a> </td><td colspan="3"><a class="el" href="format_zones.html">/zones element</a> </td></tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="2"><a class="el" href="fm_system.html">system element</a> </td></tr> <tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<td><a class="el" href="fm_zone.html">zone</a> </td><td colspan="2"><a class="el" href="fm_zone.html">zone element</a> </td></tr> <tr> -<td>name </td><td>The unique name for this project zone. </td><td>xs:string </td><td>required </td></tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> <tr> -<td>Dname </td><td>The name of the device this project zone is assigned to. </td><td>xs:string </td><td>required </td></tr> +<td>.peripheral[<em>n</em>].name </td><td>The name of the peripheral. </td><td>xs:string </td></tr> <tr> -<td>Pname </td><td>The name of the processor (on the device) this project is assigned to. </td><td>xs:string </td><td>required </td></tr> +<td>.peripheral[<em>n</em>].group </td><td>The name of the peripheral group that this peripheral belongs too. </td><td>xs:string </td></tr> <tr> -<td>info </td><td>Brief description of the project zone. </td><td>xs:string </td><td>optional </td></tr> +<td>.peripheral[<em>n</em>].start </td><td>The logical start address of the peripheral in the address map. </td><td>NonNegativeInteger </td></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>.peripheral[<em>n</em>].size </td><td>The size (in bytes) of the peripheral. </td><td>NonNegativeInteger </td></tr> <tr> -<td><a class="el" href="format_assign.html">/assign element</a> </td><td>Resource Assignments </td><td>complexType </td><td>0..* </td></tr> +<td>.peripheral[<em>n</em>].security </td><td>The <a class="el" href="zoneFormat.html#security">security</a> setting for this peripheral. </td><td>SecurityType </td></tr> <tr> -<td><a class="el" href="format_xzone.html">/xzone element</a> </td><td>Execution Zones </td><td>complexType </td><td>0..* </td></tr> +<td>.peripheral[<em>n</em>].security.s </td><td>Peripheral is assigned to <em>"secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].security.n </td><td>Peripheral is assigned to <em>"non-secure"</em> state. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].access </td><td>The <a class="el" href="zoneFormat.html#access">access</a> permissions for this peripheral in the following separate fields. </td><td>AccessType </td></tr> +<tr> +<td>.peripheral[<em>n</em>].access.r </td><td>The <em>read</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].access.w </td><td>The <em>write</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].access.x </td><td>The <em>execution</em> <a class="el" href="zoneFormat.html#access">access</a> permission. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].access.p </td><td>The <em>peripheral</em> <a class="el" href="zoneFormat.html#access">access</a> information. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].privilege </td><td>The <a class="el" href="zoneFormat.html#privilege">privilege type</a> settings for this peripheral in the following separate fields. </td><td>PrivilegeType </td></tr> +<tr> +<td>.peripheral[<em>n</em>].privilege.p </td><td>The <em>privileged</em> <em>level</em> setting of <a class="el" href="zoneFormat.html#privilege">privilege type</a>. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].privilege.u </td><td>The <em>unprivileged</em> <em>level</em> setting of <a class="el" href="zoneFormat.html#privilege">privilege type</a>. </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].shared </td><td>"1" specifies that this peripheral is used by multiple zones. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].dma </td><td>"1" specifies that this peripheral is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td></tr> +<tr> +<td>.peripheral[<em>n</em>].info </td><td>Brief description of the peripheral region. </td><td>xs:string </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_zones.html">/zones element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_zone.html">zone element</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 diff --git a/docs/Zone/html/fm_processor.html b/docs/Zone/html/fm_processor.html new file mode 100644 index 0000000..52abdf6 --- /dev/null +++ b/docs/Zone/html/fm_processor.html @@ -0,0 +1,143 @@ +<!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>processor[n] sequence element</title> +<title>CMSIS-Zone (Preview): processor[n] sequence element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_processor.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">processor[n] sequence element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_processor.html">processor[n] sequence element</a> provides a sequence of processor elements that are in the system.</p> +<table class="cmtable" summary="Element: processor[n]"> +<tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> +<tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>.processor[<em>n</em>].Pname </td><td>Name of the processor core. </td><td>RestrictedString </td></tr> +<tr> +<td>.processor[<em>n</em>].DnumInterrupts </td><td>Number of NVIC interrupts sources available to the processor core (excludes exception vectors). </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.processor[<em>n</em>].DnumSauRegions </td><td>Number of regions in the Security Attribution Unit (SAU) of the processor core. </td><td>NonNegativeInteger </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="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_system.html">system element</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> diff --git a/docs/Zone/html/fm_reg_setup.html b/docs/Zone/html/fm_reg_setup.html new file mode 100644 index 0000000..e98ade6 --- /dev/null +++ b/docs/Zone/html/fm_reg_setup.html @@ -0,0 +1,145 @@ +<!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>reg_setup[n] element</title> +<title>CMSIS-Zone (Preview): reg_setup[n] element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_reg_setup.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">reg_setup[n] element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_reg_setup.html">reg_setup[n] element</a> contains a sequence of device specific configuration for the setup of the interrupts.</p> +<table class="cmtable" summary="Element: reg_setup[n]"> +<tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> +<tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>.reg_setup[<em>n</em>].name </td><td>The name of the register or array that holds the configuration information. </td><td>xs:string </td></tr> +<tr> +<td>.reg_setup[<em>n</em>].index </td><td>The index value for the register array. </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.reg_setup[<em>n</em>].value[<em>m</em>] </td><td>An array with register setup values (corresponds to .peripheral[<em>m</em>] below. </td><td>NonNegativeInteger </td></tr> +<tr> +<td>.reg_setup[<em>n</em>].peripheral[<em>m</em>] </td><td>An array with the peripheral names that setup belongs too. </td><td>xs:string </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="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_system.html">system element</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> diff --git a/docs/Zone/html/fm_sau.html b/docs/Zone/html/fm_sau.html new file mode 100644 index 0000000..56eeaa6 --- /dev/null +++ b/docs/Zone/html/fm_sau.html @@ -0,0 +1,151 @@ +<!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>sau[n] sequence element</title> +<title>CMSIS-Zone (Preview): sau[n] sequence element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_sau.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">sau[n] sequence element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_sau.html">sau[n] sequence element</a> lists all SAU regions for initialization in this system.</p> +<p>It lists all SAU regions that require either non-secure access or non-secure callable attribute. The SAU region list is generated from:</p> +<ul> +<li>setup information from <a class="el" href="xml_sau_init.html#xml_si_region">/rzone/sau_init/region element</a></li> +<li>memory regions that are assigned to zones with non-secure domain.</li> +<li>memory regions that are configured as secure, non-secure callable.</li> +</ul> +<table class="cmtable" summary="Element: sau[n]"> +<tr> +<th>Parent Element </th><th colspan="2">Element Chain </th></tr> +<tr> +<td><a class="el" href="fm_system.html">system</a> </td><td colspan="3"><a class="el" href="fm_system.html">system element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>.sau[<em>n</em>].start </td><td>The logical start address for the region. </td><td>xs:string </td></tr> +<tr> +<td>.sau[<em>n</em>].end </td><td>The logical end address for the region. </td><td>xs:string </td></tr> +<tr> +<td>.sau[<em>n</em>].nsc </td><td>If set to 1 the region is secure, non-secure callable. </td><td>SecurityTypeEnum/xs:string </td></tr> +<tr> +<td>.sau[<em>n</em>].info </td><td>List of memory regions or info from <a class="el" href="xml_sau_init.html#xml_si_region">/rzone/sau_init/region element</a>. </td><td>xs:string </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="GenDataModel.html">Generator Data Model</a></li><li class="navelem"><a class="el" href="fm_system.html">system element</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> diff --git a/docs/Zone/html/fm_system.html b/docs/Zone/html/fm_system.html new file mode 100644 index 0000000..b9c853b --- /dev/null +++ b/docs/Zone/html/fm_system.html @@ -0,0 +1,147 @@ +<!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>system element</title> +<title>CMSIS-Zone (Preview): system element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_system.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">system element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_system.html">system element</a> provides the memory layout and the TrustZone configuration of the complete system. This information can be used for example, to create a linker script that defines the memory setup of the SoC system.</p> +<table class="cmtable" summary="Element: system"> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td><a class="el" href="fm_processor.html">.processor</a> </td><td>A sequence of all processor elements available in the system resource file. </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_memory.html">.memory</a> </td><td>A sequence of all memory regions available in the system resource file. </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_peripheral.html">.peripheral</a> </td><td>A sequence of all peripherals available in the system resource file. </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_sau.html">.sau</a> </td><td>A sequence of all SAU regions for initialization. </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_interrupt.html">.interrupt</a> </td><td>A sequence of all interrupt sources available. </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_mpc_setup.html">.mpc_setup</a> </td><td>Contains the device specific configuration registers for the setup of the Memory Protection Controller (MPC). </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_reg_setup.html">.reg_setup</a> </td><td>Contains the device specific configuration registers for the setup of the peripherals. </td><td>sequence </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="GenDataModel.html">Generator Data Model</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> diff --git a/docs/Zone/html/fm_system.js b/docs/Zone/html/fm_system.js new file mode 100644 index 0000000..16fb3ef --- /dev/null +++ b/docs/Zone/html/fm_system.js @@ -0,0 +1,10 @@ +var fm_system = +[ + [ "processor[n] sequence element", "fm_processor.html", null ], + [ "../memory[n] sequence element", "fm_memory.html", null ], + [ "../peripheral[n] element", "fm_peripheral.html", null ], + [ "sau[n] sequence element", "fm_sau.html", null ], + [ "interrupt[n] sequence element", "fm_interrupt.html", null ], + [ "mpc_setup[n] element", "fm_mpc_setup.html", null ], + [ "reg_setup[n] element", "fm_reg_setup.html", null ] +];
\ No newline at end of file diff --git a/docs/Zone/html/fm_zone.html b/docs/Zone/html/fm_zone.html new file mode 100644 index 0000000..d9d30bb --- /dev/null +++ b/docs/Zone/html/fm_zone.html @@ -0,0 +1,141 @@ +<!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>zone element</title> +<title>CMSIS-Zone (Preview): zone element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('fm_zone.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">zone element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="fm_zone.html">zone element</a> provides the setup information of a zone (or system partition) along with related peripherals. This information can be used for example, to create the MPU setup that is required for various execution zones along with the related linker setup.</p> +<table class="cmtable" summary="Element: zone"> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th></tr> +<tr> +<td>.name </td><td>The name of the zone (or system partition). </td><td>string </td></tr> +<tr> +<td><a class="el" href="fm_memory.html">.memory</a> </td><td>A sequence of all memory regions that are accessible in the zone (or system partition). </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_peripheral.html">.peripheral</a> </td><td>A sequence of all peripherals that are accessible in the zone (or system partition). </td><td>sequence </td></tr> +<tr> +<td><a class="el" href="fm_mpu_setup.html">.mpu_setup</a> </td><td>A sequence of configuration information for the Memory Protection Unit (MPU). </td><td>sequence </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="GenDataModel.html">Generator Data Model</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> diff --git a/docs/Zone/html/fm_zone.js b/docs/Zone/html/fm_zone.js new file mode 100644 index 0000000..422aebd --- /dev/null +++ b/docs/Zone/html/fm_zone.js @@ -0,0 +1,6 @@ +var fm_zone = +[ + [ "../memory[n] sequence element", "fm_memory.html", null ], + [ "../peripheral[n] element", "fm_peripheral.html", null ], + [ "mpu_setup element", "fm_mpu_setup.html", null ] +];
\ No newline at end of file diff --git a/docs/Zone/html/format_assign.html b/docs/Zone/html/format_assign.html deleted file mode 100644 index 99e1e99..0000000 --- a/docs/Zone/html/format_assign.html +++ /dev/null @@ -1,163 +0,0 @@ -<!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>/assign element</title> -<title>CMSIS-Zone (Preview): /assign element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_assign.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/assign element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>assign</b> element defines the resources used by a zone.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><zones></div> -<div class="line"> <pzone name=<span class="stringliteral">"App"</span> Dname=<span class="stringliteral">"ARM32CM4128x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"SHARED"</span> as=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwu"</span>></div> -<div class="line"> <capture symbol=<span class="stringliteral">".bss.shared"</span>/></div> -<div class="line"> <capture symbol=<span class="stringliteral">".data.shared"</span>/></div> -<div class="line"> :</div> -<div class="line"> </assign></div> -<div class="line"> <assign name=<span class="stringliteral">"ADC0"</span> access=<span class="stringliteral">"rw"</span> /></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"></zones></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Assign"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_pzone.html">pzone</a> </td><td colspan="3"><a class="el" href="format_pzone.html">/pzone element</a> </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>name </td><td>The name of a resource (mapped to the processor) to be used by this zone. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>as </td><td>The name of the mapping (alias) to be used to address the referenced resource. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>access </td><td>Additional access attributes to be used. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>info </td><td>Brief description of the resource assignment. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_capture.html">/capture element</a> </td><td>Linker usage </td><td>complexType </td><td>0..* </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_zones.html">/zones element</a></li><li class="navelem"><a class="el" href="format_pzone.html">/pzone element</a></li><li class="navelem"><a class="el" href="format_xzone.html">/xzone element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_assign.js b/docs/Zone/html/format_assign.js deleted file mode 100644 index cbda2c2..0000000 --- a/docs/Zone/html/format_assign.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_assign = -[ - [ "/capture element", "format_capture.html", null ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_block.html b/docs/Zone/html/format_block.html deleted file mode 100644 index 727098f..0000000 --- a/docs/Zone/html/format_block.html +++ /dev/null @@ -1,162 +0,0 @@ -<!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>/block element</title> -<title>CMSIS-Zone (Preview): /block element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_block.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/block element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>block</b> element is used to subdived a physical <a class="el" href="format_memory.html">memory region</a> into segregated logical blocks.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 512KB SRAM integrated on the SoC --></div> -<div class="line"> <region name=<span class="stringliteral">"SRAM"</span> size=<span class="stringliteral">"0x80000"</span> access=<span class="stringliteral">"rwx"</span> info=<span class="stringliteral">"Internal SRAM (512KB)"</span>></div> -<div class="line"> <block name=<span class="stringliteral">"SHARED"</span> offset=<span class="stringliteral">"0x00000"</span> size=<span class="stringliteral">"0x08000"</span> access=<span class="stringliteral">"rwu"</span> info=<span class="stringliteral">"Shared memory area for inter process communication."</span>/></div> -<div class="line"> :</div> -<div class="line"> </region></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> :</div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Block"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_region.html">region</a> </td><td colspan="3"><a class="el" href="format_region.html">/region element</a> </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>name </td><td>The name this memory block can be referenced by. Must be unique within a single device. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>size </td><td>The physical memory size this block allocates. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>access </td><td>The access attributes for this memory block. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>info </td><td>Brief description of the memory block. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_block.html">/block element</a> </td><td>Memory block definitions. </td><td>complexType </td><td>0..* </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li><li class="navelem"><a class="el" href="format_memory.html">/memory element</a></li><li class="navelem"><a class="el" href="format_region.html">/region element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_device.js b/docs/Zone/html/format_device.js deleted file mode 100644 index e030644..0000000 --- a/docs/Zone/html/format_device.js +++ /dev/null @@ -1,7 +0,0 @@ -var format_device = -[ - [ "/package element", "format_package.html", null ], - [ "/processor element", "format_processor.html", "format_processor" ], - [ "/resources element", "format_resources.html", "format_resources" ], - [ "/memory_map element", "format_memory_map.html", "format_memory_map" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_group.html b/docs/Zone/html/format_group.html deleted file mode 100644 index 445afb5..0000000 --- a/docs/Zone/html/format_group.html +++ /dev/null @@ -1,163 +0,0 @@ -<!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>/group element</title> -<title>CMSIS-Zone (Preview): /group element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_group.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/group element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>group</b> element can be used to logically group peripherals together, e.g. according to functionality or bus topology.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> :</div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Analog/Digital Converter 0 (12-bit)"</span>/></div> -<div class="line"> :</div> -<div class="line"> <group name=<span class="stringliteral">"USART"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter"</span>></div> -<div class="line"> <peripheral name=<span class="stringliteral">"UART0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal asynchronous receiver/transmitter 0"</span>/></div> -<div class="line"> <peripheral name=<span class="stringliteral">"USART1"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter 1"</span>/></div> -<div class="line"> :</div> -<div class="line"> </group></div> -<div class="line"> </peripherals></div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Group"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_peripherals.html">peripherals</a> </td><td colspan="3"><a class="el" href="format_peripherals.html">/peripherals element</a> </td></tr> -<tr> -<td><a class="el" href="format_group.html">group</a> </td><td colspan="3"><a class="el" href="format_group.html">/group element</a> </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>name </td><td>The name for the peripheral group. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>info </td><td>Brief description of the peripheral group. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_group.html">/group element</a> </td><td>Logical grouping of peripherals. </td><td>complexType </td><td>0..* </td></tr> -<tr> -<td><a class="el" href="format_peripheral.html">/peripheral element</a> </td><td>Peripheral definitions. </td><td>complexType </td><td>0..* </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li><li class="navelem"><a class="el" href="format_peripherals.html">/peripherals element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_group.js b/docs/Zone/html/format_group.js deleted file mode 100644 index 87d9b21..0000000 --- a/docs/Zone/html/format_group.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_group = -[ - [ "/peripheral element", "format_peripheral.html", null ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_map_memory.html b/docs/Zone/html/format_map_memory.html deleted file mode 100644 index 699b69f..0000000 --- a/docs/Zone/html/format_map_memory.html +++ /dev/null @@ -1,161 +0,0 @@ -<!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>/memory element</title> -<title>CMSIS-Zone (Preview): /memory element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_map_memory.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/memory element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>memory</b> element is used to define an address mapping for one <a class="el" href="format_region.html">memory/region</a>.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><memory_map></div> -<div class="line"> <!-- Logical address to access integrated SRAM --></div> -<div class="line"> <memory name=<span class="stringliteral">"SRAM"</span> start=<span class="stringliteral">"0x10000000"</span>/></div> -<div class="line"></div> -<div class="line"> <!-- Logical address alias to access integrated SRAM --></div> -<div class="line"> <memory name=<span class="stringliteral">"CODE_SRAM"</span> alias=<span class="stringliteral">"SRAM"</span> start=<span class="stringliteral">"0x00000000"</span>/></div> -<div class="line"> :</div> -<div class="line"></memory_map></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Memory"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_memory_map.html">memory_map</a> </td><td colspan="3"><a class="el" href="format_memory_map.html">/memory_map element</a> </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>name </td><td>The name this address mapping can be referenced by. Must be unique within a single processors memory map. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>alias </td><td>Reference to the (physical) memory region mapped. If the alias is ommitted the name is used. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>start </td><td>The logical start address the memory region is accessible at. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>size </td><td>The amount of memory that is accessible. If ommitted the size is taken over from the memory region. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<td>info </td><td>Brief description of the memory mapping. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td></td><td></td><td>complexType </td><td>0..1 </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_processor.html">/processor element</a></li><li class="navelem"><a class="el" href="format_memory_map.html">/memory_map element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_memory.js b/docs/Zone/html/format_memory.js deleted file mode 100644 index b0057f4..0000000 --- a/docs/Zone/html/format_memory.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_memory = -[ - [ "/region element", "format_region.html", "format_region" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_memory_map.js b/docs/Zone/html/format_memory_map.js deleted file mode 100644 index aba48cc..0000000 --- a/docs/Zone/html/format_memory_map.js +++ /dev/null @@ -1,5 +0,0 @@ -var format_memory_map = -[ - [ "/memory element", "format_map_memory.html", null ], - [ "/peripheral element", "format_map_peripheral.html", null ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_peripherals.html b/docs/Zone/html/format_peripherals.html deleted file mode 100644 index 3e32996..0000000 --- a/docs/Zone/html/format_peripherals.html +++ /dev/null @@ -1,155 +0,0 @@ -<!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>/peripherals element</title> -<title>CMSIS-Zone (Preview): /peripherals element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_peripherals.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/peripherals element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>peripherals</b> element groups all physical peripheral definitions.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> :</div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Analog/Digital Converter 0 (12-bit)"</span>/></div> -<div class="line"> :</div> -<div class="line"> <group name=<span class="stringliteral">"USART"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter"</span>></div> -<div class="line"> <peripheral name=<span class="stringliteral">"UART0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal asynchronous receiver/transmitter 0"</span>/></div> -<div class="line"> <peripheral name=<span class="stringliteral">"USART1"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Universal synchronous/asynchronous receiver/transmitter 1"</span>/></div> -<div class="line"> :</div> -<div class="line"> </group></div> -<div class="line"> </peripherals></div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Peripherals"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_resources.html">resources</a> </td><td colspan="3"><a class="el" href="format_resources.html">/resources element</a> </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_group.html">/group element</a> </td><td>Logical grouping of peripherals. </td><td>complexType </td><td>0..* </td></tr> -<tr> -<td><a class="el" href="format_peripheral.html">/peripheral element</a> </td><td>Peripheral definitions. </td><td>complexType </td><td>0..* </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_peripherals.js b/docs/Zone/html/format_peripherals.js deleted file mode 100644 index ff09d87..0000000 --- a/docs/Zone/html/format_peripherals.js +++ /dev/null @@ -1,5 +0,0 @@ -var format_peripherals = -[ - [ "/group element", "format_group.html", "format_group" ], - [ "/peripheral element", "format_peripheral.html", null ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_processor.js b/docs/Zone/html/format_processor.js deleted file mode 100644 index dac7317..0000000 --- a/docs/Zone/html/format_processor.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_processor = -[ - [ "/memory_map element", "format_memory_map.html", "format_memory_map" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_pzone.js b/docs/Zone/html/format_pzone.js deleted file mode 100644 index ac178ac..0000000 --- a/docs/Zone/html/format_pzone.js +++ /dev/null @@ -1,5 +0,0 @@ -var format_pzone = -[ - [ "/assign element", "format_assign.html", "format_assign" ], - [ "/xzone element", "format_xzone.html", "format_xzone" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_region.js b/docs/Zone/html/format_region.js deleted file mode 100644 index 7e215fd..0000000 --- a/docs/Zone/html/format_region.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_region = -[ - [ "/block element", "format_block.html", null ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_resources.html b/docs/Zone/html/format_resources.html deleted file mode 100644 index ed60721..0000000 --- a/docs/Zone/html/format_resources.html +++ /dev/null @@ -1,158 +0,0 @@ -<!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>/resources element</title> -<title>CMSIS-Zone (Preview): /resources element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_resources.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/resources element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>resources</b> element groups physical memory and peripheral definitions.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 512KB SRAM integrated on the SoC --></div> -<div class="line"> <region name=<span class="stringliteral">"SRAM"</span> size=<span class="stringliteral">"0x80000"</span> access=<span class="stringliteral">"rwx"</span> info=<span class="stringliteral">"Internal SRAM (512KB)"</span>/></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> <peripherals></div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rw"</span> info=<span class="stringliteral">"Analog/Digital Converter 0 (12-bit)"</span>/></div> -<div class="line"> :</div> -<div class="line"> </peripherals></div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Resources"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_system.html">system</a> </td><td colspan="3"><a class="el" href="format_system.html">/system element</a> </td></tr> -<tr> -<td><a class="el" href="format_device.html">device</a> </td><td colspan="3"><a class="el" href="format_device.html">/device element</a> </td></tr> -<tr> -<td><a class="el" href="format_processor.html">processor</a> </td><td colspan="3"><a class="el" href="format_processor.html">/processor element</a> </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_memory.html">/memory element</a> </td><td>Group with all memory region definitions. </td><td>complexType </td><td>0..1 </td></tr> -<tr> -<td><a class="el" href="format_peripherals.html">/peripherals element</a> </td><td>Group with all peripheral definitions. </td><td>complexType </td><td>0..1 </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_resources.js b/docs/Zone/html/format_resources.js deleted file mode 100644 index c99084c..0000000 --- a/docs/Zone/html/format_resources.js +++ /dev/null @@ -1,5 +0,0 @@ -var format_resources = -[ - [ "/memory element", "format_memory.html", "format_memory" ], - [ "/peripherals element", "format_peripherals.html", "format_peripherals" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_system.html b/docs/Zone/html/format_system.html deleted file mode 100644 index b957d10..0000000 --- a/docs/Zone/html/format_system.html +++ /dev/null @@ -1,177 +0,0 @@ -<!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>/system element</title> -<title>CMSIS-Zone (Preview): /system element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_system.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/system element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>system</b> element is the root element of a CMSIS-Zone system definition.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><?xml version=<span class="stringliteral">"1.0"</span> encoding=<span class="stringliteral">"UTF-8"</span> standalone=<span class="stringliteral">"no"</span>?></div> -<div class="line"><system xmlns:xs=<span class="stringliteral">"http://www.w3.org/2001/XMLSchema-instance"</span>></div> -<div class="line"> <!-- Arm SoC with Cortex-M4 processor --></div> -<div class="line"> <device Dname=<span class="stringliteral">"ARM32CM4128x"</span>></div> -<div class="line"> <processor Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> :</div> -<div class="line"> </processor></div> -<div class="line"> :</div> -<div class="line"> </device></div> -<div class="line"> </div> -<div class="line"> <resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 16MB external Flash memory, e.g. attached to the SoC <span class="keyword">using</span> a memory <span class="keyword">interface </span>--></div> -<div class="line"> <region name=<span class="stringliteral">"EXT_FLASH"</span> size=<span class="stringliteral">"0x1000000"</span> access=<span class="stringliteral">"rx"</span> info=<span class="stringliteral">"External Flash (16MB)"</span>/></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> </resources></div> -<div class="line"> </div> -<div class="line"> <zones></div> -<div class="line"> <!-- Project Zone <span class="keywordflow">for</span> Application running on the previously defined ARM SoC --></div> -<div class="line"> <pzone name=<span class="stringliteral">"Application"</span> Dname=<span class="stringliteral">"ARM32CM412x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"> </zones></div> -<div class="line"></system></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Root Element: System"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td>root </td><td colspan="3">Document root </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>xmlns:xs </td><td>Is set to: <span class="XML-Token">"http://www.w3.org/2001/XMLSchema-instance"</span> to indicate compliance to the XML format. </td><td>xs:decimal </td><td>required </td></tr> -<tr> -<td>xs:noNamespaceSchemaLocation </td><td>Path and file name of the XML Schema Definition (XSD). </td><td>xs:string </td><td>required </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_device.html">device</a> </td><td>Specifies available microcontroller devices (i.e. SoCs) that are part of the system. Typically a system contains only a single SoC device. </td><td>complexType </td><td>1..* </td></tr> -<tr> -<td><a class="el" href="format_resources.html">resources</a> </td><td>Specifies the resources (i.e. memory and peripherals) on system level, i.e. those not integral part of an SoC device. Resources defined on system level may be specified as shared between multiple SoCs. </td><td>complexType </td><td>0..1 </td></tr> -<tr> -<td><a class="el" href="format_zones.html">zones</a> </td><td>Specifies the system partitioning in terms of project and execution zones. </td><td>complexType </td><td>0..1 </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="XML_Format.html">Zone Description Format</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_system.js b/docs/Zone/html/format_system.js deleted file mode 100644 index 530c764..0000000 --- a/docs/Zone/html/format_system.js +++ /dev/null @@ -1,6 +0,0 @@ -var format_system = -[ - [ "/device element", "format_device.html", "format_device" ], - [ "/resources element", "format_resources.html", "format_resources" ], - [ "/zones element", "format_zones.html", "format_zones" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_xzone.html b/docs/Zone/html/format_xzone.html deleted file mode 100644 index 667463c..0000000 --- a/docs/Zone/html/format_xzone.html +++ /dev/null @@ -1,159 +0,0 @@ -<!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>/xzone element</title> -<title>CMSIS-Zone (Preview): /xzone element</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) -  <span id="projectnumber">Version 0.0.1</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 Page</span></a></li> - <li class="current"><a href="pages.html"><span>Usage and 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('format_xzone.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/xzone element </div> </div> -</div><!--header--> -<div class="contents"> -<div class="textblock"><p>The <b>xzone</b> element defines an execution zone, i.e. a process grouping threads sharing common resource access attributes.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><zones></div> -<div class="line"> <pzone name=<span class="stringliteral">"App"</span> Dname=<span class="stringliteral">"ARM32CM4128x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"SHARED"</span> as=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwu"</span>/></div> -<div class="line"> <assign name=<span class="stringliteral">"ADC0"</span> access=<span class="stringliteral">"rw"</span> /></div> -<div class="line"> :</div> -<div class="line"> <xzone name=<span class="stringliteral">"process"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"ADC0"</span> access=<span class="stringliteral">"rwu"</span>/></div> -<div class="line"> </xzone></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"></zones></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: XZone"> -<tr> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> -<tr> -<td><a class="el" href="format_pzone.html">pzone</a> </td><td colspan="3"><a class="el" href="format_pzone.html">/pzone element</a> </td></tr> -<tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> -<tr> -<td>name </td><td>The name of a resource (mapped to the processor) to be used by this zone. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>info </td><td>Brief description of the resource assignment. </td><td>xs:string </td><td>optional </td></tr> -<tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> -<tr> -<td><a class="el" href="format_assign.html">/assign element</a> </td><td>Resource assignments </td><td>complexType </td><td>0..* </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_zones.html">/zones element</a></li><li class="navelem"><a class="el" href="format_pzone.html">/pzone element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) 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> diff --git a/docs/Zone/html/format_xzone.js b/docs/Zone/html/format_xzone.js deleted file mode 100644 index f5fcc90..0000000 --- a/docs/Zone/html/format_xzone.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_xzone = -[ - [ "/assign element", "format_assign.html", "format_assign" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/format_zones.js b/docs/Zone/html/format_zones.js deleted file mode 100644 index bd596f9..0000000 --- a/docs/Zone/html/format_zones.js +++ /dev/null @@ -1,4 +0,0 @@ -var format_zones = -[ - [ "/pzone element", "format_pzone.html", "format_pzone" ] -];
\ No newline at end of file diff --git a/docs/Zone/html/gen_output.png b/docs/Zone/html/gen_output.png Binary files differnew file mode 100644 index 0000000..26c3236 --- /dev/null +++ b/docs/Zone/html/gen_output.png diff --git a/docs/Zone/html/genmodel.png b/docs/Zone/html/genmodel.png Binary files differdeleted file mode 100644 index c2596eb..0000000 --- a/docs/Zone/html/genmodel.png +++ /dev/null diff --git a/docs/Zone/html/gpio_pins_config.png b/docs/Zone/html/gpio_pins_config.png Binary files differnew file mode 100644 index 0000000..dc0f0da --- /dev/null +++ b/docs/Zone/html/gpio_pins_config.png diff --git a/docs/Zone/html/hello_world_output.png b/docs/Zone/html/hello_world_output.png Binary files differnew file mode 100644 index 0000000..5d17d96 --- /dev/null +++ b/docs/Zone/html/hello_world_output.png diff --git a/docs/Zone/html/hello_world_proj_window.png b/docs/Zone/html/hello_world_proj_window.png Binary files differnew file mode 100644 index 0000000..6463012 --- /dev/null +++ b/docs/Zone/html/hello_world_proj_window.png diff --git a/docs/Zone/html/import_from_file.png b/docs/Zone/html/import_from_file.png Binary files differnew file mode 100644 index 0000000..4f8a4f0 --- /dev/null +++ b/docs/Zone/html/import_from_file.png diff --git a/docs/Zone/html/import_projects.png b/docs/Zone/html/import_projects.png Binary files differnew file mode 100644 index 0000000..daa60aa --- /dev/null +++ b/docs/Zone/html/import_projects.png diff --git a/docs/Zone/html/index.html b/docs/Zone/html/index.html index 1e1f3f7..8ae2b35 100644 --- a/docs/Zone/html/index.html +++ b/docs/Zone/html/index.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -110,60 +110,44 @@ $(document).ready(function(){initNavTree('index.html','');}); <div class="title">CMSIS-Zone (Preview) Documentation</div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>This is a preview of <b>CMSIS-Zone</b> which is scheduled for release in Q1'2018. The final release of CMSIS-Zone will provide:</p> +<div class="textblock"><p><b>CMSIS-Zone</b> defines methods to describe system resources and to partition these resources into multiple projects and execution areas. The system resources may include multiple processors, memory areas, peripherals and related interrupts. The system resources and partition assignments are stored in <a class="el" href="zoneFormat.html">Zone Description Format</a> (XML based).</p> +<p><b>CMSIS-Zone</b> includes a utility that manages these XML files. This utility:</p> <ul> -<li><a class="el" href="XML_Format.html">Zone Description Format</a> (XML based) which stores consistent system setup information.</li> -<li>CMSIS-Zone configuration utility for system partitioning. The <a class="el" href="GenDataModel.html">data</a> captured can be exported to various project and configuration files using file templates.</li> +<li>displays all available system resources including memory and peripherals</li> +<li>allows to partition memory and assign resources to sub-systems.</li> +<li>supports the setup of secure, non-secure, and MPU protected execution zones with assignment of memory, peripherals, and interrupts.</li> +<li>provides a data model for generation of configuration files for tool and hardware setup.</li> </ul> -<p><b>CMSIS-Zone</b> defines methods to describe system resources and to partition these resources into multiple projects and execution areas. The system resources may include multiple processors, memory areas, and peripherals. The system resource and partitioning information is stored in <a class="el" href="XML_Format.html">Zone Description Format</a> (XML based).</p> -<p><b>CMSIS-Zone</b> includes an interactive tool that manages files in the <a class="el" href="XML_Format.html">Zone Description Format</a> which allows to:</p> -<ul> -<li>create system resource information from existing CMSIS-SVD and CMSIS-Pack descriptions.</li> -<li>partition system resources into various project zones.</li> -<li>partition a project zone into multiple execution zones.</li> -<li>generate various configuration files for tool set-up and hardware initialization.</li> -</ul> -<p>The following diagram explains the development flow when using the <b>CMSIS-Zone</b> management tool.</p> +<p>The following diagram explains the development work flow when using the <b>CMSIS-Zone</b> management tool.</p> <div class="image"> -<img src="DevelopmentFlow.png" alt="DevelopmentFlow.png"/> +<img src="Partitioning_Workflow.png" alt="Partitioning_Workflow.png"/> <div class="caption"> -CMSIS-Zone Development Flow</div></div> -<p> The following sections explain:</p> +CMSIS-Zone development workflow</div></div> +<p> The CMSIS-Zone utility reads a <a class="el" href="zoneFormat.html#rzone">.rzone</a> file that defines the overall system resources of an SoC system. An interactive GUI supports the system partitioning. The assignments of the various partitions (also called zones) saved in the <a class="el" href="zoneFormat.html#azone">.azone</a> file.</p> +<p>The combined information of resources and assignments can be exported to multiple <a class="el" href="zoneFormat.html#rzone">.rzone</a> files that represent a sub-system. By using file templates the CMSIS-Zone utility can create tool or hardware configuration files.</p> +<p>It is possible to uses these steps multiple times which allows to split a complex SoC design with multiple processors into smaller sub-systems. For example a multi-core device can be partitioned in steps:</p> <ul> -<li><a class="el" href="XML_Format.html">Zone Description Format</a> (XML based) that stores system resource information and the configuration of project zones and execution zones.</li> -<li><a class="el" href="GenDataModel.html">Generator Data Model</a> which is used to create tool set-up files and hardware configuration files.</li> +<li>Step 1: split the multi-processor system into single processor sub-systems.</li> +<li>Step 2: create the partitions for secure and non-secure execution.</li> +<li>Step 3: configure MPU protected execution zones.</li> </ul> -<h1><a class="anchor" id="UseCases"></a> -CMSIS-Zone Use Cases</h1> -<p><b>CMSIS-Zone</b> simplifies to manage the complexity and the configuration of modern embedded systems that frequently include multiple processors and/or memory protection hardware. It helps to split the embedded application various projects which creates the need to partition system resources. And it simplifies the consistent configuration of access rights across the system, for example when using an MPU (memory protection unit).</p> -<p>The following section describes several uses cases that benefit from <b>CMSIS-Zone</b>.</p> -<h2><a class="anchor" id="UseCase_MPU"></a> -MPU Protection</h2> -<p>Focused on a single core microcontroller one might want to utilize the memory protection unit (MPU) capabilities to segregate parts of an application. Thus the need to partition the system resources accordingly arises.</p> -<div class="image"> -<img src="mpu.png" alt="mpu.png"/> -<div class="caption"> -MPU Protection</div></div> - <h2><a class="anchor" id="UseCase_TrustZone"></a> -TrustZone Partitioning</h2> -<p>TrustZone extensions add another degree of segregation which must be handled consistently. In this case one has to handle MPU settings per security context and SAU configuration.</p> +<p>The following SoC diagram exemplifies step 1 and step 2 of this workflow.</p> <div class="image"> -<img src="trustzone.png" alt="trustzone.png"/> +<img src="Partitioning_Hardware.png" alt="Partitioning_Hardware.png"/> <div class="caption"> -TrustZone Partitioning and MPU Protection</div></div> - <h2><a class="anchor" id="UseCase_MultiCore"></a> -Multi-Core Partitioning</h2> -<p>Beside traditional single cores asymetric and hybrid multi-core devices contribute to increasing development complexity for embedded systems. Having multiple cores running different parts of an application concurrently needs a well defined resource assignment to prevent undesired misbehaviour.</p> -<div class="image"> -<img src="multicore.png" alt="multicore.png"/> -<div class="caption"> -Multi-Core Partitioning</div></div> +Hardware partitioning in multiple steps</div></div> +<p>The following sections explain:</p> +<ul> +<li><a class="el" href="zoneToolUsage.html">CMSIS-Zone Utility</a> shows hot to use the CMSIS-Zone stand-alone tool to generate the relevant project information to be used in integrated development environments (IDEs).</li> +<li><a class="el" href="zoneFormat.html">Zone Description Format</a> (XML based) that stores system resource information and the configuration of project zones and execution zones.</li> +<li><a class="el" href="GenDataModel.html">Generator Data Model</a> which is used to create tool set-up files and hardware configuration files. </li> +</ul> </div></div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <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 diff --git a/docs/Zone/html/lpc55_resource_map.png b/docs/Zone/html/lpc55_resource_map.png Binary files differnew file mode 100644 index 0000000..4d16faa --- /dev/null +++ b/docs/Zone/html/lpc55_resource_map.png diff --git a/docs/Zone/html/lpc55_system_startup.png b/docs/Zone/html/lpc55_system_startup.png Binary files differnew file mode 100644 index 0000000..c9c05d1 --- /dev/null +++ b/docs/Zone/html/lpc55_system_startup.png diff --git a/docs/Zone/html/lpc55_zones.png b/docs/Zone/html/lpc55_zones.png Binary files differnew file mode 100644 index 0000000..d9bc12f --- /dev/null +++ b/docs/Zone/html/lpc55_zones.png diff --git a/docs/Zone/html/navtree.js b/docs/Zone/html/navtree.js index 94c745b..a2883a2 100644 --- a/docs/Zone/html/navtree.js +++ b/docs/Zone/html/navtree.js @@ -1,19 +1,16 @@ var NAVTREE = [ [ "CMSIS-Zone (Preview)", "index.html", [ - [ "CMSIS-Zone Use Cases", "index.html#UseCases", [ - [ "MPU Protection", "index.html#UseCase_MPU", null ], - [ "TrustZone Partitioning", "index.html#UseCase_TrustZone", null ], - [ "Multi-Core Partitioning", "index.html#UseCase_MultiCore", null ] - ] ], [ "Revision History of CMSIS-Zone", "zone_revisionHistory.html", null ], - [ "Zone Description Format", "XML_Format.html", "XML_Format" ], - [ "Generator Data Model", "GenDataModel.html", [ - [ "Data Model Structure", "GenDataModel.html#GenDataModel_Structure", null ], - [ "Template Examples", "GenDataModel.html#GenDataModel_Examples", [ - [ "HTML table of all assigned memory blocks", "GenDataModel.html#GenDataModel_Examples_AssignedBlocks", null ] - ] ] - ] ] + [ "CMSIS-Zone Use Cases", "UseCases.html", [ + [ "MPU Protection", "UseCases.html#UseCase_MPU", null ], + [ "TrustZone Partitioning", "UseCases.html#UseCase_TrustZone", null ], + [ "Multi-Core Partitioning", "UseCases.html#UseCase_MultiCore", null ] + ] ], + [ "CMSIS-Zone Utility", "zoneToolUsage.html", "zoneToolUsage" ], + [ "Zone Description Format", "zoneFormat.html", "zoneFormat" ], + [ "Generator Data Model", "GenDataModel.html", "GenDataModel" ], + [ "Todo List", "todo.html", null ] ] ] ]; diff --git a/docs/Zone/html/navtreeindex0.js b/docs/Zone/html/navtreeindex0.js index d4a345b..b17630e 100644 --- a/docs/Zone/html/navtreeindex0.js +++ b/docs/Zone/html/navtreeindex0.js @@ -1,54 +1,90 @@ var NAVTREEINDEX0 = { -"GenDataModel.html":[3], -"GenDataModel.html#GenDataModel_Examples":[3,1], -"GenDataModel.html#GenDataModel_Examples_AssignedBlocks":[3,1,0], -"GenDataModel.html#GenDataModel_Structure":[3,0], -"XML_Format.html":[2], -"XML_Format.html#Example":[2,2], -"XML_Format.html#XML_Format_Model":[2,0], -"XML_Format.html#XML_Format_Model_Assign":[2,0,2], -"XML_Format.html#XML_Format_Model_Decomp":[2,0,0], -"XML_Format.html#XML_Format_Model_MemMap":[2,0,1], -"XML_Format.html#XML_Format_Schema":[2,1], -"format_assign.html":[2,3,2,0,0], -"format_assign.html":[2,3,2,0,1,0], -"format_block.html":[2,3,1,0,0,0], -"format_block.html":[2,3,0,2,0,0,0], -"format_capture.html":[2,3,2,0,0,0], -"format_capture.html":[2,3,2,0,1,0,0], -"format_device.html":[2,3,0], -"format_group.html":[2,3,1,1,0], -"format_group.html":[2,3,0,2,1,0], -"format_map_memory.html":[2,3,0,1,0,0], -"format_map_memory.html":[2,3,0,3,0], -"format_map_peripheral.html":[2,3,0,3,1], -"format_map_peripheral.html":[2,3,0,1,0,1], -"format_memory.html":[2,3,1,0], -"format_memory.html":[2,3,0,2,0], -"format_memory_map.html":[2,3,0,1,0], -"format_memory_map.html":[2,3,0,3], -"format_package.html":[2,3,0,0], -"format_peripheral.html":[2,3,1,1,0,0], -"format_peripheral.html":[2,3,1,1,1], -"format_peripheral.html":[2,3,0,2,1,0,0], -"format_peripheral.html":[2,3,0,2,1,1], -"format_peripherals.html":[2,3,1,1], -"format_peripherals.html":[2,3,0,2,1], -"format_processor.html":[2,3,0,1], -"format_pzone.html":[2,3,2,0], -"format_region.html":[2,3,1,0,0], -"format_region.html":[2,3,0,2,0,0], -"format_resources.html":[2,3,1], -"format_resources.html":[2,3,0,2], -"format_system.html":[2,3], -"format_xzone.html":[2,3,2,0,1], -"format_zones.html":[2,3,2], +"GenDataModel.html":[4], +"GenDataModel.html#fm_basics":[4,1], +"GenDataModel.html#fp_toplevel":[4,0], +"UseCases.html":[1], +"UseCases.html#UseCase_MPU":[1,0], +"UseCases.html#UseCase_MultiCore":[1,2], +"UseCases.html#UseCase_TrustZone":[1,1], +"fm_interrupt.html":[4,2,4], +"fm_memory.html":[4,2,1], +"fm_memory.html":[4,3,0], +"fm_mpc_setup.html":[4,2,5], +"fm_mpu_setup.html":[4,3,2], +"fm_peripheral.html":[4,2,2], +"fm_peripheral.html":[4,3,1], +"fm_processor.html":[4,2,0], +"fm_reg_setup.html":[4,2,6], +"fm_sau.html":[4,2,3], +"fm_system.html":[4,2], +"fm_zone.html":[4,3], "index.html":[], -"index.html#UseCase_MPU":[0,0], -"index.html#UseCase_MultiCore":[0,2], -"index.html#UseCase_TrustZone":[0,1], -"index.html#UseCases":[0], "pages.html":[], -"zone_revisionHistory.html":[1] +"todo.html":[5], +"xml_arzone.html":[3,2,0], +"xml_azone_pg.html":[3,2], +"xml_configure.html":[3,2,1], +"xml_configure.html#xml_ctype":[3,2,1,0], +"xml_creator.html":[3,1,0], +"xml_device.html":[3,1,1], +"xml_device.html#xml_package":[3,1,1,0], +"xml_device.html#xml_processor":[3,1,1,1], +"xml_memories.html":[3,1,2,1], +"xml_memories.html#xml_rmemory":[3,1,2,1,0], +"xml_memories.html#xml_rmpc":[3,1,2,1,1], +"xml_partition.html":[3,2,2], +"xml_partition.html#xml_amemory":[3,2,2,0], +"xml_partition.html#xml_aperipheral":[3,2,2,1], +"xml_partition.html#xml_aslot":[3,2,2,2], +"xml_peripherals.html":[3,1,2,2], +"xml_peripherals.html#xml_group":[3,1,2,2,0], +"xml_peripherals.html#xml_interrupt":[3,1,2,2,3], +"xml_peripherals.html#xml_p_setup":[3,1,2,2,4], +"xml_peripherals.html#xml_peripheral":[3,1,2,2,1], +"xml_peripherals.html#xml_slot":[3,1,2,2,2], +"xml_resources.html":[3,1,2], +"xml_rzone_pg.html":[3,1], +"xml_sau_init.html":[3,1,2,0], +"xml_sau_init.html#xml_si_region":[3,1,2,0,0], +"xml_zones.html":[3,2,3], +"xml_zones.html#xml_ainterrupt":[3,2,3,2], +"xml_zones.html#xml_assign":[3,2,3,1], +"xml_zones.html#xml_zone":[3,2,3,0], +"zTCLI.html":[2,3], +"zTELPC55.html":[2,4,2], +"zTELPC55.html#zTELPC55_Eclipse":[2,4,2,0], +"zTELPC55.html#zTELPC55_MDK":[2,4,2,1], +"zTELPC55.html#zTELPC55_MDK_Setup":[2,4,2,2], +"zTELPC55.html#zTELPC55_TZSetup":[2,4,2,2,1], +"zTELPC55.html#zTELPC55_hwsScatter":[2,4,2,2,0], +"zTEMusca.html":[2,4,1], +"zTESTM32L5.html":[2,4,3], +"zTESTM32L5.html#zTESTM32L5_Eclipse":[2,4,3,0], +"zTESTM32L5.html#zTESTM32L5_MDK":[2,4,3,1], +"zTESTM32L5.html#zTESTM32L5_MDK_Setup":[2,4,3,2], +"zTESTM32L5.html#zTESTM32L5_hwsScatter":[2,4,3,2,0], +"zTExamples.html":[2,4], +"zTExamples.html#zTExImport":[2,4,0], +"zTInstall.html":[2,0], +"zTInteractiveMode.html":[2,2], +"zTUI.html":[2,1], +"zTUI.html#zTGUI":[2,1,0], +"zTUI.html#zTGUIButtons":[2,1,2,0], +"zTUI.html#zTGUIZoneEditor":[2,1,2], +"zTUI.html#zTProjEx":[2,1,1], +"zTUICreateProject.html":[2,2,0], +"zTUIGenerate.html":[2,2,3], +"zTUIMemPerRes.html":[2,2,1], +"zTUIMemPerRes.html#zTUIMemAdd":[2,2,1,1], +"zTUIMemPerRes.html#zTUIMemDel":[2,2,1,2], +"zTUIMemPerRes.html#zTUIMemView":[2,2,1,0], +"zTUIMemPerRes.html#zTUIPerProp":[2,2,1,3], +"zTUIMemPerRes.html#zTUIPerSlotConf":[2,2,1,4], +"zTUIZonePart.html":[2,2,2], +"zTUIZonePart.html#zTUICreate":[2,2,2,0], +"zoneFormat.html":[3], +"zoneFormat.html#XML_Format_Schema":[3,0], +"zoneToolUsage.html":[2], +"zone_revisionHistory.html":[0] }; diff --git a/docs/Zone/html/pages.html b/docs/Zone/html/pages.html index 07b3cfd..02d8304 100644 --- a/docs/Zone/html/pages.html +++ b/docs/Zone/html/pages.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -111,43 +111,49 @@ $(document).ready(function(){initNavTree('pages.html','');}); </div><!--header--> <div class="contents"> <div class="textblock">Here is a list of all related documentation pages:</div><div class="directory"> -<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span><span onclick="javascript:toggleLevel(5);">5</span><span onclick="javascript:toggleLevel(6);">6</span><span onclick="javascript:toggleLevel(7);">7</span>]</div><table class="directory"> +<div class="levels">[detail level <span onclick="javascript:toggleLevel(1);">1</span><span onclick="javascript:toggleLevel(2);">2</span><span onclick="javascript:toggleLevel(3);">3</span><span onclick="javascript:toggleLevel(4);">4</span>]</div><table class="directory"> <tr id="row_0_" class="even"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zone_revisionHistory.html" target="_self">Revision History of CMSIS-Zone</a></td><td class="desc"></td></tr> -<tr id="row_1_"><td class="entry"><img id="arr_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_')"/><a class="el" href="XML_Format.html" target="_self">Zone Description Format</a></td><td class="desc"></td></tr> -<tr id="row_1_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_')"/><a class="el" href="format_system.html" target="_self">/system element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_0_')"/><a class="el" href="format_device.html" target="_self">/device element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="format_package.html" target="_self">/package element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_0_1_')"/><a class="el" href="format_processor.html" target="_self">/processor element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_1_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_1_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_0_1_0_')"/><a class="el" href="format_memory_map.html" target="_self">/memory_map element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_1_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="format_map_memory.html" target="_self">/memory element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_1_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_map_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_2_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_0_2_')"/><a class="el" href="format_resources.html" target="_self">/resources element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_2_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_0_2_0_')"/><a class="el" href="format_memory.html" target="_self">/memory element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_2_0_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_0_2_0_0_')"/><a class="el" href="format_region.html" target="_self">/region element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_0_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_block.html" target="_self">/block element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_2_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_0_2_1_')"/><a class="el" href="format_peripherals.html" target="_self">/peripherals element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_1_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_0_2_1_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_0_2_1_0_')"/><a class="el" href="format_group.html" target="_self">/group element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_1_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_2_1_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_3_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_0_3_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_0_3_')"/><a class="el" href="format_memory_map.html" target="_self">/memory_map element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_3_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="format_map_memory.html" target="_self">/memory element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_0_3_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_map_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_1_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_1_')"/><a class="el" href="format_resources.html" target="_self">/resources element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_1_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_1_0_')"/><a class="el" href="format_memory.html" target="_self">/memory element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_1_0_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_1_0_0_')"/><a class="el" href="format_region.html" target="_self">/region element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_0_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_block.html" target="_self">/block element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_1_0_1_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_1_1_')"/><a class="el" href="format_peripherals.html" target="_self">/peripherals element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_1_1_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_1_1_0_')"/><a class="el" href="format_group.html" target="_self">/group element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_1_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_1_1_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_peripheral.html" target="_self">/peripheral element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_2_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_2_')"/><a class="el" href="format_zones.html" target="_self">/zones element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_2_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_2_0_')"/><a class="el" href="format_pzone.html" target="_self">/pzone element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_2_0_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('1_0_2_0_0_')"/><a class="el" href="format_assign.html" target="_self">/assign element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_capture.html" target="_self">/capture element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_2_0_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_2_0_1_')"/><a class="el" href="format_xzone.html" target="_self">/xzone element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_1_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img id="arr_1_0_2_0_1_0_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('1_0_2_0_1_0_')"/><a class="el" href="format_assign.html" target="_self">/assign element</a></td><td class="desc"></td></tr> -<tr id="row_1_0_2_0_1_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="format_capture.html" target="_self">/capture element</a></td><td class="desc"></td></tr> -<tr id="row_2_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="GenDataModel.html" target="_self">Generator Data Model</a></td><td class="desc"></td></tr> +<tr id="row_1_"><td class="entry"><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="UseCases.html" target="_self">CMSIS-Zone Use Cases</a></td><td class="desc"></td></tr> +<tr id="row_2_" class="even"><td class="entry"><img id="arr_2_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('2_')"/><a class="el" href="zoneToolUsage.html" target="_self">CMSIS-Zone Utility</a></td><td class="desc"></td></tr> +<tr id="row_2_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTInstall.html" target="_self">Installation</a></td><td class="desc"></td></tr> +<tr id="row_2_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTUI.html" target="_self">User Interface</a></td><td class="desc"></td></tr> +<tr id="row_2_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_2_2_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('2_2_')"/><a class="el" href="zTInteractiveMode.html" target="_self">Interactive Mode</a></td><td class="desc"></td></tr> +<tr id="row_2_2_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTUICreateProject.html" target="_self">Create a CMSIS-Zone Project</a></td><td class="desc"></td></tr> +<tr id="row_2_2_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTUIMemPerRes.html" target="_self">Memory and Peripheral Resources</a></td><td class="desc"></td></tr> +<tr id="row_2_2_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTUIZonePart.html" target="_self">Zone Partitioning</a></td><td class="desc"></td></tr> +<tr id="row_2_2_3_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="zTUIGenerate.html" target="_self">Generate output files</a></td><td class="desc"></td></tr> +<tr id="row_2_3_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTCLI.html" target="_self">Command Line Mode</a></td><td class="desc"></td></tr> +<tr id="row_2_4_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_2_4_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('2_4_')"/><a class="el" href="zTExamples.html" target="_self">Examples</a></td><td class="desc"></td></tr> +<tr id="row_2_4_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTEMusca.html" target="_self">Arm Musca-A1</a></td><td class="desc"></td></tr> +<tr id="row_2_4_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="zTELPC55.html" target="_self">NXP LPC55S69</a></td><td class="desc"></td></tr> +<tr id="row_2_4_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="zTESTM32L5.html" target="_self">STMicroelectronics STM32L5</a></td><td class="desc"></td></tr> +<tr id="row_3_"><td class="entry"><img id="arr_3_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('3_')"/><a class="el" href="zoneFormat.html" target="_self">Zone Description Format</a></td><td class="desc"></td></tr> +<tr id="row_3_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_3_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('3_0_')"/><a class="el" href="xml_rzone_pg.html" target="_self">/rzone element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_creator.html" target="_self">/rzone/creator element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_1_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_device.html" target="_self">/rzone/device element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_2_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_3_0_2_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('3_0_2_')"/><a class="el" href="xml_resources.html" target="_self">/rzone/resources element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_2_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_sau_init.html" target="_self">/rzone/resources/sau_init element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_2_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_memories.html" target="_self">/rzone/resources/memories element</a></td><td class="desc"></td></tr> +<tr id="row_3_0_2_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="xml_peripherals.html" target="_self">/rzone/resources/peripherals element</a></td><td class="desc"></td></tr> +<tr id="row_3_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_3_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('3_1_')"/><a class="el" href="xml_azone_pg.html" target="_self">/azone element</a></td><td class="desc"></td></tr> +<tr id="row_3_1_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_arzone.html" target="_self">/azone/rzone element</a></td><td class="desc"></td></tr> +<tr id="row_3_1_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_configure.html" target="_self">/azone/configure element</a></td><td class="desc"></td></tr> +<tr id="row_3_1_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="xml_partition.html" target="_self">/azone/partition element</a></td><td class="desc"></td></tr> +<tr id="row_3_1_3_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="xml_zones.html" target="_self">/azone/zones element</a></td><td class="desc"></td></tr> +<tr id="row_4_" class="even"><td class="entry"><img id="arr_4_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('4_')"/><a class="el" href="GenDataModel.html" target="_self">Generator Data Model</a></td><td class="desc"></td></tr> +<tr id="row_4_0_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_4_0_" src="ftv2mnode.png" alt="o" width="16" height="22" onclick="toggleFolder('4_0_')"/><a class="el" href="fm_system.html" target="_self">system element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_processor.html" target="_self">processor[n] sequence element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_memory.html" target="_self">../memory[n] sequence element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_peripheral.html" target="_self">../peripheral[n] element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_3_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_sau.html" target="_self">sau[n] sequence element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_4_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_interrupt.html" target="_self">interrupt[n] sequence element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_5_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_mpc_setup.html" target="_self">mpc_setup[n] element</a></td><td class="desc"></td></tr> +<tr id="row_4_0_6_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="fm_reg_setup.html" target="_self">reg_setup[n] element</a></td><td class="desc"></td></tr> +<tr id="row_4_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img id="arr_4_1_" src="ftv2mlastnode.png" alt="\" width="16" height="22" onclick="toggleFolder('4_1_')"/><a class="el" href="fm_zone.html" target="_self">zone element</a></td><td class="desc"></td></tr> +<tr id="row_4_1_0_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_memory.html" target="_self">../memory[n] sequence element</a></td><td class="desc"></td></tr> +<tr id="row_4_1_1_"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2node.png" alt="o" width="16" height="22" /><a class="el" href="fm_peripheral.html" target="_self">../peripheral[n] element</a></td><td class="desc"></td></tr> +<tr id="row_4_1_2_" class="even"><td class="entry"><img src="ftv2vertline.png" alt="|" width="16" height="22" /><img src="ftv2blank.png" alt=" " width="16" height="22" /><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="fm_mpu_setup.html" target="_self">mpu_setup element</a></td><td class="desc"></td></tr> +<tr id="row_5_"><td class="entry"><img src="ftv2lastnode.png" alt="\" width="16" height="22" /><a class="el" href="todo.html" target="_self">Todo List</a></td><td class="desc"></td></tr> </table> </div><!-- directory --> </div><!-- contents --> @@ -155,7 +161,7 @@ $(document).ready(function(){initNavTree('pages.html','');}); <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <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 diff --git a/docs/Zone/html/partition_h_l5.png b/docs/Zone/html/partition_h_l5.png Binary files differnew file mode 100644 index 0000000..b3773a9 --- /dev/null +++ b/docs/Zone/html/partition_h_l5.png diff --git a/docs/Zone/html/peripheral_properties.png b/docs/Zone/html/peripheral_properties.png Binary files differnew file mode 100644 index 0000000..e193149 --- /dev/null +++ b/docs/Zone/html/peripheral_properties.png diff --git a/docs/Zone/html/res_prop.png b/docs/Zone/html/res_prop.png Binary files differnew file mode 100644 index 0000000..fc1502e --- /dev/null +++ b/docs/Zone/html/res_prop.png diff --git a/docs/Zone/html/resource_map.png b/docs/Zone/html/resource_map.png Binary files differnew file mode 100644 index 0000000..6e3a23b --- /dev/null +++ b/docs/Zone/html/resource_map.png diff --git a/docs/Zone/html/search/all_0.js b/docs/Zone/html/search/all_0.js index e27690c..4c0dfb6 100644 --- a/docs/Zone/html/search/all_0.js +++ b/docs/Zone/html/search/all_0.js @@ -1,5 +1,4 @@ var searchData= [ - ['generator_20data_20model',['Generator Data Model',['../GenDataModel.html',1,'']]], - ['gendatamodel_2etxt',['GenDataModel.txt',['../GenDataModel_8txt.html',1,'']]] + ['arm_20musca_2da1',['Arm Musca-A1',['../zTEMusca.html',1,'zTExamples']]] ]; diff --git a/docs/Zone/html/search/all_1.js b/docs/Zone/html/search/all_1.js index c7c9724..1a480ce 100644 --- a/docs/Zone/html/search/all_1.js +++ b/docs/Zone/html/search/all_1.js @@ -1,4 +1,7 @@ var searchData= [ - ['overview_2etxt',['Overview.txt',['../Overview_8txt.html',1,'']]] + ['cmsis_2dzone_20use_20cases',['CMSIS-Zone Use Cases',['../UseCases.html',1,'']]], + ['cmsis_2dzone_20utility',['CMSIS-Zone Utility',['../zoneToolUsage.html',1,'']]], + ['command_20line_20mode',['Command Line Mode',['../zTCLI.html',1,'zoneToolUsage']]], + ['create_20a_20cmsis_2dzone_20project',['Create a CMSIS-Zone Project',['../zTUICreateProject.html',1,'zTInteractiveMode']]] ]; diff --git a/docs/Zone/html/search/all_2.js b/docs/Zone/html/search/all_2.js index 43732cd..60aa4cc 100644 --- a/docs/Zone/html/search/all_2.js +++ b/docs/Zone/html/search/all_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['revision_20history_20of_20cmsis_2dzone',['Revision History of CMSIS-Zone',['../zone_revisionHistory.html',1,'']]] + ['examples',['Examples',['../zTExamples.html',1,'zoneToolUsage']]] ]; diff --git a/docs/Zone/html/search/all_3.js b/docs/Zone/html/search/all_3.js index 5d73130..4f5b5fe 100644 --- a/docs/Zone/html/search/all_3.js +++ b/docs/Zone/html/search/all_3.js @@ -1,4 +1,6 @@ var searchData= [ - ['xml_5fformat_2etxt',['XML_Format.txt',['../XML__Format_8txt.html',1,'']]] + ['generator_20data_20model',['Generator Data Model',['../GenDataModel.html',1,'']]], + ['gendatamodel_2etxt',['GenDataModel.txt',['../GenDataModel_8txt.html',1,'']]], + ['generate_20output_20files',['Generate output files',['../zTUIGenerate.html',1,'zTInteractiveMode']]] ]; diff --git a/docs/Zone/html/search/all_4.js b/docs/Zone/html/search/all_4.js index 0d3dff4..62c5efa 100644 --- a/docs/Zone/html/search/all_4.js +++ b/docs/Zone/html/search/all_4.js @@ -1,4 +1,6 @@ var searchData= [ - ['zone_20description_20format',['Zone Description Format',['../XML_Format.html',1,'']]] + ['interrupt_5bn_5d_20sequence_20element',['interrupt[n] sequence element',['../fm_interrupt.html',1,'fm_system']]], + ['installation',['Installation',['../zTInstall.html',1,'zoneToolUsage']]], + ['interactive_20mode',['Interactive Mode',['../zTInteractiveMode.html',1,'zoneToolUsage']]] ]; diff --git a/docs/Zone/html/search/all_5.html b/docs/Zone/html/search/all_5.html new file mode 100644 index 0000000..99ef726 --- /dev/null +++ b/docs/Zone/html/search/all_5.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_5.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_5.js b/docs/Zone/html/search/all_5.js new file mode 100644 index 0000000..434078c --- /dev/null +++ b/docs/Zone/html/search/all_5.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['mpc_5fsetup_5bn_5d_20element',['mpc_setup[n] element',['../fm_mpc_setup.html',1,'fm_system']]], + ['mpu_5fsetup_20element',['mpu_setup element',['../fm_mpu_setup.html',1,'fm_zone']]], + ['memory_20and_20peripheral_20resources',['Memory and Peripheral Resources',['../zTUIMemPerRes.html',1,'zTInteractiveMode']]] +]; diff --git a/docs/Zone/html/search/all_6.html b/docs/Zone/html/search/all_6.html new file mode 100644 index 0000000..6133ab3 --- /dev/null +++ b/docs/Zone/html/search/all_6.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_6.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_6.js b/docs/Zone/html/search/all_6.js new file mode 100644 index 0000000..9b45f0d --- /dev/null +++ b/docs/Zone/html/search/all_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['nxp_20lpc55s69',['NXP LPC55S69',['../zTELPC55.html',1,'zTExamples']]] +]; diff --git a/docs/Zone/html/search/all_7.html b/docs/Zone/html/search/all_7.html new file mode 100644 index 0000000..5748125 --- /dev/null +++ b/docs/Zone/html/search/all_7.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_7.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_7.js b/docs/Zone/html/search/all_7.js new file mode 100644 index 0000000..c7c9724 --- /dev/null +++ b/docs/Zone/html/search/all_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['overview_2etxt',['Overview.txt',['../Overview_8txt.html',1,'']]] +]; diff --git a/docs/Zone/html/search/all_8.html b/docs/Zone/html/search/all_8.html new file mode 100644 index 0000000..0179bdd --- /dev/null +++ b/docs/Zone/html/search/all_8.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_8.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_8.js b/docs/Zone/html/search/all_8.js new file mode 100644 index 0000000..7b434a1 --- /dev/null +++ b/docs/Zone/html/search/all_8.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['processor_5bn_5d_20sequence_20element',['processor[n] sequence element',['../fm_processor.html',1,'fm_system']]] +]; diff --git a/docs/Zone/html/search/all_9.html b/docs/Zone/html/search/all_9.html new file mode 100644 index 0000000..cd46d44 --- /dev/null +++ b/docs/Zone/html/search/all_9.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_9.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_9.js b/docs/Zone/html/search/all_9.js new file mode 100644 index 0000000..d3b1947 --- /dev/null +++ b/docs/Zone/html/search/all_9.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['reg_5fsetup_5bn_5d_20element',['reg_setup[n] element',['../fm_reg_setup.html',1,'fm_system']]], + ['revision_20history_20of_20cmsis_2dzone',['Revision History of CMSIS-Zone',['../zone_revisionHistory.html',1,'']]] +]; diff --git a/docs/Zone/html/search/all_a.html b/docs/Zone/html/search/all_a.html new file mode 100644 index 0000000..eab6553 --- /dev/null +++ b/docs/Zone/html/search/all_a.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_a.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_a.js b/docs/Zone/html/search/all_a.js new file mode 100644 index 0000000..6ac9872 --- /dev/null +++ b/docs/Zone/html/search/all_a.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['sau_5bn_5d_20sequence_20element',['sau[n] sequence element',['../fm_sau.html',1,'fm_system']]], + ['system_20element',['system element',['../fm_system.html',1,'GenDataModel']]], + ['stmicroelectronics_20stm32l5',['STMicroelectronics STM32L5',['../zTESTM32L5.html',1,'zTExamples']]] +]; diff --git a/docs/Zone/html/search/all_b.html b/docs/Zone/html/search/all_b.html new file mode 100644 index 0000000..a2c161e --- /dev/null +++ b/docs/Zone/html/search/all_b.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_b.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_b.js b/docs/Zone/html/search/all_b.js new file mode 100644 index 0000000..441b2de --- /dev/null +++ b/docs/Zone/html/search/all_b.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../todo.html',1,'']]] +]; diff --git a/docs/Zone/html/search/all_c.html b/docs/Zone/html/search/all_c.html new file mode 100644 index 0000000..bdd3ee2 --- /dev/null +++ b/docs/Zone/html/search/all_c.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_c.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_c.js b/docs/Zone/html/search/all_c.js new file mode 100644 index 0000000..2f8c4aa --- /dev/null +++ b/docs/Zone/html/search/all_c.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['user_20interface',['User Interface',['../zTUI.html',1,'zoneToolUsage']]] +]; diff --git a/docs/Zone/html/search/all_d.html b/docs/Zone/html/search/all_d.html new file mode 100644 index 0000000..d510933 --- /dev/null +++ b/docs/Zone/html/search/all_d.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_d.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_d.js b/docs/Zone/html/search/all_d.js new file mode 100644 index 0000000..5d73130 --- /dev/null +++ b/docs/Zone/html/search/all_d.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['xml_5fformat_2etxt',['XML_Format.txt',['../XML__Format_8txt.html',1,'']]] +]; diff --git a/docs/Zone/html/search/all_e.html b/docs/Zone/html/search/all_e.html new file mode 100644 index 0000000..3cda017 --- /dev/null +++ b/docs/Zone/html/search/all_e.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="all_e.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/all_e.js b/docs/Zone/html/search/all_e.js new file mode 100644 index 0000000..7607faf --- /dev/null +++ b/docs/Zone/html/search/all_e.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['zone_20element',['zone element',['../fm_zone.html',1,'GenDataModel']]], + ['zone_20description_20format',['Zone Description Format',['../zoneFormat.html',1,'']]], + ['zone_20partitioning',['Zone Partitioning',['../zTUIZonePart.html',1,'zTInteractiveMode']]] +]; diff --git a/docs/Zone/html/search/pages_0.js b/docs/Zone/html/search/pages_0.js index 7c0dd0e..4c0dfb6 100644 --- a/docs/Zone/html/search/pages_0.js +++ b/docs/Zone/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['generator_20data_20model',['Generator Data Model',['../GenDataModel.html',1,'']]] + ['arm_20musca_2da1',['Arm Musca-A1',['../zTEMusca.html',1,'zTExamples']]] ]; diff --git a/docs/Zone/html/search/pages_1.js b/docs/Zone/html/search/pages_1.js index 43732cd..1a480ce 100644 --- a/docs/Zone/html/search/pages_1.js +++ b/docs/Zone/html/search/pages_1.js @@ -1,4 +1,7 @@ var searchData= [ - ['revision_20history_20of_20cmsis_2dzone',['Revision History of CMSIS-Zone',['../zone_revisionHistory.html',1,'']]] + ['cmsis_2dzone_20use_20cases',['CMSIS-Zone Use Cases',['../UseCases.html',1,'']]], + ['cmsis_2dzone_20utility',['CMSIS-Zone Utility',['../zoneToolUsage.html',1,'']]], + ['command_20line_20mode',['Command Line Mode',['../zTCLI.html',1,'zoneToolUsage']]], + ['create_20a_20cmsis_2dzone_20project',['Create a CMSIS-Zone Project',['../zTUICreateProject.html',1,'zTInteractiveMode']]] ]; diff --git a/docs/Zone/html/search/pages_2.js b/docs/Zone/html/search/pages_2.js index 0d3dff4..60aa4cc 100644 --- a/docs/Zone/html/search/pages_2.js +++ b/docs/Zone/html/search/pages_2.js @@ -1,4 +1,4 @@ var searchData= [ - ['zone_20description_20format',['Zone Description Format',['../XML_Format.html',1,'']]] + ['examples',['Examples',['../zTExamples.html',1,'zoneToolUsage']]] ]; diff --git a/docs/Zone/html/search/pages_3.html b/docs/Zone/html/search/pages_3.html new file mode 100644 index 0000000..4310311 --- /dev/null +++ b/docs/Zone/html/search/pages_3.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_3.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_3.js b/docs/Zone/html/search/pages_3.js new file mode 100644 index 0000000..555a782 --- /dev/null +++ b/docs/Zone/html/search/pages_3.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['generator_20data_20model',['Generator Data Model',['../GenDataModel.html',1,'']]], + ['generate_20output_20files',['Generate output files',['../zTUIGenerate.html',1,'zTInteractiveMode']]] +]; diff --git a/docs/Zone/html/search/pages_4.html b/docs/Zone/html/search/pages_4.html new file mode 100644 index 0000000..ae5ce18 --- /dev/null +++ b/docs/Zone/html/search/pages_4.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_4.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_4.js b/docs/Zone/html/search/pages_4.js new file mode 100644 index 0000000..62c5efa --- /dev/null +++ b/docs/Zone/html/search/pages_4.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['interrupt_5bn_5d_20sequence_20element',['interrupt[n] sequence element',['../fm_interrupt.html',1,'fm_system']]], + ['installation',['Installation',['../zTInstall.html',1,'zoneToolUsage']]], + ['interactive_20mode',['Interactive Mode',['../zTInteractiveMode.html',1,'zoneToolUsage']]] +]; diff --git a/docs/Zone/html/search/pages_5.html b/docs/Zone/html/search/pages_5.html new file mode 100644 index 0000000..02c1114 --- /dev/null +++ b/docs/Zone/html/search/pages_5.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_5.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_5.js b/docs/Zone/html/search/pages_5.js new file mode 100644 index 0000000..434078c --- /dev/null +++ b/docs/Zone/html/search/pages_5.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['mpc_5fsetup_5bn_5d_20element',['mpc_setup[n] element',['../fm_mpc_setup.html',1,'fm_system']]], + ['mpu_5fsetup_20element',['mpu_setup element',['../fm_mpu_setup.html',1,'fm_zone']]], + ['memory_20and_20peripheral_20resources',['Memory and Peripheral Resources',['../zTUIMemPerRes.html',1,'zTInteractiveMode']]] +]; diff --git a/docs/Zone/html/search/pages_6.html b/docs/Zone/html/search/pages_6.html new file mode 100644 index 0000000..afb70af --- /dev/null +++ b/docs/Zone/html/search/pages_6.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_6.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_6.js b/docs/Zone/html/search/pages_6.js new file mode 100644 index 0000000..9b45f0d --- /dev/null +++ b/docs/Zone/html/search/pages_6.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['nxp_20lpc55s69',['NXP LPC55S69',['../zTELPC55.html',1,'zTExamples']]] +]; diff --git a/docs/Zone/html/search/pages_7.html b/docs/Zone/html/search/pages_7.html new file mode 100644 index 0000000..9d7ba25 --- /dev/null +++ b/docs/Zone/html/search/pages_7.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_7.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_7.js b/docs/Zone/html/search/pages_7.js new file mode 100644 index 0000000..7b434a1 --- /dev/null +++ b/docs/Zone/html/search/pages_7.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['processor_5bn_5d_20sequence_20element',['processor[n] sequence element',['../fm_processor.html',1,'fm_system']]] +]; diff --git a/docs/Zone/html/search/pages_8.html b/docs/Zone/html/search/pages_8.html new file mode 100644 index 0000000..3377887 --- /dev/null +++ b/docs/Zone/html/search/pages_8.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_8.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_8.js b/docs/Zone/html/search/pages_8.js new file mode 100644 index 0000000..d3b1947 --- /dev/null +++ b/docs/Zone/html/search/pages_8.js @@ -0,0 +1,5 @@ +var searchData= +[ + ['reg_5fsetup_5bn_5d_20element',['reg_setup[n] element',['../fm_reg_setup.html',1,'fm_system']]], + ['revision_20history_20of_20cmsis_2dzone',['Revision History of CMSIS-Zone',['../zone_revisionHistory.html',1,'']]] +]; diff --git a/docs/Zone/html/search/pages_9.html b/docs/Zone/html/search/pages_9.html new file mode 100644 index 0000000..203934e --- /dev/null +++ b/docs/Zone/html/search/pages_9.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_9.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_9.js b/docs/Zone/html/search/pages_9.js new file mode 100644 index 0000000..6ac9872 --- /dev/null +++ b/docs/Zone/html/search/pages_9.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['sau_5bn_5d_20sequence_20element',['sau[n] sequence element',['../fm_sau.html',1,'fm_system']]], + ['system_20element',['system element',['../fm_system.html',1,'GenDataModel']]], + ['stmicroelectronics_20stm32l5',['STMicroelectronics STM32L5',['../zTESTM32L5.html',1,'zTExamples']]] +]; diff --git a/docs/Zone/html/search/pages_a.html b/docs/Zone/html/search/pages_a.html new file mode 100644 index 0000000..1c097e5 --- /dev/null +++ b/docs/Zone/html/search/pages_a.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_a.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_a.js b/docs/Zone/html/search/pages_a.js new file mode 100644 index 0000000..441b2de --- /dev/null +++ b/docs/Zone/html/search/pages_a.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['todo_20list',['Todo List',['../todo.html',1,'']]] +]; diff --git a/docs/Zone/html/search/pages_b.html b/docs/Zone/html/search/pages_b.html new file mode 100644 index 0000000..f01d44a --- /dev/null +++ b/docs/Zone/html/search/pages_b.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_b.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_b.js b/docs/Zone/html/search/pages_b.js new file mode 100644 index 0000000..2f8c4aa --- /dev/null +++ b/docs/Zone/html/search/pages_b.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['user_20interface',['User Interface',['../zTUI.html',1,'zoneToolUsage']]] +]; diff --git a/docs/Zone/html/search/pages_c.html b/docs/Zone/html/search/pages_c.html new file mode 100644 index 0000000..34e3caf --- /dev/null +++ b/docs/Zone/html/search/pages_c.html @@ -0,0 +1,26 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html><head><title></title> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta name="generator" content="Doxygen 1.8.6"> +<link rel="stylesheet" type="text/css" href="search.css"/> +<script type="text/javascript" src="pages_c.js"></script> +<script type="text/javascript" src="search.js"></script> +</head> +<body class="SRPage"> +<div id="SRIndex"> +<div class="SRStatus" id="Loading">Loading...</div> +<div id="SRResults"></div> +<script type="text/javascript"><!-- +createResults(); +--></script> +<div class="SRStatus" id="Searching">Searching...</div> +<div class="SRStatus" id="NoMatches">No Matches</div> +<script type="text/javascript"><!-- +document.getElementById("Loading").style.display="none"; +document.getElementById("NoMatches").style.display="none"; +var searchResults = new SearchResults("searchResults"); +searchResults.Search(); +--></script> +</div> +</body> +</html> diff --git a/docs/Zone/html/search/pages_c.js b/docs/Zone/html/search/pages_c.js new file mode 100644 index 0000000..7607faf --- /dev/null +++ b/docs/Zone/html/search/pages_c.js @@ -0,0 +1,6 @@ +var searchData= +[ + ['zone_20element',['zone element',['../fm_zone.html',1,'GenDataModel']]], + ['zone_20description_20format',['Zone Description Format',['../zoneFormat.html',1,'']]], + ['zone_20partitioning',['Zone Partitioning',['../zTUIZonePart.html',1,'zTInteractiveMode']]] +]; diff --git a/docs/Zone/html/search/search.js b/docs/Zone/html/search/search.js index f3b5309..20f97cf 100644 --- a/docs/Zone/html/search/search.js +++ b/docs/Zone/html/search/search.js @@ -7,9 +7,9 @@ var indexSectionsWithContent = { - 0: "gorxz", + 0: "acegimnoprstuxz", 1: "gox", - 2: "grz" + 2: "acegimnprstuz" }; var indexSectionNames = diff --git a/docs/Zone/html/soc-memorymap.png b/docs/Zone/html/soc-memorymap.png Binary files differdeleted file mode 100644 index 211c986..0000000 --- a/docs/Zone/html/soc-memorymap.png +++ /dev/null diff --git a/docs/Zone/html/som-decomposition.png b/docs/Zone/html/som-decomposition.png Binary files differdeleted file mode 100644 index 2360716..0000000 --- a/docs/Zone/html/som-decomposition.png +++ /dev/null diff --git a/docs/Zone/html/storagemodel.png b/docs/Zone/html/storagemodel.png Binary files differdeleted file mode 100644 index 7f845d6..0000000 --- a/docs/Zone/html/storagemodel.png +++ /dev/null diff --git a/docs/Zone/html/todo.html b/docs/Zone/html/todo.html new file mode 100644 index 0000000..1eb400f --- /dev/null +++ b/docs/Zone/html/todo.html @@ -0,0 +1,134 @@ +<!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>Todo List</title> +<title>CMSIS-Zone (Preview): Todo List</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('todo.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Todo List </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><dl class="reflist"> +<dt><a class="anchor" id="_todo000001"></a>Page <a class="el" href="xml_partition.html">/azone/partition element</a> </dt> +<dd><p class="startdd">this needs verification</p> +<p>this needs verification</p> +<p class="enddd">this needs verification</p> +</dd> +</dl> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> diff --git a/docs/Zone/html/format_memory.html b/docs/Zone/html/xml_arzone.html index 3318a50..81669da 100644 --- a/docs/Zone/html/format_memory.html +++ b/docs/Zone/html/xml_arzone.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/memory element</title> -<title>CMSIS-Zone (Preview): /memory element</title> +<title>/azone/rzone element</title> +<title>CMSIS-Zone (Preview): /azone/rzone element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_memory.html','');}); +$(document).ready(function(){initNavTree('xml_arzone.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,37 +107,30 @@ $(document).ready(function(){initNavTree('format_memory.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/memory element </div> </div> +<div class="title">/azone/rzone element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>memory</b> element groups <a class="el" href="format_region.html">memory regions</a>.</p> +<div class="textblock"><p>The <a class="el" href="xml_arzone.html">/azone/rzone element</a> specifies the filename of the related *.rzone file. If this element is omitted the *.azone and *.rzone file have the same base name.</p> <p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 512KB SRAM integrated on the SoC --></div> -<div class="line"> <region name=<span class="stringliteral">"SRAM"</span> size=<span class="stringliteral">"0x80000"</span> access=<span class="stringliteral">"rwx"</span> info=<span class="stringliteral">"Internal SRAM (512KB)"</span>/></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> :</div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Memory"> +<div class="fragment"><div class="line"><rzone name=<span class="stringliteral">"MySystem.rzone"</span>></div> +</div><!-- fragment --><p>  </p> +<table class="cmtable" summary="Element: rzone"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_resources.html">Resources</a> </td><td colspan="3"><a class="el" href="format_resources.html">/resources element</a> </td></tr> +<td><a class="el" href="xml_azone_pg.html">azone</a> </td><td colspan="3"><a class="el" href="xml_azone_pg.html">/azone element</a> </td></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td><a class="el" href="format_region.html">/region element</a> </td><td>Memory region definitions. </td><td>complexType </td><td>0..* </td></tr> +<td>name </td><td>Name of the related *.rzone file </td><td>xs:string </td><td>required </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_azone_pg.html">/azone element</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 diff --git a/docs/Zone/html/format_map_peripheral.html b/docs/Zone/html/xml_azone_pg.html index 9bfb4ae..69655f9 100644 --- a/docs/Zone/html/format_map_peripheral.html +++ b/docs/Zone/html/xml_azone_pg.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/peripheral element</title> -<title>CMSIS-Zone (Preview): /peripheral element</title> +<title>/azone element</title> +<title>CMSIS-Zone (Preview): /azone element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_map_peripheral.html','');}); +$(document).ready(function(){initNavTree('xml_azone_pg.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,44 +107,41 @@ $(document).ready(function(){initNavTree('format_map_peripheral.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/peripheral element </div> </div> +<div class="title">/azone element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>peripheral</b> element is used to define an address mapping for one <a class="el" href="format_peripheral.html">peripheral</a>.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><memory_map></div> -<div class="line"> <!-- Logical address to access peripheral ADC0 registers --> </div> -<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> start=<span class="stringliteral">"0x40010000"</span>/></div> -<div class="line"> :</div> -<div class="line"></memory_map></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Peripheral"> +<div class="textblock"><p>The <a class="el" href="xml_azone_pg.html">/azone element</a> element is the root element of the .azone file which stores partitioning of the system or the configuration of a MPU.</p> +<table class="cmtable" summary="Root Element: azone"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_memory_map.html">memory_map</a> </td><td colspan="3"><a class="el" href="format_memory_map.html">/memory_map element</a> </td></tr> +<td>root </td><td colspan="3">Document root </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>name </td><td>The name this address mapping can be referenced by. Must be unique within a single processors memory map. </td><td>xs:string </td><td>required </td></tr> +<td>schemaVersion </td><td>CMSIS-Zone schema version used for describing the azone file. </td><td>VersionType </td><td>required </td></tr> <tr> -<td>alias </td><td>Reference to the (physical) peripheral mapped. If the alias is ommitted the name is used. </td><td>xs:string </td><td>optional </td></tr> +<td>xmlns:xs </td><td>Is set to: <span class="XML-Token">"http://www.w3.org/2001/XMLSchema-instance"</span> to indicate compliance to the XML format. </td><td>xs:decimal </td><td>required </td></tr> <tr> -<td>start </td><td>The logical start address the peripheral registers are accessible at. </td><td>xs:string </td><td>required </td></tr> -<tr> -<td>info </td><td>Brief description of the peripheral mapping. </td><td>xs:string </td><td>optional </td></tr> +<td>xs:noNamespaceSchemaLocation </td><td>File name of the schema file. For example, <span class="XML-Token">"azone.xsd"</span>. </td><td>xs:string </td><td>required </td></tr> <tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> -<td></td><td></td><td>complexType </td><td>0..1 </td></tr> +<td><a class="el" href="xml_arzone.html">rzone</a> </td><td>Reference to rzone file </td><td>RZoneType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_configure.html">configure</a> </td><td>Control the operation of the CMSIS-Zone utility </td><td>ConfigureType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_partition.html">partition</a> </td><td>Partition information for memory block splits </td><td>RegionsType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_zones.html">zones</a> </td><td>Zone assignments of processor, memory, and peripheral resources </td><td>ZonesType </td><td>0..1 </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_processor.html">/processor element</a></li><li class="navelem"><a class="el" href="format_memory_map.html">/memory_map element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</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 diff --git a/docs/Zone/html/xml_azone_pg.js b/docs/Zone/html/xml_azone_pg.js new file mode 100644 index 0000000..8120ac5 --- /dev/null +++ b/docs/Zone/html/xml_azone_pg.js @@ -0,0 +1,17 @@ +var xml_azone_pg = +[ + [ "/azone/rzone element", "xml_arzone.html", null ], + [ "/azone/configure element", "xml_configure.html", [ + [ "/azone/configure/type element", "xml_configure.html#xml_ctype", null ] + ] ], + [ "/azone/partition element", "xml_partition.html", [ + [ "/azone/partition/memory element", "xml_partition.html#xml_amemory", null ], + [ "/azone/partition/peripheral element", "xml_partition.html#xml_aperipheral", null ], + [ "/azone/partition/peripheral/slot element", "xml_partition.html#xml_aslot", null ] + ] ], + [ "/azone/zones element", "xml_zones.html", [ + [ "/azone/zones/zone element", "xml_zones.html#xml_zone", null ], + [ "/azone/zones/zone/assign element", "xml_zones.html#xml_assign", null ], + [ "/azone/zones/zone/assign/interrupt element", "xml_zones.html#xml_ainterrupt", null ] + ] ] +];
\ No newline at end of file diff --git a/docs/Zone/html/format_region.html b/docs/Zone/html/xml_configure.html index db3b2ef..eabb91a 100644 --- a/docs/Zone/html/format_region.html +++ b/docs/Zone/html/xml_configure.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/region element</title> -<title>CMSIS-Zone (Preview): /region element</title> +<title>/azone/configure element</title> +<title>CMSIS-Zone (Preview): /azone/configure element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_region.html','');}); +$(document).ready(function(){initNavTree('xml_configure.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,50 +107,55 @@ $(document).ready(function(){initNavTree('format_region.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/region element </div> </div> +<div class="title">/azone/configure element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>region</b> element is used to define individual physical memory regions.</p> +<div class="textblock"><p>The <a class="el" href="xml_configure.html">/azone/configure element</a> allows to control the operation of the CMSIS-Zone utility.</p> <p><b>Example</b> </p> -<div class="fragment"><div class="line"><resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 512KB SRAM integrated on the SoC --></div> -<div class="line"> <region name=<span class="stringliteral">"SRAM"</span> size=<span class="stringliteral">"0x80000"</span> access=<span class="stringliteral">"rwx"</span> info=<span class="stringliteral">"Internal SRAM (512KB)"</span>></div> -<div class="line"> <block name=<span class="stringliteral">"SHARED"</span> offset=<span class="stringliteral">"0x00000"</span> size=<span class="stringliteral">"0x08000"</span> access=<span class="stringliteral">"rwu"</span> info=<span class="stringliteral">"Shared memory area for inter process communication."</span>/></div> -<div class="line"> :</div> -<div class="line"> </region></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> :</div> -<div class="line"></resources></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Region"> +<div class="fragment"><div class="line"><configure mode=<span class="stringliteral">"MPU"</span>> <span class="comment">// CMSIS-Zone utility UI behavior</span></div> +<div class="line"> <type name=<span class="stringliteral">"RAM"</span> hide=<span class="stringliteral">"0"</span> select=<span class="stringliteral">"0"</span> /></div> +<div class="line"> <type name=<span class="stringliteral">"ROM"</span> hide=<span class="stringliteral">"1"</span> select=<span class="stringliteral">"1"</span> /></div> +<div class="line"> <type name=<span class="stringliteral">"Peripheral"</span> hide=<span class="stringliteral">"1"</span> select=<span class="stringliteral">"0"</span> /></div> +<div class="line"></configure></div> +</div><!-- fragment --><p>  </p> +<table class="cmtable" summary="Element: configure"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_memory.html">memory</a> </td><td colspan="3"><a class="el" href="format_memory.html">/memory element</a> </td></tr> +<td><a class="el" href="xml_azone_pg.html">azone</a> </td><td colspan="3"><a class="el" href="xml_azone_pg.html">/azone element</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>name </td><td>The name this memory region can be referenced by. Must be unique within a single device. </td><td>xs:string </td><td>required </td></tr> +<td>mode </td><td>Operation mode ("Project" or "MPU") </td><td>xs:string </td><td>required </td></tr> <tr> -<td>size </td><td>The physical memory size this region provides. </td><td>xs:string </td><td>required </td></tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> -<td>access </td><td>The access attributes for this memory region. </td><td>xs:string </td><td>required </td></tr> +<td><a class="el" href="xml_configure.html#xml_ctype">type</a> </td><td>UI behavior for memory or peripheral selection depending on the operation <em>mode</em> </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_ctype"></a> +/azone/configure/type element</h1> +<p>The <a class="el" href="xml_configure.html#xml_ctype">/azone/configure/type element</a> defines UI behavior of the CMSIS-Zone utility for a memory or peripheral selection depending on the operation <em>mode</em>.</p> +<table class="cmtable" summary="Element: type"> <tr> -<td>info </td><td>Brief description of the physical memory resource. </td><td>xs:string </td><td>optional </td></tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td><a class="el" href="xml_configure.html">configure</a> </td><td colspan="3"><a class="el" href="xml_configure.html">/azone/configure element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>Refers item type ("RAM", "ROM", or "Peripheral") that this element specifies. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>hide </td><td>"1" specifies that the item type is hidden during configuration in the UI of the CMSIS-Zone utility (default is "0"). </td><td>xs:boolean </td><td>optional </td></tr> <tr> -<td><a class="el" href="format_block.html">/block element</a> </td><td>Memory block definitions. </td><td>complexType </td><td>0..* </td></tr> +<td>select </td><td>"1" specifies that all resources with the item type are selected (default is "0"). </td><td>xs:boolean </td><td>optional </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li><li class="navelem"><a class="el" href="format_resources.html">/resources element</a></li><li class="navelem"><a class="el" href="format_memory.html">/memory element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_azone_pg.html">/azone element</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 diff --git a/docs/Zone/html/format_package.html b/docs/Zone/html/xml_creator.html index f4f58d5..80cc737 100644 --- a/docs/Zone/html/format_package.html +++ b/docs/Zone/html/xml_creator.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/package element</title> -<title>CMSIS-Zone (Preview): /package element</title> +<title>/rzone/creator element</title> +<title>CMSIS-Zone (Preview): /rzone/creator element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_package.html','');}); +$(document).ready(function(){initNavTree('xml_creator.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,41 +107,39 @@ $(document).ready(function(){initNavTree('format_package.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/package element </div> </div> +<div class="title">/rzone/creator element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>package</b> element can optinally be used to refer to the Software Pack providing a certain <a class="el" href="format_device.html">device</a>.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><device Dname=<span class="stringliteral">"ARM32CM4128x"</span>></div> -<div class="line"> <<span class="keyword">package </span>name="ARM32CM4xxx_DFP" url="http:<span class="comment">//www.keil.com/pack" vendor="ARM" version="1.8.15"/> </span></div> -<div class="line"> :</div> -<div class="line"></device></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Package"> +<div class="textblock"><p>The <a class="el" href="xml_creator.html">/rzone/creator element</a> specifies how a derived .rzone file was created.</p> +<table class="cmtable" summary="Element: device"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_device.html">device</a> </td><td colspan="3"><a class="el" href="format_device.html">/device element</a> </td></tr> +<td><a class="el" href="xml_rzone_pg.html">rzone</a> </td><td colspan="3"><a class="el" href="xml_rzone_pg.html">/rzone element</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>name </td><td>The unique pack name. </td><td>xs:string </td><td>required </td></tr> +<td>tool </td><td>Identification of the tool that generated this *.rzone file. (i.e. "CMSIS-Zone V1.1.0") </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>url </td><td>The URL the pack can be obtained from. </td><td>xs:string </td><td>required </td></tr> +<td>rzone </td><td>Name of the .rzone file which contained top level resources. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>vendor </td><td>The pack vendor name. </td><td>xs:string </td><td>required </td></tr> +<td>azone </td><td>Name of the .azone file which contained related assignments. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>version </td><td>The pack version. </td><td>xs:string </td><td>optional </td></tr> +<td>zone </td><td>Name of the zone that is represented in this derived .rzone file. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>info </td><td>Brief description of the Software Pack. </td><td>xs:string </td><td>optional </td></tr> +<td>zone_info </td><td>Brief description of the zone. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> setting for this *.rzone file. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td><p class="starttd">optional </p> +<p class="endtd"></p> +</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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</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 diff --git a/docs/Zone/html/format_processor.html b/docs/Zone/html/xml_device.html index 577ef84..f470748 100644 --- a/docs/Zone/html/format_processor.html +++ b/docs/Zone/html/xml_device.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/processor element</title> -<title>CMSIS-Zone (Preview): /processor element</title> +<title>/rzone/device element</title> +<title>CMSIS-Zone (Preview): /rzone/device element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_processor.html','');}); +$(document).ready(function(){initNavTree('xml_device.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,59 +107,95 @@ $(document).ready(function(){initNavTree('format_processor.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/processor element </div> </div> +<div class="title">/rzone/device element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>processor</b> element is used to define the processing elements integration on a <a class="el" href="format_device.html">device</a>.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><processor Pname=<span class="stringliteral">"Cortex-M4"</span> Dclock=<span class="stringliteral">"168000000"</span> Dcore=<span class="stringliteral">"Cortex-M4"</span> DcoreVersion=<span class="stringliteral">"r0p1"</span> Dendian=<span class="stringliteral">"Little-endian"</span> Dfpu=<span class="stringliteral">"SP_FPU"</span> Dmpu=<span class="stringliteral">"MPU"</span> Dtz=<span class="stringliteral">"NO_TZ"</span>></div> -<div class="line"> <memory_map></div> -<div class="line"> <!-- Logical address alias to access integrated SRAM --></div> -<div class="line"> <memory name=<span class="stringliteral">"CODE_SRAM"</span> alias=<span class="stringliteral">"SRAM"</span> start=<span class="stringliteral">"0x00000000"</span>/></div> -<div class="line"> :</div> -<div class="line"> </memory_map></div> -<div class="line"> :</div> -<div class="line"></processor></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Processor"> +<div class="textblock"><p>The <a class="el" href="xml_device.html">/rzone/device element</a> specifies the device of the system that integrates the processors.</p> +<table class="cmtable" summary="Element: device"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_device.html">device</a> </td><td colspan="3"><a class="el" href="format_device.html">/device element</a> </td></tr> +<td><a class="el" href="xml_rzone_pg.html">rzone</a> </td><td colspan="3"><a class="el" href="xml_rzone_pg.html">/rzone element</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors</b>. Each processor needs a per device unique identifier and must be used consistently in the <b>Pname</b> attribute. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>optional </td></tr> +<td>Dvendor </td><td>The devices vendor identifier. </td><td>xs:string </td><td>required </td></tr> <tr> -<td>Dcore </td><td>Specifies the processor core. </td><td>DcoreEnum </td><td>optional </td></tr> +<td>Dname </td><td>Specifies the name of the device. Only alphabetical characters, decimal digits, '-' and '_' are allowed. </td><td>RestrictedString </td><td>required </td></tr> <tr> -<td>Dfpu </td><td>Specifies whether a hardware Floating Point Unit is present in the processor. </td><td>DfpuEnum </td><td>optional </td></tr> +<td>info </td><td>Brief description of the device. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>Dmpu </td><td>Specifies whether a Memory Protection Unit is present in the processor. </td><td>DmpuEnum </td><td>optional </td></tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_device.html#xml_package">package</a> </td><td>Optional reference to the Software Pack this device is provided by. </td><td>complexType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_device.html#xml_processor">processor</a> </td><td>Processing elements and associated features embedded in the device. </td><td>complexType </td><td>1..* </td></tr> +</table> +<h1><a class="anchor" id="xml_package"></a> +/rzone/device/package element</h1> +<p>The <a class="el" href="xml_device.html#xml_package">/rzone/device/package element</a> refers to the Software Pack that provides the Device Family Pack (DFP) for the <a class="el" href="xml_device.html">device</a>.</p> +<table class="cmtable" summary="Element: package"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_device.html">device</a> </td><td colspan="3"><a class="el" href="xml_device.html">/rzone/device element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The unique pack name. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>url </td><td>The URL the pack can be obtained from. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>vendor </td><td>The pack vendor name. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>version </td><td>The pack version. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the Software Pack. </td><td>xs:string </td><td>optional </td></tr> +</table> +<h1><a class="anchor" id="xml_processor"></a> +/rzone/device/processor element</h1> +<p>The <a class="el" href="xml_device.html#xml_processor">/rzone/device/processor element</a> defines the processing elements integrated in the <a class="el" href="xml_device.html">device</a>. The information in this element is identical with CMSIS-Pack, except that it provides an additional 'info' attribute.</p> +<table class="cmtable" summary="Element: processor"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_device.html">device</a> </td><td colspan="3"><a class="el" href="xml_device.html">/rzone/device element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>Pname </td><td>Processor identifier. This attribute <b>is mandatory for devices that embed multiple processors</b>. </td><td>RestrictedString </td><td>required for all multi-core devices </td></tr> <tr> -<td>Dtz </td><td>Specifies whether an Armv8-M based device implements TrustZone. </td><td>DtzEnum </td><td>optional </td></tr> +<td>Punits </td><td>Specifies the number of processor units in a symmetric multi-processor core (MPCore). Defaults to single-core CPU (<span class="XML-Token">1</span>) when left empty. </td><td>InstancesType </td><td>required for all multi-core devices </td></tr> <tr> -<td>Ddsp </td><td>Specifies whether an Armv8-M based device supports the DSP instructions set. </td><td>DdspEnum </td><td>optional </td></tr> +<td>Dcore </td><td>Specifies the processor core. </td><td>DcoreEnum </td><td>required </td></tr> <tr> -<td>Dendian </td><td>Specifies the endianess of the processor. </td><td>DendianEnum </td><td>optional </td></tr> +<td>Dfpu </td><td>Specifies whether a hardware Floating Point Unit is present in the processor. </td><td>DfpuEnum </td><td>required </td></tr> <tr> -<td>Dclock </td><td>Specifies the max clock frequency of the processor subsystem </td><td>xs:unsignedInt </td><td>optional </td></tr> +<td>Dmpu </td><td>Specifies whether a Memory Protection Unit is present in the processor. </td><td>DmpuEnum </td><td>required </td></tr> +<tr> +<td>Dtz </td><td>Specifies whether an Armv8-M based device implements TrustZone. </td><td>DtzEnum </td><td>required for ARMv8-M based devices </td></tr> +<tr> +<td>Ddsp </td><td>Specifies whether a device supports the DSP instructions set. </td><td>DdspEnum </td><td>required </td></tr> +<tr> +<td>Dendian </td><td>Specifies the endianess of the processor. </td><td>DendianEnum </td><td>required </td></tr> +<tr> +<td>Dclock </td><td>Specifies the max clock frequency of the processor subsystem </td><td>xs:unsignedInt </td><td>required </td></tr> <tr> <td>DcoreVersion </td><td>Hardware revision of the processor core </td><td>xs:string </td><td>required </td></tr> <tr> -<td>info </td><td>Brief description of the processor. </td><td>xs:string </td><td>optional </td></tr> +<td>DnumInterrupts </td><td>Number of NVIC interrupt sources available to the processor core (excludes exception vectors). </td><td>NonNegativeInteger </td><td>optional </td></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>DnumSauRegions </td><td>Number of regions in the Security Attribution Unit (SAU) of the processor core. </td><td>NonNegativeInteger </td><td>optional </td></tr> <tr> -<td><a class="el" href="format_memory_map.html">memory_map</a> </td><td>Processor specific (non-uniform) memory map. The effective memory map of the processor is derived as the union of device and processor level mappings. </td><td>complexType </td><td>0..1 </td></tr> +<td>info </td><td>Brief description of the processor. </td><td>xs:string </td><td>optional </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_device.html">/device element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</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 diff --git a/docs/Zone/html/xml_memories.html b/docs/Zone/html/xml_memories.html new file mode 100644 index 0000000..ec2cb96 --- /dev/null +++ b/docs/Zone/html/xml_memories.html @@ -0,0 +1,232 @@ +<!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>/rzone/resources/memories element</title> +<title>CMSIS-Zone (Preview): /rzone/resources/memories element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('xml_memories.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/rzone/resources/memories element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="xml_memories.html">/rzone/resources/memories element</a> contains:</p> +<ul> +<li>a list of all memory regions available in this system.</li> +<li>a list of all Memory Protection Controllers (MPC) in this system. Some memory region or MPC might restrict the availability to specific processors.</li> +</ul> +<p><b>Example</b> </p> +<div class="fragment"><div class="line"><resources></div> +<div class="line"> <memories></div> +<div class="line"> <memory name=<span class="stringliteral">"ExtMem1"</span> start=<span class="stringliteral">"0x00000000"</span> physical=<span class="stringliteral">"0x00000000"</span> size=<span class="stringliteral">"0x00010000"</span> access=<span class="stringliteral">"rwx"</span> security=<span class="stringliteral">""</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"External memory 1 / remap"</span> external=<span class="stringliteral">"true"</span> /></div> +<div class="line"> <memory name=<span class="stringliteral">"Flash_NS"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x00080000"</span> access=<span class="stringliteral">"rx"</span> security=<span class="stringliteral">""</span> type=<span class="stringliteral">"ROM"</span> info=<span class="stringliteral">"Flash Memory (non secure)"</span> /></div> +<div class="line"> <mpc name=<span class="stringliteral">"IOTKIT_MPCSSRAM0"</span> start=<span class="stringliteral">"0x08000000"</span> size=<span class="stringliteral">"0x00100000"</span> type=<span class="stringliteral">"sp"</span> blk_size=<span class="stringliteral">"0x20000"</span> info=<span class="stringliteral">"MPC for extended Flash"</span> /></div> +<div class="line"> <memory name=<span class="stringliteral">"Flash_S"</span> start=<span class="stringliteral">"0x0c000000"</span> physical=<span class="stringliteral">"0x08001000"</span> size=<span class="stringliteral">"0x00080000"</span> access=<span class="stringliteral">"rx"</span> security=<span class="stringliteral">"c"</span> type=<span class="stringliteral">"ROM"</span> info=<span class="stringliteral">"Flash Memory (secure)"</span> /></div> +<div class="line"></div> +<div class="line"> <memory name=<span class="stringliteral">"SRAM1_C_NS"</span> start=<span class="stringliteral">"0x0A000000"</span> size=<span class="stringliteral">"0x00030000"</span> access=<span class="stringliteral">"rwx"</span> security=<span class="stringliteral">""</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"SRAM1 Code (non secure)"</span> /></div> +<div class="line"> <memory name=<span class="stringliteral">"SRAM1_C_S"</span> start=<span class="stringliteral">"0x0E000000"</span> physical=<span class="stringliteral">"0x0A000000"</span> size=<span class="stringliteral">"0x00030000"</span> access=<span class="stringliteral">"rwx"</span> security=<span class="stringliteral">"c"</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"SRAM1 Code (secure)"</span> /></div> +<div class="line"> <memory name=<span class="stringliteral">"SRAM1_S"</span> start=<span class="stringliteral">"0x30000000"</span> physical=<span class="stringliteral">"0x0A000000"</span> size=<span class="stringliteral">"0x00030000"</span> access=<span class="stringliteral">"rw"</span> security=<span class="stringliteral">"s"</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"SRAM1 (secure)"</span> /></div> +<div class="line"> <memory name=<span class="stringliteral">"SRAM1_NS"</span> start=<span class="stringliteral">"0x20000000"</span> physical=<span class="stringliteral">"0x0A000000"</span> size=<span class="stringliteral">"0x00030000"</span> access=<span class="stringliteral">"rw"</span> security=<span class="stringliteral">""</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"SRAM1 (non secure)"</span> /></div> +<div class="line"></div> +<div class="line"> <memory name=<span class="stringliteral">"FMC_Bank1"</span> start=<span class="stringliteral">"0x60000000"</span> size=<span class="stringliteral">"0x00000000"</span> access=<span class="stringliteral">"rw"</span> security=<span class="stringliteral">""</span> type=<span class="stringliteral">"RAM"</span> info=<span class="stringliteral">"Memory Controller bank 1"</span> /></div> +<div class="line"> </memories></div> +<div class="line"> :</div> +<div class="line"></resources></div> +</div><!-- fragment --><table class="cmtable" summary="Element: memories"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_resources.html">resources</a> </td><td colspan="3"><a class="el" href="xml_resources.html">/rzone/resources element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_memories.html#xml_rmemory">memory</a> </td><td>Lists a logical memory region with physical mapping. Memory might restricted to processors, access, or security modes. </td><td>complexType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_memories.html#xml_rmpc">mpc</a> </td><td>Specifies a Memory Protection Controller (MPC) for a physical address range. </td><td>complexType </td><td>0..1 </td></tr> +</table> +<h1><a class="anchor" id="xml_rmemory"></a> +/rzone/resources/memories/memory element</h1> +<p>The <a class="el" href="xml_memories.html#xml_rmemory">/rzone/resources/memories/memory element</a> lists a logical memory region with physical mapping. Memory might restricted to processors, access, or security modes.</p> +<table class="cmtable" summary="Element: memory"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_memories.html">memories</a> </td><td colspan="3"><a class="el" href="xml_memories.html">/rzone/resources/memories element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of this memory region which must be unique in this *.rzone file. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>type </td><td>The type of memory in this region ("RAM" or "ROM"). </td><td>PhysicalTypeEnum </td><td>required </td></tr> +<tr> +<td>start </td><td>The logical start address of the memory region in the address map. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>physical </td><td>The physical start address of the memory region in the address map. If physical is not specified the start address value is used. </td><td>NonNegativeInteger </td><td>optional </td></tr> +<tr> +<td>size </td><td>The size of the memory region in bytes. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this memory region. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this memory region. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this memory region. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>startup </td><td>"1" specifies that this region is used for the startup code of the application. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>uninit </td><td>"1" specifies that this region is not zero initialized during startup. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>shared </td><td>"1" specifies that this region is used by multiple zones. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this region is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>external </td><td>"1" specifies that this region is provided by an external component that is not part of the device. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access this memory region. If omitted all processors of the system have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the memory region. </td><td>xs:string </td><td>optional </td></tr> +</table> +<h1><a class="anchor" id="xml_rmpc"></a> +/rzone/resources/memories/mpc element</h1> +<p>The <a class="el" href="xml_memories.html#xml_rmpc">/rzone/resources/memories/mpc element</a> element specifies a Memory Protection Controller (MPC) for a physical memory address region. The MPC region must not necessarily overlap a physical memory space which means it can be larger or smaller.</p> +<table class="cmtable" summary="Element: mpc"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_memories.html">memories</a> </td><td colspan="3"><a class="el" href="xml_memories.html">/rzone/resources/memories element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The base register name of the MPC. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>The physical start address of the memory address region that is protected by the MPC. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>size </td><td>The size of the memory address region in bytes. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>blk_size </td><td>The size (in bytes) of each memory block. This value is also the alignment requirement for the memory blocks. The number of LUT bits is: <em>memory size</em> / <em>blk_size</em>. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>type </td><td>Specifies the permissions that the MPC verifies for the memory access:<br/> +<ul> +<li>type="s" : (default) only the Secure attribute is verified.</li> +<li>type="p" : only the Privileged attribute is verified.</li> +<li>type="sp" : both the Secure are Privileged attribute are verified. </li> +</ul> +</td><td>MpcTypeEnum </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the memory region. </td><td>xs:string </td><td>optional </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="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</a></li><li class="navelem"><a class="el" href="xml_resources.html">/rzone/resources element</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> diff --git a/docs/Zone/html/xml_partition.html b/docs/Zone/html/xml_partition.html new file mode 100644 index 0000000..5fae297 --- /dev/null +++ b/docs/Zone/html/xml_partition.html @@ -0,0 +1,245 @@ +<!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>/azone/partition element</title> +<title>CMSIS-Zone (Preview): /azone/partition element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('xml_partition.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/azone/partition element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="xml_partition.html">/azone/partition element</a> contains a list of memory partitions that are created with the CMSIS-Zone utility. These memory partitions are based on parent memory definitions specified by <a class="el" href="xml_memories.html">/rzone/resources/memories element</a>.</p> +<p><b>Example</b> </p> +<div class="fragment"><div class="line"><partition></div> +<div class="line"> <memory parent=<span class="stringliteral">"Flash_NS"</span> name=<span class="stringliteral">"ROM_NS"</span> offset=<span class="stringliteral">"0x00000000"</span> size=<span class="stringliteral">"0x40000"</span> fixed=<span class="stringliteral">"1"</span> access=<span class="stringliteral">"rx"</span> info=<span class="stringliteral">"application code"</span> /></div> +<div class="line"> <memory parent=<span class="stringliteral">"Flash_S"</span> name=<span class="stringliteral">"ROM_S"</span> offset=<span class="stringliteral">"0x00040000"</span> size=<span class="stringliteral">"0x40000"</span> access=<span class="stringliteral">"x"</span> info=<span class="stringliteral">"boot code /></span></div> +<div class="line"><span class="stringliteral"> <memory parent="</span>SRAM1_NS<span class="stringliteral">" name="</span>RAM_NS<span class="stringliteral">" offset="</span>0x00000000<span class="stringliteral">" size="</span>0x20000<span class="stringliteral">" /></span></div> +<div class="line"><span class="stringliteral"> <memory parent="</span>SRAM1_S<span class="stringliteral">" name="</span>RAM_S<span class="stringliteral">" offset="</span>0x00010000<span class="stringliteral">" size="</span>0x20000<span class="stringliteral">" /></span></div> +<div class="line"><span class="stringliteral"></partition></span></div> +</div><!-- fragment --><p>  </p> +<table class="cmtable" summary="Element: partition"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_azone_pg.html">azone</a> </td><td colspan="3"><a class="el" href="xml_azone_pg.html">/azone element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_partition.html#xml_amemory">memory</a> </td><td>Defines a new memory sub-region that is related to a parent region in the *.rzone file. </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_partition.html#xml_aperipheral">peripheral</a> </td><td>Defines a settings for a peripheral. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_amemory"></a> +/azone/partition/memory element</h1> +<p>The <a class="el" href="xml_partition.html#xml_amemory">/azone/partition/memory element</a> defines a new memory sub-region that is related to a parent region in the *.rzone file.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000001">Todo:</a></b></dt><dd>this needs verification</dd></dl> +<table class="cmtable" summary="Element: memory"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_partition.html">partition</a> </td><td colspan="3"><a class="el" href="xml_partition.html">/azone/partition element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>parent </td><td>The name of the parent region in the related *.rzone file. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>name </td><td>The name of a new memory partition. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>size </td><td>The physical memory size this block allocates. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>offset </td><td>The address offset of this memory partition. If fixed="1" the memory block cannot be re-ordered within the region. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this memory block. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this memory block. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this memory block. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>startup </td><td>"1" specifies that this region is used for the startup code of the application. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>fixed </td><td>"1" indicates a fixed offset within that region. "0" (default) allows to re-arrange the block within the region. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>uninit </td><td>"1" specifies that this region is not zero initialized during startup. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>shared </td><td>"1" specifies that this region is used by multiple zones. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this region is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access this memory region. If omitted all processors of the system have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the memory block. </td><td>xs:string </td><td>optional </td></tr> +</table> +<h1><a class="anchor" id="xml_aperipheral"></a> +/azone/partition/peripheral element</h1> +<p>The <a class="el" href="xml_partition.html#xml_aperipheral">/azone/partition/peripheral element</a> defines settings for a peripheral in a related *.rzone file.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000002">Todo:</a></b></dt><dd>this needs verification</dd></dl> +<table class="cmtable" summary="Element: peripheral"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_partition.html">partition</a> </td><td colspan="3"><a class="el" href="xml_partition.html">/azone/partition element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the peripheral. The combination group / name must be be unique within a processor (specified by Pname). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>group </td><td>The group name of the peripheral. The combination group / name must be be unique within a processor (specified by Pname). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>The logical start address of the peripheral in both secure and non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_s </td><td>The logical start address of the peripheral in secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_ns </td><td>The logical start address of the peripheral in non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>shared </td><td>"1" specifies that this peripheral group is used by multiple zones. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this peripheral group is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>external </td><td>"1" specifies that this peripheral is provided by an external component that is not part of the device. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this peripheral. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this peripheral. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this peripheral. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_partition.html#xml_aslot">slot</a> </td><td>Defines a settings for a slot. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_aslot"></a> +/azone/partition/peripheral/slot element</h1> +<p>The <a class="el" href="xml_partition.html#xml_aslot">/azone/partition/peripheral/slot element</a> defines settings for a slot in a related *.rzone file.</p> +<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000003">Todo:</a></b></dt><dd>this needs verification</dd></dl> +<table class="cmtable" summary="Element: slot"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_partition.html#xml_aperipheral">peripheral</a> </td><td colspan="3"><a class="el" href="xml_partition.html#xml_aperipheral">/azone/partition/peripheral element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the slot. The combination group / peripheral / name must be be unique within a processor (specified by Pname). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>secure </td><td>Overwrites the setting of the secure attribute in the *.rzone file. </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>privilege </td><td>Overwrites the setting of the privilege attribute in the *.rzone file. </td><td>xs:boolean </td><td>optional </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="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_azone_pg.html">/azone element</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> diff --git a/docs/Zone/html/xml_peripherals.html b/docs/Zone/html/xml_peripherals.html new file mode 100644 index 0000000..4ea8276 --- /dev/null +++ b/docs/Zone/html/xml_peripherals.html @@ -0,0 +1,332 @@ +<!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>/rzone/resources/peripherals element</title> +<title>CMSIS-Zone (Preview): /rzone/resources/peripherals element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('xml_peripherals.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/rzone/resources/peripherals element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="xml_peripherals.html">/rzone/resources/peripherals element</a> contains a list of all peripherals available in the system. It also restricts the availability to specific processors or security modes.</p> +<p><b>Example</b> </p> +<div class="fragment"><div class="line"><resources></div> +<div class="line"> :</div> +<div class="line"> <peripherals></div> +<div class="line"> <peripheral name=<span class="stringliteral">"ADC0"</span> start=<span class="stringliteral">"0x40080000"</span> size=<span class="stringliteral">"0x1000"</span> access=<span class="stringliteral">"rwp"</span> info=<span class="stringliteral">"Analog/Digital Converter 0 (12-bit)"</span>/></div> +<div class="line"> :</div> +<div class="line"> <group name=<span class="stringliteral">"TIM"</span> info=<span class="stringliteral">"Timer Group"</span>></div> +<div class="line"> <peripheral name=<span class="stringliteral">"TIM1"</span> start_ns=<span class="stringliteral">"0x40012c00"</span> start_s=<span class="stringliteral">"0x50012c00"</span> size=<span class="stringliteral">"0x400"</span> access=<span class="stringliteral">"rw"</span>></div> +<div class="line"> <interrupt name=<span class="stringliteral">"TIM1_BRK"</span> irqn=<span class="stringliteral">"41"</span> info=<span class="stringliteral">"Timer 1 Break"</span>/></div> +<div class="line"> <interrupt name=<span class="stringliteral">"TIM1_UP"</span> irqn=<span class="stringliteral">"42"</span> info=<span class="stringliteral">"Timer 1 Update"</span>/></div> +<div class="line"> <interrupt name=<span class="stringliteral">"TIM1_BRK"</span> irqn=<span class="stringliteral">"43"</span> info=<span class="stringliteral">"Timer 1 Trigger and Commutation"</span>/></div> +<div class="line"> <interrupt name=<span class="stringliteral">"TIM1_CC"</span> irqn=<span class="stringliteral">"44"</span> info=<span class="stringliteral">"Timer 1 Capture and Compare"</span>/></div> +<div class="line"> </peripheral></div> +<div class="line"> <peripheral name=<span class="stringliteral">"TIM2"</span> start_ns=<span class="stringliteral">"0x40000000"</span> start_s=<span class="stringliteral">"0x50000000"</span> size=<span class="stringliteral">"0x400"</span> access=<span class="stringliteral">"rw"</span>></div> +<div class="line"> <interrupt name=<span class="stringliteral">"TIM2"</span> irqn=<span class="stringliteral">"45"</span> info=<span class="stringliteral">"Timer2 Global Interrupt"</span>/></div> +<div class="line"> </peripheral></div> +<div class="line"> </group></div> +<div class="line"> </peripherals></div> +<div class="line"></resources></div> +</div><!-- fragment --><p>  </p> +<table class="cmtable" summary="Element: peripherals"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_resources.html">resources</a> </td><td colspan="3"><a class="el" href="xml_resources.html">/rzone/resources element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_group">group</a> </td><td>Logical grouping of peripherals. </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_peripheral">peripheral</a> </td><td>Peripheral definitions. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_group"></a> +/rzone/resources/peripherals/group element</h1> +<p>The <a class="el" href="xml_peripherals.html#xml_group">/rzone/resources/peripherals/group element</a> can be used to logically group peripherals according to functionality or bus topology.</p> +<table class="cmtable" summary="Element: group"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html">peripherals</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html">/rzone/resources/peripherals element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name for the peripheral group must be be unique within a processor (specified by Pname). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>The logical start address of the peripheral group in both secure and non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_s </td><td>The logical start address of the peripheral group in secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_ns </td><td>The logical start address of the peripheral group in non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>physical </td><td>The physical start address of the peripheral group. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>size </td><td>The physical size of the peripheral group in bytes. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>shared </td><td>"1" specifies that this peripheral group is used by multiple zones. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this peripheral group is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>external </td><td>"1" specifies that this peripheral group is provided by an external component that is not part of the device. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access this peripheral group. If omitted all processors of the system have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this peripheral group. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this peripheral group. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this peripheral group. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the peripheral group. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_peripheral">peripheral</a> </td><td>Peripheral definitions. </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_p_setup">setup</a> </td><td>Setup information for the peripheral group. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_peripheral"></a> +/rzone/resources/peripherals/.../peripheral element</h1> +<p>The <a class="el" href="xml_peripherals.html#xml_peripheral">/rzone/resources/peripherals/.../peripheral element</a> is used to define an address mapping for one peripheral.</p> +<table class="cmtable" summary="Element: peripheral"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html">peripherals</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html">/rzone/resources/peripherals element</a> </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_group">group</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html#xml_group">/rzone/resources/peripherals/group element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the peripheral. The combination group / name must be be unique within a processor (specified by Pname). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>start </td><td>The logical start address of the peripheral in both secure and non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_s </td><td>The logical start address of the peripheral in secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>start_ns </td><td>The logical start address of the peripheral in non-secure mode. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>physcial </td><td>The physical start address of the peripheral. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>offset </td><td>Specifies an offset for the peripheral for the <a class="el" href="xml_peripherals.html#xml_group">/rzone/resources/peripherals/group element</a> values. The values <em>start</em>, <em>start_s</em>, <em>start_ns</em>, <em>physical</em> are taken from the <a class="el" href="xml_peripherals.html#xml_group">/rzone/resources/peripherals/group element</a> element if not overwritten. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>size </td><td>The physical size of the peripheral in bytes. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>shared </td><td>"1" specifies that this peripheral group is used by multiple zones. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this peripheral group is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>external </td><td>"1" specifies that this peripheral is provided by an external component that is not part of the device. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access this peripheral. If omitted all processors of the system have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this peripheral. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this peripheral. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this peripheral. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the peripheral. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>slot_name </td><td>Attribute name of the slot (i.e. Pins or Channels). Used in context menu or dialog heading. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>slot_type </td><td>Specifies the values that are configured for the slots:<br/> +<ul> +<li>type="s" : (default) only the secure attribute is configured.</li> +<li>type="p" : only the Privileged attribute is configured.</li> +<li>type="sp" : both the Secure are Privileged attribute are configured. </li> +</ul> +</td><td>SlotTypeEnum </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_slot">slot</a> </td><td>Configuration of security or privileged attribute for slots (typically channels or pins). </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_interrupt">interrupt</a> </td><td>Interrupts generated by this peripheral. </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_p_setup">setup</a> </td><td>Setup information for the peripheral. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_slot"></a> +/rzone/resources/peripherals/.../peripheral/slot element</h1> +<p>The <a class="el" href="xml_peripherals.html#xml_slot">/rzone/resources/peripherals/.../peripheral/slot element</a> is specific to a channel or pin of a peripheral. It specifies the configuration for interrupts or setup registers that belong to that slot (which is typically a channels or pins).</p> +<table class="cmtable" summary="Element: interrupt"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_peripheral">peripheral</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html#xml_peripheral">/rzone/resources/peripherals/.../peripheral element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the slot (typically channel or pin name). </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>secure </td><td>Setting of the secure attribute (default="0"). </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>privilege </td><td>Setting of the privilege attribute (default="0"). </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_interrupt">interrupt</a> </td><td>Interrupts generated by this peripheral. </td><td>complexType </td><td>0..* </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_p_setup">setup</a> </td><td>Setup information for the peripheral. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_interrupt"></a> +/rzone/resources/peripherals/.../interrupt element</h1> +<p>The <a class="el" href="xml_peripherals.html#xml_interrupt">/rzone/resources/peripherals/.../interrupt element</a> defines the interrupts that are generated by a peripheral or slot.</p> +<table class="cmtable" summary="Element: interrupt"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_peripheral">peripheral</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html#xml_peripheral">/rzone/resources/peripherals/.../peripheral element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the interrupt. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>irqn </td><td>The interrupt number. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>info </td><td>Brief description of the peripheral. </td><td>xs:string </td><td>optional </td></tr> +</table> +<h1><a class="anchor" id="xml_p_setup"></a> +/rzone/resources/peripherals/.../setup element</h1> +<p>The <a class="el" href="xml_peripherals.html#xml_p_setup">/rzone/resources/peripherals/.../setup element</a> defines the setup information for this peripheral, slot, or peripheral group. The attributes <em>security</em> and <em>privilege</em> specifies conditions. When the peripheral is specified for on the the conditions, the <em>value</em> is assigned to the <em>register</em> name (with an optional <em>index</em>).</p> +<table class="cmtable" summary="Element: peripheral"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_peripheral">peripheral</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html#xml_peripheral">/rzone/resources/peripherals/.../peripheral element</a> </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html#xml_group">group</a> </td><td colspan="3"><a class="el" href="xml_peripherals.html#xml_group">/rzone/resources/peripherals/group element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the register. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>index </td><td>An index value for the register. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>value </td><td>The value that should be written to the register when the <em>security</em> or <em>privilege</em> condition matches with the peripheral configuration. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> condition for this setup value. Security can be "s" or "n". When a peripheral matches that security setting the value will be written. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> condition for this setup value. Privilege can be "u" or "p". When a peripheral matches that privilege setting the value will be written. When both Security and Privilege is specified, both conditions must match. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>info </td><td>Brief description of the setup value. </td><td>xs:string </td><td>optional </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="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</a></li><li class="navelem"><a class="el" href="xml_resources.html">/rzone/resources element</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> diff --git a/docs/Zone/html/format_zones.html b/docs/Zone/html/xml_resources.html index 3a5702b..c42c6b1 100644 --- a/docs/Zone/html/format_zones.html +++ b/docs/Zone/html/xml_resources.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/zones element</title> -<title>CMSIS-Zone (Preview): /zones element</title> +<title>/rzone/resources element</title> +<title>CMSIS-Zone (Preview): /rzone/resources element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_zones.html','');}); +$(document).ready(function(){initNavTree('xml_resources.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,37 +107,31 @@ $(document).ready(function(){initNavTree('format_zones.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/zones element </div> </div> +<div class="title">/rzone/resources element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>zones</b> element groups all zone definitions.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><zones></div> -<div class="line"> <pzone name=<span class="stringliteral">"App"</span> Dname=<span class="stringliteral">"ARM32CM4128x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"SHARED"</span> as=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwu"</span>/></div> -<div class="line"> <assign name=<span class="stringliteral">"ADC0"</span> access=<span class="stringliteral">"rw"</span> /></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"></zones></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Zones"> +<div class="textblock"><p>The <a class="el" href="xml_resources.html">/rzone/resources element</a> defines the memory and peripheral regions that are available.</p> +<table class="cmtable" summary="Element: resources"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_system.html">system</a> </td><td colspan="3"><a class="el" href="format_system.html">/system element</a> </td></tr> +<td><a class="el" href="xml_rzone_pg.html">rzone</a> </td><td colspan="3"><a class="el" href="xml_rzone_pg.html">/rzone element</a> </td></tr> <tr> <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> <tr> -<td><a class="el" href="format_pzone.html">/pzone element</a> </td><td>Project zone definitions </td><td>complexType </td><td>0..* </td></tr> +<td><a class="el" href="xml_sau_init.html">sau_init</a> </td><td>Fixed SAU settings required for this system, i.e. to access peripherals. </td><td>SauInitType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_memories.html">memories</a> </td><td>List of all memory regions available in this system. Some memory region might restrict the availability to specific processors. </td><td>complexType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_peripherals.html">peripherals</a> </td><td>List of all peripherals available for this system. </td><td>complexType </td><td>0..1 </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</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 diff --git a/docs/Zone/html/xml_resources.js b/docs/Zone/html/xml_resources.js new file mode 100644 index 0000000..0c85782 --- /dev/null +++ b/docs/Zone/html/xml_resources.js @@ -0,0 +1,17 @@ +var xml_resources = +[ + [ "/rzone/resources/sau_init element", "xml_sau_init.html", [ + [ "/rzone/sau_init/region element", "xml_sau_init.html#xml_si_region", null ] + ] ], + [ "/rzone/resources/memories element", "xml_memories.html", [ + [ "/rzone/resources/memories/memory element", "xml_memories.html#xml_rmemory", null ], + [ "/rzone/resources/memories/mpc element", "xml_memories.html#xml_rmpc", null ] + ] ], + [ "/rzone/resources/peripherals element", "xml_peripherals.html", [ + [ "/rzone/resources/peripherals/group element", "xml_peripherals.html#xml_group", null ], + [ "/rzone/resources/peripherals/.../peripheral element", "xml_peripherals.html#xml_peripheral", null ], + [ "/rzone/resources/peripherals/.../peripheral/slot element", "xml_peripherals.html#xml_slot", null ], + [ "/rzone/resources/peripherals/.../interrupt element", "xml_peripherals.html#xml_interrupt", null ], + [ "/rzone/resources/peripherals/.../setup element", "xml_peripherals.html#xml_p_setup", null ] + ] ] +];
\ No newline at end of file diff --git a/docs/Zone/html/xml_rzone_pg.html b/docs/Zone/html/xml_rzone_pg.html new file mode 100644 index 0000000..ee5c902 --- /dev/null +++ b/docs/Zone/html/xml_rzone_pg.html @@ -0,0 +1,151 @@ +<!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>/rzone element</title> +<title>CMSIS-Zone (Preview): /rzone element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('xml_rzone_pg.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/rzone element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="xml_rzone_pg.html">/rzone element</a> element is the root element of the .rzone file which describes the resources (processors, memory, peripherals) available.</p> +<table class="cmtable" summary="Element: rzone"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td>root </td><td colspan="3">Document root </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>schemaVersion </td><td>CMSIS-Zone schema version used for describing the *.rzone file. </td><td>VersionType </td><td>required </td></tr> +<tr> +<td>xmlns:xs </td><td>Is set to: <span class="XML-Token">"http://www.w3.org/2001/XMLSchema-instance"</span> to indicate compliance to the XML format. </td><td>xs:decimal </td><td>required </td></tr> +<tr> +<td>xs:noNamespaceSchemaLocation </td><td>File name of the schema file. For example, <span class="XML-Token">"rzone.xsd"</span>. </td><td>xs:string </td><td>required </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_creator.html">creator</a> </td><td>Specifies how a derived .rzone file was created. </td><td>CreatorType </td><td>0..1 </td></tr> +<tr> +<td><a class="el" href="xml_device.html">device</a> </td><td>Device that includes one or more processing element (PE). </td><td>DeviceType </td><td>1..1 </td></tr> +<tr> +<td><a class="el" href="xml_resources.html">resources</a> </td><td>Physical resources (memory and peripherals) that are available in the system. </td><td>SResourceType </td><td>1..1 </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="zoneFormat.html">Zone Description Format</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> diff --git a/docs/Zone/html/xml_rzone_pg.js b/docs/Zone/html/xml_rzone_pg.js new file mode 100644 index 0000000..511b822 --- /dev/null +++ b/docs/Zone/html/xml_rzone_pg.js @@ -0,0 +1,9 @@ +var xml_rzone_pg = +[ + [ "/rzone/creator element", "xml_creator.html", null ], + [ "/rzone/device element", "xml_device.html", [ + [ "/rzone/device/package element", "xml_device.html#xml_package", null ], + [ "/rzone/device/processor element", "xml_device.html#xml_processor", null ] + ] ], + [ "/rzone/resources element", "xml_resources.html", "xml_resources" ] +];
\ No newline at end of file diff --git a/docs/Zone/html/format_capture.html b/docs/Zone/html/xml_sau_init.html index 350db77..33dce57 100644 --- a/docs/Zone/html/format_capture.html +++ b/docs/Zone/html/xml_sau_init.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/capture element</title> -<title>CMSIS-Zone (Preview): /capture element</title> +<title>/rzone/resources/sau_init element</title> +<title>CMSIS-Zone (Preview): /rzone/resources/sau_init element</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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_capture.html','');}); +$(document).ready(function(){initNavTree('xml_sau_init.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,46 +107,48 @@ $(document).ready(function(){initNavTree('format_capture.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/capture element </div> </div> +<div class="title">/rzone/resources/sau_init element </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>capture</b> element can be used to specify linker symbol patterns to be placed into the enclosing memory assignment.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><zones></div> -<div class="line"> <pzone name=<span class="stringliteral">"App"</span> Dname=<span class="stringliteral">"ARM32CM4128x"</span> Pname=<span class="stringliteral">"Cortex-M4"</span>></div> -<div class="line"> <assign name=<span class="stringliteral">"SHARED"</span> as=<span class="stringliteral">"SRAM"</span> access=<span class="stringliteral">"rwu"</span>></div> -<div class="line"> <capture symbol=<span class="stringliteral">".bss.shared"</span>/></div> -<div class="line"> <capture symbol=<span class="stringliteral">".data.shared"</span>/></div> -<div class="line"> :</div> -<div class="line"> </assign></div> -<div class="line"> :</div> -<div class="line"> </pzone></div> -<div class="line"> :</div> -<div class="line"></zones></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Capture"> +<div class="textblock"><p>The <a class="el" href="xml_sau_init.html">/rzone/resources/sau_init element</a> specifies fixed Secure Attribute Unit (SAU) settings required for this system, for example a configuration that is required to access peripherals.</p> +<table class="cmtable" summary="Element: sau_init"> <tr> <th>Parent Element </th><th colspan="3">Element Chain </th></tr> <tr> -<td><a class="el" href="format_assign.html">assign</a> </td><td colspan="3"><a class="el" href="format_assign.html">/assign element</a> </td></tr> +<td><a class="el" href="xml_resources.html">resources</a> </td><td colspan="3"><a class="el" href="xml_resources.html">/rzone/resources element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_sau_init.html#xml_si_region">region</a> </td><td>Region settings for the SAU. </td><td>complexType </td><td>1..* </td></tr> +</table> +<h1><a class="anchor" id="xml_si_region"></a> +/rzone/sau_init/region element</h1> +<p>The <a class="el" href="xml_sau_init.html#xml_si_region">/rzone/sau_init/region element</a> contains the region setting for SAU initialization.</p> +<table class="cmtable" summary="Element: region"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_sau_init.html">sau_init</a> </td><td colspan="3"><a class="el" href="xml_sau_init.html">/rzone/resources/sau_init element</a> </td></tr> <tr> <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> <tr> -<td>cunit </td><td>Pattern selecting the compilation unit(s) to be placed into this assignment. </td><td>xs:string </td><td>optional </td></tr> +<td>Pname </td><td>The processor that requires this setting. If omitted all processors get this setting. </td><td>xs:string </td><td>optional </td></tr> <tr> -<td>symbol </td><td>Pattern selecting the symbols to be placed into this assignment. </td><td>xs:string </td><td>optional </td></tr> +<td>start </td><td>The logical start address for the region. </td><td>NonNegativeInteger </td><td>required </td></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>size </td><td>The size for the region. </td><td>NonNegativeInteger </td><td>required </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this memory region. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> <tr> -<td></td><td></td><td>complexType </td><td>0..* </td></tr> +<td>info </td><td>Brief description of region setting (for comments in source code). </td><td>xs:string </td><td>optional </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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li><li class="navelem"><a class="el" href="format_zones.html">/zones element</a></li><li class="navelem"><a class="el" href="format_pzone.html">/pzone element</a></li><li class="navelem"><a class="el" href="format_xzone.html">/xzone element</a></li><li class="navelem"><a class="el" href="format_assign.html">/assign element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <li class="navelem"><a class="el" href="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_rzone_pg.html">/rzone element</a></li><li class="navelem"><a class="el" href="xml_resources.html">/rzone/resources element</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 diff --git a/docs/Zone/html/xml_zones.html b/docs/Zone/html/xml_zones.html new file mode 100644 index 0000000..9c75536 --- /dev/null +++ b/docs/Zone/html/xml_zones.html @@ -0,0 +1,228 @@ +<!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>/azone/zones element</title> +<title>CMSIS-Zone (Preview): /azone/zones element</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('xml_zones.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">/azone/zones element </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <a class="el" href="xml_zones.html">/azone/zones element</a> contains all zone definitions.</p> +<p><b>Example</b> </p> +<div class="fragment"><div class="line"><zones></div> +<div class="line"> <zone name=<span class="stringliteral">"Network"</span>></div> +<div class="line"> <assign region=<span class="stringliteral">"RAM1"</span> block=<span class="stringliteral">"Network"</span> access=<span class="stringliteral">"rw"</span>/></div> +<div class="line"> <assign group=<span class="stringliteral">"UART"</span> peripheral=<span class="stringliteral">"USART0"</span> access=<span class="stringliteral">"rw"</span> /></div> +<div class="line"> :</div> +<div class="line"> </zone></div> +<div class="line"> :</div> +<div class="line"></zones></div> +</div><!-- fragment --><p>  </p> +<table class="cmtable" summary="Element: zones"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_azone_pg.html">azone</a> </td><td colspan="3"><a class="el" href="xml_azone_pg.html">/azone element</a> </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_zones.html#xml_zone">zone</a> </td><td>Zone definitions </td><td>complexType </td><td>1..* </td></tr> +</table> +<h1><a class="anchor" id="xml_zone"></a> +/azone/zones/zone element</h1> +<p>The <a class="el" href="xml_zones.html#xml_zone">/azone/zones/zone element</a> defines the name of a zone.</p> +<table class="cmtable" summary="Element: zone"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_zones.html">zones</a> </td><td colspan="3"><a class="el" href="xml_zones.html">/azone/zones element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The unique name for this zone. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>info </td><td>Brief description of the zone. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access the memory and peripherals of this zone. If omitted all processors of the system have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security level</a> for code execution in this zone. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for code execution in this zone. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_zones.html#xml_assign">assign</a> </td><td>Resource Assignments </td><td>complexType </td><td>1..* </td></tr> +</table> +<h1><a class="anchor" id="xml_assign"></a> +/azone/zones/zone/assign element</h1> +<p>The <a class="el" href="xml_zones.html#xml_assign">/azone/zones/zone/assign element</a> defines the resource assignments of that zone.</p> +<table class="cmtable" summary="Element: assign"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_zones.html#xml_zone">zone</a> </td><td colspan="3"><a class="el" href="xml_zones.html#xml_zone">/azone/zones/zone element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>memory </td><td>Name of a memory region or memory partition. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>group </td><td>Name of a peripheral group. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>peripheral </td><td>Name of a peripheral. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>access </td><td><a class="el" href="zoneFormat.html#access">Access</a> permissions for this assignment. </td><td><a class="el" href="zoneFormat.html#access">AccessType</a> </td><td>optional </td></tr> +<tr> +<td>Pname </td><td>The processor that can access this assignment. If omitted the processors of the zone have access. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> attributes for this assignment. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> for this assignment. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </td></tr> +<tr> +<td>uninit </td><td>"1" specifies that this region is not zero initialized during startup. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<td>dma </td><td>"1" specifies that this region is accessed by a DMA controller. Default value is "0". </td><td>xs:boolean </td><td>optional </td></tr> +<tr> +<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<tr> +<td><a class="el" href="xml_zones.html#xml_ainterrupt">interrupt</a> </td><td>Interrupt assignments for peripherals. </td><td>complexType </td><td>0..* </td></tr> +</table> +<h1><a class="anchor" id="xml_ainterrupt"></a> +/azone/zones/zone/assign/interrupt element</h1> +<p>The <a class="el" href="xml_zones.html#xml_ainterrupt">/azone/zones/zone/assign/interrupt element</a> defines the interrupt execution for a peripheral.</p> +<table class="cmtable" summary="Element: interrupt"> +<tr> +<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<tr> +<td><a class="el" href="xml_zones.html#xml_zone">assign</a> </td><td colspan="3"><a class="el" href="xml_zones.html#xml_assign">/azone/zones/zone/assign element</a> </td></tr> +<tr> +<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<tr> +<td>name </td><td>The name of the interrupt. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>value </td><td>The interrupt number. </td><td>xs:string </td><td>required </td></tr> +<tr> +<td>info </td><td>Brief description for this setting. </td><td>xs:string </td><td>optional </td></tr> +<tr> +<td>security </td><td><a class="el" href="zoneFormat.html#security">Security</a> setting for the interrupt. </td><td><a class="el" href="zoneFormat.html#security">SecurityType</a> </td><td>optional </td></tr> +<tr> +<td>privilege </td><td><a class="el" href="zoneFormat.html#privilege">Privilege level</a> setting for the interrupt. </td><td><a class="el" href="zoneFormat.html#privilege">PrivilegeType</a> </td><td>optional </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="zoneFormat.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="xml_azone_pg.html">/azone element</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> diff --git a/docs/Zone/html/zTCLI.html b/docs/Zone/html/zTCLI.html new file mode 100644 index 0000000..3ab11cf --- /dev/null +++ b/docs/Zone/html/zTCLI.html @@ -0,0 +1,151 @@ +<!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>Command Line Mode</title> +<title>CMSIS-Zone (Preview): Command Line Mode</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTCLI.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Command Line Mode </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>As the <a class="el" href="zoneFormat.html#rzone">.rzone</a> and <a class="el" href="zoneFormat.html#azone">.azone</a> files are XML based, it is possible to create or modify the files in external tools without using the <a class="el" href="zTInteractiveMode.html">Interactive Mode</a>. To generate output files the CMSIS-Zone Utility can be started in headless mode. The command line format is:</p> +<p><code>eclipsec.exe -noSplash -consoleLog –launcher.suppressErrors -application com.arm.cmsis.zone.ui.headlessgen -azone FILENME.azone -ftl FTL_DIR -ftl_gen FTL_GEN_DIR</code></p> +<p><b>Where</b> </p> +<table class="doxtable"> +<tr> +<th align="left">Parameter </th><th align="left">Description </th><th align="left">Required </th></tr> +<tr> +<td align="left"><code>-noSplash</code> </td><td align="left">Suppresses Eclipse's splash screen </td><td align="left">[required] </td></tr> +<tr> +<td align="left"><code>-launcher.suppressErrors</code> </td><td align="left">Suppresses error dialog </td><td align="left">[optional] </td></tr> +<tr> +<td align="left"><code>-consoleLog</code> </td><td align="left">Suppresses diagnostic messages </td><td align="left">[optional] </td></tr> +<tr> +<td align="left"><code>-application</code> <code>com.arm.cmsis.zone.ui.headlessgen</code> </td><td align="left">Specifies the plug-in to be called </td><td align="left">[required] </td></tr> +<tr> +<td align="left"><code>-azone</code> <code>FILNAME.azone</code> </td><td align="left">Specifies the .azone file to be processed </td><td align="left">[required] </td></tr> +<tr> +<td align="left"><code>-ftl</code> <code>FTL_DIR</code> </td><td align="left">Relative or absolute directory with templates to process </td><td align="left">[optional - by default, <code>ftl</code> directory under the azone's file path is used] </td></tr> +<tr> +<td align="left"><code>-ftl_gen</code> <code>FTL_GEN_DIR</code> </td><td align="left">Relative or absolute output directory to write generated files </td><td align="left">[optional - by default, <code>ftl_gen</code> directory under the azone's file path is used] </td></tr> +<tr> +<td align="left"><code>-help</code> </td><td align="left">Shows command line parameter information </td><td align="left">[optional] </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> diff --git a/docs/Zone/html/zTELPC55.html b/docs/Zone/html/zTELPC55.html new file mode 100644 index 0000000..ac05fbf --- /dev/null +++ b/docs/Zone/html/zTELPC55.html @@ -0,0 +1,263 @@ +<!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>NXP LPC55S69</title> +<title>CMSIS-Zone (Preview): NXP LPC55S69</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTELPC55.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">NXP LPC55S69 </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>This single processor demo application shows how to do the <a class="el" href="UseCases.html#UseCase_TrustZone">TrustZone Partitioning</a>. It is split into a secure and non-secure part. Using CMSIS-Zone, it generates:</p> +<ul> +<li>A header file that contains #defines to control the various linker scatter files (and might be used in other parts of the application).</li> +<li>Memory protection controller (MPC) setup.</li> +<li>Peripheral protection controller (PPC) and related interrupt setup.</li> +<li>Secure attribution unit (SAU) setup.</li> +</ul> +<p>The application itself shows how to implement calls between the secure and the non-secure part.</p> +<h1><a class="anchor" id="zTELPC55_Eclipse"></a> +Using the CMSIS-Zone project</h1> +<ul> +<li><a class="el" href="zTExamples.html#zTExImport">Import</a> the project "Examples\LPC55S69\Zone" into the CMSIS-Zone utility</li> +<li><a class="el" href="zTUI.html#zTProjEx">Open</a> the LPC55S69.azone file</li> +<li><a class="el" href="zTUIGenerate.html">Generate</a> the related output files</li> +</ul> +<p>The LPC55S69.azone file of that project has the following configuration settings:</p> +<ul> +<li><a class="el" href="zTUIZonePart.html#zTUICreate">Added the zones</a> <code>hello_world_s</code> and <code>hello_worls_ns</code> </li> +<li><a class="el" href="zTUIMemPerRes.html#zTUIMemAdd">Created the memory regions</a> <code>CODE_NS</code>, <code>Config</code>, <code>CODE_S</code>, <code>Veneer</code>, <code>DATA_NS</code>, and <code>DATA_S</code> </li> +<li>Selected various memory regions and peripherals for using in the different zones.</li> +</ul> +<div class="image"> +<img src="lpc55_zones.png" alt="lpc55_zones.png"/> +</div> +<p>The zones use different Flash and SRAM regions for code and data, but share Flash configuration registers. Peripherals, such as the system and IO configuration, as well as an UART are available in the secure world only. To generate the output, click on the <a class="el" href="zTUIGenerate.html">Generate</a> button in the Zone Editor tool bar. This creates the following files in the <code>ftl_gen</code> directory:</p> +<table class="doxtable"> +<tr> +<th align="left">Template File </th><th align="left">Generated File </th><th align="left">Description </th></tr> +<tr> +<td align="left">dump_fzone.txt.ftl </td><td align="left">dump_fzone.txt </td><td align="left">Contains the complete model </td></tr> +<tr> +<td align="left">helper.ftlinc </td><td align="left">N/A </td><td align="left">Helper template file with FTL functions. </td></tr> +<tr> +<td align="left">mem_layout.h.ftl </td><td align="left">mem_layout.h </td><td align="left">Header file that contains the memory region definitions, for example for the linker scatter file. </td></tr> +<tr> +<td align="left">scatter_ns.sct.ftl </td><td align="left">scatter_ns.sct </td><td align="left">Example scatter file for the non-secure zone (currently not used in MDK). </td></tr> +<tr> +<td align="left">scatter_s.sct.ftl </td><td align="left">scatter_s.sct </td><td align="left">Example scatter file for the secure zone (currently not used in MDK). </td></tr> +<tr> +<td align="left">tzm_config_mpc.c.ftl </td><td align="left">tzm_config_mpc.c </td><td align="left">Setup of the memory protection controller (MPC). </td></tr> +<tr> +<td align="left">tzm_config_ppc.c.ftl </td><td align="left">tzm_config_ppc.c </td><td align="left">Setup of the peripheral protection controller (PPC). </td></tr> +<tr> +<td align="left">tzm_config_sau.c.ftl </td><td align="left">tzm_config_sau.c </td><td align="left">Configuration of the secure attribution unit (SAU) and the NVIC interrupt assignment. </td></tr> +</table> +<p>These files can be used in any IDE to create the final application. In the following, the usage in Arm Keil MDK is described.</p> +<h1><a class="anchor" id="zTELPC55_MDK"></a> +Using the MDK project</h1> +<p>The example project can be loaded, built and debugged in µVision by performing the following steps:</p> +<ol type="1"> +<li>Navigate to Examples/LPC55S69/MDK</li> +<li>Open the multi-project workspace hello_world.uvmpw</li> +<li>Optional: Update the generated files by executing the copy_gen.bat scripts in hello_world_s\mdk and hello_world_ns\mdk folders.</li> +<li>Run the batch build in MDK. Both projects, hello_world_s and hello_world_ns need to be compiled in order.</li> +<li>Set hello_world_s as active project.</li> +<li>Connect the LPC55S69-EVK using a Micro-USB cable at Debug Link (P6).</li> +<li>Open <b>Options for Target - Debug</b> and make sure that the CMSIS-DAP ARMv8-M Debugger is selected and the LPC-LINK2 is used.</li> +<li>Optional: Open a serial terminal program (i.e. PuTTY) on the virtual serial port provided in parallel to the debugger (e.g. USB Serial Device). Configure the port to 115200/8N1.</li> +<li>Launch a debug session and watch the serial console output: <div class="image"> +<img src="hello_world_output.png" alt="hello_world_output.png"/> +</div> +</li> +</ol> +<h1><a class="anchor" id="zTELPC55_MDK_Setup"></a> +MDK project setup</h1> +<p>The multiproject workspace contains the secure <code>hello_world_s</code> project and the non-secure <code>hello_world_ns</code> project:</p> +<div class="image"> +<img src="hello_world_proj_window.png" alt="hello_world_proj_window.png"/> +</div> +<p>The projects use the files generated in CMSIS-Zone as follows:</p> +<table class="doxtable"> +<tr> +<th align="left">File </th><th align="left">Used in </th><th align="left">Description </th></tr> +<tr> +<td align="left">mem_layout.h </td><td align="left">hello_world_s, hello_world_ns </td><td align="left">Input for the scatter files. </td></tr> +<tr> +<td align="left">tzm_config_mpc.c </td><td align="left">hello_world_s </td><td align="left">Functions called from tzm_config.c </td></tr> +<tr> +<td align="left">tzm_config_ppc.c </td><td align="left">hello_world_s </td><td align="left">Functions called from tzm_config.c </td></tr> +<tr> +<td align="left">tzm_config_sau.c </td><td align="left">hello_world_s </td><td align="left">Functions called from tzm_config.c </td></tr> +</table> +<p>The scatter files <code>hello_world_s.sct</code> and <code>hello_world_ns.sct</code> are based on the original scatter files from NXP and are using a preinclude to mem_layout.h to get the information about the different memory regions.</p> +<dl class="section note"><dt>Note</dt><dd>If you want to learn more about the general project layout for an Armv8-M project using TrustZone, refer to <a href="https://www.keil.com/appnotes/docs/apnt_291.asp" target="_blank">Application Note 291</a>.</dd></dl> +<h2><a class="anchor" id="zTELPC55_hwsScatter"></a> +hello_world_s.sct</h2> +<p>As explained previously, the #defines in <code>mem_layout.h</code> can be used to create generic scatter files that are easy to update once changes in the CMSIS-Zone project happen. Using the <b>mem_layout.h</b> file from CMSIS-Zone, the following scatter file is used in the secure <code>hello_world</code> project:</p> +<div class="fragment"><div class="line">; Use Arm compiler 6 to pre-process the scatter file and pull in the defines from the mem_layout.h file:</div> +<div class="line"><span class="preprocessor">#! armclang -E --target=arm-arm-none-eabi -mcpu=cortex-m33 -I../ -xc</span></div> +<div class="line"><span class="preprocessor"></span> </div> +<div class="line"><span class="preprocessor">#include "mem_layout.h"</span></div> +<div class="line"> </div> +<div class="line">; *------- <<< Use Configuration Wizard in Context Menu >>> ------------------</div> +<div class="line"> </div> +<div class="line">;<h> Stack Configuration</div> +<div class="line">; <o> Stack Size (in Bytes) <0x0-0xFFFFFFFF:8></div> +<div class="line">;</h></div> +<div class="line"><span class="preprocessor">#define STACK_SIZE 0x400</span></div> +<div class="line"><span class="preprocessor"></span> </div> +<div class="line">;<h> Heap Configuration</div> +<div class="line">; <o> Heap Size (in Bytes) <0x0-0xFFFFFFFF:8></div> +<div class="line">;</h></div> +<div class="line"><span class="preprocessor">#define HEAP_SIZE 0xC00</span></div> +<div class="line"><span class="preprocessor"></span> </div> +<div class="line">; *-------------- <<< end of configuration section >>> -----------------------</div> +<div class="line"></div> +<div class="line">LR_CODE_S REGION_CODE_S_START REGION_CODE_S_SIZE {</div> +<div class="line"> ER_CODE_S REGION_CODE_S_START REGION_CODE_S_SIZE {</div> +<div class="line"> (RESET,+FIRST)</div> +<div class="line"> (InRoot$$Sections)</div> +<div class="line"> .ANY (+RO, +XO)</div> +<div class="line"> }</div> +<div class="line"> RW_DATA_S REGION_DATA_S_START REGION_DATA_S_SIZE-HEAP_SIZE-STACK_SIZE {</div> +<div class="line"> .ANY (+RW +ZI)</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#if HEAP_SIZE>0</span></div> +<div class="line"><span class="preprocessor"></span> ARM_LIB_HEAP REGION_DATA_S_START+REGION_DATA_S_SIZE-HEAP_SIZE-STACK_SIZE EMPTY HEAP_SIZE {</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#endif</span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#if STACK_SIZE>0</span></div> +<div class="line"><span class="preprocessor"></span> ARM_LIB_STACK REGION_DATA_S_START+REGION_DATA_S_SIZE-STACK_SIZE EMPTY STACK_SIZE {</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#endif</span></div> +<div class="line"><span class="preprocessor"></span>}</div> +<div class="line">LR_VENEER REGION_VENEER_START REGION_VENEER_SIZE {</div> +<div class="line"> ER_VENEER REGION_VENEER_START REGION_VENEER_SIZE {</div> +<div class="line"> (Veneer$$CMSE)</div> +<div class="line"> }</div> +<div class="line">}</div> +</div><!-- fragment --><h2><a class="anchor" id="zTELPC55_TZSetup"></a> +TrustZone Setup at Startup</h2> +<p>During the system initialization, the function <b>SystemInitHook</b> is called. This is used when application specific code needs to be called as close to the reset entry as possible. In this example, this function calls <b>BOARD_InitTrustZone</b>, which calls the three TZM_Config_* functions:</p> +<div class="image"> +<img src="lpc55_system_startup.png" alt="lpc55_system_startup.png"/> +</div> + </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="navelem"><a class="el" href="zTExamples.html">Examples</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> diff --git a/docs/Zone/html/zTEMusca.html b/docs/Zone/html/zTEMusca.html new file mode 100644 index 0000000..cf823b3 --- /dev/null +++ b/docs/Zone/html/zTEMusca.html @@ -0,0 +1,128 @@ +<!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>Arm Musca-A1</title> +<title>CMSIS-Zone (Preview): Arm Musca-A1</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTEMusca.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Arm Musca-A1 </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"></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="navelem"><a class="el" href="zTExamples.html">Examples</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> diff --git a/docs/Zone/html/zTESTM32L5.html b/docs/Zone/html/zTESTM32L5.html new file mode 100644 index 0000000..552b093 --- /dev/null +++ b/docs/Zone/html/zTESTM32L5.html @@ -0,0 +1,250 @@ +<!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>STMicroelectronics STM32L5</title> +<title>CMSIS-Zone (Preview): STMicroelectronics STM32L5</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTESTM32L5.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">STMicroelectronics STM32L5 </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>This single processor demo application shows how to do the <a class="el" href="UseCases.html#UseCase_TrustZone">TrustZone Partitioning</a>. It is split into a secure and non-secure part. Using CMSIS-Zone, it generates:</p> +<ul> +<li>A header file that contains #defines to control the various linker scatter files (and might be used in other parts of the application).</li> +<li>The SystemIsolation_Config.c header file that contains memory protection controller (MPC) and peripheral protection controller (PPC) and related interrupt setup.</li> +<li>The partition_gen.h header file that contains the secure attribution unit (SAU) setup and the NVIC configuration for secure/non-secure.</li> +</ul> +<p>The application itself shows how to implement calls between the secure and the non-secure part.</p> +<h1><a class="anchor" id="zTESTM32L5_Eclipse"></a> +Using the CMSIS-Zone project</h1> +<ul> +<li><a class="el" href="zTExamples.html#zTExImport">Import</a> the project "Examples\STM32L5\Zone" into the CMSIS-Zone utility</li> +<li><a class="el" href="zTUI.html#zTProjEx">Open</a> the STM32L5.azone file</li> +<li><a class="el" href="zTUIGenerate.html">Generate</a> the related output files</li> +</ul> +<p>The STM32L5.azone file of that project has the following configuration settings:</p> +<ul> +<li><a class="el" href="zTUIZonePart.html#zTUICreate">Added the zones</a> <code>blinky_s</code> and <code>blinky_ns</code> </li> +<li><a class="el" href="zTUIMemPerRes.html#zTUIMemAdd">Created the memory regions</a> <code>CODE_NS</code>, <code>CODE_S</code>, <code>Veneer</code>, <code>DATA_NS</code>, and <code>DATA_S</code> </li> +<li>Selected various memory regions and peripherals for using in the different zones.</li> +</ul> +<div class="image"> +<img src="STM32L5_zones.png" alt="STM32L5_zones.png"/> +</div> +<p>The zones use different Flash and SRAM regions for code and data, but share Flash configuration registers. Peripherals, such as the system and IO configuration, as well as an UART are available in the secure world only. To generate the output, click on the <a class="el" href="zTUIGenerate.html">Generate</a> button in the Zone Editor tool bar. This creates the following files in the <code>ftl_gen</code> directory:</p> +<table class="doxtable"> +<tr> +<th align="left">Template File </th><th align="left">Generated File </th><th align="left">Description </th></tr> +<tr> +<td align="left">dump_fzone.txt.ftl </td><td align="left">dump_fzone.txt </td><td align="left">Contains the complete model </td></tr> +<tr> +<td align="left">helper.ftlinc </td><td align="left">N/A </td><td align="left">Helper template file with FTL functions. </td></tr> +<tr> +<td align="left">mem_layout.h.ftl </td><td align="left">mem_layout.h </td><td align="left">Header file that contains the memory region definitions, for example for the linker scatter file. </td></tr> +<tr> +<td align="left">partition_gen.h.ftl </td><td align="left">partition_gen.h </td><td align="left">Configuration of the secure attribution unit (SAU) and the NVIC interrupt assignment. </td></tr> +<tr> +<td align="left">SystemIsolation_Config.c.ftl </td><td align="left">SystemIsolation_Config.c </td><td align="left">Setup of the MPC and PPC. </td></tr> +<tr> +<td align="left">blinky_ns.sct.ftl </td><td align="left">blinky_ns.sct </td><td align="left">Scatter file for non-secure zone. </td></tr> +<tr> +<td align="left">blinky_s.sct.ftl </td><td align="left">blinky_s.sct </td><td align="left">Scatter file for secure zone. </td></tr> +</table> +<p>These files can be used in any IDE to create the final application. In the following, the usage in Arm Keil MDK is described.</p> +<h1><a class="anchor" id="zTESTM32L5_MDK"></a> +Using the MDK project</h1> +<p>The example project can be loaded, built and debugged in µVision by performing the following steps:</p> +<ol type="1"> +<li>Navigate to Examples/STM32L5/MDK</li> +<li>Open the multi-project workspace blinky.uvmpw</li> +<li>Optional: Update the generated files by executing the copy_gen.bat scripts in blinky_s\mdk and blinky_ns\mdk folders.</li> +<li>Run the batch build in MDK. Both projects, blinky_s and blinky_ns need to be compiled in order.</li> +</ol> +<h1><a class="anchor" id="zTESTM32L5_MDK_Setup"></a> +MDK project setup</h1> +<p>The multiproject workspace contains the secure <code>blinky_s</code> project and the non-secure <code>blinky_ns</code> project:</p> +<div class="image"> +<img src="blinky_window.png" alt="blinky_window.png"/> +</div> +<p>The projects use the files generated in CMSIS-Zone as follows:</p> +<table class="doxtable"> +<tr> +<th align="left">File </th><th align="left">Used in </th><th align="left">Description </th></tr> +<tr> +<td align="left">mem_layout.h </td><td align="left">blinky_s, blinky_ns </td><td align="left">Input for the linker scatter files. </td></tr> +<tr> +<td align="left">partition_gen.h </td><td align="left">blinky_s </td><td align="left">Configuration of the secure attribution unit (SAU) and the NVIC interrupt assignment. This file is included in the partition_stm32l5xx.h header file. </td></tr> +<tr> +<td align="left">SystemIsolation_Config.c </td><td align="left">blinky_s </td><td align="left">Setup of the MPC and PPC. </td></tr> +<tr> +<td align="left">blinky_ns.sct </td><td align="left">blinky_ns </td><td align="left">Scatter file for non-secure zone (initally based on generated file). </td></tr> +<tr> +<td align="left">blinky_s.sct </td><td align="left">blinky_s </td><td align="left">Scatter file for secure zone (initally based on generated file). </td></tr> +</table> +<dl class="section note"><dt>Note</dt><dd>If you want to learn more about the general project layout for an Armv8-M project using TrustZone, refer to <a href="https://www.keil.com/appnotes/docs/apnt_291.asp" target="_blank">Application Note 291</a>.</dd></dl> +<h2><a class="anchor" id="zTESTM32L5_hwsScatter"></a> +blinky_s.sct</h2> +<p>As explained previously, the #defines in <code>mem_layout.h</code> can be used to create generic scatter files that are easy to update once changes in the CMSIS-Zone project happen. Using the <b>mem_layout.h</b> file from CMSIS-Zone, the following scatter file is used in the secure <code>blinky</code> project, which is based on the generated scatterf file (scatter_s.sct):</p> +<div class="fragment"><div class="line">; Use Arm compiler 6 to pre-process the scatter file and pull in the defines from the mem_layout.h file:</div> +<div class="line"><span class="preprocessor">#! armclang -E --target=arm-arm-none-eabi -mcpu=cortex-m33 -I../ -xc</span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line"><span class="preprocessor">#include "mem_layout.h"</span></div> +<div class="line"></div> +<div class="line">; *------- <<< Use Configuration Wizard in Context Menu >>> ------------------</div> +<div class="line"></div> +<div class="line">;<h> Stack Configuration</div> +<div class="line">; <o> Stack Size (in Bytes) <0x0-0xFFFFFFFF:8></div> +<div class="line">;</h></div> +<div class="line"><span class="preprocessor">#define STACK_SIZE 0x400</span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line">;<h> Heap Configuration</div> +<div class="line">; <o> Heap Size (in Bytes) <0x0-0xFFFFFFFF:8></div> +<div class="line">;</h></div> +<div class="line"><span class="preprocessor">#define HEAP_SIZE 0xC00</span></div> +<div class="line"><span class="preprocessor"></span></div> +<div class="line">; *-------------- <<< end of configuration section >>> -----------------------</div> +<div class="line">LR_CODE_S REGION_CODE_S_START REGION_CODE_S_SIZE {</div> +<div class="line"> ER_CODE_S REGION_CODE_S_START REGION_CODE_S_SIZE {</div> +<div class="line"> (RESET,+FIRST)</div> +<div class="line"> (InRoot$$Sections)</div> +<div class="line"> .ANY (+RO +XO)</div> +<div class="line"> }</div> +<div class="line"> RW_DATA_S REGION_DATA_S_START REGION_DATA_S_SIZE-HEAP_SIZE-STACK_SIZE {</div> +<div class="line"> .ANY (+RW +ZI)</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#if HEAP_SIZE>0</span></div> +<div class="line"><span class="preprocessor"></span> ARM_LIB_HEAP REGION_DATA_S_START+REGION_DATA_S_SIZE-HEAP_SIZE-STACK_SIZE EMPTY HEAP_SIZE {</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#endif</span></div> +<div class="line"><span class="preprocessor"></span><span class="preprocessor">#if STACK_SIZE>0</span></div> +<div class="line"><span class="preprocessor"></span> ARM_LIB_STACK REGION_DATA_S_START+REGION_DATA_S_SIZE-STACK_SIZE EMPTY STACK_SIZE {</div> +<div class="line"> }</div> +<div class="line"><span class="preprocessor">#endif </span></div> +<div class="line"><span class="preprocessor"></span>}</div> +<div class="line">LR_Veneer REGION_VENEER_START REGION_VENEER_SIZE {</div> +<div class="line"> ER_Veneer REGION_VENEER_START REGION_VENEER_SIZE {</div> +<div class="line"> (Veneer$$CMSE)</div> +<div class="line"> }</div> +<div class="line">}</div> +</div><!-- fragment --><p>The partition_gen.h header file contains Configuration Wizard annotation so that it can be viewed in a graphical window:</p> +<div class="image"> +<img src="partition_h_l5.png" alt="partition_h_l5.png"/> +</div> + </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="navelem"><a class="el" href="zTExamples.html">Examples</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> diff --git a/docs/Zone/html/zTExamples.html b/docs/Zone/html/zTExamples.html new file mode 100644 index 0000000..cffccb5 --- /dev/null +++ b/docs/Zone/html/zTExamples.html @@ -0,0 +1,154 @@ +<!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>Examples</title> +<title>CMSIS-Zone (Preview): Examples</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTExamples.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Examples </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The following projects are available in the CMSIS-Zone repository on GitHub: <a href="https://github.com/ARM-software/CMSIS-Zone/tree/master/Examples">https://github.com/ARM-software/CMSIS-Zone/tree/master/Examples</a>. These examples demonstrate the usage of the CMSIS-Zone utility.</p> +<table class="doxtable"> +<tr> +<th align="left">Example </th><th align="left">Description </th></tr> +<tr> +<td align="left"><a class="el" href="zTEMusca.html">Arm Musca-A1</a> </td><td align="left">Musca project </td></tr> +<tr> +<td align="left"><a class="el" href="zTELPC55.html">NXP LPC55S69</a> </td><td align="left">Single processor Cortex-M33 project with TrustZone setup </td></tr> +<tr> +<td align="left"><a class="el" href="zTESTM32L5.html">STMicroelectronics STM32L5</a> </td><td align="left">Single processor Cortex-M33 project with TrustZone setup </td></tr> +</table> +<h1><a class="anchor" id="zTExImport"></a> +Import examples</h1> +<p>Import the examples to Eclipse using the following flow:</p> +<ul> +<li>Go to <b>File - Import</b> and select <b>General - Existing Projects into Workspace</b>:</li> +</ul> +<div class="image"> +<img src="import_from_file.png" alt="import_from_file.png"/> +</div> +<p>Click <b>Next</b>.</p> +<p>Browse to the root directory, for example "Examples\LPC55S69\Zone", and select the project that you want to import. The import projects window shows the available projects:</p> +<div class="image"> +<img src="import_projects.png" alt="import_projects.png"/> +</div> +<p>Click <b>Finish</b>. The project is imported and opened in the <a class="el" href="zTUI.html#zTProjEx">Project Explorer</a>. </p> +</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> diff --git a/docs/Zone/html/zTExamples.js b/docs/Zone/html/zTExamples.js new file mode 100644 index 0000000..f0c7eaf --- /dev/null +++ b/docs/Zone/html/zTExamples.js @@ -0,0 +1,20 @@ +var zTExamples = +[ + [ "Import examples", "zTExamples.html#zTExImport", null ], + [ "Arm Musca-A1", "zTEMusca.html", null ], + [ "NXP LPC55S69", "zTELPC55.html", [ + [ "Using the CMSIS-Zone project", "zTELPC55.html#zTELPC55_Eclipse", null ], + [ "Using the MDK project", "zTELPC55.html#zTELPC55_MDK", null ], + [ "MDK project setup", "zTELPC55.html#zTELPC55_MDK_Setup", [ + [ "hello_world_s.sct", "zTELPC55.html#zTELPC55_hwsScatter", null ], + [ "TrustZone Setup at Startup", "zTELPC55.html#zTELPC55_TZSetup", null ] + ] ] + ] ], + [ "STMicroelectronics STM32L5", "zTESTM32L5.html", [ + [ "Using the CMSIS-Zone project", "zTESTM32L5.html#zTESTM32L5_Eclipse", null ], + [ "Using the MDK project", "zTESTM32L5.html#zTESTM32L5_MDK", null ], + [ "MDK project setup", "zTESTM32L5.html#zTESTM32L5_MDK_Setup", [ + [ "blinky_s.sct", "zTESTM32L5.html#zTESTM32L5_hwsScatter", null ] + ] ] + ] ] +];
\ No newline at end of file diff --git a/docs/Zone/html/zTInstall.html b/docs/Zone/html/zTInstall.html new file mode 100644 index 0000000..b206179 --- /dev/null +++ b/docs/Zone/html/zTInstall.html @@ -0,0 +1,135 @@ +<!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>Installation</title> +<title>CMSIS-Zone (Preview): Installation</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTInstall.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Installation </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>CMSIS-Zone is currently available as an executable Eclipse environment. Download the zipped archive from <a href="" target="_blank">here</a> and save it to your computer. Unzip it and run CDT_2019_3\eclipse\eclipse.exe.</p> +<p>Before creating the first project, you have to point the tool to your pack repository so that it can pick up relevant device information. Go to <b>Window - Preferences</b> and select <b>CMSIS Packs</b>:</p> +<div class="image"> +<img src="CMSISPacksPreferences.png" alt="CMSISPacksPreferences.png"/> +</div> +<p>Browse to your pack root folder, usually <code>C:\users\username\AppData\Local\Arm\Packs</code>. Click <b>Apply and Close</b>.</p> +<p>This concludes the installation and setup of the Eclipse environment. </p> +</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> diff --git a/docs/Zone/html/zTInteractiveMode.html b/docs/Zone/html/zTInteractiveMode.html new file mode 100644 index 0000000..3228cd6 --- /dev/null +++ b/docs/Zone/html/zTInteractiveMode.html @@ -0,0 +1,135 @@ +<!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>Interactive Mode</title> +<title>CMSIS-Zone (Preview): Interactive Mode</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTInteractiveMode.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Interactive Mode </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The following section explains the interactive mode of the CMSIS-Zone Utility. The following steps are explained:</p> +<ul> +<li><a class="el" href="zTUICreateProject.html">Create a CMSIS-Zone Project</a> that allows to manage system resources.</li> +<li><a class="el" href="zTUIMemPerRes.html">Memory and Peripheral Resources</a> allows to create sub-memory regions and defines properties such as access permissions.</li> +<li><a class="el" href="zTUIZonePart.html">Zone Partitioning</a> that assigns available resources to sub-projects or execution compartments.</li> +<li><a class="el" href="zTUIGenerate.html">Generate output files</a> for device configuration and linker settings. </li> +</ul> +</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> diff --git a/docs/Zone/html/zTInteractiveMode.js b/docs/Zone/html/zTInteractiveMode.js new file mode 100644 index 0000000..34d1833 --- /dev/null +++ b/docs/Zone/html/zTInteractiveMode.js @@ -0,0 +1,15 @@ +var zTInteractiveMode = +[ + [ "Create a CMSIS-Zone Project", "zTUICreateProject.html", null ], + [ "Memory and Peripheral Resources", "zTUIMemPerRes.html", [ + [ "View memory and peripheral resources", "zTUIMemPerRes.html#zTUIMemView", null ], + [ "Create Memory Regions", "zTUIMemPerRes.html#zTUIMemAdd", null ], + [ "Delete Memory Regions", "zTUIMemPerRes.html#zTUIMemDel", null ], + [ "Resource Properties", "zTUIMemPerRes.html#zTUIPerProp", null ], + [ "Configure peripheral slot access rights", "zTUIMemPerRes.html#zTUIPerSlotConf", null ] + ] ], + [ "Zone Partitioning", "zTUIZonePart.html", [ + [ "Create Zones", "zTUIZonePart.html#zTUICreate", null ] + ] ], + [ "Generate output files", "zTUIGenerate.html", null ] +];
\ No newline at end of file diff --git a/docs/Zone/html/format_device.html b/docs/Zone/html/zTUI.html index d322a34..1fa455c 100644 --- a/docs/Zone/html/format_device.html +++ b/docs/Zone/html/zTUI.html @@ -3,8 +3,8 @@ <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> -<title>/device element</title> -<title>CMSIS-Zone (Preview): /device element</title> +<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> @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -88,7 +88,7 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search'); </div> </div> <script type="text/javascript"> -$(document).ready(function(){initNavTree('format_device.html','');}); +$(document).ready(function(){initNavTree('zTUI.html','');}); </script> <div id="doc-content"> <!-- window showing the filter options --> @@ -107,70 +107,89 @@ $(document).ready(function(){initNavTree('format_device.html','');}); <div class="header"> <div class="headertitle"> -<div class="title">/device element </div> </div> +<div class="title">User Interface </div> </div> </div><!--header--> <div class="contents"> -<div class="textblock"><p>The <b>device</b> element is used to define one integral System-on-Chip (SoC) device.</p> -<p><b>Example</b> </p> -<div class="fragment"><div class="line"><device Dname=<span class="stringliteral">"ARM32CM4128x"</span>></div> -<div class="line"> <<span class="keyword">package </span>name="ARM32CM4xxx_DFP" url="http:<span class="comment">//www.keil.com/pack" vendor="ARM" version="1.8.15"/></span></div> -<div class="line"></div> -<div class="line"> <processor Pname="Cortex-M4"></div> -<div class="line"> :</div> -<div class="line"> </processor></div> -<div class="line"> :</div> -<div class="line"> </div> -<div class="line"> <!-- Device uniform memory map --></div> -<div class="line"> <memory_map></div> -<div class="line"> <!-- Logical address to access integrated SRAM --></div> -<div class="line"> <memory name="SRAM" start="0x10000000"/></div> -<div class="line"> :</div> -<div class="line"> </memory_map></div> -<div class="line"> </div> -<div class="line"> <resources></div> -<div class="line"> <memory></div> -<div class="line"> <!-- 512KB SRAM integrated on the SoC --></div> -<div class="line"> <region name="SRAM" size="0x80000" access="rwx" info="Internal SRAM (512KB)"/></div> -<div class="line"> :</div> -<div class="line"> </memory></div> -<div class="line"> </resources></div> -<div class="line"></device></div> -</div><!-- fragment --><p><b>Schema Description</b></p> -<table class="cmtable" summary="Element: Device"> +<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> -<th>Parent Element </th><th colspan="3">Element Chain </th></tr> +<td><code>zone.rzone</code> </td><td>Zone-level <a class="el" href="zoneFormat.html#rzone">.rzone</a> file </td></tr> <tr> -<td><a class="el" href="format_system.html">system</a> </td><td colspan="3"><a class="el" href="format_system.html">/system element</a> </td></tr> +<td><code>*.ftl</code> </td><td>Freemarker template file used to <a class="el" href="GenDataModel.html">generate</a> output </td></tr> <tr> -<th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr> +<td><code>helper.ftlinc</code> </td><td>Helper file to generate Freemarker output </td></tr> <tr> -<td>Dfamily </td><td>The familiy name the device belongs to. </td><td>xs:string </td><td>optional </td></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> -<td>DsubFamily </td><td>The sub familiy name the device belongs to. </td><td>xs:string </td><td>optional </td></tr> +<th>Color </th><th>Meaning </th></tr> <tr> -<td>Dname </td><td>The device name. </td><td>xs:string </td><td>required </td></tr> +<td>Green </td><td>Resource is assigned to one zone </td></tr> <tr> -<td>Dvendor </td><td>The devices vendor identifier. </td><td>xs:string </td><td>required </td></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> -<td>info </td><td>Brief description of the device. </td><td>xs:string </td><td>optional </td></tr> +<th>Button </th><th>Description </th></tr> <tr> -<th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr> +<td>Tree View </td><td>Shows the resources as a tree </td></tr> <tr> -<td><a class="el" href="format_package.html">package</a> </td><td>Optional reference to the Software Pack this device is provided by. </td><td>complexType </td><td>0..1 </td></tr> +<td>List View </td><td>Shows the resources as a simple list </td></tr> <tr> -<td><a class="el" href="format_processor.html">processor</a> </td><td>Processing elements and associated features embedded in the device. </td><td>complexType </td><td>1..* </td></tr> +<td>Arrange memory regions </td><td>Arranges memory regions according to their sizes </td></tr> <tr> -<td><a class="el" href="format_resources.html">resources</a> </td><td>Memory and peripheral resources embedded in the device. In contrast to resources defined on system level those at device level are only accessible from processors located on the same enclosing device. </td><td>complexType </td><td>0..1 </td></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="format_memory_map.html">memory_map</a> </td><td>All <em>physical</em> resources are accessible using <em>logical</em> memory addresses, i.e. typically called memory map. Common logical addresses valid for all processing elements can be defined at device level memory map, i.e. devices with an uniform memory map. Refer to the individual processor memory map for devices with non-uniform memory maps. </td><td>complexType </td><td>0..1 </td></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="XML_Format.html">Zone Description Format</a></li><li class="navelem"><a class="el" href="format_system.html">/system element</a></li> - <li class="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <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 diff --git a/docs/Zone/html/zTUICreateProject.html b/docs/Zone/html/zTUICreateProject.html new file mode 100644 index 0000000..19a17c5 --- /dev/null +++ b/docs/Zone/html/zTUICreateProject.html @@ -0,0 +1,141 @@ +<!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>Create a CMSIS-Zone Project</title> +<title>CMSIS-Zone (Preview): Create a CMSIS-Zone Project</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTUICreateProject.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Create a CMSIS-Zone Project </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>Go to <b>File - New - Project</b> and select <b>CMSIS - CMSIS-Zone Project</b>:</p> +<div class="image"> +<img src="zone_project.png" alt="zone_project.png"/> +</div> +<p>Click <b>Next</b>. In the next window, enter a <b>Project</b> <b>name:</b> </p> +<div class="image"> +<img src="SetProjectName.png" alt="SetProjectName.png"/> +</div> +<p>Click <b>Next</b>. In the next window, select <b>Use existing resource file (*.rzone)</b> and browse to the location of the .rzone file:</p> +<div class="image"> +<img src="SpecifyRzoneFile.png" alt="SpecifyRzoneFile.png"/> +</div> +<p>Click <b>Finish</b>. The new project is created and an empty *.azone file is added. </p> +</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="navelem"><a class="el" href="zTInteractiveMode.html">Interactive Mode</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> diff --git a/docs/Zone/html/zTUIGenerate.html b/docs/Zone/html/zTUIGenerate.html new file mode 100644 index 0000000..e50fb83 --- /dev/null +++ b/docs/Zone/html/zTUIGenerate.html @@ -0,0 +1,142 @@ +<!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>Generate output files</title> +<title>CMSIS-Zone (Preview): Generate output files</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTUIGenerate.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Generate output files </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The CMSIS-Zone utility can generate files that represent the configuration of the system. These files can be used in the project source files or tool configuration files.</p> +<p>other toolchains for further development. The generator process creates:</p> +<ul> +<li>Configuration files for tool and hardware setup, that are defined by <a class="el" href="GenDataModel.html">.ftl files</a> in the project <code>ftl</code> directory.</li> +<li>Files that represent <a class="el" href="zTUIZonePart.html#zTUICreate">sub-systems</a> (<a class="el" href="zoneFormat.html#rzone">.rzone</a> and <a class="el" href="zoneFormat.html#azone">.azone</a>) that can be partitioned further (restart the process).</li> +</ul> +<p>To start the generation, press the <b>Generate</b> button or use the menu item <b>CMSIS Zone - Generate</b>:</p> +<div class="image"> +<img src="GenCodeButton.png" alt="GenCodeButton.png"/> +</div> +<p>Check <a class="el" href="zTUI.html#zTProjEx">Project Explorer</a> to observe the changes. In the project, the generated <code></code>.azone and <code></code>.rzone files appear and the <code>ftl_gen</code> directory contains the files defined by the <code>ftl</code> template files:</p> +<div class="image"> +<img src="gen_output.png" alt="gen_output.png"/> +</div> + </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="navelem"><a class="el" href="zTInteractiveMode.html">Interactive Mode</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> diff --git a/docs/Zone/html/zTUIMemPerRes.html b/docs/Zone/html/zTUIMemPerRes.html new file mode 100644 index 0000000..73c6096 --- /dev/null +++ b/docs/Zone/html/zTUIMemPerRes.html @@ -0,0 +1,211 @@ +<!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>Memory and Peripheral Resources</title> +<title>CMSIS-Zone (Preview): Memory and Peripheral Resources</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTUIMemPerRes.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Memory and Peripheral Resources </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The available memory can be further divided into <a class="el" href="zTUIMemPerRes.html#zTUIMemAdd">smaller regions</a> that are later assigned to zones, for example a zone for loader and zone for application.</p> +<p>For memory and peripherals <a class="el" href="zTUIMemPerRes.html#zTUIPerProp">properties</a> such as access permission, privilege, and security level can be configured. These settings can be for example used to generate source code files that configure the device at run-time.</p> +<h1><a class="anchor" id="zTUIMemView"></a> +View memory and peripheral resources</h1> +<p>Initially, this uses the information in the *.rzone file which defines the generic access permissions for memory and peripherals. The CMSIS-Zone Editor shows the <b>Resource</b> <b>Map</b> of the given device:</p> +<div class="image"> +<img src="lpc55_resource_map.png" alt="lpc55_resource_map.png"/> +</div> +<p>Here, you can see all resources that are available on the device.You see <b>Memory</b>, <b>Peripherals</b>, <b>Cores</b>, and <b>Info</b> related to the resources. <a class="el" href="zTUI.html#zTGUIZoneEditor">Colored resources</a> are assigned to a zone.</p> +<h1><a class="anchor" id="zTUIMemAdd"></a> +Create Memory Regions</h1> +<p>To create a new memory region, right-click on the memory that you want to divide and select <b>Add memory region</b>:</p> +<div class="image"> +<img src="AddMemoryBlock.png" alt="AddMemoryBlock.png"/> +</div> +<p>In the dialog a name derived from the parent memory region is provided. Change this region name as needed and specify the size. In this dialog, you change permissions, privilege, or security level for the memory region. When done, click <b>Finish:</b> </p> +<div class="image"> +<img src="NewMemoryBlockWiz.png" alt="NewMemoryBlockWiz.png"/> +</div> +<p>The new memory region is immediately shown in the zone map. Depending on the security level, you may be able to assign this new region only to certain zones. For example, secure memory regions cannot be assigned to a non-secure zone.</p> +<div class="image"> +<img src="IRAM1_1Display.png" alt="IRAM1_1Display.png"/> +</div> +<p>The information about the memory regions is stored in the <a class="el" href="xml_partition.html#xml_amemory">/azone/partition/memory element</a> element of the *.azone file.</p> +<h1><a class="anchor" id="zTUIMemDel"></a> +Delete Memory Regions</h1> +<p>To delete a memory region, right-click on the memory region select <b>Delete memory region</b>:</p> +<div class="image"> +<img src="DelMemoryRegion.png" alt="DelMemoryRegion.png"/> +</div> +<h1><a class="anchor" id="zTUIPerProp"></a> +Resource Properties</h1> +<p>To change the properties of a resource, such as a peripheral for example, right-click the resource and select <b>Properties:</b> </p> +<div class="image"> +<img src="res_prop.png" alt="res_prop.png"/> +</div> +<p>Then, you can set these properties:</p> +<div class="image"> +<img src="peripheral_properties.png" alt="peripheral_properties.png"/> +</div> +<p><b>General</b> </p> +<ul> +<li><code>Shared:</code> the resource can be accessed by more than one zone</li> +<li><code>Startup:</code> locate the vector table to this region</li> +<li><code>No</code> zero init: preserve RAM content at startup</li> +<li><code>DMA:</code> enable direct memory access</li> +</ul> +<p><b>Permissions</b> </p> +<ul> +<li><code>peripheral:</code> mark this as a peripheral</li> +<li><code>read</code> </li> +<li><code>write</code> </li> +<li><code>execute</code> </li> +</ul> +<p><b>Privilege</b> </p> +<ul> +<li><code>not</code> specified</li> +<li><code>privileged</code> </li> +<li><code>unprivileged</code> </li> +</ul> +<p><b>Security</b> </p> +<ul> +<li><code>not</code> specified</li> +<li><code>non-secure</code> </li> +<li><code>non-secure</code> callable</li> +<li><code>secure</code> </li> +</ul> +<p>The information about the peripherals is stored in the <a class="el" href="xml_partition.html#xml_aperipheral">/azone/partition/peripheral element</a> element of the *.azone file.</p> +<h1><a class="anchor" id="zTUIPerSlotConf"></a> +Configure peripheral slot access rights</h1> +<p>Peripherals can have so called slots that can be configured separately. Depending on the peripheral, the slots have different names in the Zone Editor. For example, for DMA they are called <b>Channels:</b> </p> +<div class="image"> +<img src="dma_channel_config.png" alt="dma_channel_config.png"/> +</div> +<p>For GPIOs, they are called <b>Pins:</b> </p> +<div class="image"> +<img src="gpio_pins_config.png" alt="gpio_pins_config.png"/> +</div> +<p>In the dialog, you can set security and privilege levels:</p> +<div class="image"> +<img src="dma_gpio_config.png" alt="dma_gpio_config.png"/> +</div> +<p>The information about the slots is stored in the <a class="el" href="xml_partition.html#xml_aslot">/azone/partition/peripheral/slot element</a> element of the *.azone file. </p> +</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="navelem"><a class="el" href="zTInteractiveMode.html">Interactive Mode</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> diff --git a/docs/Zone/html/zTUIZonePart.html b/docs/Zone/html/zTUIZonePart.html new file mode 100644 index 0000000..169556b --- /dev/null +++ b/docs/Zone/html/zTUIZonePart.html @@ -0,0 +1,151 @@ +<!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>Zone Partitioning</title> +<title>CMSIS-Zone (Preview): Zone Partitioning</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zTUIZonePart.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Zone Partitioning </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>Every CMSIS-Zone project consists of one or more zones. The basic flow to create zones is as follows:</p> +<ul> +<li>In case of multi-core devices, create a zone for each processor.</li> +<li>Then create at least one zone for each processor to be able to assign memories and peripherals. If your device contains Arm Cortex-M cores supporting TrustZone for Armv8-M, create a secure and a non-secure partition for each of these cores.</li> +</ul> +<h1><a class="anchor" id="zTUICreate"></a> +Create Zones</h1> +<p>To split a multi-processor system into single-processor sub-systems, you need to create new zones. Switch to the <b>Zones</b> tab and click the <b>Add new zone</b> button:</p> +<div class="image"> +<img src="AddNewZoneButton.png" alt="AddNewZoneButton.png"/> +</div> +<p>In the new window, you need to specify a name for the zone, select the applicable core, and choose the security level (secure/non-secure).</p> +<p>In the <a class="el" href="zTEMusca.html">Musca</a> example, a new zone called "CM33_0" was created and attached to processor core 0 without any security attribute (not specified):</p> +<div class="image"> +<img src="NewZoneCM33_0.png" alt="NewZoneCM33_0.png"/> +</div> +<p>Similarly, an additional zone called "CM33_1" was created and attached to processor core 1, without security attribute.</p> +<p><b>Save</b> your settings:</p> +<div class="image"> +<img src="SaveButton.png" alt="SaveButton.png"/> +</div> +<dl class="section note"><dt>Note</dt><dd></dd></dl> +<p>Adding zones only works for the currently opened <a class="el" href="zoneFormat.html#azone">.azone</a> file. The information about the zones is stored in the <a class="el" href="xml_zones.html">/azone/zones element</a> element of the *.azone file. </p> +</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="navelem"><a class="el" href="zTInteractiveMode.html">Interactive Mode</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> diff --git a/docs/Zone/html/zone-assignment.png b/docs/Zone/html/zone-assignment.png Binary files differdeleted file mode 100644 index 30d373b..0000000 --- a/docs/Zone/html/zone-assignment.png +++ /dev/null diff --git a/docs/Zone/html/zoneFormat.html b/docs/Zone/html/zoneFormat.html new file mode 100644 index 0000000..0b68597 --- /dev/null +++ b/docs/Zone/html/zoneFormat.html @@ -0,0 +1,249 @@ +<!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>Zone Description Format</title> +<title>CMSIS-Zone (Preview): Zone Description Format</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zoneFormat.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">Zone Description Format </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The <b>Zone Description Format</b> is a tool agnostic storage format and is split into:</p> +<ul> +<li><b>Resource File (*.rzone)</b> that describes the system resources available.</li> +<li><b>Assignment File (*.azone)</b> that describes the resource partitioning.</li> +</ul> +<p>The combination of both <b>Resource File</b> and <b>Assignment File</b> can be used to create a new derived <b>Resource File</b> that only contains the resources available for this project. It is therefore possible to split the resources incrementally as needed.</p> +<p>A <b>Resource File (*.rzone)</b> can therefore describe:</p> +<ul> +<li>A complete embedded system including device with one or more processors, external memory and/or external peripheral components.</li> +<li>TrustZone definition and initial setting for Secure Attribute Unit</li> +<li>A resource partition for an independent software project (i.e. boot loader, user application, secure partition) that implement the application for the system.</li> +</ul> +<p>An <b>Assignment File (*.azone)</b> allows to specify either:</p> +<ul> +<li>The partitioning of a system into multiple independent software projects.</li> +<li>The configuration of a Memory Protection Unit (MPU) for functional segregation of a software project.</li> +</ul> +<dl class="section note"><dt>Note</dt><dd>It is impossible to use a single <b>Assignment File</b> for both, partitioning of software projects and MPU configuration.</dd></dl> +<h1><a class="anchor" id="XML_Format_Schema"></a> +Overall XML structure</h1> +<p>The CMSIS-Zone utility uses two XML files to store system and configuration information. The structure these XML files is described with schema files that are located in the ARM.CMSIS pack in the directory .\CMSIS\Utilities.</p> +<table class="doxtable"> +<tr> +<th align="left">File type </th><th align="left">Schema file </th><th align="left">Description </th></tr> +<tr> +<td align="left"><a class="el" href="zoneFormat.html#rzone">*.rzone</a> </td><td align="left">rzone.xsd </td><td align="left">Stores the system resources (processors, memory, peripherals) available. </td></tr> +<tr> +<td align="left"><a class="el" href="zoneFormat.html#azone">*.azone</a> </td><td align="left">azone.xsd </td><td align="left">Stores the system partitioning which includes assignments and memory splits for a related .rzone file. </td></tr> +<tr> +<td align="left">.fzone </td><td align="left">fzone.xsd </td><td align="left">CMSIS-Zone data input file for FreeMarker as explained in <a class="el" href="GenDataModel.html">Generator Data Model</a>. </td></tr> +</table> +<dl class="section note"><dt>Note</dt><dd>It is important to understand the relationship between *.rzone and *.azone files. While the *.rzone file contains all the information about the available resources in a system or sub-system, the *.azone file contains all the information about the system partitioning. If the *.rzone file changes (for example because the partitioning of a sub-system has changed), you will not loose the work done on the partitioning of that sub-system. If resources are removed, the <a class="el" href="zTUI.html#zTGUI">CMSIS-Zone GUI</a> will notify you about this and you can make the required changes.</dd></dl> +<p><a class="anchor" id="rzone"></a></p> +<h1>Top-level .rzone XML elements </h1> +<ul> +<li><a class="el" href="xml_rzone_pg.html"><rzone></a> is the root element of the *.rzone file.</li> +<li><a class="el" href="xml_creator.html"><creator></a> describes the creation for this *.rzone file.</li> +<li><a class="el" href="xml_device.html"><device></a> describes the device that is part of the system. It may contain one or more processors.</li> +<li><a class="el" href="xml_resources.html"><resources></a> describes the memory and peripheral resources of the system.</li> +</ul> +<h2>Structure of .rzone XML file </h2> +<div class="fragment"><div class="line"><rzone> <span class="comment">// root element of system zone file</span></div> +<div class="line"> <creator> <span class="comment">// describes how this rzone file was created</span></div> +<div class="line"> </div> +<div class="line"> <device> <span class="comment">// device information</span></div> +<div class="line"> <package/> <span class="comment">// software pack that defines device</span></div> +<div class="line"> <processor/> <span class="comment">// processor information</span></div> +<div class="line"> </device></div> +<div class="line"></div> +<div class="line"> </div> +<div class="line"> <resources> <span class="comment">// physical resources off-chip </span></div> +<div class="line"> <sau_init> <span class="comment">// fixed SAU settings required for system</span></div> +<div class="line"> <region/> <span class="comment">// region setting for SAU</span></div> +<div class="line"> </sau_init></div> +<div class="line"> </div> +<div class="line"> <memories> <span class="comment">// memories section </span></div> +<div class="line"> <memory> <span class="comment">// memory resource</span></div> +<div class="line"> <mpc> <span class="comment">// memory protection controller information</span></div> +<div class="line"> </memories></div> +<div class="line"> </div> +<div class="line"> <peripherals> <span class="comment">// peripheral resources off-chip</span></div> +<div class="line"> { <group> } <span class="comment">// peripheral group (optional)</span></div> +<div class="line"> <peripheral> <span class="comment">// peripheral description</span></div> +<div class="line"> { <slot> } <span class="comment">// slot description (optional)</span></div> +<div class="line"> <interrupt/> <span class="comment">// optional interrupts for peripheral</span></div> +<div class="line"> <setup/> <span class="comment">// optional register setup for peripheral</span></div> +<div class="line"> { <slot> }</div> +<div class="line"> </peripheral></div> +<div class="line"> { </group> } <span class="comment">// peripheral group (optional)</span></div> +<div class="line"> </peripherals></div> +<div class="line"> </resources></div> +<div class="line"></rzone></div> +</div><!-- fragment --><p><a class="anchor" id="azone"></a></p> +<h1>Top-level .azone XML elements </h1> +<ul> +<li><a class="el" href="xml_azone_pg.html"><azone></a> is the root element of the *.azone file.</li> +<li><a class="el" href="xml_configure.html"><configure></a> controls the behavior of the CMSIS-Zone utility (project or MPU assignments).</li> +<li><a class="el" href="xml_partition.html"><partition></a> defines memory partitions that split available system memory.</li> +<li><a class="el" href="xml_zones.html"><zones></a> defines the assignment of memory, block, and peripherals.</li> +</ul> +<div class="fragment"><div class="line"><azone></div> +<div class="line"> <rzone> <span class="comment">// Refers related .rzone file</span></div> +<div class="line"> <configure> <span class="comment">// CMSIS-Zone utility UI behavior</span></div> +<div class="line"> </div> +<div class="line"> <partition> <span class="comment">// memory partition information</span></div> +<div class="line"> <memory> <span class="comment">// memory split information </span></div> +<div class="line"> </partition></div> +<div class="line"> </div> +<div class="line"> <zones> <span class="comment">// zone assignments</span></div> +<div class="line"> <zone> <span class="comment">// project zone name</span></div> +<div class="line"> <assign> <span class="comment">// used peripheral or memory</span></div> +<div class="line"> <interrupt/> <span class="comment">// for peripherals optional interrupt usage</span></div> +<div class="line"> </assign></div> +<div class="line"> </zone></div> +<div class="line"> </zones></div> +<div class="line"></azone></div> +</div><!-- fragment --><p><a class="anchor" id="security"></a></p> +<h1>Security Type </h1> +<p>The attribute <em>security</em> defines the security setting for a memory or peripheral region. Only one of the settings is allow:</p> +<ul> +<li><empty> security not defined (default)</li> +<li>'n' non-secure</li> +<li>'c' secure on non-secure callable</li> +<li>'s' secure</li> +</ul> +<p><a class="anchor" id="access"></a></p> +<h1>Access Type </h1> +<p>The attribute <em>access</em> defines the access permission for a memory or peripheral region. Multiple settings are allow:</p> +<ul> +<li>'r' read</li> +<li>'w' write</li> +<li>'x' execute</li> +<li>'p' peripheral</li> +</ul> +<p><a class="anchor" id="privilege"></a></p> +<h1>Privilege Type </h1> +<p>The attribute <em>privilege</em> defines the privilege level that is required for memory/peripheral access or code execution in a MPU zone. Only one of the settings is allow:</p> +<ul> +<li><empty> privilege level not specified</li> +<li>'u' unprivileged level</li> +<li>'p' privileged level </li> +</ul> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> diff --git a/docs/Zone/html/zoneFormat.js b/docs/Zone/html/zoneFormat.js new file mode 100644 index 0000000..feaa7bf --- /dev/null +++ b/docs/Zone/html/zoneFormat.js @@ -0,0 +1,6 @@ +var zoneFormat = +[ + [ "Overall XML structure", "zoneFormat.html#XML_Format_Schema", null ], + [ "/rzone element", "xml_rzone_pg.html", "xml_rzone_pg" ], + [ "/azone element", "xml_azone_pg.html", "xml_azone_pg" ] +];
\ No newline at end of file diff --git a/docs/Zone/html/zoneToolUsage.html b/docs/Zone/html/zoneToolUsage.html new file mode 100644 index 0000000..a6f7af6 --- /dev/null +++ b/docs/Zone/html/zoneToolUsage.html @@ -0,0 +1,147 @@ +<!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>CMSIS-Zone Utility</title> +<title>CMSIS-Zone (Preview): CMSIS-Zone Utility</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) +  <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 Page</span></a></li> + <li class="current"><a href="pages.html"><span>Usage and 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('zoneToolUsage.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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </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">CMSIS-Zone Utility </div> </div> +</div><!--header--> +<div class="contents"> +<div class="textblock"><p>The section describes the CMSIS-Zone Utility which is currently a stand-alone Eclipse implementation that allows you to:</p> +<ul> +<li><a class="el" href="zTUIMemPerRes.html#zTUIMemView">View the memory and peripheral resources</a> of a complete system or sub-system.</li> +<li><a class="el" href="zTUIMemPerRes.html#zTUIMemAdd">Partition memory blocks</a> into smaller regions and define access permissions for these regions.</li> +<li><a class="el" href="zTUIMemPerRes.html#zTUIPerProp">Define access permissions</a> for peripherals.</li> +<li><a class="el" href="zTUIMemPerRes.html#zTUIPerSlotConf">Configure access rights of peripheral slots</a> (for example for DMA channels or I/O pins).</li> +<li><a class="el" href="zTUIZonePart.html">Split memory and peripheral resources into zones</a> (used for sub-projects or process separation in RTOS systems).</li> +<li><a class="el" href="zTUIGenerate.html">Generate</a> configuration files for tool and hardware setup, as well as</li> +<li><a class="el" href="zTUIGenerate.html">Generate</a> resource files for sub-systems that allow further partitioning.</li> +</ul> +<p>This section describes:</p> +<ul> +<li><a class="el" href="zTInstall.html">Installation</a> shows how to install the utility.</li> +<li><a class="el" href="zTUI.html">User Interface</a> introduces the GUI of the CMSIS-Zone Utility.</li> +<li><a class="el" href="zTInteractiveMode.html">Interactive Mode</a> explains how to create projects and zones using the GUI.</li> +<li><a class="el" href="zTCLI.html">Command Line Mode</a> demonstrates how to work with the command line interface.</li> +<li><a class="el" href="zTExamples.html">Examples</a> contains ready-to-use projects for various devices.</li> +</ul> +<dl class="section note"><dt>Note</dt><dd></dd></dl> +<p>It is assumed that you are familiar with Eclipse and <a href="https://arm-software.github.io/CMSIS_5/Pack/html/index.html" target="_blank">CMSIS-Packs</a>. The relevant device family pcks for your target device need to be installed on your computer. </p> +</div></div><!-- contents --> +</div><!-- doc-content --> +<!-- start footer part --> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + <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> diff --git a/docs/Zone/html/zoneToolUsage.js b/docs/Zone/html/zoneToolUsage.js new file mode 100644 index 0000000..824a307 --- /dev/null +++ b/docs/Zone/html/zoneToolUsage.js @@ -0,0 +1,14 @@ +var zoneToolUsage = +[ + [ "Installation", "zTInstall.html", null ], + [ "User Interface", "zTUI.html", [ + [ "CMSIS-Zone GUI", "zTUI.html#zTGUI", null ], + [ "Project Explorer", "zTUI.html#zTProjEx", null ], + [ "Zone Editor", "zTUI.html#zTGUIZoneEditor", [ + [ "Toolbar Buttons", "zTUI.html#zTGUIButtons", null ] + ] ] + ] ], + [ "Interactive Mode", "zTInteractiveMode.html", "zTInteractiveMode" ], + [ "Command Line Mode", "zTCLI.html", null ], + [ "Examples", "zTExamples.html", "zTExamples" ] +];
\ No newline at end of file diff --git a/docs/Zone/html/zone_map.png b/docs/Zone/html/zone_map.png Binary files differnew file mode 100644 index 0000000..a58104a --- /dev/null +++ b/docs/Zone/html/zone_map.png diff --git a/docs/Zone/html/zone_project.png b/docs/Zone/html/zone_project.png Binary files differnew file mode 100644 index 0000000..2b3877f --- /dev/null +++ b/docs/Zone/html/zone_project.png diff --git a/docs/Zone/html/zone_revisionHistory.html b/docs/Zone/html/zone_revisionHistory.html index 30e6e30..d19cbfb 100644 --- a/docs/Zone/html/zone_revisionHistory.html +++ b/docs/Zone/html/zone_revisionHistory.html @@ -32,7 +32,7 @@ <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td> <td style="padding-left: 0.5em;"> <div id="projectname">CMSIS-Zone (Preview) -  <span id="projectnumber">Version 0.0.1</span> +  <span id="projectnumber">Version 0.9.2</span> </div> <div id="projectbrief">System Resource Management</div> </td> @@ -114,14 +114,14 @@ $(document).ready(function(){initNavTree('zone_revisionHistory.html','');}); <tr> <th>Version </th><th>Description </th></tr> <tr> -<td>0.0.1 (Preview) </td><td>Initial specification draft </td></tr> +<td>0.0.3 (Preview 3) </td><td>Initial specification draft </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="footer">Generated on Wed Aug 1 2018 17:12:47 for CMSIS-Zone (Preview) by Arm Ltd. All rights reserved. + <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 |
