2 * EFI application loader
4 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
6 * SPDX-License-Identifier: GPL-2.0+
9 #ifndef _EFI_SELFTEST_H
10 #define _EFI_SELFTEST_H
15 #include <efi_loader.h>
16 #include <linker_lists.h>
18 #define EFI_ST_SUCCESS 0
19 #define EFI_ST_FAILURE 1
22 * Prints an error message.
24 * @... format string followed by fields to print
26 #define efi_st_error(...) \
27 (efi_st_printf("%s(%u):\nERROR: ", __FILE__, __LINE__), \
28 efi_st_printf(__VA_ARGS__)) \
31 * A test may be setup and executed at boottime,
32 * it may be setup at boottime and executed at runtime,
33 * or it may be setup and executed at runtime.
36 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
37 EFI_SETUP_BEFORE_BOOTTIME_EXIT,
38 EFI_SETUP_AFTER_BOOTTIME_EXIT,
41 extern struct efi_simple_text_output_protocol *con_out;
42 extern struct efi_simple_input_interface *con_in;
45 * Exit the boot services.
47 * The size of the memory map is determined.
48 * Pool memory is allocated to copy the memory map.
49 * The memory amp is copied and the map key is obtained.
50 * The map key is used to exit the boot services.
52 void efi_st_exit_boot_services(void);
55 * Print a pointer to an u16 string
58 * @buf: pointer to buffer address
59 * on return position of terminating zero word
61 void efi_st_printf(const char *fmt, ...)
62 __attribute__ ((format (__printf__, 1, 2)));
66 * We cannot use lib/string.c due to different CFLAGS values.
69 * @buf2: second buffer
70 * @length: number of bytes to compare
71 * @return: 0 if both buffers contain the same bytes
73 int efi_st_memcmp(const void *buf1, const void *buf2, size_t length);
76 * Compare an u16 string to a char string.
80 * @return: 0 if both buffers contain the same bytes
82 int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2);
85 * Reads an Unicode character from the input device.
87 * @return: Unicode character
89 u16 efi_st_get_key(void);
92 * struct efi_unit_test - EFI unit test
94 * An efi_unit_test provides a interface to an EFI unit test.
96 * @name: name of unit test
97 * @phase: specifies when setup and execute are executed
98 * @setup: set up the unit test
99 * @teardown: tear down the unit test
100 * @execute: execute the unit test
101 * @on_request: test is only executed on request
103 struct efi_unit_test {
105 const enum efi_test_phase phase;
106 int (*setup)(const efi_handle_t handle,
107 const struct efi_system_table *systable);
108 int (*execute)(void);
109 int (*teardown)(void);
113 /* Declare a new EFI unit test */
114 #define EFI_UNIT_TEST(__name) \
115 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)
117 #endif /* _EFI_SELFTEST_H */