test: Add a way to check part of a console line or skip it
[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                 printf("ERROR: RD image overlaps OS image (OS=0x%lx..0x%lx)\n",
263                        start, start + size);
264                 return 1;
265         }
266
267 #if IMAGE_ENABLE_OF_LIBFDT
268         /* find flattened device tree */
269         ret = boot_get_fdt(flag, argc, argv, IH_ARCH_DEFAULT, &images,
270                            &images.ft_addr, &images.ft_len);
271         if (ret) {
272                 puts("Could not find a valid device tree\n");
273                 return 1;
274         }
275
276         /* check if FDT overlaps OS image */
277         if (images.ft_addr &&
278             (((ulong)images.ft_addr >= start &&
279               (ulong)images.ft_addr <= start + size) ||
280              ((ulong)images.ft_addr + images.ft_len >= start &&
281               (ulong)images.ft_addr + images.ft_len <= start + size))) {
282                 printf("ERROR: FDT image overlaps OS image (OS=0x%lx..0x%lx)\n",
283                        start, start + size);
284                 return 1;
285         }
286
287         if (CONFIG_IS_ENABLED(CMD_FDT))
288                 set_working_fdt_addr(map_to_sysmem(images.ft_addr));
289 #endif
290
291 #if IMAGE_ENABLE_FIT
292 #if defined(CONFIG_FPGA)
293         /* find bitstreams */
294         ret = boot_get_fpga(argc, argv, &images, IH_ARCH_DEFAULT,
295                             NULL, NULL);
296         if (ret) {
297                 printf("FPGA image is corrupted or invalid\n");
298                 return 1;
299         }
300 #endif
301
302         /* find all of the loadables */
303         ret = boot_get_loadable(argc, argv, &images, IH_ARCH_DEFAULT,
304                                NULL, NULL);
305         if (ret) {
306                 printf("Loadable(s) is corrupt or invalid\n");
307                 return 1;
308         }
309 #endif
310
311         return 0;
312 }
313
314 static int bootm_find_other(struct cmd_tbl *cmdtp, int flag, int argc,
315                             char *const argv[])
316 {
317         if (((images.os.type == IH_TYPE_KERNEL) ||
318              (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
319              (images.os.type == IH_TYPE_MULTI)) &&
320             (images.os.os == IH_OS_LINUX ||
321                  images.os.os == IH_OS_VXWORKS))
322                 return bootm_find_images(flag, argc, argv, 0, 0);
323
324         return 0;
325 }
326 #endif /* USE_HOSTC */
327
328 #if !defined(USE_HOSTCC) || defined(CONFIG_FIT_SIGNATURE)
329 /**
330  * handle_decomp_error() - display a decompression error
331  *
332  * This function tries to produce a useful message. In the case where the
333  * uncompressed size is the same as the available space, we can assume that
334  * the image is too large for the buffer.
335  *
336  * @comp_type:          Compression type being used (IH_COMP_...)
337  * @uncomp_size:        Number of bytes uncompressed
338  * @ret:                errno error code received from compression library
339  * @return Appropriate BOOTM_ERR_ error code
340  */
341 static int handle_decomp_error(int comp_type, size_t uncomp_size, int ret)
342 {
343         const char *name = genimg_get_comp_name(comp_type);
344
345         /* ENOSYS means unimplemented compression type, don't reset. */
346         if (ret == -ENOSYS)
347                 return BOOTM_ERR_UNIMPLEMENTED;
348
349         if (uncomp_size >= CONFIG_SYS_BOOTM_LEN)
350                 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
351         else
352                 printf("%s: uncompress error %d\n", name, ret);
353
354         /*
355          * The decompression routines are now safe, so will not write beyond
356          * their bounds. Probably it is not necessary to reset, but maintain
357          * the current behaviour for now.
358          */
359         printf("Must RESET board to recover\n");
360 #ifndef USE_HOSTCC
361         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
362 #endif
363
364         return BOOTM_ERR_RESET;
365 }
366 #endif
367
368 #ifndef USE_HOSTCC
369 static int bootm_load_os(bootm_headers_t *images, int boot_progress)
370 {
371         image_info_t os = images->os;
372         ulong load = os.load;
373         ulong load_end;
374         ulong blob_start = os.start;
375         ulong blob_end = os.end;
376         ulong image_start = os.image_start;
377         ulong image_len = os.image_len;
378         ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
379         bool no_overlap;
380         void *load_buf, *image_buf;
381         int err;
382
383         load_buf = map_sysmem(load, 0);
384         image_buf = map_sysmem(os.image_start, image_len);
385         err = image_decomp(os.comp, load, os.image_start, os.type,
386                            load_buf, image_buf, image_len,
387                            CONFIG_SYS_BOOTM_LEN, &load_end);
388         if (err) {
389                 err = handle_decomp_error(os.comp, load_end - load, err);
390                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
391                 return err;
392         }
393
394         flush_cache(flush_start, ALIGN(load_end, ARCH_DMA_MINALIGN) - flush_start);
395
396         debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, load_end);
397         bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
398
399         no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
400
401         if (!no_overlap && load < blob_end && load_end > blob_start) {
402                 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
403                       blob_start, blob_end);
404                 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
405                       load_end);
406
407                 /* Check what type of image this is. */
408                 if (images->legacy_hdr_valid) {
409                         if (image_get_type(&images->legacy_hdr_os_copy)
410                                         == IH_TYPE_MULTI)
411                                 puts("WARNING: legacy format multi component image overwritten\n");
412                         return BOOTM_ERR_OVERLAP;
413                 } else {
414                         puts("ERROR: new format image overwritten - must RESET the board to recover\n");
415                         bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
416                         return BOOTM_ERR_RESET;
417                 }
418         }
419
420         lmb_reserve(&images->lmb, images->os.load, (load_end -
421                                                     images->os.load));
422         return 0;
423 }
424
425 /**
426  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
427  *
428  * @return interrupt flag (0 if interrupts were disabled, non-zero if they were
429  *      enabled)
430  */
431 ulong bootm_disable_interrupts(void)
432 {
433         ulong iflag;
434
435         /*
436          * We have reached the point of no return: we are going to
437          * overwrite all exception vector code, so we cannot easily
438          * recover from any failures any more...
439          */
440         iflag = disable_interrupts();
441 #ifdef CONFIG_NETCONSOLE
442         /* Stop the ethernet stack if NetConsole could have left it up */
443         eth_halt();
444 # ifndef CONFIG_DM_ETH
445         eth_unregister(eth_get_dev());
446 # endif
447 #endif
448
449 #if defined(CONFIG_CMD_USB)
450         /*
451          * turn off USB to prevent the host controller from writing to the
452          * SDRAM while Linux is booting. This could happen (at least for OHCI
453          * controller), because the HCCA (Host Controller Communication Area)
454          * lies within the SDRAM and the host controller writes continously to
455          * this area (as busmaster!). The HccaFrameNumber is for example
456          * updated every 1 ms within the HCCA structure in SDRAM! For more
457          * details see the OpenHCI specification.
458          */
459         usb_stop();
460 #endif
461         return iflag;
462 }
463
464 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
465
466 #define CONSOLE_ARG     "console="
467 #define CONSOLE_ARG_LEN (sizeof(CONSOLE_ARG) - 1)
468
469 static void fixup_silent_linux(void)
470 {
471         char *buf;
472         const char *env_val;
473         char *cmdline = env_get("bootargs");
474         int want_silent;
475
476         /*
477          * Only fix cmdline when requested. The environment variable can be:
478          *
479          *      no - we never fixup
480          *      yes - we always fixup
481          *      unset - we rely on the console silent flag
482          */
483         want_silent = env_get_yesno("silent_linux");
484         if (want_silent == 0)
485                 return;
486         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
487                 return;
488
489         debug("before silent fix-up: %s\n", cmdline);
490         if (cmdline && (cmdline[0] != '\0')) {
491                 char *start = strstr(cmdline, CONSOLE_ARG);
492
493                 /* Allocate space for maximum possible new command line */
494                 buf = malloc(strlen(cmdline) + 1 + CONSOLE_ARG_LEN + 1);
495                 if (!buf) {
496                         debug("%s: out of memory\n", __func__);
497                         return;
498                 }
499
500                 if (start) {
501                         char *end = strchr(start, ' ');
502                         int num_start_bytes = start - cmdline + CONSOLE_ARG_LEN;
503
504                         strncpy(buf, cmdline, num_start_bytes);
505                         if (end)
506                                 strcpy(buf + num_start_bytes, end);
507                         else
508                                 buf[num_start_bytes] = '\0';
509                 } else {
510                         sprintf(buf, "%s %s", cmdline, CONSOLE_ARG);
511                 }
512                 env_val = buf;
513         } else {
514                 buf = NULL;
515                 env_val = CONSOLE_ARG;
516         }
517
518         env_set("bootargs", env_val);
519         debug("after silent fix-up: %s\n", env_val);
520         free(buf);
521 }
522 #endif /* CONFIG_SILENT_CONSOLE */
523
524 /**
525  * Execute selected states of the bootm command.
526  *
527  * Note the arguments to this state must be the first argument, Any 'bootm'
528  * or sub-command arguments must have already been taken.
529  *
530  * Note that if states contains more than one flag it MUST contain
531  * BOOTM_STATE_START, since this handles and consumes the command line args.
532  *
533  * Also note that aside from boot_os_fn functions and bootm_load_os no other
534  * functions we store the return value of in 'ret' may use a negative return
535  * value, without special handling.
536  *
537  * @param cmdtp         Pointer to bootm command table entry
538  * @param flag          Command flags (CMD_FLAG_...)
539  * @param argc          Number of subcommand arguments (0 = no arguments)
540  * @param argv          Arguments
541  * @param states        Mask containing states to run (BOOTM_STATE_...)
542  * @param images        Image header information
543  * @param boot_progress 1 to show boot progress, 0 to not do this
544  * @return 0 if ok, something else on error. Some errors will cause this
545  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
546  *      then the intent is to boot an OS, so this function will not return
547  *      unless the image type is standalone.
548  */
549 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
550                     char *const argv[], int states, bootm_headers_t *images,
551                     int boot_progress)
552 {
553         boot_os_fn *boot_fn;
554         ulong iflag = 0;
555         int ret = 0, need_boot_fn;
556
557         images->state |= states;
558
559         /*
560          * Work through the states and see how far we get. We stop on
561          * any error.
562          */
563         if (states & BOOTM_STATE_START)
564                 ret = bootm_start(cmdtp, flag, argc, argv);
565
566         if (!ret && (states & BOOTM_STATE_FINDOS))
567                 ret = bootm_find_os(cmdtp, flag, argc, argv);
568
569         if (!ret && (states & BOOTM_STATE_FINDOTHER))
570                 ret = bootm_find_other(cmdtp, flag, argc, argv);
571
572         /* Load the OS */
573         if (!ret && (states & BOOTM_STATE_LOADOS)) {
574                 iflag = bootm_disable_interrupts();
575                 ret = bootm_load_os(images, 0);
576                 if (ret && ret != BOOTM_ERR_OVERLAP)
577                         goto err;
578                 else if (ret == BOOTM_ERR_OVERLAP)
579                         ret = 0;
580         }
581
582         /* Relocate the ramdisk */
583 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
584         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
585                 ulong rd_len = images->rd_end - images->rd_start;
586
587                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
588                         rd_len, &images->initrd_start, &images->initrd_end);
589                 if (!ret) {
590                         env_set_hex("initrd_start", images->initrd_start);
591                         env_set_hex("initrd_end", images->initrd_end);
592                 }
593         }
594 #endif
595 #if IMAGE_ENABLE_OF_LIBFDT && defined(CONFIG_LMB)
596         if (!ret && (states & BOOTM_STATE_FDT)) {
597                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
598                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
599                                         &images->ft_len);
600         }
601 #endif
602
603         /* From now on, we need the OS boot function */
604         if (ret)
605                 return ret;
606         boot_fn = bootm_os_get_boot_func(images->os.os);
607         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
608                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
609                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
610         if (boot_fn == NULL && need_boot_fn) {
611                 if (iflag)
612                         enable_interrupts();
613                 printf("ERROR: booting os '%s' (%d) is not supported\n",
614                        genimg_get_os_name(images->os.os), images->os.os);
615                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
616                 return 1;
617         }
618
619
620         /* Call various other states that are not generally used */
621         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
622                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
623         if (!ret && (states & BOOTM_STATE_OS_BD_T))
624                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
625         if (!ret && (states & BOOTM_STATE_OS_PREP)) {
626 #if defined(CONFIG_SILENT_CONSOLE) && !defined(CONFIG_SILENT_U_BOOT_ONLY)
627                 if (images->os.os == IH_OS_LINUX)
628                         fixup_silent_linux();
629 #endif
630                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
631         }
632
633 #ifdef CONFIG_TRACE
634         /* Pretend to run the OS, then run a user command */
635         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
636                 char *cmd_list = env_get("fakegocmd");
637
638                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
639                                 images, boot_fn);
640                 if (!ret && cmd_list)
641                         ret = run_command_list(cmd_list, -1, flag);
642         }
643 #endif
644
645         /* Check for unsupported subcommand. */
646         if (ret) {
647                 puts("subcommand not supported\n");
648                 return ret;
649         }
650
651         /* Now run the OS! We hope this doesn't return */
652         if (!ret && (states & BOOTM_STATE_OS_GO))
653                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
654                                 images, boot_fn);
655
656         /* Deal with any fallout */
657 err:
658         if (iflag)
659                 enable_interrupts();
660
661         if (ret == BOOTM_ERR_UNIMPLEMENTED)
662                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
663         else if (ret == BOOTM_ERR_RESET)
664                 do_reset(cmdtp, flag, argc, argv);
665
666         return ret;
667 }
668
669 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
670 /**
671  * image_get_kernel - verify legacy format kernel image
672  * @img_addr: in RAM address of the legacy format image to be verified
673  * @verify: data CRC verification flag
674  *
675  * image_get_kernel() verifies legacy image integrity and returns pointer to
676  * legacy image header if image verification was completed successfully.
677  *
678  * returns:
679  *     pointer to a legacy image header if valid image was found
680  *     otherwise return NULL
681  */
682 static image_header_t *image_get_kernel(ulong img_addr, int verify)
683 {
684         image_header_t *hdr = (image_header_t *)img_addr;
685
686         if (!image_check_magic(hdr)) {
687                 puts("Bad Magic Number\n");
688                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
689                 return NULL;
690         }
691         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
692
693         if (!image_check_hcrc(hdr)) {
694                 puts("Bad Header Checksum\n");
695                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
696                 return NULL;
697         }
698
699         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
700         image_print_contents(hdr);
701
702         if (verify) {
703                 puts("   Verifying Checksum ... ");
704                 if (!image_check_dcrc(hdr)) {
705                         printf("Bad Data CRC\n");
706                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
707                         return NULL;
708                 }
709                 puts("OK\n");
710         }
711         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
712
713         if (!image_check_target_arch(hdr)) {
714                 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr));
715                 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH);
716                 return NULL;
717         }
718         return hdr;
719 }
720 #endif
721
722 /**
723  * boot_get_kernel - find kernel image
724  * @os_data: pointer to a ulong variable, will hold os data start address
725  * @os_len: pointer to a ulong variable, will hold os data length
726  *
727  * boot_get_kernel() tries to find a kernel image, verifies its integrity
728  * and locates kernel data.
729  *
730  * returns:
731  *     pointer to image header if valid image was found, plus kernel start
732  *     address and length, otherwise NULL
733  */
734 static const void *boot_get_kernel(struct cmd_tbl *cmdtp, int flag, int argc,
735                                    char *const argv[], bootm_headers_t *images,
736                                    ulong *os_data, ulong *os_len)
737 {
738 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
739         image_header_t  *hdr;
740 #endif
741         ulong           img_addr;
742         const void *buf;
743         const char      *fit_uname_config = NULL;
744         const char      *fit_uname_kernel = NULL;
745 #if IMAGE_ENABLE_FIT
746         int             os_noffset;
747 #endif
748
749         img_addr = genimg_get_kernel_addr_fit(argc < 1 ? NULL : argv[0],
750                                               &fit_uname_config,
751                                               &fit_uname_kernel);
752
753         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
754
755         /* check image type, for FIT images get FIT kernel node */
756         *os_data = *os_len = 0;
757         buf = map_sysmem(img_addr, 0);
758         switch (genimg_get_format(buf)) {
759 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
760         case IMAGE_FORMAT_LEGACY:
761                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
762                        img_addr);
763                 hdr = image_get_kernel(img_addr, images->verify);
764                 if (!hdr)
765                         return NULL;
766                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
767
768                 /* get os_data and os_len */
769                 switch (image_get_type(hdr)) {
770                 case IH_TYPE_KERNEL:
771                 case IH_TYPE_KERNEL_NOLOAD:
772                         *os_data = image_get_data(hdr);
773                         *os_len = image_get_data_size(hdr);
774                         break;
775                 case IH_TYPE_MULTI:
776                         image_multi_getimg(hdr, 0, os_data, os_len);
777                         break;
778                 case IH_TYPE_STANDALONE:
779                         *os_data = image_get_data(hdr);
780                         *os_len = image_get_data_size(hdr);
781                         break;
782                 default:
783                         printf("Wrong Image Type for %s command\n",
784                                cmdtp->name);
785                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
786                         return NULL;
787                 }
788
789                 /*
790                  * copy image header to allow for image overwrites during
791                  * kernel decompression.
792                  */
793                 memmove(&images->legacy_hdr_os_copy, hdr,
794                         sizeof(image_header_t));
795
796                 /* save pointer to image header */
797                 images->legacy_hdr_os = hdr;
798
799                 images->legacy_hdr_valid = 1;
800                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
801                 break;
802 #endif
803 #if IMAGE_ENABLE_FIT
804         case IMAGE_FORMAT_FIT:
805                 os_noffset = fit_image_load(images, img_addr,
806                                 &fit_uname_kernel, &fit_uname_config,
807                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
808                                 BOOTSTAGE_ID_FIT_KERNEL_START,
809                                 FIT_LOAD_IGNORED, os_data, os_len);
810                 if (os_noffset < 0)
811                         return NULL;
812
813                 images->fit_hdr_os = map_sysmem(img_addr, 0);
814                 images->fit_uname_os = fit_uname_kernel;
815                 images->fit_uname_cfg = fit_uname_config;
816                 images->fit_noffset_os = os_noffset;
817                 break;
818 #endif
819 #ifdef CONFIG_ANDROID_BOOT_IMAGE
820         case IMAGE_FORMAT_ANDROID:
821                 printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
822                 if (android_image_get_kernel(buf, images->verify,
823                                              os_data, os_len))
824                         return NULL;
825                 break;
826 #endif
827         default:
828                 printf("Wrong Image Format for %s command\n", cmdtp->name);
829                 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO);
830                 return NULL;
831         }
832
833         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
834               *os_data, *os_len, *os_len);
835
836         return buf;
837 }
838
839 /**
840  * switch_to_non_secure_mode() - switch to non-secure mode
841  *
842  * This routine is overridden by architectures requiring this feature.
843  */
844 void __weak switch_to_non_secure_mode(void)
845 {
846 }
847
848 #else /* USE_HOSTCC */
849
850 #if defined(CONFIG_FIT_SIGNATURE)
851 static int bootm_host_load_image(const void *fit, int req_image_type,
852                                  int cfg_noffset)
853 {
854         const char *fit_uname_config = NULL;
855         ulong data, len;
856         bootm_headers_t images;
857         int noffset;
858         ulong load_end;
859         uint8_t image_type;
860         uint8_t imape_comp;
861         void *load_buf;
862         int ret;
863
864         fit_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
865         memset(&images, '\0', sizeof(images));
866         images.verify = 1;
867         noffset = fit_image_load(&images, (ulong)fit,
868                 NULL, &fit_uname_config,
869                 IH_ARCH_DEFAULT, req_image_type, -1,
870                 FIT_LOAD_IGNORED, &data, &len);
871         if (noffset < 0)
872                 return noffset;
873         if (fit_image_get_type(fit, noffset, &image_type)) {
874                 puts("Can't get image type!\n");
875                 return -EINVAL;
876         }
877
878         if (fit_image_get_comp(fit, noffset, &imape_comp)) {
879                 puts("Can't get image compression!\n");
880                 return -EINVAL;
881         }
882
883         /* Allow the image to expand by a factor of 4, should be safe */
884         load_buf = malloc((1 << 20) + len * 4);
885         ret = image_decomp(imape_comp, 0, data, image_type, load_buf,
886                            (void *)data, len, CONFIG_SYS_BOOTM_LEN,
887                            &load_end);
888         free(load_buf);
889
890         if (ret) {
891                 ret = handle_decomp_error(imape_comp, load_end - 0, ret);
892                 if (ret != BOOTM_ERR_UNIMPLEMENTED)
893                         return ret;
894         }
895
896         return 0;
897 }
898
899 int bootm_host_load_images(const void *fit, int cfg_noffset)
900 {
901         static uint8_t image_types[] = {
902                 IH_TYPE_KERNEL,
903                 IH_TYPE_FLATDT,
904                 IH_TYPE_RAMDISK,
905         };
906         int err = 0;
907         int i;
908
909         for (i = 0; i < ARRAY_SIZE(image_types); i++) {
910                 int ret;
911
912                 ret = bootm_host_load_image(fit, image_types[i], cfg_noffset);
913                 if (!err && ret && ret != -ENOENT)
914                         err = ret;
915         }
916
917         /* Return the first error we found */
918         return err;
919 }
920 #endif
921
922 #endif /* ndef USE_HOSTCC */