efi-stub-helper.c 23.1 KB
Newer Older
1
// SPDX-License-Identifier: GPL-2.0
2 3 4 5 6 7 8 9
/*
 * 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
 */

10 11 12 13
#include <linux/efi.h>
#include <asm/efi.h>

#include "efistub.h"
14

15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 * 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.
 */
28
#define EFI_READ_CHUNK_SIZE	(1024 * 1024)
29

30 31
static unsigned long __chunk_size = EFI_READ_CHUNK_SIZE;

32
static int __section(.data) __nokaslr;
33
static int __section(.data) __quiet;
34
static int __section(.data) __novamap;
35
static bool __section(.data) efi_nosoftreserve;
36 37 38 39 40

int __pure nokaslr(void)
{
	return __nokaslr;
}
41 42 43 44
int __pure is_quiet(void)
{
	return __quiet;
}
45 46 47 48
int __pure novamap(void)
{
	return __novamap;
}
49 50 51 52
bool __pure __efi_soft_reserve_enabled(void)
{
	return !efi_nosoftreserve;
}
53

54 55
#define EFI_MMAP_NR_SLACK_SLOTS	8

56
struct file_info {
57 58 59 60
	efi_file_handle_t *handle;
	u64 size;
};

61
void efi_printk(efi_system_table_t *sys_table_arg, char *str)
62 63 64 65 66 67 68 69 70
{
	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 };
71
			efi_char16_printk(sys_table_arg, nl);
72 73
		}

74
		efi_char16_printk(sys_table_arg, ch);
75 76 77
	}
}

78 79 80 81 82 83 84 85 86
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;
}

87
efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
88
				struct efi_boot_memmap *map)
89 90 91 92 93 94
{
	efi_memory_desc_t *m = NULL;
	efi_status_t status;
	unsigned long key;
	u32 desc_version;

95 96 97
	*map->desc_size =	sizeof(*m);
	*map->map_size =	*map->desc_size * 32;
	*map->buff_size =	*map->map_size;
98
again:
99
	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
100
				*map->map_size, (void **)&m);
101 102 103
	if (status != EFI_SUCCESS)
		goto fail;

104
	*map->desc_size = 0;
105
	key = 0;
