WebSVN – HelenOS – Diff – /trunk/boot/genarch/ofw_tree.c


/*
 * Copyright (C) 2006 Jakub Jermar
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - The name of the author may not be used to endorse or promote products
 *   derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#include <ofw_tree.h>
#include <ofw.h>
#include <types.h>
#include <string.h>
#include <balloc.h>
#include <asm.h>
 
#define MAX_PATH_LEN    256
 
static ofw_tree_node_t *ofw_tree_node_alloc(void)
{
    return balloc(sizeof(ofw_tree_node_t), sizeof(ofw_tree_node_t));
}
 
static ofw_tree_property_t *ofw_tree_properties_alloc(unsigned count)
{
    return balloc(count * sizeof(ofw_tree_property_t), sizeof(ofw_tree_property_t));
}
 
static void * ofw_tree_space_alloc(size_t size)
{
    char *addr;
 
    /*
     * What we do here is a nasty hack :-)
     * Problem: string property values that are allocated via this
     * function typically do not contain the trailing '\0'. This
     * is very uncomfortable for kernel, which is supposed to deal
     * with the properties.
     * Solution: when allocating space via this function, we always
     * allocate space for the extra '\0' character that we store
     * behind the requested memory.
     */
    addr = balloc(size + 1, size);
    if (addr)
        addr[size] = '\0';
    return addr;
}
 
/** Transfer information from one OpenFirmware node into its memory representation.
 *
 * Transfer entire information from the OpenFirmware device tree 'current' node to
 * its memory representation in 'current_node'. This function recursively processes
 * all node's peers and children.
 *
 * @param current_node  Pointer to uninitialized ofw_tree_node structure that will
 *          become the memory represenation of 'current'.
 * @param parent_node   Parent ofw_tree_node structure or NULL in case of root node.
 * @param current   OpenFirmware phandle to the current device tree node.
 */
static void ofw_tree_node_process(ofw_tree_node_t *current_node,
    ofw_tree_node_t *parent_node, phandle current)
{
    static char path[MAX_PATH_LEN+1];
    static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
    phandle peer;
    phandle child;
    unsigned properties = 0;
    size_t len;
    int i;
 
    /*
     * Initialize node.
     */
    current_node->parent = parent_node;
    current_node->peer = NULL;
    current_node->child = NULL;
    current_node->properties = 0;
    current_node->property = NULL;
   
    /*
     * Get the disambigued name.
     */
    len = ofw_package_to_path(current, path, MAX_PATH_LEN);
    if (len == -1)
        return;
   
    path[len] = '\0';
    for (i = len - 1; i >= 0 && path[i] != '/'; i--)
        ;
    i++;                                /* do not include '/' */
   
    len -= i;
    current_node->da_name = ofw_tree_space_alloc(len + 1);      /* add space for trailing '\0' */
    if (!current_node->da_name)
        return;
   
    memcpy(current_node->da_name, &path[i], len);
    current_node->da_name[len] = '\0';
   
    /*
     * Recursively process the potential peer node.
     */
    peer = ofw_get_peer_node(current);
    if (peer != 0 && peer != -1) {
        ofw_tree_node_t *peer_node;
       
        peer_node = ofw_tree_node_alloc();
        if (peer_node) {
            ofw_tree_node_process(peer_node, parent_node, peer);
            current_node->peer = peer_node;
        }
    }
   
    /*
     * Recursively process the potential child node.
     */
    child = ofw_get_child_node(current);
    if (child != 0 && child != -1) {
        ofw_tree_node_t *child_node;
       
        child_node = ofw_tree_node_alloc();
        if (child_node) {
            ofw_tree_node_process(child_node, current_node, child);
            current_node->child = child_node;
        }
    }
   
    /*
     * Count properties.
     */
    name[0] = '\0';
    while (ofw_next_property(current, name, name) == 1)
        current_node->properties++;
   
    if (!current_node->properties)
        return;
   
    /*
     * Copy properties.
     */
    current_node->property = ofw_tree_properties_alloc(current_node->properties);
    if (!current_node->property)
        return;
       
    name[0] = '\0';
    for (i = 0; ofw_next_property(current, name, name) == 1; i++) {
        size_t size;
       
        if (i == current_node->properties)
            break;
       
        memcpy(current_node->property[i].name, name, OFW_TREE_PROPERTY_MAX_NAMELEN);
        current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0';
 
        size = ofw_get_proplen(current, name);
        current_node->property[i].size = size;
        if (size) {
            void *buf;
           
            buf = ofw_tree_space_alloc(size);
            if (current_node->property[i].value = buf) {
                /*
                 * Copy property value to memory node.
                 */
                (void) ofw_get_property(current, name, buf, size);
            }
        } else {
            current_node->property[i].value = NULL;
        }
    }
       
    current_node->properties = i;   /* Just in case we ran out of memory. */
}
 
