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

/*
 * (C) Copyright 2010
 * Texas Instruments, <www.ti.com>
 *
 * Aneesh V <aneesh@ti.com>
 *
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <binman_sym.h>
#include <dm.h>
#include <spl.h>
#include <asm/u-boot.h>
#include <nand.h>
#include <fat.h>
#include <version.h>
#include <image.h>
#include <malloc.h>
#include <dm/root.h>
#include <linux/compiler.h>
#include <fdt_support.h>

DECLARE_GLOBAL_DATA_PTR;

#ifndef CONFIG_SYS_UBOOT_START
#define CONFIG_SYS_UBOOT_START	CONFIG_SYS_TEXT_BASE
#endif
#ifndef CONFIG_SYS_MONITOR_LEN
/* Unknown U-Boot size, let's assume it will not be more than 200 KB */
#define CONFIG_SYS_MONITOR_LEN	(200 * 1024)
#endif

u32 *boot_params_ptr = NULL;

/* See spl.h for information about this */
binman_sym_declare(ulong, u_boot_any, pos);

/* Define board data structure */
static bd_t bdata __attribute__ ((section(".data")));

/*
 * Board-specific Platform code can reimplement show_boot_progress () if needed
 */
__weak void show_boot_progress(int val) {}

/*
 * Default function to determine if u-boot or the OS should
 * be started. This implementation always returns 1.
 *
 * Please implement your own board specific funcion to do this.
 *
 * RETURN
 * 0 to not start u-boot
 * positive if u-boot should start
 */
#ifdef CONFIG_SPL_OS_BOOT
__weak int spl_start_uboot(void)
{
	puts("SPL: Please implement spl_start_uboot() for your board\n");
	puts("SPL: Direct Linux boot not active!\n");
	return 1;
}

/* weak default platform specific function to initialize
 * dram banks
 */
__weak int dram_init_banksize(void)
{
	return 0;
}

/*
 * Weak default function for arch specific zImage check. Return zero
 * and fill start and end address if image is recognized.
 */
int __weak bootz_setup(ulong image, ulong *start, ulong *end)
{
	 return 1;
}
#endif

void spl_fixup_fdt(void)
{
#if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
	void *fdt_blob = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
	int err;

	err = fdt_check_header(fdt_blob);
	if (err < 0) {
		printf("fdt_root: %s\n", fdt_strerror(err));
		return;
	}

	/* fixup the memory dt node */
	err = fdt_shrink_to_minimum(fdt_blob, 0);
	if (err == 0) {
		printf("spl: fdt_shrink_to_minimum err - %d\n", err);
		return;
	}

	err = arch_fixup_fdt(fdt_blob);
	if (err) {
		printf("spl: arch_fixup_fdt err - %d\n", err);
		return;
	}
#endif
}

/*
 * Weak default function for board specific cleanup/preparation before
 * Linux boot. Some boards/platforms might not need it, so just provide
 * an empty stub here.
 */
__weak void spl_board_prepare_for_linux(void)
{
	/* Nothing to do! */
}

__weak void spl_board_prepare_for_boot(void)
{
	/* Nothing to do! */
}

void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
{
	ulong u_boot_pos = binman_sym(ulong, u_boot_any, pos);

	spl_image->size = CONFIG_SYS_MONITOR_LEN;
	if (u_boot_pos != BINMAN_SYM_MISSING) {
		/* biman does not support separate entry addresses at present */
		spl_image->entry_point = u_boot_pos;
		spl_image->load_addr = u_boot_pos;
	} else {
		spl_image->entry_point = CONFIG_SYS_UBOOT_START;
		spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
	}
	spl_image->os = IH_OS_U_BOOT;
	spl_image->name = "U-Boot";
}

int spl_parse_image_header(struct spl_image_info *spl_image,
			   const struct image_header *header)
{
	if (image_get_magic(header) == IH_MAGIC) {
#ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
		u32 header_size = sizeof(struct image_header);

		if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
			/*
			 * On some system (e.g. powerpc), the load-address and
			 * entry-point is located at address 0. We can't load
			 * to 0-0x40. So skip header in this case.
			 */
			spl_image->load_addr = image_get_load(header);
			spl_image->entry_point = image_get_ep(header);
			spl_image->size = image_get_data_size(header);
		} else {
			spl_image->entry_point = image_get_load(header);
			/* Load including the header */
			spl_image->load_addr = spl_image->entry_point -
				header_size;
			spl_image->size = image_get_data_size(header) +
				header_size;
		}
		spl_image->os = image_get_os(header);
		spl_image->name = image_get_name(header);
		debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
			IH_NMLEN, spl_image->name,
			spl_image->load_addr, spl_image->size);
#else
		/* LEGACY image not supported */
		debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
		return -EINVAL;
