[J-u-boot.git] / boot / bootm_os.c

// SPDX-License-Identifier: GPL-2.0+
/*
 * (C) Copyright 2000-2009
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 */

#include <common.h>
#include <bootm.h>
#include <bootstage.h>
#include <cpu_func.h>
#include <efi_loader.h>
#include <env.h>
#include <fdt_support.h>
#include <image.h>
#include <lmb.h>
#include <log.h>
#include <asm/global_data.h>
#include <linux/libfdt.h>
#include <malloc.h>
#include <mapmem.h>
#include <vxworks.h>
#include <tee/optee.h>

DECLARE_GLOBAL_DATA_PTR;

static int do_bootm_standalone(int flag, int argc, char *const argv[],
			       struct bootm_headers *images)
{
	int (*appl)(int, char *const[]);

	if (!env_get_autostart()) {
		env_set_hex("filesize", images->os.image_len);
		return 0;
	}
	appl = (int (*)(int, char * const []))images->ep;
	appl(argc, argv);
	return 0;
}

/*******************************************************************/
/* OS booting routines */
/*******************************************************************/

#if defined(CONFIG_BOOTM_NETBSD) || defined(CONFIG_BOOTM_PLAN9)
static void copy_args(char *dest, int argc, char *const argv[], char delim)
{
	int i;

	for (i = 0; i < argc; i++) {
		if (i > 0)
			*dest++ = delim;
		strcpy(dest, argv[i]);
		dest += strlen(argv[i]);
	}
}
#endif

static void __maybe_unused fit_unsupported_reset(const char *msg)
{
	if (CONFIG_IS_ENABLED(FIT_VERBOSE)) {
		printf("! FIT images not supported for '%s' - must reset board to recover!\n",
		       msg);
	}
}

#ifdef CONFIG_BOOTM_NETBSD
static int do_bootm_netbsd(int flag, int argc, char *const argv[],
			   struct bootm_headers *images)
{
	void (*loader)(struct bd_info *bd, struct legacy_img_hdr *hdr,
		       char *console, char *cmdline);
	struct legacy_img_hdr *os_hdr, *hdr;
	ulong kernel_data, kernel_len;
	char *cmdline;

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("NetBSD");
		return 1;
	}
#endif
	hdr = images->legacy_hdr_os;

	/*
	 * Booting a (NetBSD) kernel image
	 *
	 * This process is pretty similar to a standalone application:
	 * The (first part of an multi-) image must be a stage-2 loader,
	 * which in turn is responsible for loading & invoking the actual
	 * kernel.  The only differences are the parameters being passed:
	 * besides the board info strucure, the loader expects a command
	 * line, the name of the console device, and (optionally) the
	 * address of the original image header.
	 */
	os_hdr = NULL;
	if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
		image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
		if (kernel_len)
			os_hdr = hdr;
	}

	if (argc > 0) {
		ulong len;
		int   i;

		for (i = 0, len = 0; i < argc; i += 1)
			len += strlen(argv[i]) + 1;
		cmdline = malloc(len);
		copy_args(cmdline, argc, argv, ' ');
	} else {
		cmdline = env_get("bootargs");
		if (cmdline == NULL)
			cmdline = "";
	}

	loader = (void (*)(struct bd_info *, struct legacy_img_hdr *, char *, char *))images->ep;

	printf("## Transferring control to NetBSD stage-2 loader (at address %08lx) ...\n",
	       (ulong)loader);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * NetBSD Stage-2 Loader Parameters:
	 *   arg[0]: pointer to board info data
	 *   arg[1]: image load address
	 *   arg[2]: char pointer to the console device to use
	 *   arg[3]: char pointer to the boot arguments
	 */
	(*loader)(gd->bd, os_hdr, "", cmdline);

	return 1;
}
#endif /* CONFIG_BOOTM_NETBSD*/

#ifdef CONFIG_BOOTM_RTEMS
static int do_bootm_rtems(int flag, int argc, char *const argv[],
			  struct bootm_headers *images)
{
	void (*entry_point)(struct bd_info *);

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("RTEMS");
		return 1;
	}
#endif

	entry_point = (void (*)(struct bd_info *))images->ep;

	printf("## Transferring control to RTEMS (at address %08lx) ...\n",
	       (ulong)entry_point);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * RTEMS Parameters:
	 *   r3: ptr to board info data
	 */
	(*entry_point)(gd->bd);

	return 1;
}
#endif /* CONFIG_BOOTM_RTEMS */

#if defined(CONFIG_BOOTM_OSE)
static int do_bootm_ose(int flag, int argc, char *const argv[],
			struct bootm_headers *images)
{
	void (*entry_point)(void);

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("OSE");
		return 1;
	}
#endif

	entry_point = (void (*)(void))images->ep;

	printf("## Transferring control to OSE (at address %08lx) ...\n",
	       (ulong)entry_point);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * OSE Parameters:
	 *   None
	 */
	(*entry_point)();

	return 1;
}
#endif /* CONFIG_BOOTM_OSE */

