blob: 1515fdaa02b05fcc6015dff3e33ec9176ea9795f [file] [log] [blame]
Tom Rini70df9d62018-05-07 17:02:21 -04001/* SPDX-License-Identifier: GPL-2.0+ */
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +02002/*
3 * EFI application loader
4 *
5 * Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
Heinrich Schuchardtd33ae3e2017-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 Schuchardt02efd5d2017-10-18 18:13:13 +020014#include <efi_loader.h>
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020015#include <linker_lists.h>
16
Heinrich Schuchardt1afe5f72017-10-04 15:31:26 +020017#define EFI_ST_SUCCESS 0
18#define EFI_ST_FAILURE 1
Heinrich Schuchardt1696dd02018-09-30 13:26:36 +020019#define EFI_ST_SUCCESS_STR L"SUCCESS"
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020020
21/**
22 * efi_st_printf() - print a message
23 *
24 * @...: format string followed by fields to print
Heinrich Schuchardt9137df82018-01-11 08:15:54 +010025 */
26#define efi_st_printf(...) \
27 (efi_st_printc(-1, __VA_ARGS__))
28
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020029/**
30 * efi_st_error() - prints an error message
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020031 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020032 * @...: format string followed by fields to print
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020033 */
34#define efi_st_error(...) \
Heinrich Schuchardt9137df82018-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 Schuchardtd33ae3e2017-09-15 10:06:11 +020037
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020038/**
39 * efi_st_todo() - prints a TODO message
Heinrich Schuchardtc53591c2017-11-06 21:17:43 +010040 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020041 * @...: format string followed by fields to print
Heinrich Schuchardtc53591c2017-11-06 21:17:43 +010042 */
43#define efi_st_todo(...) \
Heinrich Schuchardt9137df82018-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 Schuchardtc53591c2017-11-06 21:17:43 +010046
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020047/**
48 * enum efi_test_phase - phase when test will be executed
49 *
Heinrich Schuchardtd33ae3e2017-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 Schuchardta42e6292020-05-09 07:33:43 +020055 /**
56 * @EFI_EXECUTE_BEFORE_BOOTTIME_EXIT: - execute before ExitBootServices
57 *
58 * Setup, execute, and teardown are executed before ExitBootServices().
59 */
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020060 EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020061 /**
62 * @EFI_SETUP_BEFORE_BOOTTIME_EXIT: - setup before ExitBootServices
63 *
64 * Setup is executed before ExitBootServices() while execute, and
65 * teardown are executed after ExitBootServices().
66 */
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020067 EFI_SETUP_BEFORE_BOOTTIME_EXIT,
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020068 /**
69 * @EFI_SETUP_AFTER_BOOTTIME_EXIT: - setup after ExitBootServices
70 *
71 * Setup, execute, and teardown are executed after ExitBootServices().
72 */
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020073 EFI_SETUP_AFTER_BOOTTIME_EXIT,
74};
75
76extern struct efi_simple_text_output_protocol *con_out;
Heinrich Schuchardt3dabffd2018-09-08 10:20:10 +020077extern struct efi_simple_text_input_protocol *con_in;
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020078
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020079/**
80 * efi_st_exit_boot_services() - exit the boot services
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020081 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020082 * * The size of the memory map is determined.
83 * * Pool memory is allocated to copy the memory map.
84 * * The memory map is copied and the map key is obtained.
85 * * The map key is used to exit the boot services.
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020086 */
87void efi_st_exit_boot_services(void);
88
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020089/**
90 * efi_st_printc() - print a colored message
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020091 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +020092 * @color: color, see constants in efi_api.h, use -1 for no color
93 * @fmt: printf style format string
94 * @...: arguments to be printed
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020095 */
Heinrich Schuchardt9137df82018-01-11 08:15:54 +010096void efi_st_printc(int color, const char *fmt, ...)
97 __attribute__ ((format (__printf__, 2, 3)));
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +020098
Heinrich Schuchardt9cda2ef2018-09-11 22:38:04 +020099/**
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200100 * efi_st_translate_char() - translate a Unicode character to a string
Heinrich Schuchardt9cda2ef2018-09-11 22:38:04 +0200101 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200102 * @code: Unicode character
Heinrich Schuchardt9cda2ef2018-09-11 22:38:04 +0200103 * Return: string
104 */
105u16 *efi_st_translate_char(u16 code);
106
107/**
108 * efi_st_translate_code() - translate a scan code to a human readable string
109 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200110 * This function translates the scan code returned by the simple text input
111 * protocol to a human readable string, e.g. 0x04 is translated to L"Left".
112 *
113 * @code: scan code
114 * Return: Unicode string
Heinrich Schuchardt9cda2ef2018-09-11 22:38:04 +0200115 */
116u16 *efi_st_translate_code(u16 code);
117
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200118/**
119 * efi_st_strcmp_16_8() - compare an u16 string to a char string
120 *
121 * This function compares each u16 value to the char value at the same
122 * position. This function is only useful for ANSI strings.
Heinrich Schuchardt02efd5d2017-10-18 18:13:13 +0200123 *
124 * @buf1: u16 string
125 * @buf2: char string
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200126 * Return: 0 if both buffers contain equivalent strings
Heinrich Schuchardt02efd5d2017-10-18 18:13:13 +0200127 */
128int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2);
129
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200130/**
131 * efi_st_get_key() - reads an Unicode character from the input device
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200132 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200133 * Return: Unicode character
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200134 */
135u16 efi_st_get_key(void);
136
137/**
138 * struct efi_unit_test - EFI unit test
139 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200140 * The &struct efi_unit_test structure provides a interface to an EFI unit test.
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200141 *
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200142 * @name: name of the unit test used in the user interface
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200143 * @phase: specifies when setup and execute are executed
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200144 * @setup: set up function of the unit test
145 * @execute: execute function of the unit test
146 * @teardown: tear down function of the unit test
147 * @on_request: flag indicating that the test shall only be executed on request
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200148 */
149struct efi_unit_test {
150 const char *name;
151 const enum efi_test_phase phase;
152 int (*setup)(const efi_handle_t handle,
153 const struct efi_system_table *systable);
154 int (*execute)(void);
155 int (*teardown)(void);
Heinrich Schuchardt02efd5d2017-10-18 18:13:13 +0200156 bool on_request;
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200157};
158
Heinrich Schuchardta42e6292020-05-09 07:33:43 +0200159/**
160 * EFI_UNIT_TEST() - macro to declare a new EFI unit test
161 *
162 * The macro EFI_UNIT_TEST() declares an EFI unit test using the &struct
163 * efi_unit_test structure. The test is added to a linker generated list which
164 * is evaluated by the 'bootefi selftest' command.
165 *
166 * @__name: string identifying the unit test in the linker generated list
167 */
Heinrich Schuchardtd33ae3e2017-09-15 10:06:11 +0200168#define EFI_UNIT_TEST(__name) \
169 ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)
170
171#endif /* _EFI_SELFTEST_H */