xref: /openbmc/u-boot/lib/fdtdec.c (revision b18c68d8)
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 <linux/ctype.h>
13 
14 #include <asm/gpio.h>
15 
16 DECLARE_GLOBAL_DATA_PTR;
17 
18 /*
19  * Here are the type we know about. One day we might allow drivers to
20  * register. For now we just put them here. The COMPAT macro allows us to
21  * turn this into a sparse list later, and keeps the ID with the name.
22  */
23 #define COMPAT(id, name) name
24 static const char * const compat_names[COMPAT_COUNT] = {
25 	COMPAT(UNKNOWN, "<none>"),
26 	COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
27 	COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
28 	COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
29 	COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
30 	COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
31 	COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
32 	COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
33 	COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
34 	COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
35 	COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
36 	COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
37 	COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
38 	COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
39 	COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
40 	COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
41 	COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
42 	COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
43 	COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
44 	COMPAT(NVIDIA_TEGRA124_PCIE, "nvidia,tegra124-pcie"),
45 	COMPAT(NVIDIA_TEGRA30_PCIE, "nvidia,tegra30-pcie"),
46 	COMPAT(NVIDIA_TEGRA20_PCIE, "nvidia,tegra20-pcie"),
47 	COMPAT(NVIDIA_TEGRA124_XUSB_PADCTL, "nvidia,tegra124-xusb-padctl"),
48 	COMPAT(SMSC_LAN9215, "smsc,lan9215"),
49 	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
50 	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
51 	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
52 	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
53 	COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
54 	COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
55 	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
56 	COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
57 	COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
58 	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
59 	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
60 	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
61 	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
62 	COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
63 	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
64 	COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
65 	COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
66 	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
67 	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
68 	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
69 	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
70 	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
71 	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
72 	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
73 	COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
74 	COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
75 	COMPAT(TI_TPS65090, "ti,tps65090"),
76 	COMPAT(COMPAT_NXP_PTN3460, "nxp,ptn3460"),
77 	COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
78 	COMPAT(PARADE_PS8625, "parade,ps8625"),
79 	COMPAT(COMPAT_INTEL_LPC, "intel,lpc"),
80 	COMPAT(INTEL_MICROCODE, "intel,microcode"),
81 	COMPAT(MEMORY_SPD, "memory-spd"),
82 	COMPAT(INTEL_PANTHERPOINT_AHCI, "intel,pantherpoint-ahci"),
83 	COMPAT(INTEL_MODEL_206AX, "intel,model-206ax"),
84 	COMPAT(INTEL_GMA, "intel,gma"),
85 	COMPAT(AMS_AS3722, "ams,as3722"),
86 	COMPAT(INTEL_ICH_SPI, "intel,ich-spi"),
87 };
88 
89 const char *fdtdec_get_compatible(enum fdt_compat_id id)
90 {
91 	/* We allow reading of the 'unknown' ID for testing purposes */
92 	assert(id >= 0 && id < COMPAT_COUNT);
93 	return compat_names[id];
94 }
95 
96 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
97 		const char *prop_name, fdt_size_t *sizep)
98 {
99 	const fdt_addr_t *cell;
100 	int len;
101 
102 	debug("%s: %s: ", __func__, prop_name);
103 	cell = fdt_getprop(blob, node, prop_name, &len);
104 	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
105 		     len == sizeof(fdt_addr_t) * 2)) {
106 		fdt_addr_t addr = fdt_addr_to_cpu(*cell);
107 		if (sizep) {
108 			const fdt_size_t *size;
109 
110 			size = (fdt_size_t *)((char *)cell +
111 					sizeof(fdt_addr_t));
112 			*sizep = fdt_size_to_cpu(*size);
113 			debug("addr=%08lx, size=%08x\n",
114 			      (ulong)addr, *sizep);
115 		} else {
116 			debug("%08lx\n", (ulong)addr);
117 		}
118 		return addr;
119 	}
120 	debug("(not found)\n");
121 	return FDT_ADDR_T_NONE;
122 }
123 
124 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
125 		const char *prop_name)
126 {
127 	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
128 }
129 
130 #ifdef CONFIG_PCI
131 int fdtdec_get_pci_addr(const void *blob, int node, enum fdt_pci_space type,
132 		const char *prop_name, struct fdt_pci_addr *addr)
133 {
134 	const u32 *cell;
135 	int len;
136 	int ret = -ENOENT;
137 
138 	debug("%s: %s: ", __func__, prop_name);
139 
140 	/*
141 	 * If we follow the pci bus bindings strictly, we should check
142 	 * the value of the node's parent node's #address-cells and
143 	 * #size-cells. They need to be 3 and 2 accordingly. However,
144 	 * for simplicity we skip the check here.
145 	 */
146 	cell = fdt_getprop(blob, node, prop_name, &len);
147 	if (!cell)
148 		goto fail;
149 
150 	if ((len % FDT_PCI_REG_SIZE) == 0) {
151 		int num = len / FDT_PCI_REG_SIZE;
152 		int i;
153 
154 		for (i = 0; i < num; i++) {
155 			debug("pci address #%d: %08lx %08lx %08lx\n", i,
156 			      (ulong)fdt_addr_to_cpu(cell[0]),
157 			      (ulong)fdt_addr_to_cpu(cell[1]),
158 			      (ulong)fdt_addr_to_cpu(cell[2]));
159 			if ((fdt_addr_to_cpu(*cell) & type) == type) {
160 				addr->phys_hi = fdt_addr_to_cpu(cell[0]);
161 				addr->phys_mid = fdt_addr_to_cpu(cell[1]);
162 				addr->phys_lo = fdt_addr_to_cpu(cell[2]);
163 				break;
164 			} else {
165 				cell += (FDT_PCI_ADDR_CELLS +
166 					 FDT_PCI_SIZE_CELLS);
167 			}
168 		}
169 
170 		if (i == num)
171 			goto fail;
172 
173 		return 0;
174 	} else {
175 		ret = -EINVAL;
176 	}
177 
178 fail:
179 	debug("(not found)\n");
180 	return ret;
181 }
182 
183 int fdtdec_get_pci_vendev(const void *blob, int node, u16 *vendor, u16 *device)
184 {
185 	const char *list, *end;
186 	int len;
187 
188 	list = fdt_getprop(blob, node, "compatible", &len);
189 	if (!list)
190 		return -ENOENT;
191 
192 	end = list + len;
193 	while (list < end) {
194 		char *s;
195 
196 		len = strlen(list);
197 		if (len >= strlen("pciVVVV,DDDD")) {
198 			s = strstr(list, "pci");
199 
200 			/*
201 			 * check if the string is something like pciVVVV,DDDD.RR
202 			 * or just pciVVVV,DDDD
203 			 */
204 			if (s && s[7] == ',' &&
205 			    (s[12] == '.' || s[12] == 0)) {
206 				s += 3;
207 				*vendor = simple_strtol(s, NULL, 16);
208 
209 				s += 5;
210 				*device = simple_strtol(s, NULL, 16);
211 
212 				return 0;
213 			}
214 		} else {
215 			list += (len + 1);
216 		}
217 	}
218 
219 	return -ENOENT;
220 }
221 
222 int fdtdec_get_pci_bdf(const void *blob, int node,
223 		struct fdt_pci_addr *addr, pci_dev_t *bdf)
224 {
225 	u16 dt_vendor, dt_device, vendor, device;
226 	int ret;
227 
228 	/* get vendor id & device id from the compatible string */
229 	ret = fdtdec_get_pci_vendev(blob, node, &dt_vendor, &dt_device);
230 	if (ret)
231 		return ret;
232 
233 	/* extract the bdf from fdt_pci_addr */
234 	*bdf = addr->phys_hi & 0xffff00;
235 
236 	/* read vendor id & device id based on bdf */
237 	pci_read_config_word(*bdf, PCI_VENDOR_ID, &vendor);
238 	pci_read_config_word(*bdf, PCI_DEVICE_ID, &device);
239 
240 	/*
241 	 * Note there are two places in the device tree to fully describe
242 	 * a pci device: one is via compatible string with a format of
243 	 * "pciVVVV,DDDD" and the other one is the bdf numbers encoded in
244 	 * the device node's reg address property. We read the vendor id
245 	 * and device id based on bdf and compare the values with the
246 	 * "VVVV,DDDD". If they are the same, then we are good to use bdf
247 	 * to read device's bar. But if they are different, we have to rely
248 	 * on the vendor id and device id extracted from the compatible
249 	 * string and locate the real bdf by pci_find_device(). This is
250 	 * because normally we may only know device's device number and
251 	 * function number when writing device tree. The bus number is
252 	 * dynamically assigned during the pci enumeration process.
253 	 */
254 	if ((dt_vendor != vendor) || (dt_device != device)) {
255 		*bdf = pci_find_device(dt_vendor, dt_device, 0);
256 		if (*bdf == -1)
257 			return -ENODEV;
258 	}
259 
260 	return 0;
261 }
262 
263 int fdtdec_get_pci_bar32(const void *blob, int node,
264 		struct fdt_pci_addr *addr, u32 *bar)
265 {
266 	pci_dev_t bdf;
267 	int barnum;
268 	int ret;
269 
270 	/* get pci devices's bdf */
271 	ret = fdtdec_get_pci_bdf(blob, node, addr, &bdf);
272 	if (ret)
273 		return ret;
274 
275 	/* extract the bar number from fdt_pci_addr */
276 	barnum = addr->phys_hi & 0xff;
277 	if ((barnum < PCI_BASE_ADDRESS_0) || (barnum > PCI_CARDBUS_CIS))
278 		return -EINVAL;
279 
280 	barnum = (barnum - PCI_BASE_ADDRESS_0) / 4;
281 	*bar = pci_read_bar32(pci_bus_to_hose(PCI_BUS(bdf)), bdf, barnum);
282 
283 	return 0;
284 }
285 #endif
286 
287 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
288 		uint64_t default_val)
289 {
290 	const uint64_t *cell64;
291 	int length;
292 
293 	cell64 = fdt_getprop(blob, node, prop_name, &length);
294 	if (!cell64 || length < sizeof(*cell64))
295 		return default_val;
296 
297 	return fdt64_to_cpu(*cell64);
298 }
299 
300 int fdtdec_get_is_enabled(const void *blob, int node)
301 {
302 	const char *cell;
303 
304 	/*
305 	 * It should say "okay", so only allow that. Some fdts use "ok" but
306 	 * this is a bug. Please fix your device tree source file. See here
307 	 * for discussion:
308 	 *
309 	 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
310 	 */
311 	cell = fdt_getprop(blob, node, "status", NULL);
312 	if (cell)
313 		return 0 == strcmp(cell, "okay");
314 	return 1;
315 }
316 
317 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
318 {
319 	enum fdt_compat_id id;
320 
321 	/* Search our drivers */
322 	for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
323 		if (0 == fdt_node_check_compatible(blob, node,
324 				compat_names[id]))
325 			return id;
326 	return COMPAT_UNKNOWN;
327 }
328 
329 int fdtdec_next_compatible(const void *blob, int node,
330 		enum fdt_compat_id id)
331 {
332 	return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
333 }
334 
335 int fdtdec_next_compatible_subnode(const void *blob, int node,
336 		enum fdt_compat_id id, int *depthp)
337 {
338 	do {
339 		node = fdt_next_node(blob, node, depthp);
340 	} while (*depthp > 1);
341 
342 	/* If this is a direct subnode, and compatible, return it */
343 	if (*depthp == 1 && 0 == fdt_node_check_compatible(
344 						blob, node, compat_names[id]))
345 		return node;
346 
347 	return -FDT_ERR_NOTFOUND;
348 }
349 
350 int fdtdec_next_alias(const void *blob, const char *name,
351 		enum fdt_compat_id id, int *upto)
352 {
353 #define MAX_STR_LEN 20
354 	char str[MAX_STR_LEN + 20];
355 	int node, err;
356 
357 	/* snprintf() is not available */
358 	assert(strlen(name) < MAX_STR_LEN);
359 	sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
360 	node = fdt_path_offset(blob, str);
361 	if (node < 0)
362 		return node;
363 	err = fdt_node_check_compatible(blob, node, compat_names[id]);
364 	if (err < 0)
365 		return err;
366 	if (err)
367 		return -FDT_ERR_NOTFOUND;
368 	(*upto)++;
369 	return node;
370 }
371 
372 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
373 			enum fdt_compat_id id, int *node_list, int maxcount)
374 {
375 	memset(node_list, '\0', sizeof(*node_list) * maxcount);
376 
377 	return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
378 }
379 
380 /* TODO: Can we tighten this code up a little? */
381 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
382 			enum fdt_compat_id id, int *node_list, int maxcount)
383 {
384 	int name_len = strlen(name);
385 	int nodes[maxcount];
386 	int num_found = 0;
387 	int offset, node;
388 	int alias_node;
389 	int count;
390 	int i, j;
391 
392 	/* find the alias node if present */
393 	alias_node = fdt_path_offset(blob, "/aliases");
394 
395 	/*
396 	 * start with nothing, and we can assume that the root node can't
397 	 * match
398 	 */
399 	memset(nodes, '\0', sizeof(nodes));
400 
401 	/* First find all the compatible nodes */
402 	for (node = count = 0; node >= 0 && count < maxcount;) {
403 		node = fdtdec_next_compatible(blob, node, id);
404 		if (node >= 0)
405 			nodes[count++] = node;
406 	}
407 	if (node >= 0)
408 		debug("%s: warning: maxcount exceeded with alias '%s'\n",
409 		       __func__, name);
410 
411 	/* Now find all the aliases */
412 	for (offset = fdt_first_property_offset(blob, alias_node);
413 			offset > 0;
414 			offset = fdt_next_property_offset(blob, offset)) {
415 		const struct fdt_property *prop;
416 		const char *path;
417 		int number;
418 		int found;
419 
420 		node = 0;
421 		prop = fdt_get_property_by_offset(blob, offset, NULL);
422 		path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
423 		if (prop->len && 0 == strncmp(path, name, name_len))
424 			node = fdt_path_offset(blob, prop->data);
425 		if (node <= 0)
426 			continue;
427 
428 		/* Get the alias number */
429 		number = simple_strtoul(path + name_len, NULL, 10);
430 		if (number < 0 || number >= maxcount) {
431 			debug("%s: warning: alias '%s' is out of range\n",
432 			       __func__, path);
433 			continue;
434 		}
435 
436 		/* Make sure the node we found is actually in our list! */
437 		found = -1;
438 		for (j = 0; j < count; j++)
439 			if (nodes[j] == node) {
440 				found = j;
441 				break;
442 			}
443 
444 		if (found == -1) {
445 			debug("%s: warning: alias '%s' points to a node "
446 				"'%s' that is missing or is not compatible "
447 				" with '%s'\n", __func__, path,
448 				fdt_get_name(blob, node, NULL),
449 			       compat_names[id]);
450 			continue;
451 		}
452 
453 		/*
454 		 * Add this node to our list in the right place, and mark
455 		 * it as done.
456 		 */
457 		if (fdtdec_get_is_enabled(blob, node)) {
458 			if (node_list[number]) {
459 				debug("%s: warning: alias '%s' requires that "
460 				      "a node be placed in the list in a "
461 				      "position which is already filled by "
462 				      "node '%s'\n", __func__, path,
463 				      fdt_get_name(blob, node, NULL));
464 				continue;
465 			}
466 			node_list[number] = node;
467 			if (number >= num_found)
468 				num_found = number + 1;
469 		}
470 		nodes[found] = 0;
471 	}
472 
473 	/* Add any nodes not mentioned by an alias */
474 	for (i = j = 0; i < maxcount; i++) {
475 		if (!node_list[i]) {
476 			for (; j < maxcount; j++)
477 				if (nodes[j] &&
478 					fdtdec_get_is_enabled(blob, nodes[j]))
479 					break;
480 
481 			/* Have we run out of nodes to add? */
482 			if (j == maxcount)
483 				break;
484 
485 			assert(!node_list[i]);
486 			node_list[i] = nodes[j++];
487 			if (i >= num_found)
488 				num_found = i + 1;
489 		}
490 	}
491 
492 	return num_found;
493 }
494 
495 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
496 			 int *seqp)
497 {
498 	int base_len = strlen(base);
499 	const char *find_name;
500 	int find_namelen;
501 	int prop_offset;
502 	int aliases;
503 
504 	find_name = fdt_get_name(blob, offset, &find_namelen);
505 	debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
506 
507 	aliases = fdt_path_offset(blob, "/aliases");
508 	for (prop_offset = fdt_first_property_offset(blob, aliases);
509 	     prop_offset > 0;
510 	     prop_offset = fdt_next_property_offset(blob, prop_offset)) {
511 		const char *prop;
512 		const char *name;
513 		const char *slash;
514 		const char *p;
515 		int len;
516 
517 		prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
518 		debug("   - %s, %s\n", name, prop);
519 		if (len < find_namelen || *prop != '/' || prop[len - 1] ||
520 		    strncmp(name, base, base_len))
521 			continue;
522 
523 		slash = strrchr(prop, '/');
524 		if (strcmp(slash + 1, find_name))
525 			continue;
526 		for (p = name + strlen(name) - 1; p > name; p--) {
527 			if (!isdigit(*p)) {
528 				*seqp = simple_strtoul(p + 1, NULL, 10);
529 				debug("Found seq %d\n", *seqp);
530 				return 0;
531 			}
532 		}
533 	}
534 
535 	debug("Not found\n");
536 	return -ENOENT;
537 }
538 
539 int fdtdec_get_chosen_node(const void *blob, const char *name)
540 {
541 	const char *prop;
542 	int chosen_node;
543 	int len;
544 
545 	if (!blob)
546 		return -FDT_ERR_NOTFOUND;
547 	chosen_node = fdt_path_offset(blob, "/chosen");
548 	prop = fdt_getprop(blob, chosen_node, name, &len);
549 	if (!prop)
550 		return -FDT_ERR_NOTFOUND;
551 	return fdt_path_offset(blob, prop);
552 }
553 
554 int fdtdec_check_fdt(void)
555 {
556 	/*
557 	 * We must have an FDT, but we cannot panic() yet since the console
558 	 * is not ready. So for now, just assert(). Boards which need an early
559 	 * FDT (prior to console ready) will need to make their own
560 	 * arrangements and do their own checks.
561 	 */
562 	assert(!fdtdec_prepare_fdt());
563 	return 0;
564 }
565 
566 /*
567  * This function is a little odd in that it accesses global data. At some
568  * point if the architecture board.c files merge this will make more sense.
569  * Even now, it is common code.
570  */
571 int fdtdec_prepare_fdt(void)
572 {
573 	if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
574 	    fdt_check_header(gd->fdt_blob)) {
575 		printf("No valid FDT found - please append one to U-Boot "
576 			"binary, use u-boot-dtb.bin or define "
577 			"CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
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 /**
683  * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
684  * terminating item.
685  *
686  * @param blob		FDT blob to use
687  * @param node		Node to look at
688  * @param prop_name	Node property name
689  * @param gpio		Array of gpio elements to fill from FDT. This will be
690  *			untouched if either 0 or an error is returned
691  * @param max_count	Maximum number of elements allowed
692  * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
693  * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
694  */
695 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
696 		struct fdt_gpio_state *gpio, int max_count)
697 {
698 	const struct fdt_property *prop;
699 	const u32 *cell;
700 	const char *name;
701 	int len, i;
702 
703 	debug("%s: %s\n", __func__, prop_name);
704 	assert(max_count > 0);
705 	prop = fdt_get_property(blob, node, prop_name, &len);
706 	if (!prop) {
707 		debug("%s: property '%s' missing\n", __func__, prop_name);
708 		return -FDT_ERR_NOTFOUND;
709 	}
710 
711 	/* We will use the name to tag the GPIO */
712 	name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
713 	cell = (u32 *)prop->data;
714 	len /= sizeof(u32) * 3;		/* 3 cells per GPIO record */
715 	if (len > max_count) {
716 		debug(" %s: too many GPIOs / cells for "
717 			"property '%s'\n", __func__, prop_name);
718 		return -FDT_ERR_BADLAYOUT;
719 	}
720 
721 	/* Read out the GPIO data from the cells */
722 	for (i = 0; i < len; i++, cell += 3) {
723 		gpio[i].gpio = fdt32_to_cpu(cell[1]);
724 		gpio[i].flags = fdt32_to_cpu(cell[2]);
725 		gpio[i].name = name;
726 	}
727 
728 	return len;
729 }
730 
731 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
732 		struct fdt_gpio_state *gpio)
733 {
734 	int err;
735 
736 	debug("%s: %s\n", __func__, prop_name);
737 	gpio->gpio = FDT_GPIO_NONE;
738 	gpio->name = NULL;
739 	err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
740 	return err == 1 ? 0 : err;
741 }
742 
743 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
744 {
745 	int val;
746 
747 	if (!fdt_gpio_isvalid(gpio))
748 		return -1;
749 
750 	val = gpio_get_value(gpio->gpio);
751 	return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
752 }
753 
754 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
755 {
756 	if (!fdt_gpio_isvalid(gpio))
757 		return -1;
758 
759 	val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
760 	return gpio_set_value(gpio->gpio, val);
761 }
762 
763 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
764 {
765 	/*
766 	 * Return success if there is no GPIO defined. This is used for
767 	 * optional GPIOs)
768 	 */
769 	if (!fdt_gpio_isvalid(gpio))
770 		return 0;
771 
772 	if (gpio_request(gpio->gpio, gpio->name))
773 		return -1;
774 	return 0;
775 }
776 
777 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
778 		u8 *array, int count)
779 {
780 	const u8 *cell;
781 	int err;
782 
783 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
784 	if (!err)
785 		memcpy(array, cell, count);
786 	return err;
787 }
788 
789 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
790 			     const char *prop_name, int count)
791 {
792 	const u8 *cell;
793 	int err;
794 
795 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
796 	if (err)
797 		return NULL;
798 	return cell;
799 }
800 
801 int fdtdec_get_config_int(const void *blob, const char *prop_name,
802 		int default_val)
803 {
804 	int config_node;
805 
806 	debug("%s: %s\n", __func__, prop_name);
807 	config_node = fdt_path_offset(blob, "/config");
808 	if (config_node < 0)
809 		return default_val;
810 	return fdtdec_get_int(blob, config_node, prop_name, default_val);
811 }
812 
813 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
814 {
815 	int config_node;
816 	const void *prop;
817 
818 	debug("%s: %s\n", __func__, prop_name);
819 	config_node = fdt_path_offset(blob, "/config");
820 	if (config_node < 0)
821 		return 0;
822 	prop = fdt_get_property(blob, config_node, prop_name, NULL);
823 
824 	return prop != NULL;
825 }
826 
827 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
828 {
829 	const char *nodep;
830 	int nodeoffset;
831 	int len;
832 
833 	debug("%s: %s\n", __func__, prop_name);
834 	nodeoffset = fdt_path_offset(blob, "/config");
835 	if (nodeoffset < 0)
836 		return NULL;
837 
838 	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
839 	if (!nodep)
840 		return NULL;
841 
842 	return (char *)nodep;
843 }
844 
845 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
846 			 fdt_addr_t *basep, fdt_size_t *sizep)
847 {
848 	const fdt_addr_t *cell;
849 	int len;
850 
851 	debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
852 	      prop_name);
853 	cell = fdt_getprop(blob, node, prop_name, &len);
854 	if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
855 		debug("cell=%p, len=%d\n", cell, len);
856 		return -1;
857 	}
858 
859 	*basep = fdt_addr_to_cpu(*cell);
860 	*sizep = fdt_size_to_cpu(cell[1]);
861 	debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
862 	      (ulong)*sizep);
863 
864 	return 0;
865 }
866 
867 /**
868  * Read a flash entry from the fdt
869  *
870  * @param blob		FDT blob
871  * @param node		Offset of node to read
872  * @param name		Name of node being read
873  * @param entry		Place to put offset and size of this node
874  * @return 0 if ok, -ve on error
875  */
876 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
877 			   struct fmap_entry *entry)
878 {
879 	const char *prop;
880 	u32 reg[2];
881 
882 	if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
883 		debug("Node '%s' has bad/missing 'reg' property\n", name);
884 		return -FDT_ERR_NOTFOUND;
885 	}
886 	entry->offset = reg[0];
887 	entry->length = reg[1];
888 	entry->used = fdtdec_get_int(blob, node, "used", entry->length);
889 	prop = fdt_getprop(blob, node, "compress", NULL);
890 	entry->compress_algo = prop && !strcmp(prop, "lzo") ?
891 		FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
892 	prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
893 	entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
894 	entry->hash = (uint8_t *)prop;
895 
896 	return 0;
897 }
898 
899 static u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
900 {
901 	u64 number = 0;
902 
903 	while (cells--)
904 		number = (number << 32) | fdt32_to_cpu(*ptr++);
905 
906 	return number;
907 }
908 
909 int fdt_get_resource(const void *fdt, int node, const char *property,
910 		     unsigned int index, struct fdt_resource *res)
911 {
912 	const fdt32_t *ptr, *end;
913 	int na, ns, len, parent;
914 	unsigned int i = 0;
915 
916 	parent = fdt_parent_offset(fdt, node);
917 	if (parent < 0)
918 		return parent;
919 
920 	na = fdt_address_cells(fdt, parent);
921 	ns = fdt_size_cells(fdt, parent);
922 
923 	ptr = fdt_getprop(fdt, node, property, &len);
924 	if (!ptr)
925 		return len;
926 
927 	end = ptr + len / sizeof(*ptr);
928 
929 	while (ptr + na + ns <= end) {
930 		if (i == index) {
931 			res->start = res->end = fdtdec_get_number(ptr, na);
932 			res->end += fdtdec_get_number(&ptr[na], ns) - 1;
933 			return 0;
934 		}
935 
936 		ptr += na + ns;
937 		i++;
938 	}
939 
940 	return -FDT_ERR_NOTFOUND;
941 }
942 
943 int fdt_get_named_resource(const void *fdt, int node, const char *property,
944 			   const char *prop_names, const char *name,
945 			   struct fdt_resource *res)
946 {
947 	int index;
948 
949 	index = fdt_find_string(fdt, node, prop_names, name);
950 	if (index < 0)
951 		return index;
952 
953 	return fdt_get_resource(fdt, node, property, index, res);
954 }
955 
956 int fdtdec_decode_memory_region(const void *blob, int config_node,
957 				const char *mem_type, const char *suffix,
958 				fdt_addr_t *basep, fdt_size_t *sizep)
959 {
960 	char prop_name[50];
961 	const char *mem;
962 	fdt_size_t size, offset_size;
963 	fdt_addr_t base, offset;
964 	int node;
965 
966 	if (config_node == -1) {
967 		config_node = fdt_path_offset(blob, "/config");
968 		if (config_node < 0) {
969 			debug("%s: Cannot find /config node\n", __func__);
970 			return -ENOENT;
971 		}
972 	}
973 	if (!suffix)
974 		suffix = "";
975 
976 	snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
977 		 suffix);
978 	mem = fdt_getprop(blob, config_node, prop_name, NULL);
979 	if (!mem) {
980 		debug("%s: No memory type for '%s', using /memory\n", __func__,
981 		      prop_name);
982 		mem = "/memory";
983 	}
984 
985 	node = fdt_path_offset(blob, mem);
986 	if (node < 0) {
987 		debug("%s: Failed to find node '%s': %s\n", __func__, mem,
988 		      fdt_strerror(node));
989 		return -ENOENT;
990 	}
991 
992 	/*
993 	 * Not strictly correct - the memory may have multiple banks. We just
994 	 * use the first
995 	 */
996 	if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
997 		debug("%s: Failed to decode memory region %s\n", __func__,
998 		      mem);
999 		return -EINVAL;
1000 	}
1001 
1002 	snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
1003 		 suffix);
1004 	if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
1005 				 &offset_size)) {
1006 		debug("%s: Failed to decode memory region '%s'\n", __func__,
1007 		      prop_name);
1008 		return -EINVAL;
1009 	}
1010 
1011 	*basep = base + offset;
1012 	*sizep = offset_size;
1013 
1014 	return 0;
1015 }
1016 #endif
1017