summaryrefslogtreecommitdiff
path: root/meta-arm/meta-arm-bsp/documentation
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-11-17 16:29:11 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-11-19 05:11:25 +0300
commit7784c4292cd9e369da612736deb0691153d1b786 (patch)
tree31368891eb9ce67a004712b5269b7b9b0f0a3c89 /meta-arm/meta-arm-bsp/documentation
parent4a4f35a2d76c72c60405581c889e2835ca49b641 (diff)
downloadopenbmc-7784c4292cd9e369da612736deb0691153d1b786.tar.xz
subtree updates
- Remove systemd patches for object-manager due to upstream fix. meta-arm: 3b7347cd67..d5f132b199: Abdellatif El Khlifi (2): kas: corstone1000: set branches to langdale arm-bsp/documentation: corstone1000: 2022.11.10 RC: update the user guide Anton Antonov (1): arm-bsp/fvp-base: Enable virtio-rng support and unset preferred 5.15 kernel Emekcan (2): arm-bsp/trusted-services: add checks for null attributes in smm gateway arm-bsp/trusted-services: Fix GetNextVariable max_name_len in smm gateway Jon Mason (3): arm/sbsa-acs: update to the latest version arm/hafnium: cleanup the patches arm/gn: update to the latest SHA Luca Fancellu (1): arm,arm-bsp/recipes-kernel: don't use PN in arm-ffa-transport.inc Peter Hoyes (5): arm/fvp: Join cli arguments in verbose logging arm/lib: Factor out asyncio in FVPRunner arm/lib: Decouple console parsing from the FVPRunner arm/oeqa: Log the FVP output in OEFVPSSHTarget runfvp: Fix verbose output when using --console Ross Burton (1): arm/linux-arm64-ack: fix buildpaths in the perf Python module Rui Miguel Silva (3): arm/trusted-services: check before applying patches arm-bsp/trusted-services: psa test setup corstone1000 arm-bsp/trusted-firmware-m: adjust ps assets for corstone1000 Vishnu Banavath (2): arm-bsp/documentation: corstone1000: 2022.11.10 RC: update the release notes arm-bsp/documentation: corstone1000: 2022.11.10 RC: update the change log meta-raspberrypi: a305f4804b..93dadf336c: Andrei Gherzan (2): ci: Bump actions/checkout to v3 ci: Fix dco-check job with newer git versions Martin Jansa (1): raspberrypi4-64: drop DEFAULTTUNE assignment poky: 482c493cf6..44bb88cc86: Alex Kiernan (1): rust: update 1.64.0 -> 1.65.0 Alexander Kanavin (74): man-pages: upgrade 5.13 -> 6.01 piglit: upgrade to latest revision lsof: upgrade 4.96.3 -> 4.96.4 ffmpeg: upgrade 5.1.1 -> 5.1.2 ccache: upgrade 4.6.3 -> 4.7.2 python3-pip: upgrade 22.2.2 -> 22.3 ltp: upgrade 20220527 -> 20220930 alsa-utils: upgrade 1.2.7 -> 1.2.8 alsa-ucm-conf: upgrade 1.2.7.2 -> 1.2.8 libbsd: upgrade 0.11.6 -> 0.11.7 libunistring: upgrade 1.0 -> 1.1 puzzles: upgrade to latest revision libsoup: upgrade 3.2.0 -> 3.2.1 linux-firmware: upgrade 20220913 -> 20221012 python3-git: upgrade 3.1.28 -> 3.1.29 xwayland: upgrade 22.1.3 -> 22.1.4 strace: upgrade 5.19 -> 6.0 python3-dtschema: upgrade 2022.8.3 -> 2022.9 fontconfig: upgrade 2.14.0 -> 2.14.1 python3-setuptools: upgrade 65.0.2 -> 65.5.0 taglib: upgrade 1.12 -> 1.13 nghttp2: upgrade 1.49.0 -> 1.50.0 python3-wheel: upgrade 0.37.1 -> 0.38.0 libffi: upgrade 3.4.2 -> 3.4.4 libical: upgrade 3.0.15 -> 3.0.16 mtd-utils: upgrade 2.1.4 -> 2.1.5 repo: upgrade 2.29.3 -> 2.29.5 libidn2: upgrade 2.3.3 -> 2.3.4 makedepend: upgrade 1.0.6 -> 1.0.7 diffoscope: upgrade 221 -> 224 mmc-utils: upgrade to latest revision libsoup-2.4: upgrade 2.74.2 -> 2.74.3 gdk-pixbuf: upgrade 2.42.9 -> 2.42.10 harfbuzz: upgrade 5.3.0 -> 5.3.1 netbase: upgrade 6.3 -> 6.4 mpg123: upgrade 1.30.2 -> 1.31.1 sudo: upgrade 1.9.11p3 -> 1.9.12 alsa-lib: upgrade 1.2.7.2 -> 1.2.8 pango: upgrade 1.50.10 -> 1.50.11 pixman: upgrade 0.40.0 -> 0.42.2 vulkan: upgrade 1.3.224.1 -> 1.3.231.1 gstreamer1.0: upgrade 1.20.3 -> 1.20.4 shaderc: upgrade 2022.2 -> 2022.3 selftest: add a copy of previous mtd-utils version to meta-selftest python3: correctly adjust include paths in sysconfigdata vala: install vapigen-wrapper into /usr/bin/crosscripts and stage only that sanity.bbclass: do not check for presence of distutils pango: replace a recipe fix with an upstream submitted patch libpciaccess: update 0.16 -> 0.17 libxinerama: update 1.1.4 -> 1.1.5 libxkbfile: update 1.1.0 -> 1.1.1 libxmu: update 1.1.3 -> 1.1.4 libxrender: update 0.9.10 -> 0.9.11 libxshmfence: update 1.3 -> 1.3.1 libxtst: update 1.2.3 -> 1.2.4 libxxf86vm: update 1.1.4 -> 1.1.5 xcb-util: update to latest revisions xf86-input-vmmouse: update 13.1.0 -> 13.2.0 gnomebase.bbclass: return the whole version for tarball directory if it is a number adwaita-icon-theme: update 42.0 -> 43 libepoxy: convert to git libepoxy: update 1.5.9 -> 1.5.10 rgb: update 1.0.6 -> 1.1.0 meson: update 0.63.3 -> 0.64.0 systemd: update 251.4 -> 251.8 libxext: update 1.3.4 -> 1.3.5 gettext: update 0.21 -> 0.21.1 glib-2.0: update 2.72.3 -> 2.74.1 glib-networking: update 2.72.2 -> 2.74.0 readline: update 8.1.2 -> 8.2 llvm: update 15.0.1 -> 15.0.4 make: update 4.3 -> 4.4 bash: update 5.1.16 -> 5.2.9 mesa: do not rely on native llvm-config in target sysroot Atanas Bunchev (1): qemu.rst: audio: reference to Command-Line options Benjamin Szőke (1): image_types: Add 7-Zip support in conversion types and commands Changhyeok Bae (1): repo: upgrade 2.29.5 -> 2.29.9 Chase Qi (1): libc-test: add libc testsuite for musl Christoph Lauer (1): populate_sdk_base: add zip options David Bagonyi (1): gpgme: Allow setuptools3-base to be excluded from the inherit list Diego Sueiro (1): kernel.bbclass: Include randstruct seed assets in STAGING_KERNEL_BUILDDIR Etienne Cordonnier (1): mirrors.bbclass: use shallow tarball for nativesdk-binutils Jordan Crouse (2): spirv-tools: Correctly set the prefix in exported cmake packages vulkan-loader: Allow headless targets to build the loader Jose Quaresma (3): sstatesig: skip the rm_work task signature rm_work: exclude the SSTATETASKS from the rm_work tasks sinature sstate: Allow optimisation of do_deploy_archives task dependencies Joshua Watt (2): classes: create-spdx: Move to version specific class scripts: convert-overrides: Allow command-line customizations Kai Kang (1): libuv: fixup SRC_URI Konrad Weihmann (1): create-spdx: default share_src for shared sources Lee Chee Yang (1): migration guides: add release notes for 4.0.5 Leon Anavi (2): get_module_deps3.py: Check attribute '__file__' python3-manifest.json: Fix re in core Mark Asselstine (2): bitbake: data: drop unused __expand_var_regexp__ and __expand_python_regexp__ bitbake: data_smart: allow python snippets to include a dictionary Markus Volk (4): webkitgtk: use libsoup-3.0 by default epiphany: use libsoup-3.0 by default gstreamer1.0-plugins-good: use libsoup-3.0 by default libinput: upgrade 1.19.4 -> 1.21.0 Martin Jansa (1): cargo.bbclass: avoid calling which ${RUSTC} with undefined ${RUSTC} Michael Opdenacker (10): ref-manual: terms.rst: add SBOM and SPDX terms ref-manual: variables.rst: document spdx-create class variables dev-manual: common-tasks.rst: add section about SPDX / SBOM generation ref-manual: classes.rst: expand documentation of create-spdx class ref-manual: terms.rst: add reference to new SBOM/SPDX section in dev manual manuals: document "mime-xdg" class and MIME_XDG_PACKAGES manuals: add shortcut for Wikipedia links ref-manual/variables.rst: expand BB_NUMBER_THREADS description ref-manual/variables.rst: expand PARALLEL_MAKE description release-notes: use oe_git and yocto_git macros Nathan Rossi (4): oeqa/selftest/lic_checksum: Cleanup changes to emptytest include oeqa/selftest/minidebuginfo: Create selftest for minidebuginfo glibc-locale: Do not INHIBIT_DEFAULT_DEPS package: Fix handling of minidebuginfo with newer binutils Niko Mauno (1): systemd: Consider PACKAGECONFIG in RRECOMMENDS Paulo Neves (1): manuals: remove xterm requirements Pavel Zhukov (1): bitbake: gitsm: Fix regression in gitsm submodule path parsing Peter Kjellerstedt (1): pango: Make it build with ptest disabled Peter Marko (2): systemd: add group render to udev package meta-selftest/staticids: add render group for systemd Quentin Schulz (3): docs: ref-manual: classes: fix section name for github-releases docs: ref-manual: classes: add missing closing parenthesis docs: poky.yaml.in: remove pylint3 from Ubuntu/Debian host dependencies Richard Purdie (7): bitbake.conf: Drop export of SOURCE_DATE_EPOCH_FALLBACK gcc-shared-source: Fix source date epoch handling gcc-source: Fix gengtypes race gcc-source: Drop gengtype manipulation gcc-source: Ensure deploy_source_date_epoch sstate hash doesn't change sanity: Drop data finalize call bitbake: data/data_smart/build: Clean up datastore finalize/update_data references Robert Yang (1): bitbake: gitsm.py: process_submodules(): Set nobranch=1 for url Ross Burton (19): insane: add codeload.github.com to src-uri-bad check populate_sdk_ext: use ConfigParser instead of SafeConfigParser stress-ng: improve makefile use linux-firmware: don't put the firmware into the sysroot oeqa/qemurunner: update exception class for QMP API changes oeqa/core/decorator: add decorators to skip based on HOST_ARCH oeqa/selftest/buildoptions: skip test_read_only_image on qemuarm64 oeqa/selftest/efibootpartition: improve test oeqa/selftest/imagefeatures: remove hardcoded MACHINE in test_image_gen_debugfs oeqa/selftest/imagefeatures: don't use wic images in test_hypervisor_fmts oeqa/selftest/imagefeatures: set a .wks in test_fs_types oeqa/selftest/overlayfs: overlayfs: skip x86-specific tests oeqa/selftest/package: generalise test_gdb_hardlink_debug() oeqa/selftest/package: improve test_preserve_ownership oeqa/selftest/runqemu: don't hardcode qemux86-64 oeqa/selftest/runtime_test: only run the virgl tests on qemux86-64 oeqa/selftest/wic: skip more tests on aarch64 oeqa/selftest/wic: use skipIfNotArch instead of custom decorator classes/testexport: move to classes-recipe Sergei Zhmylev (1): wic: make ext2/3/4 images reproducible Tim Orling (4): python3-typing-extensions: upgrade 4.3.0 -> 4.4.0 bitbake: toaster: fixtures/README: django 1.8 -> 3.2 bitbake: toaster: fixtures/gen_fixtures.py: update branches bitbake: toaster: Add refreshed oe-core and poky fixtures Ulrich Ölmann (1): dev-manual: common-tasks.rst: fix typos Wang Mingyu (33): bind: upgrade 9.18.7 -> 9.18.8 libedit: upgrade 20210910-3.1 -> 20221030-3.1 mtools: upgrade 4.0.41 -> 4.0.42 diffstat: upgrade 1.64 -> 1.65 inetutils: upgrade 2.3 -> 2.4 orc: upgrade 0.4.32 -> 0.4.33 socat: upgrade 1.7.4.3 -> 1.7.4.4 libxcrypt: upgrade 4.4.28 -> 4.4.30 python3-babel: upgrade 2.10.3 -> 2.11.0 python3-hatch-fancy-pypi-readme: upgrade 22.7.0 -> 22.8.0 python3-hatchling upgrade: 1.11.0 -> 1.11.1 gi-docgen: upgrade 2022.1 -> 2022.2 libdrm: upgrade 2.4.113 -> 2.4.114 mmc-utils: upgrade to latest revision mobile-broadband-provider-info: upgrade 20220725 -> 20221107 libsdl2: upgrade 2.24.1 -> 2.24.2 mesa: upgrade 22.2.2 -> 22.2.3 python3-dtschema: upgrade 2022.9 -> 2022.11 python3-flit-core: upgrade 3.7.1 -> 3.8.0 python3-pip: update 22.3 -> 22.3.1 python3-psutil: upgrade 5.9.3 -> 5.9.4 python3-setuptools: upgrade 65.5.0 -> 65.5.1 python3-sphinx-rtd-theme: upgrade 1.1.0 -> 1.1.1 python3-subunit: upgrade 1.4.0 -> 1.4.1 python3-wheel: upgrade 0.38.0 -> 0.38.4 sed: update 4.8 -> 4.9 sudo: upgrade 1.9.12 -> 1.9.12p1 sysstat: upgrade 12.6.0 -> 12.6.1 babeltrace: upgrade 1.5.8 -> 1.5.11 iso-codes: upgrade 4.11.0 -> 4.12.0 libsoup: upgrade 3.2.1 -> 3.2.2 wayland-protocols: upgrade 1.27 -> 1.28 xwayland: upgrade 22.1.4 -> 22.1.5 zhengruoqin (5): python3-jsonschema: upgrade 4.16.0 -> 4.17.0 python3-pyrsistent: upgrade 0.18.1 -> 0.19.2 python3-numpy: upgrade 1.23.3 -> 1.23.4 python3-sphinx-rtd-theme: upgrade 1.0.0 -> 1.1.0 python3-pbr: upgrade 5.10.0 -> 5.11.0 meta-openembedded: 6ebff843cc..d04444509a: Armin Kuster (1): meta-oe][PATCH] gst-editing-services: fix typo in LICENSE field. Chen Pei (1): python3-brotli: Add new recipe for 1.0.9 Kory Maincent (1): openocd: fix build error Leon Anavi (6): python3-automat: Upgrade 20.2.0 -> 22.10.0 python3-asttokens: Upgrade 2.0.8 -> 2.1.0 python3-zeroconf: Upgrade 0.39.2 -> 0.39.4 python3-imageio: Upgrade 2.22.2 -> 2.22.3 python3-httplib: Upgrade 0.20.4 -> 0.21.0 python3-twisted: Upgrade 22.8.0 -> 22.10.0 Markus Volk (6): pugixml: upgrade 1.12 -> 1.13 geary: update 40.0 -> 43.0 rest: upgrade 0.8.1 -> 0.9.0 gnome-online-accounts: update 3.44.0 -> 3.46.0 yelp: use libsoup-3.0 by default surf: use libsoup-3.0 by default Martin Jansa (1): monkey: use git fetcher Randy MacLeod (1): nftables: use automake ptest output format Sakib Sajal (1): minio: add recipe for minio client Tim Orling (5): libcompress-raw-bzip2-perl: upgrade 2.096 -> 2.201 libcompress-raw-lzma-perl: upgrade 2.096 -> 2.201 libcompress-raw-zlib-perl: upgrade 2.096 -> 2.202 libio-compress-lzma-perl: upgrade 2.096 -> 2.201 libio-compress-perl: upgrade 2.096 -> 2.201 Wang Mingyu (43): python3-lazy-object-proxy: upgrade 1.7.1 -> 1.8.0 python3-luma-oled: upgrade 3.8.1 -> 3.9.0 python3-nmap: upgrade 1.5.4 -> 1.6.0 python3-pint: upgrade 0.20 -> 0.20.1 python3-protobuf: upgrade 4.21.8 -> 4.21.9 python3-pytest-benchmark: upgrade 3.4.1 -> 4.0.0 python3-pytest-html: upgrade 3.1.1 -> 3.2.0 python3-pytest-xdist: upgrade 2.5.0 -> 3.0.2 python3-requests-toolbelt: upgrade 0.10.0 -> 0.10.1 python3-websockets: upgrade 10.3 -> 10.4 fetchmail: Fix buildpaths warning. libxpresent: upgrade 1.0.0 -> 1.0.1 xkbprint: upgrade 1.0.5 -> 1.0.6 xmlsec1: upgrade 1.2.34 -> 1.2.36 openwsman: Change download branch from master to main. hwdata: upgrade 0.363 -> 0.364 lcms: upgrade 2.13.1 -> 2.14 libdbd-sqlite-perl: upgrade 1.70 -> 1.72 mosh: upgrade 1.3.2 -> 1.4.0 xfstests: upgrade 2022.10.09 -> 2022.10.30 ulogd2: upgrade 2.0.7 -> 2.0.8 cli11: upgrade 2.3.0 -> 2.3.1 ctags: upgrade 5.9.20221023.0 -> 5.9.20221106.0 valijson: upgrade 0.7 -> 1.0 openvpn: upgrade 2.5.7 -> 2.5.8 poco: upgrade 1.12.3 -> 1.12.4 poppler: upgrade 22.10.0 -> 22.11.0 satyr: upgrade 0.39 -> 0.40 ser1net: upgrade 4.3.8 -> 4.3.9 stunnel: upgrade 5.66 -> 5.67 wolfssl: upgrade 5.5.2 -> 5.5.3 tio: upgrade 2.2 -> 2.3 uhubctl: upgrade 2.4.0 -> 2.5.0 zabbix: upgrade 6.2.3 -> 6.2.4 python3-spidev: upgrade 3.5 -> 3.6 python3-gevent: upgrade 22.10.1 -> 22.10.2 python3-google-auth: upgrade 2.13.0 -> 2.14.0 python3-greenlet: upgrade 1.1.3.post0 -> 2.0.0 python3-robotframework: upgrade 6.0 -> 6.0.1 python3-regex: upgrade 2022.9.13 -> 2022.10.31 python3-pillow: upgrade 9.2.0 -> 9.3.0 python3-paramiko: upgrade 2.11.0 -> 2.12.0 python3-jsonref: upgrade 0.3.0 -> 1.0.1 leimaohui (1): samba: Fix install conflict with multilib enabled. zhengrq.fnst@fujitsu.com (5): python3-sqlalchemy: upgrade 1.4.42 -> 1.4.43 python3-websocket-client: upgrade 1.4.1 -> 1.4.2 python3-termcolor: upgrade 2.0.1 -> 2.1.0 python3-zopeinterface: upgrade 5.5.0 -> 5.5.1 python3-tqdm: upgrade 4.64.0 -> 4.64.1 Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I0a8f95b57a7b9433fe59a9055a4dae58694c1759
Diffstat (limited to 'meta-arm/meta-arm-bsp/documentation')
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst88
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst54
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst641
3 files changed, 619 insertions, 164 deletions
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst
index 5d6493a490..7cdcd28d78 100644
--- a/meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst
@@ -8,7 +8,73 @@ Change Log
##########
This document contains a summary of the new features, changes and
-fixes in each release of corstone1000 software stack.
+fixes in each release of Corstone-1000 software stack.
+
+******************
+Version 2022.11.10
+******************
+
+Changes
+=======
+
+- Booting the External System (Cortex-M3) with RTX RTOS
+- Adding MHU communication between the HOST (Cortex-A35) and the External System
+- Adding a Linux application to test the External System
+- Adding ESRT (EFI System Resource Table) support
+- Upgrading the SW stack recipes
+- Upgrades for the U-Boot FF-A driver and MM communication
+
+Corstone-1000 components versions
+=======================================
+
++-------------------------------------------+------------+
+| arm-ffa-tee | 1.1.1 |
++-------------------------------------------+------------+
+| arm-ffa-user | 5.0.0 |
++-------------------------------------------+------------+
+| corstone1000-external-sys-tests | 1.0 |
++-------------------------------------------+------------+
+| external-system | 0.1.0 |
++-------------------------------------------+------------+
+| linux-yocto | 5.19 |
++-------------------------------------------+------------+
+| u-boot | 2022.07 |
++-------------------------------------------+------------+
+| optee-client | 3.18.0 |
++-------------------------------------------+------------+
+| optee-os | 3.18.0 |
++-------------------------------------------+------------+
+| trusted-firmware-a | 2.7.0 |
++-------------------------------------------+------------+
+| trusted-firmware-m | 1.6.0 |
++-------------------------------------------+------------+
+| ts-newlib | 4.1.0 |
++-------------------------------------------+------------+
+| ts-psa-{crypto, iat, its. ps}-api-test | 451aa087a4 |
++-------------------------------------------+------------+
+| ts-sp-{se-proxy, smm-gateway} | 3d4956770f |
++-------------------------------------------+------------+
+
+Yocto distribution components versions
+=======================================
+
++-------------------------------------------+---------------------+
+| meta-arm | langdale |
++-------------------------------------------+---------------------+
+| poky | langdale |
++-------------------------------------------+---------------------+
+| meta-openembedded | langdale |
++-------------------------------------------+---------------------+
+| busybox | 1.35.0 |
++-------------------------------------------+---------------------+
+| musl | 1.2.3+git37e18b7bf3 |
++-------------------------------------------+---------------------+
+| gcc-arm-none-eabi-native | 11.2-2022.02 |
++-------------------------------------------+---------------------+
+| gcc-cross-aarch64 | 12.2 |
++-------------------------------------------+---------------------+
+| openssl | 3.0.5 |
++-------------------------------------------+---------------------+
******************
Version 2022.04.04
@@ -26,10 +92,10 @@ Version 2022.02.25
Changes
=======
-- Building and running psa-arch-tests on corstone1000 FVP
-- Enabled smm-gateway partition in Trusted Service on corstone1000 FVP
-- Enabled MHU driver in Trusted Service on corstone1000 FVP
-- Enabled OpenAMP support in SE proxy SP on corstone1000 FVP
+- Building and running psa-arch-tests on Corstone-1000 FVP
+- Enabled smm-gateway partition in Trusted Service on Corstone-1000 FVP
+- Enabled MHU driver in Trusted Service on Corstone-1000 FVP
+- Enabled OpenAMP support in SE proxy SP on Corstone-1000 FVP
******************
Version 2022.02.21
@@ -48,7 +114,7 @@ Changes
=======
- psa-arch-tests: change master to main for psa-arch-tests
- U-Boot: fix null pointer exception for get_image_info
-- TF-M: fix capsule instability issue for corstone1000
+- TF-M: fix capsule instability issue for Corstone-1000
******************
Version 2022.01.07
@@ -56,9 +122,9 @@ Version 2022.01.07
Changes
=======
-- corstone1000: fix SystemReady-IR ACS test (SCT, FWTS) failures.
+- Corstone-1000: fix SystemReady-IR ACS test (SCT, FWTS) failures.
- U-Boot: send bootcomplete event to secure enclave.
-- U-Boot: support populating corstone1000 image_info to ESRT table.
+- U-Boot: support populating Corstone-1000 image_info to ESRT table.
- U-Boot: add ethernet device and enable configs to support bootfromnetwork SCT.
******************
@@ -67,7 +133,7 @@ Version 2021.12.15
Changes
=======
-- Enabling corstone1000 FPGA support on:
+- Enabling Corstone-1000 FPGA support on:
- Linux 5.10
- OP-TEE 3.14
- Trusted Firmware-A 2.5
@@ -83,7 +149,7 @@ Version 2021.10.29
Changes
=======
-- Enabling corstone1000 FVP support on:
+- Enabling Corstone-1000 FVP support on:
- Linux 5.10
- OP-TEE 3.14
- Trusted Firmware-A 2.5
@@ -95,4 +161,4 @@ Changes
--------------
-*Copyright (c) 2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2022, Arm Limited. All rights reserved.*
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst
index 385331bd23..f657c26bc2 100644
--- a/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst
@@ -8,22 +8,44 @@ Release notes
#############
**************************
+Release notes - 2022.11.10
+**************************
+
+Known Issues or Limitations
+---------------------------
+ - The external-system can not be reset individually on (or using) AN550_v1 FPGA release. However, the system-wide reset still applies to the external-system.
+ - FPGA supports Linux distro install and boot through installer. However, FVP only supports openSUSE raw image installation and boot.
+ - Due to the performance uplimit of MPS3 FPGA and FVP, some Linux distros like Fedora Rawhide can not boot on Corstone-1000 (i.e. user may experience timeouts or boot hang).
+ - Below SCT FAILURE is a known issues in the FVP:
+ UEFI Compliant - Boot from network protocols must be implemented -- FAILURE
+ - Known limitations regarding ACS tests: The behavior after running ACS tests on FVP is not consistent. Both behaviors are expected and are valid;
+ The system might boot till the Linux prompt. Or, the system might wait after finishing the ACS tests.
+ In both cases, the system executes the entire test suite and writes the results as stated in the user guide.
+
+Platform Support
+-----------------
+ - This software release is tested on Corstone-1000 FPGA version AN550_v1
+ https://developer.arm.com/downloads/-/download-fpga-images
+ - This software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.19_21
+ https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
+
+**************************
Release notes - 2022.04.04
**************************
Known Issues or Limitations
---------------------------
- - FGPA support Linux distro install and boot through installer. However,
+ - FPGA support Linux distro install and boot through installer. However,
FVP only support openSUSE raw image installation and boot.
- Due to the performance uplimit of MPS3 FPGA and FVP, some Linux distros like Fedora Rawhide
- cannot boot on corstone1000 (i.e. user may experience timeouts or boot hang).
+ cannot boot on Corstone-1000 (i.e. user may experience timeouts or boot hang).
- Below SCT FAILURE is a known issues in the FVP:
UEFI Compliant - Boot from network protocols must be implemented -- FAILURE
Platform Support
-----------------
- - This software release is tested on corstone1000 FPGA version AN550_v1
- - This software release is tested on corstone1000 Fast Model platform (FVP) version 11.17_23
+ - This software release is tested on Corstone-1000 FPGA version AN550_v1
+ - This software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.17_23
https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
**************************
@@ -32,13 +54,13 @@ Release notes - 2022.02.25
Known Issues or Limitations
---------------------------
- - The following tests only work on corstone1000 FPGA: ACS tests (SCT, FWTS,
+ - The following tests only work on Corstone-1000 FPGA: ACS tests (SCT, FWTS,
BSA), manual capsule update test, Linux distro install and boot.
Platform Support
----------------
- - This software release is tested on corstone1000 FPGA version AN550_v1
- - This software release is tested on corstone1000 Fast Model platform (FVP) version 11.17_23
+ - This software release is tested on Corstone-1000 FPGA version AN550_v1
+ - This software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.17_23
https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
Release notes - 2022.02.21
@@ -46,13 +68,13 @@ Release notes - 2022.02.21
Known Issues or Limitations
---------------------------
- - The following tests only work on corstone1000 FPGA: ACS tests (SCT, FWTS,
+ - The following tests only work on Corstone-1000 FPGA: ACS tests (SCT, FWTS,
BSA), manual capsule update test, Linux distro install and boot, psa-arch-test.
Platform Support
----------------
- - This software release is tested on corstone1000 FPGA version AN550_v1
- - This software release is tested on corstone1000 Fast Model platform (FVP) version 11.16.21
+ - This software release is tested on Corstone-1000 FPGA version AN550_v1
+ - This software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.16.21
https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
Release notes - 2022.01.18
@@ -85,13 +107,13 @@ The following components are present in the release:
Platform Support
----------------
- - This software release is tested on corstone1000 FPGA version AN550_v1
- - This software release is tested on corstone1000 Fast Model platform (FVP) version 11.16.21
+ - This software release is tested on Corstone-1000 FPGA version AN550_v1
+ - This software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.16.21
https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
Known Issues or Limitations
---------------------------
- - The following tests only work on corstone1000 FPGA: ACS tests (SCT, FWTS,
+ - The following tests only work on Corstone-1000 FPGA: ACS tests (SCT, FWTS,
BSA), manual capsule update test, Linux distro install and boot, and
psa-arch-tests.
- Only the manual capsule update from UEFI shell is supported on FPGA.
@@ -107,7 +129,7 @@ Release notes - 2021.10.29
Software Features
-----------------
-This initial release of corstone1000 supports booting Linux on the Cortex-A35
+This initial release of Corstone-1000 supports booting Linux on the Cortex-A35
and TF-M/MCUBOOT in the Secure Enclave. The following components are present in
the release:
@@ -119,7 +141,7 @@ the release:
Platform Support
----------------
- - This Software release is tested on corstone1000 Fast Model platform (FVP) version 11.16.21
+ - This Software release is tested on Corstone-1000 Fast Model platform (FVP) version 11.16.21
https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
Known Issues or Limitations
@@ -134,4 +156,4 @@ For support email: support-subsystem-iot@arm.com
--------------
-*Copyright (c) 2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2022, Arm Limited. All rights reserved.*
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst
index d5930fc8e5..a6350bb8b0 100644
--- a/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst
@@ -9,9 +9,9 @@ User Guide
Notice
------
-The corstone1000 software stack uses the `Yocto Project <https://www.yoctoproject.org/>`__ to build
-a tiny Linux distribution suitable for the corstone1000 platform. The Yocto Project relies on the
-`Bitbake <https://docs.yoctoproject.org/bitbake.html#bitbake-documentation>`__
+The Corstone-1000 software stack uses the `Yocto Project <https://www.yoctoproject.org/>`__ to build
+a tiny Linux distribution suitable for the Corstone-1000 platform (kernel and initramfs filesystem less than 5 MB on the flash).
+The Yocto Project relies on the `Bitbake <https://docs.yoctoproject.org/bitbake.html#bitbake-documentation>`__
tool as its build tool. Please see `Yocto Project documentation <https://docs.yoctoproject.org/>`__
for more information.
@@ -35,12 +35,12 @@ The following prerequisites must be available on the host system. To resolve the
Provided components
-------------------
-Within the Yocto Project, each component included in the corstone1000 software stack is specified as
-a `bitbake recipe <https://www.yoctoproject.org/docs/1.6/bitbake-user-manual/bitbake-user-manual.html#recipes>`__.
-The recipes specific to the corstone1000 BSP are located at:
+Within the Yocto Project, each component included in the Corstone-1000 software stack is specified as
+a `bitbake recipe <https://docs.yoctoproject.org/bitbake/2.2/bitbake-user-manual/bitbake-user-manual-intro.html#recipes>`__.
+The recipes specific to the Corstone-1000 BSP are located at:
``<_workspace>/meta-arm/meta-arm-bsp/``.
-The Yocto machine config files for the corstone1000 FVP and FPGA are:
+The Yocto machine config files for the Corstone-1000 FVP and FPGA targets are:
- ``<_workspace>/meta-arm/meta-arm-bsp/conf/machine/include/corstone1000.inc``
- ``<_workspace>/meta-arm/meta-arm-bsp/conf/machine/corstone1000-fvp.conf``
@@ -86,7 +86,7 @@ The distro is based on the `poky-tiny <https://wiki.yoctoproject.org/wiki/Poky-T
distribution which is a Linux distribution stripped down to a minimal configuration.
The provided distribution is based on busybox and built using muslibc. The
-recipe responsible for building a tiny version of linux is listed below.
+recipe responsible for building a tiny version of Linux is listed below.
+-----------+----------------------------------------------------------------------------------------------+
| bbappend | <_workspace>/meta-arm/meta-arm-bsp/recipes-kernel/linux/linux-yocto_%.bbappend |
@@ -96,6 +96,16 @@ recipe responsible for building a tiny version of linux is listed below.
| defconfig | <_workspace>/meta-arm/meta-arm-bsp/recipes-kernel/linux/files/corstone1000/defconfig |
+-----------+----------------------------------------------------------------------------------------------+
+External System Tests
+=======================
+Based on `Corstone-1000/applications <https://git.gitlab.arm.com/arm-reference-solutions/corstone1000/applications>`__
+
++------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/meta-arm/meta-arm-bsp/recipes-test/corstone1000-external-sys-tests/corstone1000-external-sys-tests_1.0.bb |
++------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
+
+The recipe provides the systems-comms-tests command run in Linux and used for testing the External System.
+
**************************************************
Software for Boot Processor (a.k.a Secure Enclave)
**************************************************
@@ -107,6 +117,18 @@ Based on `Trusted Firmware-M <https://git.trustedfirmware.org/TF-M/trusted-firmw
| Recipe | <_workspace>/meta-arm/meta-arm/recipes-bsp/trusted-firmware-m/trusted-firmware-m_1.6.0.bb |
+----------+-------------------------------------------------------------------------------------------------+
+**************************************************
+Software for the External System
+**************************************************
+
+RTX
+====
+Based on `RTX RTOS <https://git.gitlab.arm.com/arm-reference-solutions/corstone1000/external_system/rtx>`__
+
++----------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/meta-arm/meta-arm-bsp/recipes-bsp/external-system/external-system_0.1.0.bb |
++----------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
+
Building the software stack
---------------------------
Create a new folder that will be your workspace and will henceforth be referred
@@ -117,7 +139,7 @@ to as ``<_workspace>`` in these instructions. To create the folder, run:
mkdir <_workspace>
cd <_workspace>
-corstone1000 is a Bitbake based Yocto Project which uses kas and bitbake
+Corstone-1000 software is based on the Yocto Project which uses kas and bitbake
commands to build the stack. To install kas tool, run:
::
@@ -128,15 +150,15 @@ In the top directory of the workspace ``<_workspace>``, run:
::
- git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.04.07
+ git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.11.10
-To build corstone1000 image for MPS3 FPGA, run:
+To build a Corstone-1000 image for MPS3 FPGA, run:
::
kas build meta-arm/kas/corstone1000-mps3.yml
-Alternatively, to build corstone1000 image for FVP, run:
+Alternatively, to build a Corstone-1000 image for FVP, run:
::
@@ -150,22 +172,19 @@ Once the build is successful, all output binaries will be placed in the followin
- ``<_workspace>/build/tmp/deploy/images/corstone1000-fvp/`` folder for FVP build;
- ``<_workspace>/build/tmp/deploy/images/corstone1000-mps3/`` folder for FPGA build.
-Everything apart from the ROM firmware is bundled into a single binary, the
-``corstone1000-image-corstone1000-{mps3,fvp}.wic.nopt`` file. The ROM firmware is the
-``bl1.bin`` file.
-
-The output binaries used by FVP are the following:
- - The ROM firmware: ``<_workspace>/build/tmp/deploy/images/corstone1000-fvp/bl1.bin``
- - The flash image: ``<_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.wic.nopt``
+Everything apart from the Secure Enclave ROM firmware and External System firmware, is bundled into a single binary, the
+``corstone1000-image-corstone1000-{mps3,fvp}.wic.nopt`` file.
-The output binaries used by FPGA are the following:
- - The ROM firmware: ``<_workspace>/build/tmp/deploy/images/corstone1000-mps3/bl1.bin``
- - The flash image: ``<_workspace>/build/tmp/deploy/images/corstone1000-mps3/corstone1000-image-corstone1000-mps3.wic.nopt``
+The output binaries run in the Corstone-1000 platform are the following:
+ - The Secure Enclave ROM firmware: ``<_workspace>/build/tmp/deploy/images/corstone1000-{mps3,fvp}/bl1.bin``
+ - The External System firmware: ``<_workspace>/build/tmp/deploy/images/corstone1000-{mps3,fvp}/es_flashfw.bin``
+ - The flash image: ``<_workspace>/build/tmp/deploy/images/corstone1000-{mps3,fvp}/corstone1000-image-corstone1000-{mps3,fvp}.wic.nopt``
Flash the firmware image on FPGA
--------------------------------
-The user should download the FPGA bit file image from `this link <https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/download-fpga-images>`__
+The user should download the FPGA bit file image ``AN550: Arm® Corstone™-1000 for MPS3 Version 1``
+from `this link <https://developer.arm.com/tools-and-software/development-boards/fpga-prototyping-boards/download-fpga-images>`__
and under the section ``Arm® Corstone™-1000 for MPS3``.
The directory structure of the FPGA bundle is shown below.
@@ -214,24 +233,32 @@ Here is an example
;************************************************
[IMAGES]
- TOTALIMAGES: 2 ;Number of Images (Max: 32)
-
+ TOTALIMAGES: 3 ;Number of Images (Max: 32)
+
IMAGE0PORT: 1
IMAGE0ADDRESS: 0x00_0000_0000
IMAGE0UPDATE: RAM
IMAGE0FILE: \SOFTWARE\bl1.bin
-
+
IMAGE1PORT: 0
- IMAGE1ADDRESS: 0x00_00010_0000
+ IMAGE1ADDRESS: 0x00_0010_0000
IMAGE1UPDATE: AUTOQSPI
IMAGE1FILE: \SOFTWARE\cs1000.bin
+
+ IMAGE2PORT: 2
+ IMAGE2ADDRESS: 0x00_0000_0000
+ IMAGE2UPDATE: RAM
+ IMAGE2FILE: \SOFTWARE\es0.bin
OUTPUT_DIR = ``<_workspace>/build/tmp/deploy/images/corstone1000-mps3``
1. Copy ``bl1.bin`` from OUTPUT_DIR directory to SOFTWARE directory of the FPGA bundle.
-2. Copy ``corstone1000-image-corstone1000-mps3.wic.nopt`` from OUTPUT_DIR directory to SOFTWARE
- directory of the FPGA bundle and rename the wic image to ``cs1000.bin``.
+2. Copy ``es_flashfw.bin`` from OUTPUT_DIR directory to SOFTWARE directory of the FPGA bundle
+ and rename the binary to ``es0.bin``.
+3. Copy ``corstone1000-image-corstone1000-mps3.wic.nopt`` from OUTPUT_DIR directory to SOFTWARE
+ directory of the FPGA bundle and rename the wic.nopt image to ``cs1000.bin``.
+
**NOTE:** Renaming of the images are required because MCC firmware has
limitation of 8 characters before .(dot) and 3 characters after .(dot).
@@ -240,41 +267,54 @@ Now, copy the entire folder to board's SDCard and reboot the board.
Running the software on FPGA
----------------------------
-On the host machine, open 3 minicom sessions. In case of Linux machine it will
-be ttyUSB0, ttyUSB1, ttyUSB2 and it might be different on Window machine.
+On the host machine, open 4 serial port terminals. In case of Linux machine it will
+be ttyUSB0, ttyUSB1, ttyUSB2, ttyUSB3 and it might be different on Windows machines.
- ttyUSB0 for MCC, OP-TEE and Secure Partition
- ttyUSB1 for Boot Processor (Cortex-M0+)
- ttyUSB2 for Host Processor (Cortex-A35)
+ - ttyUSB3 for External System Processor (Cortex-M3)
-Run following commands to open minicom sessions on Linux:
+Run following commands to open serial port terminals on Linux:
::
sudo picocom -b 115200 /dev/ttyUSB0 # in one terminal
sudo picocom -b 115200 /dev/ttyUSB1 # in another terminal
sudo picocom -b 115200 /dev/ttyUSB2 # in another terminal.
+ sudo picocom -b 115200 /dev/ttyUSB3 # in another terminal.
Once the system boot is completed, you should see console
-logs on the minicom sessions. Once the HOST(Cortex-A35) is
+logs on the serial port terminals. Once the HOST(Cortex-A35) is
booted completely, user can login to the shell using
**"root"** login.
Running the software on FVP
---------------------------
-An FVP (Fixed Virtual Platform) of the corstone1000 platform must be available to execute the
-included run script.
-The Fixed Virtual Platform (FVP) version 11.17_23 can be downloaded from the
-`Arm Ecosystem FVPs`_ page. On this page, navigate to "Corstone IoT FVPs"
-section to download the Corstone1000 platform FVP installer. Follow the
+An FVP (Fixed Virtual Platform) model of the Corstone-1000 platform must be available to run the
+Corstone-1000 FVP software image.
+
+A Yocto recipe is provided and allows to download the latest supported FVP version.
+
+The recipe is located at <_workspace>/meta-arm/meta-arm/recipes-devtools/fvp/fvp-corstone1000.bb
+
+The latest supported Fixed Virtual Platform (FVP) version is 11.19_21 and is automatically downloaded
+and installed when using the runfvp command as detailed below.
+
+The FVP can also be manually downloaded from the `Arm Ecosystem FVPs`_ page. On this page, navigate
+to "Corstone IoT FVPs" section to download the Corstone-1000 platform FVP installer. Follow the
instructions of the installer and setup the FVP.
+To run the FVP using the runfvp command, please run the following command:
+
+::
+
<_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf
When the script is executed, three terminal instances will be launched, one for the boot processor
(aka Secure Enclave) processing element and two for the Host processing element. Once the FVP is
-executing, the Boot Processor will start to boot, wherein the relevant memory contents of the .wic
+executing, the Boot Processor will start to boot, wherein the relevant memory contents of the .wic.nopt
file are copied to their respective memory locations within the model, enforce firewall policies
on memories and peripherals and then, bring the host out of reset.
@@ -282,13 +322,20 @@ The host will boot trusted-firmware-a, OP-TEE, U-Boot and then Linux, and presen
(FVP host_terminal_0):
::
+
corstone1000-fvp login:
Login using the username root.
-Running test applications
+The External System can be released out of reset on demand using the systems-comms-tests command.
+
+SystemReady-IR tests
-------------------------
+*********************
+Testing steps
+*********************
+
**NOTE**: Running the SystemReady-IR tests described below requires the user to
work with USB sticks. In our testing, not all USB stick models work well with
MPS3 FPGA. Here are the USB sticks models that are stable in our test
@@ -305,7 +352,8 @@ erase the SecureEnclave flash cleanly and prepare a clean board environment for
the testing.
Clean Secure Flash Before Testing (applicable to FPGA only)
------------------------------------------------------------
+==================================================================
+
To prepare a clean board environment with clean secure flash for the testing,
the user should prepare an image that erases the secure flash cleanly during
boot. Run following commands to build such image.
@@ -313,7 +361,7 @@ boot. Run following commands to build such image.
::
cd <_workspace>
- git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.02.18
+ git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.11.10
git clone https://git.gitlab.arm.com/arm-reference-solutions/systemready-patch.git
cp -f systemready-patch/embedded-a/corstone1000/erase_flash/0001-arm-bsp-trusted-firmware-m-corstone1000-Clean-Secure.patch meta-arm
cd meta-arm
@@ -325,7 +373,7 @@ Replace the bl1.bin and cs1000.bin files on the SD card with following files:
- The ROM firmware: <_workspace>/build/tmp/deploy/images/corstone1000-mps3/bl1.bin
- The flash image: <_workspace>/build/tmp/deploy/images/corstone1000-mps3/corstone1000-image-corstone1000-mps3.wic.nopt
-Now reboot the board. This step erases the Corstone1000 SecureEnclave flash
+Now reboot the board. This step erases the Corstone-1000 SecureEnclave flash
completely, the user should expect following message from TF-M log:
::
@@ -338,7 +386,7 @@ Then the user should follow "Building the software stack" to build a clean
software stack and flash the FPGA as normal. And continue the testing.
Run SystemReady-IR ACS tests
------------------------------
+=============================
ACS image contains two partitions. BOOT partition and RESULTS partition.
Following packages are under BOOT partition
@@ -355,10 +403,10 @@ PLEASE MAKE SURE THAT THE RESULTS PARTITION IS EMPTY BEFORE YOU START THE TESTIN
WILL NOT BE CONSISTENT
FPGA instructions for ACS image
--------------------------------
+================================
This section describes how the user can build and run Architecture Compliance
-Suite (ACS) tests on Corstone1000.
+Suite (ACS) tests on Corstone-1000.
First, the user should download the `Arm SystemReady ACS repository <https://github.com/ARM-software/arm-systemready/>`__.
This repository contains the infrastructure to build the Architecture
@@ -374,8 +422,8 @@ Once the repository is successfully downloaded, the prebuilt ACS live image can
- ``<_workspace>/arm-systemready/IR/prebuilt_images/v21.07_0.9_BETA/ir_acs_live_image.img.xz``
**NOTE**: This prebuilt ACS image includes v5.13 kernel, which doesn't provide
-USB driver support for Corstone1000. The ACS image with newer kernel version
-and with full USB support for Corstone1000 will be available in the next
+USB driver support for Corstone-1000. The ACS image with newer kernel version
+and with full USB support for Corstone-1000 will be available in the next
SystemReady release in this repository.
Then, the user should prepare a USB stick with ACS image. In the given example here,
@@ -385,7 +433,7 @@ USB drive. Run the following commands to prepare the ACS image in USB stick:
::
- cd <_workspace>/arm-systemready/IR/scripts/output/
+ cd <_workspace>/arm-systemready/IR/prebuilt_images/v21.07_0.9_BETA
unxz ir_acs_live_image.img.xz
sudo dd if=ir_acs_live_image.img of=/dev/sdb iflag=direct oflag=direct bs=1M status=progress; sync
@@ -394,19 +442,21 @@ ensure that only the USB stick with the ACS image is connected to the board,
and then boot the board.
FVP instructions for ACS image and run
----------------------------------------
+============================================
-Download acs image from:
+Download ACS image from:
- ``https://gitlab.arm.com/systemready/acs/arm-systemready/-/tree/linux-5.17-rc7/IR/prebuilt_images/v22.04_1.0-Linux-v5.17-rc7``
-Use the below command to run the FVP with acs image support in the
+Use the below command to run the FVP with ACS image support in the
SD card.
::
unxz ${<path-to-img>/ir_acs_live_image.img.xz}
-<_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf -- -C board.msd_mmc.p_mmc_file="${<path-to-img>/ir_acs_live_image.img}"
+ tmux
+
+ <_workspace>/meta-arm/scripts/runfvp <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf – -C board.msd_mmc.p_mmc_file="${<path-to-img>/ir_acs_live_image.img}"
The test results can be fetched using following commands:
@@ -416,8 +466,8 @@ The test results can be fetched using following commands:
sudo mount -o rw,offset=<offset_2nd_partition> <path-to-img>/ir_acs_live_image.img /mnt/test/
fdisk -lu <path-to-img>/ir_acs_live_image.img
-> Device Start End Sectors Size Type
- /home/emeara01/Downloads/ir_acs_live_image_modified.img1 2048 1050622 1048575 512M Microsoft basic data
- /home/emeara01/Downloads/ir_acs_live_image_modified.img2 1050624 1153022 102399 50M Microsoft basic data
+ <path-to-img>/ir_acs_live_image_modified.img1 2048 1050622 1048575 512M Microsoft basic data
+ <path-to-img>/ir_acs_live_image_modified.img2 1050624 1153022 102399 50M Microsoft basic data
-> <offset_2nd_partition> = 1050624 * 512 (sector size) = 537919488
@@ -427,7 +477,7 @@ Once test is finished, the FVP can be stoped, and result can be copied following
instructions.
Common to FVP and FPGA
------------------------
+===========================
U-Boot should be able to boot the grub bootloader from
the 1st partition and if grub is not interrupted, tests are executed
@@ -440,81 +490,226 @@ automatically in the following sequence:
The results can be fetched from the ``acs_results`` partition of the USB stick (FPGA) / SD Card (FVP).
-Manual capsule update test
---------------------------
+#####################################################
+
+Manual capsule update and ESRT checks
+---------------------------------------------------------------------
-The following steps describe running manual capsule update with the ``direct``
-method.
+The following section describes running manual capsule update with the ``direct`` method.
-Check the "Run SystemReady-IR ACS tests" section above to download and unpack the acs image file
+The steps described in this section perform manual capsule update and show how to use the ESRT feature
+to retrieve the installed capsule details.
+
+For the following tests two capsules are needed to perform 2 capsule updates. A positive update and a negative update.
+
+A positive test case capsule which boots the platform correctly until the Linux prompt, and a negative test case with an
+incorrect capsule (corrupted or outdated) which fails to boot to the host software.
+
+Check the "Run SystemReady-IR ACS tests" section above to download and unpack the ACS image file
- ``ir_acs_live_image.img.xz``
-Download edk2 and generate capsule file:
+Download edk2 under <_workspace> :
::
git clone https://github.com/tianocore/edk2.git
- edk2/BaseTools/BinWrappers/PosixLike/GenerateCapsule -e -o \
- cs1k_cap --fw-version 1 --lsv 0 --guid \
- e2bb9c06-70e9-4b14-97a3-5a7913176e3f --verbose --update-image-index \
- 0 --verbose <binary_file>
-The <binary_file> here should be a corstone1000-image-corstone1000-fvp.wic.nopt image for FVP and
-corstone1000-image-corstone1000-mps3.wic.nopt for FPGA. And this input binary file
-(capsule) should be less than 15 MB.
+*********************
+Generating Capsules
+*********************
+
+The capsule binary size (wic.nopt file) should be less than 15 MB.
Based on the user's requirement, the user can change the firmware version
number given to ``--fw-version`` option (the version number needs to be >= 1).
-Capsule Copy instructions for FPGA
------------------------------------
+Generating FPGA Capsules
+========================
+
+::
+
+ <_workspace>/edk2/BaseTools/BinWrappers/PosixLike/GenerateCapsule -e -o \
+ cs1k_cap_mps3_v5 --fw-version 5 --lsv 0 --guid \
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f --verbose --update-image-index \
+ 0 --verbose <_workspace>/build/tmp/deploy/images/corstone1000-mps3/corstone1000-image-corstone1000-mps3.wic.nopt
+
+::
+
+ <_workspace>/edk2/BaseTools/BinWrappers/PosixLike/GenerateCapsule -e -o \
+ cs1k_cap_mps3_v6 --fw-version 6 --lsv 0 --guid \
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f --verbose --update-image-index \
+ 0 --verbose <_workspace>/build/tmp/deploy/images/corstone1000-mps3/corstone1000-image-corstone1000-mps3.wic.nopt
+
+Generating FVP Capsules
+========================
+
+::
+
+ <_workspace>/edk2/BaseTools/BinWrappers/PosixLike/GenerateCapsule -e -o \
+ cs1k_cap_fvp_v6 --fw-version 6 --lsv 0 --guid \
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f --verbose --update-image-index \
+ 0 --verbose <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.wic.nopt
+
+::
+
+ <_workspace>/edk2/BaseTools/BinWrappers/PosixLike/GenerateCapsule -e -o \
+ cs1k_cap_fvp_v5 --fw-version 5 --lsv 0 --guid \
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f --verbose --update-image-index \
+ 0 --verbose <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.wic.nopt
+
+*********************
+Copying Capsules
+*********************
+
+Copying the FPGA capsules
+=========================
The user should prepare a USB stick as explained in ACS image section (see above).
-Place the generated ``cs1k_cap`` file in the root directory of the boot partition
+Place the generated ``cs1k_cap`` files in the root directory of the boot partition
in the USB stick. Note: As we are running the direct method, the ``cs1k_cap`` file
should not be under the EFI/UpdateCapsule directory as this may or may not trigger
the on disk method.
-Capsule Copy instructions for FVP
----------------------------------
+::
+
+ sudo cp cs1k_cap_mps3_v6 <mounting path>/BOOT/
+ sudo cp cs1k_cap_mps3_v5 <mounting path>/BOOT/
+ sync
+
+Copying the FVP capsules
+========================
-Run below commands to copy capsule into the
-image file and run FVP software.
+First, mount the IR image:
::
- sudo mkdir /mnt/test
- sudo mount -o rw,offset=<offset_1st_partition> <path-to-img>/ir_acs_live_image.img /mnt/test/
- sudo cp cs1k_cap /mnt/test/
- sudo umount /mnt/test
- exit
+ sudo mkdir /mnt/test
+ sudo mount -o rw,offset=1048576 <path-to-img>/ir_acs_live_image.img /mnt/test
+
+Then, copy the capsules:
+
+::
+
+ sudo cp cs1k_cap_fvp_v6 /mnt/test/
+ sudo cp cs1k_cap_fvp_v5 /mnt/test/
+ sync
+
+Then, unmount the IR image:
-<_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf -- -C "board.msd_mmc.p_mmc_file ${<path-to-img>/ir_acs_live_image.img}"
+::
+
+ sudo umount /mnt/test
+
+**NOTE:**
Size of first partition in the image file is calculated in the following way. The data is
just an example and might vary with different ir_acs_live_image.img files.
::
- fdisk -lu <path-to-img>/ir_acs_live_image.img
- -> Device Start End Sectors Size Type
- /home/emeara01/Downloads/ir_acs_live_image_modified.img1 2048 1050622 1048575 512M Microsoft basic data
- /home/emeara01/Downloads/ir_acs_live_image_modified.img2 1050624 1153022 102399 50M Microsoft basic data
+ fdisk -lu <path-to-img>/ir_acs_live_image.img
+ -> Device Start End Sectors Size Type
+ <path-to-img>/ir_acs_live_image_modified.img1 2048 1050622 1048575 512M Microsoft basic data
+ <path-to-img>/ir_acs_live_image_modified.img2 1050624 1153022 102399 50M Microsoft basic data
- -> <offset_1st_partition> = 2048 * 512 (sector size) = 1048576
+ -> <offset_1st_partition> = 2048 * 512 (sector size) = 1048576
-Common to FVP and FPGA
------------------------
-Reach u-boot then interrupt shell to reach EFI shell. Use below command at EFI shell.
+******************************
+Performing the capsule update
+******************************
+
+During this section we will be using the capsule with the higher version (cs1k_cap_<fvp/mps3>_v6) for the positive scenario
+and the capsule with the lower version (cs1k_cap_<fvp/mps3>_v5) for the negative scenario.
+
+Running the FVP with the IR prebuilt image
+==============================================
+
+Run the FVP with the IR prebuilt image:
+
+::
+
+ <_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf -- -C "board.msd_mmc.p_mmc_file ${<path-to-img>/ir_acs_live_image.img}"
+
+Running the FPGA with the IR prebuilt image
+==============================================
+
+Insert the prepared USB stick then Power cycle the MPS3 board.
+
+Executing capsule update for FVP and FPGA
+==============================================
+
+Reach u-boot then interrupt the boot to reach the EFI shell.
+
+::
+
+ Press ESC in 4 seconds to skip startup.nsh or any other key to continue.
+
+Then, type FS0: as shown below:
::
FS0:
- EFI/BOOT/app/CapsuleApp.efi cs1k_cap
-For this test, the user can provide two capsules for testing: a positive test
-case capsule which boots the board correctly, and a negative test case with an
-incorrect capsule which fails to boot the host software.
+In case of the positive scenario run the update with the higher version capsule as shown below:
+
+::
+
+ EFI/BOOT/app/CapsuleApp.efi cs1k_cap_<fvp/mps3>_v6
+
+After successfully updating the capsule the system will reset.
+
+In case of the negative scenario run the update with the lower version capsule as shown below:
+
+::
+
+ EFI/BOOT/app/CapsuleApp.efi cs1k_cap_<fvp/mps3>_v5
+
+The command above should fail and in the TF-M logs the following message should appear:
+
+::
+
+ ERROR: flash_full_capsule: version error
+
+Then, reboot manually:
+
+::
+
+ Shell> reset
+
+FPGA: Select Corstone-1000 Linux kernel boot
+==============================================
+
+Remove the USB stick before u-boot is reached so the Corstone-1000 kernel will be detected and used for booting.
+
+**NOTE:** Otherwise, the execution ends up in the ACS live image.
+
+FVP: Select Corstone-1000 Linux kernel boot
+==============================================
+
+Interrupt the u-boot shell.
+
+::
+
+ Hit any key to stop autoboot:
+
+Run the following commands in order to run the Corstone-1000 Linux kernel and being able to check the ESRT table.
+
+**NOTE:** Otherwise, the execution ends up in the ACS live image.
+
+::
+
+ $ run retrieve_kernel_load_addr
+ $ unzip $kernel_addr 0x90000000
+ $ loadm 0x90000000 $kernel_addr_r 0xf00000
+ $ bootefi $kernel_addr_r $fdtcontroladdr
+
+
+***********************
+Capsule update status
+***********************
+
+Positive scenario
+=================
In the positive case scenario, the user should see following log in TF-M log,
indicating the new capsule image is successfully applied, and the board boots
@@ -532,6 +727,36 @@ correctly.
...
+It's possible to check the content of the ESRT table after the system fully boots.
+
+In the Linux command-line run the following:
+
+::
+
+ # cd /sys/firmware/efi/esrt/entries/entry0
+ # cat *
+
+ 0x0
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f
+ 0
+ 6
+ 0
+ 6
+ 0
+
+.. line-block::
+ capsule_flags: 0x0
+ fw_class: e2bb9c06-70e9-4b14-97a3-5a7913176e3f
+ fw_type: 0
+ fw_version: 6
+ last_attempt_status: 0
+ last_attempt_version: 6
+ lowest_supported_fw_ver: 0
+
+
+Negative scenario
+=================
+
In the negative case scenario, the user should see appropriate logs in
the secure enclave terminal. If capsule pass initial verification, but fails
verifications performed during boot time, secure enclave will try new images
@@ -545,16 +770,45 @@ the previous good bank.
fwu_select_previous: in regular state by choosing previous active bank
...
-*******************************************************
-Linux distro install and boot (applicable to FPGA only)
-*******************************************************
+It's possible to check the content of the ESRT table after the system fully boots.
+
+In the Linux command-line run the following:
+
+::
+
+ # cd /sys/firmware/efi/esrt/entries/entry0
+ # cat *
+
+ 0x0
+ e2bb9c06-70e9-4b14-97a3-5a7913176e3f
+ 0
+ 6
+ 1
+ 5
+ 0
+
+.. line-block::
+ capsule_flags: 0x0
+ fw_class: e2bb9c06-70e9-4b14-97a3-5a7913176e3f
+ fw_type: 0
+ fw_version: 6
+ last_attempt_status: 1
+ last_attempt_version: 5
+ lowest_supported_fw_ver: 0
+
+Linux distros tests
+----------------------------------
+
+***************************************************************************************
+Debian/OpenSUSE install and boot (applicable to FPGA only)
+***************************************************************************************
To test Linux distro install and boot, the user should prepare two empty USB sticks.
Download one of following Linux distro images:
- Debian installer image: https://cdimage.debian.org/cdimage/weekly-builds/arm64/iso-dvd/
- OpenSUSE Tumbleweed installer image: http://download.opensuse.org/ports/aarch64/tumbleweed/iso/
- - The user should look for a DVD Snapshot like openSUSE-Tumbleweed-DVD-aarch64-Snapshot20211125-Media.iso
+ - The user should look for a DVD Snapshot like openSUSE-Tumbleweed-DVD-aarch64-Snapshot<date>-Media.iso
Once the .iso file is downloaded, the .iso file needs to be flashed to your USB drive.
@@ -578,7 +832,7 @@ Press <Ctrl+x>.
Now plug in the second USB stick, the distro installation process will start.
-**NOTE:** Due to the performance limitation of Corstone1000 MPS3 FPGA, the
+**NOTE:** Due to the performance limitation of Corstone-1000 MPS3 FPGA, the
distro installation process can take up to 24 hours to complete.
Once installation is complete, unplug the first USB stick and reboot the board.
@@ -591,46 +845,98 @@ a login prompt:
Login with the username root.
-Run psa-arch-test (applicable to both FPGA and FVP)
----------------------------------------------------
+**NOTE:** The Debian installer has a known issue "Install the GRUB bootloader - unable to install " and these are the steps to
+follow on the subsequent popups to solve the issue during the installation:
-When running psa-arch-test on MPS3 FPGA, the user should make sure there is no
-USB stick connected to the board. Power on the board and boot the board to
-Linux. Then, the user should follow the steps below to run the psa_arch_tests.
+1. Select "Continue", then "Continue" again on the next popup
+2. Scroll down and select "Execute a shell"
+3. Select "Continue"
+4. Enter the following command:
-When running psa-arch-test on Corstone1000 FVP, the user should follow the
-instructions in `Running the software on FVP`_ section to boot Linux in FVP
-host_terminal_0, and login using the username ``root``.
+::
-As a reference for the user's test results, the psa-arch-test report for `Corstone1000 software (CORSTONE1000-2022.02.18) <https://git.yoctoproject.org/meta-arm/tag/?h=CORSTONE1000-2022.02.18>`__
-can be found in `here <https://gitlab.arm.com/arm-reference-solutions/arm-reference-solutions-test-report/-/tree/master/embedded-a/corstone1000>`__.
+ in-target grub-install --no-nvram --force-extra-removable
-First, create a file containing SE_PROXY_SP UUID. Run:
+5. Enter the following command:
::
- echo 46bb39d1-b4d9-45b5-88ff-040027dab249 > sp_uuid_list.txt
+ in-target update-grub
-Then, load FFA driver module into Linux kernel. Run:
+6. Enter the following command:
::
- load_ffa_debugfs.sh .
+ exit
+
+7. Select "Continue without boot loader", then select "Continue" on the next popup
+8. At this stage, the installation should proceed as normal.
-Then, check whether the FFA driver loaded correctly by using the following command:
+***************************************************************************************
+OpenSUSE Raw image install and boot (applicable to FVP only)
+***************************************************************************************
+
+Steps to download openSUSE Tumbleweed raw image:
+ - Go to: http://download.opensuse.org/ports/aarch64/tumbleweed/appliances/
+ - The user should look for a Tumbleweed-ARM-JeOS-efi.aarch64-* Snapshot, for example, ``openSUSE-Tumbleweed-ARM-JeOS-efi.aarch64-<date>-Snapshot<date>.raw.xz``
+
+Once the .raw.xz file is downloaded, the raw image file needs to be extracted:
::
- cat /proc/modules | grep arm_ffa_user
+ unxz <file-name.raw.xz>
+
+
+The above command will generate a file ending with extension .raw image. Now, use the following command
+to run FVP with raw image installation process.
+
+::
+
+<_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf -- -C board.msd_mmc.p_mmc_file="${openSUSE raw image file path}"
+
+After successfully installing and booting the Linux distro, the user should see
+a openSUSE login prompt.
+
+::
+
+ localhost login:
+
+Login with the username 'root' and password 'linux'.
+
+PSA API tests
+----------------------
+
+***************************************************************************************
+Run PSA API test commands (applicable to both FPGA and FVP)
+***************************************************************************************
+
+When running PSA API test commands (aka PSA Arch Tests) on MPS3 FPGA, the user should make sure there is no
+USB stick connected to the board. Power on the board and boot the board to
+Linux. Then, the user should follow the steps below to run the tests.
+
+When running the tests on the Corstone-1000 FVP, the user should follow the
+instructions in `Running the software on FVP`_ section to boot Linux in FVP
+host_terminal_0, and login using the username ``root``.
+
+First, load FF-A TEE kernel module:
+
+::
+
+ insmod /lib/modules/5.19.9-yocto-standard/extra/arm-ffa-tee.ko
+
+Then, check whether the FF-A TEE driver is loaded correctly by using the following command:
+
+::
+
+ cat /proc/modules | grep arm_ffa_tee
The output should be:
::
- arm_ffa_user 16384 - - Live 0xffffffc0084b0000 (O)
+ arm_ffa_tee 16384 - - Live 0xffffffc0004f0000 (O)
-Now, run the PSA arch tests with following commands. The user should run the
-tests in following order:
+Now, run the PSA API tests in the following order:
::
@@ -639,47 +945,108 @@ tests in following order:
psa-its-api-test
psa-ps-api-test
-********************************************************
-Linux distro: OpenSUSE Raw image installation (FVP Only)
-********************************************************
+External System tests
+-----------------------------------
-Steps to download openSUSE Tumbleweed raw image:
- - Go to: http://download.opensuse.org/ports/aarch64/tumbleweed/appliances/
- - The user should look for a Tumbleweed-ARM-JeOS-efi.aarch64-* Snapshot, for example, ``openSUSE-Tumbleweed-ARM-JeOS-efi.aarch64-2022.03.18-Snapshot20220331.raw.xz``
+***************************************************************************************
+Running the External System test command (systems-comms-tests)
+***************************************************************************************
-Once the .raw.xz file is downloaded, the raw image file needs to be extracted:
+Test 1: Releasing the External System out of reset
+===================================================
+
+Run this command in the Linux command-line:
::
- unxz <file-name.raw.xz>
+ systems-comms-tests 1
+The output on the External System terminal should be:
-The above command will generate a file ending with extension .raw image. Now, use the following command
-to run FVP with raw image installation process.
+::
+
+ ___ ___
+ | / __|
+ |=== \___
+ |___ |___/
+ External System Cortex-M3 Processor
+ Running RTX RTOS
+ v0.1.0_2022-10-19_16-41-32-8c9dca7
+ MHUv2 module 'MHU0_H' started
+ MHUv2 module 'MHU1_H' started
+ MHUv2 module 'MHU0_SE' started
+ MHUv2 module 'MHU1_SE' started
+
+Test 2: Communication
+=============================================
+
+Test 2 releases the External System out of reset if not already done. Then, it performs communication between host and External System.
+
+After running Test 1, run this command in the Linux command-line:
::
-<_workspace>/meta-arm/scripts/runfvp --terminals=xterm <_workspace>/build/tmp/deploy/images/corstone1000-fvp/corstone1000-image-corstone1000-fvp.fvpconf -- -C board.msd_mmc.p_mmc_file="${openSUSE raw image file path}"
+ systems-comms-tests 2
-After successfully installing and booting the Linux distro, the user should see
-a openSUSE login prompt.
+Additional output on the External System terminal will be printed:
::
- localhost login:
+ MHUv2: Message from 'MHU0_H': 0xabcdef1
+ Received 'abcdef1' From Host MHU0
+ CMD: Increment and return to sender...
+ MHUv2: Message from 'MHU1_H': 0xabcdef1
+ Received 'abcdef1' From Host MHU1
+ CMD: Increment and return to sender...
-Login with the username 'root' and password 'linux'.
+When running Test 2 the first, Test 1 will be run in the background.
+
+The output on the External System terminal should be:
+
+::
+
+ ___ ___
+ | / __|
+ |=== \___
+ |___ |___/
+ External System Cortex-M3 Processor
+ Running RTX RTOS
+ v0.1.0_2022-10-19_16-41-32-8c9dca7
+ MHUv2 module 'MHU0_H' started
+ MHUv2 module 'MHU1_H' started
+ MHUv2 module 'MHU0_SE' started
+ MHUv2 module 'MHU1_SE' started
+ MHUv2: Message from 'MHU0_H': 0xabcdef1
+ Received 'abcdef1' From Host MHU0
+ CMD: Increment and return to sender...
+ MHUv2: Message from 'MHU1_H': 0xabcdef1
+ Received 'abcdef1' From Host MHU1
+ CMD: Increment and return to sender...
+
+The output on the Host terminal should be:
+
+::
+
+ Received abcdf00 from es0mhu0
+ Received abcdf00 from es0mhu1
+
+
+Tests results
+-----------------------------------
+
+As a reference for the end user, reports for various tests for `Corstone-1000 software (CORSTONE1000-2022.11.10) <https://git.yoctoproject.org/meta-arm/tag/?h=CORSTONE1000-2022.11.10>`__
+can be found in `here <https://gitlab.arm.com/arm-reference-solutions/arm-reference-solutions-test-report/-/tree/master/embedded-a/corstone1000>`__.
-**************************************
Running the software on FVP on Windows
-**************************************
-If the user needs to run the Corstone1000 software on FVP on Windows. The user
+---------------------------------------------------------------
+
+If the user needs to run the Corstone-1000 software on FVP on Windows. The user
should follow the build instructions in this document to build on Linux host
PC, and copy the output binaries to the Windows PC where the FVP is located,
and launch the FVP binary.
--------------
-*Copyright (c) 2021, Arm Limited. All rights reserved.*
+*Copyright (c) 2022, Arm Limited. All rights reserved.*
.. _Arm Ecosystem FVPs: https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps