[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_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=%p, size=%p\n", (void *)addr,
			      (void *)*sizep);
		} else {
			debug("%p\n", (void *)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 = (void *)fdt_addr_to_cpu(*cell);
	*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"),
f4e4e0b0	35	COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
c9aa831e	36	COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
8f1b46b1	37	COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
b19f5749	38	COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
c3bb3c8b	39	COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
cc9fe33a HR	40	COMPAT(SMSC_LAN9215, "smsc,lan9215"),
cc9fe33a HR	41	COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
c34253d1	42	COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
72dbff12 RS	43	COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
72dbff12 RS	44	COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
5d50659d	45	COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
88364387	46	COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
713cb680	47	COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
6abd1620	48	COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
108b85be	49	COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
6abd1620	50	COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
108b85be	51	COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
618766c0	52	COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
d7377b51	53	COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
1e4706a7	54	COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
45a4d4d3	55	COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
ee1e3c2f	56	COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
cd577e2b	57	COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
bb8215f4	58	COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
7772bb78	59	COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
f6267998	60	COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
ec34fa5e	61	COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
ecbd7e1e	62	COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
b5220bc6 SG	63	};
b5220bc6 SG	64
a53f4a29 SG	65	const char *fdtdec_get_compatible(enum fdt_compat_id id)
	66	{
	67	/* We allow reading of the 'unknown' ID for testing purposes */
	68	assert(id >= 0 && id < COMPAT_COUNT);
	69	return compat_names[id];
	70	}
	71
4397a2a8 SG	72	fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
4397a2a8 SG	73	const char prop_name, fdt_size_t sizep)
b5220bc6 SG	74	{
	75	const fdt_addr_t *cell;
	76	int len;
	77
1cb2323b	78	debug("%s: %s: ", __func__, prop_name);
b5220bc6	79	cell = fdt_getprop(blob, node, prop_name, &len);
4397a2a8 SG	80	if (cell && ((!sizep && len == sizeof(fdt_addr_t)) \|\|
4397a2a8 SG	81	len == sizeof(fdt_addr_t) * 2)) {
1cb2323b	82	fdt_addr_t addr = fdt_addr_to_cpu(*cell);
4397a2a8 SG	83	if (sizep) {
4397a2a8 SG	84	const fdt_size_t *size;
1cb2323b	85
4397a2a8 SG	86	size = (fdt_size_t )((char )cell +
	87	sizeof(fdt_addr_t));
	88	sizep = fdt_size_to_cpu(size);
	89	debug("addr=%p, size=%p\n", (void *)addr,
	90	(void )sizep);
	91	} else {
	92	debug("%p\n", (void *)addr);
	93	}
1cb2323b SG	94	return addr;
	95	}
	96	debug("(not found)\n");
b5220bc6 SG	97	return FDT_ADDR_T_NONE;
	98	}
	99
4397a2a8 SG	100	fdt_addr_t fdtdec_get_addr(const void *blob, int node,
	101	const char *prop_name)
	102	{
	103	return fdtdec_get_addr_size(blob, node, prop_name, NULL);
	104	}
	105
b5220bc6 SG	106	s32 fdtdec_get_int(const void blob, int node, const char prop_name,
	107	s32 default_val)
	108	{
	109	const s32 *cell;
	110	int len;
	111
1cb2323b	112	debug("%s: %s: ", __func__, prop_name);
b5220bc6	113	cell = fdt_getprop(blob, node, prop_name, &len);
1cb2323b SG	114	if (cell && len >= sizeof(s32)) {
	115	s32 val = fdt32_to_cpu(cell[0]);
	116
	117	debug("%#x (%d)\n", val, val);
	118	return val;
	119	}
	120	debug("(not found)\n");
b5220bc6 SG	121	return default_val;
	122	}
	123
aadef0a1 CLC	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
f88fe2de	137	int fdtdec_get_is_enabled(const void *blob, int node)
b5220bc6 SG	138	{
	139	const char *cell;
	140
f88fe2de SG	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	*/
b5220bc6 SG	148	cell = fdt_getprop(blob, node, "status", NULL);
b5220bc6 SG	149	if (cell)
f88fe2de SG	150	return 0 == strcmp(cell, "okay");
f88fe2de SG	151	return 1;
b5220bc6 SG	152	}
b5220bc6 SG	153
7cde397b	154	enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
b5220bc6 SG	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
3ddecfc7 SG	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
b5220bc6 SG	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);
00878476	197	node = fdt_path_offset(blob, str);
b5220bc6 SG	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;
f88fe2de SG	203	if (err)
	204	return -FDT_ERR_NOTFOUND;
	205	(*upto)++;
	206	return node;
b5220bc6 SG	207	}
b5220bc6 SG	208
a53f4a29 SG	209	int fdtdec_find_aliases_for_id(const void blob, const char name,
a53f4a29 SG	210	enum fdt_compat_id id, int *node_list, int maxcount)
c6782270 SG	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)
a53f4a29 SG	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 */
a53f4a29 SG	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)) {
c6782270 SG	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	}
a53f4a29 SG	303	node_list[number] = node;
	304	if (number >= num_found)
	305	num_found = number + 1;
	306	}
