image-fdt.c 15 KB

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