common/fdt_support.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2007
   4  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
   5  *
   6  * Copyright 2010-2011 Freescale Semiconductor, Inc.
   7  */
   8
   9 #include <common.h>
  10 #include <env.h>
  11 #include <log.h>
  12 #include <mapmem.h>
  13 #include <net.h>
  14 #include <stdio_dev.h>
  15 #include <linux/ctype.h>
  16 #include <linux/types.h>
  17 #include <asm/global_data.h>
  18 #include <linux/libfdt.h>
  19 #include <fdt_support.h>
  20 #include <exports.h>
  21 #include <fdtdec.h>
  22
  23 /**
  24  * fdt_getprop_u32_default_node - Return a node's property or a default
  25  *
  26  * @fdt: ptr to device tree
  27  * @off: offset of node
  28  * @cell: cell offset in property
  29  * @prop: property name
  30  * @dflt: default value if the property isn't found
  31  *
  32  * Convenience function to return a node's property or a default value if
  33  * the property doesn't exist.
  34  */
  35 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
  36                                 const char *prop, const u32 dflt)
  37 {
  38         const fdt32_t *val;
  39         int len;
  40
  41         val = fdt_getprop(fdt, off, prop, &len);
  42
  43         /* Check if property exists */
  44         if (!val)
  45                 return dflt;
  46
  47         /* Check if property is long enough */
  48         if (len < ((cell + 1) * sizeof(uint32_t)))
  49                 return dflt;
  50
  51         return fdt32_to_cpu(*val);
  52 }
  53
  54 /**
  55  * fdt_getprop_u32_default - Find a node and return it's property or a default
  56  *
  57  * @fdt: ptr to device tree
  58  * @path: path of node
  59  * @prop: property name
  60  * @dflt: default value if the property isn't found
  61  *
  62  * Convenience function to find a node and return it's property or a
  63  * default value if it doesn't exist.
  64  */
  65 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
  66                                 const char *prop, const u32 dflt)
  67 {
  68         int off;
  69
  70         off = fdt_path_offset(fdt, path);
  71         if (off < 0)
  72                 return dflt;
  73
  74         return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
  75 }
  76
  77 /**
  78  * fdt_find_and_setprop: Find a node and set it's property
  79  *
  80  * @fdt: ptr to device tree
  81  * @node: path of node
  82  * @prop: property name
  83  * @val: ptr to new value
  84  * @len: length of new property value
  85  * @create: flag to create the property if it doesn't exist
  86  *
  87  * Convenience function to directly set a property given the path to the node.
  88  */
  89 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
  90                          const void *val, int len, int create)
  91 {
  92         int nodeoff = fdt_path_offset(fdt, node);
  93
  94         if (nodeoff < 0)
  95                 return nodeoff;
  96
  97         if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
  98                 return 0; /* create flag not set; so exit quietly */
  99
 100         return fdt_setprop(fdt, nodeoff, prop, val, len);
 101 }
 102
 103 /**
 104  * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
 105  *
 106  * @fdt: pointer to the device tree blob
 107  * @parentoffset: structure block offset of a node
 108  * @name: name of the subnode to locate
 109  *
 110  * fdt_subnode_offset() finds a subnode of the node with a given name.
 111  * If the subnode does not exist, it will be created.
 112  */
 113 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
 114 {
 115         int offset;
 116
 117         offset = fdt_subnode_offset(fdt, parentoffset, name);
 118
 119         if (offset == -FDT_ERR_NOTFOUND)
 120                 offset = fdt_add_subnode(fdt, parentoffset, name);
 121
 122         if (offset < 0)
 123                 printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
 124
 125         return offset;
 126 }
 127
 128 /* rename to CONFIG_OF_STDOUT_PATH ? */
 129 #if defined(OF_STDOUT_PATH)
 130 static int fdt_fixup_stdout(void *fdt, int chosenoff)
 131 {
 132         return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
 133                               OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
 134 }
 135 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
 136 static int fdt_fixup_stdout(void *fdt, int chosenoff)
 137 {
 138         int err;
 139         int aliasoff;
 140         char sername[9] = { 0 };
 141         const void *path;
 142         int len;
 143         char tmp[256]; /* long enough */
 144
 145         sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
 146
 147         aliasoff = fdt_path_offset(fdt, "/aliases");
 148         if (aliasoff < 0) {
 149                 err = aliasoff;
 150                 goto noalias;
 151         }
 152
 153         path = fdt_getprop(fdt, aliasoff, sername, &len);
 154         if (!path) {
 155                 err = len;
 156                 goto noalias;
 157         }
 158
 159         /* fdt_setprop may break "path" so we copy it to tmp buffer */
 160         memcpy(tmp, path, len);
 161
 162         err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
 163         if (err < 0)
 164                 printf("WARNING: could not set linux,stdout-path %s.\n",
 165                        fdt_strerror(err));
 166
 167         return err;
 168
 169 noalias:
 170         printf("WARNING: %s: could not read %s alias: %s\n",
 171                __func__, sername, fdt_strerror(err));
 172
 173         return 0;
 174 }
 175 #else
 176 static int fdt_fixup_stdout(void *fdt, int chosenoff)
 177 {
 178         return 0;
 179 }
 180 #endif
 181
 182 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
 183                                   uint64_t val, int is_u64)
 184 {
 185         if (is_u64)
 186                 return fdt_setprop_u64(fdt, nodeoffset, name, val);
 187         else
 188                 return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
 189 }
 190
 191 int fdt_root(void *fdt)
 192 {
 193         char *serial;
 194         int err;
 195
 196         err = fdt_check_header(fdt);
 197         if (err < 0) {
 198                 printf("fdt_root: %s\n", fdt_strerror(err));
 199                 return err;
 200         }
 201
 202         serial = env_get("serial#");
 203         if (serial) {
 204                 err = fdt_setprop(fdt, 0, "serial-number", serial,
 205                                   strlen(serial) + 1);
 206
 207                 if (err < 0) {
 208                         printf("WARNING: could not set serial-number %s.\n",
 209                                fdt_strerror(err));
 210                         return err;
 211                 }
 212         }
 213
 214         return 0;
 215 }
 216
 217 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
 218 {
 219         int   nodeoffset;
 220         int   err, j, total;
 221         int is_u64;
 222         uint64_t addr, size;
 223
 224         /* just return if the size of initrd is zero */
 225         if (initrd_start == initrd_end)
 226                 return 0;
 227
 228         /* find or create "/chosen" node. */
 229         nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
 230         if (nodeoffset < 0)
 231                 return nodeoffset;
 232
 233         total = fdt_num_mem_rsv(fdt);
 234
 235         /*
 236          * Look for an existing entry and update it.  If we don't find
 237          * the entry, we will j be the next available slot.
 238          */
 239         for (j = 0; j < total; j++) {
 240                 err = fdt_get_mem_rsv(fdt, j, &addr, &size);
 241                 if (addr == initrd_start) {
 242                         fdt_del_mem_rsv(fdt, j);
 243                         break;
 244                 }
 245         }
 246
 247         err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
 248         if (err < 0) {
 249                 printf("fdt_initrd: %s\n", fdt_strerror(err));
 250                 return err;
 251         }
 252
 253         is_u64 = (fdt_address_cells(fdt, 0) == 2);
 254
 255         err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
 256                               (uint64_t)initrd_start, is_u64);
 257
 258         if (err < 0) {
 259                 printf("WARNING: could not set linux,initrd-start %s.\n",
 260                        fdt_strerror(err));
 261                 return err;
 262         }
 263
 264         err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
 265                               (uint64_t)initrd_end, is_u64);
 266
 267         if (err < 0) {
 268                 printf("WARNING: could not set linux,initrd-end %s.\n",
 269                        fdt_strerror(err));
 270
 271                 return err;
 272         }
 273
 274         return 0;
 275 }
 276
 277 int fdt_chosen(void *fdt)
 278 {
 279         int   nodeoffset;
 280         int   err;
 281         char  *str;             /* used to set string properties */
 282
 283         err = fdt_check_header(fdt);
 284         if (err < 0) {
 285                 printf("fdt_chosen: %s\n", fdt_strerror(err));
 286                 return err;
 287         }
 288
 289         /* find or create "/chosen" node. */
 290         nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
 291         if (nodeoffset < 0)
 292                 return nodeoffset;
 293
 294         str = env_get("bootargs");
 295         if (str) {
 296                 err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
 297                                   strlen(str) + 1);
 298                 if (err < 0) {
 299                         printf("WARNING: could not set bootargs %s.\n",
 300                                fdt_strerror(err));
 301                         return err;
 302                 }
 303         }
 304
 305         return fdt_fixup_stdout(fdt, nodeoffset);
 306 }
 307
 308 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
 309                       const void *val, int len, int create)
 310 {
 311 #if defined(DEBUG)
 312         int i;
 313         debug("Updating property '%s/%s' = ", path, prop);
 314         for (i = 0; i < len; i++)
 315                 debug(" %.2x", *(u8*)(val+i));
 316         debug("\n");
 317 #endif
 318         int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
 319         if (rc)
 320                 printf("Unable to update property %s:%s, err=%s\n",
 321                         path, prop, fdt_strerror(rc));
 322 }
 323
 324 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
 325                           u32 val, int create)
 326 {
 327         fdt32_t tmp = cpu_to_fdt32(val);
 328         do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
 329 }
 330
 331 void do_fixup_by_prop(void *fdt,
 332                       const char *pname, const void *pval, int plen,
 333                       const char *prop, const void *val, int len,
 334                       int create)
 335 {
 336         int off;
 337 #if defined(DEBUG)
 338         int i;
 339         debug("Updating property '%s' = ", prop);
 340         for (i = 0; i < len; i++)
 341                 debug(" %.2x", *(u8*)(val+i));
 342         debug("\n");
 343 #endif
 344         off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
 345         while (off != -FDT_ERR_NOTFOUND) {
 346                 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
 347                         fdt_setprop(fdt, off, prop, val, len);
 348                 off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
 349         }
 350 }
 351
 352 void do_fixup_by_prop_u32(void *fdt,
 353                           const char *pname, const void *pval, int plen,
 354                           const char *prop, u32 val, int create)
 355 {
 356         fdt32_t tmp = cpu_to_fdt32(val);
 357         do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
 358 }
 359
 360 void do_fixup_by_compat(void *fdt, const char *compat,
 361                         const char *prop, const void *val, int len, int create)
 362 {
 363         int off = -1;
 364 #if defined(DEBUG)
 365         int i;
 366         debug("Updating property '%s' = ", prop);
 367         for (i = 0; i < len; i++)
 368                 debug(" %.2x", *(u8*)(val+i));
 369         debug("\n");
 370 #endif
 371         off = fdt_node_offset_by_compatible(fdt, -1, compat);
 372         while (off != -FDT_ERR_NOTFOUND) {
 373                 if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
 374                         fdt_setprop(fdt, off, prop, val, len);
 375                 off = fdt_node_offset_by_compatible(fdt, off, compat);
 376         }
 377 }
 378
 379 void do_fixup_by_compat_u32(void *fdt, const char *compat,
 380                             const char *prop, u32 val, int create)
 381 {
 382         fdt32_t tmp = cpu_to_fdt32(val);
 383         do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
 384 }
 385
 386 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
 387 /*
 388  * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
 389  */
 390 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
 391                         int n)
 392 {
 393         int i;
 394         int address_cells = fdt_address_cells(fdt, 0);
 395         int size_cells = fdt_size_cells(fdt, 0);
 396         char *p = buf;
 397
 398         for (i = 0; i < n; i++) {
 399                 if (address_cells == 2)
 400                         *(fdt64_t *)p = cpu_to_fdt64(address[i]);
 401                 else
 402                         *(fdt32_t *)p = cpu_to_fdt32(address[i]);
 403                 p += 4 * address_cells;
 404
 405                 if (size_cells == 2)
 406                         *(fdt64_t *)p = cpu_to_fdt64(size[i]);
 407                 else
 408                         *(fdt32_t *)p = cpu_to_fdt32(size[i]);
 409                 p += 4 * size_cells;
 410         }
 411
 412         return p - (char *)buf;
 413 }
 414
 415 #if CONFIG_NR_DRAM_BANKS > 4
 416 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
 417 #else
 418 #define MEMORY_BANKS_MAX 4
 419 #endif
 420 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
 421 {
 422         int err, nodeoffset;
 423         int len, i;
 424         u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
 425
 426         if (banks > MEMORY_BANKS_MAX) {
 427                 printf("%s: num banks %d exceeds hardcoded limit %d."
 428                        " Recompile with higher MEMORY_BANKS_MAX?\n",
 429                        __FUNCTION__, banks, MEMORY_BANKS_MAX);
 430                 return -1;
 431         }
 432
 433         err = fdt_check_header(blob);
 434         if (err < 0) {
 435                 printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
 436                 return err;
 437         }
 438
 439         /* find or create "/memory" node. */
 440         nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
 441         if (nodeoffset < 0)
 442                         return nodeoffset;
 443
 444         err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
 445                         sizeof("memory"));
 446         if (err < 0) {
 447                 printf("WARNING: could not set %s %s.\n", "device_type",
 448                                 fdt_strerror(err));
 449                 return err;
 450         }
 451
 452         for (i = 0; i < banks; i++) {
 453                 if (start[i] == 0 && size[i] == 0)
 454                         break;
 455         }
 456
 457         banks = i;
 458
 459         if (!banks)
 460                 return 0;
 461
 462         len = fdt_pack_reg(blob, tmp, start, size, banks);
 463
 464         err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
 465         if (err < 0) {
 466                 printf("WARNING: could not set %s %s.\n",
 467                                 "reg", fdt_strerror(err));
 468                 return err;
 469         }
 470         return 0;
 471 }
 472
 473 int fdt_set_usable_memory(void *blob, u64 start[], u64 size[], int areas)
 474 {
 475         int err, nodeoffset;
 476         int len;
 477         u8 tmp[8 * 16]; /* Up to 64-bit address + 64-bit size */
 478
 479         if (areas > 8) {
 480                 printf("%s: num areas %d exceeds hardcoded limit %d\n",
 481                        __func__, areas, 8);
 482                 return -1;
 483         }
 484
 485         err = fdt_check_header(blob);
 486         if (err < 0) {
 487                 printf("%s: %s\n", __func__, fdt_strerror(err));
 488                 return err;
 489         }
 490
 491         /* find or create "/memory" node. */
 492         nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
 493         if (nodeoffset < 0)
 494                 return nodeoffset;
 495
 496         len = fdt_pack_reg(blob, tmp, start, size, areas);
 497
 498         err = fdt_setprop(blob, nodeoffset, "linux,usable-memory", tmp, len);
 499         if (err < 0) {
 500                 printf("WARNING: could not set %s %s.\n",
 501                        "reg", fdt_strerror(err));
 502                 return err;
 503         }
 504
 505         return 0;
 506 }
 507 #endif
 508
 509 int fdt_fixup_memory(void *blob, u64 start, u64 size)
 510 {
 511         return fdt_fixup_memory_banks(blob, &start, &size, 1);
 512 }
 513
 514 void fdt_fixup_ethernet(void *fdt)
 515 {
 516         int i = 0, j, prop;
 517         char *tmp, *end;
 518         char mac[16];
 519         const char *path;
 520         unsigned char mac_addr[ARP_HLEN];
 521         int offset;
 522 #ifdef FDT_SEQ_MACADDR_FROM_ENV
 523         int nodeoff;
 524         const struct fdt_property *fdt_prop;
 525 #endif
 526
 527         if (fdt_path_offset(fdt, "/aliases") < 0)
 528                 return;
 529
 530         /* Cycle through all aliases */
 531         for (prop = 0; ; prop++) {
 532                 const char *name;
 533
 534                 /* FDT might have been edited, recompute the offset */
 535                 offset = fdt_first_property_offset(fdt,
 536                         fdt_path_offset(fdt, "/aliases"));
 537                 /* Select property number 'prop' */
 538                 for (j = 0; j < prop; j++)
 539                         offset = fdt_next_property_offset(fdt, offset);
 540
 541                 if (offset < 0)
 542                         break;
 543
 544                 path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
 545                 if (!strncmp(name, "ethernet", 8)) {
 546                         /* Treat plain "ethernet" same as "ethernet0". */
 547                         if (!strcmp(name, "ethernet")
 548 #ifdef FDT_SEQ_MACADDR_FROM_ENV
 549                          || !strcmp(name, "ethernet0")
 550 #endif
 551                         )
 552                                 i = 0;
 553 #ifndef FDT_SEQ_MACADDR_FROM_ENV
 554                         else
 555                                 i = trailing_strtol(name);
 556 #endif
 557                         if (i != -1) {
 558                                 if (i == 0)
 559                                         strcpy(mac, "ethaddr");
 560                                 else
 561                                         sprintf(mac, "eth%daddr", i);
 562                         } else {
 563                                 continue;
 564                         }
 565 #ifdef FDT_SEQ_MACADDR_FROM_ENV
 566                         nodeoff = fdt_path_offset(fdt, path);
 567                         fdt_prop = fdt_get_property(fdt, nodeoff, "status",
 568                                                     NULL);
 569                         if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
 570                                 continue;
 571                         i++;
 572 #endif
 573                         tmp = env_get(mac);
 574                         if (!tmp)
 575                                 continue;
 576
 577                         for (j = 0; j < 6; j++) {
 578                                 mac_addr[j] = tmp ?
 579                                               simple_strtoul(tmp, &end, 16) : 0;
 580                                 if (tmp)
 581                                         tmp = (*end) ? end + 1 : end;
 582                         }
 583
 584                         do_fixup_by_path(fdt, path, "mac-address",
 585                                          &mac_addr, 6, 0);
 586                         do_fixup_by_path(fdt, path, "local-mac-address",
 587                                          &mac_addr, 6, 1);
 588                 }
 589         }
 590 }
 591
 592 int fdt_record_loadable(void *blob, u32 index, const char *name,
 593                         uintptr_t load_addr, u32 size, uintptr_t entry_point,
 594                         const char *type, const char *os)
 595 {
 596         int err, node;
 597
 598         err = fdt_check_header(blob);
 599         if (err < 0) {
 600                 printf("%s: %s\n", __func__, fdt_strerror(err));
 601                 return err;
 602         }
 603
 604         /* find or create "/fit-images" node */
 605         node = fdt_find_or_add_subnode(blob, 0, "fit-images");
 606         if (node < 0)
 607                 return node;
 608
 609         /* find or create "/fit-images/<name>" node */
 610         node = fdt_find_or_add_subnode(blob, node, name);
 611         if (node < 0)
 612                 return node;
 613
 614         /*
 615          * We record these as 32bit entities, possibly truncating addresses.
 616          * However, spl_fit.c is not 64bit safe either: i.e. we should not
 617          * have an issue here.
 618          */
 619         fdt_setprop_u32(blob, node, "load-addr", load_addr);
 620         if (entry_point != -1)
 621                 fdt_setprop_u32(blob, node, "entry-point", entry_point);
 622         fdt_setprop_u32(blob, node, "size", size);
 623         if (type)
 624                 fdt_setprop_string(blob, node, "type", type);
 625         if (os)
 626                 fdt_setprop_string(blob, node, "os", os);
 627
 628         return node;
 629 }
 630
 631 /* Resize the fdt to its actual size + a bit of padding */
 632 int fdt_shrink_to_minimum(void *blob, uint extrasize)
 633 {
 634         int i;
 635         uint64_t addr, size;
 636         int total, ret;
 637         uint actualsize;
 638         int fdt_memrsv = 0;
 639
 640         if (!blob)
 641                 return 0;
 642
 643         total = fdt_num_mem_rsv(blob);
 644         for (i = 0; i < total; i++) {
 645                 fdt_get_mem_rsv(blob, i, &addr, &size);
 646                 if (addr == (uintptr_t)blob) {
 647                         fdt_del_mem_rsv(blob, i);
 648                         fdt_memrsv = 1;
 649                         break;
 650                 }
 651         }
 652
 653         /*
 654          * Calculate the actual size of the fdt
 655          * plus the size needed for 5 fdt_add_mem_rsv, one
 656          * for the fdt itself and 4 for a possible initrd
 657          * ((initrd-start + initrd-end) * 2 (name & value))
 658          */
 659         actualsize = fdt_off_dt_strings(blob) +
 660                 fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
 661
 662         actualsize += extrasize;
 663         /* Make it so the fdt ends on a page boundary */
 664         actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
 665         actualsize = actualsize - ((uintptr_t)blob & 0xfff);
 666
 667         /* Change the fdt header to reflect the correct size */
 668         fdt_set_totalsize(blob, actualsize);
 669
 670         if (fdt_memrsv) {
 671                 /* Add the new reservation */
 672                 ret = fdt_add_mem_rsv(blob, map_to_sysmem(blob), actualsize);
 673                 if (ret < 0)
 674                         return ret;
 675         }
 676
 677         return actualsize;
 678 }
 679
 680 #ifdef CONFIG_PCI
 681 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
 682
 683 #define FDT_PCI_PREFETCH        (0x40000000)
 684 #define FDT_PCI_MEM32           (0x02000000)
 685 #define FDT_PCI_IO              (0x01000000)
 686 #define FDT_PCI_MEM64           (0x03000000)
 687
 688 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
 689
 690         int addrcell, sizecell, len, r;
 691         u32 *dma_range;
 692         /* sized based on pci addr cells, size-cells, & address-cells */
 693         u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
 694
 695         addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
 696         sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
 697
 698         dma_range = &dma_ranges[0];
 699         for (r = 0; r < hose->region_count; r++) {
 700                 u64 bus_start, phys_start, size;
 701
 702                 /* skip if !PCI_REGION_SYS_MEMORY */
 703                 if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
 704                         continue;
 705
 706                 bus_start = (u64)hose->regions[r].bus_start;
 707                 phys_start = (u64)hose->regions[r].phys_start;
 708                 size = (u64)hose->regions[r].size;
 709
 710                 dma_range[0] = 0;
 711                 if (size >= 0x100000000ull)
 712                         dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM64);
 713                 else
 714                         dma_range[0] |= cpu_to_fdt32(FDT_PCI_MEM32);
 715                 if (hose->regions[r].flags & PCI_REGION_PREFETCH)
 716                         dma_range[0] |= cpu_to_fdt32(FDT_PCI_PREFETCH);
 717 #ifdef CONFIG_SYS_PCI_64BIT
 718                 dma_range[1] = cpu_to_fdt32(bus_start >> 32);
 719 #else
 720                 dma_range[1] = 0;
 721 #endif
 722                 dma_range[2] = cpu_to_fdt32(bus_start & 0xffffffff);
 723
 724                 if (addrcell == 2) {
 725                         dma_range[3] = cpu_to_fdt32(phys_start >> 32);
 726                         dma_range[4] = cpu_to_fdt32(phys_start & 0xffffffff);
 727                 } else {
 728                         dma_range[3] = cpu_to_fdt32(phys_start & 0xffffffff);
 729                 }
 730
 731                 if (sizecell == 2) {
 732                         dma_range[3 + addrcell + 0] =
 733                                 cpu_to_fdt32(size >> 32);
 734                         dma_range[3 + addrcell + 1] =
 735                                 cpu_to_fdt32(size & 0xffffffff);
 736                 } else {
 737                         dma_range[3 + addrcell + 0] =
 738                                 cpu_to_fdt32(size & 0xffffffff);
 739                 }
 740
 741                 dma_range += (3 + addrcell + sizecell);
 742         }
 743
 744         len = dma_range - &dma_ranges[0];
 745         if (len)
 746                 fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
 747
 748         return 0;
 749 }
 750 #endif
 751
 752 int fdt_increase_size(void *fdt, int add_len)
 753 {
 754         int newlen;
 755
 756         newlen = fdt_totalsize(fdt) + add_len;
 757
 758         /* Open in place with a new len */
 759         return fdt_open_into(fdt, fdt, newlen);
 760 }
 761
 762 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
 763 #include <jffs2/load_kernel.h>
 764 #include <mtd_node.h>
 765
 766 static int fdt_del_subnodes(const void *blob, int parent_offset)
 767 {
 768         int off, ndepth;
 769         int ret;
 770
 771         for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
 772              (off >= 0) && (ndepth > 0);
 773              off = fdt_next_node(blob, off, &ndepth)) {
 774                 if (ndepth == 1) {
 775                         debug("delete %s: offset: %x\n",
 776                                 fdt_get_name(blob, off, 0), off);
 777                         ret = fdt_del_node((void *)blob, off);
 778                         if (ret < 0) {
 779                                 printf("Can't delete node: %s\n",
 780                                         fdt_strerror(ret));
 781                                 return ret;
 782                         } else {
 783                                 ndepth = 0;
 784                                 off = parent_offset;
 785                         }
 786                 }
 787         }
 788         return 0;
 789 }
 790
 791 static int fdt_del_partitions(void *blob, int parent_offset)
 792 {
 793         const void *prop;
 794         int ndepth = 0;
 795         int off;
 796         int ret;
 797
 798         off = fdt_next_node(blob, parent_offset, &ndepth);
 799         if (off > 0 && ndepth == 1) {
 800                 prop = fdt_getprop(blob, off, "label", NULL);
 801                 if (prop == NULL) {
 802                         /*
 803                          * Could not find label property, nand {}; node?
 804                          * Check subnode, delete partitions there if any.
 805                          */
 806                         return fdt_del_partitions(blob, off);
 807                 } else {
 808                         ret = fdt_del_subnodes(blob, parent_offset);
 809                         if (ret < 0) {
 810                                 printf("Can't remove subnodes: %s\n",
 811                                         fdt_strerror(ret));
 812                                 return ret;
 813                         }
 814                 }
 815         }
 816         return 0;
 817 }
 818
 819 static int fdt_node_set_part_info(void *blob, int parent_offset,
 820                                   struct mtd_device *dev)
 821 {
 822         struct list_head *pentry;
 823         struct part_info *part;
 824         int off, ndepth = 0;
 825         int part_num, ret;
 826         int sizecell;
 827         char buf[64];
 828
 829         ret = fdt_del_partitions(blob, parent_offset);
 830         if (ret < 0)
 831                 return ret;
 832
 833         /*
 834          * Check if size/address is 1 or 2 cells.
 835          * We assume #address-cells and #size-cells have same value.
 836          */
 837         sizecell = fdt_getprop_u32_default_node(blob, parent_offset,
 838                                                 0, "#size-cells", 1);
 839
 840         /*
 841          * Check if it is nand {}; subnode, adjust
 842          * the offset in this case
 843          */
 844         off = fdt_next_node(blob, parent_offset, &ndepth);
 845         if (off > 0 && ndepth == 1)
 846                 parent_offset = off;
 847
 848         part_num = 0;
 849         list_for_each_prev(pentry, &dev->parts) {
 850                 int newoff;
 851
 852                 part = list_entry(pentry, struct part_info, link);
 853
 854                 debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
 855                         part_num, part->name, part->size,
 856                         part->offset, part->mask_flags);
 857
 858                 sprintf(buf, "partition@%llx", part->offset);
 859 add_sub:
 860                 ret = fdt_add_subnode(blob, parent_offset, buf);
 861                 if (ret == -FDT_ERR_NOSPACE) {
 862                         ret = fdt_increase_size(blob, 512);
 863                         if (!ret)
 864                                 goto add_sub;
 865                         else
 866                                 goto err_size;
 867                 } else if (ret < 0) {
 868                         printf("Can't add partition node: %s\n",
 869                                 fdt_strerror(ret));
 870                         return ret;
 871                 }
 872                 newoff = ret;
 873
 874                 /* Check MTD_WRITEABLE_CMD flag */
 875                 if (part->mask_flags & 1) {
 876 add_ro:
 877                         ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
 878                         if (ret == -FDT_ERR_NOSPACE) {
 879                                 ret = fdt_increase_size(blob, 512);
 880                                 if (!ret)
 881                                         goto add_ro;
 882                                 else
 883                                         goto err_size;
 884                         } else if (ret < 0)
 885                                 goto err_prop;
 886                 }
 887
 888 add_reg:
 889                 if (sizecell == 2) {
 890                         ret = fdt_setprop_u64(blob, newoff,
 891                                               "reg", part->offset);
 892                         if (!ret)
 893                                 ret = fdt_appendprop_u64(blob, newoff,
 894                                                          "reg", part->size);
 895                 } else {
 896                         ret = fdt_setprop_u32(blob, newoff,
 897                                               "reg", part->offset);
 898                         if (!ret)
 899                                 ret = fdt_appendprop_u32(blob, newoff,
 900                                                          "reg", part->size);
 901                 }
 902
 903                 if (ret == -FDT_ERR_NOSPACE) {
 904                         ret = fdt_increase_size(blob, 512);
 905                         if (!ret)
 906                                 goto add_reg;
 907                         else
 908                                 goto err_size;
 909                 } else if (ret < 0)
 910                         goto err_prop;
 911
 912 add_label:
 913                 ret = fdt_setprop_string(blob, newoff, "label", part->name);
 914                 if (ret == -FDT_ERR_NOSPACE) {
 915                         ret = fdt_increase_size(blob, 512);
 916                         if (!ret)
 917                                 goto add_label;
 918                         else
 919                                 goto err_size;
 920                 } else if (ret < 0)
 921                         goto err_prop;
 922
 923                 part_num++;
 924         }
 925         return 0;
 926 err_size:
 927         printf("Can't increase blob size: %s\n", fdt_strerror(ret));
 928         return ret;
 929 err_prop:
 930         printf("Can't add property: %s\n", fdt_strerror(ret));
 931         return ret;
 932 }
 933
 934 /*
 935  * Update partitions in nor/nand nodes using info from
 936  * mtdparts environment variable. The nodes to update are
 937  * specified by node_info structure which contains mtd device
 938  * type and compatible string: E. g. the board code in
 939  * ft_board_setup() could use:
 940  *
 941  *      struct node_info nodes[] = {
 942  *              { "fsl,mpc5121-nfc",    MTD_DEV_TYPE_NAND, },
 943  *              { "cfi-flash",          MTD_DEV_TYPE_NOR,  },
 944  *      };
 945  *
 946  *      fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
 947  */
 948 void fdt_fixup_mtdparts(void *blob, const struct node_info *node_info,
 949                         int node_info_size)
 950 {
 951         struct mtd_device *dev;
 952         int i, idx;
 953         int noff;
 954         bool inited = false;
 955
 956         for (i = 0; i < node_info_size; i++) {
 957                 idx = 0;
 958                 noff = fdt_node_offset_by_compatible(blob, -1,
 959                                                      node_info[i].compat);
 960                 while (noff != -FDT_ERR_NOTFOUND) {
 961                         debug("%s: %s, mtd dev type %d\n",
 962                                 fdt_get_name(blob, noff, 0),
 963                                 node_info[i].compat, node_info[i].type);
 964
 965                         if (!inited) {
 966                                 if (mtdparts_init() != 0)
 967                                         return;
 968                                 inited = true;
 969                         }
 970
 971                         dev = device_find(node_info[i].type, idx++);
 972                         if (dev) {
 973                                 if (fdt_node_set_part_info(blob, noff, dev))
 974                                         return; /* return on error */
 975                         }
 976
 977                         /* Jump to next flash node */
 978                         noff = fdt_node_offset_by_compatible(blob, noff,
 979                                                              node_info[i].compat);
 980                 }
 981         }
 982 }
 983 #endif
 984
 985 void fdt_del_node_and_alias(void *blob, const char *alias)
 986 {
 987         int off = fdt_path_offset(blob, alias);
 988
 989         if (off < 0)
 990                 return;
 991
 992         fdt_del_node(blob, off);
 993
 994         off = fdt_path_offset(blob, "/aliases");
 995         fdt_delprop(blob, off, alias);
 996 }
 997
 998 /* Max address size we deal with */
 999 #define OF_MAX_ADDR_CELLS       4
