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

/*
 * Copyright (c) 2001 William L. Pitts
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms are freely
 * permitted provided that the above copyright notice and this
 * paragraph and the following disclaimer are duplicated in all
 * such forms.
 *
 * This software is provided "AS IS" and without any express or
 * implied warranties, including, without limitation, the implied
 * warranties of merchantability and fitness for a particular
 * purpose.
 */

#include <common.h>
#include <command.h>
#include <linux/ctype.h>
#include <net.h>
#include <elf.h>
#include <vxworks.h>

#if defined(CONFIG_WALNUT) || defined(CONFIG_SYS_VXWORKS_MAC_PTR)
DECLARE_GLOBAL_DATA_PTR;
#endif

int valid_elf_image (unsigned long addr);
unsigned long load_elf_image (unsigned long addr);

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

	/*
	 * QNX images require the data cache is disabled.
	 * Data cache is already flushed, so just turn it off.
	 */
	int dcache = dcache_status ();
	if (dcache)
		dcache_disable ();

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

	if (dcache)
		dcache_enable ();

	return ret;
}

/* ======================================================================
 * Interpreter command to boot an arbitrary ELF image from memory.
 * ====================================================================== */
int do_bootelf (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
{
	unsigned long addr;		/* Address of the ELF image     */
	unsigned long rc;		/* Return value from user code  */

	/* -------------------------------------------------- */
	int rcode = 0;

	if (argc < 2)
		addr = load_addr;
	else
		addr = simple_strtoul (argv[1], NULL, 16);

	if (!valid_elf_image (addr))
		return 1;

	addr = load_elf_image (addr);

	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 - 1, argv + 1);
	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 (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
{
	unsigned long addr;		/* Address of image            */
	unsigned long bootaddr;		/* 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 */

	/* ---------------------------------------------------
	 *
	 * Check the loadaddr variable.
	 * If we don't know where the image is then we're done.
	 */

	if (argc < 2)
		addr = 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 (NetLoop (TFTP) <= 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_WALNUT)
	tmp = (char *) CONFIG_SYS_NVRAM_BASE_ADDR + 0x500;
	memcpy ((char *) tmp, (char *) &gd->bd->bi_enetaddr[3], 3);
#elif defined(CONFIG_SYS_VXWORKS_MAC_PTR)
	tmp = (char *) CONFIG_SYS_VXWORKS_MAC_PTR;
	memcpy ((char *) tmp, (char *) &gd->bd->bi_enetaddr[0], 6);
#else
	puts ("## Ethernet MAC address not copied to NV RAM\n");
#endif

	/*
	 * Use bootaddr to find the location in memory that VxWorks
	 * will look for the bootline string. The default value for
	 * PowerPC is LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET which
	 * defaults to 0x4200
	 */

	if ((tmp = getenv ("bootaddr")) == NULL)
		bootaddr = CONFIG_SYS_VXWORKS_BOOT_ADDR;
	else
		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
	 */

	if ((bootline = getenv ("bootargs")) != NULL) {
		memcpy ((void *) bootaddr, bootline,
			max (strlen (bootline), 255));
		flush_cache (bootaddr, max (strlen (bootline), 255));
	} else {


		sprintf (build_buf, CONFIG_SYS_VXWORKS_BOOT_DEVICE);
		if ((tmp = getenv ("bootfile")) != NULL) {
			sprintf (&build_buf[strlen (build_buf)],
				 "%s:%s ", CONFIG_SYS_VXWORKS_SERVERNAME, tmp);
		} else {
			sprintf (&build_buf[strlen (build_buf)],
				 "%s:file ", CONFIG_SYS_VXWORKS_SERVERNAME);
		}

		if ((tmp = getenv ("ipaddr")) != NULL) {
			sprintf (&build_buf[strlen (build_buf)], "e=%s ", tmp);
		}

		if ((tmp = getenv ("serverip")) != NULL) {
			sprintf (&build_buf[strlen (build_buf)], "h=%s ", tmp);
		}

		if ((tmp = getenv ("hostname")) != NULL) {
			sprintf (&build_buf[strlen (build_buf)], "tn=%s ", tmp);
		}
#ifdef CONFIG_SYS_VXWORKS_ADD_PARAMS
		sprintf (&build_buf[strlen (build_buf)],
			 CONFIG_SYS_VXWORKS_ADD_PARAMS);
#endif

		memcpy ((void *) bootaddr, build_buf,
			max (strlen (build_buf), 255));
		flush_cache (bootaddr, max (strlen (build_buf), 255));
	}

	/*
	 * 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 (addr);
	} else {
		puts ("## Not an ELF image, assuming binary\n");
		/* leave addr as load_addr */
	}

	printf ("## Using bootline (@ 0x%lx): %s\n", bootaddr,
			(char *) bootaddr);
	printf ("## Starting vxWorks at 0x%08lx ...\n", addr);

	((void (*)(void)) addr) ();

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

/* ======================================================================
 * Determine if a valid ELF image exists at the given memory location.
 * First looks at the ELF header magic field, the makes sure that it is
 * executable and makes sure that it is for a PowerPC.
 * ====================================================================== */
int valid_elf_image (unsigned long addr)
{
	Elf32_Ehdr *ehdr;		/* Elf header structure pointer */

	/* -------------------------------------------------- */

	ehdr = (Elf32_Ehdr *) addr;

	if (!IS_ELF (*ehdr)) {
		printf ("## No elf image at address 0x%08lx\n", addr);
		return 0;
	}

	if (ehdr->e_type != ET_EXEC) {
		printf ("## Not a 32-bit elf image at address 0x%08lx\n", addr);
		return 0;
	}

#if 0
	if (ehdr->e_machine != EM_PPC) {
		printf ("## Not a PowerPC elf image at address 0x%08lx\n",
			addr);
		return 0;
	}
#endif

	return 1;
}

/* ======================================================================
 * A very simple elf loader, assumes the image is valid, returns the
 * entry point address.
 * ====================================================================== */
unsigned long load_elf_image (unsigned long addr)
{
	Elf32_Ehdr *ehdr;		/* Elf header structure pointer     */
	Elf32_Shdr *shdr;		/* Section header structure pointer */
	unsigned char *strtab = 0;	/* String table pointer             */
	unsigned char *image;		/* Binary image pointer             */
	int i;				/* Loop counter                     */

	/* -------------------------------------------------- */

	ehdr = (Elf32_Ehdr *) addr;

	/* Find the section header string table for output info */
	shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
			       (ehdr->e_shstrndx * sizeof (Elf32_Shdr)));

	if (shdr->sh_type == SHT_STRTAB)
		strtab = (unsigned char *) (addr + shdr->sh_offset);

	/* Load each appropriate section */
	for (i = 0; i < ehdr->e_shnum; ++i) {
		shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
				       (i * sizeof (Elf32_Shdr)));

		if (!(shdr->sh_flags & SHF_ALLOC)
		   || shdr->sh_addr == 0 || shdr->sh_size == 0) {
			continue;
		}

		if (strtab) {
			printf ("%sing %s @ 0x%08lx (%ld bytes)\n",
				(shdr->sh_type == SHT_NOBITS) ?
					"Clear" : "Load",
				&strtab[shdr->sh_name],
				(unsigned long) shdr->sh_addr,
				(long) shdr->sh_size);
		}

		if (shdr->sh_type == SHT_NOBITS) {
			memset ((void *)shdr->sh_addr, 0, shdr->sh_size);
		} else {
			image = (unsigned char *) addr + shdr->sh_offset;
			memcpy ((void *) shdr->sh_addr,
				(const void *) image,
				shdr->sh_size);
		}
		flush_cache (shdr->sh_addr, shdr->sh_size);
	}

	return ehdr->e_entry;
}

