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 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
 955         if (mtdparts_init() != 0)
 956                 return;
 957
 958         for (i = 0; i < node_info_size; i++) {
 959                 idx = 0;
 960                 noff = fdt_node_offset_by_compatible(blob, -1,
 961                                                      node_info[i].compat);
 962                 while (noff != -FDT_ERR_NOTFOUND) {
 963                         debug("%s: %s, mtd dev type %d\n",
 964                                 fdt_get_name(blob, noff, 0),
 965                                 node_info[i].compat, node_info[i].type);
 966                         dev = device_find(node_info[i].type, idx++);
 967                         if (dev) {
 968                                 if (fdt_node_set_part_info(blob, noff, dev))
 969                                         return; /* return on error */
 970                         }
 971
 972                         /* Jump to next flash node */
 973                         noff = fdt_node_offset_by_compatible(blob, noff,
 974                                                              node_info[i].compat);
 975                 }
 976         }
 977 }
 978 #endif
 979
 980 void fdt_del_node_and_alias(void *blob, const char *alias)
 981 {
 982         int off = fdt_path_offset(blob, alias);
 983
 984         if (off < 0)
 985                 return;
 986
 987         fdt_del_node(blob, off);
 988
 989         off = fdt_path_offset(blob, "/aliases");
 990         fdt_delprop(blob, off, alias);
 991 }
 992
 993 /* Max address size we deal with */
 994 #define OF_MAX_ADDR_CELLS       4
 995 #define OF_BAD_ADDR     FDT_ADDR_T_NONE
 996 #define OF_CHECK_COUNTS(na, ns) ((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
 997                         (ns) > 0)
 998
 999 /* Debug utility */
