2 * Copyright (c) 2009-2010 The FreeBSD Foundation
5 * This software was developed by Semihalf under sponsorship from
6 * the FreeBSD Foundation.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 #include <sys/cdefs.h>
31 __FBSDID("$FreeBSD$");
33 #include <sys/param.h>
34 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/systm.h>
38 #include <contrib/libfdt/libfdt.h>
40 #include <machine/stdarg.h>
42 #include <dev/fdt/fdt_common.h>
43 #include <dev/ofw/ofwvar.h>
44 #include <dev/ofw/openfirm.h>
49 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \
50 printf(fmt,##args); } while (0)
52 #define debugf(fmt, args...)
55 static int ofw_fdt_init(ofw_t, void *);
56 static phandle_t ofw_fdt_peer(ofw_t, phandle_t);
57 static phandle_t ofw_fdt_child(ofw_t, phandle_t);
58 static phandle_t ofw_fdt_parent(ofw_t, phandle_t);
59 static phandle_t ofw_fdt_instance_to_package(ofw_t, ihandle_t);
60 static ssize_t ofw_fdt_getproplen(ofw_t, phandle_t, const char *);
61 static ssize_t ofw_fdt_getprop(ofw_t, phandle_t, const char *, void *, size_t);
62 static int ofw_fdt_nextprop(ofw_t, phandle_t, const char *, char *, size_t);
63 static int ofw_fdt_setprop(ofw_t, phandle_t, const char *, const void *,
65 static ssize_t ofw_fdt_canon(ofw_t, const char *, char *, size_t);
66 static phandle_t ofw_fdt_finddevice(ofw_t, const char *);
67 static ssize_t ofw_fdt_instance_to_path(ofw_t, ihandle_t, char *, size_t);
68 static ssize_t ofw_fdt_package_to_path(ofw_t, phandle_t, char *, size_t);
69 static int ofw_fdt_interpret(ofw_t, const char *, int, cell_t *);
71 static ofw_method_t ofw_fdt_methods[] = {
72 OFWMETHOD(ofw_init, ofw_fdt_init),
73 OFWMETHOD(ofw_peer, ofw_fdt_peer),
74 OFWMETHOD(ofw_child, ofw_fdt_child),
75 OFWMETHOD(ofw_parent, ofw_fdt_parent),
76 OFWMETHOD(ofw_instance_to_package, ofw_fdt_instance_to_package),
77 OFWMETHOD(ofw_getproplen, ofw_fdt_getproplen),
78 OFWMETHOD(ofw_getprop, ofw_fdt_getprop),
79 OFWMETHOD(ofw_nextprop, ofw_fdt_nextprop),
80 OFWMETHOD(ofw_setprop, ofw_fdt_setprop),
81 OFWMETHOD(ofw_canon, ofw_fdt_canon),
82 OFWMETHOD(ofw_finddevice, ofw_fdt_finddevice),
83 OFWMETHOD(ofw_instance_to_path, ofw_fdt_instance_to_path),
84 OFWMETHOD(ofw_package_to_path, ofw_fdt_package_to_path),
85 OFWMETHOD(ofw_interpret, ofw_fdt_interpret),
89 static ofw_def_t ofw_fdt = {
96 static void *fdtp = NULL;
99 ofw_fdt_init(ofw_t ofw, void *data)
103 /* Check FDT blob integrity */
104 if ((err = fdt_check_header(data)) != 0)
112 * Device tree functions
116 fdt_phandle_offset(phandle_t p)
118 const char *dt_struct;
121 dt_struct = (const char *)fdtp + fdt_off_dt_struct(fdtp);
123 if (((const char *)p < dt_struct) ||
124 (const char *)p > (dt_struct + fdt_size_dt_struct(fdtp)))
127 offset = (const char *)p - dt_struct;
134 /* Return the next sibling of this node or 0. */
136 ofw_fdt_peer(ofw_t ofw, phandle_t node)
143 offset = fdt_path_offset(fdtp, "/");
144 p = (phandle_t)fdt_offset_ptr(fdtp, offset, sizeof(p));
149 offset = fdt_phandle_offset(node);
153 for (depth = 1, offset = fdt_next_node(fdtp, offset, &depth);
155 offset = fdt_next_node(fdtp, offset, &depth)) {
159 p = (phandle_t)fdt_offset_ptr(fdtp, offset, sizeof(p));
167 /* Return the first child of this node or 0. */
169 ofw_fdt_child(ofw_t ofw, phandle_t node)
174 offset = fdt_phandle_offset(node);
178 for (depth = 0, offset = fdt_next_node(fdtp, offset, &depth);
179 (offset >= 0) && (depth > 0);
180 offset = fdt_next_node(fdtp, offset, &depth)) {
184 p = (phandle_t)fdt_offset_ptr(fdtp, offset, sizeof(p));
192 /* Return the parent of this node or 0. */
194 ofw_fdt_parent(ofw_t ofw, phandle_t node)
197 int offset, paroffset;
199 offset = fdt_phandle_offset(node);
203 paroffset = fdt_parent_offset(fdtp, offset);
204 p = (phandle_t)fdt_offset_ptr(fdtp, paroffset, sizeof(phandle_t));
208 /* Return the package handle that corresponds to an instance handle. */
210 ofw_fdt_instance_to_package(ofw_t ofw, ihandle_t instance)
216 * Note: FDT does not have the notion of instances, but we somewhat
217 * abuse the semantics and let treat as 'instance' the internal
218 * 'phandle' prop, so that ofw I/F consumers have a uniform way of
219 * translation between internal representation (which appear in some
220 * contexts as property values) and effective phandles.
222 offset = fdt_node_offset_by_phandle(fdtp, instance);
226 p = (phandle_t)fdt_offset_ptr(fdtp, offset, sizeof(phandle_t));
230 /* Get the length of a property of a package. */
232 ofw_fdt_getproplen(ofw_t ofw, phandle_t package, const char *propname)
234 const struct fdt_property *prop;
237 offset = fdt_phandle_offset(package);
241 if (strcmp(propname, "name") == 0) {
242 /* Emulate the 'name' property */
243 fdt_get_name(fdtp, offset, &len);
248 prop = fdt_get_property(fdtp, offset, propname, &len);
253 /* Get the value of a property of a package. */
255 ofw_fdt_getprop(ofw_t ofw, phandle_t package, const char *propname, void *buf,
262 offset = fdt_phandle_offset(package);
266 if (strcmp(propname, "name") == 0) {
267 /* Emulate the 'name' property */
268 name = fdt_get_name(fdtp, offset, &len);
269 strncpy(buf, name, buflen);
270 if (len + 1 > buflen)
275 prop = fdt_getprop(fdtp, offset, propname, &len);
281 bcopy(prop, buf, len);
286 fdt_nextprop(int offset, char *buf, size_t size)
288 const struct fdt_property *prop;
291 int nextoffset, depth;
294 tag = fdt_next_tag(fdtp, offset, &nextoffset);
296 /* Find the next prop */
299 tag = fdt_next_tag(fdtp, offset, &nextoffset);
301 if (tag == FDT_BEGIN_NODE)
303 else if (tag == FDT_END_NODE)
305 else if ((tag == FDT_PROP) && (depth == 0)) {
307 (const struct fdt_property *)fdt_offset_ptr(fdtp,
308 offset, sizeof(*prop));
309 name = fdt_string(fdtp,
310 fdt32_to_cpu(prop->nameoff));
311 strncpy(buf, name, size);
312 return (strlen(name));
315 } while (depth >= 0);
321 * Get the next property of a package. Return the actual len of retrieved
325 ofw_fdt_nextprop(ofw_t ofw, phandle_t package, const char *previous, char *buf,
328 const struct fdt_property *prop;
331 offset = fdt_phandle_offset(package);
335 if (previous == NULL)
336 /* Find the first prop in the node */
337 return (fdt_nextprop(offset, buf, size));
340 * Advance to the previous prop
342 prop = fdt_get_property(fdtp, offset, previous, NULL);
346 offset = fdt_phandle_offset((phandle_t)prop);
347 rv = fdt_nextprop(offset, buf, size);
351 /* Set the value of a property of a package. */
353 ofw_fdt_setprop(ofw_t ofw, phandle_t package, const char *propname,
354 const void *buf, size_t len)
358 offset = fdt_phandle_offset(package);
362 return (fdt_setprop_inplace(fdtp, offset, propname, buf, len));
365 /* Convert a device specifier to a fully qualified pathname. */
367 ofw_fdt_canon(ofw_t ofw, const char *device, char *buf, size_t len)
373 /* Return a package handle for the specified device. */
375 ofw_fdt_finddevice(ofw_t ofw, const char *device)
380 offset = fdt_path_offset(fdtp, device);
382 p = (phandle_t)fdt_offset_ptr(fdtp, offset, sizeof(p));
387 /* Return the fully qualified pathname corresponding to an instance. */
389 ofw_fdt_instance_to_path(ofw_t ofw, ihandle_t instance, char *buf, size_t len)
395 /* Return the fully qualified pathname corresponding to a package. */
397 ofw_fdt_package_to_path(ofw_t ofw, phandle_t package, char *buf, size_t len)
404 ofw_fdt_fixup(ofw_t ofw)
406 #define FDT_MODEL_LEN 80
407 char model[FDT_MODEL_LEN];
412 if ((root = ofw_fdt_finddevice(ofw, "/")) == 0)
415 if ((len = ofw_fdt_getproplen(ofw, root, "model")) <= 0)
418 bzero(model, FDT_MODEL_LEN);
419 if (ofw_fdt_getprop(ofw, root, "model", model, FDT_MODEL_LEN) <= 0)
423 * Search fixup table and call handler if appropriate.
425 for (i = 0; fdt_fixup_table[i].model != NULL; i++) {
426 if (strncmp(model, fdt_fixup_table[i].model,
430 if (fdt_fixup_table[i].handler != NULL)
431 (*fdt_fixup_table[i].handler)(root);
438 ofw_fdt_interpret(ofw_t ofw, const char *cmd, int nret, cell_t *retvals)
443 * Note: FDT does not have the possibility to 'interpret' commands,
444 * but we abuse the interface a bit to use it for doing non-standard
445 * operations on the device tree blob.
447 * Currently the only supported 'command' is to trigger performing
450 if (strncmp("perform-fixup", cmd, 13) != 0)
453 rv = ofw_fdt_fixup(ofw);