Skip to content

Commit e88873a

Browse files
author
github-actions
committed
Update main documentation
1 parent 4b82c6f commit e88873a

38 files changed

Lines changed: 103 additions & 75 deletions

main/examples/html/footer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Wed Feb 11 2026 12:18:50 for PROJECT_NAME = Examples Version 2.2.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Wed Feb 11 2026 15:07:36 for PROJECT_NAME = Examples Version 2.2.0 by Arm Ltd. All rights reserved.');
33
};

main/infrastructure/html/footer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Wed Feb 11 2026 12:18:50 for PROJECT_NAME = Infrastructure Version 2.2.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Wed Feb 11 2026 15:07:36 for PROJECT_NAME = Infrastructure Version 2.2.0 by Arm Ltd. All rights reserved.');
33
};

main/overview/html/footer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Wed Feb 11 2026 12:18:50 for PROJECT_NAME = Overview Version 2.2.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Wed Feb 11 2026 15:07:36 for PROJECT_NAME = Overview Version 2.2.0 by Arm Ltd. All rights reserved.');
33
};

main/simulation/html/avh_fvp_cmsis.html

Lines changed: 34 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
66
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8-
<title>Arm FVP models: CMSIS-based projects</title>
8+
<title>Arm FVP models: CMSIS Support</title>
99
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
1010
<link href="tabs.css" rel="stylesheet" type="text/css"/>
1111
<link href="extra_navtree.css" rel="stylesheet" type="text/css"/>
@@ -125,12 +125,12 @@
125125
</div>
126126

127127
<div><div class="header">
128-
<div class="headertitle"><div class="title">CMSIS-based projects</div></div>
128+
<div class="headertitle"><div class="title">CMSIS Support</div></div>
129129
</div><!--header-->
130130
<div class="contents">
131131
<div class="textblock"><p><a class="anchor" id="md_src_2avh__fvp__cmsis"></a></p>
132-
<p>To enable embedded software development for Arm FVP targets, Arm provides necessary device definitions, startup code, board support packages and simple examples in <a href="https://www.open-cmsis-pack.org/">Open-CMSIS-Pack format</a>. The same CMSIS-based concept is followed for Arm FVP targets as also used for more than 12000 real hardware devices. This significantly simplifies project management in IDEs such as Keil MDK, allows straightforward integration of other software components, and improves application portability.</p>
133-
<p>Table below lists FVPs with the corresponding CMSIS-Packs that implement device/board support, as well as target device names.</p>
132+
<p>Arm provides comprehensive CMSIS support for FVP targets in <a href="https://www.open-cmsis-pack.org/">Open-CMSIS-Pack format</a>, including device definitions, startup code, board support packages, and examples.</p>
133+
<p>The following table lists available FVP models with their corresponding CMSIS-Packs and device names:</p>
134134
<table class="doxtable" style="width:115%">
135135
<tr>
136136
<th style="width:27%">Arm FVP Model Name </th><th style="width:25%">CMSIS Packs with DFP/BSP<sup> (1)</sup> </th><th style="width:17%">Device name</th><th>Description </th></tr>
@@ -191,9 +191,36 @@
191191
<p class="endtd"></p>
192192
</td></tr>
193193
</table>
194-
<blockquote class="doxtable">
195-
<p><b>Note</b> <sup>(1)</sup> The BSP packs listed here (ending with "_BSP") also contain device definition as provided in the corresponding "Device Name" cell and do not require separate device family pack (DFP). </p>
196-
</blockquote>
194+
<p><b>Note:</b> <sup>(1)</sup> BSP packs (suffixed with "_BSP") include both board support and device definitions, eliminating the need for a separate Device Family Pack (DFP).</p>
195+
<h1><a class="anchor" id="autotoc_md0"></a>
196+
Software Layers</h1>
197+
<p>The AVH_FVP pack provides board support layers for Corstone FVP platforms in the <code>board/</code> folder. Each board layer includes hardware-specific configurations, drivers, and setup for running applications on FVP simulation models.</p>
198+
<table class="markdownTable">
199+
<tr class="markdownTableHead">
200+
<th class="markdownTableHeadLeft">Folder </th><th class="markdownTableHeadLeft">Description </th></tr>
201+
<tr class="markdownTableRowOdd">
202+
<td class="markdownTableBodyLeft"><code>./board/Corstone-300</code> </td><td class="markdownTableBodyLeft">Board layer for Corstone-300 FVP with optional Ethos-U55/U65 </td></tr>
203+
<tr class="markdownTableRowEven">
204+
<td class="markdownTableBodyLeft"><code>./board/Corstone-310</code> </td><td class="markdownTableBodyLeft">Board layer for Corstone-310 FVP with optional Ethos-U55/U65 </td></tr>
205+
<tr class="markdownTableRowOdd">
206+
<td class="markdownTableBodyLeft"><code>./board/Corstone-315</code> </td><td class="markdownTableBodyLeft">Board layer for Corstone-315 FVP with optional Ethos-U65 </td></tr>
207+
<tr class="markdownTableRowEven">
208+
<td class="markdownTableBodyLeft"><code>./board/Corstone-320</code> </td><td class="markdownTableBodyLeft">Board layer for Corstone-320 FVP with optional Ethos-U85 </td></tr>
209+
</table>
210+
<p>Each folder contains a <b>README</b> with implementation details and multiple <b>CSolution layer files</b> (<code>*.clayer.yml</code>) that configure different hardware variants. The postfix in the <code>*.clayer.yml</code> filename determines the Ethos-U NPU configuration:</p>
211+
<table class="markdownTable">
212+
<tr class="markdownTableHead">
213+
<th class="markdownTableHeadLeft">Layer File </th><th class="markdownTableHeadLeft">NPU Configuration </th><th class="markdownTableHeadLeft">Description </th></tr>
214+
<tr class="markdownTableRowOdd">
215+
<td class="markdownTableBodyLeft"><code>Board.clayer.yml</code> </td><td class="markdownTableBodyLeft">None </td><td class="markdownTableBodyLeft">Cortex-M system only, no Ethos-U NPU </td></tr>
216+
<tr class="markdownTableRowEven">
217+
<td class="markdownTableBodyLeft"><code>Board-U55.clayer.yml</code> </td><td class="markdownTableBodyLeft">Ethos-U55 </td><td class="markdownTableBodyLeft">Cortex-M system + Ethos-U55 NPU (256 MACs) </td></tr>
218+
<tr class="markdownTableRowOdd">
219+
<td class="markdownTableBodyLeft"><code>Board-U65.clayer.yml</code> </td><td class="markdownTableBodyLeft">Ethos-U65 </td><td class="markdownTableBodyLeft">Cortex-M system + Ethos-U65 NPU </td></tr>
220+
<tr class="markdownTableRowEven">
221+
<td class="markdownTableBodyLeft"><code>Board-U85.clayer.yml</code> </td><td class="markdownTableBodyLeft">Ethos-U85 </td><td class="markdownTableBodyLeft">Cortex-M system + Ethos-U85 NPU </td></tr>
222+
</table>
223+
<p>Refer to <a href="https://open-cmsis-pack.github.io/cmsis-toolbox/build-overview/#software-layers">CMSIS-Toolbox - Software Layers</a> for more information on using layers in projects. </p>
197224
</div></div><!-- contents -->
198225
</div><!-- PageDoc -->
199226
</div><!-- doc-content -->

