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