1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (c) 2013, Google Inc.
4 *
5 * (C) Copyright 2008 Semihalf
6 *
7 * (C) Copyright 2000-2006
8 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
9 */
10
11 #include <common.h>
12 #include <fdt_support.h>
13 #include <fdtdec.h>
14 #include <env.h>
15 #include <errno.h>
16 #include <image.h>
17 #include <lmb.h>
18 #include <log.h>
19 #include <malloc.h>
20 #include <asm/global_data.h>
21 #include <linux/libfdt.h>
22 #include <mapmem.h>
23 #include <asm/io.h>
24 #include <tee/optee.h>
25
26 #ifndef CONFIG_SYS_FDT_PAD
27 #define CONFIG_SYS_FDT_PAD 0x3000
28 #endif
29
30 /* adding a ramdisk needs 0x44 bytes in version 2008.10 */
31 #define FDT_RAMDISK_OVERHEAD 0x80
32
33 DECLARE_GLOBAL_DATA_PTR;
34
fdt_error(const char * msg)35 static void fdt_error(const char *msg)
36 {
37 puts("ERROR: ");
38 puts(msg);
39 puts(" - must RESET the board to recover.\n");
40 }
41
42 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
image_get_fdt(ulong fdt_addr)43 static const image_header_t *image_get_fdt(ulong fdt_addr)
44 {
45 const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);
46
47 image_print_contents(fdt_hdr);
48
49 puts(" Verifying Checksum ... ");
50 if (!image_check_hcrc(fdt_hdr)) {
51 fdt_error("fdt header checksum invalid");
52 return NULL;
53 }
54
55 if (!image_check_dcrc(fdt_hdr)) {
56 fdt_error("fdt checksum invalid");
57 return NULL;
58 }
59 puts("OK\n");
60
61 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
62 fdt_error("uImage is not a fdt");
63 return NULL;
64 }
65 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
66 fdt_error("uImage is compressed");
67 return NULL;
68 }
69 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
70 fdt_error("uImage data is not a fdt");
71 return NULL;
72 }
73 return fdt_hdr;
74 }
75 #endif
76
boot_fdt_reserve_region(struct lmb * lmb,uint64_t addr,uint64_t size)77 static void boot_fdt_reserve_region(struct lmb *lmb, uint64_t addr,
78 uint64_t size)
79 {
80 long ret;
81
82 ret = lmb_reserve(lmb, addr, size);
83 if (ret >= 0) {
84 debug(" reserving fdt memory region: addr=%llx size=%llx\n",
85 (unsigned long long)addr, (unsigned long long)size);
86 } else {
87 puts("ERROR: reserving fdt memory region failed ");
88 printf("(addr=%llx size=%llx)\n",
89 (unsigned long long)addr, (unsigned long long)size);
90 }
91 }
92
93 /**
94 * boot_fdt_add_mem_rsv_regions - Mark the memreserve and reserved-memory
95 * sections as unusable
96 * @lmb: pointer to lmb handle, will be used for memory mgmt
97 * @fdt_blob: pointer to fdt blob base address
98 *
99 * Adds the and reserved-memorymemreserve regions in the dtb to the lmb block.
100 * Adding the memreserve regions prevents u-boot from using them to store the
101 * initrd or the fdt blob.
102 */
boot_fdt_add_mem_rsv_regions(struct lmb * lmb,void * fdt_blob)103 void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
104 {
105 uint64_t addr, size;
106 int i, total, ret;
107 int nodeoffset, subnode;
108 struct fdt_resource res;
109
110 if (fdt_check_header(fdt_blob) != 0)
111 return;
112
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)
117 continue;
118 boot_fdt_reserve_region(lmb, addr, size);
119 }
120
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,
128 &res);
129 if (!ret && fdtdec_get_is_enabled(fdt_blob, subnode)) {
130 addr = res.start;
131 size = res.end - res.start + 1;
132 boot_fdt_reserve_region(lmb, addr, size);
133 }
134
135 subnode = fdt_next_subnode(fdt_blob, subnode);
136 }
137 }
138 }
139
140 /**
141 * boot_relocate_fdt - relocate flat device tree
142 * @lmb: pointer to lmb handle, will be used for memory mgmt
143 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
144 * @of_size: pointer to a ulong variable, will hold fdt length
145 *
146 * boot_relocate_fdt() allocates a region of memory within the bootmap and
147 * relocates the of_flat_tree into that region, even if the fdt is already in
148 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
149 * bytes.
150 *
151 * of_flat_tree and of_size are set to final (after relocation) values
152 *
153 * returns:
154 * 0 - success
155 * 1 - failure
156 */
boot_relocate_fdt(struct lmb * lmb,char ** of_flat_tree,ulong * of_size)157 int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
158 {
159 void *fdt_blob = *of_flat_tree;
160 void *of_start = NULL;
161 char *fdt_high;
162 ulong of_len = 0;
163 int err;
164 int disable_relocation = 0;
165
166 /* nothing to do */
167 if (*of_size == 0)
168 return 0;
169
170 if (fdt_check_header(fdt_blob) != 0) {
171 fdt_error("image is not a fdt");
172 goto error;
173 }
174
175 /* position on a 4K boundary before the alloc_current */
176 /* Pad the FDT by a specified amount */
177 of_len = *of_size + CONFIG_SYS_FDT_PAD;
178
179 /* If fdt_high is set use it to select the relocation address */
180 fdt_high = env_get("fdt_high");
181 if (fdt_high) {
182 void *desired_addr = (void *)simple_strtoul(fdt_high, NULL, 16);
183
184 if (((ulong) desired_addr) == ~0UL) {
185 /* All ones means use fdt in place */
186 of_start = fdt_blob;
187 lmb_reserve(lmb, (ulong)of_start, of_len);
188 disable_relocation = 1;
189 } else if (desired_addr) {
190 of_start =
191 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
192 (ulong)desired_addr);
193 if (of_start == NULL) {
194 puts("Failed using fdt_high value for Device Tree");
195 goto error;
196 }
197 } else {
198 of_start =
199 (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
200 }
201 } else {
202 of_start =
203 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
204 env_get_bootm_mapsize()
205 + env_get_bootm_low());
206 }
207
208 if (of_start == NULL) {
209 puts("device tree - allocation error\n");
210 goto error;
211 }
212
213 if (disable_relocation) {
214 /*
215 * We assume there is space after the existing fdt to use
216 * for padding
217 */
218 fdt_set_totalsize(of_start, of_len);
219 printf(" Using Device Tree in place at %p, end %p\n",
220 of_start, of_start + of_len - 1);
221 } else {
222 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
223 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
224
225 printf(" Loading Device Tree to %p, end %p ... ",
226 of_start, of_start + of_len - 1);
227
228 err = fdt_open_into(fdt_blob, of_start, of_len);
229 if (err != 0) {
230 fdt_error("fdt move failed");
231 goto error;
232 }
233 puts("OK\n");
234 }
235
236 *of_flat_tree = of_start;
237 *of_size = of_len;
238
239 if (CONFIG_IS_ENABLED(CMD_FDT))
240 set_working_fdt_addr(map_to_sysmem(*of_flat_tree));
241 return 0;
242
243 error:
244 return 1;
245 }
246
247 /**
248 * boot_get_fdt - main fdt handling routine
249 * @argc: command argument count
250 * @argv: command argument list
251 * @arch: architecture (IH_ARCH_...)
252 * @images: pointer to the bootm images structure
253 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
254 * @of_size: pointer to a ulong variable, will hold fdt length
255 *
256 * boot_get_fdt() is responsible for finding a valid flat device tree image.
257 * Curently supported are the following ramdisk sources:
258 * - multicomponent kernel/ramdisk image,
259 * - commandline provided address of decicated ramdisk image.
260 *
261 * returns:
262 * 0, if fdt image was found and valid, or skipped
263 * of_flat_tree and of_size are set to fdt start address and length if
264 * fdt image is found and valid
265 *
266 * 1, if fdt image is found but corrupted
267 * of_flat_tree and of_size are set to 0 if no fdt exists
268 */
boot_get_fdt(int flag,int argc,char * const argv[],uint8_t arch,bootm_headers_t * images,char ** of_flat_tree,ulong * of_size)269 int boot_get_fdt(int flag, int argc, char *const argv[], uint8_t arch,
270 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
271 {
272 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
273 const image_header_t *fdt_hdr;
274 ulong load, load_end;
275 ulong image_start, image_data, image_end;
276 #endif
277 ulong img_addr;
278 ulong fdt_addr;
279 char *fdt_blob = NULL;
280 void *buf;
281 #if CONFIG_IS_ENABLED(FIT)
282 const char *fit_uname_config = images->fit_uname_cfg;
283 const char *fit_uname_fdt = NULL;
284 ulong default_addr;
285 int fdt_noffset;
286 #endif
287 const char *select = NULL;
288
289 *of_flat_tree = NULL;
290 *of_size = 0;
291
292 img_addr = (argc == 0) ? image_load_addr :
293 simple_strtoul(argv[0], NULL, 16);
294 buf = map_sysmem(img_addr, 0);
295
296 if (argc > 2)
297 select = argv[2];
298 if (select || genimg_has_config(images)) {
299 #if CONFIG_IS_ENABLED(FIT)
300 if (select) {
301 /*
302 * If the FDT blob comes from the FIT image and the
303 * FIT image address is omitted in the command line
304 * argument, try to use ramdisk or os FIT image
305 * address or default load address.
306 */
307 if (images->fit_uname_rd)
308 default_addr = (ulong)images->fit_hdr_rd;
309 else if (images->fit_uname_os)
310 default_addr = (ulong)images->fit_hdr_os;
311 else
312 default_addr = image_load_addr;
313
314 if (fit_parse_conf(select, default_addr,
315 &fdt_addr, &fit_uname_config)) {
316 debug("* fdt: config '%s' from image at 0x%08lx\n",
317 fit_uname_config, fdt_addr);
318 } else if (fit_parse_subimage(select, default_addr,
319 &fdt_addr, &fit_uname_fdt)) {
320 debug("* fdt: subimage '%s' from image at 0x%08lx\n",
321 fit_uname_fdt, fdt_addr);
322 } else
323 #endif
324 {
325 fdt_addr = simple_strtoul(select, NULL, 16);
326 debug("* fdt: cmdline image address = 0x%08lx\n",
327 fdt_addr);
328 }
329 #if CONFIG_IS_ENABLED(FIT)
330 } else {
331 /* use FIT configuration provided in first bootm
332 * command argument
333 */
334 fdt_addr = map_to_sysmem(images->fit_hdr_os);
335 fdt_noffset = fit_get_node_from_config(images,
336 FIT_FDT_PROP,
337 fdt_addr);
338 if (fdt_noffset == -ENOENT)
339 return 0;
340 else if (fdt_noffset < 0)
341 return 1;
342 }
343 #endif
344 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
345 fdt_addr);
346
347 /*
348 * Check if there is an FDT image at the
349 * address provided in the second bootm argument
350 * check image type, for FIT images get a FIT node.
351 */
352 buf = map_sysmem(fdt_addr, 0);
353 switch (genimg_get_format(buf)) {
354 #if CONFIG_IS_ENABLED(LEGACY_IMAGE_FORMAT)
355 case IMAGE_FORMAT_LEGACY:
356 /* verify fdt_addr points to a valid image header */
357 printf("## Flattened Device Tree from Legacy Image at %08lx\n",
358 fdt_addr);
359 fdt_hdr = image_get_fdt(fdt_addr);
360 if (!fdt_hdr)
361 goto no_fdt;
362
363 /*
364 * move image data to the load address,
365 * make sure we don't overwrite initial image
366 */
367 image_start = (ulong)fdt_hdr;
368 image_data = (ulong)image_get_data(fdt_hdr);
369 image_end = image_get_image_end(fdt_hdr);
370
371 load = image_get_load(fdt_hdr);
372 load_end = load + image_get_data_size(fdt_hdr);
373
374 if (load == image_start ||
375 load == image_data) {
376 fdt_addr = load;
377 break;
378 }
379
380 if ((load < image_end) && (load_end > image_start)) {
381 fdt_error("fdt overwritten");
382 goto error;
383 }
384
385 debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
386 image_data, load);
387
388 memmove((void *)load,
389 (void *)image_data,
390 image_get_data_size(fdt_hdr));
391
392 fdt_addr = load;
393 break;
394 #endif
395 case IMAGE_FORMAT_FIT:
396 /*
397 * This case will catch both: new uImage format
398 * (libfdt based) and raw FDT blob (also libfdt
399 * based).
400 */
401 #if CONFIG_IS_ENABLED(FIT)
402 /* check FDT blob vs FIT blob */
403 if (!fit_check_format(buf, IMAGE_SIZE_INVAL)) {
404 ulong load, len;
405
406 fdt_noffset = boot_get_fdt_fit(images,
407 fdt_addr, &fit_uname_fdt,
408 &fit_uname_config,
409 arch, &load, &len);
410
411 if (fdt_noffset < 0)
412 goto error;
413
414 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
415 images->fit_uname_fdt = fit_uname_fdt;
416 images->fit_noffset_fdt = fdt_noffset;
417 fdt_addr = load;
418
419 break;
420 } else
421 #endif
422 {
423 /*
424 * FDT blob
425 */
426 debug("* fdt: raw FDT blob\n");
427 printf("## Flattened Device Tree blob at %08lx\n",
428 (long)fdt_addr);
429 }
430 break;
431 default:
432 puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
433 goto error;
434 }
435
436 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
437 fdt_blob = map_sysmem(fdt_addr, 0);
438 } else if (images->legacy_hdr_valid &&
439 image_check_type(&images->legacy_hdr_os_copy,
440 IH_TYPE_MULTI)) {
441 ulong fdt_data, fdt_len;
442
443 /*
444 * Now check if we have a legacy multi-component image,
445 * get second entry data start address and len.
446 */
447 printf("## Flattened Device Tree from multi component Image at %08lX\n",
448 (ulong)images->legacy_hdr_os);
449
450 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
451 &fdt_len);
452 if (fdt_len) {
453 fdt_blob = (char *)fdt_data;
454 printf(" Booting using the fdt at 0x%p\n", fdt_blob);
455
456 if (fdt_check_header(fdt_blob) != 0) {
457 fdt_error("image is not a fdt");
458 goto error;
459 }
460
461 if (fdt_totalsize(fdt_blob) != fdt_len) {
462 fdt_error("fdt size != image size");
463 goto error;
464 }
465 } else {
466 debug("## No Flattened Device Tree\n");
467 goto no_fdt;
468 }
469 #ifdef CONFIG_ANDROID_BOOT_IMAGE
470 } else if (genimg_get_format(buf) == IMAGE_FORMAT_ANDROID) {
471 struct andr_img_hdr *hdr = buf;
472 ulong fdt_data, fdt_len;
473 u32 fdt_size, dtb_idx;
474 /*
475 * Firstly check if this android boot image has dtb field.
476 */
477 dtb_idx = (u32)env_get_ulong("adtb_idx", 10, 0);
478 if (android_image_get_dtb_by_index((ulong)hdr, dtb_idx, &fdt_addr, &fdt_size)) {
479 fdt_blob = (char *)map_sysmem(fdt_addr, 0);
480 if (fdt_check_header(fdt_blob))
481 goto no_fdt;
482
483 debug("## Using FDT in Android image dtb area with idx %u\n", dtb_idx);
484 } else if (!android_image_get_second(hdr, &fdt_data, &fdt_len) &&
485 !fdt_check_header((char *)fdt_data)) {
486 fdt_blob = (char *)fdt_data;
487 if (fdt_totalsize(fdt_blob) != fdt_len)
488 goto error;
489
490 debug("## Using FDT in Android image second area\n");
491 } else {
492 fdt_addr = env_get_hex("fdtaddr", 0);
493 if (!fdt_addr)
494 goto no_fdt;
495
496 fdt_blob = map_sysmem(fdt_addr, 0);
497 if (fdt_check_header(fdt_blob))
498 goto no_fdt;
499
500 debug("## Using FDT at ${fdtaddr}=Ox%lx\n", fdt_addr);
501 }
502 #endif
503 } else {
504 debug("## No Flattened Device Tree\n");
505 goto no_fdt;
506 }
507
508 *of_flat_tree = fdt_blob;
509 *of_size = fdt_totalsize(fdt_blob);
510 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
511 (ulong)*of_flat_tree, *of_size);
512
513 return 0;
514
515 no_fdt:
516 debug("Continuing to boot without FDT\n");
517 return 0;
518 error:
519 return 1;
520 }
521
522 /*
523 * Verify the device tree.
524 *
525 * This function is called after all device tree fix-ups have been enacted,
526 * so that the final device tree can be verified. The definition of "verified"
527 * is up to the specific implementation. However, it generally means that the
528 * addresses of some of the devices in the device tree are compared with the
529 * actual addresses at which U-Boot has placed them.
530 *
531 * Returns 1 on success, 0 on failure. If 0 is returned, U-Boot will halt the
532 * boot process.
533 */
ft_verify_fdt(void * fdt)534 __weak int ft_verify_fdt(void *fdt)
535 {
536 return 1;
537 }
538
arch_fixup_fdt(void * blob)539 __weak int arch_fixup_fdt(void *blob)
540 {
541 return 0;
542 }
543
image_setup_libfdt(bootm_headers_t * images,void * blob,int of_size,struct lmb * lmb)544 int image_setup_libfdt(bootm_headers_t *images, void *blob,
545 int of_size, struct lmb *lmb)
546 {
547 ulong *initrd_start = &images->initrd_start;
548 ulong *initrd_end = &images->initrd_end;
549 int ret = -EPERM;
550 int fdt_ret;
551
552 if (fdt_root(blob) < 0) {
553 printf("ERROR: root node setup failed\n");
554 goto err;
555 }
556 if (fdt_chosen(blob) < 0) {
557 printf("ERROR: /chosen node create failed\n");
558 goto err;
559 }
560 if (arch_fixup_fdt(blob) < 0) {
561 printf("ERROR: arch-specific fdt fixup failed\n");
562 goto err;
563 }
564
565 fdt_ret = optee_copy_fdt_nodes(blob);
566 if (fdt_ret) {
567 printf("ERROR: transfer of optee nodes to new fdt failed: %s\n",
568 fdt_strerror(fdt_ret));
569 goto err;
570 }
571
572 /* Update ethernet nodes */
573 fdt_fixup_ethernet(blob);
574 #if CONFIG_IS_ENABLED(CMD_PSTORE)
575 /* Append PStore configuration */
576 fdt_fixup_pstore(blob);
577 #endif
578 if (IMAGE_OF_BOARD_SETUP) {
579 const char *skip_board_fixup;
580
581 skip_board_fixup = env_get("skip_board_fixup");
582 if (skip_board_fixup && ((int)simple_strtol(skip_board_fixup, NULL, 10) == 1)) {
583 printf("skip board fdt fixup\n");
584 } else {
585 fdt_ret = ft_board_setup(blob, gd->bd);
586 if (fdt_ret) {
587 printf("ERROR: board-specific fdt fixup failed: %s\n",
588 fdt_strerror(fdt_ret));
589 goto err;
590 }
591 }
592 }
593 if (IMAGE_OF_SYSTEM_SETUP) {
594 fdt_ret = ft_system_setup(blob, gd->bd);
595 if (fdt_ret) {
596 printf("ERROR: system-specific fdt fixup failed: %s\n",
597 fdt_strerror(fdt_ret));
598 goto err;
599 }
600 }
601
602 /* Delete the old LMB reservation */
603 if (lmb)
604 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
605 (phys_size_t)fdt_totalsize(blob));
606
607 ret = fdt_shrink_to_minimum(blob, 0);
608 if (ret < 0)
609 goto err;
610 of_size = ret;
611
612 if (*initrd_start && *initrd_end) {
613 of_size += FDT_RAMDISK_OVERHEAD;
614 fdt_set_totalsize(blob, of_size);
615 }
616 /* Create a new LMB reservation */
617 if (lmb)
618 lmb_reserve(lmb, (ulong)blob, of_size);
619
620 fdt_initrd(blob, *initrd_start, *initrd_end);
621 if (!ft_verify_fdt(blob))
622 goto err;
623
624 #if defined(CONFIG_SOC_KEYSTONE)
625 if (IMAGE_OF_BOARD_SETUP)
626 ft_board_setup_ex(blob, gd->bd);
627 #endif
628
629 return 0;
630 err:
631 printf(" - must RESET the board to recover.\n\n");
632
633 return ret;
634 }
635