public inbox for docs@lists.yoctoproject.org
 help / color / mirror / Atom feed
From: Jamin Lin <jamin_lin@aspeedtech.com>
To: <docs@lists.yoctoproject.org>
Cc: <troy_lee@aspeedtech.com>, <jamin_lin@aspeedtech.com>
Subject: [PATCH v1] ref-manual: uboot-sign: Add how to enable ATF and TEE for U-Boot FIT image
Date: Mon, 18 Nov 2024 14:21:13 +0800	[thread overview]
Message-ID: <20241118062113.269253-1-jamin_lin@aspeedtech.com> (raw)

Add how to enable ATF and TEE for U-Boot FIT image
and Image Tree Source generation.

Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
---
 documentation/ref-manual/classes.rst   |  7 +++++
 documentation/ref-manual/variables.rst | 37 ++++++++++++++++++++++++++
 2 files changed, 44 insertions(+)

diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
index b92f4e4f2..82adab90f 100644
--- a/documentation/ref-manual/classes.rst
+++ b/documentation/ref-manual/classes.rst
@@ -3336,6 +3336,13 @@ The variables used by this class are:
 -  :term:`UBOOT_FITIMAGE_ENABLE`: enable the generation of a U-Boot FIT image.
 -  :term:`UBOOT_MKIMAGE_DTCOPTS`: DTC options for U-Boot ``mkimage`` when
    rebuilding the FIT image containing the kernel.
+-  :term:`UBOOT_FIT_ARM_TRUSTED_FIRMWARE`: enable ARM Trusted Firmware(ATF) image.
+-  :term:`UBOOT_FIT_ARM_TRUSTED_FIRMWARE_IMAGE`: path of the ATF image.
+-  :term:`UBOOT_FIT_TEE`: enable Trusted Execution Environment(TEE) image.
+-  :term:`UBOOT_FIT_TEE_IMAGE`: path of the TEE image.
+-  :term:`UBOOT_FIT_USER_IMAGE`: enable users specific image.
+-  :term:`UBOOT_FIT_CONF_USER_LOADABLES`: add user specific image in the loadable
+   property of configuration node. It is a comma-separated list of strings.
 
 See U-Boot's documentation for details about `verified boot
 <https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/verified-boot.txt>`__
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 43f4d7966..c28a03da1 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -9736,6 +9736,43 @@ system and gives an overview of their function and contents.
 
       See the :ref:`ref-classes-uboot-sign` class for details.
 
+   :term:`UBOOT_FIT_ARM_TRUSTED_FIRMWARE`
+      ARM Trusted Firmware(ATF) is a reference implementation of secure world
+      software for Arm A-Profile architectures, (Armv8-A and Armv7-A), including
+      an Exception Level 3 (EL3) Secure Monitor. The variable allows to generate
+      a U-Boot FIT image with ATF image.
+
+      Its default value is "0", so set it to "1" to enable this functionality::
+
+         UBOOT_FIT_ARM_TRUSTED_FIRMWARE = "1"
+
+   :term:`UBOOT_FIT_ARM_TRUSTED_FIRMWARE_IMAGE`
+      The path of ATF image.
+
+   :term:`UBOOT_FIT_TEE`
+      A Trusted Execution Environment(TEE) is an environment for executing code,
+      in which those executing the code can have high levels of trust in the asset
+      management of that surrounding environment. The variable allows to generate
+      a U-Boot FIT image with TEE image.
+   
+      Its default value is "0", so set it to "1" to enable this functionality::
+
+         UBOOT_FIT_TEE = "1"
+
+   :term:`UBOOT_FIT_TEE_IMAGE`
+      The path of TEE image.
+
+   :term:`UBOOT_FIT_USER_IMAGE`
+      The variable allows to generate a U-Boot FIT image with user specific image.
+
+   :term:`UBOOT_FIT_CONF_USER_LOADABLES`
+      Add user specific image in the loadable property of configuration node. It is
+      a comma-separated list of strings.
+   
+      Ex::
+      
+         UBOOT_FIT_CONF_USER_LOADABLES = '\"userA\", \"userB\"'
+
    :term:`UBOOT_LOADADDRESS`
       Specifies the load address for the U-Boot image. During U-Boot image
       creation, the :term:`UBOOT_LOADADDRESS` variable is passed as a
-- 
2.34.1



             reply	other threads:[~2024-11-18  6:21 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-11-18  6:21 Jamin Lin [this message]
2024-11-27  8:30 ` [docs] [PATCH v1] ref-manual: uboot-sign: Add how to enable ATF and TEE for U-Boot FIT image Antonin Godard
2025-03-03 13:26 ` Antonin Godard
2025-03-04  8:44   ` Jamin Lin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241118062113.269253-1-jamin_lin@aspeedtech.com \
    --to=jamin_lin@aspeedtech.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=troy_lee@aspeedtech.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox