blob: 5340cefbb6f290c7f76e5fec954989cd95374b90 [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
11#include <common.h>
12#include <efi.h>
13#include <efi_api.h>
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +020014#include <efi_loader.h>
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020015#include <linker_lists.h>
16
Heinrich Schuchardte67e7242017-10-04 15:31:26 +020017#define EFI_ST_SUCCESS 0
18#define EFI_ST_FAILURE 1
Simon Glass156ccbc2022-01-23 12:55:12 -070019#define EFI_ST_SUCCESS_STR u"SUCCESS"
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020020
21/**
22 * efi_st_printf() - print a message
23 *
24 * @...: format string followed by fields to print
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010025 */
26#define efi_st_printf(...) \
27 (efi_st_printc(-1, __VA_ARGS__))
28
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020029/**
30 * efi_st_error() - prints an error message
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020031 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020032 * @...: format string followed by fields to print
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020033 */
34#define efi_st_error(...) \
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010035 (efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \
36 efi_st_printc(EFI_LIGHTRED, __VA_ARGS__))
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020037
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020038/**
39 * efi_st_todo() - prints a TODO message
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010040 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020041 * @...: format string followed by fields to print
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010042 */
43#define efi_st_todo(...) \
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010044 (efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \
45 efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \
Heinrich Schuchardt927ca892017-11-06 21:17:43 +010046
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020047/**
48 * enum efi_test_phase - phase when test will be executed
49 *
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020050 * A test may be setup and executed at boottime,
51 * it may be setup at boottime and executed at runtime,
52 * or it may be setup and executed at runtime.
53 */
54enum efi_test_phase {
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020055 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020056 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT:
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020057 *
58 * Setup, execute, and teardown are executed before ExitBootServices().
59 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020060 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020061 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020062 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT:
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020063 *
64 * Setup is executed before ExitBootServices() while execute, and
65 * teardown are executed after ExitBootServices().
66 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020067 EFI_SETUP_BEFORE_BOOTTIME_EXIT,
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020068 /**
Heinrich Schuchardtb411b622021-03-28 10:41:00 +020069 * @EFI_SETTING_VIRTUAL_ADDRESS_MAP:
70 *
71 * Execute calls SetVirtualAddressMap(). Setup is executed before
72 * ExitBootServices() while execute is executed after
73 * ExitBootServices(), and after the execute of tests marked as
74 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT. Teardown is executed thereafter.
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020075 */
Heinrich Schuchardt5e219582021-03-24 17:48:01 +010076 EFI_SETTING_VIRTUAL_ADDRESS_MAP,
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020077};
78
79extern struct efi_simple_text_output_protocol *con_out;
Heinrich Schuchardt3e603ec2018-09-08 10:20:10 +020080extern struct efi_simple_text_input_protocol *con_in;
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020081
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020082/**
83 * efi_st_exit_boot_services() - exit the boot services
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020084 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020085 * * The size of the memory map is determined.
86 * * Pool memory is allocated to copy the memory map.
87 * * The memory map is copied and the map key is obtained.
88 * * The map key is used to exit the boot services.
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020089 */
90void efi_st_exit_boot_services(void);
91
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020092/**
93 * efi_st_printc() - print a colored message
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020094 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +020095 * @color: color, see constants in efi_api.h, use -1 for no color
96 * @fmt: printf style format string
97 * @...: arguments to be printed
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +020098 */
Heinrich Schuchardt853540c2018-01-11 08:15:54 +010099void efi_st_printc(int color, const char *fmt, ...)
100 __attribute__ ((format (__printf__, 2, 3)));
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200101
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200102/**
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200103 * efi_st_translate_char() - translate a Unicode character to a string
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200104 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200105 * @code: Unicode character
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200106 * Return: string
107 */
108u16 *efi_st_translate_char(u16 code);
109
110/**
111 * efi_st_translate_code() - translate a scan code to a human readable string
112 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200113 * This function translates the scan code returned by the simple text input
Simon Glass156ccbc2022-01-23 12:55:12 -0700114 * protocol to a human readable string, e.g. 0x04 is translated to u"Left".
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200115 *
116 * @code: scan code
117 * Return: Unicode string
Heinrich Schuchardt262ff412018-09-11 22:38:04 +0200118 */
119u16 *efi_st_translate_code(u16 code);
120
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200121/**
122 * efi_st_strcmp_16_8() - compare an u16 string to a char string
123 *
124 * This function compares each u16 value to the char value at the same
125 * position. This function is only useful for ANSI strings.
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200126 *
127 * @buf1: u16 string
128 * @buf2: char string
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200129 * Return: 0 if both buffers contain equivalent strings
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200130 */
131int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2);
132
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200133/**
134 * efi_st_get_key() - reads an Unicode character from the input device
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200135 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200136 * Return: Unicode character
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200137 */
138u16 efi_st_get_key(void);
139
140/**
141 * struct efi_unit_test - EFI unit test
142 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200143 * The &struct efi_unit_test structure provides a interface to an EFI unit test.
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200144 *
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200145 * @name: name of the unit test used in the user interface
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200146 * @phase: specifies when setup and execute are executed
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200147 * @setup: set up function of the unit test
148 * @execute: execute function of the unit test
149 * @teardown: tear down function of the unit test
150 * @on_request: flag indicating that the test shall only be executed on request
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200151 */
152struct efi_unit_test {
153 const char *name;
154 const enum efi_test_phase phase;
155 int (*setup)(const efi_handle_t handle,
156 const struct efi_system_table *systable);
157 int (*execute)(void);
158 int (*teardown)(void);
Heinrich Schuchardtd78e40d2017-10-18 18:13:13 +0200159 bool on_request;
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200160};
161
Heinrich Schuchardt7fec2492020-05-09 07:33:43 +0200162/**
163 * EFI_UNIT_TEST() - macro to declare a new EFI unit test
164 *
165 * The macro EFI_UNIT_TEST() declares an EFI unit test using the &struct
166 * efi_unit_test structure. The test is added to a linker generated list which
167 * is evaluated by the 'bootefi selftest' command.
168 *
169 * @__name: string identifying the unit test in the linker generated list
170 */
Heinrich Schuchardt623b3a52017-09-15 10:06:11 +0200171#define EFI_UNIT_TEST(__name) \
172 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)
173
174#endif /* _EFI_SELFTEST_H */