image-fdt.c 13 KB

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