From 2ea957952362fe9238cbf3996c001f8bf3f04701 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Wed, 28 May 2025 10:03:14 -0600 Subject: [PATCH 01/11] efi: Rename the lib/efi directory This directory was created when U-Boot gained the ability to run as an EFI app in 2015. Since then the EFI-loader feature has been added. The code in lib/efi is not actually used by the loader, so the name is confusing. Rename the directory to efi_client to indicate that it includes files just for U-Boot being a client of EFI, i.e. the EFI app and stub. Signed-off-by: Simon Glass --- MAINTAINERS | 2 +- Makefile | 2 +- doc/develop/uefi/u-boot_on_efi.rst | 8 ++++---- lib/Makefile | 2 +- lib/{efi => efi_client}/Kconfig | 0 lib/{efi => efi_client}/Makefile | 0 lib/{efi => efi_client}/efi.c | 0 lib/{efi => efi_client}/efi_app.c | 0 lib/{efi => efi_client}/efi_app_init.c | 0 lib/{efi => efi_client}/efi_info.c | 0 lib/{efi => efi_client}/efi_stub.c | 0 lib/efi_loader/Kconfig | 2 +- 12 files changed, 8 insertions(+), 8 deletions(-) rename lib/{efi => efi_client}/Kconfig (100%) rename lib/{efi => efi_client}/Makefile (100%) rename lib/{efi => efi_client}/efi.c (100%) rename lib/{efi => efi_client}/efi_app.c (100%) rename lib/{efi => efi_client}/efi_app_init.c (100%) rename lib/{efi => efi_client}/efi_info.c (100%) rename lib/{efi => efi_client}/efi_stub.c (100%) diff --git a/MAINTAINERS b/MAINTAINERS index d490b43c57f..3e555596a1c 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1104,7 +1104,7 @@ F: configs/efi-x86_app* F: doc/develop/uefi/u-boot_on_efi.rst F: drivers/block/efi-media-uclass.c F: drivers/block/sb_efi_media.c -F: lib/efi/efi_app.c +F: lib/efi_client/ F: scripts/build-efi.sh F: test/dm/efi_media.c diff --git a/Makefile b/Makefile index 6a0251373c4..9c22b510333 100644 --- a/Makefile +++ b/Makefile @@ -1891,7 +1891,7 @@ u-boot-payload.lds: $(LDSCRIPT_EFI) FORCE quiet_cmd_u-boot_payload ?= LD $@ cmd_u-boot_payload ?= $(LD) $(LDFLAGS_EFI_PAYLOAD) -o $@ \ -T u-boot-payload.lds arch/x86/cpu/call32.o \ - lib/efi/efi.o lib/efi/efi_stub.o u-boot.bin.o \ + lib/efi_client/efi.o lib/efi_client/efi_stub.o u-boot.bin.o \ $(addprefix arch/$(ARCH)/lib/,$(EFISTUB)) u-boot-payload: u-boot.bin.o u-boot-payload.lds FORCE diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst index 245b4af1fa3..42e84c13049 100644 --- a/doc/develop/uefi/u-boot_on_efi.rst +++ b/doc/develop/uefi/u-boot_on_efi.rst @@ -113,7 +113,7 @@ implemented completely differently. EFI Application ~~~~~~~~~~~~~~~ For the application the whole of U-Boot is built as a shared library. The -efi_main() function is in lib/efi/efi_app.c. It sets up some basic EFI +efi_main() function is in lib/efi_client/efi_app.c. It sets up some basic EFI functions with efi_init(), sets up U-Boot global_data, allocates memory for U-Boot's malloc(), etc. and enters the normal init sequence (board_init_f() and board_init_r()). @@ -149,7 +149,7 @@ image (including device tree) into a small EFI stub application responsible for booting it. The stub application is built as a normal EFI application except that it has a lot of data attached to it. -The stub application is implemented in lib/efi/efi_stub.c. The efi_main() +The stub application is implemented in lib/efi_client/efi_stub.c. The efi_main() function is called by EFI. It is responsible for copying U-Boot from its original location into memory, disabling EFI boot services and starting U-Boot. U-Boot then starts as normal, relocates, starts all drivers, etc. @@ -192,7 +192,7 @@ careful to build the correct one so that your UEFI firmware can start it. Most UEFI images are 64-bit at present. The payload stub can be build as either 32- or 64-bits. Only a small amount -of code is built this way (see the extra- line in lib/efi/Makefile). +of code is built this way (see the extra- line in lib/efi_client/Makefile). Everything else is built as a normal U-Boot, so is always 32-bit on x86 at present. @@ -353,7 +353,7 @@ This work could be extended in a number of ways: Where is the code? ------------------ -lib/efi +lib/efi_client payload stub, application, support code. Mostly arch-neutral arch/x86/cpu/efi diff --git a/lib/Makefile b/lib/Makefile index 18ae0cd87bf..1dd738a7cd1 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -5,7 +5,7 @@ ifndef CONFIG_XPL_BUILD -obj-$(CONFIG_EFI) += efi/ +obj-$(CONFIG_EFI) += efi_client/ obj-$(CONFIG_EFI_LOADER) += efi_driver/ obj-$(CONFIG_EFI_LOADER) += efi_loader/ obj-$(CONFIG_CMD_BOOTEFI_SELFTEST) += efi_selftest/ diff --git a/lib/efi/Kconfig b/lib/efi_client/Kconfig similarity index 100% rename from lib/efi/Kconfig rename to lib/efi_client/Kconfig diff --git a/lib/efi/Makefile b/lib/efi_client/Makefile similarity index 100% rename from lib/efi/Makefile rename to lib/efi_client/Makefile diff --git a/lib/efi/efi.c b/lib/efi_client/efi.c similarity index 100% rename from lib/efi/efi.c rename to lib/efi_client/efi.c diff --git a/lib/efi/efi_app.c b/lib/efi_client/efi_app.c similarity index 100% rename from lib/efi/efi_app.c rename to lib/efi_client/efi_app.c diff --git a/lib/efi/efi_app_init.c b/lib/efi_client/efi_app_init.c similarity index 100% rename from lib/efi/efi_app_init.c rename to lib/efi_client/efi_app_init.c diff --git a/lib/efi/efi_info.c b/lib/efi_client/efi_info.c similarity index 100% rename from lib/efi/efi_info.c rename to lib/efi_client/efi_info.c diff --git a/lib/efi/efi_stub.c b/lib/efi_client/efi_stub.c similarity index 100% rename from lib/efi/efi_stub.c rename to lib/efi_client/efi_stub.c diff --git a/lib/efi_loader/Kconfig b/lib/efi_loader/Kconfig index 077466f01f0..250b9469134 100644 --- a/lib/efi_loader/Kconfig +++ b/lib/efi_loader/Kconfig @@ -595,6 +595,6 @@ config BOOTEFI_TESTAPP_COMPILE endif -source "lib/efi/Kconfig" +source "lib/efi_client/Kconfig" endmenu From 0029f2447bd4fac23d0ec6107c0b911c50c2c334 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Wed, 28 May 2025 10:03:15 -0600 Subject: [PATCH 02/11] efi: Rename CONFIG_EFI to CONFIG_EFI_CLIENT The generic name 'EFI' would be more useful for common EFI features. At present it just refers to the EFI app and stub, which is confusing. Rename it to EFI_CLIENT Signed-off-by: Simon Glass --- arch/x86/Kconfig | 6 +++--- arch/x86/cpu/Makefile | 2 +- arch/x86/cpu/efi/Kconfig | 2 +- arch/x86/cpu/x86_64/Makefile | 2 +- cmd/Makefile | 2 +- configs/efi-x86_app32_defconfig | 2 +- configs/efi-x86_app64_defconfig | 2 +- configs/efi-x86_payload32_defconfig | 2 +- configs/efi-x86_payload64_defconfig | 2 +- doc/develop/uefi/u-boot_on_efi.rst | 6 +++--- drivers/block/Kconfig | 2 +- include/init.h | 2 +- lib/Kconfig | 2 +- lib/Makefile | 2 +- lib/efi_client/Kconfig | 4 ++-- lib/uuid.c | 4 ++-- 16 files changed, 22 insertions(+), 22 deletions(-) diff --git a/arch/x86/Kconfig b/arch/x86/Kconfig index 6ca0605466f..5aa134b6bcb 100644 --- a/arch/x86/Kconfig +++ b/arch/x86/Kconfig @@ -368,7 +368,7 @@ config USE_HOB config HAVE_FSP bool "Add an Firmware Support Package binary" - depends on !EFI + depends on !EFI_CLIENT select USE_HOB select HAS_ROM help @@ -517,7 +517,7 @@ config FSP_BROKEN_HOB config ENABLE_MRC_CACHE bool "Enable MRC cache" - depends on !EFI && !SYS_COREBOOT + depends on !EFI_CLIENT && !SYS_COREBOOT help Enable this feature to cause MRC data to be cached in NV storage to be used for speeding up boot time on future reboots and/or @@ -756,7 +756,7 @@ config HAVE_P2SB devices. menu "System tables" - depends on !EFI && !SYS_COREBOOT + depends on !EFI_CLIENT && !SYS_COREBOOT config GENERATE_PIRQ_TABLE bool "Generate a PIRQ table" diff --git a/arch/x86/cpu/Makefile b/arch/x86/cpu/Makefile index cc55c8fa39c..5150edb833f 100644 --- a/arch/x86/cpu/Makefile +++ b/arch/x86/cpu/Makefile @@ -47,7 +47,7 @@ obj-$(CONFIG_INTEL_BRASWELL) += braswell/ obj-$(CONFIG_INTEL_BROADWELL) += broadwell/ obj-$(CONFIG_SYS_COREBOOT) += coreboot/ obj-$(CONFIG_SYS_SLIMBOOTLOADER) += slimbootloader/ -obj-$(CONFIG_EFI) += efi/ +obj-$(CONFIG_EFI_CLIENT) += efi/ obj-$(CONFIG_QEMU) += qemu/ obj-$(CONFIG_NORTHBRIDGE_INTEL_IVYBRIDGE) += ivybridge/ obj-$(CONFIG_INTEL_QUARK) += quark/ diff --git a/arch/x86/cpu/efi/Kconfig b/arch/x86/cpu/efi/Kconfig index e0975d34d36..f5288013a8a 100644 --- a/arch/x86/cpu/efi/Kconfig +++ b/arch/x86/cpu/efi/Kconfig @@ -1,4 +1,4 @@ -if EFI +if EFI_CLIENT config SYS_CAR_ADDR hex diff --git a/arch/x86/cpu/x86_64/Makefile b/arch/x86/cpu/x86_64/Makefile index e929563b2c1..cb23c071aa3 100644 --- a/arch/x86/cpu/x86_64/Makefile +++ b/arch/x86/cpu/x86_64/Makefile @@ -5,6 +5,6 @@ obj-y += cpu.o interrupts.o setjmp.o -ifndef CONFIG_EFI +ifndef CONFIG_EFI_CLIENT obj-y += misc.o endif diff --git a/cmd/Makefile b/cmd/Makefile index e4ecf2e0493..12e948fd1b9 100644 --- a/cmd/Makefile +++ b/cmd/Makefile @@ -67,7 +67,7 @@ obj-$(CONFIG_CMD_EXTENSION) += extension_board.o obj-$(CONFIG_CMD_ECHO) += echo.o obj-$(CONFIG_ENV_IS_IN_EEPROM) += eeprom.o obj-$(CONFIG_CMD_EEPROM) += eeprom.o -obj-$(CONFIG_EFI) += efi.o efi_common.o +obj-$(CONFIG_EFI_CLIENT) += efi.o efi_common.o obj-$(CONFIG_CMD_EFIDEBUG) += efidebug.o efi_common.o obj-$(CONFIG_CMD_EFICONFIG) += eficonfig.o ifdef CONFIG_CMD_EFICONFIG diff --git a/configs/efi-x86_app32_defconfig b/configs/efi-x86_app32_defconfig index 71d1bbd956e..a06f1ccfe2a 100644 --- a/configs/efi-x86_app32_defconfig +++ b/configs/efi-x86_app32_defconfig @@ -7,7 +7,7 @@ CONFIG_DEBUG_UART_CLOCK=0 CONFIG_VENDOR_EFI=y CONFIG_TARGET_EFI_APP32=y CONFIG_DEBUG_UART=y -CONFIG_EFI=y +CONFIG_EFI_CLIENT=y CONFIG_FIT=y # CONFIG_BOOTSTD is not set CONFIG_SHOW_BOOT_PROGRESS=y diff --git a/configs/efi-x86_app64_defconfig b/configs/efi-x86_app64_defconfig index 9f7b53d0106..9bcf5162b50 100644 --- a/configs/efi-x86_app64_defconfig +++ b/configs/efi-x86_app64_defconfig @@ -8,7 +8,7 @@ CONFIG_X86_RUN_64BIT=y CONFIG_VENDOR_EFI=y CONFIG_TARGET_EFI_APP64=y CONFIG_DEBUG_UART=y -CONFIG_EFI=y +CONFIG_EFI_CLIENT=y CONFIG_EFI_APP_64BIT=y CONFIG_FIT=y # CONFIG_BOOTSTD is not set diff --git a/configs/efi-x86_payload32_defconfig b/configs/efi-x86_payload32_defconfig index e9c5ddf12ad..ce9b7ff939d 100644 --- a/configs/efi-x86_payload32_defconfig +++ b/configs/efi-x86_payload32_defconfig @@ -5,7 +5,7 @@ CONFIG_DEFAULT_DEVICE_TREE="efi-x86_payload" CONFIG_PRE_CON_BUF_ADDR=0x100000 CONFIG_VENDOR_EFI=y CONFIG_TARGET_EFI_PAYLOAD=y -CONFIG_EFI=y +CONFIG_EFI_CLIENT=y CONFIG_EFI_STUB=y CONFIG_FIT=y CONFIG_FIT_SIGNATURE=y diff --git a/configs/efi-x86_payload64_defconfig b/configs/efi-x86_payload64_defconfig index b82e10dc3a1..6ce00189886 100644 --- a/configs/efi-x86_payload64_defconfig +++ b/configs/efi-x86_payload64_defconfig @@ -5,7 +5,7 @@ CONFIG_DEFAULT_DEVICE_TREE="efi-x86_payload" CONFIG_PRE_CON_BUF_ADDR=0x100000 CONFIG_VENDOR_EFI=y CONFIG_TARGET_EFI_PAYLOAD=y -CONFIG_EFI=y +CONFIG_EFI_CLIENT=y CONFIG_EFI_STUB=y CONFIG_EFI_STUB_64BIT=y CONFIG_FIT=y diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst index 42e84c13049..9068894e408 100644 --- a/doc/develop/uefi/u-boot_on_efi.rst +++ b/doc/develop/uefi/u-boot_on_efi.rst @@ -45,7 +45,7 @@ First choose a board that has EFI support and obtain an EFI implementation for that board. It will be either 32-bit or 64-bit. Alternatively, you can opt for using QEMU [1] and the OVMF [2], as detailed below. -To build U-Boot as an EFI application, enable CONFIG_EFI and CONFIG_EFI_APP. +To build U-Boot as an EFI application, enable CONFIG_EFI_CLIENT and CONFIG_EFI_APP. The efi-x86_app32 and efi-x86_app64 configs are set up for this. Just build U-Boot as normal, e.g.:: @@ -53,7 +53,7 @@ U-Boot as normal, e.g.:: make To build U-Boot as an EFI payload (32-bit or 64-bit EFI can be used), enable -CONFIG_EFI, CONFIG_EFI_STUB, and select either CONFIG_EFI_STUB_32BIT or +CONFIG_EFI_CLIENT, CONFIG_EFI_STUB, and select either CONFIG_EFI_STUB_32BIT or CONFIG_EFI_STUB_64BIT. The efi-x86_payload configs (efi-x86_payload32_defconfig and efi-x86_payload32_defconfig) are set up for this. Then build U-Boot as normal, e.g.:: @@ -121,7 +121,7 @@ and board_init_r()). Since U-Boot limits its memory access to the allocated regions very little special code is needed. The CONFIG_EFI_APP option controls a few things that need to change so 'git grep CONFIG_EFI_APP' may be instructive. -The CONFIG_EFI option controls more general EFI adjustments. +The CONFIG_EFI_CLIENT option controls more general EFI adjustments. The only available driver is the serial driver. This calls back into EFI 'boot services' to send and receive characters. Although it is implemented diff --git a/drivers/block/Kconfig b/drivers/block/Kconfig index 750b0bd2082..c6c148ebd17 100644 --- a/drivers/block/Kconfig +++ b/drivers/block/Kconfig @@ -96,7 +96,7 @@ config TPL_BLOCK_CACHE config EFI_MEDIA bool "Support EFI media drivers" - default y if EFI || SANDBOX + default y if EFI_CLIENT || SANDBOX select BLK help Enable this to support media devices on top of UEFI. This enables diff --git a/include/init.h b/include/init.h index 2c10171359c..1e375da4893 100644 --- a/include/init.h +++ b/include/init.h @@ -18,7 +18,7 @@ * In case of the EFI app the UEFI firmware provides the low-level * initialisation. */ -#ifdef CONFIG_EFI +#ifdef CONFIG_EFI_CLIENT #define ll_boot_init() false #else #include diff --git a/lib/Kconfig b/lib/Kconfig index 6a89f797bef..fbc9de90669 100644 --- a/lib/Kconfig +++ b/lib/Kconfig @@ -1096,7 +1096,7 @@ config VPL_OF_LIBFDT_ASSUME_MASK unsafe execution. See FDT_ASSUME_PERFECT, etc. in libfdt_internal.h menu "System tables" - depends on (!EFI && !SYS_COREBOOT) || (ARM && EFI_LOADER) + depends on (!EFI_CLIENT && !SYS_COREBOOT) || (ARM && EFI_LOADER) config BLOBLIST_TABLES bool "Put tables in a bloblist" diff --git a/lib/Makefile b/lib/Makefile index 1dd738a7cd1..2643bfc867c 100644 --- a/lib/Makefile +++ b/lib/Makefile @@ -5,7 +5,7 @@ ifndef CONFIG_XPL_BUILD -obj-$(CONFIG_EFI) += efi_client/ +obj-$(CONFIG_EFI_CLIENT) += efi_client/ obj-$(CONFIG_EFI_LOADER) += efi_driver/ obj-$(CONFIG_EFI_LOADER) += efi_loader/ obj-$(CONFIG_CMD_BOOTEFI_SELFTEST) += efi_selftest/ diff --git a/lib/efi_client/Kconfig b/lib/efi_client/Kconfig index 81ed3e66b34..ec413639bfe 100644 --- a/lib/efi_client/Kconfig +++ b/lib/efi_client/Kconfig @@ -1,7 +1,7 @@ menu "U-Boot as UEFI application" depends on X86 -config EFI +config EFI_CLIENT bool "Support running U-Boot from EFI" depends on X86 imply X86_TSC_READ_BASE @@ -13,7 +13,7 @@ config EFI choice prompt "Select EFI mode to use" - depends on X86 && EFI + depends on X86 && EFI_CLIENT config EFI_APP bool "Support running as an EFI application" diff --git a/lib/uuid.c b/lib/uuid.c index a1c88b9a622..8d99b540d9f 100644 --- a/lib/uuid.c +++ b/lib/uuid.c @@ -94,7 +94,7 @@ static const struct { "system", "EFI System Partition", PARTITION_SYSTEM_GUID, }, -#if defined(CONFIG_CMD_EFIDEBUG) || defined(CONFIG_EFI) +#if defined(CONFIG_CMD_EFIDEBUG) || defined(CONFIG_EFI_CLIENT) { NULL, "Device Path", PARTITION_SYSTEM_GUID, @@ -281,7 +281,7 @@ static const struct { EFI_CERT_TYPE_PKCS7_GUID, }, #endif -#if defined(CONFIG_CMD_EFIDEBUG) || defined(CONFIG_EFI) +#if defined(CONFIG_CMD_EFIDEBUG) || defined(CONFIG_EFI_CLIENT) { "EFI_LZMA_COMPRESSED", NULL, EFI_LZMA_COMPRESSED }, { "EFI_DXE_SERVICES", NULL, EFI_DXE_SERVICES }, { "EFI_HOB_LIST", NULL, EFI_HOB_LIST }, From 81ce639e61c990e4d3b88cc975bf552e8b509090 Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Wed, 28 May 2025 10:03:16 -0600 Subject: [PATCH 03/11] efi: Create a new CONFIG_EFI Create a Kconfig which indicates that EFI functionality is in use, either as a client (EFI app / stub) or provider (EFI loader). This will make it easier to share code between these two parts of U-Boot Signed-off-by: Simon Glass --- doc/develop/uefi/u-boot_on_efi.rst | 6 +++--- lib/efi/Kconfig | 12 ++++++++++++ lib/efi_client/Kconfig | 1 + lib/efi_loader/Kconfig | 3 +++ 4 files changed, 19 insertions(+), 3 deletions(-) create mode 100644 lib/efi/Kconfig diff --git a/doc/develop/uefi/u-boot_on_efi.rst b/doc/develop/uefi/u-boot_on_efi.rst index 9068894e408..177e887ebd9 100644 --- a/doc/develop/uefi/u-boot_on_efi.rst +++ b/doc/develop/uefi/u-boot_on_efi.rst @@ -45,9 +45,9 @@ First choose a board that has EFI support and obtain an EFI implementation for that board. It will be either 32-bit or 64-bit. Alternatively, you can opt for using QEMU [1] and the OVMF [2], as detailed below. -To build U-Boot as an EFI application, enable CONFIG_EFI_CLIENT and CONFIG_EFI_APP. -The efi-x86_app32 and efi-x86_app64 configs are set up for this. Just build -U-Boot as normal, e.g.:: +To build U-Boot as an EFI application, enable CONFIG_EFI_CLIENT and +CONFIG_EFI_APP. The efi-x86_app32 and efi-x86_app64 configs are set up for +this. Just build U-Boot as normal, e.g.:: make efi-x86_app32_defconfig make diff --git a/lib/efi/Kconfig b/lib/efi/Kconfig new file mode 100644 index 00000000000..fc6d5b6d6c2 --- /dev/null +++ b/lib/efi/Kconfig @@ -0,0 +1,12 @@ +# SPDX-License-Identifier: GPL-2.0-or-later +# +# Copyright 2025 Simon Glass +# + +config EFI + bool + help + Indicates that EFI functionality is enabled, either via EFI_CLIENT or + EFI_LOADER + + This is used to provide libraries shared by both. diff --git a/lib/efi_client/Kconfig b/lib/efi_client/Kconfig index ec413639bfe..723c98d2a75 100644 --- a/lib/efi_client/Kconfig +++ b/lib/efi_client/Kconfig @@ -5,6 +5,7 @@ config EFI_CLIENT bool "Support running U-Boot from EFI" depends on X86 imply X86_TSC_READ_BASE + select EFI help U-Boot can be started from EFI on certain platforms. This allows EFI to perform most of the system init and then jump to U-Boot for diff --git a/lib/efi_loader/Kconfig b/lib/efi_loader/Kconfig index 250b9469134..c2aa88f59fb 100644 --- a/lib/efi_loader/Kconfig +++ b/lib/efi_loader/Kconfig @@ -16,6 +16,7 @@ config EFI_LOADER depends on !EFI_STUB || !X86 || X86_64 || EFI_STUB_32BIT depends on !EFI_APP default y if !ARM || SYS_CPU = armv7 || SYS_CPU = armv8 + select EFI select CHARSET # We need to send DM events, dynamically, in the EFI block driver select DM_EVENT @@ -597,4 +598,6 @@ endif source "lib/efi_client/Kconfig" +source "lib/efi/Kconfig" + endmenu From ca0b03ba60b9d684df3205a02766ffbe90d6e85a Mon Sep 17 00:00:00 2001 From: Simon Glass Date: Wed, 28 May 2025 10:03:17 -0600 Subject: [PATCH 04/11] efi: Update maintainers for EFI_CLIENT The 'EFI PAYLOAD' entry really refers to the EFI loader and EFI APP refers to the app and the payload. Rename 'EFI PAYLOAD' to 'EFI LOADER' and 'EFI APP' to 'EFI CLIENT' Signed-off-by: Simon Glass Acked-by: Ilias Apalodimas --- MAINTAINERS | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/MAINTAINERS b/MAINTAINERS index 3e555596a1c..f31dc74bec1 100644 --- a/MAINTAINERS +++ b/MAINTAINERS @@ -1094,7 +1094,7 @@ F: drivers/core/ F: include/dm/ F: test/dm/ -EFI APP +EFI CLIENT M: Simon Glass M: Heinrich Schuchardt S: Maintained @@ -1108,7 +1108,7 @@ F: lib/efi_client/ F: scripts/build-efi.sh F: test/dm/efi_media.c -EFI PAYLOAD +EFI LOADER M: Heinrich Schuchardt M: Ilias Apalodimas S: Maintained From 62b3dbfc5efd1343c2c92f8ca5b3aa122744dca5 Mon Sep 17 00:00:00 2001 From: Mattijs Korpershoek Date: Wed, 25 Jun 2025 16:58:15 +0200 Subject: [PATCH 05/11] doc: board: ti: Add defconfigs for AM69-SK The J784S4 and AM69 Platforms page only details the defconfigs for J784S4. Mention the ones needed for AM69-SK as well, to guide users on how to build for that board. Signed-off-by: Mattijs Korpershoek Reviewed-by: Neha Malcom Francis --- doc/board/ti/j784s4_evm.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/board/ti/j784s4_evm.rst b/doc/board/ti/j784s4_evm.rst index 349fb394d74..22442874110 100644 --- a/doc/board/ti/j784s4_evm.rst +++ b/doc/board/ti/j784s4_evm.rst @@ -90,6 +90,15 @@ Set the variables corresponding to this platform: export OPTEE_PLATFORM=k3-j784s4 export OPTEE_EXTRA_ARGS="CFG_CONSOLE_UART=0x8" +.. note:: + + For AM69-SK, use the following U_BOOT_CFG instead: + + .. prompt:: bash + + export UBOOT_CFG_CORTEXR=am69_sk_r5_defconfig + export UBOOT_CFG_CORTEXA=am69_sk_a72_defconfig + .. j784s4_evm_rst_include_start_build_steps 1. Trusted Firmware-A From b9bb2627bbb672a8dce58c7da5c0e48b921a6b29 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Fri, 4 Jul 2025 16:22:12 +0200 Subject: [PATCH 06/11] efi_selftest: check system table pointer Enhance the debug support unit test. Acked-by: Ilias Apalodimas Signed-off-by: Heinrich Schuchardt --- lib/efi_selftest/efi_selftest_debug_support.c | 68 ++++++++++++++++++- 1 file changed, 67 insertions(+), 1 deletion(-) diff --git a/lib/efi_selftest/efi_selftest_debug_support.c b/lib/efi_selftest/efi_selftest_debug_support.c index 9ca8b3f82f5..ac77caaf561 100644 --- a/lib/efi_selftest/efi_selftest_debug_support.c +++ b/lib/efi_selftest/efi_selftest_debug_support.c @@ -9,6 +9,7 @@ #include #include +#include /** * efi_st_debug_support_execute() - execute test @@ -21,6 +22,12 @@ static int efi_st_debug_support_execute(void) { struct efi_debug_image_info_table_header *efi_st_debug_info_table_header = NULL; efi_guid_t efi_debug_image_info_table_guid = EFI_DEBUG_IMAGE_INFO_TABLE_GUID; + struct efi_mem_desc *memory_map; + efi_uintn_t map_size = 0; + efi_uintn_t map_key; + efi_uintn_t desc_size; + u32 desc_version; + efi_status_t ret; /* get EFI_DEBUG_IMAGE_INFO_TABLE */ efi_st_debug_info_table_header = efi_st_get_config_table(&efi_debug_image_info_table_guid); @@ -30,7 +37,66 @@ static int efi_st_debug_support_execute(void) return EFI_ST_FAILURE; } - return EFI_ST_SUCCESS; + /* Load memory map */ + ret = st_boottime->get_memory_map(&map_size, NULL, &map_key, &desc_size, + &desc_version); + if (ret != EFI_BUFFER_TOO_SMALL) { + efi_st_error + ("GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n"); + return EFI_ST_FAILURE; + } + /* Allocate extra space for newly allocated memory */ + map_size += sizeof(struct efi_mem_desc); + ret = st_boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size, + (void **)&memory_map); + if (ret != EFI_SUCCESS) { + efi_st_error("AllocatePool failed\n"); + return EFI_ST_FAILURE; + } + ret = st_boottime->get_memory_map(&map_size, memory_map, &map_key, + &desc_size, &desc_version); + if (ret != EFI_SUCCESS) { + efi_st_error("GetMemoryMap failed\n"); + return EFI_ST_FAILURE; + } + /* Find the system table pointer */ + for (efi_uintn_t i = 0; map_size; ++i, map_size -= desc_size) { + struct efi_mem_desc *entry = &memory_map[i]; + u64 end; + + if (entry->type != EFI_RUNTIME_SERVICES_DATA) + continue; + + end = entry->physical_start + + (entry->num_pages << EFI_PAGE_SHIFT); + for (u64 pos = ALIGN(entry->physical_start, SZ_4M); + pos <= end; pos += SZ_4M) { + struct efi_system_table_pointer *systab_pointer = + (void *)(uintptr_t)pos; + + /* check for overflow */ + if (pos < entry->physical_start) + break; + if (systab_pointer->signature == + EFI_SYSTEM_TABLE_SIGNATURE) { + if (systab_pointer->efi_system_table_base != + (uintptr_t)st_systable) { + efi_st_error("Wrong system table address\n"); + ret = EFI_ST_FAILURE; + goto out; + } + ret = EFI_ST_SUCCESS; + goto out; + } + } + } + efi_st_error("System table pointer not found\n"); + ret = EFI_ST_FAILURE; + +out: + st_boottime->free_pool(memory_map); + + return ret; } EFI_UNIT_TEST(debug_support) = { From aa703a816a62deb876a1e77ccff030a7cc60f344 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 8 Jul 2025 12:08:20 +0200 Subject: [PATCH 07/11] efi_loader: efi_realloc() must check efi_alloc() return value Avoid copying to NULL if out of memory. Fixes: 3c08df58cc43 ("lib: efi_loader: efi_memory.c: add efi_realloc() for realloc memory") Addresses-Coverity-ID: 569499: Null pointer dereferences (NULL_RETURNS) Reviewed-by: Ilias Apalodimas Signed-off-by: Heinrich Schuchardt --- lib/efi_loader/efi_memory.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/efi_loader/efi_memory.c b/lib/efi_loader/efi_memory.c index 6dfc698a247..b77c2f980cc 100644 --- a/lib/efi_loader/efi_memory.c +++ b/lib/efi_loader/efi_memory.c @@ -714,6 +714,8 @@ efi_status_t efi_realloc(void **ptr, size_t size) sizeof(struct efi_pool_allocation); new_ptr = efi_alloc(size); + if (!new_ptr) + return EFI_OUT_OF_RESOURCES; /* copy old data to new alloced buffer */ memcpy(new_ptr, *ptr, min(size, old_size)); From 7e2506e3a247c787a9ad4b4db00bc8e6a348df90 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 8 Jul 2025 13:14:35 +0200 Subject: [PATCH 08/11] efi_loader: correct EFI_DEBUG_TABLE_ENTRY_SIZE With the current code we allocate to little memory when adding entries to the EFI_DEBUG_INFO_TABLE and we fail to correctly move entries when an entry is removed. EFI_DEBUG_TABLE_ENTRY_SIZE must be the size of an entry in the EFI_DEBUG_INFO_TABLE, not the size of a pointer. Fixes: 146546138af5 ("efi: add EFI_DEBUG_IMAGE_INFO for debug") Addresses-Coverity-ID: CID 569498: Code maintainability issues (SIZEOF_MISMATCH) Reviewed-by: Ilias Apalodimas Signed-off-by: Heinrich Schuchardt --- lib/efi_loader/efi_debug_support.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/efi_loader/efi_debug_support.c b/lib/efi_loader/efi_debug_support.c index 186bdbce750..490b0bb7088 100644 --- a/lib/efi_loader/efi_debug_support.c +++ b/lib/efi_loader/efi_debug_support.c @@ -22,7 +22,7 @@ struct efi_debug_image_info_table_header efi_m_debug_info_table_header = { */ static u32 efi_m_max_table_entries; -#define EFI_DEBUG_TABLE_ENTRY_SIZE (sizeof(union efi_debug_image_info *)) +#define EFI_DEBUG_TABLE_ENTRY_SIZE (sizeof(union efi_debug_image_info)) /** * efi_initialize_system_table_pointer() - Initialize system table pointer From ca01c847f6c76fbcfc6e3b483b791f070621bda6 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 8 Jul 2025 13:37:32 +0200 Subject: [PATCH 09/11] efi_selftest: fix ESRT creation tests The code foresees that parameters descriptor_size and descriptor_count might be NULL and then dereferences them without further check. The size check must take into account the descriptor count. ImageInfo might be NULL. In this case we must not dereference it. Fixes: 4ac6041c3cbf ("efi: ESRT creation tests") Addresses-Coverity-ID: CID 569497: Null pointer dereferences (FORWARD_NULL) Signed-off-by: Heinrich Schuchardt --- lib/efi_selftest/efi_selftest_esrt.c | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/lib/efi_selftest/efi_selftest_esrt.c b/lib/efi_selftest/efi_selftest_esrt.c index b7688deb496..7eadac90fbc 100644 --- a/lib/efi_selftest/efi_selftest_esrt.c +++ b/lib/efi_selftest/efi_selftest_esrt.c @@ -69,10 +69,12 @@ EFIAPI efi_test_fmp_get_image_info(struct efi_firmware_management_protocol *this if (package_version_name) *package_version_name = NULL; - if (*image_info_size < sizeof(*image_info)) { - *image_info_size = *descriptor_size * *descriptor_count; + if (*image_info_size < sizeof(*image_info) * TEST_ESRT_NUM_ENTRIES) { + *image_info_size = sizeof(*image_info) * TEST_ESRT_NUM_ENTRIES; return EFI_BUFFER_TOO_SMALL; } + if (!image_info) + return EFI_INVALID_PARAMETER; for (int idx = 0; idx < TEST_ESRT_NUM_ENTRIES; idx++) image_info[idx] = static_img_info[idx]; From 5bab07296c1469562536b80480d625eadc823202 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Tue, 8 Jul 2025 13:48:50 +0200 Subject: [PATCH 10/11] efi_loader: add missing check in FMP.GetImageInfo() The UEFI 2.11 specification, chapter 23.1.3 requires EFI_FIRMWARE_MANAGEMENT_PROTOCOL.GetImageInfo() to return EFI_INVALID_PARAMETER if *ImageInfoSize is not too small and ImageInfo is NULL. Fixes: f27c20148511 ("efi_loader: add firmware management protocol for FIT image") Reviewed-by: Ilias Apalodimas Signed-off-by: Heinrich Schuchardt --- lib/efi_loader/efi_firmware.c | 2 ++ 1 file changed, 2 insertions(+) diff --git a/lib/efi_loader/efi_firmware.c b/lib/efi_loader/efi_firmware.c index 75501e21557..216df83de67 100644 --- a/lib/efi_loader/efi_firmware.c +++ b/lib/efi_loader/efi_firmware.c @@ -332,6 +332,8 @@ static efi_status_t efi_fill_image_desc_array( return EFI_BUFFER_TOO_SMALL; } + if (!image_info) + return EFI_INVALID_PARAMETER; *image_info_size = total_size; ret = efi_gen_capsule_guids(); From afd5426043b3ef6aa57f2a731f94125ae983395c Mon Sep 17 00:00:00 2001 From: Enric Balletbo i Serra Date: Wed, 16 Jul 2025 15:12:06 +0200 Subject: [PATCH 11/11] docs: Update FIT signature testing instructions Update the FIT signature testing instructions to use the pytest suite instead of the old vboot_test.sh script. Signed-off-by: Enric Balletbo i Serra Reviewed-by: Mattijs Korpershoek --- doc/usage/fit/signature.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/doc/usage/fit/signature.rst b/doc/usage/fit/signature.rst index b868dcbf9fd..e5b5a8432e9 100644 --- a/doc/usage/fit/signature.rst +++ b/doc/usage/fit/signature.rst @@ -433,16 +433,14 @@ CONFIG_LEGACY_IMAGE_FORMAT Testing ------- -An easy way to test signing and verification is to use the test script -provided in test/vboot/vboot_test.sh. This uses sandbox (a special version +An easy way to test signing and verification is to use the vboot tests +provided in the pytest suite. This uses sandbox (a special version of U-Boot which runs under Linux) to show the operation of a 'bootm' command loading and verifying images. A sample run is show below:: - $ make O=sandbox sandbox_config - $ make O=sandbox - $ O=sandbox ./test/vboot/vboot_test.sh + $ ./test/py/test.py --bd sandbox --build -k vboot Simple Verified Boot Test