[people/ms/u-boot.git] / lib / fdtdec.c

/*
 * Copyright (c) 2011 The Chromium OS Authors.
 * SPDX-License-Identifier:	GPL-2.0+
 */

#include <common.h>
#include <serial.h>
#include <libfdt.h>
#include <fdtdec.h>

#include <asm/gpio.h>

DECLARE_GLOBAL_DATA_PTR;

/*
 * Here are the type we know about. One day we might allow drivers to
 * register. For now we just put them here. The COMPAT macro allows us to
 * turn this into a sparse list later, and keeps the ID with the name.
 */
#define COMPAT(id, name) name
static const char * const compat_names[COMPAT_COUNT] = {
	COMPAT(UNKNOWN, "<none>"),
	COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
	COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
	COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
	COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
	COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
	COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
	COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
	COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
	COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
	COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
	COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
	COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
	COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
	COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
	COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
	COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
	COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
	COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
	COMPAT(SMSC_LAN9215, "smsc,lan9215"),
	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
	COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
	COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
	COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
	COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
	COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
};

const char *fdtdec_get_compatible(enum fdt_compat_id id)
{
	/* We allow reading of the 'unknown' ID for testing purposes */
	assert(id >= 0 && id < COMPAT_COUNT);
	return compat_names[id];
}

fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
		const char *prop_name, fdt_size_t *sizep)
{
	const fdt_addr_t *cell;
	int len;

	debug("%s: %s: ", __func__, prop_name);
	cell = fdt_getprop(blob, node, prop_name, &len);
	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
		     len == sizeof(fdt_addr_t) * 2)) {
		fdt_addr_t addr = fdt_addr_to_cpu(*cell);
		if (sizep) {
			const fdt_size_t *size;

			size = (fdt_size_t *)((char *)cell +
					sizeof(fdt_addr_t));
			*sizep = fdt_size_to_cpu(*size);
			debug("addr=%08lx, size=%08x\n",
			      (ulong)addr, *sizep);
		} else {
			debug("%08lx\n", (ulong)addr);
		}
		return addr;
	}
	debug("(not found)\n");
	return FDT_ADDR_T_NONE;
}

fdt_addr_t fdtdec_get_addr(const void *blob, int node,
		const char *prop_name)
{
	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
}

s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
		s32 default_val)
{
	const s32 *cell;
	int len;

	debug("%s: %s: ", __func__, prop_name);
	cell = fdt_getprop(blob, node, prop_name, &len);
	if (cell && len >= sizeof(s32)) {
		s32 val = fdt32_to_cpu(cell[0]);

		debug("%#x (%d)\n", val, val);
		return val;
	}
	debug("(not found)\n");
	return default_val;
}

uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
		uint64_t default_val)
{
	const uint64_t *cell64;
	int length;

	cell64 = fdt_getprop(blob, node, prop_name, &length);
	if (!cell64 || length < sizeof(*cell64))
		return default_val;

	return fdt64_to_cpu(*cell64);
}

int fdtdec_get_is_enabled(const void *blob, int node)
{
	const char *cell;

	/*
	 * It should say "okay", so only allow that. Some fdts use "ok" but
	 * this is a bug. Please fix your device tree source file. See here
	 * for discussion:
	 *
	 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
	 */
	cell = fdt_getprop(blob, node, "status", NULL);
	if (cell)
		return 0 == strcmp(cell, "okay");
	return 1;
}

enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
{
	enum fdt_compat_id id;

	/* Search our drivers */
	for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
		if (0 == fdt_node_check_compatible(blob, node,
				compat_names[id]))
			return id;
	return COMPAT_UNKNOWN;
}

int fdtdec_next_compatible(const void *blob, int node,
		enum fdt_compat_id id)
{
	return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
}

int fdtdec_next_compatible_subnode(const void *blob, int node,
		enum fdt_compat_id id, int *depthp)
{
	do {
		node = fdt_next_node(blob, node, depthp);
	} while (*depthp > 1);

	/* If this is a direct subnode, and compatible, return it */
	if (*depthp == 1 && 0 == fdt_node_check_compatible(
						blob, node, compat_names[id]))
		return node;

	return -FDT_ERR_NOTFOUND;
}

int fdtdec_next_alias(const void *blob, const char *name,
		enum fdt_compat_id id, int *upto)
{
#define MAX_STR_LEN 20
	char str[MAX_STR_LEN + 20];
	int node, err;

	/* snprintf() is not available */
	assert(strlen(name) < MAX_STR_LEN);
	sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
	node = fdt_path_offset(blob, str);
	if (node < 0)
		return node;
	err = fdt_node_check_compatible(blob, node, compat_names[id]);
	if (err < 0)
		return err;
	if (err)
		return -FDT_ERR_NOTFOUND;
	(*upto)++;
	return node;
}

