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