Merge tag 'doc-2026-04-rc6' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request doc-2026-04-rc6 CI: https://source.denx.de/u-boot/custodians/u-boot-efi/-/pipelines/29687 Documentation: * TI boards - fix OP-TEE args - fix incorrect labels for boot switches * Fix typo in pstore documentation. * Fix document references pointing to replaced uImage.FIT. * buildman: Add missing :: for examples. * overlay-fdt-boot: .dtbos do not need load addresses. * When building the documentation use sys.path.append for pytests.
This commit is contained in:
Tom Rini
@@ -2759,8 +2759,7 @@ DOC_TARGETS := xmldocs latexdocs pdfdocs htmldocs epubdocs cleandocs \
|
||||
linkcheckdocs dochelp refcheckdocs texinfodocs infodocs
|
||||
PHONY += $(DOC_TARGETS)
|
||||
$(DOC_TARGETS): scripts_basic FORCE
|
||||
$(Q)PYTHONPATH=$(srctree)/test/py/tests:$(srctree)/test/py \
|
||||
$(MAKE) $(build)=doc $@
|
||||
$(Q)$(MAKE) $(build)=doc $@
|
||||
|
||||
PHONY += checkstack ubootrelease ubootversion
|
||||
|
||||
|
||||
@@ -1662,7 +1662,7 @@ New uImage format (FIT)
|
||||
Flexible and powerful format based on Flattened Image Tree -- FIT (similar
|
||||
to Flattened Device Tree). It allows the use of images with multiple
|
||||
components (several kernels, ramdisks, etc.), with contents protected by
|
||||
SHA1, MD5 or CRC32. More details are found in the doc/uImage.FIT directory.
|
||||
SHA1, MD5 or CRC32. More details are found in the doc/usage/fit directory.
|
||||
|
||||
|
||||
Old uImage format
|
||||
|
||||
@@ -41,4 +41,4 @@ fiptool_images. Run below command in ATF folder to generate FIP image.
|
||||
- Test
|
||||
Just boot up your board and wait for u-boot start up after ATF's log.
|
||||
For booting Linux in FIT image, please reference the FIT files in
|
||||
u-boot doc/uImage.FIT/ folder.
|
||||
u-boot doc/usage/fit/ folder.
|
||||
|
||||
+1
-1
@@ -335,7 +335,7 @@ config TPL_LOAD_FIT
|
||||
property will not be loaded. This limitation also applies to FPGA
|
||||
images with the correct "compatible" string.
|
||||
2. For FPGA images, the supported "compatible" list is in the
|
||||
doc/uImage.FIT/source_file_format.txt.
|
||||
doc/usage/fit/source_file_format.rst.
|
||||
3. FDTs are only loaded for images with an "os" property of "u-boot".
|
||||
"linux" images are also supported with Falcon boot mode.
|
||||
|
||||
|
||||
+1
-1
@@ -94,7 +94,7 @@ FIT image format for download
|
||||
To create FIT image for download one should follow the update tftp README file
|
||||
(./doc/README.update) with one notable difference:
|
||||
|
||||
The original snippet of ./doc/uImage.FIT/update_uboot.its
|
||||
The original snippet of ./doc/usage/fit/update_uboot.rst
|
||||
|
||||
images {
|
||||
update@1 {
|
||||
|
||||
+1
-1
@@ -152,7 +152,7 @@ Two for both, kernel with device tree support and also without it:
|
||||
If proper fdt file exists then it will be automatically loaded,
|
||||
so for old kernel types, please remove fdt file from boot partition.
|
||||
|
||||
The third boot option for multi image support (more info: doc/uImage.FIT/)
|
||||
The third boot option for multi image support (more info: doc/usage/fit/)
|
||||
- boot_fit - for binary file: "Image.itb"
|
||||
|
||||
Default boot command: "autoboot"
|
||||
|
||||
+1
-1
@@ -112,7 +112,7 @@ Verified Boot
|
||||
|
||||
U-Boot supports an image verification method called "Verified Boot".
|
||||
This is a brief tutorial to utilize this feature for the UniPhier platform.
|
||||
You will find details documents in the doc/uImage.FIT directory.
|
||||
You will find details documents in the doc/usage/fit directory.
|
||||
|
||||
Here, we take LD20 reference board for example, but it should work for any
|
||||
other boards including 32 bit SoCs.
|
||||
|
||||
+3
-3
@@ -48,14 +48,14 @@ The auto-update feature uses the following configuration knobs:
|
||||
Since the update file is in FIT format, it is created from an *.its file using
|
||||
the mkimage tool. dtc tool with support for binary includes, e.g. in version
|
||||
1.2.0 or later, must also be available on the system where the update file is
|
||||
to be prepared. Refer to the doc/uImage.FIT/ directory for more details on FIT
|
||||
to be prepared. Refer to the doc/usage/fit/ directory for more details on FIT
|
||||
images.
|
||||
|
||||
|
||||
Example .its files
|
||||
------------------
|
||||
|
||||
- doc/uImage.FIT/update_uboot.its
|
||||
- doc/usage/fit/update_uboot.rst
|
||||
|
||||
A simple example that can be used to create an update file for automatically
|
||||
replacing U-Boot image on a system.
|
||||
@@ -83,7 +83,7 @@ Example .its files
|
||||
where the update will be placed is correct. Making mistake here and
|
||||
attempting the auto-update can render the system unusable.
|
||||
|
||||
- doc/uImage.FIT/update3.its
|
||||
- doc/usage/fit/update3.rst
|
||||
|
||||
An example containing three updates. It can be used to update Linux kernel,
|
||||
ramdisk and FDT blob stored in Flash. The procedure for preparing the update
|
||||
|
||||
@@ -67,7 +67,8 @@ Set the variables corresponding to this platform:
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am62x
|
||||
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
# we dont use any extra OPTEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. include:: ../ti/am62x_sk.rst
|
||||
:start-after: .. am62x_evm_rst_include_start_build_steps
|
||||
|
||||
@@ -60,7 +60,8 @@ Set the variables corresponding to this platform:
|
||||
$ # we don't use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am62x
|
||||
$ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
$ # we dont use any extra OPTEE parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. include:: ../ti/am62x_sk.rst
|
||||
:start-after: .. am62x_evm_rst_include_start_build_steps
|
||||
|
||||
@@ -27,7 +27,7 @@ We will build ``u-boot-nodtb.bin`` from the u-boot source tree.
|
||||
|
||||
Generate FIT image (optional)
|
||||
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
||||
See doc/uImage.FIT for more details
|
||||
See doc/usage/fit for more details
|
||||
|
||||
Pack android boot image
|
||||
^^^^^^^^^^^^^^^^^^^^^^^
|
||||
|
||||
@@ -236,7 +236,7 @@ https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
|
||||
|
||||
* - Switch Label
|
||||
- SW2: 12345678
|
||||
- SW3: 12345678
|
||||
- SW1: 12345678
|
||||
|
||||
* - SD
|
||||
- 01000000
|
||||
|
||||
@@ -162,8 +162,8 @@ https://www.ti.com/lit/pdf/spruj16 under the `Boot Mode Pins` section.
|
||||
:header-rows: 1
|
||||
|
||||
* - Switch Label
|
||||
- SW2: 12345678
|
||||
- SW3: 12345678
|
||||
- SW2: 12345678
|
||||
|
||||
* - SD
|
||||
- 01000000
|
||||
|
||||
@@ -173,8 +173,8 @@ https://www.ti.com/lit/pdf/sprujd4 under the `Boot Mode Pins` section.
|
||||
:header-rows: 1
|
||||
|
||||
* - Switch Label
|
||||
- SW1: 12345678
|
||||
- SW2: 12345678
|
||||
- SW3: 12345678
|
||||
|
||||
* - SD
|
||||
- 01000000
|
||||
|
||||
@@ -99,7 +99,9 @@ Set the variables corresponding to this platform:
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am62x
|
||||
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
# we dont use any extra OPTEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
|
||||
.. am62px_evm_rst_include_start_build_steps
|
||||
|
||||
@@ -265,8 +267,8 @@ https://www.ti.com/lit/pdf/spruj83 under the `Boot Mode Pins` section.
|
||||
:header-rows: 1
|
||||
|
||||
* - Switch Label
|
||||
- SW2: 12345678
|
||||
- SW3: 12345678
|
||||
- SW5: 12345678
|
||||
- SW4: 12345678
|
||||
|
||||
* - SD
|
||||
- 01000000
|
||||
|
||||
@@ -87,8 +87,8 @@ Set the variables corresponding to this platform:
|
||||
export TFA_BOARD=lite
|
||||
# we dont use any extra TFA parameters
|
||||
unset TFA_EXTRA_ARGS
|
||||
export OPTEE_PLATFORM=k3-am62x
|
||||
export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
# we dont use any extra OPTEE parameters
|
||||
unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. am62x_evm_rst_include_start_build_steps
|
||||
|
||||
@@ -283,7 +283,7 @@ https://www.ti.com/lit/pdf/spruiv7 under the `Boot Mode Pins` section.
|
||||
|
||||
* - Switch Label
|
||||
- SW2: 12345678
|
||||
- SW3: 12345678
|
||||
- SW1: 12345678
|
||||
|
||||
* - SD
|
||||
- 01000000
|
||||
|
||||
@@ -59,7 +59,8 @@ Set the variables corresponding to this platform:
|
||||
$ # we don't use any extra TFA parameters
|
||||
$ unset TFA_EXTRA_ARGS
|
||||
$ export OPTEE_PLATFORM=k3-am62x
|
||||
$ export OPTEE_EXTRA_ARGS="CFG_WITH_SOFTWARE_PRNG=y"
|
||||
$ # we dont use any extra OPTEE parameters
|
||||
$ unset OPTEE_EXTRA_ARGS
|
||||
|
||||
.. include:: ../ti/am62x_sk.rst
|
||||
:start-after: .. am62x_evm_rst_include_start_build_steps
|
||||
|
||||
@@ -34,6 +34,8 @@ if os.environ.get("READTHEDOCS", "") == "True":
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
sys.path.insert(0, os.path.abspath('sphinx'))
|
||||
sys.path.append(os.path.abspath('../test/py/tests'))
|
||||
sys.path.append(os.path.abspath('../test/py'))
|
||||
from load_config import loadConfig
|
||||
|
||||
# -- General configuration ------------------------------------------------
|
||||
|
||||
@@ -5,7 +5,7 @@ Package U-Boot
|
||||
|
||||
U-Boot uses Flat Image Tree (FIT) as a standard file format for packaging
|
||||
images that it reads and boots. Documentation about FIT is available at
|
||||
doc/uImage.FIT
|
||||
doc/usage/fit
|
||||
|
||||
U-Boot also provides binman for cases not covered by FIT. Examples include
|
||||
initial execution (since FIT itself does not have an executable header) and
|
||||
|
||||
@@ -80,8 +80,8 @@ For test purpose, you can generate a kernel crash by setting reboot timeout to
|
||||
Retrieve logs in U-Boot
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
First of all, unless PStore parameters as been set during U-Boot configuration
|
||||
and match kernel ramoops parameters, it needs to be set using 'pstore set', e.g.::
|
||||
First of all, unless PStore parameters have been set during U-Boot configuration
|
||||
and match kernel ramoops parameters, they need to be set using 'pstore set', e.g.::
|
||||
|
||||
=> pstore set 0x30000000 0x100000 0x2000 0x2000
|
||||
|
||||
|
||||
@@ -157,7 +157,7 @@ development host is to be booted old-style (non-FDT) by U-Boot on an embedded
|
||||
target. Assume that the outcome of the build is vmlinux.bin.gz, a file which
|
||||
contains a gzip-compressed PPC Linux kernel (the only data file in this case).
|
||||
The uImage can be produced using the image source file
|
||||
doc/uImage.FIT/kernel.its (note that kernel.its assumes that vmlinux.bin.gz is
|
||||
doc/usage/fit/kernel.rst (note that kernel.its assumes that vmlinux.bin.gz is
|
||||
in the current working directory; if desired, an alternative path can be
|
||||
specified in the kernel.its file). Here's how to create the image and inspect
|
||||
its contents:
|
||||
@@ -269,7 +269,7 @@ Example 2 -- new-style (FDT) kernel booting
|
||||
Consider another simple scenario, where a PPC Linux kernel is to be booted
|
||||
new-style, i.e., with a FDT blob. In this case there are two prerequisite data
|
||||
files: vmlinux.bin.gz (Linux kernel) and target.dtb (FDT blob). The uImage can
|
||||
be produced using image source file doc/uImage.FIT/kernel_fdt.its like this
|
||||
be produced using image source file doc/usage/fit/kernel_fdt.rst like this
|
||||
(note again, that both prerequisite data files are assumed to be present in
|
||||
the current working directory -- image source file kernel_fdt.its can be
|
||||
modified to take the files from some other location if needed):
|
||||
|
||||
@@ -141,25 +141,21 @@ explosion problem::
|
||||
data = /incbin/("./reva.dtbo");
|
||||
type = "flat_dt";
|
||||
arch = "arm";
|
||||
load = <0x87fc0000>;
|
||||
};
|
||||
fdt-3 {
|
||||
data = /incbin/("./revb.dtbo");
|
||||
type = "flat_dt";
|
||||
arch = "arm";
|
||||
load = <0x87fc0000>;
|
||||
};
|
||||
fdt-4 {
|
||||
data = /incbin/("./bar.dtbo");
|
||||
type = "flat_dt";
|
||||
arch = "arm";
|
||||
load = <0x87fc0000>;
|
||||
};
|
||||
fdt-5 {
|
||||
data = /incbin/("./baz.dtbo");
|
||||
type = "flat_dt";
|
||||
arch = "arm";
|
||||
load = <0x87fc0000>;
|
||||
};
|
||||
};
|
||||
|
||||
@@ -202,9 +198,7 @@ Booting this image is exactly the same as the non-overlay example.
|
||||
u-boot will retrieve the base blob and apply the overlays in sequence as
|
||||
they are declared in the configuration.
|
||||
|
||||
Note the minimum amount of different DT blobs, as well as the requirement for
|
||||
the DT blobs to have a load address; the overlay application requires the blobs
|
||||
to be writeable.
|
||||
Note the minimum amount of different DT blobs.
|
||||
|
||||
Configuration using overlays and feature selection
|
||||
--------------------------------------------------
|
||||
|
||||
+1
-1
@@ -5,7 +5,7 @@ config ECDSA
|
||||
This enables the ECDSA (elliptic curve signature) algorithm for FIT
|
||||
image verification in U-Boot. The ECDSA algorithm is implemented
|
||||
using the driver model, so CONFIG_DM is required by this library.
|
||||
See doc/uImage.FIT/signature.txt for more details.
|
||||
See doc/usage/fit/signature.rst for more details.
|
||||
ECDSA is enabled for mkimage regardless of this option.
|
||||
|
||||
if ECDSA
|
||||
|
||||
+2
-2
@@ -6,7 +6,7 @@ config RSA
|
||||
help
|
||||
RSA support. This enables the RSA algorithm used for FIT image
|
||||
verification in U-Boot.
|
||||
See doc/uImage.FIT/signature.txt for more details.
|
||||
See doc/usage/fit/signature.rst for more details.
|
||||
The Modular Exponentiation algorithm in RSA is implemented using
|
||||
driver model. So CONFIG_DM needs to be enabled by default for this
|
||||
library to function.
|
||||
@@ -88,7 +88,7 @@ config RSA_SOFTWARE_EXP
|
||||
Enables driver for modular exponentiation in software. This is a RSA
|
||||
algorithm used in FIT image verification. It required RSA Key as
|
||||
input.
|
||||
See doc/uImage.FIT/signature.txt for more details.
|
||||
See doc/usage/fit/signature.rst for more details.
|
||||
|
||||
config RSA_FREESCALE_EXP
|
||||
bool "Enable RSA Modular Exponentiation with FSL crypto accelerator"
|
||||
|
||||
@@ -146,7 +146,7 @@ the '&' operator to limit the selection:
|
||||
- 'freescale & arm sandbox' - all Freescale boards with ARM architecture, plus
|
||||
sandbox
|
||||
|
||||
You can also use -x to specifically exclude some boards. For example:
|
||||
You can also use -x to specifically exclude some boards. For example::
|
||||
|
||||
buildman arm -x nvidia,freescale,.*ball$
|
||||
|
||||
@@ -970,10 +970,12 @@ a set of (tag, value) pairs.
|
||||
settings file. They can also be useful when building U-Boot against other
|
||||
open source software.
|
||||
|
||||
[make-flags]
|
||||
at91-boards=ENABLE_AT91_TEST=1
|
||||
snapper9260=${at91-boards} BUILD_TAG=442
|
||||
snapper9g45=${at91-boards} BUILD_TAG=443
|
||||
::
|
||||
|
||||
[make-flags]
|
||||
at91-boards=ENABLE_AT91_TEST=1
|
||||
snapper9260=${at91-boards} BUILD_TAG=442
|
||||
snapper9g45=${at91-boards} BUILD_TAG=443
|
||||
|
||||
This will use 'make ENABLE_AT91_TEST=1 BUILD_TAG=442' for snapper9260
|
||||
and 'make ENABLE_AT91_TEST=1 BUILD_TAG=443' for snapper9g45. A special
|
||||
@@ -986,7 +988,7 @@ a set of (tag, value) pairs.
|
||||
config.mk file and documented in the README.
|
||||
|
||||
Note that you can pass ad-hoc options to the build using environment
|
||||
variables, for example:
|
||||
variables, for example::
|
||||
|
||||
SOME_OPTION=1234 ./tools/buildman/buildman my_board
|
||||
|
||||
@@ -1357,7 +1359,7 @@ directory.
|
||||
Build summary
|
||||
-------------
|
||||
|
||||
When Buildman finishes, it displays a summary, similar to the following:
|
||||
When Buildman finishes, it displays a summary, similar to the following::
|
||||
|
||||
Completed: 5 total built, duration 0:00:21, rate 0.24
|
||||
|
||||
|
||||
+1
-1
@@ -650,7 +650,7 @@ int fit_image_cipher_data(const char *keydir, void *keydest,
|
||||
* |- algo = "sha1"
|
||||
* |- value = sha1(data)
|
||||
*
|
||||
* For signature details, please see doc/uImage.FIT/signature.txt
|
||||
* For signature details, please see doc/usage/fit/signature.rst
|
||||
*
|
||||
* @keydir Directory containing *.key and *.crt files (or NULL)
|
||||
* @keydest FDT Blob to write public keys into (NULL if none)
|
||||
|
||||
Reference in New Issue
Block a user