common/cmd_elf.c

   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>
  20 #include <elf.h>
  21 #include <vxworks.h>
  22
  23 #if defined(CONFIG_WALNUT) || defined(CONFIG_SYS_VXWORKS_MAC_PTR)
  24 DECLARE_GLOBAL_DATA_PTR;
  25 #endif
  26
  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[])
  33 {
  34         unsigned long ret;
  35
  36         /*
  37          * QNX images require the data cache is disabled.
  38          * Data cache is already flushed, so just turn it off.
  39          */
  40         int dcache = dcache_status ();
  41         if (dcache)
  42                 dcache_disable ();
  43
  44         /*
  45          * pass address parameter as argv[0] (aka command name),
  46          * and all remaining args
  47          */
  48         ret = entry (argc, argv);
  49
  50         if (dcache)
  51                 dcache_enable ();
  52
  53         return ret;
  54 }
  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
  79         /*
  80          * pass address parameter as argv[0] (aka command name),
  81          * and all remaining args
  82          */
  83         rc = do_bootelf_exec ((void *)addr, argc - 1, argv + 1);
  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  * ====================================================================== */
  96 int do_bootvx (cmd_tbl_t *cmdtp, int flag, int argc, char *argv[])
  97 {
  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      */
 102         char build_buf[128];            /* Buffer for building the bootline */
 103
 104         /* ---------------------------------------------------
 105          *
 106          * Check the loadaddr variable.
 107          * If we don't know where the image is then we're done.
 108          */
 109
 110         if (argc < 2)
 111                 addr = load_addr;
 112         else
 113                 addr = simple_strtoul (argv[1], NULL, 16);
 114
 115 #if defined(CONFIG_CMD_NET)
 116         /* Check to see if we need to tftp the image ourselves before starting */
 117
 118         if ((argc == 2) && (strcmp (argv[1], "tftp") == 0)) {
 119                 if (NetLoop (TFTP) <= 0)
 120                         return 1;
 121                 printf ("Automatic boot of VxWorks image at address 0x%08lx ... \n",
 122                      addr);
 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
 132 #if defined(CONFIG_WALNUT)
 133         tmp = (char *) CONFIG_SYS_NVRAM_BASE_ADDR + 0x500;
 134         eth_getenv_enetaddr("ethaddr", (uchar *)build_buf);
 135         memcpy(tmp, &build_buf[3], 3);
 136 #elif defined(CONFIG_SYS_VXWORKS_MAC_PTR)
 137         tmp = (char *) CONFIG_SYS_VXWORKS_MAC_PTR;
 138         eth_getenv_enetaddr("ethaddr", (uchar *)build_buf);
 139         memcpy(tmp, build_buf, 6);
 140 #else
 141         puts ("## Ethernet MAC address not copied to NV RAM\n");
 142 #endif
 143
 144         /*
 145          * Use bootaddr to find the location in memory that VxWorks
 146          * will look for the bootline string. The default value for
 147          * PowerPC is LOCAL_MEM_LOCAL_ADRS + BOOT_LINE_OFFSET which
 148          * defaults to 0x4200
 149          */
 150
 151         if ((tmp = getenv ("bootaddr")) == NULL)
 152                 bootaddr = CONFIG_SYS_VXWORKS_BOOT_ADDR;
 153         else
 154                 bootaddr = simple_strtoul (tmp, NULL, 16);
 155
 156         /*
 157          * Check to see if the bootline is defined in the 'bootargs'
 158          * parameter. If it is not defined, we may be able to
 159          * construct the info
 160          */
 161
 162         if ((bootline = getenv ("bootargs")) != NULL) {
 163                 memcpy ((void *) bootaddr, bootline,
 164                         max (strlen (bootline), 255));
 165                 flush_cache (bootaddr, max (strlen (bootline), 255));
 166         } else {
 167
 168
 169                 sprintf (build_buf, CONFIG_SYS_VXWORKS_BOOT_DEVICE);
 170                 if ((tmp = getenv ("bootfile")) != NULL) {
 171                         sprintf (&build_buf[strlen (build_buf)],
 172                                  "%s:%s ", CONFIG_SYS_VXWORKS_SERVERNAME, tmp);
 173                 } else {
 174                         sprintf (&build_buf[strlen (build_buf)],
 175                                  "%s:file ", CONFIG_SYS_VXWORKS_SERVERNAME);
 176                 }
 177
 178                 if ((tmp = getenv ("ipaddr")) != NULL) {
 179                         sprintf (&build_buf[strlen (build_buf)], "e=%s ", tmp);
 180                 }
 181
 182                 if ((tmp = getenv ("serverip")) != NULL) {
 183                         sprintf (&build_buf[strlen (build_buf)], "h=%s ", tmp);
 184                 }
 185
 186                 if ((tmp = getenv ("hostname")) != NULL) {
 187                         sprintf (&build_buf[strlen (build_buf)], "tn=%s ", tmp);
 188                 }
 189 #ifdef CONFIG_SYS_VXWORKS_ADD_PARAMS
 190                 sprintf (&build_buf[strlen (build_buf)],
 191                          CONFIG_SYS_VXWORKS_ADD_PARAMS);
 192 #endif
 193
 194                 memcpy ((void *) bootaddr, build_buf,
 195                         max (strlen (build_buf), 255));
 196                 flush_cache (bootaddr, max (strlen (build_buf), 255));
 197         }
 198
 199         /*
 200          * If the data at the load address is an elf image, then
 201          * treat it like an elf image. Otherwise, assume that it is a
 202          * binary image
 203          */
 204
 205         if (valid_elf_image (addr)) {
 206                 addr = load_elf_image (addr);
 207         } else {
 208                 puts ("## Not an ELF image, assuming binary\n");
 209                 /* leave addr as load_addr */
 210         }
 211
 212         printf ("## Using bootline (@ 0x%lx): %s\n", bootaddr,
 213                         (char *) bootaddr);
 214         printf ("## Starting vxWorks at 0x%08lx ...\n", addr);
 215
 216         ((void (*)(void)) addr) ();
 217
 218         puts ("## vxWorks terminated\n");
 219         return 1;
 220 }
 221
 222 /* ======================================================================
 223  * Determine if a valid ELF image exists at the given memory location.
 224  * First looks at the ELF header magic field, the makes sure that it is
 225  * executable and makes sure that it is for a PowerPC.
 226  * ====================================================================== */
 227 int valid_elf_image (unsigned long addr)
 228 {
 229         Elf32_Ehdr *ehdr;               /* Elf header structure pointer */
 230
 231         /* -------------------------------------------------- */
 232
 233         ehdr = (Elf32_Ehdr *) addr;
 234
 235         if (!IS_ELF (*ehdr)) {
 236                 printf ("## No elf image at address 0x%08lx\n", addr);
 237                 return 0;
 238         }
 239
 240         if (ehdr->e_type != ET_EXEC) {
 241                 printf ("## Not a 32-bit elf image at address 0x%08lx\n", addr);
 242                 return 0;
 243         }
 244
 245 #if 0
 246         if (ehdr->e_machine != EM_PPC) {
 247                 printf ("## Not a PowerPC elf image at address 0x%08lx\n",
 248                         addr);
 249                 return 0;
 250         }
 251 #endif
 252
 253         return 1;
 254 }
 255
 256 /* ======================================================================
 257  * A very simple elf loader, assumes the image is valid, returns the
 258  * entry point address.
 259  * ====================================================================== */
 260 unsigned long load_elf_image (unsigned long addr)
 261 {
 262         Elf32_Ehdr *ehdr;               /* Elf header structure pointer     */
 263         Elf32_Shdr *shdr;               /* Section header structure pointer */
 264         unsigned char *strtab = 0;      /* String table pointer             */
 265         unsigned char *image;           /* Binary image pointer             */
 266         int i;                          /* Loop counter                     */
 267
 268         /* -------------------------------------------------- */
 269
 270         ehdr = (Elf32_Ehdr *) addr;
 271
 272         /* Find the section header string table for output info */
 273         shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
 274                                (ehdr->e_shstrndx * sizeof (Elf32_Shdr)));
 275
 276         if (shdr->sh_type == SHT_STRTAB)
 277                 strtab = (unsigned char *) (addr + shdr->sh_offset);
 278
 279         /* Load each appropriate section */
 280         for (i = 0; i < ehdr->e_shnum; ++i) {
 281                 shdr = (Elf32_Shdr *) (addr + ehdr->e_shoff +
 282                                        (i * sizeof (Elf32_Shdr)));
 283
 284                 if (!(shdr->sh_flags & SHF_ALLOC)
 285                    || shdr->sh_addr == 0 || shdr->sh_size == 0) {
 286                         continue;
 287                 }
 288
 289                 if (strtab) {
 290                         printf ("%sing %s @ 0x%08lx (%ld bytes)\n",
 291                                 (shdr->sh_type == SHT_NOBITS) ?
 292                                         "Clear" : "Load",
 293                                 &strtab[shdr->sh_name],
 294                                 (unsigned long) shdr->sh_addr,
 295                                 (long) shdr->sh_size);
 296                 }
 297
 298                 if (shdr->sh_type == SHT_NOBITS) {
 299                         memset ((void *)shdr->sh_addr, 0, shdr->sh_size);
 300                 } else {
 301                         image = (unsigned char *) addr + shdr->sh_offset;
 302                         memcpy ((void *) shdr->sh_addr,
 303                                 (const void *) image,
 304                                 shdr->sh_size);
 305                 }
 306                 flush_cache (shdr->sh_addr, shdr->sh_size);
 307         }
 308
 309         return ehdr->e_entry;
 310 }
 311
 312 /* ====================================================================== */
 313 U_BOOT_CMD(
 314         bootelf,      2,      0,      do_bootelf,
 315         "Boot from an ELF image in memory",
 316         " [address] - load address of ELF image.\n"
 317 );
 318
 319 U_BOOT_CMD(
 320         bootvx,      2,      0,      do_bootvx,
 321         "Boot vxWorks from an ELF image",
 322         " [address] - load address of vxWorks ELF image.\n"
 323 );