efi_loader: segfault in efi_clear_os_indications()
[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 = hextoul(argv[0], NULL);
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 = hextoul(argv[1], NULL);
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 *)hextoul(argv[2], NULL);
199                 if (!fdt_valid(&working_fdt))
200                         return 1;
201
202                 newaddr = (struct fdt_header *)hextoul(argv[3], NULL);
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 = hextoul(argv[4], NULL);
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 req_index = -1;
368                         int startDepth = fdt_node_depth(
369                                 working_fdt, nodeoffset);
370                         int curDepth = startDepth;
371                         int cur_index = -1;
372                         int nextNodeOffset = fdt_next_node(
373                                 working_fdt, nodeoffset, &curDepth);
374
375                         if (subcmd[0] == 'n')
376                                 req_index = hextoul(argv[5], NULL);
377
378                         while (curDepth > startDepth) {
379                                 if (curDepth == startDepth + 1)
380                                         cur_index++;
381                                 if (subcmd[0] == 'n' &&
382                                     cur_index == req_index) {
383                                         const char *node_name;
384
385                                         node_name = fdt_get_name(working_fdt,
386                                                                  nextNodeOffset,
387                                                                  NULL);
388                                         env_set(var, node_name);
389                                         return 0;
390                                 }
391                                 nextNodeOffset = fdt_next_node(
392                                         working_fdt, nextNodeOffset, &curDepth);
393                                 if (nextNodeOffset < 0)
394                                         break;
395                         }
396                         if (subcmd[0] == 's') {
397                                 /* get the num nodes at this level */
398                                 env_set_ulong(var, cur_index + 1);
399                         } else {
400                                 /* node index not found */
401                                 printf("libfdt node not found\n");
402                                 return 1;
403                         }
404                 } else {
405                         nodep = fdt_getprop(
406                                 working_fdt, nodeoffset, prop, &len);
407                         if (len == 0) {
408                                 /* no property value */
409                                 env_set(var, "");
410                                 return 0;
411                         } else if (nodep && len > 0) {
412                                 if (subcmd[0] == 'v') {
413                                         int ret;
414
415                                         ret = fdt_value_env_set(nodep, len,
416                                                                 var);
417                                         if (ret != 0)
418                                                 return ret;
419                                 } else if (subcmd[0] == 'a') {
420                                         /* Get address */
421                                         char buf[11];
422
423                                         sprintf(buf, "0x%p", nodep);
424                                         env_set(var, buf);
425                                 } else if (subcmd[0] == 's') {
426                                         /* Get size */
427                                         char buf[11];
428
429                                         sprintf(buf, "0x%08X", len);
430                                         env_set(var, buf);
431                                 } else
432                                         return CMD_RET_USAGE;
433                                 return 0;
434                         } else {
435                                 printf("libfdt fdt_getprop(): %s\n",
436                                         fdt_strerror(len));
437                                 return 1;
438                         }
439                 }
440
441         /*
442          * Print (recursive) / List (single level)
443          */
444         } else if ((argv[1][0] == 'p') || (argv[1][0] == 'l')) {
445                 int depth = MAX_LEVEL;  /* how deep to print */
446                 char *pathp;            /* path */
447                 char *prop;             /* property */
448                 int  ret;               /* return value */
449                 static char root[2] = "/";
450
451                 /*
452                  * list is an alias for print, but limited to 1 level
453                  */
454                 if (argv[1][0] == 'l') {
455                         depth = 1;
456                 }
457
458                 /*
459                  * Get the starting path.  The root node is an oddball,
460                  * the offset is zero and has no name.
461                  */
462                 if (argc == 2)
463                         pathp = root;
464                 else
465                         pathp = argv[2];
466                 if (argc > 3)
467                         prop = argv[3];
468                 else
469                         prop = NULL;
470
471                 ret = fdt_print(pathp, prop, depth);
472                 if (ret != 0)
473                         return ret;
474
475         /*
476          * Remove a property/node
477          */
478         } else if (strncmp(argv[1], "rm", 2) == 0) {
479                 int  nodeoffset;        /* node offset from libfdt */
480                 int  err;
481
482                 /*
483                  * Get the path.  The root node is an oddball, the offset
484                  * is zero and has no name.
485                  */
486                 nodeoffset = fdt_path_offset (working_fdt, argv[2]);
487                 if (nodeoffset < 0) {
488                         /*
489                          * Not found or something else bad happened.
490                          */
491                         printf ("libfdt fdt_path_offset() returned %s\n",
492                                 fdt_strerror(nodeoffset));
493                         return 1;
494                 }
495                 /*
496                  * Do the delete.  A fourth parameter means delete a property,
497                  * otherwise delete the node.
498                  */
499                 if (argc > 3) {
500                         err = fdt_delprop(working_fdt, nodeoffset, argv[3]);
501                         if (err < 0) {
502                                 printf("libfdt fdt_delprop():  %s\n",
503                                         fdt_strerror(err));
504                                 return err;
505                         }
506                 } else {
507                         err = fdt_del_node(working_fdt, nodeoffset);
508                         if (err < 0) {
509                                 printf("libfdt fdt_del_node():  %s\n",
510                                         fdt_strerror(err));
511                                 return err;
512                         }
513                 }
514
515         /*
516          * Display header info
517          */
518         } else if (argv[1][0] == 'h') {
519                 if (argc == 5)
520                         return fdt_get_header_value(argc, argv);
521
522                 u32 version = fdt_version(working_fdt);
523                 printf("magic:\t\t\t0x%x\n", fdt_magic(working_fdt));
524                 printf("totalsize:\t\t0x%x (%d)\n", fdt_totalsize(working_fdt),
525                        fdt_totalsize(working_fdt));
526                 printf("off_dt_struct:\t\t0x%x\n",
527                        fdt_off_dt_struct(working_fdt));
528                 printf("off_dt_strings:\t\t0x%x\n",
529                        fdt_off_dt_strings(working_fdt));
530                 printf("off_mem_rsvmap:\t\t0x%x\n",
531                        fdt_off_mem_rsvmap(working_fdt));
532                 printf("version:\t\t%d\n", version);
533                 printf("last_comp_version:\t%d\n",
534                        fdt_last_comp_version(working_fdt));
535                 if (version >= 2)
536                         printf("boot_cpuid_phys:\t0x%x\n",
537                                 fdt_boot_cpuid_phys(working_fdt));
538                 if (version >= 3)
539                         printf("size_dt_strings:\t0x%x\n",
540                                 fdt_size_dt_strings(working_fdt));
541                 if (version >= 17)
542                         printf("size_dt_struct:\t\t0x%x\n",
543                                 fdt_size_dt_struct(working_fdt));
544                 printf("number mem_rsv:\t\t0x%x\n",
545                        fdt_num_mem_rsv(working_fdt));
546                 printf("\n");
547
548         /*
549          * Set boot cpu id
550          */
551         } else if (strncmp(argv[1], "boo", 3) == 0) {
552                 unsigned long tmp = hextoul(argv[2], NULL);
553                 fdt_set_boot_cpuid_phys(working_fdt, tmp);
554
555         /*
556          * memory command
557          */
558         } else if (strncmp(argv[1], "me", 2) == 0) {
559                 uint64_t addr, size;
560                 int err;
561                 addr = simple_strtoull(argv[2], NULL, 16);
562                 size = simple_strtoull(argv[3], NULL, 16);
563                 err = fdt_fixup_memory(working_fdt, addr, size);
564                 if (err < 0)
565                         return err;
566
567         /*
568          * mem reserve commands
569          */
570         } else if (strncmp(argv[1], "rs", 2) == 0) {
571                 if (argv[2][0] == 'p') {
572                         uint64_t addr, size;
573                         int total = fdt_num_mem_rsv(working_fdt);
574                         int j, err;
575                         printf("index\t\t   start\t\t    size\n");
576                         printf("-------------------------------"
577                                 "-----------------\n");
578                         for (j = 0; j < total; j++) {
579                                 err = fdt_get_mem_rsv(working_fdt, j, &addr, &size);
580                                 if (err < 0) {
581                                         printf("libfdt fdt_get_mem_rsv():  %s\n",
582                                                         fdt_strerror(err));
583                                         return err;
584                                 }
585                                 printf("    %x\t%08x%08x\t%08x%08x\n", j,
586                                         (u32)(addr >> 32),
587                                         (u32)(addr & 0xffffffff),
588                                         (u32)(size >> 32),
589                                         (u32)(size & 0xffffffff));
590                         }
591                 } else if (argv[2][0] == 'a') {
592                         uint64_t addr, size;
593                         int err;
594                         addr = simple_strtoull(argv[3], NULL, 16);
595                         size = simple_strtoull(argv[4], NULL, 16);
596                         err = fdt_add_mem_rsv(working_fdt, addr, size);
597
598                         if (err < 0) {
599                                 printf("libfdt fdt_add_mem_rsv():  %s\n",
600                                         fdt_strerror(err));
601                                 return err;
602                         }
603                 } else if (argv[2][0] == 'd') {
604                         unsigned long idx = hextoul(argv[3], NULL);
605                         int err = fdt_del_mem_rsv(working_fdt, idx);
606
607                         if (err < 0) {
608                                 printf("libfdt fdt_del_mem_rsv():  %s\n",
609                                         fdt_strerror(err));
610                                 return err;
611                         }
612                 } else {
613                         /* Unrecognized command */
614                         return CMD_RET_USAGE;
615                 }
616         }
617 #ifdef CONFIG_OF_BOARD_SETUP
618         /* Call the board-specific fixup routine */
619         else if (strncmp(argv[1], "boa", 3) == 0) {
620                 int err = ft_board_setup(working_fdt, gd->bd);
621
622                 if (err) {
623                         printf("Failed to update board information in FDT: %s\n",
624                                fdt_strerror(err));
625                         return CMD_RET_FAILURE;
626                 }
627 #ifdef CONFIG_ARCH_KEYSTONE
628                 ft_board_setup_ex(working_fdt, gd->bd);
629 #endif
630         }
631 #endif
632         /* Create a chosen node */
633         else if (strncmp(argv[1], "cho", 3) == 0) {
634                 unsigned long initrd_start = 0, initrd_end = 0;
635
636                 if ((argc != 2) && (argc != 4))
637                         return CMD_RET_USAGE;
638
639                 if (argc == 4) {
640                         initrd_start = hextoul(argv[2], NULL);
641                         initrd_end = hextoul(argv[3], NULL);
642                 }
643
644                 fdt_chosen(working_fdt);
645                 fdt_initrd(working_fdt, initrd_start, initrd_end);
646
647 #if defined(CONFIG_FIT_SIGNATURE)
648         } else if (strncmp(argv[1], "che", 3) == 0) {
649                 int cfg_noffset;
650                 int ret;
651                 unsigned long addr;
652                 struct fdt_header *blob;
653
654                 if (!working_fdt)
655                         return CMD_RET_FAILURE;
656
657                 if (argc > 2) {
658                         addr = hextoul(argv[2], NULL);
659                         blob = map_sysmem(addr, 0);
660                 } else {
661                         blob = (struct fdt_header *)gd->fdt_blob;
662                 }
663                 if (!fdt_valid(&blob))
664                         return 1;
665
666                 gd->fdt_blob = blob;
667                 cfg_noffset = fit_conf_get_node(working_fdt, NULL);
668                 if (!cfg_noffset) {
669                         printf("Could not find configuration node: %s\n",
670                                fdt_strerror(cfg_noffset));
671                         return CMD_RET_FAILURE;
672                 }
673
674                 ret = fit_config_verify(working_fdt, cfg_noffset);
675                 if (ret == 0)
676                         return CMD_RET_SUCCESS;
677                 else
678                         return CMD_RET_FAILURE;
679 #endif
680
681         }
682 #ifdef CONFIG_OF_LIBFDT_OVERLAY
683         /* apply an overlay */
684         else if (strncmp(argv[1], "ap", 2) == 0) {
685                 unsigned long addr;
686                 struct fdt_header *blob;
687                 int ret;
688
689                 if (argc != 3)
690                         return CMD_RET_USAGE;
691
692                 if (!working_fdt)
693                         return CMD_RET_FAILURE;
694
695                 addr = hextoul(argv[2], NULL);
696                 blob = map_sysmem(addr, 0);
697                 if (!fdt_valid(&blob))
698                         return CMD_RET_FAILURE;
699
700                 /* apply method prints messages on error */
701                 ret = fdt_overlay_apply_verbose(working_fdt, blob);
702                 if (ret)
703                         return CMD_RET_FAILURE;
704         }
705 #endif
706         /* resize the fdt */
707         else if (strncmp(argv[1], "re", 2) == 0) {
708                 uint extrasize;
709                 if (argc > 2)
710                         extrasize = hextoul(argv[2], NULL);
711                 else
712                         extrasize = 0;
713                 fdt_shrink_to_minimum(working_fdt, extrasize);
714         }
715         else {
716                 /* Unrecognized command */
717                 return CMD_RET_USAGE;
718         }
719
720         return 0;
721 }
722
723 /****************************************************************************/
724
725 /*
726  * Parse the user's input, partially heuristic.  Valid formats:
727  * <0x00112233 4 05>    - an array of cells.  Numbers follow standard
728  *                      C conventions.
729  * [00 11 22 .. nn] - byte stream
730  * "string"     - If the the value doesn't start with "<" or "[", it is
731  *                      treated as a string.  Note that the quotes are
732  *                      stripped by the parser before we get the string.
733  * newval: An array of strings containing the new property as specified
734  *      on the command line
735  * count: The number of strings in the array
736  * data: A bytestream to be placed in the property
737  * len: The length of the resulting bytestream
738  */
739 static int fdt_parse_prop(char * const *newval, int count, char *data, int *len)
740 {
741         char *cp;               /* temporary char pointer */
742         char *newp;             /* temporary newval char pointer */
743         unsigned long tmp;      /* holds converted values */
744         int stridx = 0;
745
746         *len = 0;
747         newp = newval[0];
748
749         /* An array of cells */
750         if (*newp == '<') {
751                 newp++;
752                 while ((*newp != '>') && (stridx < count)) {
753                         /*
754                          * Keep searching until we find that last ">"
755                          * That way users don't have to escape the spaces
756                          */
757                         if (*newp == '\0') {
758                                 newp = newval[++stridx];
759                                 continue;
760                         }
761
762                         cp = newp;
763                         tmp = simple_strtoul(cp, &newp, 0);
764                         if (*cp != '?')
765                                 *(fdt32_t *)data = cpu_to_fdt32(tmp);
766                         else
767                                 newp++;
768
769                         data  += 4;
770                         *len += 4;
771
772                         /* If the ptr didn't advance, something went wrong */
773                         if ((newp - cp) <= 0) {
774                                 printf("Sorry, I could not convert \"%s\"\n",
775                                         cp);
776                                 return 1;
777                         }
778
779                         while (*newp == ' ')
780                                 newp++;
781                 }
782
783                 if (*newp != '>') {
784                         printf("Unexpected character '%c'\n", *newp);
785                         return 1;
786                 }
787         } else if (*newp == '[') {
788                 /*
789                  * Byte stream.  Convert the values.
790                  */
791                 newp++;
792                 while ((stridx < count) && (*newp != ']')) {
793                         while (*newp == ' ')
794                                 newp++;
795                         if (*newp == '\0') {
796                                 newp = newval[++stridx];
797                                 continue;
798                         }
799                         if (!isxdigit(*newp))
800                                 break;
801                         tmp = hextoul(newp, &newp);
802                         *data++ = tmp & 0xFF;
803                         *len    = *len + 1;
804                 }
805                 if (*newp != ']') {
806                         printf("Unexpected character '%c'\n", *newp);
807                         return 1;
808                 }
809         } else {
810                 /*
811                  * Assume it is one or more strings.  Copy it into our
812                  * data area for convenience (including the
813                  * terminating '\0's).
814                  */
815                 while (stridx < count) {
816                         size_t length = strlen(newp) + 1;
817                         strcpy(data, newp);
818                         data += length;
819                         *len += length;
820                         newp = newval[++stridx];
821                 }
822         }
823         return 0;
824 }
825
826 /****************************************************************************/
827
828 /*
829  * Heuristic to guess if this is a string or concatenated strings.
830  */
831
832 static int is_printable_string(const void *data, int len)
833 {
834         const char *s = data;
835
836         /* zero length is not */
837         if (len == 0)
838                 return 0;
839
840         /* must terminate with zero or '\n' */
841         if (s[len - 1] != '\0' && s[len - 1] != '\n')
842                 return 0;
843
844         /* printable or a null byte (concatenated strings) */
845         while (((*s == '\0') || isprint(*s) || isspace(*s)) && (len > 0)) {
846                 /*
847                  * If we see a null, there are three possibilities:
848                  * 1) If len == 1, it is the end of the string, printable
849                  * 2) Next character also a null, not printable.
850                  * 3) Next character not a null, continue to check.
851                  */
852                 if (s[0] == '\0') {
853                         if (len == 1)
854                                 return 1;
855                         if (s[1] == '\0')
856                                 return 0;
857                 }
858                 s++;
859                 len--;
860         }
861
862         /* Not the null termination, or not done yet: not printable */
863         if (*s != '\0' || (len != 0))
864                 return 0;
865
866         return 1;
867 }
868
869
870 /*
871  * Print the property in the best format, a heuristic guess.  Print as
872  * a string, concatenated strings, a byte, word, double word, or (if all
873  * else fails) it is printed as a stream of bytes.
874  */
875 static void print_data(const void *data, int len)
876 {
877         int j;
878         const char *env_max_dump;
879         ulong max_dump = ULONG_MAX;
880
881         /* no data, don't print */
882         if (len == 0)
883                 return;
884
885         env_max_dump = env_get("fdt_max_dump");
886         if (env_max_dump)
887                 max_dump = hextoul(env_max_dump, NULL);
888
889         /*
890          * It is a string, but it may have multiple strings (embedded '\0's).
891          */
892         if (is_printable_string(data, len)) {
893                 puts("\"");
894                 j = 0;
895                 while (j < len) {
896                         if (j > 0)
897                                 puts("\", \"");
898                         puts(data);
899                         j    += strlen(data) + 1;
900                         data += strlen(data) + 1;
901                 }
902                 puts("\"");
903                 return;
904         }
905
906         if ((len %4) == 0) {
907                 if (len > max_dump)
908                         printf("* 0x%p [0x%08x]", data, len);
909                 else {
910                         const __be32 *p;
911
912                         printf("<");
913                         for (j = 0, p = data; j < len/4; j++)
914                                 printf("0x%08x%s", fdt32_to_cpu(p[j]),
915                                         j < (len/4 - 1) ? " " : "");
916                         printf(">");
917                 }
918         } else { /* anything else... hexdump */
919                 if (len > max_dump)
920                         printf("* 0x%p [0x%08x]", data, len);
921                 else {
922                         const u8 *s;
923
924                         printf("[");
925                         for (j = 0, s = data; j < len; j++)
926                                 printf("%02x%s", s[j], j < len - 1 ? " " : "");
927                         printf("]");
928                 }
929         }
930 }
931
932 /****************************************************************************/
933
934 /*
935  * Recursively print (a portion of) the working_fdt.  The depth parameter
936  * determines how deeply nested the fdt is printed.
937  */
938 static int fdt_print(const char *pathp, char *prop, int depth)
939 {
940         static char tabs[MAX_LEVEL+1] =
941                 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"
942                 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
943         const void *nodep;      /* property node pointer */
944         int  nodeoffset;        /* node offset from libfdt */
945         int  nextoffset;        /* next node offset from libfdt */
946         uint32_t tag;           /* tag */
947         int  len;               /* length of the property */
948         int  level = 0;         /* keep track of nesting level */
949         const struct fdt_property *fdt_prop;
950
951         nodeoffset = fdt_path_offset (working_fdt, pathp);
952         if (nodeoffset < 0) {
953                 /*
954                  * Not found or something else bad happened.
955                  */
956                 printf ("libfdt fdt_path_offset() returned %s\n",
957                         fdt_strerror(nodeoffset));
958                 return 1;
959         }
960         /*
961          * The user passed in a property as well as node path.
962          * Print only the given property and then return.
963          */
964         if (prop) {
965                 nodep = fdt_getprop (working_fdt, nodeoffset, prop, &len);
966                 if (len == 0) {
967                         /* no property value */
968                         printf("%s %s\n", pathp, prop);
969                         return 0;
970                 } else if (nodep && len > 0) {
971                         printf("%s = ", prop);
972                         print_data (nodep, len);
973                         printf("\n");
974                         return 0;
975                 } else {
976                         printf ("libfdt fdt_getprop(): %s\n",
977                                 fdt_strerror(len));
978                         return 1;
979                 }
980         }
981
982         /*
983          * The user passed in a node path and no property,
984          * print the node and all subnodes.
985          */
986         while(level >= 0) {
987                 tag = fdt_next_tag(working_fdt, nodeoffset, &nextoffset);
988                 switch(tag) {
989                 case FDT_BEGIN_NODE:
990                         pathp = fdt_get_name(working_fdt, nodeoffset, NULL);
991                         if (level <= depth) {
992                                 if (pathp == NULL)
993                                         pathp = "/* NULL pointer error */";
994                                 if (*pathp == '\0')
995                                         pathp = "/";    /* root is nameless */
996                                 printf("%s%s {\n",
997                                         &tabs[MAX_LEVEL - level], pathp);
998                         }
999                         level++;
1000                         if (level >= MAX_LEVEL) {
1001                                 printf("Nested too deep, aborting.\n");
1002                                 return 1;
1003                         }
1004                         break;
1005                 case FDT_END_NODE:
1006                         level--;
1007                         if (level <= depth)
1008                                 printf("%s};\n", &tabs[MAX_LEVEL - level]);
1009                         if (level == 0) {
1010                                 level = -1;             /* exit the loop */
1011                         }
1012                         break;
1013                 case FDT_PROP:
1014                         fdt_prop = fdt_offset_ptr(working_fdt, nodeoffset,
1015                                         sizeof(*fdt_prop));
1016                         pathp    = fdt_string(working_fdt,
1017                                         fdt32_to_cpu(fdt_prop->nameoff));
1018                         len      = fdt32_to_cpu(fdt_prop->len);
1019                         nodep    = fdt_prop->data;
1020                         if (len < 0) {
1021                                 printf ("libfdt fdt_getprop(): %s\n",
1022                                         fdt_strerror(len));
1023                                 return 1;
1024                         } else if (len == 0) {
1025                                 /* the property has no value */
1026                                 if (level <= depth)
1027                                         printf("%s%s;\n",
1028                                                 &tabs[MAX_LEVEL - level],
1029                                                 pathp);
1030                         } else {
1031                                 if (level <= depth) {
1032                                         printf("%s%s = ",
1033                                                 &tabs[MAX_LEVEL - level],
1034                                                 pathp);
1035                                         print_data (nodep, len);
1036                                         printf(";\n");
1037                                 }
1038                         }
1039                         break;
1040                 case FDT_NOP:
1041                         printf("%s/* NOP */\n", &tabs[MAX_LEVEL - level]);
1042                         break;
1043                 case FDT_END:
1044                         return 1;
1045                 default:
1046                         if (level <= depth)
1047                                 printf("Unknown tag 0x%08X\n", tag);
1048                         return 1;
1049                 }
1050                 nodeoffset = nextoffset;
1051         }
1052         return 0;
1053 }
1054
1055 /********************************************************************/
1056 #ifdef CONFIG_SYS_LONGHELP
1057 static char fdt_help_text[] =
1058         "addr [-c]  <addr> [<length>]   - Set the [control] fdt location to <addr>\n"
1059 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1060         "fdt apply <addr>                    - Apply overlay to the DT\n"
1061 #endif
1062 #ifdef CONFIG_OF_BOARD_SETUP
1063         "fdt boardsetup                      - Do board-specific set up\n"
1064 #endif
1065 #ifdef CONFIG_OF_SYSTEM_SETUP
1066         "fdt systemsetup                     - Do system-specific set up\n"
1067 #endif
1068         "fdt move   <fdt> <newaddr> <length> - Copy the fdt to <addr> and make it active\n"
1069         "fdt resize [<extrasize>]            - Resize fdt to size + padding to 4k addr + some optional <extrasize> if needed\n"
1070         "fdt print  <path> [<prop>]          - Recursive print starting at <path>\n"
1071         "fdt list   <path> [<prop>]          - Print one level starting at <path>\n"
1072         "fdt get value <var> <path> <prop>   - Get <property> and store in <var>\n"
1073         "fdt get name <var> <path> <index>   - Get name of node <index> and store in <var>\n"
1074         "fdt get addr <var> <path> <prop>    - Get start address of <property> and store in <var>\n"
1075         "fdt get size <var> <path> [<prop>]  - Get size of [<property>] or num nodes and store in <var>\n"
1076         "fdt set    <path> <prop> [<val>]    - Set <property> [to <val>]\n"
1077         "fdt mknode <path> <node>            - Create a new node after <path>\n"
1078         "fdt rm     <path> [<prop>]          - Delete the node or <property>\n"
1079         "fdt header [get <var> <member>]     - Display header info\n"
1080         "                                      get - get header member <member> and store it in <var>\n"
1081         "fdt bootcpu <id>                    - Set boot cpuid\n"
1082         "fdt memory <addr> <size>            - Add/Update memory node\n"
1083         "fdt rsvmem print                    - Show current mem reserves\n"
1084         "fdt rsvmem add <addr> <size>        - Add a mem reserve\n"
1085         "fdt rsvmem delete <index>           - Delete a mem reserves\n"
1086         "fdt chosen [<start> <end>]          - Add/update the /chosen branch in the tree\n"
1087         "                                        <start>/<end> - initrd start/end addr\n"
1088 #if defined(CONFIG_FIT_SIGNATURE)
1089         "fdt checksign [<addr>]              - check FIT signature\n"
1090         "                                        <start> - addr of key blob\n"
1091         "                                                  default gd->fdt_blob\n"
1092 #endif
1093         "NOTE: Dereference aliases by omitting the leading '/', "
1094                 "e.g. fdt print ethernet0.";
1095 #endif
1096
1097 U_BOOT_CMD(
1098         fdt,    255,    0,      do_fdt,
1099         "flattened device tree utility commands", fdt_help_text
1100 );