2 * Functions for working with the Flattened Device Tree data format
4 * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
5 * benh@kernel.crashing.org
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * version 2 as published by the Free Software Foundation.
12 #include <linux/kernel.h>
13 #include <linux/initrd.h>
14 #include <linux/module.h>
16 #include <linux/of_fdt.h>
17 #include <linux/string.h>
18 #include <linux/errno.h>
19 #include <linux/slab.h>
21 #include <asm/setup.h> /* for COMMAND_LINE_SIZE */
23 #include <asm/machdep.h>
24 #endif /* CONFIG_PPC */
28 char *of_fdt_get_string(struct boot_param_header *blob, u32 offset)
30 return ((char *)blob) +
31 be32_to_cpu(blob->off_dt_strings) + offset;
35 * of_fdt_get_property - Given a node in the given flat blob, return
38 void *of_fdt_get_property(struct boot_param_header *blob,
39 unsigned long node, const char *name,
42 unsigned long p = node;
45 u32 tag = be32_to_cpup((__be32 *)p);
52 if (tag != OF_DT_PROP)
55 sz = be32_to_cpup((__be32 *)p);
56 noff = be32_to_cpup((__be32 *)(p + 4));
58 if (be32_to_cpu(blob->version) < 0x10)
59 p = ALIGN(p, sz >= 8 ? 8 : 4);
61 nstr = of_fdt_get_string(blob, noff);
63 pr_warning("Can't find property index name !\n");
66 if (strcmp(name, nstr) == 0) {
77 * of_fdt_is_compatible - Return true if given node from the given blob has
78 * compat in its compatible list
79 * @blob: A device tree blob
81 * @compat: compatible string to compare with compatible list.
83 * On match, returns a non-zero value with smaller values returned for more
84 * specific compatible values.
86 int of_fdt_is_compatible(struct boot_param_header *blob,
87 unsigned long node, const char *compat)
90 unsigned long cplen, l, score = 0;
92 cp = of_fdt_get_property(blob, node, "compatible", &cplen);
97 if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
108 * of_fdt_match - Return true if node matches a list of compatible values
110 int of_fdt_match(struct boot_param_header *blob, unsigned long node,
111 const char *const *compat)
113 unsigned int tmp, score = 0;
119 tmp = of_fdt_is_compatible(blob, node, *compat);
120 if (tmp && (score == 0 || (tmp < score)))
128 static void *unflatten_dt_alloc(unsigned long *mem, unsigned long size,
133 *mem = ALIGN(*mem, align);
141 * unflatten_dt_node - Alloc and populate a device_node from the flat tree
142 * @blob: The parent device tree blob
143 * @mem: Memory chunk to use for allocating device nodes and properties
144 * @p: pointer to node in flat tree
145 * @dad: Parent struct device_node
146 * @allnextpp: pointer to ->allnext from last allocated device_node
147 * @fpsize: Size of the node path up at the current depth.
149 static unsigned long unflatten_dt_node(struct boot_param_header *blob,
152 struct device_node *dad,
153 struct device_node ***allnextpp,
154 unsigned long fpsize)
156 struct device_node *np;
157 struct property *pp, **prev_pp = NULL;
160 unsigned int l, allocl;
164 tag = be32_to_cpup((__be32 *)(*p));
165 if (tag != OF_DT_BEGIN_NODE) {
166 pr_err("Weird tag at start of node: %x\n", tag);
171 l = allocl = strlen(pathp) + 1;
172 *p = ALIGN(*p + l, 4);
174 /* version 0x10 has a more compact unit name here instead of the full
175 * path. we accumulate the full path size using "fpsize", we'll rebuild
176 * it later. We detect this because the first character of the name is
179 if ((*pathp) != '/') {
182 /* root node: special case. fpsize accounts for path
183 * plus terminating zero. root node only has '/', so
184 * fpsize should be 2, but we want to avoid the first
185 * level nodes to have two '/' so we use fpsize 1 here
190 /* account for '/' and path size minus terminal 0
198 np = unflatten_dt_alloc(&mem, sizeof(struct device_node) + allocl,
199 __alignof__(struct device_node));
201 memset(np, 0, sizeof(*np));
202 np->full_name = ((char *)np) + sizeof(struct device_node);
204 char *fn = np->full_name;
205 /* rebuild full path for new format */
206 if (dad && dad->parent) {
207 strcpy(fn, dad->full_name);
209 if ((strlen(fn) + l + 1) != allocl) {
210 pr_debug("%s: p: %d, l: %d, a: %d\n",
211 pathp, (int)strlen(fn),
218 memcpy(fn, pathp, l);
220 memcpy(np->full_name, pathp, l);
221 prev_pp = &np->properties;
223 *allnextpp = &np->allnext;
226 /* we temporarily use the next field as `last_child'*/
227 if (dad->next == NULL)
230 dad->next->sibling = np;
233 kref_init(&np->kref);
235 /* process properties */
240 tag = be32_to_cpup((__be32 *)(*p));
241 if (tag == OF_DT_NOP) {
245 if (tag != OF_DT_PROP)
248 sz = be32_to_cpup((__be32 *)(*p));
249 noff = be32_to_cpup((__be32 *)((*p) + 4));
251 if (be32_to_cpu(blob->version) < 0x10)
252 *p = ALIGN(*p, sz >= 8 ? 8 : 4);
254 pname = of_fdt_get_string(blob, noff);
256 pr_info("Can't find property name in list !\n");
259 if (strcmp(pname, "name") == 0)
261 l = strlen(pname) + 1;
262 pp = unflatten_dt_alloc(&mem, sizeof(struct property),
263 __alignof__(struct property));
265 /* We accept flattened tree phandles either in
266 * ePAPR-style "phandle" properties, or the
267 * legacy "linux,phandle" properties. If both
268 * appear and have different values, things
269 * will get weird. Don't do that. */
270 if ((strcmp(pname, "phandle") == 0) ||
271 (strcmp(pname, "linux,phandle") == 0)) {
272 if (np->phandle == 0)
273 np->phandle = be32_to_cpup((__be32*)*p);
275 /* And we process the "ibm,phandle" property
276 * used in pSeries dynamic device tree
278 if (strcmp(pname, "ibm,phandle") == 0)
279 np->phandle = be32_to_cpup((__be32 *)*p);
282 pp->value = (void *)*p;
286 *p = ALIGN((*p) + sz, 4);
288 /* with version 0x10 we may not have the name property, recreate
289 * it here from the unit name if absent
292 char *p1 = pathp, *ps = pathp, *pa = NULL;
305 pp = unflatten_dt_alloc(&mem, sizeof(struct property) + sz,
306 __alignof__(struct property));
313 memcpy(pp->value, ps, sz - 1);
314 ((char *)pp->value)[sz - 1] = 0;
315 pr_debug("fixed up name for %s -> %s\n", pathp,
321 np->name = of_get_property(np, "name", NULL);
322 np->type = of_get_property(np, "device_type", NULL);
329 while (tag == OF_DT_BEGIN_NODE || tag == OF_DT_NOP) {
330 if (tag == OF_DT_NOP)
333 mem = unflatten_dt_node(blob, mem, p, np, allnextpp,
335 tag = be32_to_cpup((__be32 *)(*p));
337 if (tag != OF_DT_END_NODE) {
338 pr_err("Weird tag at end of node: %x\n", tag);
346 * __unflatten_device_tree - create tree of device_nodes from flat blob
348 * unflattens a device-tree, creating the
349 * tree of struct device_node. It also fills the "name" and "type"
350 * pointers of the nodes so the normal device-tree walking functions
352 * @blob: The blob to expand
353 * @mynodes: The device_node tree created by the call
354 * @dt_alloc: An allocator that provides a virtual address to memory
355 * for the resulting tree
357 static void __unflatten_device_tree(struct boot_param_header *blob,
358 struct device_node **mynodes,
359 void * (*dt_alloc)(u64 size, u64 align))
361 unsigned long start, mem, size;
362 struct device_node **allnextp = mynodes;
364 pr_debug(" -> unflatten_device_tree()\n");
367 pr_debug("No device tree pointer\n");
371 pr_debug("Unflattening device tree:\n");
372 pr_debug("magic: %08x\n", be32_to_cpu(blob->magic));
373 pr_debug("size: %08x\n", be32_to_cpu(blob->totalsize));
374 pr_debug("version: %08x\n", be32_to_cpu(blob->version));
376 if (be32_to_cpu(blob->magic) != OF_DT_HEADER) {
377 pr_err("Invalid device tree blob header\n");
381 /* First pass, scan for size */
382 start = ((unsigned long)blob) +
383 be32_to_cpu(blob->off_dt_struct);
384 size = unflatten_dt_node(blob, 0, &start, NULL, NULL, 0);
385 size = (size | 3) + 1;
387 pr_debug(" size is %lx, allocating...\n", size);
389 /* Allocate memory for the expanded device tree */
390 mem = (unsigned long)
391 dt_alloc(size + 4, __alignof__(struct device_node));
393 ((__be32 *)mem)[size / 4] = cpu_to_be32(0xdeadbeef);
395 pr_debug(" unflattening %lx...\n", mem);
397 /* Second pass, do actual unflattening */
398 start = ((unsigned long)blob) +
399 be32_to_cpu(blob->off_dt_struct);
400 unflatten_dt_node(blob, mem, &start, NULL, &allnextp, 0);
401 if (be32_to_cpup((__be32 *)start) != OF_DT_END)
402 pr_warning("Weird tag at end of tree: %08x\n", *((u32 *)start));
403 if (be32_to_cpu(((__be32 *)mem)[size / 4]) != 0xdeadbeef)
404 pr_warning("End of tree marker overwritten: %08x\n",
405 be32_to_cpu(((__be32 *)mem)[size / 4]));
408 pr_debug(" <- unflatten_device_tree()\n");
411 static void *kernel_tree_alloc(u64 size, u64 align)
413 return kzalloc(size, GFP_KERNEL);
417 * of_fdt_unflatten_tree - create tree of device_nodes from flat blob
419 * unflattens the device-tree passed by the firmware, creating the
420 * tree of struct device_node. It also fills the "name" and "type"
421 * pointers of the nodes so the normal device-tree walking functions
424 void of_fdt_unflatten_tree(unsigned long *blob,
425 struct device_node **mynodes)
427 struct boot_param_header *device_tree =
428 (struct boot_param_header *)blob;
429 __unflatten_device_tree(device_tree, mynodes, &kernel_tree_alloc);
431 EXPORT_SYMBOL_GPL(of_fdt_unflatten_tree);
433 /* Everything below here references initial_boot_params directly. */
434 int __initdata dt_root_addr_cells;
435 int __initdata dt_root_size_cells;
437 struct boot_param_header *initial_boot_params;
439 #ifdef CONFIG_OF_EARLY_FLATTREE
442 * of_scan_flat_dt - scan flattened tree blob and call callback on each.
443 * @it: callback function
444 * @data: context data pointer
446 * This function is used to scan the flattened device-tree, it is
447 * used to extract the memory information at boot before we can
450 int __init of_scan_flat_dt(int (*it)(unsigned long node,
451 const char *uname, int depth,
455 unsigned long p = ((unsigned long)initial_boot_params) +
456 be32_to_cpu(initial_boot_params->off_dt_struct);
461 u32 tag = be32_to_cpup((__be32 *)p);
465 if (tag == OF_DT_END_NODE) {
469 if (tag == OF_DT_NOP)
471 if (tag == OF_DT_END)
473 if (tag == OF_DT_PROP) {
474 u32 sz = be32_to_cpup((__be32 *)p);
476 if (be32_to_cpu(initial_boot_params->version) < 0x10)
477 p = ALIGN(p, sz >= 8 ? 8 : 4);
482 if (tag != OF_DT_BEGIN_NODE) {
483 pr_err("Invalid tag %x in flat device tree!\n", tag);
488 p = ALIGN(p + strlen(pathp) + 1, 4);
489 if ((*pathp) == '/') {
491 for (lp = NULL, np = pathp; *np; np++)
497 rc = it(p, pathp, depth, data);
506 * of_get_flat_dt_root - find the root node in the flat blob
508 unsigned long __init of_get_flat_dt_root(void)
510 unsigned long p = ((unsigned long)initial_boot_params) +
511 be32_to_cpu(initial_boot_params->off_dt_struct);
513 while (be32_to_cpup((__be32 *)p) == OF_DT_NOP)
515 BUG_ON(be32_to_cpup((__be32 *)p) != OF_DT_BEGIN_NODE);
517 return ALIGN(p + strlen((char *)p) + 1, 4);
521 * of_get_flat_dt_prop - Given a node in the flat blob, return the property ptr
523 * This function can be used within scan_flattened_dt callback to get
524 * access to properties
526 void *__init of_get_flat_dt_prop(unsigned long node, const char *name,
529 return of_fdt_get_property(initial_boot_params, node, name, size);
533 * of_flat_dt_is_compatible - Return true if given node has compat in compatible list
534 * @node: node to test
535 * @compat: compatible string to compare with compatible list.
537 int __init of_flat_dt_is_compatible(unsigned long node, const char *compat)
539 return of_fdt_is_compatible(initial_boot_params, node, compat);
543 * of_flat_dt_match - Return true if node matches a list of compatible values
545 int __init of_flat_dt_match(unsigned long node, const char *const *compat)
547 return of_fdt_match(initial_boot_params, node, compat);
550 #ifdef CONFIG_BLK_DEV_INITRD
552 * early_init_dt_check_for_initrd - Decode initrd location from flat tree
553 * @node: reference to node containing initrd location ('chosen')
555 void __init early_init_dt_check_for_initrd(unsigned long node)
557 unsigned long start, end, len;
560 pr_debug("Looking for initrd properties... ");
562 prop = of_get_flat_dt_prop(node, "linux,initrd-start", &len);
565 start = of_read_ulong(prop, len/4);
567 prop = of_get_flat_dt_prop(node, "linux,initrd-end", &len);
570 end = of_read_ulong(prop, len/4);
572 early_init_dt_setup_initrd_arch(start, end);
573 pr_debug("initrd_start=0x%lx initrd_end=0x%lx\n", start, end);
576 inline void early_init_dt_check_for_initrd(unsigned long node)
579 #endif /* CONFIG_BLK_DEV_INITRD */
582 * early_init_dt_scan_root - fetch the top level address and size cells
584 int __init early_init_dt_scan_root(unsigned long node, const char *uname,
585 int depth, void *data)
592 dt_root_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
593 dt_root_addr_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
595 prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
597 dt_root_size_cells = be32_to_cpup(prop);
598 pr_debug("dt_root_size_cells = %x\n", dt_root_size_cells);
600 prop = of_get_flat_dt_prop(node, "#address-cells", NULL);
602 dt_root_addr_cells = be32_to_cpup(prop);
603 pr_debug("dt_root_addr_cells = %x\n", dt_root_addr_cells);
609 u64 __init dt_mem_next_cell(int s, __be32 **cellp)
614 return of_read_number(p, s);
618 * early_init_dt_scan_memory - Look for an parse memory nodes
620 int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
621 int depth, void *data)
623 char *type = of_get_flat_dt_prop(node, "device_type", NULL);
627 /* We are scanning "memory" nodes only */
630 * The longtrail doesn't have a device_type on the
631 * /memory node, so look for the node called /memory@0.
633 if (depth != 1 || strcmp(uname, "memory@0") != 0)
635 } else if (strcmp(type, "memory") != 0)
638 reg = of_get_flat_dt_prop(node, "linux,usable-memory", &l);
640 reg = of_get_flat_dt_prop(node, "reg", &l);
644 endp = reg + (l / sizeof(__be32));
646 pr_debug("memory scan node %s, reg size %ld, data: %x %x %x %x,\n",
647 uname, l, reg[0], reg[1], reg[2], reg[3]);
649 while ((endp - reg) >= (dt_root_addr_cells + dt_root_size_cells)) {
652 base = dt_mem_next_cell(dt_root_addr_cells, ®);
653 size = dt_mem_next_cell(dt_root_size_cells, ®);
657 pr_debug(" - %llx , %llx\n", (unsigned long long)base,
658 (unsigned long long)size);
660 early_init_dt_add_memory_arch(base, size);
666 int __init early_init_dt_scan_chosen(unsigned long node, const char *uname,
667 int depth, void *data)
672 pr_debug("search \"chosen\", depth: %d, uname: %s\n", depth, uname);
674 if (depth != 1 || !data ||
675 (strcmp(uname, "chosen") != 0 && strcmp(uname, "chosen@0") != 0))
678 early_init_dt_check_for_initrd(node);
680 /* Retrieve command line */
681 p = of_get_flat_dt_prop(node, "bootargs", &l);
682 if (p != NULL && l > 0)
683 strlcpy(data, p, min((int)l, COMMAND_LINE_SIZE));
686 * CONFIG_CMDLINE is meant to be a default in case nothing else
687 * managed to set the command line, unless CONFIG_CMDLINE_FORCE
688 * is set in which case we override whatever was found earlier.
690 #ifdef CONFIG_CMDLINE
691 #ifndef CONFIG_CMDLINE_FORCE
692 if (!((char *)data)[0])
694 strlcpy(data, CONFIG_CMDLINE, COMMAND_LINE_SIZE);
695 #endif /* CONFIG_CMDLINE */
697 pr_debug("Command line is: %s\n", (char*)data);
704 * unflatten_device_tree - create tree of device_nodes from flat blob
706 * unflattens the device-tree passed by the firmware, creating the
707 * tree of struct device_node. It also fills the "name" and "type"
708 * pointers of the nodes so the normal device-tree walking functions
711 void __init unflatten_device_tree(void)
713 __unflatten_device_tree(initial_boot_params, &allnodes,
714 early_init_dt_alloc_memory_arch);
716 /* Get pointer to "/chosen" and "/aliasas" nodes for use everywhere */
717 of_alias_scan(early_init_dt_alloc_memory_arch);
720 #endif /* CONFIG_OF_EARLY_FLATTREE */