Merge https://gitlab.denx.de/u-boot/custodians/u-boot-riscv
[oweals/u-boot.git] / lib / fdtdec.c
1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3  * Copyright (c) 2011 The Chromium OS Authors.
4  */
5
6 #ifndef USE_HOSTCC
7 #include <common.h>
8 #include <boot_fit.h>
9 #include <dm.h>
10 #include <dm/of_extra.h>
11 #include <env.h>
12 #include <errno.h>
13 #include <fdtdec.h>
14 #include <fdt_support.h>
15 #include <gzip.h>
16 #include <mapmem.h>
17 #include <linux/libfdt.h>
18 #include <serial.h>
19 #include <asm/sections.h>
20 #include <linux/ctype.h>
21 #include <linux/lzo.h>
22
23 DECLARE_GLOBAL_DATA_PTR;
24
25 /*
26  * Here are the type we know about. One day we might allow drivers to
27  * register. For now we just put them here. The COMPAT macro allows us to
28  * turn this into a sparse list later, and keeps the ID with the name.
29  *
30  * NOTE: This list is basically a TODO list for things that need to be
31  * converted to driver model. So don't add new things here unless there is a
32  * good reason why driver-model conversion is infeasible. Examples include
33  * things which are used before driver model is available.
34  */
35 #define COMPAT(id, name) name
36 static const char * const compat_names[COMPAT_COUNT] = {
37         COMPAT(UNKNOWN, "<none>"),
38         COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
39         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
40         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
41         COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
42         COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
43         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
44         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
45         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
46         COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
47         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
48         COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
49         COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
50         COMPAT(GENERIC_SPI_FLASH, "jedec,spi-nor"),
51         COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
52         COMPAT(INTEL_MICROCODE, "intel,microcode"),
53         COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
54         COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
55         COMPAT(ALTERA_SOCFPGA_DWMMC, "altr,socfpga-dw-mshc"),
56         COMPAT(ALTERA_SOCFPGA_DWC2USB, "snps,dwc2"),
57         COMPAT(INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
58         COMPAT(INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
59         COMPAT(INTEL_IVYBRIDGE_FSP, "intel,ivybridge-fsp"),
60         COMPAT(COMPAT_SUNXI_NAND, "allwinner,sun4i-a10-nand"),
61         COMPAT(ALTERA_SOCFPGA_CLK, "altr,clk-mgr"),
62         COMPAT(ALTERA_SOCFPGA_PINCTRL_SINGLE, "pinctrl-single"),
63         COMPAT(ALTERA_SOCFPGA_H2F_BRG, "altr,socfpga-hps2fpga-bridge"),
64         COMPAT(ALTERA_SOCFPGA_LWH2F_BRG, "altr,socfpga-lwhps2fpga-bridge"),
65         COMPAT(ALTERA_SOCFPGA_F2H_BRG, "altr,socfpga-fpga2hps-bridge"),
66         COMPAT(ALTERA_SOCFPGA_F2SDR0, "altr,socfpga-fpga2sdram0-bridge"),
67         COMPAT(ALTERA_SOCFPGA_F2SDR1, "altr,socfpga-fpga2sdram1-bridge"),
68         COMPAT(ALTERA_SOCFPGA_F2SDR2, "altr,socfpga-fpga2sdram2-bridge"),
69         COMPAT(ALTERA_SOCFPGA_FPGA0, "altr,socfpga-a10-fpga-mgr"),
70         COMPAT(ALTERA_SOCFPGA_NOC, "altr,socfpga-a10-noc"),
71         COMPAT(ALTERA_SOCFPGA_CLK_INIT, "altr,socfpga-a10-clk-init")
72 };
73
74 const char *fdtdec_get_compatible(enum fdt_compat_id id)
75 {
76         /* We allow reading of the 'unknown' ID for testing purposes */
77         assert(id >= 0 && id < COMPAT_COUNT);
78         return compat_names[id];
79 }
80
81 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
82                                       const char *prop_name, int index, int na,
83                                       int ns, fdt_size_t *sizep,
84                                       bool translate)
85 {
86         const fdt32_t *prop, *prop_end;
87         const fdt32_t *prop_addr, *prop_size, *prop_after_size;
88         int len;
89         fdt_addr_t addr;
90
91         debug("%s: %s: ", __func__, prop_name);
92
93         prop = fdt_getprop(blob, node, prop_name, &len);
94         if (!prop) {
95                 debug("(not found)\n");
96                 return FDT_ADDR_T_NONE;
97         }
98         prop_end = prop + (len / sizeof(*prop));
99
100         prop_addr = prop + (index * (na + ns));
101         prop_size = prop_addr + na;
102         prop_after_size = prop_size + ns;
103         if (prop_after_size > prop_end) {
104                 debug("(not enough data: expected >= %d cells, got %d cells)\n",
105                       (u32)(prop_after_size - prop), ((u32)(prop_end - prop)));
106                 return FDT_ADDR_T_NONE;
107         }
108
109 #if CONFIG_IS_ENABLED(OF_TRANSLATE)
110         if (translate)
111                 addr = fdt_translate_address(blob, node, prop_addr);
112         else
113 #endif
114                 addr = fdtdec_get_number(prop_addr, na);
115
116         if (sizep) {
117                 *sizep = fdtdec_get_number(prop_size, ns);
118                 debug("addr=%08llx, size=%llx\n", (unsigned long long)addr,
119                       (unsigned long long)*sizep);
120         } else {
121                 debug("addr=%08llx\n", (unsigned long long)addr);
122         }
123
124         return addr;
125 }
126
127 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
128                                             int node, const char *prop_name,
129                                             int index, fdt_size_t *sizep,
130                                             bool translate)
131 {
132         int na, ns;
133
134         debug("%s: ", __func__);
135
136         na = fdt_address_cells(blob, parent);
137         if (na < 1) {
138                 debug("(bad #address-cells)\n");
139                 return FDT_ADDR_T_NONE;
140         }
141
142         ns = fdt_size_cells(blob, parent);
143         if (ns < 0) {
144                 debug("(bad #size-cells)\n");
145                 return FDT_ADDR_T_NONE;
146         }
147
148         debug("na=%d, ns=%d, ", na, ns);
149
150         return fdtdec_get_addr_size_fixed(blob, node, prop_name, index, na,
151                                           ns, sizep, translate);
152 }
153
154 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
155                                               const char *prop_name, int index,
156                                               fdt_size_t *sizep,
157                                               bool translate)
158 {
159         int parent;
160
161         debug("%s: ", __func__);
162
163         parent = fdt_parent_offset(blob, node);
164         if (parent < 0) {
165                 debug("(no parent found)\n");
166                 return FDT_ADDR_T_NONE;
167         }
168
169         return fdtdec_get_addr_size_auto_parent(blob, parent, node, prop_name,
170                                                 index, sizep, translate);
171 }
172
173 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
174                                 const char *prop_name, fdt_size_t *sizep)
175 {
176         int ns = sizep ? (sizeof(fdt_size_t) / sizeof(fdt32_t)) : 0;
177
178         return fdtdec_get_addr_size_fixed(blob, node, prop_name, 0,
179                                           sizeof(fdt_addr_t) / sizeof(fdt32_t),
180                                           ns, sizep, false);
181 }
182
183 fdt_addr_t fdtdec_get_addr(const void *blob, int node, const char *prop_name)
184 {
185         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
186 }
187
188 #if CONFIG_IS_ENABLED(PCI) && defined(CONFIG_DM_PCI)
189 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
190                         const char *prop_name, struct fdt_pci_addr *addr)
191 {
192         const u32 *cell;
193         int len;
194         int ret = -ENOENT;
195
196         debug("%s: %s: ", __func__, prop_name);
197
198         /*
199          * If we follow the pci bus bindings strictly, we should check
200          * the value of the node's parent node's #address-cells and
201          * #size-cells. They need to be 3 and 2 accordingly. However,
202          * for simplicity we skip the check here.
203          */
204         cell = fdt_getprop(blob, node, prop_name, &len);
205         if (!cell)
206                 goto fail;
207
208         if ((len % FDT_PCI_REG_SIZE) == 0) {
209                 int num = len / FDT_PCI_REG_SIZE;
210                 int i;
211
212                 for (i = 0; i < num; i++) {
213                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
214                               (ulong)fdt32_to_cpu(cell[0]),
215                               (ulong)fdt32_to_cpu(cell[1]),
216                               (ulong)fdt32_to_cpu(cell[2]));
217                         if ((fdt32_to_cpu(*cell) & type) == type) {
218                                 addr->phys_hi = fdt32_to_cpu(cell[0]);
219                                 addr->phys_mid = fdt32_to_cpu(cell[1]);
220                                 addr->phys_lo = fdt32_to_cpu(cell[1]);
221                                 break;
222                         }
223
224                         cell += (FDT_PCI_ADDR_CELLS +
225                                  FDT_PCI_SIZE_CELLS);
226                 }
227
228                 if (i == num) {
229                         ret = -ENXIO;
230                         goto fail;
231                 }
232
233                 return 0;
234         }
235
236         ret = -EINVAL;
237
238 fail:
239         debug("(not found)\n");
240         return ret;
241 }
242
243 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
244 {
245         const char *list, *end;
246         int len;
247
248         list = fdt_getprop(blob, node, "compatible", &len);
249         if (!list)
250                 return -ENOENT;
251
252         end = list + len;
253         while (list < end) {
254                 len = strlen(list);
255                 if (len >= strlen("pciVVVV,DDDD")) {
256                         char *s = strstr(list, "pci");
257
258                         /*
259                          * check if the string is something like pciVVVV,DDDD.RR
260                          * or just pciVVVV,DDDD
261                          */
262                         if (s && s[7] == ',' &&
263                             (s[12] == '.' || s[12] == 0)) {
264                                 s += 3;
265                                 *vendor = simple_strtol(s, NULL, 16);
266
267                                 s += 5;
268                                 *device = simple_strtol(s, NULL, 16);
269
270                                 return 0;
271                         }
272                 }
273                 list += (len + 1);
274         }
275
276         return -ENOENT;
277 }
278
279 int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
280                          u32 *bar)
281 {
282         int barnum;
283
284         /* extract the bar number from fdt_pci_addr */
285         barnum = addr->phys_hi & 0xff;
286         if (barnum < PCI_BASE_ADDRESS_0 || barnum > PCI_CARDBUS_CIS)
287                 return -EINVAL;
288
289         barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
290         *bar = dm_pci_read_bar32(dev, barnum);
291
292         return 0;
293 }
294 #endif
295
296 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
297                            uint64_t default_val)
298 {
299         const uint64_t *cell64;
300         int length;
301
302         cell64 = fdt_getprop(blob, node, prop_name, &length);
303         if (!cell64 || length < sizeof(*cell64))
304                 return default_val;
305
306         return fdt64_to_cpu(*cell64);
307 }
308
309 int fdtdec_get_is_enabled(const void *blob, int node)
310 {
311         const char *cell;
312
313         /*
314          * It should say "okay", so only allow that. Some fdts use "ok" but
315          * this is a bug. Please fix your device tree source file. See here
316          * for discussion:
317          *
318          * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
319          */
320         cell = fdt_getprop(blob, node, "status", NULL);
321         if (cell)
322                 return strcmp(cell, "okay") == 0;
323         return 1;
324 }
325
326 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
327 {
328         enum fdt_compat_id id;
329
330         /* Search our drivers */
331         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
332                 if (fdt_node_check_compatible(blob, node,
333                                               compat_names[id]) == 0)
334                         return id;
335         return COMPAT_UNKNOWN;
336 }
337
338 int fdtdec_next_compatible(const void *blob, int node, enum fdt_compat_id id)
339 {
340         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
341 }
342
343 int fdtdec_next_compatible_subnode(const void *blob, int node,
344                                    enum fdt_compat_id id, int *depthp)
345 {
346         do {
347                 node = fdt_next_node(blob, node, depthp);
348         } while (*depthp > 1);
349
350         /* If this is a direct subnode, and compatible, return it */
351         if (*depthp == 1 && 0 == fdt_node_check_compatible(
352                                                 blob, node, compat_names[id]))
353                 return node;
354
355         return -FDT_ERR_NOTFOUND;
356 }
357
358 int fdtdec_next_alias(const void *blob, const char *name, enum fdt_compat_id id,
359                       int *upto)
360 {
361 #define MAX_STR_LEN 20
362         char str[MAX_STR_LEN + 20];
363         int node, err;
364
365         /* snprintf() is not available */
366         assert(strlen(name) < MAX_STR_LEN);
367         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
368         node = fdt_path_offset(blob, str);
369         if (node < 0)
370                 return node;
371         err = fdt_node_check_compatible(blob, node, compat_names[id]);
372         if (err < 0)
373                 return err;
374         if (err)
375                 return -FDT_ERR_NOTFOUND;
376         (*upto)++;
377         return node;
378 }
379
380 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
381                                enum fdt_compat_id id, int *node_list,
382                                int maxcount)
383 {
384         memset(node_list, '\0', sizeof(*node_list) * maxcount);
385
386         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
387 }
388
389 /* TODO: Can we tighten this code up a little? */
390 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
391                               enum fdt_compat_id id, int *node_list,
392                               int maxcount)
393 {
394         int name_len = strlen(name);
395         int nodes[maxcount];
396         int num_found = 0;
397         int offset, node;
398         int alias_node;
399         int count;
400         int i, j;
401
402         /* find the alias node if present */
403         alias_node = fdt_path_offset(blob, "/aliases");
404
405         /*
406          * start with nothing, and we can assume that the root node can't
407          * match
408          */
409         memset(nodes, '\0', sizeof(nodes));
410
411         /* First find all the compatible nodes */
412         for (node = count = 0; node >= 0 && count < maxcount;) {
413                 node = fdtdec_next_compatible(blob, node, id);
414                 if (node >= 0)
415                         nodes[count++] = node;
416         }
417         if (node >= 0)
418                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
419                       __func__, name);
420
421         /* Now find all the aliases */
422         for (offset = fdt_first_property_offset(blob, alias_node);
423                         offset > 0;
424                         offset = fdt_next_property_offset(blob, offset)) {
425                 const struct fdt_property *prop;
426                 const char *path;
427                 int number;
428                 int found;
429
430                 node = 0;
431                 prop = fdt_get_property_by_offset(blob, offset, NULL);
432                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
433                 if (prop->len && 0 == strncmp(path, name, name_len))
434                         node = fdt_path_offset(blob, prop->data);
435                 if (node <= 0)
436                         continue;
437
438                 /* Get the alias number */
439                 number = simple_strtoul(path + name_len, NULL, 10);
440                 if (number < 0 || number >= maxcount) {
441                         debug("%s: warning: alias '%s' is out of range\n",
442                               __func__, path);
443                         continue;
444                 }
445
446                 /* Make sure the node we found is actually in our list! */
447                 found = -1;
448                 for (j = 0; j < count; j++)
449                         if (nodes[j] == node) {
450                                 found = j;
451                                 break;
452                         }
453
454                 if (found == -1) {
455                         debug("%s: warning: alias '%s' points to a node "
456                                 "'%s' that is missing or is not compatible "
457                                 " with '%s'\n", __func__, path,
458                                 fdt_get_name(blob, node, NULL),
459                                compat_names[id]);
460                         continue;
461                 }
462
463                 /*
464                  * Add this node to our list in the right place, and mark
465                  * it as done.
466                  */
467                 if (fdtdec_get_is_enabled(blob, node)) {
468                         if (node_list[number]) {
469                                 debug("%s: warning: alias '%s' requires that "
470                                       "a node be placed in the list in a "
471                                       "position which is already filled by "
472                                       "node '%s'\n", __func__, path,
473                                       fdt_get_name(blob, node, NULL));
474                                 continue;
475                         }
476                         node_list[number] = node;
477                         if (number >= num_found)
478                                 num_found = number + 1;
479                 }
480                 nodes[found] = 0;
481         }
482
483         /* Add any nodes not mentioned by an alias */
484         for (i = j = 0; i < maxcount; i++) {
485                 if (!node_list[i]) {
486                         for (; j < maxcount; j++)
487                                 if (nodes[j] &&
488                                     fdtdec_get_is_enabled(blob, nodes[j]))
489                                         break;
490
491                         /* Have we run out of nodes to add? */
492                         if (j == maxcount)
493                                 break;
494
495                         assert(!node_list[i]);
496                         node_list[i] = nodes[j++];
497                         if (i >= num_found)
498                                 num_found = i + 1;
499                 }
500         }
501
502         return num_found;
503 }
504
505 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
506                          int *seqp)
507 {
508         int base_len = strlen(base);
509         const char *find_name;
510         int find_namelen;
511         int prop_offset;
512         int aliases;
513
514         find_name = fdt_get_name(blob, offset, &find_namelen);
515         debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
516
517         aliases = fdt_path_offset(blob, "/aliases");
518         for (prop_offset = fdt_first_property_offset(blob, aliases);
519              prop_offset > 0;
520              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
521                 const char *prop;
522                 const char *name;
523                 const char *slash;
524                 int len, val;
525
526                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
527                 debug("   - %s, %s\n", name, prop);
528                 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
529                     strncmp(name, base, base_len))
530                         continue;
531
532                 slash = strrchr(prop, '/');
533                 if (strcmp(slash + 1, find_name))
534                         continue;
535                 val = trailing_strtol(name);
536                 if (val != -1) {
537                         *seqp = val;
538                         debug("Found seq %d\n", *seqp);
539                         return 0;
540                 }
541         }
542
543         debug("Not found\n");
544         return -ENOENT;
545 }
546
547 int fdtdec_get_alias_highest_id(const void *blob, const char *base)
548 {
549         int base_len = strlen(base);
550         int prop_offset;
551         int aliases;
552         int max = -1;
553
554         debug("Looking for highest alias id for '%s'\n", base);
555
556         aliases = fdt_path_offset(blob, "/aliases");
557         for (prop_offset = fdt_first_property_offset(blob, aliases);
558              prop_offset > 0;
559              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
560                 const char *prop;
561                 const char *name;
562                 int len, val;
563
564                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
565                 debug("   - %s, %s\n", name, prop);
566                 if (*prop != '/' || prop[len - 1] ||
567                     strncmp(name, base, base_len))
568                         continue;
569
570                 val = trailing_strtol(name);
571                 if (val > max) {
572                         debug("Found seq %d\n", val);
573                         max = val;
574                 }
575         }
576
577         return max;
578 }
579
580 const char *fdtdec_get_chosen_prop(const void *blob, const char *name)
581 {
582         int chosen_node;
583
584         if (!blob)
585                 return NULL;
586         chosen_node = fdt_path_offset(blob, "/chosen");
587         return fdt_getprop(blob, chosen_node, name, NULL);
588 }
589
590 int fdtdec_get_chosen_node(const void *blob, const char *name)
591 {
592         const char *prop;
593
594         prop = fdtdec_get_chosen_prop(blob, name);
595         if (!prop)
596                 return -FDT_ERR_NOTFOUND;
597         return fdt_path_offset(blob, prop);
598 }
599
600 int fdtdec_check_fdt(void)
601 {
602         /*
603          * We must have an FDT, but we cannot panic() yet since the console
604          * is not ready. So for now, just assert(). Boards which need an early
605          * FDT (prior to console ready) will need to make their own
606          * arrangements and do their own checks.
607          */
608         assert(!fdtdec_prepare_fdt());
609         return 0;
610 }
611
612 /*
613  * This function is a little odd in that it accesses global data. At some
614  * point if the architecture board.c files merge this will make more sense.
615  * Even now, it is common code.
616  */
617 int fdtdec_prepare_fdt(void)
618 {
619         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
620             fdt_check_header(gd->fdt_blob)) {
621 #ifdef CONFIG_SPL_BUILD
622                 puts("Missing DTB\n");
623 #else
624                 puts("No valid device tree binary found - please append one to U-Boot binary, use u-boot-dtb.bin or define CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
625 # ifdef DEBUG
626                 if (gd->fdt_blob) {
627                         printf("fdt_blob=%p\n", gd->fdt_blob);
628                         print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
629                                      32, 0);
630                 }
631 # endif
632 #endif
633                 return -1;
634         }
635         return 0;
636 }
637
638 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
639 {
640         const u32 *phandle;
641         int lookup;
642
643         debug("%s: %s\n", __func__, prop_name);
644         phandle = fdt_getprop(blob, node, prop_name, NULL);
645         if (!phandle)
646                 return -FDT_ERR_NOTFOUND;
647
648         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
649         return lookup;
650 }
651
652 /**
653  * Look up a property in a node and check that it has a minimum length.
654  *
655  * @param blob          FDT blob
656  * @param node          node to examine
657  * @param prop_name     name of property to find
658  * @param min_len       minimum property length in bytes
659  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
660                         found, or -FDT_ERR_BADLAYOUT if not enough data
661  * @return pointer to cell, which is only valid if err == 0
662  */
663 static const void *get_prop_check_min_len(const void *blob, int node,
664                                           const char *prop_name, int min_len,
665                                           int *err)
666 {
667         const void *cell;
668         int len;
669
670         debug("%s: %s\n", __func__, prop_name);
671         cell = fdt_getprop(blob, node, prop_name, &len);
672         if (!cell)
673                 *err = -FDT_ERR_NOTFOUND;
674         else if (len < min_len)
675                 *err = -FDT_ERR_BADLAYOUT;
676         else
677                 *err = 0;
678         return cell;
679 }
680
681 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
682                          u32 *array, int count)
683 {
684         const u32 *cell;
685         int err = 0;
686
687         debug("%s: %s\n", __func__, prop_name);
688         cell = get_prop_check_min_len(blob, node, prop_name,
689                                       sizeof(u32) * count, &err);
690         if (!err) {
691                 int i;
692
693                 for (i = 0; i < count; i++)
694                         array[i] = fdt32_to_cpu(cell[i]);
695         }
696         return err;
697 }
698
699 int fdtdec_get_int_array_count(const void *blob, int node,
700                                const char *prop_name, u32 *array, int count)
701 {
702         const u32 *cell;
703         int len, elems;
704         int i;
705
706         debug("%s: %s\n", __func__, prop_name);
707         cell = fdt_getprop(blob, node, prop_name, &len);
708         if (!cell)
709                 return -FDT_ERR_NOTFOUND;
710         elems = len / sizeof(u32);
711         if (count > elems)
712                 count = elems;
713         for (i = 0; i < count; i++)
714                 array[i] = fdt32_to_cpu(cell[i]);
715
716         return count;
717 }
718
719 const u32 *fdtdec_locate_array(const void *blob, int node,
720                                const char *prop_name, int count)
721 {
722         const u32 *cell;
723         int err;
724
725         cell = get_prop_check_min_len(blob, node, prop_name,
726                                       sizeof(u32) * count, &err);
727         return err ? NULL : cell;
728 }
729
730 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
731 {
732         const s32 *cell;
733         int len;
734
735         debug("%s: %s\n", __func__, prop_name);
736         cell = fdt_getprop(blob, node, prop_name, &len);
737         return cell != NULL;
738 }
739
740 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
741                                    const char *list_name,
742                                    const char *cells_name,
743                                    int cell_count, int index,
744                                    struct fdtdec_phandle_args *out_args)
745 {
746         const __be32 *list, *list_end;
747         int rc = 0, size, cur_index = 0;
748         uint32_t count = 0;
749         int node = -1;
750         int phandle;
751
752         /* Retrieve the phandle list property */
753         list = fdt_getprop(blob, src_node, list_name, &size);
754         if (!list)
755                 return -ENOENT;
756         list_end = list + size / sizeof(*list);
757
758         /* Loop over the phandles until all the requested entry is found */
759         while (list < list_end) {
760                 rc = -EINVAL;
761                 count = 0;
762
763                 /*
764                  * If phandle is 0, then it is an empty entry with no
765                  * arguments.  Skip forward to the next entry.
766                  */
767                 phandle = be32_to_cpup(list++);
768                 if (phandle) {
769                         /*
770                          * Find the provider node and parse the #*-cells
771                          * property to determine the argument length.
772                          *
773                          * This is not needed if the cell count is hard-coded
774                          * (i.e. cells_name not set, but cell_count is set),
775                          * except when we're going to return the found node
776                          * below.
777                          */
778                         if (cells_name || cur_index == index) {
779                                 node = fdt_node_offset_by_phandle(blob,
780                                                                   phandle);
781                                 if (!node) {
782                                         debug("%s: could not find phandle\n",
783                                               fdt_get_name(blob, src_node,
784                                                            NULL));
785                                         goto err;
786                                 }
787                         }
788
789                         if (cells_name) {
790                                 count = fdtdec_get_int(blob, node, cells_name,
791                                                        -1);
792                                 if (count == -1) {
793                                         debug("%s: could not get %s for %s\n",
794                                               fdt_get_name(blob, src_node,
795                                                            NULL),
796                                               cells_name,
797                                               fdt_get_name(blob, node,
798                                                            NULL));
799                                         goto err;
800                                 }
801                         } else {
802                                 count = cell_count;
803                         }
804
805                         /*
806                          * Make sure that the arguments actually fit in the
807                          * remaining property data length
808                          */
809                         if (list + count > list_end) {
810                                 debug("%s: arguments longer than property\n",
811                                       fdt_get_name(blob, src_node, NULL));
812                                 goto err;
813                         }
814                 }
815
816                 /*
817                  * All of the error cases above bail out of the loop, so at
818                  * this point, the parsing is successful. If the requested
819                  * index matches, then fill the out_args structure and return,
820                  * or return -ENOENT for an empty entry.
821                  */
822                 rc = -ENOENT;
823                 if (cur_index == index) {
824                         if (!phandle)
825                                 goto err;
826
827                         if (out_args) {
828                                 int i;
829
830                                 if (count > MAX_PHANDLE_ARGS) {
831                                         debug("%s: too many arguments %d\n",
832                                               fdt_get_name(blob, src_node,
833                                                            NULL), count);
834                                         count = MAX_PHANDLE_ARGS;
835                                 }
836                                 out_args->node = node;
837                                 out_args->args_count = count;
838                                 for (i = 0; i < count; i++) {
839                                         out_args->args[i] =
840                                                         be32_to_cpup(list++);
841                                 }
842                         }
843
844                         /* Found it! return success */
845                         return 0;
846                 }
847
848                 node = -1;
849                 list += count;
850                 cur_index++;
851         }
852
853         /*
854          * Result will be one of:
855          * -ENOENT : index is for empty phandle
856          * -EINVAL : parsing error on data
857          * [1..n]  : Number of phandle (count mode; when index = -1)
858          */
859         rc = index < 0 ? cur_index : -ENOENT;
860  err:
861         return rc;
862 }
863
864 int fdtdec_get_child_count(const void *blob, int node)
865 {
866         int subnode;
867         int num = 0;
868
869         fdt_for_each_subnode(subnode, blob, node)
870                 num++;
871
872         return num;
873 }
874
875 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
876                           u8 *array, int count)
877 {
878         const u8 *cell;
879         int err;
880
881         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
882         if (!err)
883                 memcpy(array, cell, count);
884         return err;
885 }
886
887 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
888                                    const char *prop_name, int count)
889 {
890         const u8 *cell;
891         int err;
892
893         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
894         if (err)
895                 return NULL;
896         return cell;
897 }
898
899 int fdtdec_get_config_int(const void *blob, const char *prop_name,
900                           int default_val)
901 {
902         int config_node;
903
904         debug("%s: %s\n", __func__, prop_name);
905         config_node = fdt_path_offset(blob, "/config");
906         if (config_node < 0)
907                 return default_val;
908         return fdtdec_get_int(blob, config_node, prop_name, default_val);
909 }
910
911 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
912 {
913         int config_node;
914         const void *prop;
915
916         debug("%s: %s\n", __func__, prop_name);
917         config_node = fdt_path_offset(blob, "/config");
918         if (config_node < 0)
919                 return 0;
920         prop = fdt_get_property(blob, config_node, prop_name, NULL);
921
922         return prop != NULL;
923 }
924
925 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
926 {
927         const char *nodep;
928         int nodeoffset;
929         int len;
930
931         debug("%s: %s\n", __func__, prop_name);
932         nodeoffset = fdt_path_offset(blob, "/config");
933         if (nodeoffset < 0)
934                 return NULL;
935
936         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
937         if (!nodep)
938                 return NULL;
939
940         return (char *)nodep;
941 }
942
943 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
944 {
945         u64 number = 0;
946
947         while (cells--)
948                 number = (number << 32) | fdt32_to_cpu(*ptr++);
949
950         return number;
951 }
952
953 int fdt_get_resource(const void *fdt, int node, const char *property,
954                      unsigned int index, struct fdt_resource *res)
955 {
956         const fdt32_t *ptr, *end;
957         int na, ns, len, parent;
958         unsigned int i = 0;
959
960         parent = fdt_parent_offset(fdt, node);
961         if (parent < 0)
962                 return parent;
963
964         na = fdt_address_cells(fdt, parent);
965         ns = fdt_size_cells(fdt, parent);
966
967         ptr = fdt_getprop(fdt, node, property, &len);
968         if (!ptr)
969                 return len;
970
971         end = ptr + len / sizeof(*ptr);
972
973         while (ptr + na + ns <= end) {
974                 if (i == index) {
975                         res->start = fdtdec_get_number(ptr, na);
976                         res->end = res->start;
977                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
978                         return 0;
979                 }
980
981                 ptr += na + ns;
982                 i++;
983         }
984
985         return -FDT_ERR_NOTFOUND;
986 }
987
988 int fdt_get_named_resource(const void *fdt, int node, const char *property,
989                            const char *prop_names, const char *name,
990                            struct fdt_resource *res)
991 {
992         int index;
993
994         index = fdt_stringlist_search(fdt, node, prop_names, name);
995         if (index < 0)
996                 return index;
997
998         return fdt_get_resource(fdt, node, property, index, res);
999 }
1000
1001 static int decode_timing_property(const void *blob, int node, const char *name,
1002                                   struct timing_entry *result)
1003 {
1004         int length, ret = 0;
1005         const u32 *prop;
1006
1007         prop = fdt_getprop(blob, node, name, &length);
1008         if (!prop) {
1009                 debug("%s: could not find property %s\n",
1010                       fdt_get_name(blob, node, NULL), name);
1011                 return length;
1012         }
1013
1014         if (length == sizeof(u32)) {
1015                 result->typ = fdtdec_get_int(blob, node, name, 0);
1016                 result->min = result->typ;
1017                 result->max = result->typ;
1018         } else {
1019                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1020         }
1021
1022         return ret;
1023 }
1024
1025 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1026                                  struct display_timing *dt)
1027 {
1028         int i, node, timings_node;
1029         u32 val = 0;
1030         int ret = 0;
1031
1032         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1033         if (timings_node < 0)
1034                 return timings_node;
1035
1036         for (i = 0, node = fdt_first_subnode(blob, timings_node);
1037              node > 0 && i != index;
1038              node = fdt_next_subnode(blob, node))
1039                 i++;
1040
1041         if (node < 0)
1042                 return node;
1043
1044         memset(dt, 0, sizeof(*dt));
1045
1046         ret |= decode_timing_property(blob, node, "hback-porch",
1047                                       &dt->hback_porch);
1048         ret |= decode_timing_property(blob, node, "hfront-porch",
1049                                       &dt->hfront_porch);
1050         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1051         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1052         ret |= decode_timing_property(blob, node, "vback-porch",
1053                                       &dt->vback_porch);
1054         ret |= decode_timing_property(blob, node, "vfront-porch",
1055                                       &dt->vfront_porch);
1056         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1057         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1058         ret |= decode_timing_property(blob, node, "clock-frequency",
1059                                       &dt->pixelclock);
1060
1061         dt->flags = 0;
1062         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1063         if (val != -1) {
1064                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1065                                 DISPLAY_FLAGS_VSYNC_LOW;
1066         }
1067         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1068         if (val != -1) {
1069                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1070                                 DISPLAY_FLAGS_HSYNC_LOW;
1071         }
1072         val = fdtdec_get_int(blob, node, "de-active", -1);
1073         if (val != -1) {
1074                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1075                                 DISPLAY_FLAGS_DE_LOW;
1076         }
1077         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1078         if (val != -1) {
1079                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1080                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1081         }
1082
1083         if (fdtdec_get_bool(blob, node, "interlaced"))
1084                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1085         if (fdtdec_get_bool(blob, node, "doublescan"))
1086                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1087         if (fdtdec_get_bool(blob, node, "doubleclk"))
1088                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1089
1090         return ret;
1091 }
1092
1093 int fdtdec_setup_mem_size_base_fdt(const void *blob)
1094 {
1095         int ret, mem;
1096         struct fdt_resource res;
1097
1098         mem = fdt_path_offset(blob, "/memory");
1099         if (mem < 0) {
1100                 debug("%s: Missing /memory node\n", __func__);
1101                 return -EINVAL;
1102         }
1103
1104         ret = fdt_get_resource(blob, mem, "reg", 0, &res);
1105         if (ret != 0) {
1106                 debug("%s: Unable to decode first memory bank\n", __func__);
1107                 return -EINVAL;
1108         }
1109
1110         gd->ram_size = (phys_size_t)(res.end - res.start + 1);
1111         gd->ram_base = (unsigned long)res.start;
1112         debug("%s: Initial DRAM size %llx\n", __func__,
1113               (unsigned long long)gd->ram_size);
1114
1115         return 0;
1116 }
1117
1118 int fdtdec_setup_mem_size_base(void)
1119 {
1120         return fdtdec_setup_mem_size_base_fdt(gd->fdt_blob);
1121 }
1122
1123 #if defined(CONFIG_NR_DRAM_BANKS)
1124
1125 static int get_next_memory_node(const void *blob, int mem)
1126 {
1127         do {
1128                 mem = fdt_node_offset_by_prop_value(blob, mem,
1129                                                     "device_type", "memory", 7);
1130         } while (!fdtdec_get_is_enabled(blob, mem));
1131
1132         return mem;
1133 }
1134
1135 int fdtdec_setup_memory_banksize_fdt(const void *blob)
1136 {
1137         int bank, ret, mem, reg = 0;
1138         struct fdt_resource res;
1139
1140         mem = get_next_memory_node(blob, -1);
1141         if (mem < 0) {
1142                 debug("%s: Missing /memory node\n", __func__);
1143                 return -EINVAL;
1144         }
1145
1146         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
1147                 ret = fdt_get_resource(blob, mem, "reg", reg++, &res);
1148                 if (ret == -FDT_ERR_NOTFOUND) {
1149                         reg = 0;
1150                         mem = get_next_memory_node(blob, mem);
1151                         if (mem == -FDT_ERR_NOTFOUND)
1152                                 break;
1153
1154                         ret = fdt_get_resource(blob, mem, "reg", reg++, &res);
1155                         if (ret == -FDT_ERR_NOTFOUND)
1156                                 break;
1157                 }
1158                 if (ret != 0) {
1159                         return -EINVAL;
1160                 }
1161
1162                 gd->bd->bi_dram[bank].start = (phys_addr_t)res.start;
1163                 gd->bd->bi_dram[bank].size =
1164                         (phys_size_t)(res.end - res.start + 1);
1165
1166                 debug("%s: DRAM Bank #%d: start = 0x%llx, size = 0x%llx\n",
1167                       __func__, bank,
1168                       (unsigned long long)gd->bd->bi_dram[bank].start,
1169                       (unsigned long long)gd->bd->bi_dram[bank].size);
1170         }
1171
1172         return 0;
1173 }
1174
1175 int fdtdec_setup_memory_banksize(void)
1176 {
1177         return fdtdec_setup_memory_banksize_fdt(gd->fdt_blob);
1178
1179 }
1180 #endif
1181
1182 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1183 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT_GZIP) ||\
1184         CONFIG_IS_ENABLED(MULTI_DTB_FIT_LZO)
1185 static int uncompress_blob(const void *src, ulong sz_src, void **dstp)
1186 {
1187         size_t sz_out = CONFIG_VAL(MULTI_DTB_FIT_UNCOMPRESS_SZ);
1188         bool gzip = 0, lzo = 0;
1189         ulong sz_in = sz_src;
1190         void *dst;
1191         int rc;
1192
1193         if (CONFIG_IS_ENABLED(GZIP))
1194                 if (gzip_parse_header(src, sz_in) >= 0)
1195                         gzip = 1;
1196         if (CONFIG_IS_ENABLED(LZO))
1197                 if (!gzip && lzop_is_valid_header(src))
1198                         lzo = 1;
1199
1200         if (!gzip && !lzo)
1201                 return -EBADMSG;
1202
1203
1204         if (CONFIG_IS_ENABLED(MULTI_DTB_FIT_DYN_ALLOC)) {
1205                 dst = malloc(sz_out);
1206                 if (!dst) {
1207                         puts("uncompress_blob: Unable to allocate memory\n");
1208                         return -ENOMEM;
1209                 }
1210         } else  {
1211 #  if CONFIG_IS_ENABLED(MULTI_DTB_FIT_USER_DEFINED_AREA)
1212                 dst = (void *)CONFIG_VAL(MULTI_DTB_FIT_USER_DEF_ADDR);
1213 #  else
1214                 return -ENOTSUPP;
1215 #  endif
1216         }
1217
1218         if (CONFIG_IS_ENABLED(GZIP) && gzip)
1219                 rc = gunzip(dst, sz_out, (u8 *)src, &sz_in);
1220         else if (CONFIG_IS_ENABLED(LZO) && lzo)
1221                 rc = lzop_decompress(src, sz_in, dst, &sz_out);
1222         else
1223                 hang();
1224
1225         if (rc < 0) {
1226                 /* not a valid compressed blob */
1227                 puts("uncompress_blob: Unable to uncompress\n");
1228                 if (CONFIG_IS_ENABLED(MULTI_DTB_FIT_DYN_ALLOC))
1229                         free(dst);
1230                 return -EBADMSG;
1231         }
1232         *dstp = dst;
1233         return 0;
1234 }
1235 # else
1236 static int uncompress_blob(const void *src, ulong sz_src, void **dstp)
1237 {
1238         *dstp = (void *)src;
1239         return 0;
1240 }
1241 # endif
1242 #endif
1243
1244 #if defined(CONFIG_OF_BOARD) || defined(CONFIG_OF_SEPARATE)
1245 /*
1246  * For CONFIG_OF_SEPARATE, the board may optionally implement this to
1247  * provide and/or fixup the fdt.
1248  */
1249 __weak void *board_fdt_blob_setup(void)
1250 {
1251         void *fdt_blob = NULL;
1252 #ifdef CONFIG_SPL_BUILD
1253         /* FDT is at end of BSS unless it is in a different memory region */
1254         if (IS_ENABLED(CONFIG_SPL_SEPARATE_BSS))
1255                 fdt_blob = (ulong *)&_image_binary_end;
1256         else
1257                 fdt_blob = (ulong *)&__bss_end;
1258 #else
1259         /* FDT is at end of image */
1260         fdt_blob = (ulong *)&_end;
1261 #endif
1262         return fdt_blob;
1263 }
1264 #endif
1265
1266 int fdtdec_set_ethernet_mac_address(void *fdt, const u8 *mac, size_t size)
1267 {
1268         const char *path;
1269         int offset, err;
1270
1271         if (!is_valid_ethaddr(mac))
1272                 return -EINVAL;
1273
1274         path = fdt_get_alias(fdt, "ethernet");
1275         if (!path)
1276                 return 0;
1277
1278         debug("ethernet alias found: %s\n", path);
1279
1280         offset = fdt_path_offset(fdt, path);
1281         if (offset < 0) {
1282                 debug("ethernet alias points to absent node %s\n", path);
1283                 return -ENOENT;
1284         }
1285
1286         err = fdt_setprop_inplace(fdt, offset, "local-mac-address", mac, size);
1287         if (err < 0)
1288                 return err;
1289
1290         debug("MAC address: %pM\n", mac);
1291
1292         return 0;
1293 }
1294
1295 static int fdtdec_init_reserved_memory(void *blob)
1296 {
1297         int na, ns, node, err;
1298         fdt32_t value;
1299
1300         /* inherit #address-cells and #size-cells from the root node */
1301         na = fdt_address_cells(blob, 0);
1302         ns = fdt_size_cells(blob, 0);
1303
1304         node = fdt_add_subnode(blob, 0, "reserved-memory");
1305         if (node < 0)
1306                 return node;
1307
1308         err = fdt_setprop(blob, node, "ranges", NULL, 0);
1309         if (err < 0)
1310                 return err;
1311
1312         value = cpu_to_fdt32(ns);
1313
1314         err = fdt_setprop(blob, node, "#size-cells", &value, sizeof(value));
1315         if (err < 0)
1316                 return err;
1317
1318         value = cpu_to_fdt32(na);
1319
1320         err = fdt_setprop(blob, node, "#address-cells", &value, sizeof(value));
1321         if (err < 0)
1322                 return err;
1323
1324         return node;
1325 }
1326
1327 int fdtdec_add_reserved_memory(void *blob, const char *basename,
1328                                const struct fdt_memory *carveout,
1329                                uint32_t *phandlep)
1330 {
1331         fdt32_t cells[4] = {}, *ptr = cells;
1332         uint32_t upper, lower, phandle;
1333         int parent, node, na, ns, err;
1334         fdt_size_t size;
1335         char name[64];
1336
1337         /* create an empty /reserved-memory node if one doesn't exist */
1338         parent = fdt_path_offset(blob, "/reserved-memory");
1339         if (parent < 0) {
1340                 parent = fdtdec_init_reserved_memory(blob);
1341                 if (parent < 0)
1342                         return parent;
1343         }
1344
1345         /* only 1 or 2 #address-cells and #size-cells are supported */
1346         na = fdt_address_cells(blob, parent);
1347         if (na < 1 || na > 2)
1348                 return -FDT_ERR_BADNCELLS;
1349
1350         ns = fdt_size_cells(blob, parent);
1351         if (ns < 1 || ns > 2)
1352                 return -FDT_ERR_BADNCELLS;
1353
1354         /* find a matching node and return the phandle to that */
1355         fdt_for_each_subnode(node, blob, parent) {
1356                 const char *name = fdt_get_name(blob, node, NULL);
1357                 phys_addr_t addr, size;
1358
1359                 addr = fdtdec_get_addr_size(blob, node, "reg", &size);
1360                 if (addr == FDT_ADDR_T_NONE) {
1361                         debug("failed to read address/size for %s\n", name);
1362                         continue;
1363                 }
1364
1365                 if (addr == carveout->start && (addr + size) == carveout->end) {
1366                         *phandlep = fdt_get_phandle(blob, node);
1367                         return 0;
1368                 }
1369         }
1370
1371         /*
1372          * Unpack the start address and generate the name of the new node
1373          * base on the basename and the unit-address.
1374          */
1375         upper = upper_32_bits(carveout->start);
1376         lower = lower_32_bits(carveout->start);
1377
1378         if (na > 1 && upper > 0)
1379                 snprintf(name, sizeof(name), "%s@%x,%x", basename, upper,
1380                          lower);
1381         else {
1382                 if (upper > 0) {
1383                         debug("address %08x:%08x exceeds addressable space\n",
1384                               upper, lower);
1385                         return -FDT_ERR_BADVALUE;
1386                 }
1387
1388                 snprintf(name, sizeof(name), "%s@%x", basename, lower);
1389         }
1390
1391         node = fdt_add_subnode(blob, parent, name);
1392         if (node < 0)
1393                 return node;
1394
1395         err = fdt_generate_phandle(blob, &phandle);
1396         if (err < 0)
1397                 return err;
1398
1399         err = fdtdec_set_phandle(blob, node, phandle);
1400         if (err < 0)
1401                 return err;
1402
1403         /* store one or two address cells */
1404         if (na > 1)
1405                 *ptr++ = cpu_to_fdt32(upper);
1406
1407         *ptr++ = cpu_to_fdt32(lower);
1408
1409         /* store one or two size cells */
1410         size = carveout->end - carveout->start + 1;
1411         upper = upper_32_bits(size);
1412         lower = lower_32_bits(size);
1413
1414         if (ns > 1)
1415                 *ptr++ = cpu_to_fdt32(upper);
1416
1417         *ptr++ = cpu_to_fdt32(lower);
1418
1419         err = fdt_setprop(blob, node, "reg", cells, (na + ns) * sizeof(*cells));
1420         if (err < 0)
1421                 return err;
1422
1423         /* return the phandle for the new node for the caller to use */
1424         if (phandlep)
1425                 *phandlep = phandle;
1426
1427         return 0;
1428 }
1429
1430 int fdtdec_get_carveout(const void *blob, const char *node, const char *name,
1431                         unsigned int index, struct fdt_memory *carveout)
1432 {
1433         const fdt32_t *prop;
1434         uint32_t phandle;
1435         int offset, len;
1436         fdt_size_t size;
1437
1438         offset = fdt_path_offset(blob, node);
1439         if (offset < 0)
1440                 return offset;
1441
1442         prop = fdt_getprop(blob, offset, name, &len);
1443         if (!prop) {
1444                 debug("failed to get %s for %s\n", name, node);
1445                 return -FDT_ERR_NOTFOUND;
1446         }
1447
1448         if ((len % sizeof(phandle)) != 0) {
1449                 debug("invalid phandle property\n");
1450                 return -FDT_ERR_BADPHANDLE;
1451         }
1452
1453         if (len < (sizeof(phandle) * (index + 1))) {
1454                 debug("invalid phandle index\n");
1455                 return -FDT_ERR_BADPHANDLE;
1456         }
1457
1458         phandle = fdt32_to_cpu(prop[index]);
1459
1460         offset = fdt_node_offset_by_phandle(blob, phandle);
1461         if (offset < 0) {
1462                 debug("failed to find node for phandle %u\n", phandle);
1463                 return offset;
1464         }
1465
1466         carveout->start = fdtdec_get_addr_size_auto_noparent(blob, offset,
1467                                                              "reg", 0, &size,
1468                                                              true);
1469         if (carveout->start == FDT_ADDR_T_NONE) {
1470                 debug("failed to read address/size from \"reg\" property\n");
1471                 return -FDT_ERR_NOTFOUND;
1472         }
1473
1474         carveout->end = carveout->start + size - 1;
1475
1476         return 0;
1477 }
1478
1479 int fdtdec_set_carveout(void *blob, const char *node, const char *prop_name,
1480                         unsigned int index, const char *name,
1481                         const struct fdt_memory *carveout)
1482 {
1483         uint32_t phandle;
1484         int err, offset;
1485         fdt32_t value;
1486
1487         /* XXX implement support for multiple phandles */
1488         if (index > 0) {
1489                 debug("invalid index %u\n", index);
1490                 return -FDT_ERR_BADOFFSET;
1491         }
1492
1493         err = fdtdec_add_reserved_memory(blob, name, carveout, &phandle);
1494         if (err < 0) {
1495                 debug("failed to add reserved memory: %d\n", err);
1496                 return err;
1497         }
1498
1499         offset = fdt_path_offset(blob, node);
1500         if (offset < 0) {
1501                 debug("failed to find offset for node %s: %d\n", node, offset);
1502                 return offset;
1503         }
1504
1505         value = cpu_to_fdt32(phandle);
1506
1507         err = fdt_setprop(blob, offset, prop_name, &value, sizeof(value));
1508         if (err < 0) {
1509                 debug("failed to set %s property for node %s: %d\n", prop_name,
1510                       node, err);
1511                 return err;
1512         }
1513
1514         return 0;
1515 }
1516
1517 int fdtdec_setup(void)
1518 {
1519 #if CONFIG_IS_ENABLED(OF_CONTROL)
1520 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1521         void *fdt_blob;
1522 # endif
1523 # ifdef CONFIG_OF_EMBED
1524         /* Get a pointer to the FDT */
1525 #  ifdef CONFIG_SPL_BUILD
1526         gd->fdt_blob = __dtb_dt_spl_begin;
1527 #  else
1528         gd->fdt_blob = __dtb_dt_begin;
1529 #  endif
1530 # elif defined(CONFIG_OF_BOARD) || defined(CONFIG_OF_SEPARATE)
1531         /* Allow the board to override the fdt address. */
1532         gd->fdt_blob = board_fdt_blob_setup();
1533 # elif defined(CONFIG_OF_HOSTFILE)
1534         if (sandbox_read_fdt_from_file()) {
1535                 puts("Failed to read control FDT\n");
1536                 return -1;
1537         }
1538 # elif defined(CONFIG_OF_PRIOR_STAGE)
1539         gd->fdt_blob = (void *)prior_stage_fdt_address;
1540 # endif
1541 # ifndef CONFIG_SPL_BUILD
1542         /* Allow the early environment to override the fdt address */
1543         gd->fdt_blob = map_sysmem
1544                 (env_get_ulong("fdtcontroladdr", 16,
1545                                (unsigned long)map_to_sysmem(gd->fdt_blob)), 0);
1546 # endif
1547
1548 # if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1549         /*
1550          * Try and uncompress the blob.
1551          * Unfortunately there is no way to know how big the input blob really
1552          * is. So let us set the maximum input size arbitrarily high. 16MB
1553          * ought to be more than enough for packed DTBs.
1554          */
1555         if (uncompress_blob(gd->fdt_blob, 0x1000000, &fdt_blob) == 0)
1556                 gd->fdt_blob = fdt_blob;
1557
1558         /*
1559          * Check if blob is a FIT images containings DTBs.
1560          * If so, pick the most relevant
1561          */
1562         fdt_blob = locate_dtb_in_fit(gd->fdt_blob);
1563         if (fdt_blob) {
1564                 gd->multi_dtb_fit = gd->fdt_blob;
1565                 gd->fdt_blob = fdt_blob;
1566         }
1567
1568 # endif
1569 #endif
1570
1571         return fdtdec_prepare_fdt();
1572 }
1573
1574 #if CONFIG_IS_ENABLED(MULTI_DTB_FIT)
1575 int fdtdec_resetup(int *rescan)
1576 {
1577         void *fdt_blob;
1578
1579         /*
1580          * If the current DTB is part of a compressed FIT image,
1581          * try to locate the best match from the uncompressed
1582          * FIT image stillpresent there. Save the time and space
1583          * required to uncompress it again.
1584          */
1585         if (gd->multi_dtb_fit) {
1586                 fdt_blob = locate_dtb_in_fit(gd->multi_dtb_fit);
1587
1588                 if (fdt_blob == gd->fdt_blob) {
1589                         /*
1590                          * The best match did not change. no need to tear down
1591                          * the DM and rescan the fdt.
1592                          */
1593                         *rescan = 0;
1594                         return 0;
1595                 }
1596
1597                 *rescan = 1;
1598                 gd->fdt_blob = fdt_blob;
1599                 return fdtdec_prepare_fdt();
1600         }
1601
1602         /*
1603          * If multi_dtb_fit is NULL, it means that blob appended to u-boot is
1604          * not a FIT image containings DTB, but a single DTB. There is no need
1605          * to teard down DM and rescan the DT in this case.
1606          */
1607         *rescan = 0;
1608         return 0;
1609 }
1610 #endif
1611
1612 #ifdef CONFIG_NR_DRAM_BANKS
1613 int fdtdec_decode_ram_size(const void *blob, const char *area, int board_id,
1614                            phys_addr_t *basep, phys_size_t *sizep, bd_t *bd)
1615 {
1616         int addr_cells, size_cells;
1617         const u32 *cell, *end;
1618         u64 total_size, size, addr;
1619         int node, child;
1620         bool auto_size;
1621         int bank;
1622         int len;
1623
1624         debug("%s: board_id=%d\n", __func__, board_id);
1625         if (!area)
1626                 area = "/memory";
1627         node = fdt_path_offset(blob, area);
1628         if (node < 0) {
1629                 debug("No %s node found\n", area);
1630                 return -ENOENT;
1631         }
1632
1633         cell = fdt_getprop(blob, node, "reg", &len);
1634         if (!cell) {
1635                 debug("No reg property found\n");
1636                 return -ENOENT;
1637         }
1638
1639         addr_cells = fdt_address_cells(blob, node);
1640         size_cells = fdt_size_cells(blob, node);
1641
1642         /* Check the board id and mask */
1643         for (child = fdt_first_subnode(blob, node);
1644              child >= 0;
1645              child = fdt_next_subnode(blob, child)) {
1646                 int match_mask, match_value;
1647
1648                 match_mask = fdtdec_get_int(blob, child, "match-mask", -1);
1649                 match_value = fdtdec_get_int(blob, child, "match-value", -1);
1650
1651                 if (match_value >= 0 &&
1652                     ((board_id & match_mask) == match_value)) {
1653                         /* Found matching mask */
1654                         debug("Found matching mask %d\n", match_mask);
1655                         node = child;
1656                         cell = fdt_getprop(blob, node, "reg", &len);
1657                         if (!cell) {
1658                                 debug("No memory-banks property found\n");
1659                                 return -EINVAL;
1660                         }
1661                         break;
1662                 }
1663         }
1664         /* Note: if no matching subnode was found we use the parent node */
1665
1666         if (bd) {
1667                 memset(bd->bi_dram, '\0', sizeof(bd->bi_dram[0]) *
1668                                                 CONFIG_NR_DRAM_BANKS);
1669         }
1670
1671         auto_size = fdtdec_get_bool(blob, node, "auto-size");
1672
1673         total_size = 0;
1674         end = cell + len / 4 - addr_cells - size_cells;
1675         debug("cell at %p, end %p\n", cell, end);
1676         for (bank = 0; bank < CONFIG_NR_DRAM_BANKS; bank++) {
1677                 if (cell > end)
1678                         break;
1679                 addr = 0;
1680                 if (addr_cells == 2)
1681                         addr += (u64)fdt32_to_cpu(*cell++) << 32UL;
1682                 addr += fdt32_to_cpu(*cell++);
1683                 if (bd)
1684                         bd->bi_dram[bank].start = addr;
1685                 if (basep && !bank)
1686                         *basep = (phys_addr_t)addr;
1687
1688                 size = 0;
1689                 if (size_cells == 2)
1690                         size += (u64)fdt32_to_cpu(*cell++) << 32UL;
1691                 size += fdt32_to_cpu(*cell++);
1692
1693                 if (auto_size) {
1694                         u64 new_size;
1695
1696                         debug("Auto-sizing %llx, size %llx: ", addr, size);
1697                         new_size = get_ram_size((long *)(uintptr_t)addr, size);
1698                         if (new_size == size) {
1699                                 debug("OK\n");
1700                         } else {
1701                                 debug("sized to %llx\n", new_size);
1702                                 size = new_size;
1703                         }
1704                 }
1705
1706                 if (bd)
1707                         bd->bi_dram[bank].size = size;
1708                 total_size += size;
1709         }
1710
1711         debug("Memory size %llu\n", total_size);
1712         if (sizep)
1713                 *sizep = (phys_size_t)total_size;
1714
1715         return 0;
1716 }
1717 #endif /* CONFIG_NR_DRAM_BANKS */
1718
1719 #endif /* !USE_HOSTCC */