diff options
author | Adrian Freihofer <adrian.freihofer@siemens.com> | 2025-06-16 22:36:47 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2025-06-20 09:48:14 +0100 |
commit | 7a01d262a19c472bfebfa1aa314d5b910c9977bd (patch) | |
tree | fb3886f508ebd65acdcf46507798e93f352a3cb0 /documentation/ref-manual/variables.rst | |
parent | 474742f808378f6d577feaff8e56b3ccbaaee726 (diff) | |
download | poky-7a01d262a19c472bfebfa1aa314d5b910c9977bd.tar.gz |
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>
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r-- | documentation/ref-manual/variables.rst | 60 |
1 files changed, 29 insertions, 31 deletions
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. | |||
2790 | ``meta/classes-recipe`` to see how the variable is used. | 2790 | ``meta/classes-recipe`` to see how the variable is used. |
2791 | 2791 | ||
2792 | :term:`EXTERNAL_KERNEL_DEVICETREE` | 2792 | :term:`EXTERNAL_KERNEL_DEVICETREE` |
2793 | When inheriting :ref:`ref-classes-kernel-fitimage` and a | 2793 | When inheriting :ref:`ref-classes-kernel-fit-image` and a |
2794 | :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the | 2794 | :term:`PREFERRED_PROVIDER` for ``virtual/dtb`` set to ``devicetree``, the |
2795 | variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a | 2795 | variable :term:`EXTERNAL_KERNEL_DEVICETREE` can be used to specify a |
2796 | directory containing one or more compiled device tree or device tree | 2796 | 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. | |||
3318 | Specifies the value of the ``#address-cells`` value for the | 3318 | Specifies the value of the ``#address-cells`` value for the |
3319 | description of the FIT image. | 3319 | description of the FIT image. |
3320 | 3320 | ||
3321 | The default value is set to "1" by the :ref:`ref-classes-kernel-fitimage` | 3321 | The default value is set to "1" by the :ref:`ref-classes-kernel-fit-image` |
3322 | class, which corresponds to 32 bit addresses. | 3322 | class, which corresponds to 32 bit addresses. |
3323 | 3323 | ||
3324 | For platforms that need to set 64 bit addresses, for example in | 3324 | 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. | |||
3337 | Specifies the default device tree binary (dtb) file for a FIT image | 3337 | Specifies the default device tree binary (dtb) file for a FIT image |
3338 | when multiple ones are provided. | 3338 | when multiple ones are provided. |
3339 | 3339 | ||
3340 | This variable is used in the :ref:`ref-classes-kernel-fitimage` class. | 3340 | This variable is used in the :ref:`ref-classes-kernel-fit-image` class. |
3341 | 3341 | ||
3342 | :term:`FIT_DESC` | 3342 | :term:`FIT_DESC` |
3343 | Specifies the description string encoded into a FIT image. The | 3343 | Specifies the description string encoded into a FIT image. The |
3344 | default value is set by the :ref:`ref-classes-kernel-fitimage` class as | 3344 | default value is set by the :ref:`ref-classes-kernel-fit-image` class as |
3345 | follows:: | 3345 | follows:: |
3346 | 3346 | ||
3347 | FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" | 3347 | FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" |
@@ -3350,12 +3350,12 @@ system and gives an overview of their function and contents. | |||
3350 | Decides whether to generate the keys for signing the FIT image if | 3350 | Decides whether to generate the keys for signing the FIT image if |
3351 | they don't already exist. The keys are created in | 3351 | they don't already exist. The keys are created in |
3352 | :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" | 3352 | :term:`UBOOT_SIGN_KEYDIR`. The default value is set to "0" |
3353 | by the :ref:`ref-classes-kernel-fitimage` class. | 3353 | by the :ref:`ref-classes-kernel-fit-image` class. |
3354 | 3354 | ||
3355 | :term:`FIT_HASH_ALG` | 3355 | :term:`FIT_HASH_ALG` |
3356 | Specifies the hash algorithm used in creating the FIT Image. | 3356 | Specifies the hash algorithm used in creating the FIT Image. |
3357 | This variable is set by default to "sha256" by the | 3357 | This variable is set by default to "sha256" by the |
3358 | :ref:`ref-classes-kernel-fitimage` class. | 3358 | :ref:`ref-classes-kernel-fit-image` class. |
3359 | 3359 | ||
3360 | :term:`FIT_KERNEL_COMP_ALG` | 3360 | :term:`FIT_KERNEL_COMP_ALG` |
3361 | The compression algorithm to use for the kernel image inside the FIT Image. | 3361 | 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. | |||
3374 | :term:`FIT_KEY_GENRSA_ARGS` | 3374 | :term:`FIT_KEY_GENRSA_ARGS` |
3375 | Arguments to ``openssl genrsa`` for generating a RSA private key for | 3375 | Arguments to ``openssl genrsa`` for generating a RSA private key for |
3376 | signing the FIT image. The default value is set to "-F4" by the | 3376 | signing the FIT image. The default value is set to "-F4" by the |
3377 | :ref:`ref-classes-kernel-fitimage` class. | 3377 | :ref:`ref-classes-kernel-fit-image` class. |
3378 | 3378 | ||
3379 | :term:`FIT_KEY_REQ_ARGS` | 3379 | :term:`FIT_KEY_REQ_ARGS` |
3380 | Arguments to ``openssl req`` for generating a certificate for signing | 3380 | Arguments to ``openssl req`` for generating a certificate for signing |
3381 | the FIT image. The default value is "-batch -new" by the | 3381 | the FIT image. The default value is "-batch -new" by the |
3382 | :ref:`ref-classes-kernel-fitimage` class, "batch" for | 3382 | :ref:`ref-classes-kernel-fit-image` class, "batch" for |
3383 | non interactive mode and "new" for generating new keys. | 3383 | non interactive mode and "new" for generating new keys. |
3384 | 3384 | ||
3385 | :term:`FIT_KEY_SIGN_PKCS` | 3385 | :term:`FIT_KEY_SIGN_PKCS` |
3386 | Format for the public key certificate used for signing the FIT image. | 3386 | Format for the public key certificate used for signing the FIT image. |
3387 | The default value is set to "x509" by the | 3387 | The default value is set to "x509" by the |
3388 | :ref:`ref-classes-kernel-fitimage` class. | 3388 | :ref:`ref-classes-kernel-fit-image` class. |
3389 | 3389 | ||
3390 | :term:`FIT_SIGN_ALG` | 3390 | :term:`FIT_SIGN_ALG` |
3391 | Specifies the signature algorithm used in creating the FIT Image. | 3391 | Specifies the signature algorithm used in creating the FIT Image. |
3392 | This variable is set by default to "rsa2048" by the | 3392 | This variable is set by default to "rsa2048" by the |
3393 | :ref:`ref-classes-kernel-fitimage` class. | 3393 | :ref:`ref-classes-kernel-fit-image` class. |
3394 | 3394 | ||
3395 | :term:`FIT_PAD_ALG` | 3395 | :term:`FIT_PAD_ALG` |
3396 | Specifies the padding algorithm used in creating the FIT Image. | 3396 | Specifies the padding algorithm used in creating the FIT Image. |
3397 | The default value is set to "pkcs-1.5" by the | 3397 | The default value is set to "pkcs-1.5" by the |
3398 | :ref:`ref-classes-kernel-fitimage` class. | 3398 | :ref:`ref-classes-kernel-fit-image` class. |
3399 | 3399 | ||
3400 | :term:`FIT_SIGN_INDIVIDUAL` | 3400 | :term:`FIT_SIGN_INDIVIDUAL` |
3401 | If set to "1", the :ref:`ref-classes-kernel-fitimage` class signs each | 3401 | If set to "1", the :ref:`ref-classes-kernel-fit-image` class signs each |
3402 | image node individually, including the kernel, DTB, RAM disk, and any | 3402 | image node individually, including the kernel, DTB, RAM disk, and any |
3403 | other image types present in the FIT image, in addition to signing the | 3403 | other image types present in the FIT image, in addition to signing the |
3404 | configuration nodes. | 3404 | configuration nodes. |
@@ -3431,13 +3431,13 @@ system and gives an overview of their function and contents. | |||
3431 | :term:`FIT_SIGN_NUMBITS` | 3431 | :term:`FIT_SIGN_NUMBITS` |
3432 | Size of the private key used in the FIT image, in number of bits. | 3432 | Size of the private key used in the FIT image, in number of bits. |
3433 | The default value for this variable is set to "2048" | 3433 | The default value for this variable is set to "2048" |
3434 | by the :ref:`ref-classes-kernel-fitimage` class. | 3434 | by the :ref:`ref-classes-kernel-fit-image` class. |
3435 | 3435 | ||
3436 | :term:`FIT_UBOOT_ENV` | 3436 | :term:`FIT_UBOOT_ENV` |
3437 | This variable allows to add a U-Boot script as a text file to the | 3437 | This variable allows to add a U-Boot script as a text file to the |
3438 | FIT image. Such a script can be sourced from the U-Boot shell. | 3438 | FIT image. Such a script can be sourced from the U-Boot shell. |
3439 | 3439 | ||
3440 | When inheriting the :ref:`ref-classes-kernel-fitimage` class a | 3440 | When inheriting the :ref:`ref-classes-kernel-fit-image` class a |
3441 | script file should be included in the :term:`SRC_URI` of the Linux | 3441 | script file should be included in the :term:`SRC_URI` of the Linux |
3442 | kernel recipe. | 3442 | kernel recipe. |
3443 | 3443 | ||
@@ -5075,9 +5075,7 @@ system and gives an overview of their function and contents. | |||
5075 | :term:`KERNEL_CLASSES` | 5075 | :term:`KERNEL_CLASSES` |
5076 | A list of classes defining kernel image types that the | 5076 | A list of classes defining kernel image types that the |
5077 | :ref:`ref-classes-kernel` class should inherit. You typically | 5077 | :ref:`ref-classes-kernel` class should inherit. You typically |
5078 | append this variable to enable extended image types. An example is | 5078 | append this variable to enable extended image types. |
5079 | ":ref:`ref-classes-kernel-fitimage`", which enables | ||
5080 | FIT image support and resides in ``meta/classes-recipe/kernel-fitimage.bbclass``. | ||
5081 | You can register custom kernel image types with the | 5079 | You can register custom kernel image types with the |
5082 | :ref:`ref-classes-kernel` class using this variable. | 5080 | :ref:`ref-classes-kernel` class using this variable. |
5083 | 5081 | ||
@@ -10321,13 +10319,13 @@ system and gives an overview of their function and contents. | |||
10321 | :term:`UBOOT_DTB_LOADADDRESS` | 10319 | :term:`UBOOT_DTB_LOADADDRESS` |
10322 | Specifies the load address for the dtb image used by U-Boot. During FIT | 10320 | Specifies the load address for the dtb image used by U-Boot. During FIT |
10323 | image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in | 10321 | image creation, the :term:`UBOOT_DTB_LOADADDRESS` variable is used in |
10324 | :ref:`ref-classes-kernel-fitimage` class to specify the load address to be | 10322 | :ref:`ref-classes-kernel-fit-image` class to specify the load address to be |
10325 | used in creating the dtb sections of Image Tree Source for the FIT image. | 10323 | used in creating the dtb sections of Image Tree Source for the FIT image. |
10326 | 10324 | ||
10327 | :term:`UBOOT_DTBO_LOADADDRESS` | 10325 | :term:`UBOOT_DTBO_LOADADDRESS` |
10328 | Specifies the load address for the dtbo image used by U-Boot. During FIT | 10326 | Specifies the load address for the dtbo image used by U-Boot. During FIT |
10329 | image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in | 10327 | image creation, the :term:`UBOOT_DTBO_LOADADDRESS` variable is used in |
10330 | :ref:`ref-classes-kernel-fitimage` class to specify the load address to be | 10328 | :ref:`ref-classes-kernel-fit-image` class to specify the load address to be |
10331 | used in creating the dtbo sections of Image Tree Source for the FIT image. | 10329 | used in creating the dtbo sections of Image Tree Source for the FIT image. |
10332 | 10330 | ||
10333 | :term:`UBOOT_ENTRYPOINT` | 10331 | :term:`UBOOT_ENTRYPOINT` |
@@ -10339,7 +10337,7 @@ system and gives an overview of their function and contents. | |||
10339 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. | 10337 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. |
10340 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. | 10338 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. |
10341 | 10339 | ||
10342 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10340 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10343 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, | 10341 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, |
10344 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10342 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10345 | classes. | 10343 | classes. |
@@ -10616,7 +10614,7 @@ system and gives an overview of their function and contents. | |||
10616 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. | 10614 | - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. |
10617 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. | 10615 | - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. |
10618 | 10616 | ||
10619 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10617 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10620 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, | 10618 | :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, |
10621 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10619 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10622 | classes. | 10620 | classes. |
@@ -10644,15 +10642,15 @@ system and gives an overview of their function and contents. | |||
10644 | 10642 | ||
10645 | :term:`UBOOT_MKIMAGE` | 10643 | :term:`UBOOT_MKIMAGE` |
10646 | Specifies the name of the mkimage command as used by the | 10644 | Specifies the name of the mkimage command as used by the |
10647 | :ref:`ref-classes-kernel-fitimage` class to assemble | 10645 | :ref:`ref-classes-kernel-fit-image` class to assemble |
10648 | the FIT image. This can be used to substitute an alternative command, wrapper | 10646 | the FIT image. This can be used to substitute an alternative command, wrapper |
10649 | script or function if desired. The default is "uboot-mkimage". | 10647 | script or function if desired. The default is "uboot-mkimage". |
10650 | 10648 | ||
10651 | :term:`UBOOT_MKIMAGE_DTCOPTS` | 10649 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
10652 | Options for the device tree compiler passed to ``mkimage -D`` feature | 10650 | Options for the device tree compiler passed to ``mkimage -D`` feature |
10653 | while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` | 10651 | while creating a FIT image with the :ref:`ref-classes-kernel-fit-image` |
10654 | class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the | 10652 | class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the |
10655 | :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option | 10653 | :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option |
10656 | to ``mkimage``. | 10654 | to ``mkimage``. |
10657 | 10655 | ||
10658 | This variable is also used by the :ref:`ref-classes-uboot-sign` class. | 10656 | 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. | |||
10663 | 10661 | ||
10664 | :term:`UBOOT_MKIMAGE_SIGN` | 10662 | :term:`UBOOT_MKIMAGE_SIGN` |
10665 | Specifies the name of the mkimage command as used by the | 10663 | Specifies the name of the mkimage command as used by the |
10666 | :ref:`ref-classes-kernel-fitimage` class to sign | 10664 | :ref:`ref-classes-kernel-fit-image` class to sign |
10667 | the FIT image after it has been assembled (if enabled). This can be used | 10665 | the FIT image after it has been assembled (if enabled). This can be used |
10668 | to substitute an alternative command, wrapper script or function if | 10666 | to substitute an alternative command, wrapper script or function if |
10669 | desired. The default is "${:term:`UBOOT_MKIMAGE`}". | 10667 | desired. The default is "${:term:`UBOOT_MKIMAGE`}". |
10670 | 10668 | ||
10671 | :term:`UBOOT_MKIMAGE_SIGN_ARGS` | 10669 | :term:`UBOOT_MKIMAGE_SIGN_ARGS` |
10672 | Optionally specifies additional arguments for the | 10670 | Optionally specifies additional arguments for the |
10673 | :ref:`ref-classes-kernel-fitimage` class to pass to the | 10671 | :ref:`ref-classes-kernel-fit-image` class to pass to the |
10674 | mkimage command when signing the FIT image. | 10672 | mkimage command when signing the FIT image. |
10675 | 10673 | ||
10676 | :term:`UBOOT_RD_ENTRYPOINT` | 10674 | :term:`UBOOT_RD_ENTRYPOINT` |
10677 | Specifies the entrypoint for the RAM disk image. During FIT image | 10675 | Specifies the entrypoint for the RAM disk image. During FIT image |
10678 | creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in | 10676 | creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in |
10679 | :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be | 10677 | :ref:`ref-classes-kernel-fit-image` class to specify the entrypoint to be |
10680 | used in creating the Image Tree Source for the FIT image. | 10678 | used in creating the Image Tree Source for the FIT image. |
10681 | 10679 | ||
10682 | :term:`UBOOT_RD_LOADADDRESS` | 10680 | :term:`UBOOT_RD_LOADADDRESS` |
10683 | Specifies the load address for the RAM disk image. During FIT image | 10681 | Specifies the load address for the RAM disk image. During FIT image |
10684 | creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in | 10682 | creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in |
10685 | :ref:`ref-classes-kernel-fitimage` class to specify the load address to | 10683 | :ref:`ref-classes-kernel-fit-image` class to specify the load address to |
10686 | be used in creating the Image Tree Source for the FIT image. | 10684 | be used in creating the Image Tree Source for the FIT image. |
10687 | 10685 | ||
10688 | :term:`UBOOT_SIGN_ENABLE` | 10686 | :term:`UBOOT_SIGN_ENABLE` |
10689 | Enable signing of FIT image. The default value is "0". | 10687 | Enable signing of FIT image. The default value is "0". |
10690 | 10688 | ||
10691 | This variable is used by the :ref:`ref-classes-kernel-fitimage`, | 10689 | This variable is used by the :ref:`ref-classes-kernel-fit-image`, |
10692 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` | 10690 | :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` |
10693 | classes. | 10691 | classes. |
10694 | 10692 | ||
10695 | :term:`UBOOT_SIGN_KEYDIR` | 10693 | :term:`UBOOT_SIGN_KEYDIR` |
10696 | Location of the directory containing the RSA key and certificate used for | 10694 | Location of the directory containing the RSA key and certificate used for |
10697 | signing FIT image, used by the :ref:`ref-classes-kernel-fitimage` and | 10695 | signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and |
10698 | :ref:`ref-classes-uboot-sign` classes. | 10696 | :ref:`ref-classes-uboot-sign` classes. |
10699 | 10697 | ||
10700 | :term:`UBOOT_SIGN_KEYNAME` | 10698 | :term:`UBOOT_SIGN_KEYNAME` |
10701 | The name of keys used by the :ref:`ref-classes-kernel-fitimage` class | 10699 | The name of keys used by the :ref:`ref-classes-kernel-fit-image` class |
10702 | for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` | 10700 | for signing U-Boot FIT image stored in the :term:`UBOOT_SIGN_KEYDIR` |
10703 | directory. If we have for example a ``dev.key`` key and a ``dev.crt`` | 10701 | directory. If we have for example a ``dev.key`` key and a ``dev.crt`` |
10704 | certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will | 10702 | certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will |