#if defined(CONFIG_BOOTM_PLAN9)
static int do_bootm_plan9(int flag, int argc, char *const argv[],
			  struct bootm_headers *images)
{
	void (*entry_point)(void);
	char *s;

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("Plan 9");
		return 1;
	}
#endif

	/* See README.plan9 */
	s = env_get("confaddr");
	if (s != NULL) {
		char *confaddr = (char *)hextoul(s, NULL);

		if (argc > 0) {
			copy_args(confaddr, argc, argv, '\n');
		} else {
			s = env_get("bootargs");
			if (s != NULL)
				strcpy(confaddr, s);
		}
	}

	entry_point = (void (*)(void))images->ep;

	printf("## Transferring control to Plan 9 (at address %08lx) ...\n",
	       (ulong)entry_point);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * Plan 9 Parameters:
	 *   None
	 */
	(*entry_point)();

	return 1;
}
#endif /* CONFIG_BOOTM_PLAN9 */

#if defined(CONFIG_BOOTM_VXWORKS) && \
	(defined(CONFIG_PPC) || defined(CONFIG_ARM))

static void do_bootvx_fdt(struct bootm_headers *images)
{
#if defined(CONFIG_OF_LIBFDT)
	int ret;
	char *bootline;
	ulong of_size = images->ft_len;
	char **of_flat_tree = &images->ft_addr;
	struct lmb *lmb = &images->lmb;

	if (*of_flat_tree) {
		boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);

		ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
		if (ret)
			return;

		/* Update ethernet nodes */
		fdt_fixup_ethernet(*of_flat_tree);

		ret = fdt_add_subnode(*of_flat_tree, 0, "chosen");
		if ((ret >= 0 || ret == -FDT_ERR_EXISTS)) {
			bootline = env_get("bootargs");
			if (bootline) {
				ret = fdt_find_and_setprop(*of_flat_tree,
						"/chosen", "bootargs",
						bootline,
						strlen(bootline) + 1, 1);
				if (ret < 0) {
					printf("## ERROR: %s : %s\n", __func__,
					       fdt_strerror(ret));
					return;
				}
			}
		} else {
			printf("## ERROR: %s : %s\n", __func__,
			       fdt_strerror(ret));
			return;
		}
	}
#endif

	boot_prep_vxworks(images);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

#if defined(CONFIG_OF_LIBFDT)
	printf("## Starting vxWorks at 0x%08lx, device tree at 0x%08lx ...\n",
	       (ulong)images->ep, (ulong)*of_flat_tree);
#else
	printf("## Starting vxWorks at 0x%08lx\n", (ulong)images->ep);
#endif
	flush();

	boot_jump_vxworks(images);

	puts("## vxWorks terminated\n");
}

static int do_bootm_vxworks_legacy(int flag, int argc, char *const argv[],
				   struct bootm_headers *images)
{
	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("VxWorks");
		return 1;
	}
#endif

	do_bootvx_fdt(images);

	return 1;
}

int do_bootm_vxworks(int flag, int argc, char *const argv[],
		     struct bootm_headers *images)
{
	char *bootargs;
	int pos;
	unsigned long vxflags;
	bool std_dtb = false;

	/* get bootargs env */
	bootargs = env_get("bootargs");

	if (bootargs != NULL) {
		for (pos = 0; pos < strlen(bootargs); pos++) {
			/* find f=0xnumber flag */
			if ((bootargs[pos] == '=') && (pos >= 1) &&
			    (bootargs[pos - 1] == 'f')) {
				vxflags = hextoul(&bootargs[pos + 1], NULL);
				if (vxflags & VXWORKS_SYSFLG_STD_DTB)
					std_dtb = true;
			}
		}
	}

	if (std_dtb) {
		if (flag & BOOTM_STATE_OS_PREP)
			printf("   Using standard DTB\n");
		return do_bootm_linux(flag, argc, argv, images);
	} else {
		if (flag & BOOTM_STATE_OS_PREP)
			printf("   !!! WARNING !!! Using legacy DTB\n");
		return do_bootm_vxworks_legacy(flag, argc, argv, images);
	}
}
#endif

#if defined(CONFIG_CMD_ELF)
static int do_bootm_qnxelf(int flag, int argc, char *const argv[],
			   struct bootm_headers *images)
{
	char *local_args[2];
	char str[16];
	int dcache;

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("QNX");
		return 1;
	}
#endif

	sprintf(str, "%lx", images->ep); /* write entry-point into string */
	local_args[0] = argv[0];
	local_args[1] = str;	/* and provide it via the arguments */

	/*
	 * QNX images require the data cache is disabled.
	 */
	dcache = dcache_status();
	if (dcache)
		dcache_disable();

	do_bootelf(NULL, 0, 2, local_args);

	if (dcache)
		dcache_enable();

	return 1;
}
#endif

#ifdef CONFIG_INTEGRITY
static int do_bootm_integrity(int flag, int argc, char *const argv[],
			      struct bootm_headers *images)
{
	void (*entry_point)(void);

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

#if defined(CONFIG_FIT)
	if (!images->legacy_hdr_valid) {
		fit_unsupported_reset("INTEGRITY");
		return 1;
	}
#endif

