xref: /openbmc/u-boot/lib/fdtdec.c (revision 84baed2a2bdde3b2bf876d36cc966bd41ac67a6d)
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(SMSC_LAN9215, "smsc,lan9215"),
45 	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
46 	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
47 	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
48 	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
49 	COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
50 	COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
51 	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
52 	COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
53 	COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
54 	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
55 	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
56 	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
57 	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
58 	COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
59 	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
60 	COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
61 	COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
62 	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
63 	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
64 	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
65 	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
66 	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
67 	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
68 	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
69 	COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
70 	COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
71 	COMPAT(TI_TPS65090, "ti,tps65090"),
72 	COMPAT(COMPAT_NXP_PTN3460, "nxp,ptn3460"),
73 	COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
74 	COMPAT(PARADE_PS8625, "parade,ps8625"),
75 	COMPAT(COMPAT_INTEL_LPC, "intel,lpc"),
76 	COMPAT(INTEL_MICROCODE, "intel,microcode"),
77 	COMPAT(MEMORY_SPD, "memory-spd"),
78 };
79 
80 const char *fdtdec_get_compatible(enum fdt_compat_id id)
81 {
82 	/* We allow reading of the 'unknown' ID for testing purposes */
83 	assert(id >= 0 && id < COMPAT_COUNT);
84 	return compat_names[id];
85 }
86 
87 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
88 		const char *prop_name, fdt_size_t *sizep)
89 {
90 	const fdt_addr_t *cell;
91 	int len;
92 
93 	debug("%s: %s: ", __func__, prop_name);
94 	cell = fdt_getprop(blob, node, prop_name, &len);
95 	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
96 		     len == sizeof(fdt_addr_t) * 2)) {
97 		fdt_addr_t addr = fdt_addr_to_cpu(*cell);
98 		if (sizep) {
99 			const fdt_size_t *size;
100 
101 			size = (fdt_size_t *)((char *)cell +
102 					sizeof(fdt_addr_t));
103 			*sizep = fdt_size_to_cpu(*size);
104 			debug("addr=%08lx, size=%08x\n",
105 			      (ulong)addr, *sizep);
106 		} else {
107 			debug("%08lx\n", (ulong)addr);
108 		}
109 		return addr;
110 	}
111 	debug("(not found)\n");
112 	return FDT_ADDR_T_NONE;
113 }
114 
115 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
116 		const char *prop_name)
117 {
118 	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
119 }
120 
121 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
122 		uint64_t default_val)
123 {
124 	const uint64_t *cell64;
125 	int length;
126 
127 	cell64 = fdt_getprop(blob, node, prop_name, &length);
128 	if (!cell64 || length < sizeof(*cell64))
129 		return default_val;
130 
131 	return fdt64_to_cpu(*cell64);
132 }
133 
134 int fdtdec_get_is_enabled(const void *blob, int node)
135 {
136 	const char *cell;
137 
138 	/*
139 	 * It should say "okay", so only allow that. Some fdts use "ok" but
140 	 * this is a bug. Please fix your device tree source file. See here
141 	 * for discussion:
142 	 *
143 	 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
144 	 */
145 	cell = fdt_getprop(blob, node, "status", NULL);
146 	if (cell)
147 		return 0 == strcmp(cell, "okay");
148 	return 1;
149 }
150 
151 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
152 {
153 	enum fdt_compat_id id;
154 
155 	/* Search our drivers */
156 	for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
157 		if (0 == fdt_node_check_compatible(blob, node,
158 				compat_names[id]))
159 			return id;
160 	return COMPAT_UNKNOWN;
161 }
162 
163 int fdtdec_next_compatible(const void *blob, int node,
164 		enum fdt_compat_id id)
165 {
166 	return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
167 }
168 
169 int fdtdec_next_compatible_subnode(const void *blob, int node,
170 		enum fdt_compat_id id, int *depthp)
171 {
172 	do {
173 		node = fdt_next_node(blob, node, depthp);
174 	} while (*depthp > 1);
175 
176 	/* If this is a direct subnode, and compatible, return it */
177 	if (*depthp == 1 && 0 == fdt_node_check_compatible(
178 						blob, node, compat_names[id]))
179 		return node;
180 
181 	return -FDT_ERR_NOTFOUND;
182 }
183 
184 int fdtdec_next_alias(const void *blob, const char *name,
185 		enum fdt_compat_id id, int *upto)
186 {
187 #define MAX_STR_LEN 20
188 	char str[MAX_STR_LEN + 20];
189 	int node, err;
190 
191 	/* snprintf() is not available */
192 	assert(strlen(name) < MAX_STR_LEN);
193 	sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
194 	node = fdt_path_offset(blob, str);
195 	if (node < 0)
196 		return node;
197 	err = fdt_node_check_compatible(blob, node, compat_names[id]);
198 	if (err < 0)
199 		return err;
200 	if (err)
201 		return -FDT_ERR_NOTFOUND;
202 	(*upto)++;
203 	return node;
204 }
205 
206 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
207 			enum fdt_compat_id id, int *node_list, int maxcount)
208 {
209 	memset(node_list, '\0', sizeof(*node_list) * maxcount);
210 
211 	return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
212 }
213 
214 /* TODO: Can we tighten this code up a little? */
215 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
216 			enum fdt_compat_id id, int *node_list, int maxcount)
217 {
218 	int name_len = strlen(name);
219 	int nodes[maxcount];
220 	int num_found = 0;
221 	int offset, node;
222 	int alias_node;
223 	int count;
224 	int i, j;
225 
226 	/* find the alias node if present */
227 	alias_node = fdt_path_offset(blob, "/aliases");
228 
229 	/*
230 	 * start with nothing, and we can assume that the root node can't
231 	 * match
232 	 */
233 	memset(nodes, '\0', sizeof(nodes));
234 
235 	/* First find all the compatible nodes */
236 	for (node = count = 0; node >= 0 && count < maxcount;) {
237 		node = fdtdec_next_compatible(blob, node, id);
238 		if (node >= 0)
239 			nodes[count++] = node;
240 	}
241 	if (node >= 0)
242 		debug("%s: warning: maxcount exceeded with alias '%s'\n",
243 		       __func__, name);
244 
245 	/* Now find all the aliases */
246 	for (offset = fdt_first_property_offset(blob, alias_node);
247 			offset > 0;
248 			offset = fdt_next_property_offset(blob, offset)) {
249 		const struct fdt_property *prop;
250 		const char *path;
251 		int number;
252 		int found;
253 
254 		node = 0;
255 		prop = fdt_get_property_by_offset(blob, offset, NULL);
256 		path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
257 		if (prop->len && 0 == strncmp(path, name, name_len))
258 			node = fdt_path_offset(blob, prop->data);
259 		if (node <= 0)
260 			continue;
261 
262 		/* Get the alias number */
263 		number = simple_strtoul(path + name_len, NULL, 10);
264 		if (number < 0 || number >= maxcount) {
265 			debug("%s: warning: alias '%s' is out of range\n",
266 			       __func__, path);
267 			continue;
268 		}
269 
270 		/* Make sure the node we found is actually in our list! */
271 		found = -1;
272 		for (j = 0; j < count; j++)
273 			if (nodes[j] == node) {
274 				found = j;
275 				break;
276 			}
277 
278 		if (found == -1) {
279 			debug("%s: warning: alias '%s' points to a node "
280 				"'%s' that is missing or is not compatible "
281 				" with '%s'\n", __func__, path,
282 				fdt_get_name(blob, node, NULL),
283 			       compat_names[id]);
284 			continue;
285 		}
286 
287 		/*
288 		 * Add this node to our list in the right place, and mark
289 		 * it as done.
290 		 */
291 		if (fdtdec_get_is_enabled(blob, node)) {
292 			if (node_list[number]) {
293 				debug("%s: warning: alias '%s' requires that "
294 				      "a node be placed in the list in a "
295 				      "position which is already filled by "
296 				      "node '%s'\n", __func__, path,
297 				      fdt_get_name(blob, node, NULL));
298 				continue;
299 			}
300 			node_list[number] = node;
301 			if (number >= num_found)
302 				num_found = number + 1;
303 		}
304 		nodes[found] = 0;
305 	}
306 
307 	/* Add any nodes not mentioned by an alias */
308 	for (i = j = 0; i < maxcount; i++) {
309 		if (!node_list[i]) {
310 			for (; j < maxcount; j++)
311 				if (nodes[j] &&
312 					fdtdec_get_is_enabled(blob, nodes[j]))
313 					break;
314 
315 			/* Have we run out of nodes to add? */
316 			if (j == maxcount)
317 				break;
318 
319 			assert(!node_list[i]);
320 			node_list[i] = nodes[j++];
321 			if (i >= num_found)
322 				num_found = i + 1;
323 		}
324 	}
325 
326 	return num_found;
327 }
328 
329 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
330 			 int *seqp)
331 {
332 	int base_len = strlen(base);
333 	const char *find_name;
334 	int find_namelen;
335 	int prop_offset;
336 	int aliases;
337 
338 	find_name = fdt_get_name(blob, offset, &find_namelen);
339 	debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
340 
341 	aliases = fdt_path_offset(blob, "/aliases");
342 	for (prop_offset = fdt_first_property_offset(blob, aliases);
343 	     prop_offset > 0;
344 	     prop_offset = fdt_next_property_offset(blob, prop_offset)) {
345 		const char *prop;
346 		const char *name;
347 		const char *slash;
348 		const char *p;
349 		int len;
350 
351 		prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
352 		debug("   - %s, %s\n", name, prop);
353 		if (len < find_namelen || *prop != '/' || prop[len - 1] ||
354 		    strncmp(name, base, base_len))
355 			continue;
356 
357 		slash = strrchr(prop, '/');
358 		if (strcmp(slash + 1, find_name))
359 			continue;
360 		for (p = name + strlen(name) - 1; p > name; p--) {
361 			if (!isdigit(*p)) {
362 				*seqp = simple_strtoul(p + 1, NULL, 10);
363 				debug("Found seq %d\n", *seqp);
364 				return 0;
365 			}
366 		}
367 	}
368 
369 	debug("Not found\n");
370 	return -ENOENT;
371 }
372 
373 int fdtdec_get_alias_node(const void *blob, const char *name)
374 {
375 	const char *prop;
376 	int alias_node;
377 	int len;
378 
379 	if (!blob)
380 		return -FDT_ERR_NOTFOUND;
381 	alias_node = fdt_path_offset(blob, "/aliases");
382 	prop = fdt_getprop(blob, alias_node, name, &len);
383 	if (!prop)
384 		return -FDT_ERR_NOTFOUND;
385 	return fdt_path_offset(blob, prop);
386 }
387 
388 int fdtdec_get_chosen_node(const void *blob, const char *name)
389 {
390 	const char *prop;
391 	int chosen_node;
392 	int len;
393 
394 	if (!blob)
395 		return -FDT_ERR_NOTFOUND;
396 	chosen_node = fdt_path_offset(blob, "/chosen");
397 	prop = fdt_getprop(blob, chosen_node, name, &len);
398 	if (!prop)
399 		return -FDT_ERR_NOTFOUND;
400 	return fdt_path_offset(blob, prop);
401 }
402 
403 int fdtdec_check_fdt(void)
404 {
405 	/*
406 	 * We must have an FDT, but we cannot panic() yet since the console
407 	 * is not ready. So for now, just assert(). Boards which need an early
408 	 * FDT (prior to console ready) will need to make their own
409 	 * arrangements and do their own checks.
410 	 */
411 	assert(!fdtdec_prepare_fdt());
412 	return 0;
413 }
414 
415 /*
416  * This function is a little odd in that it accesses global data. At some
417  * point if the architecture board.c files merge this will make more sense.
418  * Even now, it is common code.
419  */
420 int fdtdec_prepare_fdt(void)
421 {
422 	if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
423 	    fdt_check_header(gd->fdt_blob)) {
424 		printf("No valid FDT found - please append one to U-Boot "
425 			"binary, use u-boot-dtb.bin or define "
426 			"CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
427 		return -1;
428 	}
429 	return 0;
430 }
431 
432 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
433 {
434 	const u32 *phandle;
435 	int lookup;
436 
437 	debug("%s: %s\n", __func__, prop_name);
438 	phandle = fdt_getprop(blob, node, prop_name, NULL);
439 	if (!phandle)
440 		return -FDT_ERR_NOTFOUND;
441 
442 	lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
443 	return lookup;
444 }
445 
446 /**
447  * Look up a property in a node and check that it has a minimum length.
448  *
449  * @param blob		FDT blob
450  * @param node		node to examine
451  * @param prop_name	name of property to find
452  * @param min_len	minimum property length in bytes
453  * @param err		0 if ok, or -FDT_ERR_NOTFOUND if the property is not
454 			found, or -FDT_ERR_BADLAYOUT if not enough data
455  * @return pointer to cell, which is only valid if err == 0
456  */
457 static const void *get_prop_check_min_len(const void *blob, int node,
458 		const char *prop_name, int min_len, int *err)
459 {
460 	const void *cell;
461 	int len;
462 
463 	debug("%s: %s\n", __func__, prop_name);
464 	cell = fdt_getprop(blob, node, prop_name, &len);
465 	if (!cell)
466 		*err = -FDT_ERR_NOTFOUND;
467 	else if (len < min_len)
468 		*err = -FDT_ERR_BADLAYOUT;
469 	else
470 		*err = 0;
471 	return cell;
472 }
473 
474 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
475 		u32 *array, int count)
476 {
477 	const u32 *cell;
478 	int i, err = 0;
479 
480 	debug("%s: %s\n", __func__, prop_name);
481 	cell = get_prop_check_min_len(blob, node, prop_name,
482 				      sizeof(u32) * count, &err);
483 	if (!err) {
484 		for (i = 0; i < count; i++)
485 			array[i] = fdt32_to_cpu(cell[i]);
486 	}
487 	return err;
488 }
489 
490 int fdtdec_get_int_array_count(const void *blob, int node,
491 			       const char *prop_name, u32 *array, int count)
492 {
493 	const u32 *cell;
494 	int len, elems;
495 	int i;
496 
497 	debug("%s: %s\n", __func__, prop_name);
498 	cell = fdt_getprop(blob, node, prop_name, &len);
499 	if (!cell)
500 		return -FDT_ERR_NOTFOUND;
501 	elems = len / sizeof(u32);
502 	if (count > elems)
503 		count = elems;
504 	for (i = 0; i < count; i++)
505 		array[i] = fdt32_to_cpu(cell[i]);
506 
507 	return count;
508 }
509 
510 const u32 *fdtdec_locate_array(const void *blob, int node,
511 			       const char *prop_name, int count)
512 {
513 	const u32 *cell;
514 	int err;
515 
516 	cell = get_prop_check_min_len(blob, node, prop_name,
517 				      sizeof(u32) * count, &err);
518 	return err ? NULL : cell;
519 }
520 
521 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
522 {
523 	const s32 *cell;
524 	int len;
525 
526 	debug("%s: %s\n", __func__, prop_name);
527 	cell = fdt_getprop(blob, node, prop_name, &len);
528 	return cell != NULL;
529 }
530 
531 /**
532  * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
533  * terminating item.
534  *
535  * @param blob		FDT blob to use
536  * @param node		Node to look at
537  * @param prop_name	Node property name
538  * @param gpio		Array of gpio elements to fill from FDT. This will be
539  *			untouched if either 0 or an error is returned
540  * @param max_count	Maximum number of elements allowed
541  * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
542  * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
543  */
544 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
545 		struct fdt_gpio_state *gpio, int max_count)
546 {
547 	const struct fdt_property *prop;
548 	const u32 *cell;
549 	const char *name;
550 	int len, i;
551 
552 	debug("%s: %s\n", __func__, prop_name);
553 	assert(max_count > 0);
554 	prop = fdt_get_property(blob, node, prop_name, &len);
555 	if (!prop) {
556 		debug("%s: property '%s' missing\n", __func__, prop_name);
557 		return -FDT_ERR_NOTFOUND;
558 	}
559 
560 	/* We will use the name to tag the GPIO */
561 	name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
562 	cell = (u32 *)prop->data;
563 	len /= sizeof(u32) * 3;		/* 3 cells per GPIO record */
564 	if (len > max_count) {
565 		debug(" %s: too many GPIOs / cells for "
566 			"property '%s'\n", __func__, prop_name);
567 		return -FDT_ERR_BADLAYOUT;
568 	}
569 
570 	/* Read out the GPIO data from the cells */
571 	for (i = 0; i < len; i++, cell += 3) {
572 		gpio[i].gpio = fdt32_to_cpu(cell[1]);
573 		gpio[i].flags = fdt32_to_cpu(cell[2]);
574 		gpio[i].name = name;
575 	}
576 
577 	return len;
578 }
579 
580 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
581 		struct fdt_gpio_state *gpio)
582 {
583 	int err;
584 
585 	debug("%s: %s\n", __func__, prop_name);
586 	gpio->gpio = FDT_GPIO_NONE;
587 	gpio->name = NULL;
588 	err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
589 	return err == 1 ? 0 : err;
590 }
591 
592 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
593 {
594 	int val;
595 
596 	if (!fdt_gpio_isvalid(gpio))
597 		return -1;
598 
599 	val = gpio_get_value(gpio->gpio);
600 	return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
601 }
602 
603 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
604 {
605 	if (!fdt_gpio_isvalid(gpio))
606 		return -1;
607 
608 	val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
609 	return gpio_set_value(gpio->gpio, val);
610 }
611 
612 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
613 {
614 	/*
615 	 * Return success if there is no GPIO defined. This is used for
616 	 * optional GPIOs)
617 	 */
618 	if (!fdt_gpio_isvalid(gpio))
619 		return 0;
620 
621 	if (gpio_request(gpio->gpio, gpio->name))
622 		return -1;
623 	return 0;
624 }
625 
626 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
627 		u8 *array, int count)
628 {
629 	const u8 *cell;
630 	int err;
631 
632 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
633 	if (!err)
634 		memcpy(array, cell, count);
635 	return err;
636 }
637 
638 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
639 			     const char *prop_name, int count)
640 {
641 	const u8 *cell;
642 	int err;
643 
644 	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
645 	if (err)
646 		return NULL;
647 	return cell;
648 }
649 
650 int fdtdec_get_config_int(const void *blob, const char *prop_name,
651 		int default_val)
652 {
653 	int config_node;
654 
655 	debug("%s: %s\n", __func__, prop_name);
656 	config_node = fdt_path_offset(blob, "/config");
657 	if (config_node < 0)
658 		return default_val;
659 	return fdtdec_get_int(blob, config_node, prop_name, default_val);
660 }
661 
662 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
663 {
664 	int config_node;
665 	const void *prop;
666 
667 	debug("%s: %s\n", __func__, prop_name);
668 	config_node = fdt_path_offset(blob, "/config");
669 	if (config_node < 0)
670 		return 0;
671 	prop = fdt_get_property(blob, config_node, prop_name, NULL);
672 
673 	return prop != NULL;
674 }
675 
676 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
677 {
678 	const char *nodep;
679 	int nodeoffset;
680 	int len;
681 
682 	debug("%s: %s\n", __func__, prop_name);
683 	nodeoffset = fdt_path_offset(blob, "/config");
684 	if (nodeoffset < 0)
685 		return NULL;
686 
687 	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
688 	if (!nodep)
689 		return NULL;
690 
691 	return (char *)nodep;
692 }
693 
694 int fdtdec_decode_region(const void *blob, int node, const char *prop_name,
695 			 fdt_addr_t *basep, fdt_size_t *sizep)
696 {
697 	const fdt_addr_t *cell;
698 	int len;
699 
700 	debug("%s: %s: %s\n", __func__, fdt_get_name(blob, node, NULL),
701 	      prop_name);
702 	cell = fdt_getprop(blob, node, prop_name, &len);
703 	if (!cell || (len < sizeof(fdt_addr_t) * 2)) {
704 		debug("cell=%p, len=%d\n", cell, len);
705 		return -1;
706 	}
707 
708 	*basep = fdt_addr_to_cpu(*cell);
709 	*sizep = fdt_size_to_cpu(cell[1]);
710 	debug("%s: base=%08lx, size=%lx\n", __func__, (ulong)*basep,
711 	      (ulong)*sizep);
712 
713 	return 0;
714 }
715 
716 /**
717  * Read a flash entry from the fdt
718  *
719  * @param blob		FDT blob
720  * @param node		Offset of node to read
721  * @param name		Name of node being read
722  * @param entry		Place to put offset and size of this node
723  * @return 0 if ok, -ve on error
724  */
725 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
726 			   struct fmap_entry *entry)
727 {
728 	const char *prop;
729 	u32 reg[2];
730 
731 	if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
732 		debug("Node '%s' has bad/missing 'reg' property\n", name);
733 		return -FDT_ERR_NOTFOUND;
734 	}
735 	entry->offset = reg[0];
736 	entry->length = reg[1];
737 	entry->used = fdtdec_get_int(blob, node, "used", entry->length);
738 	prop = fdt_getprop(blob, node, "compress", NULL);
739 	entry->compress_algo = prop && !strcmp(prop, "lzo") ?
740 		FMAP_COMPRESS_LZO : FMAP_COMPRESS_NONE;
741 	prop = fdt_getprop(blob, node, "hash", &entry->hash_size);
742 	entry->hash_algo = prop ? FMAP_HASH_SHA256 : FMAP_HASH_NONE;
743 	entry->hash = (uint8_t *)prop;
744 
745 	return 0;
746 }
747 
748 static u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
749 {
750 	u64 number = 0;
751 
752 	while (cells--)
753 		number = (number << 32) | fdt32_to_cpu(*ptr++);
754 
755 	return number;
756 }
757 
758 int fdt_get_resource(const void *fdt, int node, const char *property,
759 		     unsigned int index, struct fdt_resource *res)
760 {
761 	const fdt32_t *ptr, *end;
762 	int na, ns, len, parent;
763 	unsigned int i = 0;
764 
765 	parent = fdt_parent_offset(fdt, node);
766 	if (parent < 0)
767 		return parent;
768 
769 	na = fdt_address_cells(fdt, parent);
770 	ns = fdt_size_cells(fdt, parent);
771 
772 	ptr = fdt_getprop(fdt, node, property, &len);
773 	if (!ptr)
774 		return len;
775 
776 	end = ptr + len / sizeof(*ptr);
777 
778 	while (ptr + na + ns <= end) {
779 		if (i == index) {
780 			res->start = res->end = fdtdec_get_number(ptr, na);
781 			res->end += fdtdec_get_number(&ptr[na], ns) - 1;
782 			return 0;
783 		}
784 
785 		ptr += na + ns;
786 		i++;
787 	}
788 
789 	return -FDT_ERR_NOTFOUND;
790 }
791 
792 int fdt_get_named_resource(const void *fdt, int node, const char *property,
793 			   const char *prop_names, const char *name,
794 			   struct fdt_resource *res)
795 {
796 	int index;
797 
798 	index = fdt_find_string(fdt, node, prop_names, name);
799 	if (index < 0)
800 		return index;
801 
802 	return fdt_get_resource(fdt, node, property, index, res);
803 }
804 
805 int fdtdec_pci_get_bdf(const void *fdt, int node, int *bdf)
806 {
807 	const fdt32_t *prop;
808 	int len;
809 
810 	prop = fdt_getprop(fdt, node, "reg", &len);
811 	if (!prop)
812 		return len;
813 
814 	*bdf = fdt32_to_cpu(*prop) & 0xffffff;
815 
816 	return 0;
817 }
818 
819 int fdtdec_decode_memory_region(const void *blob, int config_node,
820 				const char *mem_type, const char *suffix,
821 				fdt_addr_t *basep, fdt_size_t *sizep)
822 {
823 	char prop_name[50];
824 	const char *mem;
825 	fdt_size_t size, offset_size;
826 	fdt_addr_t base, offset;
827 	int node;
828 
829 	if (config_node == -1) {
830 		config_node = fdt_path_offset(blob, "/config");
831 		if (config_node < 0) {
832 			debug("%s: Cannot find /config node\n", __func__);
833 			return -ENOENT;
834 		}
835 	}
836 	if (!suffix)
837 		suffix = "";
838 
839 	snprintf(prop_name, sizeof(prop_name), "%s-memory%s", mem_type,
840 		 suffix);
841 	mem = fdt_getprop(blob, config_node, prop_name, NULL);
842 	if (!mem) {
843 		debug("%s: No memory type for '%s', using /memory\n", __func__,
844 		      prop_name);
845 		mem = "/memory";
846 	}
847 
848 	node = fdt_path_offset(blob, mem);
849 	if (node < 0) {
850 		debug("%s: Failed to find node '%s': %s\n", __func__, mem,
851 		      fdt_strerror(node));
852 		return -ENOENT;
853 	}
854 
855 	/*
856 	 * Not strictly correct - the memory may have multiple banks. We just
857 	 * use the first
858 	 */
859 	if (fdtdec_decode_region(blob, node, "reg", &base, &size)) {
860 		debug("%s: Failed to decode memory region %s\n", __func__,
861 		      mem);
862 		return -EINVAL;
863 	}
864 
865 	snprintf(prop_name, sizeof(prop_name), "%s-offset%s", mem_type,
866 		 suffix);
867 	if (fdtdec_decode_region(blob, config_node, prop_name, &offset,
868 				 &offset_size)) {
869 		debug("%s: Failed to decode memory region '%s'\n", __func__,
870 		      prop_name);
871 		return -EINVAL;
872 	}
873 
874 	*basep = base + offset;
875 	*sizep = offset_size;
876 
877 	return 0;
878 }
879 #endif
880