cmd/source.c

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