[people/ms/u-boot.git] / common / spl / spl_fit.c

/*
 * Copyright (C) 2016 Google, Inc
 * Written by Simon Glass <sjg@chromium.org>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <errno.h>
#include <image.h>
#include <libfdt.h>
#include <spl.h>

#ifndef CONFIG_SYS_BOOTM_LEN
#define CONFIG_SYS_BOOTM_LEN	(64 << 20)
#endif

/**
 * spl_fit_get_image_name(): By using the matching configuration subnode,
 * retrieve the name of an image, specified by a property name and an index
 * into that.
 * @fit:	Pointer to the FDT blob.
 * @images:	Offset of the /images subnode.
 * @type:	Name of the property within the configuration subnode.
 * @index:	Index into the list of strings in this property.
 * @outname:	Name of the image
 *
 * Return:	0 on success, or a negative error number
 */
static int spl_fit_get_image_name(const void *fit, int images,
				  const char *type, int index,
				  char **outname)
{
	const char *name, *str;
	__maybe_unused int node;
	int conf_node;
	int len, i;

	conf_node = fit_find_config_node(fit);
	if (conf_node < 0) {
#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
		printf("No matching DT out of these options:\n");
		for (node = fdt_first_subnode(fit, conf_node);
		     node >= 0;
		     node = fdt_next_subnode(fit, node)) {
			name = fdt_getprop(fit, node, "description", &len);
			printf("   %s\n", name);
		}
#endif
		return conf_node;
	}

	name = fdt_getprop(fit, conf_node, type, &len);
	if (!name) {
		debug("cannot find property '%s': %d\n", type, len);
		return -EINVAL;
	}

	str = name;
	for (i = 0; i < index; i++) {
		str = strchr(str, '\0') + 1;
		if (!str || (str - name >= len)) {
			debug("no string for index %d\n", index);
			return -E2BIG;
		}
	}

	*outname = (char *)str;
	return 0;
}

/**
 * spl_fit_get_image_node(): By using the matching configuration subnode,
 * retrieve the name of an image, specified by a property name and an index
 * into that.
 * @fit:	Pointer to the FDT blob.
 * @images:	Offset of the /images subnode.
 * @type:	Name of the property within the configuration subnode.
 * @index:	Index into the list of strings in this property.
 *
 * Return:	the node offset of the respective image node or a negative
 *		error number.
 */
static int spl_fit_get_image_node(const void *fit, int images,
				  const char *type, int index)
{
	char *str;
	int err;
	int node;

	err = spl_fit_get_image_name(fit, images, type, index, &str);
	if (err)
		return err;

	debug("%s: '%s'\n", type, str);

	node = fdt_subnode_offset(fit, images, str);
	if (node < 0) {
		debug("cannot find image node '%s': %d\n", str, node);
		return -EINVAL;
	}

	return node;
}

static int get_aligned_image_offset(struct spl_load_info *info, int offset)
{
	/*
	 * If it is a FS read, get the first address before offset which is
	 * aligned to ARCH_DMA_MINALIGN. If it is raw read return the
	 * block number to which offset belongs.
	 */
	if (info->filename)
		return offset & ~(ARCH_DMA_MINALIGN - 1);

	return offset / info->bl_len;
}

static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
{
	/*
	 * If it is a FS read, get the difference between the offset and
	 * the first address before offset which is aligned to
	 * ARCH_DMA_MINALIGN. If it is raw read return the offset within the
	 * block.
	 */
	if (info->filename)
		return offset & (ARCH_DMA_MINALIGN - 1);

	return offset % info->bl_len;
}

static int get_aligned_image_size(struct spl_load_info *info, int data_size,
				  int offset)
{
	data_size = data_size + get_aligned_image_overhead(info, offset);

	if (info->filename)
		return data_size;

	return (data_size + info->bl_len - 1) / info->bl_len;
}

/**
 * spl_load_fit_image(): load the image described in a certain FIT node
 * @info:	points to information about the device to load data from
 * @sector:	the start sector of the FIT image on the device
 * @fit:	points to the flattened device tree blob describing the FIT
 *		image
 * @base_offset: the beginning of the data area containing the actual
 *		image data, relative to the beginning of the FIT
 * @node:	offset of the DT node describing the image to load (relative
 *		to @fit)
 * @image_info:	will be filled with information about the loaded image
 *		If the FIT node does not contain a "load" (address) property,
 *		the image gets loaded to the address pointed to by the
 *		load_addr member in this struct.
 *
 * Return:	0 on success or a negative error number.
 */
