]> Git Repo - u-boot.git/blob - boot/bootm.c
bootm: Simplify Android ramdisk addr in bootm_find_images()
[u-boot.git] / boot / bootm.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * (C) Copyright 2000-2009
4  * Wolfgang Denk, DENX Software Engineering, [email protected].
5  */
6
7 #ifndef USE_HOSTCC
8 #include <common.h>
9 #include <bootstage.h>
10 #include <cli.h>
11 #include <command.h>
12 #include <cpu_func.h>
13 #include <env.h>
14 #include <errno.h>
15 #include <fdt_support.h>
16 #include <irq_func.h>
17 #include <lmb.h>
18 #include <log.h>
19 #include <malloc.h>
20 #include <mapmem.h>
21 #include <net.h>
22 #include <asm/cache.h>
23 #include <asm/global_data.h>
24 #include <asm/io.h>
25 #include <linux/sizes.h>
26 #include <tpm-v2.h>
27 #if defined(CONFIG_CMD_USB)
28 #include <usb.h>
29 #endif
30 #else
31 #include "mkimage.h"
32 #endif
33
34 #include <bootm.h>
35 #include <image.h>
36
37 #define MAX_CMDLINE_SIZE        SZ_4K
38
39 #define IH_INITRD_ARCH IH_ARCH_DEFAULT
40
41 #ifndef USE_HOSTCC
42
43 DECLARE_GLOBAL_DATA_PTR;
44
45 struct bootm_headers images;            /* pointers to os/initrd/fdt images */
46
47 __weak void board_quiesce_devices(void)
48 {
49 }
50
51 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
52 /**
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
56  *
57  * image_get_kernel() verifies legacy image integrity and returns pointer to
58  * legacy image header if image verification was completed successfully.
59  *
60  * returns:
61  *     pointer to a legacy image header if valid image was found
62  *     otherwise return NULL
63  */
64 static struct legacy_img_hdr *image_get_kernel(ulong img_addr, int verify)
65 {
66         struct legacy_img_hdr *hdr = (struct legacy_img_hdr *)img_addr;
67
68         if (!image_check_magic(hdr)) {
69                 puts("Bad Magic Number\n");
70                 bootstage_error(BOOTSTAGE_ID_CHECK_MAGIC);
71                 return NULL;
72         }
73         bootstage_mark(BOOTSTAGE_ID_CHECK_HEADER);
74
75         if (!image_check_hcrc(hdr)) {
76                 puts("Bad Header Checksum\n");
77                 bootstage_error(BOOTSTAGE_ID_CHECK_HEADER);
78                 return NULL;
79         }
80
81         bootstage_mark(BOOTSTAGE_ID_CHECK_CHECKSUM);
82         image_print_contents(hdr);
83
84         if (verify) {
85                 puts("   Verifying Checksum ... ");
86                 if (!image_check_dcrc(hdr)) {
87                         printf("Bad Data CRC\n");
88                         bootstage_error(BOOTSTAGE_ID_CHECK_CHECKSUM);
89                         return NULL;
90                 }
91                 puts("OK\n");
92         }
93         bootstage_mark(BOOTSTAGE_ID_CHECK_ARCH);
94
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);
98                 return NULL;
99         }
100         return hdr;
101 }
102 #endif
103
104 /**
105  * boot_get_kernel() - find kernel image
106  *
107  * @addr_fit: first argument to bootm: address, fit configuration, etc.
108  * @os_data: pointer to a ulong variable, will hold os data start address
109  * @os_len: pointer to a ulong variable, will hold os data length
110  *     address and length, otherwise NULL
111  *     pointer to image header if valid image was found, plus kernel start
112  * @kernp: image header if valid image was found, otherwise NULL
113  *
114  * boot_get_kernel() tries to find a kernel image, verifies its integrity
115  * and locates kernel data.
116  *
117  * Return: 0 on success, -ve on error. -EPROTOTYPE means that the image is in
118  * a wrong or unsupported format
119  */
120 static int boot_get_kernel(const char *addr_fit, struct bootm_headers *images,
121                            ulong *os_data, ulong *os_len, const void **kernp)
122 {
123 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
124         struct legacy_img_hdr   *hdr;
125 #endif
126         ulong           img_addr;
127         const void *buf;
128         const char *fit_uname_config = NULL, *fit_uname_kernel = NULL;
129 #if CONFIG_IS_ENABLED(FIT)
130         int             os_noffset;
131 #endif
132
133 #ifdef CONFIG_ANDROID_BOOT_IMAGE
134         const void *boot_img;
135         const void *vendor_boot_img;
136 #endif
137         img_addr = genimg_get_kernel_addr_fit(addr_fit, &fit_uname_config,
138                                               &fit_uname_kernel);
139
140         if (IS_ENABLED(CONFIG_CMD_BOOTM_PRE_LOAD))
141                 img_addr += image_load_offset;
142
143         bootstage_mark(BOOTSTAGE_ID_CHECK_MAGIC);
144
145         /* check image type, for FIT images get FIT kernel node */
146         *os_data = *os_len = 0;
147         buf = map_sysmem(img_addr, 0);
148         switch (genimg_get_format(buf)) {
149 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
150         case IMAGE_FORMAT_LEGACY:
151                 printf("## Booting kernel from Legacy Image at %08lx ...\n",
152                        img_addr);
153                 hdr = image_get_kernel(img_addr, images->verify);
154                 if (!hdr)
155                         return -EINVAL;
156                 bootstage_mark(BOOTSTAGE_ID_CHECK_IMAGETYPE);
157
158                 /* get os_data and os_len */
159                 switch (image_get_type(hdr)) {
160                 case IH_TYPE_KERNEL:
161                 case IH_TYPE_KERNEL_NOLOAD:
162                         *os_data = image_get_data(hdr);
163                         *os_len = image_get_data_size(hdr);
164                         break;
165                 case IH_TYPE_MULTI:
166                         image_multi_getimg(hdr, 0, os_data, os_len);
167                         break;
168                 case IH_TYPE_STANDALONE:
169                         *os_data = image_get_data(hdr);
170                         *os_len = image_get_data_size(hdr);
171                         break;
172                 default:
173                         bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
174                         return -EPROTOTYPE;
175                 }
176
177                 /*
178                  * copy image header to allow for image overwrites during
179                  * kernel decompression.
180                  */
181                 memmove(&images->legacy_hdr_os_copy, hdr,
182                         sizeof(struct legacy_img_hdr));
183
184                 /* save pointer to image header */
185                 images->legacy_hdr_os = hdr;
186
187                 images->legacy_hdr_valid = 1;
188                 bootstage_mark(BOOTSTAGE_ID_DECOMP_IMAGE);
189                 break;
190 #endif
191 #if CONFIG_IS_ENABLED(FIT)
192         case IMAGE_FORMAT_FIT:
193                 os_noffset = fit_image_load(images, img_addr,
194                                 &fit_uname_kernel, &fit_uname_config,
195                                 IH_ARCH_DEFAULT, IH_TYPE_KERNEL,
196                                 BOOTSTAGE_ID_FIT_KERNEL_START,
197                                 FIT_LOAD_IGNORED, os_data, os_len);
198                 if (os_noffset < 0)
199                         return -ENOENT;
200
201                 images->fit_hdr_os = map_sysmem(img_addr, 0);
202                 images->fit_uname_os = fit_uname_kernel;
203                 images->fit_uname_cfg = fit_uname_config;
204                 images->fit_noffset_os = os_noffset;
205                 break;
206 #endif
207 #ifdef CONFIG_ANDROID_BOOT_IMAGE
208         case IMAGE_FORMAT_ANDROID: {
209                 int ret;
210
211                 boot_img = buf;
212                 vendor_boot_img = NULL;
213                 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG)) {
214                         boot_img = map_sysmem(get_abootimg_addr(), 0);
215                         vendor_boot_img = map_sysmem(get_avendor_bootimg_addr(), 0);
216                 }
217                 printf("## Booting Android Image at 0x%08lx ...\n", img_addr);
218                 ret = android_image_get_kernel(boot_img, vendor_boot_img,
219                                                images->verify, os_data, os_len);
220                 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG)) {
221                         unmap_sysmem(vendor_boot_img);
222                         unmap_sysmem(boot_img);
223                 }
224                 if (ret)
225                         return ret;
226                 break;
227         }
228 #endif
229         default:
230                 bootstage_error(BOOTSTAGE_ID_CHECK_IMAGETYPE);
231                 return -EPROTOTYPE;
232         }
233
234         debug("   kernel data at 0x%08lx, len = 0x%08lx (%ld)\n",
235               *os_data, *os_len, *os_len);
236         *kernp = buf;
237
238         return 0;
239 }
240
241 #ifdef CONFIG_LMB
242 static void boot_start_lmb(struct bootm_headers *images)
243 {
244         ulong           mem_start;
245         phys_size_t     mem_size;
246
247         mem_start = env_get_bootm_low();
248         mem_size = env_get_bootm_size();
249
250         lmb_init_and_reserve_range(&images->lmb, (phys_addr_t)mem_start,
251                                    mem_size, NULL);
252 }
253 #else
254 #define lmb_reserve(lmb, base, size)
255 static inline void boot_start_lmb(struct bootm_headers *images) { }
256 #endif
257
258 static int bootm_start(void)
259 {
260         memset((void *)&images, 0, sizeof(images));
261         images.verify = env_get_yesno("verify");
262
263         boot_start_lmb(&images);
264
265         bootstage_mark_name(BOOTSTAGE_ID_BOOTM_START, "bootm_start");
266         images.state = BOOTM_STATE_START;
267
268         return 0;
269 }
270
271 static ulong bootm_data_addr(const char *addr_str)
272 {
273         ulong addr;
274
275         if (addr_str)
276                 addr = hextoul(addr_str, NULL);
277         else
278                 addr = image_load_addr;
279
280         return addr;
281 }
282
283 /**
284  * bootm_pre_load() - Handle the pre-load processing
285  *
286  * This can be used to do a full signature check of the image, for example.
287  * It calls image_pre_load() with the data address of the image to check.
288  *
289  * @addr_str: String containing load address in hex, or NULL to use
290  * image_load_addr
291  * Return: 0 if OK, CMD_RET_FAILURE on failure
292  */
293 static int bootm_pre_load(const char *addr_str)
294 {
295         ulong data_addr = bootm_data_addr(addr_str);
296         int ret = 0;
297
298         if (IS_ENABLED(CONFIG_CMD_BOOTM_PRE_LOAD))
299                 ret = image_pre_load(data_addr);
300
301         if (ret)
302                 ret = CMD_RET_FAILURE;
303
304         return ret;
305 }
306
307 /**
308  * bootm_find_os(): Find the OS to boot
309  *
310  * @cmd_name: Command name that started this boot, e.g. "bootm"
311  * @addr_fit: Address and/or FIT specifier (first arg of bootm command)
312  * Return: 0 on success, -ve on error
313  */
314 static int bootm_find_os(const char *cmd_name, const char *addr_fit)
315 {
316         const void *os_hdr;
317 #ifdef CONFIG_ANDROID_BOOT_IMAGE
318         const void *vendor_boot_img;
319         const void *boot_img;
320 #endif
321         bool ep_found = false;
322         int ret;
323
324         /* get kernel image header, start address and length */
325         ret = boot_get_kernel(addr_fit, &images, &images.os.image_start,
326                               &images.os.image_len, &os_hdr);
327         if (ret) {
328                 if (ret == -EPROTOTYPE)
329                         printf("Wrong Image Type for %s command\n", cmd_name);
330
331                 printf("ERROR %dE: can't get kernel image!\n", ret);
332                 return 1;
333         }
334
335         /* get image parameters */
336         switch (genimg_get_format(os_hdr)) {
337 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
338         case IMAGE_FORMAT_LEGACY:
339                 images.os.type = image_get_type(os_hdr);
340                 images.os.comp = image_get_comp(os_hdr);
341                 images.os.os = image_get_os(os_hdr);
342
343                 images.os.end = image_get_image_end(os_hdr);
344                 images.os.load = image_get_load(os_hdr);
345                 images.os.arch = image_get_arch(os_hdr);
346                 break;
347 #endif
348 #if CONFIG_IS_ENABLED(FIT)
349         case IMAGE_FORMAT_FIT:
350                 if (fit_image_get_type(images.fit_hdr_os,
351                                        images.fit_noffset_os,
352                                        &images.os.type)) {
353                         puts("Can't get image type!\n");
354                         bootstage_error(BOOTSTAGE_ID_FIT_TYPE);
355                         return 1;
356                 }
357
358                 if (fit_image_get_comp(images.fit_hdr_os,
359                                        images.fit_noffset_os,
360                                        &images.os.comp)) {
361                         puts("Can't get image compression!\n");
362                         bootstage_error(BOOTSTAGE_ID_FIT_COMPRESSION);
363                         return 1;
364                 }
365
366                 if (fit_image_get_os(images.fit_hdr_os, images.fit_noffset_os,
367                                      &images.os.os)) {
368                         puts("Can't get image OS!\n");
369                         bootstage_error(BOOTSTAGE_ID_FIT_OS);
370                         return 1;
371                 }
372
373                 if (fit_image_get_arch(images.fit_hdr_os,
374                                        images.fit_noffset_os,
375                                        &images.os.arch)) {
376                         puts("Can't get image ARCH!\n");
377                         return 1;
378                 }
379
380                 images.os.end = fit_get_end(images.fit_hdr_os);
381
382                 if (fit_image_get_load(images.fit_hdr_os, images.fit_noffset_os,
383                                        &images.os.load)) {
384                         puts("Can't get image load address!\n");
385                         bootstage_error(BOOTSTAGE_ID_FIT_LOADADDR);
386                         return 1;
387                 }
388                 break;
389 #endif
390 #ifdef CONFIG_ANDROID_BOOT_IMAGE
391         case IMAGE_FORMAT_ANDROID:
392                 boot_img = os_hdr;
393                 vendor_boot_img = NULL;
394                 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG)) {
395                         boot_img = map_sysmem(get_abootimg_addr(), 0);
396                         vendor_boot_img = map_sysmem(get_avendor_bootimg_addr(), 0);
397                 }
398                 images.os.type = IH_TYPE_KERNEL;
399                 images.os.comp = android_image_get_kcomp(boot_img, vendor_boot_img);
400                 images.os.os = IH_OS_LINUX;
401                 images.os.end = android_image_get_end(boot_img, vendor_boot_img);
402                 images.os.load = android_image_get_kload(boot_img, vendor_boot_img);
403                 images.ep = images.os.load;
404                 ep_found = true;
405                 if (IS_ENABLED(CONFIG_CMD_ABOOTIMG)) {
406                         unmap_sysmem(vendor_boot_img);
407                         unmap_sysmem(boot_img);
408                 }
409                 break;
410 #endif
411         default:
412                 puts("ERROR: unknown image format type!\n");
413                 return 1;
414         }
415
416         /* If we have a valid setup.bin, we will use that for entry (x86) */
417         if (images.os.arch == IH_ARCH_I386 ||
418             images.os.arch == IH_ARCH_X86_64) {
419                 ulong len;
420
421                 ret = boot_get_setup(&images, IH_ARCH_I386, &images.ep, &len);
422                 if (ret < 0 && ret != -ENOENT) {
423                         puts("Could not find a valid setup.bin for x86\n");
424                         return 1;
425                 }
426                 /* Kernel entry point is the setup.bin */
427         } else if (images.legacy_hdr_valid) {
428                 images.ep = image_get_ep(&images.legacy_hdr_os_copy);
429 #if CONFIG_IS_ENABLED(FIT)
430         } else if (images.fit_uname_os) {
431                 int ret;
432
433                 ret = fit_image_get_entry(images.fit_hdr_os,
434                                           images.fit_noffset_os, &images.ep);
435                 if (ret) {
436                         puts("Can't get entry point property!\n");
437                         return 1;
438                 }
439 #endif
440         } else if (!ep_found) {
441                 puts("Could not find kernel entry point!\n");
442                 return 1;
443         }
444
445         if (images.os.type == IH_TYPE_KERNEL_NOLOAD) {
446                 if (IS_ENABLED(CONFIG_CMD_BOOTI) &&
447                     images.os.arch == IH_ARCH_ARM64 &&
448                     images.os.os == IH_OS_LINUX) {
449                         ulong image_addr;
450                         ulong image_size;
451
452                         ret = booti_setup(images.os.image_start, &image_addr,
453                                           &image_size, true);
454                         if (ret != 0)
455                                 return 1;
456
457                         images.os.type = IH_TYPE_KERNEL;
458                         images.os.load = image_addr;
459                         images.ep = image_addr;
460                 } else {
461                         images.os.load = images.os.image_start;
462                         images.ep += images.os.image_start;
463                 }
464         }
465
466         images.os.start = map_to_sysmem(os_hdr);
467
468         return 0;
469 }
470
471 /**
472  * bootm_find_images - wrapper to find and locate various images
473  * @flag: Ignored Argument
474  * @argc: command argument count
475  * @argv: command argument list
476  * @start: OS image start address
477  * @size: OS image size
478  *
479  * boot_find_images() will attempt to load an available ramdisk,
480  * flattened device tree, as well as specifically marked
481  * "loadable" images (loadables are FIT only)
482  *
483  * Note: bootm_find_images will skip an image if it is not found
484  *
485  * @return:
486  *     0, if all existing images were loaded correctly
487  *     1, if an image is found but corrupted, or invalid
488  */
489 int bootm_find_images(int flag, int argc, char *const argv[], ulong start,
490                       ulong size)
491 {
492         const char *select = NULL;
493         char addr_str[17];
494         ulong img_addr;
495         void *buf;
496         int ret;
497
498         img_addr = argc ? hextoul(argv[0], NULL) : image_load_addr;
499
500         if (IS_ENABLED(CONFIG_ANDROID_BOOT_IMAGE)) {
501                 /* Look for an Android boot image */
502                 buf = map_sysmem(images.os.start, 0);
503                 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
504                         strcpy(addr_str, simple_xtoa(img_addr));
505                         select = addr_str;
506                 }
507         }
508
509         if (argc >= 2)
510                 select = argv[1];
511
512         /* find ramdisk */
513         ret = boot_get_ramdisk(select, &images, IH_INITRD_ARCH,
514                                &images.rd_start, &images.rd_end);
515         if (ret) {
516                 puts("Ramdisk image is corrupt or invalid\n");
517                 return 1;
518         }
519
520         /* check if ramdisk overlaps OS image */
521         if (images.rd_start && (((ulong)images.rd_start >= start &&
522                                  (ulong)images.rd_start < start + size) ||
523                                 ((ulong)images.rd_end > start &&
524                                  (ulong)images.rd_end <= start + size) ||
525                                 ((ulong)images.rd_start < start &&
526                                  (ulong)images.rd_end >= start + size))) {
527                 printf("ERROR: RD image overlaps OS image (OS=0x%lx..0x%lx)\n",
528                        start, start + size);
529                 return 1;
530         }
531
532         if (CONFIG_IS_ENABLED(OF_LIBFDT)) {
533                 buf = map_sysmem(img_addr, 0);
534
535                 /* find flattened device tree */
536                 ret = boot_get_fdt(buf, argc > 2 ? argv[2] : NULL,
537                                    IH_ARCH_DEFAULT, &images, &images.ft_addr,
538                                    &images.ft_len);
539                 if (ret) {
540                         puts("Could not find a valid device tree\n");
541                         return 1;
542                 }
543
544                 /* check if FDT overlaps OS image */
545                 if (images.ft_addr &&
546                     (((ulong)images.ft_addr >= start &&
547                       (ulong)images.ft_addr < start + size) ||
548                      ((ulong)images.ft_addr + images.ft_len >= start &&
549                       (ulong)images.ft_addr + images.ft_len < start + size))) {
550                         printf("ERROR: FDT image overlaps OS image (OS=0x%lx..0x%lx)\n",
551                                start, start + size);
552                         return 1;
553                 }
554
555                 if (IS_ENABLED(CONFIG_CMD_FDT))
556                         set_working_fdt_addr(map_to_sysmem(images.ft_addr));
557         }
558
559 #if CONFIG_IS_ENABLED(FIT)
560         if (IS_ENABLED(CONFIG_FPGA)) {
561                 /* find bitstreams */
562                 ret = boot_get_fpga(&images);
563                 if (ret) {
564                         printf("FPGA image is corrupted or invalid\n");
565                         return 1;
566                 }
567         }
568
569         /* find all of the loadables */
570         ret = boot_get_loadable(&images);
571         if (ret) {
572                 printf("Loadable(s) is corrupt or invalid\n");
573                 return 1;
574         }
575 #endif
576
577         return 0;
578 }
579
580 static int bootm_find_other(struct cmd_tbl *cmdtp, int flag, int argc,
581                             char *const argv[])
582 {
583         if (((images.os.type == IH_TYPE_KERNEL) ||
584              (images.os.type == IH_TYPE_KERNEL_NOLOAD) ||
585              (images.os.type == IH_TYPE_MULTI)) &&
586             (images.os.os == IH_OS_LINUX ||
587                  images.os.os == IH_OS_VXWORKS))
588                 return bootm_find_images(flag, argc, argv, 0, 0);
589
590         return 0;
591 }
592 #endif /* USE_HOSTC */
593
594 #if !defined(USE_HOSTCC) || defined(CONFIG_FIT_SIGNATURE)
595 /**
596  * handle_decomp_error() - display a decompression error
597  *
598  * This function tries to produce a useful message. In the case where the
599  * uncompressed size is the same as the available space, we can assume that
600  * the image is too large for the buffer.
601  *
602  * @comp_type:          Compression type being used (IH_COMP_...)
603  * @uncomp_size:        Number of bytes uncompressed
604  * @buf_size:           Number of bytes the decompresion buffer was
605  * @ret:                errno error code received from compression library
606  * Return: Appropriate BOOTM_ERR_ error code
607  */
608 static int handle_decomp_error(int comp_type, size_t uncomp_size,
609                                size_t buf_size, int ret)
610 {
611         const char *name = genimg_get_comp_name(comp_type);
612
613         /* ENOSYS means unimplemented compression type, don't reset. */
614         if (ret == -ENOSYS)
615                 return BOOTM_ERR_UNIMPLEMENTED;
616
617         if (uncomp_size >= buf_size)
618                 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
619         else
620                 printf("%s: uncompress error %d\n", name, ret);
621
622         /*
623          * The decompression routines are now safe, so will not write beyond
624          * their bounds. Probably it is not necessary to reset, but maintain
625          * the current behaviour for now.
626          */
627         printf("Must RESET board to recover\n");
628 #ifndef USE_HOSTCC
629         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
630 #endif
631
632         return BOOTM_ERR_RESET;
633 }
634 #endif
635
636 #ifndef USE_HOSTCC
637 static int bootm_load_os(struct bootm_headers *images, int boot_progress)
638 {
639         struct image_info os = images->os;
640         ulong load = os.load;
641         ulong load_end;
642         ulong blob_start = os.start;
643         ulong blob_end = os.end;
644         ulong image_start = os.image_start;
645         ulong image_len = os.image_len;
646         ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
647         bool no_overlap;
648         void *load_buf, *image_buf;
649         int err;
650
651         load_buf = map_sysmem(load, 0);
652         image_buf = map_sysmem(os.image_start, image_len);
653         err = image_decomp(os.comp, load, os.image_start, os.type,
654                            load_buf, image_buf, image_len,
655                            CONFIG_SYS_BOOTM_LEN, &load_end);
656         if (err) {
657                 err = handle_decomp_error(os.comp, load_end - load,
658                                           CONFIG_SYS_BOOTM_LEN, err);
659                 bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
660                 return err;
661         }
662         /* We need the decompressed image size in the next steps */
663         images->os.image_len = load_end - load;
664
665         flush_cache(flush_start, ALIGN(load_end, ARCH_DMA_MINALIGN) - flush_start);
666
667         debug("   kernel loaded at 0x%08lx, end = 0x%08lx\n", load, load_end);
668         bootstage_mark(BOOTSTAGE_ID_KERNEL_LOADED);
669
670         no_overlap = (os.comp == IH_COMP_NONE && load == image_start);
671
672         if (!no_overlap && load < blob_end && load_end > blob_start) {
673                 debug("images.os.start = 0x%lX, images.os.end = 0x%lx\n",
674                       blob_start, blob_end);
675                 debug("images.os.load = 0x%lx, load_end = 0x%lx\n", load,
676                       load_end);
677
678                 /* Check what type of image this is. */
679                 if (images->legacy_hdr_valid) {
680                         if (image_get_type(&images->legacy_hdr_os_copy)
681                                         == IH_TYPE_MULTI)
682                                 puts("WARNING: legacy format multi component image overwritten\n");
683                         return BOOTM_ERR_OVERLAP;
684                 } else {
685                         puts("ERROR: new format image overwritten - must RESET the board to recover\n");
686                         bootstage_error(BOOTSTAGE_ID_OVERWRITTEN);
687                         return BOOTM_ERR_RESET;
688                 }
689         }
690
691         lmb_reserve(&images->lmb, images->os.load, (load_end -
692                                                     images->os.load));
693         return 0;
694 }
695
696 /**
697  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
698  *
699  * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were
700  *      enabled)
701  */
702 ulong bootm_disable_interrupts(void)
703 {
704         ulong iflag;
705
706         /*
707          * We have reached the point of no return: we are going to
708          * overwrite all exception vector code, so we cannot easily
709          * recover from any failures any more...
710          */
711         iflag = disable_interrupts();
712 #ifdef CONFIG_NETCONSOLE
713         /* Stop the ethernet stack if NetConsole could have left it up */
714         eth_halt();
715 #endif
716
717 #if defined(CONFIG_CMD_USB)
718         /*
719          * turn off USB to prevent the host controller from writing to the
720          * SDRAM while Linux is booting. This could happen (at least for OHCI
721          * controller), because the HCCA (Host Controller Communication Area)
722          * lies within the SDRAM and the host controller writes continously to
723          * this area (as busmaster!). The HccaFrameNumber is for example
724          * updated every 1 ms within the HCCA structure in SDRAM! For more
725          * details see the OpenHCI specification.
726          */
727         usb_stop();
728 #endif
729         return iflag;
730 }
731
732 #define CONSOLE_ARG             "console="
733 #define NULL_CONSOLE            (CONSOLE_ARG "ttynull")
734 #define CONSOLE_ARG_SIZE        sizeof(NULL_CONSOLE)
735
736 /**
737  * fixup_silent_linux() - Handle silencing the linux boot if required
738  *
739  * This uses the silent_linux envvar to control whether to add/set a "console="
740  * parameter to the command line
741  *
742  * @buf: Buffer containing the string to process
743  * @maxlen: Maximum length of buffer
744  * Return: 0 if OK, -ENOSPC if @maxlen is too small
745  */
746 static int fixup_silent_linux(char *buf, int maxlen)
747 {
748         int want_silent;
749         char *cmdline;
750         int size;
751
752         /*
753          * Move the input string to the end of buffer. The output string will be
754          * built up at the start.
755          */
756         size = strlen(buf) + 1;
757         if (size * 2 > maxlen)
758                 return -ENOSPC;
759         cmdline = buf + maxlen - size;
760         memmove(cmdline, buf, size);
761         /*
762          * Only fix cmdline when requested. The environment variable can be:
763          *
764          *      no - we never fixup
765          *      yes - we always fixup
766          *      unset - we rely on the console silent flag
767          */
768         want_silent = env_get_yesno("silent_linux");
769         if (want_silent == 0)
770                 return 0;
771         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
772                 return 0;
773
774         debug("before silent fix-up: %s\n", cmdline);
775         if (*cmdline) {
776                 char *start = strstr(cmdline, CONSOLE_ARG);
777
778                 /* Check space for maximum possible new command line */
779                 if (size + CONSOLE_ARG_SIZE > maxlen)
780                         return -ENOSPC;
781
782                 if (start) {
783                         char *end = strchr(start, ' ');
784                         int start_bytes;
785
786                         start_bytes = start - cmdline;
787                         strncpy(buf, cmdline, start_bytes);
788                         strncpy(buf + start_bytes, NULL_CONSOLE, CONSOLE_ARG_SIZE);
789                         if (end)
790                                 strcpy(buf + start_bytes + CONSOLE_ARG_SIZE - 1, end);
791                         else
792                                 buf[start_bytes + CONSOLE_ARG_SIZE] = '\0';
793                 } else {
794                         sprintf(buf, "%s %s", cmdline, NULL_CONSOLE);
795                 }
796                 if (buf + strlen(buf) >= cmdline)
797                         return -ENOSPC;
798         } else {
799                 if (maxlen < CONSOLE_ARG_SIZE)
800                         return -ENOSPC;
801                 strcpy(buf, NULL_CONSOLE);
802         }
803         debug("after silent fix-up: %s\n", buf);
804
805         return 0;
806 }
807
808 /**
809  * process_subst() - Handle substitution of ${...} fields in the environment
810  *
811  * Handle variable substitution in the provided buffer
812  *
813  * @buf: Buffer containing the string to process
814  * @maxlen: Maximum length of buffer
815  * Return: 0 if OK, -ENOSPC if @maxlen is too small
816  */
817 static int process_subst(char *buf, int maxlen)
818 {
819         char *cmdline;
820         int size;
821         int ret;
822
823         /* Move to end of buffer */
824         size = strlen(buf) + 1;
825         cmdline = buf + maxlen - size;
826         if (buf + size > cmdline)
827                 return -ENOSPC;
828         memmove(cmdline, buf, size);
829
830         ret = cli_simple_process_macros(cmdline, buf, cmdline - buf);
831
832         return ret;
833 }
834
835 int bootm_process_cmdline(char *buf, int maxlen, int flags)
836 {
837         int ret;
838
839         /* Check config first to enable compiler to eliminate code */
840         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
841             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) &&
842             (flags & BOOTM_CL_SILENT)) {
843                 ret = fixup_silent_linux(buf, maxlen);
844                 if (ret)
845                         return log_msg_ret("silent", ret);
846         }
847         if (IS_ENABLED(CONFIG_BOOTARGS_SUBST) && IS_ENABLED(CONFIG_CMDLINE) &&
848             (flags & BOOTM_CL_SUBST)) {
849                 ret = process_subst(buf, maxlen);
850                 if (ret)
851                         return log_msg_ret("subst", ret);
852         }
853
854         return 0;
855 }
856
857 int bootm_process_cmdline_env(int flags)
858 {
859         const int maxlen = MAX_CMDLINE_SIZE;
860         bool do_silent;
861         const char *env;
862         char *buf;
863         int ret;
864
865         /* First check if any action is needed */
866         do_silent = IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
867             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) && (flags & BOOTM_CL_SILENT);
868         if (!do_silent && !IS_ENABLED(CONFIG_BOOTARGS_SUBST))
869                 return 0;
870
871         env = env_get("bootargs");
872         if (env && strlen(env) >= maxlen)
873                 return -E2BIG;
874         buf = malloc(maxlen);
875         if (!buf)
876                 return -ENOMEM;
877         if (env)
878                 strcpy(buf, env);
879         else
880                 *buf = '\0';
881         ret = bootm_process_cmdline(buf, maxlen, flags);
882         if (!ret) {
883                 ret = env_set("bootargs", buf);
884
885                 /*
886                  * If buf is "" and bootargs does not exist, this will produce
887                  * an error trying to delete bootargs. Ignore it
888                  */
889                 if (ret == -ENOENT)
890                         ret = 0;
891         }
892         free(buf);
893         if (ret)
894                 return log_msg_ret("env", ret);
895
896         return 0;
897 }
898
899 int bootm_measure(struct bootm_headers *images)
900 {
901         int ret = 0;
902
903         /* Skip measurement if EFI is going to do it */
904         if (images->os.os == IH_OS_EFI &&
905             IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL) &&
906             IS_ENABLED(CONFIG_BOOTM_EFI))
907                 return ret;
908
909         if (IS_ENABLED(CONFIG_MEASURED_BOOT)) {
910                 struct tcg2_event_log elog;
911                 struct udevice *dev;
912                 void *initrd_buf;
913                 void *image_buf;
914                 const char *s;
915                 u32 rd_len;
916                 bool ign;
917
918                 elog.log_size = 0;
919                 ign = IS_ENABLED(CONFIG_MEASURE_IGNORE_LOG);
920                 ret = tcg2_measurement_init(&dev, &elog, ign);
921                 if (ret)
922                         return ret;
923
924                 image_buf = map_sysmem(images->os.image_start,
925                                        images->os.image_len);
926                 ret = tcg2_measure_data(dev, &elog, 8, images->os.image_len,
927                                         image_buf, EV_COMPACT_HASH,
928                                         strlen("linux") + 1, (u8 *)"linux");
929                 if (ret)
930                         goto unmap_image;
931
932                 rd_len = images->rd_end - images->rd_start;
933                 initrd_buf = map_sysmem(images->rd_start, rd_len);
934                 ret = tcg2_measure_data(dev, &elog, 9, rd_len, initrd_buf,
935                                         EV_COMPACT_HASH, strlen("initrd") + 1,
936                                         (u8 *)"initrd");
937                 if (ret)
938                         goto unmap_initrd;
939
940                 if (IS_ENABLED(CONFIG_MEASURE_DEVICETREE)) {
941                         ret = tcg2_measure_data(dev, &elog, 0, images->ft_len,
942                                                 (u8 *)images->ft_addr,
943                                                 EV_TABLE_OF_DEVICES,
944                                                 strlen("dts") + 1,
945                                                 (u8 *)"dts");
946                         if (ret)
947                                 goto unmap_initrd;
948                 }
949
950                 s = env_get("bootargs");
951                 if (!s)
952                         s = "";
953                 ret = tcg2_measure_data(dev, &elog, 1, strlen(s) + 1, (u8 *)s,
954                                         EV_PLATFORM_CONFIG_FLAGS,
955                                         strlen(s) + 1, (u8 *)s);
956
957 unmap_initrd:
958                 unmap_sysmem(initrd_buf);
959
960 unmap_image:
961                 unmap_sysmem(image_buf);
962                 tcg2_measurement_term(dev, &elog, ret != 0);
963         }
964
965         return ret;
966 }
967
968 /**
969  * Execute selected states of the bootm command.
970  *
971  * Note the arguments to this state must be the first argument, Any 'bootm'
972  * or sub-command arguments must have already been taken.
973  *
974  * Note that if states contains more than one flag it MUST contain
975  * BOOTM_STATE_START, since this handles and consumes the command line args.
976  *
977  * Also note that aside from boot_os_fn functions and bootm_load_os no other
978  * functions we store the return value of in 'ret' may use a negative return
979  * value, without special handling.
980  *
981  * @param cmdtp         Pointer to bootm command table entry
982  * @param flag          Command flags (CMD_FLAG_...)
983  * @param argc          Number of subcommand arguments (0 = no arguments)
984  * @param argv          Arguments
985  * @param states        Mask containing states to run (BOOTM_STATE_...)
986  * @param images        Image header information
987  * @param boot_progress 1 to show boot progress, 0 to not do this
988  * Return: 0 if ok, something else on error. Some errors will cause this
989  *      function to perform a reboot! If states contains BOOTM_STATE_OS_GO
990  *      then the intent is to boot an OS, so this function will not return
991  *      unless the image type is standalone.
992  */
993 int do_bootm_states(struct cmd_tbl *cmdtp, int flag, int argc,
994                     char *const argv[], int states, struct bootm_headers *images,
995                     int boot_progress)
996 {
997         boot_os_fn *boot_fn;
998         ulong iflag = 0;
999         int ret = 0, need_boot_fn;
1000
1001         images->state |= states;
1002
1003         /*
1004          * Work through the states and see how far we get. We stop on
1005          * any error.
1006          */
1007         if (states & BOOTM_STATE_START)
1008                 ret = bootm_start();
1009
1010         if (!ret && (states & BOOTM_STATE_PRE_LOAD))
1011                 ret = bootm_pre_load(argv[0]);
1012
1013         if (!ret && (states & BOOTM_STATE_FINDOS))
1014                 ret = bootm_find_os(cmdtp->name, argv[0]);
1015
1016         if (!ret && (states & BOOTM_STATE_FINDOTHER))
1017                 ret = bootm_find_other(cmdtp, flag, argc, argv);
1018
1019         if (IS_ENABLED(CONFIG_MEASURED_BOOT) && !ret &&
1020             (states & BOOTM_STATE_MEASURE))
1021                 bootm_measure(images);
1022
1023         /* Load the OS */
1024         if (!ret && (states & BOOTM_STATE_LOADOS)) {
1025                 iflag = bootm_disable_interrupts();
1026                 ret = bootm_load_os(images, 0);
1027                 if (ret && ret != BOOTM_ERR_OVERLAP)
1028                         goto err;
1029                 else if (ret == BOOTM_ERR_OVERLAP)
1030                         ret = 0;
1031         }
1032
1033         /* Relocate the ramdisk */
1034 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1035         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
1036                 ulong rd_len = images->rd_end - images->rd_start;
1037
1038                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
1039                         rd_len, &images->initrd_start, &images->initrd_end);
1040                 if (!ret) {
1041                         env_set_hex("initrd_start", images->initrd_start);
1042                         env_set_hex("initrd_end", images->initrd_end);
1043                 }
1044         }
1045 #endif
1046 #if CONFIG_IS_ENABLED(OF_LIBFDT) && defined(CONFIG_LMB)
1047         if (!ret && (states & BOOTM_STATE_FDT)) {
1048                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
1049                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
1050                                         &images->ft_len);
1051         }
1052 #endif
1053
1054         /* From now on, we need the OS boot function */
1055         if (ret)
1056                 return ret;
1057         boot_fn = bootm_os_get_boot_func(images->os.os);
1058         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
1059                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
1060                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
1061         if (boot_fn == NULL && need_boot_fn) {
1062                 if (iflag)
1063                         enable_interrupts();
1064                 printf("ERROR: booting os '%s' (%d) is not supported\n",
1065                        genimg_get_os_name(images->os.os), images->os.os);
1066                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
1067                 return 1;
1068         }
1069
1070
1071         /* Call various other states that are not generally used */
1072         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
1073                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, argc, argv, images);
1074         if (!ret && (states & BOOTM_STATE_OS_BD_T))
1075                 ret = boot_fn(BOOTM_STATE_OS_BD_T, argc, argv, images);
1076         if (!ret && (states & BOOTM_STATE_OS_PREP)) {
1077                 ret = bootm_process_cmdline_env(images->os.os == IH_OS_LINUX);
1078                 if (ret) {
1079                         printf("Cmdline setup failed (err=%d)\n", ret);
1080                         ret = CMD_RET_FAILURE;
1081                         goto err;
1082                 }
1083                 ret = boot_fn(BOOTM_STATE_OS_PREP, argc, argv, images);
1084         }
1085
1086 #ifdef CONFIG_TRACE
1087         /* Pretend to run the OS, then run a user command */
1088         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
1089                 char *cmd_list = env_get("fakegocmd");
1090
1091                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_FAKE_GO,
1092                                 images, boot_fn);
1093                 if (!ret && cmd_list)
1094                         ret = run_command_list(cmd_list, -1, flag);
1095         }
1096 #endif
1097
1098         /* Check for unsupported subcommand. */
1099         if (ret) {
1100                 printf("subcommand failed (err=%d)\n", ret);
1101                 return ret;
1102         }
1103
1104         /* Now run the OS! We hope this doesn't return */
1105         if (!ret && (states & BOOTM_STATE_OS_GO))
1106                 ret = boot_selected_os(argc, argv, BOOTM_STATE_OS_GO,
1107                                 images, boot_fn);
1108
1109         /* Deal with any fallout */
1110 err:
1111         if (iflag)
1112                 enable_interrupts();
1113
1114         if (ret == BOOTM_ERR_UNIMPLEMENTED)
1115                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
1116         else if (ret == BOOTM_ERR_RESET)
1117                 do_reset(cmdtp, flag, argc, argv);
1118
1119         return ret;
1120 }
1121
1122 int bootm_boot_start(ulong addr, const char *cmdline)
1123 {
1124         static struct cmd_tbl cmd = {"bootm"};
1125         char addr_str[30];
1126         char *argv[] = {addr_str, NULL};
1127         int states;
1128         int ret;
1129
1130         /*
1131          * TODO([email protected]): This uses the command-line interface, but
1132          * should not. To clean this up, the various bootm states need to be
1133          * passed an info structure instead of cmdline flags. Then this can
1134          * set up the required info and move through the states without needing
1135          * the command line.
1136          */
1137         states = BOOTM_STATE_START | BOOTM_STATE_FINDOS | BOOTM_STATE_PRE_LOAD |
1138                 BOOTM_STATE_FINDOTHER | BOOTM_STATE_LOADOS |
1139                 BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
1140                 BOOTM_STATE_OS_GO;
1141         if (IS_ENABLED(CONFIG_SYS_BOOT_RAMDISK_HIGH))
1142                 states |= BOOTM_STATE_RAMDISK;
1143         if (IS_ENABLED(CONFIG_PPC) || IS_ENABLED(CONFIG_MIPS))
1144                 states |= BOOTM_STATE_OS_CMDLINE;
1145         images.state |= states;
1146
1147         snprintf(addr_str, sizeof(addr_str), "%lx", addr);
1148
1149         ret = env_set("bootargs", cmdline);
1150         if (ret) {
1151                 printf("Failed to set cmdline\n");
1152                 return ret;
1153         }
1154         ret = do_bootm_states(&cmd, 0, 1, argv, states, &images, 1);
1155
1156         return ret;
1157 }
1158
1159 /**
1160  * switch_to_non_secure_mode() - switch to non-secure mode
1161  *
1162  * This routine is overridden by architectures requiring this feature.
1163  */
1164 void __weak switch_to_non_secure_mode(void)
1165 {
1166 }
1167
1168 #else /* USE_HOSTCC */
1169
1170 #if defined(CONFIG_FIT_SIGNATURE)
1171 static int bootm_host_load_image(const void *fit, int req_image_type,
1172                                  int cfg_noffset)
1173 {
1174         const char *fit_uname_config = NULL;
1175         ulong data, len;
1176         struct bootm_headers images;
1177         int noffset;
1178         ulong load_end, buf_size;
1179         uint8_t image_type;
1180         uint8_t image_comp;
1181         void *load_buf;
1182         int ret;
1183
1184         fit_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
1185         memset(&images, '\0', sizeof(images));
1186         images.verify = 1;
1187         noffset = fit_image_load(&images, (ulong)fit,
1188                 NULL, &fit_uname_config,
1189                 IH_ARCH_DEFAULT, req_image_type, -1,
1190                 FIT_LOAD_IGNORED, &data, &len);
1191         if (noffset < 0)
1192                 return noffset;
1193         if (fit_image_get_type(fit, noffset, &image_type)) {
1194                 puts("Can't get image type!\n");
1195                 return -EINVAL;
1196         }
1197
1198         if (fit_image_get_comp(fit, noffset, &image_comp))
1199                 image_comp = IH_COMP_NONE;
1200
1201         /* Allow the image to expand by a factor of 4, should be safe */
1202         buf_size = (1 << 20) + len * 4;
1203         load_buf = malloc(buf_size);
1204         ret = image_decomp(image_comp, 0, data, image_type, load_buf,
1205                            (void *)data, len, buf_size, &load_end);
1206         free(load_buf);
1207
1208         if (ret) {
1209                 ret = handle_decomp_error(image_comp, load_end - 0, buf_size, ret);
1210                 if (ret != BOOTM_ERR_UNIMPLEMENTED)
1211                         return ret;
1212         }
1213
1214         return 0;
1215 }
1216
1217 int bootm_host_load_images(const void *fit, int cfg_noffset)
1218 {
1219         static uint8_t image_types[] = {
1220                 IH_TYPE_KERNEL,
1221                 IH_TYPE_FLATDT,
1222                 IH_TYPE_RAMDISK,
1223         };
1224         int err = 0;
1225         int i;
1226
1227         for (i = 0; i < ARRAY_SIZE(image_types); i++) {
1228                 int ret;
1229
1230                 ret = bootm_host_load_image(fit, image_types[i], cfg_noffset);
1231                 if (!err && ret && ret != -ENOENT)
1232                         err = ret;
1233         }
1234
1235         /* Return the first error we found */
1236         return err;
1237 }
1238 #endif
1239
1240 #endif /* ndef USE_HOSTCC */
This page took 0.09857 seconds and 4 git commands to generate.