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