int fdtdec_find_aliases_for_id(const void *blob, const char *name,
			enum fdt_compat_id id, int *node_list, int maxcount)
{
	memset(node_list, '\0', sizeof(*node_list) * maxcount);

	return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
}

/* TODO: Can we tighten this code up a little? */
int fdtdec_add_aliases_for_id(const void *blob, const char *name,
			enum fdt_compat_id id, int *node_list, int maxcount)
{
	int name_len = strlen(name);
	int nodes[maxcount];
	int num_found = 0;
	int offset, node;
	int alias_node;
	int count;
	int i, j;

	/* find the alias node if present */
	alias_node = fdt_path_offset(blob, "/aliases");

	/*
	 * start with nothing, and we can assume that the root node can't
	 * match
	 */
	memset(nodes, '\0', sizeof(nodes));

	/* First find all the compatible nodes */
	for (node = count = 0; node >= 0 && count < maxcount;) {
		node = fdtdec_next_compatible(blob, node, id);
		if (node >= 0)
			nodes[count++] = node;
	}
	if (node >= 0)
		debug("%s: warning: maxcount exceeded with alias '%s'\n",
		       __func__, name);

	/* Now find all the aliases */
	for (offset = fdt_first_property_offset(blob, alias_node);
			offset > 0;
			offset = fdt_next_property_offset(blob, offset)) {
		const struct fdt_property *prop;
		const char *path;
		int number;
		int found;

		node = 0;
		prop = fdt_get_property_by_offset(blob, offset, NULL);
		path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
		if (prop->len && 0 == strncmp(path, name, name_len))
			node = fdt_path_offset(blob, prop->data);
		if (node <= 0)
			continue;

		/* Get the alias number */
		number = simple_strtoul(path + name_len, NULL, 10);
		if (number < 0 || number >= maxcount) {
			debug("%s: warning: alias '%s' is out of range\n",
			       __func__, path);
			continue;
		}

		/* Make sure the node we found is actually in our list! */
		found = -1;
		for (j = 0; j < count; j++)
			if (nodes[j] == node) {
				found = j;
				break;
			}

		if (found == -1) {
			debug("%s: warning: alias '%s' points to a node "
				"'%s' that is missing or is not compatible "
				" with '%s'\n", __func__, path,
				fdt_get_name(blob, node, NULL),
			       compat_names[id]);
			continue;
		}

		/*
		 * Add this node to our list in the right place, and mark
		 * it as done.
		 */
		if (fdtdec_get_is_enabled(blob, node)) {
			if (node_list[number]) {
				debug("%s: warning: alias '%s' requires that "
				      "a node be placed in the list in a "
				      "position which is already filled by "
				      "node '%s'\n", __func__, path,
				      fdt_get_name(blob, node, NULL));
				continue;
			}
			node_list[number] = node;
			if (number >= num_found)
				num_found = number + 1;
		}
		nodes[found] = 0;
	}

	/* Add any nodes not mentioned by an alias */
	for (i = j = 0; i < maxcount; i++) {
		if (!node_list[i]) {
			for (; j < maxcount; j++)
				if (nodes[j] &&
					fdtdec_get_is_enabled(blob, nodes[j]))
					break;

			/* Have we run out of nodes to add? */
			if (j == maxcount)
				break;

			assert(!node_list[i]);
			node_list[i] = nodes[j++];
			if (i >= num_found)
				num_found = i + 1;
		}
	}

	return num_found;
}

int fdtdec_check_fdt(void)
{
	/*
	 * We must have an FDT, but we cannot panic() yet since the console
	 * is not ready. So for now, just assert(). Boards which need an early
	 * FDT (prior to console ready) will need to make their own
	 * arrangements and do their own checks.
	 */
	assert(!fdtdec_prepare_fdt());
	return 0;
}

/*
 * This function is a little odd in that it accesses global data. At some
 * point if the architecture board.c files merge this will make more sense.
 * Even now, it is common code.
 */
int fdtdec_prepare_fdt(void)
{
	if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
	    fdt_check_header(gd->fdt_blob)) {
		printf("No valid FDT 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");
		return -1;
	}
	return 0;
}

int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
{
	const u32 *phandle;
	int lookup;

	debug("%s: %s\n", __func__, prop_name);
	phandle = fdt_getprop(blob, node, prop_name, NULL);
	if (!phandle)
		return -FDT_ERR_NOTFOUND;

	lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
	return lookup;
}

