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         {       -1,                 "",           "",                   },
 184 };
 185
 186 static const table_entry_t uimage_comp[] = {
 187         {       IH_COMP_NONE,   "none",         "uncompressed",         },
 188         {       IH_COMP_BZIP2,  "bzip2",        "bzip2 compressed",     },
 189         {       IH_COMP_GZIP,   "gzip",         "gzip compressed",      },
 190         {       IH_COMP_LZMA,   "lzma",         "lzma compressed",      },
 191         {       IH_COMP_LZO,    "lzo",          "lzo compressed",       },
 192         {       IH_COMP_LZ4,    "lz4",          "lz4 compressed",       },
 193         {       IH_COMP_ZSTD,   "zstd",         "zstd compressed",      },
 194         {       -1,             "",             "",                     },
 195 };
 196
 197 struct table_info {
 198         const char *desc;
 199         int count;
 200         const table_entry_t *table;
 201 };
 202
 203 static const struct comp_magic_map image_comp[] = {
 204         {       IH_COMP_BZIP2,  "bzip2",        {0x42, 0x5a},},
 205         {       IH_COMP_GZIP,   "gzip",         {0x1f, 0x8b},},
 206         {       IH_COMP_LZMA,   "lzma",         {0x5d, 0x00},},
 207         {       IH_COMP_LZO,    "lzo",          {0x89, 0x4c},},
 208         {       IH_COMP_LZ4,    "lz4",          {0x04, 0x22},},
 209         {       IH_COMP_ZSTD,   "zstd",         {0x28, 0xb5},},
 210         {       IH_COMP_NONE,   "none",         {},     },
 211 };
 212
 213 static const struct table_info table_info[IH_COUNT] = {
 214         { "architecture", IH_ARCH_COUNT, uimage_arch },
 215         { "compression", IH_COMP_COUNT, uimage_comp },
 216         { "operating system", IH_OS_COUNT, uimage_os },
 217         { "image type", IH_TYPE_COUNT, uimage_type },
 218 };
 219
 220 /*****************************************************************************/
 221 /* Legacy format routines */
 222 /*****************************************************************************/
 223 int image_check_hcrc(const struct legacy_img_hdr *hdr)
 224 {
 225         ulong hcrc;
 226         ulong len = image_get_header_size();
 227         struct legacy_img_hdr header;
 228
 229         /* Copy header so we can blank CRC field for re-calculation */
 230         memmove(&header, (char *)hdr, image_get_header_size());
 231         image_set_hcrc(&header, 0);
 232
 233         hcrc = crc32(0, (unsigned char *)&header, len);
 234
 235         return (hcrc == image_get_hcrc(hdr));
 236 }
 237
 238 int image_check_dcrc(const struct legacy_img_hdr *hdr)
 239 {
 240         ulong data = image_get_data(hdr);
 241         ulong len = image_get_data_size(hdr);
 242         ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
 243
 244         return (dcrc == image_get_dcrc(hdr));
 245 }
 246
 247 /**
 248  * image_multi_count - get component (sub-image) count
 249  * @hdr: pointer to the header of the multi component image
 250  *
 251  * image_multi_count() returns number of components in a multi
 252  * component image.
 253  *
 254  * Note: no checking of the image type is done, caller must pass
 255  * a valid multi component image.
 256  *
 257  * returns:
 258  *     number of components
 259  */
 260 ulong image_multi_count(const struct legacy_img_hdr *hdr)
 261 {
 262         ulong i, count = 0;
 263         uint32_t *size;
 264
 265         /* get start of the image payload, which in case of multi
 266          * component images that points to a table of component sizes */
 267         size = (uint32_t *)image_get_data(hdr);
 268
 269         /* count non empty slots */
 270         for (i = 0; size[i]; ++i)
 271                 count++;
 272
 273         return count;
 274 }
 275
 276 /**
 277  * image_multi_getimg - get component data address and size
 278  * @hdr: pointer to the header of the multi component image
 279  * @idx: index of the requested component
 280  * @data: pointer to a ulong variable, will hold component data address
 281  * @len: pointer to a ulong variable, will hold component size
 282  *
 283  * image_multi_getimg() returns size and data address for the requested
 284  * component in a multi component image.
 285  *
 286  * Note: no checking of the image type is done, caller must pass
 287  * a valid multi component image.
 288  *
 289  * returns:
 290  *     data address and size of the component, if idx is valid
 291  *     0 in data and len, if idx is out of range
 292  */
 293 void image_multi_getimg(const struct legacy_img_hdr *hdr, ulong idx,
 294                         ulong *data, ulong *len)
 295 {
 296         int i;
 297         uint32_t *size;
 298         ulong offset, count, img_data;
 299
 300         /* get number of component */
 301         count = image_multi_count(hdr);
 302
 303         /* get start of the image payload, which in case of multi
 304          * component images that points to a table of component sizes */
 305         size = (uint32_t *)image_get_data(hdr);
 306
 307         /* get address of the proper component data start, which means
 308          * skipping sizes table (add 1 for last, null entry) */
 309         img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
 310
 311         if (idx < count) {
 312                 *len = uimage_to_cpu(size[idx]);
 313                 offset = 0;
 314
 315                 /* go over all indices preceding requested component idx */
 316                 for (i = 0; i < idx; i++) {
 317                         /* add up i-th component size, rounding up to 4 bytes */
 318                         offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
 319                 }
 320
 321                 /* calculate idx-th component data address */
 322                 *data = img_data + offset;
 323         } else {
 324                 *len = 0;
 325                 *data = 0;
 326         }
 327 }
 328
 329 static void image_print_type(const struct legacy_img_hdr *hdr)
 330 {
 331         const char __maybe_unused *os, *arch, *type, *comp;
 332
 333         os = genimg_get_os_name(image_get_os(hdr));
 334         arch = genimg_get_arch_name(image_get_arch(hdr));
 335         type = genimg_get_type_name(image_get_type(hdr));
 336         comp = genimg_get_comp_name(image_get_comp(hdr));
 337
 338         printf("%s %s %s (%s)\n", arch, os, type, comp);
 339 }
 340
 341 /**
 342  * image_print_contents - prints out the contents of the legacy format image
 343  * @ptr: pointer to the legacy format image header
 344  * @p: pointer to prefix string
 345  *
 346  * image_print_contents() formats a multi line legacy image contents description.
 347  * The routine prints out all header fields followed by the size/offset data
 348  * for MULTI/SCRIPT images.
 349  *
 350  * returns:
 351  *     no returned results
 352  */
 353 void image_print_contents(const void *ptr)
 354 {
 355         const struct legacy_img_hdr *hdr = (const struct legacy_img_hdr *)ptr;
 356         const char __maybe_unused *p;
 357
 358         p = IMAGE_INDENT_STRING;
 359         printf("%sImage Name:   %.*s\n", p, IH_NMLEN, image_get_name(hdr));
 360         if (IMAGE_ENABLE_TIMESTAMP) {
 361                 printf("%sCreated:      ", p);
 362                 genimg_print_time((time_t)image_get_time(hdr));
 363         }
 364         printf("%sImage Type:   ", p);
 365         image_print_type(hdr);
 366         printf("%sData Size:    ", p);
 367         genimg_print_size(image_get_data_size(hdr));
 368         printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
 369         printf("%sEntry Point:  %08x\n", p, image_get_ep(hdr));
 370
 371         if (image_check_type(hdr, IH_TYPE_MULTI) ||
 372                         image_check_type(hdr, IH_TYPE_SCRIPT)) {
 373                 int i;
 374                 ulong data, len;
 375                 ulong count = image_multi_count(hdr);
 376
 377                 printf("%sContents:\n", p);
 378                 for (i = 0; i < count; i++) {
 379                         image_multi_getimg(hdr, i, &data, &len);
 380
 381                         printf("%s   Image %d: ", p, i);
 382                         genimg_print_size(len);
 383
 384                         if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
 385                                 /*
 386                                  * the user may need to know offsets
 387                                  * if planning to do something with
 388                                  * multiple files
 389                                  */
 390                                 printf("%s    Offset = 0x%08lx\n", p, data);
 391                         }
 392                 }
 393         } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
 394                 printf("HAB Blocks:   0x%08x   0x0000   0x%08x\n",
 395                         image_get_load(hdr) - image_get_header_size(),
 396                         (int)(image_get_size(hdr) + image_get_header_size()
 397                         + sizeof(flash_header_v2_t) - 0x2060));
 398         }
 399 }
 400
 401 /**
 402  * print_decomp_msg() - Print a suitable decompression/loading message
 403  *
 404  * @type:       OS type (IH_OS_...)
 405  * @comp_type:  Compression type being used (IH_COMP_...)
 406  * @is_xip:     true if the load address matches the image start
 407  */
 408 static void print_decomp_msg(int comp_type, int type, bool is_xip)
 409 {
 410         const char *name = genimg_get_type_name(type);
 411
 412         if (comp_type == IH_COMP_NONE)
 413                 printf("   %s %s\n", is_xip ? "XIP" : "Loading", name);
 414         else
 415                 printf("   Uncompressing %s\n", name);
 416 }
 417
 418 int image_decomp_type(const unsigned char *buf, ulong len)
 419 {
 420         const struct comp_magic_map *cmagic = image_comp;
 421
 422         if (len < 2)
 423                 return -EINVAL;
 424
 425         for (; cmagic->comp_id > 0; cmagic++) {
 426                 if (!memcmp(buf, cmagic->magic, 2))
 427                         break;
 428         }
 429
 430         return cmagic->comp_id;
 431 }
 432
 433 int image_decomp(int comp, ulong load, ulong image_start, int type,
 434                  void *load_buf, void *image_buf, ulong image_len,
 435                  uint unc_len, ulong *load_end)
 436 {
 437         int ret = -ENOSYS;
 438
 439         *load_end = load;
 440         print_decomp_msg(comp, type, load == image_start);
 441
 442         /*
 443          * Load the image to the right place, decompressing if needed. After
 444          * this, image_len will be set to the number of uncompressed bytes
 445          * loaded, ret will be non-zero on error.
 446          */
 447         switch (comp) {
 448         case IH_COMP_NONE:
 449                 ret = 0;
 450                 if (load == image_start)
 451                         break;
 452                 if (image_len <= unc_len)
 453                         memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
 454                 else
 455                         ret = -ENOSPC;
 456                 break;
 457         case IH_COMP_GZIP:
 458                 if (!tools_build() && CONFIG_IS_ENABLED(GZIP))
 459                         ret = gunzip(load_buf, unc_len, image_buf, &image_len);
 460                 break;
 461         case IH_COMP_BZIP2:
 462                 if (!tools_build() && CONFIG_IS_ENABLED(BZIP2)) {
 463                         uint size = unc_len;
 464
 465                         /*
 466                          * If we've got less than 4 MB of malloc() space,
 467                          * use slower decompression algorithm which requires
 468                          * at most 2300 KB of memory.
 469                          */
 470                         ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
 471                                 image_buf, image_len, CONSERVE_MEMORY, 0);
 472                         image_len = size;
 473                 }
 474                 break;
 475         case IH_COMP_LZMA:
 476                 if (!tools_build() && CONFIG_IS_ENABLED(LZMA)) {
 477                         SizeT lzma_len = unc_len;
 478
 479                         ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
 480                                                        image_buf, image_len);
 481                         image_len = lzma_len;
 482                 }
 483                 break;
 484         case IH_COMP_LZO:
 485                 if (!tools_build() && CONFIG_IS_ENABLED(LZO)) {
 486                         size_t size = unc_len;
 487
 488                         ret = lzop_decompress(image_buf, image_len, load_buf, &size);
 489                         image_len = size;
 490                 }
 491                 break;
 492         case IH_COMP_LZ4:
 493                 if (!tools_build() && CONFIG_IS_ENABLED(LZ4)) {
 494                         size_t size = unc_len;
 495
 496                         ret = ulz4fn(image_buf, image_len, load_buf, &size);
 497                         image_len = size;
 498                 }
 499                 break;
 500         case IH_COMP_ZSTD:
 501                 if (!tools_build() && CONFIG_IS_ENABLED(ZSTD)) {
 502                         struct abuf in, out;
 503
 504                         abuf_init_set(&in, image_buf, image_len);
 505                         abuf_init_set(&out, load_buf, unc_len);
 506                         ret = zstd_decompress(&in, &out);
 507                         if (ret >= 0) {
 508                                 image_len = ret;
 509                                 ret = 0;
 510                         }
 511                 }
 512                 break;
 513         }
 514         if (ret == -ENOSYS) {
 515                 printf("Unimplemented compression type %d\n", comp);
 516                 return ret;
 517         }
 518         if (ret)
 519                 return ret;
 520
 521         *load_end = load + image_len;
 522
 523         return 0;
 524 }
 525
 526 const table_entry_t *get_table_entry(const table_entry_t *table, int id)
 527 {
 528         for (; table->id >= 0; ++table) {
 529                 if (table->id == id)
 530                         return table;
 531         }
 532         return NULL;
 533 }
 534
 535 static const char *unknown_msg(enum ih_category category)
 536 {
 537         static const char unknown_str[] = "Unknown ";
 538         static char msg[30];
 539
 540         strcpy(msg, unknown_str);
 541         strncat(msg, table_info[category].desc,
 542                 sizeof(msg) - sizeof(unknown_str));
 543
 544         return msg;
 545 }
 546
 547 /**
 548  * genimg_get_cat_name - translate entry id to long name
 549  * @category: category to look up (enum ih_category)
 550  * @id: entry id to be translated
 551  *
 552  * This will scan the translation table trying to find the entry that matches
 553  * the given id.
 554  *
 555  * Return: long entry name if translation succeeds; error string on failure
 556  */
 557 const char *genimg_get_cat_name(enum ih_category category, uint id)
 558 {
 559         const table_entry_t *entry;
 560
 561         entry = get_table_entry(table_info[category].table, id);
 562         if (!entry)
 563                 return unknown_msg(category);
 564         return manual_reloc(entry->lname);
 565 }
 566
 567 /**
 568  * genimg_get_cat_short_name - translate entry id to short name
 569  * @category: category to look up (enum ih_category)
 570  * @id: entry id to be translated
 571  *
 572  * This will scan the translation table trying to find the entry that matches
 573  * the given id.
 574  *
 575  * Return: short entry name if translation succeeds; error string on failure
 576  */
 577 const char *genimg_get_cat_short_name(enum ih_category category, uint id)
 578 {
 579         const table_entry_t *entry;
 580
 581         entry = get_table_entry(table_info[category].table, id);
 582         if (!entry)
 583                 return unknown_msg(category);
 584         return manual_reloc(entry->sname);
 585 }
 586
 587 int genimg_get_cat_count(enum ih_category category)
 588 {
 589         return table_info[category].count;
 590 }
 591
 592 const char *genimg_get_cat_desc(enum ih_category category)
 593 {
 594         return table_info[category].desc;
 595 }
 596
 597 /**
 598  * genimg_cat_has_id - check whether category has entry id
 599  * @category: category to look up (enum ih_category)
 600  * @id: entry id to be checked
 601  *
 602  * This will scan the translation table trying to find the entry that matches
 603  * the given id.
 604  *
 605  * Return: true if category has entry id; false if not
 606  */
 607 bool genimg_cat_has_id(enum ih_category category, uint id)
 608 {
 609         if (get_table_entry(table_info[category].table, id))
 610                 return true;
 611
 612         return false;
 613 }
 614
 615 /**
 616  * get_table_entry_name - translate entry id to long name
 617  * @table: pointer to a translation table for entries of a specific type
 618  * @msg: message to be returned when translation fails
 619  * @id: entry id to be translated
 620  *
 621  * get_table_entry_name() will go over translation table trying to find
 622  * entry that matches given id. If matching entry is found, its long
 623  * name is returned to the caller.
 624  *
 625  * returns:
 626  *     long entry name if translation succeeds
 627  *     msg otherwise
 628  */
 629 char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
 630 {
 631         table = get_table_entry(table, id);
 632         if (!table)
 633                 return msg;
 634         return manual_reloc(table->lname);
 635 }
 636
 637 const char *genimg_get_os_name(uint8_t os)
 638 {
 639         return (get_table_entry_name(uimage_os, "Unknown OS", os));
 640 }
 641
 642 const char *genimg_get_arch_name(uint8_t arch)
 643 {
 644         return (get_table_entry_name(uimage_arch, "Unknown Architecture",
 645                                         arch));
 646 }
 647
 648 const char *genimg_get_type_name(uint8_t type)
 649 {
 650         return (get_table_entry_name(uimage_type, "Unknown Image", type));
 651 }
 652
 653 const char *genimg_get_comp_name(uint8_t comp)
 654 {
 655         return (get_table_entry_name(uimage_comp, "Unknown Compression",
 656                                         comp));
 657 }
 658
 659 static const char *genimg_get_short_name(const table_entry_t *table, int val)
 660 {
 661         table = get_table_entry(table, val);
 662         if (!table)
 663                 return "unknown";
 664         return manual_reloc(table->sname);
 665 }
 666
 667 const char *genimg_get_type_short_name(uint8_t type)
 668 {
 669         return genimg_get_short_name(uimage_type, type);
 670 }
 671
 672 const char *genimg_get_comp_short_name(uint8_t comp)
 673 {
 674         return genimg_get_short_name(uimage_comp, comp);
 675 }
 676
 677 const char *genimg_get_os_short_name(uint8_t os)
 678 {
 679         return genimg_get_short_name(uimage_os, os);
 680 }
 681
 682 const char *genimg_get_arch_short_name(uint8_t arch)
 683 {
 684         return genimg_get_short_name(uimage_arch, arch);
 685 }
 686
 687 /**
 688  * get_table_entry_id - translate short entry name to id
 689  * @table: pointer to a translation table for entries of a specific type
 690  * @table_name: to be used in case of error
 691  * @name: entry short name to be translated
 692  *
 693  * get_table_entry_id() will go over translation table trying to find
 694  * entry that matches given short name. If matching entry is found,
 695  * its id returned to the caller.
 696  *
 697  * returns:
 698  *     entry id if translation succeeds
 699  *     -1 otherwise
 700  */
 701 int get_table_entry_id(const table_entry_t *table,
 702                 const char *table_name, const char *name)
 703 {
 704         const table_entry_t *t;
 705
 706         for (t = table; t->id >= 0; ++t) {
 707                 if (t->sname && !strcasecmp(manual_reloc(t->sname), name))
 708                         return t->id;
 709         }
 710         debug("Invalid %s Type: %s\n", table_name, name);
 711
 712         return -1;
 713 }
 714
 715 int genimg_get_os_id(const char *name)
 716 {
 717         return (get_table_entry_id(uimage_os, "OS", name));
 718 }
 719
 720 int genimg_get_arch_id(const char *name)
 721 {
 722         return (get_table_entry_id(uimage_arch, "CPU", name));
 723 }
 724
 725 int genimg_get_type_id(const char *name)
 726 {
 727         return (get_table_entry_id(uimage_type, "Image", name));
 728 }
 729
 730 int genimg_get_comp_id(const char *name)
 731 {
 732         return (get_table_entry_id(uimage_comp, "Compression", name));
 733 }