[J-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 defined(CONFIG_WALNUT) || defined(CFG_VXWORKS_MAC_PTR)
DECLARE_GLOBAL_DATA_PTR;
#endif

#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);

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

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