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