[J-u-boot.git] / common / image-fdt.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * Copyright (c) 2013, Google Inc.
 *
 * (C) Copyright 2008 Semihalf
 *
 * (C) Copyright 2000-2006
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

#include <common.h>
#include <fdt_support.h>
#include <fdtdec.h>
#include <env.h>
#include <errno.h>
#include <image.h>
#include <malloc.h>
#include <linux/libfdt.h>
#include <mapmem.h>
#include <asm/io.h>
#include <tee/optee.h>

#ifndef CONFIG_SYS_FDT_PAD
#define CONFIG_SYS_FDT_PAD 0x3000
#endif

/* adding a ramdisk needs 0x44 bytes in version 2008.10 */
#define FDT_RAMDISK_OVERHEAD	0x80

DECLARE_GLOBAL_DATA_PTR;

static void fdt_error(const char *msg)
{
	puts("ERROR: ");
	puts(msg);
	puts(" - must RESET the board to recover.\n");
}

#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
static const image_header_t *image_get_fdt(ulong fdt_addr)
{
	const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);

	image_print_contents(fdt_hdr);

	puts("   Verifying Checksum ... ");
	if (!image_check_hcrc(fdt_hdr)) {
		fdt_error("fdt header checksum invalid");
		return NULL;
	}

	if (!image_check_dcrc(fdt_hdr)) {
		fdt_error("fdt checksum invalid");
		return NULL;
	}
	puts("OK\n");

	if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
		fdt_error("uImage is not a fdt");
		return NULL;
	}
	if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
		fdt_error("uImage is compressed");
		return NULL;
	}
	if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
		fdt_error("uImage data is not a fdt");
		return NULL;
	}
	return fdt_hdr;
}
#endif

static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
				    uint64_t size)
{
	long ret;

	ret = lmb_reserve(lmb, addr, size);
	if (ret >= 0) {
		debug("   reserving fdt memory region: addr=%llx size=%llx\n",
		      (unsigned long long)addr, (unsigned long long)size);
	} else {
		puts("ERROR: reserving fdt memory region failed ");
		printf("(addr=%llx size=%llx)\n",
		       (unsigned long long)addr, (unsigned long long)size);
	}
}

/**
 * boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
 * sections as unusable
 * @lmb: pointer to lmb handle, will be used for memory mgmt
 * @fdt_blob: pointer to fdt blob base address
 *
 * Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
 * Adding the memreserve regions prevents u-boot from using them to store the
 * initrd or the fdt blob.
 */
void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
{
	uint64_t addr, size;
	int i, total, ret;
	int nodeoffset, subnode;
	struct fdt_resource res;

	if (fdt_check_header(fdt_blob) != 0)
		return;

	/* process memreserve sections */
	total = fdt_num_mem_rsv(fdt_blob);
	for (i = 0; i < total; i++) {
		if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
			continue;
		boot_fdt_reserve_region(lmb, addr, size);
	}

	/* process reserved-memory */
	nodeoffset = fdt_subnode_offset(fdt_blob, 0, "reserved-memory");
	if (nodeoffset >= 0) {
		subnode = fdt_first_subnode(fdt_blob, nodeoffset);
		while (subnode >= 0) {
			/* check if this subnode has a reg property */
			ret = fdt_get_resource(fdt_blob, subnode, "reg", 0,
					       &res);
			if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
				addr = res.start;
				size = res.end - res.start + 1;
				boot_fdt_reserve_region(lmb, addr, size);
			}

			subnode = fdt_next_subnode(fdt_blob, subnode);
		}
	}
}

/**
 * boot_relocate_fdt - relocate flat device tree
 * @lmb: pointer to lmb handle, will be used for memory mgmt
 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
 * @of_size: pointer to a ulong variable, will hold fdt length
 *
 * boot_relocate_fdt() allocates a region of memory within the bootmap and
 * relocates the of_flat_tree into that region, even if the fdt is already in
 * the bootmap.  It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
 * bytes.
 *
 * of_flat_tree and of_size are set to final (after relocation) values
 *
 * returns:
 *      0 - success
 *      1 - failure
 */