#endif
	} else {
#ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
		/*
		 * CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
		 * code which loads images in SPL cannot guarantee that
		 * absolutely all read errors will be reported.
		 * An example is the LPC32XX MLC NAND driver, which
		 * will consider that a completely unreadable NAND block
		 * is bad, and thus should be skipped silently.
		 */
		panic("** no mkimage signature but raw image not supported");
#endif

#ifdef CONFIG_SPL_OS_BOOT
		ulong start, end;

		if (!bootz_setup((ulong)header, &start, &end)) {
			spl_image->name = "Linux";
			spl_image->os = IH_OS_LINUX;
			spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
			spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
			spl_image->size = end - start;
			debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
			      spl_image->load_addr, spl_image->size);
			return 0;
		}
#endif

#ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
		/* Signature not found - assume u-boot.bin */
		debug("mkimage signature not found - ih_magic = %x\n",
			header->ih_magic);
		spl_set_header_raw_uboot(spl_image);
#else
		/* RAW image not supported, proceed to other boot methods. */
		debug("Raw boot image support not enabled, proceeding to other boot methods\n");
		return -EINVAL;
#endif
	}

	return 0;
}

__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
{
	typedef void __noreturn (*image_entry_noargs_t)(void);

	image_entry_noargs_t image_entry =
		(image_entry_noargs_t)spl_image->entry_point;

	debug("image entry point: 0x%lX\n", spl_image->entry_point);
	image_entry();
}

static int spl_common_init(bool setup_malloc)
{
	int ret;

	debug("spl_early_init()\n");

#if CONFIG_VAL(SYS_MALLOC_F_LEN)
	if (setup_malloc) {
#ifdef CONFIG_MALLOC_F_ADDR
		gd->malloc_base = CONFIG_MALLOC_F_ADDR;
#endif
		gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
		gd->malloc_ptr = 0;
	}
#endif
	ret = bootstage_init(true);
	if (ret) {
		debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
		      ret);
		return ret;
	}
	bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
	if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
		ret = fdtdec_setup();
		if (ret) {
			debug("fdtdec_setup() returned error %d\n", ret);
			return ret;
		}
	}
	if (CONFIG_IS_ENABLED(DM)) {
		bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
		/* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
		ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
		bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
		if (ret) {
			debug("dm_init_and_scan() returned error %d\n", ret);
			return ret;
		}
	}

	return 0;
}

void spl_set_bd(void)
{
	if (!gd->bd)
		gd->bd = &bdata;
}

int spl_early_init(void)
{
	int ret;

	ret = spl_common_init(true);
	if (ret)
		return ret;
	gd->flags |= GD_FLG_SPL_EARLY_INIT;

	return 0;
}

int spl_init(void)
{
	int ret;
	bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
			IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));

	if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
		ret = spl_common_init(setup_malloc);
		if (ret)
			return ret;
	}
	gd->flags |= GD_FLG_SPL_INIT;

	return 0;
}

#ifndef BOOT_DEVICE_NONE
#define BOOT_DEVICE_NONE 0xdeadbeef
#endif

__weak void board_boot_order(u32 *spl_boot_list)
{
	spl_boot_list[0] = spl_boot_device();
}

static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
{
	struct spl_image_loader *drv =
		ll_entry_start(struct spl_image_loader, spl_image_loader);
	const int n_ents =
		ll_entry_count(struct spl_image_loader, spl_image_loader);
	struct spl_image_loader *entry;

	for (entry = drv; entry != drv + n_ents; entry++) {
		if (boot_device == entry->boot_device)
			return entry;
	}

	/* Not found */
	return NULL;
}

static int spl_load_image(struct spl_image_info *spl_image,
			  struct spl_image_loader *loader)
{
	struct spl_boot_device bootdev;

	bootdev.boot_device = loader->boot_device;
	bootdev.boot_device_name = NULL;

	return loader->load_image(spl_image, &bootdev);
}

/**
 * boot_from_devices() - Try loading an booting U-Boot from a list of devices
 *
 * @spl_image: Place to put the image details if successful
 * @spl_boot_list: List of boot devices to try
 * @count: Number of elements in spl_boot_list
 * @return 0 if OK, -ve on error
 */
static int boot_from_devices(struct spl_image_info *spl_image,
			     u32 spl_boot_list[], int count)
{
	int i;

	for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
		struct spl_image_loader *loader;

		loader = spl_ll_find_loader(spl_boot_list[i]);
#if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
		if (loader)
			printf("Trying to boot from %s\n", loader->name);
		else
			puts("SPL: Unsupported Boot Device!\n");
#endif
		if (loader && !spl_load_image(spl_image, loader))
			return 0;
	}

	return -ENODEV;
}

void board_init_r(gd_t *dummy1, ulong dummy2)
{
	u32 spl_boot_list[] = {
		BOOT_DEVICE_NONE,
		BOOT_DEVICE_NONE,
		BOOT_DEVICE_NONE,
		BOOT_DEVICE_NONE,
		BOOT_DEVICE_NONE,
	};
	struct spl_image_info spl_image;

	debug(">>spl:board_init_r()\n");

	spl_set_bd();

#ifdef CONFIG_SPL_OS_BOOT
	dram_init_banksize();
#endif

#if defined(CONFIG_SYS_SPL_MALLOC_START)
	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
			CONFIG_SYS_SPL_MALLOC_SIZE);
	gd->flags |= GD_FLG_FULL_MALLOC_INIT;
