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