	entry_point = (void (*)(void))images->ep;

	printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
	       (ulong)entry_point);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * INTEGRITY Parameters:
	 *   None
	 */
	(*entry_point)();

	return 1;
}
#endif

#ifdef CONFIG_BOOTM_OPENRTOS
static int do_bootm_openrtos(int flag, int argc, char *const argv[],
			     struct bootm_headers *images)
{
	void (*entry_point)(void);

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

	entry_point = (void (*)(void))images->ep;

	printf("## Transferring control to OpenRTOS (at address %08lx) ...\n",
		(ulong)entry_point);

	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/*
	 * OpenRTOS Parameters:
	 *   None
	 */
	(*entry_point)();

	return 1;
}
#endif

#ifdef CONFIG_BOOTM_OPTEE
static int do_bootm_tee(int flag, int argc, char *const argv[],
			struct bootm_headers *images)
{
	int ret;

	/* Verify OS type */
	if (images->os.os != IH_OS_TEE) {
		return 1;
	};

	/* Validate OPTEE header */
	ret = optee_verify_bootm_image(images->os.image_start,
				       images->os.load,
				       images->os.image_len);
	if (ret)
		return ret;

	/* Locate FDT etc */
	ret = bootm_find_images(flag, argc, argv, 0, 0);
	if (ret)
		return ret;

	/* From here we can run the regular linux boot path */
	return do_bootm_linux(flag, argc, argv, images);
}
#endif

#ifdef CONFIG_BOOTM_EFI
static int do_bootm_efi(int flag, int argc, char *const argv[],
			struct bootm_headers *images)
{
	int ret;
	efi_status_t efi_ret;
	void *image_buf;

	if (flag != BOOTM_STATE_OS_GO)
		return 0;

	/* Locate FDT, if provided */
	ret = bootm_find_images(flag, argc, argv, 0, 0);
	if (ret)
		return ret;

	/* Initialize EFI drivers */
	efi_ret = efi_init_obj_list();
	if (efi_ret != EFI_SUCCESS) {
		printf("## Failed to initialize UEFI sub-system: r = %lu\n",
		       efi_ret & ~EFI_ERROR_MASK);
		return 1;
	}

	/* Install device tree */
	efi_ret = efi_install_fdt(images->ft_len
				  ? images->ft_addr : EFI_FDT_USE_INTERNAL);
	if (efi_ret != EFI_SUCCESS) {
		printf("## Failed to install device tree: r = %lu\n",
		       efi_ret & ~EFI_ERROR_MASK);
		return 1;
	}

	/* Run EFI image */
	printf("## Transferring control to EFI (at address %08lx) ...\n",
	       images->ep);
	bootstage_mark(BOOTSTAGE_ID_RUN_OS);

	/* We expect to return */
	images->os.type = IH_TYPE_STANDALONE;

	image_buf = map_sysmem(images->ep, images->os.image_len);

	efi_ret = efi_run_image(image_buf, images->os.image_len);
	if (efi_ret != EFI_SUCCESS)
		return 1;
	return 0;
}
#endif

static boot_os_fn *boot_os[] = {
	[IH_OS_U_BOOT] = do_bootm_standalone,
#ifdef CONFIG_BOOTM_LINUX
	[IH_OS_LINUX] = do_bootm_linux,
#endif
#ifdef CONFIG_BOOTM_NETBSD
	[IH_OS_NETBSD] = do_bootm_netbsd,
#endif
#ifdef CONFIG_BOOTM_RTEMS
	[IH_OS_RTEMS] = do_bootm_rtems,
#endif
#if defined(CONFIG_BOOTM_OSE)
	[IH_OS_OSE] = do_bootm_ose,
#endif
#if defined(CONFIG_BOOTM_PLAN9)
	[IH_OS_PLAN9] = do_bootm_plan9,
#endif
#if defined(CONFIG_BOOTM_VXWORKS) && \
	(defined(CONFIG_PPC) || defined(CONFIG_ARM) || defined(CONFIG_RISCV))
	[IH_OS_VXWORKS] = do_bootm_vxworks,
#endif
#if defined(CONFIG_CMD_ELF)
	[IH_OS_QNX] = do_bootm_qnxelf,
#endif
#ifdef CONFIG_INTEGRITY
	[IH_OS_INTEGRITY] = do_bootm_integrity,
#endif
#ifdef CONFIG_BOOTM_OPENRTOS
	[IH_OS_OPENRTOS] = do_bootm_openrtos,
#endif
#ifdef CONFIG_BOOTM_OPTEE
	[IH_OS_TEE] = do_bootm_tee,
#endif
#ifdef CONFIG_BOOTM_EFI
	[IH_OS_EFI] = do_bootm_efi,
#endif
};

/* Allow for arch specific config before we boot */
__weak void arch_preboot_os(void)
{
	/* please define platform specific arch_preboot_os() */
}