#endif
	if (!(gd->flags & GD_FLG_SPL_INIT)) {
		if (spl_init())
			hang();
	}
#if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
	/*
	 * timer_init() does not exist on PPC systems. The timer is initialized
	 * and enabled (decrementer) in interrupt_init() here.
	 */
	timer_init();
#endif

#ifdef CONFIG_SPL_BOARD_INIT
	spl_board_init();
#endif

	memset(&spl_image, '\0', sizeof(spl_image));
#ifdef CONFIG_SYS_SPL_ARGS_ADDR
	spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
#endif
	board_boot_order(spl_boot_list);

	if (boot_from_devices(&spl_image, spl_boot_list,
			      ARRAY_SIZE(spl_boot_list))) {
		puts("SPL: failed to boot from all boot devices\n");
		hang();
	}

#ifdef CONFIG_CPU_V7M
	spl_image.entry_point |= 0x1;
#endif
	switch (spl_image.os) {
	case IH_OS_U_BOOT:
		debug("Jumping to U-Boot\n");
		break;
#if CONFIG_IS_ENABLED(ATF)
	case IH_OS_ARM_TRUSTED_FIRMWARE:
		debug("Jumping to U-Boot via ARM Trusted Firmware\n");
		spl_invoke_atf(&spl_image);
		break;
#endif
#ifdef CONFIG_SPL_OS_BOOT
	case IH_OS_LINUX:
		debug("Jumping to Linux\n");
		spl_fixup_fdt();
		spl_board_prepare_for_linux();
		jump_to_image_linux(&spl_image);
#endif
	default:
		debug("Unsupported OS image.. Jumping nevertheless..\n");
	}
#if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
	debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
	      gd->malloc_ptr / 1024);
#endif
#ifdef CONFIG_BOOTSTAGE_STASH
	int ret;

	bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
	ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
			      CONFIG_BOOTSTAGE_STASH_SIZE);
	if (ret)
		debug("Failed to stash bootstage: err=%d\n", ret);
#endif

	debug("loaded - jumping to U-Boot...\n");
	spl_board_prepare_for_boot();
	jump_to_image_no_args(&spl_image);
}

/*
 * This requires UART clocks to be enabled.  In order for this to work the
 * caller must ensure that the gd pointer is valid.
 */
void preloader_console_init(void)
{
	gd->baudrate = CONFIG_BAUDRATE;

	serial_init();		/* serial communications setup */

	gd->have_console = 1;

	puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
			U_BOOT_TIME ")\n");
#ifdef CONFIG_SPL_DISPLAY_PRINT
	spl_display_print();
#endif
}

/**
 * spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
 *
 * Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
 * for the main board_init_r() execution. This is typically because we need
 * more stack space for things like the MMC sub-system.
 *
 * This function calculates the stack position, copies the global_data into
 * place, sets the new gd (except for ARM, for which setting GD within a C
 * function may not always work) and returns the new stack position. The
 * caller is responsible for setting up the sp register and, in the case
 * of ARM, setting up gd.
 *
 * All of this is done using the same layout and alignments as done in
 * board_init_f_init_reserve() / board_init_f_alloc_reserve().
 *
 * @return new stack location, or 0 to use the same stack
 */
ulong spl_relocate_stack_gd(void)
{
#ifdef CONFIG_SPL_STACK_R
	gd_t *new_gd;
	ulong ptr = CONFIG_SPL_STACK_R_ADDR;

#if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
	if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
		ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
		gd->malloc_base = ptr;
		gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
		gd->malloc_ptr = 0;
	}
#endif
	/* Get stack position: use 8-byte alignment for ABI compliance */
	ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
	new_gd = (gd_t *)ptr;
	memcpy(new_gd, (void *)gd, sizeof(gd_t));
#if CONFIG_IS_ENABLED(DM)
	dm_fixup_for_gd_move(new_gd);
#endif
#if !defined(CONFIG_ARM)
	gd = new_gd;
#endif
	return ptr;
#else
	return 0;
#endif
}
Commit	Line	Data
bcae7211 A	1	/*
	2	* (C) Copyright 2010
	3	* Texas Instruments, <www.ti.com>
	4	*
	5	* Aneesh V <aneesh@ti.com>
	6	*
1a459660	7	* SPDX-License-Identifier: GPL-2.0+
bcae7211	8	*/
f1c6e192	9
bcae7211	10	#include <common.h>
8bee2d25	11	#include <binman_sym.h>
11516518	12	#include <dm.h>
47f7bcae	13	#include <spl.h>
bcae7211	14	#include <asm/u-boot.h>
bb085b87	15	#include <nand.h>
8cf686e1	16	#include <fat.h>
efb2172e	17	#include <version.h>
8cf686e1	18	#include <image.h>
2d01dd95	19	#include <malloc.h>
11516518	20	#include <dm/root.h>
761ca31e	21	#include <linux/compiler.h>
6e7585bb	22	#include <fdt_support.h>
bcae7211 A	23
	24	DECLARE_GLOBAL_DATA_PTR;
	25
