4 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
6 * SPDX-License-Identifier: GPL-2.0+
9 #include <efi_selftest.h>
12 static const struct efi_system_table *systable;
13 static const struct efi_boot_services *boottime;
14 static const struct efi_runtime_services *runtime;
15 static efi_handle_t handle;
16 static u16 reset_message[] = L"Selftest completed";
19 * Exit the boot services.
21 * The size of the memory map is determined.
22 * Pool memory is allocated to copy the memory map.
23 * The memory amp is copied and the map key is obtained.
24 * The map key is used to exit the boot services.
26 void efi_st_exit_boot_services(void)
28 unsigned long map_size = 0;
29 unsigned long map_key;
30 unsigned long desc_size;
33 struct efi_mem_desc *memory_map;
35 ret = boottime->get_memory_map(&map_size, NULL, &map_key, &desc_size,
37 if (ret != EFI_BUFFER_TOO_SMALL) {
39 "GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n");
42 /* Allocate extra space for newly allocated memory */
43 map_size += sizeof(struct efi_mem_desc);
44 ret = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size,
45 (void **)&memory_map);
46 if (ret != EFI_SUCCESS) {
47 efi_st_error("AllocatePool did not return EFI_SUCCESS\n");
50 ret = boottime->get_memory_map(&map_size, memory_map, &map_key,
51 &desc_size, &desc_version);
52 if (ret != EFI_SUCCESS) {
53 efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n");
56 ret = boottime->exit_boot_services(handle, map_key);
57 if (ret != EFI_SUCCESS) {
58 efi_st_error("ExitBootServices did not return EFI_SUCCESS\n");
61 efi_st_printf("\nBoot services terminated\n");
67 * @test the test to be executed
68 * @failures counter that will be incremented if a failure occurs
69 * @return EFI_ST_SUCCESS for success
71 static int setup(struct efi_unit_test *test, unsigned int *failures)
76 return EFI_ST_SUCCESS;
77 efi_st_printf("\nSetting up '%s'\n", test->name);
78 ret = test->setup(handle, systable);
79 if (ret != EFI_ST_SUCCESS) {
80 efi_st_error("Setting up '%s' failed\n", test->name);
83 efi_st_printf("Setting up '%s' succeeded\n", test->name);
91 * @test the test to be executed
92 * @failures counter that will be incremented if a failure occurs
93 * @return EFI_ST_SUCCESS for success
95 static int execute(struct efi_unit_test *test, unsigned int *failures)
100 return EFI_ST_SUCCESS;
101 efi_st_printf("\nExecuting '%s'\n", test->name);
102 ret = test->execute();
103 if (ret != EFI_ST_SUCCESS) {
104 efi_st_error("Executing '%s' failed\n", test->name);
107 efi_st_printf("Executing '%s' succeeded\n", test->name);
115 * @test the test to be torn down
116 * @failures counter that will be incremented if a failure occurs
117 * @return EFI_ST_SUCCESS for success
119 static int teardown(struct efi_unit_test *test, unsigned int *failures)
124 return EFI_ST_SUCCESS;
125 efi_st_printf("\nTearing down '%s'\n", test->name);
126 ret = test->teardown();
127 if (ret != EFI_ST_SUCCESS) {
128 efi_st_error("Tearing down '%s' failed\n", test->name);
131 efi_st_printf("Tearing down '%s' succeeded\n", test->name);
137 * Execute selftest of the EFI API
139 * This is the main entry point of the EFI selftest application.
141 * All tests use a driver model and are run in three phases:
142 * setup, execute, teardown.
144 * A test may be setup and executed at boottime,
145 * it may be setup at boottime and executed at runtime,
146 * or it may be setup and executed at runtime.
148 * After executing all tests the system is reset.
150 * @image_handle: handle of the loaded EFI image
151 * @systab: EFI system table
153 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
154 struct efi_system_table *systab)
156 struct efi_unit_test *test;
157 unsigned int failures = 0;
160 boottime = systable->boottime;
161 runtime = systable->runtime;
162 handle = image_handle;
163 con_out = systable->con_out;
164 con_in = systable->con_in;
166 efi_st_printf("\nTesting EFI API implementation\n");
168 efi_st_printf("\nNumber of tests to execute: %u\n",
169 ll_entry_count(struct efi_unit_test, efi_unit_test));
171 /* Execute boottime tests */
172 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
173 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
174 if (test->phase == EFI_EXECUTE_BEFORE_BOOTTIME_EXIT) {
175 setup(test, &failures);
176 execute(test, &failures);
177 teardown(test, &failures);
181 /* Execute mixed tests */
182 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
183 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
184 if (test->phase == EFI_SETUP_BEFORE_BOOTTIME_EXIT)
185 setup(test, &failures);
188 efi_st_exit_boot_services();
190 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
191 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
192 if (test->phase == EFI_SETUP_BEFORE_BOOTTIME_EXIT) {
193 execute(test, &failures);
194 teardown(test, &failures);
198 /* Execute runtime tests */
199 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
200 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
201 if (test->phase == EFI_SETUP_AFTER_BOOTTIME_EXIT) {
202 setup(test, &failures);
203 execute(test, &failures);
204 teardown(test, &failures);
209 efi_st_printf("\nSummary: %u failures\n\n", failures);
212 efi_st_printf("Preparing for reset. Press any key.\n");
214 runtime->reset_system(EFI_RESET_WARM, EFI_NOT_READY,
215 sizeof(reset_message), reset_message);
217 efi_st_error("Reset failed.\n");
219 return EFI_UNSUPPORTED;