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 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
115 uint64_t default_val)
117 const uint64_t *cell64;
120 cell64 = fdt_getprop(blob, node, prop_name, &length);
121 if (!cell64 || length < sizeof(*cell64))
124 return fdt64_to_cpu(*cell64);
127 int fdtdec_get_is_enabled(const void *blob, int node)
132 * It should say "okay", so only allow that. Some fdts use "ok" but
133 * this is a bug. Please fix your device tree source file. See here
136 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
138 cell = fdt_getprop(blob, node, "status", NULL);
140 return 0 == strcmp(cell, "okay");
144 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
146 enum fdt_compat_id id;
148 /* Search our drivers */
149 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
150 if (0 == fdt_node_check_compatible(blob, node,
153 return COMPAT_UNKNOWN;
156 int fdtdec_next_compatible(const void *blob, int node,
157 enum fdt_compat_id id)
159 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
162 int fdtdec_next_compatible_subnode(const void *blob, int node,
163 enum fdt_compat_id id, int *depthp)
166 node = fdt_next_node(blob, node, depthp);
167 } while (*depthp > 1);
169 /* If this is a direct subnode, and compatible, return it */
170 if (*depthp == 1 && 0 == fdt_node_check_compatible(
171 blob, node, compat_names[id]))
174 return -FDT_ERR_NOTFOUND;
177 int fdtdec_next_alias(const void *blob, const char *name,
178 enum fdt_compat_id id, int *upto)
180 #define MAX_STR_LEN 20
181 char str[MAX_STR_LEN + 20];
184 /* snprintf() is not available */
185 assert(strlen(name) < MAX_STR_LEN);
186 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
187 node = fdt_path_offset(blob, str);
190 err = fdt_node_check_compatible(blob, node, compat_names[id]);
194 return -FDT_ERR_NOTFOUND;
199 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
200 enum fdt_compat_id id, int *node_list, int maxcount)
202 memset(node_list, '\0', sizeof(*node_list) * maxcount);
204 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
207 /* TODO: Can we tighten this code up a little? */
208 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
209 enum fdt_compat_id id, int *node_list, int maxcount)
211 int name_len = strlen(name);
219 /* find the alias node if present */
220 alias_node = fdt_path_offset(blob, "/aliases");
223 * start with nothing, and we can assume that the root node can't
226 memset(nodes, '\0', sizeof(nodes));
228 /* First find all the compatible nodes */
229 for (node = count = 0; node >= 0 && count < maxcount;) {
230 node = fdtdec_next_compatible(blob, node, id);
232 nodes[count++] = node;
235 debug("%s: warning: maxcount exceeded with alias '%s'\n",
238 /* Now find all the aliases */
239 for (offset = fdt_first_property_offset(blob, alias_node);
241 offset = fdt_next_property_offset(blob, offset)) {
242 const struct fdt_property *prop;
248 prop = fdt_get_property_by_offset(blob, offset, NULL);
249 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
250 if (prop->len && 0 == strncmp(path, name, name_len))
251 node = fdt_path_offset(blob, prop->data);
255 /* Get the alias number */
256 number = simple_strtoul(path + name_len, NULL, 10);
257 if (number < 0 || number >= maxcount) {
258 debug("%s: warning: alias '%s' is out of range\n",
263 /* Make sure the node we found is actually in our list! */
265 for (j = 0; j < count; j++)
266 if (nodes[j] == node) {
272 debug("%s: warning: alias '%s' points to a node "
273 "'%s' that is missing or is not compatible "
274 " with '%s'\n", __func__, path,
275 fdt_get_name(blob, node, NULL),
281 * Add this node to our list in the right place, and mark
284 if (fdtdec_get_is_enabled(blob, node)) {
285 if (node_list[number]) {
286 debug("%s: warning: alias '%s' requires that "
287 "a node be placed in the list in a "
288 "position which is already filled by "
289 "node '%s'\n", __func__, path,
290 fdt_get_name(blob, node, NULL));
293 node_list[number] = node;
294 if (number >= num_found)
295 num_found = number + 1;
300 /* Add any nodes not mentioned by an alias */
301 for (i = j = 0; i < maxcount; i++) {
303 for (; j < maxcount; j++)
305 fdtdec_get_is_enabled(blob, nodes[j]))
308 /* Have we run out of nodes to add? */
312 assert(!node_list[i]);
313 node_list[i] = nodes[j++];
322 int fdtdec_check_fdt(void)
325 * We must have an FDT, but we cannot panic() yet since the console
326 * is not ready. So for now, just assert(). Boards which need an early
327 * FDT (prior to console ready) will need to make their own
328 * arrangements and do their own checks.
330 assert(!fdtdec_prepare_fdt());
335 * This function is a little odd in that it accesses global data. At some
336 * point if the architecture board.c files merge this will make more sense.
337 * Even now, it is common code.
339 int fdtdec_prepare_fdt(void)
341 if (!gd->fdt_blob || ((uintptr_t)gd->fdt_blob & 3) ||
342 fdt_check_header(gd->fdt_blob)) {
343 printf("No valid FDT found - please append one to U-Boot "
344 "binary, use u-boot-dtb.bin or define "
345 "CONFIG_OF_EMBED. For sandbox, use -d <file.dtb>\n");
351 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
356 debug("%s: %s\n", __func__, prop_name);
357 phandle = fdt_getprop(blob, node, prop_name, NULL);
359 return -FDT_ERR_NOTFOUND;
361 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
366 * Look up a property in a node and check that it has a minimum length.
368 * @param blob FDT blob
369 * @param node node to examine
370 * @param prop_name name of property to find
371 * @param min_len minimum property length in bytes
372 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
373 found, or -FDT_ERR_BADLAYOUT if not enough data
374 * @return pointer to cell, which is only valid if err == 0
376 static const void *get_prop_check_min_len(const void *blob, int node,
377 const char *prop_name, int min_len, int *err)
382 debug("%s: %s\n", __func__, prop_name);
383 cell = fdt_getprop(blob, node, prop_name, &len);
385 *err = -FDT_ERR_NOTFOUND;
386 else if (len < min_len)
387 *err = -FDT_ERR_BADLAYOUT;
393 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
394 u32 *array, int count)
399 debug("%s: %s\n", __func__, prop_name);
400 cell = get_prop_check_min_len(blob, node, prop_name,
401 sizeof(u32) * count, &err);
403 for (i = 0; i < count; i++)
404 array[i] = fdt32_to_cpu(cell[i]);
409 const u32 *fdtdec_locate_array(const void *blob, int node,
410 const char *prop_name, int count)
415 cell = get_prop_check_min_len(blob, node, prop_name,
416 sizeof(u32) * count, &err);
417 return err ? NULL : cell;
420 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
425 debug("%s: %s\n", __func__, prop_name);
426 cell = fdt_getprop(blob, node, prop_name, &len);
431 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
434 * @param blob FDT blob to use
435 * @param node Node to look at
436 * @param prop_name Node property name
437 * @param gpio Array of gpio elements to fill from FDT. This will be
438 * untouched if either 0 or an error is returned
439 * @param max_count Maximum number of elements allowed
440 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
441 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
443 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
444 struct fdt_gpio_state *gpio, int max_count)
446 const struct fdt_property *prop;
451 debug("%s: %s\n", __func__, prop_name);
452 assert(max_count > 0);
453 prop = fdt_get_property(blob, node, prop_name, &len);
455 debug("%s: property '%s' missing\n", __func__, prop_name);
456 return -FDT_ERR_NOTFOUND;
459 /* We will use the name to tag the GPIO */
460 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
461 cell = (u32 *)prop->data;
462 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
463 if (len > max_count) {
464 debug(" %s: too many GPIOs / cells for "
465 "property '%s'\n", __func__, prop_name);
466 return -FDT_ERR_BADLAYOUT;
469 /* Read out the GPIO data from the cells */
470 for (i = 0; i < len; i++, cell += 3) {
471 gpio[i].gpio = fdt32_to_cpu(cell[1]);
472 gpio[i].flags = fdt32_to_cpu(cell[2]);
479 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
480 struct fdt_gpio_state *gpio)
484 debug("%s: %s\n", __func__, prop_name);
485 gpio->gpio = FDT_GPIO_NONE;
487 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
488 return err == 1 ? 0 : err;
491 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
495 if (!fdt_gpio_isvalid(gpio))
498 val = gpio_get_value(gpio->gpio);
499 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
502 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
504 if (!fdt_gpio_isvalid(gpio))
507 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
508 return gpio_set_value(gpio->gpio, val);
511 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
514 * Return success if there is no GPIO defined. This is used for
517 if (!fdt_gpio_isvalid(gpio))
520 if (gpio_request(gpio->gpio, gpio->name))
525 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
526 u8 *array, int count)
531 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
533 memcpy(array, cell, count);
537 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
538 const char *prop_name, int count)
543 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
549 int fdtdec_get_config_int(const void *blob, const char *prop_name,
554 debug("%s: %s\n", __func__, prop_name);
555 config_node = fdt_path_offset(blob, "/config");
558 return fdtdec_get_int(blob, config_node, prop_name, default_val);
561 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
566 debug("%s: %s\n", __func__, prop_name);
567 config_node = fdt_path_offset(blob, "/config");
570 prop = fdt_get_property(blob, config_node, prop_name, NULL);
575 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
581 debug("%s: %s\n", __func__, prop_name);
582 nodeoffset = fdt_path_offset(blob, "/config");
586 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
590 return (char *)nodep;
593 int fdtdec_decode_region(const void *blob, int node,
594 const char *prop_name, void **ptrp, size_t *size)
596 const fdt_addr_t *cell;
599 debug("%s: %s\n", __func__, prop_name);
600 cell = fdt_getprop(blob, node, prop_name, &len);
601 if (!cell || (len != sizeof(fdt_addr_t) * 2))
604 *ptrp = map_sysmem(fdt_addr_to_cpu(*cell), *size);
605 *size = fdt_size_to_cpu(cell[1]);
606 debug("%s: size=%zx\n", __func__, *size);
611 * Read a flash entry from the fdt
613 * @param blob FDT blob
614 * @param node Offset of node to read
615 * @param name Name of node being read
616 * @param entry Place to put offset and size of this node
617 * @return 0 if ok, -ve on error
619 int fdtdec_read_fmap_entry(const void *blob, int node, const char *name,
620 struct fmap_entry *entry)
624 if (fdtdec_get_int_array(blob, node, "reg", reg, 2)) {
625 debug("Node '%s' has bad/missing 'reg' property\n", name);
626 return -FDT_ERR_NOTFOUND;
628 entry->offset = reg[0];
629 entry->length = reg[1];