xref: /rk3399_rockchip-uboot/common/fdt_support.c (revision c879435248277e3f357c3d9f45f12cde1b408085)
1 /*
2  * (C) Copyright 2007
3  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com
4  *
5  * Copyright 2010-2011 Freescale Semiconductor, Inc.
6  *
7  * SPDX-License-Identifier:	GPL-2.0+
8  */
9 
10 #include <common.h>
11 #include <android_image.h>
12 #include <exports.h>
13 #include <fdt_support.h>
14 #include <fdtdec.h>
15 #include <inttypes.h>
16 #include <malloc.h>
17 #ifdef CONFIG_MTD_BLK
18 #include <mtd_blk.h>
19 #endif
20 #include <stdio_dev.h>
21 #include <asm/arch/hotkey.h>
22 #include <asm/global_data.h>
23 #include <linux/ctype.h>
24 #include <linux/libfdt.h>
25 #include <linux/types.h>
26 
27 DECLARE_GLOBAL_DATA_PTR;
28 
29 /**
30  * fdt_getprop_u32_default_node - Return a node's property or a default
31  *
32  * @fdt: ptr to device tree
33  * @off: offset of node
34  * @cell: cell offset in property
35  * @prop: property name
36  * @dflt: default value if the property isn't found
37  *
38  * Convenience function to return a node's property or a default value if
39  * the property doesn't exist.
40  */
41 u32 fdt_getprop_u32_default_node(const void *fdt, int off, int cell,
42 				const char *prop, const u32 dflt)
43 {
44 	const fdt32_t *val;
45 	int len;
46 
47 	val = fdt_getprop(fdt, off, prop, &len);
48 
49 	/* Check if property exists */
50 	if (!val)
51 		return dflt;
52 
53 	/* Check if property is long enough */
54 	if (len < ((cell + 1) * sizeof(uint32_t)))
55 		return dflt;
56 
57 	return fdt32_to_cpu(*val);
58 }
59 
60 /**
61  * fdt_getprop_u32_default - Find a node and return it's property or a default
62  *
63  * @fdt: ptr to device tree
64  * @path: path of node
65  * @prop: property name
66  * @dflt: default value if the property isn't found
67  *
68  * Convenience function to find a node and return it's property or a
69  * default value if it doesn't exist.
70  */
71 u32 fdt_getprop_u32_default(const void *fdt, const char *path,
72 				const char *prop, const u32 dflt)
73 {
74 	int off;
75 
76 	off = fdt_path_offset(fdt, path);
77 	if (off < 0)
78 		return dflt;
79 
80 	return fdt_getprop_u32_default_node(fdt, off, 0, prop, dflt);
81 }
82 
83 /**
84  * fdt_find_and_setprop: Find a node and set it's property
85  *
86  * @fdt: ptr to device tree
87  * @node: path of node
88  * @prop: property name
89  * @val: ptr to new value
90  * @len: length of new property value
91  * @create: flag to create the property if it doesn't exist
92  *
93  * Convenience function to directly set a property given the path to the node.
94  */
95 int fdt_find_and_setprop(void *fdt, const char *node, const char *prop,
96 			 const void *val, int len, int create)
97 {
98 	int nodeoff = fdt_path_offset(fdt, node);
99 
100 	if (nodeoff < 0)
101 		return nodeoff;
102 
103 	if ((!create) && (fdt_get_property(fdt, nodeoff, prop, NULL) == NULL))
104 		return 0; /* create flag not set; so exit quietly */
105 
106 	return fdt_setprop(fdt, nodeoff, prop, val, len);
107 }
108 
109 /**
110  * fdt_find_or_add_subnode() - find or possibly add a subnode of a given node
111  *
112  * @fdt: pointer to the device tree blob
113  * @parentoffset: structure block offset of a node
114  * @name: name of the subnode to locate
115  *
116  * fdt_subnode_offset() finds a subnode of the node with a given name.
117  * If the subnode does not exist, it will be created.
118  */
119 int fdt_find_or_add_subnode(void *fdt, int parentoffset, const char *name)
120 {
121 	int offset;
122 
123 	offset = fdt_subnode_offset(fdt, parentoffset, name);
124 
125 	if (offset == -FDT_ERR_NOTFOUND)
126 		offset = fdt_add_subnode(fdt, parentoffset, name);
127 
128 	if (offset < 0)
129 		printf("%s: %s: %s\n", __func__, name, fdt_strerror(offset));
130 
131 	return offset;
132 }
133 
134 /* rename to CONFIG_OF_STDOUT_PATH ? */
135 #if defined(OF_STDOUT_PATH)
136 static int fdt_fixup_stdout(void *fdt, int chosenoff)
137 {
138 	return fdt_setprop(fdt, chosenoff, "linux,stdout-path",
139 			      OF_STDOUT_PATH, strlen(OF_STDOUT_PATH) + 1);
140 }
141 #elif defined(CONFIG_OF_STDOUT_VIA_ALIAS) && defined(CONFIG_CONS_INDEX)
142 static int fdt_fixup_stdout(void *fdt, int chosenoff)
143 {
144 	int err;
145 	int aliasoff;
146 	char sername[9] = { 0 };
147 	const void *path;
148 	int len;
149 	char tmp[256]; /* long enough */
150 
151 	sprintf(sername, "serial%d", CONFIG_CONS_INDEX - 1);
152 
153 	aliasoff = fdt_path_offset(fdt, "/aliases");
154 	if (aliasoff < 0) {
155 		err = aliasoff;
156 		goto noalias;
157 	}
158 
159 	path = fdt_getprop(fdt, aliasoff, sername, &len);
160 	if (!path) {
161 		err = len;
162 		goto noalias;
163 	}
164 
165 	/* fdt_setprop may break "path" so we copy it to tmp buffer */
166 	memcpy(tmp, path, len);
167 
168 	err = fdt_setprop(fdt, chosenoff, "linux,stdout-path", tmp, len);
169 	if (err < 0)
170 		printf("WARNING: could not set linux,stdout-path %s.\n",
171 		       fdt_strerror(err));
172 
173 	return err;
174 
175 noalias:
176 	printf("WARNING: %s: could not read %s alias: %s\n",
177 	       __func__, sername, fdt_strerror(err));
178 
179 	return 0;
180 }
181 #else
182 static int fdt_fixup_stdout(void *fdt, int chosenoff)
183 {
184 	return 0;
185 }
186 #endif
187 
188 static inline int fdt_setprop_uxx(void *fdt, int nodeoffset, const char *name,
189 				  uint64_t val, int is_u64)
190 {
191 	if (is_u64)
192 		return fdt_setprop_u64(fdt, nodeoffset, name, val);
193 	else
194 		return fdt_setprop_u32(fdt, nodeoffset, name, (uint32_t)val);
195 }
196 
197 int fdt_root(void *fdt)
198 {
199 	char *serial;
200 	int err;
201 
202 	err = fdt_check_header(fdt);
203 	if (err < 0) {
204 		printf("fdt_root: %s\n", fdt_strerror(err));
205 		return err;
206 	}
207 
208 	serial = env_get("serial#");
209 	if (serial) {
210 		err = fdt_setprop(fdt, 0, "serial-number", serial,
211 				  strlen(serial) + 1);
212 
213 		if (err < 0) {
214 			printf("WARNING: could not set serial-number %s.\n",
215 			       fdt_strerror(err));
216 			return err;
217 		}
218 	}
219 
220 	return 0;
221 }
222 
223 int fdt_initrd(void *fdt, ulong initrd_start, ulong initrd_end)
224 {
225 	int   nodeoffset;
226 	int   err, j, total;
227 	int is_u64;
228 	uint64_t addr, size;
229 
230 	/* just return if the size of initrd is zero */
231 	if (initrd_start == initrd_end)
232 		return 0;
233 
234 	/* find or create "/chosen" node. */
235 	nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
236 	if (nodeoffset < 0)
237 		return nodeoffset;
238 
239 	total = fdt_num_mem_rsv(fdt);
240 
241 	/*
242 	 * Look for an existing entry and update it.  If we don't find
243 	 * the entry, we will j be the next available slot.
244 	 */
245 	for (j = 0; j < total; j++) {
246 		err = fdt_get_mem_rsv(fdt, j, &addr, &size);
247 		if (addr == initrd_start) {
248 			fdt_del_mem_rsv(fdt, j);
249 			break;
250 		}
251 	}
252 
253 	err = fdt_add_mem_rsv(fdt, initrd_start, initrd_end - initrd_start);
254 	if (err < 0) {
255 		printf("fdt_initrd: %s\n", fdt_strerror(err));
256 		return err;
257 	}
258 
259 	is_u64 = (fdt_address_cells(fdt, 0) == 2);
260 
261 	err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-start",
262 			      (uint64_t)initrd_start, is_u64);
263 
264 	if (err < 0) {
265 		printf("WARNING: could not set linux,initrd-start %s.\n",
266 		       fdt_strerror(err));
267 		return err;
268 	}
269 
270 	err = fdt_setprop_uxx(fdt, nodeoffset, "linux,initrd-end",
271 			      (uint64_t)initrd_end, is_u64);
272 
273 	if (err < 0) {
274 		printf("WARNING: could not set linux,initrd-end %s.\n",
275 		       fdt_strerror(err));
276 
277 		return err;
278 	}
279 
280 	return 0;
281 }
282 
283 static int fdt_bootargs_append(void *fdt, char *data)
284 {
285 	const char *arr_bootargs[] = { "bootargs", "bootargs_ext" };
286 	int nodeoffset, len;
287 	const char *bootargs;
288 	char *str;
289 	int i, ret = 0;
290 
291 	if (!data)
292 		return 0;
293 
294 	/* find or create "/chosen" node. */
295 	nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
296 	if (nodeoffset < 0)
297 		return nodeoffset;
298 
299 	for (i = 0; i < ARRAY_SIZE(arr_bootargs); i++) {
300 		bootargs = fdt_getprop(fdt, nodeoffset,
301 				       arr_bootargs[i], NULL);
302 		if (bootargs) {
303 			len = strlen(bootargs) + strlen(data) + 2;
304 			str = malloc(len);
305 			if (!str)
306 				return -ENOMEM;
307 
308 			fdt_increase_size(fdt, strlen(data) + 1);
309 			snprintf(str, len, "%s %s", bootargs, data);
310 			ret = fdt_setprop(fdt, nodeoffset, "bootargs",
311 					  str, len);
312 			if (ret < 0)
313 				printf("WARNING: could not set bootargs %s.\n", fdt_strerror(ret));
314 
315 			free(str);
316 			break;
317 		}
318 	}
319 
320 	return ret;
321 }
322 
323 int fdt_bootargs_append_ab(void *fdt, char *slot)
324 {
325 	char *str;
326 	int len, ret = 0;
327 
328 	if (!slot)
329 		return 0;
330 
331 	len = strlen(ANDROID_ARG_SLOT_SUFFIX) + strlen(slot) + 1;
332 	str = malloc(len);
333 	if (!str)
334 		return -ENOMEM;
335 
336 	snprintf(str, len, "%s%s", ANDROID_ARG_SLOT_SUFFIX, slot);
337 	ret = fdt_bootargs_append(fdt, str);
338 	if (ret)
339 		printf("Apend slot info to bootargs fail");
340 
341 	free(str);
342 
343 	return ret;
344 }
345 
346 int fdt_chosen(void *fdt)
347 {
348 	/*
349 	 * "bootargs_ext" is used when dtbo is applied.
350 	 */
351 	const char *arr_bootargs[] = { "bootargs", "bootargs_ext" };
352 	int   nodeoffset;
353 	int   err;
354 	int   i;
355 	char  *str;		/* used to set string properties */
356 	int dump;
357 
358 	dump = is_hotkey(HK_CMDLINE);
359 
360 	err = fdt_check_header(fdt);
361 	if (err < 0) {
362 		printf("fdt_chosen: %s\n", fdt_strerror(err));
363 		return err;
364 	}
365 
366 	/* find or create "/chosen" node. */
367 	nodeoffset = fdt_find_or_add_subnode(fdt, 0, "chosen");
368 	if (nodeoffset < 0)
369 		return nodeoffset;
370 
371 	str = env_get("bootargs");
372 	if (str) {
373 #ifdef CONFIG_ARCH_ROCKCHIP
374 		const char *bootargs;
375 
376 		if (dump)
377 			printf("## U-Boot bootargs: %s\n", str);
378 
379 		for (i = 0; i < ARRAY_SIZE(arr_bootargs); i++) {
380 			bootargs = fdt_getprop(fdt, nodeoffset,
381 					       arr_bootargs[i], NULL);
382 			if (bootargs) {
383 				if (dump)
384 					printf("## Kernel %s: %s\n",
385 					       arr_bootargs[i], bootargs);
386 				/*
387 				 * Append kernel bootargs
388 				 * If use AB system, delete default "root=" which route
389 				 * to rootfs. Then the ab bootctl will choose the
390 				 * high priority system to boot and add its UUID
391 				 * to cmdline. The format is "roo=PARTUUID=xxxx...".
392 				 */
393 				hotkey_run(HK_INITCALL);
394 #ifdef CONFIG_ANDROID_AB
395 				env_update_filter("bootargs", bootargs, "root=");
396 #else
397 				env_update("bootargs", bootargs);
398 #endif
399 #ifdef CONFIG_MTD_BLK
400 				char *mtd_par_info = mtd_part_parse();
401 
402 				if (mtd_par_info) {
403 					if (memcmp(env_get("devtype"), "mtd", 3) == 0)
404 						env_update("bootargs", mtd_par_info);
405 				}
406 #endif
407 				/*
408 				 * Initrd fixup: remove unused "initrd=0x...,0x...",
409 				 * this for compatible with legacy parameter.txt
410 				 */
411 				env_delete("bootargs", "initrd=", 0);
412 
413 				/*
414 				 * If uart is required to be disabled during
415 				 * power on, it would be not initialized by
416 				 * any pre-loader and U-Boot.
417 				 *
418 				 * If we don't remove earlycon from commandline,
419 				 * kernel hangs while using earlycon to putc/getc
420 				 * which may dead loop for waiting uart status.
421 				 * (It seems the root cause is baundrate is not
422 				 * initilalized)
423 				 *
424 				 * So let's remove earlycon from commandline.
425 				 */
426 				if (gd->flags & GD_FLG_DISABLE_CONSOLE)
427 					env_delete("bootargs", "earlycon=", 0);
428 			}
429 #endif
430 		}
431 
432 		str = env_get("bootargs");
433 		err = fdt_setprop(fdt, nodeoffset, "bootargs", str,
434 				  strlen(str) + 1);
435 		if (err < 0) {
436 			printf("WARNING: could not set bootargs %s.\n",
437 			       fdt_strerror(err));
438 			return err;
439 		}
440 	}
441 
442 	if (dump)
443 		printf("## Merged bootargs: %s\n", env_get("bootargs"));
444 
445 	return fdt_fixup_stdout(fdt, nodeoffset);
446 }
447 
448 void do_fixup_by_path(void *fdt, const char *path, const char *prop,
449 		      const void *val, int len, int create)
450 {
451 #if defined(DEBUG)
452 	int i;
453 	debug("Updating property '%s/%s' = ", path, prop);
454 	for (i = 0; i < len; i++)
455 		debug(" %.2x", *(u8*)(val+i));
456 	debug("\n");
457 #endif
458 	int rc = fdt_find_and_setprop(fdt, path, prop, val, len, create);
459 	if (rc)
460 		printf("Unable to update property %s:%s, err=%s\n",
461 			path, prop, fdt_strerror(rc));
462 }
463 
464 void do_fixup_by_path_u32(void *fdt, const char *path, const char *prop,
465 			  u32 val, int create)
466 {
467 	fdt32_t tmp = cpu_to_fdt32(val);
468 	do_fixup_by_path(fdt, path, prop, &tmp, sizeof(tmp), create);
469 }
470 
471 void do_fixup_by_prop(void *fdt,
472 		      const char *pname, const void *pval, int plen,
473 		      const char *prop, const void *val, int len,
474 		      int create)
475 {
476 	int off;
477 #if defined(DEBUG)
478 	int i;
479 	debug("Updating property '%s' = ", prop);
480 	for (i = 0; i < len; i++)
481 		debug(" %.2x", *(u8*)(val+i));
482 	debug("\n");
483 #endif
484 	off = fdt_node_offset_by_prop_value(fdt, -1, pname, pval, plen);
485 	while (off != -FDT_ERR_NOTFOUND) {
486 		if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
487 			fdt_setprop(fdt, off, prop, val, len);
488 		off = fdt_node_offset_by_prop_value(fdt, off, pname, pval, plen);
489 	}
490 }
491 
492 void do_fixup_by_prop_u32(void *fdt,
493 			  const char *pname, const void *pval, int plen,
494 			  const char *prop, u32 val, int create)
495 {
496 	fdt32_t tmp = cpu_to_fdt32(val);
497 	do_fixup_by_prop(fdt, pname, pval, plen, prop, &tmp, 4, create);
498 }
499 
500 void do_fixup_by_compat(void *fdt, const char *compat,
501 			const char *prop, const void *val, int len, int create)
502 {
503 	int off = -1;
504 #if defined(DEBUG)
505 	int i;
506 	debug("Updating property '%s' = ", prop);
507 	for (i = 0; i < len; i++)
508 		debug(" %.2x", *(u8*)(val+i));
509 	debug("\n");
510 #endif
511 	off = fdt_node_offset_by_compatible(fdt, -1, compat);
512 	while (off != -FDT_ERR_NOTFOUND) {
513 		if (create || (fdt_get_property(fdt, off, prop, NULL) != NULL))
514 			fdt_setprop(fdt, off, prop, val, len);
515 		off = fdt_node_offset_by_compatible(fdt, off, compat);
516 	}
517 }
518 
519 void do_fixup_by_compat_u32(void *fdt, const char *compat,
520 			    const char *prop, u32 val, int create)
521 {
522 	fdt32_t tmp = cpu_to_fdt32(val);
523 	do_fixup_by_compat(fdt, compat, prop, &tmp, 4, create);
524 }
525 
526 #ifdef CONFIG_ARCH_FIXUP_FDT_MEMORY
527 /*
528  * fdt_pack_reg - pack address and size array into the "reg"-suitable stream
529  */
530 static int fdt_pack_reg(const void *fdt, void *buf, u64 *address, u64 *size,
531 			int n)
532 {
533 	int i;
534 	int address_cells = fdt_address_cells(fdt, 0);
535 	int size_cells = fdt_size_cells(fdt, 0);
536 	char *p = buf;
537 
538 	for (i = 0; i < n; i++) {
539 		if (address_cells == 2)
540 			*(fdt64_t *)p = cpu_to_fdt64(address[i]);
541 		else
542 			*(fdt32_t *)p = cpu_to_fdt32(address[i]);
543 		p += 4 * address_cells;
544 
545 		if (size_cells == 2)
546 			*(fdt64_t *)p = cpu_to_fdt64(size[i]);
547 		else
548 			*(fdt32_t *)p = cpu_to_fdt32(size[i]);
549 		p += 4 * size_cells;
550 	}
551 
552 	return p - (char *)buf;
553 }
554 
555 int fdt_record_loadable(void *blob, u32 index, const char *name,
556 			uintptr_t load_addr, u32 size, uintptr_t entry_point,
557 			const char *type, const char *os)
558 {
559 	int err, node;
560 
561 	err = fdt_check_header(blob);
562 	if (err < 0) {
563 		printf("%s: %s\n", __func__, fdt_strerror(err));
564 		return err;
565 	}
566 
567 	/* find or create "/fit-images" node */
568 	node = fdt_find_or_add_subnode(blob, 0, "fit-images");
569 	if (node < 0)
570 			return node;
571 
572 	/* find or create "/fit-images/<name>" node */
573 	node = fdt_find_or_add_subnode(blob, node, name);
574 	if (node < 0)
575 		return node;
576 
577 	/*
578 	 * We record these as 32bit entities, possibly truncating addresses.
579 	 * However, spl_fit.c is not 64bit safe either: i.e. we should not
580 	 * have an issue here.
581 	 */
582 	fdt_setprop_u32(blob, node, "load-addr", load_addr);
583 	if (entry_point != -1)
584 		fdt_setprop_u32(blob, node, "entry-point", entry_point);
585 	fdt_setprop_u32(blob, node, "size", size);
586 	if (type)
587 		fdt_setprop_string(blob, node, "type", type);
588 	if (os)
589 		fdt_setprop_string(blob, node, "os", os);
590 
591 	return node;
592 }
593 
594 #ifdef CONFIG_NR_DRAM_BANKS
595 #define MEMORY_BANKS_MAX CONFIG_NR_DRAM_BANKS
596 #else
597 #define MEMORY_BANKS_MAX 4
598 #endif
599 int fdt_fixup_memory_banks(void *blob, u64 start[], u64 size[], int banks)
600 {
601 	int err, nodeoffset;
602 	int len;
603 	u8 tmp[MEMORY_BANKS_MAX * 16]; /* Up to 64-bit address + 64-bit size */
604 
605 	if (banks > MEMORY_BANKS_MAX) {
606 		printf("%s: num banks %d exceeds hardcoded limit %d."
607 		       " Recompile with higher MEMORY_BANKS_MAX?\n",
608 		       __FUNCTION__, banks, MEMORY_BANKS_MAX);
609 		return -1;
610 	}
611 
612 	err = fdt_check_header(blob);
613 	if (err < 0) {
614 		printf("%s: %s\n", __FUNCTION__, fdt_strerror(err));
615 		return err;
616 	}
617 
618 	/* find or create "/memory" node. */
619 	nodeoffset = fdt_find_or_add_subnode(blob, 0, "memory");
620 	if (nodeoffset < 0)
621 			return nodeoffset;
622 
623 	err = fdt_setprop(blob, nodeoffset, "device_type", "memory",
624 			sizeof("memory"));
625 	if (err < 0) {
626 		printf("WARNING: could not set %s %s.\n", "device_type",
627 				fdt_strerror(err));
628 		return err;
629 	}
630 
631 	if (!banks)
632 		return 0;
633 
634 	len = fdt_pack_reg(blob, tmp, start, size, banks);
635 
636 	err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
637 	if (err < 0) {
638 		printf("WARNING: could not set %s %s.\n",
639 				"reg", fdt_strerror(err));
640 		return err;
641 	}
642 	return 0;
643 }
644 
645 int fdt_fixup_memory(void *blob, u64 start, u64 size)
646 {
647 	return fdt_fixup_memory_banks(blob, &start, &size, 1);
648 }
649 
650 int fdt_update_reserved_memory(void *blob, char *name, u64 start, u64 size)
651 {
652 	int nodeoffset, len, err;
653 	u8 tmp[16]; /* Up to 64-bit address + 64-bit size */
654 
655 #if 0
656 	/*name is rockchip_logo*/
657 	nodeoffset = fdt_find_or_add_subnode(blob, 0, "reserved-memory");
658 	if (nodeoffset < 0)
659 		return nodeoffset;
660 	printf("hjc>>reserved-memory>>%s, nodeoffset:%d\n", __func__, nodeoffset);
661 	nodeoffset = fdt_find_or_add_subnode(blob, nodeoffset, name);
662 	if (nodeoffset < 0)
663 		return nodeoffset;
664 #else
665 	nodeoffset = fdt_node_offset_by_compatible(blob, 0, name);
666 	if (nodeoffset < 0)
667 		debug("Can't find nodeoffset: %d\n", nodeoffset);
668 #endif
669 	len = fdt_pack_reg(blob, tmp, &start, &size, 1);
670 	err = fdt_setprop(blob, nodeoffset, "reg", tmp, len);
671 	if (err < 0) {
672 		printf("WARNING: could not set %s %s.\n",
673 				"reg", fdt_strerror(err));
674 		return err;
675 	}
676 
677 	return nodeoffset;
678 }
679 #endif
680 
681 void fdt_fixup_ethernet(void *fdt)
682 {
683 	int i = 0, j, prop;
684 	char *tmp, *end;
685 	char mac[16];
686 	const char *path;
687 	unsigned char mac_addr[ARP_HLEN];
688 	int offset;
689 #ifdef FDT_SEQ_MACADDR_FROM_ENV
690 	int nodeoff;
691 	const struct fdt_property *fdt_prop;
692 #endif
693 
694 	if (fdt_path_offset(fdt, "/aliases") < 0)
695 		return;
696 
697 	/* Cycle through all aliases */
698 	for (prop = 0; ; prop++) {
699 		const char *name;
700 
701 		/* FDT might have been edited, recompute the offset */
702 		offset = fdt_first_property_offset(fdt,
703 			fdt_path_offset(fdt, "/aliases"));
704 		/* Select property number 'prop' */
705 		for (j = 0; j < prop; j++)
706 			offset = fdt_next_property_offset(fdt, offset);
707 
708 		if (offset < 0)
709 			break;
710 
711 		path = fdt_getprop_by_offset(fdt, offset, &name, NULL);
712 		if (!strncmp(name, "ethernet", 8)) {
713 			/* Treat plain "ethernet" same as "ethernet0". */
714 			if (!strcmp(name, "ethernet")
715 #ifdef FDT_SEQ_MACADDR_FROM_ENV
716 			 || !strcmp(name, "ethernet0")
717 #endif
718 			)
719 				i = 0;
720 #ifndef FDT_SEQ_MACADDR_FROM_ENV
721 			else
722 				i = trailing_strtol(name);
723 #endif
724 			if (i != -1) {
725 				if (i == 0)
726 					strcpy(mac, "ethaddr");
727 				else
728 					sprintf(mac, "eth%daddr", i);
729 			} else {
730 				continue;
731 			}
732 #ifdef FDT_SEQ_MACADDR_FROM_ENV
733 			nodeoff = fdt_path_offset(fdt, path);
734 			fdt_prop = fdt_get_property(fdt, nodeoff, "status",
735 						    NULL);
736 			if (fdt_prop && !strcmp(fdt_prop->data, "disabled"))
737 				continue;
738 			i++;
739 #endif
740 			tmp = env_get(mac);
741 			if (!tmp)
742 				continue;
743 
744 			for (j = 0; j < 6; j++) {
745 				mac_addr[j] = tmp ?
746 					      simple_strtoul(tmp, &end, 16) : 0;
747 				if (tmp)
748 					tmp = (*end) ? end + 1 : end;
749 			}
750 
751 			do_fixup_by_path(fdt, path, "mac-address",
752 					 &mac_addr, 6, 0);
753 			do_fixup_by_path(fdt, path, "local-mac-address",
754 					 &mac_addr, 6, 1);
755 		}
756 	}
757 }
758 
759 /* Resize the fdt to its actual size + a bit of padding */
760 int fdt_shrink_to_minimum(void *blob, uint extrasize)
761 {
762 	int i;
763 	uint64_t addr, size;
764 	int total, ret;
765 	uint actualsize;
766 
767 	if (!blob)
768 		return 0;
769 
770 	total = fdt_num_mem_rsv(blob);
771 	for (i = 0; i < total; i++) {
772 		fdt_get_mem_rsv(blob, i, &addr, &size);
773 		if (addr == (uintptr_t)blob) {
774 			fdt_del_mem_rsv(blob, i);
775 			break;
776 		}
777 	}
778 
779 	/*
780 	 * Calculate the actual size of the fdt
781 	 * plus the size needed for 5 fdt_add_mem_rsv, one
782 	 * for the fdt itself and 4 for a possible initrd
783 	 * ((initrd-start + initrd-end) * 2 (name & value))
784 	 */
785 	actualsize = fdt_off_dt_strings(blob) +
786 		fdt_size_dt_strings(blob) + 5 * sizeof(struct fdt_reserve_entry);
787 
788 	actualsize += extrasize;
789 	/* Make it so the fdt ends on a page boundary */
790 	actualsize = ALIGN(actualsize + ((uintptr_t)blob & 0xfff), 0x1000);
791 	actualsize = actualsize - ((uintptr_t)blob & 0xfff);
792 
793 	/* Change the fdt header to reflect the correct size */
794 	fdt_set_totalsize(blob, actualsize);
795 
796 	/* Add the new reservation */
797 	ret = fdt_add_mem_rsv(blob, (uintptr_t)blob, actualsize);
798 	if (ret < 0)
799 		return ret;
800 
801 	return actualsize;
802 }
803 
804 #ifdef CONFIG_PCI
805 #define CONFIG_SYS_PCI_NR_INBOUND_WIN 4
806 
807 #define FDT_PCI_PREFETCH	(0x40000000)
808 #define FDT_PCI_MEM32		(0x02000000)
809 #define FDT_PCI_IO		(0x01000000)
810 #define FDT_PCI_MEM64		(0x03000000)
811 
812 int fdt_pci_dma_ranges(void *blob, int phb_off, struct pci_controller *hose) {
813 
814 	int addrcell, sizecell, len, r;
815 	u32 *dma_range;
816 	/* sized based on pci addr cells, size-cells, & address-cells */
817 	u32 dma_ranges[(3 + 2 + 2) * CONFIG_SYS_PCI_NR_INBOUND_WIN];
818 
819 	addrcell = fdt_getprop_u32_default(blob, "/", "#address-cells", 1);
820 	sizecell = fdt_getprop_u32_default(blob, "/", "#size-cells", 1);
821 
822 	dma_range = &dma_ranges[0];
823 	for (r = 0; r < hose->region_count; r++) {
824 		u64 bus_start, phys_start, size;
825 
826 		/* skip if !PCI_REGION_SYS_MEMORY */
827 		if (!(hose->regions[r].flags & PCI_REGION_SYS_MEMORY))
828 			continue;
829 
830 		bus_start = (u64)hose->regions[r].bus_start;
831 		phys_start = (u64)hose->regions[r].phys_start;
832 		size = (u64)hose->regions[r].size;
833 
834 		dma_range[0] = 0;
835 		if (size >= 0x100000000ull)
836 			dma_range[0] |= FDT_PCI_MEM64;
837 		else
838 			dma_range[0] |= FDT_PCI_MEM32;
839 		if (hose->regions[r].flags & PCI_REGION_PREFETCH)
840 			dma_range[0] |= FDT_PCI_PREFETCH;
841 #ifdef CONFIG_SYS_PCI_64BIT
842 		dma_range[1] = bus_start >> 32;
843 #else
844 		dma_range[1] = 0;
845 #endif
846 		dma_range[2] = bus_start & 0xffffffff;
847 
848 		if (addrcell == 2) {
849 			dma_range[3] = phys_start >> 32;
850 			dma_range[4] = phys_start & 0xffffffff;
851 		} else {
852 			dma_range[3] = phys_start & 0xffffffff;
853 		}
854 
855 		if (sizecell == 2) {
856 			dma_range[3 + addrcell + 0] = size >> 32;
857 			dma_range[3 + addrcell + 1] = size & 0xffffffff;
858 		} else {
859 			dma_range[3 + addrcell + 0] = size & 0xffffffff;
860 		}
861 
862 		dma_range += (3 + addrcell + sizecell);
863 	}
864 
865 	len = dma_range - &dma_ranges[0];
866 	if (len)
867 		fdt_setprop(blob, phb_off, "dma-ranges", &dma_ranges[0], len*4);
868 
869 	return 0;
870 }
871 #endif
872 
873 int fdt_increase_size(void *fdt, int add_len)
874 {
875 	int newlen;
876 
877 	newlen = fdt_totalsize(fdt) + add_len;
878 
879 	/* Open in place with a new len */
880 	return fdt_open_into(fdt, fdt, newlen);
881 }
882 
883 #ifdef CONFIG_FDT_FIXUP_PARTITIONS
884 #include <jffs2/load_kernel.h>
885 #include <mtd_node.h>
886 
887 struct reg_cell {
888 	unsigned int r0;
889 	unsigned int r1;
890 };
891 
892 int fdt_del_subnodes(const void *blob, int parent_offset)
893 {
894 	int off, ndepth;
895 	int ret;
896 
897 	for (ndepth = 0, off = fdt_next_node(blob, parent_offset, &ndepth);
898 	     (off >= 0) && (ndepth > 0);
899 	     off = fdt_next_node(blob, off, &ndepth)) {
900 		if (ndepth == 1) {
901 			debug("delete %s: offset: %x\n",
902 				fdt_get_name(blob, off, 0), off);
903 			ret = fdt_del_node((void *)blob, off);
904 			if (ret < 0) {
905 				printf("Can't delete node: %s\n",
906 					fdt_strerror(ret));
907 				return ret;
908 			} else {
909 				ndepth = 0;
910 				off = parent_offset;
911 			}
912 		}
913 	}
914 	return 0;
915 }
916 
917 int fdt_del_partitions(void *blob, int parent_offset)
918 {
919 	const void *prop;
920 	int ndepth = 0;
921 	int off;
922 	int ret;
923 
924 	off = fdt_next_node(blob, parent_offset, &ndepth);
925 	if (off > 0 && ndepth == 1) {
926 		prop = fdt_getprop(blob, off, "label", NULL);
927 		if (prop == NULL) {
928 			/*
929 			 * Could not find label property, nand {}; node?
930 			 * Check subnode, delete partitions there if any.
931 			 */
932 			return fdt_del_partitions(blob, off);
933 		} else {
934 			ret = fdt_del_subnodes(blob, parent_offset);
935 			if (ret < 0) {
936 				printf("Can't remove subnodes: %s\n",
937 					fdt_strerror(ret));
938 				return ret;
939 			}
940 		}
941 	}
942 	return 0;
943 }
944 
945 int fdt_node_set_part_info(void *blob, int parent_offset,
946 			   struct mtd_device *dev)
947 {
948 	struct list_head *pentry;
949 	struct part_info *part;
950 	struct reg_cell cell;
951 	int off, ndepth = 0;
952 	int part_num, ret;
953 	char buf[64];
954 
955 	ret = fdt_del_partitions(blob, parent_offset);
956 	if (ret < 0)
957 		return ret;
958 
959 	/*
960 	 * Check if it is nand {}; subnode, adjust
961 	 * the offset in this case
962 	 */
963 	off = fdt_next_node(blob, parent_offset, &ndepth);
964 	if (off > 0 && ndepth == 1)
965 		parent_offset = off;
966 
967 	part_num = 0;
968 	list_for_each_prev(pentry, &dev->parts) {
969 		int newoff;
970 
971 		part = list_entry(pentry, struct part_info, link);
972 
973 		debug("%2d: %-20s0x%08llx\t0x%08llx\t%d\n",
974 			part_num, part->name, part->size,
975 			part->offset, part->mask_flags);
976 
977 		sprintf(buf, "partition@%llx", part->offset);
978 add_sub:
979 		ret = fdt_add_subnode(blob, parent_offset, buf);
980 		if (ret == -FDT_ERR_NOSPACE) {
981 			ret = fdt_increase_size(blob, 512);
982 			if (!ret)
983 				goto add_sub;
984 			else
985 				goto err_size;
986 		} else if (ret < 0) {
987 			printf("Can't add partition node: %s\n",
988 				fdt_strerror(ret));
989 			return ret;
990 		}
991 		newoff = ret;
992 
993 		/* Check MTD_WRITEABLE_CMD flag */
994 		if (part->mask_flags & 1) {
995 add_ro:
996 			ret = fdt_setprop(blob, newoff, "read_only", NULL, 0);
997 			if (ret == -FDT_ERR_NOSPACE) {
998 				ret = fdt_increase_size(blob, 512);
999 				if (!ret)
1000 					goto add_ro;
1001 				else
1002 					goto err_size;
1003 			} else if (ret < 0)
1004 				goto err_prop;
1005 		}
1006 
1007 		cell.r0 = cpu_to_fdt32(part->offset);
1008 		cell.r1 = cpu_to_fdt32(part->size);
1009 add_reg:
1010 		ret = fdt_setprop(blob, newoff, "reg", &cell, sizeof(cell));
1011 		if (ret == -FDT_ERR_NOSPACE) {
1012 			ret = fdt_increase_size(blob, 512);
1013 			if (!ret)
1014 				goto add_reg;
1015 			else
1016 				goto err_size;
1017 		} else if (ret < 0)
1018 			goto err_prop;
1019 
1020 add_label:
1021 		ret = fdt_setprop_string(blob, newoff, "label", part->name);
1022 		if (ret == -FDT_ERR_NOSPACE) {
1023 			ret = fdt_increase_size(blob, 512);
1024 			if (!ret)
1025 				goto add_label;
1026 			else
1027 				goto err_size;
1028 		} else if (ret < 0)
1029 			goto err_prop;
1030 
1031 		part_num++;
1032 	}
1033 	return 0;
1034 err_size:
1035 	printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1036 	return ret;
1037 err_prop:
1038 	printf("Can't add property: %s\n", fdt_strerror(ret));
1039 	return ret;
1040 }
1041 
1042 /*
1043  * Update partitions in nor/nand nodes using info from
1044  * mtdparts environment variable. The nodes to update are
1045  * specified by node_info structure which contains mtd device
1046  * type and compatible string: E. g. the board code in
1047  * ft_board_setup() could use:
1048  *
1049  *	struct node_info nodes[] = {
1050  *		{ "fsl,mpc5121-nfc",    MTD_DEV_TYPE_NAND, },
1051  *		{ "cfi-flash",          MTD_DEV_TYPE_NOR,  },
1052  *	};
1053  *
1054  *	fdt_fixup_mtdparts(blob, nodes, ARRAY_SIZE(nodes));
1055  */
1056 void fdt_fixup_mtdparts(void *blob, void *node_info, int node_info_size)
1057 {
1058 	struct node_info *ni = node_info;
1059 	struct mtd_device *dev;
1060 	int i, idx;
1061 	int noff;
1062 
1063 	if (mtdparts_init() != 0)
1064 		return;
1065 
1066 	for (i = 0; i < node_info_size; i++) {
1067 		idx = 0;
1068 		noff = fdt_node_offset_by_compatible(blob, -1, ni[i].compat);
1069 		while (noff != -FDT_ERR_NOTFOUND) {
1070 			debug("%s: %s, mtd dev type %d\n",
1071 				fdt_get_name(blob, noff, 0),
1072 				ni[i].compat, ni[i].type);
1073 			dev = device_find(ni[i].type, idx++);
1074 			if (dev) {
1075 				if (fdt_node_set_part_info(blob, noff, dev))
1076 					return; /* return on error */
1077 			}
1078 
1079 			/* Jump to next flash node */
1080 			noff = fdt_node_offset_by_compatible(blob, noff,
1081 							     ni[i].compat);
1082 		}
1083 	}
1084 }
1085 #endif
1086 
1087 void fdt_del_node_and_alias(void *blob, const char *alias)
1088 {
1089 	int off = fdt_path_offset(blob, alias);
1090 
1091 	if (off < 0)
1092 		return;
1093 
1094 	fdt_del_node(blob, off);
1095 
1096 	off = fdt_path_offset(blob, "/aliases");
1097 	fdt_delprop(blob, off, alias);
1098 }
1099 
1100 /* Max address size we deal with */
1101 #define OF_MAX_ADDR_CELLS	4
1102 #define OF_BAD_ADDR	FDT_ADDR_T_NONE
1103 #define OF_CHECK_COUNTS(na, ns)	((na) > 0 && (na) <= OF_MAX_ADDR_CELLS && \
1104 			(ns) > 0)
1105 
1106 /* Debug utility */
1107 #ifdef DEBUG
1108 static void of_dump_addr(const char *s, const fdt32_t *addr, int na)
1109 {
1110 	printf("%s", s);
1111 	while(na--)
1112 		printf(" %08x", *(addr++));
1113 	printf("\n");
1114 }
1115 #else
1116 static void of_dump_addr(const char *s, const fdt32_t *addr, int na) { }
1117 #endif
1118 
1119 /**
1120  * struct of_bus - Callbacks for bus specific translators
1121  * @name:	A string used to identify this bus in debug output.
1122  * @addresses:	The name of the DT property from which addresses are
1123  *		to be read, typically "reg".
1124  * @match:	Return non-zero if the node whose parent is at
1125  *		parentoffset in the FDT blob corresponds to a bus
1126  *		of this type, otherwise return zero. If NULL a match
1127  *		is assumed.
1128  * @count_cells:Count how many cells (be32 values) a node whose parent
1129  *		is at parentoffset in the FDT blob will require to
1130  *		represent its address (written to *addrc) & size
1131  *		(written to *sizec).
1132  * @map:	Map the address addr from the address space of this
1133  *		bus to that of its parent, making use of the ranges
1134  *		read from DT to an array at range. na and ns are the
1135  *		number of cells (be32 values) used to hold and address
1136  *		or size, respectively, for this bus. pna is the number
1137  *		of cells used to hold an address for the parent bus.
1138  *		Returns the address in the address space of the parent
1139  *		bus.
1140  * @translate:	Update the value of the address cells at addr within an
1141  *		FDT by adding offset to it. na specifies the number of
1142  *		cells used to hold the address being translated. Returns
1143  *		zero on success, non-zero on error.
1144  *
1145  * Each bus type will include a struct of_bus in the of_busses array,
1146  * providing implementations of some or all of the functions used to
1147  * match the bus & handle address translation for its children.
1148  */
1149 struct of_bus {
1150 	const char	*name;
1151 	const char	*addresses;
1152 	int		(*match)(const void *blob, int parentoffset);
1153 	void		(*count_cells)(const void *blob, int parentoffset,
1154 				int *addrc, int *sizec);
1155 	u64		(*map)(fdt32_t *addr, const fdt32_t *range,
1156 				int na, int ns, int pna);
1157 	int		(*translate)(fdt32_t *addr, u64 offset, int na);
1158 };
1159 
1160 /* Default translator (generic bus) */
1161 void fdt_support_default_count_cells(const void *blob, int parentoffset,
1162 					int *addrc, int *sizec)
1163 {
1164 	const fdt32_t *prop;
1165 
1166 	if (addrc)
1167 		*addrc = fdt_address_cells(blob, parentoffset);
1168 
1169 	if (sizec) {
1170 		prop = fdt_getprop(blob, parentoffset, "#size-cells", NULL);
1171 		if (prop)
1172 			*sizec = be32_to_cpup(prop);
1173 		else
1174 			*sizec = 1;
1175 	}
1176 }
1177 
1178 static u64 of_bus_default_map(fdt32_t *addr, const fdt32_t *range,
1179 		int na, int ns, int pna)
1180 {
1181 	u64 cp, s, da;
1182 
1183 	cp = fdt_read_number(range, na);
1184 	s  = fdt_read_number(range + na + pna, ns);
1185 	da = fdt_read_number(addr, na);
1186 
1187 	debug("OF: default map, cp=%" PRIu64 ", s=%" PRIu64
1188 	      ", da=%" PRIu64 "\n", cp, s, da);
1189 
1190 	if (da < cp || da >= (cp + s))
1191 		return OF_BAD_ADDR;
1192 	return da - cp;
1193 }
1194 
1195 static int of_bus_default_translate(fdt32_t *addr, u64 offset, int na)
1196 {
1197 	u64 a = fdt_read_number(addr, na);
1198 	memset(addr, 0, na * 4);
1199 	a += offset;
1200 	if (na > 1)
1201 		addr[na - 2] = cpu_to_fdt32(a >> 32);
1202 	addr[na - 1] = cpu_to_fdt32(a & 0xffffffffu);
1203 
1204 	return 0;
1205 }
1206 
1207 #ifdef CONFIG_OF_ISA_BUS
1208 
1209 /* ISA bus translator */
1210 static int of_bus_isa_match(const void *blob, int parentoffset)
1211 {
1212 	const char *name;
1213 
1214 	name = fdt_get_name(blob, parentoffset, NULL);
1215 	if (!name)
1216 		return 0;
1217 
1218 	return !strcmp(name, "isa");
1219 }
1220 
1221 static void of_bus_isa_count_cells(const void *blob, int parentoffset,
1222 				   int *addrc, int *sizec)
1223 {
1224 	if (addrc)
1225 		*addrc = 2;
1226 	if (sizec)
1227 		*sizec = 1;
1228 }
1229 
1230 static u64 of_bus_isa_map(fdt32_t *addr, const fdt32_t *range,
1231 			  int na, int ns, int pna)
1232 {
1233 	u64 cp, s, da;
1234 
1235 	/* Check address type match */
1236 	if ((addr[0] ^ range[0]) & cpu_to_be32(1))
1237 		return OF_BAD_ADDR;
1238 
1239 	cp = fdt_read_number(range + 1, na - 1);
1240 	s  = fdt_read_number(range + na + pna, ns);
1241 	da = fdt_read_number(addr + 1, na - 1);
1242 
1243 	debug("OF: ISA map, cp=%" PRIu64 ", s=%" PRIu64
1244 	      ", da=%" PRIu64 "\n", cp, s, da);
1245 
1246 	if (da < cp || da >= (cp + s))
1247 		return OF_BAD_ADDR;
1248 	return da - cp;
1249 }
1250 
1251 static int of_bus_isa_translate(fdt32_t *addr, u64 offset, int na)
1252 {
1253 	return of_bus_default_translate(addr + 1, offset, na - 1);
1254 }
1255 
1256 #endif /* CONFIG_OF_ISA_BUS */
1257 
1258 /* Array of bus specific translators */
1259 static struct of_bus of_busses[] = {
1260 #ifdef CONFIG_OF_ISA_BUS
1261 	/* ISA */
1262 	{
1263 		.name = "isa",
1264 		.addresses = "reg",
1265 		.match = of_bus_isa_match,
1266 		.count_cells = of_bus_isa_count_cells,
1267 		.map = of_bus_isa_map,
1268 		.translate = of_bus_isa_translate,
1269 	},
1270 #endif /* CONFIG_OF_ISA_BUS */
1271 	/* Default */
1272 	{
1273 		.name = "default",
1274 		.addresses = "reg",
1275 		.count_cells = fdt_support_default_count_cells,
1276 		.map = of_bus_default_map,
1277 		.translate = of_bus_default_translate,
1278 	},
1279 };
1280 
1281 static struct of_bus *of_match_bus(const void *blob, int parentoffset)
1282 {
1283 	struct of_bus *bus;
1284 
1285 	if (ARRAY_SIZE(of_busses) == 1)
1286 		return of_busses;
1287 
1288 	for (bus = of_busses; bus; bus++) {
1289 		if (!bus->match || bus->match(blob, parentoffset))
1290 			return bus;
1291 	}
1292 
1293 	/*
1294 	 * We should always have matched the default bus at least, since
1295 	 * it has a NULL match field. If we didn't then it somehow isn't
1296 	 * in the of_busses array or something equally catastrophic has
1297 	 * gone wrong.
1298 	 */
1299 	assert(0);
1300 	return NULL;
1301 }
1302 
1303 static int of_translate_one(const void *blob, int parent, struct of_bus *bus,
1304 			    struct of_bus *pbus, fdt32_t *addr,
1305 			    int na, int ns, int pna, const char *rprop)
1306 {
1307 	const fdt32_t *ranges;
1308 	int rlen;
1309 	int rone;
1310 	u64 offset = OF_BAD_ADDR;
1311 
1312 	/* Normally, an absence of a "ranges" property means we are
1313 	 * crossing a non-translatable boundary, and thus the addresses
1314 	 * below the current not cannot be converted to CPU physical ones.
1315 	 * Unfortunately, while this is very clear in the spec, it's not
1316 	 * what Apple understood, and they do have things like /uni-n or
1317 	 * /ht nodes with no "ranges" property and a lot of perfectly
1318 	 * useable mapped devices below them. Thus we treat the absence of
1319 	 * "ranges" as equivalent to an empty "ranges" property which means
1320 	 * a 1:1 translation at that level. It's up to the caller not to try
1321 	 * to translate addresses that aren't supposed to be translated in
1322 	 * the first place. --BenH.
1323 	 */
1324 	ranges = fdt_getprop(blob, parent, rprop, &rlen);
1325 	if (ranges == NULL || rlen == 0) {
1326 		offset = fdt_read_number(addr, na);
1327 		memset(addr, 0, pna * 4);
1328 		debug("OF: no ranges, 1:1 translation\n");
1329 		goto finish;
1330 	}
1331 
1332 	debug("OF: walking ranges...\n");
1333 
1334 	/* Now walk through the ranges */
1335 	rlen /= 4;
1336 	rone = na + pna + ns;
1337 	for (; rlen >= rone; rlen -= rone, ranges += rone) {
1338 		offset = bus->map(addr, ranges, na, ns, pna);
1339 		if (offset != OF_BAD_ADDR)
1340 			break;
1341 	}
1342 	if (offset == OF_BAD_ADDR) {
1343 		debug("OF: not found !\n");
1344 		return 1;
1345 	}
1346 	memcpy(addr, ranges + na, 4 * pna);
1347 
1348  finish:
1349 	of_dump_addr("OF: parent translation for:", addr, pna);
1350 	debug("OF: with offset: %" PRIu64 "\n", offset);
1351 
1352 	/* Translate it into parent bus space */
1353 	return pbus->translate(addr, offset, pna);
1354 }
1355 
1356 /*
1357  * Translate an address from the device-tree into a CPU physical address,
1358  * this walks up the tree and applies the various bus mappings on the
1359  * way.
1360  *
1361  * Note: We consider that crossing any level with #size-cells == 0 to mean
1362  * that translation is impossible (that is we are not dealing with a value
1363  * that can be mapped to a cpu physical address). This is not really specified
1364  * that way, but this is traditionally the way IBM at least do things
1365  */
1366 static u64 __of_translate_address(const void *blob, int node_offset,
1367 				  const fdt32_t *in_addr, const char *rprop)
1368 {
1369 	int parent;
1370 	struct of_bus *bus, *pbus;
1371 	fdt32_t addr[OF_MAX_ADDR_CELLS];
1372 	int na, ns, pna, pns;
1373 	u64 result = OF_BAD_ADDR;
1374 
1375 	debug("OF: ** translation for device %s **\n",
1376 		fdt_get_name(blob, node_offset, NULL));
1377 
1378 	/* Get parent & match bus type */
1379 	parent = fdt_parent_offset(blob, node_offset);
1380 	if (parent < 0)
1381 		goto bail;
1382 	bus = of_match_bus(blob, parent);
1383 
1384 	/* Cound address cells & copy address locally */
1385 	bus->count_cells(blob, parent, &na, &ns);
1386 	if (!OF_CHECK_COUNTS(na, ns)) {
1387 		printf("%s: Bad cell count for %s\n", __FUNCTION__,
1388 		       fdt_get_name(blob, node_offset, NULL));
1389 		goto bail;
1390 	}
1391 	memcpy(addr, in_addr, na * 4);
1392 
1393 	debug("OF: bus is %s (na=%d, ns=%d) on %s\n",
1394 	    bus->name, na, ns, fdt_get_name(blob, parent, NULL));
1395 	of_dump_addr("OF: translating address:", addr, na);
1396 
1397 	/* Translate */
1398 	for (;;) {
1399 		/* Switch to parent bus */
1400 		node_offset = parent;
1401 		parent = fdt_parent_offset(blob, node_offset);
1402 
1403 		/* If root, we have finished */
1404 		if (parent < 0) {
1405 			debug("OF: reached root node\n");
1406 			result = fdt_read_number(addr, na);
1407 			break;
1408 		}
1409 
1410 		/* Get new parent bus and counts */
1411 		pbus = of_match_bus(blob, parent);
1412 		pbus->count_cells(blob, parent, &pna, &pns);
1413 		if (!OF_CHECK_COUNTS(pna, pns)) {
1414 			printf("%s: Bad cell count for %s\n", __FUNCTION__,
1415 				fdt_get_name(blob, node_offset, NULL));
1416 			break;
1417 		}
1418 
1419 		debug("OF: parent bus is %s (na=%d, ns=%d) on %s\n",
1420 		    pbus->name, pna, pns, fdt_get_name(blob, parent, NULL));
1421 
1422 		/* Apply bus translation */
1423 		if (of_translate_one(blob, node_offset, bus, pbus,
1424 					addr, na, ns, pna, rprop))
1425 			break;
1426 
1427 		/* Complete the move up one level */
1428 		na = pna;
1429 		ns = pns;
1430 		bus = pbus;
1431 
1432 		of_dump_addr("OF: one level translation:", addr, na);
1433 	}
1434  bail:
1435 
1436 	return result;
1437 }
1438 
1439 u64 fdt_translate_address(const void *blob, int node_offset,
1440 			  const fdt32_t *in_addr)
1441 {
1442 	return __of_translate_address(blob, node_offset, in_addr, "ranges");
1443 }
1444 
1445 /**
1446  * fdt_node_offset_by_compat_reg: Find a node that matches compatiable and
1447  * who's reg property matches a physical cpu address
1448  *
1449  * @blob: ptr to device tree
1450  * @compat: compatiable string to match
1451  * @compat_off: property name
1452  *
1453  */
1454 int fdt_node_offset_by_compat_reg(void *blob, const char *compat,
1455 					phys_addr_t compat_off)
1456 {
1457 	int len, off = fdt_node_offset_by_compatible(blob, -1, compat);
1458 	while (off != -FDT_ERR_NOTFOUND) {
1459 		const fdt32_t *reg = fdt_getprop(blob, off, "reg", &len);
1460 		if (reg) {
1461 			if (compat_off == fdt_translate_address(blob, off, reg))
1462 				return off;
1463 		}
1464 		off = fdt_node_offset_by_compatible(blob, off, compat);
1465 	}
1466 
1467 	return -FDT_ERR_NOTFOUND;
1468 }
1469 
1470 /**
1471  * fdt_alloc_phandle: Return next free phandle value
1472  *
1473  * @blob: ptr to device tree
1474  */
1475 int fdt_alloc_phandle(void *blob)
1476 {
1477 	int offset;
1478 	uint32_t phandle = 0;
1479 
1480 	for (offset = fdt_next_node(blob, -1, NULL); offset >= 0;
1481 	     offset = fdt_next_node(blob, offset, NULL)) {
1482 		phandle = max(phandle, fdt_get_phandle(blob, offset));
1483 	}
1484 
1485 	return phandle + 1;
1486 }
1487 
1488 /*
1489  * fdt_set_phandle: Create a phandle property for the given node
1490  *
1491  * @fdt: ptr to device tree
1492  * @nodeoffset: node to update
1493  * @phandle: phandle value to set (must be unique)
1494  */
1495 int fdt_set_phandle(void *fdt, int nodeoffset, uint32_t phandle)
1496 {
1497 	int ret;
1498 
1499 #ifdef DEBUG
1500 	int off = fdt_node_offset_by_phandle(fdt, phandle);
1501 
1502 	if ((off >= 0) && (off != nodeoffset)) {
1503 		char buf[64];
1504 
1505 		fdt_get_path(fdt, nodeoffset, buf, sizeof(buf));
1506 		printf("Trying to update node %s with phandle %u ",
1507 		       buf, phandle);
1508 
1509 		fdt_get_path(fdt, off, buf, sizeof(buf));
1510 		printf("that already exists in node %s.\n", buf);
1511 		return -FDT_ERR_BADPHANDLE;
1512 	}
1513 #endif
1514 
1515 	ret = fdt_setprop_cell(fdt, nodeoffset, "phandle", phandle);
1516 	if (ret < 0)
1517 		return ret;
1518 
1519 	/*
1520 	 * For now, also set the deprecated "linux,phandle" property, so that we
1521 	 * don't break older kernels.
1522 	 */
1523 	ret = fdt_setprop_cell(fdt, nodeoffset, "linux,phandle", phandle);
1524 
1525 	return ret;
1526 }
1527 
1528 /*
1529  * fdt_create_phandle: Create a phandle property for the given node
1530  *
1531  * @fdt: ptr to device tree
1532  * @nodeoffset: node to update
1533  */
1534 unsigned int fdt_create_phandle(void *fdt, int nodeoffset)
1535 {
1536 	/* see if there is a phandle already */
1537 	int phandle = fdt_get_phandle(fdt, nodeoffset);
1538 
1539 	/* if we got 0, means no phandle so create one */
1540 	if (phandle == 0) {
1541 		int ret;
1542 
1543 		phandle = fdt_alloc_phandle(fdt);
1544 		ret = fdt_set_phandle(fdt, nodeoffset, phandle);
1545 		if (ret < 0) {
1546 			printf("Can't set phandle %u: %s\n", phandle,
1547 			       fdt_strerror(ret));
1548 			return 0;
1549 		}
1550 	}
1551 
1552 	return phandle;
1553 }
1554 
1555 /*
1556  * fdt_set_node_status: Set status for the given node
1557  *
1558  * @fdt: ptr to device tree
1559  * @nodeoffset: node to update
1560  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1561  *	    FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1562  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1563  */
1564 int fdt_set_node_status(void *fdt, int nodeoffset,
1565 			enum fdt_status status, unsigned int error_code)
1566 {
1567 	char buf[16];
1568 	int ret = 0;
1569 
1570 	if (nodeoffset < 0)
1571 		return nodeoffset;
1572 
1573 	switch (status) {
1574 	case FDT_STATUS_OKAY:
1575 		ret = fdt_setprop_string(fdt, nodeoffset, "status", "okay");
1576 		break;
1577 	case FDT_STATUS_DISABLED:
1578 		ret = fdt_setprop_string(fdt, nodeoffset, "status", "disabled");
1579 		break;
1580 	case FDT_STATUS_FAIL:
1581 		ret = fdt_setprop_string(fdt, nodeoffset, "status", "fail");
1582 		break;
1583 	case FDT_STATUS_FAIL_ERROR_CODE:
1584 		sprintf(buf, "fail-%d", error_code);
1585 		ret = fdt_setprop_string(fdt, nodeoffset, "status", buf);
1586 		break;
1587 	default:
1588 		printf("Invalid fdt status: %x\n", status);
1589 		ret = -1;
1590 		break;
1591 	}
1592 
1593 	return ret;
1594 }
1595 
1596 /*
1597  * fdt_set_status_by_alias: Set status for the given node given an alias
1598  *
1599  * @fdt: ptr to device tree
1600  * @alias: alias of node to update
1601  * @status: FDT_STATUS_OKAY, FDT_STATUS_DISABLED,
1602  *	    FDT_STATUS_FAIL, FDT_STATUS_FAIL_ERROR_CODE
1603  * @error_code: optional, only used if status is FDT_STATUS_FAIL_ERROR_CODE
1604  */
1605 int fdt_set_status_by_alias(void *fdt, const char* alias,
1606 			    enum fdt_status status, unsigned int error_code)
1607 {
1608 	int offset = fdt_path_offset(fdt, alias);
1609 
1610 	return fdt_set_node_status(fdt, offset, status, error_code);
1611 }
1612 
1613 #if defined(CONFIG_VIDEO) || defined(CONFIG_LCD)
1614 int fdt_add_edid(void *blob, const char *compat, unsigned char *edid_buf)
1615 {
1616 	int noff;
1617 	int ret;
1618 
1619 	noff = fdt_node_offset_by_compatible(blob, -1, compat);
1620 	if (noff != -FDT_ERR_NOTFOUND) {
1621 		debug("%s: %s\n", fdt_get_name(blob, noff, 0), compat);
1622 add_edid:
1623 		ret = fdt_setprop(blob, noff, "edid", edid_buf, 128);
1624 		if (ret == -FDT_ERR_NOSPACE) {
1625 			ret = fdt_increase_size(blob, 512);
1626 			if (!ret)
1627 				goto add_edid;
1628 			else
1629 				goto err_size;
1630 		} else if (ret < 0) {
1631 			printf("Can't add property: %s\n", fdt_strerror(ret));
1632 			return ret;
1633 		}
1634 	}
1635 	return 0;
1636 err_size:
1637 	printf("Can't increase blob size: %s\n", fdt_strerror(ret));
1638 	return ret;
1639 }
1640 #endif
1641 
1642 /*
1643  * Verify the physical address of device tree node for a given alias
1644  *
1645  * This function locates the device tree node of a given alias, and then
1646  * verifies that the physical address of that device matches the given
1647  * parameter.  It displays a message if there is a mismatch.
1648  *
1649  * Returns 1 on success, 0 on failure
1650  */
1651 int fdt_verify_alias_address(void *fdt, int anode, const char *alias, u64 addr)
1652 {
1653 	const char *path;
1654 	const fdt32_t *reg;
1655 	int node, len;
1656 	u64 dt_addr;
1657 
1658 	path = fdt_getprop(fdt, anode, alias, NULL);
1659 	if (!path) {
1660 		/* If there's no such alias, then it's not a failure */
1661 		return 1;
1662 	}
1663 
1664 	node = fdt_path_offset(fdt, path);
1665 	if (node < 0) {
1666 		printf("Warning: device tree alias '%s' points to invalid "
1667 		       "node %s.\n", alias, path);
1668 		return 0;
1669 	}
1670 
1671 	reg = fdt_getprop(fdt, node, "reg", &len);
1672 	if (!reg) {
1673 		printf("Warning: device tree node '%s' has no address.\n",
1674 		       path);
1675 		return 0;
1676 	}
1677 
1678 	dt_addr = fdt_translate_address(fdt, node, reg);
1679 	if (addr != dt_addr) {
1680 		printf("Warning: U-Boot configured device %s at address %"
1681 		       PRIx64 ",\n but the device tree has it address %"
1682 		       PRIx64 ".\n", alias, addr, dt_addr);
1683 		return 0;
1684 	}
1685 
1686 	return 1;
1687 }
1688 
1689 /*
1690  * Returns the base address of an SOC or PCI node
1691  */
1692 u64 fdt_get_base_address(const void *fdt, int node)
1693 {
1694 	int size;
1695 	const fdt32_t *prop;
1696 
1697 	prop = fdt_getprop(fdt, node, "reg", &size);
1698 
1699 	return prop ? fdt_translate_address(fdt, node, prop) : 0;
1700 }
1701 
1702 /*
1703  * Read a property of size <prop_len>. Currently only supports 1 or 2 cells.
1704  */
1705 static int fdt_read_prop(const fdt32_t *prop, int prop_len, int cell_off,
1706 			 uint64_t *val, int cells)
1707 {
1708 	const fdt32_t *prop32 = &prop[cell_off];
1709 	const fdt64_t *prop64 = (const fdt64_t *)&prop[cell_off];
1710 
1711 	if ((cell_off + cells) > prop_len)
1712 		return -FDT_ERR_NOSPACE;
1713 
1714 	switch (cells) {
1715 	case 1:
1716 		*val = fdt32_to_cpu(*prop32);
1717 		break;
1718 	case 2:
1719 		*val = fdt64_to_cpu(*prop64);
1720 		break;
1721 	default:
1722 		return -FDT_ERR_NOSPACE;
1723 	}
1724 
1725 	return 0;
1726 }
1727 
1728 /**
1729  * fdt_read_range - Read a node's n'th range property
1730  *
1731  * @fdt: ptr to device tree
1732  * @node: offset of node
1733  * @n: range index
1734  * @child_addr: pointer to storage for the "child address" field
1735  * @addr: pointer to storage for the CPU view translated physical start
1736  * @len: pointer to storage for the range length
1737  *
1738  * Convenience function that reads and interprets a specific range out of
1739  * a number of the "ranges" property array.
1740  */
1741 int fdt_read_range(void *fdt, int node, int n, uint64_t *child_addr,
1742 		   uint64_t *addr, uint64_t *len)
1743 {
1744 	int pnode = fdt_parent_offset(fdt, node);
1745 	const fdt32_t *ranges;
1746 	int pacells;
1747 	int acells;
1748 	int scells;
1749 	int ranges_len;
1750 	int cell = 0;
1751 	int r = 0;
1752 
1753 	/*
1754 	 * The "ranges" property is an array of
1755 	 * { <child address> <parent address> <size in child address space> }
1756 	 *
1757 	 * All 3 elements can span a diffent number of cells. Fetch their size.
1758 	 */
1759 	pacells = fdt_getprop_u32_default_node(fdt, pnode, 0, "#address-cells", 1);
1760 	acells = fdt_getprop_u32_default_node(fdt, node, 0, "#address-cells", 1);
1761 	scells = fdt_getprop_u32_default_node(fdt, node, 0, "#size-cells", 1);
1762 
1763 	/* Now try to get the ranges property */
1764 	ranges = fdt_getprop(fdt, node, "ranges", &ranges_len);
1765 	if (!ranges)
1766 		return -FDT_ERR_NOTFOUND;
1767 	ranges_len /= sizeof(uint32_t);
1768 
1769 	/* Jump to the n'th entry */
1770 	cell = n * (pacells + acells + scells);
1771 
1772 	/* Read <child address> */
1773 	if (child_addr) {
1774 		r = fdt_read_prop(ranges, ranges_len, cell, child_addr,
1775 				  acells);
1776 		if (r)
1777 			return r;
1778 	}
1779 	cell += acells;
1780 
1781 	/* Read <parent address> */
1782 	if (addr)
1783 		*addr = fdt_translate_address(fdt, node, ranges + cell);
1784 	cell += pacells;
1785 
1786 	/* Read <size in child address space> */
1787 	if (len) {
1788 		r = fdt_read_prop(ranges, ranges_len, cell, len, scells);
1789 		if (r)
1790 			return r;
1791 	}
1792 
1793 	return 0;
1794 }
1795 
1796 /**
1797  * fdt_setup_simplefb_node - Fill and enable a simplefb node
1798  *
1799  * @fdt: ptr to device tree
1800  * @node: offset of the simplefb node
1801  * @base_address: framebuffer base address
1802  * @width: width in pixels
1803  * @height: height in pixels
1804  * @stride: bytes per line
1805  * @format: pixel format string
1806  *
1807  * Convenience function to fill and enable a simplefb node.
1808  */
1809 int fdt_setup_simplefb_node(void *fdt, int node, u64 base_address, u32 width,
1810 			    u32 height, u32 stride, const char *format)
1811 {
1812 	char name[32];
1813 	fdt32_t cells[4];
1814 	int i, addrc, sizec, ret;
1815 
1816 	fdt_support_default_count_cells(fdt, fdt_parent_offset(fdt, node),
1817 					&addrc, &sizec);
1818 	i = 0;
1819 	if (addrc == 2)
1820 		cells[i++] = cpu_to_fdt32(base_address >> 32);
1821 	cells[i++] = cpu_to_fdt32(base_address);
1822 	if (sizec == 2)
1823 		cells[i++] = 0;
1824 	cells[i++] = cpu_to_fdt32(height * stride);
1825 
1826 	ret = fdt_setprop(fdt, node, "reg", cells, sizeof(cells[0]) * i);
1827 	if (ret < 0)
1828 		return ret;
1829 
1830 	snprintf(name, sizeof(name), "framebuffer@%" PRIx64, base_address);
1831 	ret = fdt_set_name(fdt, node, name);
1832 	if (ret < 0)
1833 		return ret;
1834 
1835 	ret = fdt_setprop_u32(fdt, node, "width", width);
1836 	if (ret < 0)
1837 		return ret;
1838 
1839 	ret = fdt_setprop_u32(fdt, node, "height", height);
1840 	if (ret < 0)
1841 		return ret;
1842 
1843 	ret = fdt_setprop_u32(fdt, node, "stride", stride);
1844 	if (ret < 0)
1845 		return ret;
1846 
1847 	ret = fdt_setprop_string(fdt, node, "format", format);
1848 	if (ret < 0)
1849 		return ret;
1850 
1851 	ret = fdt_setprop_string(fdt, node, "status", "okay");
1852 	if (ret < 0)
1853 		return ret;
1854 
1855 	return 0;
1856 }
1857 
1858 /*
1859  * Update native-mode in display-timings from display environment variable.
1860  * The node to update are specified by path.
1861  */
1862 int fdt_fixup_display(void *blob, const char *path, const char *display)
1863 {
1864 	int off, toff;
1865 
1866 	if (!display || !path)
1867 		return -FDT_ERR_NOTFOUND;
1868 
1869 	toff = fdt_path_offset(blob, path);
1870 	if (toff >= 0)
1871 		toff = fdt_subnode_offset(blob, toff, "display-timings");
1872 	if (toff < 0)
1873 		return toff;
1874 
1875 	for (off = fdt_first_subnode(blob, toff);
1876 	     off >= 0;
1877 	     off = fdt_next_subnode(blob, off)) {
1878 		uint32_t h = fdt_get_phandle(blob, off);
1879 		debug("%s:0x%x\n", fdt_get_name(blob, off, NULL),
1880 		      fdt32_to_cpu(h));
1881 		if (strcasecmp(fdt_get_name(blob, off, NULL), display) == 0)
1882 			return fdt_setprop_u32(blob, toff, "native-mode", h);
1883 	}
1884 	return toff;
1885 }
1886 
1887 #ifdef CONFIG_OF_LIBFDT_OVERLAY
1888 /**
1889  * fdt_overlay_apply_verbose - Apply an overlay with verbose error reporting
1890  *
1891  * @fdt: ptr to device tree
1892  * @fdto: ptr to device tree overlay
1893  *
1894  * Convenience function to apply an overlay and display helpful messages
1895  * in the case of an error
1896  */
1897 int fdt_overlay_apply_verbose(void *fdt, void *fdto)
1898 {
1899 	int err;
1900 	bool has_symbols;
1901 
1902 	err = fdt_path_offset(fdt, "/__symbols__");
1903 	has_symbols = err >= 0;
1904 
1905 	err = fdt_overlay_apply(fdt, fdto);
1906 	if (err < 0) {
1907 		printf("failed on fdt_overlay_apply(): %s\n",
1908 				fdt_strerror(err));
1909 		if (!has_symbols) {
1910 			printf("base fdt does did not have a /__symbols__ node\n");
1911 			printf("make sure you've compiled with -@\n");
1912 		}
1913 	}
1914 	return err;
1915 }
1916 #endif
1917