2 * Copyright (c) 2011 The Chromium OS Authors.
3 * SPDX-License-Identifier: GPL-2.0+
12 #include <linux/ctype.h>
16 DECLARE_GLOBAL_DATA_PTR;
19 * Here are the type we know about. One day we might allow drivers to
20 * register. For now we just put them here. The COMPAT macro allows us to
21 * turn this into a sparse list later, and keeps the ID with the name.
23 #define COMPAT(id, name) name
24 static const char * const compat_names[COMPAT_COUNT] = {
25 COMPAT(UNKNOWN, "<none>"),
26 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
27 COMPAT(NVIDIA_TEGRA30_USB, "nvidia,tegra30-ehci"),
28 COMPAT(NVIDIA_TEGRA114_USB, "nvidia,tegra114-ehci"),
29 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
30 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
31 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
32 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
33 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
34 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
35 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
36 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
37 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
38 COMPAT(NVIDIA_TEGRA124_SDMMC, "nvidia,tegra124-sdhci"),
39 COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
40 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
41 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
42 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
43 COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
44 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
45 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
46 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
47 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
48 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
49 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
50 COMPAT(GOOGLE_CROS_EC, "google,cros-ec"),
51 COMPAT(GOOGLE_CROS_EC_KEYB, "google,cros-ec-keyb"),
52 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
53 COMPAT(SAMSUNG_EXYNOS5_XHCI, "samsung,exynos5250-xhci"),
54 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
55 COMPAT(SAMSUNG_EXYNOS5_USB3_PHY, "samsung,exynos5250-usb3-phy"),
56 COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
57 COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
58 COMPAT(SAMSUNG_EXYNOS_MIPI_DSI, "samsung,exynos-mipi-dsi"),
59 COMPAT(SAMSUNG_EXYNOS5_DP, "samsung,exynos5-dp"),
60 COMPAT(SAMSUNG_EXYNOS_DWMMC, "samsung,exynos-dwmmc"),
61 COMPAT(SAMSUNG_EXYNOS_MMC, "samsung,exynos-mmc"),
62 COMPAT(SAMSUNG_EXYNOS_SERIAL, "samsung,exynos4210-uart"),
63 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
64 COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
65 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
66 COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
67 COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
68 COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
69 COMPAT(SANDBOX_HOST_EMULATION, "sandbox,host-emulation"),
70 COMPAT(SANDBOX_LCD_SDL, "sandbox,lcd-sdl"),
71 COMPAT(TI_TPS65090, "ti,tps65090"),
72 COMPAT(COMPAT_NXP_PTN3460, "nxp,ptn3460"),
73 COMPAT(SAMSUNG_EXYNOS_SYSMMU, "samsung,sysmmu-v3.3"),
76 const char *fdtdec_get_compatible(enum fdt_compat_id id)
78 /* We allow reading of the 'unknown' ID for testing purposes */
79 assert(id >= 0 && id < COMPAT_COUNT);
80 return compat_names[id];
83 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
84 const char *prop_name, fdt_size_t *sizep)
86 const fdt_addr_t *cell;
89 debug("%s: %s: ", __func__, prop_name);
90 cell = fdt_getprop(blob, node, prop_name, &len);
91 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
92 len == sizeof(fdt_addr_t) * 2)) {
93 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
95 const fdt_size_t *size;
97 size = (fdt_size_t *)((char *)cell +
99 *sizep = fdt_size_to_cpu(*size);
100 debug("addr=%08lx, size=%08x\n",
101 (ulong)addr, *sizep);
103 debug("%08lx\n", (ulong)addr);
107 debug("(not found)\n");
108 return FDT_ADDR_T_NONE;
111 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
112 const char *prop_name)
114 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
117 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
118 uint64_t default_val)
120 const uint64_t *cell64;
123 cell64 = fdt_getprop(blob, node, prop_name, &length);
124 if (!cell64 || length < sizeof(*cell64))
127 return fdt64_to_cpu(*cell64);
130 int fdtdec_get_is_enabled(const void *blob, int node)
135 * It should say "okay", so only allow that. Some fdts use "ok" but
136 * this is a bug. Please fix your device tree source file. See here
139 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
141 cell = fdt_getprop(blob, node, "status", NULL);
143 return 0 == strcmp(cell, "okay");
147 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
149 enum fdt_compat_id id;
151 /* Search our drivers */
152 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
153 if (0 == fdt_node_check_compatible(blob, node,
156 return COMPAT_UNKNOWN;
159 int fdtdec_next_compatible(const void *blob, int node,
160 enum fdt_compat_id id)
162 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
165 int fdtdec_next_compatible_subnode(const void *blob, int node,
166 enum fdt_compat_id id, int *depthp)
169 node = fdt_next_node(blob, node, depthp);
170 } while (*depthp > 1);
172 /* If this is a direct subnode, and compatible, return it */
173 if (*depthp == 1 && 0 == fdt_node_check_compatible(
174 blob, node, compat_names[id]))
177 return -FDT_ERR_NOTFOUND;
180 int fdtdec_next_alias(const void *blob, const char *name,
181 enum fdt_compat_id id, int *upto)
183 #define MAX_STR_LEN 20
184 char str[MAX_STR_LEN + 20];
187 /* snprintf() is not available */
188 assert(strlen(name) < MAX_STR_LEN);
189 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
190 node = fdt_path_offset(blob, str);
193 err = fdt_node_check_compatible(blob, node, compat_names[id]);
197 return -FDT_ERR_NOTFOUND;
202 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
203 enum fdt_compat_id id, int *node_list, int maxcount)
205 memset(node_list, '\0', sizeof(*node_list) * maxcount);
207 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
210 /* TODO: Can we tighten this code up a little? */
211 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
212 enum fdt_compat_id id, int *node_list, int maxcount)
214 int name_len = strlen(name);
222 /* find the alias node if present */
223 alias_node = fdt_path_offset(blob, "/aliases");
226 * start with nothing, and we can assume that the root node can't
229 memset(nodes, '\0', sizeof(nodes));
231 /* First find all the compatible nodes */
232 for (node = count = 0; node >= 0 && count < maxcount;) {
233 node = fdtdec_next_compatible(blob, node, id);
235 nodes[count++] = node;
238 debug("%s: warning: maxcount exceeded with alias '%s'\n",
241 /* Now find all the aliases */
242 for (offset = fdt_first_property_offset(blob, alias_node);
244 offset = fdt_next_property_offset(blob, offset)) {
245 const struct fdt_property *prop;
251 prop = fdt_get_property_by_offset(blob, offset, NULL);
252 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
253 if (prop->len && 0 == strncmp(path, name, name_len))
254 node = fdt_path_offset(blob, prop->data);
258 /* Get the alias number */
259 number = simple_strtoul(path + name_len, NULL, 10);
260 if (number < 0 || number >= maxcount) {
261 debug("%s: warning: alias '%s' is out of range\n",
266 /* Make sure the node we found is actually in our list! */
268 for (j = 0; j < count; j++)
269 if (nodes[j] == node) {
275 debug("%s: warning: alias '%s' points to a node "
276 "'%s' that is missing or is not compatible "
277 " with '%s'\n", __func__, path,
278 fdt_get_name(blob, node, NULL),
284 * Add this node to our list in the right place, and mark
287 if (fdtdec_get_is_enabled(blob, node)) {
288 if (node_list[number]) {
289 debug("%s: warning: alias '%s' requires that "
290 "a node be placed in the list in a "
291 "position which is already filled by "
292 "node '%s'\n", __func__, path,
293 fdt_get_name(blob, node, NULL));
296 node_list[number] = node;
297 if (number >= num_found)
298 num_found = number + 1;
303 /* Add any nodes not mentioned by an alias */
304 for (i = j = 0; i < maxcount; i++) {
306 for (; j < maxcount; j++)
308 fdtdec_get_is_enabled(blob, nodes[j]))
311 /* Have we run out of nodes to add? */
315 assert(!node_list[i]);
316 node_list[i] = nodes[j++];
325 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
328 int base_len = strlen(base);
329 const char *find_name;
334 find_name = fdt_get_name(blob, offset, &find_namelen);
335 debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
337 aliases = fdt_path_offset(blob, "/aliases");
338 for (prop_offset = fdt_first_property_offset(blob, aliases);
340 prop_offset = fdt_next_property_offset(blob, prop_offset)) {
347 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
348 debug(" - %s, %s\n", name, prop);
349 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
350 strncmp(name, base, base_len))
353 slash = strrchr(prop, '/');
354 if (strcmp(slash + 1, find_name))
356 for (p = name; *p; p++) {
358 *seqp = simple_strtoul(p, NULL, 10);
359 debug("Found seq %d\n", *seqp);
365 debug("Not found\n");
369 int fdtdec_get_alias_node(const void *blob, const char *name)
376 return -FDT_ERR_NOTFOUND;
377 alias_node = fdt_path_offset(blob, "/aliases");
378 prop = fdt_getprop(blob, alias_node, name, &len);
380 return -FDT_ERR_NOTFOUND;
381 return fdt_path_offset(blob, prop);
384 int fdtdec_check_fdt(void)
387 * We must have an FDT, but we cannot panic() yet since the console
388 * is not ready. So for now, just assert(). Boards which need an early
389 * FDT (prior to console ready) will need to make their own
390 * arrangements and do their own checks.
392 assert(!fdtdec_prepare_fdt());
397 * This function is a little odd in that it accesses global data. At some
398 * point if the architecture board.c files merge this will make more sense.
399 * Even now, it is common code.
401 int fdtdec_prepare_fdt(void)
403 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
404 fdt_check_header(gd->fdt_blob)) {
405 printf("No valid FDT found - please append one to U-Boot "
406 "binary, use u-boot-dtb.bin or define "
407 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
413 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
418 debug("%s: %s\n", __func__, prop_name);
419 phandle = fdt_getprop(blob, node, prop_name, NULL);
421 return -FDT_ERR_NOTFOUND;
423 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
428 * Look up a property in a node and check that it has a minimum length.
430 * @param blob FDT blob
431 * @param node node to examine
432 * @param prop_name name of property to find
433 * @param min_len minimum property length in bytes
434 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
435 found, or -FDT_ERR_BADLAYOUT if not enough data
436 * @return pointer to cell, which is only valid if err == 0
438 static const void *get_prop_check_min_len(const void *blob, int node,
439 const char *prop_name, int min_len, int *err)
444 debug("%s: %s\n", __func__, prop_name);
445 cell = fdt_getprop(blob, node, prop_name, &len);
447 *err = -FDT_ERR_NOTFOUND;
448 else if (len < min_len)
449 *err = -FDT_ERR_BADLAYOUT;
455 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
456 u32 *array, int count)
461 debug("%s: %s\n", __func__, prop_name);
462 cell = get_prop_check_min_len(blob, node, prop_name,
463 sizeof(u32) * count, &err);
465 for (i = 0; i < count; i++)
466 array[i] = fdt32_to_cpu(cell[i]);
471 const u32 *fdtdec_locate_array(const void *blob, int node,
472 const char *prop_name, int count)
477 cell = get_prop_check_min_len(blob, node, prop_name,
478 sizeof(u32) * count, &err);
479 return err ? NULL : cell;
482 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
487 debug("%s: %s\n", __func__, prop_name);
488 cell = fdt_getprop(blob, node, prop_name, &len);
493 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
496 * @param blob FDT blob to use
497 * @param node Node to look at
498 * @param prop_name Node property name
499 * @param gpio Array of gpio elements to fill from FDT. This will be
500 * untouched if either 0 or an error is returned
501 * @param max_count Maximum number of elements allowed
502 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
503 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
505 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
506 struct fdt_gpio_state *gpio, int max_count)
508 const struct fdt_property *prop;
513 debug("%s: %s\n", __func__, prop_name);
514 assert(max_count > 0);
515 prop = fdt_get_property(blob, node, prop_name, &len);
517 debug("%s: property '%s' missing\n", __func__, prop_name);
518 return -FDT_ERR_NOTFOUND;
521 /* We will use the name to tag the GPIO */
522 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
523 cell = (u32 *)prop->data;
524 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
525 if (len > max_count) {
526 debug(" %s: too many GPIOs / cells for "
527 "property '%s'\n", __func__, prop_name);
528 return -FDT_ERR_BADLAYOUT;
531 /* Read out the GPIO data from the cells */
532 for (i = 0; i < len; i++, cell += 3) {
533 gpio[i].gpio = fdt32_to_cpu(cell[1]);
534 gpio[i].flags = fdt32_to_cpu(cell[2]);
541 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
542 struct fdt_gpio_state *gpio)
546 debug("%s: %s\n", __func__, prop_name);
547 gpio->gpio = FDT_GPIO_NONE;
549 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
550 return err == 1 ? 0 : err;
553 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
557 if (!fdt_gpio_isvalid(gpio))
560 val = gpio_get_value(gpio->gpio);
561 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
564 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
566 if (!fdt_gpio_isvalid(gpio))
569 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
570 return gpio_set_value(gpio->gpio, val);
573 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
576 * Return success if there is no GPIO defined. This is used for
579 if (!fdt_gpio_isvalid(gpio))
582 if (gpio_request(gpio->gpio, gpio->name))
587 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
588 u8 *array, int count)
593 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
595 memcpy(array, cell, count);
599 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
600 const char *prop_name, int count)
605 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
611 int fdtdec_get_config_int(const void *blob, const char *prop_name,
616 debug("%s: %s\n", __func__, prop_name);
617 config_node = fdt_path_offset(blob, "/config");
620 return fdtdec_get_int(blob, config_node, prop_name, default_val);
623 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
628 debug("%s: %s\n", __func__, prop_name);
629 config_node = fdt_path_offset(blob, "/config");
632 prop = fdt_get_property(blob, config_node, prop_name, NULL);
637 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
643 debug("%s: %s\n", __func__, prop_name);
644 nodeoffset = fdt_path_offset(blob, "/config");
648 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
652 return (char *)nodep;
655 int fdtdec_decode_region(const void *blob, int node,
656 const char *prop_name, void **ptrp, size_t *size)
658 const fdt_addr_t *cell;
661 debug("%s: %s\n", __func__, prop_name);
662 cell = fdt_getprop(blob, node, prop_name, &len);
663 if (!cell || (len != sizeof(fdt_addr_t) * 2))
666 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
667 *size = fdt_size_to_cpu(cell[1]);
668 debug("%s: size=%zx\n", __func__, *size);
673 * Read a flash entry from the fdt
675 * @param blob FDT blob
676 * @param node Offset of node to read
677 * @param name Name of node being read
678 * @param entry Place to put offset and size of this node
679 * @return 0 if ok, -ve on error
681 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
682 struct fmap_entry *entry)
686 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
687 debug("Node '%s' has bad/missing 'reg' property\n", name);
688 return -FDT_ERR_NOTFOUND;
690 entry->offset = reg[0];
691 entry->length = reg[1];