1623b3a57SHeinrich Schuchardt /* 2623b3a57SHeinrich Schuchardt * EFI efi_selftest 3623b3a57SHeinrich Schuchardt * 4623b3a57SHeinrich Schuchardt * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de> 5623b3a57SHeinrich Schuchardt * 6623b3a57SHeinrich Schuchardt * SPDX-License-Identifier: GPL-2.0+ 7623b3a57SHeinrich Schuchardt */ 8623b3a57SHeinrich Schuchardt 9623b3a57SHeinrich Schuchardt #include <efi_selftest.h> 10623b3a57SHeinrich Schuchardt #include <vsprintf.h> 11623b3a57SHeinrich Schuchardt 12623b3a57SHeinrich Schuchardt static const struct efi_system_table *systable; 13623b3a57SHeinrich Schuchardt static const struct efi_boot_services *boottime; 14623b3a57SHeinrich Schuchardt static const struct efi_runtime_services *runtime; 15623b3a57SHeinrich Schuchardt static efi_handle_t handle; 16623b3a57SHeinrich Schuchardt static u16 reset_message[] = L"Selftest completed"; 17623b3a57SHeinrich Schuchardt 18623b3a57SHeinrich Schuchardt /* 19623b3a57SHeinrich Schuchardt * Exit the boot services. 20623b3a57SHeinrich Schuchardt * 21623b3a57SHeinrich Schuchardt * The size of the memory map is determined. 22623b3a57SHeinrich Schuchardt * Pool memory is allocated to copy the memory map. 23623b3a57SHeinrich Schuchardt * The memory amp is copied and the map key is obtained. 24623b3a57SHeinrich Schuchardt * The map key is used to exit the boot services. 25623b3a57SHeinrich Schuchardt */ 26623b3a57SHeinrich Schuchardt void efi_st_exit_boot_services(void) 27623b3a57SHeinrich Schuchardt { 28623b3a57SHeinrich Schuchardt unsigned long map_size = 0; 29623b3a57SHeinrich Schuchardt unsigned long map_key; 30623b3a57SHeinrich Schuchardt unsigned long desc_size; 31623b3a57SHeinrich Schuchardt u32 desc_version; 32623b3a57SHeinrich Schuchardt efi_status_t ret; 33623b3a57SHeinrich Schuchardt struct efi_mem_desc *memory_map; 34623b3a57SHeinrich Schuchardt 35623b3a57SHeinrich Schuchardt ret = boottime->get_memory_map(&map_size, NULL, &map_key, &desc_size, 36623b3a57SHeinrich Schuchardt &desc_version); 37623b3a57SHeinrich Schuchardt if (ret != EFI_BUFFER_TOO_SMALL) { 38037ee6f9SHeinrich Schuchardt efi_st_error( 39037ee6f9SHeinrich Schuchardt "GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n"); 40623b3a57SHeinrich Schuchardt return; 41623b3a57SHeinrich Schuchardt } 42623b3a57SHeinrich Schuchardt /* Allocate extra space for newly allocated memory */ 43623b3a57SHeinrich Schuchardt map_size += sizeof(struct efi_mem_desc); 44623b3a57SHeinrich Schuchardt ret = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size, 45623b3a57SHeinrich Schuchardt (void **)&memory_map); 46623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 47037ee6f9SHeinrich Schuchardt efi_st_error("AllocatePool did not return EFI_SUCCESS\n"); 48623b3a57SHeinrich Schuchardt return; 49623b3a57SHeinrich Schuchardt } 50623b3a57SHeinrich Schuchardt ret = boottime->get_memory_map(&map_size, memory_map, &map_key, 51623b3a57SHeinrich Schuchardt &desc_size, &desc_version); 52623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 53037ee6f9SHeinrich Schuchardt efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n"); 54623b3a57SHeinrich Schuchardt return; 55623b3a57SHeinrich Schuchardt } 56623b3a57SHeinrich Schuchardt ret = boottime->exit_boot_services(handle, map_key); 57623b3a57SHeinrich Schuchardt if (ret != EFI_SUCCESS) { 58037ee6f9SHeinrich Schuchardt efi_st_error("ExitBootServices did not return EFI_SUCCESS\n"); 59623b3a57SHeinrich Schuchardt return; 60623b3a57SHeinrich Schuchardt } 61623b3a57SHeinrich Schuchardt efi_st_printf("\nBoot services terminated\n"); 62623b3a57SHeinrich Schuchardt } 63623b3a57SHeinrich Schuchardt 64623b3a57SHeinrich Schuchardt /* 65623b3a57SHeinrich Schuchardt * Set up a test. 66623b3a57SHeinrich Schuchardt * 67623b3a57SHeinrich Schuchardt * @test the test to be executed 68623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 69*e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 70623b3a57SHeinrich Schuchardt */ 71623b3a57SHeinrich Schuchardt static int setup(struct efi_unit_test *test, unsigned int *failures) 72623b3a57SHeinrich Schuchardt { 73623b3a57SHeinrich Schuchardt int ret; 74623b3a57SHeinrich Schuchardt 75623b3a57SHeinrich Schuchardt if (!test->setup) 76*e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 77623b3a57SHeinrich Schuchardt efi_st_printf("\nSetting up '%s'\n", test->name); 78623b3a57SHeinrich Schuchardt ret = test->setup(handle, systable); 79*e67e7249SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 80037ee6f9SHeinrich Schuchardt efi_st_error("Setting up '%s' failed\n", test->name); 81623b3a57SHeinrich Schuchardt ++*failures; 82623b3a57SHeinrich Schuchardt } else { 83623b3a57SHeinrich Schuchardt efi_st_printf("Setting up '%s' succeeded\n", test->name); 84623b3a57SHeinrich Schuchardt } 85623b3a57SHeinrich Schuchardt return ret; 86623b3a57SHeinrich Schuchardt } 87623b3a57SHeinrich Schuchardt 88623b3a57SHeinrich Schuchardt /* 89623b3a57SHeinrich Schuchardt * Execute a test. 90623b3a57SHeinrich Schuchardt * 91623b3a57SHeinrich Schuchardt * @test the test to be executed 92623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 93*e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 94623b3a57SHeinrich Schuchardt */ 95623b3a57SHeinrich Schuchardt static int execute(struct efi_unit_test *test, unsigned int *failures) 96623b3a57SHeinrich Schuchardt { 97623b3a57SHeinrich Schuchardt int ret; 98623b3a57SHeinrich Schuchardt 99623b3a57SHeinrich Schuchardt if (!test->execute) 100*e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 101623b3a57SHeinrich Schuchardt efi_st_printf("\nExecuting '%s'\n", test->name); 102623b3a57SHeinrich Schuchardt ret = test->execute(); 103*e67e7249SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 104037ee6f9SHeinrich Schuchardt efi_st_error("Executing '%s' failed\n", test->name); 105623b3a57SHeinrich Schuchardt ++*failures; 106623b3a57SHeinrich Schuchardt } else { 107623b3a57SHeinrich Schuchardt efi_st_printf("Executing '%s' succeeded\n", test->name); 108623b3a57SHeinrich Schuchardt } 109623b3a57SHeinrich Schuchardt return ret; 110623b3a57SHeinrich Schuchardt } 111623b3a57SHeinrich Schuchardt 112623b3a57SHeinrich Schuchardt /* 113623b3a57SHeinrich Schuchardt * Tear down a test. 114623b3a57SHeinrich Schuchardt * 115623b3a57SHeinrich Schuchardt * @test the test to be torn down 116623b3a57SHeinrich Schuchardt * @failures counter that will be incremented if a failure occurs 117*e67e7249SHeinrich Schuchardt * @return EFI_ST_SUCCESS for success 118623b3a57SHeinrich Schuchardt */ 119623b3a57SHeinrich Schuchardt static int teardown(struct efi_unit_test *test, unsigned int *failures) 120623b3a57SHeinrich Schuchardt { 121623b3a57SHeinrich Schuchardt int ret; 122623b3a57SHeinrich Schuchardt 123623b3a57SHeinrich Schuchardt if (!test->teardown) 124*e67e7249SHeinrich Schuchardt return EFI_ST_SUCCESS; 125623b3a57SHeinrich Schuchardt efi_st_printf("\nTearing down '%s'\n", test->name); 126623b3a57SHeinrich Schuchardt ret = test->teardown(); 127*e67e7249SHeinrich Schuchardt if (ret != EFI_ST_SUCCESS) { 128037ee6f9SHeinrich Schuchardt efi_st_error("Tearing down '%s' failed\n", test->name); 129623b3a57SHeinrich Schuchardt ++*failures; 130623b3a57SHeinrich Schuchardt } else { 131623b3a57SHeinrich Schuchardt efi_st_printf("Tearing down '%s' succeeded\n", test->name); 132623b3a57SHeinrich Schuchardt } 133623b3a57SHeinrich Schuchardt return ret; 134623b3a57SHeinrich Schuchardt } 135623b3a57SHeinrich Schuchardt 136623b3a57SHeinrich Schuchardt /* 137623b3a57SHeinrich Schuchardt * Execute selftest of the EFI API 138623b3a57SHeinrich Schuchardt * 139623b3a57SHeinrich Schuchardt * This is the main entry point of the EFI selftest application. 140623b3a57SHeinrich Schuchardt * 141623b3a57SHeinrich Schuchardt * All tests use a driver model and are run in three phases: 142623b3a57SHeinrich Schuchardt * setup, execute, teardown. 143623b3a57SHeinrich Schuchardt * 144623b3a57SHeinrich Schuchardt * A test may be setup and executed at boottime, 145623b3a57SHeinrich Schuchardt * it may be setup at boottime and executed at runtime, 146623b3a57SHeinrich Schuchardt * or it may be setup and executed at runtime. 147623b3a57SHeinrich Schuchardt * 148623b3a57SHeinrich Schuchardt * After executing all tests the system is reset. 149623b3a57SHeinrich Schuchardt * 150623b3a57SHeinrich Schuchardt * @image_handle: handle of the loaded EFI image 151623b3a57SHeinrich Schuchardt * @systab: EFI system table 152623b3a57SHeinrich Schuchardt */ 153623b3a57SHeinrich Schuchardt efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle, 154623b3a57SHeinrich Schuchardt struct efi_system_table *systab) 155623b3a57SHeinrich Schuchardt { 156623b3a57SHeinrich Schuchardt struct efi_unit_test *test; 157623b3a57SHeinrich Schuchardt unsigned int failures = 0; 158623b3a57SHeinrich Schuchardt 159623b3a57SHeinrich Schuchardt systable = systab; 160623b3a57SHeinrich Schuchardt boottime = systable->boottime; 161623b3a57SHeinrich Schuchardt runtime = systable->runtime; 162623b3a57SHeinrich Schuchardt handle = image_handle; 163623b3a57SHeinrich Schuchardt con_out = systable->con_out; 164623b3a57SHeinrich Schuchardt con_in = systable->con_in; 165623b3a57SHeinrich Schuchardt 166623b3a57SHeinrich Schuchardt efi_st_printf("\nTesting EFI API implementation\n"); 167623b3a57SHeinrich Schuchardt 168623b3a57SHeinrich Schuchardt efi_st_printf("\nNumber of tests to execute: %u\n", 169623b3a57SHeinrich Schuchardt ll_entry_count(struct efi_unit_test, efi_unit_test)); 170623b3a57SHeinrich Schuchardt 171623b3a57SHeinrich Schuchardt /* Execute boottime tests */ 172623b3a57SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 173623b3a57SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 174623b3a57SHeinrich Schuchardt if (test->phase == EFI_EXECUTE_BEFORE_BOOTTIME_EXIT) { 175623b3a57SHeinrich Schuchardt setup(test, &failures); 176623b3a57SHeinrich Schuchardt execute(test, &failures); 177623b3a57SHeinrich Schuchardt teardown(test, &failures); 178623b3a57SHeinrich Schuchardt } 179623b3a57SHeinrich Schuchardt } 180623b3a57SHeinrich Schuchardt 181623b3a57SHeinrich Schuchardt /* Execute mixed tests */ 182623b3a57SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 183623b3a57SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 184623b3a57SHeinrich Schuchardt if (test->phase == EFI_SETUP_BEFORE_BOOTTIME_EXIT) 185623b3a57SHeinrich Schuchardt setup(test, &failures); 186623b3a57SHeinrich Schuchardt } 187623b3a57SHeinrich Schuchardt 188623b3a57SHeinrich Schuchardt efi_st_exit_boot_services(); 189623b3a57SHeinrich Schuchardt 190623b3a57SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 191623b3a57SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 192623b3a57SHeinrich Schuchardt if (test->phase == EFI_SETUP_BEFORE_BOOTTIME_EXIT) { 193623b3a57SHeinrich Schuchardt execute(test, &failures); 194623b3a57SHeinrich Schuchardt teardown(test, &failures); 195623b3a57SHeinrich Schuchardt } 196623b3a57SHeinrich Schuchardt } 197623b3a57SHeinrich Schuchardt 198623b3a57SHeinrich Schuchardt /* Execute runtime tests */ 199623b3a57SHeinrich Schuchardt for (test = ll_entry_start(struct efi_unit_test, efi_unit_test); 200623b3a57SHeinrich Schuchardt test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) { 201623b3a57SHeinrich Schuchardt if (test->phase == EFI_SETUP_AFTER_BOOTTIME_EXIT) { 202623b3a57SHeinrich Schuchardt setup(test, &failures); 203623b3a57SHeinrich Schuchardt execute(test, &failures); 204623b3a57SHeinrich Schuchardt teardown(test, &failures); 205623b3a57SHeinrich Schuchardt } 206623b3a57SHeinrich Schuchardt } 207623b3a57SHeinrich Schuchardt 208623b3a57SHeinrich Schuchardt /* Give feedback */ 209623b3a57SHeinrich Schuchardt efi_st_printf("\nSummary: %u failures\n\n", failures); 210623b3a57SHeinrich Schuchardt 211623b3a57SHeinrich Schuchardt /* Reset system */ 212623b3a57SHeinrich Schuchardt efi_st_printf("Preparing for reset. Press any key.\n"); 213623b3a57SHeinrich Schuchardt efi_st_get_key(); 214623b3a57SHeinrich Schuchardt runtime->reset_system(EFI_RESET_WARM, EFI_NOT_READY, 215623b3a57SHeinrich Schuchardt sizeof(reset_message), reset_message); 216037ee6f9SHeinrich Schuchardt efi_st_printf("\n"); 217037ee6f9SHeinrich Schuchardt efi_st_error("Reset failed.\n"); 218623b3a57SHeinrich Schuchardt 219623b3a57SHeinrich Schuchardt return EFI_UNSUPPORTED; 220623b3a57SHeinrich Schuchardt } 221