/* Allow for board specific config before we boot */
__weak void board_preboot_os(void)
{
	/* please define board specific board_preboot_os() */
}

int boot_selected_os(int argc, char *const argv[], int state,
		     struct bootm_headers *images, boot_os_fn *boot_fn)
{
	arch_preboot_os();
	board_preboot_os();
	boot_fn(state, argc, argv, images);

	/* Stand-alone may return when 'autostart' is 'no' */
	if (images->os.type == IH_TYPE_STANDALONE ||
	    IS_ENABLED(CONFIG_SANDBOX) ||
	    state == BOOTM_STATE_OS_FAKE_GO) /* We expect to return */
		return 0;
	bootstage_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
	debug("\n## Control returned to monitor - resetting...\n");

	return BOOTM_ERR_RESET;
}

boot_os_fn *bootm_os_get_boot_func(int os)
{
#ifdef CONFIG_NEEDS_MANUAL_RELOC
	static bool relocated;

	if (!relocated) {
		int i;

		/* relocate boot function table */
		for (i = 0; i < ARRAY_SIZE(boot_os); i++)
			if (boot_os[i] != NULL)
				boot_os[i] += gd->reloc_off;

		relocated = true;
	}
#endif
	return boot_os[os];
}
Commit	Line	Data
83d290c5	1	// SPDX-License-Identifier: GPL-2.0+
b6396403 SG	2	/*
	3	* (C) Copyright 2000-2009
	4	* Wolfgang Denk, DENX Software Engineering, [email protected].
b6396403 SG	5	*/
	6
	7	#include <common.h>
	8	#include <bootm.h>
52f24238	9	#include <bootstage.h>
9edefc27	10	#include <cpu_func.h>
ecc7fdaa	11	#include <efi_loader.h>
c7694dd4	12	#include <env.h>
b6396403	13	#include <fdt_support.h>
4d72caa5 SG	14	#include <image.h>
4d72caa5 SG	15	#include <lmb.h>
f7ae49fc	16	#include <log.h>
401d1c4f	17	#include <asm/global_data.h>
b08c8c48	18	#include <linux/libfdt.h>
b6396403	19	#include <malloc.h>
ecc7fdaa	20	#include <mapmem.h>
b6396403	21	#include <vxworks.h>
c225e7cf	22	#include <tee/optee.h>
b6396403 SG	23
	24	DECLARE_GLOBAL_DATA_PTR;
	25
09140113	26	static int do_bootm_standalone(int flag, int argc, char *const argv[],
d9d7c20b	27	struct bootm_headers *images)
b6396403	28	{
b6396403 SG	29	int (appl)(int, char const[]);
b6396403 SG	30
78398652	31	if (!env_get_autostart()) {
018f5303	32	env_set_hex("filesize", images->os.image_len);
b6396403 SG	33	return 0;
	34	}
	35	appl = (int ()(int, char const []))images->ep;
	36	appl(argc, argv);
	37	return 0;
	38	}
	39
	40	/*******************************************************************/
	41	/* OS booting routines */
	42	/*******************************************************************/
	43
	44	#if defined(CONFIG_BOOTM_NETBSD) \|\| defined(CONFIG_BOOTM_PLAN9)
09140113	45	static void copy_args(char dest, int argc, char const argv[], char delim)
b6396403 SG	46	{
	47	int i;
	48
	49	for (i = 0; i < argc; i++) {
	50	if (i > 0)
	51	*dest++ = delim;
	52	strcpy(dest, argv[i]);
	53	dest += strlen(argv[i]);
	54	}
	55	}
	56	#endif
	57
0ab5e027 SG	58	static void __maybe_unused fit_unsupported_reset(const char *msg)
	59	{
	60	if (CONFIG_IS_ENABLED(FIT_VERBOSE)) {
	61	printf("! FIT images not supported for '%s' - must reset board to recover!\n",
	62	msg);
	63	}
	64	}
	65
