1 // SPDX-License-Identifier: GPL-2.0+
3 * (C) Copyright 2000-2009
4 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
18 #include <asm/byteorder.h>
19 #include <asm/global_data.h>
20 #include <linux/ctype.h>
21 #include <linux/err.h>
22 #include <u-boot/zlib.h>
25 DECLARE_GLOBAL_DATA_PTR
;
27 #if defined(CONFIG_CMD_IMI)
28 static int image_info(unsigned long addr
);
31 #if defined(CONFIG_CMD_IMLS)
33 #include <mtd/cfi_flash.h>
36 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
37 static int do_imls(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
41 /* we overload the cmd field with our state machine info instead of a
43 static struct cmd_tbl cmd_bootm_sub
[] = {
44 U_BOOT_CMD_MKENT(start
, 0, 1, (void *)BOOTM_STATE_START
, "", ""),
45 U_BOOT_CMD_MKENT(loados
, 0, 1, (void *)BOOTM_STATE_LOADOS
, "", ""),
46 #ifdef CONFIG_CMD_BOOTM_PRE_LOAD
47 U_BOOT_CMD_MKENT(preload
, 0, 1, (void *)BOOTM_STATE_PRE_LOAD
, "", ""),
49 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
50 U_BOOT_CMD_MKENT(ramdisk
, 0, 1, (void *)BOOTM_STATE_RAMDISK
, "", ""),
52 #ifdef CONFIG_OF_LIBFDT
53 U_BOOT_CMD_MKENT(fdt
, 0, 1, (void *)BOOTM_STATE_FDT
, "", ""),
55 U_BOOT_CMD_MKENT(cmdline
, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE
, "", ""),
56 U_BOOT_CMD_MKENT(bdt
, 0, 1, (void *)BOOTM_STATE_OS_BD_T
, "", ""),
57 U_BOOT_CMD_MKENT(prep
, 0, 1, (void *)BOOTM_STATE_OS_PREP
, "", ""),
58 U_BOOT_CMD_MKENT(fake
, 0, 1, (void *)BOOTM_STATE_OS_FAKE_GO
, "", ""),
59 U_BOOT_CMD_MKENT(go
, 0, 1, (void *)BOOTM_STATE_OS_GO
, "", ""),
62 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
63 static ulong
bootm_get_addr(int argc
, char *const argv
[])
68 addr
= hextoul(argv
[0], NULL
);
70 addr
= image_load_addr
;
76 static int do_bootm_subcommand(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
83 c
= find_cmd_tbl(argv
[0], &cmd_bootm_sub
[0], ARRAY_SIZE(cmd_bootm_sub
));
88 if (state
== BOOTM_STATE_START
)
89 state
|= BOOTM_STATE_PRE_LOAD
| BOOTM_STATE_FINDOS
|
90 BOOTM_STATE_FINDOTHER
;
91 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
92 if (state
== BOOTM_STATE_PRE_LOAD
)
93 state
|= BOOTM_STATE_START
;
96 /* Unrecognized command */
100 if (((state
& BOOTM_STATE_START
) != BOOTM_STATE_START
) &&
101 images
.state
>= state
) {
102 printf("Trying to execute a command out of order\n");
103 return CMD_RET_USAGE
;
106 ret
= do_bootm_states(cmdtp
, flag
, argc
, argv
, state
, &images
, 0);
108 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
109 if (!ret
&& (state
& BOOTM_STATE_PRE_LOAD
))
110 env_set_hex("loadaddr_verified",
111 bootm_get_addr(argc
, argv
) + image_load_offset
);
114 return ret
? CMD_RET_FAILURE
: 0;
117 /*******************************************************************/
118 /* bootm - boot application image from image in memory */
119 /*******************************************************************/
121 int do_bootm(struct cmd_tbl
*cmdtp
, int flag
, int argc
, char *const argv
[])
126 /* determine if we have a sub command */
131 hextoul(argv
[0], &endp
);
132 /* endp pointing to NULL means that argv[0] was just a
133 * valid number, pass it along to the normal bootm processing
135 * If endp is ':' or '#' assume a FIT identifier so pass
136 * along for normal processing.
138 * Right now we assume the first arg should never be '-'
140 if ((*endp
!= 0) && (*endp
!= ':') && (*endp
!= '#'))
141 return do_bootm_subcommand(cmdtp
, flag
, argc
, argv
);
144 states
= BOOTM_STATE_START
| BOOTM_STATE_FINDOS
| BOOTM_STATE_PRE_LOAD
|
145 BOOTM_STATE_FINDOTHER
| BOOTM_STATE_LOADOS
|
146 BOOTM_STATE_OS_PREP
| BOOTM_STATE_OS_FAKE_GO
|
148 if (IS_ENABLED(CONFIG_SYS_BOOT_RAMDISK_HIGH
))
149 states
|= BOOTM_STATE_RAMDISK
;
150 if (IS_ENABLED(CONFIG_MEASURED_BOOT
))
151 states
|= BOOTM_STATE_MEASURE
;
152 if (IS_ENABLED(CONFIG_PPC
) || IS_ENABLED(CONFIG_MIPS
))
153 states
|= BOOTM_STATE_OS_CMDLINE
;
154 ret
= do_bootm_states(cmdtp
, flag
, argc
, argv
, states
, &images
, 1);
156 return ret
? CMD_RET_FAILURE
: 0;
159 int bootm_maybe_autostart(struct cmd_tbl
*cmdtp
, const char *cmd
)
161 if (env_get_autostart()) {
163 local_args
[0] = (char *)cmd
;
164 local_args
[1] = NULL
;
165 printf("Automatic boot of image at addr 0x%08lX ...\n",
167 return do_bootm(cmdtp
, 0, 1, local_args
);
173 U_BOOT_LONGHELP(bootm
,
174 "[addr [arg ...]]\n - boot application image stored in memory\n"
175 "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
176 "\t'arg' can be the address of an initrd image\n"
177 #if defined(CONFIG_OF_LIBFDT)
178 "\tWhen booting a Linux kernel which requires a flat device-tree\n"
179 "\ta third argument is required which is the address of the\n"
180 "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
181 "\tuse a '-' for the second argument. If you do not pass a third\n"
182 "\ta bd_info struct will be passed instead\n"
184 #if defined(CONFIG_FIT)
185 "\t\nFor the new multi component uImage format (FIT) addresses\n"
186 "\tmust be extended to include component or configuration unit name:\n"
187 "\taddr:<subimg_uname> - direct component image specification\n"
188 "\taddr#<conf_uname> - configuration specification\n"
189 "\tUse iminfo command to get the list of existing component\n"
190 "\timages and configurations.\n"
192 "\nSub-commands to do part of the bootm sequence. The sub-commands "
194 "issued in the order below (it's ok to not issue all sub-commands):\n"
195 "\tstart [addr [arg ...]]\n"
196 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
197 "\tpreload [addr [arg ..]] - run only the preload stage\n"
199 "\tloados - load OS image\n"
200 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
201 "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
203 #if defined(CONFIG_OF_LIBFDT)
204 "\tfdt - relocate flat device tree\n"
206 "\tcmdline - OS specific command line processing/setup\n"
207 "\tbdt - OS specific bd_info processing\n"
208 "\tprep - OS specific prep before relocation or go\n"
209 #if defined(CONFIG_TRACE)
210 "\tfake - OS specific fake start without go\n"
215 bootm
, CONFIG_SYS_MAXARGS
, 1, do_bootm
,
216 "boot application image from memory", bootm_help_text
219 /*******************************************************************/
220 /* bootd - boot default image */
221 /*******************************************************************/
222 #if defined(CONFIG_CMD_BOOTD)
223 int do_bootd(struct cmd_tbl
*cmdtp
, int flag
, int argc
, char *const argv
[])
225 return run_command(env_get("bootcmd"), flag
);
229 boot
, 1, 1, do_bootd
,
230 "boot default, i.e., run 'bootcmd'",
234 /* keep old command name "bootd" for backward compatibility */
236 bootd
, 1, 1, do_bootd
,
237 "boot default, i.e., run 'bootcmd'",
244 /*******************************************************************/
245 /* iminfo - print header info for a requested image */
246 /*******************************************************************/
247 #if defined(CONFIG_CMD_IMI)
248 static int do_iminfo(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
256 return image_info(image_load_addr
);
259 for (arg
= 1; arg
< argc
; ++arg
) {
260 addr
= hextoul(argv
[arg
], NULL
);
261 if (image_info(addr
) != 0)
267 static int image_info(ulong addr
)
269 void *hdr
= (void *)map_sysmem(addr
, 0);
271 printf("\n## Checking Image at %08lx ...\n", addr
);
273 switch (genimg_get_format(hdr
)) {
274 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
275 case IMAGE_FORMAT_LEGACY
:
276 puts(" Legacy image found\n");
277 if (!image_check_magic(hdr
)) {
278 puts(" Bad Magic Number\n");
283 if (!image_check_hcrc(hdr
)) {
284 puts(" Bad Header Checksum\n");
289 image_print_contents(hdr
);
291 puts(" Verifying Checksum ... ");
292 if (!image_check_dcrc(hdr
)) {
293 puts(" Bad Data CRC\n");
301 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
302 case IMAGE_FORMAT_ANDROID
:
303 puts(" Android image found\n");
304 android_print_contents(hdr
);
308 #if defined(CONFIG_FIT)
309 case IMAGE_FORMAT_FIT
:
310 puts(" FIT image found\n");
312 if (fit_check_format(hdr
, IMAGE_SIZE_INVAL
)) {
313 puts("Bad FIT image format!\n");
318 fit_print_contents(hdr
);
320 if (!fit_all_image_verify(hdr
)) {
321 puts("Bad hash in FIT image!\n");
330 puts("Unknown image format!\n");
339 iminfo
, CONFIG_SYS_MAXARGS
, 1, do_iminfo
,
340 "print header information for application image",
342 " - print header information for application image starting at\n"
343 " address 'addr' in memory; this includes verification of the\n"
344 " image contents (magic number, header and payload checksums)"
349 /*******************************************************************/
350 /* imls - list all images found in flash */
351 /*******************************************************************/
352 #if defined(CONFIG_CMD_IMLS)
353 static int do_imls_nor(void)
359 for (i
= 0, info
= &flash_info
[0];
360 i
< CFI_FLASH_BANKS
; ++i
, ++info
) {
362 if (info
->flash_id
== FLASH_UNKNOWN
)
364 for (j
= 0; j
< info
->sector_count
; ++j
) {
366 hdr
= (void *)info
->start
[j
];
370 switch (genimg_get_format(hdr
)) {
371 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
372 case IMAGE_FORMAT_LEGACY
:
373 if (!image_check_hcrc(hdr
))
376 printf("Legacy Image at %08lX:\n", (ulong
)hdr
);
377 image_print_contents(hdr
);
379 puts(" Verifying Checksum ... ");
380 if (!image_check_dcrc(hdr
)) {
381 puts("Bad Data CRC\n");
387 #if defined(CONFIG_FIT)
388 case IMAGE_FORMAT_FIT
:
389 if (fit_check_format(hdr
, IMAGE_SIZE_INVAL
))
392 printf("FIT Image at %08lX:\n", (ulong
)hdr
);
393 fit_print_contents(hdr
);
408 #if defined(CONFIG_CMD_IMLS_NAND)
409 static int nand_imls_legacyimage(struct mtd_info
*mtd
, int nand_dev
,
410 loff_t off
, size_t len
)
415 imgdata
= malloc(len
);
417 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
419 printf(" Low memory(cannot allocate memory for image)\n");
423 ret
= nand_read_skip_bad(mtd
, off
, &len
, NULL
, mtd
->size
, imgdata
);
424 if (ret
< 0 && ret
!= -EUCLEAN
) {
429 if (!image_check_hcrc(imgdata
)) {
434 printf("Legacy Image at NAND device %d offset %08llX:\n",
436 image_print_contents(imgdata
);
438 puts(" Verifying Checksum ... ");
439 if (!image_check_dcrc(imgdata
))
440 puts("Bad Data CRC\n");
449 static int nand_imls_fitimage(struct mtd_info
*mtd
, int nand_dev
, loff_t off
,
455 imgdata
= malloc(len
);
457 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
459 printf(" Low memory(cannot allocate memory for image)\n");
463 ret
= nand_read_skip_bad(mtd
, off
, &len
, NULL
, mtd
->size
, imgdata
);
464 if (ret
< 0 && ret
!= -EUCLEAN
) {
469 if (fit_check_format(imgdata
, IMAGE_SIZE_INVAL
)) {
474 printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev
, off
);
476 fit_print_contents(imgdata
);
482 static int do_imls_nand(void)
484 struct mtd_info
*mtd
;
485 int nand_dev
= nand_curr_device
;
490 if (nand_dev
< 0 || nand_dev
>= CONFIG_SYS_MAX_NAND_DEVICE
) {
491 puts("\nNo NAND devices available\n");
497 for (nand_dev
= 0; nand_dev
< CONFIG_SYS_MAX_NAND_DEVICE
; nand_dev
++) {
498 mtd
= get_nand_dev_by_index(nand_dev
);
499 if (!mtd
->name
|| !mtd
->size
)
502 for (off
= 0; off
< mtd
->size
; off
+= mtd
->erasesize
) {
503 const struct legacy_img_hdr
*header
;
506 if (nand_block_isbad(mtd
, off
))
509 len
= sizeof(buffer
);
511 ret
= nand_read(mtd
, off
, &len
, (u8
*)buffer
);
512 if (ret
< 0 && ret
!= -EUCLEAN
) {
513 printf("NAND read error %d at offset %08llX\n",
518 switch (genimg_get_format(buffer
)) {
519 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
520 case IMAGE_FORMAT_LEGACY
:
521 header
= (const struct legacy_img_hdr
*)buffer
;
523 len
= image_get_image_size(header
);
524 nand_imls_legacyimage(mtd
, nand_dev
, off
, len
);
527 #if defined(CONFIG_FIT)
528 case IMAGE_FORMAT_FIT
:
529 len
= fit_get_size(buffer
);
530 nand_imls_fitimage(mtd
, nand_dev
, off
, len
);
541 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
542 static int do_imls(struct cmd_tbl
*cmdtp
, int flag
, int argc
,
545 int ret_nor
= 0, ret_nand
= 0;
547 #if defined(CONFIG_CMD_IMLS)
548 ret_nor
= do_imls_nor();
551 #if defined(CONFIG_CMD_IMLS_NAND)
552 ret_nand
= do_imls_nand();
566 "list all images found in flash",
568 " - Prints information about all images found at sector/block\n"
569 " boundaries in nor/nand flash."