coreboot-mirror
/
arm-trusted-firmware
mirror of https://review.coreboot.org/arm-trusted-firmware.git
1
0
Fork 0
Code Issues Releases Wiki Activity

docs: clarify instructions for running RME-enabled fw 

This patch adds some documentation improvements in response to out-of-box
usability testing:

* Provide targetted links to other parts of the documentation.
* Clarify which toolchain is required.
* Clarify where the FVP binary and the bl1.bin and fip.bin files can be found
* Remove comment that cache state modelling is disabled in the known
  limitations, since it is now supported and enabled.

Signed-off-by: Soby Mathew <soby.mathew@arm.com>
Change-Id: I0b1d889c17edb5a40c4ed81c2a58c593258c3139
This commit is contained in:
Ryan Roberts 2021-08-20 11:42:05 +01:00 committed by Soby Mathew
parent 23167c5320
commit 4f5ec5f731
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
docs/components/rme/rme-userguide.rst
View File

@ -5,10 +5,11 @@ Prerequisites
--------------
To evaluate |RME|, first follow the instructions as described in the |TF-A|
:ref:`Getting Started` section to clone the repository and setup the build
environment. This should setup the required software libraries and toolchain
for the build. Specifically, ensure that the environment variable
``CROSS_COMPILE`` is setup correctly.
:ref:`Prerequisites` section to clone the repository and setup the build
environment. This should setup the required software libraries and aarch64
baremetal toolchain for the build. Specifically, ensure that the environment
variable ``CROSS_COMPILE`` is setup correctly as described in :ref:`Performing
an Initial Build`.
Next, similar to the |TF-A| approach, follow the instructions as described
in the `TF-A Tests Getting Started`_ for the pre-requisites.
@ -75,7 +76,7 @@ To launch the Armv-A Base RevC AEM FVP, execute the following command:
.. code:: shell
./FVP_Base_RevC-2xAEMvA \
<path to fvp pkg>/models/Linux64_GCC-6.4/FVP_Base_RevC-2xAEMvA \
-C bp.dram_size=2 \
-C bp.pl011_uart0.uart_enable=1 \
-C bp.pl011_uart1.uart_enable=1 \
@ -109,6 +110,21 @@ To launch the Armv-A Base RevC AEM FVP, execute the following command:
-C bp.flashloader0.fname=<path to fip.bin> \
-C bp.secureflashloader.fname=<path to bl1.bin>
where:
``<path to fvp pkg>``
* The directory that the FVP was untared into
``<path to fip.bin>``
* The fip.bin created during |TF-A| make
* For example: ``trusted-firmware-a/build/fvp/debug/fip.bin``
``<path to bl1.bin>``
* The bl1.bin created during |TF-A| make
* For example: ``trusted-firmware-a/build/fvp/debug/bl1.bin``
Test results are output to the window titled "FVP terminal_0" and the Test
Realm Payload logs are output to the window titled "FVP terminal_3.
Details of the |TF-A-Tests| for Realm world
---------------------------------------------
@ -130,11 +146,8 @@ Known limitations of the prototype
-----------------------------------
This is a prototype to bootstrap TF-A on an RME enabled FVP. It replaces the
secure world payload with Realm world binary. Currently, due to prototype nature
of the code changes, all the appropriate cache maintenance operations are not done
and hence the cache state modelling is disabled when running on the FVP. Further,
the Granule protection table (GPT) initialization sequence is a work in progress
(although functional).
secure world payload with Realm world binary. The Granule protection table (GPT)
initialization sequence is a work in progress (although functional).
--------------