4 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
6 * SPDX-License-Identifier: GPL-2.0+
9 #include <efi_selftest.h>
13 * Constants for test step bitmap
15 #define EFI_ST_SETUP 1
16 #define EFI_ST_EXECUTE 2
17 #define EFI_ST_TEARDOWN 4
19 static const struct efi_system_table *systable;
20 static const struct efi_boot_services *boottime;
21 static const struct efi_runtime_services *runtime;
22 static efi_handle_t handle;
23 static u16 reset_message[] = L"Selftest completed";
26 * Exit the boot services.
28 * The size of the memory map is determined.
29 * Pool memory is allocated to copy the memory map.
30 * The memory amp is copied and the map key is obtained.
31 * The map key is used to exit the boot services.
33 void efi_st_exit_boot_services(void)
35 unsigned long map_size = 0;
36 unsigned long map_key;
37 unsigned long desc_size;
40 struct efi_mem_desc *memory_map;
42 ret = boottime->get_memory_map(&map_size, NULL, &map_key, &desc_size,
44 if (ret != EFI_BUFFER_TOO_SMALL) {
46 "GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n");
49 /* Allocate extra space for newly allocated memory */
50 map_size += sizeof(struct efi_mem_desc);
51 ret = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, map_size,
52 (void **)&memory_map);
53 if (ret != EFI_SUCCESS) {
54 efi_st_error("AllocatePool did not return EFI_SUCCESS\n");
57 ret = boottime->get_memory_map(&map_size, memory_map, &map_key,
58 &desc_size, &desc_version);
59 if (ret != EFI_SUCCESS) {
60 efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n");
63 ret = boottime->exit_boot_services(handle, map_key);
64 if (ret != EFI_SUCCESS) {
65 efi_st_error("ExitBootServices did not return EFI_SUCCESS\n");
68 efi_st_printf("\nBoot services terminated\n");
74 * @test the test to be executed
75 * @failures counter that will be incremented if a failure occurs
76 * @return EFI_ST_SUCCESS for success
78 static int setup(struct efi_unit_test *test, unsigned int *failures)
83 return EFI_ST_SUCCESS;
84 efi_st_printf("\nSetting up '%s'\n", test->name);
85 ret = test->setup(handle, systable);
86 if (ret != EFI_ST_SUCCESS) {
87 efi_st_error("Setting up '%s' failed\n", test->name);
90 efi_st_printf("Setting up '%s' succeeded\n", test->name);
98 * @test the test to be executed
99 * @failures counter that will be incremented if a failure occurs
100 * @return EFI_ST_SUCCESS for success
102 static int execute(struct efi_unit_test *test, unsigned int *failures)
107 return EFI_ST_SUCCESS;
108 efi_st_printf("\nExecuting '%s'\n", test->name);
109 ret = test->execute();
110 if (ret != EFI_ST_SUCCESS) {
111 efi_st_error("Executing '%s' failed\n", test->name);
114 efi_st_printf("Executing '%s' succeeded\n", test->name);
122 * @test the test to be torn down
123 * @failures counter that will be incremented if a failure occurs
124 * @return EFI_ST_SUCCESS for success
126 static int teardown(struct efi_unit_test *test, unsigned int *failures)
131 return EFI_ST_SUCCESS;
132 efi_st_printf("\nTearing down '%s'\n", test->name);
133 ret = test->teardown();
134 if (ret != EFI_ST_SUCCESS) {
135 efi_st_error("Tearing down '%s' failed\n", test->name);
138 efi_st_printf("Tearing down '%s' succeeded\n", test->name);
144 * Check that a test exists.
146 * @testname: name of the test
149 static struct efi_unit_test *find_test(const u16 *testname)
151 struct efi_unit_test *test;
153 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
154 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
155 if (!efi_st_strcmp_16_8(testname, test->name))
158 efi_st_printf("\nTest '%ps' not found\n", testname);
163 * List all available tests.
165 static void list_all_tests(void)
167 struct efi_unit_test *test;
170 efi_st_printf("\nAvailable tests:\n");
171 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
172 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
173 efi_st_printf("'%s'%s\n", test->name,
174 test->on_request ? " - on request" : "");
179 * Execute test steps of one phase.
181 * @testname name of a single selected test or NULL
183 * @steps steps to execute
184 * failures returns EFI_ST_SUCCESS if all test steps succeeded
186 void efi_st_do_tests(const u16 *testname, unsigned int phase,
187 unsigned int steps, unsigned int *failures)
189 struct efi_unit_test *test;
191 for (test = ll_entry_start(struct efi_unit_test, efi_unit_test);
192 test < ll_entry_end(struct efi_unit_test, efi_unit_test); ++test) {
194 efi_st_strcmp_16_8(testname, test->name) : test->on_request)
196 if (test->phase != phase)
198 if (steps & EFI_ST_SETUP)
199 setup(test, failures);
200 if (steps & EFI_ST_EXECUTE)
201 execute(test, failures);
202 if (steps & EFI_ST_TEARDOWN)
203 teardown(test, failures);
208 * Execute selftest of the EFI API
210 * This is the main entry point of the EFI selftest application.
212 * All tests use a driver model and are run in three phases:
213 * setup, execute, teardown.
215 * A test may be setup and executed at boottime,
216 * it may be setup at boottime and executed at runtime,
217 * or it may be setup and executed at runtime.
219 * After executing all tests the system is reset.
221 * @image_handle: handle of the loaded EFI image
222 * @systab: EFI system table
224 efi_status_t EFIAPI efi_selftest(efi_handle_t image_handle,
225 struct efi_system_table *systab)
227 unsigned int failures = 0;
228 const u16 *testname = NULL;
229 struct efi_loaded_image *loaded_image;
233 boottime = systable->boottime;
234 runtime = systable->runtime;
235 handle = image_handle;
236 con_out = systable->con_out;
237 con_in = systable->con_in;
239 ret = boottime->handle_protocol(image_handle, &efi_guid_loaded_image,
240 (void **)&loaded_image);
241 if (ret != EFI_SUCCESS) {
242 efi_st_error("Cannot open loaded image protocol");
246 if (loaded_image->load_options)
247 testname = (u16 *)loaded_image->load_options;
250 if (!efi_st_strcmp_16_8(testname, "list") ||
251 !find_test(testname)) {
255 * Once the Exit boottime service is correctly
256 * implemented we should call
257 * boottime->exit(image_handle, EFI_SUCCESS, 0, NULL);
259 * https://lists.denx.de/pipermail/u-boot/2017-October/308720.html
265 efi_st_printf("\nTesting EFI API implementation\n");
268 efi_st_printf("\nSelected test: '%ps'\n", testname);
270 efi_st_printf("\nNumber of tests to execute: %u\n",
271 ll_entry_count(struct efi_unit_test,
274 /* Execute boottime tests */
275 efi_st_do_tests(testname, EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
276 EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN,
279 /* Execute mixed tests */
280 efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT,
281 EFI_ST_SETUP, &failures);
283 efi_st_exit_boot_services();
285 efi_st_do_tests(testname, EFI_SETUP_BEFORE_BOOTTIME_EXIT,
286 EFI_ST_EXECUTE | EFI_ST_TEARDOWN, &failures);
288 /* Execute runtime tests */
289 efi_st_do_tests(testname, EFI_SETUP_AFTER_BOOTTIME_EXIT,
290 EFI_ST_SETUP | EFI_ST_EXECUTE | EFI_ST_TEARDOWN,
294 efi_st_printf("\nSummary: %u failures\n\n", failures);
297 efi_st_printf("Preparing for reset. Press any key.\n");
299 runtime->reset_system(EFI_RESET_WARM, EFI_NOT_READY,
300 sizeof(reset_message), reset_message);
302 efi_st_error("Reset failed.\n");
304 return EFI_UNSUPPORTED;