c6782270	307	nodes[found] = 0;
a53f4a29 SG	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
9a263e55 SG	332	int fdtdec_check_fdt(void)
	333	{
	334	/*
	335	* We must have an FDT, but we cannot panic() yet since the console
	336	* is not ready. So for now, just assert(). Boards which need an early
	337	* FDT (prior to console ready) will need to make their own
	338	* arrangements and do their own checks.
	339	*/
	340	assert(!fdtdec_prepare_fdt());
	341	return 0;
	342	}
	343
b5220bc6 SG	344	/*
	345	* This function is a little odd in that it accesses global data. At some
	346	* point if the architecture board.c files merge this will make more sense.
	347	* Even now, it is common code.
	348	*/
9a263e55	349	int fdtdec_prepare_fdt(void)
b5220bc6	350	{
c309c2da SG	351	if (!gd->fdt_blob \|\| ((uintptr_t)gd->fdt_blob & 3) \|\|
c309c2da SG	352	fdt_check_header(gd->fdt_blob)) {
9a263e55 SG	353	printf("No valid FDT found - please append one to U-Boot "
9a263e55 SG	354	"binary, use u-boot-dtb.bin or define "
a733b06b	355	"CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
9a263e55 SG	356	return -1;
9a263e55 SG	357	}
b5220bc6 SG	358	return 0;
b5220bc6 SG	359	}
d17da655 SG	360
	361	int fdtdec_lookup_phandle(const void blob, int node, const char prop_name)
	362	{
	363	const u32 *phandle;
	364	int lookup;
	365
1cb2323b	366	debug("%s: %s\n", __func__, prop_name);
d17da655 SG	367	phandle = fdt_getprop(blob, node, prop_name, NULL);
	368	if (!phandle)
	369	return -FDT_ERR_NOTFOUND;
	370
	371	lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
	372	return lookup;
	373	}
	374
	375	/**
	376	* Look up a property in a node and check that it has a minimum length.
	377	*
	378	* @param blob FDT blob
	379	* @param node node to examine
	380	* @param prop_name name of property to find
	381	* @param min_len minimum property length in bytes
	382	* @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
	383	found, or -FDT_ERR_BADLAYOUT if not enough data
	384	* @return pointer to cell, which is only valid if err == 0
	385	*/
	386	static const void get_prop_check_min_len(const void blob, int node,
	387	const char prop_name, int min_len, int err)
	388	{
	389	const void *cell;
	390	int len;
	391
	392	debug("%s: %s\n", __func__, prop_name);
	393	cell = fdt_getprop(blob, node, prop_name, &len);
	394	if (!cell)
	395	*err = -FDT_ERR_NOTFOUND;
	396	else if (len < min_len)
	397	*err = -FDT_ERR_BADLAYOUT;
	398	else
	399	*err = 0;
	400	return cell;
	401	}
	402
	403	int fdtdec_get_int_array(const void blob, int node, const char prop_name,
	404	u32 *array, int count)
	405	{
	406	const u32 *cell;
	407	int i, err = 0;
	408
	409	debug("%s: %s\n", __func__, prop_name);
	410	cell = get_prop_check_min_len(blob, node, prop_name,
	411	sizeof(u32) * count, &err);
	412	if (!err) {
	413	for (i = 0; i < count; i++)
	414	array[i] = fdt32_to_cpu(cell[i]);
	415	}
	416	return err;
	417	}
	418
96875e7d SG	419	const u32 fdtdec_locate_array(const void blob, int node,
	420	const char *prop_name, int count)
	421	{
	422	const u32 *cell;
	423	int err;
	424
	425	cell = get_prop_check_min_len(blob, node, prop_name,
	426	sizeof(u32) * count, &err);
	427	return err ? NULL : cell;
	428	}
	429
d17da655 SG	430	int fdtdec_get_bool(const void blob, int node, const char prop_name)
	431	{
	432	const s32 *cell;
	433	int len;
	434
	435	debug("%s: %s\n", __func__, prop_name);
	436	cell = fdt_getprop(blob, node, prop_name, &len);
	437	return cell != NULL;
	438	}
ed3ee5cd SG	439
	440	/**
	441	* Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
	442	* terminating item.
	443	*
	444	* @param blob FDT blob to use
	445	* @param node Node to look at
	446	* @param prop_name Node property name
	447	* @param gpio Array of gpio elements to fill from FDT. This will be
	448	* untouched if either 0 or an error is returned
	449	* @param max_count Maximum number of elements allowed
	450	* @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
	451	* be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
	452	*/
5921f6a2 AK	453	int fdtdec_decode_gpios(const void blob, int node, const char prop_name,
5921f6a2 AK	454	struct fdt_gpio_state *gpio, int max_count)
ed3ee5cd SG	455	{
	456	const struct fdt_property *prop;
	457	const u32 *cell;
	458	const char *name;
	459	int len, i;
	460
	461	debug("%s: %s\n", __func__, prop_name);
	462	assert(max_count > 0);
	463	prop = fdt_get_property(blob, node, prop_name, &len);
	464	if (!prop) {
1cb2323b	465	debug("%s: property '%s' missing\n", __func__, prop_name);
ed3ee5cd SG	466	return -FDT_ERR_NOTFOUND;
	467	}
	468
	469	/* We will use the name to tag the GPIO */
	470	name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
	471	cell = (u32 *)prop->data;
	472	len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
	473	if (len > max_count) {
1cb2323b	474	debug(" %s: too many GPIOs / cells for "
ed3ee5cd SG	475	"property '%s'\n", __func__, prop_name);
	476	return -FDT_ERR_BADLAYOUT;
	477	}
	478
	479	/* Read out the GPIO data from the cells */
	480	for (i = 0; i < len; i++, cell += 3) {
	481	gpio[i].gpio = fdt32_to_cpu(cell[1]);
	482	gpio[i].flags = fdt32_to_cpu(cell[2]);
	483	gpio[i].name = name;
	484	}
	485
	486	return len;
	487	}
	488
	489	int fdtdec_decode_gpio(const void blob, int node, const char prop_name,
	490	struct fdt_gpio_state *gpio)
	491	{
	492	int err;
	493
	494	debug("%s: %s\n", __func__, prop_name);
	495	gpio->gpio = FDT_GPIO_NONE;
	496	gpio->name = NULL;
	497	err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
	498	return err == 1 ? 0 : err;
	499	}
	500
202ff753 SP	501	int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
	502	{
	503	int val;
	504
	505	if (!fdt_gpio_isvalid(gpio))
	506	return -1;
	507
	508	val = gpio_get_value(gpio->gpio);
	509	return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
	510	}
	511
	512	int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
	513	{
	514	if (!fdt_gpio_isvalid(gpio))
	515	return -1;
	516
	517	val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
	518	return gpio_set_value(gpio->gpio, val);
	519	}
	520
ed3ee5cd SG	521	int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
	522	{
	523	/*
	524	* Return success if there is no GPIO defined. This is used for
	525	* optional GPIOs)
	526	*/
	527	if (!fdt_gpio_isvalid(gpio))
	528	return 0;
	529
	530	if (gpio_request(gpio->gpio, gpio->name))
	531	return -1;
	532	return 0;
	533	}
bed4d892 AS	534
	535	int fdtdec_get_byte_array(const void blob, int node, const char prop_name,
	536	u8 *array, int count)
	537	{
	538	const u8 *cell;
	539	int err;
	540
	541	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	542	if (!err)
	543	memcpy(array, cell, count);
	544	return err;
	545	}
	546
	547	const u8 fdtdec_locate_byte_array(const void blob, int node,
	548	const char *prop_name, int count)
	549	{
	550	const u8 *cell;
	551	int err;
	552
	553	cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
	554	if (err)
	555	return NULL;
	556	return cell;
	557	}
09258f1e	558
09258f1e AK	559	int fdtdec_get_config_int(const void blob, const char prop_name,
	560	int default_val)
	561	{
	562	int config_node;
	563
	564	debug("%s: %s\n", __func__, prop_name);
	565	config_node = fdt_path_offset(blob, "/config");
	566	if (config_node < 0)
	567	return default_val;
	568	return fdtdec_get_int(blob, config_node, prop_name, default_val);
	569	}
332ab0d5	570
79289c0b GB	571	int fdtdec_get_config_bool(const void blob, const char prop_name)
	572	{
	573	int config_node;
	574	const void *prop;
	575
	576	debug("%s: %s\n", __func__, prop_name);
	577	config_node = fdt_path_offset(blob, "/config");
	578	if (config_node < 0)
	579	return 0;
	580	prop = fdt_get_property(blob, config_node, prop_name, NULL);
	581
	582	return prop != NULL;
	583	}
	584
332ab0d5 SG	585	char fdtdec_get_config_string(const void blob, const char *prop_name)
	586	{
	587	const char *nodep;
	588	int nodeoffset;
	589	int len;
	590
	591	debug("%s: %s\n", __func__, prop_name);
	592	nodeoffset = fdt_path_offset(blob, "/config");
	593	if (nodeoffset < 0)
	594	return NULL;
	595
	596	nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
	597	if (!nodep)
	598	return NULL;
	599
	600	return (char *)nodep;
	601	}
f20c4619 SG	602
	603	int fdtdec_decode_region(const void *blob, int node,
	604	const char prop_name, void ptrp, size_t size)
	605	{
	606	const fdt_addr_t *cell;
	607	int len;
	608
	609	debug("%s: %s\n", __func__, prop_name);
	610	cell = fdt_getprop(blob, node, prop_name, &len);
	611	if (!cell \|\| (len != sizeof(fdt_addr_t) * 2))
	612	return -1;
	613
	614	ptrp = (void )fdt_addr_to_cpu(*cell);
	615	*size = fdt_size_to_cpu(cell[1]);
	616	debug("%s: size=%zx\n", __func__, *size);
	617	return 0;
	618	}