Merge tag 'efi-2020-07-rc2-4' of https://gitlab.denx.de/u-boot/custodians/u-boot-efi

Pull request for UEFI sub-system for efi-2020-07-rc2-4

This pull request comprises:
* bug fixes
* documentation fixes
* a new function to determine u16 string sizes and its unit test

2 files changed, 108 insertions, 51 deletions

diff --git a/include/charset.h b/include/charset.h
index fde6bdd..5564f3b 100644
--- a/include/charset.h
+++ b/include/charset.h
@@ -55,7 +55,7 @@ size_t utf8_utf16_strnlen(const char *src, size_t count);
 /**
  * utf8_utf16_strlen() - length of a utf-8 string after conversion to utf-16
  *
- * @src:		utf-8 string
+ * @a:			utf-8 string
  * Return:		length in u16 after conversion to utf-16 without the
  *			trailing \0. If an invalid UTF-8 sequence is hit one
  *			u16 will be reserved for a replacement character.
@@ -75,8 +75,8 @@ int utf8_utf16_strncpy(u16 **dst, const char *src, size_t count);
 /**
  * utf8_utf16_strcpy() - copy utf-8 string to utf-16 string
  *
- * @dst:		destination buffer
- * @src:		source buffer
+ * @d:			destination buffer
+ * @s:			source buffer
  * Return:		-1 if the input parameters are invalid
  */
 #define utf8_utf16_strcpy(d, s) utf8_utf16_strncpy((d), (s), SIZE_MAX)
@@ -126,7 +126,7 @@ size_t utf16_utf8_strnlen(const u16 *src, size_t count);
 /**
  * utf16_utf8_strlen() - length of a utf-16 string after conversion to utf-8
  *
- * @src:		utf-16 string
+ * @a:			utf-16 string
  * Return:		length in bytes after conversion to utf-8 without the
  *			trailing \0. If an invalid UTF-16 sequence is hit one
  *			byte will be reserved for a replacement character.
@@ -146,8 +146,8 @@ int utf16_utf8_strncpy(char **dst, const u16 *src, size_t count);
 /**
  * utf16_utf8_strcpy() - copy utf-16 string to utf-8 string
  *
- * @dst:		destination buffer
- * @src:		source buffer
+ * @d:			destination buffer
+ * @s:			source buffer
  * Return:		-1 if the input parameters are invalid
  */
 #define utf16_utf8_strcpy(d, s) utf16_utf8_strncpy((d), (s), SIZE_MAX)
@@ -168,7 +168,7 @@ s32 utf_to_lower(const s32 code);
  */
 s32 utf_to_upper(const s32 code);
 
-/*
+/**
  * u16_strncmp() - compare two u16 string
  *
  * @s1:		first string to compare
@@ -181,6 +181,18 @@ s32 utf_to_upper(const s32 code);
  *		corresponding u16 in s2
  */
 int u16_strncmp(const u16 *s1, const u16 *s2, size_t n);
+
+/**
+ * u16_strcmp() - compare two u16 string
+ *
+ * @s1:		first string to compare
+ * @s2:		second string to compare
+ * Return:	0  if the first n u16 are the same in s1 and s2
+ *		< 0 if the first different u16 in s1 is less than the
+ *		corresponding u16 in s2
+ *		> 0 if the first different u16 in s1 is greater than the
+ *		corresponding u16 in s2
+ */
 #define u16_strcmp(s1, s2)	u16_strncmp((s1), (s2), SIZE_MAX)
 
 /**
@@ -190,12 +202,23 @@ int u16_strncmp(const u16 *s1, const u16 *s2, size_t n);
  * In the EFI context we explicitly need a function handling u16 strings.
  *
  * @in:			null terminated u16 string
- * ReturnValue:		number of non-zero words.
+ * Return:		number of non-zero words.
  *			This is not the number of utf-16 letters!
  */
 size_t u16_strlen(const void *in);
 
 /**
+ * u16_strsize() - count size of u16 string in bytes including the null
+ *		   character
+ *
+ * Counts the number of bytes occupied by a u16 string
+ *
+ * @in:			null terminated u16 string
+ * Return:		bytes in a u16 string
+ */
+size_t u16_strsize(const void *in);
+
+/**
  * u16_strlen - count non-zero words
  *
  * This function matches wscnlen_s() if the -fshort-wchar compiler flag is set.
@@ -203,7 +226,7 @@ size_t u16_strlen(const void *in);
  *
  * @in:			null terminated u16 string
  * @count:		maximum number of words to count
- * ReturnValue:		number of non-zero words.
+ * Return:		number of non-zero words.
  *			This is not the number of utf-16 letters!
  */
 size_t u16_strnlen(const u16 *in, size_t count);