static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
			      void *fit, ulong base_offset, int node,
			      struct spl_image_info *image_info)
{
	int offset;
	size_t length;
	int len;
	ulong size;
	ulong load_addr, load_ptr;
	void *src;
	ulong overhead;
	int nr_sectors;
	int align_len = ARCH_DMA_MINALIGN - 1;
	uint8_t image_comp = -1, type = -1;
	const void *data;
	bool external_data = false;

	if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
		if (fit_image_get_comp(fit, node, &image_comp))
			puts("Cannot get image compression format.\n");
		else
			debug("%s ", genimg_get_comp_name(image_comp));

		if (fit_image_get_type(fit, node, &type))
			puts("Cannot get image type.\n");
		else
			debug("%s ", genimg_get_type_name(type));
	}

	if (fit_image_get_load(fit, node, &load_addr))
		load_addr = image_info->load_addr;

	if (!fit_image_get_data_position(fit, node, &offset)) {
		external_data = true;
	} else if (!fit_image_get_data_offset(fit, node, &offset)) {
		offset += base_offset;
		external_data = true;
	}

	if (external_data) {
		/* External data */
		if (fit_image_get_data_size(fit, node, &len))
			return -ENOENT;

		load_ptr = (load_addr + align_len) & ~align_len;
		length = len;

		overhead = get_aligned_image_overhead(info, offset);
		nr_sectors = get_aligned_image_size(info, length, offset);

		if (info->read(info,
			       sector + get_aligned_image_offset(info, offset),
			       nr_sectors, (void *)load_ptr) != nr_sectors)
			return -EIO;

		debug("External data: dst=%lx, offset=%x, size=%lx\n",
		      load_ptr, offset, (unsigned long)length);
		src = (void *)load_ptr + overhead;
	} else {
		/* Embedded data */
		if (fit_image_get_data(fit, node, &data, &length)) {
			puts("Cannot get image data/size\n");
			return -ENOENT;
		}
		debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
		      (unsigned long)length);
		src = (void *)data;
	}

#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
	board_fit_image_post_process(&src, &length);
#endif

	if (IS_ENABLED(CONFIG_SPL_OS_BOOT)	&&
	    IS_ENABLED(CONFIG_SPL_GZIP)		&&
	    image_comp == IH_COMP_GZIP		&&
	    type == IH_TYPE_KERNEL) {
		size = length;
		if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
			   src, &size)) {
			puts("Uncompressing error\n");
			return -EIO;
		}
		length = size;
	} else {
		memcpy((void *)load_addr, src, length);
	}

	if (image_info) {
		image_info->load_addr = load_addr;
		image_info->size = length;
		image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
	}

	return 0;
}

static int spl_fit_append_fdt(struct spl_image_info *spl_image,
			      struct spl_load_info *info, ulong sector,
			      void *fit, int images, ulong base_offset)
{
	struct spl_image_info image_info;
	int node, ret;

	/* Figure out which device tree the board wants to use */
	node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
	if (node < 0) {
		debug("%s: cannot find FDT node\n", __func__);
		return node;
	}

	/*
	 * Read the device tree and place it after the image.
	 * Align the destination address to ARCH_DMA_MINALIGN.
	 */
	image_info.load_addr = spl_image->load_addr + spl_image->size;
	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
				 &image_info);

	if (ret < 0)
		return ret;

	/* Make the load-address of the FDT available for the SPL framework */
	spl_image->fdt_addr = (void *)image_info.load_addr;
#if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
	/* Try to make space, so we can inject details on the loadables */
	ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
#endif

	return ret;
}

static int spl_fit_record_loadable(const void *fit, int images, int index,
				   void *blob, struct spl_image_info *image)
{
	int ret = 0;
#if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
	char *name;
	int node;

	ret = spl_fit_get_image_name(fit, images, "loadables",
				     index, &name);
	if (ret < 0)
		return ret;

	node = spl_fit_get_image_node(fit, images, "loadables", index);

	ret = fdt_record_loadable(blob, index, name, image->load_addr,
				  image->size, image->entry_point,
				  fdt_getprop(fit, node, "type", NULL),
				  fdt_getprop(fit, node, "os", NULL));
#endif
	return ret;
}

