1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
15 #include <fdt_support.h>
22 #include <asm/cache.h>
23 #include <asm/global_data.h>
25 #include <linux/sizes.h>
27 #if defined(CONFIG_CMD_USB)
37 #define MAX_CMDLINE_SIZE SZ_4K
39 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
43 DECLARE_GLOBAL_DATA_PTR
;
45 struct bootm_headers images
; /* pointers to os/initrd/fdt images */
47 __weak
void board_quiesce_devices(void)
51 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
53 * image_get_kernel - verify legacy format kernel image
54 * @img_addr: in RAM address of the legacy format image to be verified
55 * @verify: data CRC verification flag
57 * image_get_kernel() verifies legacy image integrity and returns pointer to
58 * legacy image header if image verification was completed successfully.
61 * pointer to a legacy image header if valid image was found
62 * otherwise return NULL
64 static struct legacy_img_hdr
*image_get_kernel(ulong img_addr
, int verify
)
66 struct legacy_img_hdr
*hdr
= (struct legacy_img_hdr
*)img_addr
;
68 if (!image_check_magic(hdr
)) {
69 puts("Bad Magic Number\n");
70 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC
);
73 bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER
);
75 if (!image_check_hcrc(hdr
)) {
76 puts("Bad Header Checksum\n");
77 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER
);
81 bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM
);
82 image_print_contents(hdr
);
85 puts(" Verifying Checksum ... ");
86 if (!image_check_dcrc(hdr
)) {
87 printf("Bad Data CRC\n");
88 bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM
);
93 bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH
);
95 if (!image_check_target_arch(hdr
)) {
96 printf("Unsupported Architecture 0x%x\n", image_get_arch(hdr
));
97 bootstage_error(BOOTSTAGE_ID_CHECK_ARCH
);
105 * boot_get_kernel() - find kernel image
107 * @cmd_name: Name of the command calling this function, e.g. "bootm"
108 * @addr_fit: first argument to bootm: address, fit configuration, etc.
109 * @os_data: pointer to a ulong variable, will hold os data start address
110 * @os_len: pointer to a ulong variable, will hold os data length
111 * address and length, otherwise NULL
112 * pointer to image header if valid image was found, plus kernel start
113 * @kernp: image header if valid image was found, otherwise NULL
115 * boot_get_kernel() tries to find a kernel image, verifies its integrity
116 * and locates kernel data.
119 * pointer to image header if valid image was found, plus kernel start
120 * address and length, otherwise NULL
122 static int boot_get_kernel(const char *cmd_name
, const char *addr_fit
,
123 struct bootm_headers
*images
, ulong
*os_data
,
124 ulong
*os_len
, const void **kernp
)
126 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
127 struct legacy_img_hdr
*hdr
;
131 const char *fit_uname_config
= NULL
, *fit_uname_kernel
= NULL
;
132 #if CONFIG_IS_ENABLED(FIT)
136 #ifdef CONFIG_ANDROID_BOOT_IMAGE
137 const void *boot_img
;
138 const void *vendor_boot_img
;
140 img_addr
= genimg_get_kernel_addr_fit(addr_fit
, &fit_uname_config
,
143 if (IS_ENABLED(CONFIG_CMD_BOOTM_PRE_LOAD
))
144 img_addr
+= image_load_offset
;
146 bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC
);
148 /* check image type, for FIT images get FIT kernel node */
149 *os_data
= *os_len
= 0;
150 buf
= map_sysmem(img_addr
, 0);
151 switch (genimg_get_format(buf
)) {
152 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
153 case IMAGE_FORMAT_LEGACY
:
154 printf("## Booting kernel from Legacy Image at %08lx ...\n",
156 hdr
= image_get_kernel(img_addr
, images
->verify
);
159 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE
);
161 /* get os_data and os_len */
162 switch (image_get_type(hdr
)) {
164 case IH_TYPE_KERNEL_NOLOAD
:
165 *os_data
= image_get_data(hdr
);
166 *os_len
= image_get_data_size(hdr
);
169 image_multi_getimg(hdr
, 0, os_data
, os_len
);
171 case IH_TYPE_STANDALONE
:
172 *os_data
= image_get_data(hdr
);
173 *os_len
= image_get_data_size(hdr
);
176 printf("Wrong Image Type for %s command\n",
178 bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE
);
183 * copy image header to allow for image overwrites during
184 * kernel decompression.
186 memmove(&images
->legacy_hdr_os_copy
, hdr
,
187 sizeof(struct legacy_img_hdr
));
189 /* save pointer to image header */
190 images
->legacy_hdr_os
= hdr
;
192 images
->legacy_hdr_valid
= 1;
193 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE
);
196 #if CONFIG_IS_ENABLED(FIT)
197 case IMAGE_FORMAT_FIT
:
198 os_noffset
= fit_image_load(images
, img_addr
,
199 &fit_uname_kernel
, &fit_uname_config
,
200 IH_ARCH_DEFAULT
, IH_TYPE_KERNEL
,
201 BOOTSTAGE_ID_FIT_KERNEL_START
,
202 FIT_LOAD_IGNORED
, os_data
, os_len
);
206 images
->fit_hdr_os
= map_sysmem(img_addr
, 0);
207 images
->fit_uname_os
= fit_uname_kernel
;
208 images
->fit_uname_cfg
= fit_uname_config
;
209 images
->fit_noffset_os
= os_noffset
;
212 #ifdef CONFIG_ANDROID_BOOT_IMAGE
213 case IMAGE_FORMAT_ANDROID
: {
217 vendor_boot_img
= NULL
;
218 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG
)) {
219 boot_img
= map_sysmem(get_abootimg_addr(), 0);
220 vendor_boot_img
= map_sysmem(get_avendor_bootimg_addr(), 0);
222 printf("## Booting Android Image at 0x%08lx ...\n", img_addr
);
223 ret
= android_image_get_kernel(boot_img
, vendor_boot_img
,
224 images
->verify
, os_data
, os_len
);
227 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG
)) {
228 unmap_sysmem(vendor_boot_img
);
229 unmap_sysmem(boot_img
);
235 printf("Wrong Image Format for %s command\n", cmd_name
);
236 bootstage_error(BOOTSTAGE_ID_FIT_KERNEL_INFO
);
240 debug(" kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
241 *os_data
, *os_len
, *os_len
);
248 static void boot_start_lmb(struct bootm_headers
*images
)
251 phys_size_t mem_size
;
253 mem_start
= env_get_bootm_low();
254 mem_size
= env_get_bootm_size();
256 lmb_init_and_reserve_range(&images
->lmb
, (phys_addr_t
)mem_start
,
260 #define lmb_reserve(lmb, base, size)
261 static inline void boot_start_lmb(struct bootm_headers
*images
) { }
264 static int bootm_start(void)
266 memset((void *)&images
, 0, sizeof(images
));
267 images
.verify
= env_get_yesno("verify");
269 boot_start_lmb(&images
);
271 bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START
, "bootm_start");
272 images
.state
= BOOTM_STATE_START
;
277 static ulong
bootm_data_addr(const char *addr_str
)
282 addr
= hextoul(addr_str
, NULL
);
284 addr
= image_load_addr
;
290 * bootm_pre_load() - Handle the pre-load processing
292 * This can be used to do a full signature check of the image, for example.
293 * It calls image_pre_load() with the data address of the image to check.
295 * @addr_str: String containing load address in hex, or NULL to use
297 * Return: 0 if OK, CMD_RET_FAILURE on failure
299 static int bootm_pre_load(const char *addr_str
)
301 ulong data_addr
= bootm_data_addr(addr_str
);
304 if (IS_ENABLED(CONFIG_CMD_BOOTM_PRE_LOAD
))
305 ret
= image_pre_load(data_addr
);
308 ret
= CMD_RET_FAILURE
;
313 static int bootm_find_os(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
317 #ifdef CONFIG_ANDROID_BOOT_IMAGE
318 const void *vendor_boot_img
;
319 const void *boot_img
;
321 bool ep_found
= false;
324 /* get kernel image header, start address and length */
325 ret
= boot_get_kernel(cmdtp
->name
, argv
[0], &images
,
326 &images
.os
.image_start
, &images
.os
.image_len
,
328 if (images
.os
.image_len
== 0) {
329 puts("ERROR: can't get kernel image!\n");
333 /* get image parameters */
334 switch (genimg_get_format(os_hdr
)) {
335 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
336 case IMAGE_FORMAT_LEGACY
:
337 images
.os
.type
= image_get_type(os_hdr
);
338 images
.os
.comp
= image_get_comp(os_hdr
);
339 images
.os
.os
= image_get_os(os_hdr
);
341 images
.os
.end
= image_get_image_end(os_hdr
);
342 images
.os
.load
= image_get_load(os_hdr
);
343 images
.os
.arch
= image_get_arch(os_hdr
);
346 #if CONFIG_IS_ENABLED(FIT)
347 case IMAGE_FORMAT_FIT
:
348 if (fit_image_get_type(images
.fit_hdr_os
,
349 images
.fit_noffset_os
,
351 puts("Can't get image type!\n");
352 bootstage_error(BOOTSTAGE_ID_FIT_TYPE
);
356 if (fit_image_get_comp(images
.fit_hdr_os
,
357 images
.fit_noffset_os
,
359 puts("Can't get image compression!\n");
360 bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION
);
364 if (fit_image_get_os(images
.fit_hdr_os
, images
.fit_noffset_os
,
366 puts("Can't get image OS!\n");
367 bootstage_error(BOOTSTAGE_ID_FIT_OS
);
371 if (fit_image_get_arch(images
.fit_hdr_os
,
372 images
.fit_noffset_os
,
374 puts("Can't get image ARCH!\n");
378 images
.os
.end
= fit_get_end(images
.fit_hdr_os
);
380 if (fit_image_get_load(images
.fit_hdr_os
, images
.fit_noffset_os
,
382 puts("Can't get image load address!\n");
383 bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR
);
388 #ifdef CONFIG_ANDROID_BOOT_IMAGE
389 case IMAGE_FORMAT_ANDROID
:
391 vendor_boot_img
= NULL
;
392 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG
)) {
393 boot_img
= map_sysmem(get_abootimg_addr(), 0);
394 vendor_boot_img
= map_sysmem(get_avendor_bootimg_addr(), 0);
396 images
.os
.type
= IH_TYPE_KERNEL
;
397 images
.os
.comp
= android_image_get_kcomp(boot_img
, vendor_boot_img
);
398 images
.os
.os
= IH_OS_LINUX
;
399 images
.os
.end
= android_image_get_end(boot_img
, vendor_boot_img
);
400 images
.os
.load
= android_image_get_kload(boot_img
, vendor_boot_img
);
401 images
.ep
= images
.os
.load
;
403 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG
)) {
404 unmap_sysmem(vendor_boot_img
);
405 unmap_sysmem(boot_img
);
410 puts("ERROR: unknown image format type!\n");
414 /* If we have a valid setup.bin, we will use that for entry (x86) */
415 if (images
.os
.arch
== IH_ARCH_I386
||
416 images
.os
.arch
== IH_ARCH_X86_64
) {
419 ret
= boot_get_setup(&images
, IH_ARCH_I386
, &images
.ep
, &len
);
420 if (ret
< 0 && ret
!= -ENOENT
) {
421 puts("Could not find a valid setup.bin for x86\n");
424 /* Kernel entry point is the setup.bin */
425 } else if (images
.legacy_hdr_valid
) {
426 images
.ep
= image_get_ep(&images
.legacy_hdr_os_copy
);
427 #if CONFIG_IS_ENABLED(FIT)
428 } else if (images
.fit_uname_os
) {
431 ret
= fit_image_get_entry(images
.fit_hdr_os
,
432 images
.fit_noffset_os
, &images
.ep
);
434 puts("Can't get entry point property!\n");
438 } else if (!ep_found
) {
439 puts("Could not find kernel entry point!\n");
443 if (images
.os
.type
== IH_TYPE_KERNEL_NOLOAD
) {
444 if (IS_ENABLED(CONFIG_CMD_BOOTI
) &&
445 images
.os
.arch
== IH_ARCH_ARM64
&&
446 images
.os
.os
== IH_OS_LINUX
) {
450 ret
= booti_setup(images
.os
.image_start
, &image_addr
,
455 images
.os
.type
= IH_TYPE_KERNEL
;
456 images
.os
.load
= image_addr
;
457 images
.ep
= image_addr
;
459 images
.os
.load
= images
.os
.image_start
;
460 images
.ep
+= images
.os
.image_start
;
464 images
.os
.start
= map_to_sysmem(os_hdr
);
470 * bootm_find_images - wrapper to find and locate various images
471 * @flag: Ignored Argument
472 * @argc: command argument count
473 * @argv: command argument list
474 * @start: OS image start address
475 * @size: OS image size
477 * boot_find_images() will attempt to load an available ramdisk,
478 * flattened device tree, as well as specifically marked
479 * "loadable" images (loadables are FIT only)
481 * Note: bootm_find_images will skip an image if it is not found
484 * 0, if all existing images were loaded correctly
485 * 1, if an image is found but corrupted, or invalid
487 int bootm_find_images(int flag
, int argc
, char *const argv
[], ulong start
,
493 ret
= boot_get_ramdisk(argc
, argv
, &images
, IH_INITRD_ARCH
,
494 &images
.rd_start
, &images
.rd_end
);
496 puts("Ramdisk image is corrupt or invalid\n");
500 /* check if ramdisk overlaps OS image */
501 if (images
.rd_start
&& (((ulong
)images
.rd_start
>= start
&&
502 (ulong
)images
.rd_start
< start
+ size
) ||
503 ((ulong
)images
.rd_end
> start
&&
504 (ulong
)images
.rd_end
<= start
+ size
) ||
505 ((ulong
)images
.rd_start
< start
&&
506 (ulong
)images
.rd_end
>= start
+ size
))) {
507 printf("ERROR: RD image overlaps OS image (OS=0x%lx..0x%lx)\n",
508 start
, start
+ size
);
512 #if CONFIG_IS_ENABLED(OF_LIBFDT)
513 /* find flattened device tree */
514 ret
= boot_get_fdt(flag
, argc
, argv
, IH_ARCH_DEFAULT
, &images
,
515 &images
.ft_addr
, &images
.ft_len
);
517 puts("Could not find a valid device tree\n");
521 /* check if FDT overlaps OS image */
522 if (images
.ft_addr
&&
523 (((ulong
)images
.ft_addr
>= start
&&
524 (ulong
)images
.ft_addr
< start
+ size
) ||
525 ((ulong
)images
.ft_addr
+ images
.ft_len
>= start
&&
526 (ulong
)images
.ft_addr
+ images
.ft_len
< start
+ size
))) {
527 printf("ERROR: FDT image overlaps OS image (OS=0x%lx..0x%lx)\n",
528 start
, start
+ size
);
532 if (IS_ENABLED(CONFIG_CMD_FDT
))
533 set_working_fdt_addr(map_to_sysmem(images
.ft_addr
));
536 #if CONFIG_IS_ENABLED(FIT)
537 if (IS_ENABLED(CONFIG_FPGA
)) {
538 /* find bitstreams */
539 ret
= boot_get_fpga(argc
, argv
, &images
, IH_ARCH_DEFAULT
,
542 printf("FPGA image is corrupted or invalid\n");
547 /* find all of the loadables */
548 ret
= boot_get_loadable(argc
, argv
, &images
, IH_ARCH_DEFAULT
,
551 printf("Loadable(s) is corrupt or invalid\n");
559 static int bootm_find_other(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
562 if (((images
.os
.type
== IH_TYPE_KERNEL
) ||
563 (images
.os
.type
== IH_TYPE_KERNEL_NOLOAD
) ||
564 (images
.os
.type
== IH_TYPE_MULTI
)) &&
565 (images
.os
.os
== IH_OS_LINUX
||
566 images
.os
.os
== IH_OS_VXWORKS
))
567 return bootm_find_images(flag
, argc
, argv
, 0, 0);
571 #endif /* USE_HOSTC */
573 #if !defined(USE_HOSTCC) || defined(CONFIG_FIT_SIGNATURE)
575 * handle_decomp_error() - display a decompression error
577 * This function tries to produce a useful message. In the case where the
578 * uncompressed size is the same as the available space, we can assume that
579 * the image is too large for the buffer.
581 * @comp_type: Compression type being used (IH_COMP_...)
582 * @uncomp_size: Number of bytes uncompressed
583 * @buf_size: Number of bytes the decompresion buffer was
584 * @ret: errno error code received from compression library
585 * Return: Appropriate BOOTM_ERR_ error code
587 static int handle_decomp_error(int comp_type
, size_t uncomp_size
,
588 size_t buf_size
, int ret
)
590 const char *name
= genimg_get_comp_name(comp_type
);
592 /* ENOSYS means unimplemented compression type, don't reset. */
594 return BOOTM_ERR_UNIMPLEMENTED
;
596 if (uncomp_size
>= buf_size
)
597 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
599 printf("%s: uncompress error %d\n", name
, ret
);
602 * The decompression routines are now safe, so will not write beyond
603 * their bounds. Probably it is not necessary to reset, but maintain
604 * the current behaviour for now.
606 printf("Must RESET board to recover\n");
608 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE
);
611 return BOOTM_ERR_RESET
;
616 static int bootm_load_os(struct bootm_headers
*images
, int boot_progress
)
618 struct image_info os
= images
->os
;
619 ulong load
= os
.load
;
621 ulong blob_start
= os
.start
;
622 ulong blob_end
= os
.end
;
623 ulong image_start
= os
.image_start
;
624 ulong image_len
= os
.image_len
;
625 ulong flush_start
= ALIGN_DOWN(load
, ARCH_DMA_MINALIGN
);
627 void *load_buf
, *image_buf
;
630 load_buf
= map_sysmem(load
, 0);
631 image_buf
= map_sysmem(os
.image_start
, image_len
);
632 err
= image_decomp(os
.comp
, load
, os
.image_start
, os
.type
,
633 load_buf
, image_buf
, image_len
,
634 CONFIG_SYS_BOOTM_LEN
, &load_end
);
636 err
= handle_decomp_error(os
.comp
, load_end
- load
,
637 CONFIG_SYS_BOOTM_LEN
, err
);
638 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE
);
641 /* We need the decompressed image size in the next steps */
642 images
->os
.image_len
= load_end
- load
;
644 flush_cache(flush_start
, ALIGN(load_end
, ARCH_DMA_MINALIGN
) - flush_start
);
646 debug(" kernel loaded at 0x%08lx, end = 0x%08lx\n", load
, load_end
);
647 bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED
);
649 no_overlap
= (os
.comp
== IH_COMP_NONE
&& load
== image_start
);
651 if (!no_overlap
&& load
< blob_end
&& load_end
> blob_start
) {
652 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
653 blob_start
, blob_end
);
654 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load
,
657 /* Check what type of image this is. */
658 if (images
->legacy_hdr_valid
) {
659 if (image_get_type(&images
->legacy_hdr_os_copy
)
661 puts("WARNING: legacy format multi component image overwritten\n");
662 return BOOTM_ERR_OVERLAP
;
664 puts("ERROR: new format image overwritten - must RESET the board to recover\n");
665 bootstage_error(BOOTSTAGE_ID_OVERWRITTEN
);
666 return BOOTM_ERR_RESET
;
670 lmb_reserve(&images
->lmb
, images
->os
.load
, (load_end
-
676 * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
678 * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were
681 ulong
bootm_disable_interrupts(void)
686 * We have reached the point of no return: we are going to
687 * overwrite all exception vector code, so we cannot easily
688 * recover from any failures any more...
690 iflag
= disable_interrupts();
691 #ifdef CONFIG_NETCONSOLE
692 /* Stop the ethernet stack if NetConsole could have left it up */
696 #if defined(CONFIG_CMD_USB)
698 * turn off USB to prevent the host controller from writing to the
699 * SDRAM while Linux is booting. This could happen (at least for OHCI
700 * controller), because the HCCA (Host Controller Communication Area)
701 * lies within the SDRAM and the host controller writes continously to
702 * this area (as busmaster!). The HccaFrameNumber is for example
703 * updated every 1 ms within the HCCA structure in SDRAM! For more
704 * details see the OpenHCI specification.
711 #define CONSOLE_ARG "console="
712 #define NULL_CONSOLE (CONSOLE_ARG "ttynull")
713 #define CONSOLE_ARG_SIZE sizeof(NULL_CONSOLE)
716 * fixup_silent_linux() - Handle silencing the linux boot if required
718 * This uses the silent_linux envvar to control whether to add/set a "console="
719 * parameter to the command line
721 * @buf: Buffer containing the string to process
722 * @maxlen: Maximum length of buffer
723 * Return: 0 if OK, -ENOSPC if @maxlen is too small
725 static int fixup_silent_linux(char *buf
, int maxlen
)
732 * Move the input string to the end of buffer. The output string will be
733 * built up at the start.
735 size
= strlen(buf
) + 1;
736 if (size
* 2 > maxlen
)
738 cmdline
= buf
+ maxlen
- size
;
739 memmove(cmdline
, buf
, size
);
741 * Only fix cmdline when requested. The environment variable can be:
743 * no - we never fixup
744 * yes - we always fixup
745 * unset - we rely on the console silent flag
747 want_silent
= env_get_yesno("silent_linux");
748 if (want_silent
== 0)
750 else if (want_silent
== -1 && !(gd
->flags
& GD_FLG_SILENT
))
753 debug("before silent fix-up: %s\n", cmdline
);
755 char *start
= strstr(cmdline
, CONSOLE_ARG
);
757 /* Check space for maximum possible new command line */
758 if (size
+ CONSOLE_ARG_SIZE
> maxlen
)
762 char *end
= strchr(start
, ' ');
765 start_bytes
= start
- cmdline
;
766 strncpy(buf
, cmdline
, start_bytes
);
767 strncpy(buf
+ start_bytes
, NULL_CONSOLE
, CONSOLE_ARG_SIZE
);
769 strcpy(buf
+ start_bytes
+ CONSOLE_ARG_SIZE
- 1, end
);
771 buf
[start_bytes
+ CONSOLE_ARG_SIZE
] = '\0';
773 sprintf(buf
, "%s %s", cmdline
, NULL_CONSOLE
);
775 if (buf
+ strlen(buf
) >= cmdline
)
778 if (maxlen
< CONSOLE_ARG_SIZE
)
780 strcpy(buf
, NULL_CONSOLE
);
782 debug("after silent fix-up: %s\n", buf
);
788 * process_subst() - Handle substitution of ${...} fields in the environment
790 * Handle variable substitution in the provided buffer
792 * @buf: Buffer containing the string to process
793 * @maxlen: Maximum length of buffer
794 * Return: 0 if OK, -ENOSPC if @maxlen is too small
796 static int process_subst(char *buf
, int maxlen
)
802 /* Move to end of buffer */
803 size
= strlen(buf
) + 1;
804 cmdline
= buf
+ maxlen
- size
;
805 if (buf
+ size
> cmdline
)
807 memmove(cmdline
, buf
, size
);
809 ret
= cli_simple_process_macros(cmdline
, buf
, cmdline
- buf
);
814 int bootm_process_cmdline(char *buf
, int maxlen
, int flags
)
818 /* Check config first to enable compiler to eliminate code */
819 if (IS_ENABLED(CONFIG_SILENT_CONSOLE
) &&
820 !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY
) &&
821 (flags
& BOOTM_CL_SILENT
)) {
822 ret
= fixup_silent_linux(buf
, maxlen
);
824 return log_msg_ret("silent", ret
);
826 if (IS_ENABLED(CONFIG_BOOTARGS_SUBST
) && IS_ENABLED(CONFIG_CMDLINE
) &&
827 (flags
& BOOTM_CL_SUBST
)) {
828 ret
= process_subst(buf
, maxlen
);
830 return log_msg_ret("subst", ret
);
836 int bootm_process_cmdline_env(int flags
)
838 const int maxlen
= MAX_CMDLINE_SIZE
;
844 /* First check if any action is needed */
845 do_silent
= IS_ENABLED(CONFIG_SILENT_CONSOLE
) &&
846 !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY
) && (flags
& BOOTM_CL_SILENT
);
847 if (!do_silent
&& !IS_ENABLED(CONFIG_BOOTARGS_SUBST
))
850 env
= env_get("bootargs");
851 if (env
&& strlen(env
) >= maxlen
)
853 buf
= malloc(maxlen
);
860 ret
= bootm_process_cmdline(buf
, maxlen
, flags
);
862 ret
= env_set("bootargs", buf
);
865 * If buf is "" and bootargs does not exist, this will produce
866 * an error trying to delete bootargs. Ignore it
873 return log_msg_ret("env", ret
);
878 int bootm_measure(struct bootm_headers
*images
)
882 /* Skip measurement if EFI is going to do it */
883 if (images
->os
.os
== IH_OS_EFI
&&
884 IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL
) &&
885 IS_ENABLED(CONFIG_BOOTM_EFI
))
888 if (IS_ENABLED(CONFIG_MEASURED_BOOT
)) {
889 struct tcg2_event_log elog
;
898 ign
= IS_ENABLED(CONFIG_MEASURE_IGNORE_LOG
);
899 ret
= tcg2_measurement_init(&dev
, &elog
, ign
);
903 image_buf
= map_sysmem(images
->os
.image_start
,
904 images
->os
.image_len
);
905 ret
= tcg2_measure_data(dev
, &elog
, 8, images
->os
.image_len
,
906 image_buf
, EV_COMPACT_HASH
,
907 strlen("linux") + 1, (u8
*)"linux");
911 rd_len
= images
->rd_end
- images
->rd_start
;
912 initrd_buf
= map_sysmem(images
->rd_start
, rd_len
);
913 ret
= tcg2_measure_data(dev
, &elog
, 9, rd_len
, initrd_buf
,
914 EV_COMPACT_HASH
, strlen("initrd") + 1,
919 if (IS_ENABLED(CONFIG_MEASURE_DEVICETREE
)) {
920 ret
= tcg2_measure_data(dev
, &elog
, 0, images
->ft_len
,
921 (u8
*)images
->ft_addr
,
929 s
= env_get("bootargs");
932 ret
= tcg2_measure_data(dev
, &elog
, 1, strlen(s
) + 1, (u8
*)s
,
933 EV_PLATFORM_CONFIG_FLAGS
,
934 strlen(s
) + 1, (u8
*)s
);
937 unmap_sysmem(initrd_buf
);
940 unmap_sysmem(image_buf
);
941 tcg2_measurement_term(dev
, &elog
, ret
!= 0);
948 * Execute selected states of the bootm command.
950 * Note the arguments to this state must be the first argument, Any 'bootm'
951 * or sub-command arguments must have already been taken.
953 * Note that if states contains more than one flag it MUST contain
954 * BOOTM_STATE_START, since this handles and consumes the command line args.
956 * Also note that aside from boot_os_fn functions and bootm_load_os no other
957 * functions we store the return value of in 'ret' may use a negative return
958 * value, without special handling.
960 * @param cmdtp Pointer to bootm command table entry
961 * @param flag Command flags (CMD_FLAG_...)
962 * @param argc Number of subcommand arguments (0 = no arguments)
963 * @param argv Arguments
964 * @param states Mask containing states to run (BOOTM_STATE_...)
965 * @param images Image header information
966 * @param boot_progress 1 to show boot progress, 0 to not do this
967 * Return: 0 if ok, something else on error. Some errors will cause this
968 * function to perform a reboot! If states contains BOOTM_STATE_OS_GO
969 * then the intent is to boot an OS, so this function will not return
970 * unless the image type is standalone.
972 int do_bootm_states(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
973 char *const argv
[], int states
, struct bootm_headers
*images
,
978 int ret
= 0, need_boot_fn
;
980 images
->state
|= states
;
983 * Work through the states and see how far we get. We stop on
986 if (states
& BOOTM_STATE_START
)
989 if (!ret
&& (states
& BOOTM_STATE_PRE_LOAD
))
990 ret
= bootm_pre_load(argv
[0]);
992 if (!ret
&& (states
& BOOTM_STATE_FINDOS
))
993 ret
= bootm_find_os(cmdtp
, flag
, argc
, argv
);
995 if (!ret
&& (states
& BOOTM_STATE_FINDOTHER
))
996 ret
= bootm_find_other(cmdtp
, flag
, argc
, argv
);
998 if (IS_ENABLED(CONFIG_MEASURED_BOOT
) && !ret
&&
999 (states
& BOOTM_STATE_MEASURE
))
1000 bootm_measure(images
);
1003 if (!ret
&& (states
& BOOTM_STATE_LOADOS
)) {
1004 iflag
= bootm_disable_interrupts();
1005 ret
= bootm_load_os(images
, 0);
1006 if (ret
&& ret
!= BOOTM_ERR_OVERLAP
)
1008 else if (ret
== BOOTM_ERR_OVERLAP
)
1012 /* Relocate the ramdisk */
1013 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1014 if (!ret
&& (states
& BOOTM_STATE_RAMDISK
)) {
1015 ulong rd_len
= images
->rd_end
- images
->rd_start
;
1017 ret
= boot_ramdisk_high(&images
->lmb
, images
->rd_start
,
1018 rd_len
, &images
->initrd_start
, &images
->initrd_end
);
1020 env_set_hex("initrd_start", images
->initrd_start
);
1021 env_set_hex("initrd_end", images
->initrd_end
);
1025 #if CONFIG_IS_ENABLED(OF_LIBFDT) && defined(CONFIG_LMB)
1026 if (!ret
&& (states
& BOOTM_STATE_FDT
)) {
1027 boot_fdt_add_mem_rsv_regions(&images
->lmb
, images
->ft_addr
);
1028 ret
= boot_relocate_fdt(&images
->lmb
, &images
->ft_addr
,
1033 /* From now on, we need the OS boot function */
1036 boot_fn
= bootm_os_get_boot_func(images
->os
.os
);
1037 need_boot_fn
= states
& (BOOTM_STATE_OS_CMDLINE
|
1038 BOOTM_STATE_OS_BD_T
| BOOTM_STATE_OS_PREP
|
1039 BOOTM_STATE_OS_FAKE_GO
| BOOTM_STATE_OS_GO
);
1040 if (boot_fn
== NULL
&& need_boot_fn
) {
1042 enable_interrupts();
1043 printf("ERROR: booting os '%s' (%d) is not supported\n",
1044 genimg_get_os_name(images
->os
.os
), images
->os
.os
);
1045 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS
);
1050 /* Call various other states that are not generally used */
1051 if (!ret
&& (states
& BOOTM_STATE_OS_CMDLINE
))
1052 ret
= boot_fn(BOOTM_STATE_OS_CMDLINE
, argc
, argv
, images
);
1053 if (!ret
&& (states
& BOOTM_STATE_OS_BD_T
))
1054 ret
= boot_fn(BOOTM_STATE_OS_BD_T
, argc
, argv
, images
);
1055 if (!ret
&& (states
& BOOTM_STATE_OS_PREP
)) {
1056 ret
= bootm_process_cmdline_env(images
->os
.os
== IH_OS_LINUX
);
1058 printf("Cmdline setup failed (err=%d)\n", ret
);
1059 ret
= CMD_RET_FAILURE
;
1062 ret
= boot_fn(BOOTM_STATE_OS_PREP
, argc
, argv
, images
);
1066 /* Pretend to run the OS, then run a user command */
1067 if (!ret
&& (states
& BOOTM_STATE_OS_FAKE_GO
)) {
1068 char *cmd_list
= env_get("fakegocmd");
1070 ret
= boot_selected_os(argc
, argv
, BOOTM_STATE_OS_FAKE_GO
,
1072 if (!ret
&& cmd_list
)
1073 ret
= run_command_list(cmd_list
, -1, flag
);
1077 /* Check for unsupported subcommand. */
1079 printf("subcommand failed (err=%d)\n", ret
);
1083 /* Now run the OS! We hope this doesn't return */
1084 if (!ret
&& (states
& BOOTM_STATE_OS_GO
))
1085 ret
= boot_selected_os(argc
, argv
, BOOTM_STATE_OS_GO
,
1088 /* Deal with any fallout */
1091 enable_interrupts();
1093 if (ret
== BOOTM_ERR_UNIMPLEMENTED
)
1094 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL
);
1095 else if (ret
== BOOTM_ERR_RESET
)
1096 do_reset(cmdtp
, flag
, argc
, argv
);
1101 int bootm_boot_start(ulong addr
, const char *cmdline
)
1103 static struct cmd_tbl cmd
= {"bootm"};
1105 char *argv
[] = {addr_str
, NULL
};
1110 * TODO(sjg@chromium.org): This uses the command-line interface, but
1111 * should not. To clean this up, the various bootm states need to be
1112 * passed an info structure instead of cmdline flags. Then this can
1113 * set up the required info and move through the states without needing
1116 states
= BOOTM_STATE_START
| BOOTM_STATE_FINDOS
| BOOTM_STATE_PRE_LOAD
|
1117 BOOTM_STATE_FINDOTHER
| BOOTM_STATE_LOADOS
|
1118 BOOTM_STATE_OS_PREP
| BOOTM_STATE_OS_FAKE_GO
|
1120 if (IS_ENABLED(CONFIG_SYS_BOOT_RAMDISK_HIGH
))
1121 states
|= BOOTM_STATE_RAMDISK
;
1122 if (IS_ENABLED(CONFIG_PPC
) || IS_ENABLED(CONFIG_MIPS
))
1123 states
|= BOOTM_STATE_OS_CMDLINE
;
1124 images
.state
|= states
;
1126 snprintf(addr_str
, sizeof(addr_str
), "%lx", addr
);
1128 ret
= env_set("bootargs", cmdline
);
1130 printf("Failed to set cmdline\n");
1133 ret
= do_bootm_states(&cmd
, 0, 1, argv
, states
, &images
, 1);
1139 * switch_to_non_secure_mode() - switch to non-secure mode
1141 * This routine is overridden by architectures requiring this feature.
1143 void __weak
switch_to_non_secure_mode(void)
1147 #else /* USE_HOSTCC */
1149 #if defined(CONFIG_FIT_SIGNATURE)
1150 static int bootm_host_load_image(const void *fit
, int req_image_type
,
1153 const char *fit_uname_config
= NULL
;
1155 struct bootm_headers images
;
1157 ulong load_end
, buf_size
;
1163 fit_uname_config
= fdt_get_name(fit
, cfg_noffset
, NULL
);
1164 memset(&images
, '\0', sizeof(images
));
1166 noffset
= fit_image_load(&images
, (ulong
)fit
,
1167 NULL
, &fit_uname_config
,
1168 IH_ARCH_DEFAULT
, req_image_type
, -1,
1169 FIT_LOAD_IGNORED
, &data
, &len
);
1172 if (fit_image_get_type(fit
, noffset
, &image_type
)) {
1173 puts("Can't get image type!\n");
1177 if (fit_image_get_comp(fit
, noffset
, &image_comp
))
1178 image_comp
= IH_COMP_NONE
;
1180 /* Allow the image to expand by a factor of 4, should be safe */
1181 buf_size
= (1 << 20) + len
* 4;
1182 load_buf
= malloc(buf_size
);
1183 ret
= image_decomp(image_comp
, 0, data
, image_type
, load_buf
,
1184 (void *)data
, len
, buf_size
, &load_end
);
1188 ret
= handle_decomp_error(image_comp
, load_end
- 0, buf_size
, ret
);
1189 if (ret
!= BOOTM_ERR_UNIMPLEMENTED
)
1196 int bootm_host_load_images(const void *fit
, int cfg_noffset
)
1198 static uint8_t image_types
[] = {
1206 for (i
= 0; i
< ARRAY_SIZE(image_types
); i
++) {
1209 ret
= bootm_host_load_image(fit
, image_types
[i
], cfg_noffset
);
1210 if (!err
&& ret
&& ret
!= -ENOENT
)
1214 /* Return the first error we found */
1219 #endif /* ndef USE_HOSTCC */