cmd/fdt.c

   1 /*
   2  * (C) Copyright 2007
   3  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
   4  * Based on code written by:
   5  *   Pantelis Antoniou <pantelis.antoniou@gmail.com> and
   6  *   Matthew McClintock <msm@freescale.com>
   7  *
   8  * SPDX-License-Identifier:     GPL-2.0+
   9  */
  10
  11 #include <common.h>
  12 #include <command.h>
  13 #include <linux/ctype.h>
  14 #include <linux/types.h>
  15 #include <asm/global_data.h>
  16 #include <libfdt.h>
  17 #include <fdt_support.h>
  18 #include <mapmem.h>
  19 #include <asm/io.h>
  20
  21 #define MAX_LEVEL       32              /* how deeply nested we will go */
  22 #define SCRATCHPAD      1024            /* bytes of scratchpad memory */
  23 #ifndef CONFIG_CMD_FDT_MAX_DUMP
  24 #define CONFIG_CMD_FDT_MAX_DUMP 64
  25 #endif
  26
  27 /*
  28  * Global data (for the gd->bd)
  29  */
  30 DECLARE_GLOBAL_DATA_PTR;
  31
  32 static int fdt_valid(struct fdt_header **blobp);
  33 static int fdt_parse_prop(char *const*newval, int count, char *data, int *len);
  34 static int fdt_print(const char *pathp, char *prop, int depth);
  35 static int is_printable_string(const void *data, int len);
  36
  37 /*
  38  * The working_fdt points to our working flattened device tree.
  39  */
  40 struct fdt_header *working_fdt;
  41
  42 void set_working_fdt_addr(ulong addr)
  43 {
  44         void *buf;
  45
  46         buf = map_sysmem(addr, 0);
  47         working_fdt = buf;
  48         setenv_hex("fdtaddr", addr);
  49 }
  50
  51 /*
  52  * Get a value from the fdt and format it to be set in the environment
  53  */
  54 static int fdt_value_setenv(const void *nodep, int len, const char *var)
  55 {
  56         if (is_printable_string(nodep, len))
  57                 setenv(var, (void *)nodep);
  58         else if (len == 4) {
  59                 char buf[11];
  60
  61                 sprintf(buf, "0x%08X", *(uint32_t *)nodep);
  62                 setenv(var, buf);
  63         } else if (len%4 == 0 && len <= 20) {
  64                 /* Needed to print things like sha1 hashes. */
  65                 char buf[41];
  66                 int i;
  67
  68                 for (i = 0; i < len; i += sizeof(unsigned int))
  69                         sprintf(buf + (i * 2), "%08x",
  70                                 *(unsigned int *)(nodep + i));
  71                 setenv(var, buf);
  72         } else {
  73                 printf("error: unprintable value\n");
  74                 return 1;
  75         }
  76         return 0;
  77 }
  78
  79 /*
  80  * Flattened Device Tree command, see the help for parameter definitions.
  81  */
  82 static int do_fdt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
  83 {
  84         if (argc < 2)
  85                 return CMD_RET_USAGE;
  86
  87         /*
  88          * Set the address of the fdt
  89          */
  90         if (strncmp(argv[1], "ad", 2) == 0) {
  91                 unsigned long addr;
  92                 int control = 0;
  93                 struct fdt_header *blob;
  94                 /*
  95                  * Set the address [and length] of the fdt.
  96                  */
  97                 argc -= 2;
  98                 argv += 2;
  99 /* Temporary #ifdef - some archs don't have fdt_blob yet */
 100 #ifdef CONFIG_OF_CONTROL
 101                 if (argc && !strcmp(*argv, "-c")) {
 102                         control = 1;
 103                         argc--;
 104                         argv++;
 105                 }
 106 #endif
 107                 if (argc == 0) {
 108                         if (control)
 109                                 blob = (struct fdt_header *)gd->fdt_blob;
 110                         else
 111                                 blob = working_fdt;
 112                         if (!blob || !fdt_valid(&blob))
 113                                 return 1;
 114                         printf("The address of the fdt is %#08lx\n",
 115                                control ? (ulong)map_to_sysmem(blob) :
 116                                         getenv_hex("fdtaddr", 0));
 117                         return 0;
 118                 }
 119
 120                 addr = simple_strtoul(argv[0], NULL, 16);
 121                 blob = map_sysmem(addr, 0);
 122                 if (!fdt_valid(&blob))
 123                         return 1;
 124                 if (control)
 125                         gd->fdt_blob = blob;
 126                 else
 127                         set_working_fdt_addr(addr);
 128
 129                 if (argc >= 2) {
 130                         int  len;
 131                         int  err;
 132                         /*
 133                          * Optional new length
 134                          */
 135                         len = simple_strtoul(argv[1], NULL, 16);
 136                         if (len < fdt_totalsize(blob)) {
 137                                 printf ("New length %d < existing length %d, "
 138                                         "ignoring.\n",
 139                                         len, fdt_totalsize(blob));
 140                         } else {
 141                                 /*
 142                                  * Open in place with a new length.
 143                                  */
 144                                 err = fdt_open_into(blob, blob, len);
 145                                 if (err != 0) {
 146                                         printf ("libfdt fdt_open_into(): %s\n",
 147                                                 fdt_strerror(err));
 148                                 }
 149                         }
 150                 }
 151
 152                 return CMD_RET_SUCCESS;
 153         }
 154
 155         if (!working_fdt) {
 156                 puts(
 157                         "No FDT memory address configured. Please configure\n"
 158                         "the FDT address via \"fdt addr <address>\" command.\n"
 159                         "Aborting!\n");
 160                 return CMD_RET_FAILURE;
 161         }
 162
 163         /*
 164          * Move the working_fdt
 165          */
 166         if (strncmp(argv[1], "mo", 2) == 0) {
 167                 struct fdt_header *newaddr;
 168                 int  len;
 169                 int  err;
 170
 171                 if (argc < 4)
 172                         return CMD_RET_USAGE;
 173
 174                 /*
 175                  * Set the address and length of the fdt.
 176                  */
 177                 working_fdt = (struct fdt_header *)simple_strtoul(argv[2], NULL, 16);
 178                 if (!fdt_valid(&working_fdt))
 179                         return 1;
 180
 181                 newaddr = (struct fdt_header *)simple_strtoul(argv[3],NULL,16);
 182
 183                 /*
 184                  * If the user specifies a length, use that.  Otherwise use the
 185                  * current length.
 186                  */
 187                 if (argc <= 4) {
 188                         len = fdt_totalsize(working_fdt);
 189                 } else {
 190                         len = simple_strtoul(argv[4], NULL, 16);
 191                         if (len < fdt_totalsize(working_fdt)) {
 192                                 printf ("New length 0x%X < existing length "
 193                                         "0x%X, aborting.\n",
 194                                         len, fdt_totalsize(working_fdt));
 195                                 return 1;
 196                         }
 197                 }
 198
 199                 /*
 200                  * Copy to the new location.
 201                  */
 202                 err = fdt_open_into(working_fdt, newaddr, len);
 203                 if (err != 0) {
 204                         printf ("libfdt fdt_open_into(): %s\n",
 205                                 fdt_strerror(err));
 206                         return 1;
 207                 }
 208                 working_fdt = newaddr;
 209 #ifdef CONFIG_OF_SYSTEM_SETUP
 210         /* Call the board-specific fixup routine */
 211         } else if (strncmp(argv[1], "sys", 3) == 0) {
 212                 int err = ft_system_setup(working_fdt, gd->bd);
 213
 214                 if (err) {
 215                         printf("Failed to add system information to FDT: %s\n",
 216                                fdt_strerror(err));
 217                         return CMD_RET_FAILURE;
 218                 }
 219 #endif
 220         /*
 221          * Make a new node
 222          */
 223         } else if (strncmp(argv[1], "mk", 2) == 0) {
 224                 char *pathp;            /* path */
 225                 char *nodep;            /* new node to add */
 226                 int  nodeoffset;        /* node offset from libfdt */
 227                 int  err;
 228
 229                 /*
 230                  * Parameters: Node path, new node to be appended to the path.
 231                  */
 232                 if (argc < 4)
 233                         return CMD_RET_USAGE;
 234
 235                 pathp = argv[2];
 236                 nodep = argv[3];
 237
 238                 nodeoffset = fdt_path_offset (working_fdt, pathp);
 239                 if (nodeoffset < 0) {
 240                         /*
 241                          * Not found or something else bad happened.
 242                          */
 243                         printf ("libfdt fdt_path_offset() returned %s\n",
 244                                 fdt_strerror(nodeoffset));
 245                         return 1;
 246                 }
 247                 err = fdt_add_subnode(working_fdt, nodeoffset, nodep);
 248                 if (err < 0) {
 249                         printf ("libfdt fdt_add_subnode(): %s\n",
 250                                 fdt_strerror(err));
 251                         return 1;
 252                 }
 253
 254         /*
 255          * Set the value of a property in the working_fdt.
 256          */
 257         } else if (argv[1][0] == 's') {
 258                 char *pathp;            /* path */
 259                 char *prop;             /* property */
 260                 int  nodeoffset;        /* node offset from libfdt */
 261                 static char data[SCRATCHPAD];   /* storage for the property */
 262                 int  len;               /* new length of the property */
 263                 int  ret;               /* return value */
 264
 265                 /*
 266                  * Parameters: Node path, property, optional value.
 267                  */
 268                 if (argc < 4)
 269                         return CMD_RET_USAGE;
 270
 271                 pathp  = argv[2];
 272                 prop   = argv[3];
 273                 if (argc == 4) {
 274                         len = 0;
 275                 } else {
 276                         ret = fdt_parse_prop(&argv[4], argc - 4, data, &len);
 277                         if (ret != 0)
 278                                 return ret;
 279                 }
 280
 281                 nodeoffset = fdt_path_offset (working_fdt, pathp);
 282                 if (nodeoffset < 0) {
 283                         /*
 284                          * Not found or something else bad happened.
 285                          */
 286                         printf ("libfdt fdt_path_offset() returned %s\n",
 287                                 fdt_strerror(nodeoffset));
 288                         return 1;
 289                 }
 290
 291                 ret = fdt_setprop(working_fdt, nodeoffset, prop, data, len);
 292                 if (ret < 0) {
 293                         printf ("libfdt fdt_setprop(): %s\n", fdt_strerror(ret));
 294                         return 1;
 295                 }
 296
 297         /********************************************************************
 298          * Get the value of a property in the working_fdt.
 299          ********************************************************************/
 300         } else if (argv[1][0] == 'g') {
 301                 char *subcmd;           /* sub-command */
 302                 char *pathp;            /* path */
 303                 char *prop;             /* property */
 304                 char *var;              /* variable to store result */
 305                 int  nodeoffset;        /* node offset from libfdt */
 306                 const void *nodep;      /* property node pointer */
 307                 int  len = 0;           /* new length of the property */
 308
 309                 /*
 310                  * Parameters: Node path, property, optional value.
 311                  */
 312                 if (argc < 5)
 313                         return CMD_RET_USAGE;
 314
 315                 subcmd = argv[2];
 316
 317                 if (argc < 6 && subcmd[0] != 's')
 318                         return CMD_RET_USAGE;
 319
 320                 var    = argv[3];
 321                 pathp  = argv[4];
 322                 prop   = argv[5];
 323
 324                 nodeoffset = fdt_path_offset(working_fdt, pathp);
 325                 if (nodeoffset < 0) {
 326                         /*
 327                          * Not found or something else bad happened.
 328                          */
 329                         printf("libfdt fdt_path_offset() returned %s\n",
 330                                 fdt_strerror(nodeoffset));
 331                         return 1;
 332                 }
 333
 334                 if (subcmd[0] == 'n' || (subcmd[0] == 's' && argc == 5)) {
 335                         int reqIndex = -1;
 336                         int startDepth = fdt_node_depth(
 337                                 working_fdt, nodeoffset);
 338                         int curDepth = startDepth;
 339                         int curIndex = -1;
 340                         int nextNodeOffset = fdt_next_node(
 341                                 working_fdt, nodeoffset, &curDepth);
 342
 343                         if (subcmd[0] == 'n')
 344                                 reqIndex = simple_strtoul(argv[5], NULL, 16);
 345
 346                         while (curDepth > startDepth) {
 347                                 if (curDepth == startDepth + 1)
 348                                         curIndex++;
 349                                 if (subcmd[0] == 'n' && curIndex == reqIndex) {
 350                                         const char *nodeName = fdt_get_name(
 351                                             working_fdt, nextNodeOffset, NULL);
 352
 353                                         setenv(var, (char *)nodeName);
 354                                         return 0;
 355                                 }
 356                                 nextNodeOffset = fdt_next_node(
 357                                         working_fdt, nextNodeOffset, &curDepth);
 358                                 if (nextNodeOffset < 0)
 359                                         break;
 360                         }
 361                         if (subcmd[0] == 's') {
 362                                 /* get the num nodes at this level */
 363                                 setenv_ulong(var, curIndex + 1);
 364                         } else {
 365                                 /* node index not found */
 366                                 printf("libfdt node not found\n");
 367                                 return 1;
 368                         }
 369                 } else {
 370                         nodep = fdt_getprop(
 371                                 working_fdt, nodeoffset, prop, &len);
 372                         if (len == 0) {
 373                                 /* no property value */
 374                                 setenv(var, "");
 375                                 return 0;
 376                         } else if (len > 0) {
 377                                 if (subcmd[0] == 'v') {
 378                                         int ret;
 379
 380                                         ret = fdt_value_setenv(nodep, len, var);
 381                                         if (ret != 0)
 382                                                 return ret;
 383                                 } else if (subcmd[0] == 'a') {
 384                                         /* Get address */
 385                                         char buf[11];
 386
 387                                         sprintf(buf, "0x%p", nodep);
 388                                         setenv(var, buf);
 389                                 } else if (subcmd[0] == 's') {
 390                                         /* Get size */
 391                                         char buf[11];
 392
 393                                         sprintf(buf, "0x%08X", len);
 394                                         setenv(var, buf);
 395                                 } else
 396                                         return CMD_RET_USAGE;
 397                                 return 0;
 398                         } else {
 399                                 printf("libfdt fdt_getprop(): %s\n",
 400                                         fdt_strerror(len));
 401                                 return 1;
 402                         }
 403                 }
 404
 405         /*
 406          * Print (recursive) / List (single level)
 407          */
 408         } else if ((argv[1][0] == 'p') || (argv[1][0] == 'l')) {
 409                 int depth = MAX_LEVEL;  /* how deep to print */
 410                 char *pathp;            /* path */
 411                 char *prop;             /* property */
 412                 int  ret;               /* return value */
 413                 static char root[2] = "/";
 414
 415                 /*
 416                  * list is an alias for print, but limited to 1 level
 417                  */
 418                 if (argv[1][0] == 'l') {
 419                         depth = 1;
 420                 }
 421
 422                 /*
 423                  * Get the starting path.  The root node is an oddball,
 424                  * the offset is zero and has no name.
 425                  */
 426                 if (argc == 2)
 427                         pathp = root;
 428                 else
 429                         pathp = argv[2];
 430                 if (argc > 3)
 431                         prop = argv[3];
 432                 else
 433                         prop = NULL;
 434
 435                 ret = fdt_print(pathp, prop, depth);
 436                 if (ret != 0)
 437                         return ret;
 438
 439         /*
 440          * Remove a property/node
 441          */
 442         } else if (strncmp(argv[1], "rm", 2) == 0) {
 443                 int  nodeoffset;        /* node offset from libfdt */
 444                 int  err;
 445
 446                 /*
 447                  * Get the path.  The root node is an oddball, the offset
 448                  * is zero and has no name.
 449                  */
 450                 nodeoffset = fdt_path_offset (working_fdt, argv[2]);
 451                 if (nodeoffset < 0) {
 452                         /*
 453                          * Not found or something else bad happened.
 454                          */
 455                         printf ("libfdt fdt_path_offset() returned %s\n",
 456                                 fdt_strerror(nodeoffset));
 457                         return 1;
 458                 }
 459                 /*
 460                  * Do the delete.  A fourth parameter means delete a property,
 461                  * otherwise delete the node.
 462                  */
 463                 if (argc > 3) {
 464                         err = fdt_delprop(working_fdt, nodeoffset, argv[3]);
 465                         if (err < 0) {
 466                                 printf("libfdt fdt_delprop():  %s\n",
 467                                         fdt_strerror(err));
 468                                 return err;
 469                         }
 470                 } else {
 471                         err = fdt_del_node(working_fdt, nodeoffset);
 472                         if (err < 0) {
 473                                 printf("libfdt fdt_del_node():  %s\n",
 474                                         fdt_strerror(err));
 475                                 return err;
 476                         }
 477                 }
 478
 479         /*
 480          * Display header info
 481          */
 482         } else if (argv[1][0] == 'h') {
 483                 u32 version = fdt_version(working_fdt);
 484                 printf("magic:\t\t\t0x%x\n", fdt_magic(working_fdt));
 485                 printf("totalsize:\t\t0x%x (%d)\n", fdt_totalsize(working_fdt),
 486                        fdt_totalsize(working_fdt));
 487                 printf("off_dt_struct:\t\t0x%x\n",
 488                        fdt_off_dt_struct(working_fdt));
 489                 printf("off_dt_strings:\t\t0x%x\n",
 490                        fdt_off_dt_strings(working_fdt));
 491                 printf("off_mem_rsvmap:\t\t0x%x\n",
 492                        fdt_off_mem_rsvmap(working_fdt));
 493                 printf("version:\t\t%d\n", version);
 494                 printf("last_comp_version:\t%d\n",
 495                        fdt_last_comp_version(working_fdt));
 496                 if (version >= 2)
 497                         printf("boot_cpuid_phys:\t0x%x\n",
 498                                 fdt_boot_cpuid_phys(working_fdt));
 499                 if (version >= 3)
 500                         printf("size_dt_strings:\t0x%x\n",
 501                                 fdt_size_dt_strings(working_fdt));
 502                 if (version >= 17)
 503                         printf("size_dt_struct:\t\t0x%x\n",
 504                                 fdt_size_dt_struct(working_fdt));
 505                 printf("number mem_rsv:\t\t0x%x\n",
 506                        fdt_num_mem_rsv(working_fdt));
 507                 printf("\n");
 508
 509         /*
 510          * Set boot cpu id
 511          */
 512         } else if (strncmp(argv[1], "boo", 3) == 0) {
 513                 unsigned long tmp = simple_strtoul(argv[2], NULL, 16);
 514                 fdt_set_boot_cpuid_phys(working_fdt, tmp);
 515
 516         /*
 517          * memory command
 518          */
 519         } else if (strncmp(argv[1], "me", 2) == 0) {
 520                 uint64_t addr, size;
 521                 int err;
 522                 addr = simple_strtoull(argv[2], NULL, 16);
 523                 size = simple_strtoull(argv[3], NULL, 16);
 524                 err = fdt_fixup_memory(working_fdt, addr, size);
 525                 if (err < 0)
 526                         return err;
 527
 528         /*
 529          * mem reserve commands
 530          */
 531         } else if (strncmp(argv[1], "rs", 2) == 0) {
 532                 if (argv[2][0] == 'p') {
 533                         uint64_t addr, size;
 534                         int total = fdt_num_mem_rsv(working_fdt);
 535                         int j, err;
 536                         printf("index\t\t   start\t\t    size\n");
 537                         printf("-------------------------------"
 538                                 "-----------------\n");
 539                         for (j = 0; j < total; j++) {
 540                                 err = fdt_get_mem_rsv(working_fdt, j, &addr, &size);
 541                                 if (err < 0) {
 542                                         printf("libfdt fdt_get_mem_rsv():  %s\n",
 543                                                         fdt_strerror(err));
 544                                         return err;
 545                                 }
 546                                 printf("    %x\t%08x%08x\t%08x%08x\n", j,
 547                                         (u32)(addr >> 32),
 548                                         (u32)(addr & 0xffffffff),
 549                                         (u32)(size >> 32),
 550                                         (u32)(size & 0xffffffff));
 551                         }
 552                 } else if (argv[2][0] == 'a') {
 553                         uint64_t addr, size;
 554                         int err;
 555                         addr = simple_strtoull(argv[3], NULL, 16);
 556                         size = simple_strtoull(argv[4], NULL, 16);
 557                         err = fdt_add_mem_rsv(working_fdt, addr, size);
 558
 559                         if (err < 0) {
 560                                 printf("libfdt fdt_add_mem_rsv():  %s\n",
 561                                         fdt_strerror(err));
 562                                 return err;
 563                         }
 564                 } else if (argv[2][0] == 'd') {
 565                         unsigned long idx = simple_strtoul(argv[3], NULL, 16);
 566                         int err = fdt_del_mem_rsv(working_fdt, idx);
 567
 568                         if (err < 0) {
 569                                 printf("libfdt fdt_del_mem_rsv():  %s\n",
 570                                         fdt_strerror(err));
 571                                 return err;
 572                         }
 573                 } else {
 574                         /* Unrecognized command */
 575                         return CMD_RET_USAGE;
 576                 }
 577         }
 578 #ifdef CONFIG_OF_BOARD_SETUP
 579         /* Call the board-specific fixup routine */
 580         else if (strncmp(argv[1], "boa", 3) == 0) {
 581                 int err = ft_board_setup(working_fdt, gd->bd);
 582
 583                 if (err) {
 584                         printf("Failed to update board information in FDT: %s\n",
 585                                fdt_strerror(err));
 586                         return CMD_RET_FAILURE;
 587                 }
 588         }
 589 #endif
 590         /* Create a chosen node */
 591         else if (strncmp(argv[1], "cho", 3) == 0) {
 592                 unsigned long initrd_start = 0, initrd_end = 0;
 593
 594                 if ((argc != 2) && (argc != 4))
 595                         return CMD_RET_USAGE;
 596
 597                 if (argc == 4) {
 598                         initrd_start = simple_strtoul(argv[2], NULL, 16);
 599                         initrd_end = simple_strtoul(argv[3], NULL, 16);
 600                 }
 601
 602                 fdt_chosen(working_fdt);
 603                 fdt_initrd(working_fdt, initrd_start, initrd_end);
 604
 605 #if defined(CONFIG_FIT_SIGNATURE)
 606         } else if (strncmp(argv[1], "che", 3) == 0) {
 607                 int cfg_noffset;
 608                 int ret;
 609                 unsigned long addr;
 610                 struct fdt_header *blob;
 611
 612                 if (!working_fdt)
 613                         return CMD_RET_FAILURE;
 614
 615                 if (argc > 2) {
 616                         addr = simple_strtoul(argv[2], NULL, 16);
 617                         blob = map_sysmem(addr, 0);
 618                 } else {
 619                         blob = (struct fdt_header *)gd->fdt_blob;
 620                 }
 621                 if (!fdt_valid(&blob))
 622                         return 1;
 623
 624                 gd->fdt_blob = blob;
 625                 cfg_noffset = fit_conf_get_node(working_fdt, NULL);
 626                 if (!cfg_noffset) {
 627                         printf("Could not find configuration node: %s\n",
 628                                fdt_strerror(cfg_noffset));
 629                         return CMD_RET_FAILURE;
 630                 }
 631
 632                 ret = fit_config_verify(working_fdt, cfg_noffset);
 633                 if (ret == 0)
 634                         return CMD_RET_SUCCESS;
 635                 else
 636                         return CMD_RET_FAILURE;
 637 #endif
 638
 639         }
 640 #ifdef CONFIG_OF_LIBFDT_OVERLAY
 641         /* apply an overlay */
 642         else if (strncmp(argv[1], "ap", 2) == 0) {
 643                 unsigned long addr;
 644                 struct fdt_header *blob;
 645
 646                 if (argc != 3)
 647                         return CMD_RET_USAGE;
 648
 649                 if (!working_fdt)
 650                         return CMD_RET_FAILURE;
 651
 652                 addr = simple_strtoul(argv[2], NULL, 16);
 653                 blob = map_sysmem(addr, 0);
 654                 if (!fdt_valid(&blob))
 655                         return CMD_RET_FAILURE;
 656
 657                 if (fdt_overlay_apply(working_fdt, blob))
 658                         return CMD_RET_FAILURE;
 659         }
 660 #endif
 661         /* resize the fdt */
 662         else if (strncmp(argv[1], "re", 2) == 0) {
 663                 uint extrasize;
 664                 if (argc > 2)
 665                         extrasize = simple_strtoul(argv[2], NULL, 16);
 666                 else
 667                         extrasize = 0;
 668                 fdt_shrink_to_minimum(working_fdt, extrasize);
 669         }
 670         else {
 671                 /* Unrecognized command */
 672                 return CMD_RET_USAGE;
 673         }
 674
 675         return 0;
 676 }
 677
 678 /****************************************************************************/
 679
 680 /**
 681  * fdt_valid() - Check if an FDT is valid. If not, change it to NULL
 682  *
 683  * @blobp: Pointer to FDT pointer
 684  * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL)
 685  */
 686 static int fdt_valid(struct fdt_header **blobp)
 687 {
 688         const void *blob = *blobp;
 689         int err;
 690
 691         if (blob == NULL) {
 692                 printf ("The address of the fdt is invalid (NULL).\n");
 693                 return 0;
 694         }
 695
 696         err = fdt_check_header(blob);
 697         if (err == 0)
 698                 return 1;       /* valid */
 699
 700         if (err < 0) {
 701                 printf("libfdt fdt_check_header(): %s", fdt_strerror(err));
 702                 /*
 703                  * Be more informative on bad version.
 704                  */
 705                 if (err == -FDT_ERR_BADVERSION) {
 706                         if (fdt_version(blob) <
 707                             FDT_FIRST_SUPPORTED_VERSION) {
 708                                 printf (" - too old, fdt %d < %d",
 709                                         fdt_version(blob),
 710                                         FDT_FIRST_SUPPORTED_VERSION);
 711                         }
 712                         if (fdt_last_comp_version(blob) >
 713                             FDT_LAST_SUPPORTED_VERSION) {
 714                                 printf (" - too new, fdt %d > %d",
 715                                         fdt_version(blob),
 716                                         FDT_LAST_SUPPORTED_VERSION);
 717                         }
 718                 }
 719                 printf("\n");
 720                 *blobp = NULL;
 721                 return 0;
 722         }
 723         return 1;
 724 }
 725
 726 /****************************************************************************/
 727
 728 /*
 729  * Parse the user's input, partially heuristic.  Valid formats:
 730  * <0x00112233 4 05>    - an array of cells.  Numbers follow standard
 731  *                      C conventions.
 732  * [00 11 22 .. nn] - byte stream
 733  * "string"     - If the the value doesn't start with "<" or "[", it is
 734  *                      treated as a string.  Note that the quotes are
 735  *                      stripped by the parser before we get the string.
 736  * newval: An array of strings containing the new property as specified
 737  *      on the command line
 738  * count: The number of strings in the array
 739  * data: A bytestream to be placed in the property
 740  * len: The length of the resulting bytestream
 741  */
 742 static int fdt_parse_prop(char * const *newval, int count, char *data, int *len)
 743 {
 744         char *cp;               /* temporary char pointer */
 745         char *newp;             /* temporary newval char pointer */
 746         unsigned long tmp;      /* holds converted values */
 747         int stridx = 0;
 748
 749         *len = 0;
 750         newp = newval[0];
 751
 752         /* An array of cells */
 753         if (*newp == '<') {
 754                 newp++;
 755                 while ((*newp != '>') && (stridx < count)) {
 756                         /*
 757                          * Keep searching until we find that last ">"
 758                          * That way users don't have to escape the spaces
 759                          */
 760                         if (*newp == '\0') {
 761                                 newp = newval[++stridx];
 762                                 continue;
 763                         }
 764
 765                         cp = newp;
 766                         tmp = simple_strtoul(cp, &newp, 0);
 767                         *(__be32 *)data = __cpu_to_be32(tmp);
 768                         data  += 4;
 769                         *len += 4;
 770
 771                         /* If the ptr didn't advance, something went wrong */
 772                         if ((newp - cp) <= 0) {
 773                                 printf("Sorry, I could not convert \"%s\"\n",
 774                                         cp);
 775                                 return 1;
 776                         }
 777
 778                         while (*newp == ' ')
 779                                 newp++;
 780                 }
 781
 782                 if (*newp != '>') {
 783                         printf("Unexpected character '%c'\n", *newp);
 784                         return 1;
 785                 }
 786         } else if (*newp == '[') {
 787                 /*
 788                  * Byte stream.  Convert the values.
 789                  */
 790                 newp++;
 791                 while ((stridx < count) && (*newp != ']')) {
 792                         while (*newp == ' ')
 793                                 newp++;
 794                         if (*newp == '\0') {
 795                                 newp = newval[++stridx];
 796                                 continue;
 797                         }
 798                         if (!isxdigit(*newp))
 799                                 break;
 800                         tmp = simple_strtoul(newp, &newp, 16);
 801                         *data++ = tmp & 0xFF;
 802                         *len    = *len + 1;
 803                 }
 804                 if (*newp != ']') {
 805                         printf("Unexpected character '%c'\n", *newp);
 806                         return 1;
 807                 }
 808         } else {
 809                 /*
 810                  * Assume it is one or more strings.  Copy it into our
 811                  * data area for convenience (including the
 812                  * terminating '\0's).
 813                  */
 814                 while (stridx < count) {
 815                         size_t length = strlen(newp) + 1;
 816                         strcpy(data, newp);
 817                         data += length;
 818                         *len += length;
 819                         newp = newval[++stridx];
 820                 }
 821         }
 822         return 0;
 823 }
 824
 825 /****************************************************************************/
 826
 827 /*
 828  * Heuristic to guess if this is a string or concatenated strings.
 829  */
 830
 831 static int is_printable_string(const void *data, int len)
 832 {
 833         const char *s = data;
 834
 835         /* zero length is not */
 836         if (len == 0)
 837                 return 0;
 838
 839         /* must terminate with zero or '\n' */
 840         if (s[len - 1] != '\0' && s[len - 1] != '\n')
 841                 return 0;
 842
 843         /* printable or a null byte (concatenated strings) */
 844         while (((*s == '\0') || isprint(*s) || isspace(*s)) && (len > 0)) {
 845                 /*
 846                  * If we see a null, there are three possibilities:
 847                  * 1) If len == 1, it is the end of the string, printable
 848                  * 2) Next character also a null, not printable.
 849                  * 3) Next character not a null, continue to check.
 850                  */
 851                 if (s[0] == '\0') {
 852                         if (len == 1)
 853                                 return 1;
 854                         if (s[1] == '\0')
 855                                 return 0;
 856                 }
 857                 s++;
 858                 len--;
 859         }
 860
 861         /* Not the null termination, or not done yet: not printable */
 862         if (*s != '\0' || (len != 0))
 863                 return 0;
 864
 865         return 1;
 866 }
 867
 868
 869 /*
 870  * Print the property in the best format, a heuristic guess.  Print as
 871  * a string, concatenated strings, a byte, word, double word, or (if all
 872  * else fails) it is printed as a stream of bytes.
 873  */
 874 static void print_data(const void *data, int len)
 875 {
 876         int j;
 877
 878         /* no data, don't print */
 879         if (len == 0)
 880                 return;
 881
 882         /*
 883          * It is a string, but it may have multiple strings (embedded '\0's).
 884          */
 885         if (is_printable_string(data, len)) {
 886                 puts("\"");
 887                 j = 0;
 888                 while (j < len) {
 889                         if (j > 0)
 890                                 puts("\", \"");
 891                         puts(data);
 892                         j    += strlen(data) + 1;
 893                         data += strlen(data) + 1;
 894                 }
 895                 puts("\"");
 896                 return;
 897         }
 898
 899         if ((len %4) == 0) {
 900                 if (len > CONFIG_CMD_FDT_MAX_DUMP)
 901                         printf("* 0x%p [0x%08x]", data, len);
 902                 else {
 903                         const __be32 *p;
 904
 905                         printf("<");
 906                         for (j = 0, p = data; j < len/4; j++)
 907                                 printf("0x%08x%s", fdt32_to_cpu(p[j]),
 908                                         j < (len/4 - 1) ? " " : "");
 909                         printf(">");
 910                 }
 911         } else { /* anything else... hexdump */
 912                 if (len > CONFIG_CMD_FDT_MAX_DUMP)
 913                         printf("* 0x%p [0x%08x]", data, len);
 914                 else {
 915                         const u8 *s;
 916
 917                         printf("[");
 918                         for (j = 0, s = data; j < len; j++)
 919                                 printf("%02x%s", s[j], j < len - 1 ? " " : "");
 920                         printf("]");
 921                 }
 922         }
 923 }
 924
 925 /****************************************************************************/
 926
 927 /*
 928  * Recursively print (a portion of) the working_fdt.  The depth parameter
 929  * determines how deeply nested the fdt is printed.
 930  */
 931 static int fdt_print(const char *pathp, char *prop, int depth)
 932 {
 933         static char tabs[MAX_LEVEL+1] =
 934                 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"
 935                 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
 936         const void *nodep;      /* property node pointer */
 937         int  nodeoffset;        /* node offset from libfdt */
 938         int  nextoffset;        /* next node offset from libfdt */
 939         uint32_t tag;           /* tag */
 940         int  len;               /* length of the property */
 941         int  level = 0;         /* keep track of nesting level */
 942         const struct fdt_property *fdt_prop;
 943
 944         nodeoffset = fdt_path_offset (working_fdt, pathp);
 945         if (nodeoffset < 0) {
 946                 /*
 947                  * Not found or something else bad happened.
 948                  */
 949                 printf ("libfdt fdt_path_offset() returned %s\n",
 950                         fdt_strerror(nodeoffset));
 951                 return 1;
 952         }
 953         /*
 954          * The user passed in a property as well as node path.
 955          * Print only the given property and then return.
 956          */
 957         if (prop) {
 958                 nodep = fdt_getprop (working_fdt, nodeoffset, prop, &len);
 959                 if (len == 0) {
 960                         /* no property value */
 961                         printf("%s %s\n", pathp, prop);
 962                         return 0;
 963                 } else if (len > 0) {
 964                         printf("%s = ", prop);
 965                         print_data (nodep, len);
 966                         printf("\n");
 967                         return 0;
 968                 } else {
 969                         printf ("libfdt fdt_getprop(): %s\n",
 970                                 fdt_strerror(len));
 971                         return 1;
 972                 }
 973         }
 974
 975         /*
 976          * The user passed in a node path and no property,
 977          * print the node and all subnodes.
 978          */
 979         while(level >= 0) {
 980                 tag = fdt_next_tag(working_fdt, nodeoffset, &nextoffset);
 981                 switch(tag) {
 982                 case FDT_BEGIN_NODE:
 983                         pathp = fdt_get_name(working_fdt, nodeoffset, NULL);
 984                         if (level <= depth) {
 985                                 if (pathp == NULL)
 986                                         pathp = "/* NULL pointer error */";
 987                                 if (*pathp == '\0')
 988                                         pathp = "/";    /* root is nameless */
 989                                 printf("%s%s {\n",
 990                                         &tabs[MAX_LEVEL - level], pathp);
 991                         }
 992                         level++;
 993                         if (level >= MAX_LEVEL) {
 994                                 printf("Nested too deep, aborting.\n");
 995                                 return 1;
 996                         }
 997                         break;
 998                 case FDT_END_NODE:
 999                         level--;
1000                         if (level <= depth)
1001                                 printf("%s};\n", &tabs[MAX_LEVEL - level]);
1002                         if (level == 0) {
1003                                 level = -1;             /* exit the loop */
1004                         }
1005                         break;
1006                 case FDT_PROP:
1007                         fdt_prop = fdt_offset_ptr(working_fdt, nodeoffset,
1008                                         sizeof(*fdt_prop));
1009                         pathp    = fdt_string(working_fdt,
1010                                         fdt32_to_cpu(fdt_prop->nameoff));
1011                         len      = fdt32_to_cpu(fdt_prop->len);
1012                         nodep    = fdt_prop->data;
1013                         if (len < 0) {
1014                                 printf ("libfdt fdt_getprop(): %s\n",
1015                                         fdt_strerror(len));
1016                                 return 1;
1017                         } else if (len == 0) {
1018                                 /* the property has no value */
1019                                 if (level <= depth)
1020                                         printf("%s%s;\n",
1021                                                 &tabs[MAX_LEVEL - level],
1022                                                 pathp);
1023                         } else {
1024                                 if (level <= depth) {
1025                                         printf("%s%s = ",
1026                                                 &tabs[MAX_LEVEL - level],
1027                                                 pathp);
1028                                         print_data (nodep, len);
1029                                         printf(";\n");
1030                                 }
1031                         }
1032                         break;
1033                 case FDT_NOP:
1034                         printf("%s/* NOP */\n", &tabs[MAX_LEVEL - level]);
1035                         break;
1036                 case FDT_END:
1037                         return 1;
1038                 default:
1039                         if (level <= depth)
1040                                 printf("Unknown tag 0x%08X\n", tag);
1041                         return 1;
1042                 }
1043                 nodeoffset = nextoffset;
1044         }
1045         return 0;
1046 }
1047
1048 /********************************************************************/
1049 #ifdef CONFIG_SYS_LONGHELP
1050 static char fdt_help_text[] =
1051         "addr [-c]  <addr> [<length>]   - Set the [control] fdt location to <addr>\n"
1052 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1053         "fdt apply <addr>                    - Apply overlay to the DT\n"
1054 #endif
1055 #ifdef CONFIG_OF_BOARD_SETUP
1056         "fdt boardsetup                      - Do board-specific set up\n"
1057 #endif
1058 #ifdef CONFIG_OF_SYSTEM_SETUP
1059         "fdt systemsetup                     - Do system-specific set up\n"
1060 #endif
1061         "fdt move   <fdt> <newaddr> <length> - Copy the fdt to <addr> and make it active\n"
1062         "fdt resize [<extrasize>]            - Resize fdt to size + padding to 4k addr + some optional <extrasize> if needed\n"
1063         "fdt print  <path> [<prop>]          - Recursive print starting at <path>\n"
1064         "fdt list   <path> [<prop>]          - Print one level starting at <path>\n"
1065         "fdt get value <var> <path> <prop>   - Get <property> and store in <var>\n"
1066         "fdt get name <var> <path> <index>   - Get name of node <index> and store in <var>\n"
1067         "fdt get addr <var> <path> <prop>    - Get start address of <property> and store in <var>\n"
1068         "fdt get size <var> <path> [<prop>]  - Get size of [<property>] or num nodes and store in <var>\n"
1069         "fdt set    <path> <prop> [<val>]    - Set <property> [to <val>]\n"
1070         "fdt mknode <path> <node>            - Create a new node after <path>\n"
1071         "fdt rm     <path> [<prop>]          - Delete the node or <property>\n"
1072         "fdt header                          - Display header info\n"
1073         "fdt bootcpu <id>                    - Set boot cpuid\n"
1074         "fdt memory <addr> <size>            - Add/Update memory node\n"
1075         "fdt rsvmem print                    - Show current mem reserves\n"
1076         "fdt rsvmem add <addr> <size>        - Add a mem reserve\n"
1077         "fdt rsvmem delete <index>           - Delete a mem reserves\n"
1078         "fdt chosen [<start> <end>]          - Add/update the /chosen branch in the tree\n"
1079         "                                        <start>/<end> - initrd start/end addr\n"
1080 #if defined(CONFIG_FIT_SIGNATURE)
1081         "fdt checksign [<addr>]              - check FIT signature\n"
1082         "                                        <start> - addr of key blob\n"
1083         "                                                  default gd->fdt_blob\n"
1084 #endif
1085         "NOTE: Dereference aliases by omitting the leading '/', "
1086                 "e.g. fdt print ethernet0.";
1087 #endif
1088
1089 U_BOOT_CMD(
1090         fdt,    255,    0,      do_fdt,
1091         "flattened device tree utility commands", fdt_help_text
1092 );