static int spl_fit_image_get_os(const void *fit, int noffset, uint8_t *os)
{
#if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
	return -ENOTSUPP;
#else
	return fit_image_get_os(fit, noffset, os);
#endif
}

int spl_load_simple_fit(struct spl_image_info *spl_image,
			struct spl_load_info *info, ulong sector, void *fit)
{
	int sectors;
	ulong size;
	unsigned long count;
	struct spl_image_info image_info;
	int node = -1;
	int images, ret;
	int base_offset, align_len = ARCH_DMA_MINALIGN - 1;
	int index = 0;

	/*
	 * For FIT with external data, figure out where the external images
	 * start. This is the base for the data-offset properties in each
	 * image.
	 */
	size = fdt_totalsize(fit);
	size = (size + 3) & ~3;
	base_offset = (size + 3) & ~3;

	/*
	 * So far we only have one block of data from the FIT. Read the entire
	 * thing, including that first block, placing it so it finishes before
	 * where we will load the image.
	 *
	 * Note that we will load the image such that its first byte will be
	 * at the load address. Since that byte may be part-way through a
	 * block, we may load the image up to one block before the load
	 * address. So take account of that here by subtracting an addition
	 * block length from the FIT start position.
	 *
	 * In fact the FIT has its own load address, but we assume it cannot
	 * be before CONFIG_SYS_TEXT_BASE.
	 *
	 * For FIT with data embedded, data is loaded as part of FIT image.
	 * For FIT with external data, data is not loaded in this step.
	 */
	fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len -
			align_len) & ~align_len);
	sectors = get_aligned_image_size(info, size, 0);
	count = info->read(info, sector, sectors, fit);
	debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n",
	      sector, sectors, fit, count);
	if (count == 0)
		return -EIO;

	/* find the node holding the images information */
	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
	if (images < 0) {
		debug("%s: Cannot find /images node: %d\n", __func__, images);
		return -1;
	}

	/*
	 * Find the U-Boot image using the following search order:
	 *   - start at 'firmware' (e.g. an ARM Trusted Firmware)
	 *   - fall back 'kernel' (e.g. a Falcon-mode OS boot
	 *   - fall back to using the first 'loadables' entry
	 */
	if (node < 0)
		node = spl_fit_get_image_node(fit, images, "firmware", 0);
#ifdef CONFIG_SPL_OS_BOOT
	if (node < 0)
		node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
#endif
	if (node < 0) {
		debug("could not find firmware image, trying loadables...\n");
		node = spl_fit_get_image_node(fit, images, "loadables", 0);
		/*
		 * If we pick the U-Boot image from "loadables", start at
		 * the second image when later loading additional images.
		 */
		index = 1;
	}
	if (node < 0) {
		debug("%s: Cannot find u-boot image node: %d\n",
		      __func__, node);
		return -1;
	}

	/* Load the image and set up the spl_image structure */
	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
				 spl_image);
	if (ret)
		return ret;

	/*
	 * For backward compatibility, we treat the first node that is
	 * as a U-Boot image, if no OS-type has been declared.
	 */
	if (!spl_fit_image_get_os(fit, node, &spl_image->os))
		debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
#if !defined(CONFIG_SPL_OS_BOOT)
	else
		spl_image->os = IH_OS_U_BOOT;