/**
 * Look up a property in a node and check that it has a minimum length.
 *
 * @param blob		FDT blob
 * @param node		node to examine
 * @param prop_name	name of property to find
 * @param min_len	minimum property length in bytes
 * @param err		0 if ok, or -FDT_ERR_NOTFOUND if the property is not
			found, or -FDT_ERR_BADLAYOUT if not enough data
 * @return pointer to cell, which is only valid if err == 0
 */
static const void *get_prop_check_min_len(const void *blob, int node,
		const char *prop_name, int min_len, int *err)
{
	const void *cell;
	int len;

	debug("%s: %s\n", __func__, prop_name);
	cell = fdt_getprop(blob, node, prop_name, &len);
	if (!cell)
		*err = -FDT_ERR_NOTFOUND;
	else if (len < min_len)
		*err = -FDT_ERR_BADLAYOUT;
	else
		*err = 0;
	return cell;
}

int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
		u32 *array, int count)
{
	const u32 *cell;
	int i, err = 0;

	debug("%s: %s\n", __func__, prop_name);
	cell = get_prop_check_min_len(blob, node, prop_name,
				      sizeof(u32) * count, &err);
	if (!err) {
		for (i = 0; i < count; i++)
			array[i] = fdt32_to_cpu(cell[i]);
	}
	return err;
}

const u32 *fdtdec_locate_array(const void *blob, int node,
			       const char *prop_name, int count)
{
	const u32 *cell;
	int err;

	cell = get_prop_check_min_len(blob, node, prop_name,
				      sizeof(u32) * count, &err);
	return err ? NULL : cell;
}

int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
{
	const s32 *cell;
	int len;

	debug("%s: %s\n", __func__, prop_name);
	cell = fdt_getprop(blob, node, prop_name, &len);
	return cell != NULL;
}

/**
 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
 * terminating item.
 *
 * @param blob		FDT blob to use
 * @param node		Node to look at
 * @param prop_name	Node property name
 * @param gpio		Array of gpio elements to fill from FDT. This will be
 *			untouched if either 0 or an error is returned
 * @param max_count	Maximum number of elements allowed
 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
 */
int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
		struct fdt_gpio_state *gpio, int max_count)
{
	const struct fdt_property *prop;
	const u32 *cell;
	const char *name;
	int len, i;

	debug("%s: %s\n", __func__, prop_name);
	assert(max_count > 0);
	prop = fdt_get_property(blob, node, prop_name, &len);
	if (!prop) {
		debug("%s: property '%s' missing\n", __func__, prop_name);
		return -FDT_ERR_NOTFOUND;
	}

	/* We will use the name to tag the GPIO */
	name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
	cell = (u32 *)prop->data;
	len /= sizeof(u32) * 3;		/* 3 cells per GPIO record */
	if (len > max_count) {
		debug(" %s: too many GPIOs / cells for "
			"property '%s'\n", __func__, prop_name);
		return -FDT_ERR_BADLAYOUT;
	}

	/* Read out the GPIO data from the cells */
	for (i = 0; i < len; i++, cell += 3) {
		gpio[i].gpio = fdt32_to_cpu(cell[1]);
		gpio[i].flags = fdt32_to_cpu(cell[2]);
		gpio[i].name = name;
	}

	return len;
}

int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
		struct fdt_gpio_state *gpio)
{
	int err;

	debug("%s: %s\n", __func__, prop_name);
	gpio->gpio = FDT_GPIO_NONE;
	gpio->name = NULL;
	err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
	return err == 1 ? 0 : err;
}

int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
{
	int val;

	if (!fdt_gpio_isvalid(gpio))
		return -1;

	val = gpio_get_value(gpio->gpio);
	return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
}

int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
{
	if (!fdt_gpio_isvalid(gpio))
		return -1;

	val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
	return gpio_set_value(gpio->gpio, val);
}

int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
{
	/*
	 * Return success if there is no GPIO defined. This is used for
	 * optional GPIOs)
	 */
	if (!fdt_gpio_isvalid(gpio))
		return 0;

	if (gpio_request(gpio->gpio, gpio->name))
		return -1;
	return 0;
}

int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
		u8 *array, int count)
{
	const u8 *cell;
	int err;

	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	if (!err)
		memcpy(array, cell, count);
	return err;
}

const u8 *fdtdec_locate_byte_array(const void *blob, int node,
			     const char *prop_name, int count)
{
	const u8 *cell;
	int err;

	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	if (err)
		return NULL;
	return cell;
}

int fdtdec_get_config_int(const void *blob, const char *prop_name,
		int default_val)
{
	int config_node;

	debug("%s: %s\n", __func__, prop_name);
	config_node = fdt_path_offset(blob, "/config");
	if (config_node < 0)
		return default_val;
	return fdtdec_get_int(blob, config_node, prop_name, default_val);
}

