efi_selftest: do not execute test if setup failed
[platform/kernel/u-boot.git] / include / efi_selftest.h
1 /*
2  *  EFI application loader
3  *
4  *  Copyright (c) 2017 Heinrich Schuchardt <xypron.glpk@gmx.de>
5  *
6  *  SPDX-License-Identifier:     GPL-2.0+
7  */
8
9 #ifndef _EFI_SELFTEST_H
10 #define _EFI_SELFTEST_H
11
12 #include <common.h>
13 #include <efi.h>
14 #include <efi_api.h>
15 #include <efi_loader.h>
16 #include <linker_lists.h>
17
18 #define EFI_ST_SUCCESS 0
19 #define EFI_ST_FAILURE 1
20
21 /*
22  * Prints a message.
23  */
24 #define efi_st_printf(...) \
25         (efi_st_printc(-1, __VA_ARGS__))
26
27 /*
28  * Prints an error message.
29  *
30  * @... format string followed by fields to print
31  */
32 #define efi_st_error(...) \
33         (efi_st_printc(EFI_LIGHTRED, "%s(%u):\nERROR: ", __FILE__, __LINE__), \
34         efi_st_printc(EFI_LIGHTRED, __VA_ARGS__))
35
36 /*
37  * Prints a TODO message.
38  *
39  * @... format string followed by fields to print
40  */
41 #define efi_st_todo(...) \
42         (efi_st_printc(EFI_YELLOW, "%s(%u):\nTODO: ", __FILE__, __LINE__), \
43         efi_st_printc(EFI_YELLOW, __VA_ARGS__)) \
44
45 /*
46  * A test may be setup and executed at boottime,
47  * it may be setup at boottime and executed at runtime,
48  * or it may be setup and executed at runtime.
49  */
50 enum efi_test_phase {
51         EFI_EXECUTE_BEFORE_BOOTTIME_EXIT = 1,
52         EFI_SETUP_BEFORE_BOOTTIME_EXIT,
53         EFI_SETUP_AFTER_BOOTTIME_EXIT,
54 };
55
56 extern struct efi_simple_text_output_protocol *con_out;
57 extern struct efi_simple_input_interface *con_in;
58
59 /*
60  * Exit the boot services.
61  *
62  * The size of the memory map is determined.
63  * Pool memory is allocated to copy the memory map.
64  * The memory amp is copied and the map key is obtained.
65  * The map key is used to exit the boot services.
66  */
67 void efi_st_exit_boot_services(void);
68
69 /*
70  * Print a colored message
71  *
72  * @color       color, see constants in efi_api.h, use -1 for no color
73  * @fmt         printf format
74  * @...         arguments to be printed
75  *              on return position of terminating zero word
76  */
77 void efi_st_printc(int color, const char *fmt, ...)
78                  __attribute__ ((format (__printf__, 2, 3)));
79
80 /*
81  * Compare memory.
82  * We cannot use lib/string.c due to different CFLAGS values.
83  *
84  * @buf1:       first buffer
85  * @buf2:       second buffer
86  * @length:     number of bytes to compare
87  * @return:     0 if both buffers contain the same bytes
88  */
89 int efi_st_memcmp(const void *buf1, const void *buf2, size_t length);
90
91 /*
92  * Compare an u16 string to a char string.
93  *
94  * @buf1:       u16 string
95  * @buf2:       char string
96  * @return:     0 if both buffers contain the same bytes
97  */
98 int efi_st_strcmp_16_8(const u16 *buf1, const char *buf2);
99
100 /*
101  * Reads an Unicode character from the input device.
102  *
103  * @return: Unicode character
104  */
105 u16 efi_st_get_key(void);
106
107 /**
108  * struct efi_unit_test - EFI unit test
109  *
110  * An efi_unit_test provides a interface to an EFI unit test.
111  *
112  * @name:       name of unit test
113  * @phase:      specifies when setup and execute are executed
114  * @setup:      set up the unit test
115  * @teardown:   tear down the unit test
116  * @execute:    execute the unit test
117  * @setup_ok:   setup was successful (set at runtime)
118  * @on_request: test is only executed on request
119  */
120 struct efi_unit_test {
121         const char *name;
122         const enum efi_test_phase phase;
123         int (*setup)(const efi_handle_t handle,
124                      const struct efi_system_table *systable);
125         int (*execute)(void);
126         int (*teardown)(void);
127         int setup_ok;
128         bool on_request;
129 };
130
131 /* Declare a new EFI unit test */
132 #define EFI_UNIT_TEST(__name)                                           \
133         ll_entry_declare(struct efi_unit_test, __name, efi_unit_test)
134
135 #endif /* _EFI_SELFTEST_H */