[v3] ref-manual: uboot-sign: Support firmware property in FIT config

Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows
users to specify an image to be assigned to the "firmware" property of
the FIT configuration node. This explicitly defines the primary image
to boot, instead of relying on the first entry in the "loadables" list.

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

On Mon May 26, 2025 at 9:26 AM CEST, Jamin Lin via lists.yoctoproject.org wrote:
> Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows
> users to specify an image to be assigned to the "firmware" property of
> the FIT configuration node. This explicitly defines the primary image
> to boot, instead of relying on the first entry in the "loadables" list.
>
> Signed-off-by: Jamin Lin <jamin_lin@aspeedtech.com>
> ---
>  documentation/ref-manual/classes.rst   | 2 ++
>  documentation/ref-manual/variables.rst | 7 +++++++
>  2 files changed, 9 insertions(+)
>
> diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst
> index 5187033f7..54a98bf24 100644
> --- a/documentation/ref-manual/classes.rst
> +++ b/documentation/ref-manual/classes.rst
> @@ -3426,6 +3426,8 @@ The variables used by this class are:
>  -  :term:`UBOOT_FIT_USER_SETTINGS`: adds a user-specific snippet to the U-Boot
>     Image Tree Source (ITS). Users can include their custom U-Boot Image Tree
>     Source (ITS) snippet in this variable.
> +-  :term:`UBOOT_FIT_CONF_FIRMWARE`: adds one image to the ``firmware`` property
> +   of the configuration node.
>  -  :term:`UBOOT_FIT_CONF_USER_LOADABLES`: adds one or more user-defined images
>     to the ``loadables`` property of the configuration node.
>  
> diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
> index 643a3e7ae..36c61e48e 100644
> --- a/documentation/ref-manual/variables.rst
> +++ b/documentation/ref-manual/variables.rst
> @@ -10327,6 +10327,13 @@ system and gives an overview of their function and contents.
>  
>           do_compile[depends] += "trusted-firmware-a:do_deploy"
>  
> +   :term:`UBOOT_FIT_CONF_FIRMWARE`
> +      Sets the firmware property to select the image to boot first::
> +
> +         UBOOT_FIT_CONF_FIRMWARE = "fwa"
> +
> +      If not set, the first entry in "loadables" is used to boot instead.

Thanks this looks good. I did not mean to remove the first sentence with my
suggestion, though! But that is fine, I will add it manually, no need to send a
v4.

Antonin

On Mon, 26 May 2025 15:26:01 +0800, Jamin Lin wrote:
> Add documentation for the UBOOT_FIT_CONF_FIRMWARE variable, which allows
> users to specify an image to be assigned to the "firmware" property of
> the FIT configuration node. This explicitly defines the primary image
> to boot, instead of relying on the first entry in the "loadables" list.
> 
> 

Applied, thanks!

[1/1] ref-manual: uboot-sign: Support firmware property in FIT config
      commit: f72fc69e2d2a074d5eaf1cc36b30726de58e3ab5

Best regards,