Skip to content

Commit

Permalink
Update main documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Aug 9, 2024
1 parent e105eea commit 1e849d5
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion main/examples/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Fri Aug 9 2024 08:50:17 for Examples Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 12:18:51 for Examples Version 2.0.0 by Arm Ltd. All rights reserved.');
};
2 changes: 1 addition & 1 deletion main/infrastructure/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Fri Aug 9 2024 08:50:17 for Infrastructure Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 12:18:51 for Infrastructure Version 2.0.0 by Arm Ltd. All rights reserved.');
};
2 changes: 1 addition & 1 deletion main/overview/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Fri Aug 9 2024 08:50:17 for Overview Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 12:18:52 for Overview Version 2.0.0 by Arm Ltd. All rights reserved.');
};
6 changes: 3 additions & 3 deletions main/simulation/html/Hints.html
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ <h1><a class="anchor" id="timing"></a>
<div class="line">Performance index : 0.43</div>
<div class="line">cpu_core.cpu0 : 68.40 MIPS ( 65196784 Inst)</div>
<div class="line">-------------------------------------------------------------------------------</div>
</div><!-- fragment --> Also see <a href="https://developer.arm.com/documentation/100965/latest/Timing-Annotation/Timing-annotation-tutorial/Setting-up-the-environment/Displaying-the-total-execution-time-of-the-simulation">corresponding section</a> in the Fast Models User Guide.</li>
</div><!-- fragment --> Also see section <a href="https://developer.arm.com/documentation/100965/latest/Timing-Annotation/Timing-annotation-tutorial/Setting-up-the-environment/Displaying-the-total-execution-time-of-the-simulation">Displaying the total execution time</a> in the Fast Models User Guide.</li>
<li><a href="https://github.com/ARM-software/CMSIS-View">CMSIS-View</a> utility can be used to measure and analyze timing between events in the program, including statistical data. To store the log files on FVPs, <a class="el" href="Hints.html#semihosting">semihosting</a> shall be enabled. CMSIS-View annotations can also be reused for event analysis and time measurement on real hardware.</li>
<li><a class="el" href="Using.html#Config">Model Configuration</a> parameters can be used to control and impact the execution timing:<ul>
<li>With Cycle Per Instruction (CPI) settings <code>cpi_div</code> and <code>cpi_mul</code>.</li>
Expand All @@ -219,11 +219,11 @@ <h1><a class="anchor" id="timing"></a>
</ul>
Chapter <a href="https://developer.arm.com/documentation/100965/latest/Timing-Annotation">Timing Annotations</a> in the Fast Models User Guide explains the performance estimation concept as implemented in the underlying FastModels technology. Note that the FVPs are built with Timing Annotations enabled (<code>FASTSIM_DISABLE_TA</code> set to 0).</li>
</ul>
<p>For interaction with external world such as via [virtual interfaces] or <a class="el" href="Hints.html#semihosting">Semihosting I/O</a> the timing differences need to be taken into account as explain in <a href="https://developer.arm.com/documentation/100966/1126/Getting-Started-with-Fixed-Virtual-Platforms/Timing-considerations-for-FVPs">Timing-considerations-for-FVPs</a>.</p>
<p>For interaction with external world such as via <a class="el" href="group__arm__vsi.html">Virtual Streaming Interface (VSI)</a> or <a class="el" href="Hints.html#semihosting">Semihosting I/O</a> the timing differences need to be taken into account as explain in <a href="https://developer.arm.com/documentation/100966/1126/Getting-Started-with-Fixed-Virtual-Platforms/Timing-considerations-for-FVPs">Timing-considerations-for-FVPs</a>.</p>
<h1><a class="anchor" id="stop"></a>
Execution stop</h1>
<p>Embedded applications typically run with an infinite loop that ensures continuous program execution. But for executing regression tests as part of Continuous Integration (CI) workflows it is often required that program execution is stopped after a test is completed, so that the next test can be started.</p>
<p>FVP command line option <code>--simlimit</code> can be used to stop execution after specified amount of seconds, for example, for 20 seconds, use <code>--simlimit 20</code>.</p>
<p>FVP command line options <code>--cpulimit</code>, <code>--cyclelimit</code>, <code>--timelimit</code> and <code>--simlimit</code> can be used to stop execution after specified activity time, for example, for 20 wall-clock seconds, use <code>--timelimit 20</code>. See <a href="https://developer.arm.com/documentation/100966/latest/Getting-Started-with-Fixed-Virtual-Platforms/FVP-command-line-options">FVP command line options</a> for more details.</p>
<p>FVP models have <code>shutdown_on_eot</code> parameter that enables simple implementation of program exit. The parameter should be set in the <a class="el" href="Using.html#Config">Model Configuration</a>, for example for FPV_Corstone_SSE-300:</p>
<div class="fragment"><div class="line">mps3_board.uart0.shutdown_on_eot=1 # (bool, init-time) default = &#39;0&#39; : Shutdown simulation when a EOT (ASCII 4) char is transmitted (useful for regression tests when semihosting is not available)</div>
</div><!-- fragment --><p>And then to trigger the shutdown, a EOT (ASCII 4) symbol can be transmitted to the corresponding serial interface from the program. The code below demonstrates an example, where the execution is stopped after target execution count is achieved. In this implementation the STDIO is assumed to be retargeted to the UART0:</p>
Expand Down
2 changes: 1 addition & 1 deletion main/simulation/html/footer.js
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
function writeFooter() {
document.write('Generated on Fri Aug 9 2024 08:50:21 for AVH FVP models Version 2.0.0 by Arm Ltd. All rights reserved.');
document.write('Generated on Fri Aug 9 2024 12:18:58 for AVH FVP models Version 2.0.0 by Arm Ltd. All rights reserved.');
};

0 comments on commit 1e849d5

Please sign in to comment.