int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
{
	void	*fdt_blob = *of_flat_tree;
	void	*of_start = NULL;
	char	*fdt_high;
	ulong	of_len = 0;
	int	err;
	int	disable_relocation = 0;

	/* nothing to do */
	if (*of_size == 0)
		return 0;

	if (fdt_check_header(fdt_blob) != 0) {
		fdt_error("image is not a fdt");
		goto error;
	}

	/* position on a 4K boundary before the alloc_current */
	/* Pad the FDT by a specified amount */
	of_len = *of_size + CONFIG_SYS_FDT_PAD;

	/* If fdt_high is set use it to select the relocation address */
	fdt_high = env_get("fdt_high");
	if (fdt_high) {
		void *desired_addr = (void *)simple_strtoul(fdt_high, NULL, 16);

		if (((ulong) desired_addr) == ~0UL) {
			/* All ones means use fdt in place */
			of_start = fdt_blob;
			lmb_reserve(lmb, (ulong)of_start, of_len);
			disable_relocation = 1;
		} else if (desired_addr) {
			of_start =
			    (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
							   (ulong)desired_addr);
			if (of_start == NULL) {
				puts("Failed using fdt_high value for Device Tree");
				goto error;
			}
		} else {
			of_start =
			    (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
		}
	} else {
		of_start =
		    (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
						   env_get_bootm_mapsize()
						   + env_get_bootm_low());
	}

	if (of_start == NULL) {
		puts("device tree - allocation error\n");
		goto error;
	}

	if (disable_relocation) {
		/*
		 * We assume there is space after the existing fdt to use
		 * for padding
		 */
		fdt_set_totalsize(of_start, of_len);
		printf("   Using Device Tree in place at %p, end %p\n",
		       of_start, of_start + of_len - 1);
	} else {
		debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
		      fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);

		printf("   Loading Device Tree to %p, end %p ... ",
		       of_start, of_start + of_len - 1);

		err = fdt_open_into(fdt_blob, of_start, of_len);
		if (err != 0) {
			fdt_error("fdt move failed");
			goto error;
		}
		puts("OK\n");
	}

	*of_flat_tree = of_start;
	*of_size = of_len;

	if (CONFIG_IS_ENABLED(CMD_FDT))
		set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
	return 0;

error:
	return 1;
}

/**
 * boot_get_fdt - main fdt handling routine
 * @argc: command argument count
 * @argv: command argument list
 * @arch: architecture (IH_ARCH_...)
 * @images: pointer to the bootm images structure
 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
 * @of_size: pointer to a ulong variable, will hold fdt length
 *
 * boot_get_fdt() is responsible for finding a valid flat device tree image.
 * Curently supported are the following ramdisk sources:
 *      - multicomponent kernel/ramdisk image,
 *      - commandline provided address of decicated ramdisk image.
 *
 * returns:
 *     0, if fdt image was found and valid, or skipped
 *     of_flat_tree and of_size are set to fdt start address and length if
 *     fdt image is found and valid
 *
 *     1, if fdt image is found but corrupted
 *     of_flat_tree and of_size are set to 0 if no fdt exists
 */
int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
		bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
{
#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
	const image_header_t *fdt_hdr;
	ulong		load, load_end;
	ulong		image_start, image_data, image_end;
#endif
	ulong		img_addr;
	ulong		fdt_addr;
	char		*fdt_blob = NULL;
	void		*buf;
#if CONFIG_IS_ENABLED(FIT)
	const char	*fit_uname_config = images->fit_uname_cfg;
	const char	*fit_uname_fdt = NULL;
	ulong		default_addr;
	int		fdt_noffset;
#endif
	const char *select = NULL;

	*of_flat_tree = NULL;
	*of_size = 0;

	img_addr = (argc == 0) ? image_load_addr :
			simple_strtoul(argv[0], NULL, 16);
	buf = map_sysmem(img_addr, 0);

	if (argc > 2)
		select = argv[2];
	if (select || genimg_has_config(images)) {
#if CONFIG_IS_ENABLED(FIT)
		if (select) {
			/*
			 * If the FDT blob comes from the FIT image and the
			 * FIT image address is omitted in the command line
			 * argument, try to use ramdisk or os FIT image
			 * address or default load address.
			 */
			if (images->fit_uname_rd)
				default_addr = (ulong)images->fit_hdr_rd;
			else if (images->fit_uname_os)
				default_addr = (ulong)images->fit_hdr_os;
			else
				default_addr = image_load_addr;

			if (fit_parse_conf(select, default_addr,
					   &fdt_addr, &fit_uname_config)) {
				debug("*  fdt: config '%s' from image at 0x%08lx\n",
				      fit_uname_config, fdt_addr);
			} else if (fit_parse_subimage(select, default_addr,
				   &fdt_addr, &fit_uname_fdt)) {
				debug("*  fdt: subimage '%s' from image at 0x%08lx\n",
				      fit_uname_fdt, fdt_addr);
			} else
#endif
			{
				fdt_addr = simple_strtoul(select, NULL, 16);
				debug("*  fdt: cmdline image address = 0x%08lx\n",
				      fdt_addr);
			}
#if CONFIG_IS_ENABLED(FIT)
		} else {
			/* use FIT configuration provided in first bootm
			 * command argument
			 */
			fdt_addr = map_to_sysmem(images->fit_hdr_os);
			fdt_noffset = fit_get_node_from_config(images,
							       FIT_FDT_PROP,
							       fdt_addr);
			if (fdt_noffset == -ENOENT)
				return 0;
			else if (fdt_noffset < 0)
				return 1;
		}
#endif
		debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
		      fdt_addr);

		/*
		 * Check if there is an FDT image at the
		 * address provided in the second bootm argument
		 * check image type, for FIT images get a FIT node.
		 */
		buf = map_sysmem(fdt_addr, 0);
		switch (genimg_get_format(buf)) {
#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
		case IMAGE_FORMAT_LEGACY:
			/* verify fdt_addr points to a valid image header */
			printf("## Flattened Device Tree from Legacy Image at %08lx\n",
			       fdt_addr);
			fdt_hdr = image_get_fdt(fdt_addr);
			if (!fdt_hdr)
				goto no_fdt;

			/*
			 * move image data to the load address,
			 * make sure we don't overwrite initial image
			 */
			image_start = (ulong)fdt_hdr;
			image_data = (ulong)image_get_data(fdt_hdr);
			image_end = image_get_image_end(fdt_hdr);

			load = image_get_load(fdt_hdr);
			load_end = load + image_get_data_size(fdt_hdr);

			if (load == image_start ||
			    load == image_data) {
				fdt_addr = load;
				break;
			}

			if ((load < image_end) && (load_end > image_start)) {
				fdt_error("fdt overwritten");
				goto error;
			}

			debug("   Loading FDT from 0x%08lx to 0x%08lx\n",
			      image_data, load);

			memmove((void *)load,
				(void *)image_data,
				image_get_data_size(fdt_hdr));

			fdt_addr = load;
			break;
#endif
		case IMAGE_FORMAT_FIT:
			/*
			 * This case will catch both: new uImage format
			 * (libfdt based) and raw FDT blob (also libfdt
			 * based).
			 */
#if CONFIG_IS_ENABLED(FIT)
			/* check FDT blob vs FIT blob */
			if (fit_check_format(buf)) {
				ulong load, len;

				fdt_noffset = boot_get_fdt_fit(images,
					fdt_addr, &fit_uname_fdt,
					&fit_uname_config,
					arch, &load, &len);

				images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
				images->fit_uname_fdt = fit_uname_fdt;
				images->fit_noffset_fdt = fdt_noffset;
				fdt_addr = load;

				break;
			} else
#endif
			{
				/*
				 * FDT blob
				 */
				debug("*  fdt: raw FDT blob\n");
				printf("## Flattened Device Tree blob at %08lx\n",
				       (long)fdt_addr);
			}
			break;
		default:
			puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
			goto no_fdt;
		}

		printf("   Booting using the fdt blob at %#08lx\n", fdt_addr);
		fdt_blob = map_sysmem(fdt_addr, 0);
	} else if (images->legacy_hdr_valid &&
			image_check_type(&images->legacy_hdr_os_copy,
					 IH_TYPE_MULTI)) {
		ulong fdt_data, fdt_len;

		/*
		 * Now check if we have a legacy multi-component image,
		 * get second entry data start address and len.
		 */
		printf("## Flattened Device Tree from multi component Image at %08lX\n",
		       (ulong)images->legacy_hdr_os);

		image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
				   &fdt_len);
		if (fdt_len) {
			fdt_blob = (char *)fdt_data;
			printf("   Booting using the fdt at 0x%p\n", fdt_blob);

			if (fdt_check_header(fdt_blob) != 0) {
				fdt_error("image is not a fdt");
				goto error;
			}

			if (fdt_totalsize(fdt_blob) != fdt_len) {
				fdt_error("fdt size != image size");
				goto error;
			}
		} else {
			debug("## No Flattened Device Tree\n");
			goto no_fdt;
		}
