efi-stub-helper.c 21.0 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12
/*
 * Helper functions used by the EFI stub on multiple
 * architectures. This should be #included by the EFI stub
 * implementation files.
 *
 * Copyright 2011 Intel Corporation; author Matt Fleming
 *
 * This file is part of the Linux kernel, and is made available
 * under the terms of the GNU General Public License version 2.
 *
 */

13 14 15 16
#include <linux/efi.h>
#include <asm/efi.h>

#include "efistub.h"
17

18 19 20 21 22 23 24 25 26 27 28 29 30
/*
 * Some firmware implementations have problems reading files in one go.
 * A read chunk size of 1MB seems to work for most platforms.
 *
 * Unfortunately, reading files in chunks triggers *other* bugs on some
 * platforms, so we provide a way to disable this workaround, which can
 * be done by passing "efi=nochunk" on the EFI boot stub command line.
 *
 * If you experience issues with initrd images being corrupt it's worth
 * trying efi=nochunk, but chunking is enabled by default because there
 * are far more machines that require the workaround than those that
 * break with it enabled.
 */
31
#define EFI_READ_CHUNK_SIZE	(1024 * 1024)
32

33 34
static unsigned long __chunk_size = EFI_READ_CHUNK_SIZE;

35 36
#define EFI_MMAP_NR_SLACK_SLOTS	8

37
struct file_info {
38 39 40 41
	efi_file_handle_t *handle;
	u64 size;
};

42
void efi_printk(efi_system_table_t *sys_table_arg, char *str)
43 44 45 46 47 48 49 50 51
{
	char *s8;

	for (s8 = str; *s8; s8++) {
		efi_char16_t ch[2] = { 0 };

		ch[0] = *s8;
		if (*s8 == '\n') {
			efi_char16_t nl[2] = { '\r', 0 };
52
			efi_char16_printk(sys_table_arg, nl);
53 54
		}

55
		efi_char16_printk(sys_table_arg, ch);
56 57 58
	}
}

59 60 61 62 63 64 65 66 67
static inline bool mmap_has_headroom(unsigned long buff_size,
				     unsigned long map_size,
				     unsigned long desc_size)
{
	unsigned long slack = buff_size - map_size;

	return slack / desc_size >= EFI_MMAP_NR_SLACK_SLOTS;
}

68
efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
69
				struct efi_boot_memmap *map)
70 71 72 73 74 75
{
	efi_memory_desc_t *m = NULL;
	efi_status_t status;
	unsigned long key;
	u32 desc_version;

76 77 78
	*map->desc_size =	sizeof(*m);
	*map->map_size =	*map->desc_size * 32;
	*map->buff_size =	*map->map_size;
79
again:
80
	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
81
				*map->map_size, (void **)&m);
82 83 84
	if (status != EFI_SUCCESS)
		goto fail;

85
	*map->desc_size = 0;
86
	key = 0;
87 88 89 90 91
	status = efi_call_early(get_memory_map, map->map_size, m,
				&key, map->desc_size, &desc_version);
	if (status == EFI_BUFFER_TOO_SMALL ||
	    !mmap_has_headroom(*map->buff_size, *map->map_size,
			       *map->desc_size)) {
92
		efi_call_early(free_pool, m);
93 94 95 96 97 98 99 100 101
		/*
		 * Make sure there is some entries of headroom so that the
		 * buffer can be reused for a new map after allocations are
		 * no longer permitted.  Its unlikely that the map will grow to
		 * exceed this headroom once we are ready to trigger
		 * ExitBootServices()
		 */
		*map->map_size += *map->desc_size * EFI_MMAP_NR_SLACK_SLOTS;
		*map->buff_size = *map->map_size;
102
		goto again;
103 104 105
	}

	if (status != EFI_SUCCESS)
106
		efi_call_early(free_pool, m);
107

108 109 110 111
	if (map->key_ptr && status == EFI_SUCCESS)
		*map->key_ptr = key;
	if (map->desc_ver && status == EFI_SUCCESS)
		*map->desc_ver = desc_version;
