Subversion Repositories HelenOS

Rev

Rev 2927 | Rev 4339 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed

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
/** @addtogroup ofw
29
/** @addtogroup ofw
30
 * @{
30
 * @{
31
 */
31
 */
32
/**
32
/**
33
 * @file
33
 * @file
34
 * @brief   OpenFirmware device tree navigation.
34
 * @brief   OpenFirmware device tree navigation.
35
 *
35
 *
36
 */
36
 */
37
 
37
 
38
#include <genarch/ofw/ofw_tree.h>
38
#include <genarch/ofw/ofw_tree.h>
39
#include <arch/memstr.h>
39
#include <arch/memstr.h>
40
#include <mm/slab.h>
40
#include <mm/slab.h>
41
#include <func.h>
41
#include <func.h>
42
#include <print.h>
42
#include <print.h>
43
#include <panic.h>
43
#include <panic.h>
44
 
44
 
45
#define PATH_MAX_LEN    80
45
#define PATH_MAX_LEN    80
46
#define NAME_BUF_LEN    50
46
#define NAME_BUF_LEN    50
47
 
47
 
48
static ofw_tree_node_t *ofw_root;
48
static ofw_tree_node_t *ofw_root;
49
 
49
 
50
void ofw_tree_init(ofw_tree_node_t *root)
50
void ofw_tree_init(ofw_tree_node_t *root)
51
{
51
{
52
    ofw_root = root;
52
    ofw_root = root;
53
}
53
}
54
 
54
 
55
/** Get OpenFirmware node property.
55
/** Get OpenFirmware node property.
56
 *
56
 *
57
 * @param node Node in which to lookup the property.
57
 * @param node      Node in which to lookup the property.
58
 * @param name Name of the property.
58
 * @param name      Name of the property.
59
 *
59
 *
60
 * @return Pointer to the property structure or NULL if no such property.
60
 * @return      Pointer to the property structure or NULL if no such
-
 
61
 *          property.
61
 */
62
 */
-
 
63
ofw_tree_property_t *
62
ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name)
64
ofw_tree_getprop(const ofw_tree_node_t *node, const char *name)
63
{
65
{
64
    unsigned int i;
66
    unsigned int i;
65
   
67
   
66
    for (i = 0; i < node->properties; i++) {
68
    for (i = 0; i < node->properties; i++) {
67
        if (strcmp(node->property[i].name, name) == 0)
69
        if (strcmp(node->property[i].name, name) == 0)
68
            return &node->property[i];
70
            return &node->property[i];
69
    }
71
    }
70
 
72
 
71
    return NULL;
73
    return NULL;
72
}
74
}
73
 
75
 
74
/** Return value of the 'name' property.
76
/** Return value of the 'name' property.
75
 *
77
 *
76
 * @param node Node of interest.
78
 * @param node      Node of interest.
77
 *
79
 *
78
 * @return Value of the 'name' property belonging to the node.
80
 * @return      Value of the 'name' property belonging to the node.
79
 */
81
 */
80
const char *ofw_tree_node_name(const ofw_tree_node_t *node)
82
const char *ofw_tree_node_name(const ofw_tree_node_t *node)
81
{
83
{
82
    ofw_tree_property_t *prop;
84
    ofw_tree_property_t *prop;
83
   
85
   
84
    prop = ofw_tree_getprop(node, "name");
86
    prop = ofw_tree_getprop(node, "name");
85
    if (!prop)
87
    if (!prop)
86
        panic("Node without name property.\n");
88
        panic("Node without name property.\n");
87
       
89
       
88
    if (prop->size < 2)
90
    if (prop->size < 2)
89
        panic("Invalid name property.\n");
91
        panic("Invalid name property.\n");
90
   
92
   
91
    return prop->value;
93
    return prop->value;
92
}
94
}
93
 
95
 
94
/** Lookup child of given name.
96
/** Lookup child of given name.
95
 *
97
 *
96
 * @param node Node whose child is being looked up.
98
 * @param node      Node whose child is being looked up.
97
 * @param name Name of the child being looked up.
99
 * @param name      Name of the child being looked up.
98
 *
100
 *
99
 * @return NULL if there is no such child or pointer to the matching child node.
101
 * @return      NULL if there is no such child or pointer to the
-
 
102
 *          matching child node.
100
 */
