]> git.sur5r.net Git - u-boot/blob - lib/fdtdec.c
Merge branch 'master' of git://git.denx.de/u-boot-fsl-qoriq
[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 int fdtdec_get_chosen_node(const void *blob, const char *name)
605 {
606         const char *prop;
607         int chosen_node;
608         int len;
609
610         if (!blob)
611                 return -FDT_ERR_NOTFOUND;
612         chosen_node = fdt_path_offset(blob, "/chosen");
613         prop = fdt_getprop(blob, chosen_node, name, &len);
614         if (!prop)
615                 return -FDT_ERR_NOTFOUND;
616         return fdt_path_offset(blob, prop);
617 }
618
619 int fdtdec_check_fdt(void)
620 {
621         /*
622          * We must have an FDT, but we cannot panic() yet since the console
623          * is not ready. So for now, just assert(). Boards which need an early
624          * FDT (prior to console ready) will need to make their own
625          * arrangements and do their own checks.
626          */
627         assert(!fdtdec_prepare_fdt());
628         return 0;
629 }
630
631 /*
632  * This function is a little odd in that it accesses global data. At some
633  * point if the architecture board.c files merge this will make more sense.
634  * Even now, it is common code.
635  */
636 int fdtdec_prepare_fdt(void)
637 {
638         if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
639             fdt_check_header(gd->fdt_blob)) {
640 #ifdef CONFIG_SPL_BUILD
641                 puts("Missing DTB\n");
642 #else
643                 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");
644 # ifdef DEBUG
645                 if (gd->fdt_blob) {
646                         printf("fdt_blob=%p\n", gd->fdt_blob);
647                         print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
648                                      32, 0);
649                 }
650 # endif
651 #endif
652                 return -1;
653         }
654         return 0;
655 }
656
657 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
658 {
659         const u32 *phandle;
660         int lookup;
661
662         debug("%s: %s\n", __func__, prop_name);
663         phandle = fdt_getprop(blob, node, prop_name, NULL);
664         if (!phandle)
665                 return -FDT_ERR_NOTFOUND;
666
667         lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
668         return lookup;
669 }
670
671 /**
672  * Look up a property in a node and check that it has a minimum length.
673  *
674  * @param blob          FDT blob
675  * @param node          node to examine
676  * @param prop_name     name of property to find
677  * @param min_len       minimum property length in bytes
678  * @param err           0 if ok, or -FDT_ERR_NOTFOUND if the property is not
679                         found, or -FDT_ERR_BADLAYOUT if not enough data
680  * @return pointer to cell, which is only valid if err == 0
681  */
682 static const void *get_prop_check_min_len(const void *blob, int node,
683                 const char *prop_name, int min_len, int *err)
684 {
685         const void *cell;
686         int len;
687
688         debug("%s: %s\n", __func__, prop_name);
689         cell = fdt_getprop(blob, node, prop_name, &len);
690         if (!cell)
691                 *err = -FDT_ERR_NOTFOUND;
692         else if (len < min_len)
693                 *err = -FDT_ERR_BADLAYOUT;
694         else
695                 *err = 0;
696         return cell;
697 }
698
699 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
700                 u32 *array, int count)
701 {
702         const u32 *cell;
703         int i, err = 0;
704
705         debug("%s: %s\n", __func__, prop_name);
706         cell = get_prop_check_min_len(blob, node, prop_name,
707                                       sizeof(u32) * count, &err);
708         if (!err) {
709                 for (i = 0; i < count; i++)
710                         array[i] = fdt32_to_cpu(cell[i]);
711         }
712         return err;
713 }
714
715 int fdtdec_get_int_array_count(const void *blob, int node,
716                                const char *prop_name, u32 *array, int count)
717 {
718         const u32 *cell;
719         int len, elems;
720         int i;
721
722         debug("%s: %s\n", __func__, prop_name);
723         cell = fdt_getprop(blob, node, prop_name, &len);
724         if (!cell)
725                 return -FDT_ERR_NOTFOUND;
726         elems = len / sizeof(u32);
727         if (count > elems)
728                 count = elems;
729         for (i = 0; i < count; i++)
730                 array[i] = fdt32_to_cpu(cell[i]);
731
732         return count;
733 }
734
735 const u32 *fdtdec_locate_array(const void *blob, int node,
736                                const char *prop_name, int count)
737 {
738         const u32 *cell;
739         int err;
740
741         cell = get_prop_check_min_len(blob, node, prop_name,
742                                       sizeof(u32) * count, &err);
743         return err ? NULL : cell;
744 }
745
746 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
747 {
748         const s32 *cell;
749         int len;
750
751         debug("%s: %s\n", __func__, prop_name);
752         cell = fdt_getprop(blob, node, prop_name, &len);
753         return cell != NULL;
754 }
755
756 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
757                                    const char *list_name,
758                                    const char *cells_name,
759                                    int cell_count, int index,
760                                    struct fdtdec_phandle_args *out_args)
761 {
762         const __be32 *list, *list_end;
763         int rc = 0, size, cur_index = 0;
764         uint32_t count = 0;
765         int node = -1;
766         int phandle;
767
768         /* Retrieve the phandle list property */
769         list = fdt_getprop(blob, src_node, list_name, &size);
770         if (!list)
771                 return -ENOENT;
772         list_end = list + size / sizeof(*list);
773
774         /* Loop over the phandles until all the requested entry is found */
775         while (list < list_end) {
776                 rc = -EINVAL;
777                 count = 0;
778
779                 /*
780                  * If phandle is 0, then it is an empty entry with no
781                  * arguments.  Skip forward to the next entry.
782                  */
783                 phandle = be32_to_cpup(list++);
784                 if (phandle) {
785                         /*
786                          * Find the provider node and parse the #*-cells
787                          * property to determine the argument length.
788                          *
789                          * This is not needed if the cell count is hard-coded
790                          * (i.e. cells_name not set, but cell_count is set),
791                          * except when we're going to return the found node
792                          * below.
793                          */
794                         if (cells_name || cur_index == index) {
795                                 node = fdt_node_offset_by_phandle(blob,
796                                                                   phandle);
797                                 if (!node) {
798                                         debug("%s: could not find phandle\n",
799                                               fdt_get_name(blob, src_node,
800                                                            NULL));
801                                         goto err;
802                                 }
803                         }
804
805                         if (cells_name) {
806                                 count = fdtdec_get_int(blob, node, cells_name,
807                                                        -1);
808                                 if (count == -1) {
809                                         debug("%s: could not get %s for %s\n",
810                                               fdt_get_name(blob, src_node,
811                                                            NULL),
812                                               cells_name,
813                                               fdt_get_name(blob, node,
814                                                            NULL));
815                                         goto err;
816                                 }
817                         } else {
818                                 count = cell_count;
819                         }
820
821                         /*
822                          * Make sure that the arguments actually fit in the
823                          * remaining property data length
824                          */
825                         if (list + count > list_end) {
826                                 debug("%s: arguments longer than property\n",
827                                       fdt_get_name(blob, src_node, NULL));
828                                 goto err;
829                         }
830                 }
831
832                 /*
833                  * All of the error cases above bail out of the loop, so at
834                  * this point, the parsing is successful. If the requested
835                  * index matches, then fill the out_args structure and return,
836                  * or return -ENOENT for an empty entry.
837                  */
838                 rc = -ENOENT;
839                 if (cur_index == index) {
840                         if (!phandle)
841                                 goto err;
842
843                         if (out_args) {
844                                 int i;
845
846                                 if (count > MAX_PHANDLE_ARGS) {
847                                         debug("%s: too many arguments %d\n",
848                                               fdt_get_name(blob, src_node,
849                                                            NULL), count);
850                                         count = MAX_PHANDLE_ARGS;
851                                 }
852                                 out_args->node = node;
853                                 out_args->args_count = count;
854                                 for (i = 0; i < count; i++) {
855                                         out_args->args[i] =
856                                                         be32_to_cpup(list++);
857                                 }
858                         }
859
860                         /* Found it! return success */
861                         return 0;
862                 }
863
864                 node = -1;
865                 list += count;
866                 cur_index++;
867         }
868
869         /*
870          * Result will be one of:
871          * -ENOENT : index is for empty phandle
872          * -EINVAL : parsing error on data
873          * [1..n]  : Number of phandle (count mode; when index = -1)
874          */
875         rc = index < 0 ? cur_index : -ENOENT;
876  err:
877         return rc;
878 }
879
880 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
881                 u8 *array, int count)
882 {
883         const u8 *cell;
884         int err;
885
886         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
887         if (!err)
888                 memcpy(array, cell, count);
889         return err;
890 }
891
892 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
893                              const char *prop_name, int count)
894 {
895         const u8 *cell;
896         int err;
897
898         cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
899         if (err)
900                 return NULL;
901         return cell;
902 }
903
904 int fdtdec_get_config_int(const void *blob, const char *prop_name,
905                 int default_val)
906 {
907         int config_node;
908
909         debug("%s: %s\n", __func__, prop_name);
910         config_node = fdt_path_offset(blob, "/config");
911         if (config_node < 0)
912                 return default_val;
913         return fdtdec_get_int(blob, config_node, prop_name, default_val);
914 }
915
916 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
917 {
918         int config_node;
919         const void *prop;
920
921         debug("%s: %s\n", __func__, prop_name);
922         config_node = fdt_path_offset(blob, "/config");
923         if (config_node < 0)
924                 return 0;
925         prop = fdt_get_property(blob, config_node, prop_name, NULL);
926
927         return prop != NULL;
928 }
929
930 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
931 {
932         const char *nodep;
933         int nodeoffset;
934         int len;
935
936         debug("%s: %s\n", __func__, prop_name);
937         nodeoffset = fdt_path_offset(blob, "/config");
938         if (nodeoffset < 0)
939                 return NULL;
940
941         nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
942         if (!nodep)
943                 return NULL;
944
945         return (char *)nodep;
946 }
947
948 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
949                          fdt_addr_t *basep, fdt_size_t *sizep)
950 {
951         const fdt_addr_t *cell;
952         int len;
953
954         debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
955               prop_name);
956         cell = fdt_getprop(blob, node, prop_name, &len);
957         if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
958                 debug("cell=%p, len=%d\n", cell, len);
959                 return -1;
960         }
961
962         *basep = fdt_addr_to_cpu(*cell);
963         *sizep = fdt_size_to_cpu(cell[1]);
964         debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
965               (ulong)*sizep);
966
967         return 0;
968 }
969
970 /**
971  * Read a flash entry from the fdt
972  *
973  * @param blob          FDT blob
974  * @param node          Offset of node to read
975  * @param name          Name of node being read
976  * @param entry         Place to put offset and size of this node
977  * @return 0 if ok, -ve on error
978  */
979 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
980                            struct fmap_entry *entry)
981 {
982         const char *prop;
983         u32 reg[2];
984
985         if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
986                 debug("Node '%s' has bad/missing 'reg' property\n", name);
987                 return -FDT_ERR_NOTFOUND;
988         }
989         entry->offset = reg[0];
990         entry->length = reg[1];
991         entry->used = fdtdec_get_int(blob, node, "used", entry->length);
992         prop = fdt_getprop(blob, node, "compress", NULL);
993         entry->compress_algo = prop && !strcmp(prop, "lzo") ?
994                 FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
995         prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
996         entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
997         entry->hash = (uint8_t *)prop;
998
999         return 0;
1000 }
1001
1002 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
1003 {
1004         u64 number = 0;
1005
1006         while (cells--)
1007                 number = (number << 32) | fdt32_to_cpu(*ptr++);
1008
1009         return number;
1010 }
1011
1012 int fdt_get_resource(const void *fdt, int node, const char *property,
1013                      unsigned int index, struct fdt_resource *res)
1014 {
1015         const fdt32_t *ptr, *end;
1016         int na, ns, len, parent;
1017         unsigned int i = 0;
1018
1019         parent = fdt_parent_offset(fdt, node);
1020         if (parent < 0)
1021                 return parent;
1022
1023         na = fdt_address_cells(fdt, parent);
1024         ns = fdt_size_cells(fdt, parent);
1025
1026         ptr = fdt_getprop(fdt, node, property, &len);
1027         if (!ptr)
1028                 return len;
1029
1030         end = ptr + len / sizeof(*ptr);
1031
1032         while (ptr + na + ns <= end) {
1033                 if (i == index) {
1034                         res->start = res->end = fdtdec_get_number(ptr, na);
1035                         res->end += fdtdec_get_number(&ptr[na], ns) - 1;
1036                         return 0;
1037                 }
1038
1039                 ptr += na + ns;
1040                 i++;
1041         }
1042
1043         return -FDT_ERR_NOTFOUND;
1044 }
1045
1046 int fdt_get_named_resource(const void *fdt, int node, const char *property,
1047                            const char *prop_names, const char *name,
1048                            struct fdt_resource *res)
1049 {
1050         int index;
1051
1052         index = fdt_find_string(fdt, node, prop_names, name);
1053         if (index < 0)
1054                 return index;
1055
1056         return fdt_get_resource(fdt, node, property, index, res);
1057 }
1058
1059 int fdtdec_decode_memory_region(const void *blob, int config_node,
1060                                 const char *mem_type, const char *suffix,
1061                                 fdt_addr_t *basep, fdt_size_t *sizep)
1062 {
1063         char prop_name[50];
1064         const char *mem;
1065         fdt_size_t size, offset_size;
1066         fdt_addr_t base, offset;
1067         int node;
1068
1069         if (config_node == -1) {
1070                 config_node = fdt_path_offset(blob, "/config");
1071                 if (config_node < 0) {
1072                         debug("%s: Cannot find /config node\n", __func__);
1073                         return -ENOENT;
1074                 }
1075         }
1076         if (!suffix)
1077                 suffix = "";
1078
1079         snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
1080                  suffix);
1081         mem = fdt_getprop(blob, config_node, prop_name, NULL);
1082         if (!mem) {
1083                 debug("%s: No memory type for '%s', using /memory\n", __func__,
1084                       prop_name);
1085                 mem = "/memory";
1086         }
1087
1088         node = fdt_path_offset(blob, mem);
1089         if (node < 0) {
1090                 debug("%s: Failed to find node '%s': %s\n", __func__, mem,
1091                       fdt_strerror(node));
1092                 return -ENOENT;
1093         }
1094
1095         /*
1096          * Not strictly correct - the memory may have multiple banks. We just
1097          * use the first
1098          */
1099         if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
1100                 debug("%s: Failed to decode memory region %s\n", __func__,
1101                       mem);
1102                 return -EINVAL;
1103         }
1104
1105         snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1106                  suffix);
1107         if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1108                                  &offset_size)) {
1109                 debug("%s: Failed to decode memory region '%s'\n", __func__,
1110                       prop_name);
1111                 return -EINVAL;
1112         }
1113
1114         *basep = base + offset;
1115         *sizep = offset_size;
1116
1117         return 0;
1118 }
1119
1120 static int decode_timing_property(const void *blob, int node, const char *name,
1121                                   struct timing_entry *result)
1122 {
1123         int length, ret = 0;
1124         const u32 *prop;
1125
1126         prop = fdt_getprop(blob, node, name, &length);
1127         if (!prop) {
1128                 debug("%s: could not find property %s\n",
1129                       fdt_get_name(blob, node, NULL), name);
1130                 return length;
1131         }
1132
1133         if (length == sizeof(u32)) {
1134                 result->typ = fdtdec_get_int(blob, node, name, 0);
1135                 result->min = result->typ;
1136                 result->max = result->typ;
1137         } else {
1138                 ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1139         }
1140
1141         return ret;
1142 }
1143
1144 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1145                                  struct display_timing *dt)
1146 {
1147         int i, node, timings_node;
1148         u32 val = 0;
1149         int ret = 0;
1150
1151         timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1152         if (timings_node < 0)
1153                 return timings_node;
1154
1155         for (i = 0, node = fdt_first_subnode(blob, timings_node);
1156              node > 0 && i != index;
1157              node = fdt_next_subnode(blob, node))
1158                 i++;
1159
1160         if (node < 0)
1161                 return node;
1162
1163         memset(dt, 0, sizeof(*dt));
1164
1165         ret |= decode_timing_property(blob, node, "hback-porch",
1166                                       &dt->hback_porch);
1167         ret |= decode_timing_property(blob, node, "hfront-porch",
1168                                       &dt->hfront_porch);
1169         ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1170         ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1171         ret |= decode_timing_property(blob, node, "vback-porch",
1172                                       &dt->vback_porch);
1173         ret |= decode_timing_property(blob, node, "vfront-porch",
1174                                       &dt->vfront_porch);
1175         ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1176         ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1177         ret |= decode_timing_property(blob, node, "clock-frequency",
1178                                       &dt->pixelclock);
1179
1180         dt->flags = 0;
1181         val = fdtdec_get_int(blob, node, "vsync-active", -1);
1182         if (val != -1) {
1183                 dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1184                                 DISPLAY_FLAGS_VSYNC_LOW;
1185         }
1186         val = fdtdec_get_int(blob, node, "hsync-active", -1);
1187         if (val != -1) {
1188                 dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1189                                 DISPLAY_FLAGS_HSYNC_LOW;
1190         }
1191         val = fdtdec_get_int(blob, node, "de-active", -1);
1192         if (val != -1) {
1193                 dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1194                                 DISPLAY_FLAGS_DE_LOW;
1195         }
1196         val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1197         if (val != -1) {
1198                 dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1199                                 DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1200         }
1201
1202         if (fdtdec_get_bool(blob, node, "interlaced"))
1203                 dt->flags |= DISPLAY_FLAGS_INTERLACED;
1204         if (fdtdec_get_bool(blob, node, "doublescan"))
1205                 dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1206         if (fdtdec_get_bool(blob, node, "doubleclk"))
1207                 dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1208
1209         return 0;
1210 }
1211
1212 int fdtdec_setup(void)
1213 {
1214 #if CONFIG_IS_ENABLED(OF_CONTROL)
1215 # ifdef CONFIG_OF_EMBED
1216         /* Get a pointer to the FDT */
1217         gd->fdt_blob = __dtb_dt_begin;
1218 # elif defined CONFIG_OF_SEPARATE
1219 #  ifdef CONFIG_SPL_BUILD
1220         /* FDT is at end of BSS */
1221         gd->fdt_blob = (ulong *)&__bss_end;
1222 #  else
1223         /* FDT is at end of image */
1224         gd->fdt_blob = (ulong *)&_end;
1225 #  endif
1226 # elif defined(CONFIG_OF_HOSTFILE)
1227         if (sandbox_read_fdt_from_file()) {
1228                 puts("Failed to read control FDT\n");
1229                 return -1;
1230         }
1231 # endif
1232 # ifndef CONFIG_SPL_BUILD
1233         /* Allow the early environment to override the fdt address */
1234         gd->fdt_blob = (void *)getenv_ulong("fdtcontroladdr", 16,
1235                                                 (uintptr_t)gd->fdt_blob);
1236 # endif
1237 #endif
1238         return fdtdec_prepare_fdt();
1239 }
1240
1241 #endif /* !USE_HOSTCC */