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