common/cmd_ximg.c

   1 /*
   2  * (C) Copyright 2000-2004
   3  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4  *
   5  * (C) Copyright 2003
   6  * Kai-Uwe Bloem, Auerswald GmbH & Co KG, <linux-development@auerswald.de>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11
  12 /*
  13  * Multi Image extract
  14  */
  15 #include <common.h>
  16 #include <command.h>
  17 #include <image.h>
  18 #include <watchdog.h>
  19 #if defined(CONFIG_BZIP2)
  20 #include <bzlib.h>
  21 #endif
  22 #include <asm/byteorder.h>
  23 #include <asm/io.h>
  24
  25 #ifndef CONFIG_SYS_XIMG_LEN
  26 /* use 8MByte as default max gunzip size */
  27 #define CONFIG_SYS_XIMG_LEN     0x800000
  28 #endif
  29
  30 static int
  31 do_imgextract(cmd_tbl_t * cmdtp, int flag, int argc, char * const argv[])
  32 {
  33         ulong           addr = load_addr;
  34         ulong           dest = 0;
  35         ulong           data, len;
  36         int             verify;
  37         int             part = 0;
  38 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
  39         ulong           count;
  40         image_header_t  *hdr = NULL;
  41 #endif
  42 #if defined(CONFIG_FIT)
  43         const char      *uname = NULL;
  44         const void*     fit_hdr;
  45         int             noffset;
  46         const void      *fit_data;
  47         size_t          fit_len;
  48 #endif
  49 #ifdef CONFIG_GZIP
  50         uint            unc_len = CONFIG_SYS_XIMG_LEN;
  51 #endif
  52         uint8_t         comp;
  53
  54         verify = getenv_yesno("verify");
  55
  56         if (argc > 1) {
  57                 addr = simple_strtoul(argv[1], NULL, 16);
  58         }
  59         if (argc > 2) {
  60                 part = simple_strtoul(argv[2], NULL, 16);
  61 #if defined(CONFIG_FIT)
  62                 uname = argv[2];
  63 #endif
  64         }
  65         if (argc > 3) {
  66                 dest = simple_strtoul(argv[3], NULL, 16);
  67         }
  68
  69         switch (genimg_get_format((void *)addr)) {
  70 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
  71         case IMAGE_FORMAT_LEGACY:
  72
  73                 printf("## Copying part %d from legacy image "
  74                         "at %08lx ...\n", part, addr);
  75
  76                 hdr = (image_header_t *)addr;
  77                 if (!image_check_magic(hdr)) {
  78                         printf("Bad Magic Number\n");
  79                         return 1;
  80                 }
  81
  82                 if (!image_check_hcrc(hdr)) {
  83                         printf("Bad Header Checksum\n");
  84                         return 1;
  85                 }
  86 #ifdef DEBUG
  87                 image_print_contents(hdr);
  88 #endif
  89
  90                 if (!image_check_type(hdr, IH_TYPE_MULTI)) {
  91                         printf("Wrong Image Type for %s command\n",
  92                                         cmdtp->name);
  93                         return 1;
  94                 }
  95
  96                 comp = image_get_comp(hdr);
  97                 if ((comp != IH_COMP_NONE) && (argc < 4)) {
  98                         printf("Must specify load address for %s command "
  99                                         "with compressed image\n",
 100                                         cmdtp->name);
 101                         return 1;
 102                 }
 103
 104                 if (verify) {
 105                         printf("   Verifying Checksum ... ");
 106                         if (!image_check_dcrc(hdr)) {
 107                                 printf("Bad Data CRC\n");
 108                                 return 1;
 109                         }
 110                         printf("OK\n");
 111                 }
 112
 113                 count = image_multi_count(hdr);
 114                 if (part >= count) {
 115                         printf("Bad Image Part\n");
 116                         return 1;
 117                 }
 118
 119                 image_multi_getimg(hdr, part, &data, &len);
 120                 break;
 121 #endif
 122 #if defined(CONFIG_FIT)
 123         case IMAGE_FORMAT_FIT:
 124                 if (uname == NULL) {
 125                         puts("No FIT subimage unit name\n");
 126                         return 1;
 127                 }
 128
 129                 printf("## Copying '%s' subimage from FIT image "
 130                         "at %08lx ...\n", uname, addr);
 131
 132                 fit_hdr = (const void *)addr;
 133                 if (!fit_check_format(fit_hdr)) {
 134                         puts("Bad FIT image format\n");
 135                         return 1;
 136                 }
 137
 138                 /* get subimage node offset */
 139                 noffset = fit_image_get_node(fit_hdr, uname);
 140                 if (noffset < 0) {
 141                         printf("Can't find '%s' FIT subimage\n", uname);
 142                         return 1;
 143                 }
 144
 145                 if (fit_image_check_comp(fit_hdr, noffset, IH_COMP_NONE)
 146                     && (argc < 4)) {
 147                         printf("Must specify load address for %s command "
 148                                 "with compressed image\n",
 149                                 cmdtp->name);
 150                         return 1;
 151                 }
 152
 153                 /* verify integrity */
 154                 if (verify) {
 155                         if (!fit_image_verify(fit_hdr, noffset)) {
 156                                 puts("Bad Data Hash\n");
 157                                 return 1;
 158                         }
 159                 }
 160
 161                 /* get subimage data address and length */
 162                 if (fit_image_get_data(fit_hdr, noffset,
 163                                         &fit_data, &fit_len)) {
 164                         puts("Could not find script subimage data\n");
 165                         return 1;
 166                 }
 167
 168                 if (fit_image_get_comp(fit_hdr, noffset, &comp)) {
 169                         puts("Could not find script subimage "
 170                                 "compression type\n");
 171                         return 1;
 172                 }
 173
 174                 data = (ulong)fit_data;
 175                 len = (ulong)fit_len;
 176                 break;
 177 #endif
 178         default:
 179                 puts("Invalid image type for imxtract\n");
 180                 return 1;
 181         }
 182
 183         if (argc > 3) {
 184                 switch (comp) {
 185                 case IH_COMP_NONE:
 186 #if defined(CONFIG_HW_WATCHDOG) || defined(CONFIG_WATCHDOG)
 187                         {
 188                                 size_t l = len;
 189                                 size_t tail;
 190                                 void *to = (void *) dest;
 191                                 void *from = (void *)data;
 192
 193                                 printf("   Loading part %d ... ", part);
 194
 195                                 while (l > 0) {
 196                                         tail = (l > CHUNKSZ) ? CHUNKSZ : l;
 197                                         WATCHDOG_RESET();
 198                                         memmove(to, from, tail);
 199                                         to += tail;
 200                                         from += tail;
 201                                         l -= tail;
 202                                 }
 203                         }
 204 #else   /* !(CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG) */
 205                         printf("   Loading part %d ... ", part);
 206                         memmove((char *) dest, (char *)data, len);
 207 #endif  /* CONFIG_HW_WATCHDOG || CONFIG_WATCHDOG */
 208                         break;
 209 #ifdef CONFIG_GZIP
 210                 case IH_COMP_GZIP:
 211                         printf("   Uncompressing part %d ... ", part);
 212                         if (gunzip((void *) dest, unc_len,
 213                                    (uchar *) data, &len) != 0) {
 214                                 puts("GUNZIP ERROR - image not loaded\n");
 215                                 return 1;
 216                         }
 217                         break;
 218 #endif
 219 #if defined(CONFIG_BZIP2) && defined(CONFIG_IMAGE_FORMAT_LEGACY)
 220                 case IH_COMP_BZIP2:
 221                         {
 222                                 int i;
 223
 224                                 printf("   Uncompressing part %d ... ", part);
 225                                 /*
 226                                  * If we've got less than 4 MB of malloc()
 227                                  * space, use slower decompression algorithm
 228                                  * which requires at most 2300 KB of memory.
 229                                  */
 230                                 i = BZ2_bzBuffToBuffDecompress(
 231                                         map_sysmem(ntohl(hdr->ih_load), 0),
 232                                         &unc_len, (char *)data, len,
 233                                         CONFIG_SYS_MALLOC_LEN < (4096 * 1024),
 234                                         0);
 235                                 if (i != BZ_OK) {
 236                                         printf("BUNZIP2 ERROR %d - "
 237                                                 "image not loaded\n", i);
 238                                         return 1;
 239                                 }
 240                         }
 241                         break;
 242 #endif /* CONFIG_BZIP2 */
 243                 default:
 244                         printf("Unimplemented compression type %d\n", comp);
 245                         return 1;
 246                 }
 247                 puts("OK\n");
 248         }
 249
 250         flush_cache(dest, len);
 251
 252         setenv_hex("fileaddr", data);
 253         setenv_hex("filesize", len);
 254
 255         return 0;
 256 }
 257
 258 #ifdef CONFIG_SYS_LONGHELP
 259 static char imgextract_help_text[] =
 260         "addr part [dest]\n"
 261         "    - extract <part> from legacy image at <addr> and copy to <dest>"
 262 #if defined(CONFIG_FIT)
 263         "\n"
 264         "addr uname [dest]\n"
 265         "    - extract <uname> subimage from FIT image at <addr> and copy to <dest>"
 266 #endif
 267         "";
 268 #endif
 269
 270 U_BOOT_CMD(
 271         imxtract, 4, 1, do_imgextract,
 272         "extract a part of a multi-image", imgextract_help_text
 273 );