/* ====================================================================== */
U_BOOT_CMD(
	bootelf,      2,      0,      do_bootelf,
	"Boot from an ELF image in memory",
	" [address] - load address of ELF image.\n"
);

U_BOOT_CMD(
	bootvx,      2,      0,      do_bootvx,
	"Boot vxWorks from an ELF image",
	" [address] - load address of vxWorks ELF image.\n"
);
Commit	Line	Data
458ded34 WD	1	/*
	2	* Copyright (c) 2001 William L. Pitts
	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms are freely
	6	* permitted provided that the above copyright notice and this
	7	* paragraph and the following disclaimer are duplicated in all
	8	* such forms.
	9	*
	10	* This software is provided "AS IS" and without any express or
	11	* implied warranties, including, without limitation, the implied
	12	* warranties of merchantability and fitness for a particular
	13	* purpose.
	14	*/
	15
	16	#include <common.h>
	17	#include <command.h>
	18	#include <linux/ctype.h>
	19	#include <net.h>
458ded34	20	#include <elf.h>
29a4c24d	21	#include <vxworks.h>
458ded34	22
6d0f6bcf	23	#if defined(CONFIG_WALNUT) \|\| defined(CONFIG_SYS_VXWORKS_MAC_PTR)
d87080b7 WD	24	DECLARE_GLOBAL_DATA_PTR;
d87080b7 WD	25	#endif
458ded34	26
017e9b79 MF	27	int valid_elf_image (unsigned long addr);
	28	unsigned long load_elf_image (unsigned long addr);
	29
	30	/* Allow ports to override the default behavior */
	31	__attribute__((weak))
	32	unsigned long do_bootelf_exec (ulong (entry)(int, char []), int argc, char *argv[])
