docs: Add instrucitons to install Arm ecosystem FVPs

With the addition of support for FreeRTOS TCP/IP stack, in addition to Arm Virtual Hardware using Amazon Machine Images, Arm FRI can now run ecosystem FVPs. Signed-off-by: Devaraj Ranganna <[email protected]>
FreeRTOS · Oct 4, 2023 · 4b2f7d0 · 4b2f7d0
1 parent 41b3583
commit 4b2f7d0
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 28 deletions.
diff --git a/Docs/Prerequisites.md b/Docs/Prerequisites.md
@@ -0,0 +1,48 @@
+# Prerequisites
+
+## Setting up the platforms
+
+This reference integration supports both [Arm ecosystem FVPs](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
+and Arm Virtual Hardware using [Amazon Machine Images](#setting-up-arm-virtual-hardware-using-amazon-machine-images).
+
+The Corstone-300 ecosystem FVP is aligned with the Arm MPS3 development
+platform. It is based on the Cortex-M55 processor and offers a choice of the
+Ethos-U55 and Ethos-U65 processors. This FVP is provided free of charge for the
+limited development and validation of open-source software on the Corstone-300
+platform while Arm Virtual Hardware is recommended for commercial software.
+Follow the [link](https://developer.arm.com/downloads/-/arm-ecosystem-fvps) for
+more information.
+
+### Setting up Arm ecosystem FVPs
+
+* Download the Corstone-300 FVP from [here](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
+* Run the following commands to install the Corstone-300 FVP and add FVP path
+  to `PATH` variable.
+    ```bash
+    mkdir FVP_Corstone_SSE-300_11.22_20
+    tar -xzf <download location>/FVP_Corstone_SSE-300_11.22_20_Linux64.tgz -C FVP_Corstone_SSE-300_11.22_20
+    cd FVP_Corstone_SSE-300_11.22_20
+    ./FVP_Corstone_SSE-300.sh
+    echo PATH=\"<FVP installation path>/FVP_Corstone_SSE-300/models/Linux64_GCC-9.3:\$PATH\" >> ~/.bashrc
+    source ~/.bashrc
+    ```
+
+### Setting up Arm Virtual Hardware using Amazon Machine Images
+
+Follow the instructions described in [Launch Arm Virtual Hardware Instance](setting-up-arm-virtual-hardware.md)
+to setup your development environment.
+
+If you have successfully followed the instructions, then you should have a
+console (either AWS-Web-Console or Local-Console) to an Arm Virtual Hardware
+Instance. From now on, any command-line commands described in this document
+must be run on the console connected to the Arm Virtual Hardware Instance.
+
+**Note**  
+The run example script `Tools/scripts/run.sh` assumes ecosystem FVP by default.
+If you are using Arm virtual hardware using Amazon machine images then an
+additional argument `--fvp_type vht` must be passed to the run example script.
+
+## Setting up development environment
+
+Follow the instructions described in [Setting Up your Development Environment](development-environment.md)
+to setup your development environment.
diff --git a/Docs/aws-iot-example.md b/Docs/aws-iot-example.md
@@ -44,20 +44,10 @@ non-secure (FreeRTOS kernel and the application) images are singed separately,
 MCUBoot verifies that both image signatures are valid before booting. If either
 of the verification fails, then MCUBoot stops the booting process.
 
-## Setting up Arm Virtual Hardware using Amazon Machine Images
+## Prerequisites
 
-Follow the instructions described in [Launch Arm Virtual Hardware Instance](setting-up-arm-virtual-hardware.md)
-to setup your development environment.
-
-If you have successfully followed the instructions, then you should have a
-console (either AWS-Web-Console or Local-Console) to an Arm Virtual Hardware
-Instance. From now on, any command-line commands described in this document
-must be run on the console connected to the Arm Virtual Hardware Instance.
-
-## Setting up development environment
-
-Follow the instructions described in [Setting Up your Development Environment](development-environment.md)
-to setup your development environment.
+Follow the instructions described in [Prerequisites](Prerequisites.md) and
+ensure that all the prerequisites are met before continuing.
 
 ## Setting up AWS connectivity
 

diff --git a/Docs/blinky.md b/Docs/blinky.md
@@ -9,20 +9,10 @@ on the secure-side and prints it on the console. In addition, to simulate LED
 blinking, `LED On` and `LED off` are printed onto the console at regular
 intervals.
 
-## Setting up Arm Virtual Hardware using Amazon Machine Images
+## Prerequisites
 
-Follow the instructions described in [Launch Arm Virtual Hardware Instance](setting-up-arm-virtual-hardware.md)
-to setup your development environment.
-
-If you have successfully followed the instructions, then you should have a
-console (either AWS-Web-Console or Local-Console) to Arm Virtual Hardware
-Instance. From now on, any command-line commands described in this document
-must be run on the console connected to Arm Virtual Hardware Instance.
-
-## Setting up development environment
-
-Follow the instructions described in [Setting Up your Development Environment](development-environment.md)
-to setup your development environment.
+Follow the instructions described in [Prerequisites](Prerequisites.md) and
+ensure that all the prerequisites are met before continuing.
 
 ## Building the application
 

diff --git a/Docs/development-environment.md b/Docs/development-environment.md
@@ -16,7 +16,7 @@ argument, you should run:
 git submodule update --init --recursive
 ```
 
-## Prerequisites
+## Build requirements
 
 * Ubuntu 20.04 or higher. Please note that the following instructions are
   validated on Ubuntu 20.04.

diff --git a/README.md b/README.md
@@ -15,7 +15,7 @@ This project is based on the [Corstone-300](https://developer.arm.com/Processors
 platform.
 
 Developers and partners can use this integration as a starting point to build
-FreeRTOS kernel and libraires based software stack on top of Arm Cortex-M based
+FreeRTOS kernel and libraries based software stack on top of Arm Cortex-M based
 platforms. All the components are put together in a modular manner to make
 porting of this integration across platforms easy.