blob: a2342fa3dfdd07c1de766200986cfac97579aa4d [file] [log] [blame]
Simon Glass44d3a302013-05-08 08:06:00 +00001/*
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 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02009 * SPDX-License-Identifier: GPL-2.0+
Simon Glass44d3a302013-05-08 08:06:00 +000010 */
11
12#include <common.h>
13#include <fdt_support.h>
14#include <errno.h>
15#include <image.h>
16#include <libfdt.h>
17#include <asm/io.h>
18
19#ifndef CONFIG_SYS_FDT_PAD
20#define CONFIG_SYS_FDT_PAD 0x3000
21#endif
22
23DECLARE_GLOBAL_DATA_PTR;
24
25static void fdt_error(const char *msg)
26{
27 puts("ERROR: ");
28 puts(msg);
29 puts(" - must RESET the board to recover.\n");
30}
31
Heiko Schocher21d29f72014-05-28 11:33:33 +020032#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Simon Glass44d3a302013-05-08 08:06:00 +000033static const image_header_t *image_get_fdt(ulong fdt_addr)
34{
35 const image_header_t *fdt_hdr = map_sysmem(fdt_addr, 0);
36
37 image_print_contents(fdt_hdr);
38
39 puts(" Verifying Checksum ... ");
40 if (!image_check_hcrc(fdt_hdr)) {
41 fdt_error("fdt header checksum invalid");
42 return NULL;
43 }
44
45 if (!image_check_dcrc(fdt_hdr)) {
46 fdt_error("fdt checksum invalid");
47 return NULL;
48 }
49 puts("OK\n");
50
51 if (!image_check_type(fdt_hdr, IH_TYPE_FLATDT)) {
52 fdt_error("uImage is not a fdt");
53 return NULL;
54 }
55 if (image_get_comp(fdt_hdr) != IH_COMP_NONE) {
56 fdt_error("uImage is compressed");
57 return NULL;
58 }
Masahiro Yamada2f0877c2013-09-19 12:10:18 +090059 if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
Simon Glass44d3a302013-05-08 08:06:00 +000060 fdt_error("uImage data is not a fdt");
61 return NULL;
62 }
63 return fdt_hdr;
64}
Heiko Schocher21d29f72014-05-28 11:33:33 +020065#endif
Simon Glass44d3a302013-05-08 08:06:00 +000066
67/**
68 * boot_fdt_add_mem_rsv_regions - Mark the memreserve sections as unusable
69 * @lmb: pointer to lmb handle, will be used for memory mgmt
70 * @fdt_blob: pointer to fdt blob base address
71 *
72 * Adds the memreserve regions in the dtb to the lmb block. Adding the
73 * memreserve regions prevents u-boot from using them to store the initrd
74 * or the fdt blob.
75 */
76void boot_fdt_add_mem_rsv_regions(struct lmb *lmb, void *fdt_blob)
77{
78 uint64_t addr, size;
79 int i, total;
80
81 if (fdt_check_header(fdt_blob) != 0)
82 return;
83
84 total = fdt_num_mem_rsv(fdt_blob);
85 for (i = 0; i < total; i++) {
86 if (fdt_get_mem_rsv(fdt_blob, i, &addr, &size) != 0)
87 continue;
88 printf(" reserving fdt memory region: addr=%llx size=%llx\n",
89 (unsigned long long)addr, (unsigned long long)size);
90 lmb_reserve(lmb, addr, size);
91 }
92}
93
94/**
95 * boot_relocate_fdt - relocate flat device tree
96 * @lmb: pointer to lmb handle, will be used for memory mgmt
97 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
98 * @of_size: pointer to a ulong variable, will hold fdt length
99 *
100 * boot_relocate_fdt() allocates a region of memory within the bootmap and
101 * relocates the of_flat_tree into that region, even if the fdt is already in
102 * the bootmap. It also expands the size of the fdt by CONFIG_SYS_FDT_PAD
103 * bytes.
104 *
105 * of_flat_tree and of_size are set to final (after relocation) values
106 *
107 * returns:
108 * 0 - success
109 * 1 - failure
110 */
111int boot_relocate_fdt(struct lmb *lmb, char **of_flat_tree, ulong *of_size)
112{
113 void *fdt_blob = *of_flat_tree;
114 void *of_start = NULL;
115 char *fdt_high;
116 ulong of_len = 0;
117 int err;
118 int disable_relocation = 0;
119
120 /* nothing to do */
121 if (*of_size == 0)
122 return 0;
123
124 if (fdt_check_header(fdt_blob) != 0) {
125 fdt_error("image is not a fdt");
126 goto error;
127 }
128
129 /* position on a 4K boundary before the alloc_current */
130 /* Pad the FDT by a specified amount */
131 of_len = *of_size + CONFIG_SYS_FDT_PAD;
132
133 /* If fdt_high is set use it to select the relocation address */
134 fdt_high = getenv("fdt_high");
135 if (fdt_high) {
136 void *desired_addr = (void *)simple_strtoul(fdt_high, NULL, 16);
137
138 if (((ulong) desired_addr) == ~0UL) {
139 /* All ones means use fdt in place */
140 of_start = fdt_blob;
141 lmb_reserve(lmb, (ulong)of_start, of_len);
142 disable_relocation = 1;
143 } else if (desired_addr) {
144 of_start =
145 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
146 (ulong)desired_addr);
147 if (of_start == NULL) {
148 puts("Failed using fdt_high value for Device Tree");
149 goto error;
150 }
151 } else {
152 of_start =
153 (void *)(ulong) lmb_alloc(lmb, of_len, 0x1000);
154 }
155 } else {
156 of_start =
157 (void *)(ulong) lmb_alloc_base(lmb, of_len, 0x1000,
158 getenv_bootm_mapsize()
159 + getenv_bootm_low());
160 }
161
162 if (of_start == NULL) {
163 puts("device tree - allocation error\n");
164 goto error;
165 }
166
167 if (disable_relocation) {
168 /*
169 * We assume there is space after the existing fdt to use
170 * for padding
171 */
172 fdt_set_totalsize(of_start, of_len);
173 printf(" Using Device Tree in place at %p, end %p\n",
174 of_start, of_start + of_len - 1);
175 } else {
176 debug("## device tree at %p ... %p (len=%ld [0x%lX])\n",
177 fdt_blob, fdt_blob + *of_size - 1, of_len, of_len);
178
179 printf(" Loading Device Tree to %p, end %p ... ",
180 of_start, of_start + of_len - 1);
181
182 err = fdt_open_into(fdt_blob, of_start, of_len);
183 if (err != 0) {
184 fdt_error("fdt move failed");
185 goto error;
186 }
187 puts("OK\n");
188 }
189
190 *of_flat_tree = of_start;
191 *of_size = of_len;
192
193 set_working_fdt_addr(*of_flat_tree);
194 return 0;
195
196error:
197 return 1;
198}
199
Simon Glass44d3a302013-05-08 08:06:00 +0000200/**
201 * boot_get_fdt - main fdt handling routine
202 * @argc: command argument count
203 * @argv: command argument list
Simon Glass53f375f2013-05-16 13:53:23 +0000204 * @arch: architecture (IH_ARCH_...)
Simon Glass44d3a302013-05-08 08:06:00 +0000205 * @images: pointer to the bootm images structure
206 * @of_flat_tree: pointer to a char* variable, will hold fdt start address
207 * @of_size: pointer to a ulong variable, will hold fdt length
208 *
209 * boot_get_fdt() is responsible for finding a valid flat device tree image.
210 * Curently supported are the following ramdisk sources:
211 * - multicomponent kernel/ramdisk image,
212 * - commandline provided address of decicated ramdisk image.
213 *
214 * returns:
215 * 0, if fdt image was found and valid, or skipped
216 * of_flat_tree and of_size are set to fdt start address and length if
217 * fdt image is found and valid
218 *
219 * 1, if fdt image is found but corrupted
220 * of_flat_tree and of_size are set to 0 if no fdt exists
221 */
Simon Glass53f375f2013-05-16 13:53:23 +0000222int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
Simon Glass44d3a302013-05-08 08:06:00 +0000223 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
224{
Heiko Schocher21d29f72014-05-28 11:33:33 +0200225#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Simon Glass44d3a302013-05-08 08:06:00 +0000226 const image_header_t *fdt_hdr;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200227 ulong load, load_end;
228 ulong image_start, image_data, image_end;
229#endif
Simon Glass44d3a302013-05-08 08:06:00 +0000230 ulong fdt_addr;
231 char *fdt_blob = NULL;
Simon Glass44d3a302013-05-08 08:06:00 +0000232 void *buf;
233#if defined(CONFIG_FIT)
Simon Glassf320a4d2013-07-10 23:08:10 -0700234 const char *fit_uname_config = images->fit_uname_cfg;
Simon Glass44d3a302013-05-08 08:06:00 +0000235 const char *fit_uname_fdt = NULL;
236 ulong default_addr;
Simon Glass44d3a302013-05-08 08:06:00 +0000237 int fdt_noffset;
Simon Glass44d3a302013-05-08 08:06:00 +0000238#endif
Simon Glass983c72f2013-06-11 11:14:46 -0700239 const char *select = NULL;
Simon Glass44d3a302013-05-08 08:06:00 +0000240
241 *of_flat_tree = NULL;
242 *of_size = 0;
243
Simon Glass983c72f2013-06-11 11:14:46 -0700244 if (argc > 2)
245 select = argv[2];
246 if (select || genimg_has_config(images)) {
Simon Glass44d3a302013-05-08 08:06:00 +0000247#if defined(CONFIG_FIT)
Simon Glass983c72f2013-06-11 11:14:46 -0700248 if (select) {
Simon Glass44d3a302013-05-08 08:06:00 +0000249 /*
250 * If the FDT blob comes from the FIT image and the
251 * FIT image address is omitted in the command line
252 * argument, try to use ramdisk or os FIT image
253 * address or default load address.
254 */
255 if (images->fit_uname_rd)
256 default_addr = (ulong)images->fit_hdr_rd;
257 else if (images->fit_uname_os)
258 default_addr = (ulong)images->fit_hdr_os;
259 else
260 default_addr = load_addr;
261
Simon Glass983c72f2013-06-11 11:14:46 -0700262 if (fit_parse_conf(select, default_addr,
Simon Glass44d3a302013-05-08 08:06:00 +0000263 &fdt_addr, &fit_uname_config)) {
264 debug("* fdt: config '%s' from image at 0x%08lx\n",
265 fit_uname_config, fdt_addr);
Simon Glass983c72f2013-06-11 11:14:46 -0700266 } else if (fit_parse_subimage(select, default_addr,
Simon Glass44d3a302013-05-08 08:06:00 +0000267 &fdt_addr, &fit_uname_fdt)) {
268 debug("* fdt: subimage '%s' from image at 0x%08lx\n",
269 fit_uname_fdt, fdt_addr);
270 } else
271#endif
272 {
Simon Glass983c72f2013-06-11 11:14:46 -0700273 fdt_addr = simple_strtoul(select, NULL, 16);
Simon Glass44d3a302013-05-08 08:06:00 +0000274 debug("* fdt: cmdline image address = 0x%08lx\n",
275 fdt_addr);
276 }
277#if defined(CONFIG_FIT)
278 } else {
279 /* use FIT configuration provided in first bootm
280 * command argument
281 */
282 fdt_addr = map_to_sysmem(images->fit_hdr_os);
Simon Glass53f375f2013-05-16 13:53:23 +0000283 fdt_noffset = fit_get_node_from_config(images,
284 FIT_FDT_PROP,
285 fdt_addr);
286 if (fdt_noffset == -ENOLINK)
Simon Glass44d3a302013-05-08 08:06:00 +0000287 return 0;
Simon Glass53f375f2013-05-16 13:53:23 +0000288 else if (fdt_noffset < 0)
289 return 1;
Simon Glass44d3a302013-05-08 08:06:00 +0000290 }
291#endif
Simon Glass44d3a302013-05-08 08:06:00 +0000292 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
293 fdt_addr);
294
295 /* copy from dataflash if needed */
296 fdt_addr = genimg_get_image(fdt_addr);
297
298 /*
299 * Check if there is an FDT image at the
300 * address provided in the second bootm argument
301 * check image type, for FIT images get a FIT node.
302 */
303 buf = map_sysmem(fdt_addr, 0);
304 switch (genimg_get_format(buf)) {
Heiko Schocher21d29f72014-05-28 11:33:33 +0200305#if defined(CONFIG_IMAGE_FORMAT_LEGACY)
Simon Glass44d3a302013-05-08 08:06:00 +0000306 case IMAGE_FORMAT_LEGACY:
307 /* verify fdt_addr points to a valid image header */
308 printf("## Flattened Device Tree from Legacy Image at %08lx\n",
309 fdt_addr);
310 fdt_hdr = image_get_fdt(fdt_addr);
311 if (!fdt_hdr)
312 goto error;
313
314 /*
315 * move image data to the load address,
316 * make sure we don't overwrite initial image
317 */
318 image_start = (ulong)fdt_hdr;
319 image_data = (ulong)image_get_data(fdt_hdr);
320 image_end = image_get_image_end(fdt_hdr);
321
Simon Glass53f375f2013-05-16 13:53:23 +0000322 load = image_get_load(fdt_hdr);
323 load_end = load + image_get_data_size(fdt_hdr);
Simon Glass44d3a302013-05-08 08:06:00 +0000324
Simon Glass53f375f2013-05-16 13:53:23 +0000325 if (load == image_start ||
326 load == image_data) {
Simon Glass44d3a302013-05-08 08:06:00 +0000327 fdt_blob = (char *)image_data;
328 break;
329 }
330
Simon Glass53f375f2013-05-16 13:53:23 +0000331 if ((load < image_end) && (load_end > image_start)) {
Simon Glass44d3a302013-05-08 08:06:00 +0000332 fdt_error("fdt overwritten");
333 goto error;
334 }
335
336 debug(" Loading FDT from 0x%08lx to 0x%08lx\n",
Simon Glass53f375f2013-05-16 13:53:23 +0000337 image_data, load);
Simon Glass44d3a302013-05-08 08:06:00 +0000338
Simon Glass53f375f2013-05-16 13:53:23 +0000339 memmove((void *)load,
Simon Glass44d3a302013-05-08 08:06:00 +0000340 (void *)image_data,
341 image_get_data_size(fdt_hdr));
342
Simon Glass53f375f2013-05-16 13:53:23 +0000343 fdt_addr = load;
Simon Glass44d3a302013-05-08 08:06:00 +0000344 break;
Heiko Schocher21d29f72014-05-28 11:33:33 +0200345#endif
Simon Glass44d3a302013-05-08 08:06:00 +0000346 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 defined(CONFIG_FIT)
353 /* check FDT blob vs FIT blob */
354 if (fit_check_format(buf)) {
Simon Glass53f375f2013-05-16 13:53:23 +0000355 ulong load, len;
Simon Glass44d3a302013-05-08 08:06:00 +0000356
Simon Glass53f375f2013-05-16 13:53:23 +0000357 fdt_noffset = fit_image_load(images,
Simon Glass53f375f2013-05-16 13:53:23 +0000358 fdt_addr, &fit_uname_fdt,
Simon Glassf320a4d2013-07-10 23:08:10 -0700359 &fit_uname_config,
Simon Glass53f375f2013-05-16 13:53:23 +0000360 arch, IH_TYPE_FLATDT,
361 BOOTSTAGE_ID_FIT_FDT_START,
362 FIT_LOAD_OPTIONAL, &load, &len);
Simon Glass44d3a302013-05-08 08:06:00 +0000363
Simon Glass53f375f2013-05-16 13:53:23 +0000364 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
Simon Glass44d3a302013-05-08 08:06:00 +0000365 images->fit_uname_fdt = fit_uname_fdt;
366 images->fit_noffset_fdt = fdt_noffset;
Simon Glass53f375f2013-05-16 13:53:23 +0000367 fdt_addr = load;
Simon Glass44d3a302013-05-08 08:06:00 +0000368 break;
369 } else
370#endif
371 {
372 /*
373 * FDT blob
374 */
Simon Glass44d3a302013-05-08 08:06:00 +0000375 debug("* fdt: raw FDT blob\n");
376 printf("## Flattened Device Tree blob at %08lx\n",
377 (long)fdt_addr);
378 }
379 break;
380 default:
381 puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
382 goto error;
383 }
384
Simon Glass53f375f2013-05-16 13:53:23 +0000385 printf(" Booting using the fdt blob at %#08lx\n", fdt_addr);
386 fdt_blob = map_sysmem(fdt_addr, 0);
Simon Glass44d3a302013-05-08 08:06:00 +0000387 } else if (images->legacy_hdr_valid &&
388 image_check_type(&images->legacy_hdr_os_copy,
389 IH_TYPE_MULTI)) {
390 ulong fdt_data, fdt_len;
391
392 /*
393 * Now check if we have a legacy multi-component image,
394 * get second entry data start address and len.
395 */
396 printf("## Flattened Device Tree from multi component Image at %08lX\n",
397 (ulong)images->legacy_hdr_os);
398
399 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
400 &fdt_len);
401 if (fdt_len) {
402 fdt_blob = (char *)fdt_data;
403 printf(" Booting using the fdt at 0x%p\n", fdt_blob);
404
405 if (fdt_check_header(fdt_blob) != 0) {
406 fdt_error("image is not a fdt");
407 goto error;
408 }
409
410 if (fdt_totalsize(fdt_blob) != fdt_len) {
411 fdt_error("fdt size != image size");
412 goto error;
413 }
414 } else {
415 debug("## No Flattened Device Tree\n");
416 return 0;
417 }
418 } else {
419 debug("## No Flattened Device Tree\n");
420 return 0;
421 }
422
423 *of_flat_tree = fdt_blob;
424 *of_size = fdt_totalsize(fdt_blob);
425 debug(" of_flat_tree at 0x%08lx size 0x%08lx\n",
426 (ulong)*of_flat_tree, *of_size);
427
428 return 0;
429
430error:
431 *of_flat_tree = NULL;
432 *of_size = 0;
433 return 1;
434}
Simon Glass13d06982013-05-08 08:06:01 +0000435
436/*
437 * Verify the device tree.
438 *
439 * This function is called after all device tree fix-ups have been enacted,
440 * so that the final device tree can be verified. The definition of "verified"
441 * is up to the specific implementation. However, it generally means that the
442 * addresses of some of the devices in the device tree are compared with the
443 * actual addresses at which U-Boot has placed them.
444 *
445 * Returns 1 on success, 0 on failure. If 0 is returned, U-boot will halt the
446 * boot process.
447 */
448__weak int ft_verify_fdt(void *fdt)
449{
450 return 1;
451}
452
Ma Haijune29607e2014-07-12 14:24:06 +0100453__weak int arch_fixup_fdt(void *blob)
Simon Glass13d06982013-05-08 08:06:01 +0000454{
455 return 0;
456}
457
458int image_setup_libfdt(bootm_headers_t *images, void *blob,
459 int of_size, struct lmb *lmb)
460{
461 ulong *initrd_start = &images->initrd_start;
462 ulong *initrd_end = &images->initrd_end;
463 int ret;
464
Masahiro Yamadabc6ed0f2014-04-18 17:41:00 +0900465 if (fdt_chosen(blob) < 0) {
Simon Glass13d06982013-05-08 08:06:01 +0000466 puts("ERROR: /chosen node create failed");
467 puts(" - must RESET the board to recover.\n");
468 return -1;
469 }
Ma Haijune29607e2014-07-12 14:24:06 +0100470 if (arch_fixup_fdt(blob) < 0) {
471 puts("ERROR: arch specific fdt fixup failed");
472 return -1;
473 }
Masahiro Yamada95f70622014-01-29 16:29:16 +0900474 if (IMAGE_OF_BOARD_SETUP)
Simon Glass13d06982013-05-08 08:06:01 +0000475 ft_board_setup(blob, gd->bd);
476 fdt_fixup_ethernet(blob);
477
478 /* Delete the old LMB reservation */
479 lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
480 (phys_size_t)fdt_totalsize(blob));
481
Simon Glass5bf58cc2014-07-30 03:59:02 -0600482 ret = fdt_shrink_to_minimum(blob);
Simon Glass13d06982013-05-08 08:06:01 +0000483 if (ret < 0)
484 return ret;
485 of_size = ret;
486
487 if (*initrd_start && *initrd_end) {
488 of_size += FDT_RAMDISK_OVERHEAD;
489 fdt_set_totalsize(blob, of_size);
490 }
491 /* Create a new LMB reservation */
492 lmb_reserve(lmb, (ulong)blob, of_size);
493
Masahiro Yamadadbe963a2014-04-18 17:40:59 +0900494 fdt_initrd(blob, *initrd_start, *initrd_end);
Simon Glass13d06982013-05-08 08:06:01 +0000495 if (!ft_verify_fdt(blob))
496 return -1;
497
Khoronzhuk, Ivan7c387642014-07-16 00:59:25 +0300498#if defined(CONFIG_SOC_KEYSTONE)
Vitaly Andrianov00c200f2014-04-04 13:16:47 -0400499 if (IMAGE_OF_BOARD_SETUP)
500 ft_board_setup_ex(blob, gd->bd);
501#endif
502
Simon Glass13d06982013-05-08 08:06:01 +0000503 return 0;
504}