blob: 9c75536ba94f2dede7e9b590455c231f76a07764 [file] [log] [blame]
<!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)
&#160;<span id="projectnumber">Version 0.9.2</span>
</div>
<div id="projectbrief">System Resource Management</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<div id="CMSISnav" class="tabs1">
<ul class="tablist">
<script type="text/javascript">
<!--
writeComponentTabs.call(this);
//-->
</script>
</ul>
</div>
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('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">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Pages</a></div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="headertitle">
<div class="title">/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">&lt;zones&gt;</div>
<div class="line"> &lt;zone name=<span class="stringliteral">&quot;Network&quot;</span>&gt;</div>
<div class="line"> &lt;assign region=<span class="stringliteral">&quot;RAM1&quot;</span> block=<span class="stringliteral">&quot;Network&quot;</span> access=<span class="stringliteral">&quot;rw&quot;</span>/&gt;</div>
<div class="line"> &lt;assign group=<span class="stringliteral">&quot;UART&quot;</span> peripheral=<span class="stringliteral">&quot;USART0&quot;</span> access=<span class="stringliteral">&quot;rw&quot;</span> /&gt;</div>
<div class="line"> :</div>
<div class="line"> &lt;/zone&gt;</div>
<div class="line"> :</div>
<div class="line">&lt;/zones&gt;</div>
</div><!-- fragment --><p> &#160;</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>