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_SERIAL, "samsung,exynos4210-uart"),
59 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
60 COMPAT(GENERIC_SPI_FLASH, "spi-flash"),
61 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
62 COMPAT(INFINEON_SLB9635_TPM, "infineon,slb9635-tpm"),
63 COMPAT(INFINEON_SLB9645_TPM, "infineon,slb9645-tpm"),
64 COMPAT(SAMSUNG_EXYNOS5_I2C, "samsung,exynos5-hsi2c"),
67 const char *fdtdec_get_compatible(enum fdt_compat_id id)
69 /* We allow reading of the 'unknown' ID for testing purposes */
70 assert(id >= 0 && id < COMPAT_COUNT);
71 return compat_names[id];
74 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
75 const char *prop_name, fdt_size_t *sizep)
77 const fdt_addr_t *cell;
80 debug("%s: %s: ", __func__, prop_name);
81 cell = fdt_getprop(blob, node, prop_name, &len);
82 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
83 len == sizeof(fdt_addr_t) * 2)) {
84 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
86 const fdt_size_t *size;
88 size = (fdt_size_t *)((char *)cell +
90 *sizep = fdt_size_to_cpu(*size);
91 debug("addr=%08lx, size=%08x\n",
94 debug("%08lx\n", (ulong)addr);
98 debug("(not found)\n");
99 return FDT_ADDR_T_NONE;
102 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
103 const char *prop_name)
105 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
108 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
114 debug("%s: %s: ", __func__, prop_name);
115 cell = fdt_getprop(blob, node, prop_name, &len);
116 if (cell && len >= sizeof(s32)) {
117 s32 val = fdt32_to_cpu(cell[0]);
119 debug("%#x (%d)\n", val, val);
122 debug("(not found)\n");
126 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
127 uint64_t default_val)
129 const uint64_t *cell64;
132 cell64 = fdt_getprop(blob, node, prop_name, &length);
133 if (!cell64 || length < sizeof(*cell64))
136 return fdt64_to_cpu(*cell64);
139 int fdtdec_get_is_enabled(const void *blob, int node)
144 * It should say "okay", so only allow that. Some fdts use "ok" but
145 * this is a bug. Please fix your device tree source file. See here
148 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
150 cell = fdt_getprop(blob, node, "status", NULL);
152 return 0 == strcmp(cell, "okay");
156 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
158 enum fdt_compat_id id;
160 /* Search our drivers */
161 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
162 if (0 == fdt_node_check_compatible(blob, node,
165 return COMPAT_UNKNOWN;
168 int fdtdec_next_compatible(const void *blob, int node,
169 enum fdt_compat_id id)
171 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
174 int fdtdec_next_compatible_subnode(const void *blob, int node,
175 enum fdt_compat_id id, int *depthp)
178 node = fdt_next_node(blob, node, depthp);
179 } while (*depthp > 1);
181 /* If this is a direct subnode, and compatible, return it */
182 if (*depthp == 1 && 0 == fdt_node_check_compatible(
183 blob, node, compat_names[id]))
186 return -FDT_ERR_NOTFOUND;
189 int fdtdec_next_alias(const void *blob, const char *name,
190 enum fdt_compat_id id, int *upto)
192 #define MAX_STR_LEN 20
193 char str[MAX_STR_LEN + 20];
196 /* snprintf() is not available */
197 assert(strlen(name) < MAX_STR_LEN);
198 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
199 node = fdt_path_offset(blob, str);
202 err = fdt_node_check_compatible(blob, node, compat_names[id]);
206 return -FDT_ERR_NOTFOUND;
211 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
212 enum fdt_compat_id id, int *node_list, int maxcount)
214 memset(node_list, '\0', sizeof(*node_list) * maxcount);
216 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
219 /* TODO: Can we tighten this code up a little? */
220 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
221 enum fdt_compat_id id, int *node_list, int maxcount)
223 int name_len = strlen(name);
231 /* find the alias node if present */
232 alias_node = fdt_path_offset(blob, "/aliases");
235 * start with nothing, and we can assume that the root node can't
238 memset(nodes, '\0', sizeof(nodes));
240 /* First find all the compatible nodes */
241 for (node = count = 0; node >= 0 && count < maxcount;) {
242 node = fdtdec_next_compatible(blob, node, id);
244 nodes[count++] = node;
247 debug("%s: warning: maxcount exceeded with alias '%s'\n",
250 /* Now find all the aliases */
251 for (offset = fdt_first_property_offset(blob, alias_node);
253 offset = fdt_next_property_offset(blob, offset)) {
254 const struct fdt_property *prop;
260 prop = fdt_get_property_by_offset(blob, offset, NULL);
261 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
262 if (prop->len && 0 == strncmp(path, name, name_len))
263 node = fdt_path_offset(blob, prop->data);
267 /* Get the alias number */
268 number = simple_strtoul(path + name_len, NULL, 10);
269 if (number < 0 || number >= maxcount) {
270 debug("%s: warning: alias '%s' is out of range\n",
275 /* Make sure the node we found is actually in our list! */
277 for (j = 0; j < count; j++)
278 if (nodes[j] == node) {
284 debug("%s: warning: alias '%s' points to a node "
285 "'%s' that is missing or is not compatible "
286 " with '%s'\n", __func__, path,
287 fdt_get_name(blob, node, NULL),
293 * Add this node to our list in the right place, and mark
296 if (fdtdec_get_is_enabled(blob, node)) {
297 if (node_list[number]) {
298 debug("%s: warning: alias '%s' requires that "
299 "a node be placed in the list in a "
300 "position which is already filled by "
301 "node '%s'\n", __func__, path,
302 fdt_get_name(blob, node, NULL));
305 node_list[number] = node;
306 if (number >= num_found)
307 num_found = number + 1;
312 /* Add any nodes not mentioned by an alias */
313 for (i = j = 0; i < maxcount; i++) {
315 for (; j < maxcount; j++)
317 fdtdec_get_is_enabled(blob, nodes[j]))
320 /* Have we run out of nodes to add? */
324 assert(!node_list[i]);
325 node_list[i] = nodes[j++];
334 int fdtdec_check_fdt(void)
337 * We must have an FDT, but we cannot panic() yet since the console
338 * is not ready. So for now, just assert(). Boards which need an early
339 * FDT (prior to console ready) will need to make their own
340 * arrangements and do their own checks.
342 assert(!fdtdec_prepare_fdt());
347 * This function is a little odd in that it accesses global data. At some
348 * point if the architecture board.c files merge this will make more sense.
349 * Even now, it is common code.
351 int fdtdec_prepare_fdt(void)
353 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
354 fdt_check_header(gd->fdt_blob)) {
355 printf("No valid FDT found - please append one to U-Boot "
356 "binary, use u-boot-dtb.bin or define "
357 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
363 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
368 debug("%s: %s\n", __func__, prop_name);
369 phandle = fdt_getprop(blob, node, prop_name, NULL);
371 return -FDT_ERR_NOTFOUND;
373 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
378 * Look up a property in a node and check that it has a minimum length.
380 * @param blob FDT blob
381 * @param node node to examine
382 * @param prop_name name of property to find
383 * @param min_len minimum property length in bytes
384 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
385 found, or -FDT_ERR_BADLAYOUT if not enough data
386 * @return pointer to cell, which is only valid if err == 0
388 static const void *get_prop_check_min_len(const void *blob, int node,
389 const char *prop_name, int min_len, int *err)
394 debug("%s: %s\n", __func__, prop_name);
395 cell = fdt_getprop(blob, node, prop_name, &len);
397 *err = -FDT_ERR_NOTFOUND;
398 else if (len < min_len)
399 *err = -FDT_ERR_BADLAYOUT;
405 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
406 u32 *array, int count)
411 debug("%s: %s\n", __func__, prop_name);
412 cell = get_prop_check_min_len(blob, node, prop_name,
413 sizeof(u32) * count, &err);
415 for (i = 0; i < count; i++)
416 array[i] = fdt32_to_cpu(cell[i]);
421 const u32 *fdtdec_locate_array(const void *blob, int node,
422 const char *prop_name, int count)
427 cell = get_prop_check_min_len(blob, node, prop_name,
428 sizeof(u32) * count, &err);
429 return err ? NULL : cell;
432 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
437 debug("%s: %s\n", __func__, prop_name);
438 cell = fdt_getprop(blob, node, prop_name, &len);
443 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
446 * @param blob FDT blob to use
447 * @param node Node to look at
448 * @param prop_name Node property name
449 * @param gpio Array of gpio elements to fill from FDT. This will be
450 * untouched if either 0 or an error is returned
451 * @param max_count Maximum number of elements allowed
452 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
453 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
455 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
456 struct fdt_gpio_state *gpio, int max_count)
458 const struct fdt_property *prop;
463 debug("%s: %s\n", __func__, prop_name);
464 assert(max_count > 0);
465 prop = fdt_get_property(blob, node, prop_name, &len);
467 debug("%s: property '%s' missing\n", __func__, prop_name);
468 return -FDT_ERR_NOTFOUND;
471 /* We will use the name to tag the GPIO */
472 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
473 cell = (u32 *)prop->data;
474 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
475 if (len > max_count) {
476 debug(" %s: too many GPIOs / cells for "
477 "property '%s'\n", __func__, prop_name);
478 return -FDT_ERR_BADLAYOUT;
481 /* Read out the GPIO data from the cells */
482 for (i = 0; i < len; i++, cell += 3) {
483 gpio[i].gpio = fdt32_to_cpu(cell[1]);
484 gpio[i].flags = fdt32_to_cpu(cell[2]);
491 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
492 struct fdt_gpio_state *gpio)
496 debug("%s: %s\n", __func__, prop_name);
497 gpio->gpio = FDT_GPIO_NONE;
499 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
500 return err == 1 ? 0 : err;
503 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
507 if (!fdt_gpio_isvalid(gpio))
510 val = gpio_get_value(gpio->gpio);
511 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
514 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
516 if (!fdt_gpio_isvalid(gpio))
519 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
520 return gpio_set_value(gpio->gpio, val);
523 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
526 * Return success if there is no GPIO defined. This is used for
529 if (!fdt_gpio_isvalid(gpio))
532 if (gpio_request(gpio->gpio, gpio->name))
537 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
538 u8 *array, int count)
543 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
545 memcpy(array, cell, count);
549 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
550 const char *prop_name, int count)
555 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
561 int fdtdec_get_config_int(const void *blob, const char *prop_name,
566 debug("%s: %s\n", __func__, prop_name);
567 config_node = fdt_path_offset(blob, "/config");
570 return fdtdec_get_int(blob, config_node, prop_name, default_val);
573 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
578 debug("%s: %s\n", __func__, prop_name);
579 config_node = fdt_path_offset(blob, "/config");
582 prop = fdt_get_property(blob, config_node, prop_name, NULL);
587 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
593 debug("%s: %s\n", __func__, prop_name);
594 nodeoffset = fdt_path_offset(blob, "/config");
598 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
602 return (char *)nodep;
605 int fdtdec_decode_region(const void *blob, int node,
606 const char *prop_name, void **ptrp, size_t *size)
608 const fdt_addr_t *cell;
611 debug("%s: %s\n", __func__, prop_name);
612 cell = fdt_getprop(blob, node, prop_name, &len);
613 if (!cell || (len != sizeof(fdt_addr_t) * 2))
616 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
617 *size = fdt_size_to_cpu(cell[1]);
618 debug("%s: size=%zx\n", __func__, *size);