int fdtdec_get_config_bool(const void *blob, const char *prop_name)
{
	int config_node;
	const void *prop;

	debug("%s: %s\n", __func__, prop_name);
	config_node = fdt_path_offset(blob, "/config");
	if (config_node < 0)
		return 0;
	prop = fdt_get_property(blob, config_node, prop_name, NULL);

	return prop != NULL;
}

char *fdtdec_get_config_string(const void *blob, const char *prop_name)
{
	const char *nodep;
	int nodeoffset;
	int len;

	debug("%s: %s\n", __func__, prop_name);
	nodeoffset = fdt_path_offset(blob, "/config");
	if (nodeoffset < 0)
		return NULL;

	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
	if (!nodep)
		return NULL;

	return (char *)nodep;
}

int fdtdec_decode_region(const void *blob, int node,
		const char *prop_name, void **ptrp, size_t *size)
{
	const fdt_addr_t *cell;
	int len;

	debug("%s: %s\n", __func__, prop_name);
	cell = fdt_getprop(blob, node, prop_name, &len);
	if (!cell || (len != sizeof(fdt_addr_t) * 2))
		return -1;

	*ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
	*size = fdt_size_to_cpu(cell[1]);
	debug("%s: size=%zx\n", __func__, *size);
	return 0;
}
Commit	Line	Data
b5220bc6 SG	1	/*
b5220bc6 SG	2	* Copyright (c) 2011 The Chromium OS Authors.
1a459660	3	* SPDX-License-Identifier: GPL-2.0+
b5220bc6 SG	4	*/
	5
	6	#include <common.h>
	7	#include <serial.h>
	8	#include <libfdt.h>
	9	#include <fdtdec.h>
	10
e46431e1	11	#include <asm/gpio.h>
ed3ee5cd	12
b5220bc6 SG	13	DECLARE_GLOBAL_DATA_PTR;
	14
	15	/*
	16	* Here are the type we know about. One day we might allow drivers to
	17	* register. For now we just put them here. The COMPAT macro allows us to
	18	* turn this into a sparse list later, and keeps the ID with the name.
	19	*/
	20	#define COMPAT(id, name) name
	21	static const char * const compat_names[COMPAT_COUNT] = {
f88fe2de	22	COMPAT(UNKNOWN, "<none>"),
87f938c9	23	COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
7e44d932 JL	24	COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
7e44d932 JL	25	COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
e32624ef	26	COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
96a78ac0 YL	27	COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
96a78ac0 YL	28	COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
0e35ad05 JZ	29	COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
0e35ad05 JZ	30	COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
6642a681	31	COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
312693c3	32	COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
e1ae0d1f	33	COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
87540de3	34	COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
a73ca478	35	COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
f4e4e0b0	36	COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
c9aa831e	37	COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
8f1b46b1	38	COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
b19f5749	39	COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
c3bb3c8b	40	COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
cc9fe33a HR	41	COMPAT(SMSC_LAN9215, "smsc,lan9215"),
cc9fe33a HR	42	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
c34253d1	43	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
72dbff12 RS	44	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
72dbff12 RS	45	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
5d50659d	46	COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
88364387	47	COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
713cb680	48	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
6abd1620	49	COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
108b85be	50	COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
6abd1620	51	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
108b85be	52	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
618766c0	53	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
d7377b51	54	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
1e4706a7	55	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
45a4d4d3	56	COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
ee1e3c2f	57	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
cd577e2b	58	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
bb8215f4	59	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
7772bb78	60	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
f6267998	61	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
ec34fa5e	62	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
ecbd7e1e	63	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
b5220bc6 SG	64	};
b5220bc6 SG	65
a53f4a29 SG	66	const char *fdtdec_get_compatible(enum fdt_compat_id id)
	67	{
	68	/* We allow reading of the 'unknown' ID for testing purposes */
	69	assert(id >= 0 && id < COMPAT_COUNT);
	70	return compat_names[id];
	71	}
	72
4397a2a8 SG	73	fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
4397a2a8 SG	74	const char prop_name, fdt_size_t sizep)
b5220bc6 SG	75	{
	76	const fdt_addr_t *cell;
	77	int len;
	78
1cb2323b	79	debug("%s: %s: ", __func__, prop_name);
b5220bc6	80	cell = fdt_getprop(blob, node, prop_name, &len);
4397a2a8 SG	81	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) \|\|
4397a2a8 SG	82	len == sizeof(fdt_addr_t) * 2)) {
1cb2323b	83	fdt_addr_t addr = fdt_addr_to_cpu(*cell);
4397a2a8 SG	84	if (sizep) {
4397a2a8 SG	85	const fdt_size_t *size;
1cb2323b	86
4397a2a8 SG	87	size = (fdt_size_t )((char )cell +
	88	sizeof(fdt_addr_t));
	89	sizep = fdt_size_to_cpu(size);
370b6c5c SG	90	debug("addr=%08lx, size=%08x\n",
370b6c5c SG	91	(ulong)addr, *sizep);
4397a2a8	92	} else {
370b6c5c	93	debug("%08lx\n", (ulong)addr);
4397a2a8	94	}
1cb2323b SG	95	return addr;
	96	}
	97	debug("(not found)\n");
