summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKshitij Sisodia <kshitij.sisodia@arm.com>2023-01-04 12:00:51 +0000
committerKshitij Sisodia <kshitij.sisodia@arm.com>2023-01-05 10:25:00 +0000
commit5b4fea129b2f738fc877916111908b955ad07d5a (patch)
treea773435ce52d59eb18224b1fa845bf0f93484849
parentee82c60e5ec707faa5eaa638f397dde7df820dac (diff)
downloadml-embedded-evaluation-kit-5b4fea129b2f738fc877916111908b955ad07d5a.tar.gz
MLECO-3677: Adding links for AN555 resources.
Minor documentation updates to add links for Arm Corstone-310 implementation `AN555`. Change-Id: I5fd1f577b0adcb1041aaefbc41d121ce52404e09 Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
-rw-r--r--Readme.md2
-rw-r--r--docs/documentation.md10
-rw-r--r--docs/sections/deployment.md10
3 files changed, 12 insertions, 10 deletions
diff --git a/Readme.md b/Readme.md
index c907065..1525829 100644
--- a/Readme.md
+++ b/Readme.md
@@ -60,7 +60,7 @@ by displaying different performance metrics such as inference cycle count estima
The evaluation kit primarily supports [Arm® Corstone™-300](https://developer.arm.com/ip-products/subsystem/corstone/corstone-300)
and [Arm® Corstone™-310](https://developer.arm.com/ip-products/subsystem/corstone/corstone-310) reference packages as its
-primary targets. Arm® Corstone™-300 design implementation is publicly available on an [Arm MPS3 FPGA board](https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/download-fpga-images),
+primary targets. Arm® Corstone™-300 and Corstone™-310 design implementations are publicly available on [Download FPGA Images](https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/download-fpga-images) page,
or as a [Fixed Virtual Platform of the MPS3 development board](https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps).
The Ethos-U NPU software stack is described [here](https://developer.arm.com/documentation/101888/0500/NPU-software-overview/NPU-software-components?lang=en).
diff --git a/docs/documentation.md b/docs/documentation.md
index 8998adb..6302c68 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -39,10 +39,10 @@ Before starting the setup process, please make sure that you have:
[Arm Compiler download Page](https://developer.arm.com/tools-and-software/embedded/arm-compiler/downloads)
- An Arm® MPS3 FPGA prototyping board and components for FPGA evaluation or a `Fixed Virtual Platform` binary:
- - An MPS3 board loaded with Arm® Corstone™-300 (`AN552`) or Corstone™-310 reference package. See
+ - An MPS3 board loaded with Arm® Corstone™-300 (`AN552`) or Corstone™-310 reference package (`AN555`). See
<https://developer.arm.com/downloads/-/download-fpga-images>. You
must have a USB connection between your machine and the MPS3 board - for UART menu and for deploying the
- application.
+ application.
- `Arm® Corstone™-300` based FVP for MPS3 is available from:
<https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps>.
- `Arm® Corstone™-310` based FVP is available under Arm® Virtual Hardware: <https://www.arm.com/products/development-tools/simulation/virtual-hardware>
@@ -168,7 +168,7 @@ What these folders contain:
- `use_case`: This contains "model" and "processing" APIs for each individual use case. For example, KWS use case
contains a class for a generic KWS neural network model and the "processing" API give user an easier way to drive
the MFCC calculations.
-
+
> **NOTE:** The API here is also used to export a CMSIS-pack from this repository and therefore, it is imperative to
> that the sources here do not depend on any HAL component or drive any platform dependent logic. If you are looking to
> reuse components from this repository for your application level logic, this directory should be the prime candidate.
@@ -240,13 +240,13 @@ What these folders contain:
for the set-up before calling the user defined "main" function in the higher-level `application` logic.
It is a separate CMake project that is built into a static library `libcmsis_device.a`. It depends on a CMSIS repo
through `CMSIS_SRC_PATH` variable.
- The static library is used by platform code.
+ The static library is used by platform code.
- `source/platform/mps3`\
`source/platform/simple`:
These folders contain platform specific declaration and defines, such as, platform initialisation code, peripheral
memory map, system registers, system specific timer implementation and other.
- Platform is built from selected components and configured cmsis device. It is a separate CMake project, and is
+ Platform is built from selected components and configured cmsis device. It is a separate CMake project, and is
built into a static library `libplatform-drivers.a`. It is linked into HAL library.
## Models and resources
diff --git a/docs/sections/deployment.md b/docs/sections/deployment.md
index ccf46f2..15a58c3 100644
--- a/docs/sections/deployment.md
+++ b/docs/sections/deployment.md
@@ -136,10 +136,10 @@ The FVP supports many command-line parameters, such as:
### Running the FVP without the UI
-If there is a need to run the FVP without the UI (e.g running the FVP inside of a docker container),
+If there is a need to run the FVP without the UI (e.g running the FVP inside of a docker container),
it can be done as follows:
-Add `-C mps3_board.visualisation.disable-visualisation=1` and `-C mps3_board.telnetterminal0.start_telnet=0`
+Add `-C mps3_board.visualisation.disable-visualisation=1` and `-C mps3_board.telnetterminal0.start_telnet=0`
to the command line arguments when starting the FVP. For example:
```commandline
@@ -187,8 +187,10 @@ configuration.
> **Note:**: These instructions are valid only if the evaluation is being done using the MPS3 FPGA platform using
> an Arm® Corstone™-300 (AN552) or Corstone™-310 (AN555) implementations.
-For details on platform set-up, please see the relevant documentation. For the Arm® Corstone™-300 implementation
-`AN552`, the document is available here: [Arm Developer](https://developer.arm.com/documentation/dai0552/).
+For details on platform set-up, please see the relevant documentation.
+
+- Arm® Corstone™-300 implementation `AN552`: [Arm Developer - AN552](https://developer.arm.com/documentation/dai0552/).
+- Arm® Corstone™-310 implementation `AN555`: [Arm Developer - AN555](https://developer.arm.com/documentation/107642/B/?lang=en)
For the MPS3 FPGA board, instead of loading the `axf` file directly, copy the executable blobs generated under the
`sectors/<use_case>` subdirectory to the micro SD card located on the board. Also, the `sectors/images.txt` file is