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