1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013, Google Inc.
5 * (C) Copyright 2008 Semihalf
7 * (C) Copyright 2000-2006
8 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
12 #include <fdt_support.h>
20 #include <asm/global_data.h>
21 #include <linux/libfdt.h>
24 #include <tee/optee.h>
26 #ifndef CONFIG_SYS_FDT_PAD
27 #define CONFIG_SYS_FDT_PAD 0x3000
30 /* adding a ramdisk needs 0x44 bytes in version 2008.10 */
31 #define FDT_RAMDISK_OVERHEAD 0x80
33 DECLARE_GLOBAL_DATA_PTR;
35 static void fdt_error(const char *msg)
39 puts(" - must RESET the board to recover.\n");
42 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
43 static const image_header_t *image_get_fdt(ulong fdt_addr)
45 const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);
47 image_print_contents(fdt_hdr);
49 puts(" Verifying Checksum ... ");
50 if (!image_check_hcrc(fdt_hdr)) {
51 fdt_error("fdt header checksum invalid");
55 if (!image_check_dcrc(fdt_hdr)) {
56 fdt_error("fdt checksum invalid");
61 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
62 fdt_error("uImage is not a fdt");
65 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
66 fdt_error("uImage is compressed");
69 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
70 fdt_error("uImage data is not a fdt");
77 static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
78 uint64_t size, enum lmb_flags flags)
82 ret = lmb_reserve_flags(lmb, addr, size, flags);
84 debug(" reserving fdt memory region: addr=%llx size=%llx flags=%x\n",
85 (unsigned long long)addr,
86 (unsigned long long)size, flags);
88 puts("ERROR: reserving fdt memory region failed ");
89 printf("(addr=%llx size=%llx flags=%x)\n",
90 (unsigned long long)addr,
91 (unsigned long long)size, flags);
96 * boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
97 * sections as unusable
98 * @lmb: pointer to lmb handle, will be used for memory mgmt
99 * @fdt_blob: pointer to fdt blob base address
101 * Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
102 * Adding the memreserve regions prevents u-boot from using them to store the
103 * initrd or the fdt blob.
105 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
109 int nodeoffset, subnode;
110 struct fdt_resource res;
111 enum lmb_flags flags;
113 if (fdt_check_header(fdt_blob) != 0)
116 /* process memreserve sections */
117 total = fdt_num_mem_rsv(fdt_blob);
118 for (i = 0; i < total; i++) {
119 if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
121 boot_fdt_reserve_region(lmb, addr, size, LMB_NONE);
124 /* process reserved-memory */
125 nodeoffset = fdt_subnode_offset(fdt_blob, 0, "reserved-memory");
126 if (nodeoffset >= 0) {
127 subnode = fdt_first_subnode(fdt_blob, nodeoffset);
128 while (subnode >= 0) {
129 /* check if this subnode has a reg property */
130 ret = fdt_get_resource(fdt_blob, subnode, "reg", 0,
132 if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
134 if (fdtdec_get_bool(fdt_blob, subnode,
138 size = res.end - res.start + 1;
139 boot_fdt_reserve_region(lmb, addr, size, flags);
142 subnode = fdt_next_subnode(fdt_blob, subnode);
148 * boot_relocate_fdt - relocate flat device tree
149 * @lmb: pointer to lmb handle, will be used for memory mgmt
150 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
151 * @of_size: pointer to a ulong variable, will hold fdt length
153 * boot_relocate_fdt() allocates a region of memory within the bootmap and
154 * relocates the of_flat_tree into that region, even if the fdt is already in
155 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
158 * of_flat_tree and of_size are set to final (after relocation) values
164 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
166 void *fdt_blob = *of_flat_tree;
167 void *of_start = NULL;
168 u64 start, size, usable;
174 int disable_relocation = 0;
180 if (fdt_check_header(fdt_blob) != 0) {
181 fdt_error("image is not a fdt");
185 /* position on a 4K boundary before the alloc_current */
186 /* Pad the FDT by a specified amount */
187 of_len = *of_size + CONFIG_SYS_FDT_PAD;
189 /* If fdt_high is set use it to select the relocation address */
190 fdt_high = env_get("fdt_high");
192 void *desired_addr = (void *)hextoul(fdt_high, NULL);
194 if (((ulong) desired_addr) == ~0UL) {
195 /* All ones means use fdt in place */
197 lmb_reserve(lmb, (ulong)of_start, of_len);
198 disable_relocation = 1;
199 } else if (desired_addr) {
201 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
202 (ulong)desired_addr);
203 if (of_start == NULL) {
204 puts("Failed using fdt_high value for Device Tree");
209 (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
212 mapsize = env_get_bootm_mapsize();
213 low = env_get_bootm_low();
216 for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
217 start = gd->bd->bi_dram[bank].start;
218 size = gd->bd->bi_dram[bank].size;
220 /* DRAM bank addresses are too low, skip it. */
221 if (start + size < low)
224 usable = min(size, (u64)mapsize);
227 * At least part of this DRAM bank is usable, try
228 * using it for LMB allocation.
231 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
233 /* Allocation succeeded, use this block. */
234 if (of_start != NULL)
238 * Reduce the mapping size in the next bank
239 * by the size of attempt in current bank.
241 mapsize -= usable - max(start, (u64)low);
247 if (of_start == NULL) {
248 puts("device tree - allocation error\n");
252 if (disable_relocation) {
254 * We assume there is space after the existing fdt to use
257 fdt_set_totalsize(of_start, of_len);
258 printf(" Using Device Tree in place at %p, end %p\n",
259 of_start, of_start + of_len - 1);
261 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
262 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
264 printf(" Loading Device Tree to %p, end %p ... ",
265 of_start, of_start + of_len - 1);
267 err = fdt_open_into(fdt_blob, of_start, of_len);
269 fdt_error("fdt move failed");
275 *of_flat_tree = of_start;
278 if (CONFIG_IS_ENABLED(CMD_FDT))
279 set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
287 * select_fdt() - Select and locate the FDT to use
289 * @images: pointer to the bootm images structure
290 * @select: name of FDT to select, or NULL for any
291 * @arch: expected FDT architecture
292 * @fdt_addrp: pointer to a ulong variable, will hold FDT pointer
293 * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
294 * other -ve value on other error
297 static int select_fdt(bootm_headers_t *images, const char *select, u8 arch,
303 #if CONFIG_IS_ENABLED(FIT)
304 const char *fit_uname_config = images->fit_uname_cfg;
305 const char *fit_uname_fdt = NULL;
311 * If the FDT blob comes from the FIT image and the
312 * FIT image address is omitted in the command line
313 * argument, try to use ramdisk or os FIT image
314 * address or default load address.
316 if (images->fit_uname_rd)
317 default_addr = (ulong)images->fit_hdr_rd;
318 else if (images->fit_uname_os)
319 default_addr = (ulong)images->fit_hdr_os;
321 default_addr = image_load_addr;
323 if (fit_parse_conf(select, default_addr, &fdt_addr,
324 &fit_uname_config)) {
325 debug("* fdt: config '%s' from image at 0x%08lx\n",
326 fit_uname_config, fdt_addr);
327 } else if (fit_parse_subimage(select, default_addr, &fdt_addr,
329 debug("* fdt: subimage '%s' from image at 0x%08lx\n",
330 fit_uname_fdt, fdt_addr);
334 fdt_addr = hextoul(select, NULL);
335 debug("* fdt: cmdline image address = 0x%08lx\n",
338 #if CONFIG_IS_ENABLED(FIT)
340 /* use FIT configuration provided in first bootm
343 fdt_addr = map_to_sysmem(images->fit_hdr_os);
344 fdt_noffset = fit_get_node_from_config(images, FIT_FDT_PROP,
346 if (fdt_noffset == -ENOENT)
348 else if (fdt_noffset < 0)
352 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
356 * Check if there is an FDT image at the
357 * address provided in the second bootm argument
358 * check image type, for FIT images get a FIT node.
360 buf = map_sysmem(fdt_addr, 0);
361 switch (genimg_get_format(buf)) {
362 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
363 case IMAGE_FORMAT_LEGACY: {
364 const image_header_t *fdt_hdr;
365 ulong load, load_end;
366 ulong image_start, image_data, image_end;
368 /* verify fdt_addr points to a valid image header */
369 printf("## Flattened Device Tree from Legacy Image at %08lx\n",
371 fdt_hdr = image_get_fdt(fdt_addr);
376 * move image data to the load address,
377 * make sure we don't overwrite initial image
379 image_start = (ulong)fdt_hdr;
380 image_data = (ulong)image_get_data(fdt_hdr);
381 image_end = image_get_image_end(fdt_hdr);
383 load = image_get_load(fdt_hdr);
384 load_end = load + image_get_data_size(fdt_hdr);
386 if (load == image_start ||
387 load == image_data) {
392 if ((load < image_end) && (load_end > image_start)) {
393 fdt_error("fdt overwritten");
397 debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
400 memmove((void *)load,
402 image_get_data_size(fdt_hdr));
408 case IMAGE_FORMAT_FIT:
410 * This case will catch both: new uImage format
411 * (libfdt based) and raw FDT blob (also libfdt
414 #if CONFIG_IS_ENABLED(FIT)
415 /* check FDT blob vs FIT blob */
416 if (!fit_check_format(buf, IMAGE_SIZE_INVAL)) {
419 fdt_noffset = boot_get_fdt_fit(images, fdt_addr,
427 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
428 images->fit_uname_fdt = fit_uname_fdt;
429 images->fit_noffset_fdt = fdt_noffset;
439 debug("* fdt: raw FDT blob\n");
440 printf("## Flattened Device Tree blob at %08lx\n",
445 puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
448 *fdt_addrp = fdt_addr;
454 * boot_get_fdt - main fdt handling routine
455 * @argc: command argument count
456 * @argv: command argument list
457 * @arch: architecture (IH_ARCH_...)
458 * @images: pointer to the bootm images structure
459 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
460 * @of_size: pointer to a ulong variable, will hold fdt length
462 * boot_get_fdt() is responsible for finding a valid flat device tree image.
463 * Currently supported are the following ramdisk sources:
464 * - multicomponent kernel/ramdisk image,
465 * - commandline provided address of decicated ramdisk image.
468 * 0, if fdt image was found and valid, or skipped
469 * of_flat_tree and of_size are set to fdt start address and length if
470 * fdt image is found and valid
472 * 1, if fdt image is found but corrupted
473 * of_flat_tree and of_size are set to 0 if no fdt exists
475 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
476 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
480 char *fdt_blob = NULL;
482 const char *select = NULL;
484 *of_flat_tree = NULL;
487 img_addr = (argc == 0) ? image_load_addr : hextoul(argv[0], NULL);
488 buf = map_sysmem(img_addr, 0);
492 if (select || genimg_has_config(images)) {
495 ret = select_fdt(images, select, arch, &fdt_addr);
500 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
501 fdt_blob = map_sysmem(fdt_addr, 0);
502 } else if (images->legacy_hdr_valid &&
503 image_check_type(&images->legacy_hdr_os_copy,
505 ulong fdt_data, fdt_len;
508 * Now check if we have a legacy multi-component image,
509 * get second entry data start address and len.
511 printf("## Flattened Device Tree from multi component Image at %08lX\n",
512 (ulong)images->legacy_hdr_os);
514 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
517 fdt_blob = (char *)fdt_data;
518 printf(" Booting using the fdt at 0x%p\n", fdt_blob);
520 if (fdt_check_header(fdt_blob) != 0) {
521 fdt_error("image is not a fdt");
525 if (fdt_totalsize(fdt_blob) != fdt_len) {
526 fdt_error("fdt size != image size");
530 debug("## No Flattened Device Tree\n");
533 #ifdef CONFIG_ANDROID_BOOT_IMAGE
534 } else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
535 struct andr_img_hdr *hdr = buf;
536 ulong fdt_data, fdt_len;
537 u32 fdt_size, dtb_idx;
539 * Firstly check if this android boot image has dtb field.
541 dtb_idx = (u32)env_get_ulong("adtb_idx", 10, 0);
542 if (android_image_get_dtb_by_index((ulong)hdr, dtb_idx, &fdt_addr, &fdt_size)) {
543 fdt_blob = (char *)map_sysmem(fdt_addr, 0);
544 if (fdt_check_header(fdt_blob))
547 debug("## Using FDT in Android image dtb area with idx %u\n", dtb_idx);
548 } else if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
549 !fdt_check_header((char *)fdt_data)) {
550 fdt_blob = (char *)fdt_data;
551 if (fdt_totalsize(fdt_blob) != fdt_len)
554 debug("## Using FDT in Android image second area\n");
556 fdt_addr = env_get_hex("fdtaddr", 0);
560 fdt_blob = map_sysmem(fdt_addr, 0);
561 if (fdt_check_header(fdt_blob))
564 debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
568 debug("## No Flattened Device Tree\n");
572 *of_flat_tree = fdt_blob;
573 *of_size = fdt_totalsize(fdt_blob);
574 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
575 (ulong)*of_flat_tree, *of_size);
580 debug("Continuing to boot without FDT\n");
587 * Verify the device tree.
589 * This function is called after all device tree fix-ups have been enacted,
590 * so that the final device tree can be verified. The definition of "verified"
591 * is up to the specific implementation. However, it generally means that the
592 * addresses of some of the devices in the device tree are compared with the
593 * actual addresses at which U-Boot has placed them.
595 * Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the
598 __weak int ft_verify_fdt(void *fdt)
603 __weak int arch_fixup_fdt(void *blob)
608 int image_setup_libfdt(bootm_headers_t *images, void *blob,
609 int of_size, struct lmb *lmb)
611 ulong *initrd_start = &images->initrd_start;
612 ulong *initrd_end = &images->initrd_end;
616 if (fdt_root(blob) < 0) {
617 printf("ERROR: root node setup failed\n");
620 if (fdt_chosen(blob) < 0) {
621 printf("ERROR: /chosen node create failed\n");
624 if (arch_fixup_fdt(blob) < 0) {
625 printf("ERROR: arch-specific fdt fixup failed\n");
629 fdt_ret = optee_copy_fdt_nodes(blob);
631 printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
632 fdt_strerror(fdt_ret));
636 /* Store name of configuration node as u-boot,bootconf in /chosen node */
637 if (images->fit_uname_cfg)
638 fdt_find_and_setprop(blob, "/chosen", "u-boot,bootconf",
639 images->fit_uname_cfg,
640 strlen(images->fit_uname_cfg) + 1, 1);
642 /* Update ethernet nodes */
643 fdt_fixup_ethernet(blob);
644 #if CONFIG_IS_ENABLED(CMD_PSTORE)
645 /* Append PStore configuration */
646 fdt_fixup_pstore(blob);
648 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP)) {
649 const char *skip_board_fixup;
651 skip_board_fixup = env_get("skip_board_fixup");
652 if (skip_board_fixup && ((int)simple_strtol(skip_board_fixup, NULL, 10) == 1)) {
653 printf("skip board fdt fixup\n");
655 fdt_ret = ft_board_setup(blob, gd->bd);
657 printf("ERROR: board-specific fdt fixup failed: %s\n",
658 fdt_strerror(fdt_ret));
663 if (IS_ENABLED(CONFIG_OF_SYSTEM_SETUP)) {
664 fdt_ret = ft_system_setup(blob, gd->bd);
666 printf("ERROR: system-specific fdt fixup failed: %s\n",
667 fdt_strerror(fdt_ret));
672 /* Delete the old LMB reservation */
674 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
675 (phys_size_t)fdt_totalsize(blob));
677 ret = fdt_shrink_to_minimum(blob, 0);
682 if (*initrd_start && *initrd_end) {
683 of_size += FDT_RAMDISK_OVERHEAD;
684 fdt_set_totalsize(blob, of_size);
686 /* Create a new LMB reservation */
688 lmb_reserve(lmb, (ulong)blob, of_size);
690 fdt_initrd(blob, *initrd_start, *initrd_end);
691 if (!ft_verify_fdt(blob))
694 #if defined(CONFIG_ARCH_KEYSTONE)
695 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP))
696 ft_board_setup_ex(blob, gd->bd);
701 printf(" - must RESET the board to recover.\n\n");