[linux-2.6-block.git] / drivers / firmware / efi / efi-stub-helper.c

/*
 * 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.
 *
 */
#define EFI_READ_CHUNK_SIZE	(1024 * 1024)

struct initrd {
	efi_file_handle_t *handle;
	u64 size;
};


static void efi_char16_printk(efi_system_table_t *sys_table_arg,
			      efi_char16_t *str)
{
	struct efi_simple_text_output_protocol *out;

	out = (struct efi_simple_text_output_protocol *)sys_table_arg->con_out;
	efi_call_phys2(out->output_string, out, str);
}

static void efi_printk(efi_system_table_t *sys_table_arg, char *str)
{
	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 };
			efi_char16_printk(sys_table_arg, nl);
		}

		efi_char16_printk(sys_table_arg, ch);
	}
}


static efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
				       efi_memory_desc_t **map,
				       unsigned long *map_size,
				       unsigned long *desc_size,
				       u32 *desc_ver,
				       unsigned long *key_ptr)
{
	efi_memory_desc_t *m = NULL;
	efi_status_t status;
	unsigned long key;
	u32 desc_version;

	*map_size = sizeof(*m) * 32;
again:
	/*
	 * Add an additional efi_memory_desc_t because we're doing an
	 * allocation which may be in a new descriptor region.
	 */
	*map_size += sizeof(*m);
	status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
				EFI_LOADER_DATA, *map_size, (void **)&m);
	if (status != EFI_SUCCESS)
		goto fail;

	status = efi_call_phys5(sys_table_arg->boottime->get_memory_map,
				map_size, m, &key, desc_size, &desc_version);
	if (status == EFI_BUFFER_TOO_SMALL) {
		efi_call_phys1(sys_table_arg->boottime->free_pool, m);
		goto again;
	}

	if (status != EFI_SUCCESS)
		efi_call_phys1(sys_table_arg->boottime->free_pool, m);
	if (key_ptr && status == EFI_SUCCESS)
		*key_ptr = key;
	if (desc_ver && status == EFI_SUCCESS)
		*desc_ver = desc_version;

fail:
	*map = m;
	return status;
}

/*
 * Allocate at the highest possible address that is not above 'max'.
 */
static 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)
{
	unsigned long map_size, desc_size;
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	u64 max_addr = 0;
	int i;

	status = efi_get_memory_map(sys_table_arg, &map, &map_size, &desc_size,
				    NULL, NULL);
	if (status != EFI_SUCCESS)
		goto fail;

	/*
	 * Enforce minimum alignment that EFI requires when requesting
	 * a specific address.  We are doing page-based allocations,
	 * so we must be aligned to a page.
	 */
	if (align < EFI_PAGE_SIZE)
		align = EFI_PAGE_SIZE;

	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
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;
		end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);

		if ((start + size) > end || (start + size) > max)
			continue;

		if (end - size > max)
			end = max;

		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 {
		status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &max_addr);
		if (status != EFI_SUCCESS) {
			max = max_addr;
			max_addr = 0;
			goto again;
		}

		*addr = max_addr;
	}

free_pool:
	efi_call_phys1(sys_table_arg->boottime->free_pool, map);

fail:
	return status;
}

/*
 * Allocate at the lowest possible address.
 */
static efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
			      unsigned long size, unsigned long align,
			      unsigned long *addr)
{
	unsigned long map_size, desc_size;
	efi_memory_desc_t *map;
	efi_status_t status;
	unsigned long nr_pages;
	int i;

	status = efi_get_memory_map(sys_table_arg, &map, &map_size, &desc_size,
				    NULL, NULL);
	if (status != EFI_SUCCESS)
		goto fail;

	/*
	 * Enforce minimum alignment that EFI requires when requesting
	 * a specific address.  We are doing page-based allocations,
	 * so we must be aligned to a page.
	 */
	if (align < EFI_PAGE_SIZE)
		align = EFI_PAGE_SIZE;

	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
	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;
		end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);

		/*
		 * 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;

		status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
					EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
					nr_pages, &start);
		if (status == EFI_SUCCESS) {
			*addr = start;
			break;
		}
	}

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

free_pool:
	efi_call_phys1(sys_table_arg->boottime->free_pool, map);
fail:
	return status;
}

static void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
		     unsigned long addr)
{
	unsigned long nr_pages;

	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
	efi_call_phys2(sys_table_arg->boottime->free_pages, addr, nr_pages);
}


/*
 * Check the cmdline for a LILO-style initrd= arguments.
 *
 * We only support loading an initrd from the same filesystem as the
 * kernel image.
 */
