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