106 107 108 109 110
	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)) {
111
		efi_call_early(free_pool, m);
112 113 114 115 116 117 118 119 120
		/*
		 * 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;
121
		goto again;
122 123 124
	}

	if (status != EFI_SUCCESS)
125
		efi_call_early(free_pool, m);
126

127 128 129 130
	if (map->key_ptr && status == EFI_SUCCESS)
		*map->key_ptr = key;
	if (map->desc_ver && status == EFI_SUCCESS)
		*map->desc_ver = desc_version;
131 132

fail:
133
	*map->map = m;
134 135 136
	return status;
}

137

138
unsigned long get_dram_base(efi_system_table_t *sys_table_arg)
139 140
{
	efi_status_t status;
141
	unsigned long map_size, buff_size;
142 143 144
	unsigned long membase  = EFI_ERROR;
	struct efi_memory_map map;
	efi_memory_desc_t *md;
145
	struct efi_boot_memmap boot_map;
146

147 148 149 150 151 152 153 154
	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);
155 156 157 158 159
	if (status != EFI_SUCCESS)
		return membase;

	map.map_end = map.map + map_size;

160 161
	for_each_efi_memory_desc_in_map(&map, md) {
		if (md->attribute & EFI_MEMORY_WB) {
162 163
			if (membase > md->phys_addr)
				membase = md->phys_addr;
164 165
		}
	}
166 167 168 169 170 171

	efi_call_early(free_pool, map.map);

	return membase;
}

172 173 174
/*
 * Allocate at the highest possible address that is not above 'max'.
 */
175 176 177
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)
178
{
179
	unsigned long map_size, desc_size, buff_size;
180 181 182 183 184
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	u64 max_addr = 0;
	int i;
185 186 187 188 189 190 191 192
	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;
193

194
	status = efi_get_memory_map(sys_table_arg, &boot_map);
195 196 197
	if (status != EFI_SUCCESS)
		goto fail;

198
	/*
199 200 201 202
	 * 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.
203
	 */
204 205
	if (align < EFI_ALLOC_ALIGN)
		align = EFI_ALLOC_ALIGN;
206

207 208
	size = round_up(size, EFI_ALLOC_ALIGN);
	nr_pages = size / EFI_PAGE_SIZE;
209 210 211 212 213 214
again:
	for (i = 0; i < map_size / desc_size; i++) {
		efi_memory_desc_t *desc;
		unsigned long m = (unsigned long)map;
		u64 start, end;

215
		desc = efi_early_memdesc_ptr(m, desc_size, i);
216 217 218
		if (desc->type != EFI_CONVENTIONAL_MEMORY)
			continue;

219 220 221 222
		if (efi_soft_reserve_enabled() &&
		    (desc->attribute & EFI_MEMORY_SP))
			continue;

223 224 225 226
		if (desc->num_pages < nr_pages)
			continue;

		start = desc->phys_addr;
227
		end = start + desc->num_pages * EFI_PAGE_SIZE;
228

229
		if (end > max)
230 231
			end = max;

232 233 234
		if ((start + size) > end)
			continue;

235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
		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 {
254 255 256
		status = efi_call_early(allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &max_addr);
257 258 259 260 261 262 263 264 265
		if (status != EFI_SUCCESS) {
			max = max_addr;
			max_addr = 0;
			goto again;
		}

		*addr = max_addr;
	}

266
	efi_call_early(free_pool, map);
267 268 269 270 271
fail:
	return status;
}

/*
272
 * Allocate at the lowest possible address that is not below 'min'.
273
 */
274 275 276
efi_status_t efi_low_alloc_above(efi_system_table_t *sys_table_arg,
				 unsigned long size, unsigned long align,
				 unsigned long *addr, unsigned long min)
277
{
278
	unsigned long map_size, desc_size, buff_size;
279 280 281 282
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	int i;
283 284 285 286 287 288 289 290
	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;
291

292
	status = efi_get_memory_map(sys_table_arg, &boot_map);
293 294 295
	if (status != EFI_SUCCESS)
		goto fail;

296
	/*
297 298 299 300
	 * 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.
301
	 */
302 303
	if (align < EFI_ALLOC_ALIGN)
		align = EFI_ALLOC_ALIGN;
304

305 306
	size = round_up(size, EFI_ALLOC_ALIGN);
	nr_pages = size / EFI_PAGE_SIZE;
307 308 309 310 311
	for (i = 0; i < map_size / desc_size; i++) {
		efi_memory_desc_t *desc;
		unsigned long m = (unsigned long)map;
		u64 start, end;

312
		desc = efi_early_memdesc_ptr(m, desc_size, i);
313 314 315 316

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

317 318 319 320
		if (efi_soft_reserve_enabled() &&
		    (desc->attribute & EFI_MEMORY_SP))
			continue;

321 322 323 324
		if (desc->num_pages < nr_pages)
			continue;

		start = desc->phys_addr;
325
		end = start + desc->num_pages * EFI_PAGE_SIZE;
326

327 328
		if (start < min)
			start = min;
329 330 331 332 333

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

334 335 336
		status = efi_call_early(allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &start);
337 338 339 340 341 342 343 344 345
		if (status == EFI_SUCCESS) {
			*addr = start;
			break;
		}
	}

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

346
	efi_call_early(free_pool, map);
347 348 349 350
fail:
	return status;
}

351 352
void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
	      unsigned long addr)
353 354 355
{
	unsigned long nr_pages;

356 357 358
	if (!size)
		return;

359
	nr_pages = round_up(size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
360
	efi_call_early(free_pages, addr, nr_pages);
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 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425
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);
}

426 427 428 429 430 431 432 433
static efi_status_t efi_open_volume(efi_system_table_t *sys_table_arg,
				    efi_loaded_image_t *image,
				    efi_file_handle_t **__fh)
{
	efi_file_io_interface_t *io;
	efi_file_handle_t *fh;
	efi_guid_t fs_proto = EFI_FILE_SYSTEM_GUID;
	efi_status_t status;
434
	void *handle = efi_table_attr(efi_loaded_image, device_handle, image);
435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451

	status = efi_call_early(handle_protocol, handle,
				&fs_proto, (void **)&io);
	if (status != EFI_SUCCESS) {
		efi_printk(sys_table_arg, "Failed to handle fs_proto\n");
		return status;
	}

	status = efi_call_proto(efi_file_io_interface, open_volume, io, &fh);
	if (status != EFI_SUCCESS)
		efi_printk(sys_table_arg, "Failed to open volume\n");
	else
		*__fh = fh;

	return status;
}

452 453 454 455 456 457 458 459
/*
 * 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.
 */
