Rev 2071 | Rev 3796 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed
Rev | Author | Line No. | Line |
---|---|---|---|
1893 | jermar | 1 | /* |
2071 | jermar | 2 | * Copyright (c) 2006 Jakub Jermar |
1893 | 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 | #include <ofw_tree.h> |
||
30 | #include <ofw.h> |
||
31 | #include <types.h> |
||
32 | #include <string.h> |
||
1894 | jermar | 33 | #include <balloc.h> |
1895 | jermar | 34 | #include <asm.h> |
1893 | jermar | 35 | |
1895 | jermar | 36 | #define MAX_PATH_LEN 256 |
37 | |||
1893 | jermar | 38 | static ofw_tree_node_t *ofw_tree_node_alloc(void) |
39 | { |
||
1894 | jermar | 40 | return balloc(sizeof(ofw_tree_node_t), sizeof(ofw_tree_node_t)); |
1893 | jermar | 41 | } |
42 | |||
43 | static ofw_tree_property_t *ofw_tree_properties_alloc(unsigned count) |
||
44 | { |
||
1894 | jermar | 45 | return balloc(count * sizeof(ofw_tree_property_t), sizeof(ofw_tree_property_t)); |
1893 | jermar | 46 | } |
47 | |||
48 | static void * ofw_tree_space_alloc(size_t size) |
||
49 | { |
||
1896 | jermar | 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 | */ |
||
62 | addr = balloc(size + 1, size); |
||
63 | if (addr) |
||
64 | addr[size] = '\0'; |
||
65 | return addr; |
||
1893 | jermar | 66 | } |
67 | |||
68 | /** Transfer information from one OpenFirmware node into its memory representation. |
||
69 | * |
||
70 | * Transfer entire information from the OpenFirmware device tree 'current' node to |
||
71 | * its memory representation in 'current_node'. This function recursively processes |
||
1973 | jermar | 72 | * all node's children. Node's peers are processed iteratively in order to prevent |
73 | * stack from overflowing. |
||
1893 | jermar | 74 | * |
75 | * @param current_node Pointer to uninitialized ofw_tree_node structure that will |
||
76 | * become the memory represenation of 'current'. |
||
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. |
||
79 | */ |
||
80 | static void ofw_tree_node_process(ofw_tree_node_t *current_node, |
||
81 | ofw_tree_node_t *parent_node, phandle current) |
||
82 | { |
||
1895 | jermar | 83 | static char path[MAX_PATH_LEN+1]; |
84 | static char name[OFW_TREE_PROPERTY_MAX_NAMELEN]; |
||
1893 | jermar | 85 | phandle peer; |
86 | phandle child; |
||
1895 | jermar | 87 | size_t len; |
88 | int i; |
||
1893 | jermar | 89 | |
1973 | jermar | 90 | while (current_node) { |
91 | /* |
||
92 | * Initialize node. |
||
93 | */ |
||
94 | current_node->parent = parent_node; |
||
95 | current_node->peer = NULL; |
||
96 | current_node->child = NULL; |
||
97 | current_node->node_handle = current; |
||
98 | current_node->properties = 0; |
||
99 | current_node->property = NULL; |
||
100 | current_node->device = NULL; |
||
1893 | jermar | 101 | |
1973 | jermar | 102 | /* |
103 | * Get the disambigued name. |
||
104 | */ |
||
105 | len = ofw_package_to_path(current, path, MAX_PATH_LEN); |
||
106 | if (len == -1) |
||
107 | return; |
||
1895 | jermar | 108 | |
1973 | jermar | 109 | path[len] = '\0'; |
110 | for (i = len - 1; i >= 0 && path[i] != '/'; i--) |
||
111 | ; |
||
112 | i++; /* do not include '/' */ |
||
1895 | jermar | 113 | |
1973 | jermar | 114 | len -= i; |
115 | |||
116 | /* add space for trailing '\0' */ |
||
117 | current_node->da_name = ofw_tree_space_alloc(len + 1); |
||
118 | if (!current_node->da_name) |
||
119 | return; |
||
1895 | jermar | 120 | |
1973 | jermar | 121 | memcpy(current_node->da_name, &path[i], len); |
122 | current_node->da_name[len] = '\0'; |
||
1895 | jermar | 123 | |
1973 | jermar | 124 | /* |
125 | * Recursively process the potential child node. |
||
126 | */ |
||
127 | child = ofw_get_child_node(current); |
||
128 | if (child != 0 && child != -1) { |
||
129 | ofw_tree_node_t *child_node; |
||
1893 | jermar | 130 | |
1973 | jermar | 131 | child_node = ofw_tree_node_alloc(); |
132 | if (child_node) { |
||
133 | ofw_tree_node_process(child_node, current_node, child); |
||
134 | current_node->child = child_node; |
||
135 | } |
||
1893 | jermar | 136 | } |
137 | |||
1973 | jermar | 138 | /* |
139 | * Count properties. |
||
140 | */ |
||
141 | name[0] = '\0'; |
||
142 | while (ofw_next_property(current, name, name) == 1) |
||
143 | current_node->properties++; |
||
1893 | jermar | 144 | |
1973 | jermar | 145 | if (!current_node->properties) |
146 | return; |
||
1893 | jermar | 147 | |
1973 | jermar | 148 | /* |
149 | * Copy properties. |
||
150 | */ |
||
151 | current_node->property = ofw_tree_properties_alloc(current_node->properties); |
||
152 | if (!current_node->property) |
||
153 | return; |
||
1893 | jermar | 154 | |
1973 | jermar | 155 | name[0] = '\0'; |
156 | for (i = 0; ofw_next_property(current, name, name) == 1; i++) { |
||
157 | size_t size; |
||
1893 | jermar | 158 | |
1973 | jermar | 159 | if (i == current_node->properties) |
160 | break; |
||
1893 | jermar | 161 | |
1973 | jermar | 162 | memcpy(current_node->property[i].name, name, |
163 | OFW_TREE_PROPERTY_MAX_NAMELEN); |
||
164 | current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0'; |
||
1893 | jermar | 165 | |
1973 | jermar | 166 | size = ofw_get_proplen(current, name); |
167 | current_node->property[i].size = size; |
||
168 | if (size) { |
||
169 | void *buf; |
||
1893 | jermar | 170 | |
1973 | jermar | 171 | buf = ofw_tree_space_alloc(size); |
172 | if (current_node->property[i].value = buf) { |
||
173 | /* |
||
174 | * Copy property value to memory node. |
||
175 | */ |
||
176 | (void) ofw_get_property(current, name, buf, size); |
||
177 | } |
||
178 | } else { |
||
179 | current_node->property[i].value = NULL; |
||
180 | } |
||
181 | } |
||
182 | |||
183 | current_node->properties = i; /* Just in case we ran out of memory. */ |
||
184 | |||
185 | /* |
||
186 | * Iteratively process the next peer node. |
||
187 | * Note that recursion is a bad idea here. |
||
188 | * Due to the topology of the OpenFirmware device tree, |
||
189 | * the nesting of peer nodes could be to wide and the |
||
190 | * risk of overflowing the stack is too real. |
||
191 | */ |
||
192 | peer = ofw_get_peer_node(current); |
||
193 | if (peer != 0 && peer != -1) { |
||
194 | ofw_tree_node_t *peer_node; |
||
195 | |||
196 | peer_node = ofw_tree_node_alloc(); |
||
197 | if (peer_node) { |
||
198 | current_node->peer = peer_node; |
||
199 | current_node = peer_node; |
||
200 | current = peer; |
||
1893 | jermar | 201 | /* |
1973 | jermar | 202 | * Process the peer in next iteration. |
1893 | jermar | 203 | */ |
1973 | jermar | 204 | continue; |
1893 | jermar | 205 | } |
206 | } |
||
1973 | jermar | 207 | /* |
208 | * No more peers on this level. |
||
209 | */ |
||
210 | break; |
||
1893 | jermar | 211 | } |
212 | } |
||
213 | |||
214 | /** Construct memory representation of OpenFirmware device tree. |
||
215 | * |
||
216 | * @return NULL on failure or pointer to the root node. |
||
217 | */ |
||
218 | ofw_tree_node_t *ofw_tree_build(void) |
||
219 | { |
||
220 | ofw_tree_node_t *root; |
||
3672 | jermar | 221 | phandle ssm_node; |
222 | ofw_tree_node_t *ssm; |
||
1893 | jermar | 223 | |
224 | root = ofw_tree_node_alloc(); |
||
225 | if (root) |
||
226 | ofw_tree_node_process(root, NULL, ofw_root); |
||
3672 | jermar | 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 | } |
||
1893 | jermar | 243 | |
244 | return root; |
||
245 | } |