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