3c6f8a0d SR	26	#ifndef CONFIG_SYS_UBOOT_START
	27	#define CONFIG_SYS_UBOOT_START CONFIG_SYS_TEXT_BASE
	28	#endif
ae83d882	29	#ifndef CONFIG_SYS_MONITOR_LEN
e76caa62	30	/* Unknown U-Boot size, let's assume it will not be more than 200 KB */
ae83d882 SB	31	#define CONFIG_SYS_MONITOR_LEN (200 * 1024)
	32	#endif
	33
47f7bcae	34	u32 *boot_params_ptr = NULL;
9ea5c6ef	35
8bee2d25 SG	36	/* See spl.h for information about this */
	37	binman_sym_declare(ulong, u_boot_any, pos);
	38
6507f133	39	/* Define board data structure */
bcae7211 A	40	static bd_t bdata __attribute__ ((section(".data")));
bcae7211 A	41
496c5483 HS	42	/*
	43	* Board-specific Platform code can reimplement show_boot_progress () if needed
	44	*/
	45	__weak void show_boot_progress(int val) {}
	46
379c19ab SS	47	/*
	48	* Default function to determine if u-boot or the OS should
	49	* be started. This implementation always returns 1.
	50	*
	51	* Please implement your own board specific funcion to do this.
	52	*
	53	* RETURN
	54	* 0 to not start u-boot
	55	* positive if u-boot should start
	56	*/
	57	#ifdef CONFIG_SPL_OS_BOOT
	58	__weak int spl_start_uboot(void)
	59	{
026b2fe3 TR	60	puts("SPL: Please implement spl_start_uboot() for your board\n");
026b2fe3 TR	61	puts("SPL: Direct Linux boot not active!\n");
379c19ab SS	62	return 1;
379c19ab SS	63	}
431889d6	64
6e7585bb R	65	/* weak default platform specific function to initialize
	66	* dram banks
	67	*/
	68	__weak int dram_init_banksize(void)
	69	{
	70	return 0;
	71	}
	72
431889d6 LM	73	/*
	74	* Weak default function for arch specific zImage check. Return zero
	75	* and fill start and end address if image is recognized.
	76	*/
	77	int __weak bootz_setup(ulong image, ulong start, ulong end)
	78	{
	79	return 1;
	80	}
379c19ab SS	81	#endif
379c19ab SS	82
6e7585bb R	83	void spl_fixup_fdt(void)
	84	{
	85	#if defined(CONFIG_SPL_OF_LIBFDT) && defined(CONFIG_SYS_SPL_ARGS_ADDR)
	86	void fdt_blob = (void )CONFIG_SYS_SPL_ARGS_ADDR;
	87	int err;
	88
	89	err = fdt_check_header(fdt_blob);
	90	if (err < 0) {
	91	printf("fdt_root: %s\n", fdt_strerror(err));
	92	return;
	93	}
	94
	95	/* fixup the memory dt node */
	96	err = fdt_shrink_to_minimum(fdt_blob, 0);
	97	if (err == 0) {
	98	printf("spl: fdt_shrink_to_minimum err - %d\n", err);
	99	return;
	100	}
	101
	102	err = arch_fixup_fdt(fdt_blob);
	103	if (err) {
	104	printf("spl: arch_fixup_fdt err - %d\n", err);
	105	return;
	106	}
	107	#endif
	108	}
	109
ea8256f0 SR	110	/*
	111	* Weak default function for board specific cleanup/preparation before
	112	* Linux boot. Some boards/platforms might not need it, so just provide
	113	* an empty stub here.
	114	*/
	115	__weak void spl_board_prepare_for_linux(void)
	116	{
	117	/* Nothing to do! */
	118	}
	119
3a3b9147 MS	120	__weak void spl_board_prepare_for_boot(void)
	121	{
	122	/* Nothing to do! */
	123	}
	124
