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