image-fdt.c 15 KB

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