b6396403	66	#ifdef CONFIG_BOOTM_NETBSD
09140113	67	static int do_bootm_netbsd(int flag, int argc, char *const argv[],
d9d7c20b	68	struct bootm_headers *images)
b6396403	69	{
f3543e69 SG	70	void (loader)(struct bd_info bd, struct legacy_img_hdr *hdr,
	71	char console, char cmdline);
	72	struct legacy_img_hdr os_hdr, hdr;
b6396403	73	ulong kernel_data, kernel_len;
b6396403 SG	74	char *cmdline;
	75
	76	if (flag != BOOTM_STATE_OS_GO)
	77	return 0;
	78
	79	#if defined(CONFIG_FIT)
	80	if (!images->legacy_hdr_valid) {
	81	fit_unsupported_reset("NetBSD");
	82	return 1;
	83	}
	84	#endif
	85	hdr = images->legacy_hdr_os;
	86
	87	/*
	88	* Booting a (NetBSD) kernel image
	89	*
	90	* This process is pretty similar to a standalone application:
	91	* The (first part of an multi-) image must be a stage-2 loader,
	92	* which in turn is responsible for loading & invoking the actual
	93	* kernel. The only differences are the parameters being passed:
	94	* besides the board info strucure, the loader expects a command
	95	* line, the name of the console device, and (optionally) the
	96	* address of the original image header.
	97	*/
	98	os_hdr = NULL;
	99	if (image_check_type(&images->legacy_hdr_os_copy, IH_TYPE_MULTI)) {
	100	image_multi_getimg(hdr, 1, &kernel_data, &kernel_len);
	101	if (kernel_len)
	102	os_hdr = hdr;
	103	}
	104
b6396403 SG	105	if (argc > 0) {
	106	ulong len;
	107	int i;
	108
	109	for (i = 0, len = 0; i < argc; i += 1)
	110	len += strlen(argv[i]) + 1;
	111	cmdline = malloc(len);
	112	copy_args(cmdline, argc, argv, ' ');
	113	} else {
00caae6d	114	cmdline = env_get("bootargs");
b6396403 SG	115	if (cmdline == NULL)
	116	cmdline = "";
	117	}
	118
f3543e69	119	loader = (void ()(struct bd_info , struct legacy_img_hdr , char , char *))images->ep;
b6396403 SG	120
	121	printf("## Transferring control to NetBSD stage-2 loader (at address %08lx) ...\n",
	122	(ulong)loader);
	123
	124	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	125
	126	/*
	127	* NetBSD Stage-2 Loader Parameters:
	128	* arg[0]: pointer to board info data
	129	* arg[1]: image load address
	130	* arg[2]: char pointer to the console device to use
	131	* arg[3]: char pointer to the boot arguments
	132	*/
5b8e76c3	133	(*loader)(gd->bd, os_hdr, "", cmdline);
b6396403 SG	134
	135	return 1;
	136	}
	137	#endif /* CONFIG_BOOTM_NETBSD*/
	138
b6396403	139	#ifdef CONFIG_BOOTM_RTEMS
09140113	140	static int do_bootm_rtems(int flag, int argc, char *const argv[],
d9d7c20b	141	struct bootm_headers *images)
b6396403	142	{
b75d8dc5	143	void (entry_point)(struct bd_info );
b6396403 SG	144
	145	if (flag != BOOTM_STATE_OS_GO)
	146	return 0;
	147
	148	#if defined(CONFIG_FIT)
	149	if (!images->legacy_hdr_valid) {
	150	fit_unsupported_reset("RTEMS");
	151	return 1;
	152	}
	153	#endif
	154
b75d8dc5	155	entry_point = (void ()(struct bd_info ))images->ep;
b6396403 SG	156
	157	printf("## Transferring control to RTEMS (at address %08lx) ...\n",
	158	(ulong)entry_point);
	159
	160	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	161
	162	/*
	163	* RTEMS Parameters:
	164	* r3: ptr to board info data
	165	*/
	166	(*entry_point)(gd->bd);
	167
	168	return 1;
	169	}
	170	#endif /* CONFIG_BOOTM_RTEMS */
	171
	172	#if defined(CONFIG_BOOTM_OSE)
09140113	173	static int do_bootm_ose(int flag, int argc, char *const argv[],
d9d7c20b	174	struct bootm_headers *images)
b6396403 SG	175	{
	176	void (*entry_point)(void);
	177
	178	if (flag != BOOTM_STATE_OS_GO)
	179	return 0;
	180
	181	#if defined(CONFIG_FIT)
	182	if (!images->legacy_hdr_valid) {
	183	fit_unsupported_reset("OSE");
	184	return 1;
	185	}
	186	#endif
	187
	188	entry_point = (void (*)(void))images->ep;
	189
	190	printf("## Transferring control to OSE (at address %08lx) ...\n",
	191	(ulong)entry_point);
	192
	193	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	194
	195	/*
	196	* OSE Parameters:
	197	* None
	198	*/
	199	(*entry_point)();
	200
	201	return 1;
	202	}
	203	#endif /* CONFIG_BOOTM_OSE */
	204
	205	#if defined(CONFIG_BOOTM_PLAN9)
09140113	206	static int do_bootm_plan9(int flag, int argc, char *const argv[],
d9d7c20b	207	struct bootm_headers *images)
b6396403 SG	208	{
	209	void (*entry_point)(void);
	210	char *s;
	211
	212	if (flag != BOOTM_STATE_OS_GO)
	213	return 0;
	214
	215	#if defined(CONFIG_FIT)
	216	if (!images->legacy_hdr_valid) {
	217	fit_unsupported_reset("Plan 9");
	218	return 1;
	219	}
	220	#endif
	221
	222	/* See README.plan9 */
00caae6d	223	s = env_get("confaddr");
b6396403	224	if (s != NULL) {
7e5f460e	225	char confaddr = (char )hextoul(s, NULL);
b6396403 SG	226
	227	if (argc > 0) {
	228	copy_args(confaddr, argc, argv, '\n');
	229	} else {
00caae6d	230	s = env_get("bootargs");
b6396403 SG	231	if (s != NULL)
	232	strcpy(confaddr, s);
	233	}
	234	}
	235
	236	entry_point = (void (*)(void))images->ep;
	237
	238	printf("## Transferring control to Plan 9 (at address %08lx) ...\n",
	239	(ulong)entry_point);
	240
	241	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	242
	243	/*
	244	* Plan 9 Parameters:
	245	* None
	246	*/
	247	(*entry_point)();
	248
	249	return 1;
	250	}
	251	#endif /* CONFIG_BOOTM_PLAN9 */
	252
	253	#if defined(CONFIG_BOOTM_VXWORKS) && \
	254	(defined(CONFIG_PPC) \|\| defined(CONFIG_ARM))
	255
