summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKshitij Sisodia <kshitij.sisodia@arm.com>2024-05-15 14:49:31 +0100
committerKshitij Sisodia <kshitij.sisodia@arm.com>2024-05-15 15:01:38 +0100
commit755bcc5f78df8ca179990cc1490ce7167b032e23 (patch)
tree43c7921a69482770b16819174980cb6830f79465 /docs
parent58251ecf150fbe8a09a70015f079e83570d25e51 (diff)
downloadml-embedded-evaluation-kit-main.tar.gz
Minor documentation fixesHEADmain
Minor fixes to broken links in markdown files. Added a note about timing adapters being disabled in Arm Corstone-315 by default. Change-Id: I7f0b33adc8c38e8be7a5bfcebbf5d87f4e22430c Signed-off-by: Kshitij Sisodia <kshitij.sisodia@arm.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/documentation.md6
-rw-r--r--docs/sections/building.md2
-rw-r--r--docs/sections/memory_considerations.md2
-rw-r--r--docs/sections/timing_adapters.md5
-rw-r--r--docs/sections/troubleshooting.md2
5 files changed, 10 insertions, 7 deletions
diff --git a/docs/documentation.md b/docs/documentation.md
index 0476418..41c0642 100644
--- a/docs/documentation.md
+++ b/docs/documentation.md
@@ -329,9 +329,9 @@ For further information, please see:
- [Deployment](./sections/deployment.md#deployment)
- [Fixed Virtual Platform](./sections/deployment.md#fixed-virtual-platform)
- - [Setting up the MPS3 Corstone-300 FVP](./sections/deployment.md#setting-up-the-mps3-arm-corstone_300-fvp)
- - [Deploying on an FVP emulating MPS3](./sections/deployment.md#deploying-on-an-fvp-emulating-mps3)
- - [MPS3 board](./sections/deployment.md#mps3-board)
+ - [Installing an FVP](./sections/deployment.md#installing-an-fvp)
+ - [Deploying on an FVP](./sections/deployment.md#deploying-on-an-fvp)
+ - [MPS3 FPGA board](./sections/deployment.md#mps3-fpga-board)
- [Deployment on MPS3 board](./sections/deployment.md#deployment-on-mps3-board)
## Implementing custom ML application
diff --git a/docs/sections/building.md b/docs/sections/building.md
index 7854c6a..775f71a 100644
--- a/docs/sections/building.md
+++ b/docs/sections/building.md
@@ -486,7 +486,7 @@ cmake .. \
Default CMake configuration behaviour looks for input samples, for each use case, in the default directory. All these
inputs are baked-in into the application. If the number of files baked in is greater than one, a user menu is displayed
on the application output, where the user is expected to enter their chosen option. See more here:
-[Deploying on an FVP emulating MPS3](./deployment.md#deploying-on-an-fvp-emulating-mps3).
+[Deploying on an FVP emulating MPS3](./deployment.md#deploying-on-an-fvp).
To configure the project to use single input for each use case, CMake option `USE_SINGLE_INPUT` can be set to `ON`.
This will result in each use case automatically running with predefined input data, thus removing the need for the
diff --git a/docs/sections/memory_considerations.md b/docs/sections/memory_considerations.md
index b8d1c25..30b36ac 100644
--- a/docs/sections/memory_considerations.md
+++ b/docs/sections/memory_considerations.md
@@ -290,6 +290,6 @@ used by a Vela optimized neural network model, then the Arm® *Ethos™-U* NPU w
A bigger region of memory for storing the neural network model is placed in the DDR, or flash, region under
`LOAD_REGION_1`. The two load regions are necessary as the motherboard configuration controller of the MPS3 limits the
load size at address `0x00000000` to 1MiB. This has implications on how the application **is deployed** on MPS3, as
-explained under the following section: [Deployment on MPS3](./deployment.md#mps3-board).
+explained under the following section: [Deployment on MPS3](./deployment.md#mps3-fpga-board).
The next section of the documentation covers: [Troubleshooting](troubleshooting.md).
diff --git a/docs/sections/timing_adapters.md b/docs/sections/timing_adapters.md
index b5d6e98..24f2fc9 100644
--- a/docs/sections/timing_adapters.md
+++ b/docs/sections/timing_adapters.md
@@ -161,4 +161,7 @@ not support the feature. Additionally - base addresses of timer adapters blocks
| 3 | User memory | 0x4170_3000/0x5170_3000 | 4KB |
This is why the evaluation kit is configured with timing adapters disabled altogether (parameter
-`ETHOS_U_NPU_TIMING_ADAPTER_ENABLED` set to `OFF`) for Corstone-310 target platform.
+`ETHOS_U_NPU_TIMING_ADAPTER_ENABLED` set to `OFF`) for Corstone-310 target platform.
+
+> **NOTE**: Arm® Corstone™-315 reference platforms do not use timing adapters. Therefore, like for
+Arm® Corstone™-310, they are force-disabled in the CMake configuration.
diff --git a/docs/sections/troubleshooting.md b/docs/sections/troubleshooting.md
index 6841e62..180f62d 100644
--- a/docs/sections/troubleshooting.md
+++ b/docs/sections/troubleshooting.md
@@ -51,7 +51,7 @@ For example, if the `accelerator-config` from the Vela command was `ethos-u55-12
`ethos-u55-256`, the FVP must be executed with additional command line parameter to instruct it to emulate the
256 MACs configuration instead.
-The [deploying on an FVP emulating MPS3](./deployment.md#deploying-on-an-fvp-emulating-mps3) page provides guidance
+The [deploying on an FVP](./deployment.md#deploying-on-an-fvp) page provides guidance
on how to instruct the FVP to change the number of MACs units.
Note that when the FVP is launched and the application starts executing, various parameters about the system are