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