Merge branch 'master' of git://git.denx.de/u-boot-socfpga
[platform/kernel/u-boot.git] / lib / fdtdec.c
1 /*
2  * Copyright (c) 2011 The Chromium OS Authors.
3  * SPDX-License-Identifier:     GPL-2.0+
4  */
5
6 #ifndef USE_HOSTCC
7 #include <common.h>
8 #include <dm.h>
9 #include <errno.h>
10 #include <serial.h>
11 #include <libfdt.h>
12 #include <fdtdec.h>
13 #include <asm/sections.h>
14 #include <linux/ctype.h>
15
16 DECLARE_GLOBAL_DATA_PTR;
17
18 /*
19  * Here are the type we know about. One day we might allow drivers to
20  * register. For now we just put them here. The COMPAT macro allows us to
21  * turn this into a sparse list later, and keeps the ID with the name.
22  */
23 #define COMPAT(id, name) name
24 static const char * const compat_names[COMPAT_COUNT] = {
25         COMPAT(UNKNOWN, "<none>"),
26         COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
27         COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
28         COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
29         COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
30         COMPAT(NVIDIA_TEGRA124_SOR, "nvidia,tegra124-sor"),
31         COMPAT(NVIDIA_TEGRA124_PMC, "nvidia,tegra124-pmc"),
32         COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
33         COMPAT(NVIDIA_TEGRA186_SDMMC, "nvidia,tegra186-sdhci"),
34         COMPAT(NVIDIA_TEGRA210_SDMMC, "nvidia,tegra210-sdhci"),
35         COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
36         COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
37         COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
38         COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
39         COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
40         COMPAT(SMSC_LAN9215, "smsc,lan9215"),
41         COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
42         COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
43         COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
44         COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
45         COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
46         COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
47         COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
48         COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
49         COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
50         COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
51         COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
52         COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
53         COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
54         COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
55         COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686"),
56         COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
57         COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
58         COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
59         COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
60         COMPAT(INTEL_MICROCODE, "intel,microcode"),
61         COMPAT(INTEL_PANTHERPOINT_AHCI, "intel,pantherpoint-ahci"),
62         COMPAT(INTEL_MODEL_206AX, "intel,model-206ax"),
63         COMPAT(INTEL_GMA, "intel,gma"),
64         COMPAT(AMS_AS3722, "ams,as3722"),
65         COMPAT(INTEL_ICH_SPI, "intel,ich-spi"),
66         COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
67         COMPAT(SOCIONEXT_XHCI, "socionext,uniphier-xhci"),
68         COMPAT(COMPAT_INTEL_PCH, "intel,bd82x6x"),
69         COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
70         COMPAT(ALTERA_SOCFPGA_DWMMC, "altr,socfpga-dw-mshc"),
71         COMPAT(ALTERA_SOCFPGA_DWC2USB, "snps,dwc2"),
72         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
73         COMPAT(COMPAT_INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
74         COMPAT(COMPAT_INTEL_IVYBRIDGE_FSP, "intel,ivybridge-fsp"),
75 };
76
77 const char *fdtdec_get_compatible(enum fdt_compat_id id)
78 {
79         /* We allow reading of the 'unknown' ID for testing purposes */
80         assert(id >= 0 && id < COMPAT_COUNT);
81         return compat_names[id];
82 }
83
84 fdt_addr_t fdtdec_get_addr_size_fixed(const void *blob, int node,
85                 const char *prop_name, int index, int na, int ns,
86                 fdt_size_t *sizep)
87 {
88         const fdt32_t *prop, *prop_end;
89         const fdt32_t *prop_addr, *prop_size, *prop_after_size;
90         int len;
91         fdt_addr_t addr;
92
93         debug("%s: %s: ", __func__, prop_name);
94
95         if (na > (sizeof(fdt_addr_t) / sizeof(fdt32_t))) {
96                 debug("(na too large for fdt_addr_t type)\n");
97                 return FDT_ADDR_T_NONE;
98         }
99
100         if (ns > (sizeof(fdt_size_t) / sizeof(fdt32_t))) {
101                 debug("(ns too large for fdt_size_t type)\n");
102                 return FDT_ADDR_T_NONE;
103         }
104
105         prop = fdt_getprop(blob, node, prop_name, &len);
106         if (!prop) {
107                 debug("(not found)\n");
108                 return FDT_ADDR_T_NONE;
109         }
110         prop_end = prop + (len / sizeof(*prop));
111
112         prop_addr = prop + (index * (na + ns));
113         prop_size = prop_addr + na;
114         prop_after_size = prop_size + ns;
115         if (prop_after_size > prop_end) {
116                 debug("(not enough data: expected >= %d cells, got %d cells)\n",
117                       (u32)(prop_after_size - prop), ((u32)(prop_end - prop)));
118                 return FDT_ADDR_T_NONE;
119         }
120
121         addr = fdtdec_get_number(prop_addr, na);
122
123         if (sizep) {
124                 *sizep = fdtdec_get_number(prop_size, ns);
125                 debug("addr=%08llx, size=%llx\n", (unsigned long long)addr,
126                       (unsigned long long)*sizep);
127         } else {
128                 debug("addr=%08llx\n", (unsigned long long)addr);
129         }
130
131         return addr;
132 }
133
134 fdt_addr_t fdtdec_get_addr_size_auto_parent(const void *blob, int parent,
135                 int node, const char *prop_name, int index, fdt_size_t *sizep)
136 {
137         int na, ns;
138
139         debug("%s: ", __func__);
140
141         na = fdt_address_cells(blob, parent);
142         if (na < 1) {
143                 debug("(bad #address-cells)\n");
144                 return FDT_ADDR_T_NONE;
145         }
146
147         ns = fdt_size_cells(blob, parent);
148         if (ns < 0) {
149                 debug("(bad #size-cells)\n");
150                 return FDT_ADDR_T_NONE;
151         }
152
153         debug("na=%d, ns=%d, ", na, ns);
154
155         return fdtdec_get_addr_size_fixed(blob, node, prop_name, index, na,
156                                           ns, sizep);
157 }
158
159 fdt_addr_t fdtdec_get_addr_size_auto_noparent(const void *blob, int node,
160                 const char *prop_name, int index, fdt_size_t *sizep)
161 {
162         int parent;
163
164         debug("%s: ", __func__);
165
166         parent = fdt_parent_offset(blob, node);
167         if (parent < 0) {
168                 debug("(no parent found)\n");
169                 return FDT_ADDR_T_NONE;
170         }
171
172         return fdtdec_get_addr_size_auto_parent(blob, parent, node, prop_name,
173                                                 index, sizep);
174 }
175
176 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
177                 const char *prop_name, fdt_size_t *sizep)
178 {
179         int ns = sizep ? (sizeof(fdt_size_t) / sizeof(fdt32_t)) : 0;
180
181         return fdtdec_get_addr_size_fixed(blob, node, prop_name, 0,
182                                           sizeof(fdt_addr_t) / sizeof(fdt32_t),
183                                           ns, sizep);
184 }
185
186 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
187                 const char *prop_name)
188 {
189         return fdtdec_get_addr_size(blob, node, prop_name, NULL);
190 }
191
192 #if defined(CONFIG_PCI) && defined(CONFIG_DM_PCI)
193 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
194                 const char *prop_name, struct fdt_pci_addr *addr)
195 {
196         const u32 *cell;
197         int len;
198         int ret = -ENOENT;
199
200         debug("%s: %s: ", __func__, prop_name);
201
202         /*
203          * If we follow the pci bus bindings strictly, we should check
204          * the value of the node's parent node's #address-cells and
205          * #size-cells. They need to be 3 and 2 accordingly. However,
206          * for simplicity we skip the check here.
207          */
208         cell = fdt_getprop(blob, node, prop_name, &len);
209         if (!cell)
210                 goto fail;
211
212         if ((len % FDT_PCI_REG_SIZE) == 0) {
213                 int num = len / FDT_PCI_REG_SIZE;
214                 int i;
215
216                 for (i = 0; i < num; i++) {
217                         debug("pci address #%d: %08lx %08lx %08lx\n", i,
218                               (ulong)fdt32_to_cpu(cell[0]),
219                               (ulong)fdt32_to_cpu(cell[1]),
220                               (ulong)fdt32_to_cpu(cell[2]));
221                         if ((fdt32_to_cpu(*cell) & type) == type) {
222                                 addr->phys_hi = fdt32_to_cpu(cell[0]);
223                                 addr->phys_mid = fdt32_to_cpu(cell[1]);
224                                 addr->phys_lo = fdt32_to_cpu(cell[1]);
225                                 break;
226                         } else {
227                                 cell += (FDT_PCI_ADDR_CELLS +
228                                          FDT_PCI_SIZE_CELLS);
229                         }
230                 }
231
232                 if (i == num) {
233                         ret = -ENXIO;
234                         goto fail;
235                 }
236
237                 return 0;
238         } else {
239                 ret = -EINVAL;
240         }
241
242 fail:
243         debug("(not found)\n");
244         return ret;
245 }
246
247 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
248 {
249         const char *list, *end;
250         int len;
251
252         list = fdt_getprop(blob, node, "compatible", &len);
253         if (!list)
254                 return -ENOENT;
255
256         end = list + len;
257         while (list < end) {
258                 char *s;
259
260                 len = strlen(list);
261                 if (len >= strlen("pciVVVV,DDDD")) {
262                         s = strstr(list, "pci");
263
264                         /*
265                          * check if the string is something like pciVVVV,DDDD.RR
266                          * or just pciVVVV,DDDD
267                          */
268                         if (s && s[7] == ',' &&
269                             (s[12] == '.' || s[12] == 0)) {
270                                 s += 3;
271                                 *vendor = simple_strtol(s, NULL, 16);
272
273                                 s += 5;
274                                 *device = simple_strtol(s, NULL, 16);
275
276                                 return 0;
277                         }
278                 }
279                 list += (len + 1);
280         }
281
282         return -ENOENT;
283 }
284
285 int fdtdec_get_pci_bar32(struct udevice *dev, struct fdt_pci_addr *addr,
286                          u32 *bar)
287 {
288         int barnum;
289
290         /* extract the bar number from fdt_pci_addr */
291         barnum = addr->phys_hi & 0xff;
292         if ((barnum < PCI_BASE_ADDRESS_0) || (barnum > PCI_CARDBUS_CIS))
293                 return -EINVAL;
294
295         barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
296         *bar = dm_pci_read_bar32(dev, barnum);
297
298         return 0;
299 }
300 #endif
301
302 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
303                 uint64_t default_val)
304 {
305         const uint64_t *cell64;
306         int length;
307
308         cell64 = fdt_getprop(blob, node, prop_name, &length);
309         if (!cell64 || length < sizeof(*cell64))
310                 return default_val;
311
312         return fdt64_to_cpu(*cell64);
313 }
314
315 int fdtdec_get_is_enabled(const void *blob, int node)
316 {
317         const char *cell;
318
319         /*
320          * It should say "okay", so only allow that. Some fdts use "ok" but
321          * this is a bug. Please fix your device tree source file. See here
322          * for discussion:
323          *
324          * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
325          */
326         cell = fdt_getprop(blob, node, "status", NULL);
327         if (cell)
328                 return 0 == strcmp(cell, "okay");
329         return 1;
330 }
331
332 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
333 {
334         enum fdt_compat_id id;
335
336         /* Search our drivers */
337         for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
338                 if (0 == fdt_node_check_compatible(blob, node,
339                                 compat_names[id]))
340                         return id;
341         return COMPAT_UNKNOWN;
342 }
343
344 int fdtdec_next_compatible(const void *blob, int node,
345                 enum fdt_compat_id id)
346 {
347         return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
348 }
349
350 int fdtdec_next_compatible_subnode(const void *blob, int node,
351                 enum fdt_compat_id id, int *depthp)
352 {
353         do {
354                 node = fdt_next_node(blob, node, depthp);
355         } while (*depthp > 1);
356
357         /* If this is a direct subnode, and compatible, return it */
358         if (*depthp == 1 && 0 == fdt_node_check_compatible(
359                                                 blob, node, compat_names[id]))
360                 return node;
361
362         return -FDT_ERR_NOTFOUND;
363 }
364
365 int fdtdec_next_alias(const void *blob, const char *name,
366                 enum fdt_compat_id id, int *upto)
367 {
368 #define MAX_STR_LEN 20
369         char str[MAX_STR_LEN + 20];
370         int node, err;
371
372         /* snprintf() is not available */
373         assert(strlen(name) < MAX_STR_LEN);
374         sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
375         node = fdt_path_offset(blob, str);
376         if (node < 0)
377                 return node;
378         err = fdt_node_check_compatible(blob, node, compat_names[id]);
379         if (err < 0)
380                 return err;
381         if (err)
382                 return -FDT_ERR_NOTFOUND;
383         (*upto)++;
384         return node;
385 }
386
387 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
388                         enum fdt_compat_id id, int *node_list, int maxcount)
389 {
390         memset(node_list, '\0', sizeof(*node_list) * maxcount);
391
392         return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
393 }
394
395 /* TODO: Can we tighten this code up a little? */
396 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
397                         enum fdt_compat_id id, int *node_list, int maxcount)
398 {
399         int name_len = strlen(name);
400         int nodes[maxcount];
401         int num_found = 0;
402         int offset, node;
403         int alias_node;
404         int count;
405         int i, j;
406
407         /* find the alias node if present */
408         alias_node = fdt_path_offset(blob, "/aliases");
409
410         /*
411          * start with nothing, and we can assume that the root node can't
412          * match
413          */
414         memset(nodes, '\0', sizeof(nodes));
415
416         /* First find all the compatible nodes */
417         for (node = count = 0; node >= 0 && count < maxcount;) {
418                 node = fdtdec_next_compatible(blob, node, id);
419                 if (node >= 0)
420                         nodes[count++] = node;
421         }
422         if (node >= 0)
423                 debug("%s: warning: maxcount exceeded with alias '%s'\n",
424                        __func__, name);
425
426         /* Now find all the aliases */
427         for (offset = fdt_first_property_offset(blob, alias_node);
428                         offset > 0;
429                         offset = fdt_next_property_offset(blob, offset)) {
430                 const struct fdt_property *prop;
431                 const char *path;
432                 int number;
433                 int found;
434
435                 node = 0;
436                 prop = fdt_get_property_by_offset(blob, offset, NULL);
437                 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
438                 if (prop->len && 0 == strncmp(path, name, name_len))
439                         node = fdt_path_offset(blob, prop->data);
440                 if (node <= 0)
441                         continue;
442
443                 /* Get the alias number */
444                 number = simple_strtoul(path + name_len, NULL, 10);
445                 if (number < 0 || number >= maxcount) {
446                         debug("%s: warning: alias '%s' is out of range\n",
447                                __func__, path);
448                         continue;
449                 }
450
451                 /* Make sure the node we found is actually in our list! */
452                 found = -1;
453                 for (j = 0; j < count; j++)
454                         if (nodes[j] == node) {
455                                 found = j;
456                                 break;
457                         }
458
459                 if (found == -1) {
460                         debug("%s: warning: alias '%s' points to a node "
461                                 "'%s' that is missing or is not compatible "
462                                 " with '%s'\n", __func__, path,
463                                 fdt_get_name(blob, node, NULL),
464                                compat_names[id]);
465                         continue;
466                 }
467
468                 /*
469                  * Add this node to our list in the right place, and mark
470                  * it as done.
471                  */
472                 if (fdtdec_get_is_enabled(blob, node)) {
473                         if (node_list[number]) {
474                                 debug("%s: warning: alias '%s' requires that "
475                                       "a node be placed in the list in a "
476                                       "position which is already filled by "
477                                       "node '%s'\n", __func__, path,
478                                       fdt_get_name(blob, node, NULL));
479                                 continue;
480                         }
481                         node_list[number] = node;
482                         if (number >= num_found)
483                                 num_found = number + 1;
484                 }
485                 nodes[found] = 0;
486         }
487
488         /* Add any nodes not mentioned by an alias */
489         for (i = j = 0; i < maxcount; i++) {
490                 if (!node_list[i]) {
491                         for (; j < maxcount; j++)
492                                 if (nodes[j] &&
493                                         fdtdec_get_is_enabled(blob, nodes[j]))
494                                         break;
495
496                         /* Have we run out of nodes to add? */
497                         if (j == maxcount)
498                                 break;
499
500                         assert(!node_list[i]);
501                         node_list[i] = nodes[j++];
502                         if (i >= num_found)
503                                 num_found = i + 1;
504                 }
505         }
506
507         return num_found;
508 }
509
510 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
511                          int *seqp)
512 {
513         int base_len = strlen(base);
514         const char *find_name;
515         int find_namelen;
516         int prop_offset;
517         int aliases;
518
519         find_name = fdt_get_name(blob, offset, &find_namelen);
520         debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
521
522         aliases = fdt_path_offset(blob, "/aliases");
523         for (prop_offset = fdt_first_property_offset(blob, aliases);
524              prop_offset > 0;
525              prop_offset = fdt_next_property_offset(blob, prop_offset)) {
526                 const char *prop;
527                 const char *name;
528                 const char *slash;
529                 int len, val;
530
531                 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
532                 debug("   - %s, %s\n", name, prop);
533                 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
534                     strncmp(name, base, base_len))
535                         continue;
536
537                 slash = strrchr(prop, '/');
538                 if (strcmp(slash + 1, find_name))
539                         continue;
540                 val = trailing_strtol(name);
541                 if (val != -1) {
542                         *seqp = val;
543                         debug("Found seq %d\n", *seqp);
544                         return 0;
545                 }
546         }
547
548         debug("Not found\n");
549         return -ENOENT;
550 }
551
552 const char *fdtdec_get_chosen_prop(const void *blob, const char *name)
553 {
554         int chosen_node;
555
556         if (!blob)
557                 return NULL;
558         chosen_node = fdt_path_offset(blob, "/chosen");
559         return fdt_getprop(blob, chosen_node, name, NULL);
560 }
561
562 int fdtdec_get_chosen_node(const void *blob, const char *name)
563 {
564         const char *prop;
565
566         prop = fdtdec_get_chosen_prop(blob, name);
567         if (!prop)
568                 return -FDT_ERR_NOTFOUND;
569         return fdt_path_offset(blob, prop);
570 }
571
572 int fdtdec_check_fdt(void)
573 {
574         /*
575          * We must have an FDT, but we cannot panic() yet since the console
576          * is not ready. So for now, just assert(). Boards which need an early
577          * FDT (prior to console ready) will need to make their own
578          * arrangements and do their own checks.
579          */
580         assert(!fdtdec_prepare_fdt());
581         return 0;
582 }
583
584 /*
585  * This function is a little odd in that it accesses global data. At some
586  * point if the architecture board.c files merge this will make more sense.
587  * Even now, it is common code.
588  */
589 int fdtdec_prepare_fdt(void)
590 {
591         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
592             fdt_check_header(gd->fdt_blob)) {
593 #ifdef CONFIG_SPL_BUILD
594                 puts("Missing DTB\n");
595 #else
596                 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");
597 # ifdef DEBUG
598                 if (gd->fdt_blob) {
599                         printf("fdt_blob=%p\n", gd->fdt_blob);
600                         print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
601                                      32, 0);
602                 }
603 # endif
604 #endif
605                 return -1;
606         }
607         return 0;
608 }
609
610 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
611 {
612         const u32 *phandle;
613         int lookup;
614
615         debug("%s: %s\n", __func__, prop_name);
616         phandle = fdt_getprop(blob, node, prop_name, NULL);
617         if (!phandle)
618                 return -FDT_ERR_NOTFOUND;
619
620         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
621         return lookup;
622 }
623
624 /**
625  * Look up a property in a node and check that it has a minimum length.
626  *
627  * @param blob          FDT blob
628  * @param node          node to examine
629  * @param prop_name     name of property to find
630  * @param min_len       minimum property length in bytes
631  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
632                         found, or -FDT_ERR_BADLAYOUT if not enough data
633  * @return pointer to cell, which is only valid if err == 0
634  */
635 static const void *get_prop_check_min_len(const void *blob, int node,
636                 const char *prop_name, int min_len, int *err)
637 {
638         const void *cell;
639         int len;
640
641         debug("%s: %s\n", __func__, prop_name);
642         cell = fdt_getprop(blob, node, prop_name, &len);
643         if (!cell)
644                 *err = -FDT_ERR_NOTFOUND;
645         else if (len < min_len)
646                 *err = -FDT_ERR_BADLAYOUT;
647         else
648                 *err = 0;
649         return cell;
650 }
651
652 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
653                 u32 *array, int count)
654 {
655         const u32 *cell;
656         int i, err = 0;
657
658         debug("%s: %s\n", __func__, prop_name);
659         cell = get_prop_check_min_len(blob, node, prop_name,
660                                       sizeof(u32) * count, &err);
661         if (!err) {
662                 for (i = 0; i < count; i++)
663                         array[i] = fdt32_to_cpu(cell[i]);
664         }
665         return err;
666 }
667
668 int fdtdec_get_int_array_count(const void *blob, int node,
669                                const char *prop_name, u32 *array, int count)
670 {
671         const u32 *cell;
672         int len, elems;
673         int i;
674
675         debug("%s: %s\n", __func__, prop_name);
676         cell = fdt_getprop(blob, node, prop_name, &len);
677         if (!cell)
678                 return -FDT_ERR_NOTFOUND;
679         elems = len / sizeof(u32);
680         if (count > elems)
681                 count = elems;
682         for (i = 0; i < count; i++)
683                 array[i] = fdt32_to_cpu(cell[i]);
684
685         return count;
686 }
687
688 const u32 *fdtdec_locate_array(const void *blob, int node,
689                                const char *prop_name, int count)
690 {
691         const u32 *cell;
692         int err;
693
694         cell = get_prop_check_min_len(blob, node, prop_name,
695                                       sizeof(u32) * count, &err);
696         return err ? NULL : cell;
697 }
698
699 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
700 {
701         const s32 *cell;
702         int len;
703
704         debug("%s: %s\n", __func__, prop_name);
705         cell = fdt_getprop(blob, node, prop_name, &len);
706         return cell != NULL;
707 }
708
709 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
710                                    const char *list_name,
711                                    const char *cells_name,
712                                    int cell_count, int index,
713                                    struct fdtdec_phandle_args *out_args)
714 {
715         const __be32 *list, *list_end;
716         int rc = 0, size, cur_index = 0;
717         uint32_t count = 0;
718         int node = -1;
719         int phandle;
720
721         /* Retrieve the phandle list property */
722         list = fdt_getprop(blob, src_node, list_name, &size);
723         if (!list)
724                 return -ENOENT;
725         list_end = list + size / sizeof(*list);
726
727         /* Loop over the phandles until all the requested entry is found */
728         while (list < list_end) {
729                 rc = -EINVAL;
730                 count = 0;
731
732                 /*
733                  * If phandle is 0, then it is an empty entry with no
734                  * arguments.  Skip forward to the next entry.
735                  */
736                 phandle = be32_to_cpup(list++);
737                 if (phandle) {
738                         /*
739                          * Find the provider node and parse the #*-cells
740                          * property to determine the argument length.
741                          *
742                          * This is not needed if the cell count is hard-coded
743                          * (i.e. cells_name not set, but cell_count is set),
744                          * except when we're going to return the found node
745                          * below.
746                          */
747                         if (cells_name || cur_index == index) {
748                                 node = fdt_node_offset_by_phandle(blob,
749                                                                   phandle);
750                                 if (!node) {
751                                         debug("%s: could not find phandle\n",
752                                               fdt_get_name(blob, src_node,
753                                                            NULL));
754                                         goto err;
755                                 }
756                         }
757
758                         if (cells_name) {
759                                 count = fdtdec_get_int(blob, node, cells_name,
760                                                        -1);
761                                 if (count == -1) {
762                                         debug("%s: could not get %s for %s\n",
763                                               fdt_get_name(blob, src_node,
764                                                            NULL),
765                                               cells_name,
766                                               fdt_get_name(blob, node,
767                                                            NULL));
768                                         goto err;
769                                 }
770                         } else {
771                                 count = cell_count;
772                         }
773
774                         /*
775                          * Make sure that the arguments actually fit in the
776                          * remaining property data length
777                          */
778                         if (list + count > list_end) {
779                                 debug("%s: arguments longer than property\n",
780                                       fdt_get_name(blob, src_node, NULL));
781                                 goto err;
782                         }
783                 }
784
785                 /*
786                  * All of the error cases above bail out of the loop, so at
787                  * this point, the parsing is successful. If the requested
788                  * index matches, then fill the out_args structure and return,
789                  * or return -ENOENT for an empty entry.
790                  */
791                 rc = -ENOENT;
792                 if (cur_index == index) {
793                         if (!phandle)
794                                 goto err;
795
796                         if (out_args) {
797                                 int i;
798
799                                 if (count > MAX_PHANDLE_ARGS) {
800                                         debug("%s: too many arguments %d\n",
801                                               fdt_get_name(blob, src_node,
802                                                            NULL), count);
803                                         count = MAX_PHANDLE_ARGS;
804                                 }
805                                 out_args->node = node;
806                                 out_args->args_count = count;
807                                 for (i = 0; i < count; i++) {
808                                         out_args->args[i] =
809                                                         be32_to_cpup(list++);
810                                 }
811                         }
812
813                         /* Found it! return success */
814                         return 0;
815                 }
816
817                 node = -1;
818                 list += count;
819                 cur_index++;
820         }
821
822         /*
823          * Result will be one of:
824          * -ENOENT : index is for empty phandle
825          * -EINVAL : parsing error on data
826          * [1..n]  : Number of phandle (count mode; when index = -1)
827          */
828         rc = index < 0 ? cur_index : -ENOENT;
829  err:
830         return rc;
831 }
832
833 int fdtdec_get_child_count(const void *blob, int node)
834 {
835         int subnode;
836         int num = 0;
837
838         fdt_for_each_subnode(blob, subnode, node)
839                 num++;
840
841         return num;
842 }
843
844 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
845                 u8 *array, int count)
846 {
847         const u8 *cell;
848         int err;
849
850         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
851         if (!err)
852                 memcpy(array, cell, count);
853         return err;
854 }
855
856 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
857                              const char *prop_name, int count)
858 {
859         const u8 *cell;
860         int err;
861
862         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
863         if (err)
864                 return NULL;
865         return cell;
866 }
867
868 int fdtdec_get_config_int(const void *blob, const char *prop_name,
869                 int default_val)
870 {
871         int config_node;
872
873         debug("%s: %s\n", __func__, prop_name);
874         config_node = fdt_path_offset(blob, "/config");
875         if (config_node < 0)
876                 return default_val;
877         return fdtdec_get_int(blob, config_node, prop_name, default_val);
878 }
879
880 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
881 {
882         int config_node;
883         const void *prop;
884
885         debug("%s: %s\n", __func__, prop_name);
886         config_node = fdt_path_offset(blob, "/config");
887         if (config_node < 0)
888                 return 0;
889         prop = fdt_get_property(blob, config_node, prop_name, NULL);
890
891         return prop != NULL;
892 }
893
894 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
895 {
896         const char *nodep;
897         int nodeoffset;
898         int len;
899
900         debug("%s: %s\n", __func__, prop_name);
901         nodeoffset = fdt_path_offset(blob, "/config");
902         if (nodeoffset < 0)
903                 return NULL;
904
905         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
906         if (!nodep)
907                 return NULL;
908
909         return (char *)nodep;
910 }
911
912 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
913                          fdt_addr_t *basep, fdt_size_t *sizep)
914 {
915         const fdt_addr_t *cell;
916         int len;
917
918         debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
919               prop_name);
920         cell = fdt_getprop(blob, node, prop_name, &len);
921         if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
922                 debug("cell=%p, len=%d\n", cell, len);
923                 return -1;
924         }
925
926         *basep = fdt_addr_to_cpu(*cell);
927         *sizep = fdt_size_to_cpu(cell[1]);
928         debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
929               (ulong)*sizep);
930
931         return 0;
932 }
933
934 /**
935  * Read a flash entry from the fdt
936  *
937  * @param blob          FDT blob
938  * @param node          Offset of node to read
939  * @param name          Name of node being read
940  * @param entry         Place to put offset and size of this node
941  * @return 0 if ok, -ve on error
942  */
943 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
944                            struct fmap_entry *entry)
945 {
946         const char *prop;
947         u32 reg[2];
948
949         if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
950                 debug("Node '%s' has bad/missing 'reg' property\n", name);
951                 return -FDT_ERR_NOTFOUND;
952         }
953         entry->offset = reg[0];
954         entry->length = reg[1];
955         entry->used = fdtdec_get_int(blob, node, "used", entry->length);
956         prop = fdt_getprop(blob, node, "compress", NULL);
957         entry->compress_algo = prop && !strcmp(prop, "lzo") ?
958                 FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
959         prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
960         entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
961         entry->hash = (uint8_t *)prop;
962
963         return 0;
964 }
965
966 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
967 {
968         u64 number = 0;
969
970         while (cells--)
971                 number = (number << 32) | fdt32_to_cpu(*ptr++);
972
973         return number;
974 }
975
976 int fdt_get_resource(const void *fdt, int node, const char *property,
977                      unsigned int index, struct fdt_resource *res)
978 {
979         const fdt32_t *ptr, *end;
980         int na, ns, len, parent;
981         unsigned int i = 0;
982
983         parent = fdt_parent_offset(fdt, node);
984         if (parent < 0)
985                 return parent;
986
987         na = fdt_address_cells(fdt, parent);
988         ns = fdt_size_cells(fdt, parent);
989
990         ptr = fdt_getprop(fdt, node, property, &len);
991         if (!ptr)
992                 return len;
993
994         end = ptr + len / sizeof(*ptr);
995
996         while (ptr + na + ns <= end) {
997                 if (i == index) {
998                         res->start = res->end = fdtdec_get_number(ptr, na);
999                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
1000                         return 0;
1001                 }
1002
1003                 ptr += na + ns;
1004                 i++;
1005         }
1006
1007         return -FDT_ERR_NOTFOUND;
1008 }
1009
1010 int fdt_get_named_resource(const void *fdt, int node, const char *property,
1011                            const char *prop_names, const char *name,
1012                            struct fdt_resource *res)
1013 {
1014         int index;
1015
1016         index = fdt_find_string(fdt, node, prop_names, name);
1017         if (index < 0)
1018                 return index;
1019
1020         return fdt_get_resource(fdt, node, property, index, res);
1021 }
1022
1023 int fdtdec_decode_memory_region(const void *blob, int config_node,
1024                                 const char *mem_type, const char *suffix,
1025                                 fdt_addr_t *basep, fdt_size_t *sizep)
1026 {
1027         char prop_name[50];
1028         const char *mem;
1029         fdt_size_t size, offset_size;
1030         fdt_addr_t base, offset;
1031         int node;
1032
1033         if (config_node == -1) {
1034                 config_node = fdt_path_offset(blob, "/config");
1035                 if (config_node < 0) {
1036                         debug("%s: Cannot find /config node\n", __func__);
1037                         return -ENOENT;
1038                 }
1039         }
1040         if (!suffix)
1041                 suffix = "";
1042
1043         snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
1044                  suffix);
1045         mem = fdt_getprop(blob, config_node, prop_name, NULL);
1046         if (!mem) {
1047                 debug("%s: No memory type for '%s', using /memory\n", __func__,
1048                       prop_name);
1049                 mem = "/memory";
1050         }
1051
1052         node = fdt_path_offset(blob, mem);
1053         if (node < 0) {
1054                 debug("%s: Failed to find node '%s': %s\n", __func__, mem,
1055                       fdt_strerror(node));
1056                 return -ENOENT;
1057         }
1058
1059         /*
1060          * Not strictly correct - the memory may have multiple banks. We just
1061          * use the first
1062          */
1063         if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
1064                 debug("%s: Failed to decode memory region %s\n", __func__,
1065                       mem);
1066                 return -EINVAL;
1067         }
1068
1069         snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1070                  suffix);
1071         if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1072                                  &offset_size)) {
1073                 debug("%s: Failed to decode memory region '%s'\n", __func__,
1074                       prop_name);
1075                 return -EINVAL;
1076         }
1077
1078         *basep = base + offset;
1079         *sizep = offset_size;
1080
1081         return 0;
1082 }
1083
1084 static int decode_timing_property(const void *blob, int node, const char *name,
1085                                   struct timing_entry *result)
1086 {
1087         int length, ret = 0;
1088         const u32 *prop;
1089
1090         prop = fdt_getprop(blob, node, name, &length);
1091         if (!prop) {
1092                 debug("%s: could not find property %s\n",
1093                       fdt_get_name(blob, node, NULL), name);
1094                 return length;
1095         }
1096
1097         if (length == sizeof(u32)) {
1098                 result->typ = fdtdec_get_int(blob, node, name, 0);
1099                 result->min = result->typ;
1100                 result->max = result->typ;
1101         } else {
1102                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1103         }
1104
1105         return ret;
1106 }
1107
1108 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1109                                  struct display_timing *dt)
1110 {
1111         int i, node, timings_node;
1112         u32 val = 0;
1113         int ret = 0;
1114
1115         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1116         if (timings_node < 0)
1117                 return timings_node;
1118
1119         for (i = 0, node = fdt_first_subnode(blob, timings_node);
1120              node > 0 && i != index;
1121              node = fdt_next_subnode(blob, node))
1122                 i++;
1123
1124         if (node < 0)
1125                 return node;
1126
1127         memset(dt, 0, sizeof(*dt));
1128
1129         ret |= decode_timing_property(blob, node, "hback-porch",
1130                                       &dt->hback_porch);
1131         ret |= decode_timing_property(blob, node, "hfront-porch",
1132                                       &dt->hfront_porch);
1133         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1134         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1135         ret |= decode_timing_property(blob, node, "vback-porch",
1136                                       &dt->vback_porch);
1137         ret |= decode_timing_property(blob, node, "vfront-porch",
1138                                       &dt->vfront_porch);
1139         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1140         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1141         ret |= decode_timing_property(blob, node, "clock-frequency",
1142                                       &dt->pixelclock);
1143
1144         dt->flags = 0;
1145         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1146         if (val != -1) {
1147                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1148                                 DISPLAY_FLAGS_VSYNC_LOW;
1149         }
1150         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1151         if (val != -1) {
1152                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1153                                 DISPLAY_FLAGS_HSYNC_LOW;
1154         }
1155         val = fdtdec_get_int(blob, node, "de-active", -1);
1156         if (val != -1) {
1157                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1158                                 DISPLAY_FLAGS_DE_LOW;
1159         }
1160         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1161         if (val != -1) {
1162                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1163                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1164         }
1165
1166         if (fdtdec_get_bool(blob, node, "interlaced"))
1167                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1168         if (fdtdec_get_bool(blob, node, "doublescan"))
1169                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1170         if (fdtdec_get_bool(blob, node, "doubleclk"))
1171                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1172
1173         return ret;
1174 }
1175
1176 int fdtdec_setup(void)
1177 {
1178 #if CONFIG_IS_ENABLED(OF_CONTROL)
1179 # ifdef CONFIG_OF_EMBED
1180         /* Get a pointer to the FDT */
1181         gd->fdt_blob = __dtb_dt_begin;
1182 # elif defined CONFIG_OF_SEPARATE
1183 #  ifdef CONFIG_SPL_BUILD
1184         /* FDT is at end of BSS unless it is in a different memory region */
1185         if (IS_ENABLED(CONFIG_SPL_SEPARATE_BSS))
1186                 gd->fdt_blob = (ulong *)&_image_binary_end;
1187         else
1188                 gd->fdt_blob = (ulong *)&__bss_end;
1189 #  else
1190         /* FDT is at end of image */
1191         gd->fdt_blob = (ulong *)&_end;
1192 #  endif
1193 # elif defined(CONFIG_OF_HOSTFILE)
1194         if (sandbox_read_fdt_from_file()) {
1195                 puts("Failed to read control FDT\n");
1196                 return -1;
1197         }
1198 # endif
1199 # ifndef CONFIG_SPL_BUILD
1200         /* Allow the early environment to override the fdt address */
1201         gd->fdt_blob = (void *)getenv_ulong("fdtcontroladdr", 16,
1202                                                 (uintptr_t)gd->fdt_blob);
1203 # endif
1204 #endif
1205         return fdtdec_prepare_fdt();
1206 }
1207
1208 #endif /* !USE_HOSTCC */