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_EXYNOS_DWMMC, "samsung,exynos-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"),
69 COMPAT(TI_TPS65090, "ti,tps65090"),
70 COMPAT(COMPAT_NXP_PTN3460, "nxp,ptn3460"),
73 const char *fdtdec_get_compatible(enum fdt_compat_id id)
75 /* We allow reading of the 'unknown' ID for testing purposes */
76 assert(id >= 0 && id < COMPAT_COUNT);
77 return compat_names[id];
80 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
81 const char *prop_name, fdt_size_t *sizep)
83 const fdt_addr_t *cell;
86 debug("%s: %s: ", __func__, prop_name);
87 cell = fdt_getprop(blob, node, prop_name, &len);
88 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
89 len == sizeof(fdt_addr_t) * 2)) {
90 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
92 const fdt_size_t *size;
94 size = (fdt_size_t *)((char *)cell +
96 *sizep = fdt_size_to_cpu(*size);
97 debug("addr=%08lx, size=%08x\n",
100 debug("%08lx\n", (ulong)addr);
104 debug("(not found)\n");
105 return FDT_ADDR_T_NONE;
108 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
109 const char *prop_name)
111 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
114 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
120 debug("%s: %s: ", __func__, prop_name);
121 cell = fdt_getprop(blob, node, prop_name, &len);
122 if (cell && len >= sizeof(s32)) {
123 s32 val = fdt32_to_cpu(cell[0]);
125 debug("%#x (%d)\n", val, val);
128 debug("(not found)\n");
132 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
133 uint64_t default_val)
135 const uint64_t *cell64;
138 cell64 = fdt_getprop(blob, node, prop_name, &length);
139 if (!cell64 || length < sizeof(*cell64))
142 return fdt64_to_cpu(*cell64);
145 int fdtdec_get_is_enabled(const void *blob, int node)
150 * It should say "okay", so only allow that. Some fdts use "ok" but
151 * this is a bug. Please fix your device tree source file. See here
154 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
156 cell = fdt_getprop(blob, node, "status", NULL);
158 return 0 == strcmp(cell, "okay");
162 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
164 enum fdt_compat_id id;
166 /* Search our drivers */
167 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
168 if (0 == fdt_node_check_compatible(blob, node,
171 return COMPAT_UNKNOWN;
174 int fdtdec_next_compatible(const void *blob, int node,
175 enum fdt_compat_id id)
177 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
180 int fdtdec_next_compatible_subnode(const void *blob, int node,
181 enum fdt_compat_id id, int *depthp)
184 node = fdt_next_node(blob, node, depthp);
185 } while (*depthp > 1);
187 /* If this is a direct subnode, and compatible, return it */
188 if (*depthp == 1 && 0 == fdt_node_check_compatible(
189 blob, node, compat_names[id]))
192 return -FDT_ERR_NOTFOUND;
195 int fdtdec_next_alias(const void *blob, const char *name,
196 enum fdt_compat_id id, int *upto)
198 #define MAX_STR_LEN 20
199 char str[MAX_STR_LEN + 20];
202 /* snprintf() is not available */
203 assert(strlen(name) < MAX_STR_LEN);
204 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
205 node = fdt_path_offset(blob, str);
208 err = fdt_node_check_compatible(blob, node, compat_names[id]);
212 return -FDT_ERR_NOTFOUND;
217 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
218 enum fdt_compat_id id, int *node_list, int maxcount)
220 memset(node_list, '\0', sizeof(*node_list) * maxcount);
222 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
225 /* TODO: Can we tighten this code up a little? */
226 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
227 enum fdt_compat_id id, int *node_list, int maxcount)
229 int name_len = strlen(name);
237 /* find the alias node if present */
238 alias_node = fdt_path_offset(blob, "/aliases");
241 * start with nothing, and we can assume that the root node can't
244 memset(nodes, '\0', sizeof(nodes));
246 /* First find all the compatible nodes */
247 for (node = count = 0; node >= 0 && count < maxcount;) {
248 node = fdtdec_next_compatible(blob, node, id);
250 nodes[count++] = node;
253 debug("%s: warning: maxcount exceeded with alias '%s'\n",
256 /* Now find all the aliases */
257 for (offset = fdt_first_property_offset(blob, alias_node);
259 offset = fdt_next_property_offset(blob, offset)) {
260 const struct fdt_property *prop;
266 prop = fdt_get_property_by_offset(blob, offset, NULL);
267 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
268 if (prop->len && 0 == strncmp(path, name, name_len))
269 node = fdt_path_offset(blob, prop->data);
273 /* Get the alias number */
274 number = simple_strtoul(path + name_len, NULL, 10);
275 if (number < 0 || number >= maxcount) {
276 debug("%s: warning: alias '%s' is out of range\n",
281 /* Make sure the node we found is actually in our list! */
283 for (j = 0; j < count; j++)
284 if (nodes[j] == node) {
290 debug("%s: warning: alias '%s' points to a node "
291 "'%s' that is missing or is not compatible "
292 " with '%s'\n", __func__, path,
293 fdt_get_name(blob, node, NULL),
299 * Add this node to our list in the right place, and mark
302 if (fdtdec_get_is_enabled(blob, node)) {
303 if (node_list[number]) {
304 debug("%s: warning: alias '%s' requires that "
305 "a node be placed in the list in a "
306 "position which is already filled by "
307 "node '%s'\n", __func__, path,
308 fdt_get_name(blob, node, NULL));
311 node_list[number] = node;
312 if (number >= num_found)
313 num_found = number + 1;
318 /* Add any nodes not mentioned by an alias */
319 for (i = j = 0; i < maxcount; i++) {
321 for (; j < maxcount; j++)
323 fdtdec_get_is_enabled(blob, nodes[j]))
326 /* Have we run out of nodes to add? */
330 assert(!node_list[i]);
331 node_list[i] = nodes[j++];
340 int fdtdec_check_fdt(void)
343 * We must have an FDT, but we cannot panic() yet since the console
344 * is not ready. So for now, just assert(). Boards which need an early
345 * FDT (prior to console ready) will need to make their own
346 * arrangements and do their own checks.
348 assert(!fdtdec_prepare_fdt());
353 * This function is a little odd in that it accesses global data. At some
354 * point if the architecture board.c files merge this will make more sense.
355 * Even now, it is common code.
357 int fdtdec_prepare_fdt(void)
359 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
360 fdt_check_header(gd->fdt_blob)) {
361 printf("No valid FDT found - please append one to U-Boot "
362 "binary, use u-boot-dtb.bin or define "
363 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
369 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
374 debug("%s: %s\n", __func__, prop_name);
375 phandle = fdt_getprop(blob, node, prop_name, NULL);
377 return -FDT_ERR_NOTFOUND;
379 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
384 * Look up a property in a node and check that it has a minimum length.
386 * @param blob FDT blob
387 * @param node node to examine
388 * @param prop_name name of property to find
389 * @param min_len minimum property length in bytes
390 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
391 found, or -FDT_ERR_BADLAYOUT if not enough data
392 * @return pointer to cell, which is only valid if err == 0
394 static const void *get_prop_check_min_len(const void *blob, int node,
395 const char *prop_name, int min_len, int *err)
400 debug("%s: %s\n", __func__, prop_name);
401 cell = fdt_getprop(blob, node, prop_name, &len);
403 *err = -FDT_ERR_NOTFOUND;
404 else if (len < min_len)
405 *err = -FDT_ERR_BADLAYOUT;
411 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
412 u32 *array, int count)
417 debug("%s: %s\n", __func__, prop_name);
418 cell = get_prop_check_min_len(blob, node, prop_name,
419 sizeof(u32) * count, &err);
421 for (i = 0; i < count; i++)
422 array[i] = fdt32_to_cpu(cell[i]);
427 const u32 *fdtdec_locate_array(const void *blob, int node,
428 const char *prop_name, int count)
433 cell = get_prop_check_min_len(blob, node, prop_name,
434 sizeof(u32) * count, &err);
435 return err ? NULL : cell;
438 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
443 debug("%s: %s\n", __func__, prop_name);
444 cell = fdt_getprop(blob, node, prop_name, &len);
449 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
452 * @param blob FDT blob to use
453 * @param node Node to look at
454 * @param prop_name Node property name
455 * @param gpio Array of gpio elements to fill from FDT. This will be
456 * untouched if either 0 or an error is returned
457 * @param max_count Maximum number of elements allowed
458 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
459 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
461 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
462 struct fdt_gpio_state *gpio, int max_count)
464 const struct fdt_property *prop;
469 debug("%s: %s\n", __func__, prop_name);
470 assert(max_count > 0);
471 prop = fdt_get_property(blob, node, prop_name, &len);
473 debug("%s: property '%s' missing\n", __func__, prop_name);
474 return -FDT_ERR_NOTFOUND;
477 /* We will use the name to tag the GPIO */
478 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
479 cell = (u32 *)prop->data;
480 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
481 if (len > max_count) {
482 debug(" %s: too many GPIOs / cells for "
483 "property '%s'\n", __func__, prop_name);
484 return -FDT_ERR_BADLAYOUT;
487 /* Read out the GPIO data from the cells */
488 for (i = 0; i < len; i++, cell += 3) {
489 gpio[i].gpio = fdt32_to_cpu(cell[1]);
490 gpio[i].flags = fdt32_to_cpu(cell[2]);
497 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
498 struct fdt_gpio_state *gpio)
502 debug("%s: %s\n", __func__, prop_name);
503 gpio->gpio = FDT_GPIO_NONE;
505 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
506 return err == 1 ? 0 : err;
509 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
513 if (!fdt_gpio_isvalid(gpio))
516 val = gpio_get_value(gpio->gpio);
517 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
520 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
522 if (!fdt_gpio_isvalid(gpio))
525 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
526 return gpio_set_value(gpio->gpio, val);
529 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
532 * Return success if there is no GPIO defined. This is used for
535 if (!fdt_gpio_isvalid(gpio))
538 if (gpio_request(gpio->gpio, gpio->name))
543 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
544 u8 *array, int count)
549 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
551 memcpy(array, cell, count);
555 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
556 const char *prop_name, int count)
561 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
567 int fdtdec_get_config_int(const void *blob, const char *prop_name,
572 debug("%s: %s\n", __func__, prop_name);
573 config_node = fdt_path_offset(blob, "/config");
576 return fdtdec_get_int(blob, config_node, prop_name, default_val);
579 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
584 debug("%s: %s\n", __func__, prop_name);
585 config_node = fdt_path_offset(blob, "/config");
588 prop = fdt_get_property(blob, config_node, prop_name, NULL);
593 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
599 debug("%s: %s\n", __func__, prop_name);
600 nodeoffset = fdt_path_offset(blob, "/config");
604 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
608 return (char *)nodep;
611 int fdtdec_decode_region(const void *blob, int node,
612 const char *prop_name, void **ptrp, size_t *size)
614 const fdt_addr_t *cell;
617 debug("%s: %s\n", __func__, prop_name);
618 cell = fdt_getprop(blob, node, prop_name, &len);
619 if (!cell || (len != sizeof(fdt_addr_t) * 2))
622 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
623 *size = fdt_size_to_cpu(cell[1]);
624 debug("%s: size=%zx\n", __func__, *size);
629 * Read a flash entry from the fdt
631 * @param blob FDT blob
632 * @param node Offset of node to read
633 * @param name Name of node being read
634 * @param entry Place to put offset and size of this node
635 * @return 0 if ok, -ve on error
637 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
638 struct fmap_entry *entry)
642 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
643 debug("Node '%s' has bad/missing 'reg' property\n", name);
644 return -FDT_ERR_NOTFOUND;
646 entry->offset = reg[0];
647 entry->length = reg[1];
653 #include "fdt_support.h"
655 int fdtdec_get_int(const void *blob, int node, const char *prop_name,
661 cell = fdt_getprop_w((void *)blob, node, prop_name, &len);
662 if (cell && len >= sizeof(int)) {
663 int val = fdt32_to_cpu(cell[0]);