#endif

	/*
	 * Booting a next-stage U-Boot may require us to append the FDT.
	 * We allow this to fail, as the U-Boot image might embed its FDT.
	 */
	if (spl_image->os == IH_OS_U_BOOT)
		spl_fit_append_fdt(spl_image, info, sector, fit,
				   images, base_offset);

	/* Now check if there are more images for us to load */
	for (; ; index++) {
		uint8_t os_type = IH_OS_INVALID;

		node = spl_fit_get_image_node(fit, images, "loadables", index);
		if (node < 0)
			break;

		ret = spl_load_fit_image(info, sector, fit, base_offset, node,
					 &image_info);
		if (ret < 0)
			continue;

		if (!spl_fit_image_get_os(fit, node, &os_type))
			debug("Loadable is %s\n", genimg_get_os_name(os_type));

		if (os_type == IH_OS_U_BOOT) {
			spl_fit_append_fdt(&image_info, info, sector,
					   fit, images, base_offset);
			spl_image->fdt_addr = image_info.fdt_addr;
		}

		/*
		 * If the "firmware" image did not provide an entry point,
		 * use the first valid entry point from the loadables.
		 */
		if (spl_image->entry_point == FDT_ERROR &&
		    image_info.entry_point != FDT_ERROR)
			spl_image->entry_point = image_info.entry_point;

		/* Record our loadables into the FDT */
		if (spl_image->fdt_addr)
			spl_fit_record_loadable(fit, images, index,
						spl_image->fdt_addr,
						&image_info);
	}

	/*
	 * If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
	 * Makefile will set it to 0 and it will end up as the entry point
	 * here. What it actually means is: use the load address.
	 */
	if (spl_image->entry_point == FDT_ERROR || spl_image->entry_point == 0)
		spl_image->entry_point = spl_image->load_addr;

	return 0;
}
Commit	Line	Data
f1dcee59 SG	1	/*
	2	* Copyright (C) 2016 Google, Inc
	3	* Written by Simon Glass <sjg@chromium.org>
	4	*
a616c783	5	* SPDX-License-Identifier: GPL-2.0+
f1dcee59 SG	6	*/
	7
	8	#include <common.h>
	9	#include <errno.h>
	10	#include <image.h>
	11	#include <libfdt.h>
	12	#include <spl.h>
	13
7264f292 YS	14	#ifndef CONFIG_SYS_BOOTM_LEN
	15	#define CONFIG_SYS_BOOTM_LEN (64 << 20)
	16	#endif
	17
736806fb	18	/**
a616c783	19	* spl_fit_get_image_name(): By using the matching configuration subnode,
736806fb AP	20	* retrieve the name of an image, specified by a property name and an index
	21	* into that.
	22	* @fit: Pointer to the FDT blob.
	23	* @images: Offset of the /images subnode.
	24	* @type: Name of the property within the configuration subnode.
	25	* @index: Index into the list of strings in this property.
a616c783	26	* @outname: Name of the image
736806fb	27	*
a616c783	28	* Return: 0 on success, or a negative error number
736806fb	29	*/
a616c783 PT	30	static int spl_fit_get_image_name(const void *fit, int images,
	31	const char *type, int index,
	32	char **outname)