1f1d88dd	33	{
017e9b79 MF	34	unsigned long ret;
017e9b79 MF	35
1f1d88dd MF	36	/*
	37	* QNX images require the data cache is disabled.
	38	* Data cache is already flushed, so just turn it off.
	39	*/
017e9b79 MF	40	int dcache = dcache_status ();
017e9b79 MF	41	if (dcache)
1f1d88dd MF	42	dcache_disable ();
1f1d88dd MF	43
017e9b79 MF	44	/*
	45	* pass address parameter as argv[0] (aka command name),
	46	* and all remaining args
	47	*/
	48	ret = entry (argc, argv);
1f1d88dd	49
017e9b79 MF	50	if (dcache)
	51	dcache_enable ();
	52
	53	return ret;
	54	}
458ded34 WD	55
	56	/* ======================================================================
	57	* Interpreter command to boot an arbitrary ELF image from memory.
	58	* ====================================================================== */
	59	int do_bootelf (cmd_tbl_t cmdtp, int flag, int argc, char argv[])
	60	{
	61	unsigned long addr; /* Address of the ELF image */
	62	unsigned long rc; /* Return value from user code */
	63
	64	/* -------------------------------------------------- */
	65	int rcode = 0;
	66
	67	if (argc < 2)
	68	addr = load_addr;
	69	else
	70	addr = simple_strtoul (argv[1], NULL, 16);
	71
	72	if (!valid_elf_image (addr))
	73	return 1;
	74
	75	addr = load_elf_image (addr);
	76
	77	printf ("## Starting application at 0x%08lx ...\n", addr);
	78
458ded34 WD	79	/*
	80	* pass address parameter as argv[0] (aka command name),
	81	* and all remaining args
	82	*/
017e9b79	83	rc = do_bootelf_exec ((void *)addr, argc - 1, argv + 1);
458ded34 WD	84	if (rc != 0)
	85	rcode = 1;
	86
	87	printf ("## Application terminated, rc = 0x%lx\n", rc);
	88	return rcode;
	89	}
	90
	91	/* ======================================================================
	92	* Interpreter command to boot VxWorks from a memory image. The image can
	93	* be either an ELF image or a raw binary. Will attempt to setup the
	94	* bootline and other parameters correctly.
	95	* ====================================================================== */
