Page MenuHomePhabricator

SP loading mechanisms in OP-TEE
Updated 9 Days AgoPublic

OP-TEE SPMC supports two methods for finding and loading the SP executable images. Currently only ELF executables are supported. In our buildsystem the method can be selected with the SP_PACKAGING_METHOD option [1].

  1. Embedded SP

In this case the early TA mechanism of optee_os is reused: the SP ELF files are embedded into the main OP-TEE binary. Each ELF should start with a specific section (.sp_head) containing a struct which describes the SP (UUID, stack size, etc.). The images can be added to optee_os using the EARLY_TA_PATHS config option, but our buildsystem will set this up automatically when SP_PACKAGING_METHOD=embedded is selected. The images passed in EARLY_TA_PATHS are processed by ta_bin_to_c.py in optee_os and linked into the main binary. At runtime the for_each_early_ta() macro [2] can iterate through these images (both TAs and SPs), so a particular SP can be found by UUID and then loaded by ldelf.

The SP manifest file [3] used by the SPMC to setup SPs is not included with the individual SP images. The manifest DTs should be concatenated into one DT and passed to optee_os in the CFG_EMBED_DTB_SOURCE_FILE option. Again, when selecting the embedded SP option in [1] this will be done automatically by our buildsystem.

  1. FIP SP

In this case the SP ELF files and the corresponding SP manifest DTs are encapsulated into SP packages and packed into the FIP. The goal of providing this alternative flow is to make updating SPs easier (independent of the main OP-TEE binary) and to get aligned with Hafnium (S-EL2 SPMC). For more information about the FIP, please refer to the TF-A documentation [4]. The SP packaging process and the package format is provided by TF-A (Hafnium), detailed description is available at [5]. In our buildsystem this method can be selected by SP_PACKAGING_METHOD=fip, it covers all the necessary setup automatically. In case of using another buildsystem, the following steps should be implemented:

  • TF-A config SP_LAYOUT_FILE: provide a JSON file which describes the SPs (path to SP executable and corresponding DT, example [6]). The TF-A buildsystem will create the SP packages (using sptool) based on this and pack them into the FIP.
  • TF-A config ARM_BL2_SP_LIST_DTS: provide a DT snippet which describes the SPs' UUIDs and load addresses (example: [7]). This will be injected into the SP list in TB_FW_CONFIG DT of TF-A, and BL2 will load the SPs based on this. Note that BL2 doesn't automatically load all images from the FIP: it's necessary to explicitly define them in TB_FW_CONFIG (using this injected snippet or manually editing the DT).
  • TF-A config ARM_SPMC_MANIFEST_DTS: provide the SPMC manifest (example: [8]). This DT is passed to the SPMC as a boot argument (in the TF-A naming convention this is the TOS_FW_CONFIG). It should contain the list of SP packages and the load addresses in the compatible = "arm,optee-spmc" node.
  • optee_os config: set CFG_FIP_SP=y.

At boot optee_os will parse the SP load addresses from the SPMC manifest and find the SP packages already loaded by BL2 [9]. Iterating through the SP packages, based on the SP package header in each package it will map the SP manifest DTs and load the executables using ldelf.

Note that in the process described above there are some redundancies:

  • the SP UUID has to be provided twice: in the SP manifest DT and in the ARM_BL2_SP_LIST_DTS DT snippet,
  • the SP load address has to be provided twice: in the SPMC manifest DT and in the ARM_BL2_SP_LIST_DTS DT snippet.

This could be improved in the future to have a more streamlined solution.

Note: necessary security improvements described in this task: https://developer.trustedfirmware.org/T914

[1] https://git.trustedfirmware.org/OP-TEE/build.git/tree/fvp_ffa.mk?h=psa-development

[2] https://git.trustedfirmware.org/OP-TEE/optee_os.git/tree/core/arch/arm/include/kernel/early_ta.h?h=psa-development

[3] https://trustedfirmware-a.readthedocs.io/en/latest/components/ffa-manifest-binding.html

[4] https://trustedfirmware-a.readthedocs.io/en/latest/design/firmware-design.html#firmware-image-package-fip

[5] https://trustedfirmware-a.readthedocs.io/en/latest/components/secure-partition-manager.html#boot-process

[6] https://trustedfirmware-a.readthedocs.io/en/latest/components/secure-partition-manager.html#describing-secure-partitions

[7] https://git.trustedfirmware.org/OP-TEE/build.git/tree/fvp/bl2_sp_images.dtsi?h=psa-development

[8] https://git.trustedfirmware.org/OP-TEE/build.git/tree/fvp/spmc_manifest.dts?h=psa-development

[9] https://git.trustedfirmware.org/OP-TEE/optee_os.git/tree/core/arch/arm/kernel/fip_sp.c?h=psa-development

Last Author
balintdobszay
Last Edited
Thu, Jul 15, 8:14 AM

Event Timeline

balintdobszay created this object with visibility "balintdobszay (Bálint Dobszay)".
balintdobszay created this object with edit policy "balintdobszay (Bálint Dobszay)".
balintdobszay changed the visibility from "balintdobszay (Bálint Dobszay)" to "Restricted Project (Project)".
balintdobszay edited the content of this document. (Show Details)Jun 23 2021, 1:05 PM
balintdobszay edited the content of this document. (Show Details)Jun 24 2021, 3:36 PM
balintdobszay edited the content of this document. (Show Details)Jun 24 2021, 3:52 PM
balintdobszay edited the content of this document. (Show Details)Jun 24 2021, 3:59 PM
balintdobszay published a new version of this document.
balintdobszay changed the title from SP loading mechanism to SP loading mechanisms in OP-TEE.Jun 24 2021, 4:32 PM
balintdobszay changed the visibility from "Restricted Project (Project)" to "Public (No Login Required)".Thu, Jul 8, 9:49 AM
balintdobszay edited the content of this document. (Show Details)Thu, Jul 15, 8:14 AM