112 113

fail:
114
	*map->map = m;
115 116 117
	return status;
}

118

119
unsigned long get_dram_base(efi_system_table_t *sys_table_arg)
120 121
{
	efi_status_t status;
122
	unsigned long map_size, buff_size;
123 124 125
	unsigned long membase  = EFI_ERROR;
	struct efi_memory_map map;
	efi_memory_desc_t *md;
126
	struct efi_boot_memmap boot_map;
127

128 129 130 131 132 133 134 135
	boot_map.map =		(efi_memory_desc_t **)&map.map;
	boot_map.map_size =	&map_size;
	boot_map.desc_size =	&map.desc_size;
	boot_map.desc_ver =	NULL;
	boot_map.key_ptr =	NULL;
	boot_map.buff_size =	&buff_size;

	status = efi_get_memory_map(sys_table_arg, &boot_map);
136 137 138 139 140
	if (status != EFI_SUCCESS)
		return membase;

	map.map_end = map.map + map_size;

141 142
	for_each_efi_memory_desc_in_map(&map, md) {
		if (md->attribute & EFI_MEMORY_WB) {
143 144
			if (membase > md->phys_addr)
				membase = md->phys_addr;
145 146
		}
	}
147 148 149 150 151 152

	efi_call_early(free_pool, map.map);

	return membase;
}

153 154 155
/*
 * Allocate at the highest possible address that is not above 'max'.
 */
156 157 158
efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
			    unsigned long size, unsigned long align,
			    unsigned long *addr, unsigned long max)
159
{
160
	unsigned long map_size, desc_size, buff_size;
161 162 163 164 165
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	u64 max_addr = 0;
	int i;
166 167 168 169 170 171 172 173
	struct efi_boot_memmap boot_map;

	boot_map.map =		&map;
	boot_map.map_size =	&map_size;
	boot_map.desc_size =	&desc_size;
	boot_map.desc_ver =	NULL;
	boot_map.key_ptr =	NULL;
	boot_map.buff_size =	&buff_size;
174

175
	status = efi_get_memory_map(sys_table_arg, &boot_map);
176 177 178
	if (status != EFI_SUCCESS)
		goto fail;

179
	/*
180 181 182 183
	 * Enforce minimum alignment that EFI or Linux requires when
	 * requesting a specific address.  We are doing page-based (or
	 * larger) allocations, and both the address and size must meet
	 * alignment constraints.
184
	 */
185 186
	if (align < EFI_ALLOC_ALIGN)
		align = EFI_ALLOC_ALIGN;
187

188 189
	size = round_up(size, EFI_ALLOC_ALIGN);
	nr_pages = size / EFI_PAGE_SIZE;
190 191 192 193 194 195 196 197 198 199 200 201 202 203
again:
	for (i = 0; i < map_size / desc_size; i++) {
		efi_memory_desc_t *desc;
		unsigned long m = (unsigned long)map;
		u64 start, end;

		desc = (efi_memory_desc_t *)(m + (i * desc_size));
		if (desc->type != EFI_CONVENTIONAL_MEMORY)
			continue;

		if (desc->num_pages < nr_pages)
			continue;

		start = desc->phys_addr;
204
		end = start + desc->num_pages * EFI_PAGE_SIZE;
205

206
		if (end > max)
207 208
			end = max;

209 210 211
		if ((start + size) > end)
			continue;

212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230
		if (round_down(end - size, align) < start)
			continue;

		start = round_down(end - size, align);

		/*
		 * Don't allocate at 0x0. It will confuse code that
		 * checks pointers against NULL.
		 */
		if (start == 0x0)
			continue;

		if (start > max_addr)
			max_addr = start;
	}

	if (!max_addr)
		status = EFI_NOT_FOUND;
	else {
231 232 233
		status = efi_call_early(allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &max_addr);
234 235 236 237 238 239 240 241 242
		if (status != EFI_SUCCESS) {
			max = max_addr;
			max_addr = 0;
			goto again;
		}

		*addr = max_addr;
	}

243
	efi_call_early(free_pool, map);
244 245 246 247 248 249 250
fail:
	return status;
}