/** Construct memory representation of OpenFirmware device tree.
 *
 * @return NULL on failure or pointer to the root node.
 */
ofw_tree_node_t *ofw_tree_build(void)
{
    ofw_tree_node_t *root;
   
    root = ofw_tree_node_alloc();
    if (root)
        ofw_tree_node_process(root, NULL, ofw_root);
   
    return root;
}
 

Rev 1895	Rev 1896
1	/*	1	/*
2	* Copyright (C) 2006 Jakub Jermar	2	* Copyright (C) 2006 Jakub Jermar
3	* All rights reserved.	3	* All rights reserved.
4	*	4	*
5	* Redistribution and use in source and binary forms, with or without	5	* Redistribution and use in source and binary forms, with or without
6	* modification, are permitted provided that the following conditions	6	* modification, are permitted provided that the following conditions
7	* are met:	7	* are met:
8	*	8	*
9	* - Redistributions of source code must retain the above copyright	9	* - Redistributions of source code must retain the above copyright
10	* notice, this list of conditions and the following disclaimer.	10	* notice, this list of conditions and the following disclaimer.
11	* - Redistributions in binary form must reproduce the above copyright	11	* - Redistributions in binary form must reproduce the above copyright
12	* notice, this list of conditions and the following disclaimer in the	12	* notice, this list of conditions and the following disclaimer in the
13	* documentation and/or other materials provided with the distribution.	13	* documentation and/or other materials provided with the distribution.
14	* - The name of the author may not be used to endorse or promote products	14	* - The name of the author may not be used to endorse or promote products
15	* derived from this software without specific prior written permission.	15	* derived from this software without specific prior written permission.
16	*	16	*
17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR	17	* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES	18	* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.	19	* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,	20	* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT	21	* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,	22	* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY	23	* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT	24	* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF	25	* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.	26	* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27	*/	27	*/
28		28
29	#include <ofw_tree.h>	29	#include <ofw_tree.h>
30	#include <ofw.h>	30	#include <ofw.h>
31	#include <types.h>	31	#include <types.h>
32	#include <string.h>	32	#include <string.h>
33	#include <balloc.h>	33	#include <balloc.h>
34	#include <asm.h>	34	#include <asm.h>
35		35
36	#define MAX_PATH_LEN 256	36	#define MAX_PATH_LEN 256
37		37
38	static ofw_tree_node_t *ofw_tree_node_alloc(void)	38	static ofw_tree_node_t *ofw_tree_node_alloc(void)
39	{	39	{
40	return balloc(sizeof(ofw_tree_node_t), sizeof(ofw_tree_node_t));	40	return balloc(sizeof(ofw_tree_node_t), sizeof(ofw_tree_node_t));
41	}	41	}
42		42
43	static ofw_tree_property_t *ofw_tree_properties_alloc(unsigned count)	43	static ofw_tree_property_t *ofw_tree_properties_alloc(unsigned count)
44	{	44	{
45	return balloc(count * sizeof(ofw_tree_property_t), sizeof(ofw_tree_property_t));	45	return balloc(count * sizeof(ofw_tree_property_t), sizeof(ofw_tree_property_t));
46	}	46	}
47		47
48	static void * ofw_tree_space_alloc(size_t size)	48	static void * ofw_tree_space_alloc(size_t size)
49	{	49	{
-		50	char *addr;
-		51
-		52	/*
-		53	* What we do here is a nasty hack :-)
-		54	* Problem: string property values that are allocated via this
-		55	* function typically do not contain the trailing '\0'. This
-		56	* is very uncomfortable for kernel, which is supposed to deal
-		57	* with the properties.
-		58	* Solution: when allocating space via this function, we always
-		59	* allocate space for the extra '\0' character that we store
-		60	* behind the requested memory.
-		61	*/
50	return balloc(size, size);	62	addr = balloc(size + 1, size);
-		63	if (addr)
-		64	addr[size] = '\0';
-		65	return addr;
51	}	66	}
52		67
53	/** Transfer information from one OpenFirmware node into its memory representation.	68	/** Transfer information from one OpenFirmware node into its memory representation.
54	*	69	*
55	* Transfer entire information from the OpenFirmware device tree 'current' node to	70	* Transfer entire information from the OpenFirmware device tree 'current' node to
56	* its memory representation in 'current_node'. This function recursively processes	71	* its memory representation in 'current_node'. This function recursively processes
57	* all node's peers and children.	72	* all node's peers and children.
58	*	73	*
59	* @param current_node Pointer to uninitialized ofw_tree_node structure that will	74	* @param current_node Pointer to uninitialized ofw_tree_node structure that will
60	* become the memory represenation of 'current'.	75	* become the memory represenation of 'current'.
61	* @param parent_node Parent ofw_tree_node structure or NULL in case of root node.	76	* @param parent_node Parent ofw_tree_node structure or NULL in case of root node.
62	* @param current OpenFirmware phandle to the current device tree node.	77	* @param current OpenFirmware phandle to the current device tree node.
63	*/	78	*/
64	static void ofw_tree_node_process(ofw_tree_node_t *current_node,	79	static void ofw_tree_node_process(ofw_tree_node_t *current_node,
65	ofw_tree_node_t *parent_node, phandle current)	80	ofw_tree_node_t *parent_node, phandle current)
66	{	81	{
67	static char path[MAX_PATH_LEN+1];	82	static char path[MAX_PATH_LEN+1];
68	static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];	83	static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
69	phandle peer;	84	phandle peer;
70	phandle child;	85	phandle child;
71	unsigned properties = 0;	86	unsigned properties = 0;
72	size_t len;	87	size_t len;
73	int i;	88	int i;
74		89
75	/*	90	/*
76	* Initialize node.	91	* Initialize node.
77	*/	92	*/
78	current_node->parent = parent_node;	93	current_node->parent = parent_node;
79	current_node->peer = NULL;	94	current_node->peer = NULL;
80	current_node->child = NULL;	95	current_node->child = NULL;
81	current_node->properties = 0;	96	current_node->properties = 0;
82	current_node->property = NULL;	97	current_node->property = NULL;
83		98
84	/*	99	/*
85	* Get the disambigued name.	100	* Get the disambigued name.
86	*/	101	*/
87	len = ofw_package_to_path(current, path, MAX_PATH_LEN);	102	len = ofw_package_to_path(current, path, MAX_PATH_LEN);
88	if (len == -1)	103	if (len == -1)
89	return;	104	return;
90		105
91	path[len] = '\0';	106	path[len] = '\0';
92	for (i = len - 1; i >= 0 && path[i] != '/'; i--)	107	for (i = len - 1; i >= 0 && path[i] != '/'; i--)
93	;	108	;
94	i++; /* do not include '/' */	109	i++; /* do not include '/' */
95		110
96	len -= i;	111	len -= i;
97	current_node->da_name = ofw_tree_space_alloc(len + 1); /* add space for trailing '\0' */	112	current_node->da_name = ofw_tree_space_alloc(len + 1); /* add space for trailing '\0' */
98	if (!current_node->da_name)	113	if (!current_node->da_name)
99	return;	114	return;
100		115
101	memcpy(current_node->da_name, &path[i], len);	116	memcpy(current_node->da_name, &path[i], len);
102	current_node->da_name[len] = '\0';	117	current_node->da_name[len] = '\0';
103		118
104	/*	119	/*
105	* Recursively process the potential peer node.	120	* Recursively process the potential peer node.
106	*/	121	*/
107	peer = ofw_get_peer_node(current);	122	peer = ofw_get_peer_node(current);
108	if (peer != 0 && peer != -1) {	123	if (peer != 0 && peer != -1) {
109	ofw_tree_node_t *peer_node;	124	ofw_tree_node_t *peer_node;
110		125
111	peer_node = ofw_tree_node_alloc();	126	peer_node = ofw_tree_node_alloc();
112	if (peer_node) {	127	if (peer_node) {
113	ofw_tree_node_process(peer_node, parent_node, peer);	128	ofw_tree_node_process(peer_node, parent_node, peer);
114	current_node->peer = peer_node;	129	current_node->peer = peer_node;
115	}	130	}
116	}	131	}
117		132
118	/*	133	/*
119	* Recursively process the potential child node.	134	* Recursively process the potential child node.
120	*/	135	*/
121	child = ofw_get_child_node(current);	136	child = ofw_get_child_node(current);
122	if (child != 0 && child != -1) {	137	if (child != 0 && child != -1) {
123	ofw_tree_node_t *child_node;	138	ofw_tree_node_t *child_node;
124		139
125	child_node = ofw_tree_node_alloc();	140	child_node = ofw_tree_node_alloc();
126	if (child_node) {	141	if (child_node) {
127	ofw_tree_node_process(child_node, current_node, child);	142	ofw_tree_node_process(child_node, current_node, child);
128	current_node->child = child_node;	143	current_node->child = child_node;
129	}	144	}
130	}	145	}
131		146
132	/*	147	/*
133	* Count properties.	148	* Count properties.
134	*/	149	*/
135	name[0] = '\0';	150	name[0] = '\0';
136	while (ofw_next_property(current, name, name) == 1)	151	while (ofw_next_property(current, name, name) == 1)
137	current_node->properties++;	152	current_node->properties++;
138		153
139	if (!current_node->properties)	154	if (!current_node->properties)
140	return;	155	return;
141		156
142	/*	157	/*
143	* Copy properties.	158	* Copy properties.
144	*/	159	*/
145	current_node->property = ofw_tree_properties_alloc(current_node->properties);	160	current_node->property = ofw_tree_properties_alloc(current_node->properties);
146	if (!current_node->property)	161	if (!current_node->property)
147	return;	162	return;
148		163
149	name[0] = '\0';	164	name[0] = '\0';
150	for (i = 0; ofw_next_property(current, name, name) == 1; i++) {	165	for (i = 0; ofw_next_property(current, name, name) == 1; i++) {
151	size_t size;	166	size_t size;
152		167
153	if (i == current_node->properties)	168	if (i == current_node->properties)
154	break;	169	break;
155		170
156	strncpy(current_node->property[i].name, name, sizeof(name));	171	memcpy(current_node->property[i].name, name, OFW_TREE_PROPERTY_MAX_NAMELEN);
-		172	current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0';
157		173
158	size = ofw_get_proplen(current, name);	174	size = ofw_get_proplen(current, name);
159	current_node->property[i].size = size;	175	current_node->property[i].size = size;
160	if (size) {	176	if (size) {
161	void *buf;	177	void *buf;
162		178
163	buf = ofw_tree_space_alloc(size);	179	buf = ofw_tree_space_alloc(size);
164	if (current_node->property[i].value = buf) {	180	if (current_node->property[i].value = buf) {
165	/*	181	/*
166	* Copy property value to memory node.	182	* Copy property value to memory node.
167	*/	183	*/
168	(void) ofw_get_property(current, name, buf, size);	184	(void) ofw_get_property(current, name, buf, size);
169	}	185	}
170	} else {	186	} else {
171	current_node->property[i].value = NULL;	187	current_node->property[i].value = NULL;
172	}	188	}
173	}	189	}
174		190
175	current_node->properties = i; /* Just in case we ran out of memory. */	191	current_node->properties = i; /* Just in case we ran out of memory. */
176	}	192	}
177		193
178	/** Construct memory representation of OpenFirmware device tree.	194	/** Construct memory representation of OpenFirmware device tree.
179	*	195	*
180	* @return NULL on failure or pointer to the root node.	196	* @return NULL on failure or pointer to the root node.
181	*/	197	*/
182	ofw_tree_node_t *ofw_tree_build(void)	198	ofw_tree_node_t *ofw_tree_build(void)
183	{	199	{
184	ofw_tree_node_t *root;	200	ofw_tree_node_t *root;
185		201
186	root = ofw_tree_node_alloc();	202	root = ofw_tree_node_alloc();
187	if (root)	203	if (root)
188	ofw_tree_node_process(root, NULL, ofw_root);	204	ofw_tree_node_process(root, NULL, ofw_root);
189		205
190	return root;	206	return root;
191	}	207	}
192		208

Subversion Repositories HelenOS

(root)/trunk/boot/genarch/ofw_tree.c – Rev 1895 → 1896