static efi_status_t handle_ramdisks(efi_system_table_t *sys_table_arg,
				    efi_loaded_image_t *image,
				    struct setup_header *hdr)
{
	struct initrd *initrds;
	unsigned long initrd_addr;
	efi_guid_t fs_proto = EFI_FILE_SYSTEM_GUID;
	u64 initrd_total;
	efi_file_io_interface_t *io;
	efi_file_handle_t *fh;
	efi_status_t status;
	int nr_initrds;
	char *str;
	int i, j, k;

	initrd_addr = 0;
	initrd_total = 0;

	str = (char *)(unsigned long)hdr->cmd_line_ptr;

	j = 0;			/* See close_handles */

	if (!str || !*str)
		return EFI_SUCCESS;

	for (nr_initrds = 0; *str; nr_initrds++) {
		str = strstr(str, "initrd=");
		if (!str)
			break;

		str += 7;

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

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

	if (!nr_initrds)
		return EFI_SUCCESS;

	status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
				EFI_LOADER_DATA,
				nr_initrds * sizeof(*initrds),
				&initrds);
	if (status != EFI_SUCCESS) {
		efi_printk(sys_table_arg, "Failed to alloc mem for initrds\n");
		goto fail;
	}

	str = (char *)(unsigned long)hdr->cmd_line_ptr;
	for (i = 0; i < nr_initrds; i++) {
		struct initrd *initrd;
		efi_file_handle_t *h;
		efi_file_info_t *info;
		efi_char16_t filename_16[256];
		unsigned long info_sz;
		efi_guid_t info_guid = EFI_FILE_INFO_ID;
		efi_char16_t *p;
		u64 file_sz;

		str = strstr(str, "initrd=");
		if (!str)
			break;

		str += 7;

		initrd = &initrds[i];
		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++ = '\\';
				*str++;
			} else {
				*p++ = *str++;
			}
		}

		*p = '\0';

		/* Only open the volume once. */
		if (!i) {
			efi_boot_services_t *boottime;

			boottime = sys_table_arg->boottime;

			status = efi_call_phys3(boottime->handle_protocol,
					image->device_handle, &fs_proto, &io);
			if (status != EFI_SUCCESS) {
				efi_printk(sys_table_arg, "Failed to handle fs_proto\n");
				goto free_initrds;
			}

			status = efi_call_phys2(io->open_volume, io, &fh);
			if (status != EFI_SUCCESS) {
				efi_printk(sys_table_arg, "Failed to open volume\n");
				goto free_initrds;
			}
		}

		status = efi_call_phys5(fh->open, fh, &h, filename_16,
					EFI_FILE_MODE_READ, (u64)0);
		if (status != EFI_SUCCESS) {
			efi_printk(sys_table_arg, "Failed to open initrd file: ");
			efi_char16_printk(sys_table_arg, filename_16);
			efi_printk(sys_table_arg, "\n");
			goto close_handles;
		}

		initrd->handle = h;

		info_sz = 0;
		status = efi_call_phys4(h->get_info, h, &info_guid,
					&info_sz, NULL);
		if (status != EFI_BUFFER_TOO_SMALL) {
			efi_printk(sys_table_arg, "Failed to get initrd info size\n");
			goto close_handles;
		}

grow:
		status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
					EFI_LOADER_DATA, info_sz, &info);
		if (status != EFI_SUCCESS) {
			efi_printk(sys_table_arg, "Failed to alloc mem for initrd info\n");
			goto close_handles;
		}

		status = efi_call_phys4(h->get_info, h, &info_guid,
					&info_sz, info);
		if (status == EFI_BUFFER_TOO_SMALL) {
			efi_call_phys1(sys_table_arg->boottime->free_pool,
				       info);
			goto grow;
		}

		file_sz = info->file_size;
		efi_call_phys1(sys_table_arg->boottime->free_pool, info);

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

		initrd->size = file_sz;
		initrd_total += file_sz;
	}

	if (initrd_total) {
		unsigned long addr;

		/*
		 * Multiple initrd's need to be at consecutive
		 * addresses in memory, so allocate enough memory for
		 * all the initrd's.
		 */
		status = efi_high_alloc(sys_table_arg, initrd_total, 0x1000,
				    &initrd_addr, hdr->initrd_addr_max);
		if (status != EFI_SUCCESS) {
			efi_printk(sys_table_arg, "Failed to alloc highmem for initrds\n");
			goto close_handles;
		}

		/* We've run out of free low memory. */
		if (initrd_addr > hdr->initrd_addr_max) {
			efi_printk(sys_table_arg, "We've run out of free low memory\n");
			status = EFI_INVALID_PARAMETER;
			goto free_initrd_total;
		}

		addr = initrd_addr;
		for (j = 0; j < nr_initrds; j++) {
			u64 size;

			size = initrds[j].size;
			while (size) {
				u64 chunksize;
				if (size > EFI_READ_CHUNK_SIZE)
					chunksize = EFI_READ_CHUNK_SIZE;
				else
					chunksize = size;
				status = efi_call_phys3(fh->read,
							initrds[j].handle,
							&chunksize, addr);
				if (status != EFI_SUCCESS) {
					efi_printk(sys_table_arg, "Failed to read initrd\n");
					goto free_initrd_total;
				}
				addr += chunksize;
				size -= chunksize;
			}

			efi_call_phys1(fh->close, initrds[j].handle);
		}

	}

	efi_call_phys1(sys_table_arg->boottime->free_pool, initrds);

	hdr->ramdisk_image = initrd_addr;
	hdr->ramdisk_size = initrd_total;

	return status;