d95ceb97	125	void spl_set_header_raw_uboot(struct spl_image_info *spl_image)
0c3117b1	126	{
8bee2d25 SG	127	ulong u_boot_pos = binman_sym(ulong, u_boot_any, pos);
8bee2d25 SG	128
d95ceb97	129	spl_image->size = CONFIG_SYS_MONITOR_LEN;
8bee2d25 SG	130	if (u_boot_pos != BINMAN_SYM_MISSING) {
	131	/* biman does not support separate entry addresses at present */
	132	spl_image->entry_point = u_boot_pos;
	133	spl_image->load_addr = u_boot_pos;
	134	} else {
	135	spl_image->entry_point = CONFIG_SYS_UBOOT_START;
	136	spl_image->load_addr = CONFIG_SYS_TEXT_BASE;
	137	}
d95ceb97 SG	138	spl_image->os = IH_OS_U_BOOT;
d95ceb97 SG	139	spl_image->name = "U-Boot";
0c3117b1 HS	140	}
0c3117b1 HS	141
71316c1d SG	142	int spl_parse_image_header(struct spl_image_info *spl_image,
71316c1d SG	143	const struct image_header *header)
8cf686e1	144	{
77552b06	145	if (image_get_magic(header) == IH_MAGIC) {
722a6b17 AD	146	#ifdef CONFIG_SPL_LEGACY_IMAGE_SUPPORT
	147	u32 header_size = sizeof(struct image_header);
	148
71316c1d	149	if (spl_image->flags & SPL_COPY_PAYLOAD_ONLY) {
022b4975 SR	150	/*
	151	* On some system (e.g. powerpc), the load-address and
	152	* entry-point is located at address 0. We can't load
	153	* to 0-0x40. So skip header in this case.
	154	*/
71316c1d SG	155	spl_image->load_addr = image_get_load(header);
	156	spl_image->entry_point = image_get_ep(header);
	157	spl_image->size = image_get_data_size(header);
022b4975	158	} else {
71316c1d	159	spl_image->entry_point = image_get_load(header);
022b4975	160	/* Load including the header */
71316c1d	161	spl_image->load_addr = spl_image->entry_point -
022b4975	162	header_size;
71316c1d	163	spl_image->size = image_get_data_size(header) +
022b4975 SR	164	header_size;
022b4975 SR	165	}
71316c1d SG	166	spl_image->os = image_get_os(header);
71316c1d SG	167	spl_image->name = image_get_name(header);
11e1479b	168	debug("spl: payload image: %.*s load addr: 0x%lx size: %d\n",
3fe3839a	169	IH_NMLEN, spl_image->name,
71316c1d	170	spl_image->load_addr, spl_image->size);
722a6b17 AD	171	#else
722a6b17 AD	172	/* LEGACY image not supported */
2d2531be	173	debug("Legacy boot image support not enabled, proceeding to other boot methods\n");
722a6b17 AD	174	return -EINVAL;
722a6b17 AD	175	#endif
8cf686e1	176	} else {
8c80eb3b AA	177	#ifdef CONFIG_SPL_PANIC_ON_RAW_IMAGE
	178	/*
	179	* CONFIG_SPL_PANIC_ON_RAW_IMAGE is defined when the
	180	* code which loads images in SPL cannot guarantee that
	181	* absolutely all read errors will be reported.
	182	* An example is the LPC32XX MLC NAND driver, which
	183	* will consider that a completely unreadable NAND block
	184	* is bad, and thus should be skipped silently.
	185	*/
	186	panic("** no mkimage signature but raw image not supported");
85a37729 PK	187	#endif
85a37729 PK	188
431889d6 LM	189	#ifdef CONFIG_SPL_OS_BOOT
	190	ulong start, end;
	191
	192	if (!bootz_setup((ulong)header, &start, &end)) {
71316c1d SG	193	spl_image->name = "Linux";
	194	spl_image->os = IH_OS_LINUX;
	195	spl_image->load_addr = CONFIG_SYS_LOAD_ADDR;
	196	spl_image->entry_point = CONFIG_SYS_LOAD_ADDR;
	197	spl_image->size = end - start;
11e1479b	198	debug("spl: payload zImage, load addr: 0x%lx size: %d\n",
71316c1d	199	spl_image->load_addr, spl_image->size);
431889d6 LM	200	return 0;
	201	}
	202	#endif
85a37729	203
24eb39b5	204	#ifdef CONFIG_SPL_RAW_IMAGE_SUPPORT
8cf686e1	205	/* Signature not found - assume u-boot.bin */
026b2fe3	206	debug("mkimage signature not found - ih_magic = %x\n",
8cf686e1	207	header->ih_magic);
71316c1d	208	spl_set_header_raw_uboot(spl_image);
24eb39b5 AD	209	#else
24eb39b5 AD	210	/* RAW image not supported, proceed to other boot methods. */
2d2531be	211	debug("Raw boot image support not enabled, proceeding to other boot methods\n");
24eb39b5	212	return -EINVAL;
8c80eb3b	213	#endif
8cf686e1	214	}
24eb39b5	215
7e0f2267	216	return 0;
8cf686e1 A	217	}
8cf686e1 A	218
a759f1e0	219	__weak void __noreturn jump_to_image_no_args(struct spl_image_info *spl_image)
8cf686e1	220	{
4a0eb757 S	221	typedef void __noreturn (*image_entry_noargs_t)(void);
4a0eb757 S	222
8cf686e1	223	image_entry_noargs_t image_entry =
11e1479b	224	(image_entry_noargs_t)spl_image->entry_point;
8cf686e1	225
11e1479b	226	debug("image entry point: 0x%lX\n", spl_image->entry_point);
4a0eb757	227	image_entry();
8cf686e1 A	228	}
8cf686e1 A	229
340f418a	230	static int spl_common_init(bool setup_malloc)
bcae7211	231	{
f3d46bd6 SG	232	int ret;
f3d46bd6 SG	233
340f418a EC	234	debug("spl_early_init()\n");
340f418a EC	235
f1896c45	236	#if CONFIG_VAL(SYS_MALLOC_F_LEN)
340f418a	237	if (setup_malloc) {
94b9e22e	238	#ifdef CONFIG_MALLOC_F_ADDR
340f418a	239	gd->malloc_base = CONFIG_MALLOC_F_ADDR;
94b9e22e	240	#endif
f1896c45	241	gd->malloc_limit = CONFIG_VAL(SYS_MALLOC_F_LEN);
340f418a EC	242	gd->malloc_ptr = 0;
340f418a EC	243	}
24dafad5	244	#endif
824bb1b4 SG	245	ret = bootstage_init(true);
	246	if (ret) {
	247	debug("%s: Failed to set up bootstage: ret=%d\n", __func__,
	248	ret);
	249	return ret;
	250	}
	251	bootstage_mark_name(BOOTSTAGE_ID_START_SPL, "spl");
d223e0a8	252	if (CONFIG_IS_ENABLED(OF_CONTROL) && !CONFIG_IS_ENABLED(OF_PLATDATA)) {
f3d46bd6 SG	253	ret = fdtdec_setup();
	254	if (ret) {
	255	debug("fdtdec_setup() returned error %d\n", ret);
070d00b8	256	return ret;
f3d46bd6 SG	257	}
f3d46bd6 SG	258	}
f1c6e192	259	if (CONFIG_IS_ENABLED(DM)) {
824bb1b4	260	bootstage_start(BOOTSTATE_ID_ACCUM_DM_SPL, "dm_spl");
7f73ca48	261	/* With CONFIG_SPL_OF_PLATDATA, bring in all devices */
7d23b9cf	262	ret = dm_init_and_scan(!CONFIG_IS_ENABLED(OF_PLATDATA));
824bb1b4	263	bootstage_accum(BOOTSTATE_ID_ACCUM_DM_SPL);
f3d46bd6 SG	264	if (ret) {
f3d46bd6 SG	265	debug("dm_init_and_scan() returned error %d\n", ret);
070d00b8	266	return ret;
f3d46bd6 SG	267	}
f3d46bd6 SG	268	}
340f418a EC	269
	270	return 0;
	271	}
	272
