common/cmd_source.c

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