free_initrd_total:
	efi_free(sys_table_arg, initrd_total, initrd_addr);

close_handles:
	for (k = j; k < i; k++)
		efi_call_phys1(fh->close, initrds[k].handle);
free_initrds:
	efi_call_phys1(sys_table_arg->boottime->free_pool, initrds);
fail:
	hdr->ramdisk_image = 0;
	hdr->ramdisk_size = 0;

	return status;
}
/*
 * 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.
 */
static 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)
{
	unsigned long cur_image_addr;
	unsigned long new_addr = 0;
	efi_status_t status;
	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;

	/*
	 * The EFI firmware loader could have placed the kernel image
	 * 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.
	 */
	nr_pages = round_up(alloc_size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
	status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
				EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
				nr_pages, &efi_addr);
	new_addr = efi_addr;
	/*
	 * If preferred address allocation failed allocate as low as
	 * possible.
	 */
	if (status != EFI_SUCCESS) {
		status = efi_low_alloc(sys_table_arg, alloc_size, alignment,
				       &new_addr);
	}
	if (status != EFI_SUCCESS) {
		efi_printk(sys_table_arg, "ERROR: Failed to allocate usable memory for kernel.\n");
		return status;
	}

	/*
	 * 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);
	/* Zero any extra space we may have allocated for BSS. */
	memset((void *)(new_addr + image_size), alloc_size - image_size, 0);

	/* Return the new address of the relocated image. */
	*image_addr = new_addr;

	return status;
}

/*
 * 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.
 */
static char *efi_convert_cmdline_to_ascii(efi_system_table_t *sys_table_arg,
				      efi_loaded_image_t *image,
				      int *cmd_line_len)
{
	u16 *s2;
	u8 *s1 = NULL;
	unsigned long cmdline_addr = 0;
	int load_options_size = image->load_options_size / 2; /* ASCII */
	void *options = image->load_options;
	int options_size = 0;
	efi_status_t status;
	int i;
	u16 zero = 0;

	if (options) {
		s2 = options;
		while (*s2 && *s2 != '\n' && options_size < load_options_size) {
			s2++;
			options_size++;
		}
	}

	if (options_size == 0) {
		/* No command line options, so return empty string*/
		options_size = 1;
		options = &zero;
	}

	options_size++;  /* NUL termination */
#ifdef CONFIG_ARM
	/*
	 * For ARM, allocate at a high address to avoid reserved
	 * regions at low addresses that we don't know the specfics of
	 * at the time we are processing the command line.
	 */
	status = efi_high_alloc(sys_table_arg, options_size, 0,
			    &cmdline_addr, 0xfffff000);
#else
	status = efi_low_alloc(sys_table_arg, options_size, 0,
			    &cmdline_addr);
#endif
	if (status != EFI_SUCCESS)
		return NULL;

	s1 = (u8 *)cmdline_addr;
	s2 = (u16 *)options;

	for (i = 0; i < options_size - 1; i++)
		*s1++ = *s2++;

	*s1 = '\0';

	*cmd_line_len = options_size;
	return (char *)cmdline_addr;
}
Commit	Line	Data
7721da4c RF	1	/*
	2	* Helper functions used by the EFI stub on multiple
	3	* architectures. This should be #included by the EFI stub
	4	* implementation files.
	5	*
	6	* Copyright 2011 Intel Corporation; author Matt Fleming
	7	*
	8	* This file is part of the Linux kernel, and is made available
	9	* under the terms of the GNU General Public License version 2.
	10	*
	11	*/
	12	#define EFI_READ_CHUNK_SIZE (1024 * 1024)
	13
	14	struct initrd {
	15	efi_file_handle_t *handle;
	16	u64 size;
	17	};
	18
	19
	20
	21
