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