d1fc0a31 YS	273	void spl_set_bd(void)
	274	{
	275	if (!gd->bd)
	276	gd->bd = &bdata;
	277	}
	278
340f418a EC	279	int spl_early_init(void)
	280	{
	281	int ret;
	282
	283	ret = spl_common_init(true);
	284	if (ret)
	285	return ret;
	286	gd->flags \|= GD_FLG_SPL_EARLY_INIT;
	287
	288	return 0;
	289	}
	290
	291	int spl_init(void)
	292	{
	293	int ret;
cf334edf TR	294	bool setup_malloc = !(IS_ENABLED(CONFIG_SPL_STACK_R) &&
cf334edf TR	295	IS_ENABLED(CONFIG_SPL_SYS_MALLOC_SIMPLE));
340f418a EC	296
340f418a EC	297	if (!(gd->flags & GD_FLG_SPL_EARLY_INIT)) {
cf334edf	298	ret = spl_common_init(setup_malloc);
340f418a EC	299	if (ret)
	300	return ret;
	301	}
070d00b8	302	gd->flags \|= GD_FLG_SPL_INIT;
2d01dd95	303
070d00b8 SG	304	return 0;
	305	}
	306
f101e4bd NK	307	#ifndef BOOT_DEVICE_NONE
	308	#define BOOT_DEVICE_NONE 0xdeadbeef
	309	#endif
	310
f101e4bd NK	311	__weak void board_boot_order(u32 *spl_boot_list)
	312	{
	313	spl_boot_list[0] = spl_boot_device();
	314	}
	315
a0a80290 SG	316	static struct spl_image_loader *spl_ll_find_loader(uint boot_device)
	317	{
	318	struct spl_image_loader *drv =
	319	ll_entry_start(struct spl_image_loader, spl_image_loader);
	320	const int n_ents =
	321	ll_entry_count(struct spl_image_loader, spl_image_loader);
	322	struct spl_image_loader *entry;
	323
	324	for (entry = drv; entry != drv + n_ents; entry++) {
	325	if (boot_device == entry->boot_device)
	326	return entry;
	327	}
	328
	329	/* Not found */
	330	return NULL;
	331	}
	332
