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