1bdd4683	96	int do_bootvx (cmd_tbl_t cmdtp, int flag, int argc, char argv[])
458ded34	97	{
458ded34 WD	98	unsigned long addr; /* Address of image */
	99	unsigned long bootaddr; /* Address to put the bootline */
	100	char bootline; / Text of the bootline */
	101	char tmp; / Temporary char pointer */
29a4c24d	102	char build_buf[128]; /* Buffer for building the bootline */
458ded34	103
29a4c24d NG	104	/* ---------------------------------------------------
29a4c24d NG	105	*
458ded34 WD	106	* Check the loadaddr variable.
	107	* If we don't know where the image is then we're done.
	108	*/
	109
1bdd4683 SR	110	if (argc < 2)
	111	addr = load_addr;
	112	else
	113	addr = simple_strtoul (argv[1], NULL, 16);
458ded34	114
baa26db4	115	#if defined(CONFIG_CMD_NET)
458ded34 WD	116	/* Check to see if we need to tftp the image ourselves before starting */
	117
	118	if ((argc == 2) && (strcmp (argv[1], "tftp") == 0)) {
eb9401e3	119	if (NetLoop (TFTP) <= 0)
458ded34	120	return 1;
29a4c24d NG	121	printf ("Automatic boot of VxWorks image at address 0x%08lx ... \n",
29a4c24d NG	122	addr);
458ded34 WD	123	}
	124	#endif
	125
	126	/* This should equate
	127	* to NV_RAM_ADRS + NV_BOOT_OFFSET + NV_ENET_OFFSET
	128	* from the VxWorks BSP header files.
	129	* This will vary from board to board
	130	*/
	131
c157d8e2	132	#if defined(CONFIG_WALNUT)
6d0f6bcf	133	tmp = (char *) CONFIG_SYS_NVRAM_BASE_ADDR + 0x500;
458ded34	134	memcpy ((char ) tmp, (char ) &gd->bd->bi_enetaddr[3], 3);
6d0f6bcf JCPV	135	#elif defined(CONFIG_SYS_VXWORKS_MAC_PTR)
6d0f6bcf JCPV	136	tmp = (char *) CONFIG_SYS_VXWORKS_MAC_PTR;
458ded34 WD	137	memcpy ((char ) tmp, (char ) &gd->bd->bi_enetaddr[0], 6);
458ded34 WD	138	#else
4b9206ed	139	puts ("## Ethernet MAC address not copied to NV RAM\n");
458ded34 WD	140	#endif
458ded34 WD	141
8bde7f77 WD	142	/*
	143	* Use bootaddr to find the location in memory that VxWorks
	144	* will look for the bootline string. The default value for
	145	* PowerPC is LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET which
	146	* defaults to 0x4200
458ded34 WD	147	*/
	148
	149	if ((tmp = getenv ("bootaddr")) == NULL)
29a4c24d	150	bootaddr = CONFIG_SYS_VXWORKS_BOOT_ADDR;
458ded34 WD	151	else
	152	bootaddr = simple_strtoul (tmp, NULL, 16);
	153
8bde7f77 WD	154	/*
	155	* Check to see if the bootline is defined in the 'bootargs'
	156	* parameter. If it is not defined, we may be able to
	157	* construct the info
458ded34 WD	158	*/
	159
	160	if ((bootline = getenv ("bootargs")) != NULL) {
29a4c24d NG	161	memcpy ((void *) bootaddr, bootline,
	162	max (strlen (bootline), 255));
	163	flush_cache (bootaddr, max (strlen (bootline), 255));
458ded34	164	} else {
458ded34	165
29a4c24d NG	166
	167	sprintf (build_buf, CONFIG_SYS_VXWORKS_BOOT_DEVICE);
	168	if ((tmp = getenv ("bootfile")) != NULL) {
	169	sprintf (&build_buf[strlen (build_buf)],
	170	"%s:%s ", CONFIG_SYS_VXWORKS_SERVERNAME, tmp);
458ded34	171	} else {
29a4c24d NG	172	sprintf (&build_buf[strlen (build_buf)],
29a4c24d NG	173	"%s:file ", CONFIG_SYS_VXWORKS_SERVERNAME);
458ded34 WD	174	}
	175
	176	if ((tmp = getenv ("ipaddr")) != NULL) {
29a4c24d	177	sprintf (&build_buf[strlen (build_buf)], "e=%s ", tmp);
458ded34	178	}
458ded34	179
29a4c24d NG	180	if ((tmp = getenv ("serverip")) != NULL) {
29a4c24d NG	181	sprintf (&build_buf[strlen (build_buf)], "h=%s ", tmp);
458ded34 WD	182	}
458ded34 WD	183
29a4c24d NG	184	if ((tmp = getenv ("hostname")) != NULL) {
29a4c24d NG	185	sprintf (&build_buf[strlen (build_buf)], "tn=%s ", tmp);
458ded34	186	}
29a4c24d NG	187	#ifdef CONFIG_SYS_VXWORKS_ADD_PARAMS
	188	sprintf (&build_buf[strlen (build_buf)],
	189	CONFIG_SYS_VXWORKS_ADD_PARAMS);
458ded34	190	#endif
29a4c24d NG	191
	192	memcpy ((void *) bootaddr, build_buf,
	193	max (strlen (build_buf), 255));
	194	flush_cache (bootaddr, max (strlen (build_buf), 255));
458ded34 WD	195	}
458ded34 WD	196
8bde7f77 WD	197	/*
	198	* If the data at the load address is an elf image, then
	199	* treat it like an elf image. Otherwise, assume that it is a
	200	* binary image
458ded34 WD	201	*/
	202
	203	if (valid_elf_image (addr)) {
	204	addr = load_elf_image (addr);
	205	} else {
4b9206ed	206	puts ("## Not an ELF image, assuming binary\n");
458ded34 WD	207	/* leave addr as load_addr */
	208	}
	209
	210	printf ("## Using bootline (@ 0x%lx): %s\n", bootaddr,
	211	(char *) bootaddr);
	212	printf ("## Starting vxWorks at 0x%08lx ...\n", addr);
	213
	214	((void (*)(void)) addr) ();
	215
4b9206ed	216	puts ("## vxWorks terminated\n");
458ded34 WD	217	return 1;
	218	}
	219
	220	/* ======================================================================
	221	* Determine if a valid ELF image exists at the given memory location.
	222	* First looks at the ELF header magic field, the makes sure that it is
	223	* executable and makes sure that it is for a PowerPC.
	224	* ====================================================================== */
	225	int valid_elf_image (unsigned long addr)
	226	{
	227	Elf32_Ehdr ehdr; / Elf header structure pointer */
	228
	229	/* -------------------------------------------------- */
	230
	231	ehdr = (Elf32_Ehdr *) addr;
	232
	233	if (!IS_ELF (*ehdr)) {
	234	printf ("## No elf image at address 0x%08lx\n", addr);
	235	return 0;
	236	}
	237
	238	if (ehdr->e_type != ET_EXEC) {
29a4c24d	239	printf ("## Not a 32-bit elf image at address 0x%08lx\n", addr);
458ded34 WD	240	return 0;
	241	}
	242
6069ff26	243	#if 0
458ded34 WD	244	if (ehdr->e_machine != EM_PPC) {
	245	printf ("## Not a PowerPC elf image at address 0x%08lx\n",
	246	addr);
	247	return 0;
	248	}
6069ff26	249	#endif
458ded34 WD	250
	251	return 1;
	252	}
	253