d9d7c20b	256	static void do_bootvx_fdt(struct bootm_headers *images)
b6396403 SG	257	{
	258	#if defined(CONFIG_OF_LIBFDT)
	259	int ret;
	260	char *bootline;
	261	ulong of_size = images->ft_len;
	262	char **of_flat_tree = &images->ft_addr;
	263	struct lmb *lmb = &images->lmb;
	264
	265	if (*of_flat_tree) {
	266	boot_fdt_add_mem_rsv_regions(lmb, *of_flat_tree);
	267
	268	ret = boot_relocate_fdt(lmb, of_flat_tree, &of_size);
	269	if (ret)
	270	return;
	271
a223e2bc HS	272	/* Update ethernet nodes */
	273	fdt_fixup_ethernet(*of_flat_tree);
	274
b6396403 SG	275	ret = fdt_add_subnode(*of_flat_tree, 0, "chosen");
b6396403 SG	276	if ((ret >= 0 \|\| ret == -FDT_ERR_EXISTS)) {
00caae6d	277	bootline = env_get("bootargs");
b6396403 SG	278	if (bootline) {
	279	ret = fdt_find_and_setprop(*of_flat_tree,
	280	"/chosen", "bootargs",
	281	bootline,
	282	strlen(bootline) + 1, 1);
	283	if (ret < 0) {
	284	printf("## ERROR: %s : %s\n", __func__,
	285	fdt_strerror(ret));
	286	return;
	287	}
	288	}
	289	} else {
	290	printf("## ERROR: %s : %s\n", __func__,
	291	fdt_strerror(ret));
	292	return;
	293	}
	294	}
	295	#endif
	296
	297	boot_prep_vxworks(images);
	298
	299	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	300
	301	#if defined(CONFIG_OF_LIBFDT)
	302	printf("## Starting vxWorks at 0x%08lx, device tree at 0x%08lx ...\n",
	303	(ulong)images->ep, (ulong)*of_flat_tree);
	304	#else
	305	printf("## Starting vxWorks at 0x%08lx\n", (ulong)images->ep);
	306	#endif
efc3f952	307	flush();
b6396403 SG	308
	309	boot_jump_vxworks(images);
	310
	311	puts("## vxWorks terminated\n");
	312	}
	313
09140113	314	static int do_bootm_vxworks_legacy(int flag, int argc, char *const argv[],
d9d7c20b	315	struct bootm_headers *images)
b6396403 SG	316	{
	317	if (flag != BOOTM_STATE_OS_GO)
	318	return 0;
	319
	320	#if defined(CONFIG_FIT)
	321	if (!images->legacy_hdr_valid) {
	322	fit_unsupported_reset("VxWorks");
	323	return 1;
	324	}
	325	#endif
	326
	327	do_bootvx_fdt(images);
	328
	329	return 1;
	330	}
1e26f648	331
09140113	332	int do_bootm_vxworks(int flag, int argc, char *const argv[],
d9d7c20b	333	struct bootm_headers *images)
1e26f648 LZ	334	{
	335	char *bootargs;
	336	int pos;
	337	unsigned long vxflags;
	338	bool std_dtb = false;
	339
	340	/* get bootargs env */
	341	bootargs = env_get("bootargs");
	342
	343	if (bootargs != NULL) {
	344	for (pos = 0; pos < strlen(bootargs); pos++) {
	345	/* find f=0xnumber flag */
	346	if ((bootargs[pos] == '=') && (pos >= 1) &&
	347	(bootargs[pos - 1] == 'f')) {
7e5f460e	348	vxflags = hextoul(&bootargs[pos + 1], NULL);
1e26f648 LZ	349	if (vxflags & VXWORKS_SYSFLG_STD_DTB)
	350	std_dtb = true;
	351	}
	352	}
	353	}
	354
	355	if (std_dtb) {
	356	if (flag & BOOTM_STATE_OS_PREP)
	357	printf(" Using standard DTB\n");
	358	return do_bootm_linux(flag, argc, argv, images);
	359	} else {
	360	if (flag & BOOTM_STATE_OS_PREP)
	361	printf(" !!! WARNING !!! Using legacy DTB\n");
	362	return do_bootm_vxworks_legacy(flag, argc, argv, images);
	363	}
	364	}
b6396403 SG	365	#endif
	366
	367	#if defined(CONFIG_CMD_ELF)