4b9340ab AP	33	{
4b9340ab AP	34	const char name, str;
a616c783 PT	35	__maybe_unused int node;
a616c783 PT	36	int conf_node;
4b9340ab AP	37	int len, i;
4b9340ab AP	38
3863f840	39	conf_node = fit_find_config_node(fit);
4b9340ab AP	40	if (conf_node < 0) {
	41	#ifdef CONFIG_SPL_LIBCOMMON_SUPPORT
	42	printf("No matching DT out of these options:\n");
	43	for (node = fdt_first_subnode(fit, conf_node);
	44	node >= 0;
	45	node = fdt_next_subnode(fit, node)) {
	46	name = fdt_getprop(fit, node, "description", &len);
	47	printf(" %s\n", name);
f1dcee59	48	}
4b9340ab AP	49	#endif
	50	return conf_node;
	51	}
f1dcee59	52
4b9340ab AP	53	name = fdt_getprop(fit, conf_node, type, &len);
	54	if (!name) {
	55	debug("cannot find property '%s': %d\n", type, len);
	56	return -EINVAL;
	57	}
f1dcee59	58
4b9340ab AP	59	str = name;
	60	for (i = 0; i < index; i++) {
	61	str = strchr(str, '\0') + 1;
	62	if (!str \|\| (str - name >= len)) {
	63	debug("no string for index %d\n", index);
	64	return -E2BIG;
	65	}
f1dcee59 SG	66	}
f1dcee59 SG	67
a616c783 PT	68	outname = (char )str;
	69	return 0;
	70	}
	71
	72	/**
	73	* spl_fit_get_image_node(): By using the matching configuration subnode,
	74	* retrieve the name of an image, specified by a property name and an index
	75	* into that.
	76	* @fit: Pointer to the FDT blob.
	77	* @images: Offset of the /images subnode.
	78	* @type: Name of the property within the configuration subnode.
	79	* @index: Index into the list of strings in this property.
	80	*
	81	* Return: the node offset of the respective image node or a negative
	82	* error number.
	83	*/
	84	static int spl_fit_get_image_node(const void *fit, int images,
	85	const char *type, int index)
	86	{
	87	char *str;
	88	int err;
	89	int node;
	90
	91	err = spl_fit_get_image_name(fit, images, type, index, &str);
	92	if (err)
	93	return err;
	94
4b9340ab	95	debug("%s: '%s'\n", type, str);
a616c783	96
4b9340ab AP	97	node = fdt_subnode_offset(fit, images, str);
	98	if (node < 0) {
	99	debug("cannot find image node '%s': %d\n", str, node);
	100	return -EINVAL;
f1dcee59	101	}
f1dcee59	102
736806fb	103	return node;
f1dcee59 SG	104	}
f1dcee59 SG	105
eafd5410 LV	106	static int get_aligned_image_offset(struct spl_load_info *info, int offset)
	107	{
	108	/*
	109	* If it is a FS read, get the first address before offset which is
	110	* aligned to ARCH_DMA_MINALIGN. If it is raw read return the
	111	* block number to which offset belongs.
	112	*/
	113	if (info->filename)
	114	return offset & ~(ARCH_DMA_MINALIGN - 1);
	115
	116	return offset / info->bl_len;
	117	}
	118
	119	static int get_aligned_image_overhead(struct spl_load_info *info, int offset)
	120	{
	121	/*
	122	* If it is a FS read, get the difference between the offset and
	123	* the first address before offset which is aligned to
	124	* ARCH_DMA_MINALIGN. If it is raw read return the offset within the
	125	* block.
	126	*/
	127	if (info->filename)
	128	return offset & (ARCH_DMA_MINALIGN - 1);
	129
	130	return offset % info->bl_len;
	131	}
	132
	133	static int get_aligned_image_size(struct spl_load_info *info, int data_size,
	134	int offset)
	135	{
3cc1f380 LV	136	data_size = data_size + get_aligned_image_overhead(info, offset);
3cc1f380 LV	137
eafd5410	138	if (info->filename)
3cc1f380	139	return data_size;
eafd5410 LV	140
	141	return (data_size + info->bl_len - 1) / info->bl_len;
	142	}
	143
