blob: 1b708849bcb9f3b07995b399d996add754324b2e [file] [log] [blame]
Tom Rinif739fcd2018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +02002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +02006 */
7
8#ifndef _EFI_SELFTEST_H
9#define _EFI_SELFTEST_H
10
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020011#include <efi.h>
12#include <efi_api.h>
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020013#include <efi_loader.h>
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020014#include <linker_lists.h>
15
Heinrich Schuchardte67e7242017-10-04 15:31:26 +020016#define EFI_ST_SUCCESS 0
17#define EFI_ST_FAILURE 1
Simon Glass156ccbc2022-01-23 12:55:12 -070018#define EFI_ST_SUCCESS_STR u"SUCCESS"
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020019
Heinrich Schuchardtb33f2462022-09-03 15:56:51 +020020extern const struct efi_system_table *st_systable;
21extern const struct efi_boot_services *st_boottime;
22
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020023/**
24 * efi_st_printf() - print a message
25 *
26 * @...: format string followed by fields to print
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010027 */
28#define efi_st_printf(...) \
29 (efi_st_printc(-1, __VA_ARGS__))
30
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020031/**
32 * efi_st_error() - prints an error message
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020033 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020034 * @...: format string followed by fields to print
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020035 */
36#define efi_st_error(...) \
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010037 (efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \
38 efi_st_printc(EFI_LIGHTRED, __VA_ARGS__))
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020039
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020040/**
41 * efi_st_todo() - prints a TODO message
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010042 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020043 * @...: format string followed by fields to print
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010044 */
45#define efi_st_todo(...) \
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010046 (efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \
47 efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010048
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020049/**
50 * enum efi_test_phase - phase when test will be executed
51 *
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020052 * A test may be setup and executed at boottime,
53 * it may be setup at boottime and executed at runtime,
54 * or it may be setup and executed at runtime.
55 */
56enum efi_test_phase {
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020057 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020058 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT:
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020059 *
60 * Setup, execute, and teardown are executed before ExitBootServices().
61 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020062 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020063 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020064 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT:
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020065 *
66 * Setup is executed before ExitBootServices() while execute, and
67 * teardown are executed after ExitBootServices().
68 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020069 EFI_SETUP_BEFORE_BOOTTIME_EXIT,
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020070 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020071 * @EFI_SETTING_VIRTUAL_ADDRESS_MAP:
72 *
73 * Execute calls SetVirtualAddressMap(). Setup is executed before
74 * ExitBootServices() while execute is executed after
75 * ExitBootServices(), and after the execute of tests marked as
76 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter.
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020077 */
Heinrich Schuchardt5e219582021-03-24 17:48:01 +010078 EFI_SETTING_VIRTUAL_ADDRESS_MAP,
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020079};
80
81extern struct efi_simple_text_output_protocol *con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +020082extern struct efi_simple_text_input_protocol *con_in;
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020083
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020084/**
85 * efi_st_exit_boot_services() - exit the boot services
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020086 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020087 * * The size of the memory map is determined.
88 * * Pool memory is allocated to copy the memory map.
89 * * The memory map is copied and the map key is obtained.
90 * * The map key is used to exit the boot services.
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020091 */
92void efi_st_exit_boot_services(void);
93
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020094/**
95 * efi_st_printc() - print a colored message
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020096 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020097 * @color: color, see constants in efi_api.h, use -1 for no color
98 * @fmt: printf style format string
99 * @...: arguments to be printed
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200100 */
Heinrich Schuchardt853540c2018-01-11 08:15:54 +0100101void efi_st_printc(int color, const char *fmt, ...)
102 __attribute__ ((format (__printf__, 2, 3)));
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200103
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200104/**
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200105 * efi_st_translate_char() - translate a Unicode character to a string
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200106 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200107 * @code: Unicode character
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200108 * Return: string
109 */
110u16 *efi_st_translate_char(u16 code);
111
112/**
113 * efi_st_translate_code() - translate a scan code to a human readable string
114 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200115 * This function translates the scan code returned by the simple text input
Simon Glass156ccbc2022-01-23 12:55:12 -0700116 * protocol to a human readable string, e.g. 0x04 is translated to u"Left".
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200117 *
118 * @code: scan code
119 * Return: Unicode string
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200120 */
121u16 *efi_st_translate_code(u16 code);
122
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200123/**
124 * efi_st_strcmp_16_8() - compare an u16 string to a char string
125 *
126 * This function compares each u16 value to the char value at the same
127 * position. This function is only useful for ANSI strings.
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200128 *
129 * @buf1: u16 string
130 * @buf2: char string
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200131 * Return: 0 if both buffers contain equivalent strings
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200132 */
Heinrich Schuchardtcaf29d12022-11-22 11:32:36 +0100133int efi_st_strcmp_16_8(const u16 *buf1, const unsigned char *buf2);
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200134
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200135/**
Heinrich Schuchardtb33f2462022-09-03 15:56:51 +0200136 * efi_st_get_config_table() - get configuration table
137 *
138 * @guid: GUID of the configuration table
139 * Return: pointer to configuration table or NULL
140 */
141void *efi_st_get_config_table(const efi_guid_t *guid);
142
143/**
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200144 * efi_st_get_key() - reads an Unicode character from the input device
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200145 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200146 * Return: Unicode character
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200147 */
148u16 efi_st_get_key(void);
149
150/**
Ilias Apalodimas6b2aaf82024-04-25 08:18:20 +0300151 * efi_st_query_variable_common - Common variable tests for boottime/runtime
152 *
153 * @runtime: Pointer to services table
154 * @attributes: Attributes used
155 *
156 * Return: EFI_ST_SUCCESS/FAILURE
157 */
158int efi_st_query_variable_common(struct efi_runtime_services *runtime,
159 u32 attributes);
160
161/**
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200162 * struct efi_unit_test - EFI unit test
163 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200164 * The &struct efi_unit_test structure provides a interface to an EFI unit test.
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200165 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200166 * @name: name of the unit test used in the user interface
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200167 * @phase: specifies when setup and execute are executed
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200168 * @setup: set up function of the unit test
169 * @execute: execute function of the unit test
170 * @teardown: tear down function of the unit test
171 * @on_request: flag indicating that the test shall only be executed on request
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200172 */
173struct efi_unit_test {
174 const char *name;
175 const enum efi_test_phase phase;
176 int (*setup)(const efi_handle_t handle,
177 const struct efi_system_table *systable);
178 int (*execute)(void);
179 int (*teardown)(void);
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200180 bool on_request;
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200181};
182
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200183/**
184 * EFI_UNIT_TEST() - macro to declare a new EFI unit test
185 *
186 * The macro EFI_UNIT_TEST() declares an EFI unit test using the &struct
187 * efi_unit_test structure. The test is added to a linker generated list which
188 * is evaluated by the 'bootefi selftest' command.
189 *
190 * @__name: string identifying the unit test in the linker generated list
191 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200192#define EFI_UNIT_TEST(__name) \
193 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)
194
195#endif /* _EFI_SELFTEST_H */