[J-u-boot.git] / cmd / elf.c

// SPDX-License-Identifier: BSD-2-Clause
/*
 * Copyright (c) 2001 William L. Pitts
 * All rights reserved.
 */

#include <common.h>
#include <command.h>
#include <cpu_func.h>
#include <elf.h>
#include <env.h>
#include <image.h>
#include <log.h>
#include <net.h>
#include <vxworks.h>
#ifdef CONFIG_X86
#include <vbe.h>
#include <asm/cache.h>
#include <asm/e820.h>
#include <linux/linkage.h>
#endif

/* Allow ports to override the default behavior */
static unsigned long do_bootelf_exec(ulong (*entry)(int, char * const[]),
				     int argc, char *const argv[])
{
	unsigned long ret;

	/*
	 * pass address parameter as argv[0] (aka command name),
	 * and all remaining args
	 */
	ret = entry(argc, argv);

	return ret;
}

/* Interpreter command to boot an arbitrary ELF image from memory */
int do_bootelf(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
	unsigned long addr; /* Address of the ELF image */
	unsigned long rc; /* Return value from user code */
	char *sload = NULL;
	const char *ep = env_get("autostart");
	int rcode = 0;

	/* Consume 'bootelf' */
	argc--; argv++;

	/* Check for flag. */
	if (argc >= 1 && (argv[0][0] == '-' && \
				(argv[0][1] == 'p' || argv[0][1] == 's'))) {
		sload = argv[0];
		/* Consume flag. */
		argc--; argv++;
	}
	/* Check for address. */
	if (argc >= 1 && strict_strtoul(argv[0], 16, &addr) != -EINVAL) {
		/* Consume address */
		argc--; argv++;
	} else
		addr = image_load_addr;

	if (!valid_elf_image(addr))
		return 1;

	if (sload && sload[1] == 'p')
		addr = load_elf_image_phdr(addr);
	else
		addr = load_elf_image_shdr(addr);

	if (ep && !strcmp(ep, "no"))
		return rcode;

	printf("## Starting application at 0x%08lx ...\n", addr);

	/*
	 * pass address parameter as argv[0] (aka command name),
	 * and all remaining args
	 */
	rc = do_bootelf_exec((void *)addr, argc, argv);
	if (rc != 0)
		rcode = 1;

	printf("## Application terminated, rc = 0x%lx\n", rc);

	return rcode;
}

/*
 * Interpreter command to boot VxWorks from a memory image.  The image can
 * be either an ELF image or a raw binary.  Will attempt to setup the
 * bootline and other parameters correctly.
 */
int do_bootvx(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
{
	unsigned long addr; /* Address of image */
	unsigned long bootaddr = 0; /* Address to put the bootline */
	char *bootline; /* Text of the bootline */
	char *tmp; /* Temporary char pointer */
	char build_buf[128]; /* Buffer for building the bootline */
	int ptr = 0;
#ifdef CONFIG_X86
	ulong base;
	struct e820_info *info;
	struct e820_entry *data;
	struct efi_gop_info *gop;
	struct vesa_mode_info *vesa = &mode_info.vesa;
#endif

	/*
	 * Check the loadaddr variable.
	 * If we don't know where the image is then we're done.
	 */
	if (argc < 2)
		addr = image_load_addr;
	else
		addr = simple_strtoul(argv[1], NULL, 16);

#if defined(CONFIG_CMD_NET)
	/*
	 * Check to see if we need to tftp the image ourselves
	 * before starting
	 */
	if ((argc == 2) && (strcmp(argv[1], "tftp") == 0)) {
		if (net_loop(TFTPGET) <= 0)
			return 1;
		printf("Automatic boot of VxWorks image at address 0x%08lx ...\n",
			addr);
	}
#endif

	/*
	 * This should equate to
	 * NV_RAM_ADRS + NV_BOOT_OFFSET + NV_ENET_OFFSET
	 * from the VxWorks BSP header files.
	 * This will vary from board to board
	 */
#if defined(CONFIG_SYS_VXWORKS_MAC_PTR)
	tmp = (char *)CONFIG_SYS_VXWORKS_MAC_PTR;
	eth_env_get_enetaddr("ethaddr", (uchar *)build_buf);
	memcpy(tmp, build_buf, 6);
#else
	puts("## Ethernet MAC address not copied to NV RAM\n");
#endif

#ifdef CONFIG_X86
	/*
	 * Get VxWorks's physical memory base address from environment,
	 * if we don't specify it in the environment, use a default one.
	 */
	base = env_get_hex("vx_phys_mem_base", VXWORKS_PHYS_MEM_BASE);
	data = (struct e820_entry *)(base + E820_DATA_OFFSET);
	info = (struct e820_info *)(base + E820_INFO_OFFSET);

	memset(info, 0, sizeof(struct e820_info));
	info->sign = E820_SIGNATURE;
	info->entries = install_e820_map(E820MAX, data);
	info->addr = (info->entries - 1) * sizeof(struct e820_entry) +
		     E820_DATA_OFFSET;

	/*
	 * Explicitly clear the bootloader image size otherwise if memory
	 * at this offset happens to contain some garbage data, the final
	 * available memory size for the kernel is insane.
	 */
	*(u32 *)(base + BOOT_IMAGE_SIZE_OFFSET) = 0;

	/*
	 * Prepare compatible framebuffer information block.
	 * The VESA mode has to be 32-bit RGBA.
	 */
	if (vesa->x_resolution && vesa->y_resolution) {
		gop = (struct efi_gop_info *)(base + EFI_GOP_INFO_OFFSET);
		gop->magic = EFI_GOP_INFO_MAGIC;
		gop->info.version = 0;
		gop->info.width = vesa->x_resolution;
		gop->info.height = vesa->y_resolution;
		gop->info.pixel_format = EFI_GOT_RGBA8;
		gop->info.pixels_per_scanline = vesa->bytes_per_scanline / 4;
		gop->fb_base = vesa->phys_base_ptr;
		gop->fb_size = vesa->bytes_per_scanline * vesa->y_resolution;
	}
#endif

	/*
	 * Use bootaddr to find the location in memory that VxWorks
	 * will look for the bootline string. The default value is
	 * (LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET) as defined by
	 * VxWorks BSP. For example, on PowerPC it defaults to 0x4200.
	 */
	tmp = env_get("bootaddr");
	if (!tmp) {
#ifdef CONFIG_X86
		bootaddr = base + X86_BOOT_LINE_OFFSET;
#else
		printf("## VxWorks bootline address not specified\n");
		return 1;
#endif
	}

	if (!bootaddr)
		bootaddr = simple_strtoul(tmp, NULL, 16);

	/*
	 * Check to see if the bootline is defined in the 'bootargs' parameter.
	 * If it is not defined, we may be able to construct the info.
	 */
	bootline = env_get("bootargs");
	if (!bootline) {
		tmp = env_get("bootdev");
		if (tmp) {
			strcpy(build_buf, tmp);
			ptr = strlen(tmp);
		} else {
			printf("## VxWorks boot device not specified\n");
		}

		tmp = env_get("bootfile");
		if (tmp)
			ptr += sprintf(build_buf + ptr, "host:%s ", tmp);
		else
			ptr += sprintf(build_buf + ptr, "host:vxWorks ");

		/*
		 * The following parameters are only needed if 'bootdev'
		 * is an ethernet device, otherwise they are optional.
		 */
		tmp = env_get("ipaddr");
		if (tmp) {
			ptr += sprintf(build_buf + ptr, "e=%s", tmp);
			tmp = env_get("netmask");
			if (tmp) {
				u32 mask = env_get_ip("netmask").s_addr;
				ptr += sprintf(build_buf + ptr,
					       ":%08x ", ntohl(mask));
			} else {
				ptr += sprintf(build_buf + ptr, " ");
			}
		}

		tmp = env_get("serverip");
		if (tmp)
			ptr += sprintf(build_buf + ptr, "h=%s ", tmp);

		tmp = env_get("gatewayip");
		if (tmp)
			ptr += sprintf(build_buf + ptr, "g=%s ", tmp);

		tmp = env_get("hostname");
		if (tmp)
			ptr += sprintf(build_buf + ptr, "tn=%s ", tmp);

		tmp = env_get("othbootargs");
		if (tmp) {
			strcpy(build_buf + ptr, tmp);
			ptr += strlen(tmp);
		}

		bootline = build_buf;
	}

	memcpy((void *)bootaddr, bootline, max(strlen(bootline), (size_t)255));
	flush_cache(bootaddr, max(strlen(bootline), (size_t)255));
	printf("## Using bootline (@ 0x%lx): %s\n", bootaddr, (char *)bootaddr);

	/*
	 * If the data at the load address is an elf image, then
	 * treat it like an elf image. Otherwise, assume that it is a
	 * binary image.
	 */
	if (valid_elf_image(addr))
		addr = load_elf_image_phdr(addr);
	else
		puts("## Not an ELF image, assuming binary\n");

	printf("## Starting vxWorks at 0x%08lx ...\n", addr);

	dcache_disable();
#if defined(CONFIG_ARM64) && defined(CONFIG_ARMV8_PSCI)
	armv8_setup_psci();
	smp_kick_all_cpus();
#endif

#ifdef CONFIG_X86
	/* VxWorks on x86 uses stack to pass parameters */
	((asmlinkage void (*)(int))addr)(0);
#else
	((void (*)(int))addr)(0);
#endif

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

	return 1;
}

U_BOOT_CMD(
	bootelf, CONFIG_SYS_MAXARGS, 0, do_bootelf,
	"Boot from an ELF image in memory",
	"[-p|-s] [address]\n"
	"\t- load ELF image at [address] via program headers (-p)\n"
	"\t  or via section headers (-s)"
);

U_BOOT_CMD(
	bootvx, 2, 0, do_bootvx,
	"Boot vxWorks from an ELF image",
	" [address] - load address of vxWorks ELF image."
);
Commit	Line	Data
89789ebd	1	// SPDX-License-Identifier: BSD-2-Clause
458ded34 WD	2	/*
	3	* Copyright (c) 2001 William L. Pitts
	4	* All rights reserved.
458ded34 WD	5	*/
	6
	7	#include <common.h>
	8	#include <command.h>
62270f43	9	#include <cpu_func.h>
458ded34	10	#include <elf.h>
cdbff9fc	11	#include <env.h>
8e8ccfe1	12	#include <image.h>
f7ae49fc	13	#include <log.h>
ebca3df7	14	#include <net.h>
29a4c24d	15	#include <vxworks.h>
b90ff0fd	16	#ifdef CONFIG_X86
447ae4f7	17	#include <vbe.h>
90526e9f	18	#include <asm/cache.h>
b90ff0fd	19	#include <asm/e820.h>
9aa1280a	20	#include <linux/linkage.h>
b90ff0fd	21	#endif
458ded34	22
017e9b79	23	/* Allow ports to override the default behavior */
553d8c3a	24	static unsigned long do_bootelf_exec(ulong (entry)(int, char const[]),
09140113	25	int argc, char *const argv[])
1f1d88dd	26	{
017e9b79 MF	27	unsigned long ret;
017e9b79 MF	28
017e9b79 MF	29	/*
	30	* pass address parameter as argv[0] (aka command name),
	31	* and all remaining args
	32	*/
62e03d33	33	ret = entry(argc, argv);
1f1d88dd	34
017e9b79 MF	35	return ret;
017e9b79 MF	36	}
458ded34	37
ebca3df7	38	/* Interpreter command to boot an arbitrary ELF image from memory */
09140113	39	int do_bootelf(struct cmd_tbl cmdtp, int flag, int argc, char const argv[])
458ded34	40	{
ebca3df7 BM	41	unsigned long addr; /* Address of the ELF image */
ebca3df7 BM	42	unsigned long rc; /* Return value from user code */
be1b8679	43	char *sload = NULL;
00caae6d	44	const char *ep = env_get("autostart");
458ded34 WD	45	int rcode = 0;
458ded34 WD	46
be1b8679 TR	47	/* Consume 'bootelf' */
be1b8679 TR	48	argc--; argv++;
f44a928e	49
be1b8679 TR	50	/* Check for flag. */
	51	if (argc >= 1 && (argv[0][0] == '-' && \
	52	(argv[0][1] == 'p' \|\| argv[0][1] == 's'))) {
	53	sload = argv[0];
	54	/* Consume flag. */
	55	argc--; argv++;
	56	}
	57	/* Check for address. */
	58	if (argc >= 1 && strict_strtoul(argv[0], 16, &addr) != -EINVAL) {
	59	/* Consume address */
	60	argc--; argv++;
	61	} else
bb872dd9	62	addr = image_load_addr;
458ded34	63
62e03d33	64	if (!valid_elf_image(addr))
458ded34 WD	65	return 1;
458ded34 WD	66
f44a928e MF	67	if (sload && sload[1] == 'p')
	68	addr = load_elf_image_phdr(addr);
	69	else
	70	addr = load_elf_image_shdr(addr);
458ded34	71
44c8fd3a SDPP	72	if (ep && !strcmp(ep, "no"))
	73	return rcode;
	74
62e03d33	75	printf("## Starting application at 0x%08lx ...\n", addr);
458ded34	76
458ded34 WD	77	/*
	78	* pass address parameter as argv[0] (aka command name),
	79	* and all remaining args
	80	*/
be1b8679	81	rc = do_bootelf_exec((void *)addr, argc, argv);
458ded34 WD	82	if (rc != 0)
	83	rcode = 1;
	84
62e03d33	85	printf("## Application terminated, rc = 0x%lx\n", rc);
ebca3df7	86
458ded34 WD	87	return rcode;
	88	}
	89
ebca3df7	90	/*
458ded34 WD	91	* Interpreter command to boot VxWorks from a memory image. The image can
	92	* be either an ELF image or a raw binary. Will attempt to setup the
	93	* bootline and other parameters correctly.
ebca3df7	94	*/
09140113	95	int do_bootvx(struct cmd_tbl cmdtp, int flag, int argc, char const argv[])
458ded34	96	{
ebca3df7	97	unsigned long addr; /* Address of image */
79c584e5	98	unsigned long bootaddr = 0; /* Address to put the bootline */
ebca3df7 BM	99	char bootline; / Text of the bootline */
	100	char tmp; / Temporary char pointer */
	101	char build_buf[128]; /* Buffer for building the bootline */
7f0c3c51	102	int ptr = 0;
b90ff0fd	103	#ifdef CONFIG_X86
2902be86	104	ulong base;
fa5e91f7	105	struct e820_info *info;
45519924	106	struct e820_entry *data;
447ae4f7 BM	107	struct efi_gop_info *gop;
447ae4f7 BM	108	struct vesa_mode_info *vesa = &mode_info.vesa;
b90ff0fd	109	#endif
ebca3df7 BM	110
ebca3df7 BM	111	/*
458ded34 WD	112	* Check the loadaddr variable.
	113	* If we don't know where the image is then we're done.
	114	*/
07a1a0c9	115	if (argc < 2)
bb872dd9	116	addr = image_load_addr;
1bdd4683	117	else
07a1a0c9	118	addr = simple_strtoul(argv[1], NULL, 16);
458ded34	119
baa26db4	120	#if defined(CONFIG_CMD_NET)
62e03d33	121	/*
ebca3df7 BM	122	* Check to see if we need to tftp the image ourselves
ebca3df7 BM	123	* before starting
62e03d33	124	*/
07a1a0c9	125	if ((argc == 2) && (strcmp(argv[1], "tftp") == 0)) {
bc0571fc	126	if (net_loop(TFTPGET) <= 0)
458ded34	127	return 1;
62e03d33 DS	128	printf("Automatic boot of VxWorks image at address 0x%08lx ...\n",
62e03d33 DS	129	addr);
458ded34 WD	130	}
	131	#endif
	132
ebca3df7 BM	133	/*
	134	* This should equate to
	135	* NV_RAM_ADRS + NV_BOOT_OFFSET + NV_ENET_OFFSET
458ded34 WD	136	* from the VxWorks BSP header files.
	137	* This will vary from board to board
	138	*/
8996975f	139	#if defined(CONFIG_SYS_VXWORKS_MAC_PTR)
ebca3df7	140	tmp = (char *)CONFIG_SYS_VXWORKS_MAC_PTR;
35affd7a	141	eth_env_get_enetaddr("ethaddr", (uchar *)build_buf);
62c93d92	142	memcpy(tmp, build_buf, 6);
458ded34	143	#else
62e03d33	144	puts("## Ethernet MAC address not copied to NV RAM\n");
458ded34 WD	145	#endif
458ded34 WD	146
79c584e5 BM	147	#ifdef CONFIG_X86
	148	/*
	149	* Get VxWorks's physical memory base address from environment,
	150	* if we don't specify it in the environment, use a default one.
	151	*/
	152	base = env_get_hex("vx_phys_mem_base", VXWORKS_PHYS_MEM_BASE);
	153	data = (struct e820_entry *)(base + E820_DATA_OFFSET);
	154	info = (struct e820_info *)(base + E820_INFO_OFFSET);
	155
	156	memset(info, 0, sizeof(struct e820_info));
	157	info->sign = E820_SIGNATURE;
	158	info->entries = install_e820_map(E820MAX, data);
	159	info->addr = (info->entries - 1) * sizeof(struct e820_entry) +
	160	E820_DATA_OFFSET;
	161
	162	/*
	163	* Explicitly clear the bootloader image size otherwise if memory
	164	* at this offset happens to contain some garbage data, the final
	165	* available memory size for the kernel is insane.
	166	*/
	167	(u32 )(base + BOOT_IMAGE_SIZE_OFFSET) = 0;
	168
	169	/*
	170	* Prepare compatible framebuffer information block.
	171	* The VESA mode has to be 32-bit RGBA.
	172	*/
	173	if (vesa->x_resolution && vesa->y_resolution) {
	174	gop = (struct efi_gop_info *)(base + EFI_GOP_INFO_OFFSET);
	175	gop->magic = EFI_GOP_INFO_MAGIC;
	176	gop->info.version = 0;
	177	gop->info.width = vesa->x_resolution;
	178	gop->info.height = vesa->y_resolution;
	179	gop->info.pixel_format = EFI_GOT_RGBA8;
	180	gop->info.pixels_per_scanline = vesa->bytes_per_scanline / 4;
	181	gop->fb_base = vesa->phys_base_ptr;
	182	gop->fb_size = vesa->bytes_per_scanline * vesa->y_resolution;
	183	}
	184	#endif
	185
8bde7f77 WD	186	/*
8bde7f77 WD	187	* Use bootaddr to find the location in memory that VxWorks
9e98b7e3 BM	188	* will look for the bootline string. The default value is
	189	* (LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET) as defined by
	190	* VxWorks BSP. For example, on PowerPC it defaults to 0x4200.
458ded34	191	*/
00caae6d	192	tmp = env_get("bootaddr");
9e98b7e3	193	if (!tmp) {
79c584e5 BM	194	#ifdef CONFIG_X86
	195	bootaddr = base + X86_BOOT_LINE_OFFSET;
	196	#else
9e98b7e3	197	printf("## VxWorks bootline address not specified\n");
ced71a2f	198	return 1;
79c584e5	199	#endif
ced71a2f BM	200	}
ced71a2f BM	201
79c584e5 BM	202	if (!bootaddr)
79c584e5 BM	203	bootaddr = simple_strtoul(tmp, NULL, 16);
ced71a2f BM	204
	205	/*
	206	* Check to see if the bootline is defined in the 'bootargs' parameter.
	207	* If it is not defined, we may be able to construct the info.
	208	*/
	209	bootline = env_get("bootargs");
	210	if (!bootline) {
	211	tmp = env_get("bootdev");
	212	if (tmp) {
	213	strcpy(build_buf, tmp);
	214	ptr = strlen(tmp);
	215	} else {
	216	printf("## VxWorks boot device not specified\n");
	217	}
	218
	219	tmp = env_get("bootfile");
	220	if (tmp)
	221	ptr += sprintf(build_buf + ptr, "host:%s ", tmp);
	222	else
	223	ptr += sprintf(build_buf + ptr, "host:vxWorks ");
458ded34	224
9e98b7e3	225	/*
ced71a2f BM	226	* The following parameters are only needed if 'bootdev'
ced71a2f BM	227	* is an ethernet device, otherwise they are optional.
9e98b7e3	228	*/
ced71a2f BM	229	tmp = env_get("ipaddr");
	230	if (tmp) {
	231	ptr += sprintf(build_buf + ptr, "e=%s", tmp);
	232	tmp = env_get("netmask");
192bc694	233	if (tmp) {
ced71a2f	234	u32 mask = env_get_ip("netmask").s_addr;
9e98b7e3	235	ptr += sprintf(build_buf + ptr,
ced71a2f BM	236	":%08x ", ntohl(mask));
	237	} else {
	238	ptr += sprintf(build_buf + ptr, " ");
a4092dbd	239	}
ced71a2f	240	}
458ded34	241
ced71a2f BM	242	tmp = env_get("serverip");
	243	if (tmp)
	244	ptr += sprintf(build_buf + ptr, "h=%s ", tmp);
a4092dbd	245
ced71a2f BM	246	tmp = env_get("gatewayip");
	247	if (tmp)
	248	ptr += sprintf(build_buf + ptr, "g=%s ", tmp);
458ded34	249
ced71a2f BM	250	tmp = env_get("hostname");
	251	if (tmp)
	252	ptr += sprintf(build_buf + ptr, "tn=%s ", tmp);
9e98b7e3	253
ced71a2f BM	254	tmp = env_get("othbootargs");
	255	if (tmp) {
	256	strcpy(build_buf + ptr, tmp);
	257	ptr += strlen(tmp);
9e98b7e3	258	}
29a4c24d	259
ced71a2f	260	bootline = build_buf;
458ded34 WD	261	}
458ded34 WD	262
ced71a2f BM	263	memcpy((void *)bootaddr, bootline, max(strlen(bootline), (size_t)255));
	264	flush_cache(bootaddr, max(strlen(bootline), (size_t)255));
	265	printf("## Using bootline (@ 0x%lx): %s\n", bootaddr, (char *)bootaddr);
	266
8bde7f77 WD	267	/*
	268	* If the data at the load address is an elf image, then
	269	* treat it like an elf image. Otherwise, assume that it is a
ebca3df7	270	* binary image.
458ded34	271	*/
ebca3df7	272	if (valid_elf_image(addr))
476c2fcd	273	addr = load_elf_image_phdr(addr);
ebca3df7	274	else
62e03d33	275	puts("## Not an ELF image, assuming binary\n");
458ded34	276
62e03d33	277	printf("## Starting vxWorks at 0x%08lx ...\n", addr);
458ded34	278
6eee21da	279	dcache_disable();
3194daa1 VV	280	#if defined(CONFIG_ARM64) && defined(CONFIG_ARMV8_PSCI)
	281	armv8_setup_psci();
	282	smp_kick_all_cpus();
	283	#endif
	284
9aa1280a BM	285	#ifdef CONFIG_X86
	286	/* VxWorks on x86 uses stack to pass parameters */
	287	((asmlinkage void (*)(int))addr)(0);
	288	#else
ebca3df7	289	((void (*)(int))addr)(0);
9aa1280a	290	#endif
458ded34	291
62e03d33	292	puts("## vxWorks terminated\n");
ebca3df7	293
458ded34 WD	294	return 1;
	295	}
	296
0d498393	297	U_BOOT_CMD(
be1b8679	298	bootelf, CONFIG_SYS_MAXARGS, 0, do_bootelf,
2fb2604d	299	"Boot from an ELF image in memory",
f44a928e MF	300	"[-p\|-s] [address]\n"
	301	"\t- load ELF image at [address] via program headers (-p)\n"
	302	"\t or via section headers (-s)"
8bde7f77 WD	303	);
8bde7f77 WD	304
0d498393	305	U_BOOT_CMD(
ebca3df7	306	bootvx, 2, 0, do_bootvx,
2fb2604d	307	"Boot vxWorks from an ELF image",
a89c33db	308	" [address] - load address of vxWorks ELF image."
8bde7f77	309	);