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>
45 #include <dev/ofw/ofw_bus_subr.h>
50 #define debugf(fmt, args...) do { printf("%s(): ", __func__); \
51 printf(fmt,##args); } while (0)
53 #define debugf(fmt, args...)
57 #if defined(SOC_MV_ARMADAXP) || defined(SOC_MV_ARMADA38X) || \
58 defined(SOC_MV_DISCOVERY) || defined(SOC_MV_DOVE) || \
59 defined(SOC_MV_FREY) || defined(SOC_MV_KIRKWOOD) || \
60 defined(SOC_MV_LOKIPLUS) || defined(SOC_MV_ORION)
65 static int ofw_fdt_init(ofw_t, void *);
66 static phandle_t ofw_fdt_peer(ofw_t, phandle_t);
67 static phandle_t ofw_fdt_child(ofw_t, phandle_t);
68 static phandle_t ofw_fdt_parent(ofw_t, phandle_t);
69 static phandle_t ofw_fdt_instance_to_package(ofw_t, ihandle_t);
70 static ssize_t ofw_fdt_getproplen(ofw_t, phandle_t, const char *);
71 static ssize_t ofw_fdt_getprop(ofw_t, phandle_t, const char *, void *, size_t);
72 static int ofw_fdt_nextprop(ofw_t, phandle_t, const char *, char *, size_t);
73 static int ofw_fdt_setprop(ofw_t, phandle_t, const char *, const void *,
75 static ssize_t ofw_fdt_canon(ofw_t, const char *, char *, size_t);
76 static phandle_t ofw_fdt_finddevice(ofw_t, const char *);
77 static ssize_t ofw_fdt_instance_to_path(ofw_t, ihandle_t, char *, size_t);
78 static ssize_t ofw_fdt_package_to_path(ofw_t, phandle_t, char *, size_t);
79 static int ofw_fdt_interpret(ofw_t, const char *, int, cell_t *);
81 static ofw_method_t ofw_fdt_methods[] = {
82 OFWMETHOD(ofw_init, ofw_fdt_init),
83 OFWMETHOD(ofw_peer, ofw_fdt_peer),
84 OFWMETHOD(ofw_child, ofw_fdt_child),
85 OFWMETHOD(ofw_parent, ofw_fdt_parent),
86 OFWMETHOD(ofw_instance_to_package, ofw_fdt_instance_to_package),
87 OFWMETHOD(ofw_getproplen, ofw_fdt_getproplen),
88 OFWMETHOD(ofw_getprop, ofw_fdt_getprop),
89 OFWMETHOD(ofw_nextprop, ofw_fdt_nextprop),
90 OFWMETHOD(ofw_setprop, ofw_fdt_setprop),
91 OFWMETHOD(ofw_canon, ofw_fdt_canon),
92 OFWMETHOD(ofw_finddevice, ofw_fdt_finddevice),
93 OFWMETHOD(ofw_instance_to_path, ofw_fdt_instance_to_path),
94 OFWMETHOD(ofw_package_to_path, ofw_fdt_package_to_path),
95 OFWMETHOD(ofw_interpret, ofw_fdt_interpret),
99 static ofw_def_t ofw_fdt = {
106 static void *fdtp = NULL;
109 ofw_fdt_init(ofw_t ofw, void *data)
113 /* Check FDT blob integrity */
114 if ((err = fdt_check_header(data)) != 0)
122 * Device tree functions.
124 * We use the offset from fdtp to the node as the 'phandle' in OF interface.
126 * phandle is a u32 value, therefore we cannot use the pointer to node as
127 * phandle in 64 bit. We also do not use the usual fdt offset as phandle,
128 * as it can be 0, and the OF interface has special meaning for phandle 0.
132 fdt_offset_phandle(int offset)
136 return ((phandle_t)offset + fdt_off_dt_struct(fdtp));
140 fdt_phandle_offset(phandle_t p)
143 int dtoff = fdt_off_dt_struct(fdtp);
147 return (pint - dtoff);
150 /* Return the next sibling of this node or 0. */
152 ofw_fdt_peer(ofw_t ofw, phandle_t node)
158 offset = fdt_path_offset(fdtp, "/");
160 return (fdt_offset_phandle(offset));
163 offset = fdt_phandle_offset(node);
166 offset = fdt_next_subnode(fdtp, offset);
167 return (fdt_offset_phandle(offset));
170 /* Return the first child of this node or 0. */
172 ofw_fdt_child(ofw_t ofw, phandle_t node)
176 offset = fdt_phandle_offset(node);
179 offset = fdt_first_subnode(fdtp, offset);
180 return (fdt_offset_phandle(offset));
183 /* Return the parent of this node or 0. */
185 ofw_fdt_parent(ofw_t ofw, phandle_t node)
187 int offset, paroffset;
189 offset = fdt_phandle_offset(node);
193 paroffset = fdt_parent_offset(fdtp, offset);
194 return (fdt_offset_phandle(paroffset));
197 /* Return the package handle that corresponds to an instance handle. */
199 ofw_fdt_instance_to_package(ofw_t ofw, ihandle_t instance)
202 /* Where real OF uses ihandles in the tree, FDT uses xref phandles */
203 return (OF_node_from_xref(instance));
206 /* Get the length of a property of a package. */
208 ofw_fdt_getproplen(ofw_t ofw, phandle_t package, const char *propname)
213 offset = fdt_phandle_offset(package);
218 prop = fdt_getprop(fdtp, offset, propname, &len);
220 if (prop == NULL && strcmp(propname, "name") == 0) {
221 /* Emulate the 'name' property */
222 fdt_get_name(fdtp, offset, &len);
226 if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) {
227 if (strcmp(propname, "fdtbootcpu") == 0)
228 return (sizeof(cell_t));
229 if (strcmp(propname, "fdtmemreserv") == 0)
230 return (sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp));
239 /* Get the value of a property of a package. */
241 ofw_fdt_getprop(ofw_t ofw, phandle_t package, const char *propname, void *buf,
249 offset = fdt_phandle_offset(package);
253 prop = fdt_getprop(fdtp, offset, propname, &len);
255 if (prop == NULL && strcmp(propname, "name") == 0) {
256 /* Emulate the 'name' property */
257 name = fdt_get_name(fdtp, offset, &len);
258 strncpy(buf, name, buflen);
259 if (len + 1 > buflen)
264 if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) {
265 if (strcmp(propname, "fdtbootcpu") == 0) {
266 cpuid = cpu_to_fdt32(fdt_boot_cpuid_phys(fdtp));
270 if (strcmp(propname, "fdtmemreserv") == 0) {
271 prop = (char *)fdtp + fdt_off_mem_rsvmap(fdtp);
272 len = sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp);
281 bcopy(prop, buf, len);
286 * Get the next property of a package. Return values:
287 * -1: package or previous property does not exist
288 * 0: no more properties
292 ofw_fdt_nextprop(ofw_t ofw, phandle_t package, const char *previous, char *buf,
299 offset = fdt_phandle_offset(package);
303 if (previous == NULL)
304 /* Find the first prop in the node */
305 offset = fdt_first_property_offset(fdtp, offset);
307 fdt_for_each_property_offset(offset, fdtp, offset) {
308 prop = fdt_getprop_by_offset(fdtp, offset, &name, NULL);
310 return (-1); /* Internal error */
311 /* Skip until we find 'previous', then bail out */
312 if (strcmp(name, previous) != 0)
314 offset = fdt_next_property_offset(fdtp, offset);
320 return (0); /* No properties */
322 prop = fdt_getprop_by_offset(fdtp, offset, &name, &offset);
324 return (-1); /* Internal error */
326 strncpy(buf, name, size);
331 /* Set the value of a property of a package. */
333 ofw_fdt_setprop(ofw_t ofw, phandle_t package, const char *propname,
334 const void *buf, size_t len)
338 offset = fdt_phandle_offset(package);
342 if (fdt_setprop_inplace(fdtp, offset, propname, buf, len) != 0)
343 /* Try to add property, when setting value inplace failed */
344 return (fdt_setprop(fdtp, offset, propname, buf, len));
349 /* Convert a device specifier to a fully qualified pathname. */
351 ofw_fdt_canon(ofw_t ofw, const char *device, char *buf, size_t len)
357 /* Return a package handle for the specified device. */
359 ofw_fdt_finddevice(ofw_t ofw, const char *device)
363 offset = fdt_path_offset(fdtp, device);
366 return (fdt_offset_phandle(offset));
369 /* Return the fully qualified pathname corresponding to an instance. */
371 ofw_fdt_instance_to_path(ofw_t ofw, ihandle_t instance, char *buf, size_t len)
375 phandle = OF_instance_to_package(instance);
379 return (OF_package_to_path(phandle, buf, len));
382 /* Return the fully qualified pathname corresponding to a package. */
384 ofw_fdt_package_to_path(ofw_t ofw, phandle_t package, char *buf, size_t len)
390 #if defined(FDT_MARVELL) || defined(__powerpc__)
392 ofw_fdt_fixup(ofw_t ofw)
394 #define FDT_MODEL_LEN 80
395 char model[FDT_MODEL_LEN];
400 if ((root = ofw_fdt_finddevice(ofw, "/")) == -1)
403 if ((len = ofw_fdt_getproplen(ofw, root, "model")) <= 0)
406 bzero(model, FDT_MODEL_LEN);
407 if (ofw_fdt_getprop(ofw, root, "model", model, FDT_MODEL_LEN) <= 0)
411 * Search fixup table and call handler if appropriate.
413 for (i = 0; fdt_fixup_table[i].model != NULL; i++) {
414 if (strncmp(model, fdt_fixup_table[i].model,
417 * Sometimes it's convenient to provide one
418 * fixup entry that refers to many boards.
419 * To handle this case, simply check if model
420 * is compatible parameter
422 if(!ofw_bus_node_is_compatible(root,
423 fdt_fixup_table[i].model))
426 if (fdt_fixup_table[i].handler != NULL)
427 (*fdt_fixup_table[i].handler)(root);
435 ofw_fdt_interpret(ofw_t ofw, const char *cmd, int nret, cell_t *retvals)
437 #if defined(FDT_MARVELL) || defined(__powerpc__)
441 * Note: FDT does not have the possibility to 'interpret' commands,
442 * but we abuse the interface a bit to use it for doing non-standard
443 * operations on the device tree blob.
445 * Currently the only supported 'command' is to trigger performing
448 if (strncmp("perform-fixup", cmd, 13) != 0)
451 rv = ofw_fdt_fixup(ofw);