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