From b411b62fb4a02b8c885fa86a1e8c5145cfa1b65f Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sun, 28 Mar 2021 10:41:00 +0200 Subject: efi_loader: improve documentation of enum efi_test_phase * Avoid a warning: "Incorrect use of kernel-doc format". * Remove duplicate text. * Clarify usage of EFI_SETTING_VIRTUAL_ADDRESS_MAP. Signed-off-by: Heinrich Schuchardt --- include/efi_selftest.h | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) (limited to 'include') diff --git a/include/efi_selftest.h b/include/efi_selftest.h index 07b619901c0..94ceb147330 100644 --- a/include/efi_selftest.h +++ b/include/efi_selftest.h @@ -53,21 +53,25 @@ */ enum efi_test_phase { /** - * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: - execute before ExitBootServices + * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: * * Setup, execute, and teardown are executed before ExitBootServices(). */ EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1, /** - * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: - setup before ExitBootServices + * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: * * Setup is executed before ExitBootServices() while execute, and * teardown are executed after ExitBootServices(). */ EFI_SETUP_BEFORE_BOOTTIME_EXIT, /** - * @EFI_SETTING_VIRTUAL_ADDRESS_MAP - calls SetVirtualAddressMap() - * Execute calls SetVirtualAddressMap(). + * @EFI_SETTING_VIRTUAL_ADDRESS_MAP: + * + * Execute calls SetVirtualAddressMap(). Setup is executed before + * ExitBootServices() while execute is executed after + * ExitBootServices(), and after the execute of tests marked as + * @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter. */ EFI_SETTING_VIRTUAL_ADDRESS_MAP, }; -- cgit v1.3.1 From f44c214541b8e194e284a4d08e95f3ed09a0b262 Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sun, 28 Mar 2021 10:53:18 +0200 Subject: linker_lists: document ll_entry_ref parameters Avoid 'make htmldocs' build warnings: ./include/linker_lists.h:224: warning: Function parameter or member '_type' not described in 'll_entry_ref' ./include/linker_lists.h:224: warning: Function parameter or member '_name' not described in 'll_entry_ref' ./include/linker_lists.h:224: warning: Function parameter or member '_list' not described in 'll_entry_ref' Fixes: 851144350b6f ("linker_lists: Allow use in data structures") Signed-off-by: Heinrich Schuchardt Reviewed-by: Simon Glass --- include/linker_lists.h | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'include') diff --git a/include/linker_lists.h b/include/linker_lists.h index 81a280a8841..2fea54c8343 100644 --- a/include/linker_lists.h +++ b/include/linker_lists.h @@ -219,6 +219,10 @@ * * This is like ll_entry_get(), but without the extra code, so it is suitable * for putting into data structures. + * + * @_type: C type of the list entry, e.g. 'struct foo' + * @_name: name of the entry + * @_list: name of the list */ #define ll_entry_ref(_type, _name, _list) \ ((_type *)&_u_boot_list_2_##_list##_2_##_name) -- cgit v1.3.1 From 4bc4798f41cbe000a685f4c037d54f71f0859a3c Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Sun, 28 Mar 2021 11:57:31 +0200 Subject: efi_loader: documentation codepage_437[] Variables cannot be documented via kernel-doc. Avoid 'make htmldocs' build warning ./include/charset.h:19: warning: cannot understand function prototype: 'const u16 codepage_437[128]; ' Fixes: 70616a1ed8c7 ("efi_loader: move codepage 437 table") Signed-off-by: Heinrich Schuchardt --- include/charset.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'include') diff --git a/include/charset.h b/include/charset.h index a911160f192..b93d0230923 100644 --- a/include/charset.h +++ b/include/charset.h @@ -13,7 +13,7 @@ #define MAX_UTF8_PER_UTF16 3 -/** +/* * codepage_437 - Unicode to codepage 437 translation table */ extern const u16 codepage_437[128]; -- cgit v1.3.1 From 9933eb47e5ad8ee96fd45e16df1df291c87c36ea Mon Sep 17 00:00:00 2001 From: Heinrich Schuchardt Date: Fri, 2 Apr 2021 22:16:22 +0200 Subject: efi_loader: EFI_UNACCEPTED_MEMORY_TYPE * UEFI spec 2.9 introduced a new memory type EFI_UNACCEPTED_MEMORY_TYPE. Add it to enum EFI_MEMORY_TYPE. * Add missing EFI_MEMORY_CPU_CRYPTO constant * Improve description of EFI_PERSISTENT_MEMORY_TYPE Signed-off-by: Heinrich Schuchardt --- include/efi.h | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) (limited to 'include') diff --git a/include/efi.h b/include/efi.h index 503fbf060bf..6417a9b8c53 100644 --- a/include/efi.h +++ b/include/efi.h @@ -180,9 +180,13 @@ enum efi_mem_type { */ EFI_PAL_CODE, /* - * Non-volatile memory. + * Byte addressable non-volatile memory. */ EFI_PERSISTENT_MEMORY_TYPE, + /* + * Unaccepted memory must be accepted by boot target before usage. + */ + EFI_UNACCEPTED_MEMORY_TYPE, EFI_MAX_MEMORY_TYPE, }; @@ -201,6 +205,7 @@ enum efi_mem_type { ((u64)0x0000000000010000ULL) /* higher reliability */ #define EFI_MEMORY_RO ((u64)0x0000000000020000ULL) /* read-only */ #define EFI_MEMORY_SP ((u64)0x0000000000040000ULL) /* specific-purpose memory (SPM) */ +#define EFI_MEMORY_CPU_CRYPTO ((u64)0x0000000000080000ULL) /* cryptographically protectable */ #define EFI_MEMORY_RUNTIME ((u64)0x8000000000000000ULL) /* range requires runtime mapping */ #define EFI_MEM_DESC_VERSION 1 -- cgit v1.3.1