From 082b4675ffa11dde84f80976036354ae368b77ab Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 18 Jun 2024 08:05:46 +0200 Subject: cmd: link to doc/usage/fit/x86-fit-boot.rst Replace the outdated link. Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- cmd/Kconfig | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/Kconfig b/cmd/Kconfig index b026439c773..6834bbd82f3 100644 --- a/cmd/Kconfig +++ b/cmd/Kconfig @@ -621,7 +621,7 @@ config CMD_ZBOOT Consider using FIT in preference to this since it supports directly booting both 32- and 64-bit kernels, as well as secure boot. - Documentation is available in doc/uImage.FIT/x86-fit-boot.txt + Documentation is available in doc/usage/fit/x86-fit-boot.rst. endmenu -- cgit v1.2.3 From dfb28817c10e9b446832e2b4149bb6b874251fbc Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 18 Jun 2024 08:16:44 +0200 Subject: doc: FIT links in develop/uefi/uefi.rst Correct the links to the FIT documentation. Signed-off-by: Heinrich Schuchardt Reviewed-by: Ilias Apalodimas --- doc/develop/uefi/uefi.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/develop/uefi/uefi.rst b/doc/develop/uefi/uefi.rst index 0389b269c01..ea70dcbda86 100644 --- a/doc/develop/uefi/uefi.rst +++ b/doc/develop/uefi/uefi.rst @@ -72,7 +72,7 @@ bootm command. This feature is available if U-Boot is configured with:: CONFIG_BOOTM_EFI=y -A sample configuration is provided as file doc/uImage.FIT/uefi.its. +A sample configuration is provided in :doc:`../../usage/fit/uefi`. Below you find the output of an example session starting GRUB:: @@ -96,7 +96,7 @@ Below you find the output of an example session starting GRUB:: ## Transferring control to EFI (at address 404000d0) ... Welcome to GRUB! -See doc/uImage.FIT/howto.txt for an introduction to FIT images. +See :doc:`../../usage/fit/howto` for an introduction to FIT images. Configuring UEFI secure boot ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -- cgit v1.2.3 From 3fc9de484a7cb99f7f3134f25e6c16210bd1ae93 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 18 Jun 2024 08:23:17 +0200 Subject: boot: links to FIT documentation in Kconfig Correct the links to the FIT documentation in boot/Kconfig. Signed-off-by: Heinrich Schuchardt --- boot/Kconfig | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/boot/Kconfig b/boot/Kconfig index 6f3096c15a6..36bdc83b957 100644 --- a/boot/Kconfig +++ b/boot/Kconfig @@ -85,7 +85,7 @@ config FIT_SIGNATURE using a hash signed and verified using RSA. If CONFIG_SHA_PROG_HW_ACCEL is defined, i.e support for progressive hashing is available using hardware, then the RSA library will use - it. See doc/uImage.FIT/signature.txt for more details. + it. See doc/usage/fit/signature.rst for more details. WARNING: When relying on signed FIT images with a required signature check the legacy image format is disabled by default, so that @@ -223,8 +223,8 @@ config SPL_LOAD_FIT 1. "loadables" images, other than FDTs, which do not have a "load" 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. + 2. For FPGA images, the supported "compatible" list may be found in + https://fitspec.osfw.foundation/. 3. FDTs are only loaded for images with an "os" property of "u-boot". "linux" images are also supported with Falcon boot mode. -- cgit v1.2.3 From 7ec3b48908750edd3d7b86236a614313c1b67120 Mon Sep 17 00:00:00 2001 From: Alexander Dahl Date: Fri, 21 Jun 2024 09:47:19 +0200 Subject: doc: develop: testing: Fix broken reference to pytest suite help This should have been adapted directly with or after v2021.01-693-gca6583d4e08 ("doc: move test/README to HTML documentation") or v2021.01-694-g0157619d5c8 ("doc: move test/py/README.md to HTML documentation") already. Signed-off-by: Alexander Dahl Reviewed-by: Simon Glass --- doc/develop/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst index 5afeb42f696..056bdfd2b69 100644 --- a/doc/develop/testing.rst +++ b/doc/develop/testing.rst @@ -69,7 +69,7 @@ build:: ./test/py/test.py --bd sandbox_spl --build -k test_spl -See test/py/README.md for more information about the pytest suite. +See :doc:`py_testing` for more information about the pytest suite. See :doc:`tests_sandbox` for how to run tests directly (not through pytest). -- cgit v1.2.3 From 7a8bd3fa316153ab875c1b5d0e9bdfd55337c2db Mon Sep 17 00:00:00 2001 From: Alexander Dahl Date: Fri, 21 Jun 2024 09:47:20 +0200 Subject: doc: develop: testing: Fix reference to test writing section Add missing colon in :doc: link. Fixes: fc3283314539 ("doc: Explain briefly how to write new tests") Signed-off-by: Alexander Dahl Reviewed-by: Simon Glass --- doc/develop/testing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/develop/testing.rst b/doc/develop/testing.rst index 056bdfd2b69..9114d11ad26 100644 --- a/doc/develop/testing.rst +++ b/doc/develop/testing.rst @@ -123,7 +123,7 @@ or is covered sparingly. So here are some suggestions: is much easier to add onto a test - writing a new large test can seem daunting to most contributors. -See doc:`tests_writing` for how to write tests. +See :doc:`tests_writing` for how to write tests. Future work -- cgit v1.2.3 From 271ca9ef8a37b8668b9858638175ac2da5c152df Mon Sep 17 00:00:00 2001 From: Jonathan Humphreys Date: Fri, 21 Jun 2024 15:17:06 -0500 Subject: doc: board: ti: Add capsule documentation for TI K3 devices Added introductory documentation about capsule support for TI devices, including links to more detailed information. Also added a note in the build secction that points to the host package dependency docs. This patch is followup from a request in the series introducing capsule update for TI boards. https://lore.kernel.org/r/20240618145058.552eapp5iiz772ej@hardcore Signed-off-by: Jonathan Humphreys --- doc/board/ti/k3.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) diff --git a/doc/board/ti/k3.rst b/doc/board/ti/k3.rst index a1c01d1cf02..88821a15e4c 100644 --- a/doc/board/ti/k3.rst +++ b/doc/board/ti/k3.rst @@ -203,6 +203,11 @@ online Build Procedure --------------- +.. note :: + + Make sure you have installed all necessary host package dependencies + before proceeding. See :ref:`build/gcc:Building with GCC`. + Depending on the specifics of your device, you will need three or more binaries to boot your SoC. @@ -387,6 +392,30 @@ wakeup and main domain and to boot to the U-Boot prompt | `tispl.bin` for HS devices or `tispl.bin_unsigned` for GP devices | `u-boot.img` for HS devices or `u-boot.img_unsigned` for GP devices +Capsules +-------- + +Most K3 boards have support for UEFI capsule update via capsule-on-disk +functionality. Check the ``CONFIG_EFI_CAPSULE_ON_DISK`` config option for +the board under question to verify. If configured, capsules for each of the +binaries above are automatically generated as part of the binary's build. +They are named `-capsule.bin`. For example, the capsule for +`u-boot.img` would be called `uboot-capsule.bin`. + +See :ref:`uefi_capsule_update_ref` for more information on U-Boot's support +for capsule update and how they are applied. + +Each board defines the capsules generated, including where those capsules +are applied. See the ``update_info`` definition for a board, typically +found at `board/ti//evm.c`. For example, `board/ti/am62x/evm.c`. +Usually, if the board has OSPI flash, the capsules will be applied there, +else the boot partition of the eMMC device. + +Once applied, the board will have U-Boot binaries in on-board non-volatile +storage. To start booting from that storage, set the bootmode pins +accordingly. Future updates can be performed by using the capsules +generated from the corresponding U-Boot builds. + FIT signature signing --------------------- -- cgit v1.2.3