boot/image.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2008 Semihalf
   4  *
   5  * (C) Copyright 2000-2006
   6  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   7  */
   8
   9 #ifndef USE_HOSTCC
  10 #include <common.h>
  11 #include <env.h>
  12 #include <lmb.h>
  13 #include <log.h>
  14 #include <malloc.h>
  15 #include <u-boot/crc.h>
  16
  17 #ifdef CONFIG_SHOW_BOOT_PROGRESS
  18 #include <status_led.h>
  19 #endif
  20
  21 #if CONFIG_IS_ENABLED(FIT) || CONFIG_IS_ENABLED(OF_LIBFDT)
  22 #include <linux/libfdt.h>
  23 #include <fdt_support.h>
  24 #endif
  25
  26 #include <asm/global_data.h>
  27 #include <u-boot/md5.h>
  28 #include <u-boot/sha1.h>
  29 #include <linux/errno.h>
  30 #include <asm/io.h>
  31
  32 #ifdef CONFIG_CMD_BDI
  33 extern int do_bdinfo(struct cmd_tbl *cmdtp, int flag, int argc,
  34                      char *const argv[]);
  35 #endif
  36
  37 DECLARE_GLOBAL_DATA_PTR;
  38
  39 /* Set this if we have less than 4 MB of malloc() space */
  40 #if CONFIG_SYS_MALLOC_LEN < (4096 * 1024)
  41 #define CONSERVE_MEMORY         true
  42 #else
  43 #define CONSERVE_MEMORY         false
  44 #endif
  45
  46 #else /* USE_HOSTCC */
  47 #include "mkimage.h"
  48 #include <u-boot/md5.h>
  49 #include <time.h>
  50
  51 #ifndef __maybe_unused
  52 # define __maybe_unused         /* unimplemented */
  53 #endif
  54
  55 #define CONSERVE_MEMORY         false
  56
  57 #endif /* !USE_HOSTCC*/
  58
  59 #include <abuf.h>
  60 #include <bzlib.h>
  61 #include <display_options.h>
  62 #include <gzip.h>
  63 #include <image.h>
  64 #include <imximage.h>
  65 #include <relocate.h>
  66 #include <linux/lzo.h>
  67 #include <linux/zstd.h>
  68 #include <linux/kconfig.h>
  69 #include <lzma/LzmaTypes.h>
  70 #include <lzma/LzmaDec.h>
  71 #include <lzma/LzmaTools.h>
  72 #include <u-boot/crc.h>
  73 #include <u-boot/lz4.h>
  74
  75 static const table_entry_t uimage_arch[] = {
  76         {       IH_ARCH_INVALID,        "invalid",      "Invalid ARCH", },
  77         {       IH_ARCH_ALPHA,          "alpha",        "Alpha",        },
  78         {       IH_ARCH_ARM,            "arm",          "ARM",          },
  79         {       IH_ARCH_I386,           "x86",          "Intel x86",    },
  80         {       IH_ARCH_IA64,           "ia64",         "IA64",         },
  81         {       IH_ARCH_M68K,           "m68k",         "M68K",         },
  82         {       IH_ARCH_MICROBLAZE,     "microblaze",   "MicroBlaze",   },
  83         {       IH_ARCH_MIPS,           "mips",         "MIPS",         },
  84         {       IH_ARCH_MIPS64,         "mips64",       "MIPS 64 Bit",  },
  85         {       IH_ARCH_NIOS2,          "nios2",        "NIOS II",      },
  86         {       IH_ARCH_PPC,            "powerpc",      "PowerPC",      },
  87         {       IH_ARCH_PPC,            "ppc",          "PowerPC",      },
  88         {       IH_ARCH_S390,           "s390",         "IBM S390",     },
  89         {       IH_ARCH_SH,             "sh",           "SuperH",       },
  90         {       IH_ARCH_SPARC,          "sparc",        "SPARC",        },
  91         {       IH_ARCH_SPARC64,        "sparc64",      "SPARC 64 Bit", },
  92         {       IH_ARCH_BLACKFIN,       "blackfin",     "Blackfin",     },
  93         {       IH_ARCH_AVR32,          "avr32",        "AVR32",        },
  94         {       IH_ARCH_NDS32,          "nds32",        "NDS32",        },
  95         {       IH_ARCH_OPENRISC,       "or1k",         "OpenRISC 1000",},
  96         {       IH_ARCH_SANDBOX,        "sandbox",      "Sandbox",      },
  97         {       IH_ARCH_ARM64,          "arm64",        "AArch64",      },
  98         {       IH_ARCH_ARC,            "arc",          "ARC",          },
  99         {       IH_ARCH_X86_64,         "x86_64",       "AMD x86_64",   },
 100         {       IH_ARCH_XTENSA,         "xtensa",       "Xtensa",       },
 101         {       IH_ARCH_RISCV,          "riscv",        "RISC-V",       },
 102         {       -1,                     "",             "",             },
 103 };
 104
 105 static const table_entry_t uimage_os[] = {
 106         {       IH_OS_INVALID,  "invalid",      "Invalid OS",           },
 107         {       IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware"  },
 108         {       IH_OS_LINUX,    "linux",        "Linux",                },
 109 #if defined(USE_HOSTCC)
 110         {       IH_OS_LYNXOS,   "lynxos",       "LynxOS",               },
 111 #endif
 112         {       IH_OS_NETBSD,   "netbsd",       "NetBSD",               },
 113         {       IH_OS_OSE,      "ose",          "Enea OSE",             },
 114         {       IH_OS_PLAN9,    "plan9",        "Plan 9",               },
 115         {       IH_OS_RTEMS,    "rtems",        "RTEMS",                },
 116         {       IH_OS_TEE,      "tee",          "Trusted Execution Environment" },
 117         {       IH_OS_U_BOOT,   "u-boot",       "U-Boot",               },
 118         {       IH_OS_VXWORKS,  "vxworks",      "VxWorks",              },
 119 #if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
 120         {       IH_OS_QNX,      "qnx",          "QNX",                  },
 121 #endif
 122 #if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
 123         {       IH_OS_INTEGRITY,"integrity",    "INTEGRITY",            },
 124 #endif
 125 #ifdef USE_HOSTCC
 126         {       IH_OS_4_4BSD,   "4_4bsd",       "4_4BSD",               },
 127         {       IH_OS_DELL,     "dell",         "Dell",                 },
 128         {       IH_OS_ESIX,     "esix",         "Esix",                 },
 129         {       IH_OS_FREEBSD,  "freebsd",      "FreeBSD",              },
 130         {       IH_OS_IRIX,     "irix",         "Irix",                 },
 131         {       IH_OS_NCR,      "ncr",          "NCR",                  },
 132         {       IH_OS_OPENBSD,  "openbsd",      "OpenBSD",              },
 133         {       IH_OS_PSOS,     "psos",         "pSOS",                 },
 134         {       IH_OS_SCO,      "sco",          "SCO",                  },
 135         {       IH_OS_SOLARIS,  "solaris",      "Solaris",              },
 136         {       IH_OS_SVR4,     "svr4",         "SVR4",                 },
 137 #endif
 138 #if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
 139         {       IH_OS_OPENRTOS, "openrtos",     "OpenRTOS",             },
 140 #endif
 141         {       IH_OS_OPENSBI,  "opensbi",      "RISC-V OpenSBI",       },
 142         {       IH_OS_EFI,      "efi",          "EFI Firmware" },
 143
 144         {       -1,             "",             "",                     },
 145 };
 146
 147 static const table_entry_t uimage_type[] = {
 148         {       IH_TYPE_AISIMAGE,   "aisimage",   "Davinci AIS image",},
 149         {       IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image",   },
 150         {       IH_TYPE_FIRMWARE,   "firmware",   "Firmware",           },
 151         {       IH_TYPE_FLATDT,     "flat_dt",    "Flat Device Tree",   },
 152         {       IH_TYPE_GPIMAGE,    "gpimage",    "TI Keystone SPL Image",},
 153         {       IH_TYPE_KERNEL,     "kernel",     "Kernel Image",       },
 154         {       IH_TYPE_KERNEL_NOLOAD, "kernel_noload",  "Kernel Image (no loading done)", },
 155         {       IH_TYPE_KWBIMAGE,   "kwbimage",   "Kirkwood Boot Image",},
 156         {       IH_TYPE_IMXIMAGE,   "imximage",   "Freescale i.MX Boot Image",},
 157         {       IH_TYPE_IMX8IMAGE,  "imx8image",  "NXP i.MX8 Boot Image",},
 158         {       IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
 159         {       IH_TYPE_INVALID,    "invalid",    "Invalid Image",      },
 160         {       IH_TYPE_MULTI,      "multi",      "Multi-File Image",   },
 161         {       IH_TYPE_OMAPIMAGE,  "omapimage",  "TI OMAP SPL With GP CH",},
 162         {       IH_TYPE_PBLIMAGE,   "pblimage",   "Freescale PBL Boot Image",},
 163         {       IH_TYPE_RAMDISK,    "ramdisk",    "RAMDisk Image",      },
 164         {       IH_TYPE_SCRIPT,     "script",     "Script",             },
 165         {       IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
 166         {       IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
 167         {       IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
 168         {       IH_TYPE_UBLIMAGE,   "ublimage",   "Davinci UBL image",},
 169         {       IH_TYPE_MXSIMAGE,   "mxsimage",   "Freescale MXS Boot Image",},
 170         {       IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
 171         {       IH_TYPE_X86_SETUP,  "x86_setup",  "x86 setup.bin",    },
 172         {       IH_TYPE_LPC32XXIMAGE, "lpc32xximage",  "LPC32XX Boot Image", },
 173         {       IH_TYPE_RKIMAGE,    "rkimage",    "Rockchip Boot Image" },
 174         {       IH_TYPE_RKSD,       "rksd",       "Rockchip SD Boot Image" },
 175         {       IH_TYPE_RKSPI,      "rkspi",      "Rockchip SPI Boot Image" },
 176         {       IH_TYPE_VYBRIDIMAGE, "vybridimage",  "Vybrid Boot Image", },
 177         {       IH_TYPE_ZYNQIMAGE,  "zynqimage",  "Xilinx Zynq Boot Image" },
 178         {       IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
 179         {       IH_TYPE_ZYNQMPBIF,  "zynqmpbif",  "Xilinx ZynqMP Boot Image (bif)" },
 180         {       IH_TYPE_FPGA,       "fpga",       "FPGA Image" },
 181         {       IH_TYPE_TEE,        "tee",        "Trusted Execution Environment Image",},
 182         {       IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
 183         {       IH_TYPE_PMMC,        "pmmc",        "TI Power Management Micro-Controller Firmware",},
 184         {       IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
 185         {       IH_TYPE_MTKIMAGE,   "mtk_image",   "MediaTek BootROM loadable Image" },
 186         {       IH_TYPE_COPRO, "copro", "Coprocessor Image"},
 187         {       IH_TYPE_SUNXI_EGON, "sunxi_egon",  "Allwinner eGON Boot Image" },
 188         {       -1,                 "",           "",                   },
 189 };
 190
 191 static const table_entry_t uimage_comp[] = {
 192         {       IH_COMP_NONE,   "none",         "uncompressed",         },
 193         {       IH_COMP_BZIP2,  "bzip2",        "bzip2 compressed",     },
 194         {       IH_COMP_GZIP,   "gzip",         "gzip compressed",      },
 195         {       IH_COMP_LZMA,   "lzma",         "lzma compressed",      },
 196         {       IH_COMP_LZO,    "lzo",          "lzo compressed",       },
 197         {       IH_COMP_LZ4,    "lz4",          "lz4 compressed",       },
 198         {       IH_COMP_ZSTD,   "zstd",         "zstd compressed",      },
 199         {       -1,             "",             "",                     },
 200 };
 201
 202 struct table_info {
 203         const char *desc;
 204         int count;
 205         const table_entry_t *table;
 206 };
 207
 208 static const struct comp_magic_map image_comp[] = {
 209         {       IH_COMP_BZIP2,  "bzip2",        {0x42, 0x5a},},
 210         {       IH_COMP_GZIP,   "gzip",         {0x1f, 0x8b},},
 211         {       IH_COMP_LZMA,   "lzma",         {0x5d, 0x00},},
 212         {       IH_COMP_LZO,    "lzo",          {0x89, 0x4c},},
 213         {       IH_COMP_LZ4,    "lz4",          {0x04, 0x22},},
 214         {       IH_COMP_ZSTD,   "zstd",         {0x28, 0xb5},},
 215         {       IH_COMP_NONE,   "none",         {},     },
 216 };
 217
 218 static const struct table_info table_info[IH_COUNT] = {
 219         { "architecture", IH_ARCH_COUNT, uimage_arch },
 220         { "compression", IH_COMP_COUNT, uimage_comp },
 221         { "operating system", IH_OS_COUNT, uimage_os },
 222         { "image type", IH_TYPE_COUNT, uimage_type },
 223 };
 224
 225 /*****************************************************************************/
 226 /* Legacy format routines */
 227 /*****************************************************************************/
 228 int image_check_hcrc(const image_header_t *hdr)
 229 {
 230         ulong hcrc;
 231         ulong len = image_get_header_size();
 232         image_header_t header;
 233
 234         /* Copy header so we can blank CRC field for re-calculation */
 235         memmove(&header, (char *)hdr, image_get_header_size());
 236         image_set_hcrc(&header, 0);
 237
 238         hcrc = crc32(0, (unsigned char *)&header, len);
 239
 240         return (hcrc == image_get_hcrc(hdr));
 241 }
 242
 243 int image_check_dcrc(const image_header_t *hdr)
 244 {
 245         ulong data = image_get_data(hdr);
 246         ulong len = image_get_data_size(hdr);
 247         ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
 248
 249         return (dcrc == image_get_dcrc(hdr));
 250 }
 251
 252 /**
 253  * image_multi_count - get component (sub-image) count
 254  * @hdr: pointer to the header of the multi component image
 255  *
 256  * image_multi_count() returns number of components in a multi
 257  * component image.
 258  *
 259  * Note: no checking of the image type is done, caller must pass
 260  * a valid multi component image.
 261  *
 262  * returns:
 263  *     number of components
 264  */
 265 ulong image_multi_count(const image_header_t *hdr)
 266 {
 267         ulong i, count = 0;
 268         uint32_t *size;
 269
 270         /* get start of the image payload, which in case of multi
 271          * component images that points to a table of component sizes */
 272         size = (uint32_t *)image_get_data(hdr);
 273
 274         /* count non empty slots */
 275         for (i = 0; size[i]; ++i)
 276                 count++;
 277
 278         return count;
 279 }
 280
 281 /**
 282  * image_multi_getimg - get component data address and size
 283  * @hdr: pointer to the header of the multi component image
 284  * @idx: index of the requested component
 285  * @data: pointer to a ulong variable, will hold component data address
 286  * @len: pointer to a ulong variable, will hold component size
 287  *
 288  * image_multi_getimg() returns size and data address for the requested
 289  * component in a multi component image.
 290  *
 291  * Note: no checking of the image type is done, caller must pass
 292  * a valid multi component image.
 293  *
 294  * returns:
 295  *     data address and size of the component, if idx is valid
 296  *     0 in data and len, if idx is out of range
 297  */
 298 void image_multi_getimg(const image_header_t *hdr, ulong idx,
 299                         ulong *data, ulong *len)
 300 {
 301         int i;
 302         uint32_t *size;
 303         ulong offset, count, img_data;
 304
 305         /* get number of component */
 306         count = image_multi_count(hdr);
 307
 308         /* get start of the image payload, which in case of multi
 309          * component images that points to a table of component sizes */
 310         size = (uint32_t *)image_get_data(hdr);
 311
 312         /* get address of the proper component data start, which means
 313          * skipping sizes table (add 1 for last, null entry) */
 314         img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
 315
 316         if (idx < count) {
 317                 *len = uimage_to_cpu(size[idx]);
 318                 offset = 0;
 319
 320                 /* go over all indices preceding requested component idx */
 321                 for (i = 0; i < idx; i++) {
 322                         /* add up i-th component size, rounding up to 4 bytes */
 323                         offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
 324                 }
 325
 326                 /* calculate idx-th component data address */
 327                 *data = img_data + offset;
 328         } else {
 329                 *len = 0;
 330                 *data = 0;
 331         }
 332 }
 333
 334 static void image_print_type(const image_header_t *hdr)
 335 {
 336         const char __maybe_unused *os, *arch, *type, *comp;
 337
 338         os = genimg_get_os_name(image_get_os(hdr));
 339         arch = genimg_get_arch_name(image_get_arch(hdr));
 340         type = genimg_get_type_name(image_get_type(hdr));
 341         comp = genimg_get_comp_name(image_get_comp(hdr));
 342
 343         printf("%s %s %s (%s)\n", arch, os, type, comp);
 344 }
 345
 346 /**
 347  * image_print_contents - prints out the contents of the legacy format image
 348  * @ptr: pointer to the legacy format image header
 349  * @p: pointer to prefix string
 350  *
 351  * image_print_contents() formats a multi line legacy image contents description.
 352  * The routine prints out all header fields followed by the size/offset data
 353  * for MULTI/SCRIPT images.
 354  *
 355  * returns:
 356  *     no returned results
 357  */
 358 void image_print_contents(const void *ptr)
 359 {
 360         const image_header_t *hdr = (const image_header_t *)ptr;
 361         const char __maybe_unused *p;
 362
 363         p = IMAGE_INDENT_STRING;
 364         printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
 365         if (IMAGE_ENABLE_TIMESTAMP) {
 366                 printf("%sCreated:      ", p);
 367                 genimg_print_time((time_t)image_get_time(hdr));
 368         }
 369         printf("%sImage Type:   ", p);
 370         image_print_type(hdr);
 371         printf("%sData Size:    ", p);
 372         genimg_print_size(image_get_data_size(hdr));
 373         printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
 374         printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
 375
 376         if (image_check_type(hdr, IH_TYPE_MULTI) ||
 377                         image_check_type(hdr, IH_TYPE_SCRIPT)) {
 378                 int i;
 379                 ulong data, len;
 380                 ulong count = image_multi_count(hdr);
 381
 382                 printf("%sContents:\n", p);
 383                 for (i = 0; i < count; i++) {
 384                         image_multi_getimg(hdr, i, &data, &len);
 385
 386                         printf("%s   Image %d: ", p, i);
 387                         genimg_print_size(len);
 388
 389                         if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
 390                                 /*
 391                                  * the user may need to know offsets
 392                                  * if planning to do something with
 393                                  * multiple files
 394                                  */
 395                                 printf("%s    Offset = 0x%08lx\n", p, data);
 396                         }
 397                 }
 398         } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
 399                 printf("HAB Blocks:   0x%08x   0x0000   0x%08x\n",
 400                         image_get_load(hdr) - image_get_header_size(),
 401                         (int)(image_get_size(hdr) + image_get_header_size()
 402                         + sizeof(flash_header_v2_t) - 0x2060));
 403         }
 404 }
 405
 406 /**
 407  * print_decomp_msg() - Print a suitable decompression/loading message
 408  *
 409  * @type:       OS type (IH_OS_...)
 410  * @comp_type:  Compression type being used (IH_COMP_...)
 411  * @is_xip:     true if the load address matches the image start
 412  */
 413 static void print_decomp_msg(int comp_type, int type, bool is_xip)
 414 {
 415         const char *name = genimg_get_type_name(type);
 416
 417         if (comp_type == IH_COMP_NONE)
 418                 printf("   %s %s\n", is_xip ? "XIP" : "Loading", name);
 419         else
 420                 printf("   Uncompressing %s\n", name);
 421 }
 422
 423 int image_decomp_type(const unsigned char *buf, ulong len)
 424 {
 425         const struct comp_magic_map *cmagic = image_comp;
 426
 427         if (len < 2)
 428                 return -EINVAL;
 429
 430         for (; cmagic->comp_id > 0; cmagic++) {
 431                 if (!memcmp(buf, cmagic->magic, 2))
 432                         break;
 433         }
 434
 435         return cmagic->comp_id;
 436 }
 437
 438 int image_decomp(int comp, ulong load, ulong image_start, int type,
 439                  void *load_buf, void *image_buf, ulong image_len,
 440                  uint unc_len, ulong *load_end)
 441 {
 442         int ret = -ENOSYS;
 443
 444         *load_end = load;
 445         print_decomp_msg(comp, type, load == image_start);
 446
 447         /*
 448          * Load the image to the right place, decompressing if needed. After
 449          * this, image_len will be set to the number of uncompressed bytes
 450          * loaded, ret will be non-zero on error.
 451          */
 452         switch (comp) {
 453         case IH_COMP_NONE:
 454                 ret = 0;
 455                 if (load == image_start)
 456                         break;
 457                 if (image_len <= unc_len)
 458                         memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
 459                 else
 460                         ret = -ENOSPC;
 461                 break;
 462         case IH_COMP_GZIP:
 463                 if (!tools_build() && CONFIG_IS_ENABLED(GZIP))
 464                         ret = gunzip(load_buf, unc_len, image_buf, &image_len);
 465                 break;
 466         case IH_COMP_BZIP2:
 467                 if (!tools_build() && CONFIG_IS_ENABLED(BZIP2)) {
 468                         uint size = unc_len;
 469
 470                         /*
 471                          * If we've got less than 4 MB of malloc() space,
 472                          * use slower decompression algorithm which requires
 473                          * at most 2300 KB of memory.
 474                          */
 475                         ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
 476                                 image_buf, image_len, CONSERVE_MEMORY, 0);
 477                         image_len = size;
 478                 }
 479                 break;
 480         case IH_COMP_LZMA:
 481                 if (!tools_build() && CONFIG_IS_ENABLED(LZMA)) {
 482                         SizeT lzma_len = unc_len;
 483
 484                         ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
 485                                                        image_buf, image_len);
 486                         image_len = lzma_len;
 487                 }
 488                 break;
 489         case IH_COMP_LZO:
 490                 if (!tools_build() && CONFIG_IS_ENABLED(LZO)) {
 491                         size_t size = unc_len;
 492
 493                         ret = lzop_decompress(image_buf, image_len, load_buf, &size);
 494                         image_len = size;
 495                 }
 496                 break;
 497         case IH_COMP_LZ4:
 498                 if (!tools_build() && CONFIG_IS_ENABLED(LZ4)) {
 499                         size_t size = unc_len;
 500
 501                         ret = ulz4fn(image_buf, image_len, load_buf, &size);
 502                         image_len = size;
 503                 }
 504                 break;
 505         case IH_COMP_ZSTD:
 506                 if (!tools_build() && CONFIG_IS_ENABLED(ZSTD)) {
 507                         struct abuf in, out;
 508
 509                         abuf_init_set(&in, image_buf, image_len);
 510                         abuf_init_set(&in, load_buf, unc_len);
 511                         ret = zstd_decompress(&in, &out);
 512                         if (ret >= 0) {
 513                                 image_len = ret;
 514                                 ret = 0;
 515                         }
 516                 }
 517                 break;
 518         }
 519         if (ret == -ENOSYS) {
 520                 printf("Unimplemented compression type %d\n", comp);
 521                 return ret;
 522         }
 523         if (ret)
 524                 return ret;
 525
 526         *load_end = load + image_len;
 527
 528         return 0;
 529 }
 530
 531 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
 532 {
 533         for (; table->id >= 0; ++table) {
 534                 if (table->id == id)
 535                         return table;
 536         }
 537         return NULL;
 538 }
 539
 540 static const char *unknown_msg(enum ih_category category)
 541 {
 542         static const char unknown_str[] = "Unknown ";
 543         static char msg[30];
 544
 545         strcpy(msg, unknown_str);
 546         strncat(msg, table_info[category].desc,
 547                 sizeof(msg) - sizeof(unknown_str));
 548
 549         return msg;
 550 }
 551
 552 /**
 553  * genimg_get_cat_name - translate entry id to long name
 554  * @category: category to look up (enum ih_category)
 555  * @id: entry id to be translated
 556  *
 557  * This will scan the translation table trying to find the entry that matches
 558  * the given id.
 559  *
 560  * @return long entry name if translation succeeds; error string on failure
 561  */
 562 const char *genimg_get_cat_name(enum ih_category category, uint id)
 563 {
 564         const table_entry_t *entry;
 565
 566         entry = get_table_entry(table_info[category].table, id);
 567         if (!entry)
 568                 return unknown_msg(category);
 569         return manual_reloc(entry->lname);
 570 }
 571
 572 /**
 573  * genimg_get_cat_short_name - translate entry id to short name
 574  * @category: category to look up (enum ih_category)
 575  * @id: entry id to be translated
 576  *
 577  * This will scan the translation table trying to find the entry that matches
 578  * the given id.
 579  *
 580  * @return short entry name if translation succeeds; error string on failure
 581  */
 582 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
 583 {
 584         const table_entry_t *entry;
 585
 586         entry = get_table_entry(table_info[category].table, id);
 587         if (!entry)
 588                 return unknown_msg(category);
 589         return manual_reloc(entry->sname);
 590 }
 591
 592 int genimg_get_cat_count(enum ih_category category)
 593 {
 594         return table_info[category].count;
 595 }
 596
 597 const char *genimg_get_cat_desc(enum ih_category category)
 598 {
 599         return table_info[category].desc;
 600 }
 601
 602 /**
 603  * genimg_cat_has_id - check whether category has entry id
 604  * @category: category to look up (enum ih_category)
 605  * @id: entry id to be checked
 606  *
 607  * This will scan the translation table trying to find the entry that matches
 608  * the given id.
 609  *
 610  * @return true if category has entry id; false if not
 611  */
 612 bool genimg_cat_has_id(enum ih_category category, uint id)
 613 {
 614         if (get_table_entry(table_info[category].table, id))
 615                 return true;
 616
 617         return false;
 618 }
 619
 620 /**
 621  * get_table_entry_name - translate entry id to long name
 622  * @table: pointer to a translation table for entries of a specific type
 623  * @msg: message to be returned when translation fails
 624  * @id: entry id to be translated
 625  *
 626  * get_table_entry_name() will go over translation table trying to find
 627  * entry that matches given id. If matching entry is found, its long
 628  * name is returned to the caller.
 629  *
 630  * returns:
 631  *     long entry name if translation succeeds
 632  *     msg otherwise
 633  */
 634 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
 635 {
 636         table = get_table_entry(table, id);
 637         if (!table)
 638                 return msg;
 639         return manual_reloc(table->lname);
 640 }
 641
 642 const char *genimg_get_os_name(uint8_t os)
 643 {
 644         return (get_table_entry_name(uimage_os, "Unknown OS", os));
 645 }
 646
 647 const char *genimg_get_arch_name(uint8_t arch)
 648 {
 649         return (get_table_entry_name(uimage_arch, "Unknown Architecture",
 650                                         arch));
 651 }
 652
 653 const char *genimg_get_type_name(uint8_t type)
 654 {
 655         return (get_table_entry_name(uimage_type, "Unknown Image", type));
 656 }
 657
 658 const char *genimg_get_comp_name(uint8_t comp)
 659 {
 660         return (get_table_entry_name(uimage_comp, "Unknown Compression",
 661                                         comp));
 662 }
 663
 664 static const char *genimg_get_short_name(const table_entry_t *table, int val)
 665 {
 666         table = get_table_entry(table, val);
 667         if (!table)
 668                 return "unknown";
 669         return manual_reloc(table->sname);
 670 }
 671
 672 const char *genimg_get_type_short_name(uint8_t type)
 673 {
 674         return genimg_get_short_name(uimage_type, type);
 675 }
 676
 677 const char *genimg_get_comp_short_name(uint8_t comp)
 678 {
 679         return genimg_get_short_name(uimage_comp, comp);
 680 }
 681
 682 const char *genimg_get_os_short_name(uint8_t os)
 683 {
 684         return genimg_get_short_name(uimage_os, os);
 685 }
 686
 687 const char *genimg_get_arch_short_name(uint8_t arch)
 688 {
 689         return genimg_get_short_name(uimage_arch, arch);
 690 }
 691
 692 /**
 693  * get_table_entry_id - translate short entry name to id
 694  * @table: pointer to a translation table for entries of a specific type
 695  * @table_name: to be used in case of error
 696  * @name: entry short name to be translated
 697  *
 698  * get_table_entry_id() will go over translation table trying to find
 699  * entry that matches given short name. If matching entry is found,
 700  * its id returned to the caller.
 701  *
 702  * returns:
 703  *     entry id if translation succeeds
 704  *     -1 otherwise
 705  */
 706 int get_table_entry_id(const table_entry_t *table,
 707                 const char *table_name, const char *name)
 708 {
 709         const table_entry_t *t;
 710
 711         for (t = table; t->id >= 0; ++t) {
 712                 if (t->sname && !strcasecmp(manual_reloc(t->sname), name))
 713                         return t->id;
 714         }
 715         debug("Invalid %s Type: %s\n", table_name, name);
 716
 717         return -1;
 718 }
 719
 720 int genimg_get_os_id(const char *name)
 721 {
 722         return (get_table_entry_id(uimage_os, "OS", name));
 723 }
 724
 725 int genimg_get_arch_id(const char *name)
 726 {
 727         return (get_table_entry_id(uimage_arch, "CPU", name));
 728 }
 729
 730 int genimg_get_type_id(const char *name)
 731 {
 732         return (get_table_entry_id(uimage_type, "Image", name));
 733 }
 734
 735 int genimg_get_comp_id(const char *name)
 736 {
 737         return (get_table_entry_id(uimage_comp, "Compression", name));
 738 }