1 // SPDX-License-Identifier: GPL-2.0+
5 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
8 #include <efi_selftest.h>
12 * Constants for test step bitmap
14 #define EFI_ST_SETUP 1
15 #define EFI_ST_EXECUTE 2
16 #define EFI_ST_TEARDOWN 4
18 static const struct efi_system_table
*systable
;
19 static const struct efi_boot_services
*boottime
;
20 static const struct efi_runtime_services
*runtime
;
21 static efi_handle_t handle
;
22 static u16 reset_message
[] = L
"Selftest completed";
25 * Exit the boot services.
27 * The size of the memory map is determined.
28 * Pool memory is allocated to copy the memory map.
29 * The memory amp is copied and the map key is obtained.
30 * The map key is used to exit the boot services.
32 void efi_st_exit_boot_services(void)
34 efi_uintn_t map_size
= 0;
36 efi_uintn_t desc_size
;
39 struct efi_mem_desc
*memory_map
;
41 ret
= boottime
->get_memory_map(&map_size
, NULL
, &map_key
, &desc_size
,
43 if (ret
!= EFI_BUFFER_TOO_SMALL
) {
45 "GetMemoryMap did not return EFI_BUFFER_TOO_SMALL\n");
48 /* Allocate extra space for newly allocated memory */
49 map_size
+= sizeof(struct efi_mem_desc
);
50 ret
= boottime
->allocate_pool(EFI_BOOT_SERVICES_DATA
, map_size
,
51 (void **)&memory_map
);
52 if (ret
!= EFI_SUCCESS
) {
53 efi_st_error("AllocatePool did not return EFI_SUCCESS\n");
56 ret
= boottime
->get_memory_map(&map_size
, memory_map
, &map_key
,
57 &desc_size
, &desc_version
);
58 if (ret
!= EFI_SUCCESS
) {
59 efi_st_error("GetMemoryMap did not return EFI_SUCCESS\n");
62 ret
= boottime
->exit_boot_services(handle
, map_key
);
63 if (ret
!= EFI_SUCCESS
) {
64 efi_st_error("ExitBootServices did not return EFI_SUCCESS\n");
67 efi_st_printc(EFI_WHITE
, "\nBoot services terminated\n");
73 * @test the test to be executed
74 * @failures counter that will be incremented if a failure occurs
75 * @return EFI_ST_SUCCESS for success
77 static int setup(struct efi_unit_test
*test
, unsigned int *failures
)
80 test
->setup_ok
= EFI_ST_SUCCESS
;
81 return EFI_ST_SUCCESS
;
83 efi_st_printc(EFI_LIGHTBLUE
, "\nSetting up '%s'\n", test
->name
);
84 test
->setup_ok
= test
->setup(handle
, systable
);
85 if (test
->setup_ok
!= EFI_ST_SUCCESS
) {
86 efi_st_error("Setting up '%s' failed\n", test
->name
);
89 efi_st_printc(EFI_LIGHTGREEN
,
90 "Setting up '%s' succeeded\n", test
->name
);
92 return test
->setup_ok
;
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_printc(EFI_LIGHTBLUE
, "\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_printc(EFI_LIGHTGREEN
,
115 "Executing '%s' succeeded\n", test
->name
);
123 * @test the test to be torn down
124 * @failures counter that will be incremented if a failure occurs
125 * @return EFI_ST_SUCCESS for success
127 static int teardown(struct efi_unit_test
*test
, unsigned int *failures
)
132 return EFI_ST_SUCCESS
;
133 efi_st_printc(EFI_LIGHTBLUE
, "\nTearing down '%s'\n", test
->name
);
134 ret
= test
->teardown();
135 if (ret
!= EFI_ST_SUCCESS
) {
136 efi_st_error("Tearing down '%s' failed\n", test
->name
);
139 efi_st_printc(EFI_LIGHTGREEN
,
140 "Tearing down '%s' succeeded\n", test
->name
);
146 * Check that a test exists.
148 * @testname: name of the test
151 static struct efi_unit_test
*find_test(const u16
*testname
)
153 struct efi_unit_test
*test
;
155 for (test
= ll_entry_start(struct efi_unit_test
, efi_unit_test
);
156 test
< ll_entry_end(struct efi_unit_test
, efi_unit_test
); ++test
) {
157 if (!efi_st_strcmp_16_8(testname
, test
->name
))
160 efi_st_printf("\nTest '%ps' not found\n", testname
);
165 * List all available tests.
167 static void list_all_tests(void)
169 struct efi_unit_test
*test
;
172 efi_st_printf("\nAvailable tests:\n");
173 for (test
= ll_entry_start(struct efi_unit_test
, efi_unit_test
);
174 test
< ll_entry_end(struct efi_unit_test
, efi_unit_test
); ++test
) {
175 efi_st_printf("'%s'%s\n", test
->name
,
176 test
->on_request
? " - on request" : "");
181 * Execute test steps of one phase.
183 * @testname name of a single selected test or NULL
185 * @steps steps to execute
186 * failures returns EFI_ST_SUCCESS if all test steps succeeded
188 void efi_st_do_tests(const u16
*testname
, unsigned int phase
,
189 unsigned int steps
, unsigned int *failures
)
191 struct efi_unit_test
*test
;
193 for (test
= ll_entry_start(struct efi_unit_test
, efi_unit_test
);
194 test
< ll_entry_end(struct efi_unit_test
, efi_unit_test
); ++test
) {
196 efi_st_strcmp_16_8(testname
, test
->name
) : test
->on_request
)
198 if (test
->phase
!= phase
)
200 if (steps
& EFI_ST_SETUP
)
201 setup(test
, failures
);
202 if (steps
& EFI_ST_EXECUTE
&& test
->setup_ok
== EFI_ST_SUCCESS
)
203 execute(test
, failures
);
204 if (steps
& EFI_ST_TEARDOWN
)
205 teardown(test
, failures
);
210 * Execute selftest of the EFI API
212 * This is the main entry point of the EFI selftest application.
214 * All tests use a driver model and are run in three phases:
215 * setup, execute, teardown.
217 * A test may be setup and executed at boottime,
218 * it may be setup at boottime and executed at runtime,
219 * or it may be setup and executed at runtime.
221 * After executing all tests the system is reset.
223 * @image_handle: handle of the loaded EFI image
224 * @systab: EFI system table
226 efi_status_t EFIAPI
efi_selftest(efi_handle_t image_handle
,
227 struct efi_system_table
*systab
)
229 unsigned int failures
= 0;
230 const u16
*testname
= NULL
;
231 struct efi_loaded_image
*loaded_image
;
235 boottime
= systable
->boottime
;
236 runtime
= systable
->runtime
;
237 handle
= image_handle
;
238 con_out
= systable
->con_out
;
239 con_in
= systable
->con_in
;
241 ret
= boottime
->handle_protocol(image_handle
, &efi_guid_loaded_image
,
242 (void **)&loaded_image
);
243 if (ret
!= EFI_SUCCESS
) {
244 efi_st_error("Cannot open loaded image protocol\n");
248 if (loaded_image
->load_options
)
249 testname
= (u16
*)loaded_image
->load_options
;
252 if (!efi_st_strcmp_16_8(testname
, "list") ||
253 !find_test(testname
)) {
257 * Once the Exit boottime service is correctly
258 * implemented we should call
259 * boottime->exit(image_handle, EFI_SUCCESS, 0, NULL);
261 * https://lists.denx.de/pipermail/u-boot/2017-October/308720.html
267 efi_st_printc(EFI_WHITE
, "\nTesting EFI API implementation\n");
270 efi_st_printc(EFI_WHITE
, "\nSelected test: '%ps'\n", testname
);
272 efi_st_printc(EFI_WHITE
, "\nNumber of tests to execute: %u\n",
273 ll_entry_count(struct efi_unit_test
,
276 /* Execute boottime tests */
277 efi_st_do_tests(testname
, EFI_EXECUTE_BEFORE_BOOTTIME_EXIT
,
278 EFI_ST_SETUP
| EFI_ST_EXECUTE
| EFI_ST_TEARDOWN
,
281 /* Execute mixed tests */
282 efi_st_do_tests(testname
, EFI_SETUP_BEFORE_BOOTTIME_EXIT
,
283 EFI_ST_SETUP
, &failures
);
285 efi_st_exit_boot_services();
287 efi_st_do_tests(testname
, EFI_SETUP_BEFORE_BOOTTIME_EXIT
,
288 EFI_ST_EXECUTE
| EFI_ST_TEARDOWN
, &failures
);
290 /* Execute runtime tests */
291 efi_st_do_tests(testname
, EFI_SETUP_AFTER_BOOTTIME_EXIT
,
292 EFI_ST_SETUP
| EFI_ST_EXECUTE
| EFI_ST_TEARDOWN
,
296 efi_st_printc(EFI_WHITE
, "\nSummary: %u failures\n\n", failures
);
299 efi_st_printf("Preparing for reset. Press any key.\n");
301 runtime
->reset_system(EFI_RESET_WARM
, EFI_NOT_READY
,
302 sizeof(reset_message
), reset_message
);
304 efi_st_error("Reset failed.\n");
306 return EFI_UNSUPPORTED
;