Re: [docs] [PATCH v1] ref-manual: uboot-sign: Support firmware property in FIT config

["Antonin Godard" <antonin.godard@bootlin.com>]

On Fri May 23, 2025 at 3:40 AM CEST, Jamin Lin wrote:
> Hi Antonin,
>
>> Subject: Re: [docs] [PATCH v1] ref-manual: uboot-sign: Support firmware
>> property in FIT config
>> 
>> Hi,
>> 
>> On Tue May 20, 2025 at 11:54 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 | 8 ++++++++
>> >  2 files changed, 10 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..b430fa51f 100644
>> > --- a/documentation/ref-manual/variables.rst
>> > +++ b/documentation/ref-manual/variables.rst
>> > @@ -10327,6 +10327,14 @@ system and gives an overview of their function
>> and contents.
>> >
>> >           do_compile[depends] += "trusted-firmware-a:do_deploy"
>> >
>> > +   :term:`UBOOT_FIT_CONF_FIRMWARE`
>> > +      Adds one image to the ``firmware`` property of the configuration
>> node
>> > +      of the U-Boot Image Tree Source (ITS). Sets the firmware property to
>> select
>> > +      the image to boot first. If not set, the first entry in "loadables" is
>> used
>> > +      instead.::
>> 
>> Extra "." here.
>> 
>
> Will fix
>
>> When you write:
>> 
>> """
>> The first entry in "loadables" is used instead """
>> 
>> It's not really clear to me what it is used for.
>> Used to boot?
>> 
>
> Example:1
>
> configurations {
>         default = "conf";
>         conf {
>             firmware = "fwA";
>             loadables = "fwB", "fwC", "fwD";
>         };
> };
>
> Boot fwA
>
> Example:2
>
> configurations {
>         default = "conf";
>         conf {
>             loadables = "fwB", "fwC", "fwD";
>         };
> };
>
> Boot fwB
>
> Example:3
>
> configurations {
>         default = "conf";
>         conf {
>             loadables = "fwA" "fwB", "fwC", "fwD";
>         };
> };
>
> Boot fwA

Thanks that clears things up! Can you modify the last sentence from:

"""
If not set, the first entry in "loadables" is used instead
"""

to

"""
If not set, the first entry in "loadables" is used to boot instead
"""

Thanks,
Antonin

-- 
Antonin Godard, Bootlin
Embedded Linux and Kernel engineering
https://bootlin.com