2 * Procedures for creating, accessing and interpreting the device tree.
4 * Paul Mackerras August 1996.
5 * Copyright (C) 1996-2005 Paul Mackerras.
7 * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
8 * {engebret|bergner}@us.ibm.com
10 * Adapted for sparc32 by David S. Miller davem@davemloft.net
12 * This program is free software; you can redistribute it and/or
13 * modify it under the terms of the GNU General Public License
14 * as published by the Free Software Foundation; either version
15 * 2 of the License, or (at your option) any later version.
18 #include <linux/kernel.h>
19 #include <linux/types.h>
20 #include <linux/string.h>
22 #include <linux/bootmem.h>
23 #include <linux/module.h>
26 #include <asm/oplib.h>
28 static struct device_node *allnodes;
30 /* use when traversing tree through the allnext, child, sibling,
31 * or parent members of struct device_node.
33 static DEFINE_RWLOCK(devtree_lock);
35 int of_device_is_compatible(struct device_node *device, const char *compat)
40 cp = (char *) of_get_property(device, "compatible", &cplen);
44 if (strncmp(cp, compat, strlen(compat)) == 0)
53 EXPORT_SYMBOL(of_device_is_compatible);
55 struct device_node *of_get_parent(const struct device_node *node)
57 struct device_node *np;
66 EXPORT_SYMBOL(of_get_parent);
68 struct device_node *of_get_next_child(const struct device_node *node,
69 struct device_node *prev)
71 struct device_node *next;
73 next = prev ? prev->sibling : node->child;
74 for (; next != 0; next = next->sibling) {
80 EXPORT_SYMBOL(of_get_next_child);
82 struct device_node *of_find_node_by_path(const char *path)
84 struct device_node *np = allnodes;
86 for (; np != 0; np = np->allnext) {
87 if (np->full_name != 0 && strcmp(np->full_name, path) == 0)
93 EXPORT_SYMBOL(of_find_node_by_path);
95 struct device_node *of_find_node_by_phandle(phandle handle)
97 struct device_node *np;
99 for (np = allnodes; np != 0; np = np->allnext)
100 if (np->node == handle)
105 EXPORT_SYMBOL(of_find_node_by_phandle);
107 struct device_node *of_find_node_by_name(struct device_node *from,
110 struct device_node *np;
112 np = from ? from->allnext : allnodes;
113 for (; np != NULL; np = np->allnext)
114 if (np->name != NULL && strcmp(np->name, name) == 0)
119 EXPORT_SYMBOL(of_find_node_by_name);
121 struct device_node *of_find_node_by_type(struct device_node *from,
124 struct device_node *np;
126 np = from ? from->allnext : allnodes;
127 for (; np != 0; np = np->allnext)
128 if (np->type != 0 && strcmp(np->type, type) == 0)
133 EXPORT_SYMBOL(of_find_node_by_type);
135 struct device_node *of_find_compatible_node(struct device_node *from,
136 const char *type, const char *compatible)
138 struct device_node *np;
140 np = from ? from->allnext : allnodes;
141 for (; np != 0; np = np->allnext) {
143 && !(np->type != 0 && strcmp(np->type, type) == 0))
145 if (of_device_is_compatible(np, compatible))
151 EXPORT_SYMBOL(of_find_compatible_node);
153 struct property *of_find_property(struct device_node *np, const char *name,
158 for (pp = np->properties; pp != 0; pp = pp->next) {
159 if (strcmp(pp->name, name) == 0) {
167 EXPORT_SYMBOL(of_find_property);
170 * Find a property with a given name for a given node
171 * and return the value.
173 void *of_get_property(struct device_node *np, const char *name, int *lenp)
175 struct property *pp = of_find_property(np,name,lenp);
176 return pp ? pp->value : NULL;
178 EXPORT_SYMBOL(of_get_property);
180 int of_getintprop_default(struct device_node *np, const char *name, int def)
182 struct property *prop;
185 prop = of_find_property(np, name, &len);
186 if (!prop || len != 4)
189 return *(int *) prop->value;
191 EXPORT_SYMBOL(of_getintprop_default);
193 int of_n_addr_cells(struct device_node *np)
199 ip = of_get_property(np, "#address-cells", NULL);
202 } while (np->parent);
203 /* No #address-cells property for the root node, default to 2 */
206 EXPORT_SYMBOL(of_n_addr_cells);
208 int of_n_size_cells(struct device_node *np)
214 ip = of_get_property(np, "#size-cells", NULL);
217 } while (np->parent);
218 /* No #size-cells property for the root node, default to 1 */
221 EXPORT_SYMBOL(of_n_size_cells);
223 int of_set_property(struct device_node *dp, const char *name, void *val, int len)
225 struct property **prevp;
229 new_val = kmalloc(len, GFP_KERNEL);
233 memcpy(new_val, val, len);
237 write_lock(&devtree_lock);
238 prevp = &dp->properties;
240 struct property *prop = *prevp;
242 if (!strcmp(prop->name, name)) {
243 void *old_val = prop->value;
246 ret = prom_setprop(dp->node, name, val, len);
249 prop->value = new_val;
252 if (OF_IS_DYNAMIC(prop))
255 OF_MARK_DYNAMIC(prop);
261 prevp = &(*prevp)->next;
263 write_unlock(&devtree_lock);
265 /* XXX Upate procfs if necessary... */
269 EXPORT_SYMBOL(of_set_property);
271 static unsigned int prom_early_allocated;
273 static void * __init prom_early_alloc(unsigned long size)
277 ret = __alloc_bootmem(size, SMP_CACHE_BYTES, 0UL);
279 memset(ret, 0, size);
281 prom_early_allocated += size;
286 static int is_root_node(const struct device_node *dp)
291 return (dp->parent == NULL);
294 /* The following routines deal with the black magic of fully naming a
297 * Certain well known named nodes are just the simple name string.
299 * Actual devices have an address specifier appended to the base name
300 * string, like this "foo@addr". The "addr" can be in any number of
301 * formats, and the platform plus the type of the node determine the
302 * format and how it is constructed.
304 * For children of the ROOT node, the naming convention is fixed and
305 * determined by whether this is a sun4u or sun4v system.
307 * For children of other nodes, it is bus type specific. So
308 * we walk up the tree until we discover a "device_type" property
309 * we recognize and we go from there.
311 static void __init sparc32_path_component(struct device_node *dp, char *tmp_buf)
313 struct linux_prom_registers *regs;
314 struct property *rprop;
316 rprop = of_find_property(dp, "reg", NULL);
321 sprintf(tmp_buf, "%s@%x,%x",
323 regs->which_io, regs->phys_addr);
326 /* "name@slot,offset" */
327 static void __init sbus_path_component(struct device_node *dp, char *tmp_buf)
329 struct linux_prom_registers *regs;
330 struct property *prop;
332 prop = of_find_property(dp, "reg", NULL);
337 sprintf(tmp_buf, "%s@%x,%x",
343 /* "name@devnum[,func]" */
344 static void __init pci_path_component(struct device_node *dp, char *tmp_buf)
346 struct linux_prom_pci_registers *regs;
347 struct property *prop;
350 prop = of_find_property(dp, "reg", NULL);
355 devfn = (regs->phys_hi >> 8) & 0xff;
357 sprintf(tmp_buf, "%s@%x,%x",
362 sprintf(tmp_buf, "%s@%x",
368 /* "name@addrhi,addrlo" */
369 static void __init ebus_path_component(struct device_node *dp, char *tmp_buf)
371 struct linux_prom_registers *regs;
372 struct property *prop;
374 prop = of_find_property(dp, "reg", NULL);
380 sprintf(tmp_buf, "%s@%x,%x",
382 regs->which_io, regs->phys_addr);
385 static void __init __build_path_component(struct device_node *dp, char *tmp_buf)
387 struct device_node *parent = dp->parent;
389 if (parent != NULL) {
390 if (!strcmp(parent->type, "pci") ||
391 !strcmp(parent->type, "pciex"))
392 return pci_path_component(dp, tmp_buf);
393 if (!strcmp(parent->type, "sbus"))
394 return sbus_path_component(dp, tmp_buf);
395 if (!strcmp(parent->type, "ebus"))
396 return ebus_path_component(dp, tmp_buf);
398 /* "isa" is handled with platform naming */
401 /* Use platform naming convention. */
402 return sparc32_path_component(dp, tmp_buf);
405 static char * __init build_path_component(struct device_node *dp)
407 char tmp_buf[64], *n;
410 __build_path_component(dp, tmp_buf);
411 if (tmp_buf[0] == '\0')
412 strcpy(tmp_buf, dp->name);
414 n = prom_early_alloc(strlen(tmp_buf) + 1);
420 static char * __init build_full_name(struct device_node *dp)
422 int len, ourlen, plen;
425 plen = strlen(dp->parent->full_name);
426 ourlen = strlen(dp->path_component_name);
427 len = ourlen + plen + 2;
429 n = prom_early_alloc(len);
430 strcpy(n, dp->parent->full_name);
431 if (!is_root_node(dp->parent)) {
432 strcpy(n + plen, "/");
435 strcpy(n + plen, dp->path_component_name);
440 static unsigned int unique_id;
442 static struct property * __init build_one_prop(phandle node, char *prev, char *special_name, void *special_val, int special_len)
444 static struct property *tmp = NULL;
450 memset(p, 0, sizeof(*p) + 32);
453 p = prom_early_alloc(sizeof(struct property) + 32);
454 p->unique_id = unique_id++;
457 p->name = (char *) (p + 1);
459 p->length = special_len;
460 p->value = prom_early_alloc(special_len);
461 memcpy(p->value, special_val, special_len);
464 prom_firstprop(node, p->name);
466 prom_nextprop(node, prev, p->name);
468 if (strlen(p->name) == 0) {
472 p->length = prom_getproplen(node, p->name);
473 if (p->length <= 0) {
476 p->value = prom_early_alloc(p->length + 1);
477 prom_getproperty(node, p->name, p->value, p->length);
478 ((unsigned char *)p->value)[p->length] = '\0';
484 static struct property * __init build_prop_list(phandle node)
486 struct property *head, *tail;
488 head = tail = build_one_prop(node, NULL,
489 ".node", &node, sizeof(node));
491 tail->next = build_one_prop(node, NULL, NULL, NULL, 0);
494 tail->next = build_one_prop(node, tail->name,
502 static char * __init get_one_property(phandle node, char *name)
504 char *buf = "<NULL>";
507 len = prom_getproplen(node, name);
509 buf = prom_early_alloc(len);
510 len = prom_getproperty(node, name, buf, len);
516 static struct device_node * __init create_node(phandle node)
518 struct device_node *dp;
523 dp = prom_early_alloc(sizeof(*dp));
524 dp->unique_id = unique_id++;
526 kref_init(&dp->kref);
528 dp->name = get_one_property(node, "name");
529 dp->type = get_one_property(node, "device_type");
532 /* Build interrupts later... */
534 dp->properties = build_prop_list(node);
539 static struct device_node * __init build_tree(struct device_node *parent, phandle node, struct device_node ***nextp)
541 struct device_node *dp;
543 dp = create_node(node);
546 *nextp = &dp->allnext;
549 dp->path_component_name = build_path_component(dp);
550 dp->full_name = build_full_name(dp);
552 dp->child = build_tree(dp, prom_getchild(node), nextp);
554 dp->sibling = build_tree(parent, prom_getsibling(node), nextp);
560 void __init prom_build_devicetree(void)
562 struct device_node **nextp;
564 allnodes = create_node(prom_root_node);
565 allnodes->path_component_name = "";
566 allnodes->full_name = "/";
568 nextp = &allnodes->allnext;
569 allnodes->child = build_tree(allnodes,
570 prom_getchild(allnodes->node),
572 printk("PROM: Built device tree with %u bytes of memory.\n",
573 prom_early_allocated);