29d357d7 SG	333	static int spl_load_image(struct spl_image_info *spl_image,
29d357d7 SG	334	struct spl_image_loader *loader)
070d00b8	335	{
ecdfd69a SG	336	struct spl_boot_device bootdev;
ecdfd69a SG	337
29d357d7	338	bootdev.boot_device = loader->boot_device;
ecdfd69a SG	339	bootdev.boot_device_name = NULL;
ecdfd69a SG	340
540bfe7d SG	341	return loader->load_image(spl_image, &bootdev);
	342	}
	343
	344	/**
	345	* boot_from_devices() - Try loading an booting U-Boot from a list of devices
	346	*
	347	* @spl_image: Place to put the image details if successful
	348	* @spl_boot_list: List of boot devices to try
	349	* @count: Number of elements in spl_boot_list
	350	* @return 0 if OK, -ve on error
	351	*/
	352	static int boot_from_devices(struct spl_image_info *spl_image,
	353	u32 spl_boot_list[], int count)
	354	{
	355	int i;
	356
	357	for (i = 0; i < count && spl_boot_list[i] != BOOT_DEVICE_NONE; i++) {
	358	struct spl_image_loader *loader;
	359
540bfe7d	360	loader = spl_ll_find_loader(spl_boot_list[i]);
18f26fdb	361	#if defined(CONFIG_SPL_SERIAL_SUPPORT) && defined(CONFIG_SPL_LIBCOMMON_SUPPORT)
2acf35db	362	if (loader)
cf947da1	363	printf("Trying to boot from %s\n", loader->name);
2acf35db	364	else
540bfe7d	365	puts("SPL: Unsupported Boot Device!\n");
18f26fdb	366	#endif
29d357d7	367	if (loader && !spl_load_image(spl_image, loader))
540bfe7d SG	368	return 0;
	369	}
	370
97d9df0a	371	return -ENODEV;
5211b87e NK	372	}
	373
	374	void board_init_r(gd_t *dummy1, ulong dummy2)
	375	{
d32b2d1c SG	376	u32 spl_boot_list[] = {
	377	BOOT_DEVICE_NONE,
	378	BOOT_DEVICE_NONE,
	379	BOOT_DEVICE_NONE,
	380	BOOT_DEVICE_NONE,
	381	BOOT_DEVICE_NONE,
	382	};
	383	struct spl_image_info spl_image;
5211b87e NK	384
5211b87e NK	385	debug(">>spl:board_init_r()\n");
d1fc0a31 YS	386
	387	spl_set_bd();
	388
6e7585bb R	389	#ifdef CONFIG_SPL_OS_BOOT
	390	dram_init_banksize();
	391	#endif
5211b87e NK	392
	393	#if defined(CONFIG_SYS_SPL_MALLOC_START)
	394	mem_malloc_init(CONFIG_SYS_SPL_MALLOC_START,
	395	CONFIG_SYS_SPL_MALLOC_SIZE);
	396	gd->flags \|= GD_FLG_FULL_MALLOC_INIT;
	397	#endif
	398	if (!(gd->flags & GD_FLG_SPL_INIT)) {
	399	if (spl_init())
	400	hang();
	401	}
f9d42d82	402	#if !defined(CONFIG_PPC) && !defined(CONFIG_ARCH_MX6)
5211b87e NK	403	/*
	404	* timer_init() does not exist on PPC systems. The timer is initialized
	405	* and enabled (decrementer) in interrupt_init() here.
	406	*/
	407	timer_init();
	408	#endif
	409
	410	#ifdef CONFIG_SPL_BOARD_INIT
	411	spl_board_init();
	412	#endif
	413
d32b2d1c	414	memset(&spl_image, '\0', sizeof(spl_image));
5bf5250e VM	415	#ifdef CONFIG_SYS_SPL_ARGS_ADDR
	416	spl_image.arg = (void *)CONFIG_SYS_SPL_ARGS_ADDR;
	417	#endif
f101e4bd	418	board_boot_order(spl_boot_list);
f101e4bd	419
540bfe7d SG	420	if (boot_from_devices(&spl_image, spl_boot_list,
540bfe7d SG	421	ARRAY_SIZE(spl_boot_list))) {
f101e4bd	422	puts("SPL: failed to boot from all boot devices\n");
5211b87e	423	hang();
f101e4bd	424	}
5211b87e	425
6bcdd66d VM	426	#ifdef CONFIG_CPU_V7M
	427	spl_image.entry_point \|= 0x1;
	428	#endif
9ea5c6ef	429	switch (spl_image.os) {
8cf686e1 A	430	case IH_OS_U_BOOT:
8cf686e1 A	431	debug("Jumping to U-Boot\n");
8cf686e1	432	break;
1d379090 PT	433	#if CONFIG_IS_ENABLED(ATF)
	434	case IH_OS_ARM_TRUSTED_FIRMWARE:
	435	debug("Jumping to U-Boot via ARM Trusted Firmware\n");
	436	spl_invoke_atf(&spl_image);
	437	break;
	438	#endif
379c19ab SS	439	#ifdef CONFIG_SPL_OS_BOOT
	440	case IH_OS_LINUX:
	441	debug("Jumping to Linux\n");
6e7585bb	442	spl_fixup_fdt();
379c19ab	443	spl_board_prepare_for_linux();
5bf5250e	444	jump_to_image_linux(&spl_image);
379c19ab	445	#endif
8cf686e1	446	default:
42120981	447	debug("Unsupported OS image.. Jumping nevertheless..\n");
8cf686e1	448	}
f1896c45	449	#if CONFIG_VAL(SYS_MALLOC_F_LEN) && !defined(CONFIG_SYS_SPL_MALLOC_SIZE)
fb4f5e7c SG	450	debug("SPL malloc() used %#lx bytes (%ld KB)\n", gd->malloc_ptr,
	451	gd->malloc_ptr / 1024);
	452	#endif
824bb1b4 SG	453	#ifdef CONFIG_BOOTSTAGE_STASH
	454	int ret;
	455
	456	bootstage_mark_name(BOOTSTAGE_ID_END_SPL, "end_spl");
	457	ret = bootstage_stash((void *)CONFIG_BOOTSTAGE_STASH_ADDR,
	458	CONFIG_BOOTSTAGE_STASH_SIZE);
	459	if (ret)
	460	debug("Failed to stash bootstage: err=%d\n", ret);
	461	#endif
a8c5112a	462
a8c5112a	463	debug("loaded - jumping to U-Boot...\n");
3a3b9147	464	spl_board_prepare_for_boot();
a759f1e0	465	jump_to_image_no_args(&spl_image);
bcae7211 A	466	}
bcae7211 A	467
6507f133 TR	468	/*
	469	* This requires UART clocks to be enabled. In order for this to work the
	470	* caller must ensure that the gd pointer is valid.
	471	*/
