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