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 /*
8 * Boot support
9 */
10 #include <bootm.h>
11 #include <command.h>
12 #include <env.h>
13 #include <errno.h>
14 #include <image.h>
15 #include <malloc.h>
16 #include <nand.h>
17 #include <asm/byteorder.h>
18 #include <asm/global_data.h>
19 #include <linux/ctype.h>
20 #include <linux/err.h>
21 #include <u-boot/zlib.h>
22 #include <mapmem.h>
23
24 DECLARE_GLOBAL_DATA_PTR;
25
26 #if defined(CONFIG_CMD_IMI)
27 static int image_info(unsigned long addr);
28 #endif
29
30 #if defined(CONFIG_CMD_IMLS)
31 #include <flash.h>
32 #include <mtd/cfi_flash.h>
33 #endif
34
35 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
36 static int do_imls(struct cmd_tbl *cmdtp, int flag, int argc,
37 char *const argv[]);
38 #endif
39
40 /* we overload the cmd field with our state machine info instead of a
41 * function pointer */
42 static struct cmd_tbl cmd_bootm_sub[] = {
43 U_BOOT_CMD_MKENT(start, 0, 1, (void *)BOOTM_STATE_START, "", ""),
44 U_BOOT_CMD_MKENT(loados, 0, 1, (void *)BOOTM_STATE_LOADOS, "", ""),
45 #ifdef CONFIG_CMD_BOOTM_PRE_LOAD
46 U_BOOT_CMD_MKENT(preload, 0, 1, (void *)BOOTM_STATE_PRE_LOAD, "", ""),
47 #endif
48 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
49 U_BOOT_CMD_MKENT(ramdisk, 0, 1, (void *)BOOTM_STATE_RAMDISK, "", ""),
50 #endif
51 #ifdef CONFIG_OF_LIBFDT
52 U_BOOT_CMD_MKENT(fdt, 0, 1, (void *)BOOTM_STATE_FDT, "", ""),
53 #endif
54 U_BOOT_CMD_MKENT(cmdline, 0, 1, (void *)BOOTM_STATE_OS_CMDLINE, "", ""),
55 U_BOOT_CMD_MKENT(bdt, 0, 1, (void *)BOOTM_STATE_OS_BD_T, "", ""),
56 U_BOOT_CMD_MKENT(prep, 0, 1, (void *)BOOTM_STATE_OS_PREP, "", ""),
57 U_BOOT_CMD_MKENT(fake, 0, 1, (void *)BOOTM_STATE_OS_FAKE_GO, "", ""),
58 U_BOOT_CMD_MKENT(go, 0, 1, (void *)BOOTM_STATE_OS_GO, "", ""),
59 };
60
61 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
bootm_get_addr(int argc,char * const argv[])62 static ulong bootm_get_addr(int argc, char *const argv[])
63 {
64 ulong addr;
65
66 if (argc > 0)
67 addr = hextoul(argv[0], NULL);
68 else
69 addr = image_load_addr;
70
71 return addr;
72 }
73 #endif
74
do_bootm_subcommand(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])75 static int do_bootm_subcommand(struct cmd_tbl *cmdtp, int flag, int argc,
76 char *const argv[])
77 {
78 struct bootm_info bmi;
79 int ret = 0;
80 long state;
81 struct cmd_tbl *c;
82
83 c = find_cmd_tbl(argv[0], &cmd_bootm_sub[0], ARRAY_SIZE(cmd_bootm_sub));
84 argc--; argv++;
85
86 if (c) {
87 state = (long)c->cmd;
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;
94 #endif
95 } else {
96 /* Unrecognized command */
97 return CMD_RET_USAGE;
98 }
99
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;
104 }
105
106 bootm_init(&bmi);
107 if (argc)
108 bmi.addr_img = argv[0];
109 if (argc > 1)
110 bmi.conf_ramdisk = argv[1];
111 if (argc > 2)
112 bmi.conf_fdt = argv[2];
113 bmi.cmd_name = "bootm";
114 bmi.boot_progress = false;
115
116 /* set up argc and argv[] since some OSes use them */
117 bmi.argc = argc;
118 bmi.argv = argv;
119
120 ret = bootm_run_states(&bmi, state);
121
122 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
123 if (!ret && (state & BOOTM_STATE_PRE_LOAD))
124 env_set_hex("loadaddr_verified",
125 bootm_get_addr(argc, argv) + image_load_offset);
126 #endif
127
128 return ret ? CMD_RET_FAILURE : 0;
129 }
130
131 /*******************************************************************/
132 /* bootm - boot application image from image in memory */
133 /*******************************************************************/
134
do_bootm(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])135 int do_bootm(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
136 {
137 struct bootm_info bmi;
138 int ret;
139
140 /* determine if we have a sub command */
141 argc--; argv++;
142 if (argc > 0) {
143 char *endp;
144
145 hextoul(argv[0], &endp);
146 /* endp pointing to NULL means that argv[0] was just a
147 * valid number, pass it along to the normal bootm processing
148 *
149 * If endp is ':' or '#' assume a FIT identifier so pass
150 * along for normal processing.
151 *
152 * Right now we assume the first arg should never be '-'
153 */
154 if ((*endp != 0) && (*endp != ':') && (*endp != '#'))
155 return do_bootm_subcommand(cmdtp, flag, argc, argv);
156 }
157
158 bootm_init(&bmi);
159 if (argc)
160 bmi.addr_img = argv[0];
161 if (argc > 1)
162 bmi.conf_ramdisk = argv[1];
163 if (argc > 2)
164 bmi.conf_fdt = argv[2];
165
166 /* set up argc and argv[] since some OSes use them */
167 bmi.argc = argc;
168 bmi.argv = argv;
169
170 ret = bootm_run(&bmi);
171
172 return ret ? CMD_RET_FAILURE : 0;
173 }
174
bootm_maybe_autostart(struct cmd_tbl * cmdtp,const char * cmd)175 int bootm_maybe_autostart(struct cmd_tbl *cmdtp, const char *cmd)
176 {
177 if (env_get_autostart()) {
178 char *local_args[2];
179 local_args[0] = (char *)cmd;
180 local_args[1] = NULL;
181 printf("Automatic boot of image at addr 0x%08lX ...\n",
182 image_load_addr);
183 return do_bootm(cmdtp, 0, 1, local_args);
184 }
185
186 return 0;
187 }
188
189 U_BOOT_LONGHELP(bootm,
190 "[addr [arg ...]]\n - boot application image stored in memory\n"
191 "\tpassing arguments 'arg ...'; when booting a Linux kernel,\n"
192 "\t'arg' can be the address of an initrd image\n"
193 #if defined(CONFIG_OF_LIBFDT)
194 "\tWhen booting a Linux kernel which requires a flat device-tree\n"
195 "\ta third argument is required which is the address of the\n"
196 "\tdevice-tree blob. To boot that kernel without an initrd image,\n"
197 "\tuse a '-' for the second argument. If you do not pass a third\n"
198 "\ta bd_info struct will be passed instead\n"
199 #endif
200 #if defined(CONFIG_FIT)
201 "\t\nFor the new multi component uImage format (FIT) addresses\n"
202 "\tmust be extended to include component or configuration unit name:\n"
203 "\taddr:<subimg_uname> - direct component image specification\n"
204 "\taddr#<conf_uname> - configuration specification\n"
205 "\tUse iminfo command to get the list of existing component\n"
206 "\timages and configurations.\n"
207 #endif
208 "\nSub-commands to do part of the bootm sequence. The sub-commands "
209 "must be\n"
210 "issued in the order below (it's ok to not issue all sub-commands):\n"
211 "\tstart [addr [arg ...]]\n"
212 #if defined(CONFIG_CMD_BOOTM_PRE_LOAD)
213 "\tpreload [addr [arg ..]] - run only the preload stage\n"
214 #endif
215 "\tloados - load OS image\n"
216 #if defined(CONFIG_SYS_BOOT_RAMDISK_HIGH)
217 "\tramdisk - relocate initrd, set env initrd_start/initrd_end\n"
218 #endif
219 #if defined(CONFIG_OF_LIBFDT)
220 "\tfdt - relocate flat device tree\n"
221 #endif
222 "\tcmdline - OS specific command line processing/setup\n"
223 "\tbdt - OS specific bd_info processing\n"
224 "\tprep - OS specific prep before relocation or go\n"
225 #if defined(CONFIG_TRACE)
226 "\tfake - OS specific fake start without go\n"
227 #endif
228 "\tgo - start OS");
229
230 U_BOOT_CMD(
231 bootm, CONFIG_SYS_MAXARGS, 1, do_bootm,
232 "boot application image from memory", bootm_help_text
233 );
234
235 /*******************************************************************/
236 /* bootd - boot default image */
237 /*******************************************************************/
238 #if defined(CONFIG_CMD_BOOTD)
do_bootd(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])239 int do_bootd(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
240 {
241 return run_command(env_get("bootcmd"), flag);
242 }
243
244 U_BOOT_CMD(
245 boot, 1, 1, do_bootd,
246 "boot default, i.e., run 'bootcmd'",
247 ""
248 );
249
250 /* keep old command name "bootd" for backward compatibility */
251 U_BOOT_CMD(
252 bootd, 1, 1, do_bootd,
253 "boot default, i.e., run 'bootcmd'",
254 ""
255 );
256
257 #endif
258
259 /*******************************************************************/
260 /* iminfo - print header info for a requested image */
261 /*******************************************************************/
262 #if defined(CONFIG_CMD_IMI)
do_iminfo(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])263 static int do_iminfo(struct cmd_tbl *cmdtp, int flag, int argc,
264 char *const argv[])
265 {
266 int arg;
267 ulong addr;
268 int rcode = 0;
269
270 if (argc < 2) {
271 return image_info(image_load_addr);
272 }
273
274 for (arg = 1; arg < argc; ++arg) {
275 addr = hextoul(argv[arg], NULL);
276 if (image_info(addr) != 0)
277 rcode = 1;
278 }
279 return rcode;
280 }
281
image_info(ulong addr)282 static int image_info(ulong addr)
283 {
284 void *hdr = (void *)map_sysmem(addr, 0);
285
286 printf("\n## Checking Image at %08lx ...\n", addr);
287
288 switch (genimg_get_format(hdr)) {
289 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
290 case IMAGE_FORMAT_LEGACY:
291 puts(" Legacy image found\n");
292 if (!image_check_magic(hdr)) {
293 puts(" Bad Magic Number\n");
294 unmap_sysmem(hdr);
295 return 1;
296 }
297
298 if (!image_check_hcrc(hdr)) {
299 puts(" Bad Header Checksum\n");
300 unmap_sysmem(hdr);
301 return 1;
302 }
303
304 image_print_contents(hdr);
305
306 puts(" Verifying Checksum ... ");
307 if (!image_check_dcrc(hdr)) {
308 puts(" Bad Data CRC\n");
309 unmap_sysmem(hdr);
310 return 1;
311 }
312 puts("OK\n");
313 unmap_sysmem(hdr);
314 return 0;
315 #endif
316 #if defined(CONFIG_ANDROID_BOOT_IMAGE)
317 case IMAGE_FORMAT_ANDROID:
318 puts(" Android image found\n");
319 android_print_contents(hdr);
320 unmap_sysmem(hdr);
321 return 0;
322 #endif
323 #if defined(CONFIG_FIT)
324 case IMAGE_FORMAT_FIT:
325 puts(" FIT image found\n");
326
327 if (fit_check_format(hdr, IMAGE_SIZE_INVAL)) {
328 puts("Bad FIT image format!\n");
329 unmap_sysmem(hdr);
330 return 1;
331 }
332
333 fit_print_contents(hdr);
334
335 if (!fit_all_image_verify(hdr)) {
336 puts("Bad hash in FIT image!\n");
337 unmap_sysmem(hdr);
338 return 1;
339 }
340
341 unmap_sysmem(hdr);
342 return 0;
343 #endif
344 default:
345 puts("Unknown image format!\n");
346 break;
347 }
348
349 unmap_sysmem(hdr);
350 return 1;
351 }
352
353 U_BOOT_CMD(
354 iminfo, CONFIG_SYS_MAXARGS, 1, do_iminfo,
355 "print header information for application image",
356 "addr [addr ...]\n"
357 " - print header information for application image starting at\n"
358 " address 'addr' in memory; this includes verification of the\n"
359 " image contents (magic number, header and payload checksums)"
360 );
361 #endif
362
363 /*******************************************************************/
364 /* imls - list all images found in flash */
365 /*******************************************************************/
366 #if defined(CONFIG_CMD_IMLS)
do_imls_nor(void)367 static int do_imls_nor(void)
368 {
369 flash_info_t *info;
370 int i, j;
371 void *hdr;
372
373 for (i = 0, info = &flash_info[0];
374 i < CFI_FLASH_BANKS; ++i, ++info) {
375
376 if (info->flash_id == FLASH_UNKNOWN)
377 goto next_bank;
378 for (j = 0; j < info->sector_count; ++j) {
379
380 hdr = (void *)info->start[j];
381 if (!hdr)
382 goto next_sector;
383
384 switch (genimg_get_format(hdr)) {
385 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
386 case IMAGE_FORMAT_LEGACY:
387 if (!image_check_hcrc(hdr))
388 goto next_sector;
389
390 printf("Legacy Image at %08lX:\n", (ulong)hdr);
391 image_print_contents(hdr);
392
393 puts(" Verifying Checksum ... ");
394 if (!image_check_dcrc(hdr)) {
395 puts("Bad Data CRC\n");
396 } else {
397 puts("OK\n");
398 }
399 break;
400 #endif
401 #if defined(CONFIG_FIT)
402 case IMAGE_FORMAT_FIT:
403 if (fit_check_format(hdr, IMAGE_SIZE_INVAL))
404 goto next_sector;
405
406 printf("FIT Image at %08lX:\n", (ulong)hdr);
407 fit_print_contents(hdr);
408 break;
409 #endif
410 default:
411 goto next_sector;
412 }
413
414 next_sector: ;
415 }
416 next_bank: ;
417 }
418 return 0;
419 }
420 #endif
421
422 #if defined(CONFIG_CMD_IMLS_NAND)
nand_imls_legacyimage(struct mtd_info * mtd,int nand_dev,loff_t off,size_t len)423 static int nand_imls_legacyimage(struct mtd_info *mtd, int nand_dev,
424 loff_t off, size_t len)
425 {
426 void *imgdata;
427 int ret;
428
429 imgdata = malloc(len);
430 if (!imgdata) {
431 printf("May be a Legacy Image at NAND device %d offset %08llX:\n",
432 nand_dev, off);
433 printf(" Low memory(cannot allocate memory for image)\n");
434 return -ENOMEM;
435 }
436
437 ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
438 if (ret < 0 && ret != -EUCLEAN) {
439 free(imgdata);
440 return ret;
441 }
442
443 if (!image_check_hcrc(imgdata)) {
444 free(imgdata);
445 return 0;
446 }
447
448 printf("Legacy Image at NAND device %d offset %08llX:\n",
449 nand_dev, off);
450 image_print_contents(imgdata);
451
452 puts(" Verifying Checksum ... ");
453 if (!image_check_dcrc(imgdata))
454 puts("Bad Data CRC\n");
455 else
456 puts("OK\n");
457
458 free(imgdata);
459
460 return 0;
461 }
462
nand_imls_fitimage(struct mtd_info * mtd,int nand_dev,loff_t off,size_t len)463 static int nand_imls_fitimage(struct mtd_info *mtd, int nand_dev, loff_t off,
464 size_t len)
465 {
466 void *imgdata;
467 int ret;
468
469 imgdata = malloc(len);
470 if (!imgdata) {
471 printf("May be a FIT Image at NAND device %d offset %08llX:\n",
472 nand_dev, off);
473 printf(" Low memory(cannot allocate memory for image)\n");
474 return -ENOMEM;
475 }
476
477 ret = nand_read_skip_bad(mtd, off, &len, NULL, mtd->size, imgdata);
478 if (ret < 0 && ret != -EUCLEAN) {
479 free(imgdata);
480 return ret;
481 }
482
483 if (fit_check_format(imgdata, IMAGE_SIZE_INVAL)) {
484 free(imgdata);
485 return 0;
486 }
487
488 printf("FIT Image at NAND device %d offset %08llX:\n", nand_dev, off);
489
490 fit_print_contents(imgdata);
491 free(imgdata);
492
493 return 0;
494 }
495
do_imls_nand(void)496 static int do_imls_nand(void)
497 {
498 struct mtd_info *mtd;
499 int nand_dev = nand_curr_device;
500 size_t len;
501 loff_t off;
502 u32 buffer[16];
503
504 if (nand_dev < 0 || nand_dev >= CONFIG_SYS_MAX_NAND_DEVICE) {
505 puts("\nNo NAND devices available\n");
506 return -ENODEV;
507 }
508
509 printf("\n");
510
511 for (nand_dev = 0; nand_dev < CONFIG_SYS_MAX_NAND_DEVICE; nand_dev++) {
512 mtd = get_nand_dev_by_index(nand_dev);
513 if (!mtd->name || !mtd->size)
514 continue;
515
516 for (off = 0; off < mtd->size; off += mtd->erasesize) {
517 const struct legacy_img_hdr *header;
518 int ret;
519
520 if (nand_block_isbad(mtd, off))
521 continue;
522
523 len = sizeof(buffer);
524
525 ret = nand_read(mtd, off, &len, (u8 *)buffer);
526 if (ret < 0 && ret != -EUCLEAN) {
527 printf("NAND read error %d at offset %08llX\n",
528 ret, off);
529 continue;
530 }
531
532 switch (genimg_get_format(buffer)) {
533 #if defined(CONFIG_LEGACY_IMAGE_FORMAT)
534 case IMAGE_FORMAT_LEGACY:
535 header = (const struct legacy_img_hdr *)buffer;
536
537 len = image_get_image_size(header);
538 nand_imls_legacyimage(mtd, nand_dev, off, len);
539 break;
540 #endif
541 #if defined(CONFIG_FIT)
542 case IMAGE_FORMAT_FIT:
543 len = fit_get_size(buffer);
544 nand_imls_fitimage(mtd, nand_dev, off, len);
545 break;
546 #endif
547 }
548 }
549 }
550
551 return 0;
552 }
553 #endif
554
555 #if defined(CONFIG_CMD_IMLS) || defined(CONFIG_CMD_IMLS_NAND)
do_imls(struct cmd_tbl * cmdtp,int flag,int argc,char * const argv[])556 static int do_imls(struct cmd_tbl *cmdtp, int flag, int argc,
557 char *const argv[])
558 {
559 int ret_nor = 0, ret_nand = 0;
560
561 #if defined(CONFIG_CMD_IMLS)
562 ret_nor = do_imls_nor();
563 #endif
564
565 #if defined(CONFIG_CMD_IMLS_NAND)
566 ret_nand = do_imls_nand();
567 #endif
568
569 if (ret_nor)
570 return ret_nor;
571
572 if (ret_nand)
573 return ret_nand;
574
575 return (0);
576 }
577
578 U_BOOT_CMD(
579 imls, 1, 1, do_imls,
580 "list all images found in flash",
581 "\n"
582 " - Prints information about all images found at sector/block\n"
583 " boundaries in nor/nand flash."
584 );
585 #endif
586