#ifdef CONFIG_ANDROID_BOOT_IMAGE
	} else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
		struct andr_img_hdr *hdr = buf;
		ulong fdt_data, fdt_len;

		if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
		    !fdt_check_header((char *)fdt_data)) {
			fdt_blob = (char *)fdt_data;
			if (fdt_totalsize(fdt_blob) != fdt_len)
				goto error;

			debug("## Using FDT in Android image second area\n");
		} else {
			fdt_addr = env_get_hex("fdtaddr", 0);
			if (!fdt_addr)
				goto no_fdt;

			fdt_blob = map_sysmem(fdt_addr, 0);
			if (fdt_check_header(fdt_blob))
				goto no_fdt;

			debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
		}
#endif
	} else {
		debug("## No Flattened Device Tree\n");
		goto no_fdt;
	}

	*of_flat_tree = fdt_blob;
	*of_size = fdt_totalsize(fdt_blob);
	debug("   of_flat_tree at 0x%08lx size 0x%08lx\n",
	      (ulong)*of_flat_tree, *of_size);

	return 0;

no_fdt:
	debug("Continuing to boot without FDT\n");
	return 0;
error:
	return 1;
}

/*
 * Verify the device tree.
 *
 * This function is called after all device tree fix-ups have been enacted,
 * so that the final device tree can be verified.  The definition of "verified"
 * is up to the specific implementation.  However, it generally means that the
 * addresses of some of the devices in the device tree are compared with the
 * actual addresses at which U-Boot has placed them.
 *
 * Returns 1 on success, 0 on failure.  If 0 is returned, U-Boot will halt the
 * boot process.
 */
__weak int ft_verify_fdt(void *fdt)
{
	return 1;
}

__weak int arch_fixup_fdt(void *blob)
{
	return 0;
}