8baa3818 AP	144	/**
	145	* spl_load_fit_image(): load the image described in a certain FIT node
	146	* @info: points to information about the device to load data from
	147	* @sector: the start sector of the FIT image on the device
	148	* @fit: points to the flattened device tree blob describing the FIT
a616c783	149	* image
8baa3818 AP	150	* @base_offset: the beginning of the data area containing the actual
	151	* image data, relative to the beginning of the FIT
	152	* @node: offset of the DT node describing the image to load (relative
a616c783	153	* to @fit)
8baa3818	154	* @image_info: will be filled with information about the loaded image
a616c783 PT	155	* If the FIT node does not contain a "load" (address) property,
	156	* the image gets loaded to the address pointed to by the
	157	* load_addr member in this struct.
8baa3818 AP	158	*
	159	* Return: 0 on success or a negative error number.
	160	*/
	161	static int spl_load_fit_image(struct spl_load_info *info, ulong sector,
	162	void *fit, ulong base_offset, int node,
	163	struct spl_image_info *image_info)
	164	{
5fd13d97	165	int offset;
8baa3818	166	size_t length;
5fd13d97	167	int len;
933f67aa	168	ulong size;
8baa3818 AP	169	ulong load_addr, load_ptr;
	170	void *src;
	171	ulong overhead;
	172	int nr_sectors;
	173	int align_len = ARCH_DMA_MINALIGN - 1;
7264f292	174	uint8_t image_comp = -1, type = -1;
5fd13d97	175	const void *data;
a1be94b6	176	bool external_data = false;
7264f292 YS	177
	178	if (IS_ENABLED(CONFIG_SPL_OS_BOOT) && IS_ENABLED(CONFIG_SPL_GZIP)) {
	179	if (fit_image_get_comp(fit, node, &image_comp))
	180	puts("Cannot get image compression format.\n");
	181	else
	182	debug("%s ", genimg_get_comp_name(image_comp));
	183
	184	if (fit_image_get_type(fit, node, &type))
	185	puts("Cannot get image type.\n");
	186	else
	187	debug("%s ", genimg_get_type_name(type));
	188	}
8baa3818	189
5fd13d97	190	if (fit_image_get_load(fit, node, &load_addr))
8baa3818	191	load_addr = image_info->load_addr;
8baa3818	192
a1be94b6 PF	193	if (!fit_image_get_data_position(fit, node, &offset)) {
	194	external_data = true;
	195	} else if (!fit_image_get_data_offset(fit, node, &offset)) {
5fd13d97	196	offset += base_offset;
a1be94b6 PF	197	external_data = true;
	198	}
	199
	200	if (external_data) {
	201	/* External data */
5fd13d97 YS	202	if (fit_image_get_data_size(fit, node, &len))
	203	return -ENOENT;
	204
	205	load_ptr = (load_addr + align_len) & ~align_len;
	206	length = len;
	207
	208	overhead = get_aligned_image_overhead(info, offset);
	209	nr_sectors = get_aligned_image_size(info, length, offset);
	210
	211	if (info->read(info,
	212	sector + get_aligned_image_offset(info, offset),
	213	nr_sectors, (void *)load_ptr) != nr_sectors)
	214	return -EIO;
	215
	216	debug("External data: dst=%lx, offset=%x, size=%lx\n",
	217	load_ptr, offset, (unsigned long)length);
	218	src = (void *)load_ptr + overhead;
	219	} else {
	220	/* Embedded data */
	221	if (fit_image_get_data(fit, node, &data, &length)) {
	222	puts("Cannot get image data/size\n");
	223	return -ENOENT;
	224	}
	225	debug("Embedded data: dst=%lx, size=%lx\n", load_addr,
	226	(unsigned long)length);
	227	src = (void *)data;
	228	}
8baa3818	229
8baa3818 AP	230	#ifdef CONFIG_SPL_FIT_IMAGE_POST_PROCESS
	231	board_fit_image_post_process(&src, &length);
	232	#endif
	233
7264f292 YS	234	if (IS_ENABLED(CONFIG_SPL_OS_BOOT) &&
	235	IS_ENABLED(CONFIG_SPL_GZIP) &&
	236	image_comp == IH_COMP_GZIP &&
	237	type == IH_TYPE_KERNEL) {
933f67aa	238	size = length;
7264f292	239	if (gunzip((void *)load_addr, CONFIG_SYS_BOOTM_LEN,
933f67aa	240	src, &size)) {
7264f292 YS	241	puts("Uncompressing error\n");
	242	return -EIO;
	243	}
933f67aa	244	length = size;
7264f292 YS	245	} else {
	246	memcpy((void *)load_addr, src, length);
	247	}
8baa3818 AP	248
	249	if (image_info) {
	250	image_info->load_addr = load_addr;
	251	image_info->size = length;
	252	image_info->entry_point = fdt_getprop_u32(fit, node, "entry");
	253	}
	254
	255	return 0;
	256	}
	257
d879616e PT	258	static int spl_fit_append_fdt(struct spl_image_info *spl_image,
	259	struct spl_load_info *info, ulong sector,
	260	void *fit, int images, ulong base_offset)
	261	{
	262	struct spl_image_info image_info;
	263	int node, ret;
	264
	265	/* Figure out which device tree the board wants to use */
	266	node = spl_fit_get_image_node(fit, images, FIT_FDT_PROP, 0);
	267	if (node < 0) {
	268	debug("%s: cannot find FDT node\n", __func__);
	269	return node;
	270	}
	271
	272	/*
	273	* Read the device tree and place it after the image.
	274	* Align the destination address to ARCH_DMA_MINALIGN.
	275	*/
	276	image_info.load_addr = spl_image->load_addr + spl_image->size;
	277	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
	278	&image_info);
a616c783 PT	279
	280	if (ret < 0)
	281	return ret;
	282
	283	/* Make the load-address of the FDT available for the SPL framework */
	284	spl_image->fdt_addr = (void *)image_info.load_addr;