460
efi_status_t efi_parse_options(char const *cmdline)
461 462 463
{
	char *str;

464 465 466
	str = strstr(cmdline, "nokaslr");
	if (str == cmdline || (str && str > cmdline && *(str - 1) == ' '))
		__nokaslr = 1;
467

468 469 470 471
	str = strstr(cmdline, "quiet");
	if (str == cmdline || (str && str > cmdline && *(str - 1) == ' '))
		__quiet = 1;

472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
	/*
	 * 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.
	 */
487
	while (*str && *str != ' ') {
488 489 490 491 492
		if (!strncmp(str, "nochunk", 7)) {
			str += strlen("nochunk");
			__chunk_size = -1UL;
		}

493 494 495 496 497
		if (!strncmp(str, "novamap", 7)) {
			str += strlen("novamap");
			__novamap = 1;
		}

498 499 500 501 502 503
		if (IS_ENABLED(CONFIG_EFI_SOFT_RESERVE) &&
		    !strncmp(str, "nosoftreserve", 7)) {
			str += strlen("nosoftreserve");
			efi_nosoftreserve = 1;
		}

504
		/* Group words together, delimited by "," */
505
		while (*str && *str != ' ' && *str != ',')
506 507 508 509 510 511 512 513
			str++;

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

	return EFI_SUCCESS;
}
514 515

/*
516
 * Check the cmdline for a LILO-style file= arguments.
517
 *
518 519
 * We only support loading a file from the same filesystem as
 * the kernel image.
520
 */
521 522 523 524 525 526
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)
527
{
528 529 530
	struct file_info *files;
	unsigned long file_addr;
	u64 file_size_total;
L
Leif Lindholm 已提交
531
	efi_file_handle_t *fh = NULL;
532
	efi_status_t status;
533
	int nr_files;
534 535 536
	char *str;
	int i, j, k;

537 538
	file_addr = 0;
	file_size_total = 0;
539

540
	str = cmd_line;
541 542 543

	j = 0;			/* See close_handles */

544 545 546 547 548 549
	if (!load_addr || !load_size)
		return EFI_INVALID_PARAMETER;

	*load_addr = 0;
	*load_size = 0;

550 551 552
	if (!str || !*str)
		return EFI_SUCCESS;

553
	for (nr_files = 0; *str; nr_files++) {
554
		str = strstr(str, option_string);
555 556 557
		if (!str)
			break;

558
		str += strlen(option_string);
559 560 561 562 563 564 565 566 567

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

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

568
	if (!nr_files)
569 570
		return EFI_SUCCESS;

571 572
	status = efi_call_early(allocate_pool, EFI_LOADER_DATA,
				nr_files * sizeof(*files), (void **)&files);
573
	if (status != EFI_SUCCESS) {
574
		pr_efi_err(sys_table_arg, "Failed to alloc mem for file handle list\n");
575 576 577
		goto fail;
	}

578
	str = cmd_line;
579 580
	for (i = 0; i < nr_files; i++) {
		struct file_info *file;
581 582 583
		efi_char16_t filename_16[256];
		efi_char16_t *p;

584
		str = strstr(str, option_string);
585 586 587
		if (!str)
			break;

588
		str += strlen(option_string);
589

590
		file = &files[i];
591 592 593 594 595 596 597 598 599 600 601 602
		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++ = '\\';
603
				str++;
604 605 606 607 608 609 610 611 612
			} else {
				*p++ = *str++;
			}
		}

		*p = '\0';

		/* Only open the volume once. */
		if (!i) {
613
			status = efi_open_volume(sys_table_arg, image, &fh);
614
			if (status != EFI_SUCCESS)
615
				goto free_files;
616 617
		}

618 619 620
		status = efi_file_size(sys_table_arg, fh, filename_16,
				       (void **)&file->handle, &file->size);
		if (status != EFI_SUCCESS)
621 622
			goto close_handles;

623
		file_size_total += file->size;
624 625
	}

626
	if (file_size_total) {
627 628 629
		unsigned long addr;

		/*
630 631 632
		 * 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.
633
		 */
634 635
		status = efi_high_alloc(sys_table_arg, file_size_total, 0x1000,
				    &file_addr, max_addr);
636
		if (status != EFI_SUCCESS) {
637
			pr_efi_err(sys_table_arg, "Failed to alloc highmem for files\n");
638 639 640 641
			goto close_handles;
		}

		/* We've run out of free low memory. */
642
		if (file_addr > max_addr) {
643
			pr_efi_err(sys_table_arg, "We've run out of free low memory\n");
644
			status = EFI_INVALID_PARAMETER;
645
			goto free_file_total;
646 647
		}

648 649
		addr = file_addr;
		for (j = 0; j < nr_files; j++) {
650
			unsigned long size;
651

652
			size = files[j].size;
653
			while (size) {
654
				unsigned long chunksize;
655 656

				if (IS_ENABLED(CONFIG_X86) && size > __chunk_size)
657
					chunksize = __chunk_size;
658 659
				else
					chunksize = size;
660

661
				status = efi_file_read(files[j].handle,
662 663
						       &chunksize,
						       (void *)addr);
664
				if (status != EFI_SUCCESS) {
665
					pr_efi_err(sys_table_arg, "Failed to read file\n");
666
					goto free_file_total;
667 668 669 670 671
				}
				addr += chunksize;
				size -= chunksize;
			}

672
			efi_file_close(files[j].handle);
673 674 675 676
		}

	}

