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 <dm/ofnode.h>
25 #include <tee/optee.h>
27 /* adding a ramdisk needs 0x44 bytes in version 2008.10 */
28 #define FDT_RAMDISK_OVERHEAD 0x80
30 DECLARE_GLOBAL_DATA_PTR;
32 static void fdt_error(const char *msg)
36 puts(" - must RESET the board to recover.\n");
39 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
40 static const struct legacy_img_hdr *image_get_fdt(ulong fdt_addr)
42 const struct legacy_img_hdr *fdt_hdr = map_sysmem(fdt_addr, 0);
44 image_print_contents(fdt_hdr);
46 puts(" Verifying Checksum ... ");
47 if (!image_check_hcrc(fdt_hdr)) {
48 fdt_error("fdt header checksum invalid");
52 if (!image_check_dcrc(fdt_hdr)) {
53 fdt_error("fdt checksum invalid");
58 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
59 fdt_error("uImage is not a fdt");
62 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
63 fdt_error("uImage is compressed");
66 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
67 fdt_error("uImage data is not a fdt");
74 static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
75 uint64_t size, enum lmb_flags flags)
79 ret = lmb_reserve_flags(lmb, addr, size, flags);
81 debug(" reserving fdt memory region: addr=%llx size=%llx flags=%x\n",
82 (unsigned long long)addr,
83 (unsigned long long)size, flags);
85 puts("ERROR: reserving fdt memory region failed ");
86 printf("(addr=%llx size=%llx flags=%x)\n",
87 (unsigned long long)addr,
88 (unsigned long long)size, flags);
93 * boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
94 * sections as unusable
95 * @lmb: pointer to lmb handle, will be used for memory mgmt
96 * @fdt_blob: pointer to fdt blob base address
98 * Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
99 * Adding the memreserve regions prevents u-boot from using them to store the
100 * initrd or the fdt blob.
102 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
106 int nodeoffset, subnode;
107 struct fdt_resource res;
108 enum lmb_flags flags;
110 if (fdt_check_header(fdt_blob) != 0)
113 /* process memreserve sections */
114 total = fdt_num_mem_rsv(fdt_blob);
115 for (i = 0; i < total; i++) {
116 if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
118 boot_fdt_reserve_region(lmb, addr, size, LMB_NONE);
121 /* process reserved-memory */
122 nodeoffset = fdt_subnode_offset(fdt_blob, 0, "reserved-memory");
123 if (nodeoffset >= 0) {
124 subnode = fdt_first_subnode(fdt_blob, nodeoffset);
125 while (subnode >= 0) {
126 /* check if this subnode has a reg property */
127 ret = fdt_get_resource(fdt_blob, subnode, "reg", 0,
129 if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
131 if (fdtdec_get_bool(fdt_blob, subnode,
135 size = res.end - res.start + 1;
136 boot_fdt_reserve_region(lmb, addr, size, flags);
139 subnode = fdt_next_subnode(fdt_blob, subnode);
145 * boot_relocate_fdt - relocate flat device tree
146 * @lmb: pointer to lmb handle, will be used for memory mgmt
147 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
148 * @of_size: pointer to a ulong variable, will hold fdt length
150 * boot_relocate_fdt() allocates a region of memory within the bootmap and
151 * relocates the of_flat_tree into that region, even if the fdt is already in
152 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
155 * of_flat_tree and of_size are set to final (after relocation) values
161 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
163 void *fdt_blob = *of_flat_tree;
164 void *of_start = NULL;
165 u64 start, size, usable;
171 int disable_relocation = 0;
177 if (fdt_check_header(fdt_blob) != 0) {
178 fdt_error("image is not a fdt");
182 /* position on a 4K boundary before the alloc_current */
183 /* Pad the FDT by a specified amount */
184 of_len = *of_size + CONFIG_SYS_FDT_PAD;
186 /* If fdt_high is set use it to select the relocation address */
187 fdt_high = env_get("fdt_high");
189 ulong desired_addr = hextoul(fdt_high, NULL);
192 if (desired_addr == ~0UL) {
193 /* All ones means use fdt in place */
195 lmb_reserve(lmb, map_to_sysmem(of_start), of_len);
196 disable_relocation = 1;
197 } else if (desired_addr) {
198 addr = lmb_alloc_base(lmb, of_len, 0x1000,
200 of_start = map_sysmem(addr, of_len);
201 if (of_start == NULL) {
202 puts("Failed using fdt_high value for Device Tree");
206 addr = lmb_alloc(lmb, of_len, 0x1000);
207 of_start = map_sysmem(addr, of_len);
210 mapsize = env_get_bootm_mapsize();
211 low = env_get_bootm_low();
214 for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
215 start = gd->bd->bi_dram[bank].start;
216 size = gd->bd->bi_dram[bank].size;
218 /* DRAM bank addresses are too low, skip it. */
219 if (start + size < low)
222 usable = min(size, (u64)mapsize);
225 * At least part of this DRAM bank is usable, try
226 * using it for LMB allocation.
228 of_start = map_sysmem((ulong)lmb_alloc_base(lmb,
229 of_len, 0x1000, start + usable), of_len);
230 /* Allocation succeeded, use this block. */
231 if (of_start != NULL)
235 * Reduce the mapping size in the next bank
236 * by the size of attempt in current bank.
238 mapsize -= usable - max(start, (u64)low);
244 if (of_start == NULL) {
245 puts("device tree - allocation error\n");
249 if (disable_relocation) {
251 * We assume there is space after the existing fdt to use
254 fdt_set_totalsize(of_start, of_len);
255 printf(" Using Device Tree in place at %p, end %p\n",
256 of_start, of_start + of_len - 1);
258 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
259 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
261 printf(" Loading Device Tree to %p, end %p ... ",
262 of_start, of_start + of_len - 1);
264 err = fdt_open_into(fdt_blob, of_start, of_len);
266 fdt_error("fdt move failed");
272 *of_flat_tree = of_start;
275 if (IS_ENABLED(CONFIG_CMD_FDT))
276 set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
284 * select_fdt() - Select and locate the FDT to use
286 * @images: pointer to the bootm images structure
287 * @select: name of FDT to select, or NULL for any
288 * @arch: expected FDT architecture
289 * @fdt_addrp: pointer to a ulong variable, will hold FDT pointer
290 * Return: 0 if OK, -ENOPKG if no FDT (but an error should not be reported),
291 * other -ve value on other error
294 static int select_fdt(struct bootm_headers *images, const char *select, u8 arch,
300 #if CONFIG_IS_ENABLED(FIT)
301 const char *fit_uname_config = images->fit_uname_cfg;
302 const char *fit_uname_fdt = NULL;
308 * If the FDT blob comes from the FIT image and the
309 * FIT image address is omitted in the command line
310 * argument, try to use ramdisk or os FIT image
311 * address or default load address.
313 if (images->fit_uname_rd)
314 default_addr = (ulong)images->fit_hdr_rd;
315 else if (images->fit_uname_os)
316 default_addr = (ulong)images->fit_hdr_os;
318 default_addr = image_load_addr;
320 if (fit_parse_conf(select, default_addr, &fdt_addr,
321 &fit_uname_config)) {
322 debug("* fdt: config '%s' from image at 0x%08lx\n",
323 fit_uname_config, fdt_addr);
324 } else if (fit_parse_subimage(select, default_addr, &fdt_addr,
326 debug("* fdt: subimage '%s' from image at 0x%08lx\n",
327 fit_uname_fdt, fdt_addr);
331 fdt_addr = hextoul(select, NULL);
332 debug("* fdt: cmdline image address = 0x%08lx\n",
335 #if CONFIG_IS_ENABLED(FIT)
337 /* use FIT configuration provided in first bootm
340 fdt_addr = map_to_sysmem(images->fit_hdr_os);
341 fdt_noffset = fit_get_node_from_config(images, FIT_FDT_PROP,
343 if (fdt_noffset == -ENOENT)
345 else if (fdt_noffset < 0)
349 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
353 * Check if there is an FDT image at the
354 * address provided in the second bootm argument
355 * check image type, for FIT images get a FIT node.
357 buf = map_sysmem(fdt_addr, 0);
358 switch (genimg_get_format(buf)) {
359 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
360 case IMAGE_FORMAT_LEGACY: {
361 const struct legacy_img_hdr *fdt_hdr;
362 ulong load, load_end;
363 ulong image_start, image_data, image_end;
365 /* verify fdt_addr points to a valid image header */
366 printf("## Flattened Device Tree from Legacy Image at %08lx\n",
368 fdt_hdr = image_get_fdt(fdt_addr);
373 * move image data to the load address,
374 * make sure we don't overwrite initial image
376 image_start = (ulong)fdt_hdr;
377 image_data = (ulong)image_get_data(fdt_hdr);
378 image_end = image_get_image_end(fdt_hdr);
380 load = image_get_load(fdt_hdr);
381 load_end = load + image_get_data_size(fdt_hdr);
383 if (load == image_start ||
384 load == image_data) {
389 if ((load < image_end) && (load_end > image_start)) {
390 fdt_error("fdt overwritten");
394 debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
397 memmove((void *)load,
399 image_get_data_size(fdt_hdr));
405 case IMAGE_FORMAT_FIT:
407 * This case will catch both: new uImage format
408 * (libfdt based) and raw FDT blob (also libfdt
411 #if CONFIG_IS_ENABLED(FIT)
412 /* check FDT blob vs FIT blob */
413 if (!fit_check_format(buf, IMAGE_SIZE_INVAL)) {
416 fdt_noffset = boot_get_fdt_fit(images, fdt_addr,
424 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
425 images->fit_uname_fdt = fit_uname_fdt;
426 images->fit_noffset_fdt = fdt_noffset;
436 debug("* fdt: raw FDT blob\n");
437 printf("## Flattened Device Tree blob at %08lx\n",
442 puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
445 *fdt_addrp = fdt_addr;
451 * boot_get_fdt - main fdt handling routine
452 * @argc: command argument count
453 * @argv: command argument list
454 * @arch: architecture (IH_ARCH_...)
455 * @images: pointer to the bootm images structure
456 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
457 * @of_size: pointer to a ulong variable, will hold fdt length
459 * boot_get_fdt() is responsible for finding a valid flat device tree image.
460 * Currently supported are the following ramdisk sources:
461 * - multicomponent kernel/ramdisk image,
462 * - commandline provided address of decicated ramdisk image.
465 * 0, if fdt image was found and valid, or skipped
466 * of_flat_tree and of_size are set to fdt start address and length if
467 * fdt image is found and valid
469 * 1, if fdt image is found but corrupted
470 * of_flat_tree and of_size are set to 0 if no fdt exists
472 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
473 struct bootm_headers *images, char **of_flat_tree, ulong *of_size)
477 char *fdt_blob = NULL;
479 const char *select = NULL;
481 *of_flat_tree = NULL;
484 img_addr = (argc == 0) ? image_load_addr : hextoul(argv[0], NULL);
485 buf = map_sysmem(img_addr, 0);
489 if (select || genimg_has_config(images)) {
492 ret = select_fdt(images, select, arch, &fdt_addr);
497 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
498 fdt_blob = map_sysmem(fdt_addr, 0);
499 } else if (images->legacy_hdr_valid &&
500 image_check_type(&images->legacy_hdr_os_copy,
502 ulong fdt_data, fdt_len;
505 * Now check if we have a legacy multi-component image,
506 * get second entry data start address and len.
508 printf("## Flattened Device Tree from multi component Image at %08lX\n",
509 (ulong)images->legacy_hdr_os);
511 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
514 fdt_blob = (char *)fdt_data;
515 printf(" Booting using the fdt at 0x%p\n", fdt_blob);
517 if (fdt_check_header(fdt_blob) != 0) {
518 fdt_error("image is not a fdt");
522 if (fdt_totalsize(fdt_blob) != fdt_len) {
523 fdt_error("fdt size != image size");
527 debug("## No Flattened Device Tree\n");
530 #ifdef CONFIG_ANDROID_BOOT_IMAGE
531 } else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
533 ulong fdt_data, fdt_len;
534 u32 fdt_size, dtb_idx;
536 * Firstly check if this android boot image has dtb field.
538 dtb_idx = (u32)env_get_ulong("adtb_idx", 10, 0);
539 if (android_image_get_dtb_by_index((ulong)hdr, 0,
540 dtb_idx, &fdt_addr, &fdt_size)) {
541 fdt_blob = (char *)map_sysmem(fdt_addr, 0);
542 if (fdt_check_header(fdt_blob))
545 debug("## Using FDT in Android image dtb area with idx %u\n", dtb_idx);
546 } else if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
547 !fdt_check_header((char *)fdt_data)) {
548 fdt_blob = (char *)fdt_data;
549 if (fdt_totalsize(fdt_blob) != fdt_len)
552 debug("## Using FDT in Android image second area\n");
554 fdt_addr = env_get_hex("fdtaddr", 0);
558 fdt_blob = map_sysmem(fdt_addr, 0);
559 if (fdt_check_header(fdt_blob))
562 debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
566 debug("## No Flattened Device Tree\n");
570 *of_flat_tree = fdt_blob;
571 *of_size = fdt_totalsize(fdt_blob);
572 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
573 (ulong)*of_flat_tree, *of_size);
578 debug("Continuing to boot without FDT\n");
585 * Verify the device tree.
587 * This function is called after all device tree fix-ups have been enacted,
588 * so that the final device tree can be verified. The definition of "verified"
589 * is up to the specific implementation. However, it generally means that the
590 * addresses of some of the devices in the device tree are compared with the
591 * actual addresses at which U-Boot has placed them.
593 * Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the
596 __weak int ft_verify_fdt(void *fdt)
601 __weak int arch_fixup_fdt(void *blob)
606 int image_setup_libfdt(struct bootm_headers *images, void *blob,
607 int of_size, struct lmb *lmb)
609 ulong *initrd_start = &images->initrd_start;
610 ulong *initrd_end = &images->initrd_end;
614 if (fdt_root(blob) < 0) {
615 printf("ERROR: root node setup failed\n");
618 if (fdt_chosen(blob) < 0) {
619 printf("ERROR: /chosen node create failed\n");
622 if (arch_fixup_fdt(blob) < 0) {
623 printf("ERROR: arch-specific fdt fixup failed\n");
627 fdt_ret = optee_copy_fdt_nodes(blob);
629 printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
630 fdt_strerror(fdt_ret));
634 /* Store name of configuration node as u-boot,bootconf in /chosen node */
635 if (images->fit_uname_cfg)
636 fdt_find_and_setprop(blob, "/chosen", "u-boot,bootconf",
637 images->fit_uname_cfg,
638 strlen(images->fit_uname_cfg) + 1, 1);
640 /* Update ethernet nodes */
641 fdt_fixup_ethernet(blob);
642 #if IS_ENABLED(CONFIG_CMD_PSTORE)
643 /* Append PStore configuration */
644 fdt_fixup_pstore(blob);
646 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP)) {
647 const char *skip_board_fixup;
649 skip_board_fixup = env_get("skip_board_fixup");
650 if (skip_board_fixup && ((int)simple_strtol(skip_board_fixup, NULL, 10) == 1)) {
651 printf("skip board fdt fixup\n");
653 fdt_ret = ft_board_setup(blob, gd->bd);
655 printf("ERROR: board-specific fdt fixup failed: %s\n",
656 fdt_strerror(fdt_ret));
661 if (IS_ENABLED(CONFIG_OF_SYSTEM_SETUP)) {
662 fdt_ret = ft_system_setup(blob, gd->bd);
664 printf("ERROR: system-specific fdt fixup failed: %s\n",
665 fdt_strerror(fdt_ret));
669 if (!of_live_active() && CONFIG_IS_ENABLED(EVENT)) {
670 struct event_ft_fixup fixup;
672 fixup.tree = oftree_from_fdt(blob);
673 fixup.images = images;
674 if (oftree_valid(fixup.tree)) {
675 ret = event_notify(EVT_FT_FIXUP, &fixup, sizeof(fixup));
677 printf("ERROR: fdt fixup event failed: %d\n",
684 /* Delete the old LMB reservation */
686 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
687 (phys_size_t)fdt_totalsize(blob));
689 ret = fdt_shrink_to_minimum(blob, 0);
694 if (*initrd_start && *initrd_end) {
695 of_size += FDT_RAMDISK_OVERHEAD;
696 fdt_set_totalsize(blob, of_size);
698 /* Create a new LMB reservation */
700 lmb_reserve(lmb, (ulong)blob, of_size);
702 fdt_initrd(blob, *initrd_start, *initrd_end);
703 if (!ft_verify_fdt(blob))
706 #if defined(CONFIG_ARCH_KEYSTONE)
707 if (IS_ENABLED(CONFIG_OF_BOARD_SETUP))
708 ft_board_setup_ex(blob, gd->bd);
713 printf(" - must RESET the board to recover.\n\n");