103
 */
101
ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name)
104
ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name)
102
{
105
{
103
    ofw_tree_node_t *cur;
106
    ofw_tree_node_t *cur;
104
   
107
   
105
    /*
108
    /*
106
     * Try to find the disambigued name.
109
     * Try to find the disambigued name.
107
     */
110
     */
108
    for (cur = node->child; cur; cur = cur->peer) {
111
    for (cur = node->child; cur; cur = cur->peer) {
109
        if (strcmp(cur->da_name, name) == 0)
112
        if (strcmp(cur->da_name, name) == 0)
110
            return cur;
113
            return cur;
111
    }
114
    }
112
   
115
   
113
    /*
116
    /*
114
     * Disambigued name not found.
117
     * Disambigued name not found.
115
     * Lets try our luck with possibly ambiguous "name" property.
118
     * Lets try our luck with possibly ambiguous "name" property.
116
     *
119
     *
117
     * We need to do this because paths stored in "/aliases"
120
     * We need to do this because paths stored in "/aliases"
118
     * are not always fully-qualified.
121
     * are not always fully-qualified.
119
     */
122
     */
120
    for (cur = node->child; cur; cur = cur->peer) {
123
    for (cur = node->child; cur; cur = cur->peer) {
121
        if (strcmp(ofw_tree_node_name(cur), name) == 0)
124
        if (strcmp(ofw_tree_node_name(cur), name) == 0)
122
            return cur;
125
            return cur;
123
    }
126
    }
124
       
127
       
125
    return NULL;
128
    return NULL;
126
}
129
}
127
 
130
 
128
/** Lookup first child of given device type.
131
/** Lookup first child of given device type.
129
 *
132
 *
130
 * @param node Node whose child is being looked up.
133
 * @param node      Node whose child is being looked up.
131
 * @param name Device type of the child being looked up.
134
 * @param name      Device type of the child being looked up.
132
 *
135
 *
133
 * @return NULL if there is no such child or pointer to the matching child node.
136
 * @return      NULL if there is no such child or pointer to the
-
 
137
 *          matching child node.
134
 */
138
 */
-
 
139
ofw_tree_node_t *
135
ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *name)
140
ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *name)
136
{
141
{
137
    ofw_tree_node_t *cur;
142
    ofw_tree_node_t *cur;
138
    ofw_tree_property_t *prop;
143
    ofw_tree_property_t *prop;
139
   
144
   
140
    for (cur = node->child; cur; cur = cur->peer) {
145
    for (cur = node->child; cur; cur = cur->peer) {
141
        prop = ofw_tree_getprop(cur, "device_type");
146
        prop = ofw_tree_getprop(cur, "device_type");
142
        if (!prop || !prop->value)
147
        if (!prop || !prop->value)
143
            continue;
148
            continue;
144
        if (strcmp(prop->value, name) == 0)
149
        if (strcmp(prop->value, name) == 0)
145
            return cur;
150
            return cur;
146
    }
151
    }
147
           
152
           
148
    return NULL;
153
    return NULL;
149
}
154
}
150
 
155
 
151
/** Lookup node with matching node_handle.
156
/** Lookup node with matching node_handle.
152
 *
157
 *
153
 * Child nodes are looked up recursively contrary to peer nodes that
158
 * Child nodes are looked up recursively contrary to peer nodes that
154
 * are looked up iteratively to avoid stack overflow.
159
 * are looked up iteratively to avoid stack overflow.
155
 *
160
 *
156
 * @param root Root of the searched subtree.
161
 * @param root      Root of the searched subtree.
157
 * @param handle OpenFirmware handle.
162
 * @param handle    OpenFirmware handle.
158
 *
163
 *
159
 * @return NULL if there is no such node or pointer to the matching node.
164
 * @return      NULL if there is no such node or pointer to the matching
-
 
165
 *          node.
160
 */
166
 */
-
 