337bbb62	285	#if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
a616c783 PT	286	/* Try to make space, so we can inject details on the loadables */
a616c783 PT	287	ret = fdt_shrink_to_minimum(spl_image->fdt_addr, 8192);
337bbb62	288	#endif
a616c783 PT	289
	290	return ret;
	291	}
	292
	293	static int spl_fit_record_loadable(const void *fit, int images, int index,
	294	void blob, struct spl_image_info image)
	295	{
337bbb62 PT	296	int ret = 0;
337bbb62 PT	297	#if !CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
a616c783	298	char *name;
337bbb62	299	int node;
a616c783 PT	300
	301	ret = spl_fit_get_image_name(fit, images, "loadables",
	302	index, &name);
	303	if (ret < 0)
	304	return ret;
	305
	306	node = spl_fit_get_image_node(fit, images, "loadables", index);
	307
	308	ret = fdt_record_loadable(blob, index, name, image->load_addr,
	309	image->size, image->entry_point,
	310	fdt_getprop(fit, node, "type", NULL),
	311	fdt_getprop(fit, node, "os", NULL));
337bbb62	312	#endif
d879616e PT	313	return ret;
	314	}
	315
337bbb62 PT	316	static int spl_fit_image_get_os(const void fit, int noffset, uint8_t os)
	317	{
	318	#if CONFIG_IS_ENABLED(FIT_IMAGE_TINY)
	319	return -ENOTSUPP;
	320	#else
	321	return fit_image_get_os(fit, noffset, os);
	322	#endif
	323	}
	324
f4d7d859 SG	325	int spl_load_simple_fit(struct spl_image_info *spl_image,
f4d7d859 SG	326	struct spl_load_info info, ulong sector, void fit)
f1dcee59 SG	327	{
f1dcee59 SG	328	int sectors;
8baa3818	329	ulong size;
f1dcee59	330	unsigned long count;
8baa3818	331	struct spl_image_info image_info;
c8bc3c0c YS	332	int node = -1;
c8bc3c0c YS	333	int images, ret;
eafd5410	334	int base_offset, align_len = ARCH_DMA_MINALIGN - 1;
411cf32d	335	int index = 0;
f1dcee59 SG	336
f1dcee59 SG	337	/*
c8bc3c0c YS	338	* For FIT with external data, figure out where the external images
	339	* start. This is the base for the data-offset properties in each
	340	* image.
f1dcee59 SG	341	*/
	342	size = fdt_totalsize(fit);
	343	size = (size + 3) & ~3;
	344	base_offset = (size + 3) & ~3;
	345
	346	/*
	347	* So far we only have one block of data from the FIT. Read the entire
	348	* thing, including that first block, placing it so it finishes before
	349	* where we will load the image.
	350	*
	351	* Note that we will load the image such that its first byte will be
	352	* at the load address. Since that byte may be part-way through a
	353	* block, we may load the image up to one block before the load
	354	* address. So take account of that here by subtracting an addition
	355	* block length from the FIT start position.
	356	*
	357	* In fact the FIT has its own load address, but we assume it cannot
	358	* be before CONFIG_SYS_TEXT_BASE.
c8bc3c0c YS	359	*
	360	* For FIT with data embedded, data is loaded as part of FIT image.
	361	* For FIT with external data, data is not loaded in this step.
f1dcee59	362	*/
8b528709 LV	363	fit = (void *)((CONFIG_SYS_TEXT_BASE - size - info->bl_len -
8b528709 LV	364	align_len) & ~align_len);
eafd5410	365	sectors = get_aligned_image_size(info, size, 0);
f1dcee59 SG	366	count = info->read(info, sector, sectors, fit);
	367	debug("fit read sector %lx, sectors=%d, dst=%p, count=%lu\n",
	368	sector, sectors, fit, count);
	369	if (count == 0)
	370	return -EIO;
	371
736806fb	372	/* find the node holding the images information */
f1dcee59 SG	373	images = fdt_path_offset(fit, FIT_IMAGES_PATH);
	374	if (images < 0) {
	375	debug("%s: Cannot find /images node: %d\n", __func__, images);
	376	return -1;
	377	}
736806fb	378
d879616e PT	379	/*
	380	* Find the U-Boot image using the following search order:
	381	* - start at 'firmware' (e.g. an ARM Trusted Firmware)
	382	* - fall back 'kernel' (e.g. a Falcon-mode OS boot
	383	* - fall back to using the first 'loadables' entry
	384	*/
	385	if (node < 0)
	386	node = spl_fit_get_image_node(fit, images, "firmware", 0);
c8bc3c0c	387	#ifdef CONFIG_SPL_OS_BOOT
c8bc3c0c	388	if (node < 0)
d879616e	389	node = spl_fit_get_image_node(fit, images, FIT_KERNEL_PROP, 0);
c8bc3c0c	390	#endif
f1dcee59	391	if (node < 0) {
736806fb AP	392	debug("could not find firmware image, trying loadables...\n");
736806fb AP	393	node = spl_fit_get_image_node(fit, images, "loadables", 0);
411cf32d AP	394	/*
	395	* If we pick the U-Boot image from "loadables", start at
	396	* the second image when later loading additional images.
	397	*/
	398	index = 1;
736806fb AP	399	}
	400	if (node < 0) {
	401	debug("%s: Cannot find u-boot image node: %d\n",
	402	__func__, node);
f1dcee59 SG	403	return -1;
	404	}
	405
8baa3818 AP	406	/* Load the image and set up the spl_image structure */
	407	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
	408	spl_image);
	409	if (ret)
	410	return ret;