int image_setup_libfdt(bootm_headers_t *images, void *blob,
		       int of_size, struct lmb *lmb)
{
	ulong *initrd_start = &images->initrd_start;
	ulong *initrd_end = &images->initrd_end;
	int ret = -EPERM;
	int fdt_ret;

	if (fdt_root(blob) < 0) {
		printf("ERROR: root node setup failed\n");
		goto err;
	}
	if (fdt_chosen(blob) < 0) {
		printf("ERROR: /chosen node create failed\n");
		goto err;
	}
	if (arch_fixup_fdt(blob) < 0) {
		printf("ERROR: arch-specific fdt fixup failed\n");
		goto err;
	}
	/* Update ethernet nodes */
	fdt_fixup_ethernet(blob);
	if (IMAGE_OF_BOARD_SETUP) {
		fdt_ret = ft_board_setup(blob, gd->bd);
		if (fdt_ret) {
			printf("ERROR: board-specific fdt fixup failed: %s\n",
			       fdt_strerror(fdt_ret));
			goto err;
		}
	}
	if (IMAGE_OF_SYSTEM_SETUP) {
		fdt_ret = ft_system_setup(blob, gd->bd);
		if (fdt_ret) {
			printf("ERROR: system-specific fdt fixup failed: %s\n",
			       fdt_strerror(fdt_ret));
			goto err;
		}
	}

	fdt_ret = optee_copy_fdt_nodes(gd->fdt_blob, blob);
	if (fdt_ret) {
		printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
		       fdt_strerror(fdt_ret));
		goto err;
	}

	/* Delete the old LMB reservation */
	if (lmb)
		lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
			 (phys_size_t)fdt_totalsize(blob));

	ret = fdt_shrink_to_minimum(blob, 0);
	if (ret < 0)
		goto err;
	of_size = ret;

	if (*initrd_start && *initrd_end) {
		of_size += FDT_RAMDISK_OVERHEAD;
		fdt_set_totalsize(blob, of_size);
	}
	/* Create a new LMB reservation */
	if (lmb)
		lmb_reserve(lmb, (ulong)blob, of_size);

	fdt_initrd(blob, *initrd_start, *initrd_end);
	if (!ft_verify_fdt(blob))
		goto err;

#if defined(CONFIG_SOC_KEYSTONE)
	if (IMAGE_OF_BOARD_SETUP)
		ft_board_setup_ex(blob, gd->bd);
#endif

	return 0;
err:
	printf(" - must RESET the board to recover.\n\n");

	return ret;
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
44d3a306 SG	2	/*
	3	* Copyright (c) 2013, Google Inc.
	4	*
	5	* (C) Copyright 2008 Semihalf
	6	*
	7	* (C) Copyright 2000-2006
	8	* Wolfgang Denk, DENX Software Engineering, [email protected].
44d3a306 SG	9	*/
	10
	11	#include <common.h>
	12	#include <fdt_support.h>
e2237a2c	13	#include <fdtdec.h>
cdbff9fc	14	#include <env.h>
44d3a306 SG	15	#include <errno.h>
44d3a306 SG	16	#include <image.h>
336d4615	17	#include <malloc.h>
b08c8c48	18	#include <linux/libfdt.h>
0eb25b61	19	#include <mapmem.h>
44d3a306	20	#include <asm/io.h>
6ccb05ea	21	#include <tee/optee.h>
44d3a306 SG	22
	23	#ifndef CONFIG_SYS_FDT_PAD
	24	#define CONFIG_SYS_FDT_PAD 0x3000
	25	#endif
	26
c960a68e MY	27	/* adding a ramdisk needs 0x44 bytes in version 2008.10 */
	28	#define FDT_RAMDISK_OVERHEAD 0x80
	29
44d3a306 SG	30	DECLARE_GLOBAL_DATA_PTR;
	31
	32	static void fdt_error(const char *msg)
	33	{
	34	puts("ERROR: ");
	35	puts(msg);
	36	puts(" - must RESET the board to recover.\n");
	37	}
	38
c76c93a3	39	#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
44d3a306 SG	40	static const image_header_t *image_get_fdt(ulong fdt_addr)
	41	{
	42	const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);
	43
	44	image_print_contents(fdt_hdr);
	45
	46	puts(" Verifying Checksum ... ");
	47	if (!image_check_hcrc(fdt_hdr)) {
	48	fdt_error("fdt header checksum invalid");
	49	return NULL;
	50	}
	51
	52	if (!image_check_dcrc(fdt_hdr)) {
	53	fdt_error("fdt checksum invalid");
	54	return NULL;
	55	}
	56	puts("OK\n");
	57
	58	if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
	59	fdt_error("uImage is not a fdt");
	60	return NULL;
	61	}
	62	if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
	63	fdt_error("uImage is compressed");
	64	return NULL;
	65	}
2f0877c7	66	if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
44d3a306 SG	67	fdt_error("uImage data is not a fdt");
	68	return NULL;
	69	}
	70	return fdt_hdr;
	71	}
21d29f7f	72	#endif
44d3a306	73
e2237a2c SG	74	static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
	75	uint64_t size)
	76	{
e1d7ed34	77	long ret;
e2237a2c SG	78
e2237a2c SG	79	ret = lmb_reserve(lmb, addr, size);
e1d7ed34	80	if (ret >= 0) {
e2237a2c SG	81	debug(" reserving fdt memory region: addr=%llx size=%llx\n",
	82	(unsigned long long)addr, (unsigned long long)size);
	83	} else {
	84	puts("ERROR: reserving fdt memory region failed ");
	85	printf("(addr=%llx size=%llx)\n",
	86	(unsigned long long)addr, (unsigned long long)size);
	87	}
	88	}
	89