b5220bc6 SG	98	return FDT_ADDR_T_NONE;
	99	}
	100
4397a2a8 SG	101	fdt_addr_t fdtdec_get_addr(const void *blob, int node,
	102	const char *prop_name)
	103	{
	104	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
	105	}
	106
b5220bc6 SG	107	s32 fdtdec_get_int(const void blob, int node, const char prop_name,
	108	s32 default_val)
	109	{
	110	const s32 *cell;
	111	int len;
	112
1cb2323b	113	debug("%s: %s: ", __func__, prop_name);
b5220bc6	114	cell = fdt_getprop(blob, node, prop_name, &len);
1cb2323b SG	115	if (cell && len >= sizeof(s32)) {
	116	s32 val = fdt32_to_cpu(cell[0]);
	117
	118	debug("%#x (%d)\n", val, val);
	119	return val;
	120	}
	121	debug("(not found)\n");
b5220bc6 SG	122	return default_val;
	123	}
	124
aadef0a1 CLC	125	uint64_t fdtdec_get_uint64(const void blob, int node, const char prop_name,
	126	uint64_t default_val)
	127	{
	128	const uint64_t *cell64;
	129	int length;
	130
	131	cell64 = fdt_getprop(blob, node, prop_name, &length);
	132	if (!cell64 \|\| length < sizeof(*cell64))
	133	return default_val;
	134
	135	return fdt64_to_cpu(*cell64);
	136	}
	137
f88fe2de	138	int fdtdec_get_is_enabled(const void *blob, int node)
b5220bc6 SG	139	{
	140	const char *cell;
	141
f88fe2de SG	142	/*
	143	* It should say "okay", so only allow that. Some fdts use "ok" but
	144	* this is a bug. Please fix your device tree source file. See here
	145	* for discussion:
	146	*
	147	* http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
	148	*/
b5220bc6 SG	149	cell = fdt_getprop(blob, node, "status", NULL);
b5220bc6 SG	150	if (cell)
f88fe2de SG	151	return 0 == strcmp(cell, "okay");
f88fe2de SG	152	return 1;
b5220bc6 SG	153	}
b5220bc6 SG	154
7cde397b	155	enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
b5220bc6 SG	156	{
	157	enum fdt_compat_id id;
	158
	159	/* Search our drivers */
	160	for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
	161	if (0 == fdt_node_check_compatible(blob, node,
	162	compat_names[id]))
	163	return id;
	164	return COMPAT_UNKNOWN;
	165	}
	166
	167	int fdtdec_next_compatible(const void *blob, int node,
	168	enum fdt_compat_id id)
	169	{
	170	return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
	171	}
	172
3ddecfc7 SG	173	int fdtdec_next_compatible_subnode(const void *blob, int node,
	174	enum fdt_compat_id id, int *depthp)
	175	{
	176	do {
	177	node = fdt_next_node(blob, node, depthp);
	178	} while (*depthp > 1);
	179
	180	/* If this is a direct subnode, and compatible, return it */
	181	if (*depthp == 1 && 0 == fdt_node_check_compatible(
	182	blob, node, compat_names[id]))
	183	return node;
	184
	185	return -FDT_ERR_NOTFOUND;
	186	}
	187
b5220bc6 SG	188	int fdtdec_next_alias(const void blob, const char name,
	189	enum fdt_compat_id id, int *upto)
	190	{
	191	#define MAX_STR_LEN 20
	192	char str[MAX_STR_LEN + 20];
	193	int node, err;
	194
	195	/* snprintf() is not available */
	196	assert(strlen(name) < MAX_STR_LEN);
	197	sprintf(str, "%.s%d", MAX_STR_LEN, name, upto);
00878476	198	node = fdt_path_offset(blob, str);
b5220bc6 SG	199	if (node < 0)
	200	return node;
	201	err = fdt_node_check_compatible(blob, node, compat_names[id]);
	202	if (err < 0)
	203	return err;
f88fe2de SG	204	if (err)
	205	return -FDT_ERR_NOTFOUND;
	206	(*upto)++;
	207	return node;
b5220bc6 SG	208	}
b5220bc6 SG	209
a53f4a29 SG	210	int fdtdec_find_aliases_for_id(const void blob, const char name,
a53f4a29 SG	211	enum fdt_compat_id id, int *node_list, int maxcount)
c6782270 SG	212	{
	213	memset(node_list, '\0', sizeof(node_list) maxcount);
	214
	215	return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
	216	}
	217
	218	/* TODO: Can we tighten this code up a little? */
	219	int fdtdec_add_aliases_for_id(const void blob, const char name,
	220	enum fdt_compat_id id, int *node_list, int maxcount)