da74d1f3	411
d879616e PT	412	/*
	413	* For backward compatibility, we treat the first node that is
	414	* as a U-Boot image, if no OS-type has been declared.
	415	*/
337bbb62	416	if (!spl_fit_image_get_os(fit, node, &spl_image->os))
c8bc3c0c	417	debug("Image OS is %s\n", genimg_get_os_name(spl_image->os));
d879616e PT	418	#if !defined(CONFIG_SPL_OS_BOOT)
	419	else
	420	spl_image->os = IH_OS_U_BOOT;
c8bc3c0c	421	#endif
f1dcee59	422
d879616e PT	423	/*
	424	* Booting a next-stage U-Boot may require us to append the FDT.
	425	* We allow this to fail, as the U-Boot image might embed its FDT.
	426	*/
	427	if (spl_image->os == IH_OS_U_BOOT)
	428	spl_fit_append_fdt(spl_image, info, sector, fit,
	429	images, base_offset);
411cf32d AP	430
	431	/* Now check if there are more images for us to load */
	432	for (; ; index++) {
d879616e PT	433	uint8_t os_type = IH_OS_INVALID;
d879616e PT	434
411cf32d AP	435	node = spl_fit_get_image_node(fit, images, "loadables", index);
	436	if (node < 0)
	437	break;
	438
	439	ret = spl_load_fit_image(info, sector, fit, base_offset, node,
	440	&image_info);
	441	if (ret < 0)
	442	continue;
	443
337bbb62	444	if (!spl_fit_image_get_os(fit, node, &os_type))
d879616e PT	445	debug("Loadable is %s\n", genimg_get_os_name(os_type));
d879616e PT	446
a616c783 PT	447	if (os_type == IH_OS_U_BOOT) {
a616c783 PT	448	spl_fit_append_fdt(&image_info, info, sector,
d879616e	449	fit, images, base_offset);
a616c783 PT	450	spl_image->fdt_addr = image_info.fdt_addr;
a616c783 PT	451	}
d879616e	452
411cf32d AP	453	/*
	454	* If the "firmware" image did not provide an entry point,
	455	* use the first valid entry point from the loadables.
	456	*/
	457	if (spl_image->entry_point == FDT_ERROR &&
	458	image_info.entry_point != FDT_ERROR)
	459	spl_image->entry_point = image_info.entry_point;
a616c783 PT	460
	461	/* Record our loadables into the FDT */
	462	if (spl_image->fdt_addr)
	463	spl_fit_record_loadable(fit, images, index,
	464	spl_image->fdt_addr,
	465	&image_info);
411cf32d AP	466	}
	467
	468	/*
	469	* If a platform does not provide CONFIG_SYS_UBOOT_START, U-Boot's
	470	* Makefile will set it to 0 and it will end up as the entry point
	471	* here. What it actually means is: use the load address.
	472	*/
	473	if (spl_image->entry_point == FDT_ERROR \|\| spl_image->entry_point == 0)
	474	spl_image->entry_point = spl_image->load_addr;
	475
	476	return 0;
f1dcee59	477	}