xref: /openbmc/u-boot/lib/fdtdec.c (revision 610751e9)
1 /*
2  * Copyright (c) 2011 The Chromium OS Authors.
3  * SPDX-License-Identifier:	GPL-2.0+
4  */
5 
6 #ifndef USE_HOSTCC
7 #include <common.h>
8 #include <errno.h>
9 #include <serial.h>
10 #include <libfdt.h>
11 #include <fdtdec.h>
12 #include <asm/sections.h>
13 #include <linux/ctype.h>
14 
15 DECLARE_GLOBAL_DATA_PTR;
16 
17 /*
18  * Here are the type we know about. One day we might allow drivers to
19  * register. For now we just put them here. The COMPAT macro allows us to
20  * turn this into a sparse list later, and keeps the ID with the name.
21  */
22 #define COMPAT(id, name) name
23 static const char * const compat_names[COMPAT_COUNT] = {
24 	COMPAT(UNKNOWN, "<none>"),
25 	COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
26 	COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
27 	COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
28 	COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
29 	COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
30 	COMPAT(NVIDIA_TEGRA124_DC, "nvidia,tegra124-dc"),
31 	COMPAT(NVIDIA_TEGRA124_SOR, "nvidia,tegra124-sor"),
32 	COMPAT(NVIDIA_TEGRA124_PMC, "nvidia,tegra124-pmc"),
33 	COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
34 	COMPAT(NVIDIA_TEGRA210_SDMMC, "nvidia,tegra210-sdhci"),
35 	COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
36 	COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
37 	COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
38 	COMPAT(NVIDIA_TEGRA124_PCIE, "nvidia,tegra124-pcie"),
39 	COMPAT(NVIDIA_TEGRA30_PCIE, "nvidia,tegra30-pcie"),
40 	COMPAT(NVIDIA_TEGRA20_PCIE, "nvidia,tegra20-pcie"),
41 	COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
42 	COMPAT(NVIDIA_TEGRA210_XUSB_PADCTL, "nvidia,tegra210-xusb-padctl"),
43 	COMPAT(SMSC_LAN9215, "smsc,lan9215"),
44 	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
45 	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
46 	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
47 	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
48 	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
49 	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
50 	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
51 	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
52 	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
53 	COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
54 	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
55 	COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
56 	COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
57 	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
58 	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686"),
59 	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
60 	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
61 	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
62 	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645tt"),
63 	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
64 	COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
65 	COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
66 	COMPAT(INTEL_MICROCODE, "intel,microcode"),
67 	COMPAT(MEMORY_SPD, "memory-spd"),
68 	COMPAT(INTEL_PANTHERPOINT_AHCI, "intel,pantherpoint-ahci"),
69 	COMPAT(INTEL_MODEL_206AX, "intel,model-206ax"),
70 	COMPAT(INTEL_GMA, "intel,gma"),
71 	COMPAT(AMS_AS3722, "ams,as3722"),
72 	COMPAT(INTEL_ICH_SPI, "intel,ich-spi"),
73 	COMPAT(INTEL_QRK_MRC, "intel,quark-mrc"),
74 	COMPAT(INTEL_X86_PINCTRL, "intel,x86-pinctrl"),
75 	COMPAT(SOCIONEXT_XHCI, "socionext,uniphier-xhci"),
76 	COMPAT(COMPAT_INTEL_PCH, "intel,bd82x6x"),
77 	COMPAT(COMPAT_INTEL_IRQ_ROUTER, "intel,irq-router"),
78 	COMPAT(ALTERA_SOCFPGA_DWMAC, "altr,socfpga-stmmac"),
79 	COMPAT(COMPAT_INTEL_BAYTRAIL_FSP, "intel,baytrail-fsp"),
80 	COMPAT(COMPAT_INTEL_BAYTRAIL_FSP_MDP, "intel,baytrail-fsp-mdp"),
81 };
82 
83 const char *fdtdec_get_compatible(enum fdt_compat_id id)
84 {
85 	/* We allow reading of the 'unknown' ID for testing purposes */
86 	assert(id >= 0 && id < COMPAT_COUNT);
87 	return compat_names[id];
88 }
89 
90 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
91 		const char *prop_name, fdt_size_t *sizep)
92 {
93 	const fdt_addr_t *cell;
94 	int len;
95 
96 	debug("%s: %s: ", __func__, prop_name);
97 	cell = fdt_getprop(blob, node, prop_name, &len);
98 	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
99 		     len == sizeof(fdt_addr_t) * 2)) {
100 		fdt_addr_t addr = fdt_addr_to_cpu(*cell);
101 		if (sizep) {
102 			const fdt_size_t *size;
103 
104 			size = (fdt_size_t *)((char *)cell +
105 					sizeof(fdt_addr_t));
106 			*sizep = fdt_size_to_cpu(*size);
107 			debug("addr=%08lx, size=%llx\n",
108 			      (ulong)addr, (u64)*sizep);
109 		} else {
110 			debug("%08lx\n", (ulong)addr);
111 		}
112 		return addr;
113 	}
114 	debug("(not found)\n");
115 	return FDT_ADDR_T_NONE;
116 }
117 
118 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
119 		const char *prop_name)
120 {
121 	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
122 }
123 
124 #ifdef CONFIG_PCI
125 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
126 		const char *prop_name, struct fdt_pci_addr *addr)
127 {
128 	const u32 *cell;
129 	int len;
130 	int ret = -ENOENT;
131 
132 	debug("%s: %s: ", __func__, prop_name);
133 
134 	/*
135 	 * If we follow the pci bus bindings strictly, we should check
136 	 * the value of the node's parent node's #address-cells and
137 	 * #size-cells. They need to be 3 and 2 accordingly. However,
138 	 * for simplicity we skip the check here.
139 	 */
140 	cell = fdt_getprop(blob, node, prop_name, &len);
141 	if (!cell)
142 		goto fail;
143 
144 	if ((len % FDT_PCI_REG_SIZE) == 0) {
145 		int num = len / FDT_PCI_REG_SIZE;
146 		int i;
147 
148 		for (i = 0; i < num; i++) {
149 			debug("pci address #%d: %08lx %08lx %08lx\n", i,
150 			      (ulong)fdt_addr_to_cpu(cell[0]),
151 			      (ulong)fdt_addr_to_cpu(cell[1]),
152 			      (ulong)fdt_addr_to_cpu(cell[2]));
153 			if ((fdt_addr_to_cpu(*cell) & type) == type) {
154 				addr->phys_hi = fdt_addr_to_cpu(cell[0]);
155 				addr->phys_mid = fdt_addr_to_cpu(cell[1]);
156 				addr->phys_lo = fdt_addr_to_cpu(cell[2]);
157 				break;
158 			} else {
159 				cell += (FDT_PCI_ADDR_CELLS +
160 					 FDT_PCI_SIZE_CELLS);
161 			}
162 		}
163 
164 		if (i == num) {
165 			ret = -ENXIO;
166 			goto fail;
167 		}
168 
169 		return 0;
170 	} else {
171 		ret = -EINVAL;
172 	}
173 
174 fail:
175 	debug("(not found)\n");
176 	return ret;
177 }
178 
179 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
180 {
181 	const char *list, *end;
182 	int len;
183 
184 	list = fdt_getprop(blob, node, "compatible", &len);
185 	if (!list)
186 		return -ENOENT;
187 
188 	end = list + len;
189 	while (list < end) {
190 		char *s;
191 
192 		len = strlen(list);
193 		if (len >= strlen("pciVVVV,DDDD")) {
194 			s = strstr(list, "pci");
195 
196 			/*
197 			 * check if the string is something like pciVVVV,DDDD.RR
198 			 * or just pciVVVV,DDDD
199 			 */
200 			if (s && s[7] == ',' &&
201 			    (s[12] == '.' || s[12] == 0)) {
202 				s += 3;
203 				*vendor = simple_strtol(s, NULL, 16);
204 
205 				s += 5;
206 				*device = simple_strtol(s, NULL, 16);
207 
208 				return 0;
209 			}
210 		}
211 		list += (len + 1);
212 	}
213 
214 	return -ENOENT;
215 }
216 
217 int fdtdec_get_pci_bdf(const void *blob, int node,
218 		struct fdt_pci_addr *addr, pci_dev_t *bdf)
219 {
220 	u16 dt_vendor, dt_device, vendor, device;
221 	int ret;
222 
223 	/* get vendor id & device id from the compatible string */
224 	ret = fdtdec_get_pci_vendev(blob, node, &dt_vendor, &dt_device);
225 	if (ret)
226 		return ret;
227 
228 	/* extract the bdf from fdt_pci_addr */
229 	*bdf = addr->phys_hi & 0xffff00;
230 
231 	/* read vendor id & device id based on bdf */
232 	pci_read_config_word(*bdf, PCI_VENDOR_ID, &vendor);
233 	pci_read_config_word(*bdf, PCI_DEVICE_ID, &device);
234 
235 	/*
236 	 * Note there are two places in the device tree to fully describe
237 	 * a pci device: one is via compatible string with a format of
238 	 * "pciVVVV,DDDD" and the other one is the bdf numbers encoded in
239 	 * the device node's reg address property. We read the vendor id
240 	 * and device id based on bdf and compare the values with the
241 	 * "VVVV,DDDD". If they are the same, then we are good to use bdf
242 	 * to read device's bar. But if they are different, we have to rely
243 	 * on the vendor id and device id extracted from the compatible
244 	 * string and locate the real bdf by pci_find_device(). This is
245 	 * because normally we may only know device's device number and
246 	 * function number when writing device tree. The bus number is
247 	 * dynamically assigned during the pci enumeration process.
248 	 */
249 	if ((dt_vendor != vendor) || (dt_device != device)) {
250 		*bdf = pci_find_device(dt_vendor, dt_device, 0);
251 		if (*bdf == -1)
252 			return -ENODEV;
253 	}
254 
255 	return 0;
256 }
257 
258 int fdtdec_get_pci_bar32(const void *blob, int node,
259 		struct fdt_pci_addr *addr, u32 *bar)
260 {
261 	pci_dev_t bdf;
262 	int barnum;
263 	int ret;
264 
265 	/* get pci devices's bdf */
266 	ret = fdtdec_get_pci_bdf(blob, node, addr, &bdf);
267 	if (ret)
268 		return ret;
269 
270 	/* extract the bar number from fdt_pci_addr */
271 	barnum = addr->phys_hi & 0xff;
272 	if ((barnum < PCI_BASE_ADDRESS_0) || (barnum > PCI_CARDBUS_CIS))
273 		return -EINVAL;
274 
275 	barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
276 	*bar = pci_read_bar32(pci_bus_to_hose(PCI_BUS(bdf)), bdf, barnum);
277 
278 	return 0;
279 }
280 #endif
281 
282 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
283 		uint64_t default_val)
284 {
285 	const uint64_t *cell64;
286 	int length;
287 
288 	cell64 = fdt_getprop(blob, node, prop_name, &length);
289 	if (!cell64 || length < sizeof(*cell64))
290 		return default_val;
291 
292 	return fdt64_to_cpu(*cell64);
293 }
294 
295 int fdtdec_get_is_enabled(const void *blob, int node)
296 {
297 	const char *cell;
298 
299 	/*
300 	 * It should say "okay", so only allow that. Some fdts use "ok" but
301 	 * this is a bug. Please fix your device tree source file. See here
302 	 * for discussion:
303 	 *
304 	 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
305 	 */
306 	cell = fdt_getprop(blob, node, "status", NULL);
307 	if (cell)
308 		return 0 == strcmp(cell, "okay");
309 	return 1;
310 }
311 
312 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
313 {
314 	enum fdt_compat_id id;
315 
316 	/* Search our drivers */
317 	for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
318 		if (0 == fdt_node_check_compatible(blob, node,
319 				compat_names[id]))
320 			return id;
321 	return COMPAT_UNKNOWN;
322 }
323 
324 int fdtdec_next_compatible(const void *blob, int node,
325 		enum fdt_compat_id id)
326 {
327 	return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
328 }
329 
330 int fdtdec_next_compatible_subnode(const void *blob, int node,
331 		enum fdt_compat_id id, int *depthp)
332 {
333 	do {
334 		node = fdt_next_node(blob, node, depthp);
335 	} while (*depthp > 1);
336 
337 	/* If this is a direct subnode, and compatible, return it */
338 	if (*depthp == 1 && 0 == fdt_node_check_compatible(
339 						blob, node, compat_names[id]))
340 		return node;
341 
342 	return -FDT_ERR_NOTFOUND;
343 }
344 
345 int fdtdec_next_alias(const void *blob, const char *name,
346 		enum fdt_compat_id id, int *upto)
347 {
348 #define MAX_STR_LEN 20
349 	char str[MAX_STR_LEN + 20];
350 	int node, err;
351 
352 	/* snprintf() is not available */
353 	assert(strlen(name) < MAX_STR_LEN);
354 	sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
355 	node = fdt_path_offset(blob, str);
356 	if (node < 0)
357 		return node;
358 	err = fdt_node_check_compatible(blob, node, compat_names[id]);
359 	if (err < 0)
360 		return err;
361 	if (err)
362 		return -FDT_ERR_NOTFOUND;
363 	(*upto)++;
364 	return node;
365 }
366 
367 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
368 			enum fdt_compat_id id, int *node_list, int maxcount)
369 {
370 	memset(node_list, '\0', sizeof(*node_list) * maxcount);
371 
372 	return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
373 }
374 
375 /* TODO: Can we tighten this code up a little? */
376 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
377 			enum fdt_compat_id id, int *node_list, int maxcount)
378 {
379 	int name_len = strlen(name);
380 	int nodes[maxcount];
381 	int num_found = 0;
382 	int offset, node;
383 	int alias_node;
384 	int count;
385 	int i, j;
386 
387 	/* find the alias node if present */
388 	alias_node = fdt_path_offset(blob, "/aliases");
389 
390 	/*
391 	 * start with nothing, and we can assume that the root node can't
392 	 * match
393 	 */
394 	memset(nodes, '\0', sizeof(nodes));
395 
396 	/* First find all the compatible nodes */
397 	for (node = count = 0; node >= 0 && count < maxcount;) {
398 		node = fdtdec_next_compatible(blob, node, id);
399 		if (node >= 0)
400 			nodes[count++] = node;
401 	}
402 	if (node >= 0)
403 		debug("%s: warning: maxcount exceeded with alias '%s'\n",
404 		       __func__, name);
405 
406 	/* Now find all the aliases */
407 	for (offset = fdt_first_property_offset(blob, alias_node);
408 			offset > 0;
409 			offset = fdt_next_property_offset(blob, offset)) {
410 		const struct fdt_property *prop;
411 		const char *path;
412 		int number;
413 		int found;
414 
415 		node = 0;
416 		prop = fdt_get_property_by_offset(blob, offset, NULL);
417 		path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
418 		if (prop->len && 0 == strncmp(path, name, name_len))
419 			node = fdt_path_offset(blob, prop->data);
420 		if (node <= 0)
421 			continue;
422 
423 		/* Get the alias number */
424 		number = simple_strtoul(path + name_len, NULL, 10);
425 		if (number < 0 || number >= maxcount) {
426 			debug("%s: warning: alias '%s' is out of range\n",
427 			       __func__, path);
428 			continue;
429 		}
430 
431 		/* Make sure the node we found is actually in our list! */
432 		found = -1;
433 		for (j = 0; j < count; j++)
434 			if (nodes[j] == node) {
435 				found = j;
436 				break;
437 			}
438 
439 		if (found == -1) {
440 			debug("%s: warning: alias '%s' points to a node "
441 				"'%s' that is missing or is not compatible "
442 				" with '%s'\n", __func__, path,
443 				fdt_get_name(blob, node, NULL),
444 			       compat_names[id]);
445 			continue;
446 		}
447 
448 		/*
449 		 * Add this node to our list in the right place, and mark
450 		 * it as done.
451 		 */
452 		if (fdtdec_get_is_enabled(blob, node)) {
453 			if (node_list[number]) {
454 				debug("%s: warning: alias '%s' requires that "
455 				      "a node be placed in the list in a "
456 				      "position which is already filled by "
457 				      "node '%s'\n", __func__, path,
458 				      fdt_get_name(blob, node, NULL));
459 				continue;
460 			}
461 			node_list[number] = node;
462 			if (number >= num_found)
463 				num_found = number + 1;
464 		}
465 		nodes[found] = 0;
466 	}
467 
468 	/* Add any nodes not mentioned by an alias */
469 	for (i = j = 0; i < maxcount; i++) {
470 		if (!node_list[i]) {
471 			for (; j < maxcount; j++)
472 				if (nodes[j] &&
473 					fdtdec_get_is_enabled(blob, nodes[j]))
474 					break;
475 
476 			/* Have we run out of nodes to add? */
477 			if (j == maxcount)
478 				break;
479 
480 			assert(!node_list[i]);
481 			node_list[i] = nodes[j++];
482 			if (i >= num_found)
483 				num_found = i + 1;
484 		}
485 	}
486 
487 	return num_found;
488 }
489 
490 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
491 			 int *seqp)
492 {
493 	int base_len = strlen(base);
494 	const char *find_name;
495 	int find_namelen;
496 	int prop_offset;
497 	int aliases;
498 
499 	find_name = fdt_get_name(blob, offset, &find_namelen);
500 	debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
501 
502 	aliases = fdt_path_offset(blob, "/aliases");
503 	for (prop_offset = fdt_first_property_offset(blob, aliases);
504 	     prop_offset > 0;
505 	     prop_offset = fdt_next_property_offset(blob, prop_offset)) {
506 		const char *prop;
507 		const char *name;
508 		const char *slash;
509 		int len, val;
510 
511 		prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
512 		debug("   - %s, %s\n", name, prop);
513 		if (len < find_namelen || *prop != '/' || prop[len - 1] ||
514 		    strncmp(name, base, base_len))
515 			continue;
516 
517 		slash = strrchr(prop, '/');
518 		if (strcmp(slash + 1, find_name))
519 			continue;
520 		val = trailing_strtol(name);
521 		if (val != -1) {
522 			*seqp = val;
523 			debug("Found seq %d\n", *seqp);
524 			return 0;
525 		}
526 	}
527 
528 	debug("Not found\n");
529 	return -ENOENT;
530 }
531 
532 int fdtdec_get_chosen_node(const void *blob, const char *name)
533 {
534 	const char *prop;
535 	int chosen_node;
536 	int len;
537 
538 	if (!blob)
539 		return -FDT_ERR_NOTFOUND;
540 	chosen_node = fdt_path_offset(blob, "/chosen");
541 	prop = fdt_getprop(blob, chosen_node, name, &len);
542 	if (!prop)
543 		return -FDT_ERR_NOTFOUND;
544 	return fdt_path_offset(blob, prop);
545 }
546 
547 int fdtdec_check_fdt(void)
548 {
549 	/*
550 	 * We must have an FDT, but we cannot panic() yet since the console
551 	 * is not ready. So for now, just assert(). Boards which need an early
552 	 * FDT (prior to console ready) will need to make their own
553 	 * arrangements and do their own checks.
554 	 */
555 	assert(!fdtdec_prepare_fdt());
556 	return 0;
557 }
558 
559 /*
560  * This function is a little odd in that it accesses global data. At some
561  * point if the architecture board.c files merge this will make more sense.
562  * Even now, it is common code.
563  */
564 int fdtdec_prepare_fdt(void)
565 {
566 	if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
567 	    fdt_check_header(gd->fdt_blob)) {
568 #ifdef CONFIG_SPL_BUILD
569 		puts("Missing DTB\n");
570 #else
571 		puts("No valid device tree binary found - please append one to U-Boot binary, use u-boot-dtb.bin or define CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
572 # ifdef DEBUG
573 		if (gd->fdt_blob) {
574 			printf("fdt_blob=%p\n", gd->fdt_blob);
575 			print_buffer((ulong)gd->fdt_blob, gd->fdt_blob, 4,
576 				     32, 0);
577 		}
578 # endif
579 #endif
580 		return -1;
581 	}
582 	return 0;
583 }
584 
585 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
586 {
587 	const u32 *phandle;
588 	int lookup;
589 
590 	debug("%s: %s\n", __func__, prop_name);
591 	phandle = fdt_getprop(blob, node, prop_name, NULL);
592 	if (!phandle)
593 		return -FDT_ERR_NOTFOUND;
594 
595 	lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
596 	return lookup;
597 }
598 
599 /**
600  * Look up a property in a node and check that it has a minimum length.
601  *
602  * @param blob		FDT blob
603  * @param node		node to examine
604  * @param prop_name	name of property to find
605  * @param min_len	minimum property length in bytes
606  * @param err		0 if ok, or -FDT_ERR_NOTFOUND if the property is not
607 			found, or -FDT_ERR_BADLAYOUT if not enough data
608  * @return pointer to cell, which is only valid if err == 0
609  */
610 static const void *get_prop_check_min_len(const void *blob, int node,
611 		const char *prop_name, int min_len, int *err)
612 {
613 	const void *cell;
614 	int len;
615 
616 	debug("%s: %s\n", __func__, prop_name);
617 	cell = fdt_getprop(blob, node, prop_name, &len);
618 	if (!cell)
619 		*err = -FDT_ERR_NOTFOUND;
620 	else if (len < min_len)
621 		*err = -FDT_ERR_BADLAYOUT;
622 	else
623 		*err = 0;
624 	return cell;
625 }
626 
627 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
628 		u32 *array, int count)
629 {
630 	const u32 *cell;
631 	int i, err = 0;
632 
633 	debug("%s: %s\n", __func__, prop_name);
634 	cell = get_prop_check_min_len(blob, node, prop_name,
635 				      sizeof(u32) * count, &err);
636 	if (!err) {
637 		for (i = 0; i < count; i++)
638 			array[i] = fdt32_to_cpu(cell[i]);
639 	}
640 	return err;
641 }
642 
643 int fdtdec_get_int_array_count(const void *blob, int node,
644 			       const char *prop_name, u32 *array, int count)
645 {
646 	const u32 *cell;
647 	int len, elems;
648 	int i;
649 
650 	debug("%s: %s\n", __func__, prop_name);
651 	cell = fdt_getprop(blob, node, prop_name, &len);
652 	if (!cell)
653 		return -FDT_ERR_NOTFOUND;
654 	elems = len / sizeof(u32);
655 	if (count > elems)
656 		count = elems;
657 	for (i = 0; i < count; i++)
658 		array[i] = fdt32_to_cpu(cell[i]);
659 
660 	return count;
661 }
662 
663 const u32 *fdtdec_locate_array(const void *blob, int node,
664 			       const char *prop_name, int count)
665 {
666 	const u32 *cell;
667 	int err;
668 
669 	cell = get_prop_check_min_len(blob, node, prop_name,
670 				      sizeof(u32) * count, &err);
671 	return err ? NULL : cell;
672 }
673 
674 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
675 {
676 	const s32 *cell;
677 	int len;
678 
679 	debug("%s: %s\n", __func__, prop_name);
680 	cell = fdt_getprop(blob, node, prop_name, &len);
681 	return cell != NULL;
682 }
683 
684 int fdtdec_parse_phandle_with_args(const void *blob, int src_node,
685 				   const char *list_name,
686 				   const char *cells_name,
687 				   int cell_count, int index,
688 				   struct fdtdec_phandle_args *out_args)
689 {
690 	const __be32 *list, *list_end;
691 	int rc = 0, size, cur_index = 0;
692 	uint32_t count = 0;
693 	int node = -1;
694 	int phandle;
695 
696 	/* Retrieve the phandle list property */
697 	list = fdt_getprop(blob, src_node, list_name, &size);
698 	if (!list)
699 		return -ENOENT;
700 	list_end = list + size / sizeof(*list);
701 
702 	/* Loop over the phandles until all the requested entry is found */
703 	while (list < list_end) {
704 		rc = -EINVAL;
705 		count = 0;
706 
707 		/*
708 		 * If phandle is 0, then it is an empty entry with no
709 		 * arguments.  Skip forward to the next entry.
710 		 */
711 		phandle = be32_to_cpup(list++);
712 		if (phandle) {
713 			/*
714 			 * Find the provider node and parse the #*-cells
715 			 * property to determine the argument length.
716 			 *
717 			 * This is not needed if the cell count is hard-coded
718 			 * (i.e. cells_name not set, but cell_count is set),
719 			 * except when we're going to return the found node
720 			 * below.
721 			 */
722 			if (cells_name || cur_index == index) {
723 				node = fdt_node_offset_by_phandle(blob,
724 								  phandle);
725 				if (!node) {
726 					debug("%s: could not find phandle\n",
727 					      fdt_get_name(blob, src_node,
728 							   NULL));
729 					goto err;
730 				}
731 			}
732 
733 			if (cells_name) {
734 				count = fdtdec_get_int(blob, node, cells_name,
735 						       -1);
736 				if (count == -1) {
737 					debug("%s: could not get %s for %s\n",
738 					      fdt_get_name(blob, src_node,
739 							   NULL),
740 					      cells_name,
741 					      fdt_get_name(blob, node,
742 							   NULL));
743 					goto err;
744 				}
745 			} else {
746 				count = cell_count;
747 			}
748 
749 			/*
750 			 * Make sure that the arguments actually fit in the
751 			 * remaining property data length
752 			 */
753 			if (list + count > list_end) {
754 				debug("%s: arguments longer than property\n",
755 				      fdt_get_name(blob, src_node, NULL));
756 				goto err;
757 			}
758 		}
759 
760 		/*
761 		 * All of the error cases above bail out of the loop, so at
762 		 * this point, the parsing is successful. If the requested
763 		 * index matches, then fill the out_args structure and return,
764 		 * or return -ENOENT for an empty entry.
765 		 */
766 		rc = -ENOENT;
767 		if (cur_index == index) {
768 			if (!phandle)
769 				goto err;
770 
771 			if (out_args) {
772 				int i;
773 
774 				if (count > MAX_PHANDLE_ARGS) {
775 					debug("%s: too many arguments %d\n",
776 					      fdt_get_name(blob, src_node,
777 							   NULL), count);
778 					count = MAX_PHANDLE_ARGS;
779 				}
780 				out_args->node = node;
781 				out_args->args_count = count;
782 				for (i = 0; i < count; i++) {
783 					out_args->args[i] =
784 							be32_to_cpup(list++);
785 				}
786 			}
787 
788 			/* Found it! return success */
789 			return 0;
790 		}
791 
792 		node = -1;
793 		list += count;
794 		cur_index++;
795 	}
796 
797 	/*
798 	 * Result will be one of:
799 	 * -ENOENT : index is for empty phandle
800 	 * -EINVAL : parsing error on data
801 	 * [1..n]  : Number of phandle (count mode; when index = -1)
802 	 */
803 	rc = index < 0 ? cur_index : -ENOENT;
804  err:
805 	return rc;
806 }
807 
808 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
809 		u8 *array, int count)
810 {
811 	const u8 *cell;
812 	int err;
813 
814 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
815 	if (!err)
816 		memcpy(array, cell, count);
817 	return err;
818 }
819 
820 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
821 			     const char *prop_name, int count)
822 {
823 	const u8 *cell;
824 	int err;
825 
826 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
827 	if (err)
828 		return NULL;
829 	return cell;
830 }
831 
832 int fdtdec_get_config_int(const void *blob, const char *prop_name,
833 		int default_val)
834 {
835 	int config_node;
836 
837 	debug("%s: %s\n", __func__, prop_name);
838 	config_node = fdt_path_offset(blob, "/config");
839 	if (config_node < 0)
840 		return default_val;
841 	return fdtdec_get_int(blob, config_node, prop_name, default_val);
842 }
843 
844 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
845 {
846 	int config_node;
847 	const void *prop;
848 
849 	debug("%s: %s\n", __func__, prop_name);
850 	config_node = fdt_path_offset(blob, "/config");
851 	if (config_node < 0)
852 		return 0;
853 	prop = fdt_get_property(blob, config_node, prop_name, NULL);
854 
855 	return prop != NULL;
856 }
857 
858 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
859 {
860 	const char *nodep;
861 	int nodeoffset;
862 	int len;
863 
864 	debug("%s: %s\n", __func__, prop_name);
865 	nodeoffset = fdt_path_offset(blob, "/config");
866 	if (nodeoffset < 0)
867 		return NULL;
868 
869 	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
870 	if (!nodep)
871 		return NULL;
872 
873 	return (char *)nodep;
874 }
875 
876 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
877 			 fdt_addr_t *basep, fdt_size_t *sizep)
878 {
879 	const fdt_addr_t *cell;
880 	int len;
881 
882 	debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
883 	      prop_name);
884 	cell = fdt_getprop(blob, node, prop_name, &len);
885 	if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
886 		debug("cell=%p, len=%d\n", cell, len);
887 		return -1;
888 	}
889 
890 	*basep = fdt_addr_to_cpu(*cell);
891 	*sizep = fdt_size_to_cpu(cell[1]);
892 	debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
893 	      (ulong)*sizep);
894 
895 	return 0;
896 }
897 
898 /**
899  * Read a flash entry from the fdt
900  *
901  * @param blob		FDT blob
902  * @param node		Offset of node to read
903  * @param name		Name of node being read
904  * @param entry		Place to put offset and size of this node
905  * @return 0 if ok, -ve on error
906  */
907 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
908 			   struct fmap_entry *entry)
909 {
910 	const char *prop;
911 	u32 reg[2];
912 
913 	if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
914 		debug("Node '%s' has bad/missing 'reg' property\n", name);
915 		return -FDT_ERR_NOTFOUND;
916 	}
917 	entry->offset = reg[0];
918 	entry->length = reg[1];
919 	entry->used = fdtdec_get_int(blob, node, "used", entry->length);
920 	prop = fdt_getprop(blob, node, "compress", NULL);
921 	entry->compress_algo = prop && !strcmp(prop, "lzo") ?
922 		FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
923 	prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
924 	entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
925 	entry->hash = (uint8_t *)prop;
926 
927 	return 0;
928 }
929 
930 u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
931 {
932 	u64 number = 0;
933 
934 	while (cells--)
935 		number = (number << 32) | fdt32_to_cpu(*ptr++);
936 
937 	return number;
938 }
939 
940 int fdt_get_resource(const void *fdt, int node, const char *property,
941 		     unsigned int index, struct fdt_resource *res)
942 {
943 	const fdt32_t *ptr, *end;
944 	int na, ns, len, parent;
945 	unsigned int i = 0;
946 
947 	parent = fdt_parent_offset(fdt, node);
948 	if (parent < 0)
949 		return parent;
950 
951 	na = fdt_address_cells(fdt, parent);
952 	ns = fdt_size_cells(fdt, parent);
953 
954 	ptr = fdt_getprop(fdt, node, property, &len);
955 	if (!ptr)
956 		return len;
957 
958 	end = ptr + len / sizeof(*ptr);
959 
960 	while (ptr + na + ns <= end) {
961 		if (i == index) {
962 			res->start = res->end = fdtdec_get_number(ptr, na);
963 			res->end += fdtdec_get_number(&ptr[na], ns) - 1;
964 			return 0;
965 		}
966 
967 		ptr += na + ns;
968 		i++;
969 	}
970 
971 	return -FDT_ERR_NOTFOUND;
972 }
973 
974 int fdt_get_named_resource(const void *fdt, int node, const char *property,
975 			   const char *prop_names, const char *name,
976 			   struct fdt_resource *res)
977 {
978 	int index;
979 
980 	index = fdt_find_string(fdt, node, prop_names, name);
981 	if (index < 0)
982 		return index;
983 
984 	return fdt_get_resource(fdt, node, property, index, res);
985 }
986 
987 int fdtdec_decode_memory_region(const void *blob, int config_node,
988 				const char *mem_type, const char *suffix,
989 				fdt_addr_t *basep, fdt_size_t *sizep)
990 {
991 	char prop_name[50];
992 	const char *mem;
993 	fdt_size_t size, offset_size;
994 	fdt_addr_t base, offset;
995 	int node;
996 
997 	if (config_node == -1) {
998 		config_node = fdt_path_offset(blob, "/config");
999 		if (config_node < 0) {
1000 			debug("%s: Cannot find /config node\n", __func__);
1001 			return -ENOENT;
1002 		}
1003 	}
1004 	if (!suffix)
1005 		suffix = "";
1006 
1007 	snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
1008 		 suffix);
1009 	mem = fdt_getprop(blob, config_node, prop_name, NULL);
1010 	if (!mem) {
1011 		debug("%s: No memory type for '%s', using /memory\n", __func__,
1012 		      prop_name);
1013 		mem = "/memory";
1014 	}
1015 
1016 	node = fdt_path_offset(blob, mem);
1017 	if (node < 0) {
1018 		debug("%s: Failed to find node '%s': %s\n", __func__, mem,
1019 		      fdt_strerror(node));
1020 		return -ENOENT;
1021 	}
1022 
1023 	/*
1024 	 * Not strictly correct - the memory may have multiple banks. We just
1025 	 * use the first
1026 	 */
1027 	if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
1028 		debug("%s: Failed to decode memory region %s\n", __func__,
1029 		      mem);
1030 		return -EINVAL;
1031 	}
1032 
1033 	snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1034 		 suffix);
1035 	if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1036 				 &offset_size)) {
1037 		debug("%s: Failed to decode memory region '%s'\n", __func__,
1038 		      prop_name);
1039 		return -EINVAL;
1040 	}
1041 
1042 	*basep = base + offset;
1043 	*sizep = offset_size;
1044 
1045 	return 0;
1046 }
1047 
1048 static int decode_timing_property(const void *blob, int node, const char *name,
1049 				  struct timing_entry *result)
1050 {
1051 	int length, ret = 0;
1052 	const u32 *prop;
1053 
1054 	prop = fdt_getprop(blob, node, name, &length);
1055 	if (!prop) {
1056 		debug("%s: could not find property %s\n",
1057 		      fdt_get_name(blob, node, NULL), name);
1058 		return length;
1059 	}
1060 
1061 	if (length == sizeof(u32)) {
1062 		result->typ = fdtdec_get_int(blob, node, name, 0);
1063 		result->min = result->typ;
1064 		result->max = result->typ;
1065 	} else {
1066 		ret = fdtdec_get_int_array(blob, node, name, &result->min, 3);
1067 	}
1068 
1069 	return ret;
1070 }
1071 
1072 int fdtdec_decode_display_timing(const void *blob, int parent, int index,
1073 				 struct display_timing *dt)
1074 {
1075 	int i, node, timings_node;
1076 	u32 val = 0;
1077 	int ret = 0;
1078 
1079 	timings_node = fdt_subnode_offset(blob, parent, "display-timings");
1080 	if (timings_node < 0)
1081 		return timings_node;
1082 
1083 	for (i = 0, node = fdt_first_subnode(blob, timings_node);
1084 	     node > 0 && i != index;
1085 	     node = fdt_next_subnode(blob, node))
1086 		i++;
1087 
1088 	if (node < 0)
1089 		return node;
1090 
1091 	memset(dt, 0, sizeof(*dt));
1092 
1093 	ret |= decode_timing_property(blob, node, "hback-porch",
1094 				      &dt->hback_porch);
1095 	ret |= decode_timing_property(blob, node, "hfront-porch",
1096 				      &dt->hfront_porch);
1097 	ret |= decode_timing_property(blob, node, "hactive", &dt->hactive);
1098 	ret |= decode_timing_property(blob, node, "hsync-len", &dt->hsync_len);
1099 	ret |= decode_timing_property(blob, node, "vback-porch",
1100 				      &dt->vback_porch);
1101 	ret |= decode_timing_property(blob, node, "vfront-porch",
1102 				      &dt->vfront_porch);
1103 	ret |= decode_timing_property(blob, node, "vactive", &dt->vactive);
1104 	ret |= decode_timing_property(blob, node, "vsync-len", &dt->vsync_len);
1105 	ret |= decode_timing_property(blob, node, "clock-frequency",
1106 				      &dt->pixelclock);
1107 
1108 	dt->flags = 0;
1109 	val = fdtdec_get_int(blob, node, "vsync-active", -1);
1110 	if (val != -1) {
1111 		dt->flags |= val ? DISPLAY_FLAGS_VSYNC_HIGH :
1112 				DISPLAY_FLAGS_VSYNC_LOW;
1113 	}
1114 	val = fdtdec_get_int(blob, node, "hsync-active", -1);
1115 	if (val != -1) {
1116 		dt->flags |= val ? DISPLAY_FLAGS_HSYNC_HIGH :
1117 				DISPLAY_FLAGS_HSYNC_LOW;
1118 	}
1119 	val = fdtdec_get_int(blob, node, "de-active", -1);
1120 	if (val != -1) {
1121 		dt->flags |= val ? DISPLAY_FLAGS_DE_HIGH :
1122 				DISPLAY_FLAGS_DE_LOW;
1123 	}
1124 	val = fdtdec_get_int(blob, node, "pixelclk-active", -1);
1125 	if (val != -1) {
1126 		dt->flags |= val ? DISPLAY_FLAGS_PIXDATA_POSEDGE :
1127 				DISPLAY_FLAGS_PIXDATA_NEGEDGE;
1128 	}
1129 
1130 	if (fdtdec_get_bool(blob, node, "interlaced"))
1131 		dt->flags |= DISPLAY_FLAGS_INTERLACED;
1132 	if (fdtdec_get_bool(blob, node, "doublescan"))
1133 		dt->flags |= DISPLAY_FLAGS_DOUBLESCAN;
1134 	if (fdtdec_get_bool(blob, node, "doubleclk"))
1135 		dt->flags |= DISPLAY_FLAGS_DOUBLECLK;
1136 
1137 	return 0;
1138 }
1139 
1140 int fdtdec_setup(void)
1141 {
1142 #if CONFIG_IS_ENABLED(OF_CONTROL)
1143 # ifdef CONFIG_OF_EMBED
1144 	/* Get a pointer to the FDT */
1145 	gd->fdt_blob = __dtb_dt_begin;
1146 # elif defined CONFIG_OF_SEPARATE
1147 #  ifdef CONFIG_SPL_BUILD
1148 	/* FDT is at end of BSS */
1149 	gd->fdt_blob = (ulong *)&__bss_end;
1150 #  else
1151 	/* FDT is at end of image */
1152 	gd->fdt_blob = (ulong *)&_end;
1153 #  endif
1154 # elif defined(CONFIG_OF_HOSTFILE)
1155 	if (sandbox_read_fdt_from_file()) {
1156 		puts("Failed to read control FDT\n");
1157 		return -1;
1158 	}
1159 # endif
1160 # ifndef CONFIG_SPL_BUILD
1161 	/* Allow the early environment to override the fdt address */
1162 	gd->fdt_blob = (void *)getenv_ulong("fdtcontroladdr", 16,
1163 						(uintptr_t)gd->fdt_blob);
1164 # endif
1165 #endif
1166 	return fdtdec_prepare_fdt();
1167 }
1168 
1169 #endif /* !USE_HOSTCC */
1170