@@ -240,10 +263,10 @@ u16 *u16_strdup(const void *src);
  * NOTE that a single utf16 character can generate up to 3 utf8
  * characters.  See MAX_UTF8_PER_UTF16.
  *
- * @dest   the destination buffer to write the utf8 characters
- * @src    the source utf16 string
- * @size   the number of utf16 characters to convert
- * @return the pointer to the first unwritten byte in 'dest'
+ * @dest:	the destination buffer to write the utf8 characters
+ * @src:	the source utf16 string
+ * @size:	the number of utf16 characters to convert
+ * Return:	the pointer to the first unwritten byte in 'dest'
  */
 uint8_t *utf16_to_utf8(uint8_t *dest, const uint16_t *src, size_t size);
 
diff --git a/include/efi_selftest.h b/include/efi_selftest.h
index eaee188..1515fda 100644
--- a/include/efi_selftest.h
+++ b/include/efi_selftest.h
@@ -17,69 +17,89 @@
 #define EFI_ST_SUCCESS 0
 #define EFI_ST_FAILURE 1
 #define EFI_ST_SUCCESS_STR L"SUCCESS"
-/*
- * Prints a message.
+
+/**
+ * efi_st_printf() - print a message
+ *
+ * @...:	format string followed by fields to print
  */
 #define efi_st_printf(...) \
 	(efi_st_printc(-1, __VA_ARGS__))
 
-/*
- * Prints an error message.
+/**
+ * efi_st_error() - prints an error message
  *
- * @...	format string followed by fields to print
+ * @...:	format string followed by fields to print
  */
 #define efi_st_error(...) \
 	(efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \
 	efi_st_printc(EFI_LIGHTRED, __VA_ARGS__))
 
