summaryrefslogtreecommitdiff
path: root/lib/efi_selftest/efi_selftest_load_initrd.c
blob: 00d500055679d66fdcef56d63a879a03dcaebfb5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
// SPDX-License-Identifier: GPL-2.0+
/*
 * efi_selftest_load_initrd
 *
 * Copyright (c) 2020 Ilias Apalodimas <ilias.apalodimas@linaro.org>
 *
 * This test checks the FileLoad2 protocol.
 * A known file is read from the file system and verified.
 *
 * An example usage - given a file image with a file system in partition 1
 * holding file initrd - is:
 *
 * * Configure the sandbox with
 *
 *   CONFIG_EFI_SELFTEST=y
 *   CONFIG_EFI_LOAD_FILE2_INITRD=y
 *   CONFIG_EFI_INITRD_FILESPEC="host 0:1 initrd"
 *
 * * Run ./u-boot and execute
 *
 *   host bind 0 image
 *   setenv efi_selftest load initrd
 *   bootefi selftest
 *
 * This would provide a test output like:
 *
 *   Testing EFI API implementation
 *
 *   Selected test: 'load initrd'
 *
 *   Setting up 'load initrd'
 *   Setting up 'load initrd' succeeded
 *
 *   Executing 'load initrd'
 *   Loaded 12378613 bytes
 *   CRC32 2997478465
 *
 * Now the size and CRC32 can be compared to the provided file.
 */

#include <efi_selftest.h>
#include <efi_loader.h>
#include <efi_load_initrd.h>
#include <asm/types.h>
#include <linux/string.h>

static struct efi_boot_services *boottime;

static struct efi_initrd_dp dp = {
	.vendor = {
		{
		   DEVICE_PATH_TYPE_MEDIA_DEVICE,
		   DEVICE_PATH_SUB_TYPE_VENDOR_PATH,
		   sizeof(dp.vendor),
		},
		EFI_INITRD_MEDIA_GUID,
	},
	.end = {
		DEVICE_PATH_TYPE_END,
		DEVICE_PATH_SUB_TYPE_END,
		sizeof(dp.end),
	}
};

static struct efi_initrd_dp dp_invalid = {
	.vendor = {
		{
		   DEVICE_PATH_TYPE_MEDIA_DEVICE,
		   DEVICE_PATH_SUB_TYPE_VENDOR_PATH,
		   sizeof(dp.vendor),
		},
		EFI_INITRD_MEDIA_GUID,
	},
	.end = {
		0x8f, /* invalid */
		0xfe, /* invalid */
		sizeof(dp.end),
	}
};

static int setup(const efi_handle_t handle,
		 const struct efi_system_table *systable)
{
	boottime = systable->boottime;

	return EFI_ST_SUCCESS;
}

