WebSVN – HelenOS – Diff – /branches/dynload/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 children. Node's peers are processed iteratively in order to prevent
 * stack from overflowing.
 *
 * @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;
    size_t len;
    int i;
 
    while (current_node) {
        /*
         * Initialize node.
         */
        current_node->parent = parent_node;
        current_node->peer = NULL;
        current_node->child = NULL;
        current_node->node_handle = current;
        current_node->properties = 0;
        current_node->property = NULL;
        current_node->device = 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;
 
        /* add space for trailing '\0' */
        current_node->da_name = ofw_tree_space_alloc(len + 1);
        if (!current_node->da_name)
            return;
   
        memcpy(current_node->da_name, &path[i], len);
        current_node->da_name[len] = '\0';
   
 
        /*
         * 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. */
 
        /*
         * Iteratively process the next peer node.
         * Note that recursion is a bad idea here.
         * Due to the topology of the OpenFirmware device tree,
         * the nesting of peer nodes could be to wide and the
         * risk of overflowing the stack is too real.
         */
        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) {
                current_node->peer = peer_node;
                current_node = peer_node;
                current = peer;
                /*
                 * Process the peer in next iteration.
                 */
                continue;
            }
        }
        /*
         * No more peers on this level.
         */
        break;
    }
}
 
/** 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;
    phandle ssm_node;
    ofw_tree_node_t *ssm;
   
    root = ofw_tree_node_alloc();
    if (root)
        ofw_tree_node_process(root, NULL, ofw_root);
 
    /*
     * The firmware client interface does not automatically include the
     * "ssm" node in the list of children of "/". A nasty yet working
     * solution is to explicitly stick "ssm" to the OFW tree.
     */
    ssm_node = ofw_find_device("/ssm@0,0");
    if (ssm_node != -1) {
        ssm = ofw_tree_node_alloc();
        if (ssm) {
            ofw_tree_node_process(
                ssm, root, ofw_find_device("/ssm@0,0"));
            ssm->peer = root->child;
            root->child = ssm;
        }
    }
   
    return root;
}
 