a53f4a29 SG	221	{
	222	int name_len = strlen(name);
	223	int nodes[maxcount];
	224	int num_found = 0;
	225	int offset, node;
	226	int alias_node;
	227	int count;
	228	int i, j;
	229
	230	/* find the alias node if present */
	231	alias_node = fdt_path_offset(blob, "/aliases");
	232
	233	/*
	234	* start with nothing, and we can assume that the root node can't
	235	* match
	236	*/
	237	memset(nodes, '\0', sizeof(nodes));
	238
	239	/* First find all the compatible nodes */
	240	for (node = count = 0; node >= 0 && count < maxcount;) {
	241	node = fdtdec_next_compatible(blob, node, id);
	242	if (node >= 0)
	243	nodes[count++] = node;
	244	}
	245	if (node >= 0)
	246	debug("%s: warning: maxcount exceeded with alias '%s'\n",
	247	__func__, name);
	248
	249	/* Now find all the aliases */
a53f4a29 SG	250	for (offset = fdt_first_property_offset(blob, alias_node);
	251	offset > 0;
	252	offset = fdt_next_property_offset(blob, offset)) {
	253	const struct fdt_property *prop;
	254	const char *path;
	255	int number;
	256	int found;
	257
	258	node = 0;
	259	prop = fdt_get_property_by_offset(blob, offset, NULL);
	260	path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
	261	if (prop->len && 0 == strncmp(path, name, name_len))
	262	node = fdt_path_offset(blob, prop->data);
	263	if (node <= 0)
	264	continue;
	265
	266	/* Get the alias number */
	267	number = simple_strtoul(path + name_len, NULL, 10);
	268	if (number < 0 \|\| number >= maxcount) {
	269	debug("%s: warning: alias '%s' is out of range\n",
	270	__func__, path);
	271	continue;
	272	}
	273
	274	/* Make sure the node we found is actually in our list! */
	275	found = -1;
	276	for (j = 0; j < count; j++)
	277	if (nodes[j] == node) {
	278	found = j;
	279	break;
	280	}
	281
	282	if (found == -1) {
	283	debug("%s: warning: alias '%s' points to a node "
	284	"'%s' that is missing or is not compatible "
	285	" with '%s'\n", __func__, path,
	286	fdt_get_name(blob, node, NULL),
	287	compat_names[id]);
	288	continue;
	289	}
	290
	291	/*
	292	* Add this node to our list in the right place, and mark
	293	* it as done.
	294	*/
	295	if (fdtdec_get_is_enabled(blob, node)) {
c6782270 SG	296	if (node_list[number]) {
	297	debug("%s: warning: alias '%s' requires that "
	298	"a node be placed in the list in a "
	299	"position which is already filled by "
	300	"node '%s'\n", __func__, path,
	301	fdt_get_name(blob, node, NULL));
	302	continue;
	303	}
a53f4a29 SG	304	node_list[number] = node;
	305	if (number >= num_found)
	306	num_found = number + 1;
	307	}
c6782270	308	nodes[found] = 0;
a53f4a29 SG	309	}
	310
	311	/* Add any nodes not mentioned by an alias */
	312	for (i = j = 0; i < maxcount; i++) {
	313	if (!node_list[i]) {
	314	for (; j < maxcount; j++)
	315	if (nodes[j] &&
	316	fdtdec_get_is_enabled(blob, nodes[j]))
	317	break;
	318
	319	/* Have we run out of nodes to add? */
	320	if (j == maxcount)
	321	break;
	322
	323	assert(!node_list[i]);
	324	node_list[i] = nodes[j++];
	325	if (i >= num_found)
	326	num_found = i + 1;
	327	}
	328	}
	329
	330	return num_found;
	331	}
	332
9a263e55 SG	333	int fdtdec_check_fdt(void)
	334	{
	335	/*
	336	* We must have an FDT, but we cannot panic() yet since the console
	337	* is not ready. So for now, just assert(). Boards which need an early
	338	* FDT (prior to console ready) will need to make their own
	339	* arrangements and do their own checks.
	340	*/
	341	assert(!fdtdec_prepare_fdt());
	342	return 0;
	343	}
	344