09140113	368	static int do_bootm_qnxelf(int flag, int argc, char *const argv[],
d9d7c20b	369	struct bootm_headers *images)
b6396403 SG	370	{
	371	char *local_args[2];
	372	char str[16];
995eab8b	373	int dcache;
b6396403 SG	374
	375	if (flag != BOOTM_STATE_OS_GO)
	376	return 0;
	377
	378	#if defined(CONFIG_FIT)
	379	if (!images->legacy_hdr_valid) {
	380	fit_unsupported_reset("QNX");
	381	return 1;
	382	}
	383	#endif
	384
	385	sprintf(str, "%lx", images->ep); /* write entry-point into string */
	386	local_args[0] = argv[0];
	387	local_args[1] = str; /* and provide it via the arguments */
995eab8b EV	388
	389	/*
	390	* QNX images require the data cache is disabled.
	391	*/
	392	dcache = dcache_status();
	393	if (dcache)
	394	dcache_disable();
	395
b6396403 SG	396	do_bootelf(NULL, 0, 2, local_args);
b6396403 SG	397
995eab8b EV	398	if (dcache)
	399	dcache_enable();
	400
b6396403 SG	401	return 1;
	402	}
	403	#endif
	404
	405	#ifdef CONFIG_INTEGRITY
09140113	406	static int do_bootm_integrity(int flag, int argc, char *const argv[],
d9d7c20b	407	struct bootm_headers *images)
b6396403 SG	408	{
	409	void (*entry_point)(void);
	410
	411	if (flag != BOOTM_STATE_OS_GO)
	412	return 0;
	413
	414	#if defined(CONFIG_FIT)
	415	if (!images->legacy_hdr_valid) {
	416	fit_unsupported_reset("INTEGRITY");
	417	return 1;
	418	}
	419	#endif
	420
	421	entry_point = (void (*)(void))images->ep;
	422
	423	printf("## Transferring control to INTEGRITY (at address %08lx) ...\n",
	424	(ulong)entry_point);
	425
	426	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	427
	428	/*
	429	* INTEGRITY Parameters:
	430	* None
	431	*/
	432	(*entry_point)();
	433
	434	return 1;
	435	}
	436	#endif
	437
67ddd955	438	#ifdef CONFIG_BOOTM_OPENRTOS
09140113	439	static int do_bootm_openrtos(int flag, int argc, char *const argv[],
d9d7c20b	440	struct bootm_headers *images)
67ddd955 MV	441	{
	442	void (*entry_point)(void);
	443
	444	if (flag != BOOTM_STATE_OS_GO)
	445	return 0;
	446
	447	entry_point = (void (*)(void))images->ep;
	448
	449	printf("## Transferring control to OpenRTOS (at address %08lx) ...\n",
	450	(ulong)entry_point);
	451
	452	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	453
	454	/*
	455	* OpenRTOS Parameters:
	456	* None
	457	*/
	458	(*entry_point)();
	459
	460	return 1;
	461	}
	462	#endif
	463
c225e7cf	464	#ifdef CONFIG_BOOTM_OPTEE
09140113	465	static int do_bootm_tee(int flag, int argc, char *const argv[],
d9d7c20b	466	struct bootm_headers *images)
c225e7cf BD	467	{
	468	int ret;
	469
	470	/* Verify OS type */
	471	if (images->os.os != IH_OS_TEE) {
	472	return 1;
	473	};
	474
	475	/* Validate OPTEE header */
	476	ret = optee_verify_bootm_image(images->os.image_start,
	477	images->os.load,
	478	images->os.image_len);
	479	if (ret)
	480	return ret;
	481
	482	/* Locate FDT etc */
fbde7589	483	ret = bootm_find_images(flag, argc, argv, 0, 0);
c225e7cf BD	484	if (ret)
	485	return ret;
	486
	487	/* From here we can run the regular linux boot path */
	488	return do_bootm_linux(flag, argc, argv, images);
	489	}
	490	#endif
	491
ecc7fdaa	492	#ifdef CONFIG_BOOTM_EFI
09140113	493	static int do_bootm_efi(int flag, int argc, char *const argv[],
d9d7c20b	494	struct bootm_headers *images)
ecc7fdaa CC	495	{
	496	int ret;
	497	efi_status_t efi_ret;
	498	void *image_buf;
	499
	500	if (flag != BOOTM_STATE_OS_GO)
	501	return 0;
	502
	503	/* Locate FDT, if provided */
fbde7589	504	ret = bootm_find_images(flag, argc, argv, 0, 0);
ecc7fdaa CC	505	if (ret)
	506	return ret;
	507
	508	/* Initialize EFI drivers */
	509	efi_ret = efi_init_obj_list();
	510	if (efi_ret != EFI_SUCCESS) {
	511	printf("## Failed to initialize UEFI sub-system: r = %lu\n",
	512	efi_ret & ~EFI_ERROR_MASK);
	513	return 1;
	514	}
	515
	516	/* Install device tree */
	517	efi_ret = efi_install_fdt(images->ft_len
	518	? images->ft_addr : EFI_FDT_USE_INTERNAL);
	519	if (efi_ret != EFI_SUCCESS) {
	520	printf("## Failed to install device tree: r = %lu\n",
	521	efi_ret & ~EFI_ERROR_MASK);
	522	return 1;
	523	}
	524
	525	/* Run EFI image */
	526	printf("## Transferring control to EFI (at address %08lx) ...\n",
	527	images->ep);
	528	bootstage_mark(BOOTSTAGE_ID_RUN_OS);
	529
bf758125 HS	530	/* We expect to return */
	531	images->os.type = IH_TYPE_STANDALONE;
	532
ecc7fdaa CC	533	image_buf = map_sysmem(images->ep, images->os.image_len);
	534
	535	efi_ret = efi_run_image(image_buf, images->os.image_len);
bf758125	536	if (efi_ret != EFI_SUCCESS)
ecc7fdaa	537	return 1;
ecc7fdaa CC	538	return 0;
	539	}
	540	#endif
	541
