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