drivers/of/fdt.c

   1 /*
   2  * Functions for working with the Flattened Device Tree data format
   3  *
   4  * Copyright 2009 Benjamin Herrenschmidt, IBM Corp
   5  * benh@kernel.crashing.org
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * version 2 as published by the Free Software Foundation.
  10  */
  11
  12 #include <linux/crc32.h>
  13 #include <linux/kernel.h>
  14 #include <linux/initrd.h>
  15 #include <linux/memblock.h>
  16 #include <linux/mutex.h>
  17 #include <linux/of.h>
  18 #include <linux/of_fdt.h>
  19 #include <linux/of_reserved_mem.h>
  20 #include <linux/sizes.h>
  21 #include <linux/string.h>
  22 #include <linux/errno.h>
  23 #include <linux/slab.h>
  24 #include <linux/libfdt.h>
  25 #include <linux/debugfs.h>
  26 #include <linux/serial_core.h>
  27 #include <linux/sysfs.h>
  28
  29 #include <asm/setup.h>  /* for COMMAND_LINE_SIZE */
  30 #include <asm/page.h>
  31
  32 /*
  33  * of_fdt_limit_memory - limit the number of regions in the /memory node
  34  * @limit: maximum entries
  35  *
  36  * Adjust the flattened device tree to have at most 'limit' number of
  37  * memory entries in the /memory node. This function may be called
  38  * any time after initial_boot_param is set.
  39  */
  40 void of_fdt_limit_memory(int limit)
  41 {
  42         int memory;
  43         int len;
  44         const void *val;
  45         int nr_address_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
  46         int nr_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
  47         const uint32_t *addr_prop;
  48         const uint32_t *size_prop;
  49         int root_offset;
  50         int cell_size;
  51
  52         root_offset = fdt_path_offset(initial_boot_params, "/");
  53         if (root_offset < 0)
  54                 return;
  55
  56         addr_prop = fdt_getprop(initial_boot_params, root_offset,
  57                                 "#address-cells", NULL);
  58         if (addr_prop)
  59                 nr_address_cells = fdt32_to_cpu(*addr_prop);
  60
  61         size_prop = fdt_getprop(initial_boot_params, root_offset,
  62                                 "#size-cells", NULL);
  63         if (size_prop)
  64                 nr_size_cells = fdt32_to_cpu(*size_prop);
  65
  66         cell_size = sizeof(uint32_t)*(nr_address_cells + nr_size_cells);
  67
  68         memory = fdt_path_offset(initial_boot_params, "/memory");
  69         if (memory > 0) {
  70                 val = fdt_getprop(initial_boot_params, memory, "reg", &len);
  71                 if (len > limit*cell_size) {
  72                         len = limit*cell_size;
  73                         pr_debug("Limiting number of entries to %d\n", limit);
  74                         fdt_setprop(initial_boot_params, memory, "reg", val,
  75                                         len);
  76                 }
  77         }
  78 }
  79
  80 /**
  81  * of_fdt_is_compatible - Return true if given node from the given blob has
  82  * compat in its compatible list
  83  * @blob: A device tree blob
  84  * @node: node to test
  85  * @compat: compatible string to compare with compatible list.
  86  *
  87  * On match, returns a non-zero value with smaller values returned for more
  88  * specific compatible values.
  89  */
  90 int of_fdt_is_compatible(const void *blob,
  91                       unsigned long node, const char *compat)
  92 {
  93         const char *cp;
  94         int cplen;
  95         unsigned long l, score = 0;
  96
  97         cp = fdt_getprop(blob, node, "compatible", &cplen);
  98         if (cp == NULL)
  99                 return 0;
 100         while (cplen > 0) {
 101                 score++;
 102                 if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
 103                         return score;
 104                 l = strlen(cp) + 1;
 105                 cp += l;
 106                 cplen -= l;
 107         }
 108
 109         return 0;
 110 }
 111
 112 /**
 113  * of_fdt_is_big_endian - Return true if given node needs BE MMIO accesses
 114  * @blob: A device tree blob
 115  * @node: node to test
 116  *
 117  * Returns true if the node has a "big-endian" property, or if the kernel
 118  * was compiled for BE *and* the node has a "native-endian" property.
 119  * Returns false otherwise.
 120  */
 121 bool of_fdt_is_big_endian(const void *blob, unsigned long node)
 122 {
 123         if (fdt_getprop(blob, node, "big-endian", NULL))
 124                 return true;
 125         if (IS_ENABLED(CONFIG_CPU_BIG_ENDIAN) &&
 126             fdt_getprop(blob, node, "native-endian", NULL))
 127                 return true;
 128         return false;
 129 }
 130
 131 /**
 132  * of_fdt_match - Return true if node matches a list of compatible values
 133  */
 134 int of_fdt_match(const void *blob, unsigned long node,
 135                  const char *const *compat)
 136 {
 137         unsigned int tmp, score = 0;
 138
 139         if (!compat)
 140                 return 0;
 141
 142         while (*compat) {
 143                 tmp = of_fdt_is_compatible(blob, node, *compat);
 144                 if (tmp && (score == 0 || (tmp < score)))
 145                         score = tmp;
 146                 compat++;
 147         }
 148
 149         return score;
 150 }
 151
 152 static void *unflatten_dt_alloc(void **mem, unsigned long size,
 153                                        unsigned long align)
 154 {
 155         void *res;
 156
 157         *mem = PTR_ALIGN(*mem, align);
 158         res = *mem;
 159         *mem += size;
 160
 161         return res;
 162 }
 163
 164 static void populate_properties(const void *blob,
 165                                 int offset,
 166                                 void **mem,
 167                                 struct device_node *np,
 168                                 const char *nodename,
 169                                 bool dryrun)
 170 {
 171         struct property *pp, **pprev = NULL;
 172         int cur;
 173         bool has_name = false;
 174
 175         pprev = &np->properties;
 176         for (cur = fdt_first_property_offset(blob, offset);
 177              cur >= 0;
 178              cur = fdt_next_property_offset(blob, cur)) {
 179                 const __be32 *val;
 180                 const char *pname;
 181                 u32 sz;
 182
 183                 val = fdt_getprop_by_offset(blob, cur, &pname, &sz);
 184                 if (!val) {
 185                         pr_warn("%s: Cannot locate property at 0x%x\n",
 186                                 __func__, cur);
 187                         continue;
 188                 }
 189
 190                 if (!pname) {
 191                         pr_warn("%s: Cannot find property name at 0x%x\n",
 192                                 __func__, cur);
 193                         continue;
 194                 }
 195
 196                 if (!strcmp(pname, "name"))
 197                         has_name = true;
 198
 199                 pp = unflatten_dt_alloc(mem, sizeof(struct property),
 200                                         __alignof__(struct property));
 201                 if (dryrun)
 202                         continue;
 203
 204                 /* We accept flattened tree phandles either in
 205                  * ePAPR-style "phandle" properties, or the
 206                  * legacy "linux,phandle" properties.  If both
 207                  * appear and have different values, things
 208                  * will get weird. Don't do that.
 209                  */
 210                 if (!strcmp(pname, "phandle") ||
 211                     !strcmp(pname, "linux,phandle")) {
 212                         if (!np->phandle)
 213                                 np->phandle = be32_to_cpup(val);
 214                 }
 215
 216                 /* And we process the "ibm,phandle" property
 217                  * used in pSeries dynamic device tree
 218                  * stuff
 219                  */
 220                 if (!strcmp(pname, "ibm,phandle"))
 221                         np->phandle = be32_to_cpup(val);
 222
 223                 pp->name   = (char *)pname;
 224                 pp->length = sz;
 225                 pp->value  = (__be32 *)val;
 226                 *pprev     = pp;
 227                 pprev      = &pp->next;
 228         }
 229
 230         /* With version 0x10 we may not have the name property,
 231          * recreate it here from the unit name if absent
 232          */
 233         if (!has_name) {
 234                 const char *p = nodename, *ps = p, *pa = NULL;
 235                 int len;
 236
 237                 while (*p) {
 238                         if ((*p) == '@')
 239                                 pa = p;
 240                         else if ((*p) == '/')
 241                                 ps = p + 1;
 242                         p++;
 243                 }
 244
 245                 if (pa < ps)
 246                         pa = p;
 247                 len = (pa - ps) + 1;
 248                 pp = unflatten_dt_alloc(mem, sizeof(struct property) + len,
 249                                         __alignof__(struct property));
 250                 if (!dryrun) {
 251                         pp->name   = "name";
 252                         pp->length = len;
 253                         pp->value  = pp + 1;
 254                         *pprev     = pp;
 255                         pprev      = &pp->next;
 256                         memcpy(pp->value, ps, len - 1);
 257                         ((char *)pp->value)[len - 1] = 0;
 258                         pr_debug("fixed up name for %s -> %s\n",
 259                                  nodename, (char *)pp->value);
 260                 }
 261         }
 262
 263         if (!dryrun)
 264                 *pprev = NULL;
 265 }
 266
 267 static unsigned long populate_node(const void *blob,
 268                                    int offset,
 269                                    void **mem,
 270                                    struct device_node *dad,
 271                                    unsigned long fpsize,
 272                                    struct device_node **pnp,
 273                                    bool dryrun)
 274 {
 275         struct device_node *np;
 276         const char *pathp;
 277         unsigned int l, allocl;
 278         int new_format = 0;
 279
 280         pathp = fdt_get_name(blob, offset, &l);
 281         if (!pathp) {
 282                 *pnp = NULL;
 283                 return 0;
 284         }
 285
 286         allocl = ++l;
 287
 288         /* version 0x10 has a more compact unit name here instead of the full
 289          * path. we accumulate the full path size using "fpsize", we'll rebuild
 290          * it later. We detect this because the first character of the name is
 291          * not '/'.
 292          */
 293         if ((*pathp) != '/') {
 294                 new_format = 1;
 295                 if (fpsize == 0) {
 296                         /* root node: special case. fpsize accounts for path
 297                          * plus terminating zero. root node only has '/', so
 298                          * fpsize should be 2, but we want to avoid the first
 299                          * level nodes to have two '/' so we use fpsize 1 here
 300                          */
 301                         fpsize = 1;
 302                         allocl = 2;
 303                         l = 1;
 304                         pathp = "";
 305                 } else {
 306                         /* account for '/' and path size minus terminal 0
 307                          * already in 'l'
 308                          */
 309                         fpsize += l;
 310                         allocl = fpsize;
 311                 }
 312         }
 313
 314         np = unflatten_dt_alloc(mem, sizeof(struct device_node) + allocl,
 315                                 __alignof__(struct device_node));
 316         if (!dryrun) {
 317                 char *fn;
 318                 of_node_init(np);
 319                 np->full_name = fn = ((char *)np) + sizeof(*np);
 320                 if (new_format) {
 321                         /* rebuild full path for new format */
 322                         if (dad && dad->parent) {
 323                                 strcpy(fn, dad->full_name);
 324 #ifdef DEBUG
 325                                 if ((strlen(fn) + l + 1) != allocl) {
 326                                         pr_debug("%s: p: %d, l: %d, a: %d\n",
 327                                                 pathp, (int)strlen(fn),
 328                                                 l, allocl);
 329                                 }
 330 #endif
 331                                 fn += strlen(fn);
 332                         }
 333                         *(fn++) = '/';
 334                 }
 335                 memcpy(fn, pathp, l);
 336
 337                 if (dad != NULL) {
 338                         np->parent = dad;
 339                         np->sibling = dad->child;
 340                         dad->child = np;
 341                 }
 342         }
 343
 344         populate_properties(blob, offset, mem, np, pathp, dryrun);
 345         if (!dryrun) {
 346                 np->name = of_get_property(np, "name", NULL);
 347                 np->type = of_get_property(np, "device_type", NULL);
 348
 349                 if (!np->name)
 350                         np->name = "<NULL>";
 351                 if (!np->type)
 352                         np->type = "<NULL>";
 353         }
 354
 355         *pnp = np;
 356         return fpsize;
 357 }
 358
 359 /**
 360  * unflatten_dt_node - Alloc and populate a device_node from the flat tree
 361  * @blob: The parent device tree blob
 362  * @mem: Memory chunk to use for allocating device nodes and properties
 363  * @poffset: pointer to node in flat tree
 364  * @dad: Parent struct device_node
 365  * @nodepp: The device_node tree created by the call
 366  * @fpsize: Size of the node path up at the current depth.
 367  * @dryrun: If true, do not allocate device nodes but still calculate needed
 368  * memory size
 369  */
 370 static void *unflatten_dt_node(const void *blob,
 371                                void *mem,
 372                                int *poffset,
 373                                struct device_node *dad,
 374                                struct device_node **nodepp,
 375                                unsigned long fpsize,
 376                                bool dryrun)
 377 {
 378         struct device_node *np;
 379         static int depth;
 380         int old_depth;
 381
 382         fpsize = populate_node(blob, *poffset, &mem, dad, fpsize, &np, dryrun);
 383         if (!fpsize)
 384                 return mem;
 385
 386         old_depth = depth;
 387         *poffset = fdt_next_node(blob, *poffset, &depth);
 388         if (depth < 0)
 389                 depth = 0;
 390         while (*poffset > 0 && depth > old_depth)
 391                 mem = unflatten_dt_node(blob, mem, poffset, np, NULL,
 392                                         fpsize, dryrun);
 393
 394         if (*poffset < 0 && *poffset != -FDT_ERR_NOTFOUND)
 395                 pr_err("unflatten: error %d processing FDT\n", *poffset);
 396
 397         /*
 398          * Reverse the child list. Some drivers assumes node order matches .dts
 399          * node order
 400          */
 401         if (!dryrun && np->child) {
 402                 struct device_node *child = np->child;
 403                 np->child = NULL;
 404                 while (child) {
 405                         struct device_node *next = child->sibling;
 406                         child->sibling = np->child;
 407                         np->child = child;
 408                         child = next;
 409                 }
 410         }
 411
 412         if (nodepp)
 413                 *nodepp = np;
 414
 415         return mem;
 416 }
 417
 418 /**
 419  * __unflatten_device_tree - create tree of device_nodes from flat blob
 420  *
 421  * unflattens a device-tree, creating the
 422  * tree of struct device_node. It also fills the "name" and "type"
 423  * pointers of the nodes so the normal device-tree walking functions
 424  * can be used.
 425  * @blob: The blob to expand
 426  * @mynodes: The device_node tree created by the call
 427  * @dt_alloc: An allocator that provides a virtual address to memory
 428  * for the resulting tree
 429  */
 430 static void __unflatten_device_tree(const void *blob,
 431                              struct device_node **mynodes,
 432                              void * (*dt_alloc)(u64 size, u64 align))
 433 {
 434         unsigned long size;
 435         int start;
 436         void *mem;
 437
 438         pr_debug(" -> unflatten_device_tree()\n");
 439
 440         if (!blob) {
 441                 pr_debug("No device tree pointer\n");
 442                 return;
 443         }
 444
 445         pr_debug("Unflattening device tree:\n");
 446         pr_debug("magic: %08x\n", fdt_magic(blob));
 447         pr_debug("size: %08x\n", fdt_totalsize(blob));
 448         pr_debug("version: %08x\n", fdt_version(blob));
 449
 450         if (fdt_check_header(blob)) {
 451                 pr_err("Invalid device tree blob header\n");
 452                 return;
 453         }
 454
 455         /* First pass, scan for size */
 456         start = 0;
 457         size = (unsigned long)unflatten_dt_node(blob, NULL, &start, NULL, NULL, 0, true);
 458         size = ALIGN(size, 4);
 459
 460         pr_debug("  size is %lx, allocating...\n", size);
 461
 462         /* Allocate memory for the expanded device tree */
 463         mem = dt_alloc(size + 4, __alignof__(struct device_node));
 464         memset(mem, 0, size);
 465
 466         *(__be32 *)(mem + size) = cpu_to_be32(0xdeadbeef);
 467
 468         pr_debug("  unflattening %p...\n", mem);
 469
 470         /* Second pass, do actual unflattening */
 471         start = 0;
 472         unflatten_dt_node(blob, mem, &start, NULL, mynodes, 0, false);
 473         if (be32_to_cpup(mem + size) != 0xdeadbeef)
 474                 pr_warning("End of tree marker overwritten: %08x\n",
 475                            be32_to_cpup(mem + size));
 476
 477         pr_debug(" <- unflatten_device_tree()\n");
 478 }
 479
 480 static void *kernel_tree_alloc(u64 size, u64 align)
 481 {
 482         return kzalloc(size, GFP_KERNEL);
 483 }
 484
 485 static DEFINE_MUTEX(of_fdt_unflatten_mutex);
 486
 487 /**
 488  * of_fdt_unflatten_tree - create tree of device_nodes from flat blob
 489  *
 490  * unflattens the device-tree passed by the firmware, creating the
 491  * tree of struct device_node. It also fills the "name" and "type"
 492  * pointers of the nodes so the normal device-tree walking functions
 493  * can be used.
 494  */
 495 void of_fdt_unflatten_tree(const unsigned long *blob,
 496                         struct device_node **mynodes)
 497 {
 498         mutex_lock(&of_fdt_unflatten_mutex);
 499         __unflatten_device_tree(blob, mynodes, &kernel_tree_alloc);
 500         mutex_unlock(&of_fdt_unflatten_mutex);
 501 }
 502 EXPORT_SYMBOL_GPL(of_fdt_unflatten_tree);
 503
 504 /* Everything below here references initial_boot_params directly. */
 505 int __initdata dt_root_addr_cells;
 506 int __initdata dt_root_size_cells;
 507
 508 void *initial_boot_params;
 509
 510 #ifdef CONFIG_OF_EARLY_FLATTREE
 511
 512 static u32 of_fdt_crc32;
 513
 514 /**
 515  * res_mem_reserve_reg() - reserve all memory described in 'reg' property
 516  */
 517 static int __init __reserved_mem_reserve_reg(unsigned long node,
 518                                              const char *uname)
 519 {
 520         int t_len = (dt_root_addr_cells + dt_root_size_cells) * sizeof(__be32);
 521         phys_addr_t base, size;
 522         int len;
 523         const __be32 *prop;
 524         int nomap, first = 1;
 525
 526         prop = of_get_flat_dt_prop(node, "reg", &len);
 527         if (!prop)
 528                 return -ENOENT;
 529
 530         if (len && len % t_len != 0) {
 531                 pr_err("Reserved memory: invalid reg property in '%s', skipping node.\n",
 532                        uname);
 533                 return -EINVAL;
 534         }
 535
 536         nomap = of_get_flat_dt_prop(node, "no-map", NULL) != NULL;
 537
 538         while (len >= t_len) {
 539                 base = dt_mem_next_cell(dt_root_addr_cells, &prop);
 540                 size = dt_mem_next_cell(dt_root_size_cells, &prop);
 541
 542                 if (size &&
 543                     early_init_dt_reserve_memory_arch(base, size, nomap) == 0)
 544                         pr_debug("Reserved memory: reserved region for node '%s': base %pa, size %ld MiB\n",
 545                                 uname, &base, (unsigned long)size / SZ_1M);
 546                 else
 547                         pr_info("Reserved memory: failed to reserve memory for node '%s': base %pa, size %ld MiB\n",
 548                                 uname, &base, (unsigned long)size / SZ_1M);
 549
 550                 len -= t_len;
 551                 if (first) {
 552                         fdt_reserved_mem_save_node(node, uname, base, size);
 553                         first = 0;
 554                 }
 555         }
 556         return 0;
 557 }
 558
 559 /**
 560  * __reserved_mem_check_root() - check if #size-cells, #address-cells provided
 561  * in /reserved-memory matches the values supported by the current implementation,
 562  * also check if ranges property has been provided
 563  */
 564 static int __init __reserved_mem_check_root(unsigned long node)
 565 {
 566         const __be32 *prop;
 567
 568         prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
 569         if (!prop || be32_to_cpup(prop) != dt_root_size_cells)
 570                 return -EINVAL;
 571
 572         prop = of_get_flat_dt_prop(node, "#address-cells", NULL);
 573         if (!prop || be32_to_cpup(prop) != dt_root_addr_cells)
 574                 return -EINVAL;
 575
 576         prop = of_get_flat_dt_prop(node, "ranges", NULL);
 577         if (!prop)
 578                 return -EINVAL;
 579         return 0;
 580 }
 581
 582 /**
 583  * fdt_scan_reserved_mem() - scan a single FDT node for reserved memory
 584  */
 585 static int __init __fdt_scan_reserved_mem(unsigned long node, const char *uname,
 586                                           int depth, void *data)
 587 {
 588         static int found;
 589         const char *status;
 590         int err;
 591
 592         if (!found && depth == 1 && strcmp(uname, "reserved-memory") == 0) {
 593                 if (__reserved_mem_check_root(node) != 0) {
 594                         pr_err("Reserved memory: unsupported node format, ignoring\n");
 595                         /* break scan */
 596                         return 1;
 597                 }
 598                 found = 1;
 599                 /* scan next node */
 600                 return 0;
 601         } else if (!found) {
 602                 /* scan next node */
 603                 return 0;
 604         } else if (found && depth < 2) {
 605                 /* scanning of /reserved-memory has been finished */
 606                 return 1;
 607         }
 608
 609         status = of_get_flat_dt_prop(node, "status", NULL);
 610         if (status && strcmp(status, "okay") != 0 && strcmp(status, "ok") != 0)
 611                 return 0;
 612
 613         err = __reserved_mem_reserve_reg(node, uname);
 614         if (err == -ENOENT && of_get_flat_dt_prop(node, "size", NULL))
 615                 fdt_reserved_mem_save_node(node, uname, 0, 0);
 616
 617         /* scan next node */
 618         return 0;
 619 }
 620
 621 /**
 622  * early_init_fdt_scan_reserved_mem() - create reserved memory regions
 623  *
 624  * This function grabs memory from early allocator for device exclusive use
 625  * defined in device tree structures. It should be called by arch specific code
 626  * once the early allocator (i.e. memblock) has been fully activated.
 627  */
 628 void __init early_init_fdt_scan_reserved_mem(void)
 629 {
 630         int n;
 631         u64 base, size;
 632
 633         if (!initial_boot_params)
 634                 return;
 635
 636         /* Process header /memreserve/ fields */
 637         for (n = 0; ; n++) {
 638                 fdt_get_mem_rsv(initial_boot_params, n, &base, &size);
 639                 if (!size)
 640                         break;
 641                 early_init_dt_reserve_memory_arch(base, size, 0);
 642         }
 643
 644         of_scan_flat_dt(__fdt_scan_reserved_mem, NULL);
 645         fdt_init_reserved_mem();
 646 }
 647
 648 /**
 649  * early_init_fdt_reserve_self() - reserve the memory used by the FDT blob
 650  */
 651 void __init early_init_fdt_reserve_self(void)
 652 {
 653         if (!initial_boot_params)
 654                 return;
 655
 656         /* Reserve the dtb region */
 657         early_init_dt_reserve_memory_arch(__pa(initial_boot_params),
 658                                           fdt_totalsize(initial_boot_params),
 659                                           0);
 660 }
 661
 662 /**
 663  * of_scan_flat_dt - scan flattened tree blob and call callback on each.
 664  * @it: callback function
 665  * @data: context data pointer
 666  *
 667  * This function is used to scan the flattened device-tree, it is
 668  * used to extract the memory information at boot before we can
 669  * unflatten the tree
 670  */
 671 int __init of_scan_flat_dt(int (*it)(unsigned long node,
 672                                      const char *uname, int depth,
 673                                      void *data),
 674                            void *data)
 675 {
 676         const void *blob = initial_boot_params;
 677         const char *pathp;
 678         int offset, rc = 0, depth = -1;
 679
 680         for (offset = fdt_next_node(blob, -1, &depth);
 681              offset >= 0 && depth >= 0 && !rc;
 682              offset = fdt_next_node(blob, offset, &depth)) {
 683
 684                 pathp = fdt_get_name(blob, offset, NULL);
 685                 if (*pathp == '/')
 686                         pathp = kbasename(pathp);
 687                 rc = it(offset, pathp, depth, data);
 688         }
 689         return rc;
 690 }
 691
 692 /**
 693  * of_get_flat_dt_root - find the root node in the flat blob
 694  */
 695 unsigned long __init of_get_flat_dt_root(void)
 696 {
 697         return 0;
 698 }
 699
 700 /**
 701  * of_get_flat_dt_size - Return the total size of the FDT
 702  */
 703 int __init of_get_flat_dt_size(void)
 704 {
 705         return fdt_totalsize(initial_boot_params);
 706 }
 707
 708 /**
 709  * of_get_flat_dt_prop - Given a node in the flat blob, return the property ptr
 710  *
 711  * This function can be used within scan_flattened_dt callback to get
 712  * access to properties
 713  */
 714 const void *__init of_get_flat_dt_prop(unsigned long node, const char *name,
 715                                        int *size)
 716 {
 717         return fdt_getprop(initial_boot_params, node, name, size);
 718 }
 719
 720 /**
 721  * of_flat_dt_is_compatible - Return true if given node has compat in compatible list
 722  * @node: node to test
 723  * @compat: compatible string to compare with compatible list.
 724  */
 725 int __init of_flat_dt_is_compatible(unsigned long node, const char *compat)
 726 {
 727         return of_fdt_is_compatible(initial_boot_params, node, compat);
 728 }
 729
 730 /**
 731  * of_flat_dt_match - Return true if node matches a list of compatible values
 732  */
 733 int __init of_flat_dt_match(unsigned long node, const char *const *compat)
 734 {
 735         return of_fdt_match(initial_boot_params, node, compat);
 736 }
 737
 738 struct fdt_scan_status {
 739         const char *name;
 740         int namelen;
 741         int depth;
 742         int found;
 743         int (*iterator)(unsigned long node, const char *uname, int depth, void *data);
 744         void *data;
 745 };
 746
 747 const char * __init of_flat_dt_get_machine_name(void)
 748 {
 749         const char *name;
 750         unsigned long dt_root = of_get_flat_dt_root();
 751
 752         name = of_get_flat_dt_prop(dt_root, "model", NULL);
 753         if (!name)
 754                 name = of_get_flat_dt_prop(dt_root, "compatible", NULL);
 755         return name;
 756 }
 757
 758 /**
 759  * of_flat_dt_match_machine - Iterate match tables to find matching machine.
 760  *
 761  * @default_match: A machine specific ptr to return in case of no match.
 762  * @get_next_compat: callback function to return next compatible match table.
 763  *
 764  * Iterate through machine match tables to find the best match for the machine
 765  * compatible string in the FDT.
 766  */
 767 const void * __init of_flat_dt_match_machine(const void *default_match,
 768                 const void * (*get_next_compat)(const char * const**))
 769 {
 770         const void *data = NULL;
 771         const void *best_data = default_match;
 772         const char *const *compat;
 773         unsigned long dt_root;
 774         unsigned int best_score = ~1, score = 0;
 775
 776         dt_root = of_get_flat_dt_root();
 777         while ((data = get_next_compat(&compat))) {
 778                 score = of_flat_dt_match(dt_root, compat);
 779                 if (score > 0 && score < best_score) {
 780                         best_data = data;
 781                         best_score = score;
 782                 }
 783         }
 784         if (!best_data) {
 785                 const char *prop;
 786                 int size;
 787
 788                 pr_err("\n unrecognized device tree list:\n[ ");
 789
 790                 prop = of_get_flat_dt_prop(dt_root, "compatible", &size);
 791                 if (prop) {
 792                         while (size > 0) {
 793                                 printk("'%s' ", prop);
 794                                 size -= strlen(prop) + 1;
 795                                 prop += strlen(prop) + 1;
 796                         }
 797                 }
 798                 printk("]\n\n");
 799                 return NULL;
 800         }
 801
 802         pr_info("Machine model: %s\n", of_flat_dt_get_machine_name());
 803
 804         return best_data;
 805 }
 806
 807 #ifdef CONFIG_BLK_DEV_INITRD
 808 #ifndef __early_init_dt_declare_initrd
 809 static void __early_init_dt_declare_initrd(unsigned long start,
 810                                            unsigned long end)
 811 {
 812         initrd_start = (unsigned long)__va(start);
 813         initrd_end = (unsigned long)__va(end);
 814         initrd_below_start_ok = 1;
 815 }
 816 #endif
 817
 818 /**
 819  * early_init_dt_check_for_initrd - Decode initrd location from flat tree
 820  * @node: reference to node containing initrd location ('chosen')
 821  */
 822 static void __init early_init_dt_check_for_initrd(unsigned long node)
 823 {
 824         u64 start, end;
 825         int len;
 826         const __be32 *prop;
 827
 828         pr_debug("Looking for initrd properties... ");
 829
 830         prop = of_get_flat_dt_prop(node, "linux,initrd-start", &len);
 831         if (!prop)
 832                 return;
 833         start = of_read_number(prop, len/4);
 834
 835         prop = of_get_flat_dt_prop(node, "linux,initrd-end", &len);
 836         if (!prop)
 837                 return;
 838         end = of_read_number(prop, len/4);
 839
 840         __early_init_dt_declare_initrd(start, end);
 841
 842         pr_debug("initrd_start=0x%llx  initrd_end=0x%llx\n",
 843                  (unsigned long long)start, (unsigned long long)end);
 844 }
 845 #else
 846 static inline void early_init_dt_check_for_initrd(unsigned long node)
 847 {
 848 }
 849 #endif /* CONFIG_BLK_DEV_INITRD */
 850
 851 #ifdef CONFIG_SERIAL_EARLYCON
 852
 853 static int __init early_init_dt_scan_chosen_serial(void)
 854 {
 855         int offset;
 856         const char *p, *q, *options = NULL;
 857         int l;
 858         const struct earlycon_id *match;
 859         const void *fdt = initial_boot_params;
 860
 861         offset = fdt_path_offset(fdt, "/chosen");
 862         if (offset < 0)
 863                 offset = fdt_path_offset(fdt, "/chosen@0");
 864         if (offset < 0)
 865                 return -ENOENT;
 866
 867         p = fdt_getprop(fdt, offset, "stdout-path", &l);
 868         if (!p)
 869                 p = fdt_getprop(fdt, offset, "linux,stdout-path", &l);
 870         if (!p || !l)
 871                 return -ENOENT;
 872
 873         q = strchrnul(p, ':');
 874         if (*q != '\0')
 875                 options = q + 1;
 876         l = q - p;
 877
 878         /* Get the node specified by stdout-path */
 879         offset = fdt_path_offset_namelen(fdt, p, l);
 880         if (offset < 0) {
 881                 pr_warn("earlycon: stdout-path %.*s not found\n", l, p);
 882                 return 0;
 883         }
 884
 885         for (match = __earlycon_table; match < __earlycon_table_end; match++) {
 886                 if (!match->compatible[0])
 887                         continue;
 888
 889                 if (fdt_node_check_compatible(fdt, offset, match->compatible))
 890                         continue;
 891
 892                 of_setup_earlycon(match, offset, options);
 893                 return 0;
 894         }
 895         return -ENODEV;
 896 }
 897
 898 static int __init setup_of_earlycon(char *buf)
 899 {
 900         if (buf)
 901                 return 0;
 902
 903         return early_init_dt_scan_chosen_serial();
 904 }
 905 early_param("earlycon", setup_of_earlycon);
 906 #endif
 907
 908 /**
 909  * early_init_dt_scan_root - fetch the top level address and size cells
 910  */
 911 int __init early_init_dt_scan_root(unsigned long node, const char *uname,
 912                                    int depth, void *data)
 913 {
 914         const __be32 *prop;
 915
 916         if (depth != 0)
 917                 return 0;
 918
 919         dt_root_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
 920         dt_root_addr_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
 921
 922         prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
 923         if (prop)
 924                 dt_root_size_cells = be32_to_cpup(prop);
 925         pr_debug("dt_root_size_cells = %x\n", dt_root_size_cells);
 926
 927         prop = of_get_flat_dt_prop(node, "#address-cells", NULL);
 928         if (prop)
 929                 dt_root_addr_cells = be32_to_cpup(prop);
 930         pr_debug("dt_root_addr_cells = %x\n", dt_root_addr_cells);
 931
 932         /* break now */
 933         return 1;
 934 }
 935
 936 u64 __init dt_mem_next_cell(int s, const __be32 **cellp)
 937 {
 938         const __be32 *p = *cellp;
 939
 940         *cellp = p + s;
 941         return of_read_number(p, s);
 942 }
 943
 944 /**
 945  * early_init_dt_scan_memory - Look for an parse memory nodes
 946  */
 947 int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
 948                                      int depth, void *data)
 949 {
 950         const char *type = of_get_flat_dt_prop(node, "device_type", NULL);
 951         const __be32 *reg, *endp;
 952         int l;
 953
 954         /* We are scanning "memory" nodes only */
 955         if (type == NULL) {
 956                 /*
 957                  * The longtrail doesn't have a device_type on the
 958                  * /memory node, so look for the node called /memory@0.
 959                  */
 960                 if (!IS_ENABLED(CONFIG_PPC32) || depth != 1 || strcmp(uname, "memory@0") != 0)
 961                         return 0;
 962         } else if (strcmp(type, "memory") != 0)
 963                 return 0;
 964
 965         reg = of_get_flat_dt_prop(node, "linux,usable-memory", &l);
 966         if (reg == NULL)
 967                 reg = of_get_flat_dt_prop(node, "reg", &l);
 968         if (reg == NULL)
 969                 return 0;
 970
 971         endp = reg + (l / sizeof(__be32));
 972
 973         pr_debug("memory scan node %s, reg size %d,\n", uname, l);
 974
 975         while ((endp - reg) >= (dt_root_addr_cells + dt_root_size_cells)) {
 976                 u64 base, size;
 977
 978                 base = dt_mem_next_cell(dt_root_addr_cells, &reg);
 979                 size = dt_mem_next_cell(dt_root_size_cells, &reg);
 980
 981                 if (size == 0)
 982                         continue;
 983                 pr_debug(" - %llx ,  %llx\n", (unsigned long long)base,
 984                     (unsigned long long)size);
 985
 986                 early_init_dt_add_memory_arch(base, size);
 987         }
 988
 989         return 0;
 990 }
 991
 992 int __init early_init_dt_scan_chosen(unsigned long node, const char *uname,
 993                                      int depth, void *data)
 994 {
 995         int l;
 996         const char *p;
 997
 998         pr_debug("search \"chosen\", depth: %d, uname: %s\n", depth, uname);
 999
1000         if (depth != 1 || !data ||
1001             (strcmp(uname, "chosen") != 0 && strcmp(uname, "chosen@0") != 0))
1002                 return 0;
1003
1004         early_init_dt_check_for_initrd(node);
1005
1006         /* Retrieve command line */
1007         p = of_get_flat_dt_prop(node, "bootargs", &l);
1008         if (p != NULL && l > 0)
1009                 strlcpy(data, p, min((int)l, COMMAND_LINE_SIZE));
1010
1011         /*
1012          * CONFIG_CMDLINE is meant to be a default in case nothing else
1013          * managed to set the command line, unless CONFIG_CMDLINE_FORCE
1014          * is set in which case we override whatever was found earlier.
1015          */
1016 #ifdef CONFIG_CMDLINE
1017 #if defined(CONFIG_CMDLINE_EXTEND)
1018         strlcat(data, " ", COMMAND_LINE_SIZE);
1019         strlcat(data, CONFIG_CMDLINE, COMMAND_LINE_SIZE);
1020 #elif defined(CONFIG_CMDLINE_FORCE)
1021         strlcpy(data, CONFIG_CMDLINE, COMMAND_LINE_SIZE);
1022 #else
1023         /* No arguments from boot loader, use kernel's  cmdl*/
1024         if (!((char *)data)[0])
1025                 strlcpy(data, CONFIG_CMDLINE, COMMAND_LINE_SIZE);
1026 #endif
1027 #endif /* CONFIG_CMDLINE */
1028
1029         pr_debug("Command line is: %s\n", (char*)data);
1030
1031         /* break now */
1032         return 1;
1033 }
1034
1035 #ifdef CONFIG_HAVE_MEMBLOCK
1036 #ifndef MIN_MEMBLOCK_ADDR
1037 #define MIN_MEMBLOCK_ADDR       __pa(PAGE_OFFSET)
1038 #endif
1039 #ifndef MAX_MEMBLOCK_ADDR
1040 #define MAX_MEMBLOCK_ADDR       ((phys_addr_t)~0)
1041 #endif
1042
1043 void __init __weak early_init_dt_add_memory_arch(u64 base, u64 size)
1044 {
1045         const u64 phys_offset = MIN_MEMBLOCK_ADDR;
1046
1047         if (!PAGE_ALIGNED(base)) {
1048                 if (size < PAGE_SIZE - (base & ~PAGE_MASK)) {
1049                         pr_warn("Ignoring memory block 0x%llx - 0x%llx\n",
1050                                 base, base + size);
1051                         return;
1052                 }
1053                 size -= PAGE_SIZE - (base & ~PAGE_MASK);
1054                 base = PAGE_ALIGN(base);
1055         }
1056         size &= PAGE_MASK;
1057
1058         if (base > MAX_MEMBLOCK_ADDR) {
1059                 pr_warning("Ignoring memory block 0x%llx - 0x%llx\n",
1060                                 base, base + size);
1061                 return;
1062         }
1063
1064         if (base + size - 1 > MAX_MEMBLOCK_ADDR) {
1065                 pr_warning("Ignoring memory range 0x%llx - 0x%llx\n",
1066                                 ((u64)MAX_MEMBLOCK_ADDR) + 1, base + size);
1067                 size = MAX_MEMBLOCK_ADDR - base + 1;
1068         }
1069
1070         if (base + size < phys_offset) {
1071                 pr_warning("Ignoring memory block 0x%llx - 0x%llx\n",
1072                            base, base + size);
1073                 return;
1074         }
1075         if (base < phys_offset) {
1076                 pr_warning("Ignoring memory range 0x%llx - 0x%llx\n",
1077                            base, phys_offset);
1078                 size -= phys_offset - base;
1079                 base = phys_offset;
1080         }
1081         memblock_add(base, size);
1082 }
1083
1084 int __init __weak early_init_dt_reserve_memory_arch(phys_addr_t base,
1085                                         phys_addr_t size, bool nomap)
1086 {
1087         if (nomap)
1088                 return memblock_remove(base, size);
1089         return memblock_reserve(base, size);
1090 }
1091
1092 /*
1093  * called from unflatten_device_tree() to bootstrap devicetree itself
1094  * Architectures can override this definition if memblock isn't used
1095  */
1096 void * __init __weak early_init_dt_alloc_memory_arch(u64 size, u64 align)
1097 {
1098         return __va(memblock_alloc(size, align));
1099 }
1100 #else
1101 void __init __weak early_init_dt_add_memory_arch(u64 base, u64 size)
1102 {
1103         WARN_ON(1);
1104 }
1105
1106 int __init __weak early_init_dt_reserve_memory_arch(phys_addr_t base,
1107                                         phys_addr_t size, bool nomap)
1108 {
1109         pr_err("Reserved memory not supported, ignoring range %pa - %pa%s\n",
1110                   &base, &size, nomap ? " (nomap)" : "");
1111         return -ENOSYS;
1112 }
1113
1114 void * __init __weak early_init_dt_alloc_memory_arch(u64 size, u64 align)
1115 {
1116         WARN_ON(1);
1117         return NULL;
1118 }
1119 #endif
1120
1121 bool __init early_init_dt_verify(void *params)
1122 {
1123         if (!params)
1124                 return false;
1125
1126         /* check device tree validity */
1127         if (fdt_check_header(params))
1128                 return false;
1129
1130         /* Setup flat device-tree pointer */
1131         initial_boot_params = params;
1132         of_fdt_crc32 = crc32_be(~0, initial_boot_params,
1133                                 fdt_totalsize(initial_boot_params));
1134         return true;
1135 }
1136
1137
1138 void __init early_init_dt_scan_nodes(void)
1139 {
1140         /* Retrieve various information from the /chosen node */
1141         of_scan_flat_dt(early_init_dt_scan_chosen, boot_command_line);
1142
1143         /* Initialize {size,address}-cells info */
1144         of_scan_flat_dt(early_init_dt_scan_root, NULL);
1145
1146         /* Setup memory, calling early_init_dt_add_memory_arch */
1147         of_scan_flat_dt(early_init_dt_scan_memory, NULL);
1148 }
1149
1150 bool __init early_init_dt_scan(void *params)
1151 {
1152         bool status;
1153
1154         status = early_init_dt_verify(params);
1155         if (!status)
1156                 return false;
1157
1158         early_init_dt_scan_nodes();
1159         return true;
1160 }
1161
1162 /**
1163  * unflatten_device_tree - create tree of device_nodes from flat blob
1164  *
1165  * unflattens the device-tree passed by the firmware, creating the
1166  * tree of struct device_node. It also fills the "name" and "type"
1167  * pointers of the nodes so the normal device-tree walking functions
1168  * can be used.
1169  */
1170 void __init unflatten_device_tree(void)
1171 {
1172         __unflatten_device_tree(initial_boot_params, &of_root,
1173                                 early_init_dt_alloc_memory_arch);
1174
1175         /* Get pointer to "/chosen" and "/aliases" nodes for use everywhere */
1176         of_alias_scan(early_init_dt_alloc_memory_arch);
1177 }
1178
1179 /**
1180  * unflatten_and_copy_device_tree - copy and create tree of device_nodes from flat blob
1181  *
1182  * Copies and unflattens the device-tree passed by the firmware, creating the
1183  * tree of struct device_node. It also fills the "name" and "type"
1184  * pointers of the nodes so the normal device-tree walking functions
1185  * can be used. This should only be used when the FDT memory has not been
1186  * reserved such is the case when the FDT is built-in to the kernel init
1187  * section. If the FDT memory is reserved already then unflatten_device_tree
1188  * should be used instead.
1189  */
1190 void __init unflatten_and_copy_device_tree(void)
1191 {
1192         int size;
1193         void *dt;
1194
1195         if (!initial_boot_params) {
1196                 pr_warn("No valid device tree found, continuing without\n");
1197                 return;
1198         }
1199
1200         size = fdt_totalsize(initial_boot_params);
1201         dt = early_init_dt_alloc_memory_arch(size,
1202                                              roundup_pow_of_two(FDT_V17_SIZE));
1203
1204         if (dt) {
1205                 memcpy(dt, initial_boot_params, size);
1206                 initial_boot_params = dt;
1207         }
1208         unflatten_device_tree();
1209 }
1210
1211 #ifdef CONFIG_SYSFS
1212 static ssize_t of_fdt_raw_read(struct file *filp, struct kobject *kobj,
1213                                struct bin_attribute *bin_attr,
1214                                char *buf, loff_t off, size_t count)
1215 {
1216         memcpy(buf, initial_boot_params + off, count);
1217         return count;
1218 }
1219
1220 static int __init of_fdt_raw_init(void)
1221 {
1222         static struct bin_attribute of_fdt_raw_attr =
1223                 __BIN_ATTR(fdt, S_IRUSR, of_fdt_raw_read, NULL, 0);
1224
1225         if (!initial_boot_params)
1226                 return 0;
1227
1228         if (of_fdt_crc32 != crc32_be(~0, initial_boot_params,
1229                                      fdt_totalsize(initial_boot_params))) {
1230                 pr_warn("fdt: not creating '/sys/firmware/fdt': CRC check failed\n");
1231                 return 0;
1232         }
1233         of_fdt_raw_attr.size = fdt_totalsize(initial_boot_params);
1234         return sysfs_create_bin_file(firmware_kobj, &of_fdt_raw_attr);
1235 }
1236 late_initcall(of_fdt_raw_init);
1237 #endif
1238
1239 #endif /* CONFIG_OF_EARLY_FLATTREE */