876dc36a RF	22	static void efi_char16_printk(efi_system_table_t *sys_table_arg,
876dc36a RF	23	efi_char16_t *str)
7721da4c RF	24	{
	25	struct efi_simple_text_output_protocol *out;
	26
876dc36a	27	out = (struct efi_simple_text_output_protocol *)sys_table_arg->con_out;
7721da4c RF	28	efi_call_phys2(out->output_string, out, str);
	29	}
	30
876dc36a	31	static void efi_printk(efi_system_table_t sys_table_arg, char str)
7721da4c RF	32	{
	33	char *s8;
	34
	35	for (s8 = str; *s8; s8++) {
	36	efi_char16_t ch[2] = { 0 };
	37
	38	ch[0] = *s8;
	39	if (*s8 == '\n') {
	40	efi_char16_t nl[2] = { '\r', 0 };
876dc36a	41	efi_char16_printk(sys_table_arg, nl);
7721da4c RF	42	}
7721da4c RF	43
876dc36a	44	efi_char16_printk(sys_table_arg, ch);
7721da4c RF	45	}
	46	}
	47
	48
86cc653b RF	49	static efi_status_t efi_get_memory_map(efi_system_table_t *sys_table_arg,
	50	efi_memory_desc_t **map,
	51	unsigned long *map_size,
1c089c65 RF	52	unsigned long *desc_size,
	53	u32 *desc_ver,
	54	unsigned long *key_ptr)
7721da4c RF	55	{
	56	efi_memory_desc_t *m = NULL;
	57	efi_status_t status;
	58	unsigned long key;
	59	u32 desc_version;
	60
	61	map_size = sizeof(m) * 32;
	62	again:
	63	/*
	64	* Add an additional efi_memory_desc_t because we're doing an
	65	* allocation which may be in a new descriptor region.
	66	*/
	67	map_size += sizeof(m);
876dc36a	68	status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
7721da4c RF	69	EFI_LOADER_DATA, map_size, (void *)&m);
	70	if (status != EFI_SUCCESS)
	71	goto fail;
	72
876dc36a RF	73	status = efi_call_phys5(sys_table_arg->boottime->get_memory_map,
876dc36a RF	74	map_size, m, &key, desc_size, &desc_version);
7721da4c	75	if (status == EFI_BUFFER_TOO_SMALL) {
876dc36a	76	efi_call_phys1(sys_table_arg->boottime->free_pool, m);
7721da4c RF	77	goto again;
	78	}
	79
	80	if (status != EFI_SUCCESS)
876dc36a	81	efi_call_phys1(sys_table_arg->boottime->free_pool, m);
1c089c65 RF	82	if (key_ptr && status == EFI_SUCCESS)
	83	*key_ptr = key;
	84	if (desc_ver && status == EFI_SUCCESS)
	85	*desc_ver = desc_version;
7721da4c RF	86
	87	fail:
	88	*map = m;
	89	return status;
	90	}
	91
	92	/*
	93	* Allocate at the highest possible address that is not above 'max'.
	94	*/
40e4530a	95	static efi_status_t efi_high_alloc(efi_system_table_t *sys_table_arg,
876dc36a RF	96	unsigned long size, unsigned long align,
876dc36a RF	97	unsigned long *addr, unsigned long max)
7721da4c RF	98	{
	99	unsigned long map_size, desc_size;
	100	efi_memory_desc_t *map;
	101	efi_status_t status;
	102	unsigned long nr_pages;
	103	u64 max_addr = 0;
	104	int i;
	105
1c089c65 RF	106	status = efi_get_memory_map(sys_table_arg, &map, &map_size, &desc_size,
1c089c65 RF	107	NULL, NULL);
7721da4c RF	108	if (status != EFI_SUCCESS)
	109	goto fail;
	110
38dd9c02 RF	111	/*
	112	* Enforce minimum alignment that EFI requires when requesting
	113	* a specific address. We are doing page-based allocations,
	114	* so we must be aligned to a page.
	115	*/
	116	if (align < EFI_PAGE_SIZE)
	117	align = EFI_PAGE_SIZE;
	118
7721da4c RF	119	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
	120	again:
	121	for (i = 0; i < map_size / desc_size; i++) {
	122	efi_memory_desc_t *desc;
	123	unsigned long m = (unsigned long)map;
	124	u64 start, end;
	125
	126	desc = (efi_memory_desc_t )(m + (i desc_size));
	127	if (desc->type != EFI_CONVENTIONAL_MEMORY)
	128	continue;
	129
	130	if (desc->num_pages < nr_pages)
	131	continue;
	132
	133	start = desc->phys_addr;
	134	end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);
	135
	136	if ((start + size) > end \|\| (start + size) > max)
	137	continue;
	138
	139	if (end - size > max)
	140	end = max;
	141
	142	if (round_down(end - size, align) < start)
	143	continue;
	144
	145	start = round_down(end - size, align);
	146
	147	/*
	148	* Don't allocate at 0x0. It will confuse code that
	149	* checks pointers against NULL.
	150	*/
	151	if (start == 0x0)
	152	continue;
	153
	154	if (start > max_addr)
	155	max_addr = start;
	156	}
	157
	158	if (!max_addr)
	159	status = EFI_NOT_FOUND;
	160	else {
876dc36a	161	status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
7721da4c RF	162	EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
	163	nr_pages, &max_addr);
	164	if (status != EFI_SUCCESS) {
	165	max = max_addr;
	166	max_addr = 0;
	167	goto again;
	168	}
	169
	170	*addr = max_addr;
	171	}
	172
	173	free_pool:
