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