1
2
3
4
5
6
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
33DECLARE_GLOBAL_DATA_PTR;
34
35
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
43#include "mkimage.h"
44#include <u-boot/md5.h>
45#include <time.h>
46
47#ifndef __maybe_unused
48# define __maybe_unused
49#endif
50
51#define CONSERVE_MEMORY false
52
53#endif
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
71static 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
101static 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#if defined(USE_HOSTCC)
106 { IH_OS_LYNXOS, "lynxos", "LynxOS", },
107#endif
108 { IH_OS_NETBSD, "netbsd", "NetBSD", },
109 { IH_OS_OSE, "ose", "Enea OSE", },
110 { IH_OS_PLAN9, "plan9", "Plan 9", },
111 { IH_OS_RTEMS, "rtems", "RTEMS", },
112 { IH_OS_TEE, "tee", "Trusted Execution Environment" },
113 { IH_OS_U_BOOT, "u-boot", "U-Boot", },
114 { IH_OS_VXWORKS, "vxworks", "VxWorks", },
115#if defined(CONFIG_CMD_ELF) || defined(USE_HOSTCC)
116 { IH_OS_QNX, "qnx", "QNX", },
117#endif
118#if defined(CONFIG_INTEGRITY) || defined(USE_HOSTCC)
119 { IH_OS_INTEGRITY,"integrity", "INTEGRITY", },
120#endif
121#ifdef USE_HOSTCC
122 { IH_OS_4_4BSD, "4_4bsd", "4_4BSD", },
123 { IH_OS_DELL, "dell", "Dell", },
124 { IH_OS_ESIX, "esix", "Esix", },
125 { IH_OS_FREEBSD, "freebsd", "FreeBSD", },
126 { IH_OS_IRIX, "irix", "Irix", },
127 { IH_OS_NCR, "ncr", "NCR", },
128 { IH_OS_OPENBSD, "openbsd", "OpenBSD", },
129 { IH_OS_PSOS, "psos", "pSOS", },
130 { IH_OS_SCO, "sco", "SCO", },
131 { IH_OS_SOLARIS, "solaris", "Solaris", },
132 { IH_OS_SVR4, "svr4", "SVR4", },
133#endif
134#if defined(CONFIG_BOOTM_OPENRTOS) || defined(USE_HOSTCC)
135 { IH_OS_OPENRTOS, "openrtos", "OpenRTOS", },
136#endif
137 { IH_OS_OPENSBI, "opensbi", "RISC-V OpenSBI", },
138 { IH_OS_EFI, "efi", "EFI Firmware" },
139
140 { -1, "", "", },
141};
142
143static const table_entry_t uimage_type[] = {
144 { IH_TYPE_AISIMAGE, "aisimage", "Davinci AIS image",},
145 { IH_TYPE_FILESYSTEM, "filesystem", "Filesystem Image", },
146 { IH_TYPE_FIRMWARE, "firmware", "Firmware", },
147 { IH_TYPE_FLATDT, "flat_dt", "Flat Device Tree", },
148 { IH_TYPE_GPIMAGE, "gpimage", "TI Keystone SPL Image",},
149 { IH_TYPE_KERNEL, "kernel", "Kernel Image", },
150 { IH_TYPE_KERNEL_NOLOAD, "kernel_noload", "Kernel Image (no loading done)", },
151 { IH_TYPE_KWBIMAGE, "kwbimage", "Kirkwood Boot Image",},
152 { IH_TYPE_IMXIMAGE, "imximage", "Freescale i.MX Boot Image",},
153 { IH_TYPE_IMX8IMAGE, "imx8image", "NXP i.MX8 Boot Image",},
154 { IH_TYPE_IMX8MIMAGE, "imx8mimage", "NXP i.MX8M Boot Image",},
155 { IH_TYPE_INVALID, "invalid", "Invalid Image", },
156 { IH_TYPE_MULTI, "multi", "Multi-File Image", },
157 { IH_TYPE_OMAPIMAGE, "omapimage", "TI OMAP SPL With GP CH",},
158 { IH_TYPE_PBLIMAGE, "pblimage", "Freescale PBL Boot Image",},
159 { IH_TYPE_RAMDISK, "ramdisk", "RAMDisk Image", },
160 { IH_TYPE_SCRIPT, "script", "Script", },
161 { IH_TYPE_SOCFPGAIMAGE, "socfpgaimage", "Altera SoCFPGA CV/AV preloader",},
162 { IH_TYPE_SOCFPGAIMAGE_V1, "socfpgaimage_v1", "Altera SoCFPGA A10 preloader",},
163 { IH_TYPE_STANDALONE, "standalone", "Standalone Program", },
164 { IH_TYPE_UBLIMAGE, "ublimage", "Davinci UBL image",},
165 { IH_TYPE_MXSIMAGE, "mxsimage", "Freescale MXS Boot Image",},
166 { IH_TYPE_ATMELIMAGE, "atmelimage", "ATMEL ROM-Boot Image",},
167 { IH_TYPE_X86_SETUP, "x86_setup", "x86 setup.bin", },
168 { IH_TYPE_LPC32XXIMAGE, "lpc32xximage", "LPC32XX Boot Image", },
169 { IH_TYPE_RKIMAGE, "rkimage", "Rockchip Boot Image" },
170 { IH_TYPE_RKSD, "rksd", "Rockchip SD Boot Image" },
171 { IH_TYPE_RKSPI, "rkspi", "Rockchip SPI Boot Image" },
172 { IH_TYPE_VYBRIDIMAGE, "vybridimage", "Vybrid Boot Image", },
173 { IH_TYPE_ZYNQIMAGE, "zynqimage", "Xilinx Zynq Boot Image" },
174 { IH_TYPE_ZYNQMPIMAGE, "zynqmpimage", "Xilinx ZynqMP Boot Image" },
175 { IH_TYPE_ZYNQMPBIF, "zynqmpbif", "Xilinx ZynqMP Boot Image (bif)" },
176 { IH_TYPE_FPGA, "fpga", "FPGA Image" },
177 { IH_TYPE_TEE, "tee", "Trusted Execution Environment Image",},
178 { IH_TYPE_FIRMWARE_IVT, "firmware_ivt", "Firmware with HABv4 IVT" },
179 { IH_TYPE_PMMC, "pmmc", "TI Power Management Micro-Controller Firmware",},
180 { IH_TYPE_STM32IMAGE, "stm32image", "STMicroelectronics STM32 Image" },
181 { IH_TYPE_MTKIMAGE, "mtk_image", "MediaTek BootROM loadable Image" },
182 { IH_TYPE_COPRO, "copro", "Coprocessor Image"},
183 { IH_TYPE_SUNXI_EGON, "sunxi_egon", "Allwinner eGON Boot Image" },
184 { -1, "", "", },
185};
186
187static const table_entry_t uimage_comp[] = {
188 { IH_COMP_NONE, "none", "uncompressed", },
189 { IH_COMP_BZIP2, "bzip2", "bzip2 compressed", },
190 { IH_COMP_GZIP, "gzip", "gzip compressed", },
191 { IH_COMP_LZMA, "lzma", "lzma compressed", },
192 { IH_COMP_LZO, "lzo", "lzo compressed", },
193 { IH_COMP_LZ4, "lz4", "lz4 compressed", },
194 { IH_COMP_ZSTD, "zstd", "zstd compressed", },
195 { -1, "", "", },
196};
197
198struct table_info {
199 const char *desc;
200 int count;
201 const table_entry_t *table;
202};
203
204static const struct comp_magic_map image_comp[] = {
205 { IH_COMP_BZIP2, "bzip2", {0x42, 0x5a},},
206 { IH_COMP_GZIP, "gzip", {0x1f, 0x8b},},
207 { IH_COMP_LZMA, "lzma", {0x5d, 0x00},},
208 { IH_COMP_LZO, "lzo", {0x89, 0x4c},},
209 { IH_COMP_LZ4, "lz4", {0x04, 0x22},},
210 { IH_COMP_ZSTD, "zstd", {0x28, 0xb5},},
211 { IH_COMP_NONE, "none", {}, },
212};
213
214static const struct table_info table_info[IH_COUNT] = {
215 { "architecture", IH_ARCH_COUNT, uimage_arch },
216 { "compression", IH_COMP_COUNT, uimage_comp },
217 { "operating system", IH_OS_COUNT, uimage_os },
218 { "image type", IH_TYPE_COUNT, uimage_type },
219};
220
221
222
223
224int image_check_hcrc(const image_header_t *hdr)
225{
226 ulong hcrc;
227 ulong len = image_get_header_size();
228 image_header_t header;
229
230
231 memmove(&header, (char *)hdr, image_get_header_size());
232 image_set_hcrc(&header, 0);
233
234 hcrc = crc32(0, (unsigned char *)&header, len);
235
236 return (hcrc == image_get_hcrc(hdr));
237}
238
239int image_check_dcrc(const image_header_t *hdr)
240{
241 ulong data = image_get_data(hdr);
242 ulong len = image_get_data_size(hdr);
243 ulong dcrc = crc32_wd(0, (unsigned char *)data, len, CHUNKSZ_CRC32);
244
245 return (dcrc == image_get_dcrc(hdr));
246}
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261ulong image_multi_count(const image_header_t *hdr)
262{
263 ulong i, count = 0;
264 uint32_t *size;
265
266
267
268 size = (uint32_t *)image_get_data(hdr);
269
270
271 for (i = 0; size[i]; ++i)
272 count++;
273
274 return count;
275}
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294void image_multi_getimg(const image_header_t *hdr, ulong idx,
295 ulong *data, ulong *len)
296{
297 int i;
298 uint32_t *size;
299 ulong offset, count, img_data;
300
301
302 count = image_multi_count(hdr);
303
304
305
306 size = (uint32_t *)image_get_data(hdr);
307
308
309
310 img_data = image_get_data(hdr) + (count + 1) * sizeof(uint32_t);
311
312 if (idx < count) {
313 *len = uimage_to_cpu(size[idx]);
314 offset = 0;
315
316
317 for (i = 0; i < idx; i++) {
318
319 offset += (uimage_to_cpu(size[i]) + 3) & ~3 ;
320 }
321
322
323 *data = img_data + offset;
324 } else {
325 *len = 0;
326 *data = 0;
327 }
328}
329
330static void image_print_type(const image_header_t *hdr)
331{
332 const char __maybe_unused *os, *arch, *type, *comp;
333
334 os = genimg_get_os_name(image_get_os(hdr));
335 arch = genimg_get_arch_name(image_get_arch(hdr));
336 type = genimg_get_type_name(image_get_type(hdr));
337 comp = genimg_get_comp_name(image_get_comp(hdr));
338
339 printf("%s %s %s (%s)\n", arch, os, type, comp);
340}
341
342
343
344
345
346
347
348
349
350
351
352
353
354void image_print_contents(const void *ptr)
355{
356 const image_header_t *hdr = (const image_header_t *)ptr;
357 const char __maybe_unused *p;
358
359 p = IMAGE_INDENT_STRING;
360 printf("%sImage Name: %.*s\n", p, IH_NMLEN, image_get_name(hdr));
361 if (IMAGE_ENABLE_TIMESTAMP) {
362 printf("%sCreated: ", p);
363 genimg_print_time((time_t)image_get_time(hdr));
364 }
365 printf("%sImage Type: ", p);
366 image_print_type(hdr);
367 printf("%sData Size: ", p);
368 genimg_print_size(image_get_data_size(hdr));
369 printf("%sLoad Address: %08x\n", p, image_get_load(hdr));
370 printf("%sEntry Point: %08x\n", p, image_get_ep(hdr));
371
372 if (image_check_type(hdr, IH_TYPE_MULTI) ||
373 image_check_type(hdr, IH_TYPE_SCRIPT)) {
374 int i;
375 ulong data, len;
376 ulong count = image_multi_count(hdr);
377
378 printf("%sContents:\n", p);
379 for (i = 0; i < count; i++) {
380 image_multi_getimg(hdr, i, &data, &len);
381
382 printf("%s Image %d: ", p, i);
383 genimg_print_size(len);
384
385 if (image_check_type(hdr, IH_TYPE_SCRIPT) && i > 0) {
386
387
388
389
390
391 printf("%s Offset = 0x%08lx\n", p, data);
392 }
393 }
394 } else if (image_check_type(hdr, IH_TYPE_FIRMWARE_IVT)) {
395 printf("HAB Blocks: 0x%08x 0x0000 0x%08x\n",
396 image_get_load(hdr) - image_get_header_size(),
397 (int)(image_get_size(hdr) + image_get_header_size()
398 + sizeof(flash_header_v2_t) - 0x2060));
399 }
400}
401
402
403
404
405
406
407
408
409static void print_decomp_msg(int comp_type, int type, bool is_xip)
410{
411 const char *name = genimg_get_type_name(type);
412
413 if (comp_type == IH_COMP_NONE)
414 printf(" %s %s\n", is_xip ? "XIP" : "Loading", name);
415 else
416 printf(" Uncompressing %s\n", name);
417}
418
419int image_decomp_type(const unsigned char *buf, ulong len)
420{
421 const struct comp_magic_map *cmagic = image_comp;
422
423 if (len < 2)
424 return -EINVAL;
425
426 for (; cmagic->comp_id > 0; cmagic++) {
427 if (!memcmp(buf, cmagic->magic, 2))
428 break;
429 }
430
431 return cmagic->comp_id;
432}
433
434int image_decomp(int comp, ulong load, ulong image_start, int type,
435 void *load_buf, void *image_buf, ulong image_len,
436 uint unc_len, ulong *load_end)
437{
438 int ret = -ENOSYS;
439
440 *load_end = load;
441 print_decomp_msg(comp, type, load == image_start);
442
443
444
445
446
447
448 switch (comp) {
449 case IH_COMP_NONE:
450 ret = 0;
451 if (load == image_start)
452 break;
453 if (image_len <= unc_len)
454 memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
455 else
456 ret = -ENOSPC;
457 break;
458 case IH_COMP_GZIP:
459 if (!tools_build() && CONFIG_IS_ENABLED(GZIP))
460 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
461 break;
462 case IH_COMP_BZIP2:
463 if (!tools_build() && CONFIG_IS_ENABLED(BZIP2)) {
464 uint size = unc_len;
465
466
467
468
469
470
471 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
472 image_buf, image_len, CONSERVE_MEMORY, 0);
473 image_len = size;
474 }
475 break;
476 case IH_COMP_LZMA:
477 if (!tools_build() && CONFIG_IS_ENABLED(LZMA)) {
478 SizeT lzma_len = unc_len;
479
480 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
481 image_buf, image_len);
482 image_len = lzma_len;
483 }
484 break;
485 case IH_COMP_LZO:
486 if (!tools_build() && CONFIG_IS_ENABLED(LZO)) {
487 size_t size = unc_len;
488
489 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
490 image_len = size;
491 }
492 break;
493 case IH_COMP_LZ4:
494 if (!tools_build() && CONFIG_IS_ENABLED(LZ4)) {
495 size_t size = unc_len;
496
497 ret = ulz4fn(image_buf, image_len, load_buf, &size);
498 image_len = size;
499 }
500 break;
501 case IH_COMP_ZSTD:
502 if (!tools_build() && CONFIG_IS_ENABLED(ZSTD)) {
503 struct abuf in, out;
504
505 abuf_init_set(&in, image_buf, image_len);
506 abuf_init_set(&in, load_buf, unc_len);
507 ret = zstd_decompress(&in, &out);
508 if (ret >= 0) {
509 image_len = ret;
510 ret = 0;
511 }
512 }
513 break;
514 }
515 if (ret == -ENOSYS) {
516 printf("Unimplemented compression type %d\n", comp);
517 return ret;
518 }
519 if (ret)
520 return ret;
521
522 *load_end = load + image_len;
523
524 return 0;
525}
526
527const table_entry_t *get_table_entry(const table_entry_t *table, int id)
528{
529 for (; table->id >= 0; ++table) {
530 if (table->id == id)
531 return table;
532 }
533 return NULL;
534}
535
536static const char *unknown_msg(enum ih_category category)
537{
538 static const char unknown_str[] = "Unknown ";
539 static char msg[30];
540
541 strcpy(msg, unknown_str);
542 strncat(msg, table_info[category].desc,
543 sizeof(msg) - sizeof(unknown_str));
544
545 return msg;
546}
547
548
549
550
551
552
553
554
555
556
557
558const char *genimg_get_cat_name(enum ih_category category, uint id)
559{
560 const table_entry_t *entry;
561
562 entry = get_table_entry(table_info[category].table, id);
563 if (!entry)
564 return unknown_msg(category);
565 return manual_reloc(entry->lname);
566}
567
568
569
570
571
572
573
574
575
576
577
578const char *genimg_get_cat_short_name(enum ih_category category, uint id)
579{
580 const table_entry_t *entry;
581
582 entry = get_table_entry(table_info[category].table, id);
583 if (!entry)
584 return unknown_msg(category);
585 return manual_reloc(entry->sname);
586}
587
588int genimg_get_cat_count(enum ih_category category)
589{
590 return table_info[category].count;
591}
592
593const char *genimg_get_cat_desc(enum ih_category category)
594{
595 return table_info[category].desc;
596}
597
598
599
600
601
602
603
604
605
606
607
608bool genimg_cat_has_id(enum ih_category category, uint id)
609{
610 if (get_table_entry(table_info[category].table, id))
611 return true;
612
613 return false;
614}
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630char *get_table_entry_name(const table_entry_t *table, char *msg, int id)
631{
632 table = get_table_entry(table, id);
633 if (!table)
634 return msg;
635 return manual_reloc(table->lname);
636}
637
638const char *genimg_get_os_name(uint8_t os)
639{
640 return (get_table_entry_name(uimage_os, "Unknown OS", os));
641}
642
643const char *genimg_get_arch_name(uint8_t arch)
644{
645 return (get_table_entry_name(uimage_arch, "Unknown Architecture",
646 arch));
647}
648
649const char *genimg_get_type_name(uint8_t type)
650{
651 return (get_table_entry_name(uimage_type, "Unknown Image", type));
652}
653
654const char *genimg_get_comp_name(uint8_t comp)
655{
656 return (get_table_entry_name(uimage_comp, "Unknown Compression",
657 comp));
658}
659
660static const char *genimg_get_short_name(const table_entry_t *table, int val)
661{
662 table = get_table_entry(table, val);
663 if (!table)
664 return "unknown";
665 return manual_reloc(table->sname);
666}
667
668const char *genimg_get_type_short_name(uint8_t type)
669{
670 return genimg_get_short_name(uimage_type, type);
671}
672
673const char *genimg_get_comp_short_name(uint8_t comp)
674{
675 return genimg_get_short_name(uimage_comp, comp);
676}
677
678const char *genimg_get_os_short_name(uint8_t os)
679{
680 return genimg_get_short_name(uimage_os, os);
681}
682
683const char *genimg_get_arch_short_name(uint8_t arch)
684{
685 return genimg_get_short_name(uimage_arch, arch);
686}
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702int get_table_entry_id(const table_entry_t *table,
703 const char *table_name, const char *name)
704{
705 const table_entry_t *t;
706
707 for (t = table; t->id >= 0; ++t) {
708 if (t->sname && !strcasecmp(manual_reloc(t->sname), name))
709 return t->id;
710 }
711 debug("Invalid %s Type: %s\n", table_name, name);
712
713 return -1;
714}
715
716int genimg_get_os_id(const char *name)
717{
718 return (get_table_entry_id(uimage_os, "OS", name));
719}
720
721int genimg_get_arch_id(const char *name)
722{
723 return (get_table_entry_id(uimage_arch, "CPU", name));
724}
725
726int genimg_get_type_id(const char *name)
727{
728 return (get_table_entry_id(uimage_type, "Image", name));
729}
730
731int genimg_get_comp_id(const char *name)
732{
733 return (get_table_entry_id(uimage_comp, "Compression", name));
734}
735