2 * Copyright (c) 2011 The Chromium OS Authors.
3 * See file CREDITS for list of people who contributed to this
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 DECLARE_GLOBAL_DATA_PTR;
32 * Here are the type we know about. One day we might allow drivers to
33 * register. For now we just put them here. The COMPAT macro allows us to
34 * turn this into a sparse list later, and keeps the ID with the name.
36 #define COMPAT(id, name) name
37 static const char * const compat_names[COMPAT_COUNT] = {
38 COMPAT(UNKNOWN, "<none>"),
39 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
40 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
41 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
42 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
43 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
44 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
45 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
46 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
47 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
48 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
49 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
50 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
51 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
52 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
53 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
54 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
55 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
56 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
57 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
58 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
59 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
60 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
63 const char *fdtdec_get_compatible(enum fdt_compat_id id)
65 /* We allow reading of the 'unknown' ID for testing purposes */
66 assert(id >= 0 && id < COMPAT_COUNT);
67 return compat_names[id];
70 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
71 const char *prop_name)
73 const fdt_addr_t *cell;
76 debug("%s: %s: ", __func__, prop_name);
77 cell = fdt_getprop(blob, node, prop_name, &len);
78 if (cell && (len == sizeof(fdt_addr_t) ||
79 len == sizeof(fdt_addr_t) * 2)) {
80 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
82 debug("%p\n", (void *)addr);
85 debug("(not found)\n");
86 return FDT_ADDR_T_NONE;
89 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
95 debug("%s: %s: ", __func__, prop_name);
96 cell = fdt_getprop(blob, node, prop_name, &len);
97 if (cell && len >= sizeof(s32)) {
98 s32 val = fdt32_to_cpu(cell[0]);
100 debug("%#x (%d)\n", val, val);
103 debug("(not found)\n");
107 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
108 uint64_t default_val)
110 const uint64_t *cell64;
113 cell64 = fdt_getprop(blob, node, prop_name, &length);
114 if (!cell64 || length < sizeof(*cell64))
117 return fdt64_to_cpu(*cell64);
120 int fdtdec_get_is_enabled(const void *blob, int node)
125 * It should say "okay", so only allow that. Some fdts use "ok" but
126 * this is a bug. Please fix your device tree source file. See here
129 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
131 cell = fdt_getprop(blob, node, "status", NULL);
133 return 0 == strcmp(cell, "okay");
137 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
139 enum fdt_compat_id id;
141 /* Search our drivers */
142 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
143 if (0 == fdt_node_check_compatible(blob, node,
146 return COMPAT_UNKNOWN;
149 int fdtdec_next_compatible(const void *blob, int node,
150 enum fdt_compat_id id)
152 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
155 int fdtdec_next_compatible_subnode(const void *blob, int node,
156 enum fdt_compat_id id, int *depthp)
159 node = fdt_next_node(blob, node, depthp);
160 } while (*depthp > 1);
162 /* If this is a direct subnode, and compatible, return it */
163 if (*depthp == 1 && 0 == fdt_node_check_compatible(
164 blob, node, compat_names[id]))
167 return -FDT_ERR_NOTFOUND;
170 int fdtdec_next_alias(const void *blob, const char *name,
171 enum fdt_compat_id id, int *upto)
173 #define MAX_STR_LEN 20
174 char str[MAX_STR_LEN + 20];
177 /* snprintf() is not available */
178 assert(strlen(name) < MAX_STR_LEN);
179 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
180 node = fdt_path_offset(blob, str);
183 err = fdt_node_check_compatible(blob, node, compat_names[id]);
187 return -FDT_ERR_NOTFOUND;
192 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
193 enum fdt_compat_id id, int *node_list, int maxcount)
195 memset(node_list, '\0', sizeof(*node_list) * maxcount);
197 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
200 /* TODO: Can we tighten this code up a little? */
201 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
202 enum fdt_compat_id id, int *node_list, int maxcount)
204 int name_len = strlen(name);
212 /* find the alias node if present */
213 alias_node = fdt_path_offset(blob, "/aliases");
216 * start with nothing, and we can assume that the root node can't
219 memset(nodes, '\0', sizeof(nodes));
221 /* First find all the compatible nodes */
222 for (node = count = 0; node >= 0 && count < maxcount;) {
223 node = fdtdec_next_compatible(blob, node, id);
225 nodes[count++] = node;
228 debug("%s: warning: maxcount exceeded with alias '%s'\n",
231 /* Now find all the aliases */
232 for (offset = fdt_first_property_offset(blob, alias_node);
234 offset = fdt_next_property_offset(blob, offset)) {
235 const struct fdt_property *prop;
241 prop = fdt_get_property_by_offset(blob, offset, NULL);
242 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
243 if (prop->len && 0 == strncmp(path, name, name_len))
244 node = fdt_path_offset(blob, prop->data);
248 /* Get the alias number */
249 number = simple_strtoul(path + name_len, NULL, 10);
250 if (number < 0 || number >= maxcount) {
251 debug("%s: warning: alias '%s' is out of range\n",
256 /* Make sure the node we found is actually in our list! */
258 for (j = 0; j < count; j++)
259 if (nodes[j] == node) {
265 debug("%s: warning: alias '%s' points to a node "
266 "'%s' that is missing or is not compatible "
267 " with '%s'\n", __func__, path,
268 fdt_get_name(blob, node, NULL),
274 * Add this node to our list in the right place, and mark
277 if (fdtdec_get_is_enabled(blob, node)) {
278 if (node_list[number]) {
279 debug("%s: warning: alias '%s' requires that "
280 "a node be placed in the list in a "
281 "position which is already filled by "
282 "node '%s'\n", __func__, path,
283 fdt_get_name(blob, node, NULL));
286 node_list[number] = node;
287 if (number >= num_found)
288 num_found = number + 1;
293 /* Add any nodes not mentioned by an alias */
294 for (i = j = 0; i < maxcount; i++) {
296 for (; j < maxcount; j++)
298 fdtdec_get_is_enabled(blob, nodes[j]))
301 /* Have we run out of nodes to add? */
305 assert(!node_list[i]);
306 node_list[i] = nodes[j++];
315 int fdtdec_check_fdt(void)
318 * We must have an FDT, but we cannot panic() yet since the console
319 * is not ready. So for now, just assert(). Boards which need an early
320 * FDT (prior to console ready) will need to make their own
321 * arrangements and do their own checks.
323 assert(!fdtdec_prepare_fdt());
328 * This function is a little odd in that it accesses global data. At some
329 * point if the architecture board.c files merge this will make more sense.
330 * Even now, it is common code.
332 int fdtdec_prepare_fdt(void)
334 if (((uintptr_t)gd->fdt_blob & 3) || fdt_check_header(gd->fdt_blob)) {
335 printf("No valid FDT found - please append one to U-Boot "
336 "binary, use u-boot-dtb.bin or define "
337 "CONFIG_OF_EMBED\n");
343 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
348 debug("%s: %s\n", __func__, prop_name);
349 phandle = fdt_getprop(blob, node, prop_name, NULL);
351 return -FDT_ERR_NOTFOUND;
353 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
358 * Look up a property in a node and check that it has a minimum length.
360 * @param blob FDT blob
361 * @param node node to examine
362 * @param prop_name name of property to find
363 * @param min_len minimum property length in bytes
364 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
365 found, or -FDT_ERR_BADLAYOUT if not enough data
366 * @return pointer to cell, which is only valid if err == 0
368 static const void *get_prop_check_min_len(const void *blob, int node,
369 const char *prop_name, int min_len, int *err)
374 debug("%s: %s\n", __func__, prop_name);
375 cell = fdt_getprop(blob, node, prop_name, &len);
377 *err = -FDT_ERR_NOTFOUND;
378 else if (len < min_len)
379 *err = -FDT_ERR_BADLAYOUT;
385 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
386 u32 *array, int count)
391 debug("%s: %s\n", __func__, prop_name);
392 cell = get_prop_check_min_len(blob, node, prop_name,
393 sizeof(u32) * count, &err);
395 for (i = 0; i < count; i++)
396 array[i] = fdt32_to_cpu(cell[i]);
401 const u32 *fdtdec_locate_array(const void *blob, int node,
402 const char *prop_name, int count)
407 cell = get_prop_check_min_len(blob, node, prop_name,
408 sizeof(u32) * count, &err);
409 return err ? NULL : cell;
412 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
417 debug("%s: %s\n", __func__, prop_name);
418 cell = fdt_getprop(blob, node, prop_name, &len);
423 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
426 * @param blob FDT blob to use
427 * @param node Node to look at
428 * @param prop_name Node property name
429 * @param gpio Array of gpio elements to fill from FDT. This will be
430 * untouched if either 0 or an error is returned
431 * @param max_count Maximum number of elements allowed
432 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
433 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
435 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
436 struct fdt_gpio_state *gpio, int max_count)
438 const struct fdt_property *prop;
443 debug("%s: %s\n", __func__, prop_name);
444 assert(max_count > 0);
445 prop = fdt_get_property(blob, node, prop_name, &len);
447 debug("%s: property '%s' missing\n", __func__, prop_name);
448 return -FDT_ERR_NOTFOUND;
451 /* We will use the name to tag the GPIO */
452 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
453 cell = (u32 *)prop->data;
454 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
455 if (len > max_count) {
456 debug(" %s: too many GPIOs / cells for "
457 "property '%s'\n", __func__, prop_name);
458 return -FDT_ERR_BADLAYOUT;
461 /* Read out the GPIO data from the cells */
462 for (i = 0; i < len; i++, cell += 3) {
463 gpio[i].gpio = fdt32_to_cpu(cell[1]);
464 gpio[i].flags = fdt32_to_cpu(cell[2]);
471 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
472 struct fdt_gpio_state *gpio)
476 debug("%s: %s\n", __func__, prop_name);
477 gpio->gpio = FDT_GPIO_NONE;
479 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
480 return err == 1 ? 0 : err;
483 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
487 if (!fdt_gpio_isvalid(gpio))
490 val = gpio_get_value(gpio->gpio);
491 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
494 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
496 if (!fdt_gpio_isvalid(gpio))
499 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
500 return gpio_set_value(gpio->gpio, val);
503 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
506 * Return success if there is no GPIO defined. This is used for
509 if (!fdt_gpio_isvalid(gpio))
512 if (gpio_request(gpio->gpio, gpio->name))
517 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
518 u8 *array, int count)
523 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
525 memcpy(array, cell, count);
529 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
530 const char *prop_name, int count)
535 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
541 int fdtdec_get_config_int(const void *blob, const char *prop_name,
546 debug("%s: %s\n", __func__, prop_name);
547 config_node = fdt_path_offset(blob, "/config");
550 return fdtdec_get_int(blob, config_node, prop_name, default_val);
553 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
558 debug("%s: %s\n", __func__, prop_name);
559 config_node = fdt_path_offset(blob, "/config");
562 prop = fdt_get_property(blob, config_node, prop_name, NULL);
567 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
573 debug("%s: %s\n", __func__, prop_name);
574 nodeoffset = fdt_path_offset(blob, "/config");
578 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
582 return (char *)nodep;
585 int fdtdec_decode_region(const void *blob, int node,
586 const char *prop_name, void **ptrp, size_t *size)
588 const fdt_addr_t *cell;
591 debug("%s: %s\n", __func__, prop_name);
592 cell = fdt_getprop(blob, node, prop_name, &len);
593 if (!cell || (len != sizeof(fdt_addr_t) * 2))
596 *ptrp = (void *)fdt_addr_to_cpu(*cell);
597 *size = fdt_size_to_cpu(cell[1]);
598 debug("%s: size=%zx\n", __func__, *size);