Subversion Repositories HelenOS

Rev

Rev 1896 | Rev 1908 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
1894 jermar 1
/*
2
 * Copyright (C) 2006 Jakub Jermar
3
 * All rights reserved.
4
 *
5
 * Redistribution and use in source and binary forms, with or without
6
 * modification, are permitted provided that the following conditions
7
 * are met:
8
 *
9
 * - Redistributions of source code must retain the above copyright
10
 *   notice, this list of conditions and the following disclaimer.
11
 * - Redistributions in binary form must reproduce the above copyright
12
 *   notice, this list of conditions and the following disclaimer in the
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
15
 *   derived from this software without specific prior written permission.
16
 *
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
19
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
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
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
26
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27
 */
28
 
29
/** @addtogroup ofw
30
 * @{
31
 */
32
/**
33
 * @file
34
 * @brief   OpenFirmware device tree navigation.
35
 *
36
 */
37
 
1895 jermar 38
#include <genarch/ofw/ofw_tree.h>
39
#include <arch/memstr.h>
40
#include <func.h>
41
#include <print.h>
42
#include <panic.h>
43
 
44
#define PATH_MAX_LEN    80
45
#define NAME_BUF_LEN    50
46
 
47
static ofw_tree_node_t *ofw_root;
48
 
49
void ofw_tree_init(ofw_tree_node_t *root)
50
{
51
    ofw_root = root;
52
}
53
 
1896 jermar 54
/** Get OpenFirmware node property.
55
 *
56
 * @param node Node in which to lookup the property.
57
 * @param name Name of the property.
58
 *
59
 * @return Pointer to the property structure or NULL if no such property.
60
 */
61
ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name)
62
{
63
    int i;
64
 
65
    for (i = 0; i < node->properties; i++) {
66
        if (strcmp(node->property[i].name, name) == 0)
67
            return &node->property[i];
68
    }
69
 
70
    return NULL;
71
}
72
 
1895 jermar 73
/** Return value of the 'name' property.
74
 *
75
 * @param node Node of interest.
76
 *
77
 * @return Value of the 'name' property belonging to the node.
78
 */
79
const char *ofw_tree_node_name(const ofw_tree_node_t *node)
80
{
1896 jermar 81
    ofw_tree_property_t *prop;
1895 jermar 82
 
1896 jermar 83
    prop = ofw_tree_getprop(node, "name");
84
    if (!prop)
85
        panic("Node without name property.\n");
86
 
87
    if (prop->size < 2)
88
        panic("Invalid name property.\n");
1895 jermar 89
 
1896 jermar 90
    return prop->value;
1895 jermar 91
}
92
 
93
/** Lookup child of given name.
94
 *
95
 * @param node Node whose child is being looked up.
1896 jermar 96
 * @param name Name of the child being looked up.
1895 jermar 97
 *
98
 * @return NULL if there is no such child or pointer to the matching child node.
99
 */
1899 jermar 100
ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name)
1895 jermar 101
{
102
    ofw_tree_node_t *cur;
103
 
1896 jermar 104
    /*
105
     * Try to find the disambigued name.
106
     */
1895 jermar 107
    for (cur = node->child; cur; cur = cur->peer) {
1896 jermar 108
        if (strcmp(cur->da_name, name) == 0)
1895 jermar 109
            return cur;
110
    }
111
 
1896 jermar 112
    /*
113
     * Disambigued name not found.
114
     * Lets try our luck with possibly ambiguous "name" property.
115
     *
116
     * We need to do this because paths stored in "/aliases"
117
     * are not always fully-qualified.
118
     */
119
    for (cur = node->child; cur; cur = cur->peer) {
120
        if (strcmp(ofw_tree_node_name(cur), name) == 0)
121
            return cur;
122
    }
123
 
1895 jermar 124
    return NULL;
125
}
126
 
1899 jermar 127
/** Lookup first child of given device type.
128
 *
129
 * @param node Node whose child is being looked up.
130
 * @param name Device type of the child being looked up.
131
 *
132
 * @return NULL if there is no such child or pointer to the matching child node.
133
 */
134
ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *name)
135
{
136
    ofw_tree_node_t *cur;
137
    ofw_tree_property_t *prop;
138
 
139
    for (cur = node->child; cur; cur = cur->peer) {
140
        prop = ofw_tree_getprop(cur, "device_type");
141
        if (!prop || !prop->value)
142
            continue;
143
        if (strcmp(prop->value, name) == 0)
144
            return cur;
145
    }
146
 
147
    return NULL;
148
}
149
 
150
/** Lookup first peer of given device type.
151
 *
152
 * @param node Node whose peer is being looked up.
153
 * @param name Device type of the child being looked up.
154
 *
155
 * @return NULL if there is no such child or pointer to the matching child node.
156
 */
157
ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *name)
158
{
159
    ofw_tree_node_t *cur;
160
    ofw_tree_property_t *prop;
161
 
162
    for (cur = node->peer; cur; cur = cur->peer) {
163
        prop = ofw_tree_getprop(cur, "device_type");
164
        if (!prop || !prop->value)
165
            continue;
166
        if (strcmp(prop->value, name) == 0)
167
            return cur;
168
    }
169
 
170
    return NULL;
171
}
172
 
173
 
1895 jermar 174
/** Lookup OpenFirmware node by its path.
175
 *
176
 * @param path Path to the node.
177
 *
178
 * @return NULL if there is no such node or pointer to the leaf node.
179
 */
180
ofw_tree_node_t *ofw_tree_lookup(const char *path)
181
{
182
    char buf[NAME_BUF_LEN+1];
183
    ofw_tree_node_t *node = ofw_root;
184
    index_t i, j;
185
 
186
    if (path[0] != '/')
187
        return NULL;
188
 
189
    for (i = 1; i < strlen(path) && node; i = j + 1) {
190
        for (j = i; j < strlen(path) && path[j] != '/'; j++)
191
            ;
192
        if (i == j) /* skip extra slashes */
193
            continue;
194
 
195
        memcpy(buf, &path[i], j - i);
196
        buf[j - i] = '\0';
197
        node = ofw_tree_find_child(node, buf);
198
    }
199
 
200
    return node;
201
}
202
 
203
/** Recursively print subtree rooted in a node.
204
 *
205
 * @param node Root of the subtree.
206
 * @param path Current path, NULL for the very root of the entire tree.
207
 */
208
static void ofw_tree_node_print(const ofw_tree_node_t *node, const char *path)
209
{
210
    char p[PATH_MAX_LEN];
211
 
212
    if (node->parent) {
213
        snprintf(p, PATH_MAX_LEN, "%s/%s", path, node->da_name);
214
        printf("%s\n", p);
215
    } else {
216
        snprintf(p, PATH_MAX_LEN, "%s", node->da_name);
217
        printf("/\n");
218
    }
219
 
220
    if (node->child)
221
        ofw_tree_node_print(node->child, p);
222
 
223
    if (node->peer)
224
        ofw_tree_node_print(node->peer, path);
225
}
226
 
227
/** Print the structure of the OpenFirmware device tree. */
228
void ofw_tree_print(void)
229
{
230
    ofw_tree_node_print(ofw_root, NULL);
231
}
232
 
1894 jermar 233
/** @}
234
 */