3 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
4 * Based on code written by:
5 * Pantelis Antoniou <pantelis.antoniou@gmail.com> and
6 * Matthew McClintock <msm@freescale.com>
8 * SPDX-License-Identifier: GPL-2.0+
13 #include <linux/ctype.h>
14 #include <linux/types.h>
15 #include <asm/global_data.h>
17 #include <fdt_support.h>
20 #define MAX_LEVEL 32 /* how deeply nested we will go */
21 #define SCRATCHPAD 1024 /* bytes of scratchpad memory */
22 #ifndef CONFIG_CMD_FDT_MAX_DUMP
23 #define CONFIG_CMD_FDT_MAX_DUMP 64
27 * Global data (for the gd->bd)
29 DECLARE_GLOBAL_DATA_PTR;
31 static int fdt_valid(struct fdt_header **blobp);
32 static int fdt_parse_prop(char *const*newval, int count, char *data, int *len);
33 static int fdt_print(const char *pathp, char *prop, int depth);
34 static int is_printable_string(const void *data, int len);
37 * The working_fdt points to our working flattened device tree.
39 struct fdt_header *working_fdt;
41 void set_working_fdt_addr(void *addr)
45 buf = map_sysmem((ulong)addr, 0);
47 setenv_addr("fdtaddr", addr);
51 * Get a value from the fdt and format it to be set in the environment
53 static int fdt_value_setenv(const void *nodep, int len, const char *var)
55 if (is_printable_string(nodep, len))
56 setenv(var, (void *)nodep);
60 sprintf(buf, "0x%08X", *(uint32_t *)nodep);
62 } else if (len%4 == 0 && len <= 20) {
63 /* Needed to print things like sha1 hashes. */
67 for (i = 0; i < len; i += sizeof(unsigned int))
68 sprintf(buf + (i * 2), "%08x",
69 *(unsigned int *)(nodep + i));
72 printf("error: unprintable value\n");
79 * Flattened Device Tree command, see the help for parameter definitions.
81 static int do_fdt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
87 * Set the address of the fdt
89 if (argv[1][0] == 'a') {
92 struct fdt_header *blob;
94 * Set the address [and length] of the fdt.
98 /* Temporary #ifdef - some archs don't have fdt_blob yet */
99 #ifdef CONFIG_OF_CONTROL
100 if (argc && !strcmp(*argv, "-c")) {
108 blob = (struct fdt_header *)gd->fdt_blob;
111 if (!blob || !fdt_valid(&blob))
113 printf("The address of the fdt is %#08lx\n",
114 control ? (ulong)blob :
115 getenv_hex("fdtaddr", 0));
119 addr = simple_strtoul(argv[0], NULL, 16);
120 blob = map_sysmem(addr, 0);
121 if (!fdt_valid(&blob))
126 set_working_fdt_addr(blob);
132 * Optional new length
134 len = simple_strtoul(argv[1], NULL, 16);
135 if (len < fdt_totalsize(blob)) {
136 printf ("New length %d < existing length %d, "
138 len, fdt_totalsize(blob));
141 * Open in place with a new length.
143 err = fdt_open_into(blob, blob, len);
145 printf ("libfdt fdt_open_into(): %s\n",
151 return CMD_RET_SUCCESS;
156 "No FDT memory address configured. Please configure\n"
157 "the FDT address via \"fdt addr <address>\" command.\n"
159 return CMD_RET_FAILURE;
163 * Move the working_fdt
165 if (strncmp(argv[1], "mo", 2) == 0) {
166 struct fdt_header *newaddr;
171 return CMD_RET_USAGE;
174 * Set the address and length of the fdt.
176 working_fdt = (struct fdt_header *)simple_strtoul(argv[2], NULL, 16);
177 if (!fdt_valid(&working_fdt))
180 newaddr = (struct fdt_header *)simple_strtoul(argv[3],NULL,16);
183 * If the user specifies a length, use that. Otherwise use the
187 len = fdt_totalsize(working_fdt);
189 len = simple_strtoul(argv[4], NULL, 16);
190 if (len < fdt_totalsize(working_fdt)) {
191 printf ("New length 0x%X < existing length "
193 len, fdt_totalsize(working_fdt));
199 * Copy to the new location.
201 err = fdt_open_into(working_fdt, newaddr, len);
203 printf ("libfdt fdt_open_into(): %s\n",
207 working_fdt = newaddr;
212 } else if (strncmp(argv[1], "mk", 2) == 0) {
213 char *pathp; /* path */
214 char *nodep; /* new node to add */
215 int nodeoffset; /* node offset from libfdt */
219 * Parameters: Node path, new node to be appended to the path.
222 return CMD_RET_USAGE;
227 nodeoffset = fdt_path_offset (working_fdt, pathp);
228 if (nodeoffset < 0) {
230 * Not found or something else bad happened.
232 printf ("libfdt fdt_path_offset() returned %s\n",
233 fdt_strerror(nodeoffset));
236 err = fdt_add_subnode(working_fdt, nodeoffset, nodep);
238 printf ("libfdt fdt_add_subnode(): %s\n",
244 * Set the value of a property in the working_fdt.
246 } else if (argv[1][0] == 's') {
247 char *pathp; /* path */
248 char *prop; /* property */
249 int nodeoffset; /* node offset from libfdt */
250 static char data[SCRATCHPAD]; /* storage for the property */
251 int len; /* new length of the property */
252 int ret; /* return value */
255 * Parameters: Node path, property, optional value.
258 return CMD_RET_USAGE;
265 ret = fdt_parse_prop(&argv[4], argc - 4, data, &len);
270 nodeoffset = fdt_path_offset (working_fdt, pathp);
271 if (nodeoffset < 0) {
273 * Not found or something else bad happened.
275 printf ("libfdt fdt_path_offset() returned %s\n",
276 fdt_strerror(nodeoffset));
280 ret = fdt_setprop(working_fdt, nodeoffset, prop, data, len);
282 printf ("libfdt fdt_setprop(): %s\n", fdt_strerror(ret));
286 /********************************************************************
287 * Get the value of a property in the working_fdt.
288 ********************************************************************/
289 } else if (argv[1][0] == 'g') {
290 char *subcmd; /* sub-command */
291 char *pathp; /* path */
292 char *prop; /* property */
293 char *var; /* variable to store result */
294 int nodeoffset; /* node offset from libfdt */
295 const void *nodep; /* property node pointer */
296 int len = 0; /* new length of the property */
299 * Parameters: Node path, property, optional value.
302 return CMD_RET_USAGE;
306 if (argc < 6 && subcmd[0] != 's')
307 return CMD_RET_USAGE;
313 nodeoffset = fdt_path_offset(working_fdt, pathp);
314 if (nodeoffset < 0) {
316 * Not found or something else bad happened.
318 printf("libfdt fdt_path_offset() returned %s\n",
319 fdt_strerror(nodeoffset));
323 if (subcmd[0] == 'n' || (subcmd[0] == 's' && argc == 5)) {
325 int startDepth = fdt_node_depth(
326 working_fdt, nodeoffset);
327 int curDepth = startDepth;
329 int nextNodeOffset = fdt_next_node(
330 working_fdt, nodeoffset, &curDepth);
332 if (subcmd[0] == 'n')
333 reqIndex = simple_strtoul(argv[5], NULL, 16);
335 while (curDepth > startDepth) {
336 if (curDepth == startDepth + 1)
338 if (subcmd[0] == 'n' && curIndex == reqIndex) {
339 const char *nodeName = fdt_get_name(
340 working_fdt, nextNodeOffset, NULL);
342 setenv(var, (char *)nodeName);
345 nextNodeOffset = fdt_next_node(
346 working_fdt, nextNodeOffset, &curDepth);
347 if (nextNodeOffset < 0)
350 if (subcmd[0] == 's') {
351 /* get the num nodes at this level */
352 setenv_ulong(var, curIndex + 1);
354 /* node index not found */
355 printf("libfdt node not found\n");
360 working_fdt, nodeoffset, prop, &len);
362 /* no property value */
365 } else if (len > 0) {
366 if (subcmd[0] == 'v') {
369 ret = fdt_value_setenv(nodep, len, var);
372 } else if (subcmd[0] == 'a') {
376 sprintf(buf, "0x%p", nodep);
378 } else if (subcmd[0] == 's') {
382 sprintf(buf, "0x%08X", len);
385 return CMD_RET_USAGE;
388 printf("libfdt fdt_getprop(): %s\n",
395 * Print (recursive) / List (single level)
397 } else if ((argv[1][0] == 'p') || (argv[1][0] == 'l')) {
398 int depth = MAX_LEVEL; /* how deep to print */
399 char *pathp; /* path */
400 char *prop; /* property */
401 int ret; /* return value */
402 static char root[2] = "/";
405 * list is an alias for print, but limited to 1 level
407 if (argv[1][0] == 'l') {
412 * Get the starting path. The root node is an oddball,
413 * the offset is zero and has no name.
424 ret = fdt_print(pathp, prop, depth);
429 * Remove a property/node
431 } else if (strncmp(argv[1], "rm", 2) == 0) {
432 int nodeoffset; /* node offset from libfdt */
436 * Get the path. The root node is an oddball, the offset
437 * is zero and has no name.
439 nodeoffset = fdt_path_offset (working_fdt, argv[2]);
440 if (nodeoffset < 0) {
442 * Not found or something else bad happened.
444 printf ("libfdt fdt_path_offset() returned %s\n",
445 fdt_strerror(nodeoffset));
449 * Do the delete. A fourth parameter means delete a property,
450 * otherwise delete the node.
453 err = fdt_delprop(working_fdt, nodeoffset, argv[3]);
455 printf("libfdt fdt_delprop(): %s\n",
460 err = fdt_del_node(working_fdt, nodeoffset);
462 printf("libfdt fdt_del_node(): %s\n",
469 * Display header info
471 } else if (argv[1][0] == 'h') {
472 u32 version = fdt_version(working_fdt);
473 printf("magic:\t\t\t0x%x\n", fdt_magic(working_fdt));
474 printf("totalsize:\t\t0x%x (%d)\n", fdt_totalsize(working_fdt),
475 fdt_totalsize(working_fdt));
476 printf("off_dt_struct:\t\t0x%x\n",
477 fdt_off_dt_struct(working_fdt));
478 printf("off_dt_strings:\t\t0x%x\n",
479 fdt_off_dt_strings(working_fdt));
480 printf("off_mem_rsvmap:\t\t0x%x\n",
481 fdt_off_mem_rsvmap(working_fdt));
482 printf("version:\t\t%d\n", version);
483 printf("last_comp_version:\t%d\n",
484 fdt_last_comp_version(working_fdt));
486 printf("boot_cpuid_phys:\t0x%x\n",
487 fdt_boot_cpuid_phys(working_fdt));
489 printf("size_dt_strings:\t0x%x\n",
490 fdt_size_dt_strings(working_fdt));
492 printf("size_dt_struct:\t\t0x%x\n",
493 fdt_size_dt_struct(working_fdt));
494 printf("number mem_rsv:\t\t0x%x\n",
495 fdt_num_mem_rsv(working_fdt));
501 } else if (strncmp(argv[1], "boo", 3) == 0) {
502 unsigned long tmp = simple_strtoul(argv[2], NULL, 16);
503 fdt_set_boot_cpuid_phys(working_fdt, tmp);
508 } else if (strncmp(argv[1], "me", 2) == 0) {
511 addr = simple_strtoull(argv[2], NULL, 16);
512 size = simple_strtoull(argv[3], NULL, 16);
513 err = fdt_fixup_memory(working_fdt, addr, size);
518 * mem reserve commands
520 } else if (strncmp(argv[1], "rs", 2) == 0) {
521 if (argv[2][0] == 'p') {
523 int total = fdt_num_mem_rsv(working_fdt);
525 printf("index\t\t start\t\t size\n");
526 printf("-------------------------------"
527 "-----------------\n");
528 for (j = 0; j < total; j++) {
529 err = fdt_get_mem_rsv(working_fdt, j, &addr, &size);
531 printf("libfdt fdt_get_mem_rsv(): %s\n",
535 printf(" %x\t%08x%08x\t%08x%08x\n", j,
537 (u32)(addr & 0xffffffff),
539 (u32)(size & 0xffffffff));
541 } else if (argv[2][0] == 'a') {
544 addr = simple_strtoull(argv[3], NULL, 16);
545 size = simple_strtoull(argv[4], NULL, 16);
546 err = fdt_add_mem_rsv(working_fdt, addr, size);
549 printf("libfdt fdt_add_mem_rsv(): %s\n",
553 } else if (argv[2][0] == 'd') {
554 unsigned long idx = simple_strtoul(argv[3], NULL, 16);
555 int err = fdt_del_mem_rsv(working_fdt, idx);
558 printf("libfdt fdt_del_mem_rsv(): %s\n",
563 /* Unrecognized command */
564 return CMD_RET_USAGE;
567 #ifdef CONFIG_OF_BOARD_SETUP
568 /* Call the board-specific fixup routine */
569 else if (strncmp(argv[1], "boa", 3) == 0)
570 ft_board_setup(working_fdt, gd->bd);
572 /* Create a chosen node */
573 else if (argv[1][0] == 'c') {
574 unsigned long initrd_start = 0, initrd_end = 0;
576 if ((argc != 2) && (argc != 4))
577 return CMD_RET_USAGE;
580 initrd_start = simple_strtoul(argv[2], NULL, 16);
581 initrd_end = simple_strtoul(argv[3], NULL, 16);
584 fdt_chosen(working_fdt, 1);
585 fdt_initrd(working_fdt, initrd_start, initrd_end, 1);
588 else if (strncmp(argv[1], "re", 2) == 0) {
589 fdt_resize(working_fdt);
592 /* Unrecognized command */
593 return CMD_RET_USAGE;
599 /****************************************************************************/
602 * fdt_valid() - Check if an FDT is valid. If not, change it to NULL
604 * @blobp: Pointer to FDT pointer
605 * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL)
607 static int fdt_valid(struct fdt_header **blobp)
609 const void *blob = *blobp;
613 printf ("The address of the fdt is invalid (NULL).\n");
617 err = fdt_check_header(blob);
619 return 1; /* valid */
622 printf("libfdt fdt_check_header(): %s", fdt_strerror(err));
624 * Be more informative on bad version.
626 if (err == -FDT_ERR_BADVERSION) {
627 if (fdt_version(blob) <
628 FDT_FIRST_SUPPORTED_VERSION) {
629 printf (" - too old, fdt %d < %d",
631 FDT_FIRST_SUPPORTED_VERSION);
633 if (fdt_last_comp_version(blob) >
634 FDT_LAST_SUPPORTED_VERSION) {
635 printf (" - too new, fdt %d > %d",
637 FDT_LAST_SUPPORTED_VERSION);
647 /****************************************************************************/
650 * Parse the user's input, partially heuristic. Valid formats:
651 * <0x00112233 4 05> - an array of cells. Numbers follow standard
653 * [00 11 22 .. nn] - byte stream
654 * "string" - If the the value doesn't start with "<" or "[", it is
655 * treated as a string. Note that the quotes are
656 * stripped by the parser before we get the string.
657 * newval: An array of strings containing the new property as specified
658 * on the command line
659 * count: The number of strings in the array
660 * data: A bytestream to be placed in the property
661 * len: The length of the resulting bytestream
663 static int fdt_parse_prop(char * const *newval, int count, char *data, int *len)
665 char *cp; /* temporary char pointer */
666 char *newp; /* temporary newval char pointer */
667 unsigned long tmp; /* holds converted values */
673 /* An array of cells */
676 while ((*newp != '>') && (stridx < count)) {
678 * Keep searching until we find that last ">"
679 * That way users don't have to escape the spaces
682 newp = newval[++stridx];
687 tmp = simple_strtoul(cp, &newp, 0);
688 *(__be32 *)data = __cpu_to_be32(tmp);
692 /* If the ptr didn't advance, something went wrong */
693 if ((newp - cp) <= 0) {
694 printf("Sorry, I could not convert \"%s\"\n",
704 printf("Unexpected character '%c'\n", *newp);
707 } else if (*newp == '[') {
709 * Byte stream. Convert the values.
712 while ((stridx < count) && (*newp != ']')) {
716 newp = newval[++stridx];
719 if (!isxdigit(*newp))
721 tmp = simple_strtoul(newp, &newp, 16);
722 *data++ = tmp & 0xFF;
726 printf("Unexpected character '%c'\n", *newp);
731 * Assume it is one or more strings. Copy it into our
732 * data area for convenience (including the
733 * terminating '\0's).
735 while (stridx < count) {
736 size_t length = strlen(newp) + 1;
740 newp = newval[++stridx];
746 /****************************************************************************/
749 * Heuristic to guess if this is a string or concatenated strings.
752 static int is_printable_string(const void *data, int len)
754 const char *s = data;
756 /* zero length is not */
760 /* must terminate with zero or '\n' */
761 if (s[len - 1] != '\0' && s[len - 1] != '\n')
764 /* printable or a null byte (concatenated strings) */
765 while (((*s == '\0') || isprint(*s) || isspace(*s)) && (len > 0)) {
767 * If we see a null, there are three possibilities:
768 * 1) If len == 1, it is the end of the string, printable
769 * 2) Next character also a null, not printable.
770 * 3) Next character not a null, continue to check.
782 /* Not the null termination, or not done yet: not printable */
783 if (*s != '\0' || (len != 0))
791 * Print the property in the best format, a heuristic guess. Print as
792 * a string, concatenated strings, a byte, word, double word, or (if all
793 * else fails) it is printed as a stream of bytes.
795 static void print_data(const void *data, int len)
799 /* no data, don't print */
804 * It is a string, but it may have multiple strings (embedded '\0's).
806 if (is_printable_string(data, len)) {
813 j += strlen(data) + 1;
814 data += strlen(data) + 1;
821 if (len > CONFIG_CMD_FDT_MAX_DUMP)
822 printf("* 0x%p [0x%08x]", data, len);
827 for (j = 0, p = data; j < len/4; j++)
828 printf("0x%08x%s", fdt32_to_cpu(p[j]),
829 j < (len/4 - 1) ? " " : "");
832 } else { /* anything else... hexdump */
833 if (len > CONFIG_CMD_FDT_MAX_DUMP)
834 printf("* 0x%p [0x%08x]", data, len);
839 for (j = 0, s = data; j < len; j++)
840 printf("%02x%s", s[j], j < len - 1 ? " " : "");
846 /****************************************************************************/
849 * Recursively print (a portion of) the working_fdt. The depth parameter
850 * determines how deeply nested the fdt is printed.
852 static int fdt_print(const char *pathp, char *prop, int depth)
854 static char tabs[MAX_LEVEL+1] =
855 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"
856 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
857 const void *nodep; /* property node pointer */
858 int nodeoffset; /* node offset from libfdt */
859 int nextoffset; /* next node offset from libfdt */
860 uint32_t tag; /* tag */
861 int len; /* length of the property */
862 int level = 0; /* keep track of nesting level */
863 const struct fdt_property *fdt_prop;
865 nodeoffset = fdt_path_offset (working_fdt, pathp);
866 if (nodeoffset < 0) {
868 * Not found or something else bad happened.
870 printf ("libfdt fdt_path_offset() returned %s\n",
871 fdt_strerror(nodeoffset));
875 * The user passed in a property as well as node path.
876 * Print only the given property and then return.
879 nodep = fdt_getprop (working_fdt, nodeoffset, prop, &len);
881 /* no property value */
882 printf("%s %s\n", pathp, prop);
884 } else if (len > 0) {
885 printf("%s = ", prop);
886 print_data (nodep, len);
890 printf ("libfdt fdt_getprop(): %s\n",
897 * The user passed in a node path and no property,
898 * print the node and all subnodes.
901 tag = fdt_next_tag(working_fdt, nodeoffset, &nextoffset);
904 pathp = fdt_get_name(working_fdt, nodeoffset, NULL);
905 if (level <= depth) {
907 pathp = "/* NULL pointer error */";
909 pathp = "/"; /* root is nameless */
911 &tabs[MAX_LEVEL - level], pathp);
914 if (level >= MAX_LEVEL) {
915 printf("Nested too deep, aborting.\n");
922 printf("%s};\n", &tabs[MAX_LEVEL - level]);
924 level = -1; /* exit the loop */
928 fdt_prop = fdt_offset_ptr(working_fdt, nodeoffset,
930 pathp = fdt_string(working_fdt,
931 fdt32_to_cpu(fdt_prop->nameoff));
932 len = fdt32_to_cpu(fdt_prop->len);
933 nodep = fdt_prop->data;
935 printf ("libfdt fdt_getprop(): %s\n",
938 } else if (len == 0) {
939 /* the property has no value */
942 &tabs[MAX_LEVEL - level],
945 if (level <= depth) {
947 &tabs[MAX_LEVEL - level],
949 print_data (nodep, len);
955 printf("%s/* NOP */\n", &tabs[MAX_LEVEL - level]);
961 printf("Unknown tag 0x%08X\n", tag);
964 nodeoffset = nextoffset;
969 /********************************************************************/
970 #ifdef CONFIG_SYS_LONGHELP
971 static char fdt_help_text[] =
972 "addr [-c] <addr> [<length>] - Set the [control] fdt location to <addr>\n"
973 #ifdef CONFIG_OF_BOARD_SETUP
974 "fdt boardsetup - Do board-specific set up\n"
976 "fdt move <fdt> <newaddr> <length> - Copy the fdt to <addr> and make it active\n"
977 "fdt resize - Resize fdt to size + padding to 4k addr\n"
978 "fdt print <path> [<prop>] - Recursive print starting at <path>\n"
979 "fdt list <path> [<prop>] - Print one level starting at <path>\n"
980 "fdt get value <var> <path> <prop> - Get <property> and store in <var>\n"
981 "fdt get name <var> <path> <index> - Get name of node <index> and store in <var>\n"
982 "fdt get addr <var> <path> <prop> - Get start address of <property> and store in <var>\n"
983 "fdt get size <var> <path> [<prop>] - Get size of [<property>] or num nodes and store in <var>\n"
984 "fdt set <path> <prop> [<val>] - Set <property> [to <val>]\n"
985 "fdt mknode <path> <node> - Create a new node after <path>\n"
986 "fdt rm <path> [<prop>] - Delete the node or <property>\n"
987 "fdt header - Display header info\n"
988 "fdt bootcpu <id> - Set boot cpuid\n"
989 "fdt memory <addr> <size> - Add/Update memory node\n"
990 "fdt rsvmem print - Show current mem reserves\n"
991 "fdt rsvmem add <addr> <size> - Add a mem reserve\n"
992 "fdt rsvmem delete <index> - Delete a mem reserves\n"
993 "fdt chosen [<start> <end>] - Add/update the /chosen branch in the tree\n"
994 " <start>/<end> - initrd start/end addr\n"
995 "NOTE: Dereference aliases by omiting the leading '/', "
996 "e.g. fdt print ethernet0.";
1000 fdt, 255, 0, do_fdt,
1001 "flattened device tree utility commands", fdt_help_text