1 /* SPDX-License-Identifier: GPL-2.0+ */ 2 /* 3 * EFI application loader 4 * 5 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de> 6 */ 7 8 #ifndef _EFI_SELFTEST_H 9 #define _EFI_SELFTEST_H 10 11 #include <common.h> 12 #include <efi.h> 13 #include <efi_api.h> 14 #include <efi_loader.h> 15 #include <linker_lists.h> 16 17 #define EFI_ST_SUCCESS 0 18 #define EFI_ST_FAILURE 1 19 #define EFI_ST_SUCCESS_STR u"SUCCESS" 20 21 extern const struct efi_system_table *st_systable; 22 extern const struct efi_boot_services *st_boottime; 23 24 /** 25 * efi_st_printf() - print a message 26 * 27 * @...: format string followed by fields to print 28 */ 29 #define efi_st_printf(...) \ 30 (efi_st_printc(-1, __VA_ARGS__)) 31 32 /** 33 * efi_st_error() - prints an error message 34 * 35 * @...: format string followed by fields to print 36 */ 37 #define efi_st_error(...) \ 38 (efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \ 39 efi_st_printc(EFI_LIGHTRED, __VA_ARGS__)) 40 41 /** 42 * efi_st_todo() - prints a TODO message 43 * 44 * @...: format string followed by fields to print 45 */ 46 #define efi_st_todo(...) \ 47 (efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \ 48 efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \ 49 50 /** 51 * enum efi_test_phase - phase when test will be executed 52 * 53 * A test may be setup and executed at boottime, 54 * it may be setup at boottime and executed at runtime, 55 * or it may be setup and executed at runtime. 56 */ 57 enum efi_test_phase { 58 /** 59 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: 60 * 61 * Setup, execute, and teardown are executed before ExitBootServices(). 62 */ 63 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1, 64 /** 65 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: 66 * 67 * Setup is executed before ExitBootServices() while execute, and 68 * teardown are executed after ExitBootServices(). 69 */ 70 EFI_SETUP_BEFORE_BOOTTIME_EXIT, 71 /** 72 * @EFI_SETTING_VIRTUAL_ADDRESS_MAP: 73 * 74 * Execute calls SetVirtualAddressMap(). Setup is executed before 75 * ExitBootServices() while execute is executed after 76 * ExitBootServices(), and after the execute of tests marked as 77 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter. 78 */ 79 EFI_SETTING_VIRTUAL_ADDRESS_MAP, 80 }; 81 82 extern struct efi_simple_text_output_protocol *con_out; 83 extern struct efi_simple_text_input_protocol *con_in; 84 85 /** 86 * efi_st_exit_boot_services() - exit the boot services 87 * 88 * * The size of the memory map is determined. 89 * * Pool memory is allocated to copy the memory map. 90 * * The memory map is copied and the map key is obtained. 91 * * The map key is used to exit the boot services. 92 */ 93 void efi_st_exit_boot_services(void); 94 95 /** 96 * efi_st_printc() - print a colored message 97 * 98 * @color: color, see constants in efi_api.h, use -1 for no color 99 * @fmt: printf style format string 100 * @...: arguments to be printed 101 */ 102 void efi_st_printc(int color, const char *fmt, ...) 103 __attribute__ ((format (__printf__, 2, 3))); 104 105 /** 106 * efi_st_translate_char() - translate a Unicode character to a string 107 * 108 * @code: Unicode character 109 * Return: string 110 */ 111 u16 *efi_st_translate_char(u16 code); 112 113 /** 114 * efi_st_translate_code() - translate a scan code to a human readable string 115 * 116 * This function translates the scan code returned by the simple text input 117 * protocol to a human readable string, e.g. 0x04 is translated to u"Left". 118 * 119 * @code: scan code 120 * Return: Unicode string 121 */ 122 u16 *efi_st_translate_code(u16 code); 123 124 /** 125 * efi_st_strcmp_16_8() - compare an u16 string to a char string 126 * 127 * This function compares each u16 value to the char value at the same 128 * position. This function is only useful for ANSI strings. 129 * 130 * @buf1: u16 string 131 * @buf2: char string 132 * Return: 0 if both buffers contain equivalent strings 133 */ 134 int efi_st_strcmp_16_8(const u16 *buf1, const unsigned char *buf2); 135 136 /** 137 * efi_st_get_config_table() - get configuration table 138 * 139 * @guid: GUID of the configuration table 140 * Return: pointer to configuration table or NULL 141 */ 142 void *efi_st_get_config_table(const efi_guid_t *guid); 143 144 /** 145 * efi_st_get_key() - reads an Unicode character from the input device 146 * 147 * Return: Unicode character 148 */ 149 u16 efi_st_get_key(void); 150 151 /** 152 * struct efi_unit_test - EFI unit test 153 * 154 * The &struct efi_unit_test structure provides a interface to an EFI unit test. 155 * 156 * @name: name of the unit test used in the user interface 157 * @phase: specifies when setup and execute are executed 158 * @setup: set up function of the unit test 159 * @execute: execute function of the unit test 160 * @teardown: tear down function of the unit test 161 * @on_request: flag indicating that the test shall only be executed on request 162 */ 163 struct efi_unit_test { 164 const char *name; 165 const enum efi_test_phase phase; 166 int (*setup)(const efi_handle_t handle, 167 const struct efi_system_table *systable); 168 int (*execute)(void); 169 int (*teardown)(void); 170 bool on_request; 171 }; 172 173 /** 174 * EFI_UNIT_TEST() - macro to declare a new EFI unit test 175 * 176 * The macro EFI_UNIT_TEST() declares an EFI unit test using the &struct 177 * efi_unit_test structure. The test is added to a linker generated list which 178 * is evaluated by the 'bootefi selftest' command. 179 * 180 * @__name: string identifying the unit test in the linker generated list 181 */ 182 #define EFI_UNIT_TEST(__name) \ 183 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test) 184 185 #endif /* _EFI_SELFTEST_H */ 186