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(SMSC_LAN9215, "smsc,lan9215"),
54 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
55 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
56 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
57 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
58 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
59 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
60 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
61 COMPAT(MAXIM_MAX77686_PMIC, "maxim,max77686_pmic"),
64 const char *fdtdec_get_compatible(enum fdt_compat_id id)
66 /* We allow reading of the 'unknown' ID for testing purposes */
67 assert(id >= 0 && id < COMPAT_COUNT);
68 return compat_names[id];
71 fdt_addr_t fdtdec_get_addr_size(const void *blob, int node,
72 const char *prop_name, fdt_size_t *sizep)
74 const fdt_addr_t *cell;
77 debug("%s: %s: ", __func__, prop_name);
78 cell = fdt_getprop(blob, node, prop_name, &len);
79 if (cell && ((!sizep && len == sizeof(fdt_addr_t)) ||
80 len == sizeof(fdt_addr_t) * 2)) {
81 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
83 const fdt_size_t *size;
85 size = (fdt_size_t *)((char *)cell +
87 *sizep = fdt_size_to_cpu(*size);
88 debug("addr=%p, size=%p\n", (void *)addr,
91 debug("%p\n", (void *)addr);
95 debug("(not found)\n");
96 return FDT_ADDR_T_NONE;
99 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
100 const char *prop_name)
102 return fdtdec_get_addr_size(blob, node, prop_name, NULL);
105 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
111 debug("%s: %s: ", __func__, prop_name);
112 cell = fdt_getprop(blob, node, prop_name, &len);
113 if (cell && len >= sizeof(s32)) {
114 s32 val = fdt32_to_cpu(cell[0]);
116 debug("%#x (%d)\n", val, val);
119 debug("(not found)\n");
123 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
124 uint64_t default_val)
126 const uint64_t *cell64;
129 cell64 = fdt_getprop(blob, node, prop_name, &length);
130 if (!cell64 || length < sizeof(*cell64))
133 return fdt64_to_cpu(*cell64);
136 int fdtdec_get_is_enabled(const void *blob, int node)
141 * It should say "okay", so only allow that. Some fdts use "ok" but
142 * this is a bug. Please fix your device tree source file. See here
145 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
147 cell = fdt_getprop(blob, node, "status", NULL);
149 return 0 == strcmp(cell, "okay");
153 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
155 enum fdt_compat_id id;
157 /* Search our drivers */
158 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
159 if (0 == fdt_node_check_compatible(blob, node,
162 return COMPAT_UNKNOWN;
165 int fdtdec_next_compatible(const void *blob, int node,
166 enum fdt_compat_id id)
168 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
171 int fdtdec_next_compatible_subnode(const void *blob, int node,
172 enum fdt_compat_id id, int *depthp)
175 node = fdt_next_node(blob, node, depthp);
176 } while (*depthp > 1);
178 /* If this is a direct subnode, and compatible, return it */
179 if (*depthp == 1 && 0 == fdt_node_check_compatible(
180 blob, node, compat_names[id]))
183 return -FDT_ERR_NOTFOUND;
186 int fdtdec_next_alias(const void *blob, const char *name,
187 enum fdt_compat_id id, int *upto)
189 #define MAX_STR_LEN 20
190 char str[MAX_STR_LEN + 20];
193 /* snprintf() is not available */
194 assert(strlen(name) < MAX_STR_LEN);
195 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
196 node = fdt_path_offset(blob, str);
199 err = fdt_node_check_compatible(blob, node, compat_names[id]);
203 return -FDT_ERR_NOTFOUND;
208 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
209 enum fdt_compat_id id, int *node_list, int maxcount)
211 memset(node_list, '\0', sizeof(*node_list) * maxcount);
213 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
216 /* TODO: Can we tighten this code up a little? */
217 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
218 enum fdt_compat_id id, int *node_list, int maxcount)
220 int name_len = strlen(name);
228 /* find the alias node if present */
229 alias_node = fdt_path_offset(blob, "/aliases");
232 * start with nothing, and we can assume that the root node can't
235 memset(nodes, '\0', sizeof(nodes));
237 /* First find all the compatible nodes */
238 for (node = count = 0; node >= 0 && count < maxcount;) {
239 node = fdtdec_next_compatible(blob, node, id);
241 nodes[count++] = node;
244 debug("%s: warning: maxcount exceeded with alias '%s'\n",
247 /* Now find all the aliases */
248 for (offset = fdt_first_property_offset(blob, alias_node);
250 offset = fdt_next_property_offset(blob, offset)) {
251 const struct fdt_property *prop;
257 prop = fdt_get_property_by_offset(blob, offset, NULL);
258 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
259 if (prop->len && 0 == strncmp(path, name, name_len))
260 node = fdt_path_offset(blob, prop->data);
264 /* Get the alias number */
265 number = simple_strtoul(path + name_len, NULL, 10);
266 if (number < 0 || number >= maxcount) {
267 debug("%s: warning: alias '%s' is out of range\n",
272 /* Make sure the node we found is actually in our list! */
274 for (j = 0; j < count; j++)
275 if (nodes[j] == node) {
281 debug("%s: warning: alias '%s' points to a node "
282 "'%s' that is missing or is not compatible "
283 " with '%s'\n", __func__, path,
284 fdt_get_name(blob, node, NULL),
290 * Add this node to our list in the right place, and mark
293 if (fdtdec_get_is_enabled(blob, node)) {
294 if (node_list[number]) {
295 debug("%s: warning: alias '%s' requires that "
296 "a node be placed in the list in a "
297 "position which is already filled by "
298 "node '%s'\n", __func__, path,
299 fdt_get_name(blob, node, NULL));
302 node_list[number] = node;
303 if (number >= num_found)
304 num_found = number + 1;
309 /* Add any nodes not mentioned by an alias */
310 for (i = j = 0; i < maxcount; i++) {
312 for (; j < maxcount; j++)
314 fdtdec_get_is_enabled(blob, nodes[j]))
317 /* Have we run out of nodes to add? */
321 assert(!node_list[i]);
322 node_list[i] = nodes[j++];
331 int fdtdec_check_fdt(void)
334 * We must have an FDT, but we cannot panic() yet since the console
335 * is not ready. So for now, just assert(). Boards which need an early
336 * FDT (prior to console ready) will need to make their own
337 * arrangements and do their own checks.
339 assert(!fdtdec_prepare_fdt());
344 * This function is a little odd in that it accesses global data. At some
345 * point if the architecture board.c files merge this will make more sense.
346 * Even now, it is common code.
348 int fdtdec_prepare_fdt(void)
350 if (((uintptr_t)gd->fdt_blob & 3) || fdt_check_header(gd->fdt_blob)) {
351 printf("No valid FDT found - please append one to U-Boot "
352 "binary, use u-boot-dtb.bin or define "
353 "CONFIG_OF_EMBED\n");
359 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
364 debug("%s: %s\n", __func__, prop_name);
365 phandle = fdt_getprop(blob, node, prop_name, NULL);
367 return -FDT_ERR_NOTFOUND;
369 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
374 * Look up a property in a node and check that it has a minimum length.
376 * @param blob FDT blob
377 * @param node node to examine
378 * @param prop_name name of property to find
379 * @param min_len minimum property length in bytes
380 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
381 found, or -FDT_ERR_BADLAYOUT if not enough data
382 * @return pointer to cell, which is only valid if err == 0
384 static const void *get_prop_check_min_len(const void *blob, int node,
385 const char *prop_name, int min_len, int *err)
390 debug("%s: %s\n", __func__, prop_name);
391 cell = fdt_getprop(blob, node, prop_name, &len);
393 *err = -FDT_ERR_NOTFOUND;
394 else if (len < min_len)
395 *err = -FDT_ERR_BADLAYOUT;
401 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
402 u32 *array, int count)
407 debug("%s: %s\n", __func__, prop_name);
408 cell = get_prop_check_min_len(blob, node, prop_name,
409 sizeof(u32) * count, &err);
411 for (i = 0; i < count; i++)
412 array[i] = fdt32_to_cpu(cell[i]);
417 const u32 *fdtdec_locate_array(const void *blob, int node,
418 const char *prop_name, int count)
423 cell = get_prop_check_min_len(blob, node, prop_name,
424 sizeof(u32) * count, &err);
425 return err ? NULL : cell;
428 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
433 debug("%s: %s\n", __func__, prop_name);
434 cell = fdt_getprop(blob, node, prop_name, &len);
439 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
442 * @param blob FDT blob to use
443 * @param node Node to look at
444 * @param prop_name Node property name
445 * @param gpio Array of gpio elements to fill from FDT. This will be
446 * untouched if either 0 or an error is returned
447 * @param max_count Maximum number of elements allowed
448 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
449 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
451 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
452 struct fdt_gpio_state *gpio, int max_count)
454 const struct fdt_property *prop;
459 debug("%s: %s\n", __func__, prop_name);
460 assert(max_count > 0);
461 prop = fdt_get_property(blob, node, prop_name, &len);
463 debug("%s: property '%s' missing\n", __func__, prop_name);
464 return -FDT_ERR_NOTFOUND;
467 /* We will use the name to tag the GPIO */
468 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
469 cell = (u32 *)prop->data;
470 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
471 if (len > max_count) {
472 debug(" %s: too many GPIOs / cells for "
473 "property '%s'\n", __func__, prop_name);
474 return -FDT_ERR_BADLAYOUT;
477 /* Read out the GPIO data from the cells */
478 for (i = 0; i < len; i++, cell += 3) {
479 gpio[i].gpio = fdt32_to_cpu(cell[1]);
480 gpio[i].flags = fdt32_to_cpu(cell[2]);
487 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
488 struct fdt_gpio_state *gpio)
492 debug("%s: %s\n", __func__, prop_name);
493 gpio->gpio = FDT_GPIO_NONE;
495 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
496 return err == 1 ? 0 : err;
499 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
503 if (!fdt_gpio_isvalid(gpio))
506 val = gpio_get_value(gpio->gpio);
507 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
510 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
512 if (!fdt_gpio_isvalid(gpio))
515 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
516 return gpio_set_value(gpio->gpio, val);
519 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
522 * Return success if there is no GPIO defined. This is used for
525 if (!fdt_gpio_isvalid(gpio))
528 if (gpio_request(gpio->gpio, gpio->name))
533 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
534 u8 *array, int count)
539 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
541 memcpy(array, cell, count);
545 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
546 const char *prop_name, int count)
551 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
557 int fdtdec_get_config_int(const void *blob, const char *prop_name,
562 debug("%s: %s\n", __func__, prop_name);
563 config_node = fdt_path_offset(blob, "/config");
566 return fdtdec_get_int(blob, config_node, prop_name, default_val);
569 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
574 debug("%s: %s\n", __func__, prop_name);
575 config_node = fdt_path_offset(blob, "/config");
578 prop = fdt_get_property(blob, config_node, prop_name, NULL);
583 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
589 debug("%s: %s\n", __func__, prop_name);
590 nodeoffset = fdt_path_offset(blob, "/config");
594 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
598 return (char *)nodep;
601 int fdtdec_decode_region(const void *blob, int node,
602 const char *prop_name, void **ptrp, size_t *size)
604 const fdt_addr_t *cell;
607 debug("%s: %s\n", __func__, prop_name);
608 cell = fdt_getprop(blob, node, prop_name, &len);
609 if (!cell || (len != sizeof(fdt_addr_t) * 2))
612 *ptrp = (void *)fdt_addr_to_cpu(*cell);
613 *size = fdt_size_to_cpu(cell[1]);
614 debug("%s: size=%zx\n", __func__, *size);