44d3a306	90	/**
e2237a2c SG	91	* boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
e2237a2c SG	92	* sections as unusable
44d3a306 SG	93	* @lmb: pointer to lmb handle, will be used for memory mgmt
	94	* @fdt_blob: pointer to fdt blob base address
	95	*
e2237a2c SG	96	* Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
	97	* Adding the memreserve regions prevents u-boot from using them to store the
	98	* initrd or the fdt blob.
44d3a306 SG	99	*/
	100	void boot_fdt_add_mem_rsv_regions(struct lmb lmb, void fdt_blob)
	101	{
	102	uint64_t addr, size;
e2237a2c SG	103	int i, total, ret;
	104	int nodeoffset, subnode;
	105	struct fdt_resource res;
44d3a306 SG	106
	107	if (fdt_check_header(fdt_blob) != 0)
	108	return;
	109
e2237a2c	110	/* process memreserve sections */
44d3a306 SG	111	total = fdt_num_mem_rsv(fdt_blob);
	112	for (i = 0; i < total; i++) {
	113	if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
	114	continue;
e2237a2c SG	115	boot_fdt_reserve_region(lmb, addr, size);
	116	}
	117
	118	/* process reserved-memory */
	119	nodeoffset = fdt_subnode_offset(fdt_blob, 0, "reserved-memory");
	120	if (nodeoffset >= 0) {
	121	subnode = fdt_first_subnode(fdt_blob, nodeoffset);
	122	while (subnode >= 0) {
	123	/* check if this subnode has a reg property */
	124	ret = fdt_get_resource(fdt_blob, subnode, "reg", 0,
	125	&res);
28b417ce	126	if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
e2237a2c SG	127	addr = res.start;
	128	size = res.end - res.start + 1;
	129	boot_fdt_reserve_region(lmb, addr, size);
	130	}
	131
	132	subnode = fdt_next_subnode(fdt_blob, subnode);
	133	}
44d3a306 SG	134	}
	135	}
	136
	137	/**
	138	* boot_relocate_fdt - relocate flat device tree
	139	* @lmb: pointer to lmb handle, will be used for memory mgmt
	140	* @of_flat_tree: pointer to a char* variable, will hold fdt start address
	141	* @of_size: pointer to a ulong variable, will hold fdt length
	142	*
	143	* boot_relocate_fdt() allocates a region of memory within the bootmap and
	144	* relocates the of_flat_tree into that region, even if the fdt is already in
	145	* the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
	146	* bytes.
	147	*
	148	* of_flat_tree and of_size are set to final (after relocation) values
	149	*
	150	* returns:
	151	* 0 - success
	152	* 1 - failure
	153	*/
	154	int boot_relocate_fdt(struct lmb lmb, char of_flat_tree, ulong of_size)
	155	{
	156	void fdt_blob = of_flat_tree;
	157	void *of_start = NULL;
	158	char *fdt_high;
	159	ulong of_len = 0;
	160	int err;
	161	int disable_relocation = 0;
	162
	163	/* nothing to do */
	164	if (*of_size == 0)
	165	return 0;
	166
	167	if (fdt_check_header(fdt_blob) != 0) {
	168	fdt_error("image is not a fdt");
	169	goto error;
	170	}
	171
	172	/* position on a 4K boundary before the alloc_current */
	173	/* Pad the FDT by a specified amount */
	174	of_len = *of_size + CONFIG_SYS_FDT_PAD;
	175
	176	/* If fdt_high is set use it to select the relocation address */
00caae6d	177	fdt_high = env_get("fdt_high");
44d3a306 SG	178	if (fdt_high) {
	179	void desired_addr = (void )simple_strtoul(fdt_high, NULL, 16);
	180
	181	if (((ulong) desired_addr) == ~0UL) {
	182	/* All ones means use fdt in place */
	183	of_start = fdt_blob;
	184	lmb_reserve(lmb, (ulong)of_start, of_len);
	185	disable_relocation = 1;
	186	} else if (desired_addr) {
	187	of_start =
	188	(void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
	189	(ulong)desired_addr);
	190	if (of_start == NULL) {
	191	puts("Failed using fdt_high value for Device Tree");
	192	goto error;
	193	}
	194	} else {
	195	of_start =
	196	(void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
	197	}
	198	} else {
	199	of_start =
	200	(void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
723806cc SG	201	env_get_bootm_mapsize()
723806cc SG	202	+ env_get_bootm_low());
44d3a306 SG	203	}
	204
	205	if (of_start == NULL) {
	206	puts("device tree - allocation error\n");
	207	goto error;
	208	}
	209
	210	if (disable_relocation) {
	211	/*
	212	* We assume there is space after the existing fdt to use
	213	* for padding
	214	*/
	215	fdt_set_totalsize(of_start, of_len);
	216	printf(" Using Device Tree in place at %p, end %p\n",
	217	of_start, of_start + of_len - 1);
	218	} else {
	219	debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
	220	fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
	221
	222	printf(" Loading Device Tree to %p, end %p ... ",
	223	of_start, of_start + of_len - 1);
	224
	225	err = fdt_open_into(fdt_blob, of_start, of_len);
	226	if (err != 0) {
	227	fdt_error("fdt move failed");
	228	goto error;
	229	}
	230	puts("OK\n");
	231	}
	232
	233	*of_flat_tree = of_start;
	234	*of_size = of_len;
	235
596be5f3 SG	236	if (CONFIG_IS_ENABLED(CMD_FDT))
596be5f3 SG	237	set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
44d3a306 SG	238	return 0;
	239
	240	error:
	241	return 1;
	242	}
	243
44d3a306 SG	244	/**
	245	* boot_get_fdt - main fdt handling routine
	246	* @argc: command argument count
	247	* @argv: command argument list
53f375fa	248	* @arch: architecture (IH_ARCH_...)
44d3a306 SG	249	* @images: pointer to the bootm images structure
	250	* @of_flat_tree: pointer to a char* variable, will hold fdt start address
	251	* @of_size: pointer to a ulong variable, will hold fdt length
	252	*
	253	* boot_get_fdt() is responsible for finding a valid flat device tree image.
	254	* Curently supported are the following ramdisk sources:
	255	* - multicomponent kernel/ramdisk image,
	256	* - commandline provided address of decicated ramdisk image.
	257	*
	258	* returns:
	259	* 0, if fdt image was found and valid, or skipped
	260	* of_flat_tree and of_size are set to fdt start address and length if
	261	* fdt image is found and valid
	262	*
	263	* 1, if fdt image is found but corrupted
	264	* of_flat_tree and of_size are set to 0 if no fdt exists
	265	*/
53f375fa	266	int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
44d3a306 SG	267	bootm_headers_t images, char of_flat_tree, ulong of_size)
44d3a306 SG	268	{
c76c93a3	269	#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
44d3a306	270	const image_header_t *fdt_hdr;
21d29f7f HS	271	ulong load, load_end;
	272	ulong image_start, image_data, image_end;
	273	#endif
6a7b406a	274	ulong img_addr;
44d3a306 SG	275	ulong fdt_addr;
44d3a306 SG	276	char *fdt_blob = NULL;
44d3a306	277	void *buf;
73223f0e	278	#if CONFIG_IS_ENABLED(FIT)
f320a4d8	279	const char *fit_uname_config = images->fit_uname_cfg;
44d3a306 SG	280	const char *fit_uname_fdt = NULL;
44d3a306 SG	281	ulong default_addr;
44d3a306	282	int fdt_noffset;
44d3a306	283	#endif
983c72f4	284	const char *select = NULL;
44d3a306 SG	285
	286	*of_flat_tree = NULL;
	287	*of_size = 0;
	288
bb872dd9 SG	289	img_addr = (argc == 0) ? image_load_addr :
bb872dd9 SG	290	simple_strtoul(argv[0], NULL, 16);
6a7b406a SG	291	buf = map_sysmem(img_addr, 0);
6a7b406a SG	292
983c72f4 SG	293	if (argc > 2)
	294	select = argv[2];
	295	if (select \|\| genimg_has_config(images)) {
73223f0e	296	#if CONFIG_IS_ENABLED(FIT)
983c72f4	297	if (select) {
44d3a306 SG	298	/*
	299	* If the FDT blob comes from the FIT image and the
	300	* FIT image address is omitted in the command line
	301	* argument, try to use ramdisk or os FIT image
	302	* address or default load address.
	303	*/
	304	if (images->fit_uname_rd)
	305	default_addr = (ulong)images->fit_hdr_rd;
	306	else if (images->fit_uname_os)
	307	default_addr = (ulong)images->fit_hdr_os;
	308	else
bb872dd9	309	default_addr = image_load_addr;
44d3a306	310
983c72f4	311	if (fit_parse_conf(select, default_addr,
44d3a306 SG	312	&fdt_addr, &fit_uname_config)) {
	313	debug("* fdt: config '%s' from image at 0x%08lx\n",
	314	fit_uname_config, fdt_addr);
983c72f4	315	} else if (fit_parse_subimage(select, default_addr,
44d3a306 SG	316	&fdt_addr, &fit_uname_fdt)) {
	317	debug("* fdt: subimage '%s' from image at 0x%08lx\n",
	318	fit_uname_fdt, fdt_addr);
	319	} else
	320	#endif
	321	{
983c72f4	322	fdt_addr = simple_strtoul(select, NULL, 16);
44d3a306 SG	323	debug("* fdt: cmdline image address = 0x%08lx\n",
	324	fdt_addr);
	325	}
73223f0e	326	#if CONFIG_IS_ENABLED(FIT)
44d3a306 SG	327	} else {
	328	/* use FIT configuration provided in first bootm
	329	* command argument
	330	*/
	331	fdt_addr = map_to_sysmem(images->fit_hdr_os);
53f375fa SG	332	fdt_noffset = fit_get_node_from_config(images,
	333	FIT_FDT_PROP,
	334	fdt_addr);
bd86ef11	335	if (fdt_noffset == -ENOENT)
44d3a306	336	return 0;
53f375fa SG	337	else if (fdt_noffset < 0)
53f375fa SG	338	return 1;
44d3a306 SG	339	}
44d3a306 SG	340	#endif
44d3a306 SG	341	debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
	342	fdt_addr);
	343
44d3a306 SG	344	/*
	345	* Check if there is an FDT image at the
	346	* address provided in the second bootm argument
	347	* check image type, for FIT images get a FIT node.
	348	*/
	349	buf = map_sysmem(fdt_addr, 0);
	350	switch (genimg_get_format(buf)) {
c76c93a3	351	#if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
44d3a306 SG	352	case IMAGE_FORMAT_LEGACY:
	353	/* verify fdt_addr points to a valid image header */
	354	printf("## Flattened Device Tree from Legacy Image at %08lx\n",
	355	fdt_addr);
	356	fdt_hdr = image_get_fdt(fdt_addr);
	357	if (!fdt_hdr)
48aead71	358	goto no_fdt;
44d3a306 SG	359
	360	/*
	361	* move image data to the load address,
	362	* make sure we don't overwrite initial image
	363	*/
	364	image_start = (ulong)fdt_hdr;
	365	image_data = (ulong)image_get_data(fdt_hdr);
	366	image_end = image_get_image_end(fdt_hdr);
	367
53f375fa SG	368	load = image_get_load(fdt_hdr);
53f375fa SG	369	load_end = load + image_get_data_size(fdt_hdr);
44d3a306	370
53f375fa SG	371	if (load == image_start \|\|
53f375fa SG	372	load == image_data) {
2ea47be0	373	fdt_addr = load;
44d3a306 SG	374	break;
	375	}
	376
53f375fa	377	if ((load < image_end) && (load_end > image_start)) {
44d3a306 SG	378	fdt_error("fdt overwritten");
	379	goto error;
	380	}
	381
	382	debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
53f375fa	383	image_data, load);
44d3a306	384
53f375fa	385	memmove((void *)load,
44d3a306 SG	386	(void *)image_data,
	387	image_get_data_size(fdt_hdr));
	388
53f375fa	389	fdt_addr = load;
44d3a306	390	break;
21d29f7f	391	#endif
44d3a306 SG	392	case IMAGE_FORMAT_FIT:
	393	/*
	394	* This case will catch both: new uImage format
	395	* (libfdt based) and raw FDT blob (also libfdt
	396	* based).
	397	*/
73223f0e	398	#if CONFIG_IS_ENABLED(FIT)
44d3a306 SG	399	/* check FDT blob vs FIT blob */
44d3a306 SG	400	if (fit_check_format(buf)) {
53f375fa	401	ulong load, len;
44d3a306	402
169043d8	403	fdt_noffset = boot_get_fdt_fit(images,
53f375fa	404	fdt_addr, &fit_uname_fdt,
f320a4d8	405	&fit_uname_config,
169043d8	406	arch, &load, &len);
44d3a306	407
53f375fa	408	images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
44d3a306 SG	409	images->fit_uname_fdt = fit_uname_fdt;
44d3a306 SG	410	images->fit_noffset_fdt = fdt_noffset;
53f375fa	411	fdt_addr = load;
169043d8	412
44d3a306 SG	413	break;
	414	} else
	415	#endif
	416	{
	417	/*
	418	* FDT blob
	419	*/
44d3a306 SG	420	debug("* fdt: raw FDT blob\n");
	421	printf("## Flattened Device Tree blob at %08lx\n",
	422	(long)fdt_addr);
	423	}
	424	break;
	425	default:
	426	puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
48aead71	427	goto no_fdt;
44d3a306 SG	428	}
44d3a306 SG	429
53f375fa SG	430	printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
53f375fa SG	431	fdt_blob = map_sysmem(fdt_addr, 0);
44d3a306 SG	432	} else if (images->legacy_hdr_valid &&
	433	image_check_type(&images->legacy_hdr_os_copy,
	434	IH_TYPE_MULTI)) {
	435	ulong fdt_data, fdt_len;
	436
	437	/*
	438	* Now check if we have a legacy multi-component image,
	439	* get second entry data start address and len.
	440	*/
	441	printf("## Flattened Device Tree from multi component Image at %08lX\n",
	442	(ulong)images->legacy_hdr_os);
	443
	444	image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
	445	&fdt_len);
	446	if (fdt_len) {
	447	fdt_blob = (char *)fdt_data;
	448	printf(" Booting using the fdt at 0x%p\n", fdt_blob);
	449
	450	if (fdt_check_header(fdt_blob) != 0) {
	451	fdt_error("image is not a fdt");
	452	goto error;
	453	}
	454
	455	if (fdt_totalsize(fdt_blob) != fdt_len) {
	456	fdt_error("fdt size != image size");
	457	goto error;
	458	}
	459	} else {
	460	debug("## No Flattened Device Tree\n");
48aead71	461	goto no_fdt;
44d3a306	462	}
6a7b406a SG	463	#ifdef CONFIG_ANDROID_BOOT_IMAGE
	464	} else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
	465	struct andr_img_hdr *hdr = buf;
	466	ulong fdt_data, fdt_len;
	467
