cmd/fdt.c

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