ofw_fdt.c revision 330907
1208615Sraj/*- 2330897Seadler * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3330897Seadler * 4208615Sraj * Copyright (c) 2009-2010 The FreeBSD Foundation 5208615Sraj * All rights reserved. 6208615Sraj * 7208615Sraj * This software was developed by Semihalf under sponsorship from 8208615Sraj * the FreeBSD Foundation. 9208615Sraj * 10208615Sraj * Redistribution and use in source and binary forms, with or without 11208615Sraj * modification, are permitted provided that the following conditions 12208615Sraj * are met: 13208615Sraj * 1. Redistributions of source code must retain the above copyright 14208615Sraj * notice, this list of conditions and the following disclaimer. 15208615Sraj * 2. Redistributions in binary form must reproduce the above copyright 16208615Sraj * notice, this list of conditions and the following disclaimer in the 17208615Sraj * documentation and/or other materials provided with the distribution. 18208615Sraj * 19208615Sraj * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 20208615Sraj * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 21208615Sraj * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 22208615Sraj * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 23208615Sraj * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 24208615Sraj * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 25208615Sraj * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 26208615Sraj * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 27208615Sraj * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 28208615Sraj * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 29208615Sraj * SUCH DAMAGE. 30208615Sraj */ 31208615Sraj 32208615Sraj#include <sys/cdefs.h> 33208615Sraj__FBSDID("$FreeBSD: stable/11/sys/dev/ofw/ofw_fdt.c 330907 2018-03-14 03:50:12Z kevans $"); 34208615Sraj 35208615Sraj#include <sys/param.h> 36208615Sraj#include <sys/kernel.h> 37208615Sraj#include <sys/malloc.h> 38208615Sraj#include <sys/systm.h> 39208615Sraj 40208615Sraj#include <contrib/libfdt/libfdt.h> 41208615Sraj 42208615Sraj#include <machine/stdarg.h> 43208615Sraj 44208615Sraj#include <dev/fdt/fdt_common.h> 45208615Sraj#include <dev/ofw/ofwvar.h> 46208615Sraj#include <dev/ofw/openfirm.h> 47330900Skevans#include <dev/ofw/ofw_bus_subr.h> 48208615Sraj 49208615Sraj#include "ofw_if.h" 50208615Sraj 51208615Sraj#ifdef DEBUG 52208615Sraj#define debugf(fmt, args...) do { printf("%s(): ", __func__); \ 53208615Sraj printf(fmt,##args); } while (0) 54208615Sraj#else 55208615Sraj#define debugf(fmt, args...) 56208615Sraj#endif 57208615Sraj 58314506Sian#if defined(__arm__) 59314506Sian#if defined(SOC_MV_ARMADAXP) || defined(SOC_MV_ARMADA38X) || \ 60314506Sian defined(SOC_MV_DISCOVERY) || defined(SOC_MV_DOVE) || \ 61314506Sian defined(SOC_MV_FREY) || defined(SOC_MV_KIRKWOOD) || \ 62314506Sian defined(SOC_MV_LOKIPLUS) || defined(SOC_MV_ORION) 63314506Sian#define FDT_MARVELL 64314506Sian#endif 65314506Sian#endif 66314506Sian 67208615Srajstatic int ofw_fdt_init(ofw_t, void *); 68208615Srajstatic phandle_t ofw_fdt_peer(ofw_t, phandle_t); 69208615Srajstatic phandle_t ofw_fdt_child(ofw_t, phandle_t); 70208615Srajstatic phandle_t ofw_fdt_parent(ofw_t, phandle_t); 71208615Srajstatic phandle_t ofw_fdt_instance_to_package(ofw_t, ihandle_t); 72208615Srajstatic ssize_t ofw_fdt_getproplen(ofw_t, phandle_t, const char *); 73208615Srajstatic ssize_t ofw_fdt_getprop(ofw_t, phandle_t, const char *, void *, size_t); 74208615Srajstatic int ofw_fdt_nextprop(ofw_t, phandle_t, const char *, char *, size_t); 75208615Srajstatic int ofw_fdt_setprop(ofw_t, phandle_t, const char *, const void *, 76208615Sraj size_t); 77208615Srajstatic ssize_t ofw_fdt_canon(ofw_t, const char *, char *, size_t); 78208615Srajstatic phandle_t ofw_fdt_finddevice(ofw_t, const char *); 79208615Srajstatic ssize_t ofw_fdt_instance_to_path(ofw_t, ihandle_t, char *, size_t); 80208615Srajstatic ssize_t ofw_fdt_package_to_path(ofw_t, phandle_t, char *, size_t); 81212477Smariusstatic int ofw_fdt_interpret(ofw_t, const char *, int, cell_t *); 82208615Sraj 83208615Srajstatic ofw_method_t ofw_fdt_methods[] = { 84208615Sraj OFWMETHOD(ofw_init, ofw_fdt_init), 85208615Sraj OFWMETHOD(ofw_peer, ofw_fdt_peer), 86208615Sraj OFWMETHOD(ofw_child, ofw_fdt_child), 87208615Sraj OFWMETHOD(ofw_parent, ofw_fdt_parent), 88208615Sraj OFWMETHOD(ofw_instance_to_package, ofw_fdt_instance_to_package), 89208615Sraj OFWMETHOD(ofw_getproplen, ofw_fdt_getproplen), 90208615Sraj OFWMETHOD(ofw_getprop, ofw_fdt_getprop), 91208615Sraj OFWMETHOD(ofw_nextprop, ofw_fdt_nextprop), 92208615Sraj OFWMETHOD(ofw_setprop, ofw_fdt_setprop), 93208615Sraj OFWMETHOD(ofw_canon, ofw_fdt_canon), 94208615Sraj OFWMETHOD(ofw_finddevice, ofw_fdt_finddevice), 95208615Sraj OFWMETHOD(ofw_instance_to_path, ofw_fdt_instance_to_path), 96208615Sraj OFWMETHOD(ofw_package_to_path, ofw_fdt_package_to_path), 97208615Sraj OFWMETHOD(ofw_interpret, ofw_fdt_interpret), 98208615Sraj { 0, 0 } 99208615Sraj}; 100208615Sraj 101208615Srajstatic ofw_def_t ofw_fdt = { 102208615Sraj OFW_FDT, 103208615Sraj ofw_fdt_methods, 104208615Sraj 0 105208615Sraj}; 106208615SrajOFW_DEF(ofw_fdt); 107208615Sraj 108208615Srajstatic void *fdtp = NULL; 109208615Sraj 110208615Srajstatic int 111208615Srajofw_fdt_init(ofw_t ofw, void *data) 112208615Sraj{ 113208615Sraj int err; 114208615Sraj 115208615Sraj /* Check FDT blob integrity */ 116208615Sraj if ((err = fdt_check_header(data)) != 0) 117208615Sraj return (err); 118208615Sraj 119208615Sraj fdtp = data; 120208615Sraj return (0); 121208615Sraj} 122208615Sraj 123208615Sraj/* 124226466Sjchandra * Device tree functions. 125226466Sjchandra * 126226466Sjchandra * We use the offset from fdtp to the node as the 'phandle' in OF interface. 127226466Sjchandra * 128226466Sjchandra * phandle is a u32 value, therefore we cannot use the pointer to node as 129226466Sjchandra * phandle in 64 bit. We also do not use the usual fdt offset as phandle, 130226466Sjchandra * as it can be 0, and the OF interface has special meaning for phandle 0. 131208615Sraj */ 132208615Sraj 133226466Sjchandrastatic phandle_t 134226466Sjchandrafdt_offset_phandle(int offset) 135226466Sjchandra{ 136226466Sjchandra if (offset < 0) 137226466Sjchandra return (0); 138226466Sjchandra return ((phandle_t)offset + fdt_off_dt_struct(fdtp)); 139226466Sjchandra} 140226466Sjchandra 141208615Srajstatic int 142208615Srajfdt_phandle_offset(phandle_t p) 143208615Sraj{ 144226466Sjchandra int pint = (int)p; 145226466Sjchandra int dtoff = fdt_off_dt_struct(fdtp); 146226466Sjchandra 147226466Sjchandra if (pint < dtoff) 148226466Sjchandra return (-1); 149226466Sjchandra return (pint - dtoff); 150226466Sjchandra} 151226466Sjchandra 152208615Sraj/* Return the next sibling of this node or 0. */ 153208615Srajstatic phandle_t 154208615Srajofw_fdt_peer(ofw_t ofw, phandle_t node) 155208615Sraj{ 156330907Skevans int offset; 157208615Sraj 158208615Sraj if (node == 0) { 159208615Sraj /* Find root node */ 160208615Sraj offset = fdt_path_offset(fdtp, "/"); 161208615Sraj 162226466Sjchandra return (fdt_offset_phandle(offset)); 163208615Sraj } 164208615Sraj 165208615Sraj offset = fdt_phandle_offset(node); 166208615Sraj if (offset < 0) 167208615Sraj return (0); 168330907Skevans offset = fdt_next_subnode(fdtp, offset); 169330907Skevans return (fdt_offset_phandle(offset)); 170208615Sraj} 171208615Sraj 172208615Sraj/* Return the first child of this node or 0. */ 173208615Srajstatic phandle_t 174208615Srajofw_fdt_child(ofw_t ofw, phandle_t node) 175208615Sraj{ 176330907Skevans int offset; 177208615Sraj 178208615Sraj offset = fdt_phandle_offset(node); 179208615Sraj if (offset < 0) 180208615Sraj return (0); 181330907Skevans offset = fdt_first_subnode(fdtp, offset); 182330907Skevans return (fdt_offset_phandle(offset)); 183208615Sraj} 184208615Sraj 185208615Sraj/* Return the parent of this node or 0. */ 186208615Srajstatic phandle_t 187208615Srajofw_fdt_parent(ofw_t ofw, phandle_t node) 188208615Sraj{ 189208615Sraj int offset, paroffset; 190208615Sraj 191208615Sraj offset = fdt_phandle_offset(node); 192208615Sraj if (offset < 0) 193208615Sraj return (0); 194208615Sraj 195208615Sraj paroffset = fdt_parent_offset(fdtp, offset); 196226466Sjchandra return (fdt_offset_phandle(paroffset)); 197208615Sraj} 198208615Sraj 199208615Sraj/* Return the package handle that corresponds to an instance handle. */ 200208615Srajstatic phandle_t 201208615Srajofw_fdt_instance_to_package(ofw_t ofw, ihandle_t instance) 202208615Sraj{ 203208615Sraj 204258805Snwhitehorn /* Where real OF uses ihandles in the tree, FDT uses xref phandles */ 205270945Sian return (OF_node_from_xref(instance)); 206208615Sraj} 207208615Sraj 208208615Sraj/* Get the length of a property of a package. */ 209208615Srajstatic ssize_t 210208615Srajofw_fdt_getproplen(ofw_t ofw, phandle_t package, const char *propname) 211208615Sraj{ 212330905Skevans const void *prop; 213208615Sraj int offset, len; 214208615Sraj 215208615Sraj offset = fdt_phandle_offset(package); 216208615Sraj if (offset < 0) 217215120Sraj return (-1); 218208615Sraj 219276514Snwhitehorn len = -1; 220330905Skevans prop = fdt_getprop(fdtp, offset, propname, &len); 221276514Snwhitehorn 222276514Snwhitehorn if (prop == NULL && strcmp(propname, "name") == 0) { 223208615Sraj /* Emulate the 'name' property */ 224208615Sraj fdt_get_name(fdtp, offset, &len); 225208615Sraj return (len + 1); 226208615Sraj } 227208615Sraj 228277257Snwhitehorn if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) { 229277257Snwhitehorn if (strcmp(propname, "fdtbootcpu") == 0) 230277257Snwhitehorn return (sizeof(cell_t)); 231277257Snwhitehorn if (strcmp(propname, "fdtmemreserv") == 0) 232277257Snwhitehorn return (sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp)); 233277257Snwhitehorn } 234277257Snwhitehorn 235277289Snwhitehorn if (prop == NULL) 236277289Snwhitehorn return (-1); 237277289Snwhitehorn 238208615Sraj return (len); 239208615Sraj} 240208615Sraj 241208615Sraj/* Get the value of a property of a package. */ 242208615Srajstatic ssize_t 243208615Srajofw_fdt_getprop(ofw_t ofw, phandle_t package, const char *propname, void *buf, 244208615Sraj size_t buflen) 245208615Sraj{ 246208615Sraj const void *prop; 247208615Sraj const char *name; 248208615Sraj int len, offset; 249277257Snwhitehorn uint32_t cpuid; 250208615Sraj 251208615Sraj offset = fdt_phandle_offset(package); 252208615Sraj if (offset < 0) 253215120Sraj return (-1); 254208615Sraj 255276514Snwhitehorn prop = fdt_getprop(fdtp, offset, propname, &len); 256276514Snwhitehorn 257276514Snwhitehorn if (prop == NULL && strcmp(propname, "name") == 0) { 258208615Sraj /* Emulate the 'name' property */ 259208615Sraj name = fdt_get_name(fdtp, offset, &len); 260208615Sraj strncpy(buf, name, buflen); 261208615Sraj if (len + 1 > buflen) 262208615Sraj len = buflen; 263208615Sraj return (len + 1); 264208615Sraj } 265208615Sraj 266277257Snwhitehorn if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) { 267277257Snwhitehorn if (strcmp(propname, "fdtbootcpu") == 0) { 268277257Snwhitehorn cpuid = cpu_to_fdt32(fdt_boot_cpuid_phys(fdtp)); 269277257Snwhitehorn len = sizeof(cpuid); 270277257Snwhitehorn prop = &cpuid; 271277257Snwhitehorn } 272277257Snwhitehorn if (strcmp(propname, "fdtmemreserv") == 0) { 273277257Snwhitehorn prop = (char *)fdtp + fdt_off_mem_rsvmap(fdtp); 274277257Snwhitehorn len = sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp); 275277257Snwhitehorn } 276277257Snwhitehorn } 277277257Snwhitehorn 278208615Sraj if (prop == NULL) 279215120Sraj return (-1); 280208615Sraj 281208615Sraj if (len > buflen) 282208615Sraj len = buflen; 283208615Sraj bcopy(prop, buf, len); 284208615Sraj return (len); 285208615Sraj} 286208615Sraj 287208615Sraj/* 288259199Snwhitehorn * Get the next property of a package. Return values: 289259199Snwhitehorn * -1: package or previous property does not exist 290259199Snwhitehorn * 0: no more properties 291259199Snwhitehorn * 1: success 292208615Sraj */ 293208615Srajstatic int 294208615Srajofw_fdt_nextprop(ofw_t ofw, phandle_t package, const char *previous, char *buf, 295208615Sraj size_t size) 296208615Sraj{ 297330905Skevans const void *prop; 298257745Snwhitehorn const char *name; 299257745Snwhitehorn int offset; 300208615Sraj 301208615Sraj offset = fdt_phandle_offset(package); 302208615Sraj if (offset < 0) 303215120Sraj return (-1); 304208615Sraj 305330907Skevans if (previous == NULL) 306330907Skevans /* Find the first prop in the node */ 307330907Skevans offset = fdt_first_property_offset(fdtp, offset); 308330907Skevans else { 309330907Skevans fdt_for_each_property_offset(offset, fdtp, offset) { 310330905Skevans prop = fdt_getprop_by_offset(fdtp, offset, &name, NULL); 311257745Snwhitehorn if (prop == NULL) 312257745Snwhitehorn return (-1); /* Internal error */ 313330907Skevans /* Skip until we find 'previous', then bail out */ 314330907Skevans if (strcmp(name, previous) != 0) 315330907Skevans continue; 316257745Snwhitehorn offset = fdt_next_property_offset(fdtp, offset); 317330907Skevans break; 318257745Snwhitehorn } 319257745Snwhitehorn } 320257745Snwhitehorn 321330907Skevans if (offset < 0) 322330907Skevans return (0); /* No properties */ 323330907Skevans 324330905Skevans prop = fdt_getprop_by_offset(fdtp, offset, &name, &offset); 325208615Sraj if (prop == NULL) 326257745Snwhitehorn return (-1); /* Internal error */ 327208615Sraj 328330905Skevans strncpy(buf, name, size); 329257745Snwhitehorn 330259199Snwhitehorn return (1); 331208615Sraj} 332208615Sraj 333208615Sraj/* Set the value of a property of a package. */ 334208615Srajstatic int 335208615Srajofw_fdt_setprop(ofw_t ofw, phandle_t package, const char *propname, 336208615Sraj const void *buf, size_t len) 337208615Sraj{ 338208615Sraj int offset; 339208615Sraj 340208615Sraj offset = fdt_phandle_offset(package); 341208615Sraj if (offset < 0) 342208615Sraj return (-1); 343208615Sraj 344330902Skevans if (fdt_setprop_inplace(fdtp, offset, propname, buf, len) != 0) 345330902Skevans /* Try to add property, when setting value inplace failed */ 346330902Skevans return (fdt_setprop(fdtp, offset, propname, buf, len)); 347330902Skevans 348330902Skevans return (0); 349208615Sraj} 350208615Sraj 351208615Sraj/* Convert a device specifier to a fully qualified pathname. */ 352208615Srajstatic ssize_t 353208615Srajofw_fdt_canon(ofw_t ofw, const char *device, char *buf, size_t len) 354208615Sraj{ 355208615Sraj 356208615Sraj return (-1); 357208615Sraj} 358208615Sraj 359208615Sraj/* Return a package handle for the specified device. */ 360208615Srajstatic phandle_t 361208615Srajofw_fdt_finddevice(ofw_t ofw, const char *device) 362208615Sraj{ 363208615Sraj int offset; 364208615Sraj 365208615Sraj offset = fdt_path_offset(fdtp, device); 366228201Sjchandra if (offset < 0) 367228201Sjchandra return (-1); 368226466Sjchandra return (fdt_offset_phandle(offset)); 369208615Sraj} 370208615Sraj 371208615Sraj/* Return the fully qualified pathname corresponding to an instance. */ 372208615Srajstatic ssize_t 373208615Srajofw_fdt_instance_to_path(ofw_t ofw, ihandle_t instance, char *buf, size_t len) 374208615Sraj{ 375258805Snwhitehorn phandle_t phandle; 376208615Sraj 377258805Snwhitehorn phandle = OF_instance_to_package(instance); 378258805Snwhitehorn if (phandle == -1) 379258805Snwhitehorn return (-1); 380258805Snwhitehorn 381258805Snwhitehorn return (OF_package_to_path(phandle, buf, len)); 382208615Sraj} 383208615Sraj 384208615Sraj/* Return the fully qualified pathname corresponding to a package. */ 385208615Srajstatic ssize_t 386208615Srajofw_fdt_package_to_path(ofw_t ofw, phandle_t package, char *buf, size_t len) 387208615Sraj{ 388208615Sraj 389208615Sraj return (-1); 390208615Sraj} 391208615Sraj 392314506Sian#if defined(FDT_MARVELL) || defined(__powerpc__) 393208615Srajstatic int 394208615Srajofw_fdt_fixup(ofw_t ofw) 395208615Sraj{ 396208615Sraj#define FDT_MODEL_LEN 80 397208615Sraj char model[FDT_MODEL_LEN]; 398208615Sraj phandle_t root; 399208615Sraj ssize_t len; 400208615Sraj int i; 401208615Sraj 402228201Sjchandra if ((root = ofw_fdt_finddevice(ofw, "/")) == -1) 403208615Sraj return (ENODEV); 404208615Sraj 405208615Sraj if ((len = ofw_fdt_getproplen(ofw, root, "model")) <= 0) 406208615Sraj return (0); 407208615Sraj 408208615Sraj bzero(model, FDT_MODEL_LEN); 409208615Sraj if (ofw_fdt_getprop(ofw, root, "model", model, FDT_MODEL_LEN) <= 0) 410208615Sraj return (0); 411208615Sraj 412208615Sraj /* 413208615Sraj * Search fixup table and call handler if appropriate. 414208615Sraj */ 415208615Sraj for (i = 0; fdt_fixup_table[i].model != NULL; i++) { 416208615Sraj if (strncmp(model, fdt_fixup_table[i].model, 417208615Sraj FDT_MODEL_LEN) != 0) 418330900Skevans /* 419330900Skevans * Sometimes it's convenient to provide one 420330900Skevans * fixup entry that refers to many boards. 421330900Skevans * To handle this case, simply check if model 422330900Skevans * is compatible parameter 423330900Skevans */ 424330900Skevans if(!ofw_bus_node_is_compatible(root, 425330900Skevans fdt_fixup_table[i].model)) 426330900Skevans continue; 427208615Sraj 428208615Sraj if (fdt_fixup_table[i].handler != NULL) 429208615Sraj (*fdt_fixup_table[i].handler)(root); 430208615Sraj } 431208615Sraj 432208615Sraj return (0); 433208615Sraj} 434294511Sandrew#endif 435208615Sraj 436208615Srajstatic int 437212477Smariusofw_fdt_interpret(ofw_t ofw, const char *cmd, int nret, cell_t *retvals) 438208615Sraj{ 439314506Sian#if defined(FDT_MARVELL) || defined(__powerpc__) 440208615Sraj int rv; 441208615Sraj 442208615Sraj /* 443208615Sraj * Note: FDT does not have the possibility to 'interpret' commands, 444208615Sraj * but we abuse the interface a bit to use it for doing non-standard 445208615Sraj * operations on the device tree blob. 446208615Sraj * 447208615Sraj * Currently the only supported 'command' is to trigger performing 448208615Sraj * fixups. 449208615Sraj */ 450208615Sraj if (strncmp("perform-fixup", cmd, 13) != 0) 451208615Sraj return (0); 452208615Sraj 453208615Sraj rv = ofw_fdt_fixup(ofw); 454208615Sraj if (nret > 0) 455208615Sraj retvals[0] = rv; 456208615Sraj 457208615Sraj return (rv); 458294511Sandrew#else 459294511Sandrew return (0); 460294511Sandrew#endif 461208615Sraj} 462