static int execute(void)
{
	efi_guid_t lf2_proto_guid = EFI_LOAD_FILE2_PROTOCOL_GUID;
	struct efi_load_file_protocol *lf2;
	struct efi_device_path *dp2, *dp2_invalid;
	efi_status_t status;
	efi_handle_t handle;
	char buffer[64];
	efi_uintn_t buffer_size;
	void *buf;
	u32 crc32;

	memset(buffer, 0, sizeof(buffer));

	dp2 = (struct efi_device_path *)&dp;
	status = boottime->locate_device_path(&lf2_proto_guid, &dp2, &handle);
	if (status != EFI_SUCCESS) {
		efi_st_error("Unable to locate device path\n");
		return EFI_ST_FAILURE;
	}

	status = boottime->handle_protocol(handle, &lf2_proto_guid,
					   (void **)&lf2);
	if (status != EFI_SUCCESS) {
		efi_st_error("Unable to locate protocol\n");
		return EFI_ST_FAILURE;
	}

	/* Case 1:
	 * buffer_size can't be NULL
	 * protocol can't be NULL
	 */
	status = lf2->load_file(lf2, dp2, false, NULL, &buffer);
	if (status != EFI_INVALID_PARAMETER) {
		efi_st_error("Buffer size can't be NULL\n");
		return EFI_ST_FAILURE;
	}
	buffer_size = sizeof(buffer);
	status = lf2->load_file(NULL, dp2, false, &buffer_size, &buffer);
	if (status != EFI_INVALID_PARAMETER) {
		efi_st_error("Protocol can't be NULL\n");
		return EFI_ST_FAILURE;
	}

	/*
	 * Case 2: Match end node type/sub-type on device path
	 */
	dp2_invalid = (struct efi_device_path *)&dp_invalid;
	buffer_size = sizeof(buffer);
	status = lf2->load_file(lf2, dp2_invalid, false, &buffer_size, &buffer);
	if (status != EFI_INVALID_PARAMETER) {
		efi_st_error("Invalid device path type must return EFI_INVALID_PARAMETER\n");
		return EFI_ST_FAILURE;
	}

	status = lf2->load_file(lf2, dp2_invalid, false, &buffer_size, &buffer);
	if (status != EFI_INVALID_PARAMETER) {
		efi_st_error("Invalid device path sub-type must return EFI_INVALID_PARAMETER\n");
		return EFI_ST_FAILURE;
	}

	/*
	 * Case 3:
	 * BootPolicy 'true' must return EFI_UNSUPPORTED
	 */
	buffer_size = sizeof(buffer);
	status = lf2->load_file(lf2, dp2, true, &buffer_size, &buffer);
	if (status != EFI_UNSUPPORTED) {
		efi_st_error("BootPolicy true must return EFI_UNSUPPORTED\n");
		return EFI_ST_FAILURE;
	}

	/*
	 * Case: Pass buffer size as zero, firmware must return
	 * EFI_BUFFER_TOO_SMALL and an appropriate size
	 */
	buffer_size = 0;
	status = lf2->load_file(lf2, dp2, false, &buffer_size, NULL);
	if (status != EFI_BUFFER_TOO_SMALL || !buffer_size) {
		efi_st_printf("buffer_size: %u\n", (unsigned int)buffer_size);
		efi_st_printf("status: %x\n", (unsigned int)status);
		efi_st_error("Buffer size not updated\n");
		return EFI_ST_FAILURE;
	}

	/*
	 * Case: Pass buffer size as smaller than the file_size,
	 * firmware must return * EFI_BUFFER_TOO_SMALL and an appropriate size
	 */
	buffer_size = 1;
	status = lf2->load_file(lf2, dp2, false, &buffer_size, &buffer);
	if (status != EFI_BUFFER_TOO_SMALL || buffer_size <= 1) {
		efi_st_error("Buffer size not updated\n");
		return EFI_ST_FAILURE;
	}

	status = boottime->allocate_pool(EFI_BOOT_SERVICES_DATA, buffer_size,
					 &buf);
	if (status != EFI_SUCCESS) {
		efi_st_error("Cannot allocate buffer\n");
		return EFI_ST_FAILURE;
	}

	/* Case: Pass correct buffer, load the file and verify checksum*/
	status = lf2->load_file(lf2, dp2, false, &buffer_size, buf);
	if (status != EFI_SUCCESS) {
		efi_st_error("Loading initrd failed\n");
		return EFI_ST_FAILURE;
	}

	efi_st_printf("Loaded %u bytes\n", (unsigned int)buffer_size);
	status = boottime->calculate_crc32(buf, buffer_size, &crc32);
	if (status != EFI_SUCCESS) {
		efi_st_error("Could not determine CRC32\n");
		return EFI_ST_FAILURE;
	}
	efi_st_printf("CRC32 %u\n", (unsigned int)crc32);

	status = boottime->free_pool(buf);
	if (status != EFI_SUCCESS) {
		efi_st_error("Cannot free buffer\n");
		return EFI_ST_FAILURE;
	}

	return EFI_ST_SUCCESS;
}

EFI_UNIT_TEST(load_initrd) = {
	.name = "load initrd",
	.phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
	.setup = setup,
	.execute = execute,
	.on_request = true,
};