876dc36a	174	efi_call_phys1(sys_table_arg->boottime->free_pool, map);
7721da4c RF	175
	176	fail:
	177	return status;
	178	}
	179
	180	/*
	181	* Allocate at the lowest possible address.
	182	*/
40e4530a RF	183	static efi_status_t efi_low_alloc(efi_system_table_t *sys_table_arg,
40e4530a RF	184	unsigned long size, unsigned long align,
7721da4c RF	185	unsigned long *addr)
	186	{
	187	unsigned long map_size, desc_size;
	188	efi_memory_desc_t *map;
	189	efi_status_t status;
	190	unsigned long nr_pages;
	191	int i;
	192
1c089c65 RF	193	status = efi_get_memory_map(sys_table_arg, &map, &map_size, &desc_size,
1c089c65 RF	194	NULL, NULL);
7721da4c RF	195	if (status != EFI_SUCCESS)
	196	goto fail;
	197
38dd9c02 RF	198	/*
	199	* Enforce minimum alignment that EFI requires when requesting
	200	* a specific address. We are doing page-based allocations,
	201	* so we must be aligned to a page.
	202	*/
	203	if (align < EFI_PAGE_SIZE)
	204	align = EFI_PAGE_SIZE;
	205
7721da4c RF	206	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
	207	for (i = 0; i < map_size / desc_size; i++) {
	208	efi_memory_desc_t *desc;
	209	unsigned long m = (unsigned long)map;
	210	u64 start, end;
	211
	212	desc = (efi_memory_desc_t )(m + (i desc_size));
	213
	214	if (desc->type != EFI_CONVENTIONAL_MEMORY)
	215	continue;
	216
	217	if (desc->num_pages < nr_pages)
	218	continue;
	219
	220	start = desc->phys_addr;
	221	end = start + desc->num_pages * (1UL << EFI_PAGE_SHIFT);
	222
	223	/*
	224	* Don't allocate at 0x0. It will confuse code that
	225	* checks pointers against NULL. Skip the first 8
	226	* bytes so we start at a nice even number.
	227	*/
	228	if (start == 0x0)
	229	start += 8;
	230
	231	start = round_up(start, align);
	232	if ((start + size) > end)
	233	continue;
	234
876dc36a	235	status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
7721da4c RF	236	EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
	237	nr_pages, &start);
	238	if (status == EFI_SUCCESS) {
	239	*addr = start;
	240	break;
	241	}
	242	}
	243
	244	if (i == map_size / desc_size)
	245	status = EFI_NOT_FOUND;
	246
	247	free_pool:
876dc36a	248	efi_call_phys1(sys_table_arg->boottime->free_pool, map);
7721da4c RF	249	fail:
	250	return status;
	251	}
	252