b5220bc6 SG	345	/*
	346	* This function is a little odd in that it accesses global data. At some
	347	* point if the architecture board.c files merge this will make more sense.
	348	* Even now, it is common code.
	349	*/
9a263e55	350	int fdtdec_prepare_fdt(void)
b5220bc6	351	{
c309c2da SG	352	if (!gd->fdt_blob \|\| ((uintptr_t)gd->fdt_blob & 3) \|\|
c309c2da SG	353	fdt_check_header(gd->fdt_blob)) {
9a263e55 SG	354	printf("No valid FDT found - please append one to U-Boot "
9a263e55 SG	355	"binary, use u-boot-dtb.bin or define "
a733b06b	356	"CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
9a263e55 SG	357	return -1;
9a263e55 SG	358	}
b5220bc6 SG	359	return 0;
b5220bc6 SG	360	}
d17da655 SG	361
	362	int fdtdec_lookup_phandle(const void blob, int node, const char prop_name)
	363	{
	364	const u32 *phandle;
	365	int lookup;
	366
1cb2323b	367	debug("%s: %s\n", __func__, prop_name);
d17da655 SG	368	phandle = fdt_getprop(blob, node, prop_name, NULL);
	369	if (!phandle)
	370	return -FDT_ERR_NOTFOUND;
	371
	372	lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
	373	return lookup;
	374	}
	375
	376	/**
	377	* Look up a property in a node and check that it has a minimum length.
	378	*
	379	* @param blob FDT blob
	380	* @param node node to examine
	381	* @param prop_name name of property to find
	382	* @param min_len minimum property length in bytes
	383	* @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
	384	found, or -FDT_ERR_BADLAYOUT if not enough data
	385	* @return pointer to cell, which is only valid if err == 0
	386	*/
	387	static const void get_prop_check_min_len(const void blob, int node,
	388	const char prop_name, int min_len, int err)
	389	{
	390	const void *cell;
	391	int len;
	392
	393	debug("%s: %s\n", __func__, prop_name);
	394	cell = fdt_getprop(blob, node, prop_name, &len);
	395	if (!cell)
	396	*err = -FDT_ERR_NOTFOUND;
	397	else if (len < min_len)
	398	*err = -FDT_ERR_BADLAYOUT;
	399	else
	400	*err = 0;
	401	return cell;
	402	}
	403
	404	int fdtdec_get_int_array(const void blob, int node, const char prop_name,
	405	u32 *array, int count)
	406	{
	407	const u32 *cell;
	408	int i, err = 0;
	409
	410	debug("%s: %s\n", __func__, prop_name);
	411	cell = get_prop_check_min_len(blob, node, prop_name,
	412	sizeof(u32) * count, &err);
	413	if (!err) {
	414	for (i = 0; i < count; i++)
	415	array[i] = fdt32_to_cpu(cell[i]);
	416	}
	417	return err;
	418	}
	419
96875e7d SG	420	const u32 fdtdec_locate_array(const void blob, int node,
	421	const char *prop_name, int count)
	422	{
	423	const u32 *cell;
	424	int err;
	425
	426	cell = get_prop_check_min_len(blob, node, prop_name,
	427	sizeof(u32) * count, &err);
	428	return err ? NULL : cell;
	429	}
	430
d17da655 SG	431	int fdtdec_get_bool(const void blob, int node, const char prop_name)
	432	{
	433	const s32 *cell;
	434	int len;
	435
	436	debug("%s: %s\n", __func__, prop_name);
	437	cell = fdt_getprop(blob, node, prop_name, &len);
	438	return cell != NULL;
	439	}
ed3ee5cd SG	440
	441	/**
	442	* Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
	443	* terminating item.
	444	*
	445	* @param blob FDT blob to use
	446	* @param node Node to look at
	447	* @param prop_name Node property name
	448	* @param gpio Array of gpio elements to fill from FDT. This will be
	449	* untouched if either 0 or an error is returned
	450	* @param max_count Maximum number of elements allowed
	451	* @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
	452	* be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
	453	*/
5921f6a2 AK	454	int fdtdec_decode_gpios(const void blob, int node, const char prop_name,
5921f6a2 AK	455	struct fdt_gpio_state *gpio, int max_count)
ed3ee5cd SG	456	{
	457	const struct fdt_property *prop;
	458	const u32 *cell;
	459	const char *name;
	460	int len, i;
	461
	462	debug("%s: %s\n", __func__, prop_name);
	463	assert(max_count > 0);
	464	prop = fdt_get_property(blob, node, prop_name, &len);
	465	if (!prop) {
1cb2323b	466	debug("%s: property '%s' missing\n", __func__, prop_name);
ed3ee5cd SG	467	return -FDT_ERR_NOTFOUND;
	468	}
	469
	470	/* We will use the name to tag the GPIO */
	471	name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
	472	cell = (u32 *)prop->data;
	473	len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
	474	if (len > max_count) {
1cb2323b	475	debug(" %s: too many GPIOs / cells for "
ed3ee5cd SG	476	"property '%s'\n", __func__, prop_name);
	477	return -FDT_ERR_BADLAYOUT;
	478	}
	479
	480	/* Read out the GPIO data from the cells */
	481	for (i = 0; i < len; i++, cell += 3) {
	482	gpio[i].gpio = fdt32_to_cpu(cell[1]);
	483	gpio[i].flags = fdt32_to_cpu(cell[2]);
	484	gpio[i].name = name;
	485	}
	486
	487	return len;
	488	}
	489
	490	int fdtdec_decode_gpio(const void blob, int node, const char prop_name,
	491	struct fdt_gpio_state *gpio)
	492	{
	493	int err;
	494
	495	debug("%s: %s\n", __func__, prop_name);
	496	gpio->gpio = FDT_GPIO_NONE;
	497	gpio->name = NULL;
	498	err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
	499	return err == 1 ? 0 : err;
	500	}
	501
202ff753 SP	502	int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
	503	{
	504	int val;
	505
	506	if (!fdt_gpio_isvalid(gpio))
	507	return -1;
	508
	509	val = gpio_get_value(gpio->gpio);
	510	return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
	511	}
	512
	513	int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
	514	{
	515	if (!fdt_gpio_isvalid(gpio))
	516	return -1;
	517
	518	val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
	519	return gpio_set_value(gpio->gpio, val);
	520	}
	521
ed3ee5cd SG	522	int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
	523	{
	524	/*
	525	* Return success if there is no GPIO defined. This is used for
	526	* optional GPIOs)
	527	*/
	528	if (!fdt_gpio_isvalid(gpio))
	529	return 0;
	530
	531	if (gpio_request(gpio->gpio, gpio->name))
	532	return -1;
	533	return 0;
	534	}
bed4d892 AS	535
	536	int fdtdec_get_byte_array(const void blob, int node, const char prop_name,
	537	u8 *array, int count)
	538	{
	539	const u8 *cell;
	540	int err;
	541
	542	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	543	if (!err)
	544	memcpy(array, cell, count);
	545	return err;
	546	}
	547
	548	const u8 fdtdec_locate_byte_array(const void blob, int node,
	549	const char *prop_name, int count)
	550	{
	551	const u8 *cell;
	552	int err;
	553
	554	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	555	if (err)
	556	return NULL;
	557	return cell;
	558	}
09258f1e	559
09258f1e AK	560	int fdtdec_get_config_int(const void blob, const char prop_name,
	561	int default_val)
	562	{
	563	int config_node;
	564
	565	debug("%s: %s\n", __func__, prop_name);
	566	config_node = fdt_path_offset(blob, "/config");
	567	if (config_node < 0)
	568	return default_val;
	569	return fdtdec_get_int(blob, config_node, prop_name, default_val);
	570	}
332ab0d5	571
79289c0b GB	572	int fdtdec_get_config_bool(const void blob, const char prop_name)
	573	{
	574	int config_node;
	575	const void *prop;
	576
	577	debug("%s: %s\n", __func__, prop_name);
	578	config_node = fdt_path_offset(blob, "/config");
	579	if (config_node < 0)
	580	return 0;
	581	prop = fdt_get_property(blob, config_node, prop_name, NULL);
	582
	583	return prop != NULL;
	584	}
	585
332ab0d5 SG	586	char fdtdec_get_config_string(const void blob, const char *prop_name)
	587	{
	588	const char *nodep;
	589	int nodeoffset;
	590	int len;
	591
	592	debug("%s: %s\n", __func__, prop_name);
	593	nodeoffset = fdt_path_offset(blob, "/config");
	594	if (nodeoffset < 0)
	595	return NULL;
	596
	597	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
	598	if (!nodep)
	599	return NULL;
	600
	601	return (char *)nodep;
	602	}
f20c4619 SG	603
	604	int fdtdec_decode_region(const void *blob, int node,
	605	const char prop_name, void ptrp, size_t size)
	606	{
	607	const fdt_addr_t *cell;
	608	int len;
	609
	610	debug("%s: %s\n", __func__, prop_name);
	611	cell = fdt_getprop(blob, node, prop_name, &len);
	612	if (!cell \|\| (len != sizeof(fdt_addr_t) * 2))
	613	return -1;
	614
370b6c5c	615	ptrp = map_sysmem(fdt_addr_to_cpu(cell), *size);
f20c4619 SG	616	*size = fdt_size_to_cpu(cell[1]);
	617	debug("%s: size=%zx\n", __func__, *size);
	618	return 0;
	619	}