1 // SPDX-License-Identifier: GPL-2.0+
3 * Copyright (c) 2013, Google Inc.
5 * (C) Copyright 2008 Semihalf
7 * (C) Copyright 2000-2006
12 #include <fdt_support.h>
20 #include <asm/global_data.h>
21 #include <linux/libfdt.h>
24 #include <dm/ofnode.h>
25 #include <tee/optee.h>
27 #ifndef CONFIG_SYS_FDT_PAD
28 #define CONFIG_SYS_FDT_PAD 0x3000
31 /* adding a ramdisk needs 0x44 bytes in version 2008.10 */
32 #define FDT_RAMDISK_OVERHEAD 0x80
34 DECLARE_GLOBAL_DATA_PTR;
36 static void fdt_error(const char *msg)
40 puts(" - must RESET the board to recover.\n");
43 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
44 static const image_header_t *image_get_fdt(ulong fdt_addr)
46 const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);
48 image_print_contents(fdt_hdr);
50 puts(" Verifying Checksum ... ");
51 if (!image_check_hcrc(fdt_hdr)) {
52 fdt_error("fdt header checksum invalid");
56 if (!image_check_dcrc(fdt_hdr)) {
57 fdt_error("fdt checksum invalid");
62 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
63 fdt_error("uImage is not a fdt");
66 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
67 fdt_error("uImage is compressed");
70 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
71 fdt_error("uImage data is not a fdt");
78 static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
79 uint64_t size, enum lmb_flags flags)
83 ret = lmb_reserve_flags(lmb, addr, size, flags);
85 debug(" reserving fdt memory region: addr=%llx size=%llx flags=%x\n",
86 (unsigned long long)addr,
87 (unsigned long long)size, flags);
89 puts("ERROR: reserving fdt memory region failed ");
90 printf("(addr=%llx size=%llx flags=%x)\n",
91 (unsigned long long)addr,
92 (unsigned long long)size, flags);
97 * boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
98 * sections as unusable
99 * @lmb: pointer to lmb handle, will be used for memory mgmt
100 * @fdt_blob: pointer to fdt blob base address
102 * Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
103 * Adding the memreserve regions prevents u-boot from using them to store the
104 * initrd or the fdt blob.
106 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
110 int nodeoffset, subnode;
111 struct fdt_resource res;
112 enum lmb_flags flags;
114 if (fdt_check_header(fdt_blob) != 0)
117 /* process memreserve sections */
118 total = fdt_num_mem_rsv(fdt_blob);
119 for (i = 0; i < total; i++) {
120 if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
122 boot_fdt_reserve_region(lmb, addr, size, LMB_NONE);
125 /* process reserved-memory */
126 nodeoffset = fdt_subnode_offset(fdt_blob, 0, "reserved-memory");
127 if (nodeoffset >= 0) {
128 subnode = fdt_first_subnode(fdt_blob, nodeoffset);
129 while (subnode >= 0) {
130 /* check if this subnode has a reg property */
131 ret = fdt_get_resource(fdt_blob, subnode, "reg", 0,
133 if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
135 if (fdtdec_get_bool(fdt_blob, subnode,
139 size = res.end - res.start + 1;
140 boot_fdt_reserve_region(lmb, addr, size, flags);
143 subnode = fdt_next_subnode(fdt_blob, subnode);
149 * boot_relocate_fdt - relocate flat device tree
150 * @lmb: pointer to lmb handle, will be used for memory mgmt
151 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
152 * @of_size: pointer to a ulong variable, will hold fdt length
154 * boot_relocate_fdt() allocates a region of memory within the bootmap and
155 * relocates the of_flat_tree into that region, even if the fdt is already in
156 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
159 * of_flat_tree and of_size are set to final (after relocation) values
165 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
167 void *fdt_blob = *of_flat_tree;
168 void *of_start = NULL;
169 u64 start, size, usable;
175 int disable_relocation = 0;
181 if (fdt_check_header(fdt_blob) != 0) {
182 fdt_error("image is not a fdt");
186 /* position on a 4K boundary before the alloc_current */
187 /* Pad the FDT by a specified amount */
188 of_len = *of_size + CONFIG_SYS_FDT_PAD;
190 /* If fdt_high is set use it to select the relocation address */
191 fdt_high = env_get("fdt_high");
193 void *desired_addr = (void *)hextoul(fdt_high, NULL);
195 if (((ulong) desired_addr) == ~0UL) {
196 /* All ones means use fdt in place */
198 lmb_reserve(lmb, (ulong)of_start, of_len);
199 disable_relocation = 1;
200 } else if (desired_addr) {
202 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
203 (ulong)desired_addr);
204 if (of_start == NULL) {
205 puts("Failed using fdt_high value for Device Tree");
210 (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
213 mapsize = env_get_bootm_mapsize();
214 low = env_get_bootm_low();
217 for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
218 start = gd->bd->bi_dram[bank].start;
219 size = gd->bd->bi_dram[bank].size;
221 /* DRAM bank addresses are too low, skip it. */
222 if (start + size < low)
225 usable = min(size, (u64)mapsize);
228 * At least part of this DRAM bank is usable, try
229 * using it for LMB allocation.
232 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
234 /* Allocation succeeded, use this block. */
235 if (of_start != NULL)
239 * Reduce the mapping size in the next bank
240 * by the size of attempt in current bank.
242 mapsize -= usable - max(start, (u64)low);
248 if (of_start == NULL) {
249 puts("device tree - allocation error\n");
253 if (disable_relocation) {
255 * We assume there is space after the existing fdt to use
258 fdt_set_totalsize(of_start, of_len);
259 printf(" Using Device Tree in place at %p, end %p\n",
260 of_start, of_start + of_len - 1);
262 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
263 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
265 printf(" Loading Device Tree to %p, end %p ... ",
266 of_start, of_start + of_len - 1);
268 err = fdt_open_into(fdt_blob, of_start, of_len);
270 fdt_error("fdt move failed");
276 *of_flat_tree = of_start;
279 if (CONFIG_IS_ENABLED(CMD_FDT))
280 set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
288 * select_fdt() - Select and locate the FDT to use
290 * @images: pointer to the bootm images structure
291 * @select: name of FDT to select, or NULL for any
292 * @arch: expected FDT architecture
293 * @fdt_addrp: pointer to a ulong variable, will hold FDT pointer
294 * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
295 * other -ve value on other error
298 static int select_fdt(bootm_headers_t *images, const char *select, u8 arch,
304 #if CONFIG_IS_ENABLED(FIT)
305 const char *fit_uname_config = images->fit_uname_cfg;
306 const char *fit_uname_fdt = NULL;
312 * If the FDT blob comes from the FIT image and the
313 * FIT image address is omitted in the command line
314 * argument, try to use ramdisk or os FIT image
315 * address or default load address.
317 if (images->fit_uname_rd)
318 default_addr = (ulong)images->fit_hdr_rd;
319 else if (images->fit_uname_os)
320 default_addr = (ulong)images->fit_hdr_os;
322 default_addr = image_load_addr;
324 if (fit_parse_conf(select, default_addr, &fdt_addr,
325 &fit_uname_config)) {
326 debug("* fdt: config '%s' from image at 0x%08lx\n",
327 fit_uname_config, fdt_addr);
328 } else if (fit_parse_subimage(select, default_addr, &fdt_addr,
330 debug("* fdt: subimage '%s' from image at 0x%08lx\n",
331 fit_uname_fdt, fdt_addr);
335 fdt_addr = hextoul(select, NULL);
336 debug("* fdt: cmdline image address = 0x%08lx\n",
339 #if CONFIG_IS_ENABLED(FIT)
341 /* use FIT configuration provided in first bootm
344 fdt_addr = map_to_sysmem(images->fit_hdr_os);
345 fdt_noffset = fit_get_node_from_config(images, FIT_FDT_PROP,
347 if (fdt_noffset == -ENOENT)
349 else if (fdt_noffset < 0)
353 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
357 * Check if there is an FDT image at the
358 * address provided in the second bootm argument
359 * check image type, for FIT images get a FIT node.
361 buf = map_sysmem(fdt_addr, 0);
362 switch (genimg_get_format(buf)) {
363 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
364 case IMAGE_FORMAT_LEGACY: {
365 const image_header_t *fdt_hdr;
366 ulong load, load_end;
367 ulong image_start, image_data, image_end;
369 /* verify fdt_addr points to a valid image header */
370 printf("## Flattened Device Tree from Legacy Image at %08lx\n",
372 fdt_hdr = image_get_fdt(fdt_addr);
377 * move image data to the load address,
378 * make sure we don't overwrite initial image
380 image_start = (ulong)fdt_hdr;
381 image_data = (ulong)image_get_data(fdt_hdr);
382 image_end = image_get_image_end(fdt_hdr);
384 load = image_get_load(fdt_hdr);
385 load_end = load + image_get_data_size(fdt_hdr);
387 if (load == image_start ||
388 load == image_data) {
393 if ((load < image_end) && (load_end > image_start)) {
394 fdt_error("fdt overwritten");
398 debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
401 memmove((void *)load,
403 image_get_data_size(fdt_hdr));
409 case IMAGE_FORMAT_FIT:
411 * This case will catch both: new uImage format
412 * (libfdt based) and raw FDT blob (also libfdt
415 #if CONFIG_IS_ENABLED(FIT)
416 /* check FDT blob vs FIT blob */
417 if (!fit_check_format(buf, IMAGE_SIZE_INVAL)) {
420 fdt_noffset = boot_get_fdt_fit(images, fdt_addr,
428 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
429 images->fit_uname_fdt = fit_uname_fdt;
430 images->fit_noffset_fdt = fdt_noffset;
440 debug("* fdt: raw FDT blob\n");
441 printf("## Flattened Device Tree blob at %08lx\n",
446 puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
449 *fdt_addrp = fdt_addr;
455 * boot_get_fdt - main fdt handling routine
456 * @argc: command argument count
457 * @argv: command argument list
458 * @arch: architecture (IH_ARCH_...)
459 * @images: pointer to the bootm images structure
460 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
461 * @of_size: pointer to a ulong variable, will hold fdt length
463 * boot_get_fdt() is responsible for finding a valid flat device tree image.
464 * Currently supported are the following ramdisk sources:
465 * - multicomponent kernel/ramdisk image,
466 * - commandline provided address of decicated ramdisk image.
469 * 0, if fdt image was found and valid, or skipped
470 * of_flat_tree and of_size are set to fdt start address and length if
471 * fdt image is found and valid
473 * 1, if fdt image is found but corrupted
474 * of_flat_tree and of_size are set to 0 if no fdt exists
476 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
477 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
481 char *fdt_blob = NULL;
483 const char *select = NULL;
485 *of_flat_tree = NULL;
488 img_addr = (argc == 0) ? image_load_addr : hextoul(argv[0], NULL);
489 buf = map_sysmem(img_addr, 0);
493 if (select || genimg_has_config(images)) {
496 ret = select_fdt(images, select, arch, &fdt_addr);
501 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
502 fdt_blob = map_sysmem(fdt_addr, 0);
503 } else if (images->legacy_hdr_valid &&
504 image_check_type(&images->legacy_hdr_os_copy,
506 ulong fdt_data, fdt_len;
509 * Now check if we have a legacy multi-component image,
510 * get second entry data start address and len.
512 printf("## Flattened Device Tree from multi component Image at %08lX\n",
513 (ulong)images->legacy_hdr_os);
515 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
518 fdt_blob = (char *)fdt_data;
519 printf(" Booting using the fdt at 0x%p\n", fdt_blob);
521 if (fdt_check_header(fdt_blob) != 0) {
522 fdt_error("image is not a fdt");
526 if (fdt_totalsize(fdt_blob) != fdt_len) {
527 fdt_error("fdt size != image size");
531 debug("## No Flattened Device Tree\n");
534 #ifdef CONFIG_ANDROID_BOOT_IMAGE
535 } else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
536 struct andr_img_hdr *hdr = buf;
537 ulong fdt_data, fdt_len;
538 u32 fdt_size, dtb_idx;
540 * Firstly check if this android boot image has dtb field.
542 dtb_idx = (u32)env_get_ulong("adtb_idx", 10, 0);
543 if (android_image_get_dtb_by_index((ulong)hdr, dtb_idx, &fdt_addr, &fdt_size)) {
544 fdt_blob = (char *)map_sysmem(fdt_addr, 0);
545 if (fdt_check_header(fdt_blob))
548 debug("## Using FDT in Android image dtb area with idx %u\n", dtb_idx);
549 } else if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
550 !fdt_check_header((char *)fdt_data)) {
551 fdt_blob = (char *)fdt_data;
552 if (fdt_totalsize(fdt_blob) != fdt_len)
555 debug("## Using FDT in Android image second area\n");
557 fdt_addr = env_get_hex("fdtaddr", 0);
561 fdt_blob = map_sysmem(fdt_addr, 0);
562 if (fdt_check_header(fdt_blob))
565 debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
569 debug("## No Flattened Device Tree\n");
573 *of_flat_tree = fdt_blob;
574 *of_size = fdt_totalsize(fdt_blob);
575 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
576 (ulong)*of_flat_tree, *of_size);
581 debug("Continuing to boot without FDT\n");
588 * Verify the device tree.
590 * This function is called after all device tree fix-ups have been enacted,
591 * so that the final device tree can be verified. The definition of "verified"
592 * is up to the specific implementation. However, it generally means that the
593 * addresses of some of the devices in the device tree are compared with the
594 * actual addresses at which U-Boot has placed them.
596 * Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the
599 __weak int ft_verify_fdt(void *fdt)
604 __weak int arch_fixup_fdt(void *blob)
609 int image_setup_libfdt(bootm_headers_t *images, void *blob,
610 int of_size, struct lmb *lmb)
612 ulong *initrd_start = &images->initrd_start;
613 ulong *initrd_end = &images->initrd_end;
617 if (fdt_root(blob) < 0) {
618 printf("ERROR: root node setup failed\n");
621 if (fdt_chosen(blob) < 0) {
622 printf("ERROR: /chosen node create failed\n");
625 if (arch_fixup_fdt(blob) < 0) {
626 printf("ERROR: arch-specific fdt fixup failed\n");
630 fdt_ret = optee_copy_fdt_nodes(blob);
632 printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
633 fdt_strerror(fdt_ret));
637 /* Store name of configuration node as u-boot,bootconf in /chosen node */
638 if (images->fit_uname_cfg)
639 fdt_find_and_setprop(blob, "/chosen", "u-boot,bootconf",
640 images->fit_uname_cfg,
641 strlen(images->fit_uname_cfg) + 1, 1);
643 /* Update ethernet nodes */
644 fdt_fixup_ethernet(blob);
645 #if CONFIG_IS_ENABLED(CMD_PSTORE)
646 /* Append PStore configuration */
647 fdt_fixup_pstore(blob);
649 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP)) {
650 const char *skip_board_fixup;
652 skip_board_fixup = env_get("skip_board_fixup");
653 if (skip_board_fixup && ((int)simple_strtol(skip_board_fixup, NULL, 10) == 1)) {
654 printf("skip board fdt fixup\n");
656 fdt_ret = ft_board_setup(blob, gd->bd);
658 printf("ERROR: board-specific fdt fixup failed: %s\n",
659 fdt_strerror(fdt_ret));
664 if (IS_ENABLED(CONFIG_OF_SYSTEM_SETUP)) {
665 fdt_ret = ft_system_setup(blob, gd->bd);
667 printf("ERROR: system-specific fdt fixup failed: %s\n",
668 fdt_strerror(fdt_ret));
672 if (CONFIG_IS_ENABLED(EVENT)) {
673 struct event_ft_fixup fixup;
675 fixup.tree = oftree_default();
676 ret = event_notify(EVT_FT_FIXUP, &fixup, sizeof(fixup));
678 printf("ERROR: fdt fixup event failed: %d\n", ret);
683 /* Delete the old LMB reservation */
685 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
686 (phys_size_t)fdt_totalsize(blob));
688 ret = fdt_shrink_to_minimum(blob, 0);
693 if (*initrd_start && *initrd_end) {
694 of_size += FDT_RAMDISK_OVERHEAD;
695 fdt_set_totalsize(blob, of_size);
697 /* Create a new LMB reservation */
699 lmb_reserve(lmb, (ulong)blob, of_size);
701 fdt_initrd(blob, *initrd_start, *initrd_end);
702 if (!ft_verify_fdt(blob))
705 #if defined(CONFIG_ARCH_KEYSTONE)
706 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP))
707 ft_board_setup_ex(blob, gd->bd);
712 printf(" - must RESET the board to recover.\n\n");