40e4530a	253	static void efi_free(efi_system_table_t *sys_table_arg, unsigned long size,
876dc36a	254	unsigned long addr)
7721da4c RF	255	{
	256	unsigned long nr_pages;
	257
	258	nr_pages = round_up(size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
876dc36a	259	efi_call_phys2(sys_table_arg->boottime->free_pages, addr, nr_pages);
7721da4c RF	260	}
	261
	262
	263	/*
	264	* Check the cmdline for a LILO-style initrd= arguments.
	265	*
	266	* We only support loading an initrd from the same filesystem as the
	267	* kernel image.
	268	*/
876dc36a RF	269	static efi_status_t handle_ramdisks(efi_system_table_t *sys_table_arg,
876dc36a RF	270	efi_loaded_image_t *image,
7721da4c RF	271	struct setup_header *hdr)
	272	{
	273	struct initrd *initrds;
	274	unsigned long initrd_addr;
	275	efi_guid_t fs_proto = EFI_FILE_SYSTEM_GUID;
	276	u64 initrd_total;
	277	efi_file_io_interface_t *io;
	278	efi_file_handle_t *fh;
	279	efi_status_t status;
	280	int nr_initrds;
	281	char *str;
	282	int i, j, k;
	283
	284	initrd_addr = 0;
	285	initrd_total = 0;
	286
	287	str = (char *)(unsigned long)hdr->cmd_line_ptr;
	288
	289	j = 0; /* See close_handles */
	290
	291	if (!str \|\| !*str)
	292	return EFI_SUCCESS;
	293
	294	for (nr_initrds = 0; *str; nr_initrds++) {
	295	str = strstr(str, "initrd=");
	296	if (!str)
	297	break;
	298
	299	str += 7;
	300
	301	/* Skip any leading slashes */
	302	while (str == '/' \|\| str == '\\')
	303	str++;
	304
	305	while (str && str != ' ' && *str != '\n')
	306	str++;
	307	}
	308
	309	if (!nr_initrds)
	310	return EFI_SUCCESS;
	311
876dc36a	312	status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
7721da4c RF	313	EFI_LOADER_DATA,
	314	nr_initrds * sizeof(*initrds),
	315	&initrds);
	316	if (status != EFI_SUCCESS) {
876dc36a	317	efi_printk(sys_table_arg, "Failed to alloc mem for initrds\n");
7721da4c RF	318	goto fail;
	319	}
	320
	321	str = (char *)(unsigned long)hdr->cmd_line_ptr;
	322	for (i = 0; i < nr_initrds; i++) {
	323	struct initrd *initrd;
	324	efi_file_handle_t *h;
	325	efi_file_info_t *info;
	326	efi_char16_t filename_16[256];
	327	unsigned long info_sz;
	328	efi_guid_t info_guid = EFI_FILE_INFO_ID;
	329	efi_char16_t *p;
	330	u64 file_sz;
	331
	332	str = strstr(str, "initrd=");
	333	if (!str)
	334	break;
	335
	336	str += 7;
	337
	338	initrd = &initrds[i];
	339	p = filename_16;
	340
	341	/* Skip any leading slashes */
	342	while (str == '/' \|\| str == '\\')
	343	str++;
	344
	345	while (str && str != ' ' && *str != '\n') {
	346	if ((u8 )p >= (u8 )filename_16 + sizeof(filename_16))
	347	break;
	348
	349	if (*str == '/') {
	350	*p++ = '\\';
	351	*str++;
	352	} else {
	353	p++ = str++;
	354	}
	355	}
	356
	357	*p = '\0';
	358
	359	/* Only open the volume once. */
	360	if (!i) {
	361	efi_boot_services_t *boottime;
	362
876dc36a	363	boottime = sys_table_arg->boottime;
7721da4c RF	364
	365	status = efi_call_phys3(boottime->handle_protocol,
	366	image->device_handle, &fs_proto, &io);
	367	if (status != EFI_SUCCESS) {
876dc36a	368	efi_printk(sys_table_arg, "Failed to handle fs_proto\n");
7721da4c RF	369	goto free_initrds;
	370	}
	371
	372	status = efi_call_phys2(io->open_volume, io, &fh);
	373	if (status != EFI_SUCCESS) {
876dc36a	374	efi_printk(sys_table_arg, "Failed to open volume\n");
7721da4c RF	375	goto free_initrds;
	376	}
	377	}
	378
	379	status = efi_call_phys5(fh->open, fh, &h, filename_16,
	380	EFI_FILE_MODE_READ, (u64)0);
	381	if (status != EFI_SUCCESS) {
876dc36a RF	382	efi_printk(sys_table_arg, "Failed to open initrd file: ");
	383	efi_char16_printk(sys_table_arg, filename_16);
	384	efi_printk(sys_table_arg, "\n");
7721da4c RF	385	goto close_handles;
	386	}
	387
	388	initrd->handle = h;
	389
	390	info_sz = 0;
	391	status = efi_call_phys4(h->get_info, h, &info_guid,
	392	&info_sz, NULL);
	393	if (status != EFI_BUFFER_TOO_SMALL) {
876dc36a	394	efi_printk(sys_table_arg, "Failed to get initrd info size\n");
7721da4c RF	395	goto close_handles;
	396	}
	397
	398	grow:
876dc36a	399	status = efi_call_phys3(sys_table_arg->boottime->allocate_pool,
7721da4c RF	400	EFI_LOADER_DATA, info_sz, &info);
7721da4c RF	401	if (status != EFI_SUCCESS) {
876dc36a	402	efi_printk(sys_table_arg, "Failed to alloc mem for initrd info\n");
7721da4c RF	403	goto close_handles;
	404	}
	405
	406	status = efi_call_phys4(h->get_info, h, &info_guid,
	407	&info_sz, info);
	408	if (status == EFI_BUFFER_TOO_SMALL) {
876dc36a RF	409	efi_call_phys1(sys_table_arg->boottime->free_pool,
876dc36a RF	410	info);
7721da4c RF	411	goto grow;
	412	}
	413
	414	file_sz = info->file_size;
876dc36a	415	efi_call_phys1(sys_table_arg->boottime->free_pool, info);
7721da4c RF	416
7721da4c RF	417	if (status != EFI_SUCCESS) {
876dc36a	418	efi_printk(sys_table_arg, "Failed to get initrd info\n");
7721da4c RF	419	goto close_handles;
	420	}
	421
	422	initrd->size = file_sz;
	423	initrd_total += file_sz;
	424	}
	425
	426	if (initrd_total) {
	427	unsigned long addr;
	428
	429	/*
	430	* Multiple initrd's need to be at consecutive
	431	* addresses in memory, so allocate enough memory for
	432	* all the initrd's.
	433	*/
40e4530a RF	434	status = efi_high_alloc(sys_table_arg, initrd_total, 0x1000,
40e4530a RF	435	&initrd_addr, hdr->initrd_addr_max);
7721da4c	436	if (status != EFI_SUCCESS) {
876dc36a	437	efi_printk(sys_table_arg, "Failed to alloc highmem for initrds\n");
7721da4c RF	438	goto close_handles;
	439	}
	440
	441	/* We've run out of free low memory. */
	442	if (initrd_addr > hdr->initrd_addr_max) {
876dc36a	443	efi_printk(sys_table_arg, "We've run out of free low memory\n");
7721da4c RF	444	status = EFI_INVALID_PARAMETER;
	445	goto free_initrd_total;
	446	}
	447
	448	addr = initrd_addr;
	449	for (j = 0; j < nr_initrds; j++) {
	450	u64 size;
	451
	452	size = initrds[j].size;
	453	while (size) {
	454	u64 chunksize;
	455	if (size > EFI_READ_CHUNK_SIZE)
	456	chunksize = EFI_READ_CHUNK_SIZE;
	457	else
	458	chunksize = size;
	459	status = efi_call_phys3(fh->read,
	460	initrds[j].handle,
	461	&chunksize, addr);
	462	if (status != EFI_SUCCESS) {
876dc36a	463	efi_printk(sys_table_arg, "Failed to read initrd\n");
7721da4c RF	464	goto free_initrd_total;
	465	}
	466	addr += chunksize;
	467	size -= chunksize;
	468	}
	469
	470	efi_call_phys1(fh->close, initrds[j].handle);
	471	}
	472
	473	}
	474
876dc36a	475	efi_call_phys1(sys_table_arg->boottime->free_pool, initrds);
7721da4c RF	476
	477	hdr->ramdisk_image = initrd_addr;
	478	hdr->ramdisk_size = initrd_total;
	479
	480	return status;
	481
	482	free_initrd_total:
40e4530a	483	efi_free(sys_table_arg, initrd_total, initrd_addr);
7721da4c RF	484
	485	close_handles:
	486	for (k = j; k < i; k++)
	487	efi_call_phys1(fh->close, initrds[k].handle);
	488	free_initrds:
876dc36a	489	efi_call_phys1(sys_table_arg->boottime->free_pool, initrds);
7721da4c RF	490	fail:
	491	hdr->ramdisk_image = 0;
	492	hdr->ramdisk_size = 0;
	493
	494	return status;
	495	}
