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>
32 #ifdef CONFIG_OF_LIBFDT
34 #include <asm/global_data.h>
37 #include <fdt_support.h>
39 #define MAX_LEVEL 32 /* how deeply nested we will go */
40 #define SCRATCHPAD 1024 /* bytes of scratchpad memory */
43 * Global data (for the gd->bd)
45 DECLARE_GLOBAL_DATA_PTR;
47 static int fdt_valid(void);
48 static int fdt_parse_prop(char *pathp, char *prop, char *newval,
49 char *data, int *len);
50 static int fdt_print(char *pathp, char *prop, int depth);
53 * Flattened Device Tree command, see the help for parameter definitions.
55 int do_fdt (cmd_tbl_t * cmdtp, int flag, int argc, char *argv[])
58 printf ("Usage:\n%s\n", cmdtp->usage);
62 /********************************************************************
63 * Set the address of the fdt
64 ********************************************************************/
65 if (argv[1][0] == 'a') {
67 * Set the address [and length] of the fdt.
69 fdt = (struct fdt_header *)simple_strtoul(argv[2], NULL, 16);
81 len = simple_strtoul(argv[3], NULL, 16);
82 if (len < fdt_totalsize(fdt)) {
83 printf ("New length %d < existing length %d, "
85 len, fdt_totalsize(fdt));
88 * Open in place with a new length.
90 err = fdt_open_into(fdt, fdt, len);
92 printf ("libfdt fdt_open_into(): %s\n",
98 /********************************************************************
100 ********************************************************************/
101 } else if ((argv[1][0] == 'm') && (argv[1][1] == 'o')) {
102 struct fdt_header *newaddr;
107 printf ("Usage:\n%s\n", cmdtp->usage);
112 * Set the address and length of the fdt.
114 fdt = (struct fdt_header *)simple_strtoul(argv[2], NULL, 16);
119 newaddr = (struct fdt_header *)simple_strtoul(argv[3],NULL,16);
122 * If the user specifies a length, use that. Otherwise use the
126 len = fdt_totalsize(fdt);
128 len = simple_strtoul(argv[4], NULL, 16);
129 if (len < fdt_totalsize(fdt)) {
130 printf ("New length 0x%X < existing length "
132 len, fdt_totalsize(fdt));
138 * Copy to the new location.
140 err = fdt_open_into(fdt, newaddr, len);
142 printf ("libfdt fdt_open_into(): %s\n",
148 /********************************************************************
150 ********************************************************************/
151 } else if ((argv[1][0] == 'm') && (argv[1][1] == 'k')) {
152 char *pathp; /* path */
153 char *nodep; /* new node to add */
154 int nodeoffset; /* node offset from libfdt */
158 * Parameters: Node path, new node to be appended to the path.
161 printf ("Usage:\n%s\n", cmdtp->usage);
168 nodeoffset = fdt_find_node_by_path (fdt, pathp);
169 if (nodeoffset < 0) {
171 * Not found or something else bad happened.
173 printf ("libfdt fdt_find_node_by_path() returned %s\n",
174 fdt_strerror(nodeoffset));
177 err = fdt_add_subnode(fdt, nodeoffset, nodep);
179 printf ("libfdt fdt_add_subnode(): %s\n",
184 /********************************************************************
185 * Set the value of a property in the fdt.
186 ********************************************************************/
187 } else if (argv[1][0] == 's') {
188 char *pathp; /* path */
189 char *prop; /* property */
190 char *newval; /* value from the user (as a string) */
191 int nodeoffset; /* node offset from libfdt */
192 static char data[SCRATCHPAD]; /* storage for the property */
193 int len; /* new length of the property */
194 int ret; /* return value */
197 * Parameters: Node path, property, value.
200 printf ("Usage:\n%s\n", cmdtp->usage);
208 nodeoffset = fdt_find_node_by_path (fdt, pathp);
209 if (nodeoffset < 0) {
211 * Not found or something else bad happened.
213 printf ("libfdt fdt_find_node_by_path() returned %s\n",
214 fdt_strerror(nodeoffset));
217 ret = fdt_parse_prop(pathp, prop, newval, data, &len);
221 ret = fdt_setprop(fdt, nodeoffset, prop, data, len);
223 printf ("libfdt fdt_setprop(): %s\n", fdt_strerror(ret));
227 /********************************************************************
228 * Print (recursive) / List (single level)
229 ********************************************************************/
230 } else if ((argv[1][0] == 'p') || (argv[1][0] == 'l')) {
231 int depth = MAX_LEVEL; /* how deep to print */
232 char *pathp; /* path */
233 char *prop; /* property */
234 int ret; /* return value */
237 * list is an alias for print, but limited to 1 level
239 if (argv[1][0] == 'l') {
244 * Get the starting path. The root node is an oddball,
245 * the offset is zero and has no name.
253 ret = fdt_print(pathp, prop, depth);
257 /********************************************************************
258 * Remove a property/node
259 ********************************************************************/
260 } else if (argv[1][0] == 'r') {
261 int nodeoffset; /* node offset from libfdt */
265 * Get the path. The root node is an oddball, the offset
266 * is zero and has no name.
268 nodeoffset = fdt_find_node_by_path (fdt, argv[2]);
269 if (nodeoffset < 0) {
271 * Not found or something else bad happened.
273 printf ("libfdt fdt_find_node_by_path() returned %s\n",
274 fdt_strerror(nodeoffset));
278 * Do the delete. A fourth parameter means delete a property,
279 * otherwise delete the node.
282 err = fdt_delprop(fdt, nodeoffset, argv[3]);
284 printf("libfdt fdt_delprop(): %s\n",
289 err = fdt_del_node(fdt, nodeoffset);
291 printf("libfdt fdt_del_node(): %s\n",
297 #ifdef CONFIG_OF_BOARD_SETUP
298 /********************************************************************
299 * Call the board-specific fixup routine
300 ********************************************************************/
301 } else if (argv[1][0] == 'b') {
302 ft_board_setup(fdt, gd->bd);
304 /********************************************************************
305 * Create a chosen node
306 ********************************************************************/
307 } else if (argv[1][0] == 'c') {
308 fdt_chosen(fdt, 0, 0, 1);
310 /********************************************************************
311 * Create a u-boot-env node
312 ********************************************************************/
313 } else if (argv[1][0] == 'e') {
316 /********************************************************************
318 ********************************************************************/
319 } else if (argv[1][0] == 'b') {
322 /********************************************************************
323 * Unrecognized command
324 ********************************************************************/
326 printf ("Usage:\n%s\n", cmdtp->usage);
333 /****************************************************************************/
335 static int fdt_valid(void)
340 printf ("The address of the fdt is invalid (NULL).\n");
344 err = fdt_check_header(fdt);
346 return 1; /* valid */
349 printf("libfdt fdt_check_header(): %s", fdt_strerror(err));
351 * Be more informative on bad version.
353 if (err == -FDT_ERR_BADVERSION) {
354 if (fdt_version(fdt) < FDT_FIRST_SUPPORTED_VERSION) {
355 printf (" - too old, fdt $d < %d",
357 FDT_FIRST_SUPPORTED_VERSION);
360 if (fdt_last_comp_version(fdt) > FDT_LAST_SUPPORTED_VERSION) {
361 printf (" - too new, fdt $d > %d",
363 FDT_LAST_SUPPORTED_VERSION);
374 /****************************************************************************/
377 * Parse the user's input, partially heuristic. Valid formats:
379 * <0011> - hex half word (16 bits)
380 * <00112233> - hex word (32 bits)
381 * - hex double words (64 bits) are not supported, must use
382 * a byte stream instead.
383 * [00 11 22 .. nn] - byte stream
384 * "string" - If the the value doesn't start with "<" or "[", it is
385 * treated as a string. Note that the quotes are
386 * stripped by the parser before we get the string.
388 static int fdt_parse_prop(char *pathp, char *prop, char *newval,
389 char *data, int *len)
391 char *cp; /* temporary char pointer */
392 unsigned long tmp; /* holds converted values */
394 if (*newval == '<') {
396 * Bigger values than bytes.
400 while ((*newval != '>') && (*newval != '\0')) {
402 tmp = simple_strtoul(cp, &newval, 16);
403 if ((newval - cp) <= 2) {
407 } else if ((newval - cp) <= 4) {
408 *(uint16_t *)data = __cpu_to_be16(tmp);
411 } else if ((newval - cp) <= 8) {
412 *(uint32_t *)data = __cpu_to_be32(tmp);
416 printf("Sorry, I could not convert \"%s\"\n",
420 while (*newval == ' ')
423 if (*newval != '>') {
424 printf("Unexpected character '%c'\n", *newval);
427 } else if (*newval == '[') {
429 * Byte stream. Convert the values.
433 while ((*newval != ']') && (*newval != '\0')) {
434 tmp = simple_strtoul(newval, &newval, 16);
435 *data++ = tmp & 0xFF;
437 while (*newval == ' ')
440 if (*newval != ']') {
441 printf("Unexpected character '%c'\n", *newval);
446 * Assume it is a string. Copy it into our data area for
447 * convenience (including the terminating '\0').
449 *len = strlen(newval) + 1;
450 strcpy(data, newval);
455 /****************************************************************************/
458 * Heuristic to guess if this is a string or concatenated strings.
461 static int is_printable_string(const void *data, int len)
463 const char *s = data;
465 /* zero length is not */
469 /* must terminate with zero */
470 if (s[len - 1] != '\0')
473 /* printable or a null byte (concatenated strings) */
474 while (((*s == '\0') || isprint(*s)) && (len > 0)) {
476 * If we see a null, there are three possibilities:
477 * 1) If len == 1, it is the end of the string, printable
478 * 2) Next character also a null, not printable.
479 * 3) Next character not a null, continue to check.
491 /* Not the null termination, or not done yet: not printable */
492 if (*s != '\0' || (len != 0))
500 * Print the property in the best format, a heuristic guess. Print as
501 * a string, concatenated strings, a byte, word, double word, or (if all
502 * else fails) it is printed as a stream of bytes.
504 static void print_data(const void *data, int len)
509 /* no data, don't print */
514 * It is a string, but it may have multiple strings (embedded '\0's).
516 if (is_printable_string(data, len)) {
523 j += strlen(data) + 1;
524 data += strlen(data) + 1;
532 printf("<%02x>", (*(u8 *) data) & 0xff);
534 case 2: /* half-word */
535 printf("<%04x>", be16_to_cpu(*(u16 *) data) & 0xffff);
538 printf("<%08x>", be32_to_cpu(*(u32 *) data) & 0xffffffffU);
540 case 8: /* double-word */
542 printf("<%016llx>", be64_to_cpu(*(uint64_t *) data));
544 printf("<%08x ", be32_to_cpu(*(u32 *) data) & 0xffffffffU);
546 printf("%08x>", be32_to_cpu(*(u32 *) data) & 0xffffffffU);
549 default: /* anything else... hexdump */
551 for (j = 0, s = data; j < len; j++)
552 printf("%02x%s", s[j], j < len - 1 ? " " : "");
559 /****************************************************************************/
562 * Recursively print (a portion of) the fdt. The depth parameter
563 * determines how deeply nested the fdt is printed.
565 static int fdt_print(char *pathp, char *prop, int depth)
567 static int offstack[MAX_LEVEL];
568 static char tabs[MAX_LEVEL+1] =
569 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t"
570 "\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t\t";
571 void *nodep; /* property node pointer */
572 int nodeoffset; /* node offset from libfdt */
573 int nextoffset; /* next node offset from libfdt */
574 uint32_t tag; /* tag */
575 int len; /* length of the property */
576 int level = 0; /* keep track of nesting level */
578 nodeoffset = fdt_find_node_by_path (fdt, pathp);
579 if (nodeoffset < 0) {
581 * Not found or something else bad happened.
583 printf ("libfdt fdt_find_node_by_path() returned %s\n",
584 fdt_strerror(nodeoffset));
588 * The user passed in a property as well as node path.
589 * Print only the given property and then return.
592 nodep = fdt_getprop (fdt, nodeoffset, prop, &len);
594 /* no property value */
595 printf("%s %s\n", pathp, prop);
597 } else if (len > 0) {
599 print_data (nodep, len);
603 printf ("libfdt fdt_getprop(): %s\n",
610 * The user passed in a node path and no property,
611 * print the node and all subnodes.
613 offstack[0] = nodeoffset;
616 tag = fdt_next_tag(fdt, nodeoffset, &nextoffset, &pathp);
621 &tabs[MAX_LEVEL - level], pathp);
623 offstack[level] = nodeoffset;
624 if (level >= MAX_LEVEL) {
625 printf("Aaaiii <splat> nested too deep. "
633 printf("%s};\n", &tabs[MAX_LEVEL - level]);
635 level = -1; /* exit the loop */
639 nodep = fdt_getprop (fdt, offstack[level], pathp, &len);
641 printf ("libfdt fdt_getprop(): %s\n",
644 } else if (len == 0) {
645 /* the property has no value */
648 &tabs[MAX_LEVEL - level],
653 &tabs[MAX_LEVEL - level],
655 print_data (nodep, len);
666 printf("Unknown tag 0x%08X\n", tag);
669 nodeoffset = nextoffset;
674 /********************************************************************/
678 "fdt - flattened device tree utility commands\n",
679 "addr <addr> [<length>] - Set the fdt location to <addr>\n"
680 #ifdef CONFIG_OF_BOARD_SETUP
681 "fdt boardsetup - Do board-specific set up\n"
683 "fdt move <fdt> <newaddr> <length> - Copy the fdt to <addr>\n"
684 "fdt print <path> [<prop>] - Recursive print starting at <path>\n"
685 "fdt list <path> [<prop>] - Print one level starting at <path>\n"
686 "fdt set <path> <prop> [<val>] - Set <property> [to <val>]\n"
687 "fdt mknode <path> <node> - Create a new node after <path>\n"
688 "fdt rm <path> [<prop>] - Delete the node or <property>\n"
689 "fdt chosen - Add/update the /chosen branch in the tree\n"
690 #ifdef CONFIG_OF_HAS_UBOOT_ENV
691 "fdt env - Add/replace the /u-boot-env branch in the tree\n"
693 #ifdef CONFIG_OF_HAS_BD_T
694 "fdt bd_t - Add/replace the /bd_t branch in the tree\n"
697 " If the property you are setting/printing has a '#' character or spaces,\n"
698 " you MUST escape it with a \\ character or quote it with \".\n"
699 "Examples: fdt print / # print the whole tree\n"
700 " fdt print /cpus \"#address-cells\"\n"
701 " fdt set /cpus \"#address-cells\" \"[00 00 00 01]\"\n"
704 #endif /* CONFIG_OF_LIBFDT */