1000 #ifdef DEBUG
1001 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1002 {
1003         printf("%s", s);
1004         while(na--)
1005                 printf(" %08x", *(addr++));
1006         printf("\n");
1007 }
1008 #else
1009 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1010 #endif
1011
1012 /**
1013  * struct of_bus - Callbacks for bus specific translators
1014  * @name:       A string used to identify this bus in debug output.
1015  * @addresses:  The name of the DT property from which addresses are
1016  *              to be read, typically "reg".
1017  * @match:      Return non-zero if the node whose parent is at
1018  *              parentoffset in the FDT blob corresponds to a bus
1019  *              of this type, otherwise return zero. If NULL a match
1020  *              is assumed.
1021  * @count_cells:Count how many cells (be32 values) a node whose parent
1022  *              is at parentoffset in the FDT blob will require to
1023  *              represent its address (written to *addrc) & size
1024  *              (written to *sizec).
1025  * @map:        Map the address addr from the address space of this
1026  *              bus to that of its parent, making use of the ranges
1027  *              read from DT to an array at range. na and ns are the
1028  *              number of cells (be32 values) used to hold and address
1029  *              or size, respectively, for this bus. pna is the number
1030  *              of cells used to hold an address for the parent bus.
1031  *              Returns the address in the address space of the parent
1032  *              bus.
1033  * @translate:  Update the value of the address cells at addr within an
1034  *              FDT by adding offset to it. na specifies the number of
1035  *              cells used to hold the address being translated. Returns
1036  *              zero on success, non-zero on error.
1037  *
1038  * Each bus type will include a struct of_bus in the of_busses array,
1039  * providing implementations of some or all of the functions used to
1040  * match the bus & handle address translation for its children.
1041  */
1042 struct of_bus {
1043         const char      *name;
1044         const char      *addresses;
1045         int             (*match)(const void *blob, int parentoffset);
1046         void            (*count_cells)(const void *blob, int parentoffset,
1047                                 int *addrc, int *sizec);
1048         u64             (*map)(fdt32_t *addr, const fdt32_t *range,
1049                                 int na, int ns, int pna);
1050         int             (*translate)(fdt32_t *addr, u64 offset, int na);
1051 };
1052
1053 /* Default translator (generic bus) */
1054 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1055                                         int *addrc, int *sizec)
1056 {
1057         const fdt32_t *prop;
1058
1059         if (addrc)
1060                 *addrc = fdt_address_cells(blob, parentoffset);
1061
1062         if (sizec) {
1063                 prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1064                 if (prop)
1065                         *sizec = be32_to_cpup(prop);
1066                 else
1067                         *sizec = 1;
1068         }
1069 }
1070
1071 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1072                 int na, int ns, int pna)
1073 {
1074         u64 cp, s, da;
1075
1076         cp = fdt_read_number(range, na);
1077         s  = fdt_read_number(range + na + pna, ns);
1078         da = fdt_read_number(addr, na);
1079
1080         debug("OF: default map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1081
1082         if (da < cp || da >= (cp + s))
1083                 return OF_BAD_ADDR;
1084         return da - cp;
1085 }
1086
1087 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1088 {
1089         u64 a = fdt_read_number(addr, na);
1090         memset(addr, 0, na * 4);
1091         a += offset;
1092         if (na > 1)
1093                 addr[na - 2] = cpu_to_fdt32(a >> 32);
1094         addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1095
1096         return 0;
1097 }
1098
1099 #ifdef CONFIG_OF_ISA_BUS
1100
1101 /* ISA bus translator */
1102 static int of_bus_isa_match(const void *blob, int parentoffset)
1103 {
1104         const char *name;
1105
1106         name = fdt_get_name(blob, parentoffset, NULL);
1107         if (!name)
1108                 return 0;
1109
1110         return !strcmp(name, "isa");
1111 }
1112
1113 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1114                                    int *addrc, int *sizec)
1115 {
1116         if (addrc)
1117                 *addrc = 2;
1118         if (sizec)
1119                 *sizec = 1;
1120 }
1121
1122 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1123                           int na, int ns, int pna)
1124 {
1125         u64 cp, s, da;
1126
1127         /* Check address type match */
1128         if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1129                 return OF_BAD_ADDR;
1130
1131         cp = fdt_read_number(range + 1, na - 1);
1132         s  = fdt_read_number(range + na + pna, ns);
1133         da = fdt_read_number(addr + 1, na - 1);
1134
1135         debug("OF: ISA map, cp=%llx, s=%llx, da=%llx\n", cp, s, da);
1136
1137         if (da < cp || da >= (cp + s))
1138                 return OF_BAD_ADDR;
1139         return da - cp;
1140 }
1141
1142 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1143 {
1144         return of_bus_default_translate(addr + 1, offset, na - 1);
1145 }
1146
1147 #endif /* CONFIG_OF_ISA_BUS */
1148
1149 /* Array of bus specific translators */
1150 static struct of_bus of_busses[] = {
1151 #ifdef CONFIG_OF_ISA_BUS
1152         /* ISA */
1153         {
1154                 .name = "isa",
1155                 .addresses = "reg",
1156                 .match = of_bus_isa_match,
1157                 .count_cells = of_bus_isa_count_cells,
1158                 .map = of_bus_isa_map,
1159                 .translate = of_bus_isa_translate,
1160         },
1161 #endif /* CONFIG_OF_ISA_BUS */
1162         /* Default */
1163         {
1164                 .name = "default",
1165                 .addresses = "reg",
1166                 .count_cells = fdt_support_default_count_cells,
1167                 .map = of_bus_default_map,
1168                 .translate = of_bus_default_translate,
1169         },
1170 };
1171
1172 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1173 {
1174         struct of_bus *bus;
1175
1176         if (ARRAY_SIZE(of_busses) == 1)
1177                 return of_busses;
1178
1179         for (bus = of_busses; bus; bus++) {
1180                 if (!bus->match || bus->match(blob, parentoffset))
1181                         return bus;
1182         }
1183
1184         /*
1185          * We should always have matched the default bus at least, since
1186          * it has a NULL match field. If we didn't then it somehow isn't
1187          * in the of_busses array or something equally catastrophic has
1188          * gone wrong.
1189          */
1190         assert(0);
1191         return NULL;
1192 }
1193
1194 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1195                             struct of_bus *pbus, fdt32_t *addr,
1196                             int na, int ns, int pna, const char *rprop)
1197 {
1198         const fdt32_t *ranges;
1199         int rlen;
1200         int rone;
1201         u64 offset = OF_BAD_ADDR;
1202
1203         /* Normally, an absence of a "ranges" property means we are
1204          * crossing a non-translatable boundary, and thus the addresses
1205          * below the current not cannot be converted to CPU physical ones.
1206          * Unfortunately, while this is very clear in the spec, it's not
1207          * what Apple understood, and they do have things like /uni-n or
1208          * /ht nodes with no "ranges" property and a lot of perfectly
1209          * useable mapped devices below them. Thus we treat the absence of
1210          * "ranges" as equivalent to an empty "ranges" property which means
1211          * a 1:1 translation at that level. It's up to the caller not to try
1212          * to translate addresses that aren't supposed to be translated in
1213          * the first place. --BenH.
1214          */
1215         ranges = fdt_getprop(blob, parent, rprop, &rlen);
1216         if (ranges == NULL || rlen == 0) {
1217                 offset = fdt_read_number(addr, na);
1218                 memset(addr, 0, pna * 4);
1219                 debug("OF: no ranges, 1:1 translation\n");
1220                 goto finish;
1221         }
1222
1223         debug("OF: walking ranges...\n");
1224
1225         /* Now walk through the ranges */
1226         rlen /= 4;
1227         rone = na + pna + ns;
1228         for (; rlen >= rone; rlen -= rone, ranges += rone) {
1229                 offset = bus->map(addr, ranges, na, ns, pna);
1230                 if (offset != OF_BAD_ADDR)
1231                         break;
1232         }
1233         if (offset == OF_BAD_ADDR) {
1234                 debug("OF: not found !\n");
1235                 return 1;
1236         }
1237         memcpy(addr, ranges + na, 4 * pna);
1238
1239  finish:
1240         of_dump_addr("OF: parent translation for:", addr, pna);
1241         debug("OF: with offset: %llu\n", offset);
1242
1243         /* Translate it into parent bus space */
1244         return pbus->translate(addr, offset, pna);
1245 }
1246
1247 /*
1248  * Translate an address from the device-tree into a CPU physical address,
1249  * this walks up the tree and applies the various bus mappings on the
1250  * way.
1251  *
1252  * Note: We consider that crossing any level with #size-cells == 0 to mean
1253  * that translation is impossible (that is we are not dealing with a value
1254  * that can be mapped to a cpu physical address). This is not really specified
1255  * that way, but this is traditionally the way IBM at least do things
1256  */
1257 static u64 __of_translate_address(const void *blob, int node_offset,
1258                                   const fdt32_t *in_addr, const char *rprop)
1259 {
1260         int parent;
1261         struct of_bus *bus, *pbus;
1262         fdt32_t addr[OF_MAX_ADDR_CELLS];
1263         int na, ns, pna, pns;
1264         u64 result = OF_BAD_ADDR;
1265
1266         debug("OF: ** translation for device %s **\n",
1267                 fdt_get_name(blob, node_offset, NULL));
1268
1269         /* Get parent & match bus type */
1270         parent = fdt_parent_offset(blob, node_offset);
1271         if (parent < 0)
1272                 goto bail;
1273         bus = of_match_bus(blob, parent);
1274
1275         /* Cound address cells & copy address locally */
1276         bus->count_cells(blob, parent, &na, &ns);
1277         if (!OF_CHECK_COUNTS(na, ns)) {
1278                 printf("%s: Bad cell count for %s\n", __FUNCTION__,
1279                        fdt_get_name(blob, node_offset, NULL));
1280                 goto bail;
1281         }
1282         memcpy(addr, in_addr, na * 4);
1283
1284         debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1285             bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1286         of_dump_addr("OF: translating address:", addr, na);
1287
1288         /* Translate */
1289         for (;;) {
1290                 /* Switch to parent bus */
1291                 node_offset = parent;
1292                 parent = fdt_parent_offset(blob, node_offset);
1293
1294                 /* If root, we have finished */
1295                 if (parent < 0) {
1296                         debug("OF: reached root node\n");
1297                         result = fdt_read_number(addr, na);
1298                         break;
1299                 }
1300
1301                 /* Get new parent bus and counts */
1302                 pbus = of_match_bus(blob, parent);
1303                 pbus->count_cells(blob, parent, &pna, &pns);
1304                 if (!OF_CHECK_COUNTS(pna, pns)) {
1305                         printf("%s: Bad cell count for %s\n", __FUNCTION__,
1306                                 fdt_get_name(blob, node_offset, NULL));
1307                         break;
1308                 }
1309
1310                 debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1311                     pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1312
1313                 /* Apply bus translation */
1314                 if (of_translate_one(blob, node_offset, bus, pbus,
1315                                         addr, na, ns, pna, rprop))
1316                         break;
1317
1318                 /* Complete the move up one level */
1319                 na = pna;
1320                 ns = pns;
1321                 bus = pbus;
1322
1323                 of_dump_addr("OF: one level translation:", addr, na);
1324         }
1325  bail:
1326
1327         return result;
1328 }
1329
1330 u64 fdt_translate_address(const void *blob, int node_offset,
1331                           const fdt32_t *in_addr)
1332 {
1333         return __of_translate_address(blob, node_offset, in_addr, "ranges");
1334 }
1335
1336 u64 fdt_translate_dma_address(const void *blob, int node_offset,
1337                               const fdt32_t *in_addr)
1338 {
1339         return __of_translate_address(blob, node_offset, in_addr, "dma-ranges");
1340 }
1341
1342 /**
1343  * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1344  * who's reg property matches a physical cpu address
1345  *
1346  * @blob: ptr to device tree
1347  * @compat: compatiable string to match
1348  * @compat_off: property name
1349  *
1350  */
1351 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1352                                         phys_addr_t compat_off)
1353 {
1354         int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1355         while (off != -FDT_ERR_NOTFOUND) {
1356                 const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1357                 if (reg) {
1358                         if (compat_off == fdt_translate_address(blob, off, reg))
1359                                 return off;
1360                 }
1361                 off = fdt_node_offset_by_compatible(blob, off, compat);
1362         }
1363
1364         return -FDT_ERR_NOTFOUND;
1365 }
1366
1367 /**
1368  * fdt_alloc_phandle: Return next free phandle value
1369  *
1370  * @blob: ptr to device tree
1371  */
1372 int fdt_alloc_phandle(void *blob)
1373 {
1374         int offset;
1375         uint32_t phandle = 0;
1376
1377         for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1378              offset = fdt_next_node(blob, offset, NULL)) {
1379                 phandle = max(phandle, fdt_get_phandle(blob, offset));
1380         }
1381
1382         return phandle + 1;
1383 }
1384
1385 /*
1386  * fdt_set_phandle: Create a phandle property for the given node
1387  *
1388  * @fdt: ptr to device tree
1389  * @nodeoffset: node to update
1390  * @phandle: phandle value to set (must be unique)
1391  */
1392 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1393 {
1394         int ret;
1395
1396 #ifdef DEBUG
1397         int off = fdt_node_offset_by_phandle(fdt, phandle);
1398
1399         if ((off >= 0) && (off != nodeoffset)) {
1400                 char buf[64];
1401
1402                 fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1403                 printf("Trying to update node %s with phandle %u ",
1404                        buf, phandle);
1405
1406                 fdt_get_path(fdt, off, buf, sizeof(buf));
1407                 printf("that already exists in node %s.\n", buf);
1408                 return -FDT_ERR_BADPHANDLE;
1409         }
1410 #endif
1411
1412         ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1413         if (ret < 0)
1414                 return ret;
1415
1416         /*
1417          * For now, also set the deprecated "linux,phandle" property, so that we
1418          * don't break older kernels.
1419          */
1420         ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1421
1422         return ret;
1423 }
1424
1425 /*
1426  * fdt_create_phandle: Create a phandle property for the given node
1427  *
1428  * @fdt: ptr to device tree
1429  * @nodeoffset: node to update
1430  */
1431 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1432 {
1433         /* see if there is a phandle already */
1434         int phandle = fdt_get_phandle(fdt, nodeoffset);
1435
1436         /* if we got 0, means no phandle so create one */
1437         if (phandle == 0) {
1438                 int ret;
1439
1440                 phandle = fdt_alloc_phandle(fdt);
1441                 ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1442                 if (ret < 0) {
1443                         printf("Can't set phandle %u: %s\n", phandle,
1444                                fdt_strerror(ret));
1445                         return 0;
1446                 }
1447         }
1448
1449         return phandle;
1450 }
1451
1452 /*
1453  * fdt_set_node_status: Set status for the given node
1454  *
1455  * @fdt: ptr to device tree
1456  * @nodeoffset: node to update
1457  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1458  *          FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1459  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1460  */
1461 int fdt_set_node_status(void *fdt, int nodeoffset,
1462                         enum fdt_status status, unsigned int error_code)
1463 {
1464         char buf[16];
1465         int ret = 0;
1466
1467         if (nodeoffset < 0)
1468                 return nodeoffset;
1469
1470         switch (status) {
1471         case FDT_STATUS_OKAY:
1472                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1473                 break;
1474         case FDT_STATUS_DISABLED:
1475                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1476                 break;
1477         case FDT_STATUS_FAIL:
1478                 ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1479                 break;
1480         case FDT_STATUS_FAIL_ERROR_CODE:
1481                 sprintf(buf, "fail-%d", error_code);
1482                 ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1483                 break;
1484         default:
1485                 printf("Invalid fdt status: %x\n", status);
1486                 ret = -1;
1487                 break;
1488         }
1489
1490         return ret;
1491 }
1492
1493 /*
1494  * fdt_set_status_by_alias: Set status for the given node given an alias
1495  *
1496  * @fdt: ptr to device tree
1497  * @alias: alias of node to update
1498  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1499  *          FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1500  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1501  */
1502 int fdt_set_status_by_alias(void *fdt, const char* alias,
1503                             enum fdt_status status, unsigned int error_code)
1504 {
1505         int offset = fdt_path_offset(fdt, alias);
1506
1507         return fdt_set_node_status(fdt, offset, status, error_code);
1508 }
1509
1510 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1511 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1512 {
1513         int noff;
1514         int ret;
1515
1516         noff = fdt_node_offset_by_compatible(blob, -1, compat);
1517         if (noff != -FDT_ERR_NOTFOUND) {
1518                 debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1519 add_edid:
1520                 ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1521                 if (ret == -FDT_ERR_NOSPACE) {
1522                         ret = fdt_increase_size(blob, 512);
1523                         if (!ret)
1524                                 goto add_edid;
1525                         else
1526                                 goto err_size;
1527                 } else if (ret < 0) {
1528                         printf("Can't add property: %s\n", fdt_strerror(ret));
1529                         return ret;
1530                 }
1531         }
1532         return 0;
1533 err_size:
1534         printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1535         return ret;
1536 }
1537 #endif
1538
1539 /*
1540  * Verify the physical address of device tree node for a given alias
1541  *
1542  * This function locates the device tree node of a given alias, and then
1543  * verifies that the physical address of that device matches the given
1544  * parameter.  It displays a message if there is a mismatch.
1545  *
1546  * Returns 1 on success, 0 on failure
1547  */
1548 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1549 {
1550         const char *path;
1551         const fdt32_t *reg;
1552         int node, len;
1553         u64 dt_addr;
1554
1555         path = fdt_getprop(fdt, anode, alias, NULL);
1556         if (!path) {
1557                 /* If there's no such alias, then it's not a failure */
1558                 return 1;
1559         }
1560
1561         node = fdt_path_offset(fdt, path);
1562         if (node < 0) {
1563                 printf("Warning: device tree alias '%s' points to invalid "
1564                        "node %s.\n", alias, path);
1565                 return 0;
1566         }
1567
1568         reg = fdt_getprop(fdt, node, "reg", &len);
1569         if (!reg) {
1570                 printf("Warning: device tree node '%s' has no address.\n",
1571                        path);
1572                 return 0;
1573         }
1574
1575         dt_addr = fdt_translate_address(fdt, node, reg);
1576         if (addr != dt_addr) {
1577                 printf("Warning: U-Boot configured device %s at address %llu,\n"
1578                        "but the device tree has it address %llx.\n",
1579                        alias, addr, dt_addr);
1580                 return 0;
1581         }
1582
1583         return 1;
1584 }
1585
1586 /*
1587  * Returns the base address of an SOC or PCI node
1588  */
1589 u64 fdt_get_base_address(const void *fdt, int node)
1590 {
1591         int size;
1592         const fdt32_t *prop;
1593
1594         prop = fdt_getprop(fdt, node, "reg", &size);
1595
1596         return prop ? fdt_translate_address(fdt, node, prop) : OF_BAD_ADDR;
1597 }
1598
1599 /*
1600  * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1601  */
1602 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1603                          uint64_t *val, int cells)
1604 {
1605         const fdt32_t *prop32 = &prop[cell_off];
1606         const unaligned_fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1607
1608         if ((cell_off + cells) > prop_len)
1609                 return -FDT_ERR_NOSPACE;
1610
1611         switch (cells) {
1612         case 1:
1613                 *val = fdt32_to_cpu(*prop32);
1614                 break;
1615         case 2:
1616                 *val = fdt64_to_cpu(*prop64);
1617                 break;
1618         default:
1619                 return -FDT_ERR_NOSPACE;
1620         }
1621
1622         return 0;
1623 }
1624
1625 /**
1626  * fdt_read_range - Read a node's n'th range property
1627  *
1628  * @fdt: ptr to device tree
1629  * @node: offset of node
1630  * @n: range index
1631  * @child_addr: pointer to storage for the "child address" field
1632  * @addr: pointer to storage for the CPU view translated physical start
1633  * @len: pointer to storage for the range length
1634  *
1635  * Convenience function that reads and interprets a specific range out of
1636  * a number of the "ranges" property array.
1637  */
1638 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1639                    uint64_t *addr, uint64_t *len)
1640 {
1641         int pnode = fdt_parent_offset(fdt, node);
1642         const fdt32_t *ranges;
1643         int pacells;
1644         int acells;
1645         int scells;
1646         int ranges_len;
1647         int cell = 0;
1648         int r = 0;
1649
1650         /*
1651          * The "ranges" property is an array of
1652          * { <child address> <parent address> <size in child address space> }
1653          *
1654          * All 3 elements can span a diffent number of cells. Fetch their size.
1655          */
1656         pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1657         acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1658         scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1659
1660         /* Now try to get the ranges property */
1661         ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1662         if (!ranges)
1663                 return -FDT_ERR_NOTFOUND;
1664         ranges_len /= sizeof(uint32_t);
1665
1666         /* Jump to the n'th entry */
1667         cell = n * (pacells + acells + scells);
1668
1669         /* Read <child address> */
1670         if (child_addr) {
1671                 r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1672                                   acells);
1673                 if (r)
1674                         return r;
1675         }
1676         cell += acells;
1677
1678         /* Read <parent address> */
1679         if (addr)
1680                 *addr = fdt_translate_address(fdt, node, ranges + cell);
1681         cell += pacells;
1682
1683         /* Read <size in child address space> */
1684         if (len) {
1685                 r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1686                 if (r)
1687                         return r;
1688         }
1689
1690         return 0;
1691 }
1692
1693 /**
1694  * fdt_setup_simplefb_node - Fill and enable a simplefb node
1695  *
1696  * @fdt: ptr to device tree
1697  * @node: offset of the simplefb node
1698  * @base_address: framebuffer base address
1699  * @width: width in pixels
1700  * @height: height in pixels
1701  * @stride: bytes per line
1702  * @format: pixel format string
1703  *
1704  * Convenience function to fill and enable a simplefb node.
1705  */
1706 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1707                             u32 height, u32 stride, const char *format)
1708 {
1709         char name[32];
1710         fdt32_t cells[4];
1711         int i, addrc, sizec, ret;
1712
1713         fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1714                                         &addrc, &sizec);
1715         i = 0;
1716         if (addrc == 2)
1717                 cells[i++] = cpu_to_fdt32(base_address >> 32);
1718         cells[i++] = cpu_to_fdt32(base_address);
1719         if (sizec == 2)
1720                 cells[i++] = 0;
1721         cells[i++] = cpu_to_fdt32(height * stride);
1722
1723         ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1724         if (ret < 0)
1725                 return ret;
1726
1727         snprintf(name, sizeof(name), "framebuffer@%llx", base_address);
1728         ret = fdt_set_name(fdt, node, name);
1729         if (ret < 0)
1730                 return ret;
1731
1732         ret = fdt_setprop_u32(fdt, node, "width", width);
1733         if (ret < 0)
1734                 return ret;
1735
1736         ret = fdt_setprop_u32(fdt, node, "height", height);
1737         if (ret < 0)
1738                 return ret;
1739
1740         ret = fdt_setprop_u32(fdt, node, "stride", stride);
1741         if (ret < 0)
1742                 return ret;
1743
1744         ret = fdt_setprop_string(fdt, node, "format", format);
1745         if (ret < 0)
1746                 return ret;
1747
1748         ret = fdt_setprop_string(fdt, node, "status", "okay");
1749         if (ret < 0)
1750                 return ret;
1751
1752         return 0;
1753 }
1754
1755 /*
1756  * Update native-mode in display-timings from display environment variable.
1757  * The node to update are specified by path.
1758  */
1759 int fdt_fixup_display(void *blob, const char *path, const char *display)
1760 {
1761         int off, toff;
1762
1763         if (!display || !path)
1764                 return -FDT_ERR_NOTFOUND;
1765
1766         toff = fdt_path_offset(blob, path);
1767         if (toff >= 0)
1768                 toff = fdt_subnode_offset(blob, toff, "display-timings");
1769         if (toff < 0)
1770                 return toff;
1771
1772         for (off = fdt_first_subnode(blob, toff);
1773              off >= 0;
1774              off = fdt_next_subnode(blob, off)) {
1775                 uint32_t h = fdt_get_phandle(blob, off);
1776                 debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1777                       fdt32_to_cpu(h));
1778                 if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1779                         return fdt_setprop_u32(blob, toff, "native-mode", h);
1780         }
1781         return toff;
1782 }
1783
1784 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1785 /**
1786  * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1787  *
1788  * @fdt: ptr to device tree
1789  * @fdto: ptr to device tree overlay
1790  *
1791  * Convenience function to apply an overlay and display helpful messages
1792  * in the case of an error
1793  */
1794 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1795 {
1796         int err;
1797         bool has_symbols;
1798
1799         err = fdt_path_offset(fdt, "/__symbols__");
1800         has_symbols = err >= 0;
1801
1802         err = fdt_overlay_apply(fdt, fdto);
1803         if (err < 0) {
1804                 printf("failed on fdt_overlay_apply(): %s\n",
1805                                 fdt_strerror(err));
1806                 if (!has_symbols) {
1807                         printf("base fdt does did not have a /__symbols__ node\n");
1808                         printf("make sure you've compiled with -@\n");
1809                 }
1810         }
1811         return err;
1812 }
1813 #endif