18b8f2c4 ER	468	if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
	469	!fdt_check_header((char *)fdt_data)) {
	470	fdt_blob = (char *)fdt_data;
	471	if (fdt_totalsize(fdt_blob) != fdt_len)
	472	goto error;
6a7b406a	473
18b8f2c4 ER	474	debug("## Using FDT in Android image second area\n");
18b8f2c4 ER	475	} else {
62392675 ER	476	fdt_addr = env_get_hex("fdtaddr", 0);
	477	if (!fdt_addr)
	478	goto no_fdt;
6a7b406a	479
62392675 ER	480	fdt_blob = map_sysmem(fdt_addr, 0);
	481	if (fdt_check_header(fdt_blob))
	482	goto no_fdt;
6a7b406a	483
62392675	484	debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
18b8f2c4	485	}
6a7b406a	486	#endif
44d3a306 SG	487	} else {
44d3a306 SG	488	debug("## No Flattened Device Tree\n");
48aead71	489	goto no_fdt;
44d3a306 SG	490	}
	491
	492	*of_flat_tree = fdt_blob;
	493	*of_size = fdt_totalsize(fdt_blob);
	494	debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
	495	(ulong)of_flat_tree, of_size);
	496
	497	return 0;
	498
48aead71	499	no_fdt:
80281829 ER	500	debug("Continuing to boot without FDT\n");
80281829 ER	501	return 0;
44d3a306	502	error:
44d3a306 SG	503	return 1;
44d3a306 SG	504	}
13d06981 SG	505
	506	/*
	507	* Verify the device tree.
	508	*
	509	* This function is called after all device tree fix-ups have been enacted,
	510	* so that the final device tree can be verified. The definition of "verified"
	511	* is up to the specific implementation. However, it generally means that the
	512	* addresses of some of the devices in the device tree are compared with the
	513	* actual addresses at which U-Boot has placed them.
	514	*
a187559e	515	* Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the
13d06981 SG	516	* boot process.
	517	*/
	518	__weak int ft_verify_fdt(void *fdt)
	519	{
	520	return 1;
	521	}
	522
