183d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+ 2623b3a57SHeinrich Schuchardt /* 3623b3a57SHeinrich Schuchardt * EFI efi_selftest 4623b3a57SHeinrich Schuchardt * 5623b3a57SHeinrich Schuchardt * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de> 6623b3a57SHeinrich Schuchardt */ 7623b3a57SHeinrich Schuchardt 8623b3a57SHeinrich Schuchardt #include <efi_selftest.h> 9623b3a57SHeinrich Schuchardt #include <vsprintf.h> 10623b3a57SHeinrich Schuchardt 11404ea593SSimon Glass /* Constants for test step bitmap */ 121f66a12eSHeinrich Schuchardt #define EFI_ST_SETUP 1 131f66a12eSHeinrich Schuchardt #define EFI_ST_EXECUTE 2 141f66a12eSHeinrich Schuchardt #define EFI_ST_TEARDOWN 4 151f66a12eSHeinrich Schuchardt 16623b3a57SHeinrich Schuchardt static const struct efi_system_table *systable; 17623b3a57SHeinrich Schuchardt static const struct efi_boot_services *boottime; 18623b3a57SHeinrich Schuchardt static const struct efi_runtime_services *runtime; 19623b3a57SHeinrich Schuchardt static efi_handle_t handle; 20623b3a57SHeinrich Schuchardt static u16 reset_message[] = L"Selftest completed"; 21*3c2c54caSHeinrich Schuchardt static int *setup_status; 22623b3a57SHeinrich Schuchardt 23623b3a57SHeinrich Schuchardt /* 24623b3a57SHeinrich Schuchardt * Exit the boot services. 25623b3a57SHeinrich Schuchardt * 26623b3a57SHeinrich Schuchardt * The size of the memory map is determined. 27623b3a57SHeinrich Schuchardt * Pool memory is allocated to copy the memory map. 28404ea593SSimon Glass * The memory map is copied and the map key is obtained. 29623b3a57SHeinrich Schuchardt * The map key is used to exit the boot services. 30623b3a57SHeinrich Schuchardt */ 31623b3a57SHeinrich Schuchardt void efi_st_exit_boot_services(void) 32623b3a57SHeinrich Schuchardt { 33f5a2a938SHeinrich Schuchardt efi_uintn_t map_size = 0; 34f5a2a938SHeinrich Schuchardt efi_uintn_t map_key; 35f5a2a938SHeinrich Schuchardt efi_uintn_t desc_size; 36623b3a57SHeinrich Schuchardt u32 desc_version; 37623b3a57SHeinrich Schuchardt efi_status_t ret; 38623b3a57SHeinrich Schuchardt struct efi_mem_desc *memory_map; 39623b3a57SHeinrich Schuchardt 40623b3a57SHeinrich Schuchardt ret = boottime->get_memory_map(&map_size, NULL, &map_key, &desc_size, 41623b3a57SHeinrich Schuchardt &desc_version); 42623b3a57SHeinrich Schuchardt if (ret != EFI_BUFFER_TOO_SMALL) { 43037ee6f9SHeinrich Schuchardt efi_st_error( 44037ee6f9SHeinrich Schuchardt "GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n"); 45623b3a57SHeinrich Schuchardt return; 46623b3a57SHeinrich Schuchardt } 47623b3a57SHeinrich Schuchardt /* Allocate extra space for newly allocated memory */ 48623b3a57SHeinrich Schuchardt map_size += sizeof(struct efi_mem_desc); 49623b3a57SHeinrich Schuchardt ret = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size, 50623b3a57SHeinrich Schuchardt (void **)&memory_map); 51623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 52037ee6f9SHeinrich Schuchardt efi_st_error("AllocatePool did not return EFI_SUCCESS\n"); 53623b3a57SHeinrich Schuchardt return; 54623b3a57SHeinrich Schuchardt } 55623b3a57SHeinrich Schuchardt ret = boottime->get_memory_map(&map_size, memory_map, &map_key, 56623b3a57SHeinrich Schuchardt &desc_size, &desc_version); 57623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 58037ee6f9SHeinrich Schuchardt efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n"); 59623b3a57SHeinrich Schuchardt return; 60623b3a57SHeinrich Schuchardt } 61623b3a57SHeinrich Schuchardt ret = boottime->exit_boot_services(handle, map_key); 62623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 63037ee6f9SHeinrich Schuchardt efi_st_error("ExitBootServices did not return EFI_SUCCESS\n"); 64623b3a57SHeinrich Schuchardt return; 65623b3a57SHeinrich Schuchardt } 66853540c8SHeinrich Schuchardt efi_st_printc(EFI_WHITE, "\nBoot services terminated\n"); 67623b3a57SHeinrich Schuchardt } 68623b3a57SHeinrich Schuchardt 69623b3a57SHeinrich Schuchardt /* 70623b3a57SHeinrich Schuchardt * Set up a test. 71623b3a57SHeinrich Schuchardt * 72623b3a57SHeinrich Schuchardt * @test the test to be executed 73623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 74e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 75623b3a57SHeinrich Schuchardt */ 76623b3a57SHeinrich Schuchardt static int setup(struct efi_unit_test *test, unsigned int *failures) 77623b3a57SHeinrich Schuchardt { 784c174394SHeinrich Schuchardt int ret; 794c174394SHeinrich Schuchardt 804c174394SHeinrich Schuchardt if (!test->setup) 81e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 82853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTBLUE, "\nSetting up '%s'\n", test->name); 834c174394SHeinrich Schuchardt ret = test->setup(handle, systable); 844c174394SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 85037ee6f9SHeinrich Schuchardt efi_st_error("Setting up '%s' failed\n", test->name); 86623b3a57SHeinrich Schuchardt ++*failures; 87623b3a57SHeinrich Schuchardt } else { 88853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTGREEN, 89853540c8SHeinrich Schuchardt "Setting up '%s' succeeded\n", test->name); 90623b3a57SHeinrich Schuchardt } 914c174394SHeinrich Schuchardt return ret; 92623b3a57SHeinrich Schuchardt } 93623b3a57SHeinrich Schuchardt 94623b3a57SHeinrich Schuchardt /* 95623b3a57SHeinrich Schuchardt * Execute a test. 96623b3a57SHeinrich Schuchardt * 97623b3a57SHeinrich Schuchardt * @test the test to be executed 98623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 99e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 100623b3a57SHeinrich Schuchardt */ 101623b3a57SHeinrich Schuchardt static int execute(struct efi_unit_test *test, unsigned int *failures) 102623b3a57SHeinrich Schuchardt { 103623b3a57SHeinrich Schuchardt int ret; 104623b3a57SHeinrich Schuchardt 105623b3a57SHeinrich Schuchardt if (!test->execute) 106e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 107853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTBLUE, "\nExecuting '%s'\n", test->name); 108623b3a57SHeinrich Schuchardt ret = test->execute(); 109e67e7249SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 110037ee6f9SHeinrich Schuchardt efi_st_error("Executing '%s' failed\n", test->name); 111623b3a57SHeinrich Schuchardt ++*failures; 112623b3a57SHeinrich Schuchardt } else { 113853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTGREEN, 114853540c8SHeinrich Schuchardt "Executing '%s' succeeded\n", test->name); 115623b3a57SHeinrich Schuchardt } 116623b3a57SHeinrich Schuchardt return ret; 117623b3a57SHeinrich Schuchardt } 118623b3a57SHeinrich Schuchardt 119623b3a57SHeinrich Schuchardt /* 120623b3a57SHeinrich Schuchardt * Tear down a test. 121623b3a57SHeinrich Schuchardt * 122623b3a57SHeinrich Schuchardt * @test the test to be torn down 123623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 124e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 125623b3a57SHeinrich Schuchardt */ 126623b3a57SHeinrich Schuchardt static int teardown(struct efi_unit_test *test, unsigned int *failures) 127623b3a57SHeinrich Schuchardt { 128623b3a57SHeinrich Schuchardt int ret; 129623b3a57SHeinrich Schuchardt 130623b3a57SHeinrich Schuchardt if (!test->teardown) 131e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 132853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTBLUE, "\nTearing down '%s'\n", test->name); 133623b3a57SHeinrich Schuchardt ret = test->teardown(); 134e67e7249SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 135037ee6f9SHeinrich Schuchardt efi_st_error("Tearing down '%s' failed\n", test->name); 136623b3a57SHeinrich Schuchardt ++*failures; 137623b3a57SHeinrich Schuchardt } else { 138853540c8SHeinrich Schuchardt efi_st_printc(EFI_LIGHTGREEN, 139853540c8SHeinrich Schuchardt "Tearing down '%s' succeeded\n", test->name); 140623b3a57SHeinrich Schuchardt } 141623b3a57SHeinrich Schuchardt return ret; 142623b3a57SHeinrich Schuchardt } 143623b3a57SHeinrich Schuchardt 144623b3a57SHeinrich Schuchardt /* 145d78e40d6SHeinrich Schuchardt * Check that a test exists. 1461f66a12eSHeinrich Schuchardt * 147d78e40d6SHeinrich Schuchardt * @testname: name of the test 148404ea593SSimon Glass * @return: test, or NULL if not found 1491f66a12eSHeinrich Schuchardt */ 150d78e40d6SHeinrich Schuchardt static struct efi_unit_test *find_test(const u16 *testname) 1511f66a12eSHeinrich Schuchardt { 1521f66a12eSHeinrich Schuchardt struct efi_unit_test *test; 1531f66a12eSHeinrich Schuchardt 1541f66a12eSHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 1551f66a12eSHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 156d78e40d6SHeinrich Schuchardt if (!efi_st_strcmp_16_8(testname, test->name)) 157d78e40d6SHeinrich Schuchardt return test; 158d78e40d6SHeinrich Schuchardt } 159d78e40d6SHeinrich Schuchardt efi_st_printf("\nTest '%ps' not found\n", testname); 160d78e40d6SHeinrich Schuchardt return NULL; 161d78e40d6SHeinrich Schuchardt } 162d78e40d6SHeinrich Schuchardt 163d78e40d6SHeinrich Schuchardt /* 164d78e40d6SHeinrich Schuchardt * List all available tests. 165d78e40d6SHeinrich Schuchardt */ 166d78e40d6SHeinrich Schuchardt static void list_all_tests(void) 167d78e40d6SHeinrich Schuchardt { 168d78e40d6SHeinrich Schuchardt struct efi_unit_test *test; 169d78e40d6SHeinrich Schuchardt 170d78e40d6SHeinrich Schuchardt /* List all tests */ 171d78e40d6SHeinrich Schuchardt efi_st_printf("\nAvailable tests:\n"); 172d78e40d6SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 173d78e40d6SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 174d78e40d6SHeinrich Schuchardt efi_st_printf("'%s'%s\n", test->name, 175d78e40d6SHeinrich Schuchardt test->on_request ? " - on request" : ""); 176d78e40d6SHeinrich Schuchardt } 177d78e40d6SHeinrich Schuchardt } 178d78e40d6SHeinrich Schuchardt 179d78e40d6SHeinrich Schuchardt /* 180d78e40d6SHeinrich Schuchardt * Execute test steps of one phase. 181d78e40d6SHeinrich Schuchardt * 182d78e40d6SHeinrich Schuchardt * @testname name of a single selected test or NULL 183d78e40d6SHeinrich Schuchardt * @phase test phase 184404ea593SSimon Glass * @steps steps to execute (mask with bits from EFI_ST_...) 185d78e40d6SHeinrich Schuchardt * failures returns EFI_ST_SUCCESS if all test steps succeeded 186d78e40d6SHeinrich Schuchardt */ 187d78e40d6SHeinrich Schuchardt void efi_st_do_tests(const u16 *testname, unsigned int phase, 188d78e40d6SHeinrich Schuchardt unsigned int steps, unsigned int *failures) 189d78e40d6SHeinrich Schuchardt { 1904c174394SHeinrich Schuchardt int i = 0; 191d78e40d6SHeinrich Schuchardt struct efi_unit_test *test; 192d78e40d6SHeinrich Schuchardt 193d78e40d6SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 1944c174394SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); 1954c174394SHeinrich Schuchardt ++test, ++i) { 196d78e40d6SHeinrich Schuchardt if (testname ? 197d78e40d6SHeinrich Schuchardt efi_st_strcmp_16_8(testname, test->name) : test->on_request) 198d78e40d6SHeinrich Schuchardt continue; 1991f66a12eSHeinrich Schuchardt if (test->phase != phase) 2001f66a12eSHeinrich Schuchardt continue; 2011f66a12eSHeinrich Schuchardt if (steps & EFI_ST_SETUP) 202*3c2c54caSHeinrich Schuchardt setup_status[i] = setup(test, failures); 203*3c2c54caSHeinrich Schuchardt if (steps & EFI_ST_EXECUTE && setup_status[i] == EFI_ST_SUCCESS) 2041f66a12eSHeinrich Schuchardt execute(test, failures); 2051f66a12eSHeinrich Schuchardt if (steps & EFI_ST_TEARDOWN) 2061f66a12eSHeinrich Schuchardt teardown(test, failures); 2071f66a12eSHeinrich Schuchardt } 2081f66a12eSHeinrich Schuchardt } 2091f66a12eSHeinrich Schuchardt 2101f66a12eSHeinrich Schuchardt /* 211623b3a57SHeinrich Schuchardt * Execute selftest of the EFI API 212623b3a57SHeinrich Schuchardt * 213623b3a57SHeinrich Schuchardt * This is the main entry point of the EFI selftest application. 214623b3a57SHeinrich Schuchardt * 215623b3a57SHeinrich Schuchardt * All tests use a driver model and are run in three phases: 216623b3a57SHeinrich Schuchardt * setup, execute, teardown. 217623b3a57SHeinrich Schuchardt * 218623b3a57SHeinrich Schuchardt * A test may be setup and executed at boottime, 219623b3a57SHeinrich Schuchardt * it may be setup at boottime and executed at runtime, 220623b3a57SHeinrich Schuchardt * or it may be setup and executed at runtime. 221623b3a57SHeinrich Schuchardt * 222623b3a57SHeinrich Schuchardt * After executing all tests the system is reset. 223623b3a57SHeinrich Schuchardt * 224623b3a57SHeinrich Schuchardt * @image_handle: handle of the loaded EFI image 225623b3a57SHeinrich Schuchardt * @systab: EFI system table 226623b3a57SHeinrich Schuchardt */ 227623b3a57SHeinrich Schuchardt efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle, 228623b3a57SHeinrich Schuchardt struct efi_system_table *systab) 229623b3a57SHeinrich Schuchardt { 230623b3a57SHeinrich Schuchardt unsigned int failures = 0; 231d78e40d6SHeinrich Schuchardt const u16 *testname = NULL; 232d78e40d6SHeinrich Schuchardt struct efi_loaded_image *loaded_image; 233d78e40d6SHeinrich Schuchardt efi_status_t ret; 234623b3a57SHeinrich Schuchardt 235623b3a57SHeinrich Schuchardt systable = systab; 236623b3a57SHeinrich Schuchardt boottime = systable->boottime; 237623b3a57SHeinrich Schuchardt runtime = systable->runtime; 238623b3a57SHeinrich Schuchardt handle = image_handle; 239623b3a57SHeinrich Schuchardt con_out = systable->con_out; 240623b3a57SHeinrich Schuchardt con_in = systable->con_in; 241623b3a57SHeinrich Schuchardt 242d78e40d6SHeinrich Schuchardt ret = boottime->handle_protocol(image_handle, &efi_guid_loaded_image, 243d78e40d6SHeinrich Schuchardt (void **)&loaded_image); 244d78e40d6SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 245c51e7df9SHeinrich Schuchardt efi_st_error("Cannot open loaded image protocol\n"); 246d78e40d6SHeinrich Schuchardt return ret; 247d78e40d6SHeinrich Schuchardt } 248d78e40d6SHeinrich Schuchardt 249d78e40d6SHeinrich Schuchardt if (loaded_image->load_options) 250d78e40d6SHeinrich Schuchardt testname = (u16 *)loaded_image->load_options; 251d78e40d6SHeinrich Schuchardt 252d78e40d6SHeinrich Schuchardt if (testname) { 253d78e40d6SHeinrich Schuchardt if (!efi_st_strcmp_16_8(testname, "list") || 254d78e40d6SHeinrich Schuchardt !find_test(testname)) { 255d78e40d6SHeinrich Schuchardt list_all_tests(); 256d78e40d6SHeinrich Schuchardt /* 257d78e40d6SHeinrich Schuchardt * TODO: 258d78e40d6SHeinrich Schuchardt * Once the Exit boottime service is correctly 259d78e40d6SHeinrich Schuchardt * implemented we should call 260d78e40d6SHeinrich Schuchardt * boottime->exit(image_handle, EFI_SUCCESS, 0, NULL); 261d78e40d6SHeinrich Schuchardt * here, cf. 262d78e40d6SHeinrich Schuchardt * https://lists.denx.de/pipermail/u-boot/2017-October/308720.html 263d78e40d6SHeinrich Schuchardt */ 264d78e40d6SHeinrich Schuchardt return EFI_SUCCESS; 265d78e40d6SHeinrich Schuchardt } 266d78e40d6SHeinrich Schuchardt } 267d78e40d6SHeinrich Schuchardt 268853540c8SHeinrich Schuchardt efi_st_printc(EFI_WHITE, "\nTesting EFI API implementation\n"); 269623b3a57SHeinrich Schuchardt 270d78e40d6SHeinrich Schuchardt if (testname) 271853540c8SHeinrich Schuchardt efi_st_printc(EFI_WHITE, "\nSelected test: '%ps'\n", testname); 272d78e40d6SHeinrich Schuchardt else 273853540c8SHeinrich Schuchardt efi_st_printc(EFI_WHITE, "\nNumber of tests to execute: %u\n", 274d78e40d6SHeinrich Schuchardt ll_entry_count(struct efi_unit_test, 275d78e40d6SHeinrich Schuchardt efi_unit_test)); 276623b3a57SHeinrich Schuchardt 2774c174394SHeinrich Schuchardt /* Allocate buffer for setup results */ 2784c174394SHeinrich Schuchardt ret = boottime->allocate_pool(EFI_RUNTIME_SERVICES_DATA, sizeof(int) * 2794c174394SHeinrich Schuchardt ll_entry_count(struct efi_unit_test, 2804c174394SHeinrich Schuchardt efi_unit_test), 281*3c2c54caSHeinrich Schuchardt (void **)&setup_status); 2824c174394SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 2834c174394SHeinrich Schuchardt efi_st_error("Allocate pool failed\n"); 2844c174394SHeinrich Schuchardt return ret; 2854c174394SHeinrich Schuchardt } 2864c174394SHeinrich Schuchardt 287623b3a57SHeinrich Schuchardt /* Execute boottime tests */ 288d78e40d6SHeinrich Schuchardt efi_st_do_tests(testname, EFI_EXECUTE_BEFORE_BOOTTIME_EXIT, 2891f66a12eSHeinrich Schuchardt EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN, 2901f66a12eSHeinrich Schuchardt &failures); 291623b3a57SHeinrich Schuchardt 292623b3a57SHeinrich Schuchardt /* Execute mixed tests */ 293d78e40d6SHeinrich Schuchardt efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT, 2941f66a12eSHeinrich Schuchardt EFI_ST_SETUP, &failures); 295623b3a57SHeinrich Schuchardt 296623b3a57SHeinrich Schuchardt efi_st_exit_boot_services(); 297623b3a57SHeinrich Schuchardt 298d78e40d6SHeinrich Schuchardt efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT, 2991f66a12eSHeinrich Schuchardt EFI_ST_EXECUTE | EFI_ST_TEARDOWN, &failures); 300623b3a57SHeinrich Schuchardt 301623b3a57SHeinrich Schuchardt /* Execute runtime tests */ 302d78e40d6SHeinrich Schuchardt efi_st_do_tests(testname, EFI_SETUP_AFTER_BOOTTIME_EXIT, 3031f66a12eSHeinrich Schuchardt EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN, 3041f66a12eSHeinrich Schuchardt &failures); 305623b3a57SHeinrich Schuchardt 306623b3a57SHeinrich Schuchardt /* Give feedback */ 307853540c8SHeinrich Schuchardt efi_st_printc(EFI_WHITE, "\nSummary: %u failures\n\n", failures); 308623b3a57SHeinrich Schuchardt 309623b3a57SHeinrich Schuchardt /* Reset system */ 310404ea593SSimon Glass efi_st_printf("Preparing for reset. Press any key...\n"); 311623b3a57SHeinrich Schuchardt efi_st_get_key(); 312623b3a57SHeinrich Schuchardt runtime->reset_system(EFI_RESET_WARM, EFI_NOT_READY, 313623b3a57SHeinrich Schuchardt sizeof(reset_message), reset_message); 314037ee6f9SHeinrich Schuchardt efi_st_printf("\n"); 315404ea593SSimon Glass efi_st_error("Reset failed\n"); 316623b3a57SHeinrich Schuchardt 317623b3a57SHeinrich Schuchardt return EFI_UNSUPPORTED; 318623b3a57SHeinrich Schuchardt } 319