b6396403 SG	542	static boot_os_fn *boot_os[] = {
	543	[IH_OS_U_BOOT] = do_bootm_standalone,
	544	#ifdef CONFIG_BOOTM_LINUX
	545	[IH_OS_LINUX] = do_bootm_linux,
	546	#endif
	547	#ifdef CONFIG_BOOTM_NETBSD
	548	[IH_OS_NETBSD] = do_bootm_netbsd,
	549	#endif
b6396403 SG	550	#ifdef CONFIG_BOOTM_RTEMS
	551	[IH_OS_RTEMS] = do_bootm_rtems,
	552	#endif
	553	#if defined(CONFIG_BOOTM_OSE)
	554	[IH_OS_OSE] = do_bootm_ose,
	555	#endif
	556	#if defined(CONFIG_BOOTM_PLAN9)
	557	[IH_OS_PLAN9] = do_bootm_plan9,
	558	#endif
	559	#if defined(CONFIG_BOOTM_VXWORKS) && \
08337cd6	560	(defined(CONFIG_PPC) \|\| defined(CONFIG_ARM) \|\| defined(CONFIG_RISCV))
b6396403 SG	561	[IH_OS_VXWORKS] = do_bootm_vxworks,
	562	#endif
	563	#if defined(CONFIG_CMD_ELF)
	564	[IH_OS_QNX] = do_bootm_qnxelf,
	565	#endif
	566	#ifdef CONFIG_INTEGRITY
	567	[IH_OS_INTEGRITY] = do_bootm_integrity,
	568	#endif
67ddd955 MV	569	#ifdef CONFIG_BOOTM_OPENRTOS
	570	[IH_OS_OPENRTOS] = do_bootm_openrtos,
	571	#endif
c225e7cf BD	572	#ifdef CONFIG_BOOTM_OPTEE
	573	[IH_OS_TEE] = do_bootm_tee,
	574	#endif
ecc7fdaa CC	575	#ifdef CONFIG_BOOTM_EFI
	576	[IH_OS_EFI] = do_bootm_efi,
	577	#endif
b6396403 SG	578	};
	579
	580	/* Allow for arch specific config before we boot */
82c3a4c4	581	__weak void arch_preboot_os(void)
b6396403 SG	582	{
	583	/* please define platform specific arch_preboot_os() */
	584	}
b6396403	585
fd3d1212 MV	586	/* Allow for board specific config before we boot */
	587	__weak void board_preboot_os(void)
	588	{
	589	/* please define board specific board_preboot_os() */
	590	}
	591
09140113	592	int boot_selected_os(int argc, char *const argv[], int state,
d9d7c20b	593	struct bootm_headers images, boot_os_fn boot_fn)
b6396403 SG	594	{
b6396403 SG	595	arch_preboot_os();
fd3d1212	596	board_preboot_os();
b6396403 SG	597	boot_fn(state, argc, argv, images);
	598
	599	/* Stand-alone may return when 'autostart' is 'no' */
	600	if (images->os.type == IH_TYPE_STANDALONE \|\|
b9c771b0	601	IS_ENABLED(CONFIG_SANDBOX) \|\|
b6396403 SG	602	state == BOOTM_STATE_OS_FAKE_GO) /* We expect to return */
	603	return 0;
	604	bootstage_error(BOOTSTAGE_ID_BOOT_OS_RETURNED);
851bda81 LM	605	debug("\n## Control returned to monitor - resetting...\n");
851bda81 LM	606
b6396403 SG	607	return BOOTM_ERR_RESET;
	608	}
	609
	610	boot_os_fn *bootm_os_get_boot_func(int os)
	611	{
	612	#ifdef CONFIG_NEEDS_MANUAL_RELOC
	613	static bool relocated;
	614
	615	if (!relocated) {
	616	int i;
	617
	618	/* relocate boot function table */
	619	for (i = 0; i < ARRAY_SIZE(boot_os); i++)
	620	if (boot_os[i] != NULL)
	621	boot_os[i] += gd->reloc_off;
	622
	623	relocated = true;
	624	}
	625	#endif
	626	return boot_os[os];
	627	}