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
 -----BEGIN PGP SIGNATURE-----
 
 iQIzBAABCAAdFiEEbcT5xx8ppvoGt20zxIHbvCwFGsQFAl65bSgACgkQxIHbvCwF
 GsRr/g/9GlyZVDKw+TGeSvaSUYc5P4VTMDXYLyDSJ9NZBmkRGs5QCj9YrVKI9qw9
 p4WFkt2lPnVv3GW6woUYlkvTG/pUX1KYyeUSp9rbzT7n14qwSnCwwHAc0z7UIp3Z
 0cTGtDUgxAFK4t7tcZLG4JUB8LW3Kdz9sExOiFSoMIqlniVZboZFBr+mwY0MCpaO
 92Wv915jJnLSWJkuOn2o3IhKBNZQfGSVeXQ8kaiNjHN+Qq1+iTolZPr6MS+BiaYX
 qzBixaUYwZKP19+L5O451y5vXSUfe8mu8RGcJaZFKxOcFATYvXMwoYgFGZAe5tIa
 aCu5Ig3MJeotaSn6pbiSoYiXoMzgT3TyjW+ER3Mf3BBJ7SWoMyau1Imtc0E11BOg
 tfqTD8+QdRgNuTzhScbkdC+MgOUYGlxdtS+v9ElAzZCNXgdsCl2g883IAg7Ouj3N
 tBy2pMe6aClGwF3gHBtT+YyY/Hz2lwX7oyJtXEuIGx/Brm9T33qA6Oko5m517LpJ
 fGlSpjpLC10byb3yjOZ7keoHZe5JA6quqiiKAIs+8fWfBxrXj7DAeQzqpbOlkQM5
 iZIshe0Fly6u3ZXiZEZM446eMRP5+Cu+X4CQDGqkG2nFI85Jq4sXVe06s/09O32b
 l0AGxvziD9c7MBU7NW1m6rv5KXjN1SXC7j6sKX/EO0JV0vNBdgI=
 =vqQZ
 -----END PGP SIGNATURE-----

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
This commit is contained in:
Tom Rini 2020-05-11 14:23:23 -04:00
commit ac14bc4169
10 changed files with 154 additions and 57 deletions

View File

@ -480,6 +480,11 @@ static int do_efi_show_memmap(cmd_tbl_t *cmdtp, int flag,
EFI_PHYS_ADDR_WIDTH - 5, spc, EFI_PHYS_ADDR_WIDTH - 3, spc);
printf("================ %.*s %.*s ==========\n",
EFI_PHYS_ADDR_WIDTH, sep, EFI_PHYS_ADDR_WIDTH, sep);
/*
* Coverity check: dereferencing null pointer "map."
* This is a false positive as memmap will always be
* populated by allocate_pool() above.
*/
for (i = 0, map = memmap; i < map_size / sizeof(*map); map++, i++) {
if (map->type < ARRAY_SIZE(efi_mem_type_string))
type = efi_mem_type_string[map->type];
@ -602,7 +607,7 @@ static int do_efi_boot_add(cmd_tbl_t *cmdtp, int flag,
+ sizeof(struct efi_device_path); /* for END */
/* optional data */
if (argc < 6)
if (argc == 6)
lo.optional_data = NULL;
else
lo.optional_data = (const u8 *)argv[6];
@ -965,7 +970,7 @@ static int do_efi_boot_next(cmd_tbl_t *cmdtp, int flag,
return CMD_RET_USAGE;
bootnext = (u16)simple_strtoul(argv[1], &endp, 16);
if (*endp != '\0' || bootnext > 0xffff) {
if (*endp) {
printf("invalid value: %s\n", argv[1]);
r = CMD_RET_FAILURE;
goto out;

View File

@ -163,3 +163,12 @@ Unicode Collation protocol
.. kernel-doc:: lib/efi_loader/efi_unicode_collation.c
:internal:
Unit testing
------------
The following library functions are provided to support writing UEFI unit tests.
The should not be used elsewhere.
.. kernel-doc:: include/efi_selftest.h
:internal:

View File

@ -9,3 +9,4 @@ U-Boot API documentation
efi
linker_lists
serial
unicode

7
doc/api/unicode.rst Normal file
View File

@ -0,0 +1,7 @@
.. SPDX-License-Identifier: GPL-2.0+
Unicode support
===============
.. kernel-doc:: include/charset.h
:internal:

View File

@ -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,11 +202,22 @@ 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
*
@ -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);

View File

@ -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)

View File

@ -379,6 +379,11 @@ size_t u16_strnlen(const u16 *in, size_t count)
return i;
}
size_t u16_strsize(const void *in)
{
return (u16_strlen(in) + 1) * sizeof(u16);
}
u16 *u16_strcpy(u16 *dest, const u16 *src)
{
u16 *tmp = dest;

View File

@ -293,12 +293,12 @@ bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
efi_image_region_add(regs, efi, &opt->CheckSum, 0);
if (nt64->OptionalHeader.NumberOfRvaAndSizes <= ctidx) {
efi_image_region_add(regs,
&opt->CheckSum + 1,
&opt->Subsystem,
efi + opt->SizeOfHeaders, 0);
} else {
/* Skip Certificates Table */
efi_image_region_add(regs,
&opt->CheckSum + 1,
&opt->Subsystem,
&opt->DataDirectory[ctidx], 0);
efi_image_region_add(regs,
&opt->DataDirectory[ctidx] + 1,
@ -313,7 +313,7 @@ bool efi_image_parse(void *efi, size_t len, struct efi_image_regions **regp,
IMAGE_OPTIONAL_HEADER32 *opt = &nt->OptionalHeader;
efi_image_region_add(regs, efi, &opt->CheckSum, 0);
efi_image_region_add(regs, &opt->CheckSum + 1,
efi_image_region_add(regs, &opt->Subsystem,
&opt->DataDirectory[ctidx], 0);
efi_image_region_add(regs, &opt->DataDirectory[ctidx] + 1,
efi + opt->SizeOfHeaders, 0);

View File

@ -767,7 +767,10 @@ static efi_status_t parse_uboot_variable(char *variable,
/* guid */
c = *(name - 1);
*(name - 1) = '\0'; /* guid need be null-terminated here */
uuid_str_to_bin(guid, (unsigned char *)vendor, UUID_STR_FORMAT_GUID);
if (uuid_str_to_bin(guid, (unsigned char *)vendor,
UUID_STR_FORMAT_GUID))
/* The only error would be EINVAL. */
return EFI_INVALID_PARAMETER;
*(name - 1) = c;
/* attributes */

View File

@ -581,6 +581,16 @@ static int unicode_test_u16_strncmp(struct unit_test_state *uts)
}
UNICODE_TEST(unicode_test_u16_strncmp);
static int unicode_test_u16_strsize(struct unit_test_state *uts)
{
ut_asserteq_64(u16_strsize(c1), 14);
ut_asserteq_64(u16_strsize(c2), 18);
ut_asserteq_64(u16_strsize(c3), 8);
ut_asserteq_64(u16_strsize(c4), 14);
return 0;
}
UNICODE_TEST(unicode_test_u16_strsize);
int do_ut_unicode(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
struct unit_test *tests = ll_entry_start(struct unit_test, unicode_test);