/*
 * Allocate at the lowest possible address.
 */
251 252 253
efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
			   unsigned long size, unsigned long align,
			   unsigned long *addr)
254
{
255
	unsigned long map_size, desc_size, buff_size;
256 257 258 259
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	int i;
260 261 262 263 264 265 266 267
	struct efi_boot_memmap boot_map;

	boot_map.map =		&map;
	boot_map.map_size =	&map_size;
	boot_map.desc_size =	&desc_size;
	boot_map.desc_ver =	NULL;
	boot_map.key_ptr =	NULL;
	boot_map.buff_size =	&buff_size;
268

269
	status = efi_get_memory_map(sys_table_arg, &boot_map);
270 271 272
	if (status != EFI_SUCCESS)
		goto fail;

273
	/*
274 275 276 277
	 * Enforce minimum alignment that EFI or Linux requires when
	 * requesting a specific address.  We are doing page-based (or
	 * larger) allocations, and both the address and size must meet
	 * alignment constraints.
278
	 */
279 280
	if (align < EFI_ALLOC_ALIGN)
		align = EFI_ALLOC_ALIGN;
281

282 283
	size = round_up(size, EFI_ALLOC_ALIGN);
	nr_pages = size / EFI_PAGE_SIZE;
284 285 286 287 288 289 290 291 292 293 294 295 296 297
	for (i = 0; i < map_size / desc_size; i++) {
		efi_memory_desc_t *desc;
		unsigned long m = (unsigned long)map;
		u64 start, end;

		desc = (efi_memory_desc_t *)(m + (i * desc_size));

		if (desc->type != EFI_CONVENTIONAL_MEMORY)
			continue;

		if (desc->num_pages < nr_pages)
			continue;

		start = desc->phys_addr;
298
		end = start + desc->num_pages * EFI_PAGE_SIZE;
299 300 301 302 303 304 305 306 307 308 309 310 311

		/*
		 * Don't allocate at 0x0. It will confuse code that
		 * checks pointers against NULL. Skip the first 8
		 * bytes so we start at a nice even number.
		 */
		if (start == 0x0)
			start += 8;

		start = round_up(start, align);
		if ((start + size) > end)
			continue;

312 313 314
		status = efi_call_early(allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &start);
315 316 317 318 319 320 321 322 323
		if (status == EFI_SUCCESS) {
			*addr = start;
			break;
		}
	}

	if (i == map_size / desc_size)
		status = EFI_NOT_FOUND;

324
	efi_call_early(free_pool, map);
325 326 327 328
fail:
	return status;
}

329 330
void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
	      unsigned long addr)
331 332 333
{
	unsigned long nr_pages;

334 335 336
	if (!size)
		return;

337
	nr_pages = round_up(size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
338
	efi_call_early(free_pages, addr, nr_pages);
339 340
}

341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
static efi_status_t efi_file_size(efi_system_table_t *sys_table_arg, void *__fh,
				  efi_char16_t *filename_16, void **handle,
				  u64 *file_sz)
{
	efi_file_handle_t *h, *fh = __fh;
	efi_file_info_t *info;
	efi_status_t status;
	efi_guid_t info_guid = EFI_FILE_INFO_ID;
	unsigned long info_sz;

	status = efi_call_proto(efi_file_handle, open, fh, &h, filename_16,
				EFI_FILE_MODE_READ, (u64)0);
	if (status != EFI_SUCCESS) {
		efi_printk(sys_table_arg, "Failed to open file: ");
		efi_char16_printk(sys_table_arg, filename_16);
		efi_printk(sys_table_arg, "\n");
		return status;
	}

	*handle = h;

	info_sz = 0;
	status = efi_call_proto(efi_file_handle, get_info, h, &info_guid,
				&info_sz, NULL);
	if (status != EFI_BUFFER_TOO_SMALL) {
		efi_printk(sys_table_arg, "Failed to get file info size\n");
		return status;
	}

grow:
	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
				info_sz, (void **)&info);
	if (status != EFI_SUCCESS) {
		efi_printk(sys_table_arg, "Failed to alloc mem for file info\n");
		return status;
	}

	status = efi_call_proto(efi_file_handle, get_info, h, &info_guid,
				&info_sz, info);
	if (status == EFI_BUFFER_TOO_SMALL) {
		efi_call_early(free_pool, info);
		goto grow;
	}

	*file_sz = info->file_size;
	efi_call_early(free_pool, info);

	if (status != EFI_SUCCESS)
		efi_printk(sys_table_arg, "Failed to get initrd info\n");

	return status;
}