4280342a AB	523	__weak int arch_fixup_fdt(void *blob)
	524	{
	525	return 0;
	526	}
	527
13d06981 SG	528	int image_setup_libfdt(bootm_headers_t images, void blob,
	529	int of_size, struct lmb *lmb)
	530	{
	531	ulong *initrd_start = &images->initrd_start;
	532	ulong *initrd_end = &images->initrd_end;
6f4dbc21 SG	533	int ret = -EPERM;
6f4dbc21 SG	534	int fdt_ret;
13d06981	535
10be5b5d PK	536	if (fdt_root(blob) < 0) {
	537	printf("ERROR: root node setup failed\n");
	538	goto err;
	539	}
bc6ed0f9	540	if (fdt_chosen(blob) < 0) {
6f4dbc21 SG	541	printf("ERROR: /chosen node create failed\n");
6f4dbc21 SG	542	goto err;
13d06981	543	}
e29607ed	544	if (arch_fixup_fdt(blob) < 0) {
6f4dbc21 SG	545	printf("ERROR: arch-specific fdt fixup failed\n");
	546	goto err;
	547	}
26d61195 TR	548	/* Update ethernet nodes */
26d61195 TR	549	fdt_fixup_ethernet(blob);
6f4dbc21 SG	550	if (IMAGE_OF_BOARD_SETUP) {
	551	fdt_ret = ft_board_setup(blob, gd->bd);
	552	if (fdt_ret) {
	553	printf("ERROR: board-specific fdt fixup failed: %s\n",
	554	fdt_strerror(fdt_ret));
	555	goto err;
	556	}
e29607ed	557	}
c654b517	558	if (IMAGE_OF_SYSTEM_SETUP) {
d89212b7 MK	559	fdt_ret = ft_system_setup(blob, gd->bd);
d89212b7 MK	560	if (fdt_ret) {
c654b517 SG	561	printf("ERROR: system-specific fdt fixup failed: %s\n",
	562	fdt_strerror(fdt_ret));
	563	goto err;
	564	}
	565	}
13d06981	566
6ccb05ea HS	567	fdt_ret = optee_copy_fdt_nodes(gd->fdt_blob, blob);
	568	if (fdt_ret) {
	569	printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
	570	fdt_strerror(fdt_ret));
	571	goto err;
	572	}
	573
