blob: eb12e4be04ac40d4c9d6d0aa162b9f49a5da30cf [file] [log] [blame]
Tom Rini10e47792018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Marian Balakowicz41d71ed2008-01-08 18:14:09 +01002/*
3 * (C) Copyright 2008 Semihalf
4 *
5 * (C) Copyright 2000-2006
6 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
Marian Balakowicz41d71ed2008-01-08 18:14:09 +01007 */
Marian Balakowicz9c701e82008-01-31 13:57:17 +01008
Marian Balakowicz41d71ed2008-01-08 18:14:09 +01009#ifndef USE_HOSTCC
Simon Glass0af6e2d2019-08-01 09:46:52 -060010#include <env.h>
Simon Glass1ab16922022-07-31 12:28:48 -060011#include <display_options.h>
Andy Shevchenkoe3b3ad92021-11-08 21:03:38 +030012#include <init.h>
Simon Glass2dc9c342020-05-10 11:40:01 -060013#include <lmb.h>
Simon Glass0f2af882020-05-10 11:40:05 -060014#include <log.h>
Simon Glass9bc15642020-02-03 07:36:16 -070015#include <malloc.h>
Simon Glass48b6c6b2019-11-14 12:57:16 -070016#include <u-boot/crc.h>
Marian Balakowicz95418502008-01-31 13:55:39 +010017
18#ifdef CONFIG_SHOW_BOOT_PROGRESS
19#include <status_led.h>
20#endif
21
Simon Glass85c057e2021-09-25 19:43:21 -060022#if CONFIG_IS_ENABLED(FIT) || CONFIG_IS_ENABLED(OF_LIBFDT)
Masahiro Yamada75f82d02018-03-05 01:20:11 +090023#include <linux/libfdt.h>
Marian Balakowiczc536d6f2008-02-21 17:20:19 +010024#include <fdt_support.h>
Marian Balakowicza50d5152008-03-12 10:12:37 +010025#endif
26
Simon Glass3ba929a2020-10-30 21:38:53 -060027#include <asm/global_data.h>
Andy Fleming72c23be2008-04-02 16:19:07 -050028#include <u-boot/md5.h>
Jeroen Hofsteebfe88fe2014-06-12 22:27:12 +020029#include <u-boot/sha1.h>
Masahiro Yamada56a931c2016-09-21 11:28:55 +090030#include <linux/errno.h>
Simon Glass49648062013-05-07 06:12:03 +000031#include <asm/io.h>
Marian Balakowicza50d5152008-03-12 10:12:37 +010032
Marian Balakowicz2efc2642008-01-31 13:58:13 +010033DECLARE_GLOBAL_DATA_PTR;
Marian Balakowicz61fde552008-02-27 11:01:04 +010034
Simon Glassfd86d012021-09-25 07:03:14 -060035/* 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
Marian Balakowicz41d71ed2008-01-08 18:14:09 +010038#else
Simon Glassfd86d012021-09-25 07:03:14 -060039#define CONSERVE_MEMORY false
40#endif
41
42#else /* USE_HOSTCC */
Marian Balakowicz95418502008-01-31 13:55:39 +010043#include "mkimage.h"
Tom Rini8fac3d42023-12-14 07:16:54 -050044#include <linux/kconfig.h>
Andy Fleming72c23be2008-04-02 16:19:07 -050045#include <u-boot/md5.h>
Marian Balakowicze227fbb2008-02-29 21:24:06 +010046#include <time.h>
Heiko Schocher62cb1562015-06-29 09:10:46 +020047
48#ifndef __maybe_unused
49# define __maybe_unused /* unimplemented */
50#endif
Simon Glassfd86d012021-09-25 07:03:14 -060051
52#define CONSERVE_MEMORY false
53
Marian Balakowicze227fbb2008-02-29 21:24:06 +010054#endif /* !USE_HOSTCC*/
Marian Balakowicz41d71ed2008-01-08 18:14:09 +010055
Simon Glassfd86d012021-09-25 07:03:14 -060056#include <abuf.h>
57#include <bzlib.h>
Simon Glass4a8a8a12021-09-25 07:03:17 -060058#include <display_options.h>
Simon Glassfd86d012021-09-25 07:03:14 -060059#include <gzip.h>
Simon Glass4d7237b2021-09-25 07:03:15 -060060#include <image.h>
Breno Matheus Limac592c342019-09-23 18:39:47 +000061#include <imximage.h>
Simon Glass684ef382021-09-25 07:03:18 -060062#include <relocate.h>
Simon Glassfd86d012021-09-25 07:03:14 -060063#include <linux/lzo.h>
64#include <linux/zstd.h>
Simon Glassfd86d012021-09-25 07:03:14 -060065#include <lzma/LzmaTypes.h>
66#include <lzma/LzmaDec.h>
67#include <lzma/LzmaTools.h>
68#include <u-boot/crc.h>
Simon Glasscaf62672021-10-09 09:28:21 -060069#include <u-boot/lz4.h>
Simon Glass9adb6862013-02-24 17:33:25 +000070
Mike Frysingercf2feb12010-10-20 07:17:39 -040071static const table_entry_t uimage_arch[] = {
Simon Glassa3ed7372016-06-30 10:52:15 -060072 { IH_ARCH_INVALID, "invalid", "Invalid ARCH", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +010073 { 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", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +010081 { IH_ARCH_NIOS2, "nios2", "NIOS II", },
Grant Erickson80f51b82008-05-04 16:45:01 -070082 { IH_ARCH_PPC, "powerpc", "PowerPC", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +010083 { 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", },
Macpaul Lin354b4e32011-10-19 20:41:09 +000090 { IH_ARCH_NDS32, "nds32", "NDS32", },
Stefan Kristiansson15c669c2011-11-26 19:04:50 +000091 { IH_ARCH_OPENRISC, "or1k", "OpenRISC 1000",},
Simon Glass49648062013-05-07 06:12:03 +000092 { IH_ARCH_SANDBOX, "sandbox", "Sandbox", },
David Feng85fd5f12013-12-14 11:47:35 +080093 { IH_ARCH_ARM64, "arm64", "AArch64", },
Alexey Brodkin78bc86f2014-02-04 12:56:16 +040094 { IH_ARCH_ARC, "arc", "ARC", },
Simon Glass9d428302014-10-10 08:21:57 -060095 { IH_ARCH_X86_64, "x86_64", "AMD x86_64", },
Chris Zankel41e37372016-08-10 18:36:43 +030096 { IH_ARCH_XTENSA, "xtensa", "Xtensa", },
Rick Chencda20702018-03-13 13:37:29 +080097 { IH_ARCH_RISCV, "riscv", "RISC-V", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +010098 { -1, "", "", },
99};
100
Mike Frysingercf2feb12010-10-20 07:17:39 -0400101static const table_entry_t uimage_os[] = {
Simon Glassa3ed7372016-06-30 10:52:15 -0600102 { IH_OS_INVALID, "invalid", "Invalid OS", },
Philipp Tomsich1bf3eb22017-09-13 21:29:29 +0200103 { IH_OS_ARM_TRUSTED_FIRMWARE, "arm-trusted-firmware", "ARM Trusted Firmware" },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100104 { IH_OS_LINUX, "linux", "Linux", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100105 { IH_OS_NETBSD, "netbsd", "NetBSD", },
Torkel Lundgren29a58662010-09-28 11:05:36 +0200106 { IH_OS_OSE, "ose", "Enea OSE", },
Steven Stallion36ec8ac2013-03-20 06:31:35 +0000107 { IH_OS_PLAN9, "plan9", "Plan 9", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100108 { IH_OS_RTEMS, "rtems", "RTEMS", },
Bryan O'Donoghue2f72dec2018-03-13 16:50:35 +0000109 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100110 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
miao.yan@windriver.com8bb64242013-12-27 16:01:50 +0800111 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100112#if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
113 { IH_OS_QNX, "qnx", "QNX", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100114#endif
Peter Tyser56b8dd12008-09-08 14:56:49 -0500115#if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
116 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
117#endif
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100118#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
Marek Vasut0e3b5122014-12-16 14:07:21 +0100131#if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
132 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
133#endif
Lukas Auer515b9342019-08-21 21:14:44 +0200134 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
Cristian Ciocaltea217f9642019-12-24 18:05:38 +0200135 { IH_OS_EFI, "efi", "EFI Firmware" },
Marek Vasut0e3b5122014-12-16 14:07:21 +0100136
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100137 { -1, "", "", },
138};
139
Mike Frysingercf2feb12010-10-20 07:17:39 -0400140static const table_entry_t uimage_type[] = {
Stefano Babic38855512011-10-17 00:07:43 +0000141 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100142 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
143 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
John Rigby34d12a12011-07-21 09:10:30 -0400144 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
Karicheri, Muralidharan82777932014-04-04 13:16:48 -0400145 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100146 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
Stephen Warren8c87eba2011-11-10 13:17:53 -0700147 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
Stefano Babic38855512011-10-17 00:07:43 +0000148 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
149 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
Peng Fan60a56072018-10-16 04:50:30 +0000150 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
Peng Fan31c51da2018-11-20 10:19:36 +0000151 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
Simon Glassa3ed7372016-06-30 10:52:15 -0600152 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100153 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
Stefano Babic38855512011-10-17 00:07:43 +0000154 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
Shaohui Xieea65fd82012-08-10 02:49:35 +0000155 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100156 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
157 { IH_TYPE_SCRIPT, "script", "Script", },
Marek Vasut83f69282018-04-15 13:15:33 +0200158 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
159 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100160 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
Heiko Schocher58cb84d2011-07-16 00:06:42 +0000161 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
Marek Vasut4a0e05d2013-08-26 20:43:33 +0200162 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
Andreas Bießmann7c75d3e2014-05-19 14:23:39 +0200163 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
Simon Glass0129b522014-10-19 21:11:24 -0600164 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
Albert ARIBAUD \(3ADEV\)ed1cb1a2015-03-31 11:40:49 +0200165 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
Simon Glassc9c74032015-08-30 16:55:24 -0600166 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
Simon Glass3b1e5072015-08-30 16:55:25 -0600167 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
Simon Glassc17b1452015-08-30 16:55:26 -0600168 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
Albert ARIBAUD \(3ADEV\)2e9f4942016-09-26 09:08:06 +0200169 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
Nathan Rossice1771e2015-11-17 22:56:56 +1000170 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
Michal Simekfa124662016-04-27 14:03:29 +0200171 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
Alexander Graf5329d672018-04-13 14:18:52 +0200172 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
Michal Simek0a130b12016-05-17 13:58:44 +0200173 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
Andrew F. Davis378bcff2016-11-29 16:33:21 -0600174 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
Sven Ebenfeld59697a22016-11-06 16:37:56 +0100175 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
Andrew F. Davis30f9d562017-07-31 10:58:20 -0500176 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
Patrick Delaunaye6db5df2018-03-12 10:46:04 +0100177 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
developere1de5d42018-11-15 10:07:49 +0800178 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
Patrick Delaunay42594db2019-08-02 15:07:19 +0200179 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
Andre Przywarae53f9d92018-12-20 01:15:18 +0000180 { IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" },
Samuel Holland75728782022-03-18 00:00:43 -0500181 { IH_TYPE_SUNXI_TOC0, "sunxi_toc0", "Allwinner TOC0 Boot Image" },
Marc Kleine-Budde0aa1da62022-11-23 12:55:33 +0100182 { IH_TYPE_FDT_LEGACY, "fdt_legacy", "legacy Image with Flat Device Tree ", },
Ralph Siemsen2d283fa2023-05-12 21:36:57 -0400183 { IH_TYPE_RENESAS_SPKG, "spkgimage", "Renesas SPKG Image" },
Heinrich Schuchardtb28f8f32023-09-17 13:47:30 +0200184 { IH_TYPE_STARFIVE_SPL, "sfspl", "StarFive SPL Image" },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100185 { -1, "", "", },
186};
187
Mike Frysingercf2feb12010-10-20 07:17:39 -0400188static const table_entry_t uimage_comp[] = {
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100189 { IH_COMP_NONE, "none", "uncompressed", },
190 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
191 { IH_COMP_GZIP, "gzip", "gzip compressed", },
Luigi 'Comio' Mantellini35afc062008-09-08 02:46:13 +0200192 { IH_COMP_LZMA, "lzma", "lzma compressed", },
Peter Korsgaardf7440cd2009-11-19 11:37:51 +0100193 { IH_COMP_LZO, "lzo", "lzo compressed", },
Julius Wernerf41a3ca2015-10-06 20:03:53 -0700194 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
Robert Markod1c24842020-04-25 19:37:21 +0200195 { IH_COMP_ZSTD, "zstd", "zstd compressed", },
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100196 { -1, "", "", },
197};
198
Simon Glasse3f81ae2022-10-20 18:23:03 -0600199static 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
Simon Glass7da41d52016-06-30 10:52:14 -0600206struct table_info {
207 const char *desc;
208 int count;
209 const table_entry_t *table;
210};
211
Atish Patra04e8cd82020-03-05 16:24:22 -0800212static 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},},
Artem Lapkinc81801d2021-08-31 18:22:18 +0800217 { IH_COMP_LZ4, "lz4", {0x04, 0x22},},
218 { IH_COMP_ZSTD, "zstd", {0x28, 0xb5},},
Atish Patra04e8cd82020-03-05 16:24:22 -0800219 { IH_COMP_NONE, "none", {}, },
220};
221
Simon Glass7da41d52016-06-30 10:52:14 -0600222static 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 },
Simon Glasse3f81ae2022-10-20 18:23:03 -0600227 { "phase", IH_PHASE_COUNT, uimage_phase },
Simon Glass7da41d52016-06-30 10:52:14 -0600228};
229
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100230/*****************************************************************************/
231/* Legacy format routines */
232/*****************************************************************************/
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600233int image_check_hcrc(const struct legacy_img_hdr *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100234{
235 ulong hcrc;
Stephen Warren6904b6e2011-10-18 11:11:49 +0000236 ulong len = image_get_header_size();
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600237 struct legacy_img_hdr header;
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100238
239 /* Copy header so we can blank CRC field for re-calculation */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000240 memmove(&header, (char *)hdr, image_get_header_size());
241 image_set_hcrc(&header, 0);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100242
Stephen Warren6904b6e2011-10-18 11:11:49 +0000243 hcrc = crc32(0, (unsigned char *)&header, len);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100244
Stephen Warren6904b6e2011-10-18 11:11:49 +0000245 return (hcrc == image_get_hcrc(hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100246}
247
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600248int image_check_dcrc(const struct legacy_img_hdr *hdr)
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100249{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000250 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);
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100253
Stephen Warren6904b6e2011-10-18 11:11:49 +0000254 return (dcrc == image_get_dcrc(hdr));
Marian Balakowicz41d71ed2008-01-08 18:14:09 +0100255}
256
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100257/**
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 */
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600270ulong image_multi_count(const struct legacy_img_hdr *hdr)
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100271{
272 ulong i, count = 0;
Marian Balakowicza1474212008-02-29 16:00:06 +0100273 uint32_t *size;
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100274
275 /* get start of the image payload, which in case of multi
276 * component images that points to a table of component sizes */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000277 size = (uint32_t *)image_get_data(hdr);
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100278
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 */
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600303void image_multi_getimg(const struct legacy_img_hdr *hdr, ulong idx,
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100304 ulong *data, ulong *len)
305{
306 int i;
Marian Balakowicza1474212008-02-29 16:00:06 +0100307 uint32_t *size;
Nick Spence143a1592008-05-10 14:02:04 -0700308 ulong offset, count, img_data;
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100309
310 /* get number of component */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000311 count = image_multi_count(hdr);
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100312
313 /* get start of the image payload, which in case of multi
314 * component images that points to a table of component sizes */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000315 size = (uint32_t *)image_get_data(hdr);
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100316
317 /* get address of the proper component data start, which means
318 * skipping sizes table (add 1 for last, null entry) */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000319 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100320
321 if (idx < count) {
Stephen Warren6904b6e2011-10-18 11:11:49 +0000322 *len = uimage_to_cpu(size[idx]);
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100323 offset = 0;
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100324
325 /* go over all indices preceding requested component idx */
326 for (i = 0; i < idx; i++) {
Nick Spence143a1592008-05-10 14:02:04 -0700327 /* add up i-th component size, rounding up to 4 bytes */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000328 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100329 }
330
331 /* calculate idx-th component data address */
Nick Spence143a1592008-05-10 14:02:04 -0700332 *data = img_data + offset;
Marian Balakowiczb4a12a92008-01-08 18:12:17 +0100333 } else {
334 *len = 0;
335 *data = 0;
336 }
337}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100338
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600339static void image_print_type(const struct legacy_img_hdr *hdr)
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100340{
Heiko Schocher62cb1562015-06-29 09:10:46 +0200341 const char __maybe_unused *os, *arch, *type, *comp;
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100342
Stephen Warren6904b6e2011-10-18 11:11:49 +0000343 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));
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100347
Stephen Warren6904b6e2011-10-18 11:11:49 +0000348 printf("%s %s %s (%s)\n", arch, os, type, comp);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100349}
350
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100351/**
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200352 * image_print_contents - prints out the contents of the legacy format image
Wolfgang Denk3b506772009-08-19 11:42:56 +0200353 * @ptr: pointer to the legacy format image header
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100354 * @p: pointer to prefix string
355 *
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200356 * image_print_contents() formats a multi line legacy image contents description.
Marian Balakowicze227fbb2008-02-29 21:24:06 +0100357 * 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 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000363void image_print_contents(const void *ptr)
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100364{
Simon Glassbb7d3bb2022-09-06 20:26:52 -0600365 const struct legacy_img_hdr *hdr = (const struct legacy_img_hdr *)ptr;
Heiko Schocher62cb1562015-06-29 09:10:46 +0200366 const char __maybe_unused *p;
Bartlomiej Sieka47868592008-04-18 12:39:23 +0200367
Simon Glass1030f162013-05-08 08:05:58 +0000368 p = IMAGE_INDENT_STRING;
Stephen Warren6904b6e2011-10-18 11:11:49 +0000369 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
Simon Glassaf0ec0d2013-05-07 06:11:51 +0000370 if (IMAGE_ENABLE_TIMESTAMP) {
371 printf("%sCreated: ", p);
372 genimg_print_time((time_t)image_get_time(hdr));
373 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000374 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));
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100380
Stephen Warren6904b6e2011-10-18 11:11:49 +0000381 if (image_check_type(hdr, IH_TYPE_MULTI) ||
382 image_check_type(hdr, IH_TYPE_SCRIPT)) {
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100383 int i;
384 ulong data, len;
Stephen Warren6904b6e2011-10-18 11:11:49 +0000385 ulong count = image_multi_count(hdr);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100386
Stephen Warren6904b6e2011-10-18 11:11:49 +0000387 printf("%sContents:\n", p);
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100388 for (i = 0; i < count; i++) {
Stephen Warren6904b6e2011-10-18 11:11:49 +0000389 image_multi_getimg(hdr, i, &data, &len);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100390
Stephen Warren6904b6e2011-10-18 11:11:49 +0000391 printf("%s Image %d: ", p, i);
392 genimg_print_size(len);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100393
Stephen Warren6904b6e2011-10-18 11:11:49 +0000394 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100395 /*
396 * the user may need to know offsets
397 * if planning to do something with
398 * multiple files
399 */
Stephen Warren6904b6e2011-10-18 11:11:49 +0000400 printf("%s Offset = 0x%08lx\n", p, data);
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100401 }
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100402 }
Sven Ebenfeld59697a22016-11-06 16:37:56 +0100403 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
404 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
Breno Matheus Limac592c342019-09-23 18:39:47 +0000405 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));
Marian Balakowiczd7c88a42008-02-29 14:58:34 +0100408 }
409}
410
Julius Werner47ef9862019-07-24 19:37:54 -0700411/**
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
Simon Glass59f0c4d2023-11-19 07:43:32 -0700417 * @load: Load address for printing
Julius Werner47ef9862019-07-24 19:37:54 -0700418 */
Simon Glass59f0c4d2023-11-19 07:43:32 -0700419static void print_decomp_msg(int comp_type, int type, bool is_xip,
420 ulong load)
Julius Werner47ef9862019-07-24 19:37:54 -0700421{
422 const char *name = genimg_get_type_name(type);
423
Simon Glass59f0c4d2023-11-19 07:43:32 -0700424 /* Shows "Loading Kernel Image" for example */
Julius Werner47ef9862019-07-24 19:37:54 -0700425 if (comp_type == IH_COMP_NONE)
Simon Glass59f0c4d2023-11-19 07:43:32 -0700426 printf(" %s %s", is_xip ? "XIP" : "Loading", name);
Julius Werner47ef9862019-07-24 19:37:54 -0700427 else
Simon Glass59f0c4d2023-11-19 07:43:32 -0700428 printf(" Uncompressing %s", name);
429
430 printf(" to %lx\n", load);
Julius Werner47ef9862019-07-24 19:37:54 -0700431}
432
Atish Patra04e8cd82020-03-05 16:24:22 -0800433int image_decomp_type(const unsigned char *buf, ulong len)
434{
435 const struct comp_magic_map *cmagic = image_comp;
436
437 if (len < 2)
438 return -EINVAL;
439
440 for (; cmagic->comp_id > 0; cmagic++) {
441 if (!memcmp(buf, cmagic->magic, 2))
442 break;
443 }
444
445 return cmagic->comp_id;
446}
447
Julius Werner47ef9862019-07-24 19:37:54 -0700448int image_decomp(int comp, ulong load, ulong image_start, int type,
449 void *load_buf, void *image_buf, ulong image_len,
450 uint unc_len, ulong *load_end)
451{
Simon Glasseefec3d2021-09-25 07:03:11 -0600452 int ret = -ENOSYS;
Julius Werner47ef9862019-07-24 19:37:54 -0700453
454 *load_end = load;
Simon Glass59f0c4d2023-11-19 07:43:32 -0700455 print_decomp_msg(comp, type, load == image_start, load);
Julius Werner47ef9862019-07-24 19:37:54 -0700456
457 /*
458 * Load the image to the right place, decompressing if needed. After
459 * this, image_len will be set to the number of uncompressed bytes
460 * loaded, ret will be non-zero on error.
461 */
462 switch (comp) {
463 case IH_COMP_NONE:
Simon Glasseefec3d2021-09-25 07:03:11 -0600464 ret = 0;
Julius Werner47ef9862019-07-24 19:37:54 -0700465 if (load == image_start)
466 break;
467 if (image_len <= unc_len)
468 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
469 else
470 ret = -ENOSPC;
471 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600472 case IH_COMP_GZIP:
Simon Glassdb503fb2021-09-25 19:43:14 -0600473 if (!tools_build() && CONFIG_IS_ENABLED(GZIP))
Simon Glassfd86d012021-09-25 07:03:14 -0600474 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
Julius Werner47ef9862019-07-24 19:37:54 -0700475 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600476 case IH_COMP_BZIP2:
Simon Glassdb503fb2021-09-25 19:43:14 -0600477 if (!tools_build() && CONFIG_IS_ENABLED(BZIP2)) {
Simon Glassfd86d012021-09-25 07:03:14 -0600478 uint size = unc_len;
Julius Werner47ef9862019-07-24 19:37:54 -0700479
Simon Glassfd86d012021-09-25 07:03:14 -0600480 /*
481 * If we've got less than 4 MB of malloc() space,
482 * use slower decompression algorithm which requires
483 * at most 2300 KB of memory.
484 */
485 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
486 image_buf, image_len, CONSERVE_MEMORY, 0);
487 image_len = size;
488 }
Julius Werner47ef9862019-07-24 19:37:54 -0700489 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600490 case IH_COMP_LZMA:
Simon Glassdb503fb2021-09-25 19:43:14 -0600491 if (!tools_build() && CONFIG_IS_ENABLED(LZMA)) {
Simon Glassfd86d012021-09-25 07:03:14 -0600492 SizeT lzma_len = unc_len;
Julius Werner47ef9862019-07-24 19:37:54 -0700493
Simon Glassfd86d012021-09-25 07:03:14 -0600494 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
495 image_buf, image_len);
496 image_len = lzma_len;
497 }
Julius Werner47ef9862019-07-24 19:37:54 -0700498 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600499 case IH_COMP_LZO:
Simon Glassdb503fb2021-09-25 19:43:14 -0600500 if (!tools_build() && CONFIG_IS_ENABLED(LZO)) {
Simon Glassfd86d012021-09-25 07:03:14 -0600501 size_t size = unc_len;
Julius Werner47ef9862019-07-24 19:37:54 -0700502
Simon Glassfd86d012021-09-25 07:03:14 -0600503 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
504 image_len = size;
505 }
Julius Werner47ef9862019-07-24 19:37:54 -0700506 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600507 case IH_COMP_LZ4:
Simon Glassdb503fb2021-09-25 19:43:14 -0600508 if (!tools_build() && CONFIG_IS_ENABLED(LZ4)) {
Simon Glassfd86d012021-09-25 07:03:14 -0600509 size_t size = unc_len;
Julius Werner47ef9862019-07-24 19:37:54 -0700510
Simon Glassfd86d012021-09-25 07:03:14 -0600511 ret = ulz4fn(image_buf, image_len, load_buf, &size);
512 image_len = size;
513 }
Julius Werner47ef9862019-07-24 19:37:54 -0700514 break;
Simon Glassfd86d012021-09-25 07:03:14 -0600515 case IH_COMP_ZSTD:
Simon Glassdb503fb2021-09-25 19:43:14 -0600516 if (!tools_build() && CONFIG_IS_ENABLED(ZSTD)) {
Simon Glassfd86d012021-09-25 07:03:14 -0600517 struct abuf in, out;
Robert Markod1c24842020-04-25 19:37:21 +0200518
Simon Glassfd86d012021-09-25 07:03:14 -0600519 abuf_init_set(&in, image_buf, image_len);
Jérôme Carretero0edb7a92022-03-16 15:35:36 -0400520 abuf_init_set(&out, load_buf, unc_len);
Simon Glassfd86d012021-09-25 07:03:14 -0600521 ret = zstd_decompress(&in, &out);
522 if (ret >= 0) {
523 image_len = ret;
524 ret = 0;
525 }
Robert Markod1c24842020-04-25 19:37:21 +0200526 }
Robert Markod1c24842020-04-25 19:37:21 +0200527 break;
528 }
Simon Glasseefec3d2021-09-25 07:03:11 -0600529 if (ret == -ENOSYS) {
Julius Werner47ef9862019-07-24 19:37:54 -0700530 printf("Unimplemented compression type %d\n", comp);
Simon Glasseefec3d2021-09-25 07:03:11 -0600531 return ret;
Julius Werner47ef9862019-07-24 19:37:54 -0700532 }
Simon Glasseefec3d2021-09-25 07:03:11 -0600533 if (ret)
534 return ret;
Julius Werner47ef9862019-07-24 19:37:54 -0700535
536 *load_end = load + image_len;
537
Simon Glasseefec3d2021-09-25 07:03:11 -0600538 return 0;
Julius Werner47ef9862019-07-24 19:37:54 -0700539}
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100540
Simon Glass434a31b2015-06-23 15:38:25 -0600541const table_entry_t *get_table_entry(const table_entry_t *table, int id)
542{
543 for (; table->id >= 0; ++table) {
544 if (table->id == id)
545 return table;
546 }
547 return NULL;
548}
549
Simon Glass19864332016-06-30 10:52:16 -0600550static const char *unknown_msg(enum ih_category category)
551{
Simon Glassddb26072016-10-31 10:21:09 -0600552 static const char unknown_str[] = "Unknown ";
Simon Glass19864332016-06-30 10:52:16 -0600553 static char msg[30];
554
Simon Glassddb26072016-10-31 10:21:09 -0600555 strcpy(msg, unknown_str);
556 strncat(msg, table_info[category].desc,
557 sizeof(msg) - sizeof(unknown_str));
Simon Glass19864332016-06-30 10:52:16 -0600558
559 return msg;
560}
561
562/**
Naoki Hayama9f1622f2020-10-07 11:22:24 +0900563 * genimg_get_cat_name - translate entry id to long name
Simon Glass19864332016-06-30 10:52:16 -0600564 * @category: category to look up (enum ih_category)
565 * @id: entry id to be translated
566 *
567 * This will scan the translation table trying to find the entry that matches
568 * the given id.
569 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100570 * Return: long entry name if translation succeeds; error string on failure
Simon Glass19864332016-06-30 10:52:16 -0600571 */
572const char *genimg_get_cat_name(enum ih_category category, uint id)
573{
574 const table_entry_t *entry;
575
576 entry = get_table_entry(table_info[category].table, id);
577 if (!entry)
578 return unknown_msg(category);
Marek Vasut869835d2023-09-06 23:29:59 +0200579 return entry->lname;
Simon Glass19864332016-06-30 10:52:16 -0600580}
581
582/**
Naoki Hayama9f1622f2020-10-07 11:22:24 +0900583 * genimg_get_cat_short_name - translate entry id to short name
Simon Glass19864332016-06-30 10:52:16 -0600584 * @category: category to look up (enum ih_category)
585 * @id: entry id to be translated
586 *
587 * This will scan the translation table trying to find the entry that matches
588 * the given id.
589 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100590 * Return: short entry name if translation succeeds; error string on failure
Simon Glass19864332016-06-30 10:52:16 -0600591 */
592const char *genimg_get_cat_short_name(enum ih_category category, uint id)
593{
594 const table_entry_t *entry;
595
596 entry = get_table_entry(table_info[category].table, id);
597 if (!entry)
598 return unknown_msg(category);
Marek Vasut869835d2023-09-06 23:29:59 +0200599 return entry->sname;
Simon Glass19864332016-06-30 10:52:16 -0600600}
601
602int genimg_get_cat_count(enum ih_category category)
603{
604 return table_info[category].count;
605}
606
607const char *genimg_get_cat_desc(enum ih_category category)
608{
609 return table_info[category].desc;
610}
611
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100612/**
Naoki Hayamad7e82912020-10-07 11:21:25 +0900613 * genimg_cat_has_id - check whether category has entry id
614 * @category: category to look up (enum ih_category)
615 * @id: entry id to be checked
616 *
617 * This will scan the translation table trying to find the entry that matches
618 * the given id.
619 *
Heinrich Schuchardt47b4c022022-01-19 18:05:50 +0100620 * Return: true if category has entry id; false if not
Naoki Hayamad7e82912020-10-07 11:21:25 +0900621 */
622bool genimg_cat_has_id(enum ih_category category, uint id)
623{
624 if (get_table_entry(table_info[category].table, id))
625 return true;
626
627 return false;
628}
629
630/**
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100631 * get_table_entry_name - translate entry id to long name
632 * @table: pointer to a translation table for entries of a specific type
633 * @msg: message to be returned when translation fails
634 * @id: entry id to be translated
635 *
636 * get_table_entry_name() will go over translation table trying to find
637 * entry that matches given id. If matching entry is found, its long
638 * name is returned to the caller.
639 *
640 * returns:
641 * long entry name if translation succeeds
642 * msg otherwise
643 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400644char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100645{
Simon Glass434a31b2015-06-23 15:38:25 -0600646 table = get_table_entry(table, id);
647 if (!table)
648 return msg;
Marek Vasut869835d2023-09-06 23:29:59 +0200649 return table->lname;
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100650}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100651
Stephen Warren6904b6e2011-10-18 11:11:49 +0000652const char *genimg_get_os_name(uint8_t os)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100653{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000654 return (get_table_entry_name(uimage_os, "Unknown OS", os));
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100655}
656
Stephen Warren6904b6e2011-10-18 11:11:49 +0000657const char *genimg_get_arch_name(uint8_t arch)
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100658{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000659 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
660 arch));
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100661}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100662
Stephen Warren6904b6e2011-10-18 11:11:49 +0000663const char *genimg_get_type_name(uint8_t type)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100664{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000665 return (get_table_entry_name(uimage_type, "Unknown Image", type));
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100666}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100667
Naoki Hayama9f1622f2020-10-07 11:22:24 +0900668const char *genimg_get_comp_name(uint8_t comp)
669{
670 return (get_table_entry_name(uimage_comp, "Unknown Compression",
671 comp));
672}
673
Simon Glasse3f81ae2022-10-20 18:23:03 -0600674const char *genimg_get_phase_name(enum image_phase_t phase)
675{
676 return get_table_entry_name(uimage_phase, "Unknown Phase", phase);
677}
678
Simon Glass86c362d2016-02-22 22:55:50 -0700679static const char *genimg_get_short_name(const table_entry_t *table, int val)
Simon Glass434a31b2015-06-23 15:38:25 -0600680{
Simon Glass86c362d2016-02-22 22:55:50 -0700681 table = get_table_entry(table, val);
Simon Glass434a31b2015-06-23 15:38:25 -0600682 if (!table)
683 return "unknown";
Marek Vasut869835d2023-09-06 23:29:59 +0200684 return table->sname;
Simon Glass434a31b2015-06-23 15:38:25 -0600685}
686
Simon Glass86c362d2016-02-22 22:55:50 -0700687const char *genimg_get_type_short_name(uint8_t type)
688{
689 return genimg_get_short_name(uimage_type, type);
690}
691
Simon Glass86c362d2016-02-22 22:55:50 -0700692const char *genimg_get_comp_short_name(uint8_t comp)
693{
694 return genimg_get_short_name(uimage_comp, comp);
695}
696
697const char *genimg_get_os_short_name(uint8_t os)
698{
699 return genimg_get_short_name(uimage_os, os);
700}
701
702const char *genimg_get_arch_short_name(uint8_t arch)
703{
704 return genimg_get_short_name(uimage_arch, arch);
705}
706
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100707/**
708 * get_table_entry_id - translate short entry name to id
709 * @table: pointer to a translation table for entries of a specific type
710 * @table_name: to be used in case of error
711 * @name: entry short name to be translated
712 *
713 * get_table_entry_id() will go over translation table trying to find
714 * entry that matches given short name. If matching entry is found,
715 * its id returned to the caller.
716 *
717 * returns:
718 * entry id if translation succeeds
719 * -1 otherwise
720 */
Mike Frysingercf2feb12010-10-20 07:17:39 -0400721int get_table_entry_id(const table_entry_t *table,
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100722 const char *table_name, const char *name)
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100723{
Mike Frysingercf2feb12010-10-20 07:17:39 -0400724 const table_entry_t *t;
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100725
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100726 for (t = table; t->id >= 0; ++t) {
Marek Vasut869835d2023-09-06 23:29:59 +0200727 if (t->sname && !strcasecmp(t->sname, name))
Simon Glass684ef382021-09-25 07:03:18 -0600728 return t->id;
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100729 }
Stephen Warren6904b6e2011-10-18 11:11:49 +0000730 debug("Invalid %s Type: %s\n", table_name, name);
Simon Glass434a31b2015-06-23 15:38:25 -0600731
732 return -1;
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100733}
734
Stephen Warren6904b6e2011-10-18 11:11:49 +0000735int genimg_get_os_id(const char *name)
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100736{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000737 return (get_table_entry_id(uimage_os, "OS", name));
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100738}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100739
Stephen Warren6904b6e2011-10-18 11:11:49 +0000740int genimg_get_arch_id(const char *name)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100741{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000742 return (get_table_entry_id(uimage_arch, "CPU", name));
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100743}
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100744
Stephen Warren6904b6e2011-10-18 11:11:49 +0000745int genimg_get_type_id(const char *name)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100746{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000747 return (get_table_entry_id(uimage_type, "Image", name));
Marian Balakowicz05c1d3f2008-01-31 13:20:07 +0100748}
Marian Balakowicz95418502008-01-31 13:55:39 +0100749
Stephen Warren6904b6e2011-10-18 11:11:49 +0000750int genimg_get_comp_id(const char *name)
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100751{
Stephen Warren6904b6e2011-10-18 11:11:49 +0000752 return (get_table_entry_id(uimage_comp, "Compression", name));
Marian Balakowiczc3c7eb22008-02-29 15:59:59 +0100753}
Simon Glasse3f81ae2022-10-20 18:23:03 -0600754
755int genimg_get_phase_id(const char *name)
756{
757 return get_table_entry_id(uimage_phase, "Phase", name);
758}