static efi_status_t efi_file_read(void *handle, unsigned long *size, void *addr)
{
	return efi_call_proto(efi_file_handle, read, handle, size, addr);
}

static efi_status_t efi_file_close(void *handle)
{
	return efi_call_proto(efi_file_handle, close, handle);
}

404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
/*
 * Parse the ASCII string 'cmdline' for EFI options, denoted by the efi=
 * option, e.g. efi=nochunk.
 *
 * It should be noted that efi= is parsed in two very different
 * environments, first in the early boot environment of the EFI boot
 * stub, and subsequently during the kernel boot.
 */
efi_status_t efi_parse_options(char *cmdline)
{
	char *str;

	/*
	 * If no EFI parameters were specified on the cmdline we've got
	 * nothing to do.
	 */
	str = strstr(cmdline, "efi=");
	if (!str)
		return EFI_SUCCESS;

	/* Skip ahead to first argument */
	str += strlen("efi=");

	/*
	 * Remember, because efi= is also used by the kernel we need to
	 * skip over arguments we don't understand.
	 */
	while (*str) {
		if (!strncmp(str, "nochunk", 7)) {
			str += strlen("nochunk");
			__chunk_size = -1UL;
		}

		/* Group words together, delimited by "," */
		while (*str && *str != ',')
			str++;

		if (*str == ',')
			str++;
	}

	return EFI_SUCCESS;
}
447 448

/*
449
 * Check the cmdline for a LILO-style file= arguments.
450
 *
451 452
 * We only support loading a file from the same filesystem as
 * the kernel image.
453
 */
454 455 456 457 458 459
efi_status_t handle_cmdline_files(efi_system_table_t *sys_table_arg,
				  efi_loaded_image_t *image,
				  char *cmd_line, char *option_string,
				  unsigned long max_addr,
				  unsigned long *load_addr,
				  unsigned long *load_size)
460
{
461 462 463
	struct file_info *files;
	unsigned long file_addr;
	u64 file_size_total;
L
Leif Lindholm 已提交
464
	efi_file_handle_t *fh = NULL;
465
	efi_status_t status;
466
	int nr_files;
467 468 469
	char *str;
	int i, j, k;

470 471
	file_addr = 0;
	file_size_total = 0;
472

473
	str = cmd_line;
474 475 476

	j = 0;			/* See close_handles */

477 478 479 480 481 482
	if (!load_addr || !load_size)
		return EFI_INVALID_PARAMETER;

	*load_addr = 0;
	*load_size = 0;

483 484 485
	if (!str || !*str)
		return EFI_SUCCESS;

486
	for (nr_files = 0; *str; nr_files++) {
487
		str = strstr(str, option_string);
488 489 490
		if (!str)
			break;

491
		str += strlen(option_string);
492 493 494 495 496 497 498 499 500

		/* Skip any leading slashes */
		while (*str == '/' || *str == '\\')
			str++;

		while (*str && *str != ' ' && *str != '\n')
			str++;
	}

501
	if (!nr_files)
502 503
		return EFI_SUCCESS;

504 505
	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
				nr_files * sizeof(*files), (void **)&files);
506
	if (status != EFI_SUCCESS) {
507
		pr_efi_err(sys_table_arg, "Failed to alloc mem for file handle list\n");
508 509 510
		goto fail;
	}

