common/cmd_source.c

   1 /*
   2  * (C) Copyright 2001
   3  * Kyle Harris, kharris@nexus-tech.net
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 /*
  25  * The "source" command allows to define "script images", i. e. files
  26  * that contain command sequences that can be executed by the command
  27  * interpreter. It returns the exit status of the last command
  28  * executed from the script. This is very similar to running a shell
  29  * script in a UNIX shell, hence the name for the command.
  30  */
  31
  32 /* #define DEBUG */
  33
  34 #include <common.h>
  35 #include <command.h>
  36 #include <image.h>
  37 #include <malloc.h>
  38 #include <asm/byteorder.h>
  39 #include <asm/io.h>
  40 #if defined(CONFIG_8xx)
  41 #include <mpc8xx.h>
  42 #endif
  43
  44 int
  45 source (ulong addr, const char *fit_uname)
  46 {
  47         ulong           len;
  48         const image_header_t *hdr;
  49         ulong           *data;
  50         int             verify;
  51         void *buf;
  52 #if defined(CONFIG_FIT)
  53         const void*     fit_hdr;
  54         int             noffset;
  55         const void      *fit_data;
  56         size_t          fit_len;
  57 #endif
  58
  59         verify = getenv_yesno ("verify");
  60
  61         buf = map_sysmem(addr, 0);
  62         switch (genimg_get_format(buf)) {
  63         case IMAGE_FORMAT_LEGACY:
  64                 hdr = buf;
  65
  66                 if (!image_check_magic (hdr)) {
  67                         puts ("Bad magic number\n");
  68                         return 1;
  69                 }
  70
  71                 if (!image_check_hcrc (hdr)) {
  72                         puts ("Bad header crc\n");
  73                         return 1;
  74                 }
  75
  76                 if (verify) {
  77                         if (!image_check_dcrc (hdr)) {
  78                                 puts ("Bad data crc\n");
  79                                 return 1;
  80                         }
  81                 }
  82
  83                 if (!image_check_type (hdr, IH_TYPE_SCRIPT)) {
  84                         puts ("Bad image type\n");
  85                         return 1;
  86                 }
  87
  88                 /* get length of script */
  89                 data = (ulong *)image_get_data (hdr);
  90
  91                 if ((len = uimage_to_cpu (*data)) == 0) {
  92                         puts ("Empty Script\n");
  93                         return 1;
  94                 }
  95
  96                 /*
  97                  * scripts are just multi-image files with one component, seek
  98                  * past the zero-terminated sequence of image lengths to get
  99                  * to the actual image data
 100                  */
 101                 while (*data++);
 102                 break;
 103 #if defined(CONFIG_FIT)
 104         case IMAGE_FORMAT_FIT:
 105                 if (fit_uname == NULL) {
 106                         puts ("No FIT subimage unit name\n");
 107                         return 1;
 108                 }
 109
 110                 fit_hdr = buf;
 111                 if (!fit_check_format (fit_hdr)) {
 112                         puts ("Bad FIT image format\n");
 113                         return 1;
 114                 }
 115
 116                 /* get script component image node offset */
 117                 noffset = fit_image_get_node (fit_hdr, fit_uname);
 118                 if (noffset < 0) {
 119                         printf ("Can't find '%s' FIT subimage\n", fit_uname);
 120                         return 1;
 121                 }
 122
 123                 if (!fit_image_check_type (fit_hdr, noffset, IH_TYPE_SCRIPT)) {
 124                         puts ("Not a image image\n");
 125                         return 1;
 126                 }
 127
 128                 /* verify integrity */
 129                 if (verify) {
 130                         if (!fit_image_verify(fit_hdr, noffset)) {
 131                                 puts ("Bad Data Hash\n");
 132                                 return 1;
 133                         }
 134                 }
 135
 136                 /* get script subimage data address and length */
 137                 if (fit_image_get_data (fit_hdr, noffset, &fit_data, &fit_len)) {
 138                         puts ("Could not find script subimage data\n");
 139                         return 1;
 140                 }
 141
 142                 data = (ulong *)fit_data;
 143                 len = (ulong)fit_len;
 144                 break;
 145 #endif
 146         default:
 147                 puts ("Wrong image format for \"source\" command\n");
 148                 return 1;
 149         }
 150
 151         debug ("** Script length: %ld\n", len);
 152         return run_command_list((char *)data, len, 0);
 153 }
 154
 155 /**************************************************/
 156 #if defined(CONFIG_CMD_SOURCE)
 157 int
 158 do_source (cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
 159 {
 160         ulong addr;
 161         int rcode;
 162         const char *fit_uname = NULL;
 163
 164         /* Find script image */
 165         if (argc < 2) {
 166                 addr = CONFIG_SYS_LOAD_ADDR;
 167                 debug ("*  source: default load address = 0x%08lx\n", addr);
 168 #if defined(CONFIG_FIT)
 169         } else if (fit_parse_subimage (argv[1], load_addr, &addr, &fit_uname)) {
 170                 debug ("*  source: subimage '%s' from FIT image at 0x%08lx\n",
 171                                 fit_uname, addr);
 172 #endif
 173         } else {
 174                 addr = simple_strtoul(argv[1], NULL, 16);
 175                 debug ("*  source: cmdline image address = 0x%08lx\n", addr);
 176         }
 177
 178         printf ("## Executing script at %08lx\n", addr);
 179         rcode = source (addr, fit_uname);
 180         return rcode;
 181 }
 182
 183 #ifdef CONFIG_SYS_LONGHELP
 184 static char source_help_text[] =
 185         "[addr]\n"
 186         "\t- run script starting at addr\n"
 187         "\t- A valid image header must be present"
 188 #if defined(CONFIG_FIT)
 189         "\n"
 190         "For FIT format uImage addr must include subimage\n"
 191         "unit name in the form of addr:<subimg_uname>"
 192 #endif
 193         "";
 194 #endif
 195
 196 U_BOOT_CMD(
 197         source, 2, 0,   do_source,
 198         "run script from memory", source_help_text
 199 );
 200 #endif