2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
14 DECLARE_GLOBAL_DATA_PTR;
17 * Here are the type we know about. One day we might allow drivers to
18 * register. For now we just put them here. The COMPAT macro allows us to
19 * turn this into a sparse list later, and keeps the ID with the name.
21 #define COMPAT(id, name) name
22 static const char * const compat_names[COMPAT_COUNT] = {
23 COMPAT(UNKNOWN, "<none>"),
24 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
25 COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
26 COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
27 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
28 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
29 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
30 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
31 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
32 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
33 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
34 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
35 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
36 COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
37 COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
38 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
39 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
40 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
41 COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
42 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
43 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
44 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
45 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
46 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
47 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
48 COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
49 COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
50 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
51 COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
52 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
53 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
54 COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
55 COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
56 COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
57 COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
58 COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
59 COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
60 COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
61 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
62 COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
63 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
64 COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
65 COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
66 COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
67 COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
68 COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
71 const char *fdtdec_get_compatible(enum fdt_compat_id id)
73 /* We allow reading of the 'unknown' ID for testing purposes */
74 assert(id >= 0 && id < COMPAT_COUNT);
75 return compat_names[id];
78 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
79 const char *prop_name, fdt_size_t *sizep)
81 const fdt_addr_t *cell;
84 debug("%s: %s: ", __func__, prop_name);
85 cell = fdt_getprop(blob, node, prop_name, &len);
86 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
87 len == sizeof(fdt_addr_t) * 2)) {
88 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
90 const fdt_size_t *size;
92 size = (fdt_size_t *)((char *)cell +
94 *sizep = fdt_size_to_cpu(*size);
95 debug("addr=%08lx, size=%08x\n",
98 debug("%08lx\n", (ulong)addr);
102 debug("(not found)\n");
103 return FDT_ADDR_T_NONE;
106 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
107 const char *prop_name)
109 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
112 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
118 debug("%s: %s: ", __func__, prop_name);
119 cell = fdt_getprop(blob, node, prop_name, &len);
120 if (cell && len >= sizeof(s32)) {
121 s32 val = fdt32_to_cpu(cell[0]);
123 debug("%#x (%d)\n", val, val);
126 debug("(not found)\n");
130 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
131 uint64_t default_val)
133 const uint64_t *cell64;
136 cell64 = fdt_getprop(blob, node, prop_name, &length);
137 if (!cell64 || length < sizeof(*cell64))
140 return fdt64_to_cpu(*cell64);
143 int fdtdec_get_is_enabled(const void *blob, int node)
148 * It should say "okay", so only allow that. Some fdts use "ok" but
149 * this is a bug. Please fix your device tree source file. See here
152 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
154 cell = fdt_getprop(blob, node, "status", NULL);
156 return 0 == strcmp(cell, "okay");
160 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
162 enum fdt_compat_id id;
164 /* Search our drivers */
165 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
166 if (0 == fdt_node_check_compatible(blob, node,
169 return COMPAT_UNKNOWN;
172 int fdtdec_next_compatible(const void *blob, int node,
173 enum fdt_compat_id id)
175 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
178 int fdtdec_next_compatible_subnode(const void *blob, int node,
179 enum fdt_compat_id id, int *depthp)
182 node = fdt_next_node(blob, node, depthp);
183 } while (*depthp > 1);
185 /* If this is a direct subnode, and compatible, return it */
186 if (*depthp == 1 && 0 == fdt_node_check_compatible(
187 blob, node, compat_names[id]))
190 return -FDT_ERR_NOTFOUND;
193 int fdtdec_next_alias(const void *blob, const char *name,
194 enum fdt_compat_id id, int *upto)
196 #define MAX_STR_LEN 20
197 char str[MAX_STR_LEN + 20];
200 /* snprintf() is not available */
201 assert(strlen(name) < MAX_STR_LEN);
202 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
203 node = fdt_path_offset(blob, str);
206 err = fdt_node_check_compatible(blob, node, compat_names[id]);
210 return -FDT_ERR_NOTFOUND;
215 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
216 enum fdt_compat_id id, int *node_list, int maxcount)
218 memset(node_list, '\0', sizeof(*node_list) * maxcount);
220 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
223 /* TODO: Can we tighten this code up a little? */
224 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
225 enum fdt_compat_id id, int *node_list, int maxcount)
227 int name_len = strlen(name);
235 /* find the alias node if present */
236 alias_node = fdt_path_offset(blob, "/aliases");
239 * start with nothing, and we can assume that the root node can't
242 memset(nodes, '\0', sizeof(nodes));
244 /* First find all the compatible nodes */
245 for (node = count = 0; node >= 0 && count < maxcount;) {
246 node = fdtdec_next_compatible(blob, node, id);
248 nodes[count++] = node;
251 debug("%s: warning: maxcount exceeded with alias '%s'\n",
254 /* Now find all the aliases */
255 for (offset = fdt_first_property_offset(blob, alias_node);
257 offset = fdt_next_property_offset(blob, offset)) {
258 const struct fdt_property *prop;
264 prop = fdt_get_property_by_offset(blob, offset, NULL);
265 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
266 if (prop->len && 0 == strncmp(path, name, name_len))
267 node = fdt_path_offset(blob, prop->data);
271 /* Get the alias number */
272 number = simple_strtoul(path + name_len, NULL, 10);
273 if (number < 0 || number >= maxcount) {
274 debug("%s: warning: alias '%s' is out of range\n",
279 /* Make sure the node we found is actually in our list! */
281 for (j = 0; j < count; j++)
282 if (nodes[j] == node) {
288 debug("%s: warning: alias '%s' points to a node "
289 "'%s' that is missing or is not compatible "
290 " with '%s'\n", __func__, path,
291 fdt_get_name(blob, node, NULL),
297 * Add this node to our list in the right place, and mark
300 if (fdtdec_get_is_enabled(blob, node)) {
301 if (node_list[number]) {
302 debug("%s: warning: alias '%s' requires that "
303 "a node be placed in the list in a "
304 "position which is already filled by "
305 "node '%s'\n", __func__, path,
306 fdt_get_name(blob, node, NULL));
309 node_list[number] = node;
310 if (number >= num_found)
311 num_found = number + 1;
316 /* Add any nodes not mentioned by an alias */
317 for (i = j = 0; i < maxcount; i++) {
319 for (; j < maxcount; j++)
321 fdtdec_get_is_enabled(blob, nodes[j]))
324 /* Have we run out of nodes to add? */
328 assert(!node_list[i]);
329 node_list[i] = nodes[j++];
338 int fdtdec_check_fdt(void)
341 * We must have an FDT, but we cannot panic() yet since the console
342 * is not ready. So for now, just assert(). Boards which need an early
343 * FDT (prior to console ready) will need to make their own
344 * arrangements and do their own checks.
346 assert(!fdtdec_prepare_fdt());
351 * This function is a little odd in that it accesses global data. At some
352 * point if the architecture board.c files merge this will make more sense.
353 * Even now, it is common code.
355 int fdtdec_prepare_fdt(void)
357 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
358 fdt_check_header(gd->fdt_blob)) {
359 printf("No valid FDT found - please append one to U-Boot "
360 "binary, use u-boot-dtb.bin or define "
361 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
367 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
372 debug("%s: %s\n", __func__, prop_name);
373 phandle = fdt_getprop(blob, node, prop_name, NULL);
375 return -FDT_ERR_NOTFOUND;
377 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
382 * Look up a property in a node and check that it has a minimum length.
384 * @param blob FDT blob
385 * @param node node to examine
386 * @param prop_name name of property to find
387 * @param min_len minimum property length in bytes
388 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
389 found, or -FDT_ERR_BADLAYOUT if not enough data
390 * @return pointer to cell, which is only valid if err == 0
392 static const void *get_prop_check_min_len(const void *blob, int node,
393 const char *prop_name, int min_len, int *err)
398 debug("%s: %s\n", __func__, prop_name);
399 cell = fdt_getprop(blob, node, prop_name, &len);
401 *err = -FDT_ERR_NOTFOUND;
402 else if (len < min_len)
403 *err = -FDT_ERR_BADLAYOUT;
409 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
410 u32 *array, int count)
415 debug("%s: %s\n", __func__, prop_name);
416 cell = get_prop_check_min_len(blob, node, prop_name,
417 sizeof(u32) * count, &err);
419 for (i = 0; i < count; i++)
420 array[i] = fdt32_to_cpu(cell[i]);
425 const u32 *fdtdec_locate_array(const void *blob, int node,
426 const char *prop_name, int count)
431 cell = get_prop_check_min_len(blob, node, prop_name,
432 sizeof(u32) * count, &err);
433 return err ? NULL : cell;
436 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
441 debug("%s: %s\n", __func__, prop_name);
442 cell = fdt_getprop(blob, node, prop_name, &len);
447 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
450 * @param blob FDT blob to use
451 * @param node Node to look at
452 * @param prop_name Node property name
453 * @param gpio Array of gpio elements to fill from FDT. This will be
454 * untouched if either 0 or an error is returned
455 * @param max_count Maximum number of elements allowed
456 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
457 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
459 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
460 struct fdt_gpio_state *gpio, int max_count)
462 const struct fdt_property *prop;
467 debug("%s: %s\n", __func__, prop_name);
468 assert(max_count > 0);
469 prop = fdt_get_property(blob, node, prop_name, &len);
471 debug("%s: property '%s' missing\n", __func__, prop_name);
472 return -FDT_ERR_NOTFOUND;
475 /* We will use the name to tag the GPIO */
476 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
477 cell = (u32 *)prop->data;
478 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
479 if (len > max_count) {
480 debug(" %s: too many GPIOs / cells for "
481 "property '%s'\n", __func__, prop_name);
482 return -FDT_ERR_BADLAYOUT;
485 /* Read out the GPIO data from the cells */
486 for (i = 0; i < len; i++, cell += 3) {
487 gpio[i].gpio = fdt32_to_cpu(cell[1]);
488 gpio[i].flags = fdt32_to_cpu(cell[2]);
495 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
496 struct fdt_gpio_state *gpio)
500 debug("%s: %s\n", __func__, prop_name);
501 gpio->gpio = FDT_GPIO_NONE;
503 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
504 return err == 1 ? 0 : err;
507 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
511 if (!fdt_gpio_isvalid(gpio))
514 val = gpio_get_value(gpio->gpio);
515 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
518 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
520 if (!fdt_gpio_isvalid(gpio))
523 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
524 return gpio_set_value(gpio->gpio, val);
527 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
530 * Return success if there is no GPIO defined. This is used for
533 if (!fdt_gpio_isvalid(gpio))
536 if (gpio_request(gpio->gpio, gpio->name))
541 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
542 u8 *array, int count)
547 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
549 memcpy(array, cell, count);
553 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
554 const char *prop_name, int count)
559 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
565 int fdtdec_get_config_int(const void *blob, const char *prop_name,
570 debug("%s: %s\n", __func__, prop_name);
571 config_node = fdt_path_offset(blob, "/config");
574 return fdtdec_get_int(blob, config_node, prop_name, default_val);
577 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
582 debug("%s: %s\n", __func__, prop_name);
583 config_node = fdt_path_offset(blob, "/config");
586 prop = fdt_get_property(blob, config_node, prop_name, NULL);
591 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
597 debug("%s: %s\n", __func__, prop_name);
598 nodeoffset = fdt_path_offset(blob, "/config");
602 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
606 return (char *)nodep;
609 int fdtdec_decode_region(const void *blob, int node,
610 const char *prop_name, void **ptrp, size_t *size)
612 const fdt_addr_t *cell;
615 debug("%s: %s\n", __func__, prop_name);
616 cell = fdt_getprop(blob, node, prop_name, &len);
617 if (!cell || (len != sizeof(fdt_addr_t) * 2))
620 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
621 *size = fdt_size_to_cpu(cell[1]);
622 debug("%s: size=%zx\n", __func__, *size);
627 * Read a flash entry from the fdt
629 * @param blob FDT blob
630 * @param node Offset of node to read
631 * @param name Name of node being read
632 * @param entry Place to put offset and size of this node
633 * @return 0 if ok, -ve on error
635 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
636 struct fmap_entry *entry)
640 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
641 debug("Node '%s' has bad/missing 'reg' property\n", name);
642 return -FDT_ERR_NOTFOUND;
644 entry->offset = reg[0];
645 entry->length = reg[1];
651 #include "fdt_support.h"
653 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
659 cell = fdt_getprop_w((void *)blob, node, prop_name, &len);
660 if (cell && len >= sizeof(int)) {
661 int val = fdt32_to_cpu(cell[0]);