1208615Sraj/*- 2208615Sraj * Copyright (c) 2009-2010 The FreeBSD Foundation 3208615Sraj * All rights reserved. 4208615Sraj * 5208615Sraj * This software was developed by Semihalf under sponsorship from 6208615Sraj * the FreeBSD Foundation. 7208615Sraj * 8208615Sraj * Redistribution and use in source and binary forms, with or without 9208615Sraj * modification, are permitted provided that the following conditions 10208615Sraj * are met: 11208615Sraj * 1. Redistributions of source code must retain the above copyright 12208615Sraj * notice, this list of conditions and the following disclaimer. 13208615Sraj * 2. Redistributions in binary form must reproduce the above copyright 14208615Sraj * notice, this list of conditions and the following disclaimer in the 15208615Sraj * documentation and/or other materials provided with the distribution. 16208615Sraj * 17208615Sraj * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18208615Sraj * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19208615Sraj * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20208615Sraj * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21208615Sraj * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22208615Sraj * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23208615Sraj * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24208615Sraj * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25208615Sraj * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26208615Sraj * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27208615Sraj * SUCH DAMAGE. 28208615Sraj */ 29208615Sraj 30208615Sraj#include <sys/cdefs.h> 31208615Sraj__FBSDID("$FreeBSD: stable/11/sys/dev/ofw/ofw_fdt.c 331722 2018-03-29 02:50:57Z eadler $"); 32208615Sraj 33208615Sraj#include <sys/param.h> 34208615Sraj#include <sys/kernel.h> 35208615Sraj#include <sys/malloc.h> 36208615Sraj#include <sys/systm.h> 37208615Sraj 38208615Sraj#include <contrib/libfdt/libfdt.h> 39208615Sraj 40208615Sraj#include <machine/stdarg.h> 41208615Sraj 42208615Sraj#include <dev/fdt/fdt_common.h> 43208615Sraj#include <dev/ofw/ofwvar.h> 44208615Sraj#include <dev/ofw/openfirm.h> 45330900Skevans#include <dev/ofw/ofw_bus_subr.h> 46208615Sraj 47208615Sraj#include "ofw_if.h" 48208615Sraj 49208615Sraj#ifdef DEBUG 50208615Sraj#define debugf(fmt, args...) do { printf("%s(): ", __func__); \ 51208615Sraj printf(fmt,##args); } while (0) 52208615Sraj#else 53208615Sraj#define debugf(fmt, args...) 54208615Sraj#endif 55208615Sraj 56314506Sian#if defined(__arm__) 57314506Sian#if defined(SOC_MV_ARMADAXP) || defined(SOC_MV_ARMADA38X) || \ 58314506Sian defined(SOC_MV_DISCOVERY) || defined(SOC_MV_DOVE) || \ 59314506Sian defined(SOC_MV_FREY) || defined(SOC_MV_KIRKWOOD) || \ 60314506Sian defined(SOC_MV_LOKIPLUS) || defined(SOC_MV_ORION) 61314506Sian#define FDT_MARVELL 62314506Sian#endif 63314506Sian#endif 64314506Sian 65208615Srajstatic int ofw_fdt_init(ofw_t, void *); 66208615Srajstatic phandle_t ofw_fdt_peer(ofw_t, phandle_t); 67208615Srajstatic phandle_t ofw_fdt_child(ofw_t, phandle_t); 68208615Srajstatic phandle_t ofw_fdt_parent(ofw_t, phandle_t); 69208615Srajstatic phandle_t ofw_fdt_instance_to_package(ofw_t, ihandle_t); 70208615Srajstatic ssize_t ofw_fdt_getproplen(ofw_t, phandle_t, const char *); 71208615Srajstatic ssize_t ofw_fdt_getprop(ofw_t, phandle_t, const char *, void *, size_t); 72208615Srajstatic int ofw_fdt_nextprop(ofw_t, phandle_t, const char *, char *, size_t); 73208615Srajstatic int ofw_fdt_setprop(ofw_t, phandle_t, const char *, const void *, 74208615Sraj size_t); 75208615Srajstatic ssize_t ofw_fdt_canon(ofw_t, const char *, char *, size_t); 76208615Srajstatic phandle_t ofw_fdt_finddevice(ofw_t, const char *); 77208615Srajstatic ssize_t ofw_fdt_instance_to_path(ofw_t, ihandle_t, char *, size_t); 78208615Srajstatic ssize_t ofw_fdt_package_to_path(ofw_t, phandle_t, char *, size_t); 79212477Smariusstatic int ofw_fdt_interpret(ofw_t, const char *, int, cell_t *); 80208615Sraj 81208615Srajstatic ofw_method_t ofw_fdt_methods[] = { 82208615Sraj OFWMETHOD(ofw_init, ofw_fdt_init), 83208615Sraj OFWMETHOD(ofw_peer, ofw_fdt_peer), 84208615Sraj OFWMETHOD(ofw_child, ofw_fdt_child), 85208615Sraj OFWMETHOD(ofw_parent, ofw_fdt_parent), 86208615Sraj OFWMETHOD(ofw_instance_to_package, ofw_fdt_instance_to_package), 87208615Sraj OFWMETHOD(ofw_getproplen, ofw_fdt_getproplen), 88208615Sraj OFWMETHOD(ofw_getprop, ofw_fdt_getprop), 89208615Sraj OFWMETHOD(ofw_nextprop, ofw_fdt_nextprop), 90208615Sraj OFWMETHOD(ofw_setprop, ofw_fdt_setprop), 91208615Sraj OFWMETHOD(ofw_canon, ofw_fdt_canon), 92208615Sraj OFWMETHOD(ofw_finddevice, ofw_fdt_finddevice), 93208615Sraj OFWMETHOD(ofw_instance_to_path, ofw_fdt_instance_to_path), 94208615Sraj OFWMETHOD(ofw_package_to_path, ofw_fdt_package_to_path), 95208615Sraj OFWMETHOD(ofw_interpret, ofw_fdt_interpret), 96208615Sraj { 0, 0 } 97208615Sraj}; 98208615Sraj 99208615Srajstatic ofw_def_t ofw_fdt = { 100208615Sraj OFW_FDT, 101208615Sraj ofw_fdt_methods, 102208615Sraj 0 103208615Sraj}; 104208615SrajOFW_DEF(ofw_fdt); 105208615Sraj 106208615Srajstatic void *fdtp = NULL; 107208615Sraj 108208615Srajstatic int 109208615Srajofw_fdt_init(ofw_t ofw, void *data) 110208615Sraj{ 111208615Sraj int err; 112208615Sraj 113208615Sraj /* Check FDT blob integrity */ 114208615Sraj if ((err = fdt_check_header(data)) != 0) 115208615Sraj return (err); 116208615Sraj 117208615Sraj fdtp = data; 118208615Sraj return (0); 119208615Sraj} 120208615Sraj 121208615Sraj/* 122226466Sjchandra * Device tree functions. 123226466Sjchandra * 124226466Sjchandra * We use the offset from fdtp to the node as the 'phandle' in OF interface. 125226466Sjchandra * 126226466Sjchandra * phandle is a u32 value, therefore we cannot use the pointer to node as 127226466Sjchandra * phandle in 64 bit. We also do not use the usual fdt offset as phandle, 128226466Sjchandra * as it can be 0, and the OF interface has special meaning for phandle 0. 129208615Sraj */ 130208615Sraj 131226466Sjchandrastatic phandle_t 132226466Sjchandrafdt_offset_phandle(int offset) 133226466Sjchandra{ 134226466Sjchandra if (offset < 0) 135226466Sjchandra return (0); 136226466Sjchandra return ((phandle_t)offset + fdt_off_dt_struct(fdtp)); 137226466Sjchandra} 138226466Sjchandra 139208615Srajstatic int 140208615Srajfdt_phandle_offset(phandle_t p) 141208615Sraj{ 142226466Sjchandra int pint = (int)p; 143226466Sjchandra int dtoff = fdt_off_dt_struct(fdtp); 144226466Sjchandra 145226466Sjchandra if (pint < dtoff) 146226466Sjchandra return (-1); 147226466Sjchandra return (pint - dtoff); 148226466Sjchandra} 149226466Sjchandra 150208615Sraj/* Return the next sibling of this node or 0. */ 151208615Srajstatic phandle_t 152208615Srajofw_fdt_peer(ofw_t ofw, phandle_t node) 153208615Sraj{ 154330907Skevans int offset; 155208615Sraj 156208615Sraj if (node == 0) { 157208615Sraj /* Find root node */ 158208615Sraj offset = fdt_path_offset(fdtp, "/"); 159208615Sraj 160226466Sjchandra return (fdt_offset_phandle(offset)); 161208615Sraj } 162208615Sraj 163208615Sraj offset = fdt_phandle_offset(node); 164208615Sraj if (offset < 0) 165208615Sraj return (0); 166330907Skevans offset = fdt_next_subnode(fdtp, offset); 167330907Skevans return (fdt_offset_phandle(offset)); 168208615Sraj} 169208615Sraj 170208615Sraj/* Return the first child of this node or 0. */ 171208615Srajstatic phandle_t 172208615Srajofw_fdt_child(ofw_t ofw, phandle_t node) 173208615Sraj{ 174330907Skevans int offset; 175208615Sraj 176208615Sraj offset = fdt_phandle_offset(node); 177208615Sraj if (offset < 0) 178208615Sraj return (0); 179330907Skevans offset = fdt_first_subnode(fdtp, offset); 180330907Skevans return (fdt_offset_phandle(offset)); 181208615Sraj} 182208615Sraj 183208615Sraj/* Return the parent of this node or 0. */ 184208615Srajstatic phandle_t 185208615Srajofw_fdt_parent(ofw_t ofw, phandle_t node) 186208615Sraj{ 187208615Sraj int offset, paroffset; 188208615Sraj 189208615Sraj offset = fdt_phandle_offset(node); 190208615Sraj if (offset < 0) 191208615Sraj return (0); 192208615Sraj 193208615Sraj paroffset = fdt_parent_offset(fdtp, offset); 194226466Sjchandra return (fdt_offset_phandle(paroffset)); 195208615Sraj} 196208615Sraj 197208615Sraj/* Return the package handle that corresponds to an instance handle. */ 198208615Srajstatic phandle_t 199208615Srajofw_fdt_instance_to_package(ofw_t ofw, ihandle_t instance) 200208615Sraj{ 201208615Sraj 202258805Snwhitehorn /* Where real OF uses ihandles in the tree, FDT uses xref phandles */ 203270945Sian return (OF_node_from_xref(instance)); 204208615Sraj} 205208615Sraj 206208615Sraj/* Get the length of a property of a package. */ 207208615Srajstatic ssize_t 208208615Srajofw_fdt_getproplen(ofw_t ofw, phandle_t package, const char *propname) 209208615Sraj{ 210330905Skevans const void *prop; 211208615Sraj int offset, len; 212208615Sraj 213208615Sraj offset = fdt_phandle_offset(package); 214208615Sraj if (offset < 0) 215215120Sraj return (-1); 216208615Sraj 217276514Snwhitehorn len = -1; 218330905Skevans prop = fdt_getprop(fdtp, offset, propname, &len); 219276514Snwhitehorn 220276514Snwhitehorn if (prop == NULL && strcmp(propname, "name") == 0) { 221208615Sraj /* Emulate the 'name' property */ 222208615Sraj fdt_get_name(fdtp, offset, &len); 223208615Sraj return (len + 1); 224208615Sraj } 225208615Sraj 226277257Snwhitehorn if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) { 227277257Snwhitehorn if (strcmp(propname, "fdtbootcpu") == 0) 228277257Snwhitehorn return (sizeof(cell_t)); 229277257Snwhitehorn if (strcmp(propname, "fdtmemreserv") == 0) 230277257Snwhitehorn return (sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp)); 231277257Snwhitehorn } 232277257Snwhitehorn 233277289Snwhitehorn if (prop == NULL) 234277289Snwhitehorn return (-1); 235277289Snwhitehorn 236208615Sraj return (len); 237208615Sraj} 238208615Sraj 239208615Sraj/* Get the value of a property of a package. */ 240208615Srajstatic ssize_t 241208615Srajofw_fdt_getprop(ofw_t ofw, phandle_t package, const char *propname, void *buf, 242208615Sraj size_t buflen) 243208615Sraj{ 244208615Sraj const void *prop; 245208615Sraj const char *name; 246208615Sraj int len, offset; 247277257Snwhitehorn uint32_t cpuid; 248208615Sraj 249208615Sraj offset = fdt_phandle_offset(package); 250208615Sraj if (offset < 0) 251215120Sraj return (-1); 252208615Sraj 253276514Snwhitehorn prop = fdt_getprop(fdtp, offset, propname, &len); 254276514Snwhitehorn 255276514Snwhitehorn if (prop == NULL && strcmp(propname, "name") == 0) { 256208615Sraj /* Emulate the 'name' property */ 257208615Sraj name = fdt_get_name(fdtp, offset, &len); 258208615Sraj strncpy(buf, name, buflen); 259208615Sraj if (len + 1 > buflen) 260208615Sraj len = buflen; 261208615Sraj return (len + 1); 262208615Sraj } 263208615Sraj 264277257Snwhitehorn if (prop == NULL && offset == fdt_path_offset(fdtp, "/chosen")) { 265277257Snwhitehorn if (strcmp(propname, "fdtbootcpu") == 0) { 266277257Snwhitehorn cpuid = cpu_to_fdt32(fdt_boot_cpuid_phys(fdtp)); 267277257Snwhitehorn len = sizeof(cpuid); 268277257Snwhitehorn prop = &cpuid; 269277257Snwhitehorn } 270277257Snwhitehorn if (strcmp(propname, "fdtmemreserv") == 0) { 271277257Snwhitehorn prop = (char *)fdtp + fdt_off_mem_rsvmap(fdtp); 272277257Snwhitehorn len = sizeof(uint64_t)*2*fdt_num_mem_rsv(fdtp); 273277257Snwhitehorn } 274277257Snwhitehorn } 275277257Snwhitehorn 276208615Sraj if (prop == NULL) 277215120Sraj return (-1); 278208615Sraj 279208615Sraj if (len > buflen) 280208615Sraj len = buflen; 281208615Sraj bcopy(prop, buf, len); 282208615Sraj return (len); 283208615Sraj} 284208615Sraj 285208615Sraj/* 286259199Snwhitehorn * Get the next property of a package. Return values: 287259199Snwhitehorn * -1: package or previous property does not exist 288259199Snwhitehorn * 0: no more properties 289259199Snwhitehorn * 1: success 290208615Sraj */ 291208615Srajstatic int 292208615Srajofw_fdt_nextprop(ofw_t ofw, phandle_t package, const char *previous, char *buf, 293208615Sraj size_t size) 294208615Sraj{ 295330905Skevans const void *prop; 296257745Snwhitehorn const char *name; 297257745Snwhitehorn int offset; 298208615Sraj 299208615Sraj offset = fdt_phandle_offset(package); 300208615Sraj if (offset < 0) 301215120Sraj return (-1); 302208615Sraj 303330907Skevans if (previous == NULL) 304330907Skevans /* Find the first prop in the node */ 305330907Skevans offset = fdt_first_property_offset(fdtp, offset); 306330907Skevans else { 307330907Skevans fdt_for_each_property_offset(offset, fdtp, offset) { 308330905Skevans prop = fdt_getprop_by_offset(fdtp, offset, &name, NULL); 309257745Snwhitehorn if (prop == NULL) 310257745Snwhitehorn return (-1); /* Internal error */ 311330907Skevans /* Skip until we find 'previous', then bail out */ 312330907Skevans if (strcmp(name, previous) != 0) 313330907Skevans continue; 314257745Snwhitehorn offset = fdt_next_property_offset(fdtp, offset); 315330907Skevans break; 316257745Snwhitehorn } 317257745Snwhitehorn } 318257745Snwhitehorn 319330907Skevans if (offset < 0) 320330907Skevans return (0); /* No properties */ 321330907Skevans 322330905Skevans prop = fdt_getprop_by_offset(fdtp, offset, &name, &offset); 323208615Sraj if (prop == NULL) 324257745Snwhitehorn return (-1); /* Internal error */ 325208615Sraj 326330905Skevans strncpy(buf, name, size); 327257745Snwhitehorn 328259199Snwhitehorn return (1); 329208615Sraj} 330208615Sraj 331208615Sraj/* Set the value of a property of a package. */ 332208615Srajstatic int 333208615Srajofw_fdt_setprop(ofw_t ofw, phandle_t package, const char *propname, 334208615Sraj const void *buf, size_t len) 335208615Sraj{ 336208615Sraj int offset; 337208615Sraj 338208615Sraj offset = fdt_phandle_offset(package); 339208615Sraj if (offset < 0) 340208615Sraj return (-1); 341208615Sraj 342330902Skevans if (fdt_setprop_inplace(fdtp, offset, propname, buf, len) != 0) 343330902Skevans /* Try to add property, when setting value inplace failed */ 344330902Skevans return (fdt_setprop(fdtp, offset, propname, buf, len)); 345330902Skevans 346330902Skevans return (0); 347208615Sraj} 348208615Sraj 349208615Sraj/* Convert a device specifier to a fully qualified pathname. */ 350208615Srajstatic ssize_t 351208615Srajofw_fdt_canon(ofw_t ofw, const char *device, char *buf, size_t len) 352208615Sraj{ 353208615Sraj 354208615Sraj return (-1); 355208615Sraj} 356208615Sraj 357208615Sraj/* Return a package handle for the specified device. */ 358208615Srajstatic phandle_t 359208615Srajofw_fdt_finddevice(ofw_t ofw, const char *device) 360208615Sraj{ 361208615Sraj int offset; 362208615Sraj 363208615Sraj offset = fdt_path_offset(fdtp, device); 364228201Sjchandra if (offset < 0) 365228201Sjchandra return (-1); 366226466Sjchandra return (fdt_offset_phandle(offset)); 367208615Sraj} 368208615Sraj 369208615Sraj/* Return the fully qualified pathname corresponding to an instance. */ 370208615Srajstatic ssize_t 371208615Srajofw_fdt_instance_to_path(ofw_t ofw, ihandle_t instance, char *buf, size_t len) 372208615Sraj{ 373258805Snwhitehorn phandle_t phandle; 374208615Sraj 375258805Snwhitehorn phandle = OF_instance_to_package(instance); 376258805Snwhitehorn if (phandle == -1) 377258805Snwhitehorn return (-1); 378258805Snwhitehorn 379258805Snwhitehorn return (OF_package_to_path(phandle, buf, len)); 380208615Sraj} 381208615Sraj 382208615Sraj/* Return the fully qualified pathname corresponding to a package. */ 383208615Srajstatic ssize_t 384208615Srajofw_fdt_package_to_path(ofw_t ofw, phandle_t package, char *buf, size_t len) 385208615Sraj{ 386208615Sraj 387208615Sraj return (-1); 388208615Sraj} 389208615Sraj 390314506Sian#if defined(FDT_MARVELL) || defined(__powerpc__) 391208615Srajstatic int 392208615Srajofw_fdt_fixup(ofw_t ofw) 393208615Sraj{ 394208615Sraj#define FDT_MODEL_LEN 80 395208615Sraj char model[FDT_MODEL_LEN]; 396208615Sraj phandle_t root; 397208615Sraj ssize_t len; 398208615Sraj int i; 399208615Sraj 400228201Sjchandra if ((root = ofw_fdt_finddevice(ofw, "/")) == -1) 401208615Sraj return (ENODEV); 402208615Sraj 403208615Sraj if ((len = ofw_fdt_getproplen(ofw, root, "model")) <= 0) 404208615Sraj return (0); 405208615Sraj 406208615Sraj bzero(model, FDT_MODEL_LEN); 407208615Sraj if (ofw_fdt_getprop(ofw, root, "model", model, FDT_MODEL_LEN) <= 0) 408208615Sraj return (0); 409208615Sraj 410208615Sraj /* 411208615Sraj * Search fixup table and call handler if appropriate. 412208615Sraj */ 413208615Sraj for (i = 0; fdt_fixup_table[i].model != NULL; i++) { 414208615Sraj if (strncmp(model, fdt_fixup_table[i].model, 415208615Sraj FDT_MODEL_LEN) != 0) 416330900Skevans /* 417330900Skevans * Sometimes it's convenient to provide one 418330900Skevans * fixup entry that refers to many boards. 419330900Skevans * To handle this case, simply check if model 420330900Skevans * is compatible parameter 421330900Skevans */ 422330900Skevans if(!ofw_bus_node_is_compatible(root, 423330900Skevans fdt_fixup_table[i].model)) 424330900Skevans continue; 425208615Sraj 426208615Sraj if (fdt_fixup_table[i].handler != NULL) 427208615Sraj (*fdt_fixup_table[i].handler)(root); 428208615Sraj } 429208615Sraj 430208615Sraj return (0); 431208615Sraj} 432294511Sandrew#endif 433208615Sraj 434208615Srajstatic int 435212477Smariusofw_fdt_interpret(ofw_t ofw, const char *cmd, int nret, cell_t *retvals) 436208615Sraj{ 437314506Sian#if defined(FDT_MARVELL) || defined(__powerpc__) 438208615Sraj int rv; 439208615Sraj 440208615Sraj /* 441208615Sraj * Note: FDT does not have the possibility to 'interpret' commands, 442208615Sraj * but we abuse the interface a bit to use it for doing non-standard 443208615Sraj * operations on the device tree blob. 444208615Sraj * 445208615Sraj * Currently the only supported 'command' is to trigger performing 446208615Sraj * fixups. 447208615Sraj */ 448208615Sraj if (strncmp("perform-fixup", cmd, 13) != 0) 449208615Sraj return (0); 450208615Sraj 451208615Sraj rv = ofw_fdt_fixup(ofw); 452208615Sraj if (nret > 0) 453208615Sraj retvals[0] = rv; 454208615Sraj 455208615Sraj return (rv); 456294511Sandrew#else 457294511Sandrew return (0); 458294511Sandrew#endif 459208615Sraj} 460