1000 #define OF_BAD_ADDR     FDT_ADDR_T_NONE
1001 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
1002                         (ns) > 0)
1003
1004 /* Debug utility */
1005 #ifdef DEBUG
1006 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1007 {
1008         printf("%s", s);
1009         while(na--)
1010                 printf(" %08x", *(addr++));
1011         printf("\n");
1012 }
1013 #else
1014 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1015 #endif
1016
1017 /**
1018  * struct of_bus - Callbacks for bus specific translators
1019  * @name:       A string used to identify this bus in debug output.
1020  * @addresses:  The name of the DT property from which addresses are
1021  *              to be read, typically "reg".
1022  * @match:      Return non-zero if the node whose parent is at
1023  *              parentoffset in the FDT blob corresponds to a bus
1024  *              of this type, otherwise return zero. If NULL a match
1025  *              is assumed.
1026  * @count_cells:Count how many cells (be32 values) a node whose parent
1027  *              is at parentoffset in the FDT blob will require to
1028  *              represent its address (written to *addrc) & size
1029  *              (written to *sizec).
1030  * @map:        Map the address addr from the address space of this
1031  *              bus to that of its parent, making use of the ranges
1032  *              read from DT to an array at range. na and ns are the
1033  *              number of cells (be32 values) used to hold and address
1034  *              or size, respectively, for this bus. pna is the number
1035  *              of cells used to hold an address for the parent bus.
1036  *              Returns the address in the address space of the parent
1037  *              bus.
1038  * @translate:  Update the value of the address cells at addr within an
1039  *              FDT by adding offset to it. na specifies the number of
1040  *              cells used to hold the address being translated. Returns
1041  *              zero on success, non-zero on error.
1042  *
1043  * Each bus type will include a struct of_bus in the of_busses array,
1044  * providing implementations of some or all of the functions used to
1045  * match the bus & handle address translation for its children.
1046  */
1047 struct of_bus {
1048         const char      *name;
1049         const char      *addresses;
1050         int             (*match)(const void *blob, int parentoffset);
1051         void            (*count_cells)(const void *blob, int parentoffset,
1052                                 int *addrc, int *sizec);
1053         u64             (*map)(fdt32_t *addr, const fdt32_t *range,
1054                                 int na, int ns, int pna);
1055         int             (*translate)(fdt32_t *addr, u64 offset, int na);
1056 };
1057
1058 /* Default translator (generic bus) */
1059 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1060                                         int *addrc, int *sizec)
1061 {
1062         const fdt32_t *prop;
1063
1064         if (addrc)
1065                 *addrc = fdt_address_cells(blob, parentoffset);
1066
1067         if (sizec) {
1068                 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1069                 if (prop)
1070                         *sizec = be32_to_cpup(prop);
1071                 else
1072                         *sizec = 1;
1073         }
1074 }
1075
1076 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1077                 int na, int ns, int pna)
1078 {
1079         u64 cp, s, da;
1080
1081         cp = fdt_read_number(range, na);
1082         s  = fdt_read_number(range + na + pna, ns);
1083         da = fdt_read_number(addr, na);
1084
1085         debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1086
1087         if (da < cp || da >= (cp + s))
1088                 return OF_BAD_ADDR;
1089         return da - cp;
1090 }
1091
1092 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1093 {
1094         u64 a = fdt_read_number(addr, na);
1095         memset(addr, 0, na * 4);
1096         a += offset;
1097         if (na > 1)
1098                 addr[na - 2] = cpu_to_fdt32(a >> 32);
1099         addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1100
1101         return 0;
1102 }
1103
1104 #ifdef CONFIG_OF_ISA_BUS
1105
1106 /* ISA bus translator */
1107 static int of_bus_isa_match(const void *blob, int parentoffset)
1108 {
1109         const char *name;
1110
1111         name = fdt_get_name(blob, parentoffset, NULL);
1112         if (!name)
1113                 return 0;
1114
1115         return !strcmp(name, "isa");
1116 }
1117
1118 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1119                                    int *addrc, int *sizec)
1120 {
1121         if (addrc)
1122                 *addrc = 2;
1123         if (sizec)
1124                 *sizec = 1;
1125 }
1126
1127 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1128                           int na, int ns, int pna)
1129 {
1130         u64 cp, s, da;
1131
1132         /* Check address type match */
1133         if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1134                 return OF_BAD_ADDR;
1135
1136         cp = fdt_read_number(range + 1, na - 1);
1137         s  = fdt_read_number(range + na + pna, ns);
1138         da = fdt_read_number(addr + 1, na - 1);
1139
1140         debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1141
1142         if (da < cp || da >= (cp + s))
1143                 return OF_BAD_ADDR;
1144         return da - cp;
1145 }
1146
1147 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1148 {
1149         return of_bus_default_translate(addr + 1, offset, na - 1);
1150 }
1151
1152 #endif /* CONFIG_OF_ISA_BUS */
1153
1154 /* Array of bus specific translators */
1155 static struct of_bus of_busses[] = {
1156 #ifdef CONFIG_OF_ISA_BUS
1157         /* ISA */
1158         {
1159                 .name = "isa",
1160                 .addresses = "reg",
1161                 .match = of_bus_isa_match,
1162                 .count_cells = of_bus_isa_count_cells,
1163                 .map = of_bus_isa_map,
1164                 .translate = of_bus_isa_translate,
1165         },
1166 #endif /* CONFIG_OF_ISA_BUS */
1167         /* Default */
1168         {
1169                 .name = "default",
1170                 .addresses = "reg",
1171                 .count_cells = fdt_support_default_count_cells,
1172                 .map = of_bus_default_map,
1173                 .translate = of_bus_default_translate,
1174         },
1175 };
1176
1177 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1178 {
1179         struct of_bus *bus;
1180
1181         if (ARRAY_SIZE(of_busses) == 1)
1182                 return of_busses;
1183
1184         for (bus = of_busses; bus; bus++) {
1185                 if (!bus->match || bus->match(blob, parentoffset))
1186                         return bus;
1187         }
1188
1189         /*
1190          * We should always have matched the default bus at least, since
1191          * it has a NULL match field. If we didn't then it somehow isn't
1192          * in the of_busses array or something equally catastrophic has
1193          * gone wrong.
1194          */
1195         assert(0);
1196         return NULL;
1197 }
1198
1199 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1200                             struct of_bus *pbus, fdt32_t *addr,
1201                             int na, int ns, int pna, const char *rprop)
1202 {
1203         const fdt32_t *ranges;
1204         int rlen;
1205         int rone;
1206         u64 offset = OF_BAD_ADDR;
1207
1208         /* Normally, an absence of a "ranges" property means we are
1209          * crossing a non-translatable boundary, and thus the addresses
1210          * below the current not cannot be converted to CPU physical ones.
1211          * Unfortunately, while this is very clear in the spec, it's not
1212          * what Apple understood, and they do have things like /uni-n or
1213          * /ht nodes with no "ranges" property and a lot of perfectly
1214          * useable mapped devices below them. Thus we treat the absence of
1215          * "ranges" as equivalent to an empty "ranges" property which means
1216          * a 1:1 translation at that level. It's up to the caller not to try
1217          * to translate addresses that aren't supposed to be translated in
1218          * the first place. --BenH.
1219          */
1220         ranges = fdt_getprop(blob, parent, rprop, &rlen);
1221         if (ranges == NULL || rlen == 0) {
1222                 offset = fdt_read_number(addr, na);
1223                 memset(addr, 0, pna * 4);
1224                 debug("OF: no ranges, 1:1 translation\n");
1225                 goto finish;
1226         }
1227
1228         debug("OF: walking ranges...\n");
1229
1230         /* Now walk through the ranges */
1231         rlen /= 4;
1232         rone = na + pna + ns;
1233         for (; rlen >= rone; rlen -= rone, ranges += rone) {
1234                 offset = bus->map(addr, ranges, na, ns, pna);
1235                 if (offset != OF_BAD_ADDR)
1236                         break;
1237         }
1238         if (offset == OF_BAD_ADDR) {
1239                 debug("OF: not found !\n");
1240                 return 1;
1241         }
1242         memcpy(addr, ranges + na, 4 * pna);
1243
1244  finish:
1245         of_dump_addr("OF: parent translation for:", addr, pna);
1246         debug("OF: with offset: %llu\n", offset);
1247
1248         /* Translate it into parent bus space */
1249         return pbus->translate(addr, offset, pna);
1250 }
1251
1252 /*
1253  * Translate an address from the device-tree into a CPU physical address,
1254  * this walks up the tree and applies the various bus mappings on the
1255  * way.
1256  *
1257  * Note: We consider that crossing any level with #size-cells == 0 to mean
1258  * that translation is impossible (that is we are not dealing with a value
1259  * that can be mapped to a cpu physical address). This is not really specified
1260  * that way, but this is traditionally the way IBM at least do things
1261  */
1262 static u64 __of_translate_address(const void *blob, int node_offset,
1263                                   const fdt32_t *in_addr, const char *rprop)
1264 {
1265         int parent;
1266         struct of_bus *bus, *pbus;
1267         fdt32_t addr[OF_MAX_ADDR_CELLS];
1268         int na, ns, pna, pns;
1269         u64 result = OF_BAD_ADDR;
1270
1271         debug("OF: ** translation for device %s **\n",
1272                 fdt_get_name(blob, node_offset, NULL));
1273
1274         /* Get parent & match bus type */
1275         parent = fdt_parent_offset(blob, node_offset);
1276         if (parent < 0)
1277                 goto bail;
1278         bus = of_match_bus(blob, parent);
1279
1280         /* Cound address cells & copy address locally */
1281         bus->count_cells(blob, parent, &na, &ns);
1282         if (!OF_CHECK_COUNTS(na, ns)) {
1283                 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1284                        fdt_get_name(blob, node_offset, NULL));
1285                 goto bail;
1286         }
1287         memcpy(addr, in_addr, na * 4);
1288
1289         debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1290             bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1291         of_dump_addr("OF: translating address:", addr, na);
1292
1293         /* Translate */
1294         for (;;) {
1295                 /* Switch to parent bus */
1296                 node_offset = parent;
1297                 parent = fdt_parent_offset(blob, node_offset);
1298
1299                 /* If root, we have finished */
1300                 if (parent < 0) {
1301                         debug("OF: reached root node\n");
1302                         result = fdt_read_number(addr, na);
1303                         break;
1304                 }
1305
1306                 /* Get new parent bus and counts */
1307                 pbus = of_match_bus(blob, parent);
1308                 pbus->count_cells(blob, parent, &pna, &pns);
1309                 if (!OF_CHECK_COUNTS(pna, pns)) {
1310                         printf("%s: Bad cell count for %s\n", __FUNCTION__,
1311                                 fdt_get_name(blob, node_offset, NULL));
1312                         break;
1313                 }
1314
1315                 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1316                     pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1317
1318                 /* Apply bus translation */
1319                 if (of_translate_one(blob, node_offset, bus, pbus,
1320                                         addr, na, ns, pna, rprop))
1321                         break;
1322
1323                 /* Complete the move up one level */
1324                 na = pna;
1325                 ns = pns;
1326                 bus = pbus;
1327
1328                 of_dump_addr("OF: one level translation:", addr, na);
1329         }
1330  bail:
1331
1332         return result;
1333 }
1334
1335 u64 fdt_translate_address(const void *blob, int node_offset,
1336                           const fdt32_t *in_addr)
1337 {
1338         return __of_translate_address(blob, node_offset, in_addr, "ranges");
1339 }
1340
1341 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1342                               const fdt32_t *in_addr)
1343 {
1344         return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1345 }
1346
1347 /**
1348  * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1349  * who's reg property matches a physical cpu address
1350  *
1351  * @blob: ptr to device tree
1352  * @compat: compatiable string to match
1353  * @compat_off: property name
1354  *
1355  */
1356 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1357                                         phys_addr_t compat_off)
1358 {
1359         int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1360         while (off != -FDT_ERR_NOTFOUND) {
1361                 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1362                 if (reg) {
1363                         if (compat_off == fdt_translate_address(blob, off, reg))
1364                                 return off;
1365                 }
1366                 off = fdt_node_offset_by_compatible(blob, off, compat);
1367         }
1368
1369         return -FDT_ERR_NOTFOUND;
1370 }
1371
1372 /**
1373  * fdt_alloc_phandle: Return next free phandle value
1374  *
1375  * @blob: ptr to device tree
1376  */
1377 int fdt_alloc_phandle(void *blob)
1378 {
1379         int offset;
1380         uint32_t phandle = 0;
1381
1382         for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1383              offset = fdt_next_node(blob, offset, NULL)) {
1384                 phandle = max(phandle, fdt_get_phandle(blob, offset));
1385         }
1386
1387         return phandle + 1;
1388 }
1389
1390 /*
1391  * fdt_set_phandle: Create a phandle property for the given node
1392  *
1393  * @fdt: ptr to device tree
1394  * @nodeoffset: node to update
1395  * @phandle: phandle value to set (must be unique)
1396  */
1397 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1398 {
1399         int ret;
1400
1401 #ifdef DEBUG
1402         int off = fdt_node_offset_by_phandle(fdt, phandle);
1403
1404         if ((off >= 0) && (off != nodeoffset)) {
1405                 char buf[64];
1406
1407                 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1408                 printf("Trying to update node %s with phandle %u ",
1409                        buf, phandle);
1410
1411                 fdt_get_path(fdt, off, buf, sizeof(buf));
1412                 printf("that already exists in node %s.\n", buf);
1413                 return -FDT_ERR_BADPHANDLE;
1414         }
1415 #endif
1416
1417         ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1418         if (ret < 0)
1419                 return ret;
1420
1421         /*
1422          * For now, also set the deprecated "linux,phandle" property, so that we
1423          * don't break older kernels.
1424          */
1425         ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1426
1427         return ret;
1428 }
1429
1430 /*
1431  * fdt_create_phandle: Create a phandle property for the given node
1432  *
1433  * @fdt: ptr to device tree
1434  * @nodeoffset: node to update
1435  */
1436 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1437 {
1438         /* see if there is a phandle already */
1439         int phandle = fdt_get_phandle(fdt, nodeoffset);
1440
1441         /* if we got 0, means no phandle so create one */
1442         if (phandle == 0) {
1443                 int ret;
1444
1445                 phandle = fdt_alloc_phandle(fdt);
1446                 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1447                 if (ret < 0) {
1448                         printf("Can't set phandle %u: %s\n", phandle,
1449                                fdt_strerror(ret));
1450                         return 0;
1451                 }
1452         }
1453
1454         return phandle;
1455 }
1456
1457 /*
1458  * fdt_set_node_status: Set status for the given node
1459  *
1460  * @fdt: ptr to device tree
1461  * @nodeoffset: node to update
1462  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1463  *          FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1464  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1465  */
1466 int fdt_set_node_status(void *fdt, int nodeoffset,
1467                         enum fdt_status status, unsigned int error_code)
1468 {
1469         char buf[16];
1470         int ret = 0;
1471
1472         if (nodeoffset < 0)
1473                 return nodeoffset;
1474
1475         switch (status) {
1476         case FDT_STATUS_OKAY:
1477                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1478                 break;
1479         case FDT_STATUS_DISABLED:
1480                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1481                 break;
1482         case FDT_STATUS_FAIL:
1483                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1484                 break;
1485         case FDT_STATUS_FAIL_ERROR_CODE:
1486                 sprintf(buf, "fail-%d", error_code);
1487                 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1488                 break;
1489         default:
1490                 printf("Invalid fdt status: %x\n", status);
1491                 ret = -1;
1492                 break;
1493         }
1494
1495         return ret;
1496 }
1497
1498 /*
1499  * fdt_set_status_by_alias: Set status for the given node given an alias
1500  *
1501  * @fdt: ptr to device tree
1502  * @alias: alias of node to update
1503  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1504  *          FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1505  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1506  */
1507 int fdt_set_status_by_alias(void *fdt, const char* alias,
1508                             enum fdt_status status, unsigned int error_code)
1509 {
1510         int offset = fdt_path_offset(fdt, alias);
1511
1512         return fdt_set_node_status(fdt, offset, status, error_code);
1513 }
1514
1515 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1516 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1517 {
1518         int noff;
1519         int ret;
1520
1521         noff = fdt_node_offset_by_compatible(blob, -1, compat);
1522         if (noff != -FDT_ERR_NOTFOUND) {
1523                 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1524 add_edid:
1525                 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1526                 if (ret == -FDT_ERR_NOSPACE) {
1527                         ret = fdt_increase_size(blob, 512);
1528                         if (!ret)
1529                                 goto add_edid;
1530                         else
1531                                 goto err_size;
1532                 } else if (ret < 0) {
1533                         printf("Can't add property: %s\n", fdt_strerror(ret));
1534                         return ret;
1535                 }
1536         }
1537         return 0;
1538 err_size:
1539         printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1540         return ret;
1541 }
1542 #endif
1543
1544 /*
1545  * Verify the physical address of device tree node for a given alias
1546  *
1547  * This function locates the device tree node of a given alias, and then
1548  * verifies that the physical address of that device matches the given
1549  * parameter.  It displays a message if there is a mismatch.
1550  *
1551  * Returns 1 on success, 0 on failure
1552  */
1553 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1554 {
1555         const char *path;
1556         const fdt32_t *reg;
1557         int node, len;
1558         u64 dt_addr;
1559
1560         path = fdt_getprop(fdt, anode, alias, NULL);
1561         if (!path) {
1562                 /* If there's no such alias, then it's not a failure */
1563                 return 1;
1564         }
1565
1566         node = fdt_path_offset(fdt, path);
1567         if (node < 0) {
1568                 printf("Warning: device tree alias '%s' points to invalid "
1569                        "node %s.\n", alias, path);
1570                 return 0;
1571         }
1572
1573         reg = fdt_getprop(fdt, node, "reg", &len);
1574         if (!reg) {
1575                 printf("Warning: device tree node '%s' has no address.\n",
1576                        path);
1577                 return 0;
1578         }
1579
1580         dt_addr = fdt_translate_address(fdt, node, reg);
1581         if (addr != dt_addr) {
1582                 printf("Warning: U-Boot configured device %s at address %llu,\n"
1583                        "but the device tree has it address %llx.\n",
1584                        alias, addr, dt_addr);
1585                 return 0;
1586         }
1587
1588         return 1;
1589 }
1590
1591 /*
1592  * Returns the base address of an SOC or PCI node
1593  */
1594 u64 fdt_get_base_address(const void *fdt, int node)
1595 {
1596         int size;
1597         const fdt32_t *prop;
1598
1599         prop = fdt_getprop(fdt, node, "reg", &size);
1600
1601         return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1602 }
1603
1604 /*
1605  * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1606  */
1607 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1608                          uint64_t *val, int cells)
1609 {
1610         const fdt32_t *prop32 = &prop[cell_off];
1611         const unaligned_fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1612
1613         if ((cell_off + cells) > prop_len)
1614                 return -FDT_ERR_NOSPACE;
1615
1616         switch (cells) {
1617         case 1:
1618                 *val = fdt32_to_cpu(*prop32);
1619                 break;
1620         case 2:
1621                 *val = fdt64_to_cpu(*prop64);
1622                 break;
1623         default:
1624                 return -FDT_ERR_NOSPACE;
1625         }
1626
1627         return 0;
1628 }
1629
1630 /**
1631  * fdt_read_range - Read a node's n'th range property
1632  *
1633  * @fdt: ptr to device tree
1634  * @node: offset of node
1635  * @n: range index
1636  * @child_addr: pointer to storage for the "child address" field
1637  * @addr: pointer to storage for the CPU view translated physical start
1638  * @len: pointer to storage for the range length
1639  *
1640  * Convenience function that reads and interprets a specific range out of
1641  * a number of the "ranges" property array.
1642  */
1643 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1644                    uint64_t *addr, uint64_t *len)
1645 {
1646         int pnode = fdt_parent_offset(fdt, node);
1647         const fdt32_t *ranges;
1648         int pacells;
1649         int acells;
1650         int scells;
1651         int ranges_len;
1652         int cell = 0;
1653         int r = 0;
1654
1655         /*
1656          * The "ranges" property is an array of
1657          * { <child address> <parent address> <size in child address space> }
1658          *
1659          * All 3 elements can span a diffent number of cells. Fetch their size.
1660          */
1661         pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1662         acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1663         scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1664
1665         /* Now try to get the ranges property */
1666         ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1667         if (!ranges)
1668                 return -FDT_ERR_NOTFOUND;
1669         ranges_len /= sizeof(uint32_t);
1670
1671         /* Jump to the n'th entry */
1672         cell = n * (pacells + acells + scells);
1673
1674         /* Read <child address> */
1675         if (child_addr) {
1676                 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1677                                   acells);
1678                 if (r)
1679                         return r;
1680         }
1681         cell += acells;
1682
1683         /* Read <parent address> */
1684         if (addr)
1685                 *addr = fdt_translate_address(fdt, node, ranges + cell);
1686         cell += pacells;
1687
1688         /* Read <size in child address space> */
1689         if (len) {
1690                 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1691                 if (r)
1692                         return r;
1693         }
1694
1695         return 0;
1696 }
1697
1698 /**
1699  * fdt_setup_simplefb_node - Fill and enable a simplefb node
1700  *
1701  * @fdt: ptr to device tree
1702  * @node: offset of the simplefb node
1703  * @base_address: framebuffer base address
1704  * @width: width in pixels
1705  * @height: height in pixels
1706  * @stride: bytes per line
1707  * @format: pixel format string
1708  *
1709  * Convenience function to fill and enable a simplefb node.
1710  */
1711 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1712                             u32 height, u32 stride, const char *format)
1713 {
1714         char name[32];
1715         fdt32_t cells[4];
1716         int i, addrc, sizec, ret;
1717
1718         fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1719                                         &addrc, &sizec);
1720         i = 0;
1721         if (addrc == 2)
1722                 cells[i++] = cpu_to_fdt32(base_address >> 32);
1723         cells[i++] = cpu_to_fdt32(base_address);
1724         if (sizec == 2)
1725                 cells[i++] = 0;
1726         cells[i++] = cpu_to_fdt32(height * stride);
1727
1728         ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1729         if (ret < 0)
1730                 return ret;
1731
1732         snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1733         ret = fdt_set_name(fdt, node, name);
1734         if (ret < 0)
1735                 return ret;
1736
1737         ret = fdt_setprop_u32(fdt, node, "width", width);
1738         if (ret < 0)
1739                 return ret;
1740
1741         ret = fdt_setprop_u32(fdt, node, "height", height);
1742         if (ret < 0)
1743                 return ret;
1744
1745         ret = fdt_setprop_u32(fdt, node, "stride", stride);
1746         if (ret < 0)
1747                 return ret;
1748
1749         ret = fdt_setprop_string(fdt, node, "format", format);
1750         if (ret < 0)
1751                 return ret;
1752
1753         ret = fdt_setprop_string(fdt, node, "status", "okay");
1754         if (ret < 0)
1755                 return ret;
1756
1757         return 0;
1758 }
1759
1760 /*
1761  * Update native-mode in display-timings from display environment variable.
1762  * The node to update are specified by path.
1763  */
1764 int fdt_fixup_display(void *blob, const char *path, const char *display)
1765 {
1766         int off, toff;
1767
1768         if (!display || !path)
1769                 return -FDT_ERR_NOTFOUND;
1770
1771         toff = fdt_path_offset(blob, path);
1772         if (toff >= 0)
1773                 toff = fdt_subnode_offset(blob, toff, "display-timings");
1774         if (toff < 0)
1775                 return toff;
1776
1777         for (off = fdt_first_subnode(blob, toff);
1778              off >= 0;
1779              off = fdt_next_subnode(blob, off)) {
1780                 uint32_t h = fdt_get_phandle(blob, off);
1781                 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1782                       fdt32_to_cpu(h));
1783                 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1784                         return fdt_setprop_u32(blob, toff, "native-mode", h);
1785         }
1786         return toff;
1787 }
1788
1789 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1790 /**
1791  * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1792  *
1793  * @fdt: ptr to device tree
1794  * @fdto: ptr to device tree overlay
1795  *
1796  * Convenience function to apply an overlay and display helpful messages
1797  * in the case of an error
1798  */
1799 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1800 {
1801         int err;
1802         bool has_symbols;
1803
1804         err = fdt_path_offset(fdt, "/__symbols__");
1805         has_symbols = err >= 0;
1806
1807         err = fdt_overlay_apply(fdt, fdto);
1808         if (err < 0) {
1809                 printf("failed on fdt_overlay_apply(): %s\n",
1810                                 fdt_strerror(err));
1811                 if (!has_symbols) {
1812                         printf("base fdt does did not have a /__symbols__ node\n");
1813                         printf("make sure you've compiled with -@\n");
1814                 }
1815         }
1816         return err;
1817 }
1818 #endif