bcae7211 A	472	void preloader_console_init(void)
bcae7211 A	473	{
bcae7211 A	474	gd->baudrate = CONFIG_BAUDRATE;
bcae7211 A	475
bcae7211 A	476	serial_init(); /* serial communications setup */
bcae7211 A	477
b88befa5 IY	478	gd->have_console = 1;
b88befa5 IY	479
026b2fe3 TR	480	puts("\nU-Boot SPL " PLAIN_VERSION " (" U_BOOT_DATE " - " \
026b2fe3 TR	481	U_BOOT_TIME ")\n");
861a86f4 TR	482	#ifdef CONFIG_SPL_DISPLAY_PRINT
	483	spl_display_print();
	484	#endif
cc3f7058	485	}
db910353 SG	486
	487	/**
	488	* spl_relocate_stack_gd() - Relocate stack ready for board_init_r() execution
	489	*
	490	* Sometimes board_init_f() runs with a stack in SRAM but we want to use SDRAM
	491	* for the main board_init_r() execution. This is typically because we need
	492	* more stack space for things like the MMC sub-system.
	493	*
	494	* This function calculates the stack position, copies the global_data into
adc421e4 AA	495	* place, sets the new gd (except for ARM, for which setting GD within a C
	496	* function may not always work) and returns the new stack position. The
	497	* caller is responsible for setting up the sp register and, in the case
	498	* of ARM, setting up gd.
	499	*
	500	* All of this is done using the same layout and alignments as done in
	501	* board_init_f_init_reserve() / board_init_f_alloc_reserve().
db910353 SG	502	*
	503	* @return new stack location, or 0 to use the same stack
	504	*/
	505	ulong spl_relocate_stack_gd(void)
	506	{
	507	#ifdef CONFIG_SPL_STACK_R
	508	gd_t *new_gd;
adc421e4	509	ulong ptr = CONFIG_SPL_STACK_R_ADDR;
db910353	510
ae2cee2e	511	#if defined(CONFIG_SPL_SYS_MALLOC_SIMPLE) && CONFIG_VAL(SYS_MALLOC_F_LEN)
dcfcb8d4	512	if (CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN) {
dcfcb8d4 HG	513	ptr -= CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
	514	gd->malloc_base = ptr;
	515	gd->malloc_limit = CONFIG_SPL_STACK_R_MALLOC_SIMPLE_LEN;
	516	gd->malloc_ptr = 0;
	517	}
	518	#endif
adc421e4 AA	519	/* Get stack position: use 8-byte alignment for ABI compliance */
	520	ptr = CONFIG_SPL_STACK_R_ADDR - roundup(sizeof(gd_t),16);
	521	new_gd = (gd_t *)ptr;
	522	memcpy(new_gd, (void *)gd, sizeof(gd_t));
2f11cd91 SG	523	#if CONFIG_IS_ENABLED(DM)
	524	dm_fixup_for_gd_move(new_gd);
	525	#endif
adc421e4 AA	526	#if !defined(CONFIG_ARM)
	527	gd = new_gd;
	528	#endif
db910353 SG	529	return ptr;
	530	#else
	531	return 0;
	532	#endif
	533	}