2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
13 DECLARE_GLOBAL_DATA_PTR;
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.
20 #define COMPAT(id, name) name
21 static const char * const compat_names[COMPAT_COUNT] = {
22 COMPAT(UNKNOWN, "<none>"),
23 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
24 COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
25 COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
26 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
27 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
28 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
29 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
30 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
31 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
32 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
33 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
34 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
35 COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
36 COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
37 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
38 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
39 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
40 COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
41 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
42 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
43 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
44 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
45 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
46 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
47 COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
48 COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
49 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
50 COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
51 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
52 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
53 COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
54 COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
55 COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
56 COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
57 COMPAT(SAMSUNG_EXYNOS5_DWMMC, "samsung,exynos5250-dwmmc"),
58 COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
59 COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
60 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
61 COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
62 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
63 COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
64 COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
65 COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
66 COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
67 COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
70 const char *fdtdec_get_compatible(enum fdt_compat_id id)
72 /* We allow reading of the 'unknown' ID for testing purposes */
73 assert(id >= 0 && id < COMPAT_COUNT);
74 return compat_names[id];
77 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
78 const char *prop_name, fdt_size_t *sizep)
80 const fdt_addr_t *cell;
83 debug("%s: %s: ", __func__, prop_name);
84 cell = fdt_getprop(blob, node, prop_name, &len);
85 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
86 len == sizeof(fdt_addr_t) * 2)) {
87 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
89 const fdt_size_t *size;
91 size = (fdt_size_t *)((char *)cell +
93 *sizep = fdt_size_to_cpu(*size);
94 debug("addr=%08lx, size=%08x\n",
97 debug("%08lx\n", (ulong)addr);
101 debug("(not found)\n");
102 return FDT_ADDR_T_NONE;
105 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
106 const char *prop_name)
108 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
111 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
117 debug("%s: %s: ", __func__, prop_name);
118 cell = fdt_getprop(blob, node, prop_name, &len);
119 if (cell && len >= sizeof(s32)) {
120 s32 val = fdt32_to_cpu(cell[0]);
122 debug("%#x (%d)\n", val, val);
125 debug("(not found)\n");
129 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
130 uint64_t default_val)
132 const uint64_t *cell64;
135 cell64 = fdt_getprop(blob, node, prop_name, &length);
136 if (!cell64 || length < sizeof(*cell64))
139 return fdt64_to_cpu(*cell64);
142 int fdtdec_get_is_enabled(const void *blob, int node)
147 * It should say "okay", so only allow that. Some fdts use "ok" but
148 * this is a bug. Please fix your device tree source file. See here
151 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
153 cell = fdt_getprop(blob, node, "status", NULL);
155 return 0 == strcmp(cell, "okay");
159 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
161 enum fdt_compat_id id;
163 /* Search our drivers */
164 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
165 if (0 == fdt_node_check_compatible(blob, node,
168 return COMPAT_UNKNOWN;
171 int fdtdec_next_compatible(const void *blob, int node,
172 enum fdt_compat_id id)
174 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
177 int fdtdec_next_compatible_subnode(const void *blob, int node,
178 enum fdt_compat_id id, int *depthp)
181 node = fdt_next_node(blob, node, depthp);
182 } while (*depthp > 1);
184 /* If this is a direct subnode, and compatible, return it */
185 if (*depthp == 1 && 0 == fdt_node_check_compatible(
186 blob, node, compat_names[id]))
189 return -FDT_ERR_NOTFOUND;
192 int fdtdec_next_alias(const void *blob, const char *name,
193 enum fdt_compat_id id, int *upto)
195 #define MAX_STR_LEN 20
196 char str[MAX_STR_LEN + 20];
199 /* snprintf() is not available */
200 assert(strlen(name) < MAX_STR_LEN);
201 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
202 node = fdt_path_offset(blob, str);
205 err = fdt_node_check_compatible(blob, node, compat_names[id]);
209 return -FDT_ERR_NOTFOUND;
214 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
215 enum fdt_compat_id id, int *node_list, int maxcount)
217 memset(node_list, '\0', sizeof(*node_list) * maxcount);
219 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
222 /* TODO: Can we tighten this code up a little? */
223 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
224 enum fdt_compat_id id, int *node_list, int maxcount)
226 int name_len = strlen(name);
234 /* find the alias node if present */
235 alias_node = fdt_path_offset(blob, "/aliases");
238 * start with nothing, and we can assume that the root node can't
241 memset(nodes, '\0', sizeof(nodes));
243 /* First find all the compatible nodes */
244 for (node = count = 0; node >= 0 && count < maxcount;) {
245 node = fdtdec_next_compatible(blob, node, id);
247 nodes[count++] = node;
250 debug("%s: warning: maxcount exceeded with alias '%s'\n",
253 /* Now find all the aliases */
254 for (offset = fdt_first_property_offset(blob, alias_node);
256 offset = fdt_next_property_offset(blob, offset)) {
257 const struct fdt_property *prop;
263 prop = fdt_get_property_by_offset(blob, offset, NULL);
264 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
265 if (prop->len && 0 == strncmp(path, name, name_len))
266 node = fdt_path_offset(blob, prop->data);
270 /* Get the alias number */
271 number = simple_strtoul(path + name_len, NULL, 10);
272 if (number < 0 || number >= maxcount) {
273 debug("%s: warning: alias '%s' is out of range\n",
278 /* Make sure the node we found is actually in our list! */
280 for (j = 0; j < count; j++)
281 if (nodes[j] == node) {
287 debug("%s: warning: alias '%s' points to a node "
288 "'%s' that is missing or is not compatible "
289 " with '%s'\n", __func__, path,
290 fdt_get_name(blob, node, NULL),
296 * Add this node to our list in the right place, and mark
299 if (fdtdec_get_is_enabled(blob, node)) {
300 if (node_list[number]) {
301 debug("%s: warning: alias '%s' requires that "
302 "a node be placed in the list in a "
303 "position which is already filled by "
304 "node '%s'\n", __func__, path,
305 fdt_get_name(blob, node, NULL));
308 node_list[number] = node;
309 if (number >= num_found)
310 num_found = number + 1;
315 /* Add any nodes not mentioned by an alias */
316 for (i = j = 0; i < maxcount; i++) {
318 for (; j < maxcount; j++)
320 fdtdec_get_is_enabled(blob, nodes[j]))
323 /* Have we run out of nodes to add? */
327 assert(!node_list[i]);
328 node_list[i] = nodes[j++];
337 int fdtdec_check_fdt(void)
340 * We must have an FDT, but we cannot panic() yet since the console
341 * is not ready. So for now, just assert(). Boards which need an early
342 * FDT (prior to console ready) will need to make their own
343 * arrangements and do their own checks.
345 assert(!fdtdec_prepare_fdt());
350 * This function is a little odd in that it accesses global data. At some
351 * point if the architecture board.c files merge this will make more sense.
352 * Even now, it is common code.
354 int fdtdec_prepare_fdt(void)
356 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
357 fdt_check_header(gd->fdt_blob)) {
358 printf("No valid FDT found - please append one to U-Boot "
359 "binary, use u-boot-dtb.bin or define "
360 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
366 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
371 debug("%s: %s\n", __func__, prop_name);
372 phandle = fdt_getprop(blob, node, prop_name, NULL);
374 return -FDT_ERR_NOTFOUND;
376 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
381 * Look up a property in a node and check that it has a minimum length.
383 * @param blob FDT blob
384 * @param node node to examine
385 * @param prop_name name of property to find
386 * @param min_len minimum property length in bytes
387 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
388 found, or -FDT_ERR_BADLAYOUT if not enough data
389 * @return pointer to cell, which is only valid if err == 0
391 static const void *get_prop_check_min_len(const void *blob, int node,
392 const char *prop_name, int min_len, int *err)
397 debug("%s: %s\n", __func__, prop_name);
398 cell = fdt_getprop(blob, node, prop_name, &len);
400 *err = -FDT_ERR_NOTFOUND;
401 else if (len < min_len)
402 *err = -FDT_ERR_BADLAYOUT;
408 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
409 u32 *array, int count)
414 debug("%s: %s\n", __func__, prop_name);
415 cell = get_prop_check_min_len(blob, node, prop_name,
416 sizeof(u32) * count, &err);
418 for (i = 0; i < count; i++)
419 array[i] = fdt32_to_cpu(cell[i]);
424 const u32 *fdtdec_locate_array(const void *blob, int node,
425 const char *prop_name, int count)
430 cell = get_prop_check_min_len(blob, node, prop_name,
431 sizeof(u32) * count, &err);
432 return err ? NULL : cell;
435 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
440 debug("%s: %s\n", __func__, prop_name);
441 cell = fdt_getprop(blob, node, prop_name, &len);
446 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
449 * @param blob FDT blob to use
450 * @param node Node to look at
451 * @param prop_name Node property name
452 * @param gpio Array of gpio elements to fill from FDT. This will be
453 * untouched if either 0 or an error is returned
454 * @param max_count Maximum number of elements allowed
455 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
456 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
458 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
459 struct fdt_gpio_state *gpio, int max_count)
461 const struct fdt_property *prop;
466 debug("%s: %s\n", __func__, prop_name);
467 assert(max_count > 0);
468 prop = fdt_get_property(blob, node, prop_name, &len);
470 debug("%s: property '%s' missing\n", __func__, prop_name);
471 return -FDT_ERR_NOTFOUND;
474 /* We will use the name to tag the GPIO */
475 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
476 cell = (u32 *)prop->data;
477 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
478 if (len > max_count) {
479 debug(" %s: too many GPIOs / cells for "
480 "property '%s'\n", __func__, prop_name);
481 return -FDT_ERR_BADLAYOUT;
484 /* Read out the GPIO data from the cells */
485 for (i = 0; i < len; i++, cell += 3) {
486 gpio[i].gpio = fdt32_to_cpu(cell[1]);
487 gpio[i].flags = fdt32_to_cpu(cell[2]);
494 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
495 struct fdt_gpio_state *gpio)
499 debug("%s: %s\n", __func__, prop_name);
500 gpio->gpio = FDT_GPIO_NONE;
502 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
503 return err == 1 ? 0 : err;
506 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
510 if (!fdt_gpio_isvalid(gpio))
513 val = gpio_get_value(gpio->gpio);
514 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
517 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
519 if (!fdt_gpio_isvalid(gpio))
522 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
523 return gpio_set_value(gpio->gpio, val);
526 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
529 * Return success if there is no GPIO defined. This is used for
532 if (!fdt_gpio_isvalid(gpio))
535 if (gpio_request(gpio->gpio, gpio->name))
540 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
541 u8 *array, int count)
546 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
548 memcpy(array, cell, count);
552 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
553 const char *prop_name, int count)
558 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
564 int fdtdec_get_config_int(const void *blob, const char *prop_name,
569 debug("%s: %s\n", __func__, prop_name);
570 config_node = fdt_path_offset(blob, "/config");
573 return fdtdec_get_int(blob, config_node, prop_name, default_val);
576 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
581 debug("%s: %s\n", __func__, prop_name);
582 config_node = fdt_path_offset(blob, "/config");
585 prop = fdt_get_property(blob, config_node, prop_name, NULL);
590 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
596 debug("%s: %s\n", __func__, prop_name);
597 nodeoffset = fdt_path_offset(blob, "/config");
601 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
605 return (char *)nodep;
608 int fdtdec_decode_region(const void *blob, int node,
609 const char *prop_name, void **ptrp, size_t *size)
611 const fdt_addr_t *cell;
614 debug("%s: %s\n", __func__, prop_name);
615 cell = fdt_getprop(blob, node, prop_name, &len);
616 if (!cell || (len != sizeof(fdt_addr_t) * 2))
619 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
620 *size = fdt_size_to_cpu(cell[1]);
621 debug("%s: size=%zx\n", __func__, *size);
626 * Read a flash entry from the fdt
628 * @param blob FDT blob
629 * @param node Offset of node to read
630 * @param name Name of node being read
631 * @param entry Place to put offset and size of this node
632 * @return 0 if ok, -ve on error
634 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
635 struct fmap_entry *entry)
639 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
640 debug("Node '%s' has bad/missing 'reg' property\n", name);
641 return -FDT_ERR_NOTFOUND;
643 entry->offset = reg[0];
644 entry->length = reg[1];