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 * See file CREDITS for list of people who contributed to this
11 * This program is free software; you can redistribute it and/or
12 * modify it under the terms of the GNU General Public License as
13 * published by the Free Software Foundation; either version 2 of
14 * the License, or (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program; if not, write to the Free Software
23 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 #include <linux/ctype.h>
30 #include <linux/types.h>
31 #include <asm/global_data.h>
33 #include <fdt_support.h>
35 #define MAX_LEVEL 32 /* how deeply nested we will go */
36 #define SCRATCHPAD 1024 /* bytes of scratchpad memory */
37 #ifndef CONFIG_CMD_FDT_MAX_DUMP
38 #define CONFIG_CMD_FDT_MAX_DUMP 64
42 * Global data (for the gd->bd)
44 DECLARE_GLOBAL_DATA_PTR;
46 static int fdt_valid(struct fdt_header **blobp);
47 static int fdt_parse_prop(char *const*newval, int count, char *data, int *len);
48 static int fdt_print(const char *pathp, char *prop, int depth);
49 static int is_printable_string(const void *data, int len);
52 * The working_fdt points to our working flattened device tree.
54 struct fdt_header *working_fdt;
56 void set_working_fdt_addr(void *addr)
59 setenv_addr("fdtaddr", addr);
63 * Get a value from the fdt and format it to be set in the environment
65 static int fdt_value_setenv(const void *nodep, int len, const char *var)
67 if (is_printable_string(nodep, len))
68 setenv(var, (void *)nodep);
72 sprintf(buf, "0x%08X", *(uint32_t *)nodep);
74 } else if (len%4 == 0 && len <= 20) {
75 /* Needed to print things like sha1 hashes. */
79 for (i = 0; i < len; i += sizeof(unsigned int))
80 sprintf(buf + (i * 2), "%08x",
81 *(unsigned int *)(nodep + i));
84 printf("error: unprintable value\n");
91 * Flattened Device Tree command, see the help for parameter definitions.
93 static int do_fdt(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
99 * Set the address of the fdt
101 if (argv[1][0] == 'a') {
104 struct fdt_header *blob;
106 * Set the address [and length] of the fdt.
110 /* Temporary #ifdef - some archs don't have fdt_blob yet */
111 #ifdef CONFIG_OF_CONTROL
112 if (argc && !strcmp(*argv, "-c")) {
120 blob = (struct fdt_header *)gd->fdt_blob;
123 if (!blob || !fdt_valid(&blob))
125 printf("The address of the fdt is %#08lx\n",
126 control ? (ulong)blob :
127 getenv_hex("fdtaddr", 0));
131 addr = simple_strtoul(argv[0], NULL, 16);
132 blob = (struct fdt_header *)addr;
133 if (!fdt_valid(&blob))
138 set_working_fdt_addr((void *)addr);
144 * Optional new length
146 len = simple_strtoul(argv[1], NULL, 16);
147 if (len < fdt_totalsize(blob)) {
148 printf ("New length %d < existing length %d, "
150 len, fdt_totalsize(blob));
153 * Open in place with a new length.
155 err = fdt_open_into(blob, blob, len);
157 printf ("libfdt fdt_open_into(): %s\n",
163 return CMD_RET_SUCCESS;
168 "No FDT memory address configured. Please configure\n"
169 "the FDT address via \"fdt addr <address>\" command.\n"
171 return CMD_RET_FAILURE;
175 * Move the working_fdt
177 if (strncmp(argv[1], "mo", 2) == 0) {
178 struct fdt_header *newaddr;
183 return CMD_RET_USAGE;
186 * Set the address and length of the fdt.
188 working_fdt = (struct fdt_header *)simple_strtoul(argv[2], NULL, 16);
189 if (!fdt_valid(&working_fdt))
192 newaddr = (struct fdt_header *)simple_strtoul(argv[3],NULL,16);
195 * If the user specifies a length, use that. Otherwise use the
199 len = fdt_totalsize(working_fdt);
201 len = simple_strtoul(argv[4], NULL, 16);
202 if (len < fdt_totalsize(working_fdt)) {
203 printf ("New length 0x%X < existing length "
205 len, fdt_totalsize(working_fdt));
211 * Copy to the new location.
213 err = fdt_open_into(working_fdt, newaddr, len);
215 printf ("libfdt fdt_open_into(): %s\n",
219 working_fdt = newaddr;
224 } else if (strncmp(argv[1], "mk", 2) == 0) {
225 char *pathp; /* path */
226 char *nodep; /* new node to add */
227 int nodeoffset; /* node offset from libfdt */
231 * Parameters: Node path, new node to be appended to the path.
234 return CMD_RET_USAGE;
239 nodeoffset = fdt_path_offset (working_fdt, pathp);
240 if (nodeoffset < 0) {
242 * Not found or something else bad happened.
244 printf ("libfdt fdt_path_offset() returned %s\n",
245 fdt_strerror(nodeoffset));
248 err = fdt_add_subnode(working_fdt, nodeoffset, nodep);
250 printf ("libfdt fdt_add_subnode(): %s\n",
256 * Set the value of a property in the working_fdt.
258 } else if (argv[1][0] == 's') {
259 char *pathp; /* path */
260 char *prop; /* property */
261 int nodeoffset; /* node offset from libfdt */
262 static char data[SCRATCHPAD]; /* storage for the property */
263 int len; /* new length of the property */
264 int ret; /* return value */
267 * Parameters: Node path, property, optional value.
270 return CMD_RET_USAGE;
277 ret = fdt_parse_prop(&argv[4], argc - 4, data, &len);
282 nodeoffset = fdt_path_offset (working_fdt, pathp);
283 if (nodeoffset < 0) {
285 * Not found or something else bad happened.
287 printf ("libfdt fdt_path_offset() returned %s\n",
288 fdt_strerror(nodeoffset));
292 ret = fdt_setprop(working_fdt, nodeoffset, prop, data, len);
294 printf ("libfdt fdt_setprop(): %s\n", fdt_strerror(ret));
298 /********************************************************************
299 * Get the value of a property in the working_fdt.
300 ********************************************************************/
301 } else if (argv[1][0] == 'g') {
302 char *subcmd; /* sub-command */
303 char *pathp; /* path */
304 char *prop; /* property */
305 char *var; /* variable to store result */
306 int nodeoffset; /* node offset from libfdt */
307 const void *nodep; /* property node pointer */
308 int len = 0; /* new length of the property */
311 * Parameters: Node path, property, optional value.
314 return CMD_RET_USAGE;
318 if (argc < 6 && subcmd[0] != 's')
319 return CMD_RET_USAGE;
325 nodeoffset = fdt_path_offset(working_fdt, pathp);
326 if (nodeoffset < 0) {
328 * Not found or something else bad happened.
330 printf("libfdt fdt_path_offset() returned %s\n",
331 fdt_strerror(nodeoffset));
335 if (subcmd[0] == 'n' || (subcmd[0] == 's' && argc == 5)) {
337 int startDepth = fdt_node_depth(
338 working_fdt, nodeoffset);
339 int curDepth = startDepth;
341 int nextNodeOffset = fdt_next_node(
342 working_fdt, nodeoffset, &curDepth);
344 if (subcmd[0] == 'n')
345 reqIndex = simple_strtoul(argv[5], NULL, 16);
347 while (curDepth > startDepth) {
348 if (curDepth == startDepth + 1)
350 if (subcmd[0] == 'n' && curIndex == reqIndex) {
351 const char *nodeName = fdt_get_name(
352 working_fdt, nextNodeOffset, NULL);
354 setenv(var, (char *)nodeName);
357 nextNodeOffset = fdt_next_node(
358 working_fdt, nextNodeOffset, &curDepth);
359 if (nextNodeOffset < 0)
362 if (subcmd[0] == 's') {
363 /* get the num nodes at this level */
364 setenv_ulong(var, curIndex + 1);
366 /* node index not found */
367 printf("libfdt node not found\n");
372 working_fdt, nodeoffset, prop, &len);
374 /* no property value */
377 } else if (len > 0) {
378 if (subcmd[0] == 'v') {
381 ret = fdt_value_setenv(nodep, len, var);
384 } else if (subcmd[0] == 'a') {
388 sprintf(buf, "0x%p", nodep);
390 } else if (subcmd[0] == 's') {
394 sprintf(buf, "0x%08X", len);
397 return CMD_RET_USAGE;
400 printf("libfdt fdt_getprop(): %s\n",
407 * Print (recursive) / List (single level)
409 } else if ((argv[1][0] == 'p') || (argv[1][0] == 'l')) {
410 int depth = MAX_LEVEL; /* how deep to print */
411 char *pathp; /* path */
412 char *prop; /* property */
413 int ret; /* return value */
414 static char root[2] = "/";
417 * list is an alias for print, but limited to 1 level
419 if (argv[1][0] == 'l') {
424 * Get the starting path. The root node is an oddball,
425 * the offset is zero and has no name.
436 ret = fdt_print(pathp, prop, depth);
441 * Remove a property/node
443 } else if (strncmp(argv[1], "rm", 2) == 0) {
444 int nodeoffset; /* node offset from libfdt */
448 * Get the path. The root node is an oddball, the offset
449 * is zero and has no name.
451 nodeoffset = fdt_path_offset (working_fdt, argv[2]);
452 if (nodeoffset < 0) {
454 * Not found or something else bad happened.
456 printf ("libfdt fdt_path_offset() returned %s\n",
457 fdt_strerror(nodeoffset));
461 * Do the delete. A fourth parameter means delete a property,
462 * otherwise delete the node.
465 err = fdt_delprop(working_fdt, nodeoffset, argv[3]);
467 printf("libfdt fdt_delprop(): %s\n",
472 err = fdt_del_node(working_fdt, nodeoffset);
474 printf("libfdt fdt_del_node(): %s\n",
481 * Display header info
483 } else if (argv[1][0] == 'h') {
484 u32 version = fdt_version(working_fdt);
485 printf("magic:\t\t\t0x%x\n", fdt_magic(working_fdt));
486 printf("totalsize:\t\t0x%x (%d)\n", fdt_totalsize(working_fdt),
487 fdt_totalsize(working_fdt));
488 printf("off_dt_struct:\t\t0x%x\n",
489 fdt_off_dt_struct(working_fdt));
490 printf("off_dt_strings:\t\t0x%x\n",
491 fdt_off_dt_strings(working_fdt));
492 printf("off_mem_rsvmap:\t\t0x%x\n",
493 fdt_off_mem_rsvmap(working_fdt));
494 printf("version:\t\t%d\n", version);
495 printf("last_comp_version:\t%d\n",
496 fdt_last_comp_version(working_fdt));
498 printf("boot_cpuid_phys:\t0x%x\n",
499 fdt_boot_cpuid_phys(working_fdt));
501 printf("size_dt_strings:\t0x%x\n",
502 fdt_size_dt_strings(working_fdt));
504 printf("size_dt_struct:\t\t0x%x\n",
505 fdt_size_dt_struct(working_fdt));
506 printf("number mem_rsv:\t\t0x%x\n",
507 fdt_num_mem_rsv(working_fdt));
513 } else if (strncmp(argv[1], "boo", 3) == 0) {
514 unsigned long tmp = simple_strtoul(argv[2], NULL, 16);
515 fdt_set_boot_cpuid_phys(working_fdt, tmp);
520 } else if (strncmp(argv[1], "me", 2) == 0) {
523 addr = simple_strtoull(argv[2], NULL, 16);
524 size = simple_strtoull(argv[3], NULL, 16);
525 err = fdt_fixup_memory(working_fdt, addr, size);
530 * mem reserve commands
532 } else if (strncmp(argv[1], "rs", 2) == 0) {
533 if (argv[2][0] == 'p') {
535 int total = fdt_num_mem_rsv(working_fdt);
537 printf("index\t\t start\t\t size\n");
538 printf("-------------------------------"
539 "-----------------\n");
540 for (j = 0; j < total; j++) {
541 err = fdt_get_mem_rsv(working_fdt, j, &addr, &size);
543 printf("libfdt fdt_get_mem_rsv(): %s\n",
547 printf(" %x\t%08x%08x\t%08x%08x\n", j,
549 (u32)(addr & 0xffffffff),
551 (u32)(size & 0xffffffff));
553 } else if (argv[2][0] == 'a') {
556 addr = simple_strtoull(argv[3], NULL, 16);
557 size = simple_strtoull(argv[4], NULL, 16);
558 err = fdt_add_mem_rsv(working_fdt, addr, size);
561 printf("libfdt fdt_add_mem_rsv(): %s\n",
565 } else if (argv[2][0] == 'd') {
566 unsigned long idx = simple_strtoul(argv[3], NULL, 16);
567 int err = fdt_del_mem_rsv(working_fdt, idx);
570 printf("libfdt fdt_del_mem_rsv(): %s\n",
575 /* Unrecognized command */
576 return CMD_RET_USAGE;
579 #ifdef CONFIG_OF_BOARD_SETUP
580 /* Call the board-specific fixup routine */
581 else if (strncmp(argv[1], "boa", 3) == 0)
582 ft_board_setup(working_fdt, gd->bd);
584 /* Create a chosen node */
585 else if (argv[1][0] == 'c') {
586 unsigned long initrd_start = 0, initrd_end = 0;
588 if ((argc != 2) && (argc != 4))
589 return CMD_RET_USAGE;
592 initrd_start = simple_strtoul(argv[2], NULL, 16);
593 initrd_end = simple_strtoul(argv[3], NULL, 16);
596 fdt_chosen(working_fdt, 1);
597 fdt_initrd(working_fdt, initrd_start, initrd_end, 1);
600 else if (strncmp(argv[1], "re", 2) == 0) {
601 fdt_resize(working_fdt);
604 /* Unrecognized command */
605 return CMD_RET_USAGE;
611 /****************************************************************************/
614 * fdt_valid() - Check if an FDT is valid. If not, change it to NULL
616 * @blobp: Pointer to FDT pointer
617 * @return 1 if OK, 0 if bad (in which case *blobp is set to NULL)
619 static int fdt_valid(struct fdt_header **blobp)
621 const void *blob = *blobp;
625 printf ("The address of the fdt is invalid (NULL).\n");
629 err = fdt_check_header(blob);
631 return 1; /* valid */
634 printf("libfdt fdt_check_header(): %s", fdt_strerror(err));
636 * Be more informative on bad version.
638 if (err == -FDT_ERR_BADVERSION) {
639 if (fdt_version(blob) <
640 FDT_FIRST_SUPPORTED_VERSION) {
641 printf (" - too old, fdt %d < %d",
643 FDT_FIRST_SUPPORTED_VERSION);
645 if (fdt_last_comp_version(blob) >
646 FDT_LAST_SUPPORTED_VERSION) {
647 printf (" - too new, fdt %d > %d",
649 FDT_LAST_SUPPORTED_VERSION);
659 /****************************************************************************/
662 * Parse the user's input, partially heuristic. Valid formats:
663 * <0x00112233 4 05> - an array of cells. Numbers follow standard
665 * [00 11 22 .. nn] - byte stream
666 * "string" - If the the value doesn't start with "<" or "[", it is
667 * treated as a string. Note that the quotes are
668 * stripped by the parser before we get the string.
669 * newval: An array of strings containing the new property as specified
670 * on the command line
671 * count: The number of strings in the array
672 * data: A bytestream to be placed in the property
673 * len: The length of the resulting bytestream
675 static int fdt_parse_prop(char * const *newval, int count, char *data, int *len)
677 char *cp; /* temporary char pointer */
678 char *newp; /* temporary newval char pointer */
679 unsigned long tmp; /* holds converted values */
685 /* An array of cells */
688 while ((*newp != '>') && (stridx < count)) {
690 * Keep searching until we find that last ">"
691 * That way users don't have to escape the spaces
694 newp = newval[++stridx];
699 tmp = simple_strtoul(cp, &newp, 0);
700 *(__be32 *)data = __cpu_to_be32(tmp);
704 /* If the ptr didn't advance, something went wrong */
705 if ((newp - cp) <= 0) {
706 printf("Sorry, I could not convert \"%s\"\n",
716 printf("Unexpected character '%c'\n", *newp);
719 } else if (*newp == '[') {
721 * Byte stream. Convert the values.
724 while ((stridx < count) && (*newp != ']')) {
728 newp = newval[++stridx];
731 if (!isxdigit(*newp))
733 tmp = simple_strtoul(newp, &newp, 16);
734 *data++ = tmp & 0xFF;
738 printf("Unexpected character '%c'\n", *newp);
743 * Assume it is one or more strings. Copy it into our
744 * data area for convenience (including the
745 * terminating '\0's).
747 while (stridx < count) {
748 size_t length = strlen(newp) + 1;
752 newp = newval[++stridx];
758 /****************************************************************************/
761 * Heuristic to guess if this is a string or concatenated strings.
764 static int is_printable_string(const void *data, int len)
766 const char *s = data;
768 /* zero length is not */
772 /* must terminate with zero or '\n' */
773 if (s[len - 1] != '\0' && s[len - 1] != '\n')
776 /* printable or a null byte (concatenated strings) */
777 while (((*s == '\0') || isprint(*s) || isspace(*s)) && (len > 0)) {
779 * If we see a null, there are three possibilities:
780 * 1) If len == 1, it is the end of the string, printable
781 * 2) Next character also a null, not printable.
782 * 3) Next character not a null, continue to check.
794 /* Not the null termination, or not done yet: not printable */
795 if (*s != '\0' || (len != 0))
803 * Print the property in the best format, a heuristic guess. Print as
804 * a string, concatenated strings, a byte, word, double word, or (if all
805 * else fails) it is printed as a stream of bytes.
807 static void print_data(const void *data, int len)
811 /* no data, don't print */
816 * It is a string, but it may have multiple strings (embedded '\0's).
818 if (is_printable_string(data, len)) {
825 j += strlen(data) + 1;
826 data += strlen(data) + 1;
833 if (len > CONFIG_CMD_FDT_MAX_DUMP)
834 printf("* 0x%p [0x%08x]", data, len);
839 for (j = 0, p = data; j < len/4; j++)
840 printf("0x%08x%s", fdt32_to_cpu(p[j]),
841 j < (len/4 - 1) ? " " : "");
844 } else { /* anything else... hexdump */
845 if (len > CONFIG_CMD_FDT_MAX_DUMP)
846 printf("* 0x%p [0x%08x]", data, len);
851 for (j = 0, s = data; j < len; j++)
852 printf("%02x%s", s[j], j < len - 1 ? " " : "");
858 /****************************************************************************/
861 * Recursively print (a portion of) the working_fdt. The depth parameter
862 * determines how deeply nested the fdt is printed.
864 static int fdt_print(const char *pathp, char *prop, int depth)
866 static char tabs[MAX_LEVEL+1] =
867 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"
868 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
869 const void *nodep; /* property node pointer */
870 int nodeoffset; /* node offset from libfdt */
871 int nextoffset; /* next node offset from libfdt */
872 uint32_t tag; /* tag */
873 int len; /* length of the property */
874 int level = 0; /* keep track of nesting level */
875 const struct fdt_property *fdt_prop;
877 nodeoffset = fdt_path_offset (working_fdt, pathp);
878 if (nodeoffset < 0) {
880 * Not found or something else bad happened.
882 printf ("libfdt fdt_path_offset() returned %s\n",
883 fdt_strerror(nodeoffset));
887 * The user passed in a property as well as node path.
888 * Print only the given property and then return.
891 nodep = fdt_getprop (working_fdt, nodeoffset, prop, &len);
893 /* no property value */
894 printf("%s %s\n", pathp, prop);
896 } else if (len > 0) {
897 printf("%s = ", prop);
898 print_data (nodep, len);
902 printf ("libfdt fdt_getprop(): %s\n",
909 * The user passed in a node path and no property,
910 * print the node and all subnodes.
913 tag = fdt_next_tag(working_fdt, nodeoffset, &nextoffset);
916 pathp = fdt_get_name(working_fdt, nodeoffset, NULL);
917 if (level <= depth) {
919 pathp = "/* NULL pointer error */";
921 pathp = "/"; /* root is nameless */
923 &tabs[MAX_LEVEL - level], pathp);
926 if (level >= MAX_LEVEL) {
927 printf("Nested too deep, aborting.\n");
934 printf("%s};\n", &tabs[MAX_LEVEL - level]);
936 level = -1; /* exit the loop */
940 fdt_prop = fdt_offset_ptr(working_fdt, nodeoffset,
942 pathp = fdt_string(working_fdt,
943 fdt32_to_cpu(fdt_prop->nameoff));
944 len = fdt32_to_cpu(fdt_prop->len);
945 nodep = fdt_prop->data;
947 printf ("libfdt fdt_getprop(): %s\n",
950 } else if (len == 0) {
951 /* the property has no value */
954 &tabs[MAX_LEVEL - level],
957 if (level <= depth) {
959 &tabs[MAX_LEVEL - level],
961 print_data (nodep, len);
967 printf("%s/* NOP */\n", &tabs[MAX_LEVEL - level]);
973 printf("Unknown tag 0x%08X\n", tag);
976 nodeoffset = nextoffset;
981 /********************************************************************/
982 #ifdef CONFIG_SYS_LONGHELP
983 static char fdt_help_text[] =
984 "addr [-c] <addr> [<length>] - Set the [control] fdt location to <addr>\n"
985 #ifdef CONFIG_OF_BOARD_SETUP
986 "fdt boardsetup - Do board-specific set up\n"
988 "fdt move <fdt> <newaddr> <length> - Copy the fdt to <addr> and make it active\n"
989 "fdt resize - Resize fdt to size + padding to 4k addr\n"
990 "fdt print <path> [<prop>] - Recursive print starting at <path>\n"
991 "fdt list <path> [<prop>] - Print one level starting at <path>\n"
992 "fdt get value <var> <path> <prop> - Get <property> and store in <var>\n"
993 "fdt get name <var> <path> <index> - Get name of node <index> and store in <var>\n"
994 "fdt get addr <var> <path> <prop> - Get start address of <property> and store in <var>\n"
995 "fdt get size <var> <path> [<prop>] - Get size of [<property>] or num nodes and store in <var>\n"
996 "fdt set <path> <prop> [<val>] - Set <property> [to <val>]\n"
997 "fdt mknode <path> <node> - Create a new node after <path>\n"
998 "fdt rm <path> [<prop>] - Delete the node or <property>\n"
999 "fdt header - Display header info\n"
1000 "fdt bootcpu <id> - Set boot cpuid\n"
1001 "fdt memory <addr> <size> - Add/Update memory node\n"
1002 "fdt rsvmem print - Show current mem reserves\n"
1003 "fdt rsvmem add <addr> <size> - Add a mem reserve\n"
1004 "fdt rsvmem delete <index> - Delete a mem reserves\n"
1005 "fdt chosen [<start> <end>] - Add/update the /chosen branch in the tree\n"
1006 " <start>/<end> - initrd start/end addr\n"
1007 "NOTE: Dereference aliases by omiting the leading '/', "
1008 "e.g. fdt print ethernet0.";
1012 fdt, 255, 0, do_fdt,
1013 "flattened device tree utility commands", fdt_help_text