ref-manual: replace kernel-fitimage by kernel-fit-image

(From yocto-docs rev: 93c92dd2837708ba00a4ca47667e60d7bb09430b)

Signed-off-by: Adrian Freihofer <adrian.freihofer@siemens.com>
Signed-off-by: Antonin Godard <antonin.godard@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Adrian Freihofer 2025-06-16 22:36:47 +02:00 committed by Richard Purdie
parent 474742f808
commit 7a01d262a1
2 changed files with 170 additions and 91 deletions

View File

@ -1732,77 +1732,158 @@ Its behavior is mainly controlled by the following variables:
- :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler - :term:`KERNEL_DTC_FLAGS`: flags for ``dtc``, the Device Tree Compiler
- :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages - :term:`KERNEL_PACKAGE_NAME`: base name of the kernel packages
.. _ref-classes-kernel-fitimage: .. _ref-classes-kernel-fit-image:
``kernel-fitimage`` ``kernel-fit-image``
=================== ====================
The :ref:`ref-classes-kernel-fitimage` class provides support to pack a kernel image, The :ref:`ref-classes-kernel-fit-image` class provides support to pack a kernel image,
device trees, a U-boot script, an :term:`Initramfs` bundle and a RAM disk device trees, a U-boot script, and an :term:`Initramfs` into a single FIT image.
into a single FIT image. In theory, a FIT image can support any number In theory, a FIT image can support any number of kernels, U-boot scripts,
of kernels, U-boot scripts, :term:`Initramfs` bundles, RAM disks and device-trees. :term:`Initramfs`, and device trees.
However, :ref:`ref-classes-kernel-fitimage` currently only supports However, :ref:`ref-classes-kernel-fit-image` currently only supports
limited usecases: just one kernel image, an optional U-boot script, limited usecases: just one kernel image, an optional U-boot script,
an optional :term:`Initramfs` bundle, an optional RAM disk, and any number of an optional :term:`Initramfs`, and any number of device trees.
device trees.
To create a FIT image, it is required that :term:`KERNEL_CLASSES` The FIT image is created by a recipe which inherits the
is set to include ":ref:`ref-classes-kernel-fitimage`" and one of :term:`KERNEL_IMAGETYPE`, :ref:`ref-classes-kernel-fit-image` class.
:term:`KERNEL_ALT_IMAGETYPE` or :term:`KERNEL_IMAGETYPES` to include "fitImage". One such example is the ``linux-yocto-fitimage`` recipe which creates a FIT
image for the Linux Yocto kernel.
Additionally, it is required that :term:`KERNEL_CLASSES` is set to include
:ref:`ref-classes-kernel-fit-extra-artifacts`.
The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required kernel
artifacts to the :term:`DEPLOY_DIR_IMAGE` which are used by the
:ref:`ref-classes-kernel-fit-image` class to create the FIT image.
The options for the device tree compiler passed to ``mkimage -D`` The simplest example for building a FIT image is to add::
when creating the FIT image are specified using the
:term:`UBOOT_MKIMAGE_DTCOPTS` variable.
Only a single kernel can be added to the FIT image created by KERNEL_CLASSES += "kernel-fit-extra-artifacts"
:ref:`ref-classes-kernel-fitimage` and the kernel image in FIT is mandatory. The
address where the kernel image is to be loaded by U-Boot is
specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by
:term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2"
is necessary if such addresses are 64 bit ones.
Multiple device trees can be added to the FIT image created by to the machine :term:`configuration file` and to execute::
:ref:`ref-classes-kernel-fitimage` and the device tree is optional.
The address where the device tree is to be loaded by U-Boot is
specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays
and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries.
Only a single RAM disk can be added to the FIT image created by bitbake linux-yocto-fitimage
:ref:`ref-classes-kernel-fitimage` and the RAM disk in FIT is optional.
The address where the RAM disk image is to be loaded by U-Boot
is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
:term:`UBOOT_RD_ENTRYPOINT`. The ramdisk is added to the FIT image when
:term:`INITRAMFS_IMAGE` is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE`
is not set to 1.
Only a single :term:`Initramfs` bundle can be added to the FIT image created by This results in a ``fitImage`` file deployed to the :term:`DEPLOY_DIR_IMAGE`
:ref:`ref-classes-kernel-fitimage` and the :term:`Initramfs` bundle in FIT is optional. directory and a ``linux-yocto-fitimage`` package which can be installed.
In case of :term:`Initramfs`, the kernel is configured to be bundled with the root filesystem
in the same binary (example: zImage-initramfs-:term:`MACHINE`.bin).
When the kernel is copied to RAM and executed, it unpacks the :term:`Initramfs` root filesystem.
The :term:`Initramfs` bundle can be enabled when :term:`INITRAMFS_IMAGE`
is specified and requires that :term:`INITRAMFS_IMAGE_BUNDLE` is set to 1.
The address where the :term:`Initramfs` bundle is to be loaded by U-boot is specified
by :term:`UBOOT_LOADADDRESS` and the entrypoint by :term:`UBOOT_ENTRYPOINT`.
Only a single U-boot boot script can be added to the FIT image created by The same approach works for all variants of the ``linux-yocto`` kernel.
:ref:`ref-classes-kernel-fitimage` and the boot script is optional. For example, if the ``linux-yocto-rt`` kernel should be used, add the following
The boot script is specified in the ITS file as a text file containing lines to the machine configuration file::
U-boot commands. When using a boot script the user should configure the
U-boot :ref:`ref-tasks-install` task to copy the script to sysroot.
So the script can be included in the FIT image by the :ref:`ref-classes-kernel-fitimage`
class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
load the boot script from the FIT image and execute it.
The FIT image generated by the :ref:`ref-classes-kernel-fitimage` class is signed when the KERNEL_CLASSES += "kernel-fit-extra-artifacts"
variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`, PREFERRED_PROVIDER_virtual/kernel = "linux-yocto-rt"
:term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set
appropriately. The default values used for :term:`FIT_HASH_ALG` and
:term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fitimage` are "sha256" and
"rsa2048" respectively. The keys for signing the FIT image can be generated using
the :ref:`ref-classes-kernel-fitimage` class when both :term:`FIT_GENERATE_KEYS` and
:term:`UBOOT_SIGN_ENABLE` are set to "1".
The FIT image, this time including the RT kernel, is built again by calling::
bitbake linux-yocto-fitimage
For other kernels provided by other layers, the same approach would work.
However, it is usually more intuitive to add a custom FIT image recipe next to
the custom kernel recipe.
For example, if a layer provides a ``linux-vanilla`` recipe, a
``linux-vanilla-fitimage`` recipe may be added as well.
The ``linux-vanilla-fitimage`` recipe can be created as a customized copy of
the ``linux-yocto-fitimage`` recipe.
Usually the kernel is built as a dependency of an image.
If the FIT image should be used as a replacement for the kernel image which
is installed in the root filesystem, then the following variables can be set
e.g. in the machine configuration file::
# Create and deploy the vmlinux artifact which gets included into the FIT image
KERNEL_CLASSES += "kernel-fit-extra-artifacts"
# Do not install the kernel image package
RRECOMMENDS:${KERNEL_PACKAGE_NAME}-base = ""
# Install the FIT image package
MACHINE_ESSENTIAL_EXTRA_RDEPENDS += "linux-yocto-fitimage"
# Configure the image.bbclass to depend on the FIT image instead of only
# the kernel to ensure the FIT image is built and deployed with the image
KERNEL_DEPLOY_DEPEND = "linux-yocto-fitimage:do_deploy"
The :ref:`ref-classes-kernel-fit-image` class processes several variables that
allow configuration:
- The options for the device tree compiler passed to ``mkimage -D``
when creating the FIT image are specified using the
:term:`UBOOT_MKIMAGE_DTCOPTS` variable.
- Only a single kernel can be added to the FIT image created by
:ref:`ref-classes-kernel-fit-image` and it is a mandatory component of the
FIT image.
The address where the kernel image is to be loaded by U-Boot is
specified by :term:`UBOOT_LOADADDRESS` and the entrypoint by
:term:`UBOOT_ENTRYPOINT`. Setting :term:`FIT_ADDRESS_CELLS` to "2"
is necessary if such addresses are 64 bit ones.
- Multiple device trees can be added to the FIT image created by
:ref:`ref-classes-kernel-fit-image` and the device tree is optional.
The address where the device tree is to be loaded by U-Boot is
specified by :term:`UBOOT_DTBO_LOADADDRESS` for device tree overlays
and by :term:`UBOOT_DTB_LOADADDRESS` for device tree binaries.
- Only a single :term:`Initramfs` can be added to the FIT image created by
:ref:`ref-classes-kernel-fit-image`. The :term:`Initramfs` in FIT is optional.
The address where the RAM disk image is to be loaded by U-Boot
is specified by :term:`UBOOT_RD_LOADADDRESS` and the entrypoint by
:term:`UBOOT_RD_ENTRYPOINT`. The :term:`Initramfs` is added to the FIT image
when :term:`INITRAMFS_IMAGE` is specified.
- It's recommended to add the :term:`Initramfs` and the kernel image as
independent image nodes to the FIT image.
Bundling a RAM disk image with the kernel image and including the bundle
(:term:`INITRAMFS_IMAGE_BUNDLE` set to "1") in the FIT image is possible.
However, this approach has the disadvantage that any change to the RAM
disk image necessitates rebuilding the kernel image.
This process requires the full kernel build directory, which is kind of
incompatible with the :term:`SSTATE_DIR` and, consequently, with SDKs.
- Only a single U-Boot boot script can be added to the FIT image created by
:ref:`ref-classes-kernel-fit-image`. The boot script is optional.
The boot script is specified in the ITS file as a text file containing
U-Boot commands. When using a boot script the recipe which inherits the
:ref:`ref-classes-kernel-fit-image` class should add the script to
:term:`SRC_URI` and set the :term:`FIT_UBOOT_ENV` variable to the name of the
file like the following::
FIT_UBOOT_ENV = "boot.txt"
SRC_URI += "file://${FIT_UBOOT_ENV}"
At run-time, U-boot's boot command can be configured to load the boot script
from the FIT image and source it.
- The FIT image generated by the :ref:`ref-classes-kernel-fit-image` class is signed when the
variables :term:`UBOOT_SIGN_ENABLE`, :term:`UBOOT_MKIMAGE_DTCOPTS`,
:term:`UBOOT_SIGN_KEYDIR` and :term:`UBOOT_SIGN_KEYNAME` are set
appropriately. The default values used for :term:`FIT_HASH_ALG` and
:term:`FIT_SIGN_ALG` in :ref:`ref-classes-kernel-fit-image` are "sha256" and
"rsa2048" respectively. The keys for signing the FIT image can be generated using
the :ref:`ref-classes-kernel-fit-image` class when both :term:`FIT_GENERATE_KEYS` and
:term:`UBOOT_SIGN_ENABLE` are set to "1".
.. _ref-classes-kernel-fit-extra-artifacts:
``kernel-fit-extra-artifacts``
==============================
The :ref:`ref-classes-kernel-fit-extra-artifacts` class exposes the required
kernel artifacts to the :term:`DEPLOY_DIR_IMAGE` directory.
These artifacts are used by the :ref:`ref-classes-kernel-fit-image` class to
create a FIT image that can include the kernel, device trees, an optional
U-Boot script, and an optional Initramfs.
This class is typically included by adding it to the :term:`KERNEL_CLASSES`
variable in your kernel recipe or machine configuration when building FIT images.
It ensures that all necessary files are available for packaging into the FIT image,
such as the kernel binary, device tree blobs (DTBs), and other related files.
For example, to enable this class, set::
KERNEL_CLASSES += "kernel-fit-extra-artifacts"
This is required when using the :ref:`ref-classes-kernel-fit-image` class to
generate FIT images for your kernel.
.. _ref-classes-kernel-grub: .. _ref-classes-kernel-grub:
@ -3438,7 +3519,7 @@ See U-Boot's documentation for details about `verified boot
and the `signature process and the `signature process
<https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/signature.txt>`__. <https://source.denx.de/u-boot/u-boot/-/blob/master/doc/uImage.FIT/signature.txt>`__.
See also the description of :ref:`ref-classes-kernel-fitimage` class, which this class See also the description of :ref:`ref-classes-kernel-fit-image` class, which this class
imitates. imitates.
.. _ref-classes-uki: .. _ref-classes-uki:

