sunxi: USB download gadget cable detection
[oweals/u-boot.git] / common / image-fdt.c
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
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
23 DECLARE_GLOBAL_DATA_PTR;
24
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
32 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
33 static 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         }
59         if (fdt_check_header((void *)image_get_data(fdt_hdr)) != 0) {
60                 fdt_error("uImage data is not a fdt");
61                 return NULL;
62         }
63         return fdt_hdr;
64 }
65 #endif
66
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  */
76 void 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  */
111 int 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((ulong)*of_flat_tree);
194         return 0;
195
196 error:
197         return 1;
198 }
199
200 /**
201  * boot_get_fdt - main fdt handling routine
202  * @argc: command argument count
203  * @argv: command argument list
204  * @arch: architecture (IH_ARCH_...)
205  * @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  */
222 int boot_get_fdt(int flag, int argc, char * const argv[], uint8_t arch,
223                 bootm_headers_t *images, char **of_flat_tree, ulong *of_size)
224 {
225 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
226         const image_header_t *fdt_hdr;
227         ulong           load, load_end;
228         ulong           image_start, image_data, image_end;
229 #endif
230         ulong           fdt_addr;
231         char            *fdt_blob = NULL;
232         void            *buf;
233 #if defined(CONFIG_FIT)
234         const char      *fit_uname_config = images->fit_uname_cfg;
235         const char      *fit_uname_fdt = NULL;
236         ulong           default_addr;
237         int             fdt_noffset;
238 #endif
239         const char *select = NULL;
240         int             ok_no_fdt = 0;
241
242         *of_flat_tree = NULL;
243         *of_size = 0;
244
245         if (argc > 2)
246                 select = argv[2];
247         if (select || genimg_has_config(images)) {
248 #if defined(CONFIG_FIT)
249                 if (select) {
250                         /*
251                          * If the FDT blob comes from the FIT image and the
252                          * FIT image address is omitted in the command line
253                          * argument, try to use ramdisk or os FIT image
254                          * address or default load address.
255                          */
256                         if (images->fit_uname_rd)
257                                 default_addr = (ulong)images->fit_hdr_rd;
258                         else if (images->fit_uname_os)
259                                 default_addr = (ulong)images->fit_hdr_os;
260                         else
261                                 default_addr = load_addr;
262
263                         if (fit_parse_conf(select, default_addr,
264                                            &fdt_addr, &fit_uname_config)) {
265                                 debug("*  fdt: config '%s' from image at 0x%08lx\n",
266                                       fit_uname_config, fdt_addr);
267                         } else if (fit_parse_subimage(select, default_addr,
268                                    &fdt_addr, &fit_uname_fdt)) {
269                                 debug("*  fdt: subimage '%s' from image at 0x%08lx\n",
270                                       fit_uname_fdt, fdt_addr);
271                         } else
272 #endif
273                         {
274                                 fdt_addr = simple_strtoul(select, NULL, 16);
275                                 debug("*  fdt: cmdline image address = 0x%08lx\n",
276                                       fdt_addr);
277                         }
278 #if defined(CONFIG_FIT)
279                 } else {
280                         /* use FIT configuration provided in first bootm
281                          * command argument
282                          */
283                         fdt_addr = map_to_sysmem(images->fit_hdr_os);
284                         fdt_noffset = fit_get_node_from_config(images,
285                                                                FIT_FDT_PROP,
286                                                                fdt_addr);
287                         if (fdt_noffset == -ENOLINK)
288                                 return 0;
289                         else if (fdt_noffset < 0)
290                                 return 1;
291                 }
292 #endif
293                 debug("## Checking for 'FDT'/'FDT Image' at %08lx\n",
294                       fdt_addr);
295
296                 /* copy from dataflash if needed */
297                 fdt_addr = genimg_get_image(fdt_addr);
298
299                 /*
300                  * Check if there is an FDT image at the
301                  * address provided in the second bootm argument
302                  * check image type, for FIT images get a FIT node.
303                  */
304                 buf = map_sysmem(fdt_addr, 0);
305                 switch (genimg_get_format(buf)) {
306 #if defined(CONFIG_IMAGE_FORMAT_LEGACY)
307                 case IMAGE_FORMAT_LEGACY:
308                         /* verify fdt_addr points to a valid image header */
309                         printf("## Flattened Device Tree from Legacy Image at %08lx\n",
310                                fdt_addr);
311                         fdt_hdr = image_get_fdt(fdt_addr);
312                         if (!fdt_hdr)
313                                 goto no_fdt;
314
315                         /*
316                          * move image data to the load address,
317                          * make sure we don't overwrite initial image
318                          */
319                         image_start = (ulong)fdt_hdr;
320                         image_data = (ulong)image_get_data(fdt_hdr);
321                         image_end = image_get_image_end(fdt_hdr);
322
323                         load = image_get_load(fdt_hdr);
324                         load_end = load + image_get_data_size(fdt_hdr);
325
326                         if (load == image_start ||
327                             load == image_data) {
328                                 fdt_blob = (char *)image_data;
329                                 break;
330                         }
331
332                         if ((load < image_end) && (load_end > image_start)) {
333                                 fdt_error("fdt overwritten");
334                                 goto error;
335                         }
336
337                         debug("   Loading FDT from 0x%08lx to 0x%08lx\n",
338                               image_data, load);
339
340                         memmove((void *)load,
341                                 (void *)image_data,
342                                 image_get_data_size(fdt_hdr));
343
344                         fdt_addr = load;
345                         break;
346 #endif
347                 case IMAGE_FORMAT_FIT:
348                         /*
349                          * This case will catch both: new uImage format
350                          * (libfdt based) and raw FDT blob (also libfdt
351                          * based).
352                          */
353 #if defined(CONFIG_FIT)
354                         /* check FDT blob vs FIT blob */
355                         if (fit_check_format(buf)) {
356                                 ulong load, len;
357
358                                 fdt_noffset = fit_image_load(images,
359                                         fdt_addr, &fit_uname_fdt,
360                                         &fit_uname_config,
361                                         arch, IH_TYPE_FLATDT,
362                                         BOOTSTAGE_ID_FIT_FDT_START,
363                                         FIT_LOAD_OPTIONAL, &load, &len);
364
365                                 images->fit_hdr_fdt = map_sysmem(fdt_addr, 0);
366                                 images->fit_uname_fdt = fit_uname_fdt;
367                                 images->fit_noffset_fdt = fdt_noffset;
368                                 fdt_addr = load;
369                                 break;
370                         } else
371 #endif
372                         {
373                                 /*
374                                  * FDT blob
375                                  */
376                                 debug("*  fdt: raw FDT blob\n");
377                                 printf("## Flattened Device Tree blob at %08lx\n",
378                                        (long)fdt_addr);
379                         }
380                         break;
381                 default:
382                         puts("ERROR: Did not find a cmdline Flattened Device Tree\n");
383                         goto no_fdt;
384                 }
385
386                 printf("   Booting using the fdt blob at %#08lx\n", fdt_addr);
387                 fdt_blob = map_sysmem(fdt_addr, 0);
388         } else if (images->legacy_hdr_valid &&
389                         image_check_type(&images->legacy_hdr_os_copy,
390                                          IH_TYPE_MULTI)) {
391                 ulong fdt_data, fdt_len;
392
393                 /*
394                  * Now check if we have a legacy multi-component image,
395                  * get second entry data start address and len.
396                  */
397                 printf("## Flattened Device Tree from multi component Image at %08lX\n",
398                        (ulong)images->legacy_hdr_os);
399
400                 image_multi_getimg(images->legacy_hdr_os, 2, &fdt_data,
401                                    &fdt_len);
402                 if (fdt_len) {
403                         fdt_blob = (char *)fdt_data;
404                         printf("   Booting using the fdt at 0x%p\n", fdt_blob);
405
406                         if (fdt_check_header(fdt_blob) != 0) {
407                                 fdt_error("image is not a fdt");
408                                 goto error;
409                         }
410
411                         if (fdt_totalsize(fdt_blob) != fdt_len) {
412                                 fdt_error("fdt size != image size");
413                                 goto error;
414                         }
415                 } else {
416                         debug("## No Flattened Device Tree\n");
417                         goto no_fdt;
418                 }
419         } else {
420                 debug("## No Flattened Device Tree\n");
421                 goto no_fdt;
422         }
423
424         *of_flat_tree = fdt_blob;
425         *of_size = fdt_totalsize(fdt_blob);
426         debug("   of_flat_tree at 0x%08lx size 0x%08lx\n",
427               (ulong)*of_flat_tree, *of_size);
428
429         return 0;
430
431 no_fdt:
432         ok_no_fdt = 1;
433 error:
434         *of_flat_tree = NULL;
435         *of_size = 0;
436         if (!select && ok_no_fdt) {
437                 debug("Continuing to boot without FDT\n");
438                 return 0;
439         }
440         return 1;
441 }
442
443 /*
444  * Verify the device tree.
445  *
446  * This function is called after all device tree fix-ups have been enacted,
447  * so that the final device tree can be verified.  The definition of "verified"
448  * is up to the specific implementation.  However, it generally means that the
449  * addresses of some of the devices in the device tree are compared with the
450  * actual addresses at which U-Boot has placed them.
451  *
452  * Returns 1 on success, 0 on failure.  If 0 is returned, U-boot will halt the
453  * boot process.
454  */
455 __weak int ft_verify_fdt(void *fdt)
456 {
457         return 1;
458 }
459
460 __weak int arch_fixup_fdt(void *blob)
461 {
462         return 0;
463 }
464
465 int image_setup_libfdt(bootm_headers_t *images, void *blob,
466                        int of_size, struct lmb *lmb)
467 {
468         ulong *initrd_start = &images->initrd_start;
469         ulong *initrd_end = &images->initrd_end;
470         int ret = -EPERM;
471         int fdt_ret;
472
473         if (fdt_chosen(blob) < 0) {
474                 printf("ERROR: /chosen node create failed\n");
475                 goto err;
476         }
477         if (arch_fixup_fdt(blob) < 0) {
478                 printf("ERROR: arch-specific fdt fixup failed\n");
479                 goto err;
480         }
481         if (IMAGE_OF_BOARD_SETUP) {
482                 fdt_ret = ft_board_setup(blob, gd->bd);
483                 if (fdt_ret) {
484                         printf("ERROR: board-specific fdt fixup failed: %s\n",
485                                fdt_strerror(fdt_ret));
486                         goto err;
487                 }
488         }
489         if (IMAGE_OF_SYSTEM_SETUP) {
490                 if (ft_system_setup(blob, gd->bd)) {
491                         printf("ERROR: system-specific fdt fixup failed: %s\n",
492                                fdt_strerror(fdt_ret));
493                         goto err;
494                 }
495         }
496         fdt_fixup_ethernet(blob);
497
498         /* Delete the old LMB reservation */
499         lmb_free(lmb, (phys_addr_t)(u32)(uintptr_t)blob,
500                  (phys_size_t)fdt_totalsize(blob));
501
502         ret = fdt_shrink_to_minimum(blob);
503         if (ret < 0)
504                 goto err;
505         of_size = ret;
506
507         if (*initrd_start && *initrd_end) {
508                 of_size += FDT_RAMDISK_OVERHEAD;
509                 fdt_set_totalsize(blob, of_size);
510         }
511         /* Create a new LMB reservation */
512         lmb_reserve(lmb, (ulong)blob, of_size);
513
514         fdt_initrd(blob, *initrd_start, *initrd_end);
515         if (!ft_verify_fdt(blob))
516                 goto err;
517
518 #if defined(CONFIG_SOC_KEYSTONE)
519         if (IMAGE_OF_BOARD_SETUP)
520                 ft_board_setup_ex(blob, gd->bd);
521 #endif
522
523         return 0;
524 err:
525         printf(" - must RESET the board to recover.\n\n");
526
527         return ret;
528 }