2 * Copyright (c) 2011 The Chromium OS Authors.
3 * See file CREDITS for list of people who contributed to this
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation; either version 2 of
9 * the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
29 DECLARE_GLOBAL_DATA_PTR;
32 * Here are the type we know about. One day we might allow drivers to
33 * register. For now we just put them here. The COMPAT macro allows us to
34 * turn this into a sparse list later, and keeps the ID with the name.
36 #define COMPAT(id, name) name
37 static const char * const compat_names[COMPAT_COUNT] = {
38 COMPAT(UNKNOWN, "<none>"),
39 COMPAT(NVIDIA_TEGRA20_USB, "nvidia,tegra20-ehci"),
40 COMPAT(NVIDIA_TEGRA114_I2C, "nvidia,tegra114-i2c"),
41 COMPAT(NVIDIA_TEGRA20_I2C, "nvidia,tegra20-i2c"),
42 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
43 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
44 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
45 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
46 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
47 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
48 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
49 COMPAT(NVIDIA_TEGRA30_SDMMC, "nvidia,tegra30-sdhci"),
50 COMPAT(NVIDIA_TEGRA20_SDMMC, "nvidia,tegra20-sdhci"),
51 COMPAT(NVIDIA_TEGRA20_SFLASH, "nvidia,tegra20-sflash"),
52 COMPAT(NVIDIA_TEGRA20_SLINK, "nvidia,tegra20-slink"),
53 COMPAT(NVIDIA_TEGRA114_SPI, "nvidia,tegra114-spi"),
54 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
55 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
56 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
57 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
58 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
59 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
60 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
61 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
62 COMPAT(SAMSUNG_EXYNOS_TMU, "samsung,exynos-tmu"),
63 COMPAT(SAMSUNG_EXYNOS_FIMD, "samsung,exynos-fimd"),
64 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
65 COMPAT(MAXIM_98095_CODEC, "maxim,max98095-codec"),
68 const char *fdtdec_get_compatible(enum fdt_compat_id id)
70 /* We allow reading of the 'unknown' ID for testing purposes */
71 assert(id >= 0 && id < COMPAT_COUNT);
72 return compat_names[id];
75 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
76 const char *prop_name)
78 const fdt_addr_t *cell;
81 debug("%s: %s: ", __func__, prop_name);
82 cell = fdt_getprop(blob, node, prop_name, &len);
83 if (cell && (len == sizeof(fdt_addr_t) ||
84 len == sizeof(fdt_addr_t) * 2)) {
85 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
87 debug("%p\n", (void *)addr);
90 debug("(not found)\n");
91 return FDT_ADDR_T_NONE;
94 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
100 debug("%s: %s: ", __func__, prop_name);
101 cell = fdt_getprop(blob, node, prop_name, &len);
102 if (cell && len >= sizeof(s32)) {
103 s32 val = fdt32_to_cpu(cell[0]);
105 debug("%#x (%d)\n", val, val);
108 debug("(not found)\n");
112 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
113 uint64_t default_val)
115 const uint64_t *cell64;
118 cell64 = fdt_getprop(blob, node, prop_name, &length);
119 if (!cell64 || length < sizeof(*cell64))
122 return fdt64_to_cpu(*cell64);
125 int fdtdec_get_is_enabled(const void *blob, int node)
130 * It should say "okay", so only allow that. Some fdts use "ok" but
131 * this is a bug. Please fix your device tree source file. See here
134 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
136 cell = fdt_getprop(blob, node, "status", NULL);
138 return 0 == strcmp(cell, "okay");
142 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
144 enum fdt_compat_id id;
146 /* Search our drivers */
147 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
148 if (0 == fdt_node_check_compatible(blob, node,
151 return COMPAT_UNKNOWN;
154 int fdtdec_next_compatible(const void *blob, int node,
155 enum fdt_compat_id id)
157 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
160 int fdtdec_next_compatible_subnode(const void *blob, int node,
161 enum fdt_compat_id id, int *depthp)
164 node = fdt_next_node(blob, node, depthp);
165 } while (*depthp > 1);
167 /* If this is a direct subnode, and compatible, return it */
168 if (*depthp == 1 && 0 == fdt_node_check_compatible(
169 blob, node, compat_names[id]))
172 return -FDT_ERR_NOTFOUND;
175 int fdtdec_next_alias(const void *blob, const char *name,
176 enum fdt_compat_id id, int *upto)
178 #define MAX_STR_LEN 20
179 char str[MAX_STR_LEN + 20];
182 /* snprintf() is not available */
183 assert(strlen(name) < MAX_STR_LEN);
184 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
185 node = fdt_path_offset(blob, str);
188 err = fdt_node_check_compatible(blob, node, compat_names[id]);
192 return -FDT_ERR_NOTFOUND;
197 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
198 enum fdt_compat_id id, int *node_list, int maxcount)
200 memset(node_list, '\0', sizeof(*node_list) * maxcount);
202 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
205 /* TODO: Can we tighten this code up a little? */
206 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
207 enum fdt_compat_id id, int *node_list, int maxcount)
209 int name_len = strlen(name);
217 /* find the alias node if present */
218 alias_node = fdt_path_offset(blob, "/aliases");
221 * start with nothing, and we can assume that the root node can't
224 memset(nodes, '\0', sizeof(nodes));
226 /* First find all the compatible nodes */
227 for (node = count = 0; node >= 0 && count < maxcount;) {
228 node = fdtdec_next_compatible(blob, node, id);
230 nodes[count++] = node;
233 debug("%s: warning: maxcount exceeded with alias '%s'\n",
236 /* Now find all the aliases */
237 for (offset = fdt_first_property_offset(blob, alias_node);
239 offset = fdt_next_property_offset(blob, offset)) {
240 const struct fdt_property *prop;
246 prop = fdt_get_property_by_offset(blob, offset, NULL);
247 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
248 if (prop->len && 0 == strncmp(path, name, name_len))
249 node = fdt_path_offset(blob, prop->data);
253 /* Get the alias number */
254 number = simple_strtoul(path + name_len, NULL, 10);
255 if (number < 0 || number >= maxcount) {
256 debug("%s: warning: alias '%s' is out of range\n",
261 /* Make sure the node we found is actually in our list! */
263 for (j = 0; j < count; j++)
264 if (nodes[j] == node) {
270 debug("%s: warning: alias '%s' points to a node "
271 "'%s' that is missing or is not compatible "
272 " with '%s'\n", __func__, path,
273 fdt_get_name(blob, node, NULL),
279 * Add this node to our list in the right place, and mark
282 if (fdtdec_get_is_enabled(blob, node)) {
283 if (node_list[number]) {
284 debug("%s: warning: alias '%s' requires that "
285 "a node be placed in the list in a "
286 "position which is already filled by "
287 "node '%s'\n", __func__, path,
288 fdt_get_name(blob, node, NULL));
291 node_list[number] = node;
292 if (number >= num_found)
293 num_found = number + 1;
298 /* Add any nodes not mentioned by an alias */
299 for (i = j = 0; i < maxcount; i++) {
301 for (; j < maxcount; j++)
303 fdtdec_get_is_enabled(blob, nodes[j]))
306 /* Have we run out of nodes to add? */
310 assert(!node_list[i]);
311 node_list[i] = nodes[j++];
320 int fdtdec_check_fdt(void)
323 * We must have an FDT, but we cannot panic() yet since the console
324 * is not ready. So for now, just assert(). Boards which need an early
325 * FDT (prior to console ready) will need to make their own
326 * arrangements and do their own checks.
328 assert(!fdtdec_prepare_fdt());
333 * This function is a little odd in that it accesses global data. At some
334 * point if the architecture board.c files merge this will make more sense.
335 * Even now, it is common code.
337 int fdtdec_prepare_fdt(void)
339 if (((uintptr_t)gd->fdt_blob & 3) || fdt_check_header(gd->fdt_blob)) {
340 printf("No valid FDT found - please append one to U-Boot "
341 "binary, use u-boot-dtb.bin or define "
342 "CONFIG_OF_EMBED\n");
348 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
353 debug("%s: %s\n", __func__, prop_name);
354 phandle = fdt_getprop(blob, node, prop_name, NULL);
356 return -FDT_ERR_NOTFOUND;
358 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
363 * Look up a property in a node and check that it has a minimum length.
365 * @param blob FDT blob
366 * @param node node to examine
367 * @param prop_name name of property to find
368 * @param min_len minimum property length in bytes
369 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
370 found, or -FDT_ERR_BADLAYOUT if not enough data
371 * @return pointer to cell, which is only valid if err == 0
373 static const void *get_prop_check_min_len(const void *blob, int node,
374 const char *prop_name, int min_len, int *err)
379 debug("%s: %s\n", __func__, prop_name);
380 cell = fdt_getprop(blob, node, prop_name, &len);
382 *err = -FDT_ERR_NOTFOUND;
383 else if (len < min_len)
384 *err = -FDT_ERR_BADLAYOUT;
390 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
391 u32 *array, int count)
396 debug("%s: %s\n", __func__, prop_name);
397 cell = get_prop_check_min_len(blob, node, prop_name,
398 sizeof(u32) * count, &err);
400 for (i = 0; i < count; i++)
401 array[i] = fdt32_to_cpu(cell[i]);
406 const u32 *fdtdec_locate_array(const void *blob, int node,
407 const char *prop_name, int count)
412 cell = get_prop_check_min_len(blob, node, prop_name,
413 sizeof(u32) * count, &err);
414 return err ? NULL : cell;
417 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
422 debug("%s: %s\n", __func__, prop_name);
423 cell = fdt_getprop(blob, node, prop_name, &len);
428 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
431 * @param blob FDT blob to use
432 * @param node Node to look at
433 * @param prop_name Node property name
434 * @param gpio Array of gpio elements to fill from FDT. This will be
435 * untouched if either 0 or an error is returned
436 * @param max_count Maximum number of elements allowed
437 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
438 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
440 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
441 struct fdt_gpio_state *gpio, int max_count)
443 const struct fdt_property *prop;
448 debug("%s: %s\n", __func__, prop_name);
449 assert(max_count > 0);
450 prop = fdt_get_property(blob, node, prop_name, &len);
452 debug("%s: property '%s' missing\n", __func__, prop_name);
453 return -FDT_ERR_NOTFOUND;
456 /* We will use the name to tag the GPIO */
457 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
458 cell = (u32 *)prop->data;
459 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
460 if (len > max_count) {
461 debug(" %s: too many GPIOs / cells for "
462 "property '%s'\n", __func__, prop_name);
463 return -FDT_ERR_BADLAYOUT;
466 /* Read out the GPIO data from the cells */
467 for (i = 0; i < len; i++, cell += 3) {
468 gpio[i].gpio = fdt32_to_cpu(cell[1]);
469 gpio[i].flags = fdt32_to_cpu(cell[2]);
476 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
477 struct fdt_gpio_state *gpio)
481 debug("%s: %s\n", __func__, prop_name);
482 gpio->gpio = FDT_GPIO_NONE;
484 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
485 return err == 1 ? 0 : err;
488 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
492 if (!fdt_gpio_isvalid(gpio))
495 val = gpio_get_value(gpio->gpio);
496 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
499 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
501 if (!fdt_gpio_isvalid(gpio))
504 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
505 return gpio_set_value(gpio->gpio, val);
508 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
511 * Return success if there is no GPIO defined. This is used for
514 if (!fdt_gpio_isvalid(gpio))
517 if (gpio_request(gpio->gpio, gpio->name))
522 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
523 u8 *array, int count)
528 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
530 memcpy(array, cell, count);
534 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
535 const char *prop_name, int count)
540 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
546 int fdtdec_get_config_int(const void *blob, const char *prop_name,
551 debug("%s: %s\n", __func__, prop_name);
552 config_node = fdt_path_offset(blob, "/config");
555 return fdtdec_get_int(blob, config_node, prop_name, default_val);
558 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
563 debug("%s: %s\n", __func__, prop_name);
564 config_node = fdt_path_offset(blob, "/config");
567 prop = fdt_get_property(blob, config_node, prop_name, NULL);
572 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
578 debug("%s: %s\n", __func__, prop_name);
579 nodeoffset = fdt_path_offset(blob, "/config");
583 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
587 return (char *)nodep;
590 int fdtdec_decode_region(const void *blob, int node,
591 const char *prop_name, void **ptrp, size_t *size)
593 const fdt_addr_t *cell;
596 debug("%s: %s\n", __func__, prop_name);
597 cell = fdt_getprop(blob, node, prop_name, &len);
598 if (!cell || (len != sizeof(fdt_addr_t) * 2))
601 *ptrp = (void *)fdt_addr_to_cpu(*cell);
602 *size = fdt_size_to_cpu(cell[1]);
603 debug("%s: size=%zx\n", __func__, *size);