View File

@ -2790,7 +2790,7 @@ system and gives an overview of their function and contents.
``meta/classes-recipe`` to see how the variable is used. ``meta/classes-recipe`` to see how the variable is used.
:term:`EXTERNAL_KERNEL_DEVICETREE` :term:`EXTERNAL_KERNEL_DEVICETREE`
When inheriting :ref:`ref-classes-kernel-fitimage` and a When inheriting :ref:`ref-classes-kernel-fit-image` and a
:term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the
variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a
directory containing one or more compiled device tree or device tree directory containing one or more compiled device tree or device tree
@ -3318,7 +3318,7 @@ system and gives an overview of their function and contents.
Specifies the value of the ``#address-cells`` value for the Specifies the value of the ``#address-cells`` value for the
description of the FIT image. description of the FIT image.
The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` The default value is set to "1" by the :ref:`ref-classes-kernel-fit-image`
class, which corresponds to 32 bit addresses. class, which corresponds to 32 bit addresses.
For platforms that need to set 64 bit addresses, for example in For platforms that need to set 64 bit addresses, for example in
@ -3337,11 +3337,11 @@ system and gives an overview of their function and contents.
Specifies the default device tree binary (dtb) file for a FIT image Specifies the default device tree binary (dtb) file for a FIT image
when multiple ones are provided. when multiple ones are provided.
This variable is used in the :ref:`ref-classes-kernel-fitimage` class. This variable is used in the :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_DESC` :term:`FIT_DESC`
Specifies the description string encoded into a FIT image. The Specifies the description string encoded into a FIT image. The
default value is set by the :ref:`ref-classes-kernel-fitimage` class as default value is set by the :ref:`ref-classes-kernel-fit-image` class as
follows:: follows::
FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}"
@ -3350,12 +3350,12 @@ system and gives an overview of their function and contents.
Decides whether to generate the keys for signing the FIT image if Decides whether to generate the keys for signing the FIT image if
they don't already exist. The keys are created in they don't already exist. The keys are created in
:term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0"
by the :ref:`ref-classes-kernel-fitimage` class. by the :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_HASH_ALG` :term:`FIT_HASH_ALG`
Specifies the hash algorithm used in creating the FIT Image. Specifies the hash algorithm used in creating the FIT Image.
This variable is set by default to "sha256" by the This variable is set by default to "sha256" by the
:ref:`ref-classes-kernel-fitimage` class. :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_KERNEL_COMP_ALG` :term:`FIT_KERNEL_COMP_ALG`
The compression algorithm to use for the kernel image inside the FIT Image. The compression algorithm to use for the kernel image inside the FIT Image.
@ -3374,31 +3374,31 @@ system and gives an overview of their function and contents.
:term:`FIT_KEY_GENRSA_ARGS` :term:`FIT_KEY_GENRSA_ARGS`
Arguments to ``openssl genrsa`` for generating a RSA private key for Arguments to ``openssl genrsa`` for generating a RSA private key for
signing the FIT image. The default value is set to "-F4" by the signing the FIT image. The default value is set to "-F4" by the
:ref:`ref-classes-kernel-fitimage` class. :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_KEY_REQ_ARGS` :term:`FIT_KEY_REQ_ARGS`
Arguments to ``openssl req`` for generating a certificate for signing Arguments to ``openssl req`` for generating a certificate for signing
the FIT image. The default value is "-batch -new" by the the FIT image. The default value is "-batch -new" by the
:ref:`ref-classes-kernel-fitimage` class, "batch" for :ref:`ref-classes-kernel-fit-image` class, "batch" for
non interactive mode and "new" for generating new keys. non interactive mode and "new" for generating new keys.
:term:`FIT_KEY_SIGN_PKCS` :term:`FIT_KEY_SIGN_PKCS`
Format for the public key certificate used for signing the FIT image. Format for the public key certificate used for signing the FIT image.
The default value is set to "x509" by the The default value is set to "x509" by the
:ref:`ref-classes-kernel-fitimage` class. :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_SIGN_ALG` :term:`FIT_SIGN_ALG`
Specifies the signature algorithm used in creating the FIT Image. Specifies the signature algorithm used in creating the FIT Image.
This variable is set by default to "rsa2048" by the This variable is set by default to "rsa2048" by the
:ref:`ref-classes-kernel-fitimage` class. :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_PAD_ALG` :term:`FIT_PAD_ALG`
Specifies the padding algorithm used in creating the FIT Image. Specifies the padding algorithm used in creating the FIT Image.
The default value is set to "pkcs-1.5" by the The default value is set to "pkcs-1.5" by the
:ref:`ref-classes-kernel-fitimage` class. :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_SIGN_INDIVIDUAL` :term:`FIT_SIGN_INDIVIDUAL`
If set to "1", the :ref:`ref-classes-kernel-fitimage` class signs each If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each
image node individually, including the kernel, DTB, RAM disk, and any image node individually, including the kernel, DTB, RAM disk, and any
other image types present in the FIT image, in addition to signing the other image types present in the FIT image, in addition to signing the
configuration nodes. configuration nodes.
@ -3431,13 +3431,13 @@ system and gives an overview of their function and contents.
:term:`FIT_SIGN_NUMBITS` :term:`FIT_SIGN_NUMBITS`
Size of the private key used in the FIT image, in number of bits. Size of the private key used in the FIT image, in number of bits.
The default value for this variable is set to "2048" The default value for this variable is set to "2048"
by the :ref:`ref-classes-kernel-fitimage` class. by the :ref:`ref-classes-kernel-fit-image` class.
:term:`FIT_UBOOT_ENV` :term:`FIT_UBOOT_ENV`
This variable allows to add a U-Boot script as a text file to the This variable allows to add a U-Boot script as a text file to the
FIT image. Such a script can be sourced from the U-Boot shell. FIT image. Such a script can be sourced from the U-Boot shell.
When inheriting the :ref:`ref-classes-kernel-fitimage` class a When inheriting the :ref:`ref-classes-kernel-fit-image` class a
script file should be included in the :term:`SRC_URI` of the Linux script file should be included in the :term:`SRC_URI` of the Linux
kernel recipe. kernel recipe.
@ -5075,9 +5075,7 @@ system and gives an overview of their function and contents.
:term:`KERNEL_CLASSES` :term:`KERNEL_CLASSES`
A list of classes defining kernel image types that the A list of classes defining kernel image types that the
:ref:`ref-classes-kernel` class should inherit. You typically :ref:`ref-classes-kernel` class should inherit. You typically
append this variable to enable extended image types. An example is append this variable to enable extended image types.
":ref:`ref-classes-kernel-fitimage`", which enables
FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``.
You can register custom kernel image types with the You can register custom kernel image types with the
:ref:`ref-classes-kernel` class using this variable. :ref:`ref-classes-kernel` class using this variable.
@ -10321,13 +10319,13 @@ system and gives an overview of their function and contents.
:term:`UBOOT_DTB_LOADADDRESS` :term:`UBOOT_DTB_LOADADDRESS`
Specifies the load address for the dtb image used by U-Boot. During FIT Specifies the load address for the dtb image used by U-Boot. During FIT
image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in
:ref:`ref-classes-kernel-fitimage` class to specify the load address to be :ref:`ref-classes-kernel-fit-image` class to specify the load address to be
used in creating the dtb sections of Image Tree Source for the FIT image. used in creating the dtb sections of Image Tree Source for the FIT image.
:term:`UBOOT_DTBO_LOADADDRESS` :term:`UBOOT_DTBO_LOADADDRESS`
Specifies the load address for the dtbo image used by U-Boot. During FIT Specifies the load address for the dtbo image used by U-Boot. During FIT
image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in
:ref:`ref-classes-kernel-fitimage` class to specify the load address to be :ref:`ref-classes-kernel-fit-image` class to specify the load address to be
used in creating the dtbo sections of Image Tree Source for the FIT image. used in creating the dtbo sections of Image Tree Source for the FIT image.
:term:`UBOOT_ENTRYPOINT` :term:`UBOOT_ENTRYPOINT`
@ -10339,7 +10337,7 @@ system and gives an overview of their function and contents.
- The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
- The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
This variable is used by the :ref:`ref-classes-kernel-fitimage`, This variable is used by the :ref:`ref-classes-kernel-fit-image`,
:ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
:ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
classes. classes.
@ -10616,7 +10614,7 @@ system and gives an overview of their function and contents.
- The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
- The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
This variable is used by the :ref:`ref-classes-kernel-fitimage`, This variable is used by the :ref:`ref-classes-kernel-fit-image`,
:ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
:ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
classes. classes.
@ -10644,15 +10642,15 @@ system and gives an overview of their function and contents.
:term:`UBOOT_MKIMAGE` :term:`UBOOT_MKIMAGE`
Specifies the name of the mkimage command as used by the Specifies the name of the mkimage command as used by the
:ref:`ref-classes-kernel-fitimage` class to assemble :ref:`ref-classes-kernel-fit-image` class to assemble
the FIT image. This can be used to substitute an alternative command, wrapper the FIT image. This can be used to substitute an alternative command, wrapper
script or function if desired. The default is "uboot-mkimage". script or function if desired. The default is "uboot-mkimage".
:term:`UBOOT_MKIMAGE_DTCOPTS` :term:`UBOOT_MKIMAGE_DTCOPTS`
Options for the device tree compiler passed to ``mkimage -D`` feature Options for the device tree compiler passed to ``mkimage -D`` feature
while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` while creating a FIT image with the :ref:`ref-classes-kernel-fit-image`
class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the
:ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option
to ``mkimage``. to ``mkimage``.
This variable is also used by the :ref:`ref-classes-uboot-sign` class. This variable is also used by the :ref:`ref-classes-uboot-sign` class.
@ -10663,42 +10661,42 @@ system and gives an overview of their function and contents.
:term:`UBOOT_MKIMAGE_SIGN` :term:`UBOOT_MKIMAGE_SIGN`
Specifies the name of the mkimage command as used by the Specifies the name of the mkimage command as used by the
:ref:`ref-classes-kernel-fitimage` class to sign :ref:`ref-classes-kernel-fit-image` class to sign
the FIT image after it has been assembled (if enabled). This can be used the FIT image after it has been assembled (if enabled). This can be used
to substitute an alternative command, wrapper script or function if to substitute an alternative command, wrapper script or function if
desired. The default is "${:term:`UBOOT_MKIMAGE`}". desired. The default is "${:term:`UBOOT_MKIMAGE`}".
:term:`UBOOT_MKIMAGE_SIGN_ARGS` :term:`UBOOT_MKIMAGE_SIGN_ARGS`
Optionally specifies additional arguments for the Optionally specifies additional arguments for the
:ref:`ref-classes-kernel-fitimage` class to pass to the :ref:`ref-classes-kernel-fit-image` class to pass to the
mkimage command when signing the FIT image. mkimage command when signing the FIT image.
:term:`UBOOT_RD_ENTRYPOINT` :term:`UBOOT_RD_ENTRYPOINT`
Specifies the entrypoint for the RAM disk image. During FIT image Specifies the entrypoint for the RAM disk image. During FIT image
creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in
:ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be :ref:`ref-classes-kernel-fit-image` class to specify the entrypoint to be
used in creating the Image Tree Source for the FIT image. used in creating the Image Tree Source for the FIT image.
:term:`UBOOT_RD_LOADADDRESS` :term:`UBOOT_RD_LOADADDRESS`
Specifies the load address for the RAM disk image. During FIT image Specifies the load address for the RAM disk image. During FIT image
creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in
:ref:`ref-classes-kernel-fitimage` class to specify the load address to :ref:`ref-classes-kernel-fit-image` class to specify the load address to
be used in creating the Image Tree Source for the FIT image. be used in creating the Image Tree Source for the FIT image.
:term:`UBOOT_SIGN_ENABLE` :term:`UBOOT_SIGN_ENABLE`
Enable signing of FIT image. The default value is "0". Enable signing of FIT image. The default value is "0".
This variable is used by the :ref:`ref-classes-kernel-fitimage`, This variable is used by the :ref:`ref-classes-kernel-fit-image`,
:ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
classes. classes.
:term:`UBOOT_SIGN_KEYDIR` :term:`UBOOT_SIGN_KEYDIR`
Location of the directory containing the RSA key and certificate used for Location of the directory containing the RSA key and certificate used for
signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and
:ref:`ref-classes-uboot-sign` classes. :ref:`ref-classes-uboot-sign` classes.
:term:`UBOOT_SIGN_KEYNAME` :term:`UBOOT_SIGN_KEYNAME`
The name of keys used by the :ref:`ref-classes-kernel-fitimage` class The name of keys used by the :ref:`ref-classes-kernel-fit-image` class
for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR`
directory. If we have for example a ``dev.key`` key and a ``dev.crt`` directory. If we have for example a ``dev.key`` key and a ``dev.crt``
certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will