of: Fix the section mismatch warnings.
[firefly-linux-kernel-4.4.55.git] / 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/kernel.h>
13 #include <linux/initrd.h>
14 #include <linux/module.h>
15 #include <linux/of.h>
16 #include <linux/of_fdt.h>
17 #include <linux/of_reserved_mem.h>
18 #include <linux/sizes.h>
19 #include <linux/string.h>
20 #include <linux/errno.h>
21 #include <linux/slab.h>
22 #include <linux/memblock.h>
23
24 #include <asm/setup.h>  /* for COMMAND_LINE_SIZE */
25 #ifdef CONFIG_PPC
26 #include <asm/machdep.h>
27 #endif /* CONFIG_PPC */
28
29 #include <asm/page.h>
30
31 char *of_fdt_get_string(struct boot_param_header *blob, u32 offset)
32 {
33         return ((char *)blob) +
34                 be32_to_cpu(blob->off_dt_strings) + offset;
35 }
36
37 /**
38  * of_fdt_get_property - Given a node in the given flat blob, return
39  * the property ptr
40  */
41 void *of_fdt_get_property(struct boot_param_header *blob,
42                        unsigned long node, const char *name,
43                        unsigned long *size)
44 {
45         unsigned long p = node;
46
47         do {
48                 u32 tag = be32_to_cpup((__be32 *)p);
49                 u32 sz, noff;
50                 const char *nstr;
51
52                 p += 4;
53                 if (tag == OF_DT_NOP)
54                         continue;
55                 if (tag != OF_DT_PROP)
56                         return NULL;
57
58                 sz = be32_to_cpup((__be32 *)p);
59                 noff = be32_to_cpup((__be32 *)(p + 4));
60                 p += 8;
61                 if (be32_to_cpu(blob->version) < 0x10)
62                         p = ALIGN(p, sz >= 8 ? 8 : 4);
63
64                 nstr = of_fdt_get_string(blob, noff);
65                 if (nstr == NULL) {
66                         pr_warning("Can't find property index name !\n");
67                         return NULL;
68                 }
69                 if (strcmp(name, nstr) == 0) {
70                         if (size)
71                                 *size = sz;
72                         return (void *)p;
73                 }
74                 p += sz;
75                 p = ALIGN(p, 4);
76         } while (1);
77 }
78
79 /**
80  * of_fdt_is_compatible - Return true if given node from the given blob has
81  * compat in its compatible list
82  * @blob: A device tree blob
83  * @node: node to test
84  * @compat: compatible string to compare with compatible list.
85  *
86  * On match, returns a non-zero value with smaller values returned for more
87  * specific compatible values.
88  */
89 int of_fdt_is_compatible(struct boot_param_header *blob,
90                       unsigned long node, const char *compat)
91 {
92         const char *cp;
93         unsigned long cplen, l, score = 0;
94
95         cp = of_fdt_get_property(blob, node, "compatible", &cplen);
96         if (cp == NULL)
97                 return 0;
98         while (cplen > 0) {
99                 score++;
100                 if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
101                         return score;
102                 l = strlen(cp) + 1;
103                 cp += l;
104                 cplen -= l;
105         }
106
107         return 0;
108 }
109
110 /**
111  * of_fdt_match - Return true if node matches a list of compatible values
112  */
113 int of_fdt_match(struct boot_param_header *blob, unsigned long node,
114                  const char *const *compat)
115 {
116         unsigned int tmp, score = 0;
117
118         if (!compat)
119                 return 0;
120
121         while (*compat) {
122                 tmp = of_fdt_is_compatible(blob, node, *compat);
123                 if (tmp && (score == 0 || (tmp < score)))
124                         score = tmp;
125                 compat++;
126         }
127
128         return score;
129 }
130
131 static void *unflatten_dt_alloc(unsigned long *mem, unsigned long size,
132                                        unsigned long align)
133 {
134         void *res;
135
136         *mem = ALIGN(*mem, align);
137         res = (void *)*mem;
138         *mem += size;
139
140         return res;
141 }
142
143 /**
144  * unflatten_dt_node - Alloc and populate a device_node from the flat tree
145  * @blob: The parent device tree blob
146  * @mem: Memory chunk to use for allocating device nodes and properties
147  * @p: pointer to node in flat tree
148  * @dad: Parent struct device_node
149  * @allnextpp: pointer to ->allnext from last allocated device_node
150  * @fpsize: Size of the node path up at the current depth.
151  */
152 static unsigned long unflatten_dt_node(struct boot_param_header *blob,
153                                 unsigned long mem,
154                                 unsigned long *p,
155                                 struct device_node *dad,
156                                 struct device_node ***allnextpp,
157                                 unsigned long fpsize)
158 {
159         struct device_node *np;
160         struct property *pp, **prev_pp = NULL;
161         char *pathp;
162         u32 tag;
163         unsigned int l, allocl;
164         int has_name = 0;
165         int new_format = 0;
166
167         tag = be32_to_cpup((__be32 *)(*p));
168         if (tag != OF_DT_BEGIN_NODE) {
169                 pr_err("Weird tag at start of node: %x\n", tag);
170                 return mem;
171         }
172         *p += 4;
173         pathp = (char *)*p;
174         l = allocl = strlen(pathp) + 1;
175         *p = ALIGN(*p + l, 4);
176
177         /* version 0x10 has a more compact unit name here instead of the full
178          * path. we accumulate the full path size using "fpsize", we'll rebuild
179          * it later. We detect this because the first character of the name is
180          * not '/'.
181          */
182         if ((*pathp) != '/') {
183                 new_format = 1;
184                 if (fpsize == 0) {
185                         /* root node: special case. fpsize accounts for path
186                          * plus terminating zero. root node only has '/', so
187                          * fpsize should be 2, but we want to avoid the first
188                          * level nodes to have two '/' so we use fpsize 1 here
189                          */
190                         fpsize = 1;
191                         allocl = 2;
192                         l = 1;
193                         *pathp = '\0';
194                 } else {
195                         /* account for '/' and path size minus terminal 0
196                          * already in 'l'
197                          */
198                         fpsize += l;
199                         allocl = fpsize;
200                 }
201         }
202
203         np = unflatten_dt_alloc(&mem, sizeof(struct device_node) + allocl,
204                                 __alignof__(struct device_node));
205         if (allnextpp) {
206                 char *fn;
207                 memset(np, 0, sizeof(*np));
208                 np->full_name = fn = ((char *)np) + sizeof(*np);
209                 if (new_format) {
210                         /* rebuild full path for new format */
211                         if (dad && dad->parent) {
212                                 strcpy(fn, dad->full_name);
213 #ifdef DEBUG
214                                 if ((strlen(fn) + l + 1) != allocl) {
215                                         pr_debug("%s: p: %d, l: %d, a: %d\n",
216                                                 pathp, (int)strlen(fn),
217                                                 l, allocl);
218                                 }
219 #endif
220                                 fn += strlen(fn);
221                         }
222                         *(fn++) = '/';
223                 }
224                 memcpy(fn, pathp, l);
225
226                 prev_pp = &np->properties;
227                 **allnextpp = np;
228                 *allnextpp = &np->allnext;
229                 if (dad != NULL) {
230                         np->parent = dad;
231                         /* we temporarily use the next field as `last_child'*/
232                         if (dad->next == NULL)
233                                 dad->child = np;
234                         else
235                                 dad->next->sibling = np;
236                         dad->next = np;
237                 }
238                 kref_init(&np->kref);
239         }
240         /* process properties */
241         while (1) {
242                 u32 sz, noff;
243                 char *pname;
244
245                 tag = be32_to_cpup((__be32 *)(*p));
246                 if (tag == OF_DT_NOP) {
247                         *p += 4;
248                         continue;
249                 }
250                 if (tag != OF_DT_PROP)
251                         break;
252                 *p += 4;
253                 sz = be32_to_cpup((__be32 *)(*p));
254                 noff = be32_to_cpup((__be32 *)((*p) + 4));
255                 *p += 8;
256                 if (be32_to_cpu(blob->version) < 0x10)
257                         *p = ALIGN(*p, sz >= 8 ? 8 : 4);
258
259                 pname = of_fdt_get_string(blob, noff);
260                 if (pname == NULL) {
261                         pr_info("Can't find property name in list !\n");
262                         break;
263                 }
264                 if (strcmp(pname, "name") == 0)
265                         has_name = 1;
266                 l = strlen(pname) + 1;
267                 pp = unflatten_dt_alloc(&mem, sizeof(struct property),
268                                         __alignof__(struct property));
269                 if (allnextpp) {
270                         /* We accept flattened tree phandles either in
271                          * ePAPR-style "phandle" properties, or the
272                          * legacy "linux,phandle" properties.  If both
273                          * appear and have different values, things
274                          * will get weird.  Don't do that. */
275                         if ((strcmp(pname, "phandle") == 0) ||
276                             (strcmp(pname, "linux,phandle") == 0)) {
277                                 if (np->phandle == 0)
278                                         np->phandle = be32_to_cpup((__be32*)*p);
279                         }
280                         /* And we process the "ibm,phandle" property
281                          * used in pSeries dynamic device tree
282                          * stuff */
283                         if (strcmp(pname, "ibm,phandle") == 0)
284                                 np->phandle = be32_to_cpup((__be32 *)*p);
285                         pp->name = pname;
286                         pp->length = sz;
287                         pp->value = (void *)*p;
288                         *prev_pp = pp;
289                         prev_pp = &pp->next;
290                 }
291                 *p = ALIGN((*p) + sz, 4);
292         }
293         /* with version 0x10 we may not have the name property, recreate
294          * it here from the unit name if absent
295          */
296         if (!has_name) {
297                 char *p1 = pathp, *ps = pathp, *pa = NULL;
298                 int sz;
299
300                 while (*p1) {
301                         if ((*p1) == '@')
302                                 pa = p1;
303                         if ((*p1) == '/')
304                                 ps = p1 + 1;
305                         p1++;
306                 }
307                 if (pa < ps)
308                         pa = p1;
309                 sz = (pa - ps) + 1;
310                 pp = unflatten_dt_alloc(&mem, sizeof(struct property) + sz,
311                                         __alignof__(struct property));
312                 if (allnextpp) {
313                         pp->name = "name";
314                         pp->length = sz;
315                         pp->value = pp + 1;
316                         *prev_pp = pp;
317                         prev_pp = &pp->next;
318                         memcpy(pp->value, ps, sz - 1);
319                         ((char *)pp->value)[sz - 1] = 0;
320                         pr_debug("fixed up name for %s -> %s\n", pathp,
321                                 (char *)pp->value);
322                 }
323         }
324         if (allnextpp) {
325                 *prev_pp = NULL;
326                 np->name = of_get_property(np, "name", NULL);
327                 np->type = of_get_property(np, "device_type", NULL);
328
329                 if (!np->name)
330                         np->name = "<NULL>";
331                 if (!np->type)
332                         np->type = "<NULL>";
333         }
334         while (tag == OF_DT_BEGIN_NODE || tag == OF_DT_NOP) {
335                 if (tag == OF_DT_NOP)
336                         *p += 4;
337                 else
338                         mem = unflatten_dt_node(blob, mem, p, np, allnextpp,
339                                                 fpsize);
340                 tag = be32_to_cpup((__be32 *)(*p));
341         }
342         if (tag != OF_DT_END_NODE) {
343                 pr_err("Weird tag at end of node: %x\n", tag);
344                 return mem;
345         }
346         *p += 4;
347         return mem;
348 }
349
350 /**
351  * __unflatten_device_tree - create tree of device_nodes from flat blob
352  *
353  * unflattens a device-tree, creating the
354  * tree of struct device_node. It also fills the "name" and "type"
355  * pointers of the nodes so the normal device-tree walking functions
356  * can be used.
357  * @blob: The blob to expand
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
361  */
362 static void __unflatten_device_tree(struct boot_param_header *blob,
363                              struct device_node **mynodes,
364                              void * (*dt_alloc)(u64 size, u64 align))
365 {
366         unsigned long start, mem, size;
367         struct device_node **allnextp = mynodes;
368
369         pr_debug(" -> unflatten_device_tree()\n");
370
371         if (!blob) {
372                 pr_debug("No device tree pointer\n");
373                 return;
374         }
375
376         pr_debug("Unflattening device tree:\n");
377         pr_debug("magic: %08x\n", be32_to_cpu(blob->magic));
378         pr_debug("size: %08x\n", be32_to_cpu(blob->totalsize));
379         pr_debug("version: %08x\n", be32_to_cpu(blob->version));
380
381         if (be32_to_cpu(blob->magic) != OF_DT_HEADER) {
382                 pr_err("Invalid device tree blob header\n");
383                 return;
384         }
385
386         /* First pass, scan for size */
387         start = ((unsigned long)blob) +
388                 be32_to_cpu(blob->off_dt_struct);
389         size = unflatten_dt_node(blob, 0, &start, NULL, NULL, 0);
390         size = (size | 3) + 1;
391
392         pr_debug("  size is %lx, allocating...\n", size);
393
394         /* Allocate memory for the expanded device tree */
395         mem = (unsigned long)
396                 dt_alloc(size + 4, __alignof__(struct device_node));
397
398         ((__be32 *)mem)[size / 4] = cpu_to_be32(0xdeadbeef);
399
400         pr_debug("  unflattening %lx...\n", mem);
401
402         /* Second pass, do actual unflattening */
403         start = ((unsigned long)blob) +
404                 be32_to_cpu(blob->off_dt_struct);
405         unflatten_dt_node(blob, mem, &start, NULL, &allnextp, 0);
406         if (be32_to_cpup((__be32 *)start) != OF_DT_END)
407                 pr_warning("Weird tag at end of tree: %08x\n", *((u32 *)start));
408         if (be32_to_cpu(((__be32 *)mem)[size / 4]) != 0xdeadbeef)
409                 pr_warning("End of tree marker overwritten: %08x\n",
410                            be32_to_cpu(((__be32 *)mem)[size / 4]));
411         *allnextp = NULL;
412
413         pr_debug(" <- unflatten_device_tree()\n");
414 }
415
416 static void *kernel_tree_alloc(u64 size, u64 align)
417 {
418         return kzalloc(size, GFP_KERNEL);
419 }
420
421 /**
422  * of_fdt_unflatten_tree - create tree of device_nodes from flat blob
423  *
424  * unflattens the device-tree passed by the firmware, creating the
425  * tree of struct device_node. It also fills the "name" and "type"
426  * pointers of the nodes so the normal device-tree walking functions
427  * can be used.
428  */
429 void of_fdt_unflatten_tree(unsigned long *blob,
430                         struct device_node **mynodes)
431 {
432         struct boot_param_header *device_tree =
433                 (struct boot_param_header *)blob;
434         __unflatten_device_tree(device_tree, mynodes, &kernel_tree_alloc);
435 }
436 EXPORT_SYMBOL_GPL(of_fdt_unflatten_tree);
437
438 /* Everything below here references initial_boot_params directly. */
439 int __initdata dt_root_addr_cells;
440 int __initdata dt_root_size_cells;
441
442 struct boot_param_header *initial_boot_params;
443
444 #ifdef CONFIG_OF_EARLY_FLATTREE
445
446 /**
447  * res_mem_reserve_reg() - reserve all memory described in 'reg' property
448  */
449 static int __init __reserved_mem_reserve_reg(unsigned long node,
450                                              const char *uname)
451 {
452         int t_len = (dt_root_addr_cells + dt_root_size_cells) * sizeof(__be32);
453         phys_addr_t base, size;
454         unsigned long len;
455         __be32 *prop;
456         int nomap, first = 1;
457
458         prop = of_get_flat_dt_prop(node, "reg", &len);
459         if (!prop)
460                 return -ENOENT;
461
462         if (len && len % t_len != 0) {
463                 pr_err("Reserved memory: invalid reg property in '%s', skipping node.\n",
464                        uname);
465                 return -EINVAL;
466         }
467
468         nomap = of_get_flat_dt_prop(node, "no-map", NULL) != NULL;
469
470         while (len >= t_len) {
471                 base = dt_mem_next_cell(dt_root_addr_cells, &prop);
472                 size = dt_mem_next_cell(dt_root_size_cells, &prop);
473
474                 if (base && size &&
475                     early_init_dt_reserve_memory_arch(base, size, nomap) == 0)
476                         pr_debug("Reserved memory: reserved region for node '%s': base %pa, size %ld MiB\n",
477                                 uname, &base, (unsigned long)size / SZ_1M);
478                 else
479                         pr_info("Reserved memory: failed to reserve memory for node '%s': base %pa, size %ld MiB\n",
480                                 uname, &base, (unsigned long)size / SZ_1M);
481
482                 len -= t_len;
483                 if (first) {
484                         fdt_reserved_mem_save_node(node, uname, base, size);
485                         first = 0;
486                 }
487         }
488         return 0;
489 }
490
491 /**
492  * __reserved_mem_check_root() - check if #size-cells, #address-cells provided
493  * in /reserved-memory matches the values supported by the current implementation,
494  * also check if ranges property has been provided
495  */
496 static int __init __reserved_mem_check_root(unsigned long node)
497 {
498         __be32 *prop;
499
500         prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
501         if (!prop || be32_to_cpup(prop) != dt_root_size_cells)
502                 return -EINVAL;
503
504         prop = of_get_flat_dt_prop(node, "#address-cells", NULL);
505         if (!prop || be32_to_cpup(prop) != dt_root_addr_cells)
506                 return -EINVAL;
507
508         prop = of_get_flat_dt_prop(node, "ranges", NULL);
509         if (!prop)
510                 return -EINVAL;
511         return 0;
512 }
513
514 /**
515  * fdt_scan_reserved_mem() - scan a single FDT node for reserved memory
516  */
517 static int __init __fdt_scan_reserved_mem(unsigned long node, const char *uname,
518                                           int depth, void *data)
519 {
520         static int found;
521         const char *status;
522         int err;
523
524         if (!found && depth == 1 && strcmp(uname, "reserved-memory") == 0) {
525                 if (__reserved_mem_check_root(node) != 0) {
526                         pr_err("Reserved memory: unsupported node format, ignoring\n");
527                         /* break scan */
528                         return 1;
529                 }
530                 found = 1;
531                 /* scan next node */
532                 return 0;
533         } else if (!found) {
534                 /* scan next node */
535                 return 0;
536         } else if (found && depth < 2) {
537                 /* scanning of /reserved-memory has been finished */
538                 return 1;
539         }
540
541         status = of_get_flat_dt_prop(node, "status", NULL);
542         if (status && strcmp(status, "okay") != 0 && strcmp(status, "ok") != 0)
543                 return 0;
544
545         err = __reserved_mem_reserve_reg(node, uname);
546         if (err == -ENOENT && of_get_flat_dt_prop(node, "size", NULL))
547                 fdt_reserved_mem_save_node(node, uname, 0, 0);
548
549         /* scan next node */
550         return 0;
551 }
552
553 /**
554  * early_init_fdt_scan_reserved_mem() - create reserved memory regions
555  *
556  * This function grabs memory from early allocator for device exclusive use
557  * defined in device tree structures. It should be called by arch specific code
558  * once the early allocator (i.e. memblock) has been fully activated.
559  */
560 void __init early_init_fdt_scan_reserved_mem(void)
561 {
562         if (!initial_boot_params)
563                 return;
564
565         of_scan_flat_dt(__fdt_scan_reserved_mem, NULL);
566         fdt_init_reserved_mem();
567 }
568
569 /**
570  * of_scan_flat_dt - scan flattened tree blob and call callback on each.
571  * @it: callback function
572  * @data: context data pointer
573  *
574  * This function is used to scan the flattened device-tree, it is
575  * used to extract the memory information at boot before we can
576  * unflatten the tree
577  */
578 int __init of_scan_flat_dt(int (*it)(unsigned long node,
579                                      const char *uname, int depth,
580                                      void *data),
581                            void *data)
582 {
583         unsigned long p = ((unsigned long)initial_boot_params) +
584                 be32_to_cpu(initial_boot_params->off_dt_struct);
585         int rc = 0;
586         int depth = -1;
587
588         do {
589                 u32 tag = be32_to_cpup((__be32 *)p);
590                 const char *pathp;
591
592                 p += 4;
593                 if (tag == OF_DT_END_NODE) {
594                         depth--;
595                         continue;
596                 }
597                 if (tag == OF_DT_NOP)
598                         continue;
599                 if (tag == OF_DT_END)
600                         break;
601                 if (tag == OF_DT_PROP) {
602                         u32 sz = be32_to_cpup((__be32 *)p);
603                         p += 8;
604                         if (be32_to_cpu(initial_boot_params->version) < 0x10)
605                                 p = ALIGN(p, sz >= 8 ? 8 : 4);
606                         p += sz;
607                         p = ALIGN(p, 4);
608                         continue;
609                 }
610                 if (tag != OF_DT_BEGIN_NODE) {
611                         pr_err("Invalid tag %x in flat device tree!\n", tag);
612                         return -EINVAL;
613                 }
614                 depth++;
615                 pathp = (char *)p;
616                 p = ALIGN(p + strlen(pathp) + 1, 4);
617                 if (*pathp == '/')
618                         pathp = kbasename(pathp);
619                 rc = it(p, pathp, depth, data);
620                 if (rc != 0)
621                         break;
622         } while (1);
623
624         return rc;
625 }
626
627 /**
628  * of_get_flat_dt_root - find the root node in the flat blob
629  */
630 unsigned long __init of_get_flat_dt_root(void)
631 {
632         unsigned long p = ((unsigned long)initial_boot_params) +
633                 be32_to_cpu(initial_boot_params->off_dt_struct);
634
635         while (be32_to_cpup((__be32 *)p) == OF_DT_NOP)
636                 p += 4;
637         BUG_ON(be32_to_cpup((__be32 *)p) != OF_DT_BEGIN_NODE);
638         p += 4;
639         return ALIGN(p + strlen((char *)p) + 1, 4);
640 }
641
642 /**
643  * of_get_flat_dt_prop - Given a node in the flat blob, return the property ptr
644  *
645  * This function can be used within scan_flattened_dt callback to get
646  * access to properties
647  */
648 void *__init of_get_flat_dt_prop(unsigned long node, const char *name,
649                                  unsigned long *size)
650 {
651         return of_fdt_get_property(initial_boot_params, node, name, size);
652 }
653
654 /**
655  * of_flat_dt_is_compatible - Return true if given node has compat in compatible list
656  * @node: node to test
657  * @compat: compatible string to compare with compatible list.
658  */
659 int __init of_flat_dt_is_compatible(unsigned long node, const char *compat)
660 {
661         return of_fdt_is_compatible(initial_boot_params, node, compat);
662 }
663
664 /**
665  * of_flat_dt_match - Return true if node matches a list of compatible values
666  */
667 int __init of_flat_dt_match(unsigned long node, const char *const *compat)
668 {
669         return of_fdt_match(initial_boot_params, node, compat);
670 }
671
672 struct fdt_scan_status {
673         const char *name;
674         int namelen;
675         int depth;
676         int found;
677         int (*iterator)(unsigned long node, const char *uname, int depth, void *data);
678         void *data;
679 };
680
681 /**
682  * fdt_scan_node_by_path - iterator for of_scan_flat_dt_by_path function
683  */
684 static int __init fdt_scan_node_by_path(unsigned long node, const char *uname,
685                                         int depth, void *data)
686 {
687         struct fdt_scan_status *st = data;
688
689         /*
690          * if scan at the requested fdt node has been completed,
691          * return -ENXIO to abort further scanning
692          */
693         if (depth <= st->depth)
694                 return -ENXIO;
695
696         /* requested fdt node has been found, so call iterator function */
697         if (st->found)
698                 return st->iterator(node, uname, depth, st->data);
699
700         /* check if scanning automata is entering next level of fdt nodes */
701         if (depth == st->depth + 1 &&
702             strncmp(st->name, uname, st->namelen) == 0 &&
703             uname[st->namelen] == 0) {
704                 st->depth += 1;
705                 if (st->name[st->namelen] == 0) {
706                         st->found = 1;
707                 } else {
708                         const char *next = st->name + st->namelen + 1;
709                         st->name = next;
710                         st->namelen = strcspn(next, "/");
711                 }
712                 return 0;
713         }
714
715         /* scan next fdt node */
716         return 0;
717 }
718
719 /**
720  * of_scan_flat_dt_by_path - scan flattened tree blob and call callback on each
721  *                           child of the given path.
722  * @path: path to start searching for children
723  * @it: callback function
724  * @data: context data pointer
725  *
726  * This function is used to scan the flattened device-tree starting from the
727  * node given by path. It is used to extract information (like reserved
728  * memory), which is required on ealy boot before we can unflatten the tree.
729  */
730 int __init of_scan_flat_dt_by_path(const char *path,
731         int (*it)(unsigned long node, const char *name, int depth, void *data),
732         void *data)
733 {
734         struct fdt_scan_status st = {path, 0, -1, 0, it, data};
735         int ret = 0;
736
737         if (initial_boot_params)
738                 ret = of_scan_flat_dt(fdt_scan_node_by_path, &st);
739
740         if (!st.found)
741                 return -ENOENT;
742         else if (ret == -ENXIO) /* scan has been completed */
743                 return 0;
744         else
745                 return ret;
746 }
747
748 #ifdef CONFIG_BLK_DEV_INITRD
749 /**
750  * early_init_dt_check_for_initrd - Decode initrd location from flat tree
751  * @node: reference to node containing initrd location ('chosen')
752  */
753 void __init early_init_dt_check_for_initrd(unsigned long node)
754 {
755         u64 start, end;
756         unsigned long len;
757         __be32 *prop;
758
759         pr_debug("Looking for initrd properties... ");
760
761         prop = of_get_flat_dt_prop(node, "linux,initrd-start", &len);
762         if (!prop)
763                 return;
764         start = of_read_number(prop, len/4);
765
766         prop = of_get_flat_dt_prop(node, "linux,initrd-end", &len);
767         if (!prop)
768                 return;
769         end = of_read_number(prop, len/4);
770
771         early_init_dt_setup_initrd_arch(start, end);
772         pr_debug("initrd_start=0x%llx  initrd_end=0x%llx\n",
773                  (unsigned long long)start, (unsigned long long)end);
774 }
775 #else
776 inline void early_init_dt_check_for_initrd(unsigned long node)
777 {
778 }
779 #endif /* CONFIG_BLK_DEV_INITRD */
780
781 /**
782  * early_init_dt_scan_root - fetch the top level address and size cells
783  */
784 int __init early_init_dt_scan_root(unsigned long node, const char *uname,
785                                    int depth, void *data)
786 {
787         __be32 *prop;
788
789         if (depth != 0)
790                 return 0;
791
792         dt_root_size_cells = OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
793         dt_root_addr_cells = OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
794
795         prop = of_get_flat_dt_prop(node, "#size-cells", NULL);
796         if (prop)
797                 dt_root_size_cells = be32_to_cpup(prop);
798         pr_debug("dt_root_size_cells = %x\n", dt_root_size_cells);
799
800         prop = of_get_flat_dt_prop(node, "#address-cells", NULL);
801         if (prop)
802                 dt_root_addr_cells = be32_to_cpup(prop);
803         pr_debug("dt_root_addr_cells = %x\n", dt_root_addr_cells);
804
805         /* break now */
806         return 1;
807 }
808
809 u64 __init dt_mem_next_cell(int s, __be32 **cellp)
810 {
811         __be32 *p = *cellp;
812
813         *cellp = p + s;
814         return of_read_number(p, s);
815 }
816
817 /**
818  * early_init_dt_scan_memory - Look for an parse memory nodes
819  */
820 int __init early_init_dt_scan_memory(unsigned long node, const char *uname,
821                                      int depth, void *data)
822 {
823         char *type = of_get_flat_dt_prop(node, "device_type", NULL);
824         __be32 *reg, *endp;
825         unsigned long l;
826
827         /* We are scanning "memory" nodes only */
828         if (type == NULL) {
829                 /*
830                  * The longtrail doesn't have a device_type on the
831                  * /memory node, so look for the node called /memory@0.
832                  */
833                 if (depth != 1 || strcmp(uname, "memory@0") != 0)
834                         return 0;
835         } else if (strcmp(type, "memory") != 0)
836                 return 0;
837
838         reg = of_get_flat_dt_prop(node, "linux,usable-memory", &l);
839         if (reg == NULL)
840                 reg = of_get_flat_dt_prop(node, "reg", &l);
841         if (reg == NULL)
842                 return 0;
843
844         endp = reg + (l / sizeof(__be32));
845
846         pr_debug("memory scan node %s, reg size %ld, data: %x %x %x %x,\n",
847             uname, l, reg[0], reg[1], reg[2], reg[3]);
848
849         while ((endp - reg) >= (dt_root_addr_cells + dt_root_size_cells)) {
850                 u64 base, size;
851
852                 base = dt_mem_next_cell(dt_root_addr_cells, &reg);
853                 size = dt_mem_next_cell(dt_root_size_cells, &reg);
854
855                 if (size == 0)
856                         continue;
857                 pr_debug(" - %llx ,  %llx\n", (unsigned long long)base,
858                     (unsigned long long)size);
859
860                 early_init_dt_add_memory_arch(base, size);
861         }
862
863         return 0;
864 }
865
866 int __init early_init_dt_scan_chosen(unsigned long node, const char *uname,
867                                      int depth, void *data)
868 {
869         unsigned long l;
870         char *p;
871
872         pr_debug("search \"chosen\", depth: %d, uname: %s\n", depth, uname);
873
874         if (depth != 1 || !data ||
875             (strcmp(uname, "chosen") != 0 && strcmp(uname, "chosen@0") != 0))
876                 return 0;
877
878         early_init_dt_check_for_initrd(node);
879
880         /* Retrieve command line */
881         p = of_get_flat_dt_prop(node, "bootargs", &l);
882         if (p != NULL && l > 0)
883                 strlcpy(data, p, min((int)l, COMMAND_LINE_SIZE));
884
885         /*
886          * CONFIG_CMDLINE is meant to be a default in case nothing else
887          * managed to set the command line, unless CONFIG_CMDLINE_FORCE
888          * is set in which case we override whatever was found earlier.
889          */
890 #ifdef CONFIG_CMDLINE
891 #ifndef CONFIG_CMDLINE_FORCE
892         if (!((char *)data)[0])
893 #endif
894                 strlcpy(data, CONFIG_CMDLINE, COMMAND_LINE_SIZE);
895 #endif /* CONFIG_CMDLINE */
896
897         pr_debug("Command line is: %s\n", (char*)data);
898
899         /* break now */
900         return 1;
901 }
902
903 #ifdef CONFIG_HAVE_MEMBLOCK
904 void __init __weak early_init_dt_add_memory_arch(u64 base, u64 size)
905 {
906         const u64 phys_offset = __pa(PAGE_OFFSET);
907         base &= PAGE_MASK;
908         size &= PAGE_MASK;
909         if (base + size < phys_offset) {
910                 pr_warning("Ignoring memory block 0x%llx - 0x%llx\n",
911                            base, base + size);
912                 return;
913         }
914         if (base < phys_offset) {
915                 pr_warning("Ignoring memory range 0x%llx - 0x%llx\n",
916                            base, phys_offset);
917                 size -= phys_offset - base;
918                 base = phys_offset;
919         }
920         memblock_add(base, size);
921 }
922
923 int __init __weak early_init_dt_reserve_memory_arch(phys_addr_t base,
924                                         phys_addr_t size, bool nomap)
925 {
926         if (memblock_is_region_reserved(base, size))
927                 return -EBUSY;
928         if (nomap)
929                 return memblock_remove(base, size);
930         return memblock_reserve(base, size);
931 }
932
933 /*
934  * called from unflatten_device_tree() to bootstrap devicetree itself
935  * Architectures can override this definition if memblock isn't used
936  */
937 void * __init __weak early_init_dt_alloc_memory_arch(u64 size, u64 align)
938 {
939         return __va(memblock_alloc(size, align));
940 }
941 #else
942 int __init __weak early_init_dt_reserve_memory_arch(phys_addr_t base,
943                                         phys_addr_t size, bool nomap)
944 {
945         pr_err("Reserved memory not supported, ignoring range 0x%llx - 0x%llx%s\n",
946                   base, size, nomap ? " (nomap)" : "");
947         return -ENOSYS;
948 }
949 #endif
950
951 bool __init early_init_dt_scan(void *params)
952 {
953         if (!params)
954                 return false;
955
956         /* Setup flat device-tree pointer */
957         initial_boot_params = params;
958
959         /* check device tree validity */
960         if (be32_to_cpu(initial_boot_params->magic) != OF_DT_HEADER) {
961                 initial_boot_params = NULL;
962                 return false;
963         }
964
965         /* Retrieve various information from the /chosen node */
966         of_scan_flat_dt(early_init_dt_scan_chosen, boot_command_line);
967
968         /* Initialize {size,address}-cells info */
969         of_scan_flat_dt(early_init_dt_scan_root, NULL);
970
971         /* Setup memory, calling early_init_dt_add_memory_arch */
972         of_scan_flat_dt(early_init_dt_scan_memory, NULL);
973
974         return true;
975 }
976
977 /**
978  * unflatten_device_tree - create tree of device_nodes from flat blob
979  *
980  * unflattens the device-tree passed by the firmware, creating the
981  * tree of struct device_node. It also fills the "name" and "type"
982  * pointers of the nodes so the normal device-tree walking functions
983  * can be used.
984  */
985 void __init unflatten_device_tree(void)
986 {
987         __unflatten_device_tree(initial_boot_params, &of_allnodes,
988                                 early_init_dt_alloc_memory_arch);
989
990         /* Get pointer to "/chosen" and "/aliasas" nodes for use everywhere */
991         of_alias_scan(early_init_dt_alloc_memory_arch);
992 }
993
994 #endif /* CONFIG_OF_EARLY_FLATTREE */