4a9f3a7c RF	496	/*
	497	* Relocate a kernel image, either compressed or uncompressed.
	498	* In the ARM64 case, all kernel images are currently
	499	* uncompressed, and as such when we relocate it we need to
	500	* allocate additional space for the BSS segment. Any low
	501	* memory that this function should avoid needs to be
	502	* unavailable in the EFI memory map, as if the preferred
	503	* address is not available the lowest available address will
	504	* be used.
	505	*/
	506	static efi_status_t efi_relocate_kernel(efi_system_table_t *sys_table_arg,
	507	unsigned long *image_addr,
	508	unsigned long image_size,
	509	unsigned long alloc_size,
	510	unsigned long preferred_addr,
	511	unsigned long alignment)
c6866d72	512	{
4a9f3a7c RF	513	unsigned long cur_image_addr;
4a9f3a7c RF	514	unsigned long new_addr = 0;
c6866d72	515	efi_status_t status;
4a9f3a7c RF	516	unsigned long nr_pages;
	517	efi_physical_addr_t efi_addr = preferred_addr;
	518
	519	if (!image_addr \|\| !image_size \|\| !alloc_size)
	520	return EFI_INVALID_PARAMETER;
	521	if (alloc_size < image_size)
	522	return EFI_INVALID_PARAMETER;
	523
	524	cur_image_addr = *image_addr;
c6866d72 RF	525
	526	/*
	527	* The EFI firmware loader could have placed the kernel image
4a9f3a7c RF	528	* anywhere in memory, but the kernel has restrictions on the
	529	* max physical address it can run at. Some architectures
	530	* also have a prefered address, so first try to relocate
	531	* to the preferred address. If that fails, allocate as low
	532	* as possible while respecting the required alignment.
c6866d72	533	*/
4a9f3a7c RF	534	nr_pages = round_up(alloc_size, EFI_PAGE_SIZE) / EFI_PAGE_SIZE;
4a9f3a7c RF	535	status = efi_call_phys4(sys_table_arg->boottime->allocate_pages,
c6866d72	536	EFI_ALLOCATE_ADDRESS, EFI_LOADER_DATA,
4a9f3a7c RF	537	nr_pages, &efi_addr);
	538	new_addr = efi_addr;
	539	/*
	540	* If preferred address allocation failed allocate as low as
	541	* possible.
	542	*/
c6866d72	543	if (status != EFI_SUCCESS) {
4a9f3a7c RF	544	status = efi_low_alloc(sys_table_arg, alloc_size, alignment,
	545	&new_addr);
	546	}
	547	if (status != EFI_SUCCESS) {
	548	efi_printk(sys_table_arg, "ERROR: Failed to allocate usable memory for kernel.\n");
	549	return status;
c6866d72 RF	550	}
c6866d72 RF	551
4a9f3a7c RF	552	/*
	553	* We know source/dest won't overlap since both memory ranges
	554	* have been allocated by UEFI, so we can safely use memcpy.
	555	*/
	556	memcpy((void )new_addr, (void )cur_image_addr, image_size);
	557	/* Zero any extra space we may have allocated for BSS. */
	558	memset((void *)(new_addr + image_size), alloc_size - image_size, 0);
c6866d72	559
4a9f3a7c RF	560	/* Return the new address of the relocated image. */
4a9f3a7c RF	561	*image_addr = new_addr;
c6866d72 RF	562
	563	return status;
	564	}
