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"),
74 COMPAT(PARADE_PS8625, "parade,ps8625"),
75 COMPAT(COMPAT_INTEL_LPC, "intel,lpc"),
76 COMPAT(INTEL_MICROCODE, "intel,microcode"),
77 COMPAT(MEMORY_SPD, "memory-spd"),
78 COMPAT(INTEL_PANTHERPOINT_AHCI, "intel,pantherpoint-ahci"),
81 const char *fdtdec_get_compatible(enum fdt_compat_id id)
83 /* We allow reading of the 'unknown' ID for testing purposes */
84 assert(id >= 0 && id < COMPAT_COUNT);
85 return compat_names[id];
88 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
89 const char *prop_name, fdt_size_t *sizep)
91 const fdt_addr_t *cell;
94 debug("%s: %s: ", __func__, prop_name);
95 cell = fdt_getprop(blob, node, prop_name, &len);
96 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
97 len == sizeof(fdt_addr_t) * 2)) {
98 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
100 const fdt_size_t *size;
102 size = (fdt_size_t *)((char *)cell +
104 *sizep = fdt_size_to_cpu(*size);
105 debug("addr=%08lx, size=%08x\n",
106 (ulong)addr, *sizep);
108 debug("%08lx\n", (ulong)addr);
112 debug("(not found)\n");
113 return FDT_ADDR_T_NONE;
116 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
117 const char *prop_name)
119 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
122 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
123 uint64_t default_val)
125 const uint64_t *cell64;
128 cell64 = fdt_getprop(blob, node, prop_name, &length);
129 if (!cell64 || length < sizeof(*cell64))
132 return fdt64_to_cpu(*cell64);
135 int fdtdec_get_is_enabled(const void *blob, int node)
140 * It should say "okay", so only allow that. Some fdts use "ok" but
141 * this is a bug. Please fix your device tree source file. See here
144 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
146 cell = fdt_getprop(blob, node, "status", NULL);
148 return 0 == strcmp(cell, "okay");
152 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
154 enum fdt_compat_id id;
156 /* Search our drivers */
157 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
158 if (0 == fdt_node_check_compatible(blob, node,
161 return COMPAT_UNKNOWN;
164 int fdtdec_next_compatible(const void *blob, int node,
165 enum fdt_compat_id id)
167 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
170 int fdtdec_next_compatible_subnode(const void *blob, int node,
171 enum fdt_compat_id id, int *depthp)
174 node = fdt_next_node(blob, node, depthp);
175 } while (*depthp > 1);
177 /* If this is a direct subnode, and compatible, return it */
178 if (*depthp == 1 && 0 == fdt_node_check_compatible(
179 blob, node, compat_names[id]))
182 return -FDT_ERR_NOTFOUND;
185 int fdtdec_next_alias(const void *blob, const char *name,
186 enum fdt_compat_id id, int *upto)
188 #define MAX_STR_LEN 20
189 char str[MAX_STR_LEN + 20];
192 /* snprintf() is not available */
193 assert(strlen(name) < MAX_STR_LEN);
194 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
195 node = fdt_path_offset(blob, str);
198 err = fdt_node_check_compatible(blob, node, compat_names[id]);
202 return -FDT_ERR_NOTFOUND;
207 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
208 enum fdt_compat_id id, int *node_list, int maxcount)
210 memset(node_list, '\0', sizeof(*node_list) * maxcount);
212 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
215 /* TODO: Can we tighten this code up a little? */
216 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
217 enum fdt_compat_id id, int *node_list, int maxcount)
219 int name_len = strlen(name);
227 /* find the alias node if present */
228 alias_node = fdt_path_offset(blob, "/aliases");
231 * start with nothing, and we can assume that the root node can't
234 memset(nodes, '\0', sizeof(nodes));
236 /* First find all the compatible nodes */
237 for (node = count = 0; node >= 0 && count < maxcount;) {
238 node = fdtdec_next_compatible(blob, node, id);
240 nodes[count++] = node;
243 debug("%s: warning: maxcount exceeded with alias '%s'\n",
246 /* Now find all the aliases */
247 for (offset = fdt_first_property_offset(blob, alias_node);
249 offset = fdt_next_property_offset(blob, offset)) {
250 const struct fdt_property *prop;
256 prop = fdt_get_property_by_offset(blob, offset, NULL);
257 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
258 if (prop->len && 0 == strncmp(path, name, name_len))
259 node = fdt_path_offset(blob, prop->data);
263 /* Get the alias number */
264 number = simple_strtoul(path + name_len, NULL, 10);
265 if (number < 0 || number >= maxcount) {
266 debug("%s: warning: alias '%s' is out of range\n",
271 /* Make sure the node we found is actually in our list! */
273 for (j = 0; j < count; j++)
274 if (nodes[j] == node) {
280 debug("%s: warning: alias '%s' points to a node "
281 "'%s' that is missing or is not compatible "
282 " with '%s'\n", __func__, path,
283 fdt_get_name(blob, node, NULL),
289 * Add this node to our list in the right place, and mark
292 if (fdtdec_get_is_enabled(blob, node)) {
293 if (node_list[number]) {
294 debug("%s: warning: alias '%s' requires that "
295 "a node be placed in the list in a "
296 "position which is already filled by "
297 "node '%s'\n", __func__, path,
298 fdt_get_name(blob, node, NULL));
301 node_list[number] = node;
302 if (number >= num_found)
303 num_found = number + 1;
308 /* Add any nodes not mentioned by an alias */
309 for (i = j = 0; i < maxcount; i++) {
311 for (; j < maxcount; j++)
313 fdtdec_get_is_enabled(blob, nodes[j]))
316 /* Have we run out of nodes to add? */
320 assert(!node_list[i]);
321 node_list[i] = nodes[j++];
330 int fdtdec_get_alias_seq(const void *blob, const char *base, int offset,
333 int base_len = strlen(base);
334 const char *find_name;
339 find_name = fdt_get_name(blob, offset, &find_namelen);
340 debug("Looking for '%s' at %d, name %s\n", base, offset, find_name);
342 aliases = fdt_path_offset(blob, "/aliases");
343 for (prop_offset = fdt_first_property_offset(blob, aliases);
345 prop_offset = fdt_next_property_offset(blob, prop_offset)) {
352 prop = fdt_getprop_by_offset(blob, prop_offset, &name, &len);
353 debug(" - %s, %s\n", name, prop);
354 if (len < find_namelen || *prop != '/' || prop[len - 1] ||
355 strncmp(name, base, base_len))
358 slash = strrchr(prop, '/');
359 if (strcmp(slash + 1, find_name))
361 for (p = name + strlen(name) - 1; p > name; p--) {
363 *seqp = simple_strtoul(p + 1, NULL, 10);
364 debug("Found seq %d\n", *seqp);
370 debug("Not found\n");
374 int fdtdec_get_alias_node(const void *blob, const char *name)
381 return -FDT_ERR_NOTFOUND;
382 alias_node = fdt_path_offset(blob, "/aliases");
383 prop = fdt_getprop(blob, alias_node, name, &len);
385 return -FDT_ERR_NOTFOUND;
386 return fdt_path_offset(blob, prop);
389 int fdtdec_get_chosen_node(const void *blob, const char *name)
396 return -FDT_ERR_NOTFOUND;
397 chosen_node = fdt_path_offset(blob, "/chosen");
398 prop = fdt_getprop(blob, chosen_node, name, &len);
400 return -FDT_ERR_NOTFOUND;
401 return fdt_path_offset(blob, prop);
404 int fdtdec_check_fdt(void)
407 * We must have an FDT, but we cannot panic() yet since the console
408 * is not ready. So for now, just assert(). Boards which need an early
409 * FDT (prior to console ready) will need to make their own
410 * arrangements and do their own checks.
412 assert(!fdtdec_prepare_fdt());
417 * This function is a little odd in that it accesses global data. At some
418 * point if the architecture board.c files merge this will make more sense.
419 * Even now, it is common code.
421 int fdtdec_prepare_fdt(void)
423 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
424 fdt_check_header(gd->fdt_blob)) {
425 printf("No valid FDT found - please append one to U-Boot "
426 "binary, use u-boot-dtb.bin or define "
427 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
433 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
438 debug("%s: %s\n", __func__, prop_name);
439 phandle = fdt_getprop(blob, node, prop_name, NULL);
441 return -FDT_ERR_NOTFOUND;
443 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
448 * Look up a property in a node and check that it has a minimum length.
450 * @param blob FDT blob
451 * @param node node to examine
452 * @param prop_name name of property to find
453 * @param min_len minimum property length in bytes
454 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
455 found, or -FDT_ERR_BADLAYOUT if not enough data
456 * @return pointer to cell, which is only valid if err == 0
458 static const void *get_prop_check_min_len(const void *blob, int node,
459 const char *prop_name, int min_len, int *err)
464 debug("%s: %s\n", __func__, prop_name);
465 cell = fdt_getprop(blob, node, prop_name, &len);
467 *err = -FDT_ERR_NOTFOUND;
468 else if (len < min_len)
469 *err = -FDT_ERR_BADLAYOUT;
475 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
476 u32 *array, int count)
481 debug("%s: %s\n", __func__, prop_name);
482 cell = get_prop_check_min_len(blob, node, prop_name,
483 sizeof(u32) * count, &err);
485 for (i = 0; i < count; i++)
486 array[i] = fdt32_to_cpu(cell[i]);
491 int fdtdec_get_int_array_count(const void *blob, int node,
492 const char *prop_name, u32 *array, int count)
498 debug("%s: %s\n", __func__, prop_name);
499 cell = fdt_getprop(blob, node, prop_name, &len);
501 return -FDT_ERR_NOTFOUND;
502 elems = len / sizeof(u32);
505 for (i = 0; i < count; i++)
506 array[i] = fdt32_to_cpu(cell[i]);
511 const u32 *fdtdec_locate_array(const void *blob, int node,
512 const char *prop_name, int count)
517 cell = get_prop_check_min_len(blob, node, prop_name,
518 sizeof(u32) * count, &err);
519 return err ? NULL : cell;
522 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
527 debug("%s: %s\n", __func__, prop_name);
528 cell = fdt_getprop(blob, node, prop_name, &len);
533 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
536 * @param blob FDT blob to use
537 * @param node Node to look at
538 * @param prop_name Node property name
539 * @param gpio Array of gpio elements to fill from FDT. This will be
540 * untouched if either 0 or an error is returned
541 * @param max_count Maximum number of elements allowed
542 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
543 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
545 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
546 struct fdt_gpio_state *gpio, int max_count)
548 const struct fdt_property *prop;
553 debug("%s: %s\n", __func__, prop_name);
554 assert(max_count > 0);
555 prop = fdt_get_property(blob, node, prop_name, &len);
557 debug("%s: property '%s' missing\n", __func__, prop_name);
558 return -FDT_ERR_NOTFOUND;
561 /* We will use the name to tag the GPIO */
562 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
563 cell = (u32 *)prop->data;
564 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
565 if (len > max_count) {
566 debug(" %s: too many GPIOs / cells for "
567 "property '%s'\n", __func__, prop_name);
568 return -FDT_ERR_BADLAYOUT;
571 /* Read out the GPIO data from the cells */
572 for (i = 0; i < len; i++, cell += 3) {
573 gpio[i].gpio = fdt32_to_cpu(cell[1]);
574 gpio[i].flags = fdt32_to_cpu(cell[2]);
581 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
582 struct fdt_gpio_state *gpio)
586 debug("%s: %s\n", __func__, prop_name);
587 gpio->gpio = FDT_GPIO_NONE;
589 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
590 return err == 1 ? 0 : err;
593 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
597 if (!fdt_gpio_isvalid(gpio))
600 val = gpio_get_value(gpio->gpio);
601 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
604 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
606 if (!fdt_gpio_isvalid(gpio))
609 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
610 return gpio_set_value(gpio->gpio, val);
613 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
616 * Return success if there is no GPIO defined. This is used for
619 if (!fdt_gpio_isvalid(gpio))
622 if (gpio_request(gpio->gpio, gpio->name))
627 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
628 u8 *array, int count)
633 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
635 memcpy(array, cell, count);
639 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
640 const char *prop_name, int count)
645 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
651 int fdtdec_get_config_int(const void *blob, const char *prop_name,
656 debug("%s: %s\n", __func__, prop_name);
657 config_node = fdt_path_offset(blob, "/config");
660 return fdtdec_get_int(blob, config_node, prop_name, default_val);
663 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
668 debug("%s: %s\n", __func__, prop_name);
669 config_node = fdt_path_offset(blob, "/config");
672 prop = fdt_get_property(blob, config_node, prop_name, NULL);
677 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
683 debug("%s: %s\n", __func__, prop_name);
684 nodeoffset = fdt_path_offset(blob, "/config");
688 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
692 return (char *)nodep;
695 int fdtdec_decode_region(const void *blob, int node,
696 const char *prop_name, void **ptrp, size_t *size)
698 const fdt_addr_t *cell;
701 debug("%s: %s\n", __func__, prop_name);
702 cell = fdt_getprop(blob, node, prop_name, &len);
703 if (!cell || (len != sizeof(fdt_addr_t) * 2))
706 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
707 *size = fdt_size_to_cpu(cell[1]);
708 debug("%s: size=%zx\n", __func__, *size);
713 * Read a flash entry from the fdt
715 * @param blob FDT blob
716 * @param node Offset of node to read
717 * @param name Name of node being read
718 * @param entry Place to put offset and size of this node
719 * @return 0 if ok, -ve on error
721 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
722 struct fmap_entry *entry)
726 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
727 debug("Node '%s' has bad/missing 'reg' property\n", name);
728 return -FDT_ERR_NOTFOUND;
730 entry->offset = reg[0];
731 entry->length = reg[1];
736 static u64 fdtdec_get_number(const fdt32_t *ptr, unsigned int cells)
741 number = (number << 32) | fdt32_to_cpu(*ptr++);
746 int fdt_get_resource(const void *fdt, int node, const char *property,
747 unsigned int index, struct fdt_resource *res)
749 const fdt32_t *ptr, *end;
750 int na, ns, len, parent;
753 parent = fdt_parent_offset(fdt, node);
757 na = fdt_address_cells(fdt, parent);
758 ns = fdt_size_cells(fdt, parent);
760 ptr = fdt_getprop(fdt, node, property, &len);
764 end = ptr + len / sizeof(*ptr);
766 while (ptr + na + ns <= end) {
768 res->start = res->end = fdtdec_get_number(ptr, na);
769 res->end += fdtdec_get_number(&ptr[na], ns) - 1;
777 return -FDT_ERR_NOTFOUND;
780 int fdt_get_named_resource(const void *fdt, int node, const char *property,
781 const char *prop_names, const char *name,
782 struct fdt_resource *res)
786 index = fdt_find_string(fdt, node, prop_names, name);
790 return fdt_get_resource(fdt, node, property, index, res);
793 int fdtdec_pci_get_bdf(const void *fdt, int node, int *bdf)
798 prop = fdt_getprop(fdt, node, "reg", &len);
802 *bdf = fdt32_to_cpu(*prop) & 0xffffff;