xml_memories.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <title>/rzone/resources/memories element</title>
  7. <title>CMSIS-Zone: /rzone/resources/memories element</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <link href="cmsis.css" rel="stylesheet" type="text/css" />
  10. <script type="text/javascript" src="jquery.js"></script>
  11. <script type="text/javascript" src="dynsections.js"></script>
  12. <script type="text/javascript" src="printComponentTabs.js"></script>
  13. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  14. <script type="text/javascript" src="resize.js"></script>
  15. <script type="text/javascript" src="navtree.js"></script>
  16. <script type="text/javascript">
  17. $(document).ready(initResizable);
  18. $(window).load(resizeHeight);
  19. </script>
  20. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  21. <script type="text/javascript" src="search/search.js"></script>
  22. <script type="text/javascript">
  23. $(document).ready(function() { searchBox.OnSelectItem(0); });
  24. </script>
  25. </head>
  26. <body>
  27. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  28. <div id="titlearea">
  29. <table cellspacing="0" cellpadding="0">
  30. <tbody>
  31. <tr style="height: 46px;">
  32. <td id="projectlogo"><img alt="Logo" src="CMSIS_Logo_Final.png"/></td>
  33. <td style="padding-left: 0.5em;">
  34. <div id="projectname">CMSIS-Zone
  35. &#160;<span id="projectnumber">Version 1.0.0</span>
  36. </div>
  37. <div id="projectbrief">System Resource Management</div>
  38. </td>
  39. </tr>
  40. </tbody>
  41. </table>
  42. </div>
  43. <!-- end header part -->
  44. <div id="CMSISnav" class="tabs1">
  45. <ul class="tablist">
  46. <script type="text/javascript">
  47. <!--
  48. writeComponentTabs.call(this);
  49. //-->
  50. </script>
  51. </ul>
  52. </div>
  53. <!-- Generated by Doxygen 1.8.6 -->
  54. <script type="text/javascript">
  55. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  56. </script>
  57. <div id="navrow1" class="tabs">
  58. <ul class="tablist">
  59. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  60. <li class="current"><a href="pages.html"><span>Usage&#160;and&#160;Description</span></a></li>
  61. <li>
  62. <div id="MSearchBox" class="MSearchBoxInactive">
  63. <span class="left">
  64. <img id="MSearchSelect" src="search/mag_sel.png"
  65. onmouseover="return searchBox.OnSearchSelectShow()"
  66. onmouseout="return searchBox.OnSearchSelectHide()"
  67. alt=""/>
  68. <input type="text" id="MSearchField" value="Search" accesskey="S"
  69. onfocus="searchBox.OnSearchFieldFocus(true)"
  70. onblur="searchBox.OnSearchFieldFocus(false)"
  71. onkeyup="searchBox.OnSearchFieldChange(event)"/>
  72. </span><span class="right">
  73. <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  74. </span>
  75. </div>
  76. </li>
  77. </ul>
  78. </div>
  79. </div><!-- top -->
  80. <div id="side-nav" class="ui-resizable side-nav-resizable">
  81. <div id="nav-tree">
  82. <div id="nav-tree-contents">
  83. <div id="nav-sync" class="sync"></div>
  84. </div>
  85. </div>
  86. <div id="splitbar" style="-moz-user-select:none;"
  87. class="ui-resizable-handle">
  88. </div>
  89. </div>
  90. <script type="text/javascript">
  91. $(document).ready(function(){initNavTree('xml_memories.html','');});
  92. </script>
  93. <div id="doc-content">
  94. <!-- window showing the filter options -->
  95. <div id="MSearchSelectWindow"
  96. onmouseover="return searchBox.OnSearchSelectShow()"
  97. onmouseout="return searchBox.OnSearchSelectHide()"
  98. onkeydown="return searchBox.OnSearchSelectKey(event)">
  99. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  100. <!-- iframe showing the search results (closed by default) -->
  101. <div id="MSearchResultsWindow">
  102. <iframe src="javascript:void(0)" frameborder="0"
  103. name="MSearchResults" id="MSearchResults">
  104. </iframe>
  105. </div>
  106. <div class="header">
  107. <div class="headertitle">
  108. <div class="title">/rzone/resources/memories element </div> </div>
  109. </div><!--header-->
  110. <div class="contents">
  111. <div class="textblock"><p>The <a class="el" href="xml_memories.html">/rzone/resources/memories element</a> contains:</p>
  112. <ul>
  113. <li>a list of all memory regions available in this system.</li>
  114. <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>
  115. </ul>
  116. <p><b>Example</b> </p>
  117. <div class="fragment"><div class="line">&lt;resources&gt;</div>
  118. <div class="line"> &lt;memories&gt;</div>
  119. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;ExtMem1&quot;</span> start=<span class="stringliteral">&quot;0x00000000&quot;</span> physical=<span class="stringliteral">&quot;0x00000000&quot;</span> size=<span class="stringliteral">&quot;0x00010000&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> security=<span class="stringliteral">&quot;&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;External memory 1 / remap&quot;</span> external=<span class="stringliteral">&quot;true&quot;</span> /&gt;</div>
  120. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;Flash_NS&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x00080000&quot;</span> access=<span class="stringliteral">&quot;rx&quot;</span> security=<span class="stringliteral">&quot;&quot;</span> type=<span class="stringliteral">&quot;ROM&quot;</span> info=<span class="stringliteral">&quot;Flash Memory (non secure)&quot;</span> /&gt;</div>
  121. <div class="line"> &lt;mpc name=<span class="stringliteral">&quot;IOTKIT_MPCSSRAM0&quot;</span> start=<span class="stringliteral">&quot;0x08000000&quot;</span> size=<span class="stringliteral">&quot;0x00100000&quot;</span> type=<span class="stringliteral">&quot;sp&quot;</span> blk_size=<span class="stringliteral">&quot;0x20000&quot;</span> info=<span class="stringliteral">&quot;MPC for extended Flash&quot;</span> /&gt;</div>
  122. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;Flash_S&quot;</span> start=<span class="stringliteral">&quot;0x0c000000&quot;</span> physical=<span class="stringliteral">&quot;0x08001000&quot;</span> size=<span class="stringliteral">&quot;0x00080000&quot;</span> access=<span class="stringliteral">&quot;rx&quot;</span> security=<span class="stringliteral">&quot;c&quot;</span> type=<span class="stringliteral">&quot;ROM&quot;</span> info=<span class="stringliteral">&quot;Flash Memory (secure)&quot;</span> /&gt;</div>
  123. <div class="line"></div>
  124. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM1_C_NS&quot;</span> start=<span class="stringliteral">&quot;0x0A000000&quot;</span> size=<span class="stringliteral">&quot;0x00030000&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> security=<span class="stringliteral">&quot;&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;SRAM1 Code (non secure)&quot;</span> /&gt;</div>
  125. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM1_C_S&quot;</span> start=<span class="stringliteral">&quot;0x0E000000&quot;</span> physical=<span class="stringliteral">&quot;0x0A000000&quot;</span> size=<span class="stringliteral">&quot;0x00030000&quot;</span> access=<span class="stringliteral">&quot;rwx&quot;</span> security=<span class="stringliteral">&quot;c&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;SRAM1 Code (secure)&quot;</span> /&gt;</div>
  126. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM1_S&quot;</span> start=<span class="stringliteral">&quot;0x30000000&quot;</span> physical=<span class="stringliteral">&quot;0x0A000000&quot;</span> size=<span class="stringliteral">&quot;0x00030000&quot;</span> access=<span class="stringliteral">&quot;rw&quot;</span> security=<span class="stringliteral">&quot;s&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;SRAM1 (secure)&quot;</span> /&gt;</div>
  127. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;SRAM1_NS&quot;</span> start=<span class="stringliteral">&quot;0x20000000&quot;</span> physical=<span class="stringliteral">&quot;0x0A000000&quot;</span> size=<span class="stringliteral">&quot;0x00030000&quot;</span> access=<span class="stringliteral">&quot;rw&quot;</span> security=<span class="stringliteral">&quot;&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;SRAM1 (non secure)&quot;</span> /&gt;</div>
  128. <div class="line"></div>
  129. <div class="line"> &lt;memory name=<span class="stringliteral">&quot;FMC_Bank1&quot;</span> start=<span class="stringliteral">&quot;0x60000000&quot;</span> size=<span class="stringliteral">&quot;0x00000000&quot;</span> access=<span class="stringliteral">&quot;rw&quot;</span> security=<span class="stringliteral">&quot;&quot;</span> type=<span class="stringliteral">&quot;RAM&quot;</span> info=<span class="stringliteral">&quot;Memory Controller bank 1&quot;</span> /&gt;</div>
  130. <div class="line"> &lt;/memories&gt;</div>
  131. <div class="line"> :</div>
  132. <div class="line">&lt;/resources&gt;</div>
  133. </div><!-- fragment --><table class="cmtable" summary="Element: memories">
  134. <tr>
  135. <th>Parent Element </th><th colspan="3">Element Chain </th></tr>
  136. <tr>
  137. <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>
  138. <tr>
  139. <th>Child Elements </th><th>Description </th><th>Type </th><th>Occurrence </th></tr>
  140. <tr>
  141. <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>
  142. <tr>
  143. <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>
  144. </table>
  145. <h1><a class="anchor" id="xml_rmemory"></a>
  146. /rzone/resources/memories/memory element</h1>
  147. <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>
  148. <table class="cmtable" summary="Element: memory">
  149. <tr>
  150. <th>Parent Element </th><th colspan="3">Element Chain </th></tr>
  151. <tr>
  152. <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>
  153. <tr>
  154. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  155. <tr>
  156. <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>
  157. <tr>
  158. <td>type </td><td>The type of memory in this region ("RAM" or "ROM"). </td><td>PhysicalTypeEnum </td><td>required </td></tr>
  159. <tr>
  160. <td>start </td><td>The logical start address of the memory region in the address map. </td><td>NonNegativeInteger </td><td>required </td></tr>
  161. <tr>
  162. <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>
  163. <tr>
  164. <td>size </td><td>The size of the memory region in bytes. </td><td>NonNegativeInteger </td><td>required </td></tr>
  165. <tr>
  166. <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>
  167. <tr>
  168. <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>
  169. <tr>
  170. <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>
  171. <tr>
  172. <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>
  173. <tr>
  174. <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>
  175. <tr>
  176. <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>
  177. <tr>
  178. <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>
  179. <tr>
  180. <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>
  181. <tr>
  182. <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>
  183. <tr>
  184. <td>info </td><td>Brief description of the memory region. </td><td>xs:string </td><td>optional </td></tr>
  185. </table>
  186. <h1><a class="anchor" id="xml_rmpc"></a>
  187. /rzone/resources/memories/mpc element</h1>
  188. <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>
  189. <table class="cmtable" summary="Element: mpc">
  190. <tr>
  191. <th>Parent Element </th><th colspan="3">Element Chain </th></tr>
  192. <tr>
  193. <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>
  194. <tr>
  195. <th>Attributes </th><th>Description </th><th>Type </th><th>Use </th></tr>
  196. <tr>
  197. <td>name </td><td>The base register name of the MPC. </td><td>xs:string </td><td>required </td></tr>
  198. <tr>
  199. <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>
  200. <tr>
  201. <td>size </td><td>The size of the memory address region in bytes. </td><td>NonNegativeInteger </td><td>required </td></tr>
  202. <tr>
  203. <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>
  204. <tr>
  205. <td>type </td><td>Specifies the permissions that the MPC verifies for the memory access:<br/>
  206. <ul>
  207. <li>type="s" : (default) only the Secure attribute is verified.</li>
  208. <li>type="p" : only the Privileged attribute is verified.</li>
  209. <li>type="sp" : both the Secure are Privileged attribute are verified. </li>
  210. </ul>
  211. </td><td>MpcTypeEnum </td><td>optional </td></tr>
  212. <tr>
  213. <td>info </td><td>Brief description of the memory region. </td><td>xs:string </td><td>optional </td></tr>
  214. </table>
  215. </div></div><!-- contents -->
  216. </div><!-- doc-content -->
  217. <!-- start footer part -->
  218. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  219. <ul>
  220. <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>
  221. <li class="footer">Generated on Thu Apr 9 2020 15:50:03 for CMSIS-Zone Version 1.0.0 by Arm Ltd. All rights reserved.
  222. <!--
  223. <a href="http://www.doxygen.org/index.html">
  224. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.6
  225. -->
  226. </li>
  227. </ul>
  228. </div>
  229. </body>
  230. </html>