main/simulation/html/doxygen_crawl.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
<body>
1111
<a href="annotated.html"/>
1212
<a href="avh_fvp_cmsis.html"/>
13+
<a href="avh_fvp_cmsis.html#autotoc_md0"/>
1314
<a href="classes.html"/>
1415
<a href="dir_05919b2fbcaf3de9fbeeb988d1e0d89f.html"/>
1516
<a href="dir_2e1d9f80bbf17079ea58b080a2a5eec7.html"/>

main/simulation/html/footer.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
function writeFooter() {
2-
document.write('Generated on Wed Feb 11 2026 12:18:55 for Arm FVP models Version 2.2.0 by Arm Ltd. All rights reserved.');
2+
document.write('Generated on Wed Feb 11 2026 15:07:41 for Arm FVP models Version 2.2.0 by Arm Ltd. All rights reserved.');
33
};

main/simulation/html/group__arm__vio__pyenv.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@
133133
</p>
134134
<p>Python environment for Arm FVPs. </p>
135135
<p>Arm FVPs require an installation of <b>Python 3.9</b> for running the Python virtual interfaces. If you are using a Windows machine you can use an embedded Python installation in FVPs root directory, otherwise a system installation is required. Additional Python packages can be added using <em>pip</em>. In case you are using embedded Python installation see section: <a class="el" href="#embedded-pip-vio">Install additional packages in embedded Python</a></p>
136-
<h1><a class="anchor" id="autotoc_md0"></a>
136+
<h1><a class="anchor" id="autotoc_md1"></a>
137137
Known issues</h1>
138138
<p>Some Python packages can't be imported directly in the Python virtual interfaces, because they are incompatible with Python sub-interpreters (e.g. <em>numpy</em>). Possible workaround for this issue is to split the Python module into client and server scripts.</p>
139139
<h1><a class="anchor" id="embedded-pip-vio"></a>

