| |
| Realm Management Extension (RME) |
| ==================================== |
| |
| FEAT_RME (or RME for short) is an Armv9-A extension and is one component of the |
| `Arm Confidential Compute Architecture (Arm CCA)`_. TF-A supports RME starting |
| from version 2.6. This chapter discusses the changes to TF-A to support RME and |
| provides instructions on how to build and run TF-A with RME. |
| |
| RME support in TF-A |
| --------------------- |
| |
| The following diagram shows an Arm CCA software architecture with TF-A as the |
| EL3 firmware. In the Arm CCA architecture there are two additional security |
| states and address spaces: ``Root`` and ``Realm``. TF-A firmware runs in the |
| Root world. In the realm world, a Realm Management Monitor firmware (RMM) |
| manages the execution of Realm VMs and their interaction with the hypervisor. |
| |
| .. image:: ../resources/diagrams/arm-cca-software-arch.png |
| |
| RME is the hardware extension to support Arm CCA. To support RME, various |
| changes have been introduced to TF-A. We discuss those changes below. |
| |
| Changes to translation tables library |
| *************************************** |
| RME adds Root and Realm Physical address spaces. To support this, two new |
| memory type macros, ``MT_ROOT`` and ``MT_REALM``, have been added to the |
| :ref:`Translation (XLAT) Tables Library`. These macros are used to configure |
| memory regions as Root or Realm respectively. |
| |
| .. note:: |
| |
| Only version 2 of the translation tables library supports the new memory |
| types. |
| |
| Changes to context management |
| ******************************* |
| A new CPU context for the Realm world has been added. The existing |
| :ref:`CPU context management API<PSCI Library Integration guide for Armv8-A |
| AArch32 systems>` can be used to manage Realm context. |
| |
| Boot flow changes |
| ******************* |
| In a typical TF-A boot flow, BL2 runs at Secure-EL1. However when RME is |
| enabled, TF-A runs in the Root world at EL3. Therefore, the boot flow is |
| modified to run BL2 at EL3 when RME is enabled. In addition to this, a |
| Realm-world firmware (RMM) is loaded by BL2 in the Realm physical address |
| space. |
| |
| The boot flow when RME is enabled looks like the following: |
| |
| 1. BL1 loads and executes BL2 at EL3 |
| 2. BL2 loads images including RMM |
| 3. BL2 transfers control to BL31 |
| 4. BL31 initializes SPM (if SPM is enabled) |
| 5. BL31 initializes RMM |
| 6. BL31 transfers control to Normal-world software |
| |
| Granule Protection Tables (GPT) library |
| ***************************************** |
| Isolation between the four physical address spaces is enforced by a process |
| called Granule Protection Check (GPC) performed by the MMU downstream any |
| address translation. GPC makes use of Granule Protection Table (GPT) in the |
| Root world that describes the physical address space assignment of every |
| page (granule). A GPT library that provides APIs to initialize GPTs and to |
| transition granules between different physical address spaces has been added. |
| More information about the GPT library can be found in the |
| :ref:`Granule Protection Tables Library` chapter. |
| |
| RMM Dispatcher (RMMD) |
| ************************ |
| RMMD is a new standard runtime service that handles the switch to the Realm |
| world. It initializes the RMM and handles Realm Management Interface (RMI) |
| SMC calls from Non-secure and Realm worlds. |
| |
| There is a contract between RMM and RMMD that defines the arguments that the |
| former needs to take in order to initialize and also the possible return values. |
| This contract is defined in the RMM Boot Interface, which can be found at |
| :ref:`rmm_el3_boot_interface`. |
| |
| There is also a specification of the runtime services provided by TF-A |
| to RMM. This can be found at :ref:`runtime_services_and_interface`. |
| |
| Test Realm Payload (TRP) |
| ************************* |
| TRP is a small test payload that runs at R-EL2 and implements a subset of |
| the Realm Management Interface (RMI) commands to primarily test EL3 firmware |
| and the interface between R-EL2 and EL3. When building TF-A with RME enabled, |
| if a path to an RMM image is not provided, TF-A builds the TRP by default |
| and uses it as RMM image. |
| |
| Building and running TF-A with RME |
| ------------------------------------ |
| |
| This section describes how you can build and run TF-A with RME enabled. |
| We assume you have all the :ref:`Prerequisites` to build TF-A. |
| |
| The following instructions show you how to build and run TF-A with RME |
| for two scenarios: |
| |
| - Three-world execution: TF-A with TF-A Tests or Linux. |
| |
| - NS (TF-A Test or Linux), |
| - Root (TF-A) |
| - Realm (RMM or TRP) |
| |
| - Four-world execution: TF-A, Hafnium and TF-A Tests or Linux. |
| |
| - NS (TF-A Test or Linux), |
| - Root (TF-A) |
| - Realm (RMM or TRP) |
| - SPM (Hafnium) |
| |
| To run the tests, you need an FVP model. Please use the :ref:`latest version |
| <Arm Fixed Virtual Platforms (FVP)>` of *FVP_Base_RevC-2xAEMvA* model. |
| |
| Three World Testing with TF-A Tests |
| ************************************* |
| |
| **1. Obtain and build TF-A Tests with Realm Payload** |
| |
| The full set of instructions to setup build host and build options for |
| TF-A-Tests can be found in the `TFTF Getting Started`_. |
| |
| Use the following instructions to build TF-A with `TF-A Tests`_ as the |
| non-secure payload (BL33). |
| |
| .. code:: shell |
| |
| git clone https://git.trustedfirmware.org/TF-A/tf-a-tests.git |
| cd tf-a-tests |
| make CROSS_COMPILE=aarch64-none-elf- PLAT=fvp DEBUG=1 all pack_realm |
| |
| This produces a TF-A Tests binary (**tftf.bin**) with Realm payload packaged |
| and **sp_layout.json** in the **build/fvp/debug** directory. |
| |
| **2. Obtain and build RMM Image** |
| |
| Please refer to the `RMM Getting Started`_ on how to setup |
| Host Environment and build RMM. |
| |
| The below command shows how to build RMM using the default build options for FVP. |
| |
| .. code:: shell |
| |
| git clone --recursive https://git.trustedfirmware.org/TF-RMM/tf-rmm.git |
| cd tf-rmm |
| cmake -DRMM_CONFIG=fvp_defcfg -S . -B build |
| cmake --build build |
| |
| This will generate **rmm.img** in **build** folder. |
| |
| **3. Build TF-A** |
| |
| The `TF-A Getting Started`_ has the necessary instructions to setup Host |
| machine and build TF-A. |
| |
| To build for RME, set ``ENABLE_RME`` build option to 1 and provide the path to |
| the RMM binary using the ``RMM`` build option. |
| Currently, this feature is only supported for the FVP platform. |
| |
| .. note:: |
| |
| ENABLE_RME build option is currently experimental. |
| |
| If the ``RMM`` option is not used, then the Test Realm Payload (TRP) in TF-A |
| will be built and used as the RMM. |
| |
| .. code:: shell |
| |
| git clone https://git.trustedfirmware.org/TF-A/trusted-firmware-a.git |
| cd trusted-firmware-a |
| make CROSS_COMPILE=aarch64-none-elf- \ |
| PLAT=fvp \ |
| ENABLE_RME=1 \ |
| RMM=<path/to/rmm.img> \ |
| FVP_HW_CONFIG_DTS=fdts/fvp-base-gicv3-psci-1t.dts \ |
| DEBUG=1 \ |
| BL33=<path/to/tftf.bin> \ |
| all fip |
| |
| This produces **bl1.bin** and **fip.bin** binaries in the **build/fvp/debug** directory. |
| |
| Running the tests for a 3 world FVP setup |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| |
| Use the following command to run the tests on FVP. TF-A Tests should boot |
| and run the default tests including Realm world tests. |
| |
| .. code:: shell |
| |
| FVP_Base_RevC-2xAEMvA \ |
| -C bp.refcounter.non_arch_start_at_default=1 \ |
| -C bp.secureflashloader.fname=<path/to/bl1.bin> \ |
| -C bp.flashloader0.fname=<path/to/fip.bin> \ |
| -C bp.refcounter.use_real_time=0 \ |
| -C bp.ve_sysregs.exit_on_shutdown=1 \ |
| -C cache_state_modelled=1 \ |
| -C bp.dram_size=2 \ |
| -C bp.secure_memory=1 \ |
| -C pci.pci_smmuv3.mmu.SMMU_ROOT_IDR0=3 \ |
| -C pci.pci_smmuv3.mmu.SMMU_ROOT_IIDR=0x43B \ |
| -C pci.pci_smmuv3.mmu.root_register_page_offset=0x20000 \ |
| -C cluster0.NUM_CORES=4 \ |
| -C cluster0.PA_SIZE=48 \ |
| -C cluster0.ecv_support_level=2 \ |
| -C cluster0.gicv3.cpuintf-mmap-access-level=2 \ |
| -C cluster0.gicv3.without-DS-support=1 \ |
| -C cluster0.gicv4.mask-virtual-interrupt=1 \ |
| -C cluster0.has_arm_v8-6=1 \ |
| -C cluster0.has_amu=1 \ |
| -C cluster0.has_branch_target_exception=1 \ |
| -C cluster0.rme_support_level=2 \ |
| -C cluster0.has_rndr=1 \ |
| -C cluster0.has_v8_7_pmu_extension=2 \ |
| -C cluster0.max_32bit_el=-1 \ |
| -C cluster0.stage12_tlb_size=1024 \ |
| -C cluster0.check_memory_attributes=0 \ |
| -C cluster0.ish_is_osh=1 \ |
| -C cluster0.restriction_on_speculative_execution=2 \ |
| -C cluster0.restriction_on_speculative_execution_aarch32=2 \ |
| -C cluster1.NUM_CORES=4 \ |
| -C cluster1.PA_SIZE=48 \ |
| -C cluster1.ecv_support_level=2 \ |
| -C cluster1.gicv3.cpuintf-mmap-access-level=2 \ |
| -C cluster1.gicv3.without-DS-support=1 \ |
| -C cluster1.gicv4.mask-virtual-interrupt=1 \ |
| -C cluster1.has_arm_v8-6=1 \ |
| -C cluster1.has_amu=1 \ |
| -C cluster1.has_branch_target_exception=1 \ |
| -C cluster1.rme_support_level=2 \ |
| -C cluster1.has_rndr=1 \ |
| -C cluster1.has_v8_7_pmu_extension=2 \ |
| -C cluster1.max_32bit_el=-1 \ |
| -C cluster1.stage12_tlb_size=1024 \ |
| -C cluster1.check_memory_attributes=0 \ |
| -C cluster1.ish_is_osh=1 \ |
| -C cluster1.restriction_on_speculative_execution=2 \ |
| -C cluster1.restriction_on_speculative_execution_aarch32=2 \ |
| -C pctl.startup=0.0.0.0 \ |
| -C bp.smsc_91c111.enabled=1 \ |
| -C bp.hostbridge.userNetworking=1 |
| |
| The bottom of the output from *uart0* should look something like the following. |
| |
| .. code-block:: shell |
| |
| ... |
| |
| > Test suite 'FF-A Interrupt' |
| Passed |
| > Test suite 'SMMUv3 tests' |
| Passed |
| > Test suite 'PMU Leakage' |
| Passed |
| > Test suite 'DebugFS' |
| Passed |
| > Test suite 'RMI and SPM tests' |
| Passed |
| > Test suite 'Realm payload at EL1' |
| Passed |
| > Test suite 'Invalid memory access' |
| Passed |
| ... |
| |
| Building TF-A with RME enabled Linux Kernel |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| |
| If an RME enabled Linux kernel and filesystem is available for testing, |
| and a suitable NS boot loader is not available, then this option can be used to |
| launch kernel directly after BL31: |
| |
| .. code-block:: shell |
| |
| cd trusted-firmware-a |
| make CROSS_COMPILE=aarch64-none-elf- \ |
| PLAT=fvp \ |
| ENABLE_RME=1 \ |
| RMM=<path/to/rmm.img> \ |
| FVP_HW_CONFIG_DTS=fdts/fvp-base-gicv3-psci-1t.dts \ |
| DEBUG=1 \ |
| ARM_LINUX_KERNEL_AS_BL33=1 \ |
| PRELOADED_BL33_BASE=0x84000000 \ |
| all fip |
| |
| Boot and run the RME enabled Linux Kernel |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| |
| Use the following additional arguments to boot the kernel on FVP. |
| |
| .. code-block:: shell |
| |
| --data cluster0.cpu0=<path_to_kernel_Image>@0x84000000 \ |
| -C bp.virtioblockdevice.image_path=<path_to_rootfs.ext4> |
| |
| .. tip:: |
| |
| Set the FVP option `cache_state_modelled=0` to run Linux based tests much faster. |
| |
| Four-world execution with Hafnium and TF-A Tests |
| ************************************************* |
| |
| Four-world execution involves software components in each security state: root, |
| secure, realm and non-secure. This section describes how to build TF-A |
| with four-world support. |
| |
| We use TF-A as the root firmware, `Hafnium SPM`_ is the reference Secure world component |
| and the software components for the other 2 worlds (Realm and Non-Secure) |
| are as described in the previous section. |
| |
| **1. Obtain and build Hafnium** |
| |
| .. code:: shell |
| |
| git clone --recurse-submodules https://git.trustedfirmware.org/hafnium/hafnium.git |
| cd hafnium |
| # Use the default prebuilt LLVM/clang toolchain |
| PATH=$PWD/prebuilts/linux-x64/clang/bin:$PWD/prebuilts/linux-x64/dtc:$PATH |
| |
| Feature MTE needs to be disabled in Hafnium build, apply following patch to |
| project/reference submodule |
| |
| .. code:: diff |
| |
| diff --git a/BUILD.gn b/BUILD.gn |
| index cc6a78f..234b20a 100644 |
| --- a/BUILD.gn |
| +++ b/BUILD.gn |
| @@ -83,7 +83,6 @@ aarch64_toolchains("secure_aem_v8a_fvp") { |
| pl011_base_address = "0x1c090000" |
| smmu_base_address = "0x2b400000" |
| smmu_memory_size = "0x100000" |
| - enable_mte = "1" |
| plat_log_level = "LOG_LEVEL_INFO" |
| } |
| } |
| |
| .. code:: shell |
| |
| make PROJECT=reference |
| |
| The Hafnium binary should be located at |
| *out/reference/secure_aem_v8a_fvp_clang/hafnium.bin* |
| |
| **2. Build TF-A** |
| |
| Build TF-A with RME as well as SPM enabled. |
| |
| Use sp_layout.json previously generated in tf-a-test build. |
| |
| .. code:: shell |
| |
| make CROSS_COMPILE=aarch64-none-elf- \ |
| PLAT=fvp \ |
| ENABLE_RME=1 \ |
| FVP_HW_CONFIG_DTS=fdts/fvp-base-gicv3-psci-1t.dts \ |
| SPD=spmd \ |
| SPMD_SPM_AT_SEL2=1 \ |
| BRANCH_PROTECTION=1 \ |
| CTX_INCLUDE_PAUTH_REGS=1 \ |
| DEBUG=1 \ |
| SP_LAYOUT_FILE=<path/to/sp_layout.json> \ |
| BL32=<path/to/hafnium.bin> \ |
| BL33=<path/to/tftf.bin> \ |
| RMM=<path/to/rmm.img> \ |
| all fip |
| |
| Running the tests for a 4 world FVP setup |
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ |
| |
| Use the following arguments in addition to |
| `Running the tests for a 3 world FVP setup`_ to run tests for 4 world setup. |
| |
| .. code:: shell |
| |
| -C pci.pci_smmuv3.mmu.SMMU_AIDR=2 \ |
| -C pci.pci_smmuv3.mmu.SMMU_IDR0=0x0046123B \ |
| -C pci.pci_smmuv3.mmu.SMMU_IDR1=0x00600002 \ |
| -C pci.pci_smmuv3.mmu.SMMU_IDR3=0x1714 \ |
| -C pci.pci_smmuv3.mmu.SMMU_IDR5=0xFFFF0475 \ |
| -C pci.pci_smmuv3.mmu.SMMU_S_IDR1=0xA0000002 \ |
| -C pci.pci_smmuv3.mmu.SMMU_S_IDR2=0 \ |
| -C pci.pci_smmuv3.mmu.SMMU_S_IDR3=0 |
| |
| .. _Arm Confidential Compute Architecture (Arm CCA): https://www.arm.com/why-arm/architecture/security-features/arm-confidential-compute-architecture |
| .. _Arm Architecture Models website: https://developer.arm.com/tools-and-software/simulation-models/fixed-virtual-platforms/arm-ecosystem-models |
| .. _TF-A Getting Started: https://trustedfirmware-a.readthedocs.io/en/latest/getting_started/index.html |
| .. _TF-A Tests: https://trustedfirmware-a-tests.readthedocs.io/en/latest |
| .. _TFTF Getting Started: https://trustedfirmware-a-tests.readthedocs.io/en/latest/getting_started/index.html |
| .. _Hafnium SPM: https://www.trustedfirmware.org/projects/hafnium |
| .. _RMM Getting Started: https://git.trustedfirmware.org/TF-RMM/tf-rmm.git/tree/docs/getting_started/index.rst |