summaryrefslogtreecommitdiff
path: root/meta-arm/meta-arm-bsp/documentation
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2022-11-03 21:47:49 +0300
committerPatrick Williams <patrick@stwcx.xyz>2022-11-03 22:43:10 +0300
commit2390b1b6299fb1e57e6d9a94c287ce1c0b322376 (patch)
tree09462bb0a9634a75c5044f4a4db872fa857780da /meta-arm/meta-arm-bsp/documentation
parent5641269ed7838c5ea402b23c5e0ac0af5d6a866b (diff)
downloadopenbmc-2390b1b6299fb1e57e6d9a94c287ce1c0b322376.tar.xz
subtree updates2.14.0-dev
meta-arm: 14c7e5b336..3b7347cd67: Jon Mason (6): CI: Remove host bitbake variables arm: add Mickledore to layer compat string CI: Add packages for opencsd and gator-daemon to base build CI: add common fvp yml file arm/opencsd: update to version 1.3.1 arm/gator-daemon: update to v7.8.0 Jose Quaresma (2): optee-ftpm/optee-os: add missing space in EXTRA_OEMAKE optee-os-ts: avoid using escape chars in EXTRA_OEMAKE Mohamed Omar Asaker (4): Revert "arm-bsp/trusted-firmware-m: corstone1000: secure debug code checkout from yocto" Revert "arm-bsp/trusted-firmware-m: corstone1000: bump tfm SHA" arm-bsp/trusted-firmware-m: corstone1000 support FMP image info arm-bsp/corstone1000: add msd configs for fvp Ross Burton (5): arm/hafnium: add missing Upstream-Status arm-bsp/hafnium: add missing Upstream-Status arm-bsp/linux-arm64-ack: fix malformed Upstream-Status tag CI: add documentation job CI: track meta-openembedded's langdale branch Rui Miguel Silva (2): arm/trusted-services: port crypto config arm-bsp/corstone1000: apply ts patch to psa crypto api test Satish Kumar (1): arm-bsp/trusted-service: corstone1000: esrt support Vishnu Banavath (4): runfvp: corstone1000: add mmc card configuration meta-arm-bsp/doc: add readthedocs for corstone1000 arm-bsp/optee: register DRAM1 for N1SDP target arm-bsp:optee: enable optee test for N1SDP target meta-raspberrypi: 722c51647c..a305f4804b: Sung Gon Kim (1): libcamera: rename bbappend to match any version meta-openembedded: 8073ec2275..6ebff843cc: Akash Hadke (1): audit: Fix compile error for audit_2.8.5 Alex Kiernan (1): lldpd: Upgrade 1.0.14 -> 1.0.15 Alexander Kanavin (3): sip3: remove the recipe python3-wxgtk4: skip the recipe python3-yappi: mark as incompatible with python 3.11 Bhupesh Sharma (1): android-tools-conf-configfs: Allow handling two or more UDC controllers Eero Aaltonen (1): valijson: use install task from CMakeLists.txt Etienne Cordonnier (1): uutils-coreutils: upgrade 0.0.15 -> 0.0.16 Gianfranco Costamagna (2): vboxguestdrivers: upgrade 6.1.38 -> 7.0.0 vbxguestdrivers: upgrade 7.0.0 -> 7.0.2 Joshua Watt (3): nginx: Add ipv6 support iniparser: Add native support libzip: Add native support Khem Raj (3): postfix: Upgrade to 3.7.3 msktutil: Add recipe protobuf: Enable protoc binary in nativesdk Leon Anavi (7): python3-cheetah: Upgrade 3.2.6 -> 3.2.6.post1 python3-dill: Upgrade 0.3.5.1 -> 0.3.6 python3-pythonping: Upgrade 1.1.3 -> 1.1.4 python3-colorama: Upgrade 0.4.5 -> 0.4.6 python3-pint: Upgrade 0.19.2 -> 0.20 python3-traitlets: Upgrade 5.4.0 -> 5.5.0 python3-py-cpuinfo: Upgrade 8.0.0 -> 9.0.0 Markus Volk (4): perfetto: build libperfetto libcamera: upgrade -> 0.0.1 gtk-vnc: add recipe spice-gtk: add recipe Meier Boas (1): jwt-cpp: add recipe Ovidiu Panait (1): syzkaller: add recipe and selftest for syzkaller fuzzing Peter Marko (2): cpputest: remove dev package dependency cpputest: add possibility to build extensions Robert Joslyn (1): fwupd: Fix plugin_gpio PACKAGECONFIG Sebastian Trahm (1): Add recipe for python3-pytest-json-report Tim Orling (5): libmime-types-perl: upgrade 2.17 -> 2.22 libcompress-raw*-perl: move from libio/compress-* libio-compress*-perl: cleanup; fixes libcompress-raw-*-perl: cleanup; fixes packagegroup-meta-perl: mv libcompress-raw-*-perl Vincent Davis Jr (2): libglvnd: add new recipe libglvnd v1.5.0 xf86-video-amdgpu: add new recipe xf86-video-amdgpu Wang Mingyu (36): bats: upgrade 1.8.0 -> 1.8.2 ctags: upgrade 5.9.20221009.0 -> 5.9.20221016.0 fvwm: upgrade 2.6.9 -> 2.7.0 makedumpfile: upgrade 1.7.1 -> 1.7.2 sanlock: upgrade 3.8.4 -> 3.8.5 python3-astroid: upgrade 2.12.11 -> 2.12.12 python3-charset-normalizer: upgrade 2.1.1 -> 3.0.0 python3-google-api-python-client: upgrade 2.64.0 -> 2.65.0 python3-google-auth: upgrade 2.12.0 -> 2.13.0 python3-grpcio-tools: upgrade 1.49.1 -> 1.50.0 python3-grpcio: upgrade 1.49.1 -> 1.50.0 python3-huey: upgrade 2.4.3 -> 2.4.4 python3-incremental: upgrade 21.3.0 -> 22.10.0 python3-luma-core: upgrade 2.3.1 -> 2.4.0 python3-oauthlib: upgrade 3.2.1 -> 3.2.2 python3-pandas: upgrade 1.5.0 -> 1.5.1 python3-pastedeploy: upgrade 2.1.1 -> 3.0.1 python3-pika: upgrade 1.3.0 -> 1.3.1 python3-portalocker: upgrade 2.5.1 -> 2.6.0 python3-protobuf: upgrade 4.21.7 -> 4.21.8 python3-pyjwt: upgrade 2.5.0 -> 2.6.0 python3-pymongo: upgrade 4.2.0 -> 4.3.2 python3-pywbemtools: upgrade 1.0.0 -> 1.0.1 python3-robotframework: upgrade 5.0.1 -> 6.0 python3-socketio: upgrade 5.7.1 -> 5.7.2 python3-sqlalchemy: upgrade 1.4.41 -> 1.4.42 tracker-miners: upgrade 3.2.1 -> 3.4.1 tracker: upgrade 3.4.0 -> 3.4.1 wolfssl: upgrade 5.5.1 -> 5.5.2 cglm: upgrade 0.8.5 -> 0.8.7 ctags: upgrade 5.9.20221016.0 -> 5.9.20221023.0 flatbuffers: upgrade 22.9.29 -> 22.10.26 function2: upgrade 4.2.1 -> 4.2.2 poco: upgrade 1.12.2 -> 1.12.3 thingsboard-gateway: upgrade 3.1 -> 3.2 grpc: upgrade 1.50.0 -> 1.50.1 Xiangyu Chen (1): ipmitool: fix typo in .bb file's comments, using = instead of =? Zheng Qiu (1): jq: improve ptest and disable valgrind by default zhengruoqin (5): tcpslice: upgrade 1.5 -> 1.6 tio: upgrade 2.1 -> 2.2 python3-stevedore: upgrade 4.0.1 -> 4.1.0 python3-xxhash: upgrade 3.0.0 -> 3.1.0 python3-zeroconf: upgrade 0.39.1 -> 0.39.2 meta-security: e8e7318189..2aa48e6f4e: Armin Kuster (1): kas-security-base.yml: make work again Gowtham Suresh Kumar (1): Update PARSEC recipe to latest v1.1.0 release Michael Haener (1): tpm2-openssl: update to 1.1.1 poky: 95c802b0be..482c493cf6: Adrian Freihofer (3): own-mirrors: add crate buildconf: compare abspath ref-manual: add wic command bootloader ptable option Ahmad Fatoum (2): kernel-fitimage: mangle slashes to underscores as late as possible kernel-fitimage: skip FDT section creation for applicable symlinks Alex Kiernan (4): u-boot: Remove duplicate inherit of cml1 u-boot: Add savedefconfig task rust: update 1.63.0 -> 1.64.0 cargo_common.bbclass: Fix typos Alexander Kanavin (40): rust-target-config: match riscv target names with what rust expects rust: install rustfmt for riscv32 as well unfs3: correct upstream version check gnu-config: update to latest revision llvm: update 14.0.6 -> 15.0.1 grep: update 3.7 -> 3.8 hdparm: update 9.64 -> 9.65 stress-ng: update 0.14.03 -> 0.14.06 vulkan: update 1.3.216.0 -> 1.3.224.1 wayland-utils: update 1.0.0 -> 1.1.0 libxft: update 2.3.4 -> 2.3.6 pinentry: update 1.2.0 -> 1.2.1 ovmf: upgrade edk2-stable202205 -> edk2-stable202208 cmake: update 3.24.0 -> 3.24.2 jquery: upgrade 3.6.0 -> 3.6.1 python3-dbus: upgrade 1.2.18 -> 1.3.2 python3-hatch-fancy-pypi-readme: add a recipe python3-jsonschema: upgrade 4.9.1 -> 4.16.0 shadow: update 4.12.1 -> 4.12.3 lttng-modules: upgrade 2.13.4 -> 2.13.5 libsoup: upgrade 3.0.7 -> 3.2.0 libxslt: upgrade 1.1.35 -> 1.1.37 quilt: backport a patch to address grep 3.8 failures python3: update 3.10.6 -> 3.11.0 cargo-update-recipe-crates.bbclass: add a class to generate SRC_URI crate lists from Cargo.lock python3-bcrypt: convert to use cargo-update-recipe-crates class. python3-cryptography: convert to cargo-update-recipe-crates class groff: submit patches upstream tcl: correct patch status tcl: correct upstream version check lttng-tools: submit determinism.patch upstream cmake: drop qt4 patches kea: submit patch upstream argp-standalone: replace with a maintained fork ovmf: correct patches status go: submit patch upstream libffi: submit patch upstream go: update 1.19 -> 1.19.2 rust-common.bbclass: use built-in rust targets for -native builds rust: submit a rewritten version of crossbeam_atomic.patch upstream Andrew Geissler (1): go: add support to build on ppc64le Bartosz Golaszewski (1): bluez5: add dbus to RDEPENDS Bernhard Rosenkränzer (1): cmake-native: Fix host tool contamination Bruce Ashfield (3): kern-tools: fix relative path processing linux-yocto/5.19: update to v5.19.14 linux-yocto/5.15: update to v5.15.72 Changhyeok Bae (2): ethtool: upgrade 5.19 -> 6.0 iproute2: upgrade 5.19.0 -> 6.0.0 Chen Qi (1): openssl: export necessary env vars in SDK Christian Eggers (1): linux-firmware: split rtl8761 firmware Claus Stovgaard (1): gstreamer1.0-libav: fix errors with ffmpeg 5.x Ed Tanous (1): openssl: Upgrade 3.0.5 -> 3.0.7 Etienne Cordonnier (1): mirrors.bbclass: use shallow tarball for binutils-native Fabio Estevam (1): go-mod.bbclass: Remove repeated word Frank de Brabander (1): cve-update-db-native: add timeout to urlopen() calls Hitendra Prajapati (1): openssl: CVE-2022-3358 Using a Custom Cipher with NID_undef may lead to NULL encryption Jan-Simon Moeller (1): buildtools-tarball: export certificates to python and curl Jeremy Puhlman (1): qemu-native: Add PACKAGECONFIG option for jack Johan Korsnes (1): bitbake: bitbake: user-manual: inform about spaces in :remove Jon Mason (2): linux-yocto: add efi entry for machine features linux-yocto-dev: add qemuarmv5 Jose Quaresma (3): kernel-yocto: improve fatal error messages of symbol_why.py oeqa/selftest/archiver: Add multiconfig test for shared recipes archiver: avoid using machine variable as it breaks multiconfig Joshua Watt (3): runqemu: Fix gl-es argument from causing other arguments to be ignored qemu-helper-native: Re-write bridge helper as C program runqemu: Do not perturb script environment Justin Bronder (1): bitbake: asyncrpc: serv: correct closed client socket detection Kai Kang (1): mesa: only apply patch to fix ALWAYS_INLINE for native Keiya Nobuta (2): gnutls: Unified package names to lower-case create-spdx: Remove ";name=..." for downloadLocation Khem Raj (3): perf: Depend on native setuptools3 musl: Upgrade to latest master mesa: Add native patch via a variable Lee Chee Yang (2): migration-guides/release-notes-4.1.rst: update Repositories / Downloads migration-guides/release-notes-4.1.rst: update Repositories / Downloads Leon Anavi (1): python3-manifest.json: Move urllib to netclient Liam Beguin (1): meson: make wrapper options sub-command specific Luca Boccassi (1): systemd: add systemd-creds and systemd-cryptenroll to systemd-extra-utils Marek Vasut (1): bluez5: Point hciattach bcm43xx firmware search path to /lib/firmware Mark Asselstine (2): bitbake: tests: bb.tests.fetch.URLHandle: add 2 new tests bitbake: bitbake: bitbake-layers: checkout layer(s) branch when clone exists Mark Hatle (2): insane.bbclass: Allow hashlib version that only accepts on parameter bitbake: utils/ply: Update md5 to better report errors with hashlib Markus Volk (2): wayland-protocols: upgrade 1.26 -> 1.27 mesa: update 22.2.0 -> 22.2.2 Martin Jansa (3): vulkan-samples: add lfs=0 to SRC_URI to avoid git smudge errors in do_unpack externalsrc.bbclass: fix git repo detection cargo-update-recipe-crates: small improvements Maxim Uvarov (2): wic: add UEFI kernel as UEFI stub wic: bootimg-efi: implement --include-path Michael Opdenacker (11): manuals: updates for building on Windows (WSL 2) ref-manual: classes.rst: add links to all references to a class poky.conf: remove Ubuntu 21.10 bitbake: doc: bitbake-user-manual: expand description of BB_PRESSURE_MAX variables bitbake: bitbake-user-manual: details about variable flags starting with underscore Documentation/README: formalize guidelines for external link syntax manuals: replace "_" by "__" in external links manuals: stop referring to the meta-openembedded repo from GitHub manuals: add missing references to SDKMACHINE and SDK_ARCH manuals: use references to the "Build Directory" term create-spdx.bbclass: remove unused SPDX_INCLUDE_PACKAGED Mikko Rapeli (6): os-release: replace DISTRO_CODENAME with VERSION_CODENAME os-release: add HOMEPAGE and link to documentation ref-manual: variables.rst: add documentation for CVE_VERSION ref-manual: classes.rst: improve documentation for cve-check.bbclass dev-manual: common-tasks.rst: add regular updates and CVE scans to security best practices dev-manual: common-tasks.rst: refactor and improve "Checking for Vulnerabilities" section Ming Liu (1): dropbear: add pam to PACKAGECONFIG Mingli Yu (1): grub: disable build on armv7ve/a with hardfp Oliver Lang (2): bitbake: cooker: fix a typo bitbake: runqueue: fix a typo Pablo Saavedra Rodi?o (1): weston: update 10.0.2 -> 11.0.0 Paul Eggleton (2): install-buildtools: support buildtools-make-tarball and update to 4.1 ref-manual: add info on buildtools-make-tarball Peter Bergin (1): gptfdisk: remove warning message from target system Peter Kjellerstedt (3): gcc: Allow -Wno-error=poison-system-directories to take effect base-passwd: Update to 3.6.1 externalsrc.bbclass: Remove a trailing slash from ${B} Qiu, Zheng (2): tiff: fix a typo for CVE-2022-2953.patch valgrind: update to 3.20.0 Quentin Schulz (1): docs: add support for langdale (4.1) release Richard Purdie (4): openssl: Fix SSL_CERT_FILE to match ca-certs location bitbake: tests/fetch: Allow handling of a file:// url within a submodule patchelf: upgrade 0.15.0 -> 0.16.1 lttng-modules: upgrade 2.13.5 -> 2.13.7 Robert Joslyn (1): curl: Update 7.85.0 to 7.86.0 Ross Burton (26): populate_sdk_base: ensure ptest-pkgs pulls in ptest-runner scripts/oe-check-sstate: cleanup scripts/oe-check-sstate: force build to run for all targets, specifically populate_sysroot externalsrc: move back to classes opkg-utils: use a git clone, not a dynamic snapshot oe/packagemanager/rpm: don't leak file objects zlib: use .gz archive and set a PREMIRROR glib-2.0: fix rare GFileInfo test case failure lighttpd: fix CVE-2022-41556 acpid: upgrade 2.0.33 -> 2.0.34 python3-hatchling: upgrade 1.9.0 -> 1.10.0 pango: upgrade 1.50.9 -> 1.50.10 piglit: upgrade to latest revision lsof: upgrade 4.95.0 -> 4.96.3 zlib: do out-of-tree builds zlib: upgrade 1.2.12 -> 1.2.13 libx11: apply the fix for CVE-2022-3554 xserver-xorg: ignore CVE-2022-3553 as it is XQuartz-specific xserver-xorg: backport fixes for CVE-2022-3550 and CVE-2022-3551 tiff: fix a number of CVEs qemu: backport the fix for CVE-2022-3165 bitbake: fetch2/git: don't set core.fsyncobjectfiles=0 sanity: check for GNU tar specifically expat: upgrade to 2.5.0 oeqa/target/ssh: add ignore_status argument to run() oeqa/runtime/dnf: rewrite test_dnf_installroot_usrmerge Sakib Sajal (1): go: update 1.19.2 -> 1.19.3 Sean Anderson (6): uboot-sign: Fix using wrong KEY_REQ_ARGS kernel: Clear SYSROOT_DIRS instead of replacing sysroot_stage_all kernel-fitimage: Use KERNEL_OUTPUT_DIR where appropriate uboot-sign: Use bitbake variables directly uboot-sign: Split off kernel-fitimage variables u-boot: Rework signing to remove interdependencies Sergei Zhmylev (2): wic: implement binary repeatable disk identifiers wic: honor the SOURCE_DATE_EPOCH in case of updated fstab Teoh Jay Shen (1): vim: Upgrade 9.0.0598 -> 9.0.0614 Thomas Perrot (2): psplash: add psplash-default in rdepends xserver-xorg: move some recommended dependencies in required Tim Orling (23): python3-cryptography: upgrade 37.0.4 -> 38.0.1 python3-cryptography-vectors: upgrade 37.0.4 -> 38.0.1 python3-certifi: upgrade 2022.9.14 -> 2022.9.24 python3-hypothesis: upgrade 6.54.5 -> 6.56.1 python3-pyopenssl: upgrade 22.0.0 -> 22.1.0 python3-bcrypt: upgrade 3.2.2 -> 4.0.0 python3-sphinx: upgrade 5.1.1 -> 5.2.3 python3-setuptools-rust: upgrade 1.5.1 -> 1.5.2 python3-iso8601: upgrade 1.0.2 -> 1.1.0 python3-poetry-core: upgrade 1.0.8 -> 1.3.2 git: upgrade 2.37.3 -> 2.38.1 vim: upgrade 9.0.0614 -> 9.0.0820 python3-mako: upgrade 1.2.2 -> 1.2.3 python3-bcrypt: upgrade 4.0.0 -> 4.0.1 python3-cryptography{-vectors}: 38.0.1 -> 38.0.3 python3-psutil: upgrade 5.9.2 -> 5.9.3 python3-pytest: upgrade 7.1.3 -> 7.2.0 python3-pytest-subtests: upgrade 0.8.0 -> 0.9.0 python3-hypothesis: upgrade 6.56.1 -> 6.56.4 python3-more-itertools: upgrade 8.14.0 -> 9.0.0 python3-pytz: upgrade 2022.4 -> 2022.6 python3-zipp: upgrade 3.9.0 -> 3.10.0 python3-sphinx: upgrade 5.2.3 -> 5.3.0 Vincent Davis Jr (1): linux-firmware: package amdgpu firmware Vyacheslav Yurkov (1): overlayfs: Allow not used mount points Xiangyu Chen (1): linux-yocto-dev: add qemuarm64 Yan Xinkuan (1): bc: Add ptest. ciarancourtney (1): wic: swap partitions are not added to fstab wangmy (32): init-system-helpers: upgrade 1.64 -> 1.65.2 meson: upgrade 0.63.2 -> 0.63.3 mtools: upgrade 4.0.40 -> 4.0.41 dbus: upgrade 1.14.0 -> 1.14.4 ifupdown: upgrade 0.8.37 -> 0.8.39 openssh: upgrade 9.0p1 -> 9.1p1 python3-hatchling: upgrade 1.10.0 -> 1.11.0 u-boot: upgrade 2022.07 -> 2022.10 python3-git: upgrade 3.1.27 -> 3.1.28 python3-importlib-metadata: upgrade 4.12.0 -> 5.0.0 gnutls: upgrade 3.7.7 -> 3.7.8 gsettings-desktop-schemas: upgrade 42.0 -> 43.0 harfbuzz: upgrade 5.1.0 -> 5.3.0 libcap: upgrade 2.65 -> 2.66 libical: upgrade 3.0.14 -> 3.0.15 libva: upgrade 2.15.0 -> 2.16.0 libva-utils: upgrade 2.15.0 -> 2.16.0 powertop: upgrade 2.14 -> 2.15 numactl: upgrade 2.0.15 -> 2.0.16 python3-pytz: upgrade 2022.2.1 -> 2022.4 python3-zipp: upgrade 3.8.1 -> 3.9.0 repo: upgrade 2.29.2 -> 2.29.3 sqlite3: upgrade 3.39.3 -> 3.39.4 wpebackend-fdo: upgrade 1.12.1 -> 1.14.0 xkeyboard-config: upgrade 2.36 -> 2.37 xz: upgrade 5.2.6 -> 5.2.7 libksba: upgrade 1.6.0 -> 1.6.2 libsdl2: upgrade 2.24.0 -> 2.24.1 libwpe: upgrade 1.12.3 -> 1.14.0 lttng-ust: upgrade 2.13.4 -> 2.13.5 btrfs-tools: upgrade 5.19.1 -> 6.0 lighttpd: upgrade 1.4.66 -> 1.4.67 Signed-off-by: Patrick Williams <patrick@stwcx.xyz> Change-Id: I3322dd0057da9f05bb2ba216fdcda3f569c0493b
Diffstat (limited to 'meta-arm/meta-arm-bsp/documentation')
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst98
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/conf.py52
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/CorstoneSubsystems.pngbin0 -> 111103 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/ExternalFlash.pngbin0 -> 35431 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureBootChain.pngbin0 -> 150409 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureFirmwareUpdate.pngbin0 -> 61393 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureServices.pngbin0 -> 73965 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/images/UEFISupport.pngbin0 -> 98811 bytes
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/index.rst16
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst137
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/software-architecture.rst239
-rw-r--r--meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst685
-rw-r--r--meta-arm/meta-arm-bsp/documentation/requirements.txt12
13 files changed, 1239 insertions, 0 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
new file mode 100644
index 0000000000..5d6493a490
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/change-log.rst
@@ -0,0 +1,98 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+##########
+Change Log
+##########
+
+This document contains a summary of the new features, changes and
+fixes in each release of corstone1000 software stack.
+
+******************
+Version 2022.04.04
+******************
+
+Changes
+=======
+- Linux distro openSUSE, raw image installation and boot in the FVP.
+- SCT test support in FVP.
+- Manual capsule update support in FVP.
+
+******************
+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
+
+******************
+Version 2022.02.21
+******************
+
+Changes
+=======
+- psa-arch-tests: recipe is dropped and merged into the secure-partitons recipe.
+- psa-arch-tests: The tests are align with latest tfm version for psa-crypto-api suite.
+
+******************
+Version 2022.01.18
+******************
+
+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
+
+******************
+Version 2022.01.07
+******************
+
+Changes
+=======
+- corstone1000: 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: add ethernet device and enable configs to support bootfromnetwork SCT.
+
+******************
+Version 2021.12.15
+******************
+
+Changes
+=======
+- Enabling corstone1000 FPGA support on:
+ - Linux 5.10
+ - OP-TEE 3.14
+ - Trusted Firmware-A 2.5
+ - Trusted Firmware-M 1.5
+- Building and running psa-arch-tests
+- Adding openamp support in SE proxy SP
+- OP-TEE: adding smm-gateway partition
+- U-Boot: introducing Arm FF-A and MM support
+
+******************
+Version 2021.10.29
+******************
+
+Changes
+=======
+- Enabling corstone1000 FVP support on:
+ - Linux 5.10
+ - OP-TEE 3.14
+ - Trusted Firmware-A 2.5
+ - Trusted Firmware-M 1.4
+- Linux kernel: enabling EFI, adding FF-A debugfs driver, integrating ARM_FFA_TRANSPORT.
+- U-Boot: Extending EFI support
+- python3-imgtool: adding recipe for Trusted-firmware-m
+- python3-imgtool: adding the Yocto recipe used in signing host images (based on MCUBOOT format)
+
+--------------
+
+*Copyright (c) 2021, Arm Limited. All rights reserved.*
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/conf.py b/meta-arm/meta-arm-bsp/documentation/corstone1000/conf.py
new file mode 100644
index 0000000000..e9cab63359
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/conf.py
@@ -0,0 +1,52 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'corstone1000'
+copyright = '2020-2022, Arm Limited'
+author = 'Arm Limited'
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'docs/infra']
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+#html_static_path = ['_static']
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/CorstoneSubsystems.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/CorstoneSubsystems.png
new file mode 100644
index 0000000000..a41e721027
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/CorstoneSubsystems.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/ExternalFlash.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/ExternalFlash.png
new file mode 100644
index 0000000000..38407c08d9
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/ExternalFlash.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureBootChain.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureBootChain.png
new file mode 100644
index 0000000000..bc5b4ba35e
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureBootChain.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureFirmwareUpdate.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureFirmwareUpdate.png
new file mode 100644
index 0000000000..5fdae9db29
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureFirmwareUpdate.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureServices.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureServices.png
new file mode 100644
index 0000000000..b7631b0230
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/SecureServices.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/images/UEFISupport.png b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/UEFISupport.png
new file mode 100644
index 0000000000..f58531719d
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/images/UEFISupport.png
Binary files differ
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/index.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/index.rst
new file mode 100644
index 0000000000..8626c42c2b
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/index.rst
@@ -0,0 +1,16 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+################
+ARM Corstone1000
+################
+
+.. toctree::
+ :maxdepth: 1
+
+ software-architecture
+ user-guide
+ release-notes
+ change-log
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst
new file mode 100644
index 0000000000..385331bd23
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/release-notes.rst
@@ -0,0 +1,137 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+#############
+Release notes
+#############
+
+**************************
+Release notes - 2022.04.04
+**************************
+
+Known Issues or Limitations
+---------------------------
+ - FGPA 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).
+ - 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
+ https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
+
+**************************
+Release notes - 2022.02.25
+**************************
+
+Known Issues or Limitations
+---------------------------
+ - The following tests only work on corstone1000 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
+ https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
+
+Release notes - 2022.02.21
+--------------------------
+
+Known Issues or Limitations
+---------------------------
+ - The following tests only work on corstone1000 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
+ https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
+
+Release notes - 2022.01.18
+--------------------------
+
+Known Issues or Limitations
+---------------------------
+
+ - Before running each SystemReady-IR tests: ACS tests (SCT, FWTS, BSA), manual
+ capsule update test, Linux distro install and boot, etc., the SecureEnclave
+ flash must be cleaned. See user-guide "Clean Secure Flash Before Testing"
+ section.
+
+Release notes - 2021.12.15
+--------------------------
+
+Software Features
+------------------
+The following components are present in the release:
+
+ - Yocto version Honister
+ - Linux kernel version 5.10
+ - U-Boot 2021.07
+ - OP-TEE version 3.14
+ - Trusted Firmware-A 2.5
+ - Trusted Firmware-M 1.5
+ - OpenAMP 347397decaa43372fc4d00f965640ebde042966d
+ - Trusted Services a365a04f937b9b76ebb2e0eeade226f208cbc0d2
+
+
+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
+ 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,
+ 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.
+ - Due to flash size limitation and to support A/B banks,the wic image provided
+ by the user should be smaller than 15MB.
+ - The failures in PSA Arch Crypto Test are known limitations with crypto
+ library. It requires further investigation. The user can refer to `PSA Arch Crypto Test Failure Analysis In TF-M V1.5 Release <https://developer.trustedfirmware.org/w/tf_m/release/psa_arch_crypto_test_failure_analysis_in_tf-m_v1.5_release/>`__
+ for the reason for each failing test.
+
+
+Release notes - 2021.10.29
+--------------------------
+
+Software Features
+-----------------
+This initial release of corstone1000 supports booting Linux on the Cortex-A35
+and TF-M/MCUBOOT in the Secure Enclave. The following components are present in
+the release:
+
+ - Linux kernel version 5.10
+ - U-Boot 2021.07
+ - OP-TEE version 3.14
+ - Trusted Firmware-A 2.5
+ - Trusted Firmware-M 1.4
+
+Platform Support
+----------------
+ - This Software release is tested on corstone1000 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
+---------------------------
+ - No software support for external system(Cortex M3)
+ - No communication established between A35 and M0+
+ - Very basic functionality of booting Secure Enclave, Trusted Firmware-A , OP-TEE , u-boot and Linux are performed
+
+Support
+-------
+For support email: support-subsystem-iot@arm.com
+
+--------------
+
+*Copyright (c) 2021, Arm Limited. All rights reserved.*
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/software-architecture.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/software-architecture.rst
new file mode 100644
index 0000000000..a17f1b8a68
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/software-architecture.rst
@@ -0,0 +1,239 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+######################
+Software architecture
+######################
+
+
+*****************
+ARM corstone1000
+*****************
+
+ARM corstone1000 is a reference solution for IoT devices. It is part of
+Total Solution for IoT which consists of hardware and software reference
+implementation.
+
+Corstone1000 software plus hardware reference solution is PSA Level-2 ready
+certified (`PSA L2 Ready`_) as well as System Ready IR certified(`SRIR cert`_).
+More information on the corstone1000 subsystem product and design can be
+found at:
+`Arm corstone1000 Software`_ and `Arm corstone1000 Technical Overview`_.
+
+This readme explicitly focuses on the software part of the solution and
+provides internal details on the software components. The reference
+software package of the platform can be retrieved following instructions
+present in the user-guide document.
+
+***************
+Design Overview
+***************
+
+The software architecture of corstone1000 platform is a reference
+implementation of Platform Security Architecture (`PSA`_) which provides
+framework to build secure IoT devices.
+
+The base system architecture of the platform is created from three
+different tyes of systems: Secure Enclave, Host and External System.
+Each subsystem provides different functionality to overall SoC.
+
+
+.. image:: images/CorstoneSubsystems.png
+ :width: 720
+ :alt: CorstoneSubsystems
+
+
+The Secure Enclave System, provides PSA Root of Trust (RoT) and
+cryptographic functions. It is based on an Cortex-M0+ processor,
+CC312 Cryptographic Accelerator and peripherals, such as watchdog and
+secure flash. Software running on the Secure Enclave is isolated via
+hardware for enhanced security. Communication with the Secure Encalve
+is achieved using Message Hnadling Units (MHUs) and shared memory.
+On system power on, the Secure Enclaves boots first. Its software
+comprises of two boot loading stages, both based on mcuboot, and
+TrustedFirmware-M(`TF-M`_) as runtime software. The software design on
+Secure Enclave follows Firmware Framework for M class
+processor (`FF-M`_) specification.
+
+The Host System is based on ARM Cotex-A35 processor with standardized
+peripherals to allow for the booting of a Linux OS. The Cortex-A35 has
+the TrustZone technology that allows secure and non-secure security
+states in the processor. The software design in the Host System follows
+Firmware Framework for A class procseeor (`FF-A`_) specification.
+The boot process follows Trusted Boot Base Requirement (`TBBR`_).
+The Host Subsystem is taken out of reset by the Secure Enclave system
+during its final stages of the initialization. The Host subsystem runs
+FF-A Secure Partitions(based on `Trusted Services`_) and OPTEE-OS
+(`OPTEE-OS`_) in the secure world, and u-boot(`u-boot repo`_) and
+linux (`linux repo`_) in the non-secure world. The communication between
+non-secure and the secure world is performed via FF-A messages.
+
+An external system is intended to implement use-case specific
+functionality. The system is based on Cortex-M3 and run RTX RTOS.
+Communictaion between external system and Host(cortex-A35) is performed
+using MHU as transport mechanism and rpmsg messaging system.
+
+Overall, the corstone1000 architecture is designed to cover a range
+of Power, Performance, and Area (PPA) applications, and enable extension
+for use-case specific applications, for example, sensors, cloud
+connectivitiy, and edge computing.
+
+*****************
+Secure Boot Chain
+*****************
+
+For the security of a device, it is essential that only authorized
+software should run on the device. The corstone1000 boot uses a
+Secure Boot Chain process where an already authenticated image verifies
+and loads the following software in the chain. For the boot chain
+process to work, the start of the chain should be trusted, forming the
+Root of Trust (RoT) of the device. The RoT of the device is immutable in
+nature and encoded into the device by the device owner before it
+is deployed into the field. In Corstone1000, the BL1 image of the secure
+enclave and content of the CC312 OTP (One Time Programmable) memory
+forms the RoT. The BL1 image exists in ROM (Read Only Memory).
+
+.. image:: images/SecureBootChain.png
+ :width: 870
+ :alt: SecureBootChain
+
+It is a lengthy chain to boot the software on corstone1000. On power on,
+the secure enclave starts executing BL1 code from the ROM which is the RoT
+of the device. Authentication of an image involves the steps listed below:
+
+- Load image from flash to dynamic RAM.
+- The public key present in the image header is validated by comparing with the hash. Depending on the image, the hash of the public key is either stored in the OTP or part of the software which is being already verfied in the previous stages.
+- The image is validated using the public key.
+
+In the secure enclave, BL1 authenticates the BL2 and passes the execution
+control. BL2 authenticates the initial boot loader of the host (Host BL2)
+and TF-M. The execution control is now passed to TF-M. TF-M being the run
+time executable of secure enclaves initializes itself and, in the end,
+brings the host CPU out of rest. The host follows the boot standard defined
+in the `TBBR`_ to authenticate the secure and non-secure software.
+
+***************
+Secure Services
+***************
+
+corstone1000 is unique in providing a secure environment to run a secure
+workload. The platform has Trustzone technology in the Host subsystem but
+it also has hardware isolated secure enclave environment to run such secure
+workloads. In corstone1000, known Secure Services such as Crypto, Protected
+Storage, Internal Trusted Storage and Attestation are available via PSA
+Functional APIs in TF-M. There is no difference for a user communicating to
+these services which are running on a secure enclave instead of the
+secure world of the host subsystem. The below diagram presents the data
+flow path for such calls.
+
+
+.. image:: images/SecureServices.png
+ :width: 930
+ :alt: SecureServices
+
+
+The SE Proxy SP (Secure Enclave Proxy Secure Partition) is a proxy partition
+managed by OPTEE which forwards such calls to the secure enclave. The
+solution relies on OpenAMP which uses shared memory and MHU interrupts as
+a doorbell for communication between two cores. corstone1000 implements
+isolation level 2. Cortex-M0+ MPU (Memory Protection Unit) is used to implement
+isolation level 2.
+
+For a user to define its own secure service, both the options of the host
+secure world or secure encalve are available. It's a trade-off between
+lower latency vs higher security. Services running on a secure enclave are
+secure by real hardware isolation but have a higher latency path. In the
+second scenario, the services running on the secure world of the host
+subsystem have lower latency but virtual hardware isolation created by
+Trustzone technology.
+
+
+**********************
+Secure Firmware Update
+**********************
+
+Apart from always booting the authorized images, it is also essential that
+the device only accepts the authorized images in the firmware update
+process. corstone1000 supports OTA (Over the Air) firmware updates and
+follows Platform Security Firmware Update sepcification (`FWU`_).
+
+As standardized into `FWU`_, the external flash is divided into two
+banks of which one bank has currently running images and the other bank is
+used for staging new images. There are four updatable units, i.e. Secure
+Enclave's BL2 and TF-M, and Host's FIP (Firmware Image Package) and Kernel
+Image. The new images are accepted in the form of a UEFI capsule.
+
+
+.. image:: images/ExternalFlash.png
+ :width: 690
+ :alt: ExternalFlash
+
+
+The Metadata Block in the flash has the below firmware update state machine.
+TF-M runs an OTA service that is responsible for accepting and updating the
+images in the flash. The communication between the UEFI Capsule update
+subsystem and the OTA service follows the same data path explained above.
+The OTA service writes the new images to the passive bank after successful
+capsule verification. It changes the state of the system to trial state and
+triggers the reset. Boot loaders in Secure Enclave and Host read the Metadata
+block to get the information on the boot bank. In the successful trial stage,
+the acknowledgment from the host moves the state of the system from trial to
+regular. Any failure in the trial stage or system hangs leads to a system
+reset. This is made sure by the use of watchdog hardware. The Secure Enclave's
+BL1 has the logic to identify multiple resets and eventually switch back to the
+previous good bank. The ability to revert to the previous bank is crucial to
+guarantee the availability of the device.
+
+
+.. image:: images/SecureFirmwareUpdate.png
+ :width: 430
+ :alt: SecureFirmwareUpdate
+
+
+
+******************************
+UEFI Runtime Support in u-boot
+******************************
+
+Implementation of UEFI boottime and runtime APIs require variable storage.
+In corstone1000, these UEFI variables are stored in the Protected Storage
+service. The below diagram presents the data flow to store UEFI variables.
+The u-boot implementation of the UEFI subsystem uses the FF-A driver to
+communicate with the SMM Service in the secure world. The backend of the
+SMM service uses the proxy PS from the SE Proxy SP. From there on, the PS
+calls are forwarded to the secure enclave as explained above.
+
+
+.. image:: images/UEFISupport.png
+ :width: 590
+ :alt: UEFISupport
+
+
+***************
+References
+***************
+`ARM corstone1000 Search`_
+`Arm security features`_
+
+--------------
+
+*Copyright (c) 2022, Arm Limited. All rights reserved.*
+
+.. _Arm corstone1000 Technical Overview: https://developer.arm.com/documentation/102360/0000
+.. _Arm corstone1000 Software: https://developer.arm.com/Tools%20and%20Software/Corstone-1000%20Software
+.. _Arm corstone1000 Search: https://developer.arm.com/search#q=corstone-1000
+.. _Arm security features: https://www.arm.com/architecture/security-features/platform-security
+.. _linux repo: https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/
+.. _FF-A: https://developer.arm.com/documentation/den0077/latest
+.. _FF-M: https://developer.arm.com/-/media/Files/pdf/PlatformSecurityArchitecture/Architect/DEN0063-PSA_Firmware_Framework-1.0.0-2.pdf?revision=2d1429fa-4b5b-461a-a60e-4ef3d8f7f4b4&hash=3BFD6F3E687F324672F18E5BE9F08EDC48087C93
+.. _FWU: https://developer.arm.com/documentation/den0118/a/
+.. _OPTEE-OS: https://github.com/OP-TEE/optee_os
+.. _PSA: https://www.psacertified.org/
+.. _PSA L2 Ready: https://www.psacertified.org/products/corstone-1000/
+.. _SRIR cert: https://armkeil.blob.core.windows.net/developer/Files/pdf/certificate-list/arm-systemready-ir-certification-arm-corstone-1000.pdf
+.. _TBBR: https://developer.arm.com/documentation/den0006/latest
+.. _TF-M: https://www.trustedfirmware.org/projects/tf-m/
+.. _Trusted Services: https://www.trustedfirmware.org/projects/trusted-services/
+.. _u-boot repo: https://github.com/u-boot/u-boot.git
diff --git a/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst b/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst
new file mode 100644
index 0000000000..d5930fc8e5
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/corstone1000/user-guide.rst
@@ -0,0 +1,685 @@
+..
+ # Copyright (c) 2022, Arm Limited.
+ #
+ # SPDX-License-Identifier: MIT
+
+##########
+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>`__
+tool as its build tool. Please see `Yocto Project documentation <https://docs.yoctoproject.org/>`__
+for more information.
+
+
+Prerequisites
+-------------
+These instructions assume your host PC is running Ubuntu Linux 18.04 or 20.04 LTS, with
+at least 32GB of free disk space and 16GB of RAM as minimum requirement. The
+following instructions expect that you are using a bash shell.
+
+The following prerequisites must be available on the host system. To resolve these dependencies, run:
+
+::
+
+ sudo apt-get update
+ sudo apt-get install gawk wget git-core diffstat unzip texinfo gcc-multilib \
+ build-essential chrpath socat cpio python3 python3-pip python3-pexpect \
+ xz-utils debianutils iputils-ping python3-git libegl1-mesa libsdl1.2-dev \
+ xterm zstd liblz4-tool picocom
+ sudo apt-get upgrade libstdc++6
+
+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:
+``<_workspace>/meta-arm/meta-arm-bsp/``.
+
+The Yocto machine config files for the corstone1000 FVP and FPGA are:
+
+ - ``<_workspace>/meta-arm/meta-arm-bsp/conf/machine/include/corstone1000.inc``
+ - ``<_workspace>/meta-arm/meta-arm-bsp/conf/machine/corstone1000-fvp.conf``
+ - ``<_workspace>/meta-arm/meta-arm-bsp/conf/machine/corstone1000-mps3.conf``
+
+*****************
+Software for Host
+*****************
+
+Trusted Firmware-A
+==================
+Based on `Trusted Firmware-A <https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git>`__
+
++----------+---------------------------------------------------------------------------------------------------+
+| bbappend | <_workspace>/meta-arm/meta-arm-bsp/recipes-bsp/trusted-firmware-a/trusted-firmware-a_2.7.bbappend |
++----------+---------------------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/meta-arm/meta-arm/recipes-bsp/trusted-firmware-a/trusted-firmware-a_2.7.bb |
++----------+---------------------------------------------------------------------------------------------------+
+
+OP-TEE
+======
+Based on `OP-TEE <https://git.trustedfirmware.org/OP-TEE/optee_os.git>`__
+
++----------+------------------------------------------------------------------------------------+
+| bbappend | <_workspace>/meta-arm/meta-arm-bsp/recipes-security/optee/optee-os_3.18.0.bbappend |
++----------+------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/meta-arm/meta-arm/recipes-security/optee/optee-os_3.18.0.bb |
++----------+------------------------------------------------------------------------------------+
+
+U-Boot
+=======
+Based on `U-Boot <https://gitlab.com/u-boot>`__
+
++----------+---------------------------------------------------------------------+
+| bbappend | <_workspace>/meta-arm/meta-arm/recipes-bsp/u-boot/u-boot_%.bbappend |
++----------+---------------------------------------------------------------------+
+| Recipe | <_workspace>/poky/meta/recipes-bsp/u-boot/u-boot_2022.07.bb |
++----------+---------------------------------------------------------------------+
+
+Linux
+=====
+The distro is based on the `poky-tiny <https://wiki.yoctoproject.org/wiki/Poky-Tiny>`__
+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.
+
++-----------+----------------------------------------------------------------------------------------------+
+| bbappend | <_workspace>/meta-arm/meta-arm-bsp/recipes-kernel/linux/linux-yocto_%.bbappend |
++-----------+----------------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/poky/meta/recipes-kernel/linux/linux-yocto_5.19.bb |
++-----------+----------------------------------------------------------------------------------------------+
+| defconfig | <_workspace>/meta-arm/meta-arm-bsp/recipes-kernel/linux/files/corstone1000/defconfig |
++-----------+----------------------------------------------------------------------------------------------+
+
+**************************************************
+Software for Boot Processor (a.k.a Secure Enclave)
+**************************************************
+Based on `Trusted Firmware-M <https://git.trustedfirmware.org/TF-M/trusted-firmware-m.git>`__
+
++----------+-------------------------------------------------------------------------------------------------+
+| bbappend | <_workspace>/meta-arm/meta-arm-bsp/recipes-bsp/trusted-firmware-m/trusted-firmware-m_%.bbappend |
++----------+-------------------------------------------------------------------------------------------------+
+| Recipe | <_workspace>/meta-arm/meta-arm/recipes-bsp/trusted-firmware-m/trusted-firmware-m_1.6.0.bb |
++----------+-------------------------------------------------------------------------------------------------+
+
+Building the software stack
+---------------------------
+Create a new folder that will be your workspace and will henceforth be referred
+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
+commands to build the stack. To install kas tool, run:
+
+::
+
+ pip3 install kas
+
+In the top directory of the workspace ``<_workspace>``, run:
+
+::
+
+ git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.04.07
+
+To build corstone1000 image for MPS3 FPGA, run:
+
+::
+
+ kas build meta-arm/kas/corstone1000-mps3.yml
+
+Alternatively, to build corstone1000 image for FVP, run:
+
+::
+
+ kas build meta-arm/kas/corstone1000-fvp.yml
+
+The initial clean build will be lengthy, given that all host utilities are to
+be built as well as the target images. This includes host executables (python,
+cmake, etc.) and the required toolchain(s).
+
+Once the build is successful, all output binaries will be placed in the following folders:
+ - ``<_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``
+
+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``
+
+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>`__
+and under the section ``Arm® Corstone™-1000 for MPS3``.
+
+The directory structure of the FPGA bundle is shown below.
+
+::
+
+ Boardfiles
+ ├── MB
+ │   ├── BRD_LOG.TXT
+ │   ├── HBI0309B
+ │   │   ├── AN550
+ │   │   │   ├── AN550_v1.bit
+ │   │   │   ├── an550_v1.txt
+ │   │   │   └── images.txt
+ │   │   ├── board.txt
+ │   │   └── mbb_v210.ebf
+ │   └── HBI0309C
+ │   ├── AN550
+ │   │   ├── AN550_v1.bit
+ │   │   ├── an550_v1.txt
+ │   │   └── images.txt
+ │   ├── board.txt
+ │   └── mbb_v210.ebf
+ ├── SOFTWARE
+ │   ├── ES0.bin
+ │   ├── SE.bin
+ │   └── an550_st.axf
+ └── config.txt
+
+Depending upon the MPS3 board version (printed on the MPS3 board) you should update the images.txt file
+(in corresponding HBI0309x folder) so that the file points to the images under SOFTWARE directory.
+
+Here is an example
+
+::
+
+ ;************************************************
+ ; Preload port mapping *
+ ;************************************************
+ ; PORT 0 & ADDRESS: 0x00_0000_0000 QSPI Flash (XNVM) (32MB)
+ ; PORT 0 & ADDRESS: 0x00_8000_0000 OCVM (DDR4 2GB)
+ ; PORT 1 Secure Enclave (M0+) ROM (64KB)
+ ; PORT 2 External System 0 (M3) Code RAM (256KB)
+ ; PORT 3 Secure Enclave OTP memory (8KB)
+ ; PORT 4 CVM (4MB)
+ ;************************************************
+
+ [IMAGES]
+ TOTALIMAGES: 2 ;Number of Images (Max: 32)
+
+ IMAGE0PORT: 1
+ IMAGE0ADDRESS: 0x00_0000_0000
+ IMAGE0UPDATE: RAM
+ IMAGE0FILE: \SOFTWARE\bl1.bin
+
+ IMAGE1PORT: 0
+ IMAGE1ADDRESS: 0x00_00010_0000
+ IMAGE1UPDATE: AUTOQSPI
+ IMAGE1FILE: \SOFTWARE\cs1000.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``.
+
+**NOTE:** Renaming of the images are required because MCC firmware has
+limitation of 8 characters before .(dot) and 3 characters after .(dot).
+
+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.
+
+ - ttyUSB0 for MCC, OP-TEE and Secure Partition
+ - ttyUSB1 for Boot Processor (Cortex-M0+)
+ - ttyUSB2 for Host Processor (Cortex-A35)
+
+Run following commands to open minicom sessions 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.
+
+Once the system boot is completed, you should see console
+logs on the minicom sessions. 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
+instructions of the installer and setup the FVP.
+
+<_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
+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.
+
+The host will boot trusted-firmware-a, OP-TEE, U-Boot and then Linux, and present a login prompt
+(FVP host_terminal_0):
+
+::
+ corstone1000-fvp login:
+
+Login using the username root.
+
+Running test applications
+-------------------------
+
+**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
+environment.
+
+ - HP V165W 8 GB USB Flash Drive
+ - SanDisk Ultra 32GB Dual USB Flash Drive USB M3.0
+ - SanDisk Ultra 16GB Dual USB Flash Drive USB M3.0
+
+**NOTE**:
+Before running each of the tests in this chapter, the user should follow the
+steps described in following section "Clean Secure Flash Before Testing" to
+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.
+
+::
+
+ cd <_workspace>
+ git clone https://git.yoctoproject.org/git/meta-arm -b CORSTONE1000-2022.02.18
+ 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
+ git apply 0001-arm-bsp-trusted-firmware-m-corstone1000-Clean-Secure.patch
+ cd ..
+ kas build meta-arm/kas/corstone1000-mps3.yml
+
+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
+completely, the user should expect following message from TF-M log:
+
+::
+
+ !!!SECURE FLASH HAS BEEN CLEANED!!!
+ NOW YOU CAN FLASH THE ACTUAL CORSTONE1000 IMAGE
+ PLEASE REMOVE THE LATEST ERASE SECURE FLASH PATCH AND BUILD THE IMAGE AGAIN
+
+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
+
+ * SCT
+ * FWTS
+ * BSA uefi
+ * BSA linux
+ * grub
+ * uefi manual capsule application
+
+RESULTS partition is used to store the test results.
+PLEASE MAKE SURE THAT THE RESULTS PARTITION IS EMPTY BEFORE YOU START THE TESTING. OTHERWISE THE TEST RESULTS
+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.
+
+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
+Compliance Suite (ACS) and the bootable prebuilt images to be used for the
+certifications of SystemReady-IR. To download the repository, run command:
+
+::
+
+ cd <_workspace>
+ git clone https://github.com/ARM-software/arm-systemready.git -b v21.09_REL1.0
+
+Once the repository is successfully downloaded, the prebuilt ACS live image can be found in:
+ - ``<_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
+SystemReady release in this repository.
+
+Then, the user should prepare a USB stick with ACS image. In the given example here,
+we assume the USB device is ``/dev/sdb`` (the user should use ``lsblk`` command to
+confirm). Be cautious here and don't confuse your host PC's own hard drive with the
+USB drive. Run the following commands to prepare the ACS image in USB stick:
+
+::
+
+ cd <_workspace>/arm-systemready/IR/scripts/output/
+ 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
+
+Once the USB stick with ACS image is prepared, the user should make sure that
+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:
+ - ``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
+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}"
+
+The test results can be fetched using following commands:
+
+::
+
+ sudo mkdir /mnt/test
+ 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
+
+ -> <offset_2nd_partition> = 1050624 * 512 (sector size) = 537919488
+
+The FVP will reset multiple times during the test, and it might take up to 1 day to finish
+the test. At the end of test, the FVP host terminal will halt showing a shell prompt.
+Once test is finished, the FVP can be stoped, and result can be copied following above
+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
+automatically in the following sequence:
+
+ - SCT
+ - UEFI BSA
+ - FWTS
+ - BSA Linux
+
+The results can be fetched from the ``acs_results`` partition of the USB stick (FPGA) / SD Card (FVP).
+
+Manual capsule update test
+--------------------------
+
+The following steps describe 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
+ - ``ir_acs_live_image.img.xz``
+
+Download edk2 and generate capsule file:
+
+::
+
+ 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.
+
+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
+-----------------------------------
+
+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
+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
+---------------------------------
+
+Run below commands to copy capsule into the
+image file and run FVP software.
+
+::
+
+ 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
+
+<_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}"
+
+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
+
+ -> <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.
+
+::
+
+ 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 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
+correctly.
+
+::
+
+ ...
+ SysTick_Handler: counted = 10, expiring on = 360
+ SysTick_Handler: counted = 20, expiring on = 360
+ SysTick_Handler: counted = 30, expiring on = 360
+ ...
+ metadata_write: success: active = 1, previous = 0
+ accept_full_capsule: exit: fwu state is changed to regular
+ ...
+
+
+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
+predetermined number of times (defined in the code), before reverting back to
+the previous good bank.
+
+::
+
+ ...
+ metadata_write: success: active = 0, previous = 1
+ fwu_select_previous: in regular state by choosing previous active bank
+ ...
+
+*******************************************************
+Linux distro 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
+
+Once the .iso file is downloaded, the .iso file needs to be flashed to your USB drive.
+
+In the given example here, we assume the USB device is ``/dev/sdb`` (the user
+should use `lsblk` command to confirm). Be cautious here and don't confuse your
+host PC's own hard drive with the USB drive. Then copy the contents of an iso
+file into the first USB stick, run:
+
+::
+
+ sudo dd if=</path/to/iso_file> of=/dev/sdb iflag=direct oflag=direct status=progress bs=1M; sync;
+
+Boot the MSP3 board with the first USB stick connected. Open following minicom sessions:
+
+::
+
+ sudo picocom -b 115200 /dev/ttyUSB0 # in one terminal
+ sudo picocom -b 115200 /dev/ttyUSB2 # in another terminal.
+
+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
+distro installation process can take up to 24 hours to complete.
+
+Once installation is complete, unplug the first USB stick and reboot the board.
+After successfully installing and booting the Linux distro, the user should see
+a login prompt:
+
+::
+
+ debian login:
+
+Login with the username root.
+
+Run psa-arch-test (applicable to both FPGA and FVP)
+---------------------------------------------------
+
+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.
+
+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>`__.
+
+First, create a file containing SE_PROXY_SP UUID. Run:
+
+::
+
+ echo 46bb39d1-b4d9-45b5-88ff-040027dab249 > sp_uuid_list.txt
+
+Then, load FFA driver module into Linux kernel. Run:
+
+::
+
+ load_ffa_debugfs.sh .
+
+Then, check whether the FFA driver loaded correctly by using the following command:
+
+::
+
+ cat /proc/modules | grep arm_ffa_user
+
+The output should be:
+
+::
+
+ arm_ffa_user 16384 - - Live 0xffffffc0084b0000 (O)
+
+Now, run the PSA arch tests with following commands. The user should run the
+tests in following order:
+
+::
+
+ psa-iat-api-test
+ psa-crypto-api-test
+ psa-its-api-test
+ psa-ps-api-test
+
+********************************************************
+Linux distro: OpenSUSE Raw image installation (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-2022.03.18-Snapshot20220331.raw.xz``
+
+Once the .raw.xz file is downloaded, the raw image file needs to be extracted:
+
+::
+
+ 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'.
+
+**************************************
+Running the software on FVP on Windows
+**************************************
+If the user needs to run the Corstone1000 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.*
+
+.. _Arm Ecosystem FVPs: https://developer.arm.com/tools-and-software/open-source-software/arm-platforms-software/arm-ecosystem-fvps
diff --git a/meta-arm/meta-arm-bsp/documentation/requirements.txt b/meta-arm/meta-arm-bsp/documentation/requirements.txt
new file mode 100644
index 0000000000..b82e5e071a
--- /dev/null
+++ b/meta-arm/meta-arm-bsp/documentation/requirements.txt
@@ -0,0 +1,12 @@
+# Copyright (c) 2022, Arm Limited.
+#
+# SPDX-License-Identifier: MIT
+
+# Read The Docs specific
+jinja2==3.1.1
+
+# Required to build the documentation
+sphinx==4.5.0
+sphinx_rtd_theme==1.0.0
+sphinx-copybutton==0.5.0
+docutils==0.17.1