Update documentation for release pack/1.2.0

ARM-software · May 16, 2024 · 5ec3b22 · 5ec3b22
1 parent b2efb50
commit 5ec3b22
Show file tree

Hide file tree

Showing 230 changed files with 22,380 additions and 2 deletions.
diff --git a/latest b/latest
@@ -1 +1 @@
-pack/1.2.0-rc0
+pack/1.2.0
diff --git a/pack/1.2.0/ArmFault.png b/pack/1.2.0/ArmFault.png
diff --git a/pack/1.2.0/CalcMemUsed.png b/pack/1.2.0/CalcMemUsed.png
diff --git a/pack/1.2.0/ComponentViewerOverview.png b/pack/1.2.0/ComponentViewerOverview.png
diff --git a/pack/1.2.0/EventOutput1.png b/pack/1.2.0/EventOutput1.png
diff --git a/pack/1.2.0/EventOutput2.png b/pack/1.2.0/EventOutput2.png
diff --git a/pack/1.2.0/EventRecorderFilter.png b/pack/1.2.0/EventRecorderFilter.png
diff --git a/pack/1.2.0/EventRecorderOverview.png b/pack/1.2.0/EventRecorderOverview.png
diff --git a/pack/1.2.0/EventStatistics_w_Energy.png b/pack/1.2.0/EventStatistics_w_Energy.png
diff --git a/pack/1.2.0/EventStatistics_wo_Energy.png b/pack/1.2.0/EventStatistics_wo_Energy.png
diff --git a/pack/1.2.0/ExampleProjects.html b/pack/1.2.0/ExampleProjects.html
@@ -0,0 +1,155 @@
+<!-- HTML header for doxygen 1.9.6-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>CMSIS-View: Examples</title>
+<link href="doxygen.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="tabs.js"></script>
+<script type="text/javascript" src="footer.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(document).ready(function() { init_search(); });
+/* @license-end */
+</script>
+<script type="text/javascript" src="darkmode_toggle.js"></script>
+<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
+<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
+<link href="extra_search.css" rel="stylesheet" type="text/css"/>
+<link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
+<link href="version.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="../version.js"></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: 55px;">
+  <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
+  <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
+   <div id="projectname">CMSIS-View
+   &#160;<span id="projectnumber"><script type="text/javascript">
+     <!--
+     writeHeader.call(this);
+     writeVersionDropdown.call(this, "CMSIS-View");
+     //-->
+    </script>
+   </span>
+   </div>
+   <div id="projectbrief">Record program events, display status information, and analyze execution faults</div>
+  </td>
+   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
+  <!--END !PROJECT_NAME-->
+ </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.9.6 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search/",'.html');
+/* @license-end */
+</script>
+</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">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function(){initNavTree('ExampleProjects.html',''); initResizable(); });
+/* @license-end */
+</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)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</div>
+
+<div><div class="header">
+  <div class="headertitle"><div class="title">Examples </div></div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p><a class="anchor" id="md_src_examples"></a> CMSIS-View provides several example projects that demonstrate the usage of CMSIS-View software components in embedded applications. The projects are available in the <code>Examples/</code> directory and are also part of the CMSIS-View pack.</p>
+<table class="markdownTable">
+<tr class="markdownTableHead">
+<th class="markdownTableHeadLeft">Example Project   </th><th class="markdownTableHeadLeft">Description    </th></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyLeft"><a class="el" href="scvd_evt_stat.html">EventStatistic</a>   </td><td class="markdownTableBodyLeft">Shows the usage of start/stop events for statistical code profiling using <a href="https://arm-software.github.io/AVH/main/overview/html/index.html">Arm Virtual Hardware (AVH)</a> processor simulation.    </td></tr>
+<tr class="markdownTableRowEven">
+<td class="markdownTableBodyLeft"><a class="el" href="flt_example_CM7.html">Fault/VHT_MPS2_Cortex-M7</a>   </td><td class="markdownTableBodyLeft">Shows the usage of the Fault component on a Cortex-M7 <a href="https://arm-software.github.io/AVH/main/overview/html/index.html">Arm Virtual Hardware (AVH)</a> processor simulation.    </td></tr>
+<tr class="markdownTableRowOdd">
+<td class="markdownTableBodyLeft"><a class="el" href="flt_example_CM33.html">Fault/B-U585I-IOT02A</a>   </td><td class="markdownTableBodyLeft">Shows the usage of the Fault component on a Cortex-M33 with TrustZone. This example runs on STMicroelectronics <a href="https://www.st.com/en/evaluation-tools/b-u585i-iot02a.html"><b>B-U585I-IOT02A</b></a> evaluation board.   </td></tr>
+</table>
+<p>Other examples with CMSIS-View support can be also found in various CMSIS packs with device support, BSP and software components. For example <a href="https://arm-software.github.io/CMSIS-RTX/latest/index.html">CMSIS-RTX</a>, <a href="https://www.keil.com/pack/doc/mw/General/html/index.html">MDK Middleware</a> and others, or also in GitHub projects at <a href="https://github.com/Arm-Examples">https://github.com/Arm-Examples</a>. </p>
+</div></div><!-- contents -->
+</div><!-- PageDoc -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">
+      <script type="text/javascript">
+        <!--
+        writeFooter.call(this);
+        //-->
+      </script> 
+    </li>
+  </ul>
+</div>
+</body>
+</html>
diff --git a/pack/1.2.0/ExampleProjects.js b/pack/1.2.0/ExampleProjects.js
@@ -0,0 +1,6 @@
+var ExampleProjects =
+[
+    [ "EventStatistic", "scvd_evt_stat.html", null ],
+    [ "Fault/VHT_MPS2_Cortex-M7", "flt_example_CM7.html", null ],
+    [ "Fault/B-U585I-IOT02A", "flt_example_CM33.html", null ]
+];
diff --git a/pack/1.2.0/Fault_CM33_CV_MemManage.png b/pack/1.2.0/Fault_CM33_CV_MemManage.png
diff --git a/pack/1.2.0/Fault_CM33_CV_NoFault.png b/pack/1.2.0/Fault_CM33_CV_NoFault.png
diff --git a/pack/1.2.0/Fault_CM33_EvR_MemManage.png b/pack/1.2.0/Fault_CM33_EvR_MemManage.png
diff --git a/pack/1.2.0/Fault_CM33_STDIO_MemManage.png b/pack/1.2.0/Fault_CM33_STDIO_MemManage.png
diff --git a/pack/1.2.0/Fault_CM33_UI.png b/pack/1.2.0/Fault_CM33_UI.png
diff --git a/pack/1.2.0/Fault_CM7_UI.png b/pack/1.2.0/Fault_CM7_UI.png
diff --git a/pack/1.2.0/Fault_CM7_eventlist_MemManage.png b/pack/1.2.0/Fault_CM7_eventlist_MemManage.png
diff --git a/pack/1.2.0/Fault_STDIO_MemManage.png b/pack/1.2.0/Fault_STDIO_MemManage.png
diff --git a/pack/1.2.0/Fault_create_iram2.png b/pack/1.2.0/Fault_create_iram2.png
diff --git a/pack/1.2.0/Fault_memory_location.png b/pack/1.2.0/Fault_memory_location.png
diff --git a/pack/1.2.0/Fault_set_comp.png b/pack/1.2.0/Fault_set_comp.png
diff --git a/pack/1.2.0/Manage_MyTest_SCVD.png b/pack/1.2.0/Manage_MyTest_SCVD.png
diff --git a/pack/1.2.0/Manage_SCVD_Files.png b/pack/1.2.0/Manage_SCVD_Files.png
diff --git a/pack/1.2.0/SCVDExample.png b/pack/1.2.0/SCVDExample.png
diff --git a/pack/1.2.0/SCVD_Format.html b/pack/1.2.0/SCVD_Format.html
@@ -0,0 +1,174 @@
+<!-- HTML header for doxygen 1.9.6-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
+<head>
+<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
+<meta http-equiv="X-UA-Compatible" content="IE=11"/>
+<meta name="viewport" content="width=device-width, initial-scale=1"/>
+<title>CMSIS-View: SCVD file format</title>
+<link href="doxygen.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="tabs.js"></script>
+<script type="text/javascript" src="footer.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="navtree.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="resize.js"></script>
+<script type="text/javascript" src="navtreedata.js"></script>
+<script type="text/javascript" src="navtree.js"></script>
+<link href="search/search.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="search/searchdata.js"></script>
+<script type="text/javascript" src="search/search.js"></script>
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+  $(document).ready(function() { init_search(); });
+/* @license-end */
+</script>
+<script type="text/javascript" src="darkmode_toggle.js"></script>
+<link href="extra_stylesheet.css" rel="stylesheet" type="text/css"/>
+<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
+<link href="extra_search.css" rel="stylesheet" type="text/css"/>
+<link href="extra_tabs.css" rel="stylesheet" type="text/css"/>
+<link href="version.css" rel="stylesheet" type="text/css"/>
+<script type="text/javascript" src="../version.js"></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: 55px;">
+  <td id="projectlogo" style="padding: 1.5em;"><a href="https://www.keil.arm.com/cmsis" target="_blank"><img alt="Logo" src="cmsis_logo_white_small.png"/</a></td>
+  <td style="padding-left: 1em; padding-bottom: 1em;padding-top: 1em;">
+   <div id="projectname">CMSIS-View
+   &#160;<span id="projectnumber"><script type="text/javascript">
+     <!--
+     writeHeader.call(this);
+     writeVersionDropdown.call(this, "CMSIS-View");
+     //-->
+    </script>
+   </span>
+   </div>
+   <div id="projectbrief">Record program events, display status information, and analyze execution faults</div>
+  </td>
+   <td>        <div id="MSearchBox" class="MSearchBoxInactive">
+        <span class="left">
+          <span id="MSearchSelect"                onmouseover="return searchBox.OnSearchSelectShow()"                onmouseout="return searchBox.OnSearchSelectHide()">&#160;</span>
+          <input type="text" id="MSearchField" value="" placeholder="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.svg" alt=""/></a>
+          </span>
+        </div>
+</td>
+  <!--END !PROJECT_NAME-->
+ </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.9.6 -->
+<script type="text/javascript">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+var searchBox = new SearchBox("searchBox", "search/",'.html');
+/* @license-end */
+</script>
+</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">
+/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
+$(document).ready(function(){initNavTree('SCVD_Format.html',''); initResizable(); });
+/* @license-end */
+</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)">
+</div>
+
+<!-- iframe showing the search results (closed by default) -->
+<div id="MSearchResultsWindow">
+<div id="MSearchResults">
+<div class="SRPage">
+<div id="SRIndex">
+<div id="SRResults"></div>
+<div class="SRStatus" id="Loading">Loading...</div>
+<div class="SRStatus" id="Searching">Searching...</div>
+<div class="SRStatus" id="NoMatches">No Matches</div>
+</div>
+</div>
+</div>
+</div>
+
+<div><div class="header">
+  <div class="headertitle"><div class="title">SCVD file format </div></div>
+</div><!--header-->
+<div class="contents">
+<div class="textblock"><p>The SCVD (Software Component View Description) files are formatted in XML and based on the schema file <a href="https://github.com/ARM-software/CMSIS-View/blob/main/Schema/Component_Viewer.xsd"><b>Component_Viewer.xsd</b></a>.</p>
+<p>The SCVD file format is described in the following sections:</p>
+<ul>
+<li><a class="el" href="xml_elements.html">XML elements</a> : specifies the structure and top level elements of an SCVD file.</li>
+<li><a class="el" href="Symbol_Access.html">Symbol Access</a> : explains how to refer to application symbols when reading program variables.</li>
+<li><a class="el" href="data_type.html">Data types</a> : lists available scalar data types used in XML elements and explains how complex data types are defined.</li>
+<li><a class="el" href="scvd_expression.html">Expressions</a> : describes supported expressions for making calculations in an SCVD file.</li>
+<li><a class="el" href="builtin_function.html">Built-in functions</a> : lists built-in functions that can be used for calculating stack memory usage, accessing CPU registers or application program symbols.</li>
+<li><a class="el" href="value_output.html">Value output</a> : shows how to format output data for display in the <a href="https://developer.arm.com/documentation/101407/latest/Debugging/Debug-Windows-and-Dialogs/Component-Viewer" target="_blank"><b>Component Viewer</b></a> or <a href="https://developer.arm.com/documentation/101407/latest/Debugging/Debug-Windows-and-Dialogs/Event-Recorder" target="_blank"><b>Event Recorder</b></a>.</li>
+</ul>
+<h1><a class="anchor" id="scvd_validate"></a>
+SCVD file validation</h1>
+<p>The schema file <a href="https://github.com/ARM-software/CMSIS-View/blob/main/Schema/Component_Viewer.xsd"><b>Component_Viewer.xsd</b></a>. specifies the XML format. Use this schema file together with XML tools for validating an *.scvd file.</p>
+<h1><a class="anchor" id="scvd_in_debug"></a>
+Using SCVD files in a debugger</h1>
+<p>The following steps explain how to use an *.SCVD file in the µVision Debugger. Other tools might require different steps:</p>
+<ul>
+<li>Add the SCVD file to µVision as described in <a href="https://developer.arm.com/documentation/101407/0538/Creating-Applications/Tips-and-Tricks/Manage-Component-Viewer-Description-Files" target="_blank"><b>Manage Component Viewer Description Files</b></a>.</li>
+<li>Use the debug windows as described in <a href="https://developer.arm.com/documentation/101407/latest/Debugging/Debug-Windows-and-Dialogs/Component-Viewer" target="_blank"><b>Component Viewer</b></a>.</li>
+</ul>
+<h1><a class="anchor" id="scvd_in_packs"></a>
+SCVD files in software packs</h1>
+<p>Software components which are part of Software Packs may add related *.SCVD files directly in the Package Description file (*.pdsc) using the &lt;file&gt; element category <span class="XML-Token">other</span>. In the *.pdsc file example below <span class="XML-Token">Network.scvd</span> is added to the debugger when the component <span class="XML-Token">:Network:Core</span> is selected. For details, refer to <a href="https://open-cmsis-pack.github.io/Open-CMSIS-Pack-Spec/main/html/pdsc_components_pg.html" target="_blank"><b>CMSIS-Pack - Pack Description (*.PDSC) Format</b></a>.</p>
+<div class="fragment"><div class="line">&lt;component CClass=<span class="stringliteral">&quot;Network&quot;</span> Cgroup=<span class="stringliteral">&quot;Core&quot;</span>&gt;</div>
+<div class="line">  &lt;files&gt;</div>
+<div class="line">    &lt;file category=<span class="stringliteral">&quot;library&quot;</span>  name=<span class="stringliteral">&quot;Network/Lib/ARM/Network.lib&quot;</span>/&gt;</div>
+<div class="line">    &lt;file category=<span class="stringliteral">&quot;other&quot;</span>    name=<span class="stringliteral">&quot;Network/Network.scvd&quot;</span>/&gt;</div>
+<div class="line">  &lt;/files&gt;</div>
+<div class="line">&lt;/component&gt;</div>
+</div><!-- fragment --><p><br  />
+ </p>
+</div></div><!-- contents -->
+</div><!-- PageDoc -->
+</div><!-- doc-content -->
+<!-- start footer part -->
+<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
+  <ul>
+    <li class="footer">
+      <script type="text/javascript">
+        <!--
+        writeFooter.call(this);
+        //-->
+      </script> 
+    </li>
+  </ul>
+</div>
+</body>
+</html>