summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/variables.rst
diff options
context:
space:
mode:
Diffstat (limited to 'documentation/ref-manual/variables.rst')
-rw-r--r--documentation/ref-manual/variables.rst84
1 files changed, 52 insertions, 32 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index 5c18b852d1..c6ae3fb8bc 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -2576,7 +2576,7 @@ system and gives an overview of their function and contents.
2576 You can safely share this directory between multiple builds on the 2576 You can safely share this directory between multiple builds on the
2577 same development machine. For additional information on how the build 2577 same development machine. For additional information on how the build
2578 process gets source files when working behind a firewall or proxy 2578 process gets source files when working behind a firewall or proxy
2579 server, see this specific question in the ":doc:`faq`" 2579 server, see this specific question in the ":doc:`/ref-manual/faq`"
2580 chapter. You can also refer to the 2580 chapter. You can also refer to the
2581 ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`" 2581 ":yocto_wiki:`Working Behind a Network Proxy </Working_Behind_a_Network_Proxy>`"
2582 Wiki page. 2582 Wiki page.
@@ -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
@@ -8764,6 +8762,28 @@ system and gives an overview of their function and contents.
8764 image), compared to just using the :ref:`ref-classes-create-spdx` class 8762 image), compared to just using the :ref:`ref-classes-create-spdx` class
8765 with no option. 8763 with no option.
8766 8764
8765 :term:`SPDX_INCLUDE_COMPILED_SOURCES`
8766 This option allows the same as :term:`SPDX_INCLUDE_SOURCES` but including
8767 only the sources used to compile the host tools and the target packages.
8768 While :term:`SPDX_INCLUDE_SOURCES` includes all files in the source
8769 directory as source file descriptions, :term:`SPDX_INCLUDE_COMPILED_SOURCES`
8770 includes only the sources that are used to produce the binaries delivered
8771 as packages. The source files that are not used during compilation are not
8772 included in the SBOM. It uses debugsource information generated during
8773 ``do_package`` to filter out source files.
8774
8775 This enables an external tool to use the SPDX information to disregard
8776 vulnerabilities that are not compiled in the packages.
8777
8778 Enable this option as follows::
8779
8780 SPDX_INCLUDE_COMPILED_SOURCES = "1"
8781
8782 According to our tests, building ``core-image-minimal`` for the
8783 ``qemux86-64`` machine, enabling this option compared with the
8784 :term:`SPDX_INCLUDE_SOURCES` reduces the size of the ``tmp/deploy/spdx``
8785 directory from 2GB to 1.6GB.
8786
8767 :term:`SPDX_NAMESPACE_PREFIX` 8787 :term:`SPDX_NAMESPACE_PREFIX`
8768 This option could be used in order to change the prefix of ``spdxDocument`` 8788 This option could be used in order to change the prefix of ``spdxDocument``
8769 and the prefix of ``documentNamespace``. It is set by default to 8789 and the prefix of ``documentNamespace``. It is set by default to
@@ -10321,13 +10341,13 @@ system and gives an overview of their function and contents.
10321 :term:`UBOOT_DTB_LOADADDRESS` 10341 :term:`UBOOT_DTB_LOADADDRESS`
10322 Specifies the load address for the dtb image used by U-Boot. During FIT 10342 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 10343 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 10344 :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. 10345 used in creating the dtb sections of Image Tree Source for the FIT image.
10326 10346
10327 :term:`UBOOT_DTBO_LOADADDRESS` 10347 :term:`UBOOT_DTBO_LOADADDRESS`
10328 Specifies the load address for the dtbo image used by U-Boot. During FIT 10348 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 10349 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 10350 :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. 10351 used in creating the dtbo sections of Image Tree Source for the FIT image.
10332 10352
10333 :term:`UBOOT_ENTRYPOINT` 10353 :term:`UBOOT_ENTRYPOINT`
@@ -10339,7 +10359,7 @@ system and gives an overview of their function and contents.
10339 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. 10359 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
10340 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. 10360 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
10341 10361
10342 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10362 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10343 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, 10363 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
10344 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10364 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10345 classes. 10365 classes.
@@ -10616,7 +10636,7 @@ system and gives an overview of their function and contents.
10616 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation. 10636 - The :term:`FIT_ADDRESS_CELLS` variable for FIT image creation.
10617 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation. 10637 - The :term:`UBOOT_FIT_ADDRESS_CELLS` variable for U-Boot FIT image creation.
10618 10638
10619 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10639 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10620 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`, 10640 :ref:`ref-classes-kernel-uimage`, :ref:`ref-classes-kernel`,
10621 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10641 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10622 classes. 10642 classes.
@@ -10644,15 +10664,15 @@ system and gives an overview of their function and contents.
10644 10664
10645 :term:`UBOOT_MKIMAGE` 10665 :term:`UBOOT_MKIMAGE`
10646 Specifies the name of the mkimage command as used by the 10666 Specifies the name of the mkimage command as used by the
10647 :ref:`ref-classes-kernel-fitimage` class to assemble 10667 :ref:`ref-classes-kernel-fit-image` class to assemble
10648 the FIT image. This can be used to substitute an alternative command, wrapper 10668 the FIT image. This can be used to substitute an alternative command, wrapper
10649 script or function if desired. The default is "uboot-mkimage". 10669 script or function if desired. The default is "uboot-mkimage".
10650 10670
10651 :term:`UBOOT_MKIMAGE_DTCOPTS` 10671 :term:`UBOOT_MKIMAGE_DTCOPTS`
10652 Options for the device tree compiler passed to ``mkimage -D`` feature 10672 Options for the device tree compiler passed to ``mkimage -D`` feature
10653 while creating a FIT image with the :ref:`ref-classes-kernel-fitimage` 10673 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 10674 class. If :term:`UBOOT_MKIMAGE_DTCOPTS` is not set then the
10655 :ref:`ref-classes-kernel-fitimage` class will not pass the ``-D`` option 10675 :ref:`ref-classes-kernel-fit-image` class will not pass the ``-D`` option
10656 to ``mkimage``. 10676 to ``mkimage``.
10657 10677
10658 This variable is also used by the :ref:`ref-classes-uboot-sign` class. 10678 This variable is also used by the :ref:`ref-classes-uboot-sign` class.
@@ -10663,42 +10683,42 @@ system and gives an overview of their function and contents.
10663 10683
10664 :term:`UBOOT_MKIMAGE_SIGN` 10684 :term:`UBOOT_MKIMAGE_SIGN`
10665 Specifies the name of the mkimage command as used by the 10685 Specifies the name of the mkimage command as used by the
10666 :ref:`ref-classes-kernel-fitimage` class to sign 10686 :ref:`ref-classes-kernel-fit-image` class to sign
10667 the FIT image after it has been assembled (if enabled). This can be used 10687 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 10688 to substitute an alternative command, wrapper script or function if
10669 desired. The default is "${:term:`UBOOT_MKIMAGE`}". 10689 desired. The default is "${:term:`UBOOT_MKIMAGE`}".
10670 10690
10671 :term:`UBOOT_MKIMAGE_SIGN_ARGS` 10691 :term:`UBOOT_MKIMAGE_SIGN_ARGS`
10672 Optionally specifies additional arguments for the 10692 Optionally specifies additional arguments for the
10673 :ref:`ref-classes-kernel-fitimage` class to pass to the 10693 :ref:`ref-classes-kernel-fit-image` class to pass to the
10674 mkimage command when signing the FIT image. 10694 mkimage command when signing the FIT image.
10675 10695
10676 :term:`UBOOT_RD_ENTRYPOINT` 10696 :term:`UBOOT_RD_ENTRYPOINT`
10677 Specifies the entrypoint for the RAM disk image. During FIT image 10697 Specifies the entrypoint for the RAM disk image. During FIT image
10678 creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in 10698 creation, the :term:`UBOOT_RD_ENTRYPOINT` variable is used in
10679 :ref:`ref-classes-kernel-fitimage` class to specify the entrypoint to be 10699 :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. 10700 used in creating the Image Tree Source for the FIT image.
10681 10701
10682 :term:`UBOOT_RD_LOADADDRESS` 10702 :term:`UBOOT_RD_LOADADDRESS`
10683 Specifies the load address for the RAM disk image. During FIT image 10703 Specifies the load address for the RAM disk image. During FIT image
10684 creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in 10704 creation, the :term:`UBOOT_RD_LOADADDRESS` variable is used in
10685 :ref:`ref-classes-kernel-fitimage` class to specify the load address to 10705 :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. 10706 be used in creating the Image Tree Source for the FIT image.
10687 10707
10688 :term:`UBOOT_SIGN_ENABLE` 10708 :term:`UBOOT_SIGN_ENABLE`
10689 Enable signing of FIT image. The default value is "0". 10709 Enable signing of FIT image. The default value is "0".
10690 10710
10691 This variable is used by the :ref:`ref-classes-kernel-fitimage`, 10711 This variable is used by the :ref:`ref-classes-kernel-fit-image`,
10692 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign` 10712 :ref:`ref-classes-uboot-config` and :ref:`ref-classes-uboot-sign`
10693 classes. 10713 classes.
10694 10714
10695 :term:`UBOOT_SIGN_KEYDIR` 10715 :term:`UBOOT_SIGN_KEYDIR`
10696 Location of the directory containing the RSA key and certificate used for 10716 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 10717 signing FIT image, used by the :ref:`ref-classes-kernel-fit-image` and
10698 :ref:`ref-classes-uboot-sign` classes. 10718 :ref:`ref-classes-uboot-sign` classes.
10699 10719
10700 :term:`UBOOT_SIGN_KEYNAME` 10720 :term:`UBOOT_SIGN_KEYNAME`
10701 The name of keys used by the :ref:`ref-classes-kernel-fitimage` class 10721 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` 10722 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`` 10723 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 10724 certificate stored in the :term:`UBOOT_SIGN_KEYDIR` directory, you will