feat(tools/shrinkwrap): add shrinkwrap configs for RMM
This patch adds a shrinkwrap configuration to build and run RMM TFTF
tests using the current local (or, alternatively, a different one)
RMM repository. The configuration included in this patch can be
found at:
- <RMM_ROOT>/shrinkwrap/configs/rmm-tftf.yaml
In addition to the above configuration, this patch includes the
following overlays, that can be used in any needed combination:
- rmm.yaml
- rmm-debug.yaml
- model-enable-lpa2.yaml
- model-wait-debugger.yaml
- clean.yaml
Of all the above overlays, which are stored on the same directory as
the configuration, the first one is already used by the former
whereas the rest of overlays can be used as needed to test any
particular functionality.
In addition to the presented configuration and overlays, this patch
also adds instructions to the Getting Started guide to build
and run the 3-world CCA demonstrator. This is done by using
the `rmm.yaml` overlay provided in the patch,
so it can be used to test RMM during development.
Signed-off-by: Javier Almansa Sobrino <javier.almansasobrino@arm.com>
Change-Id: I8ccd243d8580ad6ddb4b146674f55c8d6b5b1df9
diff --git a/docs/getting_started/getting-started.rst b/docs/getting_started/getting-started.rst
index 367b1d6..4b8bfbc 100644
--- a/docs/getting_started/getting-started.rst
+++ b/docs/getting_started/getting-started.rst
@@ -286,10 +286,16 @@
or an appropriate Test utility running in Non-Secure world which can interact
with |RMM| via Realm Management Interface (RMI).
-The `TF-A`_ project includes build and run instructions for an RME enabled
-system on the FVP platform as part of `TF-A RME documentation`_.
-The ``rmm.img`` binary is provided to the TF-A bootloader to be packaged
-in FIP using ``RMM`` build option in `TF-A`_.
+Building all of the involved stack is complicated. We recommend using the
+`Shrinkwrap`_ tooling to bootstrap the stack. For more details on `Shrinkwrap`_
+and utilizing configs and overlays included in |RMM| please refer to
+:ref:`using_shrinkwrap_with_rmm` and, specially for building a demonstrator
+for 3-world, you can refer to :ref:`3_world_testing`.
+
+The |TF-A| documentation also provides some documentation to build |TF-A| and
+other pieces of firmware for RME in `TF-A RME documentation`_. The |RMM| build
+option in |TF-A| should point to the ``rmm.img`` binary generated by building
+|RMM|.
If |RMM| is built for the `fake_host` architecture
(see :ref:`RMM Fake Host Build`), then the generated `rmm.elf` binary can
@@ -305,3 +311,4 @@
.. _TF-A RME documentation: https://trustedfirmware-a.readthedocs.io/en/latest/components/realm-management-extension.html
.. _TF-RMM Gerrit page: https://review.trustedfirmware.org/admin/repos/TF-RMM/tf-rmm
.. _Git hooks documentation: https://git-scm.com/docs/githooks
+.. _Shrinkwrap: https://shrinkwrap.docs.arm.com