[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>


#if (CONFIG_COMMANDS & CFG_CMD_ELF)

#ifndef MAX
#define MAX(a,b) ((a) > (b) ? (a) : (b))
#endif

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

/* ======================================================================
 * 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);

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

	/*
	 * pass address parameter as argv[0] (aka command name),
	 * and all remaining args
	 */
	rc = ((ulong (*)(int, char *[])) addr) (--argc, &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[])
{
#if defined(CONFIG_WALNUT)	|| \
    defined(CFG_VXWORKS_MAC_PTR)
	DECLARE_GLOBAL_DATA_PTR;
#endif

	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      */

#if defined(CONFIG_4xx) || defined(CONFIG_IOP480)
	char build_buf[80];		/* Buffer for building the bootline */
#endif
	/* -------------------------------------------------- */

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

	if ((tmp = getenv ("loadaddr")) != NULL) {
		addr = simple_strtoul (tmp, NULL, 16);
	} else {
		puts ("No load address provided\n");
		return 1;
	}

#if (CONFIG_COMMANDS & CFG_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 *) CFG_NVRAM_BASE_ADDR + 0x500;
	memcpy ((char *) tmp, (char *) &gd->bd->bi_enetaddr[3], 3);
#elif defined(CFG_VXWORKS_MAC_PTR)
	tmp = (char *) CFG_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 = 0x4200;
	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 {
#if defined(CONFIG_4xx)
		sprintf (build_buf, "ibmEmac(0,0)");

		if ((tmp = getenv ("hostname")) != NULL) {
			sprintf (&build_buf[strlen (build_buf - 1)],
				"host:%s ", tmp);
		} else {
			sprintf (&build_buf[strlen (build_buf - 1)],
				": ");
		}

		if ((tmp = getenv ("ipaddr")) != NULL) {
			sprintf (&build_buf[strlen (build_buf - 1)],
				"e=%s ", tmp);
		}
		memcpy ((void *)bootaddr, build_buf, MAX(strlen(build_buf), 255));
		flush_cache (bootaddr, MAX(strlen(build_buf), 255));
#elif defined(CONFIG_IOP480)
		sprintf (build_buf, "dc(0,0)");

		if ((tmp = getenv ("hostname")) != NULL) {
			sprintf (&build_buf[strlen (build_buf - 1)],
				"host:%s ", tmp);
		} else {
			sprintf (&build_buf[strlen (build_buf - 1)],
				": ");
		}

		if ((tmp = getenv ("ipaddr")) != NULL) {
			sprintf (&build_buf[strlen (build_buf - 1)],
				"e=%s ", tmp);
		}
		memcpy ((void *) bootaddr, build_buf, MAX(strlen(build_buf), 255));
		flush_cache (bootaddr, MAX(strlen(build_buf), 255));
#else

		/*
		 * I'm not sure what the device should be for other
		 * PPC flavors, the hostname and ipaddr should be ok
		 * to just copy
		 */

		puts ("No bootargs defined\n");
		return 1;
#endif
	}

	/*
	 * 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,
	"bootelf - Boot from an ELF image in memory\n",
	" [address] - load address of ELF image.\n"
);

U_BOOT_CMD(
	bootvx,      2,      0,      do_bootvx,
	"bootvx  - Boot vxWorks from an ELF image\n",
	" [address] - load address of vxWorks ELF image.\n"
);

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