511
	str = cmd_line;
512 513
	for (i = 0; i < nr_files; i++) {
		struct file_info *file;
514 515 516
		efi_char16_t filename_16[256];
		efi_char16_t *p;

517
		str = strstr(str, option_string);
518 519 520
		if (!str)
			break;

521
		str += strlen(option_string);
522

523
		file = &files[i];
524 525 526 527 528 529 530 531 532 533 534 535
		p = filename_16;

		/* Skip any leading slashes */
		while (*str == '/' || *str == '\\')
			str++;

		while (*str && *str != ' ' && *str != '\n') {
			if ((u8 *)p >= (u8 *)filename_16 + sizeof(filename_16))
				break;

			if (*str == '/') {
				*p++ = '\\';
536
				str++;
537 538 539 540 541 542 543 544 545
			} else {
				*p++ = *str++;
			}
		}

		*p = '\0';

		/* Only open the volume once. */
		if (!i) {
546 547 548
			status = efi_open_volume(sys_table_arg, image,
						 (void **)&fh);
			if (status != EFI_SUCCESS)
549
				goto free_files;
550 551
		}

552 553 554
		status = efi_file_size(sys_table_arg, fh, filename_16,
				       (void **)&file->handle, &file->size);
		if (status != EFI_SUCCESS)
555 556
			goto close_handles;

557
		file_size_total += file->size;
558 559
	}

560
	if (file_size_total) {
561 562 563
		unsigned long addr;

		/*
564 565 566
		 * Multiple files need to be at consecutive addresses in memory,
		 * so allocate enough memory for all the files.  This is used
		 * for loading multiple files.
567
		 */
568 569
		status = efi_high_alloc(sys_table_arg, file_size_total, 0x1000,
				    &file_addr, max_addr);
570
		if (status != EFI_SUCCESS) {
571
			pr_efi_err(sys_table_arg, "Failed to alloc highmem for files\n");
572 573 574 575
			goto close_handles;
		}

		/* We've run out of free low memory. */
576
		if (file_addr > max_addr) {
577
			pr_efi_err(sys_table_arg, "We've run out of free low memory\n");
578
			status = EFI_INVALID_PARAMETER;
579
			goto free_file_total;
580 581
		}

582 583
		addr = file_addr;
		for (j = 0; j < nr_files; j++) {
584
			unsigned long size;
585

586
			size = files[j].size;
587
			while (size) {
588
				unsigned long chunksize;
589 590
				if (size > __chunk_size)
					chunksize = __chunk_size;
591 592
				else
					chunksize = size;
593

594
				status = efi_file_read(files[j].handle,
595 596
						       &chunksize,
						       (void *)addr);
597
				if (status != EFI_SUCCESS) {
598
					pr_efi_err(sys_table_arg, "Failed to read file\n");
599
					goto free_file_total;
600 601 602 603 604
				}
				addr += chunksize;
				size -= chunksize;
			}

605
			efi_file_close(files[j].handle);
606 607 608 609
		}

	}

610
	efi_call_early(free_pool, files);
611

612 613
	*load_addr = file_addr;
	*load_size = file_size_total;
614 615 616

	return status;

617 618
free_file_total:
	efi_free(sys_table_arg, file_size_total, file_addr);
619 620 621

close_handles:
	for (k = j; k < i; k++)
622
		efi_file_close(files[k].handle);
623
free_files:
624
	efi_call_early(free_pool, files);
625
fail:
626 627
	*load_addr = 0;
	*load_size = 0;
628 629 630

	return status;
}
631 632 633 634 635 636 637 638 639 640
/*
 * Relocate a kernel image, either compressed or uncompressed.
 * In the ARM64 case, all kernel images are currently
 * uncompressed, and as such when we relocate it we need to
 * allocate additional space for the BSS segment. Any low
 * memory that this function should avoid needs to be
 * unavailable in the EFI memory map, as if the preferred
 * address is not available the lowest available address will
 * be used.
 */
