Skip to content

Commit defc502

Browse files
committed
docs: Documentation improvements
* Move supported toolchain information from application docs to README.md to avoid duplicatiing it on all supported examples. * Move supported platforms description from docs/prerequisites.md to README.md to list and describe the supported platforms in one place. * Add supported versions information to supported targets. Signed-off-by: Devaraj Ranganna <[email protected]>
1 parent d097a4b commit defc502

7 files changed

+20
-38
lines changed

Diff for: README.md

+19-1
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,27 @@ porting of this integration across platforms easy.
1919

2020
## Supported Targets
2121

22-
* [Corstone-300](https://developer.arm.com/Processors/Corstone-300)
22+
Arm Corstone-3xx targets includes an example subsystem based on the Cortex-M
23+
CPU and Ethos NPU, alongside a range of other components in a scalable and
24+
flexible reference package. This enables designers to build secure,
25+
AI-capable SoCs faster.
26+
2327
* [Corstone-310](https://developer.arm.com/Processors/Corstone-310)
28+
* Arm Cortex-M85 CPU and Ethos-U55 NPU
29+
* Supported versions: 11.24.13 and above
30+
* [Corstone-300](https://developer.arm.com/Processors/Corstone-300)
31+
* Arm Cortex-M55 CPU and Ethos-U55 NPU
32+
* Supported versions: 11.24.13 and above
33+
34+
## Supported Toolchains
35+
36+
* Arm Compiler for Embedded (armclang)
37+
* Arm GNU Toolchain (arm-none-eabi-gcc)
2438

39+
> Note:
40+
The build script `./tools/scripts/build.sh` assumes
41+
`Arm Compiler for Embedded (armclang)` by default, append the extra option
42+
`--toolchain GNU` to build using Arm GNU Toolchain.
2543

2644
## Directory structure
2745

Diff for: docs/aws_iot_example.md

-5
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,6 @@ Or, run the command below to perform a clean build:
3131
./tools/scripts/build.sh aws-iot-example -c
3232
```
3333

34-
This will build the example with the Arm Compiler (armclang) by default. If you
35-
would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
36-
[installed by yourself](./development_environment.md), append the extra option
37-
`--toolchain GNU` to the build command above.
38-
3934
## Provisioning the device credentials into Protected Storage
4035

4136
During the build process a ```provisioning_data.bin``` is built into the ```build/applications/aws_iot_example/provisioning_data``` directory.

Diff for: docs/blinky.md

-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,6 @@ Run the command below to perform a clean build:
2626
./tools/scripts/build.sh blinky -c
2727
```
2828

29-
This will build the example with the Arm Compiler (armclang) by default. If you
30-
would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
31-
[installed by yourself](./development_environment.md), append the extra option
32-
`--toolchain GNU` to the build command above.
33-
3429
## Running the application
3530

3631
To run the blinky example, run the following command:

Diff for: docs/keyword_detection.md

-5
Original file line numberDiff line numberDiff line change
@@ -59,11 +59,6 @@ Or, run the command below to perform a clean build:
5959
./tools/scripts/build.sh keyword-detection --certificate_path <certificate pem's path> --private_key_path <private key pem's path> --target <corstone300/corstone310> --inference <ETHOS/SOFTWARE> --audio <ROM/VSI> -c
6060
```
6161

62-
This will build the example with the Arm Compiler (armclang) by default. If you
63-
would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
64-
[installed by yourself](./development_environment.md), append the extra option
65-
`--toolchain GNU` to the build command above.
66-
6762

6863
## Provisioning the device credentials into Protected Storage
6964
During the build process a ```provisioning_data.bin``` is built into the ```build/applications/keyword_detection/provisioning_data``` directory.

Diff for: docs/prerequisites.md

+1-11
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,6 @@
11
# Prerequisites
22

3-
## Setting up the platforms
4-
5-
This reference integration supports [Arm ecosystem FVPs](https://developer.arm.com/downloads/-/arm-ecosystem-fvps).
6-
7-
The Corstone-310 model is a reference subsystem for a secure SSE-310 SoC
8-
aligned with the Arm MPS3 development platform. It is based on a Cortex®-M85
9-
processor and an Ethos-U55 neural network processor and the DMA-350
10-
Direct Memory Access controller. Follow the [link](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
11-
for more information.
12-
13-
### Setting up Arm ecosystem FVPs
3+
## Setting up Arm ecosystem FVPs
144

155
* Download the Corstone-310 FVP from [here](https://developer.arm.com/downloads/-/arm-ecosystem-fvps)
166
* Run the following commands to install the Corstone-310 FVP and add FVP path

Diff for: docs/running_aws_iot_core_device_advisor_tests.md

-5
Original file line numberDiff line numberDiff line change
@@ -89,11 +89,6 @@ Or, run the command below to perform a clean build:
8989
./tools/scripts/build.sh ${APPLICATION_NAME} -c
9090
```
9191

92-
This will build the example with the Arm Compiler (armclang) by default. If you
93-
would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
94-
[installed by yourself](./development_environment.md), append the extra option
95-
`--toolchain GNU` to the build command above.
96-
9792
## Running the application
9893

9994
We need to start the device advisor tests before running the application. If

Diff for: docs/speech_recognition.md

-6
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,6 @@ Or, run the command below to perform a clean build:
3737
./tools/scripts/build.sh speech-recognition --certificate_path <certificate pem's path> --private_key_path <private key pem's path> --target <corstone300/corstone310> --inference <ETHOS/SOFTWARE> --audio <ROM/VSI> -c
3838
```
3939

40-
This will build the example with the Arm Compiler (armclang) by default. If you
41-
would like to build it with the Arm GNU Toolchain (arm-none-eabi-gcc)
42-
[installed by yourself](./development_environment.md), append the extra option
43-
`--toolchain GNU` to the build command above.
44-
45-
4640
## Provisioning the device credentials into Protected Storage
4741
During the build process a ```provisioning_data.bin``` is built into the ```build/applications/speech_recognition/provisioning_data``` directory.
4842
This binary contains the device credentials (private key and certificate).

0 commit comments

Comments
 (0)