458ded34 WD	254	/* ======================================================================
	255	* A very simple elf loader, assumes the image is valid, returns the
	256	* entry point address.
	257	* ====================================================================== */
	258	unsigned long load_elf_image (unsigned long addr)
	259	{
	260	Elf32_Ehdr ehdr; / Elf header structure pointer */
	261	Elf32_Shdr shdr; / Section header structure pointer */
	262	unsigned char strtab = 0; / String table pointer */
	263	unsigned char image; / Binary image pointer */
	264	int i; /* Loop counter */
	265
	266	/* -------------------------------------------------- */
	267
	268	ehdr = (Elf32_Ehdr *) addr;
	269
	270	/* Find the section header string table for output info */
	271	shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
	272	(ehdr->e_shstrndx * sizeof (Elf32_Shdr)));
	273
	274	if (shdr->sh_type == SHT_STRTAB)
	275	strtab = (unsigned char *) (addr + shdr->sh_offset);
	276
	277	/* Load each appropriate section */
	278	for (i = 0; i < ehdr->e_shnum; ++i) {
	279	shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
	280	(i * sizeof (Elf32_Shdr)));
	281
	282	if (!(shdr->sh_flags & SHF_ALLOC)
	283	\|\| shdr->sh_addr == 0 \|\| shdr->sh_size == 0) {
	284	continue;
	285	}
	286
	287	if (strtab) {
	288	printf ("%sing %s @ 0x%08lx (%ld bytes)\n",
	289	(shdr->sh_type == SHT_NOBITS) ?
	290	"Clear" : "Load",
	291	&strtab[shdr->sh_name],
	292	(unsigned long) shdr->sh_addr,
	293	(long) shdr->sh_size);
	294	}
	295
	296	if (shdr->sh_type == SHT_NOBITS) {
	297	memset ((void *)shdr->sh_addr, 0, shdr->sh_size);
	298	} else {
	299	image = (unsigned char *) addr + shdr->sh_offset;
	300	memcpy ((void *) shdr->sh_addr,
	301	(const void *) image,
	302	shdr->sh_size);
	303	}
	304	flush_cache (shdr->sh_addr, shdr->sh_size);
	305	}
	306
	307	return ehdr->e_entry;
	308	}
	309
	310	/* ====================================================================== */
0d498393 WD	311	U_BOOT_CMD(
0d498393 WD	312	bootelf, 2, 0, do_bootelf,
2fb2604d	313	"Boot from an ELF image in memory",
8bde7f77 WD	314	" [address] - load address of ELF image.\n"
	315	);
	316
0d498393 WD	317	U_BOOT_CMD(
0d498393 WD	318	bootvx, 2, 0, do_bootvx,
2fb2604d	319	"Boot vxWorks from an ELF image",
8bde7f77 WD	320	" [address] - load address of vxWorks ELF image.\n"
8bde7f77 WD	321	);