mirror of
https://github.com/brain-hackers/u-boot-brain
synced 2024-08-24 02:48:51 +09:00
![Tom Rini](/assets/img/avatar_default.png)
When U-Boot started using SPDX tags we were among the early adopters and there weren't a lot of other examples to borrow from. So we picked the area of the file that usually had a full license text and replaced it with an appropriate SPDX-License-Identifier: entry. Since then, the Linux Kernel has adopted SPDX tags and they place it as the very first line in a file (except where shebangs are used, then it's second line) and with slightly different comment styles than us. In part due to community overlap, in part due to better tag visibility and in part for other minor reasons, switch over to that style. This commit changes all instances where we have a single declared license in the tag as both the before and after are identical in tag contents. There's also a few places where I found we did not have a tag and have introduced one. Signed-off-by: Tom Rini <trini@konsulko.com>
308 lines
8.1 KiB
C
308 lines
8.1 KiB
C
// SPDX-License-Identifier: GPL-2.0+
|
|
/*
|
|
* EFI efi_selftest
|
|
*
|
|
* Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
|
|
*/
|
|
|
|
#include <efi_selftest.h>
|
|
#include <vsprintf.h>
|
|
|
|
/*
|
|
* Constants for test step bitmap
|
|
*/
|
|
#define EFI_ST_SETUP 1
|
|
#define EFI_ST_EXECUTE 2
|
|
#define EFI_ST_TEARDOWN 4
|
|
|
|
static const struct efi_system_table *systable;
|
|
static const struct efi_boot_services *boottime;
|
|
static const struct efi_runtime_services *runtime;
|
|
static efi_handle_t handle;
|
|
static u16 reset_message[] = L"Selftest completed";
|
|
|
|
/*
|
|
* 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.
|
|
*/
|
|
void efi_st_exit_boot_services(void)
|
|
{
|
|
efi_uintn_t map_size = 0;
|
|
efi_uintn_t map_key;
|
|
efi_uintn_t desc_size;
|
|
u32 desc_version;
|
|
efi_status_t ret;
|
|
struct efi_mem_desc *memory_map;
|
|
|
|
ret = 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;
|
|
}
|
|
/* Allocate extra space for newly allocated memory */
|
|
map_size += sizeof(struct efi_mem_desc);
|
|
ret = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size,
|
|
(void **)&memory_map);
|
|
if (ret != EFI_SUCCESS) {
|
|
efi_st_error("AllocatePool did not return EFI_SUCCESS\n");
|
|
return;
|
|
}
|
|
ret = boottime->get_memory_map(&map_size, memory_map, &map_key,
|
|
&desc_size, &desc_version);
|
|
if (ret != EFI_SUCCESS) {
|
|
efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n");
|
|
return;
|
|
}
|
|
ret = boottime->exit_boot_services(handle, map_key);
|
|
if (ret != EFI_SUCCESS) {
|
|
efi_st_error("ExitBootServices did not return EFI_SUCCESS\n");
|
|
return;
|
|
}
|
|
efi_st_printc(EFI_WHITE, "\nBoot services terminated\n");
|
|
}
|
|
|
|
/*
|
|
* Set up a test.
|
|
*
|
|
* @test the test to be executed
|
|
* @failures counter that will be incremented if a failure occurs
|
|
* @return EFI_ST_SUCCESS for success
|
|
*/
|
|
static int setup(struct efi_unit_test *test, unsigned int *failures)
|
|
{
|
|
if (!test->setup) {
|
|
test->setup_ok = EFI_ST_SUCCESS;
|
|
return EFI_ST_SUCCESS;
|
|
}
|
|
efi_st_printc(EFI_LIGHTBLUE, "\nSetting up '%s'\n", test->name);
|
|
test->setup_ok = test->setup(handle, systable);
|
|
if (test->setup_ok != EFI_ST_SUCCESS) {
|
|
efi_st_error("Setting up '%s' failed\n", test->name);
|
|
++*failures;
|
|
} else {
|
|
efi_st_printc(EFI_LIGHTGREEN,
|
|
"Setting up '%s' succeeded\n", test->name);
|
|
}
|
|
return test->setup_ok;
|
|
}
|
|
|
|
/*
|
|
* Execute a test.
|
|
*
|
|
* @test the test to be executed
|
|
* @failures counter that will be incremented if a failure occurs
|
|
* @return EFI_ST_SUCCESS for success
|
|
*/
|
|
static int execute(struct efi_unit_test *test, unsigned int *failures)
|
|
{
|
|
int ret;
|
|
|
|
if (!test->execute)
|
|
return EFI_ST_SUCCESS;
|
|
efi_st_printc(EFI_LIGHTBLUE, "\nExecuting '%s'\n", test->name);
|
|
ret = test->execute();
|
|
if (ret != EFI_ST_SUCCESS) {
|
|
efi_st_error("Executing '%s' failed\n", test->name);
|
|
++*failures;
|
|
} else {
|
|
efi_st_printc(EFI_LIGHTGREEN,
|
|
"Executing '%s' succeeded\n", test->name);
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
/*
|
|
* Tear down a test.
|
|
*
|
|
* @test the test to be torn down
|
|
* @failures counter that will be incremented if a failure occurs
|
|
* @return EFI_ST_SUCCESS for success
|
|
*/
|
|
static int teardown(struct efi_unit_test *test, unsigned int *failures)
|
|
{
|
|
int ret;
|
|
|
|
if (!test->teardown)
|
|
return EFI_ST_SUCCESS;
|
|
efi_st_printc(EFI_LIGHTBLUE, "\nTearing down '%s'\n", test->name);
|
|
ret = test->teardown();
|
|
if (ret != EFI_ST_SUCCESS) {
|
|
efi_st_error("Tearing down '%s' failed\n", test->name);
|
|
++*failures;
|
|
} else {
|
|
efi_st_printc(EFI_LIGHTGREEN,
|
|
"Tearing down '%s' succeeded\n", test->name);
|
|
}
|
|
return ret;
|
|
}
|
|
|
|
/*
|
|
* Check that a test exists.
|
|
*
|
|
* @testname: name of the test
|
|
* @return: test
|
|
*/
|
|
static struct efi_unit_test *find_test(const u16 *testname)
|
|
{
|
|
struct efi_unit_test *test;
|
|
|
|
for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
|
|
test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
|
|
if (!efi_st_strcmp_16_8(testname, test->name))
|
|
return test;
|
|
}
|
|
efi_st_printf("\nTest '%ps' not found\n", testname);
|
|
return NULL;
|
|
}
|
|
|
|
/*
|
|
* List all available tests.
|
|
*/
|
|
static void list_all_tests(void)
|
|
{
|
|
struct efi_unit_test *test;
|
|
|
|
/* List all tests */
|
|
efi_st_printf("\nAvailable tests:\n");
|
|
for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
|
|
test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
|
|
efi_st_printf("'%s'%s\n", test->name,
|
|
test->on_request ? " - on request" : "");
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Execute test steps of one phase.
|
|
*
|
|
* @testname name of a single selected test or NULL
|
|
* @phase test phase
|
|
* @steps steps to execute
|
|
* failures returns EFI_ST_SUCCESS if all test steps succeeded
|
|
*/
|
|
void efi_st_do_tests(const u16 *testname, unsigned int phase,
|
|
unsigned int steps, unsigned int *failures)
|
|
{
|
|
struct efi_unit_test *test;
|
|
|
|
for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
|
|
test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
|
|
if (testname ?
|
|
efi_st_strcmp_16_8(testname, test->name) : test->on_request)
|
|
continue;
|
|
if (test->phase != phase)
|
|
continue;
|
|
if (steps & EFI_ST_SETUP)
|
|
setup(test, failures);
|
|
if (steps & EFI_ST_EXECUTE && test->setup_ok == EFI_ST_SUCCESS)
|
|
execute(test, failures);
|
|
if (steps & EFI_ST_TEARDOWN)
|
|
teardown(test, failures);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* Execute selftest of the EFI API
|
|
*
|
|
* This is the main entry point of the EFI selftest application.
|
|
*
|
|
* All tests use a driver model and are run in three phases:
|
|
* setup, execute, teardown.
|
|
*
|
|
* 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.
|
|
*
|
|
* After executing all tests the system is reset.
|
|
*
|
|
* @image_handle: handle of the loaded EFI image
|
|
* @systab: EFI system table
|
|
*/
|
|
efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
|
|
struct efi_system_table *systab)
|
|
{
|
|
unsigned int failures = 0;
|
|
const u16 *testname = NULL;
|
|
struct efi_loaded_image *loaded_image;
|
|
efi_status_t ret;
|
|
|
|
systable = systab;
|
|
boottime = systable->boottime;
|
|
runtime = systable->runtime;
|
|
handle = image_handle;
|
|
con_out = systable->con_out;
|
|
con_in = systable->con_in;
|
|
|
|
ret = boottime->handle_protocol(image_handle, &efi_guid_loaded_image,
|
|
(void **)&loaded_image);
|
|
if (ret != EFI_SUCCESS) {
|
|
efi_st_error("Cannot open loaded image protocol\n");
|
|
return ret;
|
|
}
|
|
|
|
if (loaded_image->load_options)
|
|
testname = (u16 *)loaded_image->load_options;
|
|
|
|
if (testname) {
|
|
if (!efi_st_strcmp_16_8(testname, "list") ||
|
|
!find_test(testname)) {
|
|
list_all_tests();
|
|
/*
|
|
* TODO:
|
|
* Once the Exit boottime service is correctly
|
|
* implemented we should call
|
|
* boottime->exit(image_handle, EFI_SUCCESS, 0, NULL);
|
|
* here, cf.
|
|
* https://lists.denx.de/pipermail/u-boot/2017-October/308720.html
|
|
*/
|
|
return EFI_SUCCESS;
|
|
}
|
|
}
|
|
|
|
efi_st_printc(EFI_WHITE, "\nTesting EFI API implementation\n");
|
|
|
|
if (testname)
|
|
efi_st_printc(EFI_WHITE, "\nSelected test: '%ps'\n", testname);
|
|
else
|
|
efi_st_printc(EFI_WHITE, "\nNumber of tests to execute: %u\n",
|
|
ll_entry_count(struct efi_unit_test,
|
|
efi_unit_test));
|
|
|
|
/* Execute boottime tests */
|
|
efi_st_do_tests(testname, EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
|
|
EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN,
|
|
&failures);
|
|
|
|
/* Execute mixed tests */
|
|
efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT,
|
|
EFI_ST_SETUP, &failures);
|
|
|
|
efi_st_exit_boot_services();
|
|
|
|
efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT,
|
|
EFI_ST_EXECUTE | EFI_ST_TEARDOWN, &failures);
|
|
|
|
/* Execute runtime tests */
|
|
efi_st_do_tests(testname, EFI_SETUP_AFTER_BOOTTIME_EXIT,
|
|
EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN,
|
|
&failures);
|
|
|
|
/* Give feedback */
|
|
efi_st_printc(EFI_WHITE, "\nSummary: %u failures\n\n", failures);
|
|
|
|
/* Reset system */
|
|
efi_st_printf("Preparing for reset. Press any key.\n");
|
|
efi_st_get_key();
|
|
runtime->reset_system(EFI_RESET_WARM, EFI_NOT_READY,
|
|
sizeof(reset_message), reset_message);
|
|
efi_st_printf("\n");
|
|
efi_st_error("Reset failed.\n");
|
|
|
|
return EFI_UNSUPPORTED;
|
|
}
|