main/simulation/html/group__arm__vsi__pyenv.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -129,23 +129,23 @@
129129
</div><!--header-->
130130
<div class="contents">
131131
<p>Arm FVPs require an installation of <b>Python 3.9</b> for running the Python virtual interfaces. Additional Python packages can be added using <em>pip</em>.</p>
132-
<h1><a class="anchor" id="autotoc_md1"></a>
132+
<h1><a class="anchor" id="autotoc_md2"></a>
133133
Python requirements</h1>
134134
<p>The following packages are required on Linux systems (Ubuntu 20.04 and later):</p><ul>
135135
<li><em>libatomic1</em> </li>
136136
<li><em>python3.9</em> </li>
137137
<li><em>python3-pip</em> </li>
138138
</ul>
139139
<p>Run the following command to install required packages on Ubuntu: </p><div class="fragment"><div class="line">sudo apt install libatomic1 python3.9 python3-pip</div>
140-
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md2"></a>
140+
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md3"></a>
141141
Known issues</h1>
142142
<ul>
143143
<li>Some Python packages can't be imported directly in the Python virtual interfaces, because they are incompatible with Python sub-interpreters (e.g. <em>numpy</em>). Possible workaround for this issue is to split the Python module into client and server scripts.</li>
144144
</ul>
145-
<h1><a class="anchor" id="autotoc_md3"></a>
145+
<h1><a class="anchor" id="autotoc_md4"></a>
146146
Setup for FVPs older than 11.26</h1>
147147
<p>If you are using a Windows machine you can use an embedded Python installation in FVPs root directory, otherwise a system installation is required.</p>
148-
<h2><a class="anchor" id="autotoc_md4"></a>
148+
<h2><a class="anchor" id="autotoc_md5"></a>
149149
Install additional packages in embedded Python</h2>
150150
<p>By default the embedded Python installation on Windows does not support installation of new packages using pip. To enable installing new packages follow the steps described below.</p><ul>
151151
<li>Download <a href="https://bootstrap.pypa.io/get-pip.py">get-pip.py</a> to the FVPs root directory.</li>
@@ -156,7 +156,7 @@ <h2><a class="anchor" id="autotoc_md4"></a>
156156
<li>Install new packages using: <div class="fragment"><div class="line">.\python.exe -m pip install &lt;package&gt;</div>
157157
</div><!-- fragment --> The packages will be installed in <code>Lib\site-packages</code> subfolder.</li>
158158
</ul>
159-
<h2><a class="anchor" id="autotoc_md5"></a>
159+
<h2><a class="anchor" id="autotoc_md6"></a>
160160
Known issues</h2>
161161
<ul>
162162
<li>Fast Models (Version 11.22.39) available through vcpkg include a stripped-down version of libpython3.9 library on Linux systems. This can cause the Fast Model to close with an error (<em>VSI:Video:ImportError: No module named '_posixsubprocess'</em>) when running applications with VSI. <br />

main/simulation/html/group__arm__vsi__video.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -165,7 +165,7 @@
165165
<img src="vsi_video_structure.png" alt=""/>
166166
<div class="caption">
167167
Video VSI Implementation Overview</div></div>
168-
<h2><a class="anchor" id="autotoc_md6"></a>
168+
<h2><a class="anchor" id="autotoc_md7"></a>
169169
Python requirements</h2>
170170
<p>In addition to the requirements listed in <a class="el" href="group__arm__vsi__pyenv.html">Python environment setup</a>, the VSI Video use case also requires installed OpenCV Python package. Run the following command to install it with pip: </p><div class="fragment"><div class="line">pip install opencv-python</div>
171171
</div><!-- fragment --><h2><a class="anchor" id="video_vsi_detail"></a>

main/simulation/html/hints.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ <h2><a class="anchor" id="uart"></a>
150150
<p>Below is useful information for using UART I/O on FVP targets:</p>
151151
<ul>
152152
<li><b>Concept</b>: <a href="https://developer.arm.com/documentation/100966/latest/Getting-Started-with-Fixed-Virtual-Platforms/Using-a-terminal-with-an-FVP">Using-a-terminal-with-an-FVP</a> and <a href="https://developer.arm.com/documentation/100964/1126/Fast-Models-components/Peripheral-components/TelnetTerminal">TelnetTerminal</a> explain the concept in details.</li>
153-
<li><b>UART Drivers</b>: CMSIS BSP packs listed in <a class="el" href="avh_fvp_cmsis.html">CMSIS-based projects</a> contain drivers for UART access on corresponding FVP targets.</li>
153+
<li><b>UART Drivers</b>: CMSIS BSP packs listed in <a class="el" href="avh_fvp_cmsis.html">CMSIS Support</a> contain drivers for UART access on corresponding FVP targets.</li>
154154
<li><b>Retarget to UART</b>: <a href="https://arm-software.github.io/CMSIS_6/latest/Compiler/index.html">CMSIS-Compiler component</a> implements retargeting of standard output functions, such as <code>printf()</code>.</li>
155155
<li><b>FVP parameters</b>: the default values of FVP configuration parameters related to UART and Telnet should already work correctly. Refer to the FVP and Fast Models documentation as well as reference examples for additional information.</li>
156156
<li><b>Windows setup</b> : On Windows you need to enable Telnet, as follows:<ul>

0 commit comments

Comments
 (0)