-/*
- * Prints a TODO message.
+/**
+ * efi_st_todo() - prints a TODO message
  *
- * @...	format string followed by fields to print
+ * @...:	format string followed by fields to print
  */
 #define efi_st_todo(...) \
 	(efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \
 	efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \
 
-/*
+/**
+ * enum efi_test_phase - phase when test will be executed
+ *
  * A test may be setup and executed at boottime,
  * it may be setup at boottime and executed at runtime,
  * or it may be setup and executed at runtime.
  */
 enum efi_test_phase {
+	/**
+	 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: - execute before ExitBootServices
+	 *
+	 * Setup, execute, and teardown are executed before ExitBootServices().
+	 */
 	EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
+	/**
+	 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: - setup before ExitBootServices
+	 *
+	 * Setup is executed before ExitBootServices() while execute, and
+	 * teardown are executed after ExitBootServices().
+	 */
 	EFI_SETUP_BEFORE_BOOTTIME_EXIT,
+	/**
+	 * @EFI_SETUP_AFTER_BOOTTIME_EXIT: - setup after ExitBootServices
+	 *
+	 * Setup, execute, and teardown are executed after ExitBootServices().
+	 */
 	EFI_SETUP_AFTER_BOOTTIME_EXIT,
 };
 
 extern struct efi_simple_text_output_protocol *con_out;
 extern struct efi_simple_text_input_protocol *con_in;
 
-/*
- * Exit the boot services.
+/**
+ * efi_st_exit_boot_services() - exit the boot services
  *
- * The size of the memory map is determined.
- * Pool memory is allocated to copy the memory map.
- * The memory amp is copied and the map key is obtained.
- * The map key is used to exit the boot services.
+ * * The size of the memory map is determined.
+ * * Pool memory is allocated to copy the memory map.
+ * * The memory map is copied and the map key is obtained.
+ * * The map key is used to exit the boot services.
  */
 void efi_st_exit_boot_services(void);
 
-/*
- * Print a colored message
+/**
+ * efi_st_printc() - print a colored message
  *
- * @color	color, see constants in efi_api.h, use -1 for no color
- * @fmt		printf format
- * @...		arguments to be printed
- *		on return position of terminating zero word
+ * @color:	color, see constants in efi_api.h, use -1 for no color
+ * @fmt:	printf style format string
+ * @...:	arguments to be printed
  */
 void efi_st_printc(int color, const char *fmt, ...)
 		 __attribute__ ((format (__printf__, 2, 3)));
 
 /**
- * efi_st_translate_char() - translate a unicode character to a string
+ * efi_st_translate_char() - translate a Unicode character to a string
  *
- * @code:	unicode character
+ * @code:	Unicode character
  * Return:	string
  */
 u16 *efi_st_translate_char(u16 code);
@@ -87,38 +107,44 @@ u16 *efi_st_translate_char(u16 code);
 /**
  * efi_st_translate_code() - translate a scan code to a human readable string
  *
- * @code:	unicode character
- * Return:	string
+ * This function translates the scan code returned by the simple text input
+ * protocol to a human readable string, e.g. 0x04 is translated to L"Left".
+ *
+ * @code:	scan code
+ * Return:	Unicode string
  */
 u16 *efi_st_translate_code(u16 code);
 
-/*
- * Compare an u16 string to a char string.
+/**
+ * efi_st_strcmp_16_8() - compare an u16 string to a char string
+ *
+ * This function compares each u16 value to the char value at the same
+ * position. This function is only useful for ANSI strings.
  *
  * @buf1:	u16 string
  * @buf2:	char string
- * @return:	0 if both buffers contain the same bytes
+ * Return:	0 if both buffers contain equivalent strings
  */
 int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2);
 
-/*
- * Reads an Unicode character from the input device.
+/**
+ * efi_st_get_key() - reads an Unicode character from the input device
  *
- * @return: Unicode character
+ * Return:	Unicode character
  */
 u16 efi_st_get_key(void);
 
 /**
  * struct efi_unit_test - EFI unit test
  *
- * An efi_unit_test provides a interface to an EFI unit test.
+ * The &struct efi_unit_test structure provides a interface to an EFI unit test.
  *
- * @name:	name of unit test
+ * @name:	name of the unit test used in the user interface
  * @phase:	specifies when setup and execute are executed
- * @setup:	set up the unit test
- * @teardown:	tear down the unit test
- * @execute:	execute the unit test
- * @on_request:	test is only executed on request
+ * @setup:	set up function of the unit test
+ * @execute:	execute function of the unit test
+ * @teardown:	tear down function of the unit test
+ * @on_request:	flag indicating that the test shall only be executed on request
  */
 struct efi_unit_test {
 	const char *name;
@@ -130,7 +156,15 @@ struct efi_unit_test {
 	bool on_request;
 };
 
-/* Declare a new EFI unit test */
+/**
+ * EFI_UNIT_TEST() - macro to declare a new EFI unit test
+ *
+ * The macro EFI_UNIT_TEST() declares an EFI unit test using the &struct
+ * efi_unit_test structure. The test is added to a linker generated list which
+ * is evaluated by the 'bootefi selftest' command.
+ *
+ * @__name:	string identifying the unit test in the linker generated list
+ */
 #define EFI_UNIT_TEST(__name)						\
 	ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)