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