Rev 2927	Rev 3674
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;	50	char *addr;
51		51
52	/*	52	/*
53	* What we do here is a nasty hack :-)	53	* What we do here is a nasty hack :-)
54	* Problem: string property values that are allocated via this	54	* Problem: string property values that are allocated via this
55	* function typically do not contain the trailing '\0'. This	55	* function typically do not contain the trailing '\0'. This
56	* is very uncomfortable for kernel, which is supposed to deal	56	* is very uncomfortable for kernel, which is supposed to deal
57	* with the properties.	57	* with the properties.
58	* Solution: when allocating space via this function, we always	58	* Solution: when allocating space via this function, we always
59	* allocate space for the extra '\0' character that we store	59	* allocate space for the extra '\0' character that we store
60	* behind the requested memory.	60	* behind the requested memory.
61	*/	61	*/
62	addr = balloc(size + 1, size);	62	addr = balloc(size + 1, size);
63	if (addr)	63	if (addr)
64	addr[size] = '\0';	64	addr[size] = '\0';
65	return addr;	65	return addr;
66	}	66	}
67		67
68	/** Transfer information from one OpenFirmware node into its memory representation.	68	/** Transfer information from one OpenFirmware node into its memory representation.
69	*	69	*
70	* Transfer entire information from the OpenFirmware device tree 'current' node to	70	* Transfer entire information from the OpenFirmware device tree 'current' node to
71	* its memory representation in 'current_node'. This function recursively processes	71	* its memory representation in 'current_node'. This function recursively processes
72	* all node's children. Node's peers are processed iteratively in order to prevent	72	* all node's children. Node's peers are processed iteratively in order to prevent
73	* stack from overflowing.	73	* stack from overflowing.
74	*	74	*
75	* @param current_node Pointer to uninitialized ofw_tree_node structure that will	75	* @param current_node Pointer to uninitialized ofw_tree_node structure that will
76	* become the memory represenation of 'current'.	76	* become the memory represenation of 'current'.
77	* @param parent_node Parent ofw_tree_node structure or NULL in case of root node.	77	* @param parent_node Parent ofw_tree_node structure or NULL in case of root node.
78	* @param current OpenFirmware phandle to the current device tree node.	78	* @param current OpenFirmware phandle to the current device tree node.
79	*/	79	*/
80	static void ofw_tree_node_process(ofw_tree_node_t *current_node,	80	static void ofw_tree_node_process(ofw_tree_node_t *current_node,
81	ofw_tree_node_t *parent_node, phandle current)	81	ofw_tree_node_t *parent_node, phandle current)
82	{	82	{
83	static char path[MAX_PATH_LEN+1];	83	static char path[MAX_PATH_LEN+1];
84	static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];	84	static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
85	phandle peer;	85	phandle peer;
86	phandle child;	86	phandle child;
87	size_t len;	87	size_t len;
88	int i;	88	int i;
89		89
90	while (current_node) {	90	while (current_node) {
91	/*	91	/*
92	* Initialize node.	92	* Initialize node.
93	*/	93	*/
94	current_node->parent = parent_node;	94	current_node->parent = parent_node;
95	current_node->peer = NULL;	95	current_node->peer = NULL;
96	current_node->child = NULL;	96	current_node->child = NULL;
97	current_node->node_handle = current;	97	current_node->node_handle = current;
98	current_node->properties = 0;	98	current_node->properties = 0;
99	current_node->property = NULL;	99	current_node->property = NULL;
100	current_node->device = NULL;	100	current_node->device = NULL;
101		101
102	/*	102	/*
103	* Get the disambigued name.	103	* Get the disambigued name.
104	*/	104	*/
105	len = ofw_package_to_path(current, path, MAX_PATH_LEN);	105	len = ofw_package_to_path(current, path, MAX_PATH_LEN);
106	if (len == -1)	106	if (len == -1)
107	return;	107	return;
108		108
109	path[len] = '\0';	109	path[len] = '\0';
110	for (i = len - 1; i >= 0 && path[i] != '/'; i--)	110	for (i = len - 1; i >= 0 && path[i] != '/'; i--)
111	;	111	;
112	i++; /* do not include '/' */	112	i++; /* do not include '/' */
113		113
114	len -= i;	114	len -= i;
115		115
116	/* add space for trailing '\0' */	116	/* add space for trailing '\0' */
117	current_node->da_name = ofw_tree_space_alloc(len + 1);	117	current_node->da_name = ofw_tree_space_alloc(len + 1);
118	if (!current_node->da_name)	118	if (!current_node->da_name)
119	return;	119	return;
120		120
121	memcpy(current_node->da_name, &path[i], len);	121	memcpy(current_node->da_name, &path[i], len);
122	current_node->da_name[len] = '\0';	122	current_node->da_name[len] = '\0';
123		123
124		-
125	/*	124	/*
126	* Recursively process the potential child node.	125	* Recursively process the potential child node.
127	*/	126	*/
128	child = ofw_get_child_node(current);	127	child = ofw_get_child_node(current);
129	if (child != 0 && child != -1) {	128	if (child != 0 && child != -1) {
130	ofw_tree_node_t *child_node;	129	ofw_tree_node_t *child_node;
131		130
132	child_node = ofw_tree_node_alloc();	131	child_node = ofw_tree_node_alloc();
133	if (child_node) {	132	if (child_node) {
134	ofw_tree_node_process(child_node, current_node, child);	133	ofw_tree_node_process(child_node, current_node, child);
135	current_node->child = child_node;	134	current_node->child = child_node;
136	}	135	}
137	}	136	}
138		137
139	/*	138	/*
140	* Count properties.	139	* Count properties.
141	*/	140	*/
142	name[0] = '\0';	141	name[0] = '\0';
143	while (ofw_next_property(current, name, name) == 1)	142	while (ofw_next_property(current, name, name) == 1)
144	current_node->properties++;	143	current_node->properties++;
145		144
146	if (!current_node->properties)	145	if (!current_node->properties)
147	return;	146	return;
148		147
149	/*	148	/*
150	* Copy properties.	149	* Copy properties.
151	*/	150	*/
152	current_node->property = ofw_tree_properties_alloc(current_node->properties);	151	current_node->property = ofw_tree_properties_alloc(current_node->properties);
153	if (!current_node->property)	152	if (!current_node->property)
154	return;	153	return;
155		154
156	name[0] = '\0';	155	name[0] = '\0';
157	for (i = 0; ofw_next_property(current, name, name) == 1; i++) {	156	for (i = 0; ofw_next_property(current, name, name) == 1; i++) {
158	size_t size;	157	size_t size;
159		158
160	if (i == current_node->properties)	159	if (i == current_node->properties)
161	break;	160	break;
162		161
163	memcpy(current_node->property[i].name, name,	162	memcpy(current_node->property[i].name, name,
164	OFW_TREE_PROPERTY_MAX_NAMELEN);	163	OFW_TREE_PROPERTY_MAX_NAMELEN);
165	current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0';	164	current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0';
166		165
167	size = ofw_get_proplen(current, name);	166	size = ofw_get_proplen(current, name);
168	current_node->property[i].size = size;	167	current_node->property[i].size = size;
169	if (size) {	168	if (size) {
170	void *buf;	169	void *buf;
171		170
172	buf = ofw_tree_space_alloc(size);	171	buf = ofw_tree_space_alloc(size);
173	if (current_node->property[i].value = buf) {	172	if (current_node->property[i].value = buf) {
174	/*	173	/*
175	* Copy property value to memory node.	174	* Copy property value to memory node.
176	*/	175	*/
177	(void) ofw_get_property(current, name, buf, size);	176	(void) ofw_get_property(current, name, buf, size);
178	}	177	}
179	} else {	178	} else {
180	current_node->property[i].value = NULL;	179	current_node->property[i].value = NULL;
181	}	180	}
182	}	181	}
183		182
184	current_node->properties = i; /* Just in case we ran out of memory. */	183	current_node->properties = i; /* Just in case we ran out of memory. */
185		184
186	/*	185	/*
187	* Iteratively process the next peer node.	186	* Iteratively process the next peer node.
188	* Note that recursion is a bad idea here.	187	* Note that recursion is a bad idea here.
189	* Due to the topology of the OpenFirmware device tree,	188	* Due to the topology of the OpenFirmware device tree,
190	* the nesting of peer nodes could be to wide and the	189	* the nesting of peer nodes could be to wide and the
191	* risk of overflowing the stack is too real.	190	* risk of overflowing the stack is too real.
192	*/	191	*/
193	peer = ofw_get_peer_node(current);	192	peer = ofw_get_peer_node(current);
194	if (peer != 0 && peer != -1) {	193	if (peer != 0 && peer != -1) {
195	ofw_tree_node_t *peer_node;	194	ofw_tree_node_t *peer_node;
196		195
197	peer_node = ofw_tree_node_alloc();	196	peer_node = ofw_tree_node_alloc();
198	if (peer_node) {	197	if (peer_node) {
199	current_node->peer = peer_node;	198	current_node->peer = peer_node;
200	current_node = peer_node;	199	current_node = peer_node;
201	current = peer;	200	current = peer;
202	/*	201	/*
203	* Process the peer in next iteration.	202	* Process the peer in next iteration.
204	*/	203	*/
205	continue;	204	continue;
206	}	205	}
207	}	206	}
208	/*	207	/*
209	* No more peers on this level.	208	* No more peers on this level.
210	*/	209	*/
211	break;	210	break;
212	}	211	}
213	}	212	}
214		213
215	/** Construct memory representation of OpenFirmware device tree.	214	/** Construct memory representation of OpenFirmware device tree.
216	*	215	*
217	* @return NULL on failure or pointer to the root node.	216	* @return NULL on failure or pointer to the root node.
218	*/	217	*/
219	ofw_tree_node_t *ofw_tree_build(void)	218	ofw_tree_node_t *ofw_tree_build(void)
220	{	219	{
221	ofw_tree_node_t *root;	220	ofw_tree_node_t *root;
-		221	phandle ssm_node;
-		222	ofw_tree_node_t *ssm;
222		223
223	root = ofw_tree_node_alloc();	224	root = ofw_tree_node_alloc();
224	if (root)	225	if (root)
225	ofw_tree_node_process(root, NULL, ofw_root);	226	ofw_tree_node_process(root, NULL, ofw_root);
-		227
-		228	/*
-		229	* The firmware client interface does not automatically include the
-		230	* "ssm" node in the list of children of "/". A nasty yet working
-		231	* solution is to explicitly stick "ssm" to the OFW tree.
-		232	*/
-		233	ssm_node = ofw_find_device("/ssm@0,0");
-		234	if (ssm_node != -1) {
-		235	ssm = ofw_tree_node_alloc();
-		236	if (ssm) {
-		237	ofw_tree_node_process(
-		238	ssm, root, ofw_find_device("/ssm@0,0"));
-		239	ssm->peer = root->child;
-		240	root->child = ssm;
-		241	}
-		242	}
226		243
227	return root;	244	return root;
228	}	245	}
229		246

Subversion Repositories HelenOS

(root)/branches/dynload/boot/genarch/ofw_tree.c – Rev 2927 → 3674