diff options
Diffstat (limited to 'docs/Zone/html/zoneFormat.html')
| -rw-r--r-- | docs/Zone/html/zoneFormat.html | 249 |
1 files changed, 249 insertions, 0 deletions
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> |