summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorTom Rini <[email protected]>2024-07-15 08:21:46 -0600
committerTom Rini <[email protected]>2024-07-15 08:21:46 -0600
commit5e9c055f90ad9fa1d4df73b155d72932d26f4c5c (patch)
treeb3dcdd6be9ba9b8ceabaa8561a45375ea3968b15 /doc
parent2c7c90c34717dde57eeb01606f4aae9ccafaaddf (diff)
parentda909648e13fdfb5306123f4bc2a89bf2cbf682e (diff)
Merge tag 'efi-2024-10-rc1-2' of https://source.denx.de/u-boot/custodians/u-boot-efi
Pull request efi-2024-10-rc1-2 Documentation: * use current versions of certifi and urllib3 for building documentation * add bootelf command documentation * correct the description of the Goldfish RTC driver * correct heading level of itest examples UEFI: * print device-tree in dtbdump.efi * consider CONFIG_EFI_IGNORE_OSINDICATIONS in TestEfiCapsuleFirmwareRaw * correct cmd_capsule_esl_gen invocation in scripts/Makefile.lib * use capsule CRT instead of ESL file when building capsules Others: * let ENV_IS_IN_EXT4 enable SYS_MMC_ENV_DEV * check if CONFIG_SYS_MMC_ENV_DEV is defined in mmc_get_env_dev
Diffstat (limited to 'doc')
-rw-r--r--doc/develop/uefi/uefi.rst8
-rw-r--r--doc/sphinx/requirements.txt4
-rw-r--r--doc/usage/cmd/bootelf.rst61
-rw-r--r--doc/usage/cmd/itest.rst2
-rw-r--r--doc/usage/index.rst1
5 files changed, 69 insertions, 7 deletions
diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst
index 88596f312c0..d450b12bf80 100644
--- a/doc/develop/uefi/uefi.rst
+++ b/doc/develop/uefi/uefi.rst
@@ -580,10 +580,10 @@ and used by the steps highlighted below.
}
You can perform step-4 through the Kconfig symbol
-CONFIG_EFI_CAPSULE_ESL_FILE. This symbol points to the esl file
-generated in step-2. Once the symbol has been populated with the path
-to the esl file, it will automatically get embedded into the
-platform's dtb as part of U-Boot build.
+CONFIG_EFI_CAPSULE_CRT_FILE. This symbol points to the signing key
+generated in step-2. As part of U-Boot build, the ESL certificate file will
+be generated from the signing key and automatically get embedded into the
+platform's dtb.
Anti-rollback Protection
************************
diff --git a/doc/sphinx/requirements.txt b/doc/sphinx/requirements.txt
index 306b05a995e..40dde599916 100644
--- a/doc/sphinx/requirements.txt
+++ b/doc/sphinx/requirements.txt
@@ -1,6 +1,6 @@
alabaster==0.7.16
Babel==2.15.0
-certifi==2024.6.2
+certifi==2024.7.4
charset-normalizer==3.3.2
docutils==0.20.1
idna==3.7
@@ -22,4 +22,4 @@ sphinxcontrib-jquery==4.1
sphinxcontrib-jsmath==1.0.1
sphinxcontrib-qthelp==1.0.7
sphinxcontrib-serializinghtml==1.1.10
-urllib3==2.2.1
+urllib3==2.2.2
diff --git a/doc/usage/cmd/bootelf.rst b/doc/usage/cmd/bootelf.rst
new file mode 100644
index 00000000000..705524c594a
--- /dev/null
+++ b/doc/usage/cmd/bootelf.rst
@@ -0,0 +1,61 @@
+.. SPDX-License-Identifier: GPL-2.0-or-later
+.. Copyright 2024, Maxim Moskalets <[email protected]>
+
+.. index::
+ single: bootelf (command)
+
+bootelf command
+===============
+
+Synopsis
+--------
+
+::
+
+ bootelf [-p|-s] [-d <fdt_addr>] [<image_addr> [<arg>]...]
+
+Description
+-----------
+
+The *bootelf* command is used to launch a ELF binary at *image_addr*. If
+*image_addr* is not specified, the bootelf command will try to find image in
+*image_load_addr* variable (*CONFIG\_SYS\_LOAD\_ADDR* by default).
+
+Args after *image_addr* will be passed to application in common *argc*, *argv*
+format.
+
+A command sequence to run a ELF image using FDT might look like
+
+::
+
+ load mmc 0:1 ${loadaddr} /kernel.elf
+ load mmc 0:1 ${fdt_addr_r} /soc-board.dtb
+ bootelf -d ${fdt_addr_r} ${loadaddr} ${loadaddr}
+
+image_addr
+ Address of the ELF binary.
+
+fdt_addr
+ Address of the device-tree. This argument in only needed if bootable
+ application uses FDT that requires additional setup (like /memory node).
+
+arg
+ Any text arguments for bootable application. This is usually the address
+ of the device-tree.
+
+Flags:
+
+-p
+ Load ELF image via program headers.
+
+-s
+ Load ELF image via section headers.
+
+-d
+ Setup FDT by address.
+
+Configuration
+-------------
+
+The bootelf command is only available if CONFIG_CMD_ELF=y. FDT setup by flag -d
+need CONFIG_CMD_ELF_FDT_SETUP=y.
diff --git a/doc/usage/cmd/itest.rst b/doc/usage/cmd/itest.rst
index 9c307fb4bf4..adcad05b2d4 100644
--- a/doc/usage/cmd/itest.rst
+++ b/doc/usage/cmd/itest.rst
@@ -58,7 +58,7 @@ op
======== ======================
Examples
-========
+--------
The itest command sets the result variable $? to true (0) or false (1):
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 2f211f748ab..49b354e6ffd 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -33,6 +33,7 @@ Shell commands
cmd/bootd
cmd/bootdev
cmd/bootefi
+ cmd/bootelf
cmd/bootflow
cmd/booti
cmd/bootm