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 20 /* 21 * Prints a message. 22 */ 23 #define efi_st_printf(...) \ 24 (efi_st_printc(-1, __VA_ARGS__)) 25 26 /* 27 * Prints an error message. 28 * 29 * @... format string followed by fields to print 30 */ 31 #define efi_st_error(...) \ 32 (efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \ 33 efi_st_printc(EFI_LIGHTRED, __VA_ARGS__)) 34 35 /* 36 * Prints a TODO message. 37 * 38 * @... format string followed by fields to print 39 */ 40 #define efi_st_todo(...) \ 41 (efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \ 42 efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \ 43 44 /* 45 * A test may be setup and executed at boottime, 46 * it may be setup at boottime and executed at runtime, 47 * or it may be setup and executed at runtime. 48 */ 49 enum efi_test_phase { 50 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1, 51 EFI_SETUP_BEFORE_BOOTTIME_EXIT, 52 EFI_SETUP_AFTER_BOOTTIME_EXIT, 53 }; 54 55 extern struct efi_simple_text_output_protocol *con_out; 56 extern struct efi_simple_text_input_protocol *con_in; 57 58 /* 59 * Exit the boot services. 60 * 61 * The size of the memory map is determined. 62 * Pool memory is allocated to copy the memory map. 63 * The memory amp is copied and the map key is obtained. 64 * The map key is used to exit the boot services. 65 */ 66 void efi_st_exit_boot_services(void); 67 68 /* 69 * Print a colored message 70 * 71 * @color color, see constants in efi_api.h, use -1 for no color 72 * @fmt printf format 73 * @... arguments to be printed 74 * on return position of terminating zero word 75 */ 76 void efi_st_printc(int color, const char *fmt, ...) 77 __attribute__ ((format (__printf__, 2, 3))); 78 79 /** 80 * efi_st_translate_char() - translate a unicode character to a string 81 * 82 * @code: unicode character 83 * Return: string 84 */ 85 u16 *efi_st_translate_char(u16 code); 86 87 /** 88 * efi_st_translate_code() - translate a scan code to a human readable string 89 * 90 * @code: unicode character 91 * Return: string 92 */ 93 u16 *efi_st_translate_code(u16 code); 94 95 /* 96 * Compare memory. 97 * We cannot use lib/string.c due to different CFLAGS values. 98 * 99 * @buf1: first buffer 100 * @buf2: second buffer 101 * @length: number of bytes to compare 102 * @return: 0 if both buffers contain the same bytes 103 */ 104 int efi_st_memcmp(const void *buf1, const void *buf2, size_t length); 105 106 /* 107 * Compare an u16 string to a char string. 108 * 109 * @buf1: u16 string 110 * @buf2: char string 111 * @return: 0 if both buffers contain the same bytes 112 */ 113 int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2); 114 115 /* 116 * Reads an Unicode character from the input device. 117 * 118 * @return: Unicode character 119 */ 120 u16 efi_st_get_key(void); 121 122 /** 123 * struct efi_unit_test - EFI unit test 124 * 125 * An efi_unit_test provides a interface to an EFI unit test. 126 * 127 * @name: name of unit test 128 * @phase: specifies when setup and execute are executed 129 * @setup: set up the unit test 130 * @teardown: tear down the unit test 131 * @execute: execute the unit test 132 * @setup_ok: setup was successful (set at runtime) 133 * @on_request: test is only executed on request 134 */ 135 struct efi_unit_test { 136 const char *name; 137 const enum efi_test_phase phase; 138 int (*setup)(const efi_handle_t handle, 139 const struct efi_system_table *systable); 140 int (*execute)(void); 141 int (*teardown)(void); 142 int setup_ok; 143 bool on_request; 144 }; 145 146 /* Declare a new EFI unit test */ 147 #define EFI_UNIT_TEST(__name) \ 148 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test) 149 150 #endif /* _EFI_SELFTEST_H */ 151