]> Git Repo - J-u-boot.git/blob - boot/bootm.c
Merge patch series "arm64: add a software pagetable walker"
[J-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 <bootm.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         phys_addr_t     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, 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                 images.os.load = images.os.image_start;
447                 images.ep += images.os.image_start;
448         }
449
450         images.os.start = map_to_sysmem(os_hdr);
451
452         return 0;
453 }
454
455 /**
456  * check_overlap() - Check if an image overlaps the OS
457  *
458  * @name: Name of image to check (used to print error)
459  * @base: Base address of image
460  * @end: End address of image (+1)
461  * @os_start: Start of OS
462  * @os_size: Size of OS in bytes
463  * Return: 0 if OK, -EXDEV if the image overlaps the OS
464  */
465 static int check_overlap(const char *name, ulong base, ulong end,
466                          ulong os_start, ulong os_size)
467 {
468         ulong os_end;
469
470         if (!base)
471                 return 0;
472         os_end = os_start + os_size;
473
474         if ((base >= os_start && base < os_end) ||
475             (end > os_start && end <= os_end) ||
476             (base < os_start && end >= os_end)) {
477                 printf("ERROR: %s image overlaps OS image (OS=%lx..%lx)\n",
478                        name, os_start, os_end);
479
480                 return -EXDEV;
481         }
482
483         return 0;
484 }
485
486 int bootm_find_images(ulong img_addr, const char *conf_ramdisk,
487                       const char *conf_fdt, ulong start, ulong size)
488 {
489         const char *select = conf_ramdisk;
490         char addr_str[17];
491         void *buf;
492         int ret;
493
494         if (IS_ENABLED(CONFIG_ANDROID_BOOT_IMAGE)) {
495                 /* Look for an Android boot image */
496                 buf = map_sysmem(images.os.start, 0);
497                 if (buf && genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
498                         strcpy(addr_str, simple_xtoa(img_addr));
499                         select = addr_str;
500                 }
501         }
502
503         if (conf_ramdisk)
504                 select = conf_ramdisk;
505
506         /* find ramdisk */
507         ret = boot_get_ramdisk(select, &images, IH_INITRD_ARCH,
508                                &images.rd_start, &images.rd_end);
509         if (ret) {
510                 puts("Ramdisk image is corrupt or invalid\n");
511                 return 1;
512         }
513
514         /* check if ramdisk overlaps OS image */
515         if (check_overlap("RD", images.rd_start, images.rd_end, start, size))
516                 return 1;
517
518         if (CONFIG_IS_ENABLED(OF_LIBFDT)) {
519                 buf = map_sysmem(img_addr, 0);
520
521                 /* find flattened device tree */
522                 ret = boot_get_fdt(buf, conf_fdt, IH_ARCH_DEFAULT, &images,
523                                    &images.ft_addr, &images.ft_len);
524                 if (ret) {
525                         puts("Could not find a valid device tree\n");
526                         return 1;
527                 }
528
529                 /* check if FDT overlaps OS image */
530                 if (check_overlap("FDT", map_to_sysmem(images.ft_addr),
531                                   images.ft_len, start, size))
532                         return 1;
533
534                 if (IS_ENABLED(CONFIG_CMD_FDT))
535                         set_working_fdt_addr(map_to_sysmem(images.ft_addr));
536         }
537
538 #if CONFIG_IS_ENABLED(FIT)
539         if (IS_ENABLED(CONFIG_FPGA)) {
540                 /* find bitstreams */
541                 ret = boot_get_fpga(&images);
542                 if (ret) {
543                         printf("FPGA image is corrupted or invalid\n");
544                         return 1;
545                 }
546         }
547
548         /* find all of the loadables */
549         ret = boot_get_loadable(&images);
550         if (ret) {
551                 printf("Loadable(s) is corrupt or invalid\n");
552                 return 1;
553         }
554 #endif
555
556         return 0;
557 }
558
559 static int bootm_find_other(ulong img_addr, const char *conf_ramdisk,
560                             const char *conf_fdt)
561 {
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 || images.os.os == IH_OS_VXWORKS ||
566              images.os.os == IH_OS_EFI || images.os.os == IH_OS_TEE)) {
567                 return bootm_find_images(img_addr, conf_ramdisk, conf_fdt, 0,
568                                          0);
569         }
570
571         return 0;
572 }
573 #endif /* USE_HOSTC */
574
575 #if !defined(USE_HOSTCC) || defined(CONFIG_FIT_SIGNATURE)
576 /**
577  * handle_decomp_error() - display a decompression error
578  *
579  * This function tries to produce a useful message. In the case where the
580  * uncompressed size is the same as the available space, we can assume that
581  * the image is too large for the buffer.
582  *
583  * @comp_type:          Compression type being used (IH_COMP_...)
584  * @uncomp_size:        Number of bytes uncompressed
585  * @buf_size:           Number of bytes the decompresion buffer was
586  * @ret:                errno error code received from compression library
587  * Return: Appropriate BOOTM_ERR_ error code
588  */
589 static int handle_decomp_error(int comp_type, size_t uncomp_size,
590                                size_t buf_size, int ret)
591 {
592         const char *name = genimg_get_comp_name(comp_type);
593
594         /* ENOSYS means unimplemented compression type, don't reset. */
595         if (ret == -ENOSYS)
596                 return BOOTM_ERR_UNIMPLEMENTED;
597
598         if (uncomp_size >= buf_size)
599                 printf("Image too large: increase CONFIG_SYS_BOOTM_LEN\n");
600         else
601                 printf("%s: uncompress error %d\n", name, ret);
602
603         /*
604          * The decompression routines are now safe, so will not write beyond
605          * their bounds. Probably it is not necessary to reset, but maintain
606          * the current behaviour for now.
607          */
608         printf("Must RESET board to recover\n");
609 #ifndef USE_HOSTCC
610         bootstage_error(BOOTSTAGE_ID_DECOMP_IMAGE);
611 #endif
612
613         return BOOTM_ERR_RESET;
614 }
615 #endif
616
617 #ifndef USE_HOSTCC
618 static int bootm_load_os(struct bootm_headers *images, int boot_progress)
619 {
620         struct image_info os = images->os;
621         ulong load = os.load;
622         ulong load_end;
623         ulong blob_start = os.start;
624         ulong blob_end = os.end;
625         ulong image_start = os.image_start;
626         ulong image_len = os.image_len;
627         ulong flush_start = ALIGN_DOWN(load, ARCH_DMA_MINALIGN);
628         bool no_overlap;
629         void *load_buf, *image_buf;
630         int err;
631
632         /*
633          * For a "noload" compressed kernel we need to allocate a buffer large
634          * enough to decompress in to and use that as the load address now.
635          * Assume that the kernel compression is at most a factor of 4 since
636          * zstd almost achieves that.
637          * Use an alignment of 2MB since this might help arm64
638          */
639         if (os.type == IH_TYPE_KERNEL_NOLOAD && os.comp != IH_COMP_NONE) {
640                 ulong req_size = ALIGN(image_len * 4, SZ_1M);
641
642                 load = lmb_alloc(&images->lmb, req_size, SZ_2M);
643                 if (!load)
644                         return 1;
645                 os.load = load;
646                 images->ep = load;
647                 debug("Allocated %lx bytes at %lx for kernel (size %lx) decompression\n",
648                       req_size, load, image_len);
649         }
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         if (IS_ENABLED(CONFIG_CMD_BOOTI) && images->os.arch == IH_ARCH_ARM64 &&
692             images->os.os == IH_OS_LINUX) {
693                 ulong relocated_addr;
694                 ulong image_size;
695                 int ret;
696
697                 ret = booti_setup(load, &relocated_addr, &image_size, false);
698                 if (ret) {
699                         printf("Failed to prep arm64 kernel (err=%d)\n", ret);
700                         return BOOTM_ERR_RESET;
701                 }
702
703                 /* Handle BOOTM_STATE_LOADOS */
704                 if (relocated_addr != load) {
705                         printf("Moving Image from 0x%lx to 0x%lx, end=%lx\n",
706                                load, relocated_addr,
707                                relocated_addr + image_size);
708                         memmove((void *)relocated_addr, load_buf, image_size);
709                 }
710
711                 images->ep = relocated_addr;
712                 images->os.start = relocated_addr;
713                 images->os.end = relocated_addr + image_size;
714         }
715
716         lmb_reserve(&images->lmb, images->os.load, (load_end -
717                                                     images->os.load));
718         return 0;
719 }
720
721 /**
722  * bootm_disable_interrupts() - Disable interrupts in preparation for load/boot
723  *
724  * Return: interrupt flag (0 if interrupts were disabled, non-zero if they were
725  *      enabled)
726  */
727 ulong bootm_disable_interrupts(void)
728 {
729         ulong iflag;
730
731         /*
732          * We have reached the point of no return: we are going to
733          * overwrite all exception vector code, so we cannot easily
734          * recover from any failures any more...
735          */
736         iflag = disable_interrupts();
737 #ifdef CONFIG_NETCONSOLE
738         /* Stop the ethernet stack if NetConsole could have left it up */
739         eth_halt();
740 #endif
741
742 #if defined(CONFIG_CMD_USB)
743         /*
744          * turn off USB to prevent the host controller from writing to the
745          * SDRAM while Linux is booting. This could happen (at least for OHCI
746          * controller), because the HCCA (Host Controller Communication Area)
747          * lies within the SDRAM and the host controller writes continously to
748          * this area (as busmaster!). The HccaFrameNumber is for example
749          * updated every 1 ms within the HCCA structure in SDRAM! For more
750          * details see the OpenHCI specification.
751          */
752         usb_stop();
753 #endif
754         return iflag;
755 }
756
757 #define CONSOLE_ARG             "console="
758 #define NULL_CONSOLE            (CONSOLE_ARG "ttynull")
759 #define CONSOLE_ARG_SIZE        sizeof(NULL_CONSOLE)
760
761 /**
762  * fixup_silent_linux() - Handle silencing the linux boot if required
763  *
764  * This uses the silent_linux envvar to control whether to add/set a "console="
765  * parameter to the command line
766  *
767  * @buf: Buffer containing the string to process
768  * @maxlen: Maximum length of buffer
769  * Return: 0 if OK, -ENOSPC if @maxlen is too small
770  */
771 static int fixup_silent_linux(char *buf, int maxlen)
772 {
773         int want_silent;
774         char *cmdline;
775         int size;
776
777         /*
778          * Move the input string to the end of buffer. The output string will be
779          * built up at the start.
780          */
781         size = strlen(buf) + 1;
782         if (size * 2 > maxlen)
783                 return -ENOSPC;
784         cmdline = buf + maxlen - size;
785         memmove(cmdline, buf, size);
786         /*
787          * Only fix cmdline when requested. The environment variable can be:
788          *
789          *      no - we never fixup
790          *      yes - we always fixup
791          *      unset - we rely on the console silent flag
792          */
793         want_silent = env_get_yesno("silent_linux");
794         if (want_silent == 0)
795                 return 0;
796         else if (want_silent == -1 && !(gd->flags & GD_FLG_SILENT))
797                 return 0;
798
799         debug("before silent fix-up: %s\n", cmdline);
800         if (*cmdline) {
801                 char *start = strstr(cmdline, CONSOLE_ARG);
802
803                 /* Check space for maximum possible new command line */
804                 if (size + CONSOLE_ARG_SIZE > maxlen)
805                         return -ENOSPC;
806
807                 if (start) {
808                         char *end = strchr(start, ' ');
809                         int start_bytes;
810
811                         start_bytes = start - cmdline;
812                         strncpy(buf, cmdline, start_bytes);
813                         strncpy(buf + start_bytes, NULL_CONSOLE, CONSOLE_ARG_SIZE);
814                         if (end)
815                                 strcpy(buf + start_bytes + CONSOLE_ARG_SIZE - 1, end);
816                         else
817                                 buf[start_bytes + CONSOLE_ARG_SIZE] = '\0';
818                 } else {
819                         sprintf(buf, "%s %s", cmdline, NULL_CONSOLE);
820                 }
821                 if (buf + strlen(buf) >= cmdline)
822                         return -ENOSPC;
823         } else {
824                 if (maxlen < CONSOLE_ARG_SIZE)
825                         return -ENOSPC;
826                 strcpy(buf, NULL_CONSOLE);
827         }
828         debug("after silent fix-up: %s\n", buf);
829
830         return 0;
831 }
832
833 /**
834  * process_subst() - Handle substitution of ${...} fields in the environment
835  *
836  * Handle variable substitution in the provided buffer
837  *
838  * @buf: Buffer containing the string to process
839  * @maxlen: Maximum length of buffer
840  * Return: 0 if OK, -ENOSPC if @maxlen is too small
841  */
842 static int process_subst(char *buf, int maxlen)
843 {
844         char *cmdline;
845         int size;
846         int ret;
847
848         /* Move to end of buffer */
849         size = strlen(buf) + 1;
850         cmdline = buf + maxlen - size;
851         if (buf + size > cmdline)
852                 return -ENOSPC;
853         memmove(cmdline, buf, size);
854
855         ret = cli_simple_process_macros(cmdline, buf, cmdline - buf);
856
857         return ret;
858 }
859
860 int bootm_process_cmdline(char *buf, int maxlen, int flags)
861 {
862         int ret;
863
864         /* Check config first to enable compiler to eliminate code */
865         if (IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
866             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) &&
867             (flags & BOOTM_CL_SILENT)) {
868                 ret = fixup_silent_linux(buf, maxlen);
869                 if (ret)
870                         return log_msg_ret("silent", ret);
871         }
872         if (IS_ENABLED(CONFIG_BOOTARGS_SUBST) && IS_ENABLED(CONFIG_CMDLINE) &&
873             (flags & BOOTM_CL_SUBST)) {
874                 ret = process_subst(buf, maxlen);
875                 if (ret)
876                         return log_msg_ret("subst", ret);
877         }
878
879         return 0;
880 }
881
882 int bootm_process_cmdline_env(int flags)
883 {
884         const int maxlen = MAX_CMDLINE_SIZE;
885         bool do_silent;
886         const char *env;
887         char *buf;
888         int ret;
889
890         /* First check if any action is needed */
891         do_silent = IS_ENABLED(CONFIG_SILENT_CONSOLE) &&
892             !IS_ENABLED(CONFIG_SILENT_U_BOOT_ONLY) && (flags & BOOTM_CL_SILENT);
893         if (!do_silent && !IS_ENABLED(CONFIG_BOOTARGS_SUBST))
894                 return 0;
895
896         env = env_get("bootargs");
897         if (env && strlen(env) >= maxlen)
898                 return -E2BIG;
899         buf = malloc(maxlen);
900         if (!buf)
901                 return -ENOMEM;
902         if (env)
903                 strcpy(buf, env);
904         else
905                 *buf = '\0';
906         ret = bootm_process_cmdline(buf, maxlen, flags);
907         if (!ret) {
908                 ret = env_set("bootargs", buf);
909
910                 /*
911                  * If buf is "" and bootargs does not exist, this will produce
912                  * an error trying to delete bootargs. Ignore it
913                  */
914                 if (ret == -ENOENT)
915                         ret = 0;
916         }
917         free(buf);
918         if (ret)
919                 return log_msg_ret("env", ret);
920
921         return 0;
922 }
923
924 int bootm_measure(struct bootm_headers *images)
925 {
926         int ret = 0;
927
928         /* Skip measurement if EFI is going to do it */
929         if (images->os.os == IH_OS_EFI &&
930             IS_ENABLED(CONFIG_EFI_TCG2_PROTOCOL) &&
931             IS_ENABLED(CONFIG_BOOTM_EFI))
932                 return ret;
933
934         if (IS_ENABLED(CONFIG_MEASURED_BOOT)) {
935                 struct tcg2_event_log elog;
936                 struct udevice *dev;
937                 void *initrd_buf;
938                 void *image_buf;
939                 const char *s;
940                 u32 rd_len;
941                 bool ign;
942
943                 elog.log_size = 0;
944                 ign = IS_ENABLED(CONFIG_MEASURE_IGNORE_LOG);
945                 ret = tcg2_measurement_init(&dev, &elog, ign);
946                 if (ret)
947                         return ret;
948
949                 image_buf = map_sysmem(images->os.image_start,
950                                        images->os.image_len);
951                 ret = tcg2_measure_data(dev, &elog, 8, images->os.image_len,
952                                         image_buf, EV_COMPACT_HASH,
953                                         strlen("linux") + 1, (u8 *)"linux");
954                 if (ret)
955                         goto unmap_image;
956
957                 rd_len = images->rd_end - images->rd_start;
958                 initrd_buf = map_sysmem(images->rd_start, rd_len);
959                 ret = tcg2_measure_data(dev, &elog, 9, rd_len, initrd_buf,
960                                         EV_COMPACT_HASH, strlen("initrd") + 1,
961                                         (u8 *)"initrd");
962                 if (ret)
963                         goto unmap_initrd;
964
965                 if (IS_ENABLED(CONFIG_MEASURE_DEVICETREE)) {
966                         ret = tcg2_measure_data(dev, &elog, 1, images->ft_len,
967                                                 (u8 *)images->ft_addr,
968                                                 EV_TABLE_OF_DEVICES,
969                                                 strlen("dts") + 1,
970                                                 (u8 *)"dts");
971                         if (ret)
972                                 goto unmap_initrd;
973                 }
974
975                 s = env_get("bootargs");
976                 if (!s)
977                         s = "";
978                 ret = tcg2_measure_data(dev, &elog, 1, strlen(s) + 1, (u8 *)s,
979                                         EV_PLATFORM_CONFIG_FLAGS,
980                                         strlen(s) + 1, (u8 *)s);
981
982 unmap_initrd:
983                 unmap_sysmem(initrd_buf);
984
985 unmap_image:
986                 unmap_sysmem(image_buf);
987                 tcg2_measurement_term(dev, &elog, ret != 0);
988         }
989
990         return ret;
991 }
992
993 int bootm_run_states(struct bootm_info *bmi, int states)
994 {
995         struct bootm_headers *images = bmi->images;
996         boot_os_fn *boot_fn;
997         ulong iflag = 0;
998         int ret = 0, need_boot_fn;
999
1000         images->state |= states;
1001
1002         /*
1003          * Work through the states and see how far we get. We stop on
1004          * any error.
1005          */
1006         if (states & BOOTM_STATE_START)
1007                 ret = bootm_start();
1008
1009         if (!ret && (states & BOOTM_STATE_PRE_LOAD))
1010                 ret = bootm_pre_load(bmi->addr_img);
1011
1012         if (!ret && (states & BOOTM_STATE_FINDOS))
1013                 ret = bootm_find_os(bmi->cmd_name, bmi->addr_img);
1014
1015         if (!ret && (states & BOOTM_STATE_FINDOTHER)) {
1016                 ulong img_addr;
1017
1018                 img_addr = bmi->addr_img ? hextoul(bmi->addr_img, NULL)
1019                         : image_load_addr;
1020                 ret = bootm_find_other(img_addr, bmi->conf_ramdisk,
1021                                        bmi->conf_fdt);
1022         }
1023
1024         if (IS_ENABLED(CONFIG_MEASURED_BOOT) && !ret &&
1025             (states & BOOTM_STATE_MEASURE))
1026                 bootm_measure(images);
1027
1028         /* Load the OS */
1029         if (!ret && (states & BOOTM_STATE_LOADOS)) {
1030                 iflag = bootm_disable_interrupts();
1031                 ret = bootm_load_os(images, 0);
1032                 if (ret && ret != BOOTM_ERR_OVERLAP)
1033                         goto err;
1034                 else if (ret == BOOTM_ERR_OVERLAP)
1035                         ret = 0;
1036         }
1037
1038         /* Relocate the ramdisk */
1039 #ifdef CONFIG_SYS_BOOT_RAMDISK_HIGH
1040         if (!ret && (states & BOOTM_STATE_RAMDISK)) {
1041                 ulong rd_len = images->rd_end - images->rd_start;
1042
1043                 ret = boot_ramdisk_high(&images->lmb, images->rd_start,
1044                         rd_len, &images->initrd_start, &images->initrd_end);
1045                 if (!ret) {
1046                         env_set_hex("initrd_start", images->initrd_start);
1047                         env_set_hex("initrd_end", images->initrd_end);
1048                 }
1049         }
1050 #endif
1051 #if CONFIG_IS_ENABLED(OF_LIBFDT) && defined(CONFIG_LMB)
1052         if (!ret && (states & BOOTM_STATE_FDT)) {
1053                 boot_fdt_add_mem_rsv_regions(&images->lmb, images->ft_addr);
1054                 ret = boot_relocate_fdt(&images->lmb, &images->ft_addr,
1055                                         &images->ft_len);
1056         }
1057 #endif
1058
1059         /* From now on, we need the OS boot function */
1060         if (ret)
1061                 return ret;
1062         boot_fn = bootm_os_get_boot_func(images->os.os);
1063         need_boot_fn = states & (BOOTM_STATE_OS_CMDLINE |
1064                         BOOTM_STATE_OS_BD_T | BOOTM_STATE_OS_PREP |
1065                         BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO);
1066         if (boot_fn == NULL && need_boot_fn) {
1067                 if (iflag)
1068                         enable_interrupts();
1069                 printf("ERROR: booting os '%s' (%d) is not supported\n",
1070                        genimg_get_os_name(images->os.os), images->os.os);
1071                 bootstage_error(BOOTSTAGE_ID_CHECK_BOOT_OS);
1072                 return 1;
1073         }
1074
1075         /* Call various other states that are not generally used */
1076         if (!ret && (states & BOOTM_STATE_OS_CMDLINE))
1077                 ret = boot_fn(BOOTM_STATE_OS_CMDLINE, bmi);
1078         if (!ret && (states & BOOTM_STATE_OS_BD_T))
1079                 ret = boot_fn(BOOTM_STATE_OS_BD_T, bmi);
1080         if (!ret && (states & BOOTM_STATE_OS_PREP)) {
1081                 int flags = 0;
1082                 /* For Linux OS do all substitutions at console processing */
1083                 if (images->os.os == IH_OS_LINUX)
1084                         flags = BOOTM_CL_ALL;
1085                 ret = bootm_process_cmdline_env(flags);
1086                 if (ret) {
1087                         printf("Cmdline setup failed (err=%d)\n", ret);
1088                         ret = CMD_RET_FAILURE;
1089                         goto err;
1090                 }
1091                 ret = boot_fn(BOOTM_STATE_OS_PREP, bmi);
1092         }
1093
1094 #ifdef CONFIG_TRACE
1095         /* Pretend to run the OS, then run a user command */
1096         if (!ret && (states & BOOTM_STATE_OS_FAKE_GO)) {
1097                 char *cmd_list = env_get("fakegocmd");
1098
1099                 ret = boot_selected_os(BOOTM_STATE_OS_FAKE_GO, bmi, boot_fn);
1100                 if (!ret && cmd_list)
1101                         ret = run_command_list(cmd_list, -1, 0);
1102         }
1103 #endif
1104
1105         /* Check for unsupported subcommand. */
1106         if (ret) {
1107                 printf("subcommand failed (err=%d)\n", ret);
1108                 return ret;
1109         }
1110
1111         /* Now run the OS! We hope this doesn't return */
1112         if (!ret && (states & BOOTM_STATE_OS_GO))
1113                 ret = boot_selected_os(BOOTM_STATE_OS_GO, bmi, boot_fn);
1114
1115         /* Deal with any fallout */
1116 err:
1117         if (iflag)
1118                 enable_interrupts();
1119
1120         if (ret == BOOTM_ERR_UNIMPLEMENTED) {
1121                 bootstage_error(BOOTSTAGE_ID_DECOMP_UNIMPL);
1122         } else if (ret == BOOTM_ERR_RESET) {
1123                 printf("Resetting the board...\n");
1124                 reset_cpu();
1125         }
1126
1127         return ret;
1128 }
1129
1130 int boot_run(struct bootm_info *bmi, const char *cmd, int extra_states)
1131 {
1132         int states;
1133
1134         bmi->cmd_name = cmd;
1135         states = BOOTM_STATE_MEASURE | BOOTM_STATE_OS_PREP |
1136                 BOOTM_STATE_OS_FAKE_GO | BOOTM_STATE_OS_GO;
1137         if (IS_ENABLED(CONFIG_SYS_BOOT_RAMDISK_HIGH))
1138                 states |= BOOTM_STATE_RAMDISK;
1139         states |= extra_states;
1140
1141         return bootm_run_states(bmi, states);
1142 }
1143
1144 int bootm_run(struct bootm_info *bmi)
1145 {
1146         return boot_run(bmi, "bootm", BOOTM_STATE_START | BOOTM_STATE_FINDOS |
1147                         BOOTM_STATE_PRE_LOAD | BOOTM_STATE_FINDOTHER |
1148                         BOOTM_STATE_LOADOS);
1149 }
1150
1151 int bootz_run(struct bootm_info *bmi)
1152 {
1153         return boot_run(bmi, "bootz", 0);
1154 }
1155
1156 int booti_run(struct bootm_info *bmi)
1157 {
1158         return boot_run(bmi, "booti", 0);
1159 }
1160
1161 int bootm_boot_start(ulong addr, const char *cmdline)
1162 {
1163         char addr_str[30];
1164         struct bootm_info bmi;
1165         int states;
1166         int ret;
1167
1168         states = BOOTM_STATE_START | BOOTM_STATE_FINDOS | BOOTM_STATE_PRE_LOAD |
1169                 BOOTM_STATE_FINDOTHER | BOOTM_STATE_LOADOS |
1170                 BOOTM_STATE_OS_PREP | BOOTM_STATE_OS_FAKE_GO |
1171                 BOOTM_STATE_OS_GO;
1172         if (IS_ENABLED(CONFIG_SYS_BOOT_RAMDISK_HIGH))
1173                 states |= BOOTM_STATE_RAMDISK;
1174         if (IS_ENABLED(CONFIG_PPC) || IS_ENABLED(CONFIG_MIPS))
1175                 states |= BOOTM_STATE_OS_CMDLINE;
1176         images.state |= states;
1177
1178         snprintf(addr_str, sizeof(addr_str), "%lx", addr);
1179
1180         ret = env_set("bootargs", cmdline);
1181         if (ret) {
1182                 printf("Failed to set cmdline\n");
1183                 return ret;
1184         }
1185         bootm_init(&bmi);
1186         bmi.addr_img = addr_str;
1187         bmi.cmd_name = "bootm";
1188         ret = bootm_run_states(&bmi, states);
1189
1190         return ret;
1191 }
1192
1193 void bootm_init(struct bootm_info *bmi)
1194 {
1195         memset(bmi, '\0', sizeof(struct bootm_info));
1196         bmi->boot_progress = true;
1197         if (IS_ENABLED(CONFIG_CMD_BOOTM))
1198                 bmi->images = &images;
1199 }
1200
1201 /**
1202  * switch_to_non_secure_mode() - switch to non-secure mode
1203  *
1204  * This routine is overridden by architectures requiring this feature.
1205  */
1206 void __weak switch_to_non_secure_mode(void)
1207 {
1208 }
1209
1210 #else /* USE_HOSTCC */
1211
1212 #if defined(CONFIG_FIT_SIGNATURE)
1213 static int bootm_host_load_image(const void *fit, int req_image_type,
1214                                  int cfg_noffset)
1215 {
1216         const char *fit_uname_config = NULL;
1217         ulong data, len;
1218         struct bootm_headers images;
1219         int noffset;
1220         ulong load_end, buf_size;
1221         uint8_t image_type;
1222         uint8_t image_comp;
1223         void *load_buf;
1224         int ret;
1225
1226         fit_uname_config = fdt_get_name(fit, cfg_noffset, NULL);
1227         memset(&images, '\0', sizeof(images));
1228         images.verify = 1;
1229         noffset = fit_image_load(&images, (ulong)fit,
1230                 NULL, &fit_uname_config,
1231                 IH_ARCH_DEFAULT, req_image_type, -1,
1232                 FIT_LOAD_IGNORED, &data, &len);
1233         if (noffset < 0)
1234                 return noffset;
1235         if (fit_image_get_type(fit, noffset, &image_type)) {
1236                 puts("Can't get image type!\n");
1237                 return -EINVAL;
1238         }
1239
1240         if (fit_image_get_comp(fit, noffset, &image_comp))
1241                 image_comp = IH_COMP_NONE;
1242
1243         /* Allow the image to expand by a factor of 4, should be safe */
1244         buf_size = (1 << 20) + len * 4;
1245         load_buf = malloc(buf_size);
1246         ret = image_decomp(image_comp, 0, data, image_type, load_buf,
1247                            (void *)data, len, buf_size, &load_end);
1248         free(load_buf);
1249
1250         if (ret) {
1251                 ret = handle_decomp_error(image_comp, load_end - 0, buf_size, ret);
1252                 if (ret != BOOTM_ERR_UNIMPLEMENTED)
1253                         return ret;
1254         }
1255
1256         return 0;
1257 }
1258
1259 int bootm_host_load_images(const void *fit, int cfg_noffset)
1260 {
1261         static uint8_t image_types[] = {
1262                 IH_TYPE_KERNEL,
1263                 IH_TYPE_FLATDT,
1264                 IH_TYPE_RAMDISK,
1265         };
1266         int err = 0;
1267         int i;
1268
1269         for (i = 0; i < ARRAY_SIZE(image_types); i++) {
1270                 int ret;
1271
1272                 ret = bootm_host_load_image(fit, image_types[i], cfg_noffset);
1273                 if (!err && ret && ret != -ENOENT)
1274                         err = ret;
1275         }
1276
1277         /* Return the first error we found */
1278         return err;
1279 }
1280 #endif
1281
1282 #endif /* ndef USE_HOSTCC */
This page took 0.101342 seconds and 4 git commands to generate.