diff options
author | Paul Eggleton <paul.eggleton@microsoft.com> | 2020-12-21 17:06:03 -0800 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2020-12-24 08:23:33 +0000 |
commit | f567cda0a9bebec26d33871cd09001e3b5ade1b4 (patch) | |
tree | 17f80dcc7b6977bc0eb1db75404a7a132a1f54d5 /documentation/ref-manual | |
parent | 345fb462effa1d505e813a26b265d3b09b57b1e3 (diff) | |
download | poky-f567cda0a9bebec26d33871cd09001e3b5ade1b4.tar.gz |
variables: Add documentation for new kernel-fitimage vars
Add documentation for FIT_DESC, FIT_SIGN_INDIVIDUAL, UBOOT_MKIMAGE,
UBOOT_MKIMAGE_SIGN and UBOOT_MKIMAGE_SIGN_ARGS.
(From yocto-docs rev: 3c8c9d419d0137279ba1a4e7d3f381df93d6f12d)
Signed-off-by: Paul Eggleton <paul.eggleton@microsoft.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual')
-rw-r--r-- | documentation/ref-manual/variables.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 8f7f86e6b3..b80bcbaf58 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -2538,6 +2538,13 @@ system and gives an overview of their function and contents. | |||
2538 | For guidance on how to create your own file permissions settings | 2538 | For guidance on how to create your own file permissions settings |
2539 | table file, examine the existing ``fs-perms.txt``. | 2539 | table file, examine the existing ``fs-perms.txt``. |
2540 | 2540 | ||
2541 | :term:`FIT_DESC` | ||
2542 | Specifies the description string encoded into a fitImage. The default | ||
2543 | value is set by the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` | ||
2544 | class as follows:: | ||
2545 | |||
2546 | FIT_DESC ?= "U-Boot fitImage for ${DISTRO_NAME}/${PV}/${MACHINE}" | ||
2547 | |||
2541 | :term:`FIT_GENERATE_KEYS` | 2548 | :term:`FIT_GENERATE_KEYS` |
2542 | Decides whether to generate the keys for signing fitImage if they | 2549 | Decides whether to generate the keys for signing fitImage if they |
2543 | don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. | 2550 | don't already exist. The keys are created in ``UBOOT_SIGN_KEYDIR``. |
@@ -2568,6 +2575,13 @@ system and gives an overview of their function and contents. | |||
2568 | Size of private key in number of bits used in fitImage. The default | 2575 | Size of private key in number of bits used in fitImage. The default |
2569 | value is "2048". | 2576 | value is "2048". |
2570 | 2577 | ||
2578 | :term:`FIT_SIGN_INDIVIDUAL` | ||
2579 | If set to "1", then the :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` | ||
2580 | class will sign the kernel, dtb and ramdisk images individually in addition | ||
2581 | to signing the fitImage itself. This could be useful if you are | ||
2582 | intending to verify signatures in another context than booting via | ||
2583 | U-Boot. | ||
2584 | |||
2571 | :term:`FONT_EXTRA_RDEPENDS` | 2585 | :term:`FONT_EXTRA_RDEPENDS` |
2572 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, | 2586 | When inheriting the :ref:`fontcache <ref-classes-fontcache>` class, |
2573 | this variable specifies the runtime dependencies for font packages. | 2587 | this variable specifies the runtime dependencies for font packages. |
@@ -8441,12 +8455,30 @@ system and gives an overview of their function and contents. | |||
8441 | Specifies the target called in the ``Makefile``. The default target | 8455 | Specifies the target called in the ``Makefile``. The default target |
8442 | is "all". | 8456 | is "all". |
8443 | 8457 | ||
8458 | :term:`UBOOT_MKIMAGE` | ||
8459 | Specifies the name of the mkimage command as used by the | ||
8460 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to assemble | ||
8461 | the FIT image. This can be used to substitute an alternative command, wrapper | ||
8462 | script or function if desired. The default is "uboot-mkimage". | ||
8463 | |||
8444 | :term:`UBOOT_MKIMAGE_DTCOPTS` | 8464 | :term:`UBOOT_MKIMAGE_DTCOPTS` |
8445 | Options for the device tree compiler passed to mkimage '-D' | 8465 | Options for the device tree compiler passed to mkimage '-D' |
8446 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. | 8466 | feature while creating FIT image in :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class. |
8447 | If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not | 8467 | If ``UBOOT_MKIMAGE_DTCOPTS`` is not set then kernel-fitimage will not |
8448 | pass the ``-D`` option to mkimage. | 8468 | pass the ``-D`` option to mkimage. |
8449 | 8469 | ||
8470 | :term:`UBOOT_MKIMAGE_SIGN` | ||
8471 | Specifies the name of the mkimage command as used by the | ||
8472 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to sign | ||
8473 | the FIT image after it has been assembled (if enabled). This can be used | ||
8474 | to substitute an alternative command, wrapper script or function if | ||
8475 | desired. The default is "${:term:`UBOOT_MKIMAGE`}". | ||
8476 | |||
8477 | :term:`UBOOT_MKIMAGE_SIGN_ARGS` | ||
8478 | Optionally specifies additional arguments for the | ||
8479 | :ref:`kernel-fitimage <ref-classes-kernel-fitimage>` class to pass to the | ||
8480 | mkimage command when signing the FIT image. | ||
8481 | |||
8450 | :term:`UBOOT_RD_ENTRYPOINT` | 8482 | :term:`UBOOT_RD_ENTRYPOINT` |
8451 | Specifies the entrypoint for the RAM disk image. | 8483 | Specifies the entrypoint for the RAM disk image. |
8452 | During FIT image creation, the | 8484 | During FIT image creation, the |