aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJonny Svärd <jonny.svaerd@arm.com>2022-05-24 17:01:57 +0200
committerKristofer Jonsson <kristofer.jonsson@arm.com>2022-05-25 09:34:12 +0000
commit90ada2ea5681b2a2722a10d2898eac34c2510791 (patch)
treedf27229d991d99343cb04be186e1328a39108873
parent1c0e7ae4bbf8ee81411b4c2e02c70ca892d17390 (diff)
downloadethos-u-core-driver-90ada2ea5681b2a2722a10d2898eac34c2510791.tar.gz
Clarify README regarding CPU choice22.08-rc222.08-rc122.0822.05
Currently TARGET_CPU should be used to set CPU+features, if using core_platform provided toolchain files. Change-Id: I053cc25de12501a2773238820daa150f9ea20fa7
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index 5338e8f..d5e68bb 100644
--- a/README.md
+++ b/README.md
@@ -8,8 +8,16 @@ The source code comes with a CMake based build system. The driver is expected to
be cross compiled for any of the supported Arm Cortex(R)-M CPUs, which requires
the user to configure the build to match their system configuration.
-One such requirement is to define `CMAKE_SYSTEM_PROCESSOR` for the target CPU,
-for example "cortex-m55+nodsp+nofp". Similarly the target NPU configuration is
+
+One such requirement is to define the target CPU, normally by setting
+`CMAKE_SYSTEM_PROCESSOR`. **Note** that when using the toolchain files provided
+in [core_platform](https://git.mlplatform.org/ml/ethos-u/ethos-u-core-platform.git),
+the variable `TARGET_CPU` must be used instead of `CMAKE_SYSTEM_PROCESSOR`.
+
+Target CPU is specified on the form "cortex-m<nr><features>", for example:
+"cortex-m55+nodsp+nofp".
+
+Similarly the target NPU configuration is
controlled by setting `ETHOSU_TARGET_NPU_CONFIG`, for example "ethos-u55-128".
The build configuration can be defined either in the toolchain file or
@@ -23,6 +31,16 @@ $ cmake -B build \
$ cmake --build build
```
+or when using toolchain files from [core_platform](https://git.mlplatform.org/ml/ethos-u/ethos-u-core-platform.git)
+
+```[bash]
+$ cmake -B build \
+ -DCMAKE_TOOLCHAIN_FILE=<core_platform_toolchain> \
+ -DTARGET_CPU=cortex-m<nr><features> \
+ -DETHOSU_TARGET_NPU_CONFIG=ethos-u<nr>-<macs>
+$ cmake --build build
+```
+
## Driver APIs
The driver APIs are defined in `include/ethosu_driver.h` and the related types