13d06981	574	/* Delete the old LMB reservation */
dea2174d AG	575	if (lmb)
	576	lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
	577	(phys_size_t)fdt_totalsize(blob));
13d06981	578
ef476836	579	ret = fdt_shrink_to_minimum(blob, 0);
13d06981	580	if (ret < 0)
6f4dbc21	581	goto err;
13d06981 SG	582	of_size = ret;
	583
	584	if (initrd_start && initrd_end) {
	585	of_size += FDT_RAMDISK_OVERHEAD;
	586	fdt_set_totalsize(blob, of_size);
	587	}
	588	/* Create a new LMB reservation */
dea2174d AG	589	if (lmb)
dea2174d AG	590	lmb_reserve(lmb, (ulong)blob, of_size);
13d06981	591
dbe963ae	592	fdt_initrd(blob, initrd_start, initrd_end);
13d06981	593	if (!ft_verify_fdt(blob))
6f4dbc21	594	goto err;
13d06981	595
7c387646	596	#if defined(CONFIG_SOC_KEYSTONE)
00c200f1 VA	597	if (IMAGE_OF_BOARD_SETUP)
	598	ft_board_setup_ex(blob, gd->bd);
	599	#endif
	600
13d06981	601	return 0;
6f4dbc21 SG	602	err:
	603	printf(" - must RESET the board to recover.\n\n");
	604
	605	return ret;
13d06981	606	}