167
ofw_tree_node_t *
161
ofw_tree_node_t *ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle)
168
ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle)
162
{
169
{
163
    ofw_tree_node_t *cur;
170
    ofw_tree_node_t *cur;
164
 
171
 
165
    for (cur = root; cur; cur = cur->peer) {       
172
    for (cur = root; cur; cur = cur->peer) {       
166
        if (cur->node_handle == handle)
173
        if (cur->node_handle == handle)
167
            return cur;
174
            return cur;
168
 
175
 
169
        if (cur->child) {
176
        if (cur->child) {
170
            ofw_tree_node_t *node;
177
            ofw_tree_node_t *node;
171
           
178
           
172
            node = ofw_tree_find_node_by_handle(cur->child, handle);
179
            node = ofw_tree_find_node_by_handle(cur->child, handle);
173
            if (node)
180
            if (node)
174
                return node;
181
                return node;
175
        }
182
        }
176
    }
183
    }
177
   
184
   
178
    return NULL;   
185
    return NULL;   
179
}
186
}
180
 
187
 
181
/** Lookup first peer of given device type.
188
/** Lookup first peer of given device type.
182
 *
189
 *
183
 * @param node Node whose peer is being looked up.
190
 * @param node      Node whose peer is being looked up.
184
 * @param name Device type of the child being looked up.
191
 * @param name      Device type of the child being looked up.
185
 *
192
 *
186
 * @return NULL if there is no such child or pointer to the matching child node.
193
 * @return      NULL if there is no such child or pointer to the
-
 
194
 *          matching child node.
187
 */
195
 */
-
 
196
ofw_tree_node_t *
188
ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *name)
197
ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *name)
189
{
198
{
190
    ofw_tree_node_t *cur;
199
    ofw_tree_node_t *cur;
191
    ofw_tree_property_t *prop;
200
    ofw_tree_property_t *prop;
192
   
201
   
193
    for (cur = node->peer; cur; cur = cur->peer) {
202
    for (cur = node->peer; cur; cur = cur->peer) {
194
        prop = ofw_tree_getprop(cur, "device_type");
203
        prop = ofw_tree_getprop(cur, "device_type");
195
        if (!prop || !prop->value)
204
        if (!prop || !prop->value)
196
            continue;
205
            continue;
197
        if (strcmp(prop->value, name) == 0)
206
        if (strcmp(prop->value, name) == 0)
198
            return cur;
207
            return cur;
199
    }
208
    }
200
           
209
           
201
    return NULL;
210
    return NULL;
202
}
211
}
203
 
212
 
204
 
213
 
-
 
214
/** Lookup first peer of given name.
-
 
215
 *
-
 
216
 * @param node      Node whose peer is being looked up.
-
 
217
 * @param name      Name of the child being looked up.
-
 
218
 *
-
 
219
 * @return      NULL if there is no such peer or pointer to the matching
-
 
220
 *          peer node.
-
 
221
 */
-
 
222
ofw_tree_node_t *
-
 
223
ofw_tree_find_peer_by_name(ofw_tree_node_t *node, const char *name)
-
 
224
{
-
 
225
    ofw_tree_node_t *cur;
-
 
226
    ofw_tree_property_t *prop;
-
 
227
   
-
 
228
    for (cur = node->peer; cur; cur = cur->peer) {
-
 
229
        prop = ofw_tree_getprop(cur, "name");
-
 
230
        if (!prop || !prop->value)
-
 
231
            continue;
-
 
232
        if (strcmp(prop->value, name) == 0)
-
 
233
            return cur;
-
 
234
    }
-
 
235
           
-
 
236
    return NULL;
-
 
237
}
-
 
238
 
205
/** Lookup OpenFirmware node by its path.
239
/** Lookup OpenFirmware node by its path.
206
 *
240
 *
207
 * @param path Path to the node.
241
 * @param path      Path to the node.
208
 *
242
 *
209
 * @return NULL if there is no such node or pointer to the leaf node.
243
 * @return      NULL if there is no such node or pointer to the leaf
-
 
244
 *          node.
210
 */
245
 */