677
	efi_call_early(free_pool, files);
678

679 680
	*load_addr = file_addr;
	*load_size = file_size_total;
681 682 683

	return status;

684 685
free_file_total:
	efi_free(sys_table_arg, file_size_total, file_addr);
686 687 688

close_handles:
	for (k = j; k < i; k++)
689
		efi_file_close(files[k].handle);
690
free_files:
691
	efi_call_early(free_pool, files);
692
fail:
693 694
	*load_addr = 0;
	*load_size = 0;
695 696 697

	return status;
}
698 699 700 701 702 703 704 705 706 707
/*
 * 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.
 */
708 709 710 711 712
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,
713 714
				 unsigned long alignment,
				 unsigned long min_addr)
715
{
716 717
	unsigned long cur_image_addr;
	unsigned long new_addr = 0;
718
	efi_status_t status;
719 720 721 722 723 724 725 726 727
	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;
728 729 730

	/*
	 * The EFI firmware loader could have placed the kernel image
731 732 733 734 735
	 * 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.
736
	 */
737
	nr_pages = round_up(alloc_size, EFI_ALLOC_ALIGN) / EFI_PAGE_SIZE;
738 739 740
	status = efi_call_early(allocate_pages,
				EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
				nr_pages, &efi_addr);
741 742 743 744 745
	new_addr = efi_addr;
	/*
	 * If preferred address allocation failed allocate as low as
	 * possible.
	 */
746
	if (status != EFI_SUCCESS) {
747 748
		status = efi_low_alloc_above(sys_table_arg, alloc_size,
					     alignment, &new_addr, min_addr);
749 750
	}
	if (status != EFI_SUCCESS) {
751
		pr_efi_err(sys_table_arg, "Failed to allocate usable memory for kernel.\n");
752
		return status;
753 754
	}

755 756 757 758 759
	/*
	 * 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);
760

761 762
	/* Return the new address of the relocated image. */
	*image_addr = new_addr;
763 764 765

	return status;
}
766

767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815
/*
 * 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;
}

816 817 818 819
#ifndef MAX_CMDLINE_ADDRESS
#define MAX_CMDLINE_ADDRESS	ULONG_MAX
#endif

820 821 822 823 824
/*
 * 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.
 */
825 826 827
char *efi_convert_cmdline(efi_system_table_t *sys_table_arg,
			  efi_loaded_image_t *image,
			  int *cmd_line_len)
828
{
829
	const u16 *s2;
830 831
	u8 *s1 = NULL;
	unsigned long cmdline_addr = 0;
832 833 834 835
	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 */
836 837 838 839 840
	efi_status_t status;
	u16 zero = 0;

	if (options) {
		s2 = options;
841 842 843 844
		while (*s2 && *s2 != '\n'
		       && options_chars < load_options_chars) {
			options_bytes += efi_utf8_bytes(*s2++);
			options_chars++;
845 846 847
		}
	}

848
	if (!options_chars) {
849 850 851 852
		/* No command line options, so return empty string*/
		options = &zero;
	}

853
	options_bytes++;	/* NUL termination */
L
Leif Lindholm 已提交
854

855 856
	status = efi_high_alloc(sys_table_arg, options_bytes, 0,
				&cmdline_addr, MAX_CMDLINE_ADDRESS);
857 858 859 860
	if (status != EFI_SUCCESS)
		return NULL;

	s1 = (u8 *)cmdline_addr;
861
	s2 = (const u16 *)options;
862

863
	s1 = efi_utf16_to_utf8(s1, s2, options_chars);
864 865
	*s1 = '\0';

866
	*cmd_line_len = options_bytes;
867 868
	return (char *)cmdline_addr;
}
869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941

/*
 * 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;
}
942 943 944

void *get_efi_config_table(efi_system_table_t *sys_table, efi_guid_t guid)
{
945 946 947 948 949 950 951 952 953 954 955 956 957 958
	unsigned long tables = efi_table_attr(efi_system_table, tables, sys_table);
	int nr_tables = efi_table_attr(efi_system_table, nr_tables, sys_table);
	int i;

	for (i = 0; i < nr_tables; i++) {
		efi_config_table_t *t = (void *)tables;

		if (efi_guidcmp(t->guid, guid) == 0)
			return efi_table_attr(efi_config_table, table, t);

		tables += efi_is_native() ? sizeof(efi_config_table_t)
					  : sizeof(efi_config_table_32_t);
	}
	return NULL;
959
}