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