5fef3870 RF	565
	566	/*
	567	* Convert the unicode UEFI command line to ASCII to pass to kernel.
	568	* Size of memory allocated return in *cmd_line_len.
	569	* Returns NULL on error.
	570	*/
	571	static char efi_convert_cmdline_to_ascii(efi_system_table_t sys_table_arg,
	572	efi_loaded_image_t *image,
	573	int *cmd_line_len)
	574	{
	575	u16 *s2;
	576	u8 *s1 = NULL;
	577	unsigned long cmdline_addr = 0;
	578	int load_options_size = image->load_options_size / 2; /* ASCII */
	579	void *options = image->load_options;
	580	int options_size = 0;
	581	efi_status_t status;
	582	int i;
	583	u16 zero = 0;
	584
	585	if (options) {
	586	s2 = options;
	587	while (s2 && s2 != '\n' && options_size < load_options_size) {
	588	s2++;
	589	options_size++;
	590	}
	591	}
	592
	593	if (options_size == 0) {
	594	/* No command line options, so return empty string*/
	595	options_size = 1;
	596	options = &zero;
	597	}
	598
	599	options_size++; /* NUL termination */
	600	#ifdef CONFIG_ARM
	601	/*
	602	* For ARM, allocate at a high address to avoid reserved
	603	* regions at low addresses that we don't know the specfics of
	604	* at the time we are processing the command line.
	605	*/
	606	status = efi_high_alloc(sys_table_arg, options_size, 0,
	607	&cmdline_addr, 0xfffff000);
	608	#else
	609	status = efi_low_alloc(sys_table_arg, options_size, 0,
	610	&cmdline_addr);
	611	#endif
	612	if (status != EFI_SUCCESS)
	613	return NULL;
	614
	615	s1 = (u8 *)cmdline_addr;
	616	s2 = (u16 *)options;
	617
	618	for (i = 0; i < options_size - 1; i++)
	619	s1++ = s2++;
	620
	621	*s1 = '\0';
	622
	623	*cmd_line_len = options_size;
	624	return (char *)cmdline_addr;
	625	}