From 7a01d262a19c472bfebfa1aa314d5b910c9977bd Mon Sep 17 00:00:00 2001 From: Adrian Freihofer Date: Mon, 16 Jun 2025 22:36:47 +0200 Subject: ref-manual: replace kernel-fitimage by kernel-fit-image (From yocto-docs rev: 93c92dd2837708ba00a4ca47667e60d7bb09430b) Signed-off-by: Adrian Freihofer Signed-off-by: Antonin Godard Signed-off-by: Richard Purdie --- documentation/ref-manual/variables.rst | 60 ++++++++++++++++------------------ 1 file changed, 29 insertions(+), 31 deletions(-) (limited to 'documentation/ref-manual/variables.rst') diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 5c18b852d1..fd14274a13 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2790,7 +2790,7 @@ system and gives an overview of their function and contents. ``meta/classes-recipe`` to see how the variable is used. :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 variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a 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 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. 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 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` 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:: 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 they don't already exist. The keys are created in :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` Specifies the hash algorithm used in creating the FIT Image. 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` 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` Arguments to ``openssl genrsa`` for generating a RSA private key for 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` Arguments to ``openssl req`` for generating a certificate for signing 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. :term:`FIT_KEY_SIGN_PKCS` Format for the public key certificate used for signing the FIT image. 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` Specifies the signature algorithm used in creating the FIT Image. 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` Specifies the padding algorithm used in creating the FIT Image. 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` - 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 other image types present in the FIT image, in addition to signing the configuration nodes. @@ -3431,13 +3431,13 @@ system and gives an overview of their function and contents. :term:`FIT_SIGN_NUMBITS` Size of the private key used in the FIT image, in number of bits. 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` 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. - 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 kernel recipe. @@ -5075,9 +5075,7 @@ system and gives an overview of their function and contents. :term:`KERNEL_CLASSES` A list of classes defining kernel image types that the :ref:`ref-classes-kernel` class should inherit. You typically - append this variable to enable extended image types. An example is - ":ref:`ref-classes-kernel-fitimage`", which enables - FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. + append this variable to enable extended image types. You can register custom kernel image types with the :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` 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 - :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. :term:`UBOOT_DTBO_LOADADDRESS` 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 - :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. :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:`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-uboot-config` and :ref:`ref-classes-uboot-sign` 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:`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-uboot-config` and :ref:`ref-classes-uboot-sign` classes. @@ -10644,15 +10642,15 @@ system and gives an overview of their function and contents. :term:`UBOOT_MKIMAGE` 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 script or function if desired. The default is "uboot-mkimage". :term:`UBOOT_MKIMAGE_DTCOPTS` 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 - :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``. 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` 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 to substitute an alternative command, wrapper script or function if desired. The default is "${:term:`UBOOT_MKIMAGE`}". :term:`UBOOT_MKIMAGE_SIGN_ARGS` 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. :term:`UBOOT_RD_ENTRYPOINT` Specifies the entrypoint for the RAM disk image. During FIT image 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. :term:`UBOOT_RD_LOADADDRESS` Specifies the load address for the RAM disk image. During FIT image 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. :term:`UBOOT_SIGN_ENABLE` 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` classes. :term:`UBOOT_SIGN_KEYDIR` 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. :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` 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 -- cgit v1.2.3-54-g00ecf