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