211
ofw_tree_node_t *ofw_tree_lookup(const char *path)
246
ofw_tree_node_t *ofw_tree_lookup(const char *path)
212
{
247
{
213
    char buf[NAME_BUF_LEN+1];
248
    char buf[NAME_BUF_LEN + 1];
214
    ofw_tree_node_t *node = ofw_root;
249
    ofw_tree_node_t *node = ofw_root;
215
    index_t i, j;
250
    index_t i, j;
216
   
251
   
217
    if (path[0] != '/')
252
    if (path[0] != '/')
218
        return NULL;
253
        return NULL;
219
   
254
   
220
    for (i = 1; i < strlen(path) && node; i = j + 1) {
255
    for (i = 1; i < strlen(path) && node; i = j + 1) {
221
        for (j = i; j < strlen(path) && path[j] != '/'; j++)
256
        for (j = i; j < strlen(path) && path[j] != '/'; j++)
222
            ;
257
            ;
223
        if (i == j) /* skip extra slashes */
258
        if (i == j) /* skip extra slashes */
224
            continue;
259
            continue;
225
           
260
           
226
        memcpy(buf, &path[i], j - i);
261
        memcpy(buf, &path[i], j - i);
227
        buf[j - i] = '\0';
262
        buf[j - i] = '\0';
228
        node = ofw_tree_find_child(node, buf);
263
        node = ofw_tree_find_child(node, buf);
229
    }
264
    }
230
   
265
   
231
    return node;
266
    return node;
232
}
267
}
233
 
268
 
234
/** Print OpenFirmware device subtree rooted in a node.
269
/** Print OpenFirmware device subtree rooted in a node.
235
 *
270
 *
236
 * Child nodes are processed recursively and peer nodes are processed
271
 * Child nodes are processed recursively and peer nodes are processed
237
 * iteratively in order to avoid stack overflow.
272
 * iteratively in order to avoid stack overflow.
238
 *
273
 *
239
 * @param node Root of the subtree.
274
 * @param node      Root of the subtree.
240
 * @param path Current path, NULL for the very root of the entire tree.
275
 * @param path      Current path, NULL for the very root of the entire tree.
241
 */
276
 */
242
static void ofw_tree_node_print(const ofw_tree_node_t *node, const char *path)
277
static void ofw_tree_node_print(const ofw_tree_node_t *node, const char *path)
243
{
278
{
244
    char *p;
279
    char *p;
245
    const ofw_tree_node_t *cur;
280
    const ofw_tree_node_t *cur;
246
 
281
 
247
    p = (char *) malloc(PATH_MAX_LEN, 0);
282
    p = (char *) malloc(PATH_MAX_LEN, 0);
248
 
283
 
249
    for (cur = node; cur; cur = cur->peer) {
284
    for (cur = node; cur; cur = cur->peer) {
250
        if (cur->parent) {
285
        if (cur->parent) {
251
            snprintf(p, PATH_MAX_LEN, "%s/%s", path, cur->da_name);
286
            snprintf(p, PATH_MAX_LEN, "%s/%s", path, cur->da_name);
252
            printf("%s\n", p);
287
            printf("%s\n", p);
253
        } else {
288
        } else {
254
            snprintf(p, PATH_MAX_LEN, "%s", cur->da_name);
289
            snprintf(p, PATH_MAX_LEN, "%s", cur->da_name);
255
            printf("/\n");
290
            printf("/\n");
256
        }
291
        }
257
 
292
 
258
        if (cur->child)
293
        if (cur->child)
259
            ofw_tree_node_print(cur->child, p);
294
            ofw_tree_node_print(cur->child, p);
260
    }
295
    }
261
 
296
 
262
    free(p);
297
    free(p);
263
}
298
}
264
 
299
 
265
/** Print the structure of the OpenFirmware device tree. */
300
/** Print the structure of the OpenFirmware device tree. */
266
void ofw_tree_print(void)
301
void ofw_tree_print(void)
267
{
302
{
268
    ofw_tree_node_print(ofw_root, NULL);
303
    ofw_tree_node_print(ofw_root, NULL);
269
}
304
}
270
 
305
 
271
/** @}
306
/** @}
272
 */
307
 */
273
 
308