641 642 643 644 645 646
efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
				 unsigned long *image_addr,
				 unsigned long image_size,
				 unsigned long alloc_size,
				 unsigned long preferred_addr,
				 unsigned long alignment)
647
{
648 649
	unsigned long cur_image_addr;
	unsigned long new_addr = 0;
650
	efi_status_t status;
651 652 653 654 655 656 657 658 659
	unsigned long nr_pages;
	efi_physical_addr_t efi_addr = preferred_addr;

	if (!image_addr || !image_size || !alloc_size)
		return EFI_INVALID_PARAMETER;
	if (alloc_size < image_size)
		return EFI_INVALID_PARAMETER;

	cur_image_addr = *image_addr;
660 661 662

	/*
	 * The EFI firmware loader could have placed the kernel image
663 664 665 666 667
	 * anywhere in memory, but the kernel has restrictions on the
	 * max physical address it can run at.  Some architectures
	 * also have a prefered address, so first try to relocate
	 * to the preferred address.  If that fails, allocate as low
	 * as possible while respecting the required alignment.
668
	 */
669
	nr_pages = round_up(alloc_size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
670 671 672
	status = efi_call_early(allocate_pages,
				EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
				nr_pages, &efi_addr);
673 674 675 676 677
	new_addr = efi_addr;
	/*
	 * If preferred address allocation failed allocate as low as
	 * possible.
	 */
678
	if (status != EFI_SUCCESS) {
679 680 681 682
		status = efi_low_alloc(sys_table_arg, alloc_size, alignment,
				       &new_addr);
	}
	if (status != EFI_SUCCESS) {
683
		pr_efi_err(sys_table_arg, "Failed to allocate usable memory for kernel.\n");
684
		return status;
685 686
	}

687 688 689 690 691
	/*
	 * We know source/dest won't overlap since both memory ranges
	 * have been allocated by UEFI, so we can safely use memcpy.
	 */
	memcpy((void *)new_addr, (void *)cur_image_addr, image_size);
692

693 694
	/* Return the new address of the relocated image. */
	*image_addr = new_addr;
695 696 697

	return status;
}
698

699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
/*
 * Get the number of UTF-8 bytes corresponding to an UTF-16 character.
 * This overestimates for surrogates, but that is okay.
 */
static int efi_utf8_bytes(u16 c)
{
	return 1 + (c >= 0x80) + (c >= 0x800);
}

/*
 * Convert an UTF-16 string, not necessarily null terminated, to UTF-8.
 */
static u8 *efi_utf16_to_utf8(u8 *dst, const u16 *src, int n)
{
	unsigned int c;

	while (n--) {
		c = *src++;
		if (n && c >= 0xd800 && c <= 0xdbff &&
		    *src >= 0xdc00 && *src <= 0xdfff) {
			c = 0x10000 + ((c & 0x3ff) << 10) + (*src & 0x3ff);
			src++;
			n--;
		}
		if (c >= 0xd800 && c <= 0xdfff)
			c = 0xfffd; /* Unmatched surrogate */
		if (c < 0x80) {
			*dst++ = c;
			continue;
		}
		if (c < 0x800) {
			*dst++ = 0xc0 + (c >> 6);
			goto t1;
		}
		if (c < 0x10000) {
			*dst++ = 0xe0 + (c >> 12);
			goto t2;
		}
		*dst++ = 0xf0 + (c >> 18);
		*dst++ = 0x80 + ((c >> 12) & 0x3f);
	t2:
		*dst++ = 0x80 + ((c >> 6) & 0x3f);
	t1:
		*dst++ = 0x80 + (c & 0x3f);
	}

	return dst;
}

748 749 750 751
#ifndef MAX_CMDLINE_ADDRESS
#define MAX_CMDLINE_ADDRESS	ULONG_MAX
#endif

752 753 754 755 756
/*
 * Convert the unicode UEFI command line to ASCII to pass to kernel.
 * Size of memory allocated return in *cmd_line_len.
 * Returns NULL on error.
 */
757 758 759
char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
			  efi_loaded_image_t *image,
			  int *cmd_line_len)
760
{
761
	const u16 *s2;
762 763
	u8 *s1 = NULL;
	unsigned long cmdline_addr = 0;
764 765 766 767
	int load_options_chars = image->load_options_size / 2; /* UTF-16 */
	const u16 *options = image->load_options;
	int options_bytes = 0;  /* UTF-8 bytes */
	int options_chars = 0;  /* UTF-16 chars */
768 769 770 771 772
	efi_status_t status;
	u16 zero = 0;

	if (options) {
		s2 = options;
773 774 775 776
		while (*s2 && *s2 != '\n'
		       && options_chars < load_options_chars) {
			options_bytes += efi_utf8_bytes(*s2++);
			options_chars++;
777 778 779
		}
	}

780
	if (!options_chars) {
781 782 783 784
		/* No command line options, so return empty string*/
		options = &zero;
	}

785
	options_bytes++;	/* NUL termination */
L
Leif Lindholm 已提交
786

787 788
	status = efi_high_alloc(sys_table_arg, options_bytes, 0,
				&cmdline_addr, MAX_CMDLINE_ADDRESS);
789 790 791 792
	if (status != EFI_SUCCESS)
		return NULL;

	s1 = (u8 *)cmdline_addr;
793
	s2 = (const u16 *)options;
794

795
	s1 = efi_utf16_to_utf8(s1, s2, options_chars);
796 797
	*s1 = '\0';

798
	*cmd_line_len = options_bytes;
799 800
	return (char *)cmdline_addr;
}
801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873

/*
 * Handle calling ExitBootServices according to the requirements set out by the
 * spec.  Obtains the current memory map, and returns that info after calling
 * ExitBootServices.  The client must specify a function to perform any
 * processing of the memory map data prior to ExitBootServices.  A client
 * specific structure may be passed to the function via priv.  The client
 * function may be called multiple times.
 */
efi_status_t efi_exit_boot_services(efi_system_table_t *sys_table_arg,
				    void *handle,
				    struct efi_boot_memmap *map,
				    void *priv,
				    efi_exit_boot_map_processing priv_func)
{
	efi_status_t status;

	status = efi_get_memory_map(sys_table_arg, map);

	if (status != EFI_SUCCESS)
		goto fail;

	status = priv_func(sys_table_arg, map, priv);
	if (status != EFI_SUCCESS)
		goto free_map;

	status = efi_call_early(exit_boot_services, handle, *map->key_ptr);

	if (status == EFI_INVALID_PARAMETER) {
		/*
		 * The memory map changed between efi_get_memory_map() and
		 * exit_boot_services().  Per the UEFI Spec v2.6, Section 6.4:
		 * EFI_BOOT_SERVICES.ExitBootServices we need to get the
		 * updated map, and try again.  The spec implies one retry
		 * should be sufficent, which is confirmed against the EDK2
		 * implementation.  Per the spec, we can only invoke
		 * get_memory_map() and exit_boot_services() - we cannot alloc
		 * so efi_get_memory_map() cannot be used, and we must reuse
		 * the buffer.  For all practical purposes, the headroom in the
		 * buffer should account for any changes in the map so the call
		 * to get_memory_map() is expected to succeed here.
		 */
		*map->map_size = *map->buff_size;
		status = efi_call_early(get_memory_map,
					map->map_size,
					*map->map,
					map->key_ptr,
					map->desc_size,
					map->desc_ver);

		/* exit_boot_services() was called, thus cannot free */
		if (status != EFI_SUCCESS)
			goto fail;

		status = priv_func(sys_table_arg, map, priv);
		/* exit_boot_services() was called, thus cannot free */
		if (status != EFI_SUCCESS)
			goto fail;

		status = efi_call_early(exit_boot_services, handle, *map->key_ptr);
	}

	/* exit_boot_services() was called, thus cannot free */
	if (status != EFI_SUCCESS)
		goto fail;

	return EFI_SUCCESS;

free_map:
	efi_call_early(free_pool, *map->map);
fail:
	return status;
}