blob: 5f47d8d29b77cc1064a5f390906bfaebbb90465f [file] [log] [blame]
b.liue9582032025-04-17 19:18:16 +08001// SPDX-License-Identifier: GPL-2.0
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
7 */
8
9#define pr_fmt(fmt) "OF: fdt: " fmt
10
11#include <linux/crc32.h>
12#include <linux/kernel.h>
13#include <linux/initrd.h>
14#include <linux/memblock.h>
15#include <linux/mutex.h>
16#include <linux/of.h>
17#include <linux/of_fdt.h>
18#include <linux/of_reserved_mem.h>
19#include <linux/sizes.h>
20#include <linux/string.h>
21#include <linux/errno.h>
22#include <linux/slab.h>
23#include <linux/libfdt.h>
24#include <linux/debugfs.h>
25#include <linux/serial_core.h>
26#include <linux/sysfs.h>
27#include <linux/random.h>
28
29#include <asm/setup.h> /* for COMMAND_LINE_SIZE */
30#include <asm/page.h>
31
32#include "of_private.h"
33
34/*
35 * of_fdt_limit_memory - limit the number of regions in the /memory node
36 * @limit: maximum entries
37 *
38 * Adjust the flattened device tree to have at most 'limit' number of
39 * memory entries in the /memory node. This function may be called
40 * any time after initial_boot_param is set.
41 */
42void __init of_fdt_limit_memory(int limit)
43{
44 int memory;
45 int len;
46 const void *val;
47 int nr_address_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
48 int nr_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
49 const __be32 *addr_prop;
50 const __be32 *size_prop;
51 int root_offset;
52 int cell_size;
53
54 root_offset = fdt_path_offset(initial_boot_params, "/");
55 if (root_offset < 0)
56 return;
57
58 addr_prop = fdt_getprop(initial_boot_params, root_offset,
59 "#address-cells", NULL);
60 if (addr_prop)
61 nr_address_cells = fdt32_to_cpu(*addr_prop);
62
63 size_prop = fdt_getprop(initial_boot_params, root_offset,
64 "#size-cells", NULL);
65 if (size_prop)
66 nr_size_cells = fdt32_to_cpu(*size_prop);
67
68 cell_size = sizeof(uint32_t)*(nr_address_cells + nr_size_cells);
69
70 memory = fdt_path_offset(initial_boot_params, "/memory");
71 if (memory > 0) {
72 val = fdt_getprop(initial_boot_params, memory, "reg", &len);
73 if (len > limit*cell_size) {
74 len = limit*cell_size;
75 pr_debug("Limiting number of entries to %d\n", limit);
76 fdt_setprop(initial_boot_params, memory, "reg", val,
77 len);
78 }
79 }
80}
81
82static bool of_fdt_device_is_available(const void *blob, unsigned long node)
83{
84 const char *status = fdt_getprop(blob, node, "status", NULL);
85
86 if (!status)
87 return true;
88
89 if (!strcmp(status, "ok") || !strcmp(status, "okay"))
90 return true;
91
92 return false;
93}
94
95static void *unflatten_dt_alloc(void **mem, unsigned long size,
96 unsigned long align)
97{
98 void *res;
99
100 *mem = PTR_ALIGN(*mem, align);
101 res = *mem;
102 *mem += size;
103
104 return res;
105}
106
107static void populate_properties(const void *blob,
108 int offset,
109 void **mem,
110 struct device_node *np,
111 const char *nodename,
112 bool dryrun)
113{
114 struct property *pp, **pprev = NULL;
115 int cur;
116 bool has_name = false;
117
118 pprev = &np->properties;
119 for (cur = fdt_first_property_offset(blob, offset);
120 cur >= 0;
121 cur = fdt_next_property_offset(blob, cur)) {
122 const __be32 *val;
123 const char *pname;
124 u32 sz;
125
126 val = fdt_getprop_by_offset(blob, cur, &pname, &sz);
127 if (!val) {
128 pr_warn("Cannot locate property at 0x%x\n", cur);
129 continue;
130 }
131
132 if (!pname) {
133 pr_warn("Cannot find property name at 0x%x\n", cur);
134 continue;
135 }
136
137 if (!strcmp(pname, "name"))
138 has_name = true;
139
140 pp = unflatten_dt_alloc(mem, sizeof(struct property),
141 __alignof__(struct property));
142 if (dryrun)
143 continue;
144
145 /* We accept flattened tree phandles either in
146 * ePAPR-style "phandle" properties, or the
147 * legacy "linux,phandle" properties. If both
148 * appear and have different values, things
149 * will get weird. Don't do that.
150 */
151 if (!strcmp(pname, "phandle") ||
152 !strcmp(pname, "linux,phandle")) {
153 if (!np->phandle)
154 np->phandle = be32_to_cpup(val);
155 }
156
157 /* And we process the "ibm,phandle" property
158 * used in pSeries dynamic device tree
159 * stuff
160 */
161 if (!strcmp(pname, "ibm,phandle"))
162 np->phandle = be32_to_cpup(val);
163
164 pp->name = (char *)pname;
165 pp->length = sz;
166 pp->value = (__be32 *)val;
167 *pprev = pp;
168 pprev = &pp->next;
169 }
170
171 /* With version 0x10 we may not have the name property,
172 * recreate it here from the unit name if absent
173 */
174 if (!has_name) {
175 const char *p = nodename, *ps = p, *pa = NULL;
176 int len;
177
178 while (*p) {
179 if ((*p) == '@')
180 pa = p;
181 else if ((*p) == '/')
182 ps = p + 1;
183 p++;
184 }
185
186 if (pa < ps)
187 pa = p;
188 len = (pa - ps) + 1;
189 pp = unflatten_dt_alloc(mem, sizeof(struct property) + len,
190 __alignof__(struct property));
191 if (!dryrun) {
192 pp->name = "name";
193 pp->length = len;
194 pp->value = pp + 1;
195 *pprev = pp;
196 pprev = &pp->next;
197 memcpy(pp->value, ps, len - 1);
198 ((char *)pp->value)[len - 1] = 0;
199 pr_debug("fixed up name for %s -> %s\n",
200 nodename, (char *)pp->value);
201 }
202 }
203
204 if (!dryrun)
205 *pprev = NULL;
206}
207
208static bool populate_node(const void *blob,
209 int offset,
210 void **mem,
211 struct device_node *dad,
212 struct device_node **pnp,
213 bool dryrun)
214{
215 struct device_node *np;
216 const char *pathp;
217 unsigned int l, allocl;
218
219 pathp = fdt_get_name(blob, offset, &l);
220 if (!pathp) {
221 *pnp = NULL;
222 return false;
223 }
224
225 allocl = ++l;
226
227 np = unflatten_dt_alloc(mem, sizeof(struct device_node) + allocl,
228 __alignof__(struct device_node));
229 if (!dryrun) {
230 char *fn;
231 of_node_init(np);
232 np->full_name = fn = ((char *)np) + sizeof(*np);
233
234 memcpy(fn, pathp, l);
235
236 if (dad != NULL) {
237 np->parent = dad;
238 np->sibling = dad->child;
239 dad->child = np;
240 }
241 }
242
243 populate_properties(blob, offset, mem, np, pathp, dryrun);
244 if (!dryrun) {
245 np->name = of_get_property(np, "name", NULL);
246 if (!np->name)
247 np->name = "<NULL>";
248 }
249
250 *pnp = np;
251 return true;
252}
253
254static void reverse_nodes(struct device_node *parent)
255{
256 struct device_node *child, *next;
257
258 /* In-depth first */
259 child = parent->child;
260 while (child) {
261 reverse_nodes(child);
262
263 child = child->sibling;
264 }
265
266 /* Reverse the nodes in the child list */
267 child = parent->child;
268 parent->child = NULL;
269 while (child) {
270 next = child->sibling;
271
272 child->sibling = parent->child;
273 parent->child = child;
274 child = next;
275 }
276}
277
278/**
279 * unflatten_dt_nodes - Alloc and populate a device_node from the flat tree
280 * @blob: The parent device tree blob
281 * @mem: Memory chunk to use for allocating device nodes and properties
282 * @dad: Parent struct device_node
283 * @nodepp: The device_node tree created by the call
284 *
285 * Return: The size of unflattened device tree or error code
286 */
287static int unflatten_dt_nodes(const void *blob,
288 void *mem,
289 struct device_node *dad,
290 struct device_node **nodepp)
291{
292 struct device_node *root;
293 int offset = 0, depth = 0, initial_depth = 0;
294#define FDT_MAX_DEPTH 64
295 struct device_node *nps[FDT_MAX_DEPTH];
296 void *base = mem;
297 bool dryrun = !base;
298
299 if (nodepp)
300 *nodepp = NULL;
301
302 /*
303 * We're unflattening device sub-tree if @dad is valid. There are
304 * possibly multiple nodes in the first level of depth. We need
305 * set @depth to 1 to make fdt_next_node() happy as it bails
306 * immediately when negative @depth is found. Otherwise, the device
307 * nodes except the first one won't be unflattened successfully.
308 */
309 if (dad)
310 depth = initial_depth = 1;
311
312 root = dad;
313 nps[depth] = dad;
314
315 for (offset = 0;
316 offset >= 0 && depth >= initial_depth;
317 offset = fdt_next_node(blob, offset, &depth)) {
318 if (WARN_ON_ONCE(depth >= FDT_MAX_DEPTH - 1))
319 continue;
320
321 if (!IS_ENABLED(CONFIG_OF_KOBJ) &&
322 !of_fdt_device_is_available(blob, offset))
323 continue;
324
325 if (!populate_node(blob, offset, &mem, nps[depth],
326 &nps[depth+1], dryrun))
327 return mem - base;
328
329 if (!dryrun && nodepp && !*nodepp)
330 *nodepp = nps[depth+1];
331 if (!dryrun && !root)
332 root = nps[depth+1];
333 }
334
335 if (offset < 0 && offset != -FDT_ERR_NOTFOUND) {
336 pr_err("Error %d processing FDT\n", offset);
337 return -EINVAL;
338 }
339
340 /*
341 * Reverse the child list. Some drivers assumes node order matches .dts
342 * node order
343 */
344 if (!dryrun)
345 reverse_nodes(root);
346
347 return mem - base;
348}
349
350/**
351 * __unflatten_device_tree - create tree of device_nodes from flat blob
352 * @blob: The blob to expand
353 * @dad: Parent device node
354 * @mynodes: The device_node tree created by the call
355 * @dt_alloc: An allocator that provides a virtual address to memory
356 * for the resulting tree
357 * @detached: if true set OF_DETACHED on @mynodes
358 *
359 * unflattens a device-tree, creating the tree of struct device_node. It also
360 * fills the "name" and "type" pointers of the nodes so the normal device-tree
361 * walking functions can be used.
362 *
363 * Return: NULL on failure or the memory chunk containing the unflattened
364 * device tree on success.
365 */
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)
371{
372 int size;
373 void *mem;
374
375 pr_debug(" -> unflatten_device_tree()\n");
376
377 if (!blob) {
378 pr_debug("No device tree pointer\n");
379 return NULL;
380 }
381
382 pr_debug("Unflattening device tree:\n");
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));
386
387 if (fdt_check_header(blob)) {
388 pr_err("Invalid device tree blob header\n");
389 return NULL;
390 }
391
392 /* First pass, scan for size */
393 size = unflatten_dt_nodes(blob, NULL, dad, NULL);
394 if (size < 0)
395 return NULL;
396
397 size = ALIGN(size, 4);
398 pr_debug(" size is %d, allocating...\n", size);
399
400 /* Allocate memory for the expanded device tree */
401 mem = dt_alloc(size + 4, __alignof__(struct device_node));
402 if (!mem)
403 return NULL;
404
405 memset(mem, 0, size);
406
407 *(__be32 *)(mem + size) = cpu_to_be32(0xdeadbeef);
408
409 pr_debug(" unflattening %p...\n", mem);
410
411 /* Second pass, do actual unflattening */
412 unflatten_dt_nodes(blob, mem, dad, mynodes);
413 if (be32_to_cpup(mem + size) != 0xdeadbeef)
414 pr_warning("End of tree marker overwritten: %08x\n",
415 be32_to_cpup(mem + size));
416
417 if (detached && mynodes) {
418 of_node_set_flag(*mynodes, OF_DETACHED);
419 pr_debug("unflattened tree is detached\n");
420 }
421
422 pr_debug(" <- unflatten_device_tree()\n");
423 return mem;
424}
425
426static void *kernel_tree_alloc(u64 size, u64 align)
427{
428 return kzalloc(size, GFP_KERNEL);
429}
430
431static DEFINE_MUTEX(of_fdt_unflatten_mutex);
432
433/**
434 * of_fdt_unflatten_tree - create tree of device_nodes from flat blob
435 * @blob: Flat device tree blob
436 * @dad: Parent device node
437 * @mynodes: The device tree created by the call
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.
443 *
444 * Return: NULL on failure or the memory chunk containing the unflattened
445 * device tree on success.
446 */
447void *of_fdt_unflatten_tree(const unsigned long *blob,
448 struct device_node *dad,
449 struct device_node **mynodes)
450{
451 void *mem;
452
453 mutex_lock(&of_fdt_unflatten_mutex);
454 mem = __unflatten_device_tree(blob, dad, mynodes, &kernel_tree_alloc,
455 true);
456 mutex_unlock(&of_fdt_unflatten_mutex);
457
458 return mem;
459}
460EXPORT_SYMBOL_GPL(of_fdt_unflatten_tree);
461
462/* Everything below here references initial_boot_params directly. */
463int __initdata dt_root_addr_cells;
464int __initdata dt_root_size_cells;
465
466void *initial_boot_params __ro_after_init;
467
468#ifdef CONFIG_OF_EARLY_FLATTREE
469
470static u32 of_fdt_crc32;
471
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;
480 int len;
481 const __be32 *prop;
482 int first = 1;
483 bool nomap;
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
501 if (size &&
502 early_init_dt_reserve_memory_arch(base, size, nomap) == 0)
503 pr_debug("Reserved memory: reserved region for node '%s': base %pa, size %lu 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 %lu MiB\n",
507 uname, &base, (unsigned long)(size / SZ_1M));
508
509 len -= t_len;
510 if (first) {
511 fdt_reserved_mem_save_node(node, uname, base, size);
512 first = 0;
513 }
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 */
523static int __init __reserved_mem_check_root(unsigned long node)
524{
525 const __be32 *prop;
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;
548 int err;
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
567 if (!of_fdt_device_is_available(initial_boot_params, node))
568 return 0;
569
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);
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{
587 int n;
588 u64 base, size;
589
590 if (!initial_boot_params)
591 return;
592
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;
598 early_init_dt_reserve_memory_arch(base, size, false);
599 }
600
601 of_scan_flat_dt(__fdt_scan_reserved_mem, NULL);
602 fdt_init_reserved_mem();
603}
604
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),
616 false);
617}
618
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{
633 const void *blob = initial_boot_params;
634 const char *pathp;
635 int offset, rc = 0, depth = -1;
636
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)) {
643
644 pathp = fdt_get_name(blob, offset, NULL);
645 if (*pathp == '/')
646 pathp = kbasename(pathp);
647 rc = it(offset, pathp, depth, data);
648 }
649 return rc;
650}
651
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
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
690int __init of_get_flat_dt_subnode_by_name(unsigned long node, const char *uname)
691{
692 return fdt_subnode_offset(initial_boot_params, node, uname);
693}
694
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{
700 return 0;
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 */
709const void *__init of_get_flat_dt_prop(unsigned long node, const char *name,
710 int *size)
711{
712 return fdt_getprop(initial_boot_params, node, name, size);
713}
714
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 * Return: a non-zero value on match 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
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
757/**
758 * of_flat_dt_match - Return true if node matches a list of compatible values
759 */
760static int __init of_flat_dt_match(unsigned long node, const char *const *compat)
761{
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;
775}
776
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
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
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;
833 int size;
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
854#ifdef CONFIG_BLK_DEV_INITRD
855static void __early_init_dt_declare_initrd(unsigned long start,
856 unsigned long end)
857{
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 }
868}
869
870/**
871 * early_init_dt_check_for_initrd - Decode initrd location from flat tree
872 * @node: reference to node containing initrd location ('chosen')
873 */
874static void __init early_init_dt_check_for_initrd(unsigned long node)
875{
876 u64 start, end;
877 int len;
878 const __be32 *prop;
879
880 pr_debug("Looking for initrd properties... ");
881
882 prop = of_get_flat_dt_prop(node, "linux,initrd-start", &len);
883 if (!prop)
884 return;
885 start = of_read_number(prop, len/4);
886
887 prop = of_get_flat_dt_prop(node, "linux,initrd-end", &len);
888 if (!prop)
889 return;
890 end = of_read_number(prop, len/4);
891
892 __early_init_dt_declare_initrd(start, end);
893 phys_initrd_start = start;
894 phys_initrd_size = end - start;
895
896 pr_debug("initrd_start=0x%llx initrd_end=0x%llx\n",
897 (unsigned long long)start, (unsigned long long)end);
898}
899#else
900static inline void early_init_dt_check_for_initrd(unsigned long node)
901{
902}
903#endif /* CONFIG_BLK_DEV_INITRD */
904
905#ifdef CONFIG_SERIAL_EARLYCON
906
907int __init early_init_dt_scan_chosen_stdout(void)
908{
909 int offset;
910 const char *p, *q, *options = NULL;
911 int l;
912 const struct earlycon_id **p_match;
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
927 q = strchrnul(p, ':');
928 if (*q != '\0')
929 options = q + 1;
930 l = q - p;
931
932 /* Get the node specified by stdout-path */
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 }
938
939 for (p_match = __earlycon_table; p_match < __earlycon_table_end;
940 p_match++) {
941 const struct earlycon_id *match = *p_match;
942
943 if (!match->compatible[0])
944 continue;
945
946 if (fdt_node_check_compatible(fdt, offset, match->compatible))
947 continue;
948
949 of_setup_earlycon(match, offset, options);
950 return 0;
951 }
952 return -ENODEV;
953}
954#endif
955
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{
962 const __be32 *prop;
963
964 if (depth != 0)
965 return 0;
966
967 dt_root_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
968 dt_root_addr_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
969
970 prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
971 if (prop)
972 dt_root_size_cells = be32_to_cpup(prop);
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);
976 if (prop)
977 dt_root_addr_cells = be32_to_cpup(prop);
978 pr_debug("dt_root_addr_cells = %x\n", dt_root_addr_cells);
979
980 /* break now */
981 return 1;
982}
983
984u64 __init dt_mem_next_cell(int s, const __be32 **cellp)
985{
986 const __be32 *p = *cellp;
987
988 *cellp = p + s;
989 return of_read_number(p, s);
990}
991
992/**
993 * early_init_dt_scan_memory - Look for and parse memory nodes
994 */
995int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
996 int depth, void *data)
997{
998 const char *type = of_get_flat_dt_prop(node, "device_type", NULL);
999 const __be32 *reg, *endp;
1000 int l;
1001 bool hotpluggable;
1002
1003 /* We are scanning "memory" nodes only */
1004 if (type == NULL || strcmp(type, "memory") != 0)
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));
1014 hotpluggable = of_get_flat_dt_prop(node, "hotpluggable", NULL);
1015
1016 pr_debug("memory scan node %s, reg size %d,\n", uname, l);
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);
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);
1037 }
1038
1039 return 0;
1040}
1041
1042/*
1043 * Convert configs to something easy to use in C code
1044 */
1045#if defined(CONFIG_CMDLINE_FORCE)
1046static const int overwrite_incoming_cmdline = 1;
1047static const int read_dt_cmdline;
1048static const int concat_cmdline;
1049#elif defined(CONFIG_CMDLINE_EXTEND)
1050static const int overwrite_incoming_cmdline;
1051static const int read_dt_cmdline = 1;
1052static const int concat_cmdline = 1;
1053#else /* CMDLINE_FROM_BOOTLOADER */
1054static const int overwrite_incoming_cmdline;
1055static const int read_dt_cmdline = 1;
1056static const int concat_cmdline;
1057#endif
1058
1059#ifdef CONFIG_CMDLINE
1060static const char *config_cmdline = CONFIG_CMDLINE;
1061#else
1062static const char *config_cmdline = "";
1063#endif
1064
1065int __init early_init_dt_scan_chosen(unsigned long node, const char *uname,
1066 int depth, void *data)
1067{
1068 int l = 0;
1069 const char *p = NULL;
1070 const void *rng_seed;
1071 char *cmdline = data;
1072
1073 pr_debug("search \"chosen\", depth: %d, uname: %s\n", depth, uname);
1074
1075 if (depth != 1 || !cmdline ||
1076 (strcmp(uname, "chosen") != 0 && strcmp(uname, "chosen@0") != 0))
1077 return 0;
1078
1079 early_init_dt_check_for_initrd(node);
1080
1081 /* Put CONFIG_CMDLINE in if forced or if data had nothing in it to start */
1082 if (overwrite_incoming_cmdline || !cmdline[0])
1083 strlcpy(cmdline, config_cmdline, COMMAND_LINE_SIZE);
1084
1085 /* Retrieve command line unless forcing */
1086 if (read_dt_cmdline)
1087 p = of_get_flat_dt_prop(node, "bootargs", &l);
1088
1089 if (p != NULL && l > 0) {
1090 if (concat_cmdline) {
1091 int cmdline_len;
1092 int copy_len;
1093 strlcat(cmdline, " ", COMMAND_LINE_SIZE);
1094 cmdline_len = strlen(cmdline);
1095 copy_len = COMMAND_LINE_SIZE - cmdline_len - 1;
1096 copy_len = min((int)l, copy_len);
1097 strncpy(cmdline + cmdline_len, p, copy_len);
1098 cmdline[cmdline_len + copy_len] = '\0';
1099 } else {
1100 strlcpy(cmdline, p, min(l, COMMAND_LINE_SIZE));
1101 }
1102 }
1103
1104 pr_debug("Command line is: %s\n", (char*)data);
1105
1106 rng_seed = of_get_flat_dt_prop(node, "rng-seed", &l);
1107 if (rng_seed && l > 0) {
1108 add_bootloader_randomness(rng_seed, l);
1109
1110 /* try to clear seed so it won't be found. */
1111 fdt_nop_property(initial_boot_params, node, "rng-seed");
1112
1113 /* update CRC check value */
1114 of_fdt_crc32 = crc32_be(~0, initial_boot_params,
1115 fdt_totalsize(initial_boot_params));
1116 }
1117
1118 /* break now */
1119 return 1;
1120}
1121
1122#ifndef MIN_MEMBLOCK_ADDR
1123#define MIN_MEMBLOCK_ADDR __pa(PAGE_OFFSET)
1124#endif
1125#ifndef MAX_MEMBLOCK_ADDR
1126#define MAX_MEMBLOCK_ADDR ((phys_addr_t)~0)
1127#endif
1128
1129void __init __weak early_init_dt_add_memory_arch(u64 base, u64 size)
1130{
1131 const u64 phys_offset = MIN_MEMBLOCK_ADDR;
1132
1133 if (size < PAGE_SIZE - (base & ~PAGE_MASK)) {
1134 pr_warn("Ignoring memory block 0x%llx - 0x%llx\n",
1135 base, base + size);
1136 return;
1137 }
1138
1139 if (!PAGE_ALIGNED(base)) {
1140 size -= PAGE_SIZE - (base & ~PAGE_MASK);
1141 base = PAGE_ALIGN(base);
1142 }
1143 size &= PAGE_MASK;
1144
1145 if (base > MAX_MEMBLOCK_ADDR) {
1146 pr_warning("Ignoring memory block 0x%llx - 0x%llx\n",
1147 base, base + size);
1148 return;
1149 }
1150
1151 if (base + size - 1 > MAX_MEMBLOCK_ADDR) {
1152 pr_warning("Ignoring memory range 0x%llx - 0x%llx\n",
1153 ((u64)MAX_MEMBLOCK_ADDR) + 1, base + size);
1154 size = MAX_MEMBLOCK_ADDR - base + 1;
1155 }
1156
1157 if (base + size < phys_offset) {
1158 pr_warning("Ignoring memory block 0x%llx - 0x%llx\n",
1159 base, base + size);
1160 return;
1161 }
1162 if (base < phys_offset) {
1163 pr_warning("Ignoring memory range 0x%llx - 0x%llx\n",
1164 base, phys_offset);
1165 size -= phys_offset - base;
1166 base = phys_offset;
1167 }
1168 memblock_add(base, size);
1169}
1170
1171int __init __weak early_init_dt_mark_hotplug_memory_arch(u64 base, u64 size)
1172{
1173 return memblock_mark_hotplug(base, size);
1174}
1175
1176int __init __weak early_init_dt_reserve_memory_arch(phys_addr_t base,
1177 phys_addr_t size, bool nomap)
1178{
1179 if (nomap)
1180 return memblock_remove(base, size);
1181 return memblock_reserve(base, size);
1182}
1183
1184static void * __init early_init_dt_alloc_memory_arch(u64 size, u64 align)
1185{
1186 void *ptr = memblock_alloc(size, align);
1187
1188 if (!ptr)
1189 panic("%s: Failed to allocate %llu bytes align=0x%llx\n",
1190 __func__, size, align);
1191
1192 return ptr;
1193}
1194
1195bool __init early_init_dt_verify(void *params)
1196{
1197 if (!params)
1198 return false;
1199
1200 /* check device tree validity */
1201 if (fdt_check_header(params))
1202 return false;
1203
1204 /* Setup flat device-tree pointer */
1205 initial_boot_params = params;
1206 of_fdt_crc32 = crc32_be(~0, initial_boot_params,
1207 fdt_totalsize(initial_boot_params));
1208 return true;
1209}
1210
1211
1212void __init early_init_dt_scan_nodes(void)
1213{
1214 int rc = 0;
1215
1216 /* Retrieve various information from the /chosen node */
1217 rc = of_scan_flat_dt(early_init_dt_scan_chosen, boot_command_line);
1218 if (!rc)
1219 pr_warn("No chosen node found, continuing without\n");
1220
1221 /* Initialize {size,address}-cells info */
1222 of_scan_flat_dt(early_init_dt_scan_root, NULL);
1223
1224 /* Setup memory, calling early_init_dt_add_memory_arch */
1225 of_scan_flat_dt(early_init_dt_scan_memory, NULL);
1226}
1227
1228bool __init early_init_dt_scan(void *params)
1229{
1230 bool status;
1231
1232 status = early_init_dt_verify(params);
1233 if (!status)
1234 return false;
1235
1236 early_init_dt_scan_nodes();
1237 return true;
1238}
1239
1240/**
1241 * unflatten_device_tree - create tree of device_nodes from flat blob
1242 *
1243 * unflattens the device-tree passed by the firmware, creating the
1244 * tree of struct device_node. It also fills the "name" and "type"
1245 * pointers of the nodes so the normal device-tree walking functions
1246 * can be used.
1247 */
1248void __init unflatten_device_tree(void)
1249{
1250 __unflatten_device_tree(initial_boot_params, NULL, &of_root,
1251 early_init_dt_alloc_memory_arch, false);
1252
1253 /* Get pointer to "/chosen" and "/aliases" nodes for use everywhere */
1254 of_alias_scan(early_init_dt_alloc_memory_arch);
1255
1256 unittest_unflatten_overlay_base();
1257}
1258
1259/**
1260 * unflatten_and_copy_device_tree - copy and create tree of device_nodes from flat blob
1261 *
1262 * Copies and unflattens the device-tree passed by the firmware, creating the
1263 * tree of struct device_node. It also fills the "name" and "type"
1264 * pointers of the nodes so the normal device-tree walking functions
1265 * can be used. This should only be used when the FDT memory has not been
1266 * reserved such is the case when the FDT is built-in to the kernel init
1267 * section. If the FDT memory is reserved already then unflatten_device_tree
1268 * should be used instead.
1269 */
1270void __init unflatten_and_copy_device_tree(void)
1271{
1272 int size;
1273 void *dt;
1274
1275 if (!initial_boot_params) {
1276 pr_warn("No valid device tree found, continuing without\n");
1277 return;
1278 }
1279
1280 size = fdt_totalsize(initial_boot_params);
1281 dt = early_init_dt_alloc_memory_arch(size,
1282 roundup_pow_of_two(FDT_V17_SIZE));
1283
1284 if (dt) {
1285 memcpy(dt, initial_boot_params, size);
1286 initial_boot_params = dt;
1287 }
1288 unflatten_device_tree();
1289}
1290
1291#ifdef CONFIG_SYSFS
1292static ssize_t of_fdt_raw_read(struct file *filp, struct kobject *kobj,
1293 struct bin_attribute *bin_attr,
1294 char *buf, loff_t off, size_t count)
1295{
1296 memcpy(buf, initial_boot_params + off, count);
1297 return count;
1298}
1299
1300static int __init of_fdt_raw_init(void)
1301{
1302 static struct bin_attribute of_fdt_raw_attr =
1303 __BIN_ATTR(fdt, S_IRUSR, of_fdt_raw_read, NULL, 0);
1304
1305 if (!initial_boot_params)
1306 return 0;
1307
1308 if (of_fdt_crc32 != crc32_be(~0, initial_boot_params,
1309 fdt_totalsize(initial_boot_params))) {
1310 pr_warn("not creating '/sys/firmware/fdt': CRC check failed\n");
1311 return 0;
1312 }
1313 of_fdt_raw_attr.size = fdt_totalsize(initial_boot_params);
1314 return sysfs_create_bin_file(firmware_kobj, &of_fdt_raw_attr);
1315}
1316late_initcall(of_fdt_raw_init);
1317#endif
1318
1319#endif /* CONFIG_OF_EARLY_FLATTREE */