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