xref: /openbmc/u-boot/lib/efi_selftest/efi_selftest_startimage_exit.c (revision beff8e34b22d708df11b32b6ed27be49ba345875)
183d290c5STom Rini // SPDX-License-Identifier: GPL-2.0+
28218f7b5SHeinrich Schuchardt /*
38218f7b5SHeinrich Schuchardt  * efi_selftest_start_image
48218f7b5SHeinrich Schuchardt  *
58218f7b5SHeinrich Schuchardt  * Copyright (c) 2018 Heinrich Schuchardt <xypron.glpk@gmx.de>
68218f7b5SHeinrich Schuchardt  *
78218f7b5SHeinrich Schuchardt  * This test checks the StartImage boot service.
88218f7b5SHeinrich Schuchardt  * The efi_selftest_miniapp_exit.efi application is loaded into memory
98218f7b5SHeinrich Schuchardt  * and started.
108218f7b5SHeinrich Schuchardt  */
118218f7b5SHeinrich Schuchardt 
128218f7b5SHeinrich Schuchardt #include <efi_selftest.h>
138218f7b5SHeinrich Schuchardt /* Include containing the miniapp.efi application */
148218f7b5SHeinrich Schuchardt #include "efi_miniapp_file_image_exit.h"
158218f7b5SHeinrich Schuchardt 
168218f7b5SHeinrich Schuchardt /* Block size of compressed disk image */
178218f7b5SHeinrich Schuchardt #define COMPRESSED_DISK_IMAGE_BLOCK_SIZE 8
188218f7b5SHeinrich Schuchardt 
198218f7b5SHeinrich Schuchardt /* Binary logarithm of the block size */
208218f7b5SHeinrich Schuchardt #define LB_BLOCK_SIZE 9
218218f7b5SHeinrich Schuchardt 
228218f7b5SHeinrich Schuchardt static efi_handle_t image_handle;
238218f7b5SHeinrich Schuchardt static struct efi_boot_services *boottime;
248218f7b5SHeinrich Schuchardt 
258218f7b5SHeinrich Schuchardt /* One 8 byte block of the compressed disk image */
268218f7b5SHeinrich Schuchardt struct line {
278218f7b5SHeinrich Schuchardt 	size_t addr;
288218f7b5SHeinrich Schuchardt 	char *line;
298218f7b5SHeinrich Schuchardt };
308218f7b5SHeinrich Schuchardt 
318218f7b5SHeinrich Schuchardt /* Compressed file image */
328218f7b5SHeinrich Schuchardt struct compressed_file_image {
338218f7b5SHeinrich Schuchardt 	size_t length;
348218f7b5SHeinrich Schuchardt 	struct line lines[];
358218f7b5SHeinrich Schuchardt };
368218f7b5SHeinrich Schuchardt 
378218f7b5SHeinrich Schuchardt static struct compressed_file_image img = EFI_ST_DISK_IMG;
388218f7b5SHeinrich Schuchardt 
398218f7b5SHeinrich Schuchardt /* Decompressed file image */
408218f7b5SHeinrich Schuchardt static u8 *image;
418218f7b5SHeinrich Schuchardt 
428218f7b5SHeinrich Schuchardt /*
438218f7b5SHeinrich Schuchardt  * Decompress the disk image.
448218f7b5SHeinrich Schuchardt  *
458218f7b5SHeinrich Schuchardt  * @image	decompressed disk image
468218f7b5SHeinrich Schuchardt  * @return	status code
478218f7b5SHeinrich Schuchardt  */
decompress(u8 ** image)488218f7b5SHeinrich Schuchardt static efi_status_t decompress(u8 **image)
498218f7b5SHeinrich Schuchardt {
508218f7b5SHeinrich Schuchardt 	u8 *buf;
518218f7b5SHeinrich Schuchardt 	size_t i;
528218f7b5SHeinrich Schuchardt 	size_t addr;
538218f7b5SHeinrich Schuchardt 	size_t len;
548218f7b5SHeinrich Schuchardt 	efi_status_t ret;
558218f7b5SHeinrich Schuchardt 
568218f7b5SHeinrich Schuchardt 	ret = boottime->allocate_pool(EFI_LOADER_DATA, img.length,
578218f7b5SHeinrich Schuchardt 				      (void **)&buf);
588218f7b5SHeinrich Schuchardt 	if (ret != EFI_SUCCESS) {
598218f7b5SHeinrich Schuchardt 		efi_st_error("Out of memory\n");
608218f7b5SHeinrich Schuchardt 		return ret;
618218f7b5SHeinrich Schuchardt 	}
628218f7b5SHeinrich Schuchardt 	boottime->set_mem(buf, img.length, 0);
638218f7b5SHeinrich Schuchardt 
648218f7b5SHeinrich Schuchardt 	for (i = 0; ; ++i) {
658218f7b5SHeinrich Schuchardt 		if (!img.lines[i].line)
668218f7b5SHeinrich Schuchardt 			break;
678218f7b5SHeinrich Schuchardt 		addr = img.lines[i].addr;
688218f7b5SHeinrich Schuchardt 		len = COMPRESSED_DISK_IMAGE_BLOCK_SIZE;
698218f7b5SHeinrich Schuchardt 		if (addr + len > img.length)
708218f7b5SHeinrich Schuchardt 			len = img.length - addr;
718218f7b5SHeinrich Schuchardt 		boottime->copy_mem(buf + addr, img.lines[i].line, len);
728218f7b5SHeinrich Schuchardt 	}
738218f7b5SHeinrich Schuchardt 	*image = buf;
748218f7b5SHeinrich Schuchardt 	return ret;
758218f7b5SHeinrich Schuchardt }
768218f7b5SHeinrich Schuchardt 
778218f7b5SHeinrich Schuchardt /*
788218f7b5SHeinrich Schuchardt  * Setup unit test.
798218f7b5SHeinrich Schuchardt  *
808218f7b5SHeinrich Schuchardt  * @handle:	handle of the loaded image
818218f7b5SHeinrich Schuchardt  * @systable:	system table
828218f7b5SHeinrich Schuchardt  * @return:	EFI_ST_SUCCESS for success
838218f7b5SHeinrich Schuchardt  */
setup(const efi_handle_t handle,const struct efi_system_table * systable)848218f7b5SHeinrich Schuchardt static int setup(const efi_handle_t handle,
858218f7b5SHeinrich Schuchardt 		 const struct efi_system_table *systable)
868218f7b5SHeinrich Schuchardt {
878218f7b5SHeinrich Schuchardt 	image_handle = handle;
888218f7b5SHeinrich Schuchardt 	boottime = systable->boottime;
898218f7b5SHeinrich Schuchardt 
908218f7b5SHeinrich Schuchardt 	/* Load the application image into memory */
918218f7b5SHeinrich Schuchardt 	decompress(&image);
928218f7b5SHeinrich Schuchardt 
938218f7b5SHeinrich Schuchardt 	return EFI_ST_SUCCESS;
948218f7b5SHeinrich Schuchardt }
958218f7b5SHeinrich Schuchardt 
968218f7b5SHeinrich Schuchardt /*
978218f7b5SHeinrich Schuchardt  * Tear down unit test.
988218f7b5SHeinrich Schuchardt  *
998218f7b5SHeinrich Schuchardt  * @return:	EFI_ST_SUCCESS for success
1008218f7b5SHeinrich Schuchardt  */
teardown(void)1018218f7b5SHeinrich Schuchardt static int teardown(void)
1028218f7b5SHeinrich Schuchardt {
1038218f7b5SHeinrich Schuchardt 	efi_status_t r = EFI_ST_SUCCESS;
1048218f7b5SHeinrich Schuchardt 
1058218f7b5SHeinrich Schuchardt 	if (image) {
106*afa17aa2SHeinrich Schuchardt 		r = boottime->free_pool(image);
1078218f7b5SHeinrich Schuchardt 		if (r != EFI_SUCCESS) {
1088218f7b5SHeinrich Schuchardt 			efi_st_error("Failed to free image\n");
1098218f7b5SHeinrich Schuchardt 			return EFI_ST_FAILURE;
1108218f7b5SHeinrich Schuchardt 		}
1118218f7b5SHeinrich Schuchardt 	}
1128218f7b5SHeinrich Schuchardt 	return r;
1138218f7b5SHeinrich Schuchardt }
1148218f7b5SHeinrich Schuchardt 
1158218f7b5SHeinrich Schuchardt /*
1168218f7b5SHeinrich Schuchardt  * Execute unit test.
1178218f7b5SHeinrich Schuchardt  *
1188218f7b5SHeinrich Schuchardt  * Load and start the application image.
1198218f7b5SHeinrich Schuchardt  *
1208218f7b5SHeinrich Schuchardt  * @return:	EFI_ST_SUCCESS for success
1218218f7b5SHeinrich Schuchardt  */
execute(void)1228218f7b5SHeinrich Schuchardt static int execute(void)
1238218f7b5SHeinrich Schuchardt {
1248218f7b5SHeinrich Schuchardt 	efi_status_t ret;
1258218f7b5SHeinrich Schuchardt 	efi_handle_t handle;
1268218f7b5SHeinrich Schuchardt 
1278218f7b5SHeinrich Schuchardt 	ret = boottime->load_image(false, image_handle, NULL, image,
1288218f7b5SHeinrich Schuchardt 				   img.length, &handle);
1298218f7b5SHeinrich Schuchardt 	if (ret != EFI_SUCCESS) {
1308218f7b5SHeinrich Schuchardt 		efi_st_error("Failed to load image\n");
1318218f7b5SHeinrich Schuchardt 		return EFI_ST_FAILURE;
1328218f7b5SHeinrich Schuchardt 	}
1338218f7b5SHeinrich Schuchardt 	ret = boottime->start_image(handle, NULL, NULL);
1348218f7b5SHeinrich Schuchardt 	if (ret != EFI_UNSUPPORTED) {
1358218f7b5SHeinrich Schuchardt 		efi_st_error("Wrong return value from application\n");
1368218f7b5SHeinrich Schuchardt 		return EFI_ST_FAILURE;
1378218f7b5SHeinrich Schuchardt 	}
1388218f7b5SHeinrich Schuchardt 
1398218f7b5SHeinrich Schuchardt 	return EFI_ST_SUCCESS;
1408218f7b5SHeinrich Schuchardt }
1418218f7b5SHeinrich Schuchardt 
1428218f7b5SHeinrich Schuchardt EFI_UNIT_TEST(startimage_exit) = {
1438218f7b5SHeinrich Schuchardt 	.name = "start image exit",
1448218f7b5SHeinrich Schuchardt 	.phase = EFI_EXECUTE_BEFORE_BOOTTIME_EXIT,
1458218f7b5SHeinrich Schuchardt 	.setup = setup,
1468218f7b5SHeinrich Schuchardt 	.execute = execute,
1478218f7b5SHeinrich Schuchardt 	.teardown = teardown,
1488218f7b5SHeinrich Schuchardt };
149