Merge branch 'master' of git://git.denx.de/u-boot-i2c
[oweals/u-boot.git] / common / bootm.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2000-2009
4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
5  */
6
7 #ifndef USE_HOSTCC
8 #include <common.h>
9 #include <bootstage.h>
10 #include <bzlib.h>
11 #include <errno.h>
12 #include <fdt_support.h>
13 #include <lmb.h>
14 #include <malloc.h>
15 #include <mapmem.h>
16 #include <asm/io.h>
17 #include <linux/lzo.h>
18 #include <lzma/LzmaTypes.h>
19 #include <lzma/LzmaDec.h>
20 #include <lzma/LzmaTools.h>
21 #if defined(CONFIG_CMD_USB)
22 #include <usb.h>
23 #endif
24 #else
25 #include "mkimage.h"
26 #endif
27
28 #include <command.h>
29 #include <bootm.h>
30 #include <image.h>
31
32 #ifndef CONFIG_SYS_BOOTM_LEN
33 /* use 8MByte as default max gunzip size */
34 #define CONFIG_SYS_BOOTM_LEN    0x800000
35 #endif
36
37 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
38
39 #ifndef USE_HOSTCC
40
41 DECLARE_GLOBAL_DATA_PTR;
42
43 bootm_headers_t images;         /* pointers to os/initrd/fdt images */
44
45 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
46                                    char * const argv[], bootm_headers_t *images,
47                                    ulong *os_data, ulong *os_len);
48
49 __weak void board_quiesce_devices(void)
50 {
51 }
52
53 #ifdef CONFIG_LMB
54 static void boot_start_lmb(bootm_headers_t *images)
55 {
56         ulong           mem_start;
57         phys_size_t     mem_size;
58
59         mem_start = env_get_bootm_low();
60         mem_size = env_get_bootm_size();
61
62         lmb_init_and_reserve_range(&images->lmb, (phys_addr_t)mem_start,
63                                    mem_size, NULL);
64 }
65 #else
66 #define lmb_reserve(lmb, base, size)
67 static inline void boot_start_lmb(bootm_headers_t *images) { }
68 #endif
69
70 static int bootm_start(cmd_tbl_t *cmdtp, int flag, int argc,
71                        char * const argv[])
72 {
73         memset((void *)&images, 0, sizeof(images));
74         images.verify = env_get_yesno("verify");
75
76         boot_start_lmb(&images);
77
78         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
79         images.state = BOOTM_STATE_START;
80
81         return 0;
82 }
83
84 static int bootm_find_os(cmd_tbl_t *cmdtp, int flag, int argc,
85                          char * const argv[])
86 {
87         const void *os_hdr;
88         bool ep_found = false;
89         int ret;
90
91         /* get kernel image header, start address and length */
92         os_hdr = boot_get_kernel(cmdtp, flag, argc, argv,
93                         &images, &images.os.image_start, &images.os.image_len);
94         if (images.os.image_len == 0) {
95                 puts("ERROR: can't get kernel image!\n");
96                 return 1;
97         }
98
99         /* get image parameters */
100         switch (genimg_get_format(os_hdr)) {
101 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
102         case IMAGE_FORMAT_LEGACY:
103                 images.os.type = image_get_type(os_hdr);
104                 images.os.comp = image_get_comp(os_hdr);
105                 images.os.os = image_get_os(os_hdr);
106
107                 images.os.end = image_get_image_end(os_hdr);
108                 images.os.load = image_get_load(os_hdr);
109                 images.os.arch = image_get_arch(os_hdr);
110                 break;
111 #endif
112 #if IMAGE_ENABLE_FIT
113         case IMAGE_FORMAT_FIT:
114                 if (fit_image_get_type(images.fit_hdr_os,
115                                        images.fit_noffset_os,
116                                        &images.os.type)) {
117                         puts("Can't get image type!\n");
118                         bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
119                         return 1;
120                 }
121
122                 if (fit_image_get_comp(images.fit_hdr_os,
123                                        images.fit_noffset_os,
124                                        &images.os.comp)) {
125                         puts("Can't get image compression!\n");
126                         bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
127                         return 1;
128                 }
129
130                 if (fit_image_get_os(images.fit_hdr_os, images.fit_noffset_os,
131                                      &images.os.os)) {
132                         puts("Can't get image OS!\n");
133                         bootstage_error(BOOTSTAGE_ID_FIT_OS);
134                         return 1;
135                 }
136
137                 if (fit_image_get_arch(images.fit_hdr_os,
138                                        images.fit_noffset_os,
139                                        &images.os.arch)) {
140                         puts("Can't get image ARCH!\n");
141                         return 1;
142                 }
143
144                 images.os.end = fit_get_end(images.fit_hdr_os);
145
146                 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
147                                        &images.os.load)) {
148                         puts("Can't get image load address!\n");
149                         bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
150                         return 1;
151                 }
152                 break;
153 #endif
154 #ifdef CONFIG_ANDROID_BOOT_IMAGE
155         case IMAGE_FORMAT_ANDROID:
156                 images.os.type = IH_TYPE_KERNEL;
157                 images.os.comp = IH_COMP_NONE;
158                 images.os.os = IH_OS_LINUX;
159
160                 images.os.end = android_image_get_end(os_hdr);
161                 images.os.load = android_image_get_kload(os_hdr);
162                 images.ep = images.os.load;
163                 ep_found = true;
164                 break;
165 #endif
166         default:
167                 puts("ERROR: unknown image format type!\n");
168                 return 1;
169         }
170
171         /* If we have a valid setup.bin, we will use that for entry (x86) */
172         if (images.os.arch == IH_ARCH_I386 ||
173             images.os.arch == IH_ARCH_X86_64) {
174                 ulong len;
175
176                 ret = boot_get_setup(&images, IH_ARCH_I386, &images.ep, &len);
177                 if (ret < 0 && ret != -ENOENT) {
178                         puts("Could not find a valid setup.bin for x86\n");
179                         return 1;
180                 }
181                 /* Kernel entry point is the setup.bin */
182         } else if (images.legacy_hdr_valid) {
183                 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
184 #if IMAGE_ENABLE_FIT
185         } else if (images.fit_uname_os) {
186                 int ret;
187
188                 ret = fit_image_get_entry(images.fit_hdr_os,
189                                           images.fit_noffset_os, &images.ep);
190                 if (ret) {
191                         puts("Can't get entry point property!\n");
192                         return 1;
193                 }
194 #endif
195         } else if (!ep_found) {
196                 puts("Could not find kernel entry point!\n");
197                 return 1;
198         }
199
200         if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
201                 if (CONFIG_IS_ENABLED(CMD_BOOTI) &&
202                     images.os.arch == IH_ARCH_ARM64) {
203                         ulong image_addr;
204                         ulong image_size;
205
206                         ret = booti_setup(images.os.image_start, &image_addr,
207                                           &image_size, true);
208                         if (ret != 0)
209                                 return 1;
210
211                         images.os.type = IH_TYPE_KERNEL;
212                         images.os.load = image_addr;
213                         images.ep = image_addr;
214                 } else {
215                         images.os.load = images.os.image_start;
216                         images.ep += images.os.image_start;
217                 }
218         }
219
220         images.os.start = map_to_sysmem(os_hdr);
221
222         return 0;
223 }
224
225 /**
226  * bootm_find_images - wrapper to find and locate various images
227  * @flag: Ignored Argument
228  * @argc: command argument count
229  * @argv: command argument list
230  *
231  * boot_find_images() will attempt to load an available ramdisk,
232  * flattened device tree, as well as specifically marked
233  * "loadable" images (loadables are FIT only)
234  *
235  * Note: bootm_find_images will skip an image if it is not found
236  *
237  * @return:
238  *     0, if all existing images were loaded correctly
239  *     1, if an image is found but corrupted, or invalid
240  */
241 int bootm_find_images(int flag, int argc, char * const argv[])
242 {
243         int ret;
244
245         /* find ramdisk */
246         ret = boot_get_ramdisk(argc, argv, &images, IH_INITRD_ARCH,
247                                &images.rd_start, &images.rd_end);
248         if (ret) {
249                 puts("Ramdisk image is corrupt or invalid\n");
250                 return 1;
251         }
252
253 #if IMAGE_ENABLE_OF_LIBFDT
254         /* find flattened device tree */
255         ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
256                            &images.ft_addr, &images.ft_len);
257         if (ret) {
258                 puts("Could not find a valid device tree\n");
259                 return 1;
260         }
261         if (CONFIG_IS_ENABLED(CMD_FDT))
262                 set_working_fdt_addr(map_to_sysmem(images.ft_addr));
263 #endif
264
265 #if IMAGE_ENABLE_FIT
266 #if defined(CONFIG_FPGA)
267         /* find bitstreams */
268         ret = boot_get_fpga(argc, argv, &images, IH_ARCH_DEFAULT,
269                             NULL, NULL);
270         if (ret) {
271                 printf("FPGA image is corrupted or invalid\n");
272                 return 1;
273         }
274 #endif
275
276         /* find all of the loadables */
277         ret = boot_get_loadable(argc, argv, &images, IH_ARCH_DEFAULT,
278                                NULL, NULL);
279         if (ret) {
280                 printf("Loadable(s) is corrupt or invalid\n");
281                 return 1;
282         }
283 #endif
284
285         return 0;
286 }
287
288 static int bootm_find_other(cmd_tbl_t *cmdtp, int flag, int argc,
289                             char * const argv[])
290 {
291         if (((images.os.type == IH_TYPE_KERNEL) ||
292              (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
293              (images.os.type == IH_TYPE_MULTI)) &&
294             (images.os.os == IH_OS_LINUX ||
295                  images.os.os == IH_OS_VXWORKS))
296                 return bootm_find_images(flag, argc, argv);
297
298         return 0;
299 }
300 #endif /* USE_HOSTC */
301
302 /**
303  * print_decomp_msg() - Print a suitable decompression/loading message
304  *
305  * @type:       OS type (IH_OS_...)
306  * @comp_type:  Compression type being used (IH_COMP_...)
307  * @is_xip:     true if the load address matches the image start
308  */
309 static void print_decomp_msg(int comp_type, int type, bool is_xip)
310 {
311         const char *name = genimg_get_type_name(type);
312
313         if (comp_type == IH_COMP_NONE)
314                 printf("   %s %s ... ", is_xip ? "XIP" : "Loading", name);
315         else
316                 printf("   Uncompressing %s ... ", name);
317 }
318
319 /**
320  * handle_decomp_error() - display a decompression error
321  *
322  * This function tries to produce a useful message. In the case where the
323  * uncompressed size is the same as the available space, we can assume that
324  * the image is too large for the buffer.
325  *
326  * @comp_type:          Compression type being used (IH_COMP_...)
327  * @uncomp_size:        Number of bytes uncompressed
328  * @unc_len:            Amount of space available for decompression
329  * @ret:                Error code to report
330  * @return BOOTM_ERR_RESET, indicating that the board must be reset
331  */
332 static int handle_decomp_error(int comp_type, size_t uncomp_size,
333                                size_t unc_len, int ret)
334 {
335         const char *name = genimg_get_comp_name(comp_type);
336
337         if (uncomp_size >= unc_len)
338                 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
339         else
340                 printf("%s: uncompress error %d\n", name, ret);
341
342         /*
343          * The decompression routines are now safe, so will not write beyond
344          * their bounds. Probably it is not necessary to reset, but maintain
345          * the current behaviour for now.
346          */
347         printf("Must RESET board to recover\n");
348 #ifndef USE_HOSTCC
349         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
350 #endif
351
352         return BOOTM_ERR_RESET;
353 }
354
355 int bootm_decomp_image(int comp, ulong load, ulong image_start, int type,
356                        void *load_buf, void *image_buf, ulong image_len,
357                        uint unc_len, ulong *load_end)
358 {
359         int ret = 0;
360
361         *load_end = load;
362         print_decomp_msg(comp, type, load == image_start);
363
364         /*
365          * Load the image to the right place, decompressing if needed. After
366          * this, image_len will be set to the number of uncompressed bytes
367          * loaded, ret will be non-zero on error.
368          */
369         switch (comp) {
370         case IH_COMP_NONE:
371                 if (load == image_start)
372                         break;
373                 if (image_len <= unc_len)
374                         memmove_wd(load_buf, image_buf, image_len, CHUNKSZ);
375                 else
376                         ret = 1;
377                 break;
378 #ifdef CONFIG_GZIP
379         case IH_COMP_GZIP: {
380                 ret = gunzip(load_buf, unc_len, image_buf, &image_len);
381                 break;
382         }
383 #endif /* CONFIG_GZIP */
384 #ifdef CONFIG_BZIP2
385         case IH_COMP_BZIP2: {
386                 uint size = unc_len;
387
388                 /*
389                  * If we've got less than 4 MB of malloc() space,
390                  * use slower decompression algorithm which requires
391                  * at most 2300 KB of memory.
392                  */
393                 ret = BZ2_bzBuffToBuffDecompress(load_buf, &size,
394                         image_buf, image_len,
395                         CONFIG_SYS_MALLOC_LEN < (4096 * 1024), 0);
396                 image_len = size;
397                 break;
398         }
399 #endif /* CONFIG_BZIP2 */
400 #ifdef CONFIG_LZMA
401         case IH_COMP_LZMA: {
402                 SizeT lzma_len = unc_len;
403
404                 ret = lzmaBuffToBuffDecompress(load_buf, &lzma_len,
405                                                image_buf, image_len);
406                 image_len = lzma_len;
407                 break;
408         }
409 #endif /* CONFIG_LZMA */
410 #ifdef CONFIG_LZO
411         case IH_COMP_LZO: {
412                 size_t size = unc_len;
413
414                 ret = lzop_decompress(image_buf, image_len, load_buf, &size);
415                 image_len = size;
416                 break;
417         }
418 #endif /* CONFIG_LZO */
419 #ifdef CONFIG_LZ4
420         case IH_COMP_LZ4: {
421                 size_t size = unc_len;
422
423                 ret = ulz4fn(image_buf, image_len, load_buf, &size);
424                 image_len = size;
425                 break;
426         }
427 #endif /* CONFIG_LZ4 */
428         default:
429                 printf("Unimplemented compression type %d\n", comp);
430                 return BOOTM_ERR_UNIMPLEMENTED;
431         }
432
433         if (ret)
434                 return handle_decomp_error(comp, image_len, unc_len, ret);
435         *load_end = load + image_len;
436
437         puts("OK\n");
438
439         return 0;
440 }
441
442 #ifndef USE_HOSTCC
443 static int bootm_load_os(bootm_headers_t *images, int boot_progress)
444 {
445         image_info_t os = images->os;
446         ulong load = os.load;
447         ulong load_end;
448         ulong blob_start = os.start;
449         ulong blob_end = os.end;
450         ulong image_start = os.image_start;
451         ulong image_len = os.image_len;
452         ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
453         ulong flush_len;
454         bool no_overlap;
455         void *load_buf, *image_buf;
456         int err;
457
458         load_buf = map_sysmem(load, 0);
459         image_buf = map_sysmem(os.image_start, image_len);
460         err = bootm_decomp_image(os.comp, load, os.image_start, os.type,
461                                  load_buf, image_buf, image_len,
462                                  CONFIG_SYS_BOOTM_LEN, &load_end);
463         if (err) {
464                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
465                 return err;
466         }
467
468         flush_len = load_end - load;
469         if (flush_start < load)
470                 flush_len += load - flush_start;
471
472         flush_cache(flush_start, ALIGN(flush_len, ARCH_DMA_MINALIGN));
473
474         debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, load_end);
475         bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
476
477         no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
478
479         if (!no_overlap && load < blob_end && load_end > blob_start) {
480                 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
481                       blob_start, blob_end);
482                 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
483                       load_end);
484
485                 /* Check what type of image this is. */
486                 if (images->legacy_hdr_valid) {
487                         if (image_get_type(&images->legacy_hdr_os_copy)
488                                         == IH_TYPE_MULTI)
489                                 puts("WARNING: legacy format multi component image overwritten\n");
490                         return BOOTM_ERR_OVERLAP;
491                 } else {
492                         puts("ERROR: new format image overwritten - must RESET the board to recover\n");
493                         bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
494                         return BOOTM_ERR_RESET;
495                 }
496         }
497
498         lmb_reserve(&images->lmb, images->os.load, (load_end -
499                                                     images->os.load));
500         return 0;
501 }
502
503 /**
504  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
505  *
506  * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
507  *      enabled)
508  */
509 ulong bootm_disable_interrupts(void)
510 {
511         ulong iflag;
512
513         /*
514          * We have reached the point of no return: we are going to
515          * overwrite all exception vector code, so we cannot easily
516          * recover from any failures any more...
517          */
518         iflag = disable_interrupts();
519 #ifdef CONFIG_NETCONSOLE
520         /* Stop the ethernet stack if NetConsole could have left it up */
521         eth_halt();
522 # ifndef CONFIG_DM_ETH
523         eth_unregister(eth_get_dev());
524 # endif
525 #endif
526
527 #if defined(CONFIG_CMD_USB)
528         /*
529          * turn off USB to prevent the host controller from writing to the
530          * SDRAM while Linux is booting. This could happen (at least for OHCI
531          * controller), because the HCCA (Host Controller Communication Area)
532          * lies within the SDRAM and the host controller writes continously to
533          * this area (as busmaster!). The HccaFrameNumber is for example
534          * updated every 1 ms within the HCCA structure in SDRAM! For more
535          * details see the OpenHCI specification.
536          */
537         usb_stop();
538 #endif
539         return iflag;
540 }
541
542 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
543
544 #define CONSOLE_ARG     "console="
545 #define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
546
547 static void fixup_silent_linux(void)
548 {
549         char *buf;
550         const char *env_val;
551         char *cmdline = env_get("bootargs");
552         int want_silent;
553
554         /*
555          * Only fix cmdline when requested. The environment variable can be:
556          *
557          *      no - we never fixup
558          *      yes - we always fixup
559          *      unset - we rely on the console silent flag
560          */
561         want_silent = env_get_yesno("silent_linux");
562         if (want_silent == 0)
563                 return;
564         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
565                 return;
566
567         debug("before silent fix-up: %s\n", cmdline);
568         if (cmdline && (cmdline[0] != '\0')) {
569                 char *start = strstr(cmdline, CONSOLE_ARG);
570
571                 /* Allocate space for maximum possible new command line */
572                 buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
573                 if (!buf) {
574                         debug("%s: out of memory\n", __func__);
575                         return;
576                 }
577
578                 if (start) {
579                         char *end = strchr(start, ' ');
580                         int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
581
582                         strncpy(buf, cmdline, num_start_bytes);
583                         if (end)
584                                 strcpy(buf + num_start_bytes, end);
585                         else
586                                 buf[num_start_bytes] = '\0';
587                 } else {
588                         sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
589                 }
590                 env_val = buf;
591         } else {
592                 buf = NULL;
593                 env_val = CONSOLE_ARG;
594         }
595
596         env_set("bootargs", env_val);
597         debug("after silent fix-up: %s\n", env_val);
598         free(buf);
599 }
600 #endif /* CONFIG_SILENT_CONSOLE */
601
602 /**
603  * Execute selected states of the bootm command.
604  *
605  * Note the arguments to this state must be the first argument, Any 'bootm'
606  * or sub-command arguments must have already been taken.
607  *
608  * Note that if states contains more than one flag it MUST contain
609  * BOOTM_STATE_START, since this handles and consumes the command line args.
610  *
611  * Also note that aside from boot_os_fn functions and bootm_load_os no other
612  * functions we store the return value of in 'ret' may use a negative return
613  * value, without special handling.
614  *
615  * @param cmdtp         Pointer to bootm command table entry
616  * @param flag          Command flags (CMD_FLAG_...)
617  * @param argc          Number of subcommand arguments (0 = no arguments)
618  * @param argv          Arguments
619  * @param states        Mask containing states to run (BOOTM_STATE_...)
620  * @param images        Image header information
621  * @param boot_progress 1 to show boot progress, 0 to not do this
622  * @return 0 if ok, something else on error. Some errors will cause this
623  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
624  *      then the intent is to boot an OS, so this function will not return
625  *      unless the image type is standalone.
626  */
627 int do_bootm_states(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[],
628                     int states, bootm_headers_t *images, int boot_progress)
629 {
630         boot_os_fn *boot_fn;
631         ulong iflag = 0;
632         int ret = 0, need_boot_fn;
633
634         images->state |= states;
635
636         /*
637          * Work through the states and see how far we get. We stop on
638          * any error.
639          */
640         if (states & BOOTM_STATE_START)
641                 ret = bootm_start(cmdtp, flag, argc, argv);
642
643         if (!ret && (states & BOOTM_STATE_FINDOS))
644                 ret = bootm_find_os(cmdtp, flag, argc, argv);
645
646         if (!ret && (states & BOOTM_STATE_FINDOTHER))
647                 ret = bootm_find_other(cmdtp, flag, argc, argv);
648
649         /* Load the OS */
650         if (!ret && (states & BOOTM_STATE_LOADOS)) {
651                 iflag = bootm_disable_interrupts();
652                 ret = bootm_load_os(images, 0);
653                 if (ret && ret != BOOTM_ERR_OVERLAP)
654                         goto err;
655                 else if (ret == BOOTM_ERR_OVERLAP)
656                         ret = 0;
657         }
658
659         /* Relocate the ramdisk */
660 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
661         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
662                 ulong rd_len = images->rd_end - images->rd_start;
663
664                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
665                         rd_len, &images->initrd_start, &images->initrd_end);
666                 if (!ret) {
667                         env_set_hex("initrd_start", images->initrd_start);
668                         env_set_hex("initrd_end", images->initrd_end);
669                 }
670         }
671 #endif
672 #if IMAGE_ENABLE_OF_LIBFDT && defined(CONFIG_LMB)
673         if (!ret && (states & BOOTM_STATE_FDT)) {
674                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
675                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
676                                         &images->ft_len);
677         }
678 #endif
679
680         /* From now on, we need the OS boot function */
681         if (ret)
682                 return ret;
683         boot_fn = bootm_os_get_boot_func(images->os.os);
684         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
685                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
686                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
687         if (boot_fn == NULL && need_boot_fn) {
688                 if (iflag)
689                         enable_interrupts();
690                 printf("ERROR: booting os '%s' (%d) is not supported\n",
691                        genimg_get_os_name(images->os.os), images->os.os);
692                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
693                 return 1;
694         }
695
696
697         /* Call various other states that are not generally used */
698         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
699                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
700         if (!ret && (states & BOOTM_STATE_OS_BD_T))
701                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
702         if (!ret && (states & BOOTM_STATE_OS_PREP)) {
703 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
704                 if (images->os.os == IH_OS_LINUX)
705                         fixup_silent_linux();
706 #endif
707                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
708         }
709
710 #ifdef CONFIG_TRACE
711         /* Pretend to run the OS, then run a user command */
712         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
713                 char *cmd_list = env_get("fakegocmd");
714
715                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
716                                 images, boot_fn);
717                 if (!ret && cmd_list)
718                         ret = run_command_list(cmd_list, -1, flag);
719         }
720 #endif
721
722         /* Check for unsupported subcommand. */
723         if (ret) {
724                 puts("subcommand not supported\n");
725                 return ret;
726         }
727
728         /* Now run the OS! We hope this doesn't return */
729         if (!ret && (states & BOOTM_STATE_OS_GO))
730                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
731                                 images, boot_fn);
732
733         /* Deal with any fallout */
734 err:
735         if (iflag)
736                 enable_interrupts();
737
738         if (ret == BOOTM_ERR_UNIMPLEMENTED)
739                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
740         else if (ret == BOOTM_ERR_RESET)
741                 do_reset(cmdtp, flag, argc, argv);
742
743         return ret;
744 }
745
746 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
747 /**
748  * image_get_kernel - verify legacy format kernel image
749  * @img_addr: in RAM address of the legacy format image to be verified
750  * @verify: data CRC verification flag
751  *
752  * image_get_kernel() verifies legacy image integrity and returns pointer to
753  * legacy image header if image verification was completed successfully.
754  *
755  * returns:
756  *     pointer to a legacy image header if valid image was found
757  *     otherwise return NULL
758  */
759 static image_header_t *image_get_kernel(ulong img_addr, int verify)
760 {
761         image_header_t *hdr = (image_header_t *)img_addr;
762
763         if (!image_check_magic(hdr)) {
764                 puts("Bad Magic Number\n");
765                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
766                 return NULL;
767         }
768         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
769
770         if (!image_check_hcrc(hdr)) {
771                 puts("Bad Header Checksum\n");
772                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
773                 return NULL;
774         }
775
776         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
777         image_print_contents(hdr);
778
779         if (verify) {
780                 puts("   Verifying Checksum ... ");
781                 if (!image_check_dcrc(hdr)) {
782                         printf("Bad Data CRC\n");
783                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
784                         return NULL;
785                 }
786                 puts("OK\n");
787         }
788         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
789
790         if (!image_check_target_arch(hdr)) {
791                 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
792                 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
793                 return NULL;
794         }
795         return hdr;
796 }
797 #endif
798
799 /**
800  * boot_get_kernel - find kernel image
801  * @os_data: pointer to a ulong variable, will hold os data start address
802  * @os_len: pointer to a ulong variable, will hold os data length
803  *
804  * boot_get_kernel() tries to find a kernel image, verifies its integrity
805  * and locates kernel data.
806  *
807  * returns:
808  *     pointer to image header if valid image was found, plus kernel start
809  *     address and length, otherwise NULL
810  */
811 static const void *boot_get_kernel(cmd_tbl_t *cmdtp, int flag, int argc,
812                                    char * const argv[], bootm_headers_t *images,
813                                    ulong *os_data, ulong *os_len)
814 {
815 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
816         image_header_t  *hdr;
817 #endif
818         ulong           img_addr;
819         const void *buf;
820         const char      *fit_uname_config = NULL;
821         const char      *fit_uname_kernel = NULL;
822 #if IMAGE_ENABLE_FIT
823         int             os_noffset;
824 #endif
825
826         img_addr = genimg_get_kernel_addr_fit(argc < 1 ? NULL : argv[0],
827                                               &fit_uname_config,
828                                               &fit_uname_kernel);
829
830         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
831
832         /* check image type, for FIT images get FIT kernel node */
833         *os_data = *os_len = 0;
834         buf = map_sysmem(img_addr, 0);
835         switch (genimg_get_format(buf)) {
836 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
837         case IMAGE_FORMAT_LEGACY:
838                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
839                        img_addr);
840                 hdr = image_get_kernel(img_addr, images->verify);
841                 if (!hdr)
842                         return NULL;
843                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
844
845                 /* get os_data and os_len */
846                 switch (image_get_type(hdr)) {
847                 case IH_TYPE_KERNEL:
848                 case IH_TYPE_KERNEL_NOLOAD:
849                         *os_data = image_get_data(hdr);
850                         *os_len = image_get_data_size(hdr);
851                         break;
852                 case IH_TYPE_MULTI:
853                         image_multi_getimg(hdr, 0, os_data, os_len);
854                         break;
855                 case IH_TYPE_STANDALONE:
856                         *os_data = image_get_data(hdr);
857                         *os_len = image_get_data_size(hdr);
858                         break;
859                 default:
860                         printf("Wrong Image Type for %s command\n",
861                                cmdtp->name);
862                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
863                         return NULL;
864                 }
865
866                 /*
867                  * copy image header to allow for image overwrites during
868                  * kernel decompression.
869                  */
870                 memmove(&images->legacy_hdr_os_copy, hdr,
871                         sizeof(image_header_t));
872
873                 /* save pointer to image header */
874                 images->legacy_hdr_os = hdr;
875
876                 images->legacy_hdr_valid = 1;
877                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
878                 break;
879 #endif
880 #if IMAGE_ENABLE_FIT
881         case IMAGE_FORMAT_FIT:
882                 os_noffset = fit_image_load(images, img_addr,
883                                 &fit_uname_kernel, &fit_uname_config,
884                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
885                                 BOOTSTAGE_ID_FIT_KERNEL_START,
886                                 FIT_LOAD_IGNORED, os_data, os_len);
887                 if (os_noffset < 0)
888                         return NULL;
889
890                 images->fit_hdr_os = map_sysmem(img_addr, 0);
891                 images->fit_uname_os = fit_uname_kernel;
892                 images->fit_uname_cfg = fit_uname_config;
893                 images->fit_noffset_os = os_noffset;
894                 break;
895 #endif
896 #ifdef CONFIG_ANDROID_BOOT_IMAGE
897         case IMAGE_FORMAT_ANDROID:
898                 printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
899                 if (android_image_get_kernel(buf, images->verify,
900                                              os_data, os_len))
901                         return NULL;
902                 break;
903 #endif
904         default:
905                 printf("Wrong Image Format for %s command\n", cmdtp->name);
906                 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
907                 return NULL;
908         }
909
910         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
911               *os_data, *os_len, *os_len);
912
913         return buf;
914 }
915
916 /**
917  * switch_to_non_secure_mode() - switch to non-secure mode
918  *
919  * This routine is overridden by architectures requiring this feature.
920  */
921 void __weak switch_to_non_secure_mode(void)
922 {
923 }
924
925 #else /* USE_HOSTCC */
926
927 void memmove_wd(void *to, void *from, size_t len, ulong chunksz)
928 {
929         memmove(to, from, len);
930 }
931
932 static int bootm_host_load_image(const void *fit, int req_image_type)
933 {
934         const char *fit_uname_config = NULL;
935         ulong data, len;
936         bootm_headers_t images;
937         int noffset;
938         ulong load_end;
939         uint8_t image_type;
940         uint8_t imape_comp;
941         void *load_buf;
942         int ret;
943
944         memset(&images, '\0', sizeof(images));
945         images.verify = 1;
946         noffset = fit_image_load(&images, (ulong)fit,
947                 NULL, &fit_uname_config,
948                 IH_ARCH_DEFAULT, req_image_type, -1,
949                 FIT_LOAD_IGNORED, &data, &len);
950         if (noffset < 0)
951                 return noffset;
952         if (fit_image_get_type(fit, noffset, &image_type)) {
953                 puts("Can't get image type!\n");
954                 return -EINVAL;
955         }
956
957         if (fit_image_get_comp(fit, noffset, &imape_comp)) {
958                 puts("Can't get image compression!\n");
959                 return -EINVAL;
960         }
961
962         /* Allow the image to expand by a factor of 4, should be safe */
963         load_buf = malloc((1 << 20) + len * 4);
964         ret = bootm_decomp_image(imape_comp, 0, data, image_type, load_buf,
965                                  (void *)data, len, CONFIG_SYS_BOOTM_LEN,
966                                  &load_end);
967         free(load_buf);
968
969         if (ret && ret != BOOTM_ERR_UNIMPLEMENTED)
970                 return ret;
971
972         return 0;
973 }
974
975 int bootm_host_load_images(const void *fit, int cfg_noffset)
976 {
977         static uint8_t image_types[] = {
978                 IH_TYPE_KERNEL,
979                 IH_TYPE_FLATDT,
980                 IH_TYPE_RAMDISK,
981         };
982         int err = 0;
983         int i;
984
985         for (i = 0; i < ARRAY_SIZE(image_types); i++) {
986                 int ret;
987
988                 ret = bootm_host_load_image(fit, image_types[i]);
989                 if (!err && ret && ret != -ENOENT)
990                         err = ret;
991         }
992
993         /* Return the first error we found */
994         return err;
995 }
996
997 #endif /* ndef USE_HOSTCC */