[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;
	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 (!env_get_autostart())
		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 = hextoul(argv[1], NULL);

#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 = hextoul(tmp, NULL);

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