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_TEGRA20_I2C, "nvidia,tegra20-i2c"),
41 COMPAT(NVIDIA_TEGRA20_DVC, "nvidia,tegra20-i2c-dvc"),
42 COMPAT(NVIDIA_TEGRA20_EMC, "nvidia,tegra20-emc"),
43 COMPAT(NVIDIA_TEGRA20_EMC_TABLE, "nvidia,tegra20-emc-table"),
44 COMPAT(NVIDIA_TEGRA20_KBC, "nvidia,tegra20-kbc"),
45 COMPAT(NVIDIA_TEGRA20_NAND, "nvidia,tegra20-nand"),
46 COMPAT(NVIDIA_TEGRA20_PWM, "nvidia,tegra20-pwm"),
47 COMPAT(NVIDIA_TEGRA20_DC, "nvidia,tegra20-dc"),
48 COMPAT(SMSC_LAN9215, "smsc,lan9215"),
49 COMPAT(SAMSUNG_EXYNOS5_SROMC, "samsung,exynos-sromc"),
50 COMPAT(SAMSUNG_S3C2440_I2C, "samsung,s3c2440-i2c"),
51 COMPAT(SAMSUNG_EXYNOS5_SOUND, "samsung,exynos-sound"),
52 COMPAT(WOLFSON_WM8994_CODEC, "wolfson,wm8994-codec"),
53 COMPAT(SAMSUNG_EXYNOS_SPI, "samsung,exynos-spi"),
54 COMPAT(SAMSUNG_EXYNOS_EHCI, "samsung,exynos-ehci"),
55 COMPAT(SAMSUNG_EXYNOS_USB_PHY, "samsung,exynos-usb-phy"),
58 const char *fdtdec_get_compatible(enum fdt_compat_id id)
60 /* We allow reading of the 'unknown' ID for testing purposes */
61 assert(id >= 0 && id < COMPAT_COUNT);
62 return compat_names[id];
65 fdt_addr_t fdtdec_get_addr(const void *blob, int node,
66 const char *prop_name)
68 const fdt_addr_t *cell;
71 debug("%s: %s: ", __func__, prop_name);
72 cell = fdt_getprop(blob, node, prop_name, &len);
73 if (cell && (len == sizeof(fdt_addr_t) ||
74 len == sizeof(fdt_addr_t) * 2)) {
75 fdt_addr_t addr = fdt_addr_to_cpu(*cell);
77 debug("%p\n", (void *)addr);
80 debug("(not found)\n");
81 return FDT_ADDR_T_NONE;
84 s32 fdtdec_get_int(const void *blob, int node, const char *prop_name,
90 debug("%s: %s: ", __func__, prop_name);
91 cell = fdt_getprop(blob, node, prop_name, &len);
92 if (cell && len >= sizeof(s32)) {
93 s32 val = fdt32_to_cpu(cell[0]);
95 debug("%#x (%d)\n", val, val);
98 debug("(not found)\n");
102 uint64_t fdtdec_get_uint64(const void *blob, int node, const char *prop_name,
103 uint64_t default_val)
105 const uint64_t *cell64;
108 cell64 = fdt_getprop(blob, node, prop_name, &length);
109 if (!cell64 || length < sizeof(*cell64))
112 return fdt64_to_cpu(*cell64);
115 int fdtdec_get_is_enabled(const void *blob, int node)
120 * It should say "okay", so only allow that. Some fdts use "ok" but
121 * this is a bug. Please fix your device tree source file. See here
124 * http://www.mail-archive.com/u-boot@lists.denx.de/msg71598.html
126 cell = fdt_getprop(blob, node, "status", NULL);
128 return 0 == strcmp(cell, "okay");
132 enum fdt_compat_id fdtdec_lookup(const void *blob, int node)
134 enum fdt_compat_id id;
136 /* Search our drivers */
137 for (id = COMPAT_UNKNOWN; id < COMPAT_COUNT; id++)
138 if (0 == fdt_node_check_compatible(blob, node,
141 return COMPAT_UNKNOWN;
144 int fdtdec_next_compatible(const void *blob, int node,
145 enum fdt_compat_id id)
147 return fdt_node_offset_by_compatible(blob, node, compat_names[id]);
150 int fdtdec_next_compatible_subnode(const void *blob, int node,
151 enum fdt_compat_id id, int *depthp)
154 node = fdt_next_node(blob, node, depthp);
155 } while (*depthp > 1);
157 /* If this is a direct subnode, and compatible, return it */
158 if (*depthp == 1 && 0 == fdt_node_check_compatible(
159 blob, node, compat_names[id]))
162 return -FDT_ERR_NOTFOUND;
165 int fdtdec_next_alias(const void *blob, const char *name,
166 enum fdt_compat_id id, int *upto)
168 #define MAX_STR_LEN 20
169 char str[MAX_STR_LEN + 20];
172 /* snprintf() is not available */
173 assert(strlen(name) < MAX_STR_LEN);
174 sprintf(str, "%.*s%d", MAX_STR_LEN, name, *upto);
175 node = fdt_path_offset(blob, str);
178 err = fdt_node_check_compatible(blob, node, compat_names[id]);
182 return -FDT_ERR_NOTFOUND;
187 int fdtdec_find_aliases_for_id(const void *blob, const char *name,
188 enum fdt_compat_id id, int *node_list, int maxcount)
190 memset(node_list, '\0', sizeof(*node_list) * maxcount);
192 return fdtdec_add_aliases_for_id(blob, name, id, node_list, maxcount);
195 /* TODO: Can we tighten this code up a little? */
196 int fdtdec_add_aliases_for_id(const void *blob, const char *name,
197 enum fdt_compat_id id, int *node_list, int maxcount)
199 int name_len = strlen(name);
207 /* find the alias node if present */
208 alias_node = fdt_path_offset(blob, "/aliases");
211 * start with nothing, and we can assume that the root node can't
214 memset(nodes, '\0', sizeof(nodes));
216 /* First find all the compatible nodes */
217 for (node = count = 0; node >= 0 && count < maxcount;) {
218 node = fdtdec_next_compatible(blob, node, id);
220 nodes[count++] = node;
223 debug("%s: warning: maxcount exceeded with alias '%s'\n",
226 /* Now find all the aliases */
227 for (offset = fdt_first_property_offset(blob, alias_node);
229 offset = fdt_next_property_offset(blob, offset)) {
230 const struct fdt_property *prop;
236 prop = fdt_get_property_by_offset(blob, offset, NULL);
237 path = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
238 if (prop->len && 0 == strncmp(path, name, name_len))
239 node = fdt_path_offset(blob, prop->data);
243 /* Get the alias number */
244 number = simple_strtoul(path + name_len, NULL, 10);
245 if (number < 0 || number >= maxcount) {
246 debug("%s: warning: alias '%s' is out of range\n",
251 /* Make sure the node we found is actually in our list! */
253 for (j = 0; j < count; j++)
254 if (nodes[j] == node) {
260 debug("%s: warning: alias '%s' points to a node "
261 "'%s' that is missing or is not compatible "
262 " with '%s'\n", __func__, path,
263 fdt_get_name(blob, node, NULL),
269 * Add this node to our list in the right place, and mark
272 if (fdtdec_get_is_enabled(blob, node)) {
273 if (node_list[number]) {
274 debug("%s: warning: alias '%s' requires that "
275 "a node be placed in the list in a "
276 "position which is already filled by "
277 "node '%s'\n", __func__, path,
278 fdt_get_name(blob, node, NULL));
281 node_list[number] = node;
282 if (number >= num_found)
283 num_found = number + 1;
288 /* Add any nodes not mentioned by an alias */
289 for (i = j = 0; i < maxcount; i++) {
291 for (; j < maxcount; j++)
293 fdtdec_get_is_enabled(blob, nodes[j]))
296 /* Have we run out of nodes to add? */
300 assert(!node_list[i]);
301 node_list[i] = nodes[j++];
310 int fdtdec_check_fdt(void)
313 * We must have an FDT, but we cannot panic() yet since the console
314 * is not ready. So for now, just assert(). Boards which need an early
315 * FDT (prior to console ready) will need to make their own
316 * arrangements and do their own checks.
318 assert(!fdtdec_prepare_fdt());
323 * This function is a little odd in that it accesses global data. At some
324 * point if the architecture board.c files merge this will make more sense.
325 * Even now, it is common code.
327 int fdtdec_prepare_fdt(void)
329 if (((uintptr_t)gd->fdt_blob & 3) || fdt_check_header(gd->fdt_blob)) {
330 printf("No valid FDT found - please append one to U-Boot "
331 "binary, use u-boot-dtb.bin or define "
332 "CONFIG_OF_EMBED\n");
338 int fdtdec_lookup_phandle(const void *blob, int node, const char *prop_name)
343 debug("%s: %s\n", __func__, prop_name);
344 phandle = fdt_getprop(blob, node, prop_name, NULL);
346 return -FDT_ERR_NOTFOUND;
348 lookup = fdt_node_offset_by_phandle(blob, fdt32_to_cpu(*phandle));
353 * Look up a property in a node and check that it has a minimum length.
355 * @param blob FDT blob
356 * @param node node to examine
357 * @param prop_name name of property to find
358 * @param min_len minimum property length in bytes
359 * @param err 0 if ok, or -FDT_ERR_NOTFOUND if the property is not
360 found, or -FDT_ERR_BADLAYOUT if not enough data
361 * @return pointer to cell, which is only valid if err == 0
363 static const void *get_prop_check_min_len(const void *blob, int node,
364 const char *prop_name, int min_len, int *err)
369 debug("%s: %s\n", __func__, prop_name);
370 cell = fdt_getprop(blob, node, prop_name, &len);
372 *err = -FDT_ERR_NOTFOUND;
373 else if (len < min_len)
374 *err = -FDT_ERR_BADLAYOUT;
380 int fdtdec_get_int_array(const void *blob, int node, const char *prop_name,
381 u32 *array, int count)
386 debug("%s: %s\n", __func__, prop_name);
387 cell = get_prop_check_min_len(blob, node, prop_name,
388 sizeof(u32) * count, &err);
390 for (i = 0; i < count; i++)
391 array[i] = fdt32_to_cpu(cell[i]);
396 const u32 *fdtdec_locate_array(const void *blob, int node,
397 const char *prop_name, int count)
402 cell = get_prop_check_min_len(blob, node, prop_name,
403 sizeof(u32) * count, &err);
404 return err ? NULL : cell;
407 int fdtdec_get_bool(const void *blob, int node, const char *prop_name)
412 debug("%s: %s\n", __func__, prop_name);
413 cell = fdt_getprop(blob, node, prop_name, &len);
418 * Decode a list of GPIOs from an FDT. This creates a list of GPIOs with no
421 * @param blob FDT blob to use
422 * @param node Node to look at
423 * @param prop_name Node property name
424 * @param gpio Array of gpio elements to fill from FDT. This will be
425 * untouched if either 0 or an error is returned
426 * @param max_count Maximum number of elements allowed
427 * @return number of GPIOs read if ok, -FDT_ERR_BADLAYOUT if max_count would
428 * be exceeded, or -FDT_ERR_NOTFOUND if the property is missing.
430 int fdtdec_decode_gpios(const void *blob, int node, const char *prop_name,
431 struct fdt_gpio_state *gpio, int max_count)
433 const struct fdt_property *prop;
438 debug("%s: %s\n", __func__, prop_name);
439 assert(max_count > 0);
440 prop = fdt_get_property(blob, node, prop_name, &len);
442 debug("%s: property '%s' missing\n", __func__, prop_name);
443 return -FDT_ERR_NOTFOUND;
446 /* We will use the name to tag the GPIO */
447 name = fdt_string(blob, fdt32_to_cpu(prop->nameoff));
448 cell = (u32 *)prop->data;
449 len /= sizeof(u32) * 3; /* 3 cells per GPIO record */
450 if (len > max_count) {
451 debug(" %s: too many GPIOs / cells for "
452 "property '%s'\n", __func__, prop_name);
453 return -FDT_ERR_BADLAYOUT;
456 /* Read out the GPIO data from the cells */
457 for (i = 0; i < len; i++, cell += 3) {
458 gpio[i].gpio = fdt32_to_cpu(cell[1]);
459 gpio[i].flags = fdt32_to_cpu(cell[2]);
466 int fdtdec_decode_gpio(const void *blob, int node, const char *prop_name,
467 struct fdt_gpio_state *gpio)
471 debug("%s: %s\n", __func__, prop_name);
472 gpio->gpio = FDT_GPIO_NONE;
474 err = fdtdec_decode_gpios(blob, node, prop_name, gpio, 1);
475 return err == 1 ? 0 : err;
478 int fdtdec_get_gpio(struct fdt_gpio_state *gpio)
482 if (!fdt_gpio_isvalid(gpio))
485 val = gpio_get_value(gpio->gpio);
486 return gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
489 int fdtdec_set_gpio(struct fdt_gpio_state *gpio, int val)
491 if (!fdt_gpio_isvalid(gpio))
494 val = gpio->flags & FDT_GPIO_ACTIVE_LOW ? val ^ 1 : val;
495 return gpio_set_value(gpio->gpio, val);
498 int fdtdec_setup_gpio(struct fdt_gpio_state *gpio)
501 * Return success if there is no GPIO defined. This is used for
504 if (!fdt_gpio_isvalid(gpio))
507 if (gpio_request(gpio->gpio, gpio->name))
512 int fdtdec_get_byte_array(const void *blob, int node, const char *prop_name,
513 u8 *array, int count)
518 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
520 memcpy(array, cell, count);
524 const u8 *fdtdec_locate_byte_array(const void *blob, int node,
525 const char *prop_name, int count)
530 cell = get_prop_check_min_len(blob, node, prop_name, count, &err);
536 int fdtdec_get_config_int(const void *blob, const char *prop_name,
541 debug("%s: %s\n", __func__, prop_name);
542 config_node = fdt_path_offset(blob, "/config");
545 return fdtdec_get_int(blob, config_node, prop_name, default_val);
548 int fdtdec_get_config_bool(const void *blob, const char *prop_name)
553 debug("%s: %s\n", __func__, prop_name);
554 config_node = fdt_path_offset(blob, "/config");
557 prop = fdt_get_property(blob, config_node, prop_name, NULL);
562 char *fdtdec_get_config_string(const void *blob, const char *prop_name)
568 debug("%s: %s\n", __func__, prop_name);
569 nodeoffset = fdt_path_offset(blob, "/config");
573 nodep = fdt_getprop(blob, nodeoffset, prop_name, &len);
577 return (char *)nodep;
580 int fdtdec_decode_region(const void *blob, int node,
581 const char *prop_name, void **ptrp, size_t *size)
583 const fdt_addr_t *cell;
586 debug("%s: %s\n", __func__, prop_name);
587 cell = fdt_getprop(blob, node, prop_name, &len);
588 if (!cell || (len != sizeof(fdt_addr_t) * 2))
591 *ptrp = (void *)fdt_addr_to_cpu(*cell);
